com.fathzer.soft.ajlib.swing

Class Utils

java.lang.Object

com.fathzer.soft.ajlib.swing.Utils

public abstract class Utils
extends Object

Some Swing utilities.

Author:

Jean-Marc Astesana
License: LGPL v3

Method Summary

Modifier and Type	Method and Description
static void	centerWindow(Window window, Window reference) Deprecated.
static Icon	createIcon(URL path, float sizeRatio)
static Icon	createIcon(URL path, int size) Gets an icon by its URL and resize it if needed.
static String	getLFClassFromName(String lookAndFeelName) Converts a look and feel name to its class name.
static Window	getOwnerWindow(Component component) Gets the window which contains a component.
static MouseListener	getToolTipAdapter(int initialDelay, int dismissDelay, int reshowDelay) Returns a utility MouseListener to set custom toolTip delays on component.
static boolean	isVisible(Rectangle rec)
static int	packColumn(JTable table, int colIndex, int margin) Sets the preferred width of the visible column specified by vColIndex.
static void	packColumns(JTable table, int margin) Packs the columns of a JTable.
static void	restoreState(Frame frame, Preferences prefs) Restores the state (size, position, maximized/minimized state) of a frame.
static void	saveState(Frame frame, Preferences prefs) Saves the state (size, position, maximized/minimized state) of a frame.
static void	setSafeBounds(Frame frame, Rectangle bounds) Carefully sets the rectangle of a frame.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getOwnerWindow

public static Window getOwnerWindow(Component component)

Gets the window which contains a component.
Note that this method, unlike java.swing.SwingUtilities.getAncestor, this method returns the invoker window if the component is a menu item (java.swing.SwingUtilities.getAncestor returns null in such a case).

Parameters:

component - the component

Returns:

The window containing the component or null if no window contains the component.

centerWindow

@Deprecated
public static void centerWindow(Window window,
                                             Window reference)

Deprecated.

Centers a window relatively to another.

Parameters:

window - The window to center

reference - The reference window

See Also:

Window.setLocationRelativeTo(Component)

packColumns

public static void packColumns(JTable table,
                               int margin)

Packs the columns of a JTable.

Parameters:

table - The Jtable to pack

margin - the margin in pixels

See Also:

packColumn(JTable, int, int)

packColumn

public static int packColumn(JTable table,
                             int colIndex,
                             int margin)

Sets the preferred width of the visible column specified by vColIndex.
The column will be just wide enough to show the column head and the widest cell in the column. margin pixels are added to the left and right (resulting in an additional width of 2*margin pixels).

Parameters:

table - a table

colIndex - the column index (model based not view based)

margin - The cells margin

Returns:

The width of the column or -1 if the column is not displayed at this time.

createIcon

public static Icon createIcon(URL path,
                              int size)

Gets an icon by its URL and resize it if needed.

Parameters:

path - The absolute icon path resource

size - the required size

Returns:

the icon or null if the path is

createIcon

public static Icon createIcon(URL path,
                              float sizeRatio)

getToolTipAdapter

public static MouseListener getToolTipAdapter(int initialDelay,
                                              int dismissDelay,
                                              int reshowDelay)

Returns a utility MouseListener to set custom toolTip delays on component.
To use custom delays, add the return adapter as a MouseListener to the component. component.addMouseListener(Utils.getToolTipAdpater(...))

Parameters:

initialDelay - see javax.swing.ToolTipManager documentation. A negative int to use the default delay.

dismissDelay - see javax.swing.ToolTipManager documentation. A negative int to use the default delay. Zero to disable the tooltip.

reshowDelay - see javax.swing.ToolTipManager documentation. A negative int to use the default delay.

Returns:

a MouseListener

getLFClassFromName

public static String getLFClassFromName(String lookAndFeelName)

Converts a look and feel name to its class name.

Parameters:

lookAndFeelName - The name of the look and feel

Returns:

The class name of the look and feel or null if the LAF is unknown.

saveState

public static void saveState(Frame frame,
                             Preferences prefs)

Saves the state (size, position, maximized/minimized state) of a frame.

Parameters:

frame - The frame we want to save the state

prefs - The preferences where to save the state

See Also:

restoreState(Frame, Preferences)

restoreState

public static void restoreState(Frame frame,
                                Preferences prefs)

Restores the state (size, position, maximized/minimized state) of a frame.
State should have been previously saved with saveState(java.awt.Frame, java.util.prefs.Preferences).

Parameters:

frame - The frame we want to save the state

prefs - The preferences where to save the state

See Also:

saveState(Frame, Preferences)

setSafeBounds

public static void setSafeBounds(Frame frame,
                                 Rectangle bounds)

Carefully sets the rectangle of a frame.
This means it ensure the frame is visible on the screen.

Parameters:

frame - The frame to resize/move

bounds - The future frame rectangle. If its height or its width is < 0, the frame is maximized vertically/horizontally. If it is not visible on the current available screens, the frame's location is set to the middle of the default screen.

isVisible

public static boolean isVisible(Rectangle rec)