MultiViewWindow (Commons)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - com.lf.commons.docking.multiview.MultiViewWindow

All Implemented Interfaces:

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

Direct Known Subclasses:

MultiViewOptionsWindow
```
public abstract class MultiViewWindow
extends javax.swing.JPanel
implements DockingWindow, ActionDelegate, ConfigurableUnit
```
Docking window base class for polymorphic windows using the card layout.
Many of the commons docking windows like MultiViewOptionsWindow are subclasses since the functionality is very multipurpose. The overall layout can be switched programmatically to enable multi view windows for all available positions within the docking manager (left, right, top, bottom, center). This window type is called polymorphic since it changes its content dynamically (here: if the master docking window is activated). The CardLayout allows developers to add multiple components being placed at the same position. One component is declared to be the active one and will be displayed automatically.

Since:

1.6

Version:

$Revision: 1.17 $, $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 java.util.Hashtable<java.lang.String,WindowView>`	`cacheViewByID` Remembers the view IDs.
`protected int`	`counter` Counter for unique IDs.
`protected java.lang.String`	`helpID` Help system ID from the application (must be delegated).
`protected int`	`orientation` The orientation of the components (use `SwingConstants.HORIZONTAL` (default) or `SwingConstants.VERTICAL`).
`protected WindowParamDef`	`windowParams` Data holder for the docking window parameters.

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

MultiViewWindow()
Constructor for the GUI component.

Constructors
Constructor and Description
`MultiViewWindow()` Constructor for the GUI component.

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`addView(WindowView view)` Adds a new view for the multi view pane.
`void`	`configureUnit(java.lang.String id, Configuration config)` Restores values from persistent data stores.
`protected void`	`finalize()` Clean-up method to help the gc.
`WindowView`	`findView(java.lang.Class type)` Provides the first-best parental view for a certain view class.
`WindowView`	`findView(java.awt.Component comp)` Provides the parental view for a component.
`WindowView`	`findView(java.lang.String id)` Provides the parental view for a certain view identifier.
`ActionDelegate`	`getActionDelegate()` Provides the optional action delegate responsible for shared buttons and menu items.
`java.awt.Component`	`getComponent()` Provides the component to be displayed in the center of the docking manager.
`DockingManager`	`getDockingManager()` Provides the docking manager specified when `windowAdded()` was called.
`javax.swing.ImageIcon`	`getIcon()` Provides the graphical icon of the window used for display.
`java.lang.String`	`getID()` Provides the identifier for the window.
`int`	`getMode()` Provides the mode the the window is presented.
`int`	`getPreferredHeight()` Provides the preferred height of the component for TOP and BOTTOM locations.
`int`	`getPreferredWidth()` Provides the preferred width of the component for LEFT and RIGHT locations.
`boolean`	`getShowButtons()` Provides the visibility of the buttons on the left side of the component.
`java.lang.String[]`	`getSupportedActions()` Provides the supported shared actions for this delegate.
`java.lang.String`	`getTitle()` Provides the title of the window used for display.
`java.lang.String`	`getToolTip()` Provides the tooltip of the window used for display.
`WindowView`	`getVisibleView()` Provides the multi view pane selection (view).
`java.lang.String`	`getVisibleViewID()` Provides the multi view pane selection (view ID).
`int`	`getWindowHeight()` Provides the height when in window mode.
`int`	`getWindowLocation()` Provides the last location of the window passed to the `windowxxx()` methods.
`int`	`getWindowLocationX()` Provides the location on the x-axis when in window mode.
`int`	`getWindowLocationY()` Provides the location on the y-axis when in window mode.
`int`	`getWindowState()` Provides the state (iconified etc.) when in window mode.
`int`	`getWindowWidth()` Provides the width when in window mode.
`boolean`	`isAutomatic()` Provides if the window may be controlled externally.
`boolean`	`isButtonPressed()` Provides the info whether the window is showing or not (hidden).
`boolean`	`isButtonVisible()` Provides the info whether the control button is visible or not.
`boolean`	`isGrowing()` Provides if the window fills the location completely.
`boolean`	`isWindowMode()` Provides the info whether the window is being displayed as separate window.
`boolean`	`isWindowVisible()` Provides if the window is currently being shown.
`void`	`processAction(SharedAction action)` Indicates that the given action was initiated and must be processed.
`void`	`refresh()` Updates the contents of the docking window.
`WindowView`	`removeView(java.lang.String id)` Removes a view from the multi view pane.
`WindowView`	`removeView(WindowView view)` Removes a view from the multi view pane.
`void`	`setAutomatic(boolean enable)` Sets if the window may be controlled externally.
`void`	`setButtonPressed(boolean pressed)` Sets the info whether the window is showing or not (hidden).
`void`	`setButtonVisible(boolean visible)` Sets the info whether the control button is visible or not.
`void`	`setGrowing(boolean enable)` Sets if the window fills the location completely.
`void`	`setHelpID(java.lang.String helpid)` Sets the identifier for the context sensitive help (must be delegated).
`void`	`setID(java.lang.String id)` Sets the identifier for the window.
`void`	`setMode(int mode)` Sets the mode the the window is presented.
`void`	`setOrientation(int layout)` Sets the window layout to either horizontal or vertical.
`void`	`setPreferredHeight(int height)` Sets the preferred height of the component for TOP and BOTTOM locations.
`void`	`setPreferredWidth(int width)` Sets the preferred width of the component for LEFT and RIGHT locations.
`void`	`setShowButtons(boolean show)` Sets the visibility of the buttons on the left side of the component.
`void`	`setVisibleView(java.awt.Component comp)` Provides the multi view pane selection (view).
`void`	`setVisibleView(java.lang.String id)` Provides the multi view pane selection (view).
`void`	`setWindowHeight(int height)` Sets the height when in window mode.
`void`	`setWindowLocationX(int locx)` Sets the location on the x-axis when in window mode.
`void`	`setWindowLocationY(int locy)` Sets the location on the y-axis when in window mode.
`void`	`setWindowMode(boolean enable)` Sets the info whether the window is being displayed as separate window.
`void`	`setWindowState(int state)` Sets the state (iconified etc.) when in window mode.
`void`	`setWindowVisible(boolean visible)` Sets the state if the window is currently being shown.
`void`	`setWindowWidth(int width)` Sets the width when in window mode.
`void`	`startControl(SharedAction[] actions)` Provides the info that the given shared actions must now be controlled.
`void`	`stopControl()` Provides the info that the control of the given shared actions must be stopped.
`void`	`storeUnit(java.lang.String id, Configuration config)` Stores the current configuration values persistently.
`void`	`unitRegistered(ApplicationModel model, java.lang.String id)` Informs the configurable unit that it was registered with a model.
`void`	`unitUnregistered(ApplicationModel model, java.lang.String id)` Informs the configurable unit that it was unregistered with a model.
`void`	`windowAdded(DockingManager manager, int location)` Informs the docking window that it was added by the manager.
`void`	`windowBecomesHidden(int location)` Informs the docking window that it will be made invisible by the manager.
`void`	`windowBecomesShown(int location)` Informs the docking window that it will be made visible by the manager.
`void`	`windowIsActive(int location)` Informs the docking window that it is now the active window.
`void`	`windowIsHiding(int location)` Informs the docking window that it was made invisible by the manager.
`void`	`windowIsInactive(int location)` Informs the docking window that it is not the active window any longer.
`void`	`windowIsShowing(int location)` Informs the docking window that it was made visible by the manager.
`void`	`windowRemoved(DockingManager manager, int location)` Informs the docking window that it was removed by the manager.

Methods inherited from class javax.swing.JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

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

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

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

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - windowParams
```
protected WindowParamDef windowParams
```
    Data holder for the docking window parameters.
  - counter
```
protected int counter
```
    Counter for unique IDs.
  - cacheViewByID
```
protected java.util.Hashtable<java.lang.String,WindowView> cacheViewByID
```
    Remembers the view IDs.
  - helpID
```
protected java.lang.String helpID
```
    Help system ID from the application (must be delegated).
  - orientation
```
protected int orientation
```
    The orientation of the components (use SwingConstants.HORIZONTAL (default) or SwingConstants.VERTICAL).
- Constructor Detail
  - MultiViewWindow
```
public MultiViewWindow()
```
    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
    Since:
    
    1.6
  - getID
```
public java.lang.String getID()
```
    Provides the identifier for the window.
    
    Specified by:
    
    getID in interface DockingWindow
    
    Returns:
    The window identifier
    Since:
    
    1.6
  - setID
```
public void setID(java.lang.String id)
```
    Sets the identifier for the window.
    Overwrite the default identifier for this window if multiple instances are used.
    
    Parameters:
    id - The window identifier
    Since:
    
    1.6
  - getTitle
```
public java.lang.String getTitle()
```
    Provides the title of the window used for display.
    
    Specified by:
    
    getTitle in interface DockingWindow
    
    Returns:
    The window title
    Since:
    
    1.6
  - getToolTip
```
public java.lang.String getToolTip()
```
    Provides the tooltip of the window used for display.
    
    Specified by:
    
    getToolTip in interface DockingWindow
    
    Returns:
    The window tooltip
    Since:
    
    1.6
  - getIcon
```
public javax.swing.ImageIcon getIcon()
```
    Provides the graphical icon of the window used for display.
    
    Specified by:
    
    getIcon in interface DockingWindow
    
    Returns:
    The window icon
    Since:
    
    1.6
  - getComponent
```
public java.awt.Component getComponent()
```
    Provides the component to be displayed in the center of the docking manager.
    
    Specified by:
    
    getComponent in interface DockingWindow
    
    Returns:
    The component
    Since:
    
    1.6
  - getPreferredWidth
```
public int getPreferredWidth()
```
    Provides the preferred width of the component for LEFT and RIGHT locations.
    
    Specified by:
    
    getPreferredWidth in interface DockingWindow
    
    Returns:
    The preferred width
    Since:
    
    1.6
  - setPreferredWidth
```
public void setPreferredWidth(int width)
```
    Sets the preferred width of the component for LEFT and RIGHT locations.
    
    Specified by:
    
    setPreferredWidth in interface DockingWindow
    
    Parameters:
    width - The preferred width
    Since:
    
    1.6
  - getPreferredHeight
```
public int getPreferredHeight()
```
    Provides the preferred height of the component for TOP and BOTTOM locations.
    
    Specified by:
    
    getPreferredHeight in interface DockingWindow
    
    Returns:
    The preferred height
    Since:
    
    1.6
  - setPreferredHeight
```
public void setPreferredHeight(int height)
```
    Sets the preferred height of the component for TOP and BOTTOM locations.
    
    Specified by:
    
    setPreferredHeight in interface DockingWindow
    
    Parameters:
    height - The preferred height
    Since:
    
    1.6
  - getMode
```
public int getMode()
```
    Provides the mode the the window is presented.
    
    Specified by:
    
    getMode in interface DockingWindow
    
    Returns:
    The mode (MODE_DOCKING_PINNED, MODE_DOCKING_UNPINNED, ...)
    Since:
    
    1.6
  - setMode
```
public void setMode(int mode)
```
    Sets the mode the the window is presented.
    
    Specified by:
    
    setMode in interface DockingWindow
    
    Parameters:
    mode - The mode (MODE_DOCKING_PINNED, MODE_DOCKING_UNPINNED, ...)
    Since:
    
    1.6
  - isAutomatic
```
public boolean isAutomatic()
```
    Provides if the window may be controlled externally.
    
    Specified by:
    
    isAutomatic in interface DockingWindow
    
    Returns:
    The automatic mode
    Since:
    
    1.6
  - setAutomatic
```
public void setAutomatic(boolean enable)
```
    Sets if the window may be controlled externally.
    
    Specified by:
    
    setAutomatic in interface DockingWindow
    
    Parameters:
    enable - The automatic mode
    Since:
    
    1.6
  - isGrowing
```
public boolean isGrowing()
```
    Provides if the window fills the location completely.
    
    Specified by:
    
    isGrowing in interface DockingWindow
    
    Returns:
    The growing mode
    Since:
    
    1.6
  - setGrowing
```
public void setGrowing(boolean enable)
```
    Sets if the window fills the location completely.
    
    Specified by:
    
    setGrowing in interface DockingWindow
    
    Parameters:
    enable - The growing mode
    Since:
    
    1.6
  - isButtonVisible
```
public boolean isButtonVisible()
```
    Provides the info whether the control button is visible or not.
    The visibility of the component itself within the docking manager can easily be determined by calling isVisible().
    
    Specified by:
    
    isButtonVisible in interface DockingWindow
    
    Returns:
    The visibility flag
    Since:
    
    1.6
  - setButtonVisible
```
public void setButtonVisible(boolean visible)
```
    Sets the info whether the control button is visible or not.
    The visibility of the component itself within the docking manager can easily be determined by calling isVisible().
    
    Specified by:
    
    setButtonVisible in interface DockingWindow
    
    Parameters:
    visible - The visibility flag
    Since:
    
    1.6
  - isButtonPressed
```
public boolean isButtonPressed()
```
    Provides the info whether the window is showing or not (hidden).
    
    Specified by:
    
    isButtonPressed in interface DockingWindow
    
    Returns:
    The pressed flag
    Since:
    
    1.6
  - setButtonPressed
```
public void setButtonPressed(boolean pressed)
```
    Sets the info whether the window is showing or not (hidden).
    
    Specified by:
    
    setButtonPressed in interface DockingWindow
    
    Parameters:
    pressed - The pressed flag
    Since:
    
    1.6
  - isWindowMode
```
public boolean isWindowMode()
```
    Provides the info whether the window is being displayed as separate window.
    
    Specified by:
    
    isWindowMode in interface DockingWindow
    
    Returns:
    The flag
    Since:
    
    1.6
  - setWindowMode
```
public void setWindowMode(boolean enable)
```
    Sets the info whether the window is being displayed as separate window.
    
    Specified by:
    
    setWindowMode in interface DockingWindow
    
    Parameters:
    enable - The flag
    Since:
    
    1.6
  - isWindowVisible
```
public boolean isWindowVisible()
```
    Provides if the window is currently being shown.
    
    Specified by:
    
    isWindowVisible in interface DockingWindow
    
    Returns:
    Visible?
    Since:
    
    1.6
  - setWindowVisible
```
public void setWindowVisible(boolean visible)
```
    Sets the state if the window is currently being shown.
    
    Specified by:
    
    setWindowVisible in interface DockingWindow
    
    Parameters:
    visible - The state
    Since:
    
    1.6
  - getWindowLocationX
```
public int getWindowLocationX()
```
    Provides the location on the x-axis when in window mode.
    
    Specified by:
    
    getWindowLocationX in interface DockingWindow
    
    Returns:
    The x-axis location
    Since:
    
    1.6
  - setWindowLocationX
```
public void setWindowLocationX(int locx)
```
    Sets the location on the x-axis when in window mode.
    
    Specified by:
    
    setWindowLocationX in interface DockingWindow
    
    Parameters:
    locx - The x-axis location
    Since:
    
    1.6
  - getWindowLocationY
```
public int getWindowLocationY()
```
    Provides the location on the y-axis when in window mode.
    
    Specified by:
    
    getWindowLocationY in interface DockingWindow
    
    Returns:
    The The y-axis location
    Since:
    
    1.6
  - setWindowLocationY
```
public void setWindowLocationY(int locy)
```
    Sets the location on the y-axis when in window mode.
    
    Specified by:
    
    setWindowLocationY in interface DockingWindow
    
    Parameters:
    locy - The y-axis location
    Since:
    
    1.6
  - getWindowWidth
```
public int getWindowWidth()
```
    Provides the width when in window mode.
    
    Specified by:
    
    getWindowWidth in interface DockingWindow
    
    Returns:
    The width
    Since:
    
    1.6
  - setWindowWidth
```
public void setWindowWidth(int width)
```
    Sets the width when in window mode.
    
    Specified by:
    
    setWindowWidth in interface DockingWindow
    
    Parameters:
    width - The width
    Since:
    
    1.6
  - getWindowHeight
```
public int getWindowHeight()
```
    Provides the height when in window mode.
    
    Specified by:
    
    getWindowHeight in interface DockingWindow
    
    Returns:
    The height
    Since:
    
    1.6
  - setWindowHeight
```
public void setWindowHeight(int height)
```
    Sets the height when in window mode.
    
    Specified by:
    
    setWindowHeight in interface DockingWindow
    
    Parameters:
    height - The height
    Since:
    
    1.6
  - getWindowState
```
public int getWindowState()
```
    Provides the state (iconified etc.) when in window mode.
    
    Specified by:
    
    getWindowState in interface DockingWindow
    
    Returns:
    The state
    Since:
    
    1.6
  - setWindowState
```
public void setWindowState(int state)
```
    Sets the state (iconified etc.) when in window mode.
    
    Specified by:
    
    setWindowState in interface DockingWindow
    
    Parameters:
    state - The state
    Since:
    
    1.6
  - windowAdded
```
public void windowAdded(DockingManager manager,
               int location)
