com.lf.commons.docking

Class DockingManager

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

com.lf.commons.docking.DockingManager

All Implemented Interfaces:

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

public class DockingManager
extends javax.swing.JPanel

Complex component implementing a docking framework for applications.

Docking panels can be added on the left, right, top, and bottom position. The alignment of the docking bars can be configured, also the component in the center of the manager component. This can be an editor like JetBrain's IDEA or some sort of data area like CARAMEL. The panels can be moved, hidden, pinned, or closed to let the user handle the application GUI as fast and comfortable as possible.

Since:

1.6

Version:

$Revision: 1.81 $, $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
protected javax.swing.JMenuItem[]	acceleratorItems The items holding the docking accelerators like "DELETE" also used for separate windows.
protected ActionManager	actionManager The manager for the high-level shared actions.
protected DockingWindow	activeWindow Remembers the currently active docking window (e.g. for refresh).
protected BackgroundTaskManager	bgTaskManager Instance managing the background tasks.
protected java.util.Hashtable<java.lang.String,javax.swing.JToggleButton>	cacheButtonsByActionCmd Remembers the window buttons associated with the menu items.
protected java.util.Hashtable<javax.swing.JToggleButton,DockingWindow>	cacheWindowByButton Maps the docking bar buttons and the associated window objects.
protected DockingManagerController	controller The MVC controller implementing the callbacks.
protected com.jgoodies.uif_lite.panel.SimpleInternalFrame	decoCenter
protected boolean	deiconify Auto-deiconify separate windows?
protected DockingCenterView	dockingCenterView Viewing component with center component.
protected DockingNonCenterView	dockingNonCenterView Viewing component without center component.
protected DockingCenter	dockingView Current viewing component.
protected boolean	exclusiveMode Flag for exclusive mode.
protected DockingWindow	exclusiveModeActive Remembers the previous active window when exclusive mode is entered (restored).
protected java.awt.event.WindowListener	frameListener Listener to monitor the main window state (auto-iconify etc.).
protected boolean	hideOnEscape Hide windows on ESCAPE?
protected boolean	iconify Auto-iconify separate windows?
protected java.util.Vector<ApplicationStateListener>	listeners Container holding the state listeners.
protected javax.swing.JMenu	menu Menu to associate with this component.
static int	MODE_DOCKING_EXCLUSIVE Represents the docking mode of windows (window in dock and exclusive).
static int	MODE_DOCKING_PINNED Represents the docking mode of windows (window in dock and pinned).
static int	MODE_DOCKING_UNPINNED Represents the docking mode of windows (window in dock and unpinned).
protected javax.swing.JPanel	panelBottom
protected javax.swing.JPanel	panelCenter
protected javax.swing.JPanel	panelLeft
protected javax.swing.JPanel	panelRight
protected javax.swing.JPanel	panelTop
protected javax.swing.JCheckBoxMenuItem	popupItemAutomatic Popup menu item.
protected javax.swing.JMenuItem	popupItemClose Popup menu item.
protected javax.swing.JCheckBoxMenuItem	popupItemExclusive Popup menu item.
protected javax.swing.JMenuItem	popupItemHide Popup menu item.
protected javax.swing.JMenuItem	popupItemMoveBottom Popup menu item.
protected javax.swing.JMenuItem	popupItemMoveLeft Popup menu item.
protected javax.swing.JMenuItem	popupItemMoveRight Popup menu item.
protected javax.swing.JMenuItem	popupItemMoveTop Popup menu item.
protected javax.swing.JCheckBoxMenuItem	popupItemPinned Popup menu item.
protected javax.swing.JMenuItem	popupItemShiftDown Popup menu item.
protected javax.swing.JMenuItem	popupItemShiftLeft Popup menu item.
protected javax.swing.JMenuItem	popupItemShiftRight Popup menu item.
protected javax.swing.JMenuItem	popupItemShiftUp Popup menu item.
protected javax.swing.JMenuItem	popupItemShow Popup menu item.
protected javax.swing.JCheckBoxMenuItem	popupItemUnpinned Popup menu item.
protected javax.swing.JCheckBoxMenuItem	popupItemWindow Popup menu item.
protected java.awt.event.MouseListener	popupListener Context menu for window buttons.
protected javax.swing.JPopupMenu	popupMenu Context menu for window buttons.
protected javax.swing.JMenu	popupMenuMove Popup menu.
protected java.util.Stack<javax.swing.JToggleButton>	stackBottom Remembers the sequence of opened docking windows (bottom position).
protected java.util.Stack<java.lang.String>	stackGlobal Remembers the ID sequence of opened docking windows to be restored.
protected java.util.Stack<javax.swing.JToggleButton>	stackLeft Remembers the sequence of opened docking windows (left position).
protected java.util.Stack<javax.swing.JToggleButton>	stackRight Remembers the sequence of opened docking windows (right position).
protected java.util.Stack<javax.swing.JToggleButton>	stackTop Remembers the sequence of opened docking windows (top position).
protected StatusBar	statusBar Application status bar if available.
protected java.awt.event.FocusListener	unpinnedListener Listener implementing the unpinned mode.
protected java.awt.Window	window The window hosting this docking manager.
protected int	windowCloseAction How to react if a separate window shall be closed.
protected java.awt.event.WindowFocusListener	windowListener Listener to (de)activate docking windows in separate windows.

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
DockingManager() Constructor for the GUI component.

