com.lf.commons.dialog.options

Class DockingUnit

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.lf.commons.dialog.options.DockingUnit

All Implemented Interfaces:

OptionsUnit, ConfigurableUnit, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class DockingUnit
extends javax.swing.JPanel
implements ConfigurableUnit, OptionsUnit

Configurable panel to configure the options of the DockingManager

Since:

1.6

Version:

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

Author:

Axel Schwolow

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLOSE_DOCK_HIDE Separate window close action.
static int	CLOSE_DOCK_SHOW Separate window close action.
static int	CLOSE_FULL Separate window close action.
static java.net.URL	ICON_SMALL Default unit icon.
protected boolean	initialized Components have been setup already?
protected java.util.Vector<java.awt.Component>	matches Remembers the components matching a search pattern for reset.
protected OptionsDialog	parent Parental dialog.

Fields inherited from class javax.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
DockingUnit() Constructor of this form.

Method Summary

Methods

Modifier and Type	Method and Description
void	changedUpdate(javax.swing.event.DocumentEvent event) Called whenever the document is changed.
void	configureUnit(java.lang.String id, Configuration config) Restores values from persistent data stores.
protected void	finalize() Cares for proper cleanup after releasing the object.
int	find(java.lang.String pattern) Searches this unit for certain patterns specified by the user.
javax.swing.ImageIcon	getBigIcon() Provides the graphical icon of a certain size (normally 32x32 pixels).
static int	getCloseAction(java.lang.String id, Configuration config, int fallback) Convenience getter for the action when a separate window is closed.
static boolean	getCloseOnEscape(java.lang.String id, Configuration config, boolean fallback) Convenience getter to use ESCAPE to hide windows.
java.awt.Component	getComponent() Provides the GUI component to be displayed.
static boolean	getMainDeiconify(java.lang.String id, Configuration config, boolean fallback) Convenience getter.
static boolean	getMainIconify(java.lang.String id, Configuration config, boolean fallback) Convenience getter.
javax.swing.ImageIcon	getSmallIcon() Provides the graphical icon of a certain size (normally 16x16 pixels).
java.lang.String	getText() Provides the text of the item to be displayed in the list of the OptionsDialog.
java.lang.String	getTitle() Provides the title of the item to be displayed on top of the OptionsDialog.
protected void	init() Initializes the GUI components.
boolean	isInputValid() Provides the info if the options of this unit are OK to be used.
boolean	isModified() Provides the info if the options of this unit have been changed.
void	resetSearch(java.lang.String pattern) Resets this unit so that the components do not highlight any search results.
static void	setCloseAction(java.lang.String id, Configuration config, int value) Convenience setter for the action when a separate window is closed.
void	setCloseOnEscape(boolean enabled) (De)activates closing the windows on ESCAPE.
static void	setCloseOnEscape(java.lang.String id, Configuration config, boolean value) Convenience setter to use ESCAPE to hide windows.
static void	setMainDeiconify(java.lang.String id, Configuration config, boolean value) Convenience setter.
static void	setMainIconify(java.lang.String id, Configuration config, boolean value) Convenience setter.
static void	storeDefaultValues(java.lang.String id, Configuration config, boolean escape, int closeaction, boolean iconify, boolean deiconify, boolean tofront) Convenience method to populate the configuration with default values.
void	storeUnit(java.lang.String id, Configuration config) Stores the current configuration values persistently.
void	unitAdded(OptionsDialog parent, java.lang.String id) Informs the unit that it was added to the dialog.
void	unitBecomesHidden() Informs the unit that it will vanish from the screen (deselected).
void	unitBecomesShown() Informs the unit that it becomes visible on the screen (selected).
void	unitIsHiding() Informs the unit that it was made invisible by the manager (deselected).
void	unitIsShowing() Informs the unit that it was made visible by the manager (selected).
void	unitRegistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was registered with a model.
void	unitRemoved(OptionsDialog parent, java.lang.String id) Informs the unit that it was removed from the tabbed window.
void	unitUnregistered(ApplicationModel model, java.lang.String id) Informs the configurable unit that it was unregistered with a model.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

