IlvDockingArea (Perforce JViews 10.0 API)

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - ilog.views.appframe.swing.docking.IlvDockingArea

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, RootPaneContainer
```
public class IlvDockingArea
extends JComponent
implements RootPaneContainer
```
Root container that handles a hierarchy of dockables.
Dockables are containers that can be docked (put in the main area of the application) or undocked (put outside of the application in an outer top-level window). These components can be docked as children of a split pane or as tabs of a tabbed pane. The docking hierarchy can be set by configuration and modified dynamically by user interaction.
These dockables can contain any user component, so that they become a dockable component for the application.
The IlvDockingArea provides API to set and retrieve these user components and associate them with the dockables defined by configuration.
The IlvDockingArea also provides a listener interface for notification of docking events when a docking state is changed by user interaction.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class javax.swing.JComponent
  JComponent.AccessibleJComponent
- 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
Modifier and Type	Field and Description
`static String`	`CLOSABLE_PROPERTY` Bound property name for the closable property of a dockable.
`static String`	`CONTENT_PANE_PROPERTY` Bound property name.
`static String`	`DOCKABLE_PROPERTY` Bound property name that determines whether the dockable can be docked and undocked.
`static String`	`FIXED_HEIGHT_PROPERTY` Bound property name that determines whether the dockable has a fixed height.
`static String`	`FIXED_WIDTH_PROPERTY` Bound property name that determines whether the dockable has a fixed width.
`static String`	`GLASS_PANE_PROPERTY` Bound property name.
`static String`	`ICON_PROPERTY` Bound property name for the icon of a dockable.
`static String`	`LAYERED_PANE_PROPERTY` Bound property name.
`static String`	`MINIMUM_SIZE_PROPERTY` Bound property name that stores the minimum size of the dockable.
`static String`	`PIN_STATE_PROPERTY` Bound property name that stores the pin state of the dockable.
`static String`	`PINABLE_PROPERTY` Bound property name for the pinable property of a dockable.
`static String`	`ROOT_PANE_PROPERTY` Bound property name.
`static String`	`SCROLLABLE_PROPERTY` Bound property name that determines whether the dockable is scrollable.
`static String`	`TAB_ICON_PROPERTY` Bound property name for the tab icon of a dockable.
`static String`	`TITLE_PROPERTY` Bound property name for the title of a dockable.
`static String`	`TITLE_VISIBLE_PROPERTY` Bound property name that determines whether the dockable has a title visible.
`static String`	`TOOLTIP_PROPERTY` Bound property name for the tooltip of a dockable.
`static String`	`WORKSPACE_ACTION_COMMAND_PROPERTY` Bound property name that stores the action command of the action which triggers the activation of a workspace configuration.
`static String`	`WORKSPACE_DESCRIPTION_PROPERTY` Bound property name that stores the description of a workspace configuration.
`static String`	`WORKSPACE_DISPLAYED_NAME_PROPERTY` Bound property name that stores the name to be displayed for a workspace configuration.
`static String`	`WORKSPACE_ICON_PROPERTY` Bound property name that stores the icon associated with a workspace configuration.
`static String`	`WORKSPACE_TOOLTIP_PROPERTY` Bound property name that stores the tooltip to be displayed for a workspace configuration.
`static String`	`WORKSPACE_WRITABLE_PROPERTY` Bound property name that determines whether a workspace can be saved in the user settings.

Fields inherited from class javax.swing.JComponent
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
accessibleContext, 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

IlvDockingArea()
Constructs a new IlvDockingArea.