```
    Informs the docking window that it was added by the manager.
    Remember that if the window is moved from one docking bar to another it is removed and added again so that this method and windowRemoved() are called.
    
    Specified by:
    
    windowAdded in interface DockingWindow
    
    Parameters:
    manager - The docking manager
    location - The location (TOP, BOTTOM, LEFT, RIGHT)
    Since:
    
    1.6
  - windowRemoved
```
public void windowRemoved(DockingManager manager,
                 int location)
```
    Informs the docking window that it was removed by the manager.
    Remember that if the window is moved from one docking bar to another it is removed and added again so that this method and windowAdded() are called.
    
    Specified by:
    
    windowRemoved in interface DockingWindow
    
    Parameters:
    manager - The docking manager
    location - The location (TOP, BOTTOM, LEFT, RIGHT)
    Since:
    
    1.6
  - windowBecomesShown
```
public void windowBecomesShown(int location)
```
    Informs the docking window that it will be made visible by the manager.
    
    Specified by:
    
    windowBecomesShown in interface DockingWindow
    
    Parameters:
    location - The location (TOP, BOTTOM, LEFT, RIGHT)
    Since:
    
    1.6
  - windowBecomesHidden
```
public void windowBecomesHidden(int location)
```
    Informs the docking window that it will be made invisible by the manager.
    
    Specified by:
    
    windowBecomesHidden in interface DockingWindow
    
    Parameters:
    location - The location (TOP, BOTTOM, LEFT, RIGHT)
    Since:
    
    1.6
  - windowIsShowing
```
public void windowIsShowing(int location)
```
    Informs the docking window that it was made visible by the manager.
    
    Specified by:
    
    windowIsShowing in interface DockingWindow
    
    Parameters:
    location - The location (TOP, BOTTOM, LEFT, RIGHT)
    Since:
    
    1.6
  - windowIsHiding
```
public void windowIsHiding(int location)
```
    Informs the docking window that it was made invisible by the manager.
    
    Specified by:
    
    windowIsHiding in interface DockingWindow
    
    Parameters:
    location - The location (TOP, BOTTOM, LEFT, RIGHT)
    Since:
    
    1.6
  - windowIsActive
```
public void windowIsActive(int location)
```
    Informs the docking window that it is now the active window.
    
    Specified by:
    
    windowIsActive in interface DockingWindow
    
    Parameters:
    location - The location (TOP, BOTTOM, LEFT, RIGHT)
    Since:
    
    1.6
  - windowIsInactive
```
public void windowIsInactive(int location)
```
    Informs the docking window that it is not the active window any longer.
    
    Specified by:
    
    windowIsInactive in interface DockingWindow
    
    Parameters:
    location - The location (TOP, BOTTOM, LEFT, RIGHT)
    Since:
    
    1.6
  - getDockingManager
```
public DockingManager getDockingManager()
```
    Provides the docking manager specified when windowAdded() was called.
    
    Specified by:
    
    getDockingManager in interface DockingWindow
    
    Returns:
    The docking manager, null if not available
    Since:
    
    1.6
  - refresh
```
public void refresh()
```
    Updates the contents of the docking window.
    
    Specified by:
    
    refresh in interface DockingWindow
    
    Since:
    
    1.6
  - getActionDelegate
```
public ActionDelegate getActionDelegate()
```
    Provides the optional action delegate responsible for shared buttons and menu items.
    
    Specified by:
    
    getActionDelegate in interface DockingWindow
    
    Returns:
    The delegate instance, null if not available
    Since:
    
    1.6
  - getWindowLocation
```
public int getWindowLocation()
```
    Provides the last location of the window passed to the windowxxx() methods.
    
    Specified by:
    
    getWindowLocation in interface DockingWindow
    
    Returns:
    The location (TOP, BOTTOM, LEFT, RIGHT) or -1
    Since:
    
    1.6
  - getSupportedActions
```
public java.lang.String[] getSupportedActions()
```
    Provides the supported shared actions for this delegate.
    
    Specified by:
    
    getSupportedActions in interface ActionDelegate
    
    Returns:
    The names of actions supported by this delegate
    Since:
    
    1.6
  - startControl
```
public void startControl(SharedAction[] actions)
```
    Provides the info that the given shared actions must now be controlled.
    
    Specified by:
    
    startControl in interface ActionDelegate
    
    Parameters:
    actions - The actions to care for
    Since:
    
    1.6
  - stopControl
```
public void stopControl()
```
    Provides the info that the control of the given shared actions must be stopped.
    
    Specified by:
    
    stopControl in interface ActionDelegate
    
    Since:
    
    1.6
  - processAction
```
public void processAction(SharedAction action)
```
    Indicates that the given action was initiated and must be processed.
    
    Specified by:
    
    processAction in interface ActionDelegate
    
    Parameters:
    action - The action to be processed
    Since:
    
    1.6
  - addView
```
public java.lang.String addView(WindowView view)
```
    Adds a new view for the multi view pane.
    
    Parameters:
    view - The new view to be added
    
    Returns:
    Unique ID
    
    Throws:
    
    java.lang.NullPointerException - If parameter is null
    Since:
    
    1.6
  - removeView
```
public WindowView removeView(java.lang.String id)
```
    Removes a view from the multi view pane.
    
    Parameters:
    id - The view ID
    
    Returns:
    The removed view, null if not removed
    
    Throws:
    
    java.lang.NullPointerException - If parameter is null
    Since:
    
    1.6
  - removeView
```
public WindowView removeView(WindowView view)
```
    Removes a view from the multi view pane.
    
    Parameters:
    view - The view
    
    Returns:
    The removed view, null if not removed
    
    Throws:
    
    java.lang.NullPointerException - If parameter is null
    Since:
    
    1.6
  - getVisibleViewID
```
public java.lang.String getVisibleViewID()
```
    Provides the multi view pane selection (view ID).
    
    Returns:
    The visible ID or null if not available
    Since:
    
    1.6
  - getVisibleView
```
public WindowView getVisibleView()
```
    Provides the multi view pane selection (view).
    
    Returns:
    The visible view or null if not available
    Since:
    
    1.6
  - setVisibleView
```
public void setVisibleView(java.lang.String id)
```
    Provides the multi view pane selection (view).
    
    Parameters:
    id - The view identifier to be selected
    Since:
    
    1.6
  - setVisibleView
```
public void setVisibleView(java.awt.Component comp)
```
    Provides the multi view pane selection (view).
    
    Parameters:
    comp - The desired component
    Since:
    
    1.6
  - findView
```
public WindowView findView(java.awt.Component comp)
```
    Provides the parental view for a component.
    
    Parameters:
    comp - The desired component
    
    Returns:
    The parental view or null if not available
    Since:
    
    1.6
  - findView
```
public WindowView findView(java.lang.String id)
```
    Provides the parental view for a certain view identifier.
    
    Parameters:
    id - The desired identifier
    
    Returns:
    The parental view or null if not available
    Since:
    
    1.6
  - findView
```
public WindowView findView(java.lang.Class type)
```
    Provides the first-best parental view for a certain view class.
    
    Parameters:
    type - The desired class type
    
    Returns:
    The parental view or null if not available
    Since:
    
    1.6
  - configureUnit
```
public void configureUnit(java.lang.String id,
                 Configuration config)
