com.jidesoft.docking
Class DefaultDockableHolder

java.lang.Object
  java.awt.Component
      java.awt.Container
          java.awt.Window
              java.awt.Frame
                  javax.swing.JFrame
                      com.jidesoft.docking.DefaultDockableHolder

All Implemented Interfaces:

DockableHolder, ImageObserver, MenuContainer, Serializable, Accessible, RootPaneContainer, WindowConstants

Direct Known Subclasses:

DefaultDockableBarDockableHolder

public class DefaultDockableHolder
extends JFrame
implements DockableHolder

Default implementation of DockableHolder.

See Also:

Serialized Form

Nested Class Summary

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

JFrame.AccessibleJFrame

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

Frame.AccessibleAWTFrame

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

Window.AccessibleAWTWindow

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

Container.AccessibleAWTContainer

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

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

protected boolean	_autoDispose
protected JPanel	_contentContainer
protected DockingManager	_dockingManager

Fields inherited from class javax.swing.JFrame

accessibleContext, EXIT_ON_CLOSE, rootPane, rootPaneCheckingEnabled

Fields inherited from class java.awt.Frame

CROSSHAIR_CURSOR, DEFAULT_CURSOR, E_RESIZE_CURSOR, HAND_CURSOR, ICONIFIED, MAXIMIZED_BOTH, MAXIMIZED_HORIZ, MAXIMIZED_VERT, MOVE_CURSOR, N_RESIZE_CURSOR, NE_RESIZE_CURSOR, NORMAL, NW_RESIZE_CURSOR, S_RESIZE_CURSOR, SE_RESIZE_CURSOR, SW_RESIZE_CURSOR, TEXT_CURSOR, W_RESIZE_CURSOR, WAIT_CURSOR

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface javax.swing.WindowConstants

DISPOSE_ON_CLOSE, DO_NOTHING_ON_CLOSE, HIDE_ON_CLOSE

Fields inherited from interface java.awt.image.ImageObserver

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

Constructor Summary

DefaultDockableHolder()
Constructs a new DefaultDockableHolder that is initially invisible.

DefaultDockableHolder(GraphicsConfiguration gc)
Creates a DefaultDockableHolder in the specified GraphicsConfiguration of a screen device and a blank title.

DefaultDockableHolder(String title)
Creates a new, initially invisible DefaultDockableHolder with the specified title.

DefaultDockableHolder(String title, GraphicsConfiguration gc)
Creates a DefaultDockableHolder with the specified title and the specified GraphicsConfiguration of a screen device.

Method Summary

protected DockingManager	createDockingManager(Container contentContainer) Creates the docking manager.
void	dispose() Releases all of the native screen resources used by this Window, its subcomponents, and all of its owned children.
DockingManager	getDockingManager() Gets the default docking manager.
LayoutPersistence	getLayoutPersistence() Gets the layout persistence.
protected void	initFrame(Container container) Creates a content container and add it to CENTER of JFrame content pane.
boolean	isAutoDispose() Checks if the docking manager will be disposed when the JFrame is disposed.
protected boolean	isContentPaneCheckingEnabled()
void	setAutoDispose(boolean autoDispose) Sets the auto dispose flag.
protected void	setContentPaneCheckingEnabled(boolean contentPaneCheckingEnabled)

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, getJMenuBar, getLayeredPane, getRootPane, getTransferHandler, isDefaultLookAndFeelDecorated, isRootPaneCheckingEnabled, paramString, processWindowEvent, remove, repaint, setContentPane, setDefaultCloseOperation, setDefaultLookAndFeelDecorated, setGlassPane, setIconImage, setJMenuBar, setLayeredPane, setLayout, setRootPane, setRootPaneCheckingEnabled, setTransferHandler, update

Methods inherited from class java.awt.Frame

addNotify, getCursorType, getExtendedState, getFrames, getIconImage, getMaximizedBounds, getMenuBar, getState, getTitle, isResizable, isUndecorated, remove, removeNotify, setCursor, setExtendedState, setMaximizedBounds, setMenuBar, setResizable, setState, setTitle, setUndecorated

Methods inherited from class java.awt.Window