Method Summary

Methods

Modifier and Type	Method and Description
void	activateObservation(java.awt.Component comp) Adds mouse listener recursively to docking window components.
void	activateObservation(DockingWindow window) Adds mouse listener recursively to docking window components.
void	addApplicationStateListener(ApplicationStateListener listener) Adds a listener reacting on application state changes.
javax.swing.JToggleButton	addWindow(DockingWindow window, int location) Adds a new window to be managed here.
boolean	canExit() Checks if the application can exit.
boolean	closeWindow(DockingWindow window) Closes the specified docking window if available.
void	deactivateObservation(java.awt.Component comp) Removes mouse listener recursively from docking window components.
void	deactivateObservation(DockingWindow window) Removes mouse listener recursively from docking window components.
void	doLayout() Causes this container to lay out its components.
protected void	finalize() Clean-up method to help the gc.
DockingWindow	findFirstBestWindow(java.lang.Class type) Determines the first-best instance of a certain kind currently installed.
DockingWindow	findFirstBestWindow(java.lang.String clazz) Determines the first-best instance of a certain kind currently installed.
DockingWindow[]	findWindows(java.lang.Class type) Determines the instances of a certain kind currently installed.
static DockingWindow[]	findWindows(java.awt.Component comp, java.lang.Class type) Determines the instances of a certain kind currently installed.
static DockingWindow[]	findWindows(java.awt.Component comp, java.lang.String clazz) Determines the instances of a certain kind currently installed.
DockingWindow[]	findWindows(java.lang.String clazz) Determines the instances of a certain kind currently installed.
DockingWindow	getActiveWindow() Provides the docking window currently being active (dock or separate window).
DockingWindow	getActiveWindowInDock() Provides the docking window currently being active in the dock.
DockingWindow[]	getAllWindows() Provides all windows currently managed by the manager.
DockingWindow[]	getAllWindows(int location) Provides the windows handled by the desired bar.
BackgroundTaskManager	getBackgroundTaskManager() Getter for background task manager.
java.lang.String[]	getPressedSequence() Gets the global opening sequence of docking windows to be restored on application restart.
DockingWindow[]	getSeparateWindows() Provides the docking windows in separate window mode (own frame).
StatusBar	getStatusBar() Provides the status bar of the application to print messages, progress etc.
protected DockingWindow	getWindow(java.lang.String id) Finds the docking window associated with the given ID.
static com.jgoodies.uif_lite.panel.SimpleInternalFrame	getWindowDecoration(DockingWindow window) Determines the decoration component (internal frame) for a specific docking window.
int	getWindowLocation(DockingWindow window) Determines the location of the specified docking window.
boolean	hideWindow(DockingWindow window) Hides the specified docking window if available and currently shown.
void	installDockingAccelerators(javax.swing.JFrame frame) Convenience to add the docking accelerators like "DELETE" also used for separate windows.
static boolean	isAutomatic(DockingWindow window) Checks whether the window may be controlled externally.
void	refresh() Updates the currently active docking window if available.
void	removeApplicationStateListener(ApplicationStateListener listener) Removes a listener reacting on application state changes.
void	removeWindow(DockingWindow window) Removes an existing window from the current location.
void	setActionManager(ActionManager manager) Sets the manager for the high-level shared actions
void	setActiveWindow(DockingWindow window) Updates the docking window decorations (enabled/disabled).
protected void	setActiveWindow(java.lang.String id) Updates the docking window decorations (enabled/disabled).
void	setCenterComponent(java.awt.Component comp) Sets the component to be displayed in the center region of the manager.
void	setDividerSize(int size) Adjusts the size of the dividers used for dragging.
void	setDockingAccelerators(javax.swing.JMenuItem[] accelitems) Provides the items holding the docking accelerators like "DELETE" also used for separate windows.
void	setMainWindowActions(boolean iconify, boolean deiconify) Configures if ESCAPE hides the docking windows.
void	setMenu(javax.swing.JMenu menu) Sets the menu representing the current docking windows.
void	setNonCenterBackgroundComponent(java.awt.Component comp) Sets the component to be displayed in the center region of the manager.
void	setParentWindow(java.awt.Window parent) Sets the top-level container this docking manager is displayed.
void	setPositions(java.lang.String[] windowIDs, int location) Tries to restore the given sorting of windows based on their unique identifiers.
void	setPressedSequence(java.lang.String[] sequence) Sets the global opening sequence of docking windows to be restored on application restart.
void	setStatusBar(StatusBar bar) Sets the status bar of the application to print messages, progress etc.
void	setWindowCloseAction(int closeaction) Configures if ESCAPE hides the docking windows.
void	setWindowCloseOnEscape(boolean enable) Configures if ESCAPE hides the docking windows.
boolean	showWindow(DockingWindow window) Shows the specified docking window if available.
boolean	showWindow(DockingWindow window, boolean show) Shows the specified docking window if available (only button becomes visible).
boolean	showWindowNonActive(DockingWindow window) Shows the specified docking window if available but it does not become the active window.
TaskDialog	startBackgroundTask(BackgroundTask bgtask, javax.swing.Icon icon, java.lang.String unitid, TaskDialogCustom comp) Adds a new task to be executed by the internal background task manager.
void	updateActionDelegate(DockingWindow window) Updates the action delegate for the active window.
void	updateBar(java.util.Stack stack) Updates the docking window hierarchy of a specific location after changes were applied.
void	updateButton(DockingWindow window) Let's the docking manager update the button associated with the given window.

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, 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