Constructors
Constructor and Description
`IlvDockingArea()` Constructs a new `IlvDockingArea`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addDockingListener(DockingListener listener)` Adds a docking listener to the list of listeners managed by this docking area.
`protected void`	`addImpl(Component comp, Object constraints, int index)` Ensures that, by default, children cannot be added directly to this component.
`boolean`	`addTab(String tabOnPane, String newPaneName, boolean after)` Adds a tab pane containing the new dockable pane with the specified `newPaneName` before or after the dockable pane with the `tabOnPane` name, depending on the value of the `after` parameter.
`boolean`	`addTab(String tabOnPane, String newPaneName, boolean after, boolean select)` Adds a tab pane containing the new dockable pane with the specified `newPaneName` before or after the dockable pane with the `tabOnPane` name, depending on the value of the `after` parameter.
`void`	`addWorkspacePropertyChangeListener(String name, PropertyChangeListener listener)` Adds a `PropertyChangeListener` to the list of listeners associated with the specified workspace.
`protected JRootPane`	`createRootPane()` Called by the constructor to set up the `JRootPane`.
`boolean`	`dock(String name)` Docks the dockable with the specified `name` at the position defined in the settings of the docking area.
`void`	`dock(String name, int side, double proportionalSize)` Docks the dockable with the specified `name` at the specified side of the docking area.
`boolean`	`duplicateWorkspaceConfiguration(String name, String newName)` Duplicates the workspace configuration with the specified `name` into the configuration with the new name `newName`.
`ilog.views.appframe.swing.docking.dockable.IlvDockable`	`getActiveDockable()` Returns the dockable currently active in this docking area.
`String`	`getActiveDockableName()` Returns the name of the dockable currently active in this docking area.
`IlvApplication`	`getApplication()` Returns the application associated with this docking area.
`Container`	`getContentPane()` Returns the content pane for this internal frame.
`ActionListener`	`getDefaultCloseActionListener()` Returns the default close action listener for the dockable panes.
`Dimension`	`getDefaultFloatingMaximumSize(Dimension d)` Retrieves the maximum size of the floatable window.
`Dimension`	`getDefaultFloatingMinimumSize(Dimension d)` Retrieves the minimum size of the floatable window.
`ActionListener`	`getDefaultPinActionListener()` Returns the default pin action listener for the dockable panes.
`ilog.views.appframe.swing.docking.dockable.IlvDockable`	`getDockable(String name)` Returns the dockable pane with the specified name.
`Component`	`getDockableComponent(String name)` Returns the component associated with the dockable pane with the specified name.
`Object`	`getDockableProperty(String name, String propertyName)` Returns the `propertyName` property of the dockable with the specified `name`.
`int`	`getDockableThreshold()` Returns the number of pixel needed to be traversed by the mouse before a drag operation begins.
`IlvDocumentView`	`getDockableView(String name)` Returns the document view contained by the dockable with the specified name.
`Point`	`getFloatingLocation(String name)` Returns the location of the floating window containing the dockable with the specified `name`.
`Component`	`getGlassPane()` Returns the glass pane for this internal frame.
`int`	`getInnerSensibilityMargin()` Retrieves the size of the inner sensitive area of the `IlvDockable`s on which you can drop an `IlvDockable` in order to dock it.
`JLayeredPane`	`getLayeredPane()` Returns the layered pane for this internal frame.
`String`	`getMDIPane()` Returns the name of the MDI pane.
`int`	`getOuterSensibilityMargin()` Retrieves the size of the outer sensitive area of the `IlvDockingArea` on which you can drop an `IlvDockable` in order to dock it.
`JRootPane`	`getRootPane()` Returns the `rootPane` object for this internal frame.
`String`	`getWorkspaceConfiguration()` Returns the name of the current workspace configuration.
`String[]`	`getWorkspaceConfigurations()` Returns the list of workspaces defined for this docking area.
`Object`	`getWorkspaceProperty(String name, String propertyName)` Returns the value of the `propertyName` property of the specified workspace configuration.
`boolean`	`isAllowingDocking()` Tells if docking and undocking windows is allowed.
`boolean`	`isConstraintFloatable()` Tells if the docking area constraints the floatable windows into the visible screen area.
`boolean`	`isDockableDocked(String name)` Determines whether the dockable with the specified `name` is docked.
`boolean`	`isDockableUndocked(String name)` Determines whether the dockable with the specified `name` is undocked.
`boolean`	`isDockableVisible(String name)` Determines whether the dockable with the specified `name` is visible.
`boolean`	`isReadUserSettings()` Determines whether this docking area is initialized according to the user settings that were saved during the last application session.
`protected boolean`	`isRootPaneCheckingEnabled()` Returns whether calls to `add` and `setLayout` cause an exception to be thrown.
`boolean`	`isUsingPreferredSize()` Tells if the default floating window size is determined with the preferred size of the contained component or if it should take the undocked component size.
`boolean`	`isWriteUserSettings()` Determines whether this docking area saves the current layout of its dockable panes in the user settings when the application is closing.
`void`	`lockUpdate()` Freezes the layout of the docking area until the method `unlockUpdate()` is called.
`void`	`readWorkspaceConfiguration(String name, IlvSettingsElement element)` Reads the workspace configuration with the specified `name` from the settings.
`boolean`	`removeDockable(String name)` Removes the dockable with the specified `name` from the docking area.
`boolean`	`removeDockingListener(DockingListener listener)` Removes the specified docking listener from the list of docking listeners managed by this docking area.
`boolean`	`removeWorkspaceConfiguration(String name)` Removes the workspace configuration with the specified `name` into the configuration with the new name `newName`.
`void`	`removeWorkspacePropertyChangeListener(String name, PropertyChangeListener listener)` Removes a `PropertyChangeListener` to the list of listeners associated with the specified workspace.
`void`	`setActiveDockable(ilog.views.appframe.swing.docking.dockable.IlvDockable dockable)` Sets the new active dockable of this docking area to the specified dockable.
`void`	`setActiveDockable(String name)` Sets the new active dockable of this docking area to the dockable with the specified `name`.
`void`	`setAllowingDocking(boolean allow)` Specifies if docking and undocking windows is allowed.
`void`	`setApplication(IlvApplication application)` Sets the application of the docking area.
`void`	`setCloseActionListener(ActionListener action)` Sets a global action listener for all the dockable panes of the application.
`void`	`setCloseActionListener(String dockablePane, ActionListener action)` Sets the close action listener for the dockable whose name is dockablePane This action listener will be invoked when the user hits the close icon of the dockable pane.
`void`	`setComponentOrientation(ComponentOrientation o)` Sets the language-sensitive orientation that is to be used to order the elements or text within this component.
`void`	`setConstraintFloatable(boolean c)` Tells the docking area if it should constraint the floatable windows into the visible screen area.
`void`	`setContentPane(Container c)` Sets the `contentPane` property of this `IlvDockingArea`.
`void`	`setCursor(Cursor cursor)` Sets the cursor image to the specified cursor.
`void`	`setDefaultFloatingMaximumSize(Dimension d)` Sets the maximum size of the floatable window.
`void`	`setDefaultFloatingMinimumSize(Dimension d)` Sets the minimum size of the floatable window.
`boolean`	`setDockableComponent(String name, Component component)` Attaches the specified component to the dockable pane with the specified name.
`void`	`setDockableProperties(String name, String title, String tooltip, ImageIcon windowIcon, ImageIcon tabIcon)` Sets display properties to the dockable pane with the specified `name`.
`Object`	`setDockableProperty(String name, String propertyName, Object value)` Changes the `propertyName` property of the dockable with the specified `name`.
`void`	`setDockableThreshold(int pixels)` Set the number of pixel that must be traversed by the mouse before a drag operation begins.
`void`	`setDockableVisibilityAction(String dockableName, String command)` Specifies a checkable action to associate with the visibility of a specified dockable.
`void`	`setDockableVisible(String name, boolean visible)` Shows or hides the dockable with the specified `name`, depending on the value of the parameter `show`.
`void`	`setGlassPane(Component glass)` Sets the `glassPane` property of this `IlvDockingArea`.
`void`	`setInnerSensibilityMargin(int margin)` Sets the size of the inner sensitive area of the `IlvDockable`s on which you can drop an `IlvDockable` in order to dock it.
`void`	`setLayeredPane(JLayeredPane layered)` Sets the `layeredPane` property of this `IlvDockingArea`.
`void`	`setLayout(LayoutManager manager)` Ensures that, by default, the layout of this component cannot be set.
`void`	`setMDIPane(String name)` Specifies the MDI pane of the docking area were nondockable panes have to be added.
`void`	`setOuterSensibilityMargin(int margin)` Sets the size of the outer sensitive area of the `IlvDockingArea` on which you can drop an `IlvDockable` in order to dock it.
`void`	`setPinActionListener(ActionListener action)` Sets a global action listener for all the dockable panes of the application.
`void`	`setPinActionListener(String dockablePane, ActionListener action)` Sets the pin action listener for the dockable whose name is dockablePane This action listener will be invoked when the user hits the pin icon of the dockable pane.
`void`	`setReadUserSettings(boolean readUserSettings)` Specifies if the docking area is initialized according to the user settings.
`protected void`	`setRootPane(JRootPane root)` Sets the `rootPane` property for this `IlvDockingArea`.
`protected void`	`setRootPaneCheckingEnabled(boolean enabled)` Determines whether calls to `add` and `setLayout` cause an exception to be thrown.
`void`	`setUsingPreferredSize(boolean b)` Specifies if the default floating window size is to be determined accordingly to the preferred size of the contained component.
`void`	`setWorkspaceActivationAction(String workspaceName, String command)` Specifies a checkable action to associate with the activation of a specified workspace configuration.
`void`	`setWorkspaceConfiguration(String name)` Sets the current workspace configuration to the configuration defined in the settings with the specified `name`.
`void`	`setWorkspaceProperty(String name, String propertyName, Object value)` Sets the value of the `propertyName` property of the specified workspace configuration to the specified `value`.
`void`	`setWriteUserSettings(boolean writeUserSettings)` Specifies if the docking area should write the current layout of its dockable panes in the user settings when the application is closing.
`boolean`	`split(String paneToSplit, String newPaneName, int orientation, double proportionalLocation)` Replaces the dockable pane with the `paneToSplit` name with a new split pane containing this dockable pane and the new dockable pane with the `newPaneName`.
`void`	`undock(String name)` Undocks the dockable with the specified `name`.
`void`	`undock(String name, Point location)` Undocks the dockable with the specified `name` at the specified screen location.
`void`	`unlockUpdate()` Unfreezes the layout of the docking area.
`void`	`updateComponentTreeUI()` A simple minded look and feel change: ask each node in the main window's tree and in the list of floatable windows to call `updateUI()` to initialize its UI property with the current look and feel.
`void`	`writeWorkspaceConfiguration(String name, IlvSettingsElement element)` Writes the workspace configuration with the specified `name` into the settings.

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, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paramString, 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, updateUI

Methods inherited from class java.awt.Container
add, add, add, add, add, addContainerListener, 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, 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, getAccessibleContext, 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, 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, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CONTENT_PANE_PROPERTY
```
public static final String CONTENT_PANE_PROPERTY
```
    Bound property name.
    
    See Also:
    
    Constant Field Values
  - LAYERED_PANE_PROPERTY
```
public static final String LAYERED_PANE_PROPERTY
```
    Bound property name.
    
    See Also:
    
    Constant Field Values
  - ROOT_PANE_PROPERTY
```
public static final String ROOT_PANE_PROPERTY
```
    Bound property name.
    
    See Also:
    
    Constant Field Values
  - GLASS_PANE_PROPERTY
```
public static final String GLASS_PANE_PROPERTY
```
    Bound property name.
    
    See Also:
    
    Constant Field Values
  - TITLE_PROPERTY
```
public static final String TITLE_PROPERTY
```
    Bound property name for the title of a dockable. The value of the property should be a key to a string resource.
    
    See Also:
    
    Constant Field Values
  - ICON_PROPERTY
```
public static final String ICON_PROPERTY
```
    Bound property name for the icon of a dockable.
    
    See Also:
    
    Constant Field Values
  - TAB_ICON_PROPERTY
```
public static final String TAB_ICON_PROPERTY
```
    Bound property name for the tab icon of a dockable.
    
    See Also:
    
    Constant Field Values
  - TOOLTIP_PROPERTY
```
public static final String TOOLTIP_PROPERTY
```
    Bound property name for the tooltip of a dockable. The value of the property should be a key to a string resource.
    
    See Also:
    
    Constant Field Values
  - PINABLE_PROPERTY
```
public static final String PINABLE_PROPERTY
```
    Bound property name for the pinable property of a dockable.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    Constant Field Values
  - CLOSABLE_PROPERTY
```
public static final String CLOSABLE_PROPERTY
```
    Bound property name for the closable property of a dockable.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    Constant Field Values
  - DOCKABLE_PROPERTY
```
public static final String DOCKABLE_PROPERTY
```
    Bound property name that determines whether the dockable can be docked and undocked.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    Constant Field Values
  - SCROLLABLE_PROPERTY
```
public static final String SCROLLABLE_PROPERTY
```
    Bound property name that determines whether the dockable is scrollable.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    Constant Field Values
  - TITLE_VISIBLE_PROPERTY
```
public static final String TITLE_VISIBLE_PROPERTY
```
    Bound property name that determines whether the dockable has a title visible.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    Constant Field Values
  - FIXED_WIDTH_PROPERTY
```
public static final String FIXED_WIDTH_PROPERTY
```
    Bound property name that determines whether the dockable has a fixed width.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    Constant Field Values
  - FIXED_HEIGHT_PROPERTY
```
public static final String FIXED_HEIGHT_PROPERTY
```
    Bound property name that determines whether the dockable has a fixed height.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    Constant Field Values
  - PIN_STATE_PROPERTY
```
public static final String PIN_STATE_PROPERTY
```
    Bound property name that stores the pin state of the dockable.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    Constant Field Values
  - MINIMUM_SIZE_PROPERTY
```
public static final String MINIMUM_SIZE_PROPERTY
```
    Bound property name that stores the minimum size of the dockable.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    Constant Field Values
  - WORKSPACE_DISPLAYED_NAME_PROPERTY
```
public static final String WORKSPACE_DISPLAYED_NAME_PROPERTY
```
    Bound property name that stores the name to be displayed for a workspace configuration.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    getWorkspaceProperty(java.lang.String, java.lang.String), Constant Field Values
  - WORKSPACE_ICON_PROPERTY
```
public static final String WORKSPACE_ICON_PROPERTY
```
    Bound property name that stores the icon associated with a workspace configuration.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    getWorkspaceProperty(java.lang.String, java.lang.String), Constant Field Values
  - WORKSPACE_DESCRIPTION_PROPERTY
```
public static final String WORKSPACE_DESCRIPTION_PROPERTY
```
    Bound property name that stores the description of a workspace configuration.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    getWorkspaceProperty(java.lang.String, java.lang.String), Constant Field Values
  - WORKSPACE_TOOLTIP_PROPERTY
```
public static final String WORKSPACE_TOOLTIP_PROPERTY
```
    Bound property name that stores the tooltip to be displayed for a workspace configuration.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    getWorkspaceProperty(java.lang.String, java.lang.String), Constant Field Values
  - WORKSPACE_ACTION_COMMAND_PROPERTY
```
public static final String WORKSPACE_ACTION_COMMAND_PROPERTY
```
    Bound property name that stores the action command of the action which triggers the activation of a workspace configuration.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    getWorkspaceProperty(java.lang.String, java.lang.String), Constant Field Values
  - WORKSPACE_WRITABLE_PROPERTY
```
public static final String WORKSPACE_WRITABLE_PROPERTY
```
    Bound property name that determines whether a workspace can be saved in the user settings.
    If this property equals Boolean.FALSE, the workspace is not saved in the user settings. Otherwise, the workspace is saved in the user settings.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    getWorkspaceProperty(java.lang.String, java.lang.String), Constant Field Values
- Constructor Detail
  - IlvDockingArea
```
public IlvDockingArea()
```
    Constructs a new IlvDockingArea.
- Method Detail
  - createRootPane
```
protected JRootPane createRootPane()
```
    Called by the constructor to set up the JRootPane.
    
    Returns:
    
    A new JRootPane.
    
    See Also:
    
    JRootPane
  - isRootPaneCheckingEnabled
```
protected boolean isRootPaneCheckingEnabled()
```
    Returns whether calls to add and setLayout cause an exception to be thrown.
    
    Returns:
    
    true if add and setLayout are checked.
    
    See Also:
    
    addImpl(java.awt.Component, java.lang.Object, int), setLayout(java.awt.LayoutManager), setRootPaneCheckingEnabled(boolean)
  - setRootPaneCheckingEnabled
```
protected void setRootPaneCheckingEnabled(boolean enabled)
```
    Determines whether calls to add and setLayout cause an exception to be thrown.
    
    Parameters:
    
    enabled - A boolean value, true if checking is to be enabled, which causes the exceptions to be thrown
    
    See Also:
    
    addImpl(java.awt.Component, java.lang.Object, int), setLayout(java.awt.LayoutManager), isRootPaneCheckingEnabled()
  - addImpl
```
protected void addImpl(Component comp,
                       Object constraints,
                       int index)
