com.jidesoft.action
Class DefaultDockableBarDockableHolder

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

All Implemented Interfaces:

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

public class DefaultDockableBarDockableHolder
extends DefaultDockableHolder
implements DockableBarDockableHolder

An implementation of JFrame which can support both DockableBars (of JIDE Action Framework) and DockableFrames (of JIDE Docking Framework).

If for some reason you can't use DefaultDockableBarDockableHolder, you will need to override getJMenuBar() method in your JFrame. See the code below. If you don't override this method, nothing will break seriously except you won't be able to use ALT key to activate the menu bar on Windows OS.

     public JMenuBar getJMenuBar() {
       if (getDockableBarManager() != null) {
           Collection col = getDockableBarManager().getAllDockableBars();
           for (Iterator iterator = col.iterator(); iterator.hasNext();) {
               DockableBar bar = (DockableBar) iterator.next();
               if (bar instanceof CommandBar && ((CommandBar) bar).isMenuBar()) {
                   return bar;
               }
           }
       }
       return super.getJMenuBar();
   }
 

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

Fields inherited from class com.jidesoft.docking.DefaultDockableHolder

_autoDispose, _contentContainer, _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

DefaultDockableBarDockableHolder()

DefaultDockableBarDockableHolder(GraphicsConfiguration gc)

DefaultDockableBarDockableHolder(String title)

DefaultDockableBarDockableHolder(String title, GraphicsConfiguration gc)

Method Summary

protected ContentContainer	createContentContainer()
protected DockableBarManager	createDockableBarManager(Container contentContainer)
void	dispose() Releases all of the native screen resources used by this Window, its subcomponents, and all of its owned children.
DockableBarManager	getDockableBarManager() Gets the default dockable bar manager.
JMenuBar	getJMenuBar() Override in DefaultDockableBarHolder to return the menu bar in DockableBarManager.
LayoutPersistence	getLayoutPersistence() Gets the layout persistence.
protected void	initFrame(Container container) Create a content container and add it to CENTER of JFrame content pane.

Methods inherited from class com.jidesoft.docking.DefaultDockableHolder

createDockingManager, getDockingManager, isAutoDispose, isContentPaneCheckingEnabled, setAutoDispose, setContentPaneCheckingEnabled

Methods inherited from class javax.swing.JFrame

addImpl, createRootPane, frameInit, getAccessibleContext, getContentPane, getDefaultCloseOperation, getGlassPane, getGraphics, 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 com.jidesoft.docking.DockableHolder

getDockingManager

Methods inherited from interface java.awt.MenuContainer

getFont, postEvent

Constructor Detail

DefaultDockableBarDockableHolder

public DefaultDockableBarDockableHolder()
                                 throws HeadlessException

Throws:

HeadlessException

DefaultDockableBarDockableHolder

public DefaultDockableBarDockableHolder(GraphicsConfiguration gc)

DefaultDockableBarDockableHolder

public DefaultDockableBarDockableHolder(String title)
                                 throws HeadlessException

Throws:

HeadlessException

DefaultDockableBarDockableHolder

public DefaultDockableBarDockableHolder(String title,
                                        GraphicsConfiguration gc)

Method Detail

initFrame

protected void initFrame(Container container)

Create a content container and add it to CENTER of JFrame content pane.

Overrides:

initFrame in class DefaultDockableHolder

Parameters:

container - the container where the docking manager is installed.

createDockableBarManager

protected DockableBarManager createDockableBarManager(Container contentContainer)

createContentContainer

protected ContentContainer createContentContainer()

getDockableBarManager

public DockableBarManager getDockableBarManager()

Gets the default dockable bar manager.

Specified by:

getDockableBarManager in interface DockableBarHolder

Returns:

dockable bar manager

getLayoutPersistence

public LayoutPersistence getLayoutPersistence()

Gets the layout persistence. In the case of DefaultDockableBarDockableHolder, it's an instance of LayoutPersistenceManager that manages both DockingManager and DockableBarManager.

Overrides:

getLayoutPersistence in class DefaultDockableHolder

Returns:

layout persistence.

getJMenuBar

public JMenuBar getJMenuBar()

Override in DefaultDockableBarHolder to return the menu bar in DockableBarManager.

Overrides:

getJMenuBar in class JFrame

Returns:

the menubar for this frame

dispose

public void dispose()

Description copied from class: DefaultDockableHolder

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 DefaultDockableHolder

See Also:

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