com.lf.commons.docking

Class DockingUtils

java.lang.Object

com.lf.commons.docking.DockingUtils

public class DockingUtils
extends java.lang.Object

Some multipurpose utility methods for docking components.

Since:

1.6

Version:

$Revision: 1.24 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CONFIG_AUTOMATIC Variable for the configuration.
protected static java.lang.String	CONFIG_BUTTON_VISIBLE Variable for the configuration.
protected static java.lang.String	CONFIG_HEIGHT Variable for the configuration.
protected static java.lang.String	CONFIG_LOCATION Variable for the configuration.
protected static java.lang.String	CONFIG_MODE Variable for the configuration.
protected static java.lang.String	CONFIG_WIDTH Variable for the configuration.
protected static java.lang.String	CONFIG_WINDOW_HEIGHT Variable for the configuration.
protected static java.lang.String	CONFIG_WINDOW_LOCX Variable for the configuration.
protected static java.lang.String	CONFIG_WINDOW_LOCY Variable for the configuration.
protected static java.lang.String	CONFIG_WINDOW_MODE Variable for the configuration.
protected static java.lang.String	CONFIG_WINDOW_STATE Variable for the configuration.
protected static java.lang.String	CONFIG_WINDOW_VISIBLE Variable for the configuration.
protected static java.lang.String	CONFIG_WINDOW_WIDTH Variable for the configuration.

Constructor Summary

Constructors

Constructor and Description
DockingUtils() Constructor method for i18n purposes only.

Method Summary

Methods

Modifier and Type	Method and Description
static void	configure(java.lang.String id, Configuration config, DockingWindow window) Restores values from persistent data stores.
static void	debugPrint(DockingWindow window) Convenience method to show the current docking window configuration.
static void	doClickImmediately(javax.swing.JToggleButton button) Alternative for the doClick() method where events are generated immediately.
static DockingManager	findDockingManager(java.awt.Component comp) Finds the docking manager for a managed component.
static int	getWindowLocation(java.lang.String id, Configuration config, int fallback) Convenience method to extract the location of docking windows.
static java.lang.String	mapFromDockingMode(int mode) Maps the given numerical window mode type to the corresponding text representation.
static void	store(java.lang.String id, Configuration config, DockingWindow window) Stores the current configuration values persistently.

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_WIDTH

protected static final java.lang.String CONFIG_WIDTH

Variable for the configuration.

See Also:

Constant Field Values

CONFIG_HEIGHT

protected static final java.lang.String CONFIG_HEIGHT

Variable for the configuration.

See Also:

Constant Field Values

CONFIG_MODE

protected static final java.lang.String CONFIG_MODE

Variable for the configuration.

See Also:

Constant Field Values

CONFIG_AUTOMATIC

protected static final java.lang.String CONFIG_AUTOMATIC

Variable for the configuration.

See Also:

Constant Field Values

CONFIG_BUTTON_VISIBLE

protected static final java.lang.String CONFIG_BUTTON_VISIBLE

Variable for the configuration.

See Also:

Constant Field Values

CONFIG_LOCATION

protected static final java.lang.String CONFIG_LOCATION

Variable for the configuration.

See Also:

Constant Field Values

CONFIG_WINDOW_MODE

protected static final java.lang.String CONFIG_WINDOW_MODE

Variable for the configuration.

See Also:

Constant Field Values

CONFIG_WINDOW_WIDTH

protected static final java.lang.String CONFIG_WINDOW_WIDTH

Variable for the configuration.

See Also:

Constant Field Values

CONFIG_WINDOW_HEIGHT

protected static final java.lang.String CONFIG_WINDOW_HEIGHT

Variable for the configuration.

See Also:

Constant Field Values

CONFIG_WINDOW_LOCX

protected static final java.lang.String CONFIG_WINDOW_LOCX

Variable for the configuration.

See Also:

Constant Field Values

CONFIG_WINDOW_LOCY

protected static final java.lang.String CONFIG_WINDOW_LOCY

Variable for the configuration.

See Also:

Constant Field Values

CONFIG_WINDOW_STATE

protected static final java.lang.String CONFIG_WINDOW_STATE

Variable for the configuration.

See Also:

Constant Field Values

CONFIG_WINDOW_VISIBLE

protected static final java.lang.String CONFIG_WINDOW_VISIBLE

Variable for the configuration.

See Also:

Constant Field Values

Constructor Detail

DockingUtils

public DockingUtils()
             throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

Method Detail

findDockingManager

public static DockingManager findDockingManager(java.awt.Component comp)

Finds the docking manager for a managed component.

To be successful it is necessary that the component is in the component hierarchy of the docking manager. If there are multiple managers (e.g. embedded) the closest parent in the hierarchy is provided so callers must walk through the hierarchies manually.

Parameters:

comp - The child component

Returns:

The docking manager or null, if not available

Since:

1.6

configure

public static void configure(java.lang.String id,
             Configuration config,
             DockingWindow window)

Restores values from persistent data stores.

All relevant values of the DockingWindow interface are processed here.

Parameters:

id - The unique identifier for the instance

config - The configuration

window - The docking window

Since:

1.6

store

public static void store(java.lang.String id,
         Configuration config,
         DockingWindow window)

Stores the current configuration values persistently.

All relevant values of the DockingWindow interface are processed here.

Parameters:

id - The unique identifier for the instance

config - The configuration

window - The docking window

Since:

1.6

getWindowLocation

public static int getWindowLocation(java.lang.String id,
                    Configuration config,
                    int fallback)

Convenience method to extract the location of docking windows.

Parameters:

id - The unique identifier for the instance

config - The configuration

fallback - The fallback value

Returns:

The location or fallback

Since:

1.6

mapFromDockingMode

public static java.lang.String mapFromDockingMode(int mode)

Maps the given numerical window mode type to the corresponding text representation.

Parameters:

mode - The internal value

Returns:

The mode text, null if not a valid mode

Since:

1.6

debugPrint

public static void debugPrint(DockingWindow window)

Convenience method to show the current docking window configuration.

Parameters:

window - The window

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

doClickImmediately

public static void doClickImmediately(javax.swing.JToggleButton button)

Alternative for the doClick() method where events are generated immediately.

After this method has been called the ActionEvent's have already been generated and processed by the listeners.

Parameters:

button - The button

Since:

1.6