```
    Ensures that, by default, children cannot be added directly to this component. Instead, children must be added to its content pane. For example:
```
 thisComponent.getContentPane().add(child)
 
```
    An attempt to add directly to this component will cause a runtime exception to be thrown. Subclasses can disable this behavior.
    Overrides:
    
    addImpl in class Container
    
    Parameters:
    
    comp - The Component to be added.
    
    constraints - The object containing the constraints, if any.
    
    index - The index.
    
    Throws:
    
    Error - if called with isRootPaneChecking true.
    
    See Also:
    
    setRootPaneCheckingEnabled(boolean)
  - setLayout
```
public void setLayout(LayoutManager manager)
```
    Ensures that, by default, the layout of this component cannot be set. Instead, the layout of its content pane should be set. For example:
```
 thisComponent.getContentPane().setLayout(new GridLayout(1,2))
 
```
    An attempt to set the layout of this component will cause a runtime exception to be thrown. Subclasses can disable this behavior.
    Overrides:
    
    setLayout in class Container
    
    Parameters:
    
    manager - the LayoutManager
    
    Throws:
    
    Error - if called with isRootPaneChecking. true
    
    See Also:
    
    setRootPaneCheckingEnabled(boolean)
  - getContentPane
```
public Container getContentPane()
```
    Returns the content pane for this internal frame.
    
    Specified by:
    
    getContentPane in interface RootPaneContainer
    
    Returns:
    
    The content pane.
  - setContentPane
```
public void setContentPane(Container c)
```
    Sets the contentPane property of this IlvDockingArea.
    
    Specified by:
    
    setContentPane in interface RootPaneContainer
    
    Parameters:
    
    c - The content pane for this internal frame.
    
    Throws:
    
    IllegalComponentStateException - (a runtime exception) if the content pane parameter is null.
    
    See Also:
    
    RootPaneContainer.getContentPane()
  - getLayeredPane
```
public JLayeredPane getLayeredPane()
```
    Returns the layered pane for this internal frame.
    
    Specified by:
    
    getLayeredPane in interface RootPaneContainer
    
    Returns:
    
    A JLayeredPane object.
    
    See Also:
    
    RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane), RootPaneContainer.getLayeredPane()
  - setLayeredPane
```
public void setLayeredPane(JLayeredPane layered)
```
    Sets the layeredPane property of this IlvDockingArea.
    
    Specified by:
    
    setLayeredPane in interface RootPaneContainer
    
    Parameters:
    
    layered - The JLayeredPane for this internal frame.
    
    Throws:
    
    IllegalComponentStateException - (a runtime exception) if the layered pane parameter is null.
    
    See Also:
    
    RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)
  - getGlassPane
```
public Component getGlassPane()
```
    Returns the glass pane for this internal frame.
    
    Specified by:
    
    getGlassPane in interface RootPaneContainer
    
    Returns:
    
    The glass pane.
    
    See Also:
    
    RootPaneContainer.setGlassPane(java.awt.Component)
  - setGlassPane
```
public void setGlassPane(Component glass)
```
    Sets the glassPane property of this IlvDockingArea.
    
    Specified by:
    
    setGlassPane in interface RootPaneContainer
    
    Parameters:
    
    glass - The glass pane for this internal frame.
    
    See Also:
    
    RootPaneContainer.getGlassPane()
  - getRootPane
```
public JRootPane getRootPane()
```
    Returns the rootPane object for this internal frame.
    
    Specified by:
    
    getRootPane in interface RootPaneContainer
    
    Overrides:
    
    getRootPane in class JComponent
    
    Returns:
    
    The rootPane property.
    
    See Also:
    
    RootPaneContainer.getRootPane()
  - setRootPane
```
protected void setRootPane(JRootPane root)
```
    Sets the rootPane property for this IlvDockingArea. This method is called by the constructor.
    
    Parameters:
    
    root - The new JRootPane object.
  - getApplication
```
public IlvApplication getApplication()
```
    Returns the application associated with this docking area.
    
    See Also:
    
    setApplication(ilog.views.appframe.IlvApplication)
  - setApplication
```
public void setApplication(IlvApplication application)
```
    Sets the application of the docking area.
    
    Parameters:
    
    application - The new application of the docking area.
  - setWorkspaceConfiguration
```
public void setWorkspaceConfiguration(String name)
```
    Sets the current workspace configuration to the configuration defined in the settings with the specified name.
    
    See Also:
    
    getWorkspaceConfiguration()
  - getWorkspaceConfiguration
```
public String getWorkspaceConfiguration()
```
    Returns the name of the current workspace configuration.
    
    See Also:
    
    setWorkspaceConfiguration(java.lang.String)
  - duplicateWorkspaceConfiguration
```
public boolean duplicateWorkspaceConfiguration(String name,
                                               String newName)