```
    Restores values from persistent data stores.
    
    Specified by:
    
    configureUnit in interface ConfigurableUnit
    
    Parameters:
    id - The unique identifier for the instance
    config - The configuration
    Since:
    
    1.6
  - storeUnit
```
public void storeUnit(java.lang.String id,
             Configuration config)
```
    Stores the current configuration values persistently.
    
    Specified by:
    
    storeUnit in interface ConfigurableUnit
    
    Parameters:
    id - The unique identifier for the instance
    config - The configuration
    Since:
    
    1.6
  - unitRegistered
```
public void unitRegistered(ApplicationModel model,
                  java.lang.String id)
```
    Informs the configurable unit that it was registered with a model.
    
    Specified by:
    
    unitRegistered in interface ConfigurableUnit
    
    Parameters:
    model - The application model
    id - The unique identifier for the instance
    Since:
    
    1.6
  - unitUnregistered
```
public void unitUnregistered(ApplicationModel model,
                    java.lang.String id)
```
    Informs the configurable unit that it was unregistered with a model.
    
    Specified by:
    
    unitUnregistered in interface ConfigurableUnit
    
    Parameters:
    model - The application model
    id - The unique identifier for the instance
    Since:
    
    1.6
  - setHelpID
```
public void setHelpID(java.lang.String helpid)
```
    Sets the identifier for the context sensitive help (must be delegated).
    
    Parameters:
    helpid - The help system link
    Since:
    
    1.6
  - setShowButtons
```
public void setShowButtons(boolean show)
```
    Sets the visibility of the buttons on the left side of the component.
    
    Parameters:
    show - Buttons enabled?
    Since:
    
    1.6
  - getShowButtons
```
public boolean getShowButtons()
```
    Provides the visibility of the buttons on the left side of the component.
    
    Returns:
    Buttons enabled?
    Since:
    
    1.6
  - setOrientation
```
public void setOrientation(int layout)
```
    Sets the window layout to either horizontal or vertical.
    If horizontally laid out, the buttons are placed on the left side while the vertical layout causes the buttons to be positioned on top of the multi view pane.
    
    Parameters:
    layout - Use SwingConstants.HORIZONTAL or SwingConstants.VERTICAL
    
    Throws:
    
    java.lang.IllegalArgumentException - If the parameters are not OK
    Since:
    
    1.6

Class MultiViewWindow

Nested Class Summary

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

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

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

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

Field Summary

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

windowParams

counter

cacheViewByID

helpID

orientation

Constructor Detail

MultiViewWindow

Method Detail

finalize

getID

setID

getTitle

getToolTip

getIcon

getComponent

getPreferredWidth

setPreferredWidth

getPreferredHeight

setPreferredHeight

getMode

setMode

isAutomatic

setAutomatic

isGrowing

setGrowing

isButtonVisible

setButtonVisible

isButtonPressed

setButtonPressed

isWindowMode

setWindowMode

isWindowVisible

setWindowVisible

getWindowLocationX

setWindowLocationX

getWindowLocationY

setWindowLocationY

getWindowWidth

setWindowWidth

getWindowHeight

setWindowHeight

getWindowState

setWindowState

windowAdded

windowRemoved

windowBecomesShown

windowBecomesHidden

windowIsShowing

windowIsHiding

windowIsActive

windowIsInactive

getDockingManager

refresh

getActionDelegate

getWindowLocation

getSupportedActions

startControl

stopControl

processAction

addView

removeView

removeView