addPropertyChangeListener, addPropertyChangeListener, addWindowFocusListener, addWindowListener, addWindowStateListener, applyResourceBundle, applyResourceBundle, createBufferStrategy, createBufferStrategy, getBufferStrategy, getFocusableWindowState, getFocusCycleRootAncestor, getFocusOwner, getFocusTraversalKeys, getGraphicsConfiguration, getIconImages, getInputContext, getListeners, getLocale, getModalExclusionType, getMostRecentFocusOwner, getOwnedWindows, getOwner, getOwnerlessWindows, getToolkit, getWarningString, getWindowFocusListeners, getWindowListeners, getWindows, getWindowStateListeners, hide, isActive, isAlwaysOnTop, isAlwaysOnTopSupported, isFocusableWindow, isFocusCycleRoot, isFocused, isLocationByPlatform, isShowing, pack, paint, postEvent, processEvent, processWindowFocusEvent, processWindowStateEvent, removeWindowFocusListener, removeWindowListener, removeWindowStateListener, reshape, setAlwaysOnTop, setBounds, setBounds, setCursor, setFocusableWindowState, setFocusCycleRoot, setIconImages, setLocationByPlatform, setLocationRelativeTo, setMinimumSize, setModalExclusionType, setSize, setSize, setVisible, show, toBack, toFront

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalPolicy, getInsets, getLayout, getMaximumSize, getMinimumSize, getMousePosition, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, print, printComponents, processContainerEvent, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusTraversalKeys, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setFont, transferFocusBackward, 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, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, processMouseWheelEvent, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resize, resize, setBackground, setComponentOrientation, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setName, setPreferredSize, show, size, toString, transferFocus, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Field Detail

_dockingManager

protected DockingManager _dockingManager

_contentContainer

protected JPanel _contentContainer

_autoDispose

protected boolean _autoDispose

Constructor Detail

DefaultDockableHolder

public DefaultDockableHolder()
                      throws HeadlessException

Constructs a new DefaultDockableHolder that is initially invisible.

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

DefaultDockableHolder

public DefaultDockableHolder(GraphicsConfiguration gc)

Creates a DefaultDockableHolder in the specified GraphicsConfiguration of a screen device and a blank title.

Parameters:

gc - the GraphicsConfiguration that is used to construct the new JFrame with; if gc is null, the system default GraphicsConfiguration is assumed

DefaultDockableHolder

public DefaultDockableHolder(String title)
                      throws HeadlessException

Creates a new, initially invisible DefaultDockableHolder with the specified title.

Parameters:

title - the title to be displayed in the frame's border. A null value is treated as an empty string, "".

Throws:

HeadlessException - if GraphicsEnvironment.isHeadless() returns true.

DefaultDockableHolder

public DefaultDockableHolder(String title,
                             GraphicsConfiguration gc)

Creates a DefaultDockableHolder with the specified title and the specified GraphicsConfiguration of a screen device.

Parameters:

title - the title to be displayed in the frame's border. A null value is treated as an empty string, "".

gc - the GraphicsConfiguration that is used to construct the new JFrame with; if gc is null, the system default GraphicsConfiguration is assumed

Method Detail

initFrame

protected void initFrame(Container container)

Creates a content container and add it to CENTER of JFrame content pane. It will also create a default DockingManager.

Parameters:

container - the container where the docking manager is installed.

createDockingManager

protected DockingManager createDockingManager(Container contentContainer)

Creates the docking manager.

Parameters:

contentContainer - the container where the docking manager is installed.

Returns:

docking manager.

getDockingManager

public DockingManager getDockingManager()

Gets the default docking manager.

Specified by:

getDockingManager in interface DockableHolder

Returns:

docking manager.

getLayoutPersistence

public LayoutPersistence getLayoutPersistence()

Gets the layout persistence. In the case of DefaultDockableHolder, it's the same value that is returned from getDockingManager().

Returns:

layout persistence.

dispose

public void dispose()

Releases all of the native screen resources used by this Window, its subcomponents, and all of its owned children. That is, the resources for these Components will be destroyed, any memory they consume will be returned to the OS, and they will be marked as undisplayable.

The Window and its subcomponents can be made displayable again by rebuilding the native resources with a subsequent call to pack or show. The states of the recreated Window and its subcomponents will be identical to the states of these objects at the point where the Window was disposed (not accounting for additional modifications between those actions).

Overrides:

dispose in class Window

See Also:

Component.isDisplayable(), Window.pack(), Window.show()

isAutoDispose

public boolean isAutoDispose()

Checks if the docking manager will be disposed when the JFrame is disposed.

Returns:

true or false.

setAutoDispose

public void setAutoDispose(boolean autoDispose)

Sets the auto dispose flag. If true, the docking manager will be disposed when the JFrame is disposed.

Parameters:

autoDispose - true or false.

isContentPaneCheckingEnabled

protected boolean isContentPaneCheckingEnabled()

setContentPaneCheckingEnabled

protected void setContentPaneCheckingEnabled(boolean contentPaneCheckingEnabled)