```
    Duplicates the workspace configuration with the specified name into the configuration with the new name newName.
    
    Parameters:
    
    name - The name of the configuration to duplicate.
    
    newName - The name of the new created configuration.
    
    Returns:
    
    true if the operation succeeded. Otherwise, if the specified name does not correspond to a valid configuration name or if the new newName corresponds to the name of an existing configuration, this method returns false.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    getWorkspaceConfiguration(), readWorkspaceConfiguration(java.lang.String, ilog.views.appframe.settings.IlvSettingsElement)
  - readWorkspaceConfiguration
```
public void readWorkspaceConfiguration(String name,
                                       IlvSettingsElement element)
```
    Reads the workspace configuration with the specified name from the settings.
    If no workspace configuration is defined with the specified name, a new one is added to this docking area.
    
    Parameters:
    
    name - The name of the docking configuration to add.
    
    element - The settings element that contains the definition of the docking configuration.
    
    See Also:
    
    writeWorkspaceConfiguration(java.lang.String, ilog.views.appframe.settings.IlvSettingsElement), removeWorkspaceConfiguration(java.lang.String)
  - writeWorkspaceConfiguration
```
public void writeWorkspaceConfiguration(String name,
                                        IlvSettingsElement element)
```
    Writes the workspace configuration with the specified name into the settings.
    
    Parameters:
    
    name - The name of the workspace configuration.
    
    element - The settings element to save the workspace configuration in.
    
    See Also:
    
    readWorkspaceConfiguration(java.lang.String, ilog.views.appframe.settings.IlvSettingsElement), writeWorkspaceConfiguration(java.lang.String, ilog.views.appframe.settings.IlvSettingsElement)
  - removeWorkspaceConfiguration
```
public boolean removeWorkspaceConfiguration(String name)
```
    Removes the workspace configuration with the specified name into the configuration with the new name newName.
    If the workspace configuration being removed is the configuration currently active in the docking area, the configuration that was previously active is activated.
    
    Parameters:
    
    name - The name of the configuration to remove.
    
    Returns:
    
    true if the operation succeeded. Otherwise, if the specified name does not correspond to a valid configuration name, this method returns false.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    getWorkspaceConfiguration(), duplicateWorkspaceConfiguration(java.lang.String, java.lang.String)
  - getWorkspaceProperty
```
public Object getWorkspaceProperty(String name,
                                   String propertyName)
```
    Returns the value of the propertyName property of the specified workspace configuration.
    Predefined workspace properties are:
    Parameters:
    
    name - The name of the workspace configuration.
    
    propertyName - The name of the property to retrieve.
    
    Returns:
    
    The value of the propertyName property. This method returns null if no property is defined with the specified name for this workspace configuration.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    setWorkspaceProperty(java.lang.String, java.lang.String, java.lang.Object)
  - setWorkspaceProperty
```
public void setWorkspaceProperty(String name,
                                 String propertyName,
                                 Object value)
```
    Sets the value of the propertyName property of the specified workspace configuration to the specified value.
    
    Parameters:
    
    name - The name of the workspace configuration.
    
    propertyName - The name of the property to set.
    
    value - The value to set to the property.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    getWorkspaceProperty(java.lang.String, java.lang.String)
  - addWorkspacePropertyChangeListener
```
public void addWorkspacePropertyChangeListener(String name,
                                               PropertyChangeListener listener)