MODE_DOCKING_PINNED

public static final int MODE_DOCKING_PINNED

Represents the docking mode of windows (window in dock and pinned).

See Also:

Constant Field Values

MODE_DOCKING_UNPINNED

public static final int MODE_DOCKING_UNPINNED

Represents the docking mode of windows (window in dock and unpinned).

See Also:

Constant Field Values

MODE_DOCKING_EXCLUSIVE

public static final int MODE_DOCKING_EXCLUSIVE

Represents the docking mode of windows (window in dock and exclusive).

See Also:

Constant Field Values

cacheWindowByButton

protected java.util.Hashtable<javax.swing.JToggleButton,DockingWindow> cacheWindowByButton

Maps the docking bar buttons and the associated window objects.

stackTop

protected java.util.Stack<javax.swing.JToggleButton> stackTop

Remembers the sequence of opened docking windows (top position).

stackBottom

protected java.util.Stack<javax.swing.JToggleButton> stackBottom

Remembers the sequence of opened docking windows (bottom position).

stackLeft

protected java.util.Stack<javax.swing.JToggleButton> stackLeft

Remembers the sequence of opened docking windows (left position).

stackRight

protected java.util.Stack<javax.swing.JToggleButton> stackRight

Remembers the sequence of opened docking windows (right position).