ICON_SMALL

public static java.net.URL ICON_SMALL

Default unit icon.

CLOSE_DOCK_SHOW

public static int CLOSE_DOCK_SHOW

Separate window close action.

CLOSE_DOCK_HIDE

public static int CLOSE_DOCK_HIDE

Separate window close action.

CLOSE_FULL

public static int CLOSE_FULL

Separate window close action.

initialized

protected boolean initialized

Components have been setup already?

matches

protected java.util.Vector<java.awt.Component> matches

Remembers the components matching a search pattern for reset.

parent

protected OptionsDialog parent

Parental dialog.

Constructor Detail

DockingUnit

public DockingUnit()

Constructor of this form.

Since:

1.6

Method Detail

init

protected void init()

Initializes the GUI components.

Since:

1.6

finalize

protected void finalize()
                 throws java.lang.Throwable

Cares for proper cleanup after releasing the object.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

Since:

1.6

configureUnit

public void configureUnit(java.lang.String id,
                 Configuration config)

Restores values from persistent data stores.

Specified by:

configureUnit in interface ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

storeUnit

public void storeUnit(java.lang.String id,
             Configuration config)

Stores the current configuration values persistently.

Specified by:

storeUnit in interface ConfigurableUnit

Parameters:

id - The unique identifier for the instance

config - The configuration

Since:

1.6

storeDefaultValues

public static void storeDefaultValues(java.lang.String id,
                      Configuration config,
                      boolean escape,
                      int closeaction,
                      boolean iconify,
                      boolean deiconify,
                      boolean tofront)

Convenience method to populate the configuration with default values.

Parameters:

id - The unique identifier for the instance

config - The configuration

escape - Hide windows on ESCAPE?

closeaction - One of CLOSE_DOCK_SHOW|...

iconify - Auto-iconify separate windows?

deiconify - Auto-deiconify separate windows?

tofront - Move separate windows to front?

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

unitRegistered

public void unitRegistered(ApplicationModel model,
                  java.lang.String id)

Informs the configurable unit that it was registered with a model.

Specified by:

unitRegistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

unitUnregistered

public void unitUnregistered(ApplicationModel model,
                    java.lang.String id)

Informs the configurable unit that it was unregistered with a model.

Specified by:

unitUnregistered in interface ConfigurableUnit

Parameters:

model - The application model

id - The unique identifier for the instance

Since:

1.6

setCloseOnEscape

public void setCloseOnEscape(boolean enabled)

(De)activates closing the windows on ESCAPE.

Parameters:

enabled - Close windows on ESCAPE?

Throws:

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

getText

public java.lang.String getText()

Provides the text of the item to be displayed in the list of the OptionsDialog.

Specified by:

getText in interface OptionsUnit

Returns:

The item text

Since:

1.6

getBigIcon

public javax.swing.ImageIcon getBigIcon()

Provides the graphical icon of a certain size (normally 32x32 pixels).

Specified by:

getBigIcon in interface OptionsUnit

Returns:

The item icon

Since:

1.6

getSmallIcon

public javax.swing.ImageIcon getSmallIcon()

Provides the graphical icon of a certain size (normally 16x16 pixels).

Specified by:

getSmallIcon in interface OptionsUnit

Returns:

The item icon

Since:

1.6

getTitle

public java.lang.String getTitle()

Provides the title of the item to be displayed on top of the OptionsDialog.

Specified by:

getTitle in interface OptionsUnit

Returns:

The item title

Since:

1.6

getComponent

public java.awt.Component getComponent()

Provides the GUI component to be displayed.

Specified by:

getComponent in interface OptionsUnit

Returns:

The GUI component, null indicates folder functionality

Since:

1.6

find

public int find(java.lang.String pattern)

Searches this unit for certain patterns specified by the user.

Specified by:

find in interface OptionsUnit

Parameters:

pattern - The search pattern

Returns:

Match count, 0 means does not match

Since:

1.6

resetSearch

public void resetSearch(java.lang.String pattern)