```
    Adds a PropertyChangeListener to the list of listeners associated with the specified workspace.
    The listener is registered for all properties of the workspace configuration with the specified name.
    
    Parameters:
    
    name - The name of the workspace configuration.
    
    listener - The listener to be added.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    removeWorkspacePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), setWorkspaceProperty(java.lang.String, java.lang.String, java.lang.Object)
  - removeWorkspacePropertyChangeListener
```
public void removeWorkspacePropertyChangeListener(String name,
                                                  PropertyChangeListener listener)
```
    Removes a PropertyChangeListener to the list of listeners associated with the specified workspace.
    
    Parameters:
    
    name - The name of the workspace configuration.
    
    listener - The listener to be removed.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    addWorkspacePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener), setWorkspaceProperty(java.lang.String, java.lang.String, java.lang.Object)
  - getWorkspaceConfigurations
```
public String[] getWorkspaceConfigurations()
```
    Returns the list of workspaces defined for this docking area.
    
    Since:
    
    JViews 6.0
  - setWorkspaceActivationAction
```
public void setWorkspaceActivationAction(String workspaceName,
                                         String command)
```
    Specifies a checkable action to associate with the activation of a specified workspace configuration.
    When the specified workspace configuration is active in the docking area, the action is checked. When another workspace configuration is active, the action is unchecked. Checking the action activates the specified workspace configuration in the docking area.
    
    Parameters:
    
    workspaceName - The name of the workspace configuration that is to be made activated.
    
    command - The command key of the action.
    
    Since:
    
    JViews6.0
  - setDockableComponent
```
public boolean setDockableComponent(String name,
                                    Component component)
```
    Attaches the specified component to the dockable pane with the specified name. The docking location of this pane is defined by the current workspace configuration.
    
    Parameters:
    
    name - The name of the dockable pane to attach the component to.
    
    component - The component to attach.
    
    Returns:
    
    true if a dockable pane with the specified name could be found; false otherwise.
    
    See Also:
    
    getDockableComponent(java.lang.String), setDockableProperties(java.lang.String, java.lang.String, java.lang.String, javax.swing.ImageIcon, javax.swing.ImageIcon)
  - setDockableProperties
```
public void setDockableProperties(String name,
                                  String title,
                                  String tooltip,
                                  ImageIcon windowIcon,
                                  ImageIcon tabIcon)
```
    Sets display properties to the dockable pane with the specified name. If a pane style is defined in the settings for the specified dockable pane, it is overridden with the specified properties.
    
    Parameters:
    
    name - The name of the dockable pane to configure properties of.
    
    title - The title of the dockable pane. Should be a key to a string resource.
    
    tooltip - The tooltip to be displayed when the dockable pane is inserted in a tabbed pane.
    
    windowIcon - The icon of the window that owns the dockable pane when it is undocked - can be null.
    
    tabIcon - The icon of the tab that owns the dockable pane when it is docked as a tab pane - can be null.
    
    See Also:
    
    getDockableComponent(java.lang.String), setDockableComponent(String, Component), setDockableProperty(String, String, Object), getDockableProperty(String, String)
  - setDockableProperty
```
public Object setDockableProperty(String name,
                                  String propertyName,
                                  Object value)
```
    Changes the propertyName property of the dockable with the specified name.
    Parameters:
    
    name - The name of the dockable to change a property of.
    propertyName - The name of the property to change the value of. Predefined dockable properties are:
    
    TITLE_PROPERTY
    
    ICON_PROPERTY
    
    TAB_ICON_PROPERTY
    
    TOOLTIP_PROPERTY
    
    PINABLE_PROPERTY
    
    CLOSABLE_PROPERTY
    
    DOCKABLE_PROPERTY
    
    SCROLLABLE_PROPERTY
    
    TITLE_VISIBLE_PROPERTY
    
    FIXED_WIDTH_PROPERTY
    
    FIXED_HEIGHT_PROPERTY
    
    PIN_STATE_PROPERTY
    value - The new value of the propertyName property.
    
    Returns:
    
    The previous value of the property.
    
    See Also:
    
    getDockableProperty(java.lang.String, java.lang.String)
  - getDockableProperty
```
public Object getDockableProperty(String name,
                                  String propertyName)
```
    Returns the propertyName property of the dockable with the specified name.
    Parameters:
    
    name - The name of the dockable to retrieve a property from.
    propertyName - The name of the property to return the value of. Predefined dockable properties are:
    
    TITLE_PROPERTY
    
    ICON_PROPERTY
    
    TAB_ICON_PROPERTY
    
    TOOLTIP_PROPERTY
    
    PINABLE_PROPERTY
    
    CLOSABLE_PROPERTY
    
    DOCKABLE_PROPERTY
    
    SCROLLABLE_PROPERTY
    
    TITLE_VISIBLE_PROPERTY
    
    FIXED_WIDTH_PROPERTY
    
    FIXED_HEIGHT_PROPERTY
    
    PIN_STATE_PROPERTY
    Returns:
    
    The value of the property.
    
    See Also:
    
    setDockableProperty(java.lang.String, java.lang.String, java.lang.Object)
  - getDockableComponent
```
public Component getDockableComponent(String name)
```
    Returns the component associated with the dockable pane with the specified name.
    
    Parameters:
    
    name - The name of the dockable pane to retrieve the associated component of.
    
    Returns:
    
    The dockable component.
    
    See Also:
    
    setDockableComponent(java.lang.String, java.awt.Component)
  - getDockableView
```
public IlvDocumentView getDockableView(String name)
```
    Returns the document view contained by the dockable with the specified name.
    
    Parameters:
    
    name - The name of the dockable to retrieve the document view from.
    
    Returns:
    
    The document view of the specified dockable - can be null if no document view is contained by the dockable.
    
    Since:
    
    JViews6.0
  - getActiveDockable
```
public ilog.views.appframe.swing.docking.dockable.IlvDockable getActiveDockable()
```
    Returns the dockable currently active in this docking area.
    
    See Also:
    
    setActiveDockable(IlvDockable), getActiveDockableName()
  - setActiveDockable
```
public void setActiveDockable(ilog.views.appframe.swing.docking.dockable.IlvDockable dockable)
```
    Sets the new active dockable of this docking area to the specified dockable.
    
    Parameters:
    
    dockable - The dockable to activate.
    
    See Also:
    
    getActiveDockable(), setActiveDockable(String)
  - getActiveDockableName
```
public String getActiveDockableName()
```
    Returns the name of the dockable currently active in this docking area.
    
    See Also:
    
    getActiveDockable(), setActiveDockable(String)
  - setActiveDockable
```
public void setActiveDockable(String name)
```
    Sets the new active dockable of this docking area to the dockable with the specified name.
    
    Parameters:
    
    name - The name of the dockable to activate.
    
    See Also:
    
    getActiveDockableName(), setActiveDockable(IlvDockable)
  - addDockingListener
```
public void addDockingListener(DockingListener listener)
```
    Adds a docking listener to the list of listeners managed by this docking area.
    
    Parameters:
    
    listener - The new docking listener.
    
    See Also:
    
    removeDockingListener(ilog.views.appframe.swing.docking.DockingListener)
  - removeDockingListener
```
public boolean removeDockingListener(DockingListener listener)
```
    Removes the specified docking listener from the list of docking listeners managed by this docking area.
    
    Parameters:
    
    listener - The listener to remove.
    
    Returns:
    
    true if the listener was previously added to the docking area; false otherwise.
    
    See Also:
    
    addDockingListener(ilog.views.appframe.swing.docking.DockingListener)
  - lockUpdate
```
public void lockUpdate()
```
    Freezes the layout of the docking area until the method unlockUpdate() is called.
    This method should be called before applying a set of modifications to the area that can alter its layout, as splitting panes, docking panes or changing their visibility states. This prevent a flickering effect that is due to the update of the area for each of the applied modifications. The area area will update its layout as soon as the method unlockUpdate() is called.
    The area supports successive calls to this method. For each call to this method must correspond a call to the method unlockUpdate(). If this method is called twice, the layout of the area will be updated the second time the method unlockUpdate is called.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    unlockUpdate()
  - unlockUpdate
```
public void unlockUpdate()
```
    Unfreezes the layout of the docking area.
    This method must be called after the method lockUpdate() is called.
  - getDockable
```
public ilog.views.appframe.swing.docking.dockable.IlvDockable getDockable(String name)
```
    Returns the dockable pane with the specified name.
    
    Parameters:
    
    name - The name of the dockable with the specified name.
  - isDockableVisible
```
public boolean isDockableVisible(String name)
```
    Determines whether the dockable with the specified name is visible.
    
    Parameters:
    
    name - The name of the dockable to determine the visibility of.
    
    Returns:
    
    true if the specified dockable is visible; false otherwise.
    
    See Also:
    
    setDockableVisible(java.lang.String, boolean)
  - setDockableVisible
```
public void setDockableVisible(String name,
                               boolean visible)