stackGlobal

protected java.util.Stack<java.lang.String> stackGlobal

Remembers the ID sequence of opened docking windows to be restored.

menu

protected javax.swing.JMenu menu

Menu to associate with this component.

cacheButtonsByActionCmd

protected java.util.Hashtable<java.lang.String,javax.swing.JToggleButton> cacheButtonsByActionCmd

Remembers the window buttons associated with the menu items.

dockingView

protected DockingCenter dockingView

Current viewing component.

dockingCenterView

protected DockingCenterView dockingCenterView

Viewing component with center component.

dockingNonCenterView

protected DockingNonCenterView dockingNonCenterView

Viewing component without center component.

exclusiveMode

protected boolean exclusiveMode

Flag for exclusive mode.

exclusiveModeActive

protected DockingWindow exclusiveModeActive

Remembers the previous active window when exclusive mode is entered (restored).

popupListener

protected java.awt.event.MouseListener popupListener

Context menu for window buttons.

popupMenu

protected javax.swing.JPopupMenu popupMenu

Context menu for window buttons.

popupItemClose

protected javax.swing.JMenuItem popupItemClose

Popup menu item.

popupItemHide

protected javax.swing.JMenuItem popupItemHide

Popup menu item.

popupMenuMove

protected javax.swing.JMenu popupMenuMove

Popup menu.

popupItemMoveTop

protected javax.swing.JMenuItem popupItemMoveTop

Popup menu item.

popupItemMoveBottom

protected javax.swing.JMenuItem popupItemMoveBottom

Popup menu item.

popupItemMoveLeft

protected javax.swing.JMenuItem popupItemMoveLeft

Popup menu item.

popupItemMoveRight

protected javax.swing.JMenuItem popupItemMoveRight

Popup menu item.

popupItemShiftUp

protected javax.swing.JMenuItem popupItemShiftUp

Popup menu item.

popupItemShiftDown

protected javax.swing.JMenuItem popupItemShiftDown

Popup menu item.

popupItemShiftLeft

protected javax.swing.JMenuItem popupItemShiftLeft

Popup menu item.

popupItemShiftRight

protected javax.swing.JMenuItem popupItemShiftRight

Popup menu item.

popupItemShow

protected javax.swing.JMenuItem popupItemShow

Popup menu item.

popupItemPinned

protected javax.swing.JCheckBoxMenuItem popupItemPinned

Popup menu item.

popupItemUnpinned

protected javax.swing.JCheckBoxMenuItem popupItemUnpinned

Popup menu item.

popupItemExclusive

protected javax.swing.JCheckBoxMenuItem popupItemExclusive

Popup menu item.

popupItemWindow

protected javax.swing.JCheckBoxMenuItem popupItemWindow

Popup menu item.

popupItemAutomatic

protected javax.swing.JCheckBoxMenuItem popupItemAutomatic

Popup menu item.

statusBar

protected StatusBar statusBar

Application status bar if available.

bgTaskManager

protected BackgroundTaskManager bgTaskManager

Instance managing the background tasks.

unpinnedListener

protected java.awt.event.FocusListener unpinnedListener

Listener implementing the unpinned mode.

activeWindow

protected DockingWindow activeWindow

Remembers the currently active docking window (e.g. for refresh).

controller

protected DockingManagerController controller

The MVC controller implementing the callbacks.

actionManager

protected ActionManager actionManager

The manager for the high-level shared actions.

window

protected java.awt.Window window

The window hosting this docking manager.

windowListener

protected java.awt.event.WindowFocusListener windowListener

Listener to (de)activate docking windows in separate windows.

acceleratorItems

