com.jidesoft.action
Interface DockableBarManager

All Superinterfaces:

LayoutPersistence, RootPanePersistence

All Known Implementing Classes:

DefaultDockableBarManager

public interface DockableBarManager
extends LayoutPersistence, RootPanePersistence

DockableBarManager is an interface that has all the necessary methods to manages DockableBars.

Methods in this interface can be categorized into the following categories.

• Add, remove, show, hide DockableBars.
• Save/load layout information to/from a persistent storage.
• Interactive with user allowing user to drag, dock, float, hide, or resize all DockableBars.

  See Also:

  DockableBar

  Field Summary

  static String	CLIENT_PROPERTY_SUPPRESS_CONTEXT_MENU
  static String	CONTEXT_MENU_FLOATABLE
  static String	CONTEXT_MENU_HIDABLE
  static String	CONTEXT_MENU_REARRANGABLE
  static int	DOUBLE_CLICK_NONE
  static int	DOUBLE_CLICK_TO_FLOAT

  Fields inherited from interface com.jidesoft.swing.LayoutPersistence

  ATTRIBUTE_PERSISTENCE_NAME, NODE_LAYOUT_PERSISTENCE

  Method Summary

  void	addDockableBar(DockableBar bar) Adds this dockable bar to DockableBarManager.
  void	addDockableBarsRearrangedListener(DockableBarsRearrangedListener l) Adds DockableBarsRearrangedListener to receive DockableBarsRearrangedEvents.
  void	beginDraggingDockableBar(JComponent f, int mouseX, int mouseY, double relativeX, double relativeY, boolean single) This method is normally called when the user has indicated that they will begin dragging a component around.
  void	beginResizingDockableBar(JComponent f, int direction) This methods is normally called when the user has indicated that they will begin resizing the dockable bar.
  DockableBarContainer	createDockableBarContainer() Creates the containers for DockableBars.
  FloatingDockableBarContainer	createFloatingDockableBarContainer(Window owner) Creates a window which contains the toolbar after it has been dragged out from its container
  void	dispose() Removes all used resources.
  void	dockDockableBar(DockableBar bar, int side, int row, boolean createNewRow, int start) Docks the dockable bar at the specified side and row.
  void	dragDockableBar(JComponent f, int newX, int newY, int mouseModifiers) The user has moved the dockable bar.
  void	endDraggingDockableBar() This method signals the end of the dragging session.
  void	endResizingDockableBar(JComponent f) This method signals the end of the resize session.
  void	floatDockableBar(DockableBar dockableBar, Rectangle bounds) Float the dockable bar.
  List<String>	getAllDockableBarNames() Gets a list of all the names of dockable bars.
  Collection<DockableBar>	getAllDockableBars() Gets a collection of all the dockable bars.
  JPopupMenu	getContextMenu() Gets the default context menu for DockableBarManager.
  DockableBar	getDockableBar(String key) Gets the dockable bar with the key.
  DockableBarContainer	getDockableBarContainer(int side) Gets the dockable bar container by side.
  DockableBarContext	getDockableBarContextOf(String barName) Gets the DockableBarContext of the dockable bar.
  DockableBarFactory	getDockableBarFactory() Gets the dockable bar factory.
  DockableBarPopupMenuCustomizer	getDockableBarPopupMenuCustomizer() Gets the popup menu customizer for DockableBar.
  DockableBarsRearrangedListener[]	getDockableBarsRearrangedListeners() Returns an array of all the DockableBarsRearrangedListeners added to this DockableBarManager with addDockableBarsRearrangedListener.
  int	getDoubleClickAction() Gets the action when user double clicks on the title bar of a dockable bar.
  Rectangle	getInitBounds() Gets initial bounds of the main frame.
  int	getInitState() Gets initial state of the main frame.
  MainContainer	getMainContainer() Gets the main container.
  RootPaneContainer	getRootPaneContainer() Gets root pane container.
  void	hideDockableBar(String key) Hides the dockable bar with the specified key.
  boolean	isFloatable() Return true if floating is allowed for dockable dockable bars.
  boolean	isHidable() Return true if floating is allowed for dockable dockable bars.
  boolean	isHideFloatingDockableBarsWhenDeactivate() Checks if the floating dockable bars should be hidden automatically when the main frame is deactivated.
  boolean	isRearrangable() If the dockable bars can be rearranged.
  boolean	isShowContextMenu() Checks if the context menu should be shown.
  boolean	isShowInitial() A client may specify that the docking layout is to be initialized without showing the window.
  boolean	isUseGlassPaneEnabled() Checks if we will use glass pane to change cursor.
  void	pauseDragDockableBar() Pause the dragging session of a dockable bar.
  void	removeAllDockableBars() Removes all dockable bars from this DockableBarManager.
  void	removeDockableBar(String key) Removes this dockable bar from DockableBarManager.
  void	removeDockableBarsRearrangedListener(DockableBarsRearrangedListener l) Removes the specified DockableBarsRearrangedListener so that it no longer receives DockableBarsRearrangedEvents from this DockableBarManager.
  void	removeExtraContexts() Removes extra DockableBarContexts that is saved in cache but the corresponding dockable bars are not in DockableBarManager anymore.
  void	removeFromHiddenDockableBars(String name) Removes a dockable bar from the hidden dockable bar list.
  void	resizingDockableBar(JComponent f, int newX, int newY, int newWidth, int newHeight, int deltaX, int deltaY) The user has resized the component.
  void	setDockableBarAvailable(String key) Makes the dockable bar available.
  void	setDockableBarFactory(DockableBarFactory dockableBarFactory) Sets the dockable bar factory.
  void	setDockableBarPopupMenuCustomizer(DockableBarPopupMenuCustomizer customizer) Sets the popup customizer for DockableBar.
  void	setDockableBarUnavailable(String key) Makes the bar unavailable.
  void	setDoubleClickAction(int doubleClickAction) Sets the action when user double clicks on the title bar of a dockable bar.
  void	setFloatable(boolean floatable) Enable or disable floating of dockable dockable bars
  void	setFloatingDockableBarsVisible(boolean show) Sets all floating dockable bar visible or invisible.
  void	setHidable(boolean hidable) Enable or disable floating of dockable dockable bars
  void	setHideFloatingDockableBarsWhenDeactivate(boolean hideFloatingDockableBarsWhenDeactivate) Sets if the floating dockable bars should be hidden automatically when the main frame is deactivated.
  void	setInitBounds(Rectangle initBounds) Sets the initial bounds of the main frame.
  void	setInitState(int initState) Sets the initial state of the main frame.
  void	setRearrangable(boolean rearrangeable) Enable or disable the rearrangement of dockable bars.
  void	setShowContextMenu(boolean showContextMenu) Sets the flag to show context menu or not.
  void	setShowInitial(boolean value) A client may specify that the docking layout is to be initialized without showing the window.
  void	setUseGlassPaneEnabled(boolean useGlassPaneEnabled) Enables us to use glass pane to for cursor change purpose.
  void	showContextMenu(MouseEvent e, Component component) Show context menu of dockable bar or dockable bar container.
  void	showDockableBar(String key) Shows the dockable bar with the specified key.
  void	showInitial() A client may specify that the docking layout is to be initialized without showing the window.
  void	switchRootPaneContainer(RootPaneContainer rootContainer) Change the root pane container.
  void	toggleState(DockableBar bar) Toggle the dockable bar's state.
  void	toggleState(String key) Toggle the dockable bar's state.
  void	updateComponentTreeUI() Call this method with LookAndFeel changes.

  Methods inherited from interface com.jidesoft.swing.LayoutPersistence

  beginLoadLayoutData, getAvailableLayouts, getLayoutDirectory, getLayoutPersistenceName, getLayoutRawData, getLoadCallback, getSaveCallback, getVersion, getXmlEncoding, isLast, isLayoutAvailable, isLayoutDataVersionValid, isLoadDataSuccessful, isNeedFormatCheck, isXmlFormat, loadInitialLayout, loadInitialLayout, loadInitialLayout, loadLayoutData, loadLayoutDataFrom, loadLayoutDataFromFile, loadLayoutFrom, loadLayoutFrom, removeLayout, resetToDefault, saveLayoutData, saveLayoutDataAs, saveLayoutDataToFile, saveLayoutTo, saveLayoutTo, setLast, setLayoutDirectory, setLayoutPersistenceName, setLayoutRawData, setLoadCallback, setNeedFormatCheck, setProfileKey, setSaveCallback, setUseFrameBounds, setUseFrameState, setUsePref, setVersion, setXmlEncoding, setXmlFormat

  Field Detail

  CONTEXT_MENU_REARRANGABLE

  static final String CONTEXT_MENU_REARRANGABLE

  See Also:

  Constant Field Values

  CONTEXT_MENU_HIDABLE

  static final String CONTEXT_MENU_HIDABLE

  See Also:

  Constant Field Values

  CONTEXT_MENU_FLOATABLE

  static final String CONTEXT_MENU_FLOATABLE

  See Also:

  Constant Field Values

  CLIENT_PROPERTY_SUPPRESS_CONTEXT_MENU

  static final String CLIENT_PROPERTY_SUPPRESS_CONTEXT_MENU

  See Also:

  Constant Field Values

  DOUBLE_CLICK_NONE

  static final int DOUBLE_CLICK_NONE

  See Also:

  Constant Field Values

  DOUBLE_CLICK_TO_FLOAT

  static final int DOUBLE_CLICK_TO_FLOAT

  See Also:

  Constant Field Values

  Method Detail

  addDockableBar

  void addDockableBar(DockableBar bar)

  Adds this dockable bar to DockableBarManager.

  Parameters:

  bar - dockable bar to be added

  removeDockableBar

  void removeDockableBar(String key)

  Removes this dockable bar from DockableBarManager.

  Parameters:

  key - key of dockable bar to be removed

  removeAllDockableBars

  void removeAllDockableBars()

  Removes all dockable bars from this DockableBarManager.

  removeExtraContexts

  void removeExtraContexts()

  Removes extra DockableBarContexts that is saved in cache but the corresponding dockable bars are not in DockableBarManager anymore.

  getDockableBar

  DockableBar getDockableBar(String key)

  Gets the dockable bar with the key.

  Parameters:

  key -

  Returns:

  dockable bar which has the key

  showDockableBar

  void showDockableBar(String key)

  Shows the dockable bar with the specified key.

  Parameters:

  key - the key of dockable bar to be shown

  hideDockableBar

  void hideDockableBar(String key)

  Hides the dockable bar with the specified key.

  Parameters:

  key - the key of dockable bar to be hidden

  beginDraggingDockableBar

  void beginDraggingDockableBar(JComponent f,
                                int mouseX,
                                int mouseY,
                                double relativeX,
                                double relativeY,
                                boolean single)

  This method is normally called when the user has indicated that they will begin dragging a component around. This method should be called prior to any dragDockableBar() calls to allow the DockableBarManager to prepare. Normally f will be a DockableBar.

  Parameters:

  f - a component to be dragged

  mouseX - mouse screen location on X direction

  mouseY - mouse screen location on Y direction

  relativeX - percentage location of mouse to the component on X direction

  relativeY - percentage location of mouse to the component on Y direction

  single - drag just one dockable bar or all dockable bars in tabs

  dragDockableBar

  void dragDockableBar(JComponent f,
                       int newX,
                       int newY,
                       int mouseModifiers)

  The user has moved the dockable bar. Calls to this method will be preceded by calls to beginDraggingDockableBar(). Normally f will be a DockableBar.

  Parameters:

  f - component to be dragged

  newX - new mouse location on X direction

  newY - new mouse location on Y direction

  mouseModifiers - mouse modifiers from MouseEvent when dragging

  pauseDragDockableBar

  void pauseDragDockableBar()

  Pause the dragging session of a dockable bar. It simply hide any indication of it's being dragging. dragDockableBar will automatically resume the dragging session.

  endDraggingDockableBar

  void endDraggingDockableBar()

  This method signals the end of the dragging session. Any state maintained by the DockableBarManager can be removed here. Normally f will be a DockableBar.

  beginResizingDockableBar

  void beginResizingDockableBar(JComponent f,
                                int direction)

  This methods is normally called when the user has indicated that they will begin resizing the dockable bar. This method should be called prior to any resizeDockableBar() calls to allow the DockableBarManager to prepare. Normally f will be a DockableBar.

  resizingDockableBar

  void resizingDockableBar(JComponent f,
                           int newX,
                           int newY,
                           int newWidth,
                           int newHeight,
                           int deltaX,
                           int deltaY)

  The user has resized the component. Calls to this method will be preceded by calls to beginResizingDockableBar(). Normally f will be a DockableBar.

  endResizingDockableBar

  void endResizingDockableBar(JComponent f)

  This method signals the end of the resize session. Any state maintained by the DockableBarManager can be removed here. Normally f will be a DockableBar.

  getRootPaneContainer

  RootPaneContainer getRootPaneContainer()

  Gets root pane container. Root pane container is the JFrame, JWindow, JDialog or JApplet where this manager is installed to.

  Specified by:

  getRootPaneContainer in interface RootPanePersistence

  Returns:

  root pane container

  getMainContainer

  MainContainer getMainContainer()

  Gets the main container. Main container is the container that is in the center of content container except dockable bars.

  Returns:

  main container

  toggleState

  void toggleState(String key)

  Toggle the dockable bar's state. If it's docked, change to floating mode; if it's floating, change to docked mode.

  Parameters:

  key - the key of the dockable bar to toggle state.

  toggleState

  void toggleState(DockableBar bar)

  Toggle the dockable bar's state. If it's docked, change to floating mode; if it's floating, change to docked mode.

  Parameters:

  bar - the dockable bar to toggle state

  isRearrangable

  boolean isRearrangable()

  If the dockable bars can be rearranged.

  Returns:

  Return true if the dockable bars can be rearranged by user.

  setRearrangable

  void setRearrangable(boolean rearrangeable)

  Enable or disable the rearrangement of dockable bars. It will enable or disable all dockable bar.

  Parameters:

  rearrangeable - true if the dockable bars can be rearranged by user.

  isFloatable

  boolean isFloatable()

  Return true if floating is allowed for dockable dockable bars.

  Returns:

  true if floating is allowed

  setFloatable

  void setFloatable(boolean floatable)

  Enable or disable floating of dockable dockable bars

  Parameters:

  floatable -

  isHidable

  boolean isHidable()

  Return true if floating is allowed for dockable dockable bars.

  Returns:

  true if floating is allowed

  setHidable

  void setHidable(boolean hidable)

  Enable or disable floating of dockable dockable bars

  Parameters:

  hidable -

  updateComponentTreeUI

  void updateComponentTreeUI()

  Call this method with LookAndFeel changes.

  getAllDockableBars

  Collection<DockableBar> getAllDockableBars()

  Gets a collection of all the dockable bars. The order of dockable bar in this collection is unpredictable. If you want to get them in the order of being added, use getAllDockableBarNames().

  Returns:

  the collection of all dockable bars

  See Also:

  getAllDockableBarNames()

  getAllDockableBarNames

  List<String> getAllDockableBarNames()

  Gets a list of all the names of dockable bars. You can call getDockableBar(name) to Gets the actual dockable bar. The order of dockable bar name in this list is the same order as they were added. If you want to get all dockable bars and doesn't matter the order, you can use getAllDockableBars().

  Returns:

  the list of all dockable bars

  getDockableBarPopupMenuCustomizer

  DockableBarPopupMenuCustomizer getDockableBarPopupMenuCustomizer()

  Gets the popup menu customizer for DockableBar. When user right clicks on the dockable bar or empty spaces among dockable bar, a popup menu will be shown to allow user hide/show each dockable bars. However if you want to add additional menu items to this popup menu, you can use this customizer to do it.

  Returns:

  popup menu customizer.

  See Also:

  setDockableBarPopupMenuCustomizer(DockableBarPopupMenuCustomizer)

  setDockableBarPopupMenuCustomizer

  void setDockableBarPopupMenuCustomizer(DockableBarPopupMenuCustomizer customizer)

  Sets the popup customizer for DockableBar.

  Parameters:

  customizer -

  See Also:

  getDockableBarPopupMenuCustomizer()

  showContextMenu

  void showContextMenu(MouseEvent e,
                       Component component)

  Show context menu of dockable bar or dockable bar container.

  Parameters:

  e - source of the event

  component - dockable bar or dockable bar container

  floatDockableBar

  void floatDockableBar(DockableBar dockableBar,
                        Rectangle bounds)

  Float the dockable bar.

  Parameters:

  dockableBar - dockable bar to be floated

  bounds - the bounds of float dockable bar

  dockDockableBar

  void dockDockableBar(DockableBar bar,
                       int side,
                       int row,
                       boolean createNewRow,
                       int start)

  Docks the dockable bar at the specified side and row.

  Parameters:

  bar - the dockable bar to be docked

  side - four possible sides

  row - the row index

  createNewRow - true to create a new row at the specified row index. Otherwise uses the existing row.

  start - the starting position, in pixels.

  getDockableBarContainer

  DockableBarContainer getDockableBarContainer(int side)

  Gets the dockable bar container by side.

  Parameters:

  side -

  Returns:

  dockable bar container

  createDockableBarContainer

  DockableBarContainer createDockableBarContainer()

  Creates the containers for DockableBars.

  Returns:

  the DockableBarContainer.

  getInitBounds

  Rectangle getInitBounds()

  Gets initial bounds of the main frame.

  Returns:

  initial bounds

  setInitBounds

  void setInitBounds(Rectangle initBounds)

  Sets the initial bounds of the main frame.

  Parameters:

  initBounds -

  getInitState

  int getInitState()

  Gets initial state of the main frame. State could be the states that are specified in Frame.getExtendedState().

  Returns:

  the initial state

  setInitState

  void setInitState(int initState)

  Sets the initial state of the main frame. State can be the states that are specified in Frame.getExtendedState().

  Parameters:

  initState - the initial state

  dispose

  void dispose()

  Removes all used resources.

  getDockableBarContextOf

  DockableBarContext getDockableBarContextOf(String barName)

  Gets the DockableBarContext of the dockable bar.

  Parameters:

  barName -

  Returns:

  the DockableBarContext.

  removeFromHiddenDockableBars

  void removeFromHiddenDockableBars(String name)

  Removes a dockable bar from the hidden dockable bar list.

  Parameters:

  name -

  setFloatingDockableBarsVisible

  void setFloatingDockableBarsVisible(boolean show)

  Sets all floating dockable bar visible or invisible.

  Parameters:

  show -

  switchRootPaneContainer

  void switchRootPaneContainer(RootPaneContainer rootContainer)

  Change the root pane container. The root pane container is set as a parameter in constructor of DockableBarManager. However if the content container is moved to another root pane container, you need to call this method to let DockableBarManager know the change.

  We suggest you call saveLayout to a known location before calling this method, then call loadLayout to load the saved layout back after calling to switchRootPaneContainer to make sure dockable dockable bars are laid out correctly in the new root pane container.

  Parameters:

  rootContainer -

  setShowInitial

  void setShowInitial(boolean value)

  A client may specify that the docking layout is to be initialized without showing the window. In this case, the client is responsible for calling showInitial() the first time the window is to be shown.

  Default is true, show the window at the end of initial layout.

  Parameters:

  value -

  isShowInitial

  boolean isShowInitial()

  A client may specify that the docking layout is to be initialized without showing the window. In this case, the client is responsible for calling showInitial() the first time the window is to be shown.

  showInitial

  void showInitial()

  A client may specify that the docking layout is to be initialized without showing the window. In this case, the client is responsible for calling showInitial() the first time the window is to be shown.

  isHideFloatingDockableBarsWhenDeactivate

  boolean isHideFloatingDockableBarsWhenDeactivate()

  Checks if the floating dockable bars should be hidden automatically when the main frame is deactivated.

  Returns:

  true if the floating dockable bars are hidden automatically when the main frame is deactivated.

  setHideFloatingDockableBarsWhenDeactivate

  void setHideFloatingDockableBarsWhenDeactivate(boolean hideFloatingDockableBarsWhenDeactivate)

  Sets if the floating dockable bars should be hidden automatically when the main frame is deactivated.

  Parameters:

  hideFloatingDockableBarsWhenDeactivate -

  isShowContextMenu

  boolean isShowContextMenu()

  Checks if the context menu should be shown.

  Returns:

  true if context menu will be shown. Otherwise false.

  setShowContextMenu

  void setShowContextMenu(boolean showContextMenu)

  Sets the flag to show context menu or not.

  Parameters:

  showContextMenu -

  addDockableBarsRearrangedListener

  void addDockableBarsRearrangedListener(DockableBarsRearrangedListener l)

  Adds DockableBarsRearrangedListener to receive DockableBarsRearrangedEvents.

  Parameters:

  l -

  removeDockableBarsRearrangedListener

  void removeDockableBarsRearrangedListener(DockableBarsRearrangedListener l)

  Removes the specified DockableBarsRearrangedListener so that it no longer receives DockableBarsRearrangedEvents from this DockableBarManager.

  Parameters:

  l - the DockableBarsRearrangedListener

  getDockableBarsRearrangedListeners

  DockableBarsRearrangedListener[] getDockableBarsRearrangedListeners()

  Returns an array of all the DockableBarsRearrangedListeners added to this DockableBarManager with addDockableBarsRearrangedListener.

  Returns:

  all of the DockableBarsRearrangedListeners added or an empty array if no listeners have been added

  Since:

  1.4

  See Also:

  addDockableBarsRearrangedListener(com.jidesoft.action.event.DockableBarsRearrangedListener)

  getDockableBarFactory

  DockableBarFactory getDockableBarFactory()

  Gets the dockable bar factory. The factory is used in loadInitialLayout() method. If the dockable bar exists in initial layout but not added to DockingManager, the factory will be used to create the dockable bar.

  Returns:

  the dockable bar factory.

  setDockableBarFactory

  void setDockableBarFactory(DockableBarFactory dockableBarFactory)

  Sets the dockable bar factory.

  Parameters:

  dockableBarFactory -

  getContextMenu

  JPopupMenu getContextMenu()

  Gets the default context menu for DockableBarManager. The menu has menu items to show/hide any dockable bar and changes options such as rearrangeable, hidable and floatable.

  Returns:

  the default context menu.

  createFloatingDockableBarContainer

  FloatingDockableBarContainer createFloatingDockableBarContainer(Window owner)

  Creates a window which contains the toolbar after it has been dragged out from its container

  Parameters:

  owner - the owner of the FloatingDockableBarContainer.

  Returns:

  a FloatingDockableBarContainer object, containing the toolbar.

  isUseGlassPaneEnabled

  boolean isUseGlassPaneEnabled()

  Checks if we will use glass pane to change cursor.

  Returns:

  true or false.

  setUseGlassPaneEnabled

  void setUseGlassPaneEnabled(boolean useGlassPaneEnabled)

  Enables us to use glass pane to for cursor change purpose.

  Parameters:

  useGlassPaneEnabled -

  setDockableBarAvailable

  void setDockableBarAvailable(String key)

  Makes the dockable bar available.

  Usually all dockable bars are added to DockableBarManager when application is started. However some dockable bars may only be available under certain context. For example, palette toolbar should only be available when editing a GUI form. In this case, you can set the palette to available when GUI form is active. Or else, set it to unavailable.

  Set the bar available will restore the last state of the bar when it is set to unavailable.

  Parameters:

  key - key of dockable bar

  setDockableBarUnavailable

  void setDockableBarUnavailable(String key)

  Makes the bar unavailable.

  Usually all dockable bars are added to DockableBarManager when application is started. However some bars may only be available under certain context. For example, palette bar should only be available when editing a GUI form. In this case, you can set the palette to available when GUI form is active. Or else, set it to unavailable.

  Set the bar unavailable will hide the dockable bar no matter what state it is. However the state will be remembered so that when later it was set to available, that state will be restored. When bar is unavailable, operations to that dockable bar such as showDockableBar, hideDockableBar, etc, will have no effect.

  Please note, the available/unavailable flag will not be saved into the layout file. As a matter of fact, all bars will become available so that their previous position can be saved precisely. So whenever you call saveLayoutData methods, you need to make those bars unavailable again.

  Parameters:

  key - key of dockable bar

  getDoubleClickAction

  int getDoubleClickAction()

  Gets the action when user double clicks on the title bar of a dockable bar. It could be either DOUBLE_CLICK_TO_FLOAT by default or DOUBLE_CLICK_NONE if you don't want to have any action associated with double click.

  Returns:

  the action of double click on title bar.

  setDoubleClickAction

  void setDoubleClickAction(int doubleClickAction)

  Sets the action when user double clicks on the title bar of a dockable bar.

  Parameters:

  doubleClickAction - either DOUBLE_CLICK_TO_FLOAT or DOUBLE_CLICK_NONE.