```
    Shows or hides the dockable with the specified name, depending on the value of the parameter show.
    
    Parameters:
    
    name - The name of the dockable to show or hide.
    
    visible - If true, will show the dockable; otherwise, hides the dockable.
    
    See Also:
    
    isDockableVisible(java.lang.String)
  - isDockableDocked
```
public boolean isDockableDocked(String name)
```
    Determines whether the dockable with the specified name is docked.
    
    Parameters:
    
    name - The name of the dockable.
    
    Returns:
    
    true if the dockable is docked; false if the dockable is hidden or floating.
    
    See Also:
    
    dock(java.lang.String), isDockableUndocked(java.lang.String), isDockableVisible(java.lang.String)
  - dock
```
public boolean dock(String name)
```
    Docks the dockable with the specified name at the position defined in the settings of the docking area. If the dockable was previously docked, this method does nothing.
    
    Parameters:
    
    name - The name of the dockable to dock.
    
    Returns:
    
    true if the operation is successful; false if no dockable could be found with the specified name or if no docking position was specified for the dockable in the docked state.
    
    See Also:
    
    dock(String, int, double), isDockableDocked(java.lang.String), undock(java.lang.String)
  - dock
```
public void dock(String name,
                 int side,
                 double proportionalSize)
```
    Docks the dockable with the specified name at the specified side of the docking area. If the dockable was previously docked, this method does nothing.
    Parameters:
    
    name - The name of the new dockable pane to dock.
    side - The side of the docking area to dock the dockable in. This value must be one of the following values:
    
    SwingConstants.WEST
    
    SwingConstants.NORTH
    
    SwingConstants.EAST
    
    SwingConstants.SOUTH
    proportionalSize - The proportional divider location of the newly created split pane.
    
    See Also:
    
    dock(String), isDockableDocked(java.lang.String), undock(java.lang.String)
  - split
```
public boolean split(String paneToSplit,
                     String newPaneName,
                     int orientation,
                     double proportionalLocation)
```
    Replaces the dockable pane with the paneToSplit name with a new split pane containing this dockable pane and the new dockable pane with the newPaneName.
    Parameters:
    
    paneToSplit - The name of the dockable pane to split.
    
    newPaneName - The name of the new dockable pane to insert.
    orientation - Specifies where the new dockable pane should be inserted relative to the paneToSplit dockable pane. This value must be one of the following:
    
    SwingConstants.WEST
    
    SwingConstants.NORTH
    
    SwingConstants.EAST
    
    SwingConstants.SOUTH
    proportionalLocation - Specifies the proportional location of the divider of the newly created split pane. If the value is negative, the divider location will be calculated according to the preferred size of the newly inserted dockable pane.
    
    Returns:
    
    true if the operation is successful; false if no dockable could be found with the specified names.
  - addTab
```
public boolean addTab(String tabOnPane,
                      String newPaneName,
                      boolean after)
```
    Adds a tab pane containing the new dockable pane with the specified newPaneName before or after the dockable pane with the tabOnPane name, depending on the value of the after parameter. If the dockable pane with the tabOnPane name is not a tab, it will be replaced with a newly created tabbed pane containing this dockable pane in a tab.
    It is mandatory that the properties of the new dockable pane to insert be previously declared to the docking area. This is done either from the settings in a <pane> element or by invoking the method setDockableProperties(java.lang.String, java.lang.String, java.lang.String, javax.swing.ImageIcon, javax.swing.ImageIcon).
    The new added dockable pane is selected.
    
    Parameters:
    
    tabOnPane - The name of the dockable pane to add a tab before or after.
    
    newPaneName - The name of the new dockable pane to tab.
    
    after - If true, the new tab will be inserted after the tab containing the dockable pane with the tabOnPane name. Otherwise, the new tab is inserted before.
    
    Returns:
    
    true if the operation is successful; false if no dockable could be found with the specified tabOnPane name or if no pane properties could be found for the new pane to insert.
    
    See Also:
    
    addTab(java.lang.String, java.lang.String, boolean, boolean)
  - addTab
```
public boolean addTab(String tabOnPane,
                      String newPaneName,
                      boolean after,
                      boolean select)
```
    Adds a tab pane containing the new dockable pane with the specified newPaneName before or after the dockable pane with the tabOnPane name, depending on the value of the after parameter. If the dockable pane with the tabOnPane name is not a tab, it will be replaced with a newly created tabbed pane containing this dockable pane in a tab.
    It is mandatory that the properties of the new dockable pane to insert be previously declared to the docking area. This is done either from the settings in a <pane> element or by invoking the method setDockableProperties(java.lang.String, java.lang.String, java.lang.String, javax.swing.ImageIcon, javax.swing.ImageIcon).
    
    Parameters:
    
    tabOnPane - The name of the dockable pane to add a tab before or after.
    
    newPaneName - The name of the new dockable pane to tab.
    
    after - If true, the new tab will be inserted after the tab containing the dockable pane with the tabOnPane name. Otherwise, the new tab is inserted before.
    
    select - If true, the dockable pane is selected. Otherwise, it is not selected and the current selected tab in the tabbed pane remains unchanged.
    
    Returns:
    
    true if the operation is successful; false if no dockable could be found with the specified tabOnPane name or if no pane properties could be found for the new pane to insert.
    
    Since:
    
    JViews 6.0
    
    See Also:
    
    addTab(java.lang.String, java.lang.String, boolean)
  - undock
```
public void undock(String name)
```
    Undocks the dockable with the specified name. If the dockable was previously undocked, this method does nothing.
    
    Parameters:
    
    name - The name of the dockable to undock.
    
    See Also:
    
    isDockableUndocked(java.lang.String), dock(java.lang.String)
  - undock
```
public void undock(String name,
                   Point location)