protected javax.swing.JMenuItem[] acceleratorItems

The items holding the docking accelerators like "DELETE" also used for separate windows.

hideOnEscape

protected boolean hideOnEscape

Hide windows on ESCAPE?

windowCloseAction

protected int windowCloseAction

How to react if a separate window shall be closed.

listeners

protected java.util.Vector<ApplicationStateListener> listeners

Container holding the state listeners.

iconify

protected boolean iconify

Auto-iconify separate windows?

deiconify

protected boolean deiconify

Auto-deiconify separate windows?

frameListener

protected java.awt.event.WindowListener frameListener

Listener to monitor the main window state (auto-iconify etc.).

panelTop

protected javax.swing.JPanel panelTop

panelLeft

protected javax.swing.JPanel panelLeft

panelRight

protected javax.swing.JPanel panelRight

panelBottom

protected javax.swing.JPanel panelBottom

panelCenter

protected javax.swing.JPanel panelCenter

decoCenter

protected com.jgoodies.uif_lite.panel.SimpleInternalFrame decoCenter

Constructor Detail

DockingManager

public DockingManager()

Constructor for the GUI component.

Since:

1.6

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Clean-up method to help the gc.

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable - Error indication

Since:

1.5

addWindow

public javax.swing.JToggleButton addWindow(DockingWindow window,
                                  int location)

Adds a new window to be managed here.

Parameters:

window - The window to be added

location - The location (TOP, BOTTOM, LEFT, RIGHT)

Returns:

The created button

Throws:

java.lang.NullPointerException - Error indication

Since:

1.5

activateObservation

public void activateObservation(DockingWindow window)

Adds mouse listener recursively to docking window components.

This is necessary to implement the unpinned functionality of docking windows. If a window uses components in the background which are made visible on the fly, this method must be called for the unpinned mode to work properly.

In addition to the mouse listener a focus listener is installed which enables the manager to properly react on focus changes of the docking windows. This is necessary to update the associated menu items on basis of the active component. Printing and refreshing are only possible if one of the docking windows has the focus.

Parameters:

window - The docking window

Since:

1.5

activateObservation

public void activateObservation(java.awt.Component comp)

Adds mouse listener recursively to docking window components.

This is necessary to implement the unpinned functionality of docking windows. If a window uses components in the background which are made visible on the fly, this method must be called for the unpinned mode to work properly.

In addition to the mouse listener a focus listener is installed which enables the manager to properly react on focus changes of the docking windows. This is necessary to update the associated menu items on basis of the active component. Printing and refreshing are only possible if one of the docking windows has the focus.

Parameters:

comp - The comp, recursed if it is a container

Since:

1.5

deactivateObservation

public void deactivateObservation(DockingWindow window)

Removes mouse listener recursively from docking window components.

Parameters:

window - The docking window

Since:

1.6

deactivateObservation

public void deactivateObservation(java.awt.Component comp)

Removes mouse listener recursively from docking window components.

Parameters:

comp - The comp, recursed if it is a container

Since:

1.6

getAllWindows

public DockingWindow[] getAllWindows(int location)

Provides the windows handled by the desired bar.

Returns all windows, not only the windows with pressed toggle buttons.

Parameters:

location - The location (TOP, BOTTOM, LEFT, RIGHT)

Returns:

The windows, may have zero-length

Throws:

java.lang.IllegalArgumentException - Error indication

Since:

1.6

setPositions

public void setPositions(java.lang.String[] windowIDs,
                int location)

Tries to restore the given sorting of windows based on their unique identifiers.

Parameters:

windowIDs - The sorting

location - The location (TOP, BOTTOM, LEFT, RIGHT)

Throws:

java.lang.IllegalArgumentException - Error indication

Since:

1.6

removeWindow

public void removeWindow(DockingWindow window)

Removes an existing window from the current location.

The window is removed completely. This means that is not part of the menu any longer and also no control button is shown by the docking manager. The state is the same before it was added.

Parameters:

window - The window to be removed

Throws:

java.lang.NullPointerException - Error indication

Since:

1.5

setCenterComponent

public void setCenterComponent(java.awt.Component comp)

Sets the component to be displayed in the center region of the manager.

This may be some kind of editor (IDEA) or a dummy component simpy showing a white canvas with a logo in the right bottom corner (JFormDesigner).

Parameters:

comp - The center component, null deactivates

Since:

1.6

setNonCenterBackgroundComponent

public void setNonCenterBackgroundComponent(java.awt.Component comp)

Sets the component to be displayed in the center region of the manager.

Remember that this component is only displayed if the docking manager is in non-center mode, and if no other docking window from the sides is currently showing! Normally you should not add a interactive component but some nice background filling graphics, animations, or other graphically compelling effects.

Parameters:

comp - The background component, null deactivates

Since:

1.6

setMenu

public void setMenu(javax.swing.JMenu menu)

Sets the menu representing the current docking windows.

Parameters:

menu - The menu reflecting the current docking windows

Throws:

java.lang.NullPointerException - If parameter is null

Since:

1.6

updateBar

public void updateBar(java.util.Stack stack)

Updates the docking window hierarchy of a specific location after changes were applied.

Parameters:

stack - The manipulated stack which shall be reflected

Since:

1.6

setDividerSize

public void setDividerSize(int size)

Adjusts the size of the dividers used for dragging.

Parameters:

size - The divider size

Since:

1.6

getAllWindows

public DockingWindow[] getAllWindows()

Provides all windows currently managed by the manager.

Returns:

The windows, maybe empty

Since:

1.6

getSeparateWindows

public DockingWindow[] getSeparateWindows()

Provides the docking windows in separate window mode (own frame).

Returns:

The windows, maybe empty

Since:

1.6

getWindowLocation

public int getWindowLocation(DockingWindow window)

Determines the location of the specified docking window.

Parameters:

window - The window to be displayed

Returns:

The location (TOP, BOTTOM, LEFT, RIGHT), -1 in error case

Since:

1.6

closeWindow

public boolean closeWindow(DockingWindow window)

Closes the specified docking window if available.

Closing causes the window button to be removed so that the window must be re-activated by using the corresponding menu item.

Parameters:

window - The desired docking window

Returns:

The docking manager or null if not available

Since:

1.6

showWindow

public boolean showWindow(DockingWindow window)

Shows the specified docking window if available.

Parameters:

window - The desired docking window

Returns:

Successful?

Since:

1.6

showWindow

public boolean showWindow(DockingWindow window,
                 boolean show)

Shows the specified docking window if available (only button becomes visible).

Parameters:

window - The desired docking window

show - Show the window (click button)?

Returns:

Successful?

Since:

1.6

showWindowNonActive

public boolean showWindowNonActive(DockingWindow window)

Shows the specified docking window if available but it does not become the active window.

This method should be used for depending windows like the search options which should only be made visible but does not influence the current focus.

Parameters:

window - The desired docking window

Returns:

Successful?

Since:

1.6

hideWindow

public boolean hideWindow(DockingWindow window)

Hides the specified docking window if available and currently shown.

Parameters:

window - The desired docking window

Returns:

The docking manager or null if not available

Since:

1.6

refresh

public void refresh()

Updates the currently active docking window if available.

Since:

1.6

getWindow

protected DockingWindow getWindow(java.lang.String id)

Finds the docking window associated with the given ID.

Parameters:

id - The ID of the docking window

Returns:

The window, null if not available

Throws:

java.lang.NullPointerException - If id is null

Since:

1.6

setActiveWindow

protected void setActiveWindow(java.lang.String id)

Updates the docking window decorations (enabled/disabled).

Parameters:

id - The ID of the active docking window, null if non is available

Since:

1.6

setActiveWindow

public void setActiveWindow(DockingWindow window)

Updates the docking window decorations (enabled/disabled).

Parameters:

window - The active docking window, null if non is available

Since:

1.6

getActiveWindow

public DockingWindow getActiveWindow()

Provides the docking window currently being active (dock or separate window).

Returns:

The active docking window, null if none is available

Since:

1.6

getActiveWindowInDock

public DockingWindow getActiveWindowInDock()

Provides the docking window currently being active in the dock.

Returns:

The active docking window, null if none is available

Since:

1.6

updateActionDelegate

public void updateActionDelegate(DockingWindow window)

Updates the action delegate for the active window.

This allows docking windows to activate different action delegates while being executed. Only the active window is asked to provide the new action delegate.

Parameters:

window - The window, active window if null

Since:

1.6

getWindowDecoration

public static com.jgoodies.uif_lite.panel.SimpleInternalFrame getWindowDecoration(DockingWindow window)

Determines the decoration component (internal frame) for a specific docking window.

Parameters:

window - The interesting docking window

Returns:

The docking window decoration component, null if non is available

Since:

1.6

setStatusBar

public void setStatusBar(StatusBar bar)

Sets the status bar of the application to print messages, progress etc.

Parameters:

bar - The application status bar, may be null

Since:

1.6

getStatusBar

public StatusBar getStatusBar()

Provides the status bar of the application to print messages, progress etc.

Returns:

The application status bar, null if not available

Since:

1.6

findWindows

public DockingWindow[] findWindows(java.lang.String clazz)

Determines the instances of a certain kind currently installed.

Parameters:

clazz - The window class type to be found

Returns:

The array with instances, may be empty

Throws:

java.lang.NullPointerException - Error indication

Since:

1.5

findFirstBestWindow

public DockingWindow findFirstBestWindow(java.lang.String clazz)

Determines the first-best instance of a certain kind currently installed.

Parameters:

clazz - The window class type to be found

Returns:

The instance, may be null

Throws:

java.lang.NullPointerException - Error indication

Since:

1.6

findWindows

public DockingWindow[] findWindows(java.lang.Class type)

Determines the instances of a certain kind currently installed.

Parameters:

type - The window class type to be found

Returns:

The array with instances, may be empty

Throws:

java.lang.NullPointerException - Error indication

Since:

1.5

findFirstBestWindow

public DockingWindow findFirstBestWindow(java.lang.Class type)

Determines the first-best instance of a certain kind currently installed.

Parameters:

type - The window class type to be found

Returns:

The instance, may be null

Throws:

java.lang.NullPointerException - Error indication

Since:

1.6

findWindows

public static DockingWindow[] findWindows(java.awt.Component comp,
                          java.lang.String clazz)

Determines the instances of a certain kind currently installed.

This variant finds the docking manager (nearest parent) in the component hierarchy and then searches for windows a the desired type.

Parameters:

comp - The managed component

clazz - The window class type to be found

Returns:

The array with instances, may be empty

Throws:

java.lang.NullPointerException - Error indication

Since:

1.5

findWindows

public static DockingWindow[] findWindows(java.awt.Component comp,
                          java.lang.Class type)

Determines the instances of a certain kind currently installed.

This variant finds the docking manager (nearest parent) in the component hierarchy and then searches for windows of the desired type.

Parameters:

comp - The child component

type - The window class type to be found

Returns:

The array with instances, may be empty

Throws:

java.lang.NullPointerException - Error indication

Since:

1.5

startBackgroundTask

public TaskDialog startBackgroundTask(BackgroundTask bgtask,
                             javax.swing.Icon icon,
                             java.lang.String unitid,
                             TaskDialogCustom comp)

Adds a new task to be executed by the internal background task manager.

The manager will create a dialog showing the current status of the task. If the monitor window TaskWindow was added by the application this is used to display the list of running background tasks. Then the user can choose whether to let the dialog finish the task or to execute it completely in the background so that the user can work simultaneously (e.g. downloading a file does not require the user to wait).

Parameters:

bgtask - The new task to be executed

icon - The icon to be displayed

unitid - The identifier for the configurable unit, use default if null