Resets this unit so that the components do not highlight any search results.

Specified by:

resetSearch in interface OptionsUnit

Parameters:

pattern - The search pattern

Since:

1.6

isModified

public boolean isModified()

Provides the info if the options of this unit have been changed.

Specified by:

isModified in interface OptionsUnit

Returns:

Has the options been altered?

Since:

1.6

isInputValid

public boolean isInputValid()

Provides the info if the options of this unit are OK to be used.

Specified by:

isInputValid in interface OptionsUnit

Returns:

Options OK?

Since:

1.6

unitAdded

public void unitAdded(OptionsDialog parent,
             java.lang.String id)

Informs the unit that it was added to the dialog.

Specified by:

unitAdded in interface OptionsUnit

Parameters:

parent - The dialog

id - The unique ID

Since:

1.6

unitRemoved

public void unitRemoved(OptionsDialog parent,
               java.lang.String id)

Informs the unit that it was removed from the tabbed window.

Specified by:

unitRemoved in interface OptionsUnit

Parameters:

parent - The dialog

id - The unique ID

Since:

1.6

unitBecomesShown

public void unitBecomesShown()

Informs the unit that it becomes visible on the screen (selected).

Specified by:

unitBecomesShown in interface OptionsUnit

Since:

1.6

unitBecomesHidden

public void unitBecomesHidden()

Informs the unit that it will vanish from the screen (deselected).

Specified by:

unitBecomesHidden in interface OptionsUnit

Since:

1.6

unitIsShowing

public void unitIsShowing()

Informs the unit that it was made visible by the manager (selected).

Specified by:

unitIsShowing in interface OptionsUnit

Since:

1.6

unitIsHiding

public void unitIsHiding()

Informs the unit that it was made invisible by the manager (deselected).

Specified by:

unitIsHiding in interface OptionsUnit

Since:

1.6

getCloseOnEscape

public static boolean getCloseOnEscape(java.lang.String id,
                       Configuration config,
                       boolean fallback)

Convenience getter to use ESCAPE to hide windows.

Parameters:

id - The unit ID

config - The cache

fallback - Default value

Returns:

The value

Since:

1.6

setCloseOnEscape

public static void setCloseOnEscape(java.lang.String id,
                    Configuration config,
                    boolean value)

Convenience setter to use ESCAPE to hide windows.

Parameters:

id - The unit ID

config - The cache

value - The value

Since:

1.6

getMainIconify

public static boolean getMainIconify(java.lang.String id,
                     Configuration config,
                     boolean fallback)

Convenience getter.

Parameters:

id - The unit ID

config - The cache

fallback - Default value

Returns:

The value

Since:

1.6

setMainIconify

public static void setMainIconify(java.lang.String id,
                  Configuration config,
                  boolean value)

Convenience setter.

Parameters:

id - The unit ID

config - The cache

value - The value

Since:

1.6

getMainDeiconify

public static boolean getMainDeiconify(java.lang.String id,
                       Configuration config,
                       boolean fallback)

Convenience getter.

Parameters:

id - The unit ID

config - The cache

fallback - Default value

Returns:

The value

Since:

1.6

setMainDeiconify

public static void setMainDeiconify(java.lang.String id,
                    Configuration config,
                    boolean value)

Convenience setter.

Parameters:

id - The unit ID

config - The cache

value - The value

Since:

1.6

getCloseAction

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

Convenience getter for the action when a separate window is closed.

Parameters:

id - The unit ID

config - The cache

fallback - Default value, one of DockingUnit.CLOSE_DOCK_SHOW|...

Returns:

The value

Since:

1.6

setCloseAction

public static void setCloseAction(java.lang.String id,
                  Configuration config,
                  int value)

Convenience setter for the action when a separate window is closed.

Parameters:

id - The unit ID

config - The cache

value - The value, one of DockingUnit.CLOSE_DOCK_SHOW|...

Since:

1.6

changedUpdate

public void changedUpdate(javax.swing.event.DocumentEvent event)

Called whenever the document is changed.

Parameters:

event - The event object

Since:

1.6