```
    Undocks the dockable with the specified name at the specified screen location. If the dockable was previously undocked, this method does nothing.
    
    Parameters:
    
    name - The name of the dockable to undock.
    
    location - The location of the floating window containing the dockable.
    
    See Also:
    
    isDockableUndocked(java.lang.String), undock(String)
  - isDockableUndocked
```
public boolean isDockableUndocked(String name)
```
    Determines whether the dockable with the specified name is undocked.
    
    Parameters:
    
    name - The name of the dockable.
    
    Returns:
    
    true if the dockable is undocked; false if the dockable is hidden or docked.
    
    See Also:
    
    isDockableDocked(java.lang.String), isDockableVisible(java.lang.String), getFloatingLocation(java.lang.String)
  - getFloatingLocation
```
public Point getFloatingLocation(String name)
```
    Returns the location of the floating window containing the dockable with the specified name.
    
    Parameters:
    
    name - The name of the dockable to retrieve the floating location from.
    
    Returns:
    
    The location of the floating window if the dockable is undocked (the method isDockableUndocked(java.lang.String) returns true); null otherwise.
  - setDockableVisibilityAction
```
public void setDockableVisibilityAction(String dockableName,
                                        String command)
```
    Specifies a checkable action to associate with the visibility of a specified dockable. When the dockable is visible, the action is checked. When the dockable is hidden, the action is unchecked. Checking/unchecking the action respectively shows/hides the dockable.
    
    Parameters:
    
    dockableName - The name of the dockable that is to be made visible or hidden.
    
    command - The command key of the action, controlled by the specified action.
  - setMDIPane
```
public void setMDIPane(String name)
```
    Specifies the MDI pane of the docking area were nondockable panes have to be added. When the dockable tag of a dockable pane is removed, the dockable pane is added to this pane.
    It is recommended that the MDI pane corresponds to the MDI client of the application and does not have the dockable tag.
    
    See Also:
    
    getMDIPane()
  - getMDIPane
```
public String getMDIPane()
```
    Returns the name of the MDI pane.
    
    See Also:
    
    setMDIPane(java.lang.String)
  - setInnerSensibilityMargin
```
public void setInnerSensibilityMargin(int margin)
```
    Sets the size of the inner sensitive area of the IlvDockables on which you can drop an IlvDockable in order to dock it.
    
    See Also:
    
    getInnerSensibilityMargin(), setOuterSensibilityMargin(int), getOuterSensibilityMargin()
  - getInnerSensibilityMargin
```
public int getInnerSensibilityMargin()
```
    Retrieves the size of the inner sensitive area of the IlvDockables on which you can drop an IlvDockable in order to dock it.
    
    See Also:
    
    setInnerSensibilityMargin(int), setOuterSensibilityMargin(int), getOuterSensibilityMargin()
  - setOuterSensibilityMargin
```
public void setOuterSensibilityMargin(int margin)
```
    Sets the size of the outer sensitive area of the IlvDockingArea on which you can drop an IlvDockable in order to dock it.
    
    See Also:
    
    setInnerSensibilityMargin(int), getInnerSensibilityMargin(), getOuterSensibilityMargin()
  - getOuterSensibilityMargin
```
public int getOuterSensibilityMargin()
```
    Retrieves the size of the outer sensitive area of the IlvDockingArea on which you can drop an IlvDockable in order to dock it.
    
    See Also:
    
    setInnerSensibilityMargin(int), getInnerSensibilityMargin(), setOuterSensibilityMargin(int)
  - removeDockable
```
public boolean removeDockable(String name)
```
    Removes the dockable with the specified name from the docking area.
    
    Returns:
    
    true if the dockable belongs to the docking area; false otherwise.
  - getDefaultCloseActionListener
```
public ActionListener getDefaultCloseActionListener()
```
    Returns the default close action listener for the dockable panes. The actionPerformed method of the listener hides the panel.
    
    See Also:
    
    setCloseActionListener(String, ActionListener), setCloseActionListener(ActionListener)
  - setCloseActionListener
```
public void setCloseActionListener(String dockablePane,
                                   ActionListener action)
```
    Sets the close action listener for the dockable whose name is dockablePane This action listener will be invoked when the user hits the close icon of the dockable pane.
    
    See Also:
    
    setCloseActionListener(ActionListener), getDefaultCloseActionListener()
  - setCloseActionListener
```
public void setCloseActionListener(ActionListener action)
```
    Sets a global action listener for all the dockable panes of the application. If no specific action listener have been installed for a dockable pane, this action listener will be invoked.
    
    See Also:
    
    setCloseActionListener(String, ActionListener), getDefaultCloseActionListener()
  - getDefaultPinActionListener
```
public ActionListener getDefaultPinActionListener()
```
    Returns the default pin action listener for the dockable panes. The actionPerformed method of the listener hides the panel.
    
    See Also:
    
    setPinActionListener(String, ActionListener), setPinActionListener(ActionListener)
  - setPinActionListener
```
public void setPinActionListener(String dockablePane,
                                 ActionListener action)