comp - The optional custom component, the preferred height should be set

Returns:

The task dialog, null if not displayed (background mode)

Throws:

java.lang.NullPointerException - Error indication

Since:

1.5

getBackgroundTaskManager

public BackgroundTaskManager getBackgroundTaskManager()

Getter for background task manager.

Returns:

The background task manager

Since:

1.6

doLayout

public void doLayout()

Causes this container to lay out its components.

Overrides:

doLayout in class java.awt.Container

Since:

1.6

setActionManager

public void setActionManager(ActionManager manager)

Sets the manager for the high-level shared actions

Parameters:

manager - The action manager

Since:

1.6

getPressedSequence

public java.lang.String[] getPressedSequence()

Gets the global opening sequence of docking windows to be restored on application restart.

Can be used by the WindowConfigurator class to restore the windows exactly as the user terminated the application. The window IDs can easily be stored persistently.

Returns:

The global opening sequence, may have zero-length

Since:

1.6

setPressedSequence

public void setPressedSequence(java.lang.String[] sequence)

Sets the global opening sequence of docking windows to be restored on application restart.

Can be used by the WindowConfigurator class to restore the windows exactly as the user terminated the application. The window IDs can easily be stored persistently.

Parameters:

sequence - The global opening sequence, may have zero-length

Since:

1.6

updateButton

public void updateButton(DockingWindow window)

Let's the docking manager update the button associated with the given window.

Can be called whenever a docking window changes its icon, text, or tooltip to be reflected.

Parameters:

window - The docking window

Since:

1.6

isAutomatic

public static boolean isAutomatic(DockingWindow window)

Checks whether the window may be controlled externally.

Parameters:

window - The docking window

Returns:

Automatic mode?

Since:

1.6

setDockingAccelerators

public void setDockingAccelerators(javax.swing.JMenuItem[] accelitems)

Provides the items holding the docking accelerators like "DELETE" also used for separate windows.

Parameters:

accelitems - The accelerators

Since:

1.6

installDockingAccelerators

public void installDockingAccelerators(javax.swing.JFrame frame)

Convenience to add the docking accelerators like "DELETE" also used for separate windows.

Parameters:

frame - The window

Since:

1.6

setParentWindow

public void setParentWindow(java.awt.Window parent)

Sets the top-level container this docking manager is displayed.

Here, a focus listener is added which restores the previous active docking window when the main window becomes the active window again.

Parameters:

parent - The parental window (dialog, frame, ...)

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

setWindowCloseOnEscape

public void setWindowCloseOnEscape(boolean enable)

Configures if ESCAPE hides the docking windows.

Parameters:

enable - Use ESCAPE?

Since:

1.6

setWindowCloseAction

public void setWindowCloseAction(int closeaction)

Configures if ESCAPE hides the docking windows.

Parameters:

closeaction - One of DockingUnit.CLOSE_DOCK_SHOW|...

Throws:

java.lang.IllegalArgumentException - If a parameter is invalid

Since:

1.6

addApplicationStateListener

public void addApplicationStateListener(ApplicationStateListener listener)

Adds a listener reacting on application state changes.

Parameters:

listener - The listener instance

Throws:

java.lang.NullPointerException - If parameter is null

Since:

1.6

removeApplicationStateListener

public void removeApplicationStateListener(ApplicationStateListener listener)

Removes a listener reacting on application state changes.

Parameters:

listener - The listener instance

Throws:

java.lang.NullPointerException - If parameter is null

Since:

1.6

canExit

public boolean canExit()

Checks if the application can exit.

If there is any pending data e.g. managed by docking windows the shutdown sequence can be stopped by returning false.

Returns:

Exit OK?

Since:

1.6

setMainWindowActions

public void setMainWindowActions(boolean iconify,
                        boolean deiconify)

Configures if ESCAPE hides the docking windows.

Parameters:

iconify - Auto-iconify separate windows?

deiconify - Auto-deiconify separate windows?

Since:

1.6