```
    Sets the pin action listener for the dockable whose name is dockablePane This action listener will be invoked when the user hits the pin icon of the dockable pane.
    
    See Also:
    
    setPinActionListener(ActionListener), getDefaultPinActionListener()
  - setPinActionListener
```
public void setPinActionListener(ActionListener action)
```
    Sets a global action listener for all the dockable panes of the application. If no specific action listener have been installed for a dockable pane, this action listener will be invoked.
    
    See Also:
    
    setPinActionListener(String, ActionListener), getDefaultPinActionListener()
  - updateComponentTreeUI
```
public void updateComponentTreeUI()
```
    A simple minded look and feel change: ask each node in the main window's tree and in the list of floatable windows to call updateUI() to initialize its UI property with the current look and feel.
  - setCursor
```
public void setCursor(Cursor cursor)
```
    Sets the cursor image to the specified cursor. This cursor image is displayed when the contains method for this component returns true for the current cursor location, and this Component is visible, displayable, and enabled. Setting the cursor of a Container causes that cursor to be displayed within all of the container's subcomponents, except for those that have a non-null cursor.
    
    Overrides:
    
    setCursor in class Component
    
    Parameters:
    
    cursor - One of the constants defined by the Cursor class; if this parameter is null then this component will inherit the cursor of its parent.
  - setDefaultFloatingMinimumSize
```
public void setDefaultFloatingMinimumSize(Dimension d)
```
    Sets the minimum size of the floatable window. This size is used when the user undocks an IlvDockablePane : If the computed size of the window is smaller than the minimum size, the window will be adjusted to this minimum size.
    
    See Also:
    
    getDefaultFloatingMinimumSize(java.awt.Dimension), setDefaultFloatingMaximumSize(java.awt.Dimension), getDefaultFloatingMaximumSize(java.awt.Dimension)
  - getDefaultFloatingMinimumSize
```
public Dimension getDefaultFloatingMinimumSize(Dimension d)
```
    Retrieves the minimum size of the floatable window. This size is used when the user undocks an IlvDockablePane : If the computed size of the window is smaller than the minimum size, the window will be adjusted to this minimum size.
    
    See Also:
    
    setDefaultFloatingMinimumSize(java.awt.Dimension), setDefaultFloatingMaximumSize(java.awt.Dimension), getDefaultFloatingMaximumSize(java.awt.Dimension)
  - setDefaultFloatingMaximumSize
```
public void setDefaultFloatingMaximumSize(Dimension d)
```
    Sets the maximum size of the floatable window. This size is used when the user undocks an IlvDockablePane : If the computed size of the window is greater than the maximum size, the window will be adjusted to this maximum size.
    
    See Also:
    
    setDefaultFloatingMinimumSize(java.awt.Dimension), getDefaultFloatingMinimumSize(java.awt.Dimension), getDefaultFloatingMaximumSize(java.awt.Dimension)
  - getDefaultFloatingMaximumSize
```
public Dimension getDefaultFloatingMaximumSize(Dimension d)
```
    Retrieves the maximum size of the floatable window. This size is used when the user undocks an IlvDockablePane : If the computed size of the window is greater than the maximum size, the window will be adjusted to this maximum size.
    
    See Also:
    
    setDefaultFloatingMinimumSize(java.awt.Dimension), getDefaultFloatingMinimumSize(java.awt.Dimension), setDefaultFloatingMaximumSize(java.awt.Dimension)
  - setUsingPreferredSize
```
public void setUsingPreferredSize(boolean b)
```
    Specifies if the default floating window size is to be determined accordingly to the preferred size of the contained component. If the argument is set to false, the size is set to the undocked component size.
    
    See Also:
    
    isUsingPreferredSize()
  - isUsingPreferredSize
```
public boolean isUsingPreferredSize()
```
    Tells if the default floating window size is determined with the preferred size of the contained component or if it should take the undocked component size.
    
    See Also:
    
    setUsingPreferredSize(boolean)
  - isReadUserSettings
```
public boolean isReadUserSettings()
```
    Determines whether this docking area is initialized according to the user settings that were saved during the last application session. If no user settings were found, the docking area is initialized according to the application settings.
    This method returns the value set with the last call to the method setReadUserSettings(boolean). If this method has not been called, this method returns true.
    
    Returns:
    
    true if the docking area initializes its content according to the user settings; false otherwise.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    setReadUserSettings(boolean), isWriteUserSettings(), setWriteUserSettings(boolean)
  - setReadUserSettings
```
public void setReadUserSettings(boolean readUserSettings)
```
    Specifies if the docking area is initialized according to the user settings. This method must be invoked before the docking area initializes its content from the settings, that is before the main window that contains the docking area is connected to the application. See the method IlvMainWindow.setApplication(ilog.views.appframe.IlvApplication) for more details.
    
    Parameters:
    
    readUserSettings - If true, this docking area is initialized according to the user settings, if any. If false, the docking area is initialized according to the application settings.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    isReadUserSettings(), isWriteUserSettings(), setWriteUserSettings(boolean)
  - isWriteUserSettings
```
public boolean isWriteUserSettings()
```
    Determines whether this docking area saves the current layout of its dockable panes in the user settings when the application is closing.
    
    Returns:
    
    true if the docking area saves the layout in the user settings; false otherwise.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    isReadUserSettings(), setReadUserSettings(boolean), setWriteUserSettings(boolean)
  - setWriteUserSettings
```
public void setWriteUserSettings(boolean writeUserSettings)
```
    Specifies if the docking area should write the current layout of its dockable panes in the user settings when the application is closing.
    
    Parameters:
    
    writeUserSettings - If true, this docking area saves its layout in the user settings. If false, the current layout of the docking area will not be saved in the user settings and will not be restored for the next application session.
    
    Since:
    
    JViews6.0
    
    See Also:
    
    isReadUserSettings(), setReadUserSettings(boolean), isWriteUserSettings()
  - setComponentOrientation
```
public void setComponentOrientation(ComponentOrientation o)
```
    Sets the language-sensitive orientation that is to be used to order the elements or text within this component. See Component.setComponentOrientation(java.awt.ComponentOrientation) for more details.
    
    Overrides:
    
    setComponentOrientation in class Component
    
    Since:
    
    JViews6.0
    
    See Also:
    
    ComponentOrientation
  - setAllowingDocking
```
public void setAllowingDocking(boolean allow)
```
    Specifies if docking and undocking windows is allowed.
    
    Parameters:
    
    allow - if true docking and undocking windows is allowed. if false docking and undocking windows is not allowed.
    
    Since:
    
    JViews 6.5
  - isAllowingDocking
```
public boolean isAllowingDocking()
```
    Tells if docking and undocking windows is allowed.
    
    Returns:
    
    true if docking and undocking is allowed, false otherwise.
    
    Since:
    
    JViews 6.5
  - setDockableThreshold
```
public void setDockableThreshold(int pixels)
```
    Set the number of pixel that must be traversed by the mouse before a drag operation begins.
    
    Since:
    
    JViews 6.5
  - getDockableThreshold
```
public int getDockableThreshold()
```
    Returns the number of pixel needed to be traversed by the mouse before a drag operation begins.
    
    Since:
    
    JViews 6.5
  - setConstraintFloatable
```
public void setConstraintFloatable(boolean c)
```
    Tells the docking area if it should constraint the floatable windows into the visible screen area.
    
    Since:
    
    JViews 6.5
  - isConstraintFloatable
```
public boolean isConstraintFloatable()
```
    Tells if the docking area constraints the floatable windows into the visible screen area.
    
    Since:
    
    JViews 6.5

Class IlvDockingArea

Nested Class Summary

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.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

CONTENT_PANE_PROPERTY

LAYERED_PANE_PROPERTY

ROOT_PANE_PROPERTY

GLASS_PANE_PROPERTY

TITLE_PROPERTY

ICON_PROPERTY

TAB_ICON_PROPERTY

TOOLTIP_PROPERTY

PINABLE_PROPERTY

CLOSABLE_PROPERTY

DOCKABLE_PROPERTY

SCROLLABLE_PROPERTY

TITLE_VISIBLE_PROPERTY

FIXED_WIDTH_PROPERTY

FIXED_HEIGHT_PROPERTY

PIN_STATE_PROPERTY

MINIMUM_SIZE_PROPERTY

WORKSPACE_DISPLAYED_NAME_PROPERTY

WORKSPACE_ICON_PROPERTY

WORKSPACE_DESCRIPTION_PROPERTY

WORKSPACE_TOOLTIP_PROPERTY

WORKSPACE_ACTION_COMMAND_PROPERTY

WORKSPACE_WRITABLE_PROPERTY

Constructor Detail

IlvDockingArea

Method Detail

createRootPane

isRootPaneCheckingEnabled

setRootPaneCheckingEnabled

addImpl

setLayout

getContentPane

setContentPane

getLayeredPane

setLayeredPane

getGlassPane

setGlassPane

getRootPane

setRootPane

getApplication

setApplication

setWorkspaceConfiguration

getWorkspaceConfiguration

duplicateWorkspaceConfiguration

readWorkspaceConfiguration

writeWorkspaceConfiguration

removeWorkspaceConfiguration

getWorkspaceProperty

setWorkspaceProperty

addWorkspacePropertyChangeListener

removeWorkspacePropertyChangeListener

getWorkspaceConfigurations

setWorkspaceActivationAction

setDockableComponent

setDockableProperties

setDockableProperty

getDockableProperty

getDockableComponent

getDockableView

getActiveDockable

setActiveDockable

getActiveDockableName

setActiveDockable

addDockingListener