public class IlvDockingArea extends JComponent implements RootPaneContainer
IlvDockingArea
provides API to set and
retrieve these user components and associate them with the
dockables defined by configuration.
IlvDockingArea
also provides a listener interface
for notification of docking events when a docking state
is changed by user interaction.JComponent.AccessibleJComponent
Container.AccessibleAWTContainer
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
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.
|
listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW
accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
Constructor and Description |
---|
IlvDockingArea()
Constructs a new
IlvDockingArea . |
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. |
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
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
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
public static final String CONTENT_PANE_PROPERTY
public static final String LAYERED_PANE_PROPERTY
public static final String ROOT_PANE_PROPERTY
public static final String GLASS_PANE_PROPERTY
public static final String TITLE_PROPERTY
public static final String ICON_PROPERTY
public static final String TAB_ICON_PROPERTY
public static final String TOOLTIP_PROPERTY
public static final String PINABLE_PROPERTY
public static final String CLOSABLE_PROPERTY
public static final String DOCKABLE_PROPERTY
public static final String SCROLLABLE_PROPERTY
public static final String TITLE_VISIBLE_PROPERTY
public static final String FIXED_WIDTH_PROPERTY
public static final String FIXED_HEIGHT_PROPERTY
public static final String PIN_STATE_PROPERTY
public static final String MINIMUM_SIZE_PROPERTY
public static final String WORKSPACE_DISPLAYED_NAME_PROPERTY
getWorkspaceProperty(java.lang.String, java.lang.String)
,
Constant Field Valuespublic static final String WORKSPACE_ICON_PROPERTY
getWorkspaceProperty(java.lang.String, java.lang.String)
,
Constant Field Valuespublic static final String WORKSPACE_DESCRIPTION_PROPERTY
getWorkspaceProperty(java.lang.String, java.lang.String)
,
Constant Field Valuespublic static final String WORKSPACE_TOOLTIP_PROPERTY
getWorkspaceProperty(java.lang.String, java.lang.String)
,
Constant Field Valuespublic static final String WORKSPACE_ACTION_COMMAND_PROPERTY
getWorkspaceProperty(java.lang.String, java.lang.String)
,
Constant Field Valuespublic static final String WORKSPACE_WRITABLE_PROPERTY
If this property equals Boolean.FALSE
,
the workspace is not saved in the user settings. Otherwise, the
workspace is saved in the user settings.
getWorkspaceProperty(java.lang.String, java.lang.String)
,
Constant Field Valuesprotected JRootPane createRootPane()
JRootPane
.JRootPane
.JRootPane
protected boolean isRootPaneCheckingEnabled()
add
and
setLayout
cause an exception to be thrown.true
if add
and
setLayout
are checked.addImpl(java.awt.Component, java.lang.Object, int)
,
setLayout(java.awt.LayoutManager)
,
setRootPaneCheckingEnabled(boolean)
protected void setRootPaneCheckingEnabled(boolean enabled)
add
and
setLayout
cause an exception to be thrown.enabled
- A boolean value, true
if checking is to be
enabled, which causes the exceptions to be thrownaddImpl(java.awt.Component, java.lang.Object, int)
,
setLayout(java.awt.LayoutManager)
,
isRootPaneCheckingEnabled()
protected void addImpl(Component comp, Object constraints, int index)
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.
addImpl
in class Container
comp
- The Component
to be added.constraints
- The object containing the constraints, if any.index
- The index.Error
- if called with isRootPaneChecking
true
.setRootPaneCheckingEnabled(boolean)
public void setLayout(LayoutManager manager)
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.
setLayout
in class Container
manager
- the LayoutManager
Error
- if called with isRootPaneChecking
.
true
setRootPaneCheckingEnabled(boolean)
public Container getContentPane()
getContentPane
in interface RootPaneContainer
public void setContentPane(Container c)
contentPane
property of this IlvDockingArea
.setContentPane
in interface RootPaneContainer
c
- The content pane for this internal frame.IllegalComponentStateException
- (a runtime
exception) if the content pane parameter is null
.RootPaneContainer.getContentPane()
public JLayeredPane getLayeredPane()
getLayeredPane
in interface RootPaneContainer
JLayeredPane
object.RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)
,
RootPaneContainer.getLayeredPane()
public void setLayeredPane(JLayeredPane layered)
layeredPane
property of this IlvDockingArea
.setLayeredPane
in interface RootPaneContainer
layered
- The JLayeredPane
for this internal frame.IllegalComponentStateException
- (a runtime
exception) if the layered pane parameter is null
.RootPaneContainer.setLayeredPane(javax.swing.JLayeredPane)
public Component getGlassPane()
getGlassPane
in interface RootPaneContainer
RootPaneContainer.setGlassPane(java.awt.Component)
public void setGlassPane(Component glass)
glassPane
property of this IlvDockingArea
.setGlassPane
in interface RootPaneContainer
glass
- The glass pane for this internal frame.RootPaneContainer.getGlassPane()
public JRootPane getRootPane()
rootPane
object for this internal frame.getRootPane
in interface RootPaneContainer
getRootPane
in class JComponent
rootPane
property.RootPaneContainer.getRootPane()
protected void setRootPane(JRootPane root)
rootPane
property
for this IlvDockingArea
.
This method is called by the constructor.root
- The new JRootPane
object.public IlvApplication getApplication()
public void setApplication(IlvApplication application)
application
- The new application of the docking area.public void setWorkspaceConfiguration(String name)
name
.getWorkspaceConfiguration()
public String getWorkspaceConfiguration()
public boolean duplicateWorkspaceConfiguration(String name, String newName)
name
into the configuration with the new name newName
.name
- The name of the configuration to duplicate.newName
- The name of the new created configuration.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
.getWorkspaceConfiguration()
,
readWorkspaceConfiguration(java.lang.String, ilog.views.appframe.settings.IlvSettingsElement)
public void readWorkspaceConfiguration(String name, IlvSettingsElement element)
name
from the settings.
If no workspace configuration is defined with the specified name, a new one is added to this docking area.
name
- The name of the docking configuration to add.element
- The settings element that contains the definition
of the docking configuration.writeWorkspaceConfiguration(java.lang.String, ilog.views.appframe.settings.IlvSettingsElement)
,
removeWorkspaceConfiguration(java.lang.String)
public void writeWorkspaceConfiguration(String name, IlvSettingsElement element)
name
into the settings.name
- The name of the workspace configuration.element
- The settings element to save the workspace
configuration in.readWorkspaceConfiguration(java.lang.String, ilog.views.appframe.settings.IlvSettingsElement)
,
writeWorkspaceConfiguration(java.lang.String, ilog.views.appframe.settings.IlvSettingsElement)
public boolean removeWorkspaceConfiguration(String name)
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.
name
- The name of the configuration to remove.true
if the operation succeeded. Otherwise,
if the specified name
does not correspond to
a valid configuration name, this method returns false
.getWorkspaceConfiguration()
,
duplicateWorkspaceConfiguration(java.lang.String, java.lang.String)
public Object getWorkspaceProperty(String name, String propertyName)
propertyName
property
of the specified
workspace configuration.
Predefined workspace properties are:
name
- The name of the workspace configuration.propertyName
- The name of the property to retrieve.propertyName
property.
This method returns null
if no property is defined
with the specified name for this workspace configuration.setWorkspaceProperty(java.lang.String, java.lang.String, java.lang.Object)
public void setWorkspaceProperty(String name, String propertyName, Object value)
propertyName
property of the specified
workspace configuration to the specified value
.name
- The name of the workspace configuration.propertyName
- The name of the property to set.value
- The value to set to the property.getWorkspaceProperty(java.lang.String, java.lang.String)
public void addWorkspacePropertyChangeListener(String name, PropertyChangeListener listener)
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
.
name
- The name of the workspace configuration.listener
- The listener to be added.removeWorkspacePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
,
setWorkspaceProperty(java.lang.String, java.lang.String, java.lang.Object)
public void removeWorkspacePropertyChangeListener(String name, PropertyChangeListener listener)
PropertyChangeListener
to the list of listeners
associated with the specified workspace.name
- The name of the workspace configuration.listener
- The listener to be removed.addWorkspacePropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener)
,
setWorkspaceProperty(java.lang.String, java.lang.String, java.lang.Object)
public String[] getWorkspaceConfigurations()
public void setWorkspaceActivationAction(String workspaceName, String command)
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.
workspaceName
- The name of the workspace configuration that is to
be made activated.command
- The command key of the action.public boolean setDockableComponent(String name, Component component)
name
- The name of the dockable pane to attach the component to.component
- The component to attach.true
if a dockable pane with the specified name
could be found; false
otherwise.getDockableComponent(java.lang.String)
,
setDockableProperties(java.lang.String, java.lang.String, java.lang.String, javax.swing.ImageIcon, javax.swing.ImageIcon)
public void setDockableProperties(String name, String title, String tooltip, ImageIcon windowIcon, ImageIcon tabIcon)
name
. If a pane style is defined in the settings for
the specified dockable pane, it is overridden with the specified
properties.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.getDockableComponent(java.lang.String)
,
setDockableComponent(String, Component)
,
setDockableProperty(String, String, Object)
,
getDockableProperty(String, String)
public Object setDockableProperty(String name, String propertyName, Object value)
propertyName
property of the dockable with the
specified name
.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:value
- The new value of the propertyName
property.getDockableProperty(java.lang.String, java.lang.String)
public Object getDockableProperty(String name, String propertyName)
propertyName
property of the dockable with the
specified name
.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:setDockableProperty(java.lang.String, java.lang.String, java.lang.Object)
public Component getDockableComponent(String name)
name
- The name of the dockable pane to retrieve the associated
component of.setDockableComponent(java.lang.String, java.awt.Component)
public IlvDocumentView getDockableView(String name)
name
- The name of the dockable to retrieve the document view from.null
if no document view is contained by the dockable.public ilog.views.appframe.swing.docking.dockable.IlvDockable getActiveDockable()
public void setActiveDockable(ilog.views.appframe.swing.docking.dockable.IlvDockable dockable)
dockable
- The dockable to activate.getActiveDockable()
,
setActiveDockable(String)
public String getActiveDockableName()
getActiveDockable()
,
setActiveDockable(String)
public void setActiveDockable(String name)
name
.name
- The name of the dockable to activate.getActiveDockableName()
,
setActiveDockable(IlvDockable)
public void addDockingListener(DockingListener listener)
listener
- The new docking listener.removeDockingListener(ilog.views.appframe.swing.docking.DockingListener)
public boolean removeDockingListener(DockingListener listener)
listener
- The listener to remove.true
if the listener was previously added to
the docking area; false
otherwise.addDockingListener(ilog.views.appframe.swing.docking.DockingListener)
public void lockUpdate()
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.
unlockUpdate()
public void unlockUpdate()
This method must be called after the method
lockUpdate()
is called.
public ilog.views.appframe.swing.docking.dockable.IlvDockable getDockable(String name)
name
- The name of the dockable with the specified name.public boolean isDockableVisible(String name)
name
is visible.name
- The name of the dockable to determine the visibility of.true
if the specified dockable is visible;
false
otherwise.setDockableVisible(java.lang.String, boolean)
public void setDockableVisible(String name, boolean visible)
name
,
depending on the value of the parameter show
.name
- The name of the dockable to show or hide.visible
- If true
, will show the dockable; otherwise,
hides the dockable.isDockableVisible(java.lang.String)
public boolean isDockableDocked(String name)
name
is
docked.name
- The name of the dockable.true
if the dockable is docked; false
if the dockable is hidden or floating.dock(java.lang.String)
,
isDockableUndocked(java.lang.String)
,
isDockableVisible(java.lang.String)
public boolean dock(String name)
name
at
the position defined in the settings of the docking area.
If the dockable was previously docked, this method does nothing.name
- The name of the dockable to dock.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.dock(String, int, double)
,
isDockableDocked(java.lang.String)
,
undock(java.lang.String)
public void dock(String name, int side, double proportionalSize)
name
at the specified side of the docking area.
If the dockable was previously docked, this method does nothing.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.dock(String)
,
isDockableDocked(java.lang.String)
,
undock(java.lang.String)
public boolean split(String paneToSplit, String newPaneName, int orientation, double proportionalLocation)
paneToSplit
name with
a new split pane containing this dockable pane and the new dockable
pane with the newPaneName
.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.true
if the operation is successful; false
if no dockable could be found with the specified names.public boolean addTab(String tabOnPane, String newPaneName, boolean after)
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.
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.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.addTab(java.lang.String, java.lang.String, boolean, boolean)
public boolean addTab(String tabOnPane, String newPaneName, boolean after, boolean select)
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)
.
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.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.addTab(java.lang.String, java.lang.String, boolean)
public void undock(String name)
name
.
If the dockable was previously undocked, this method does nothing.name
- The name of the dockable to undock.isDockableUndocked(java.lang.String)
,
dock(java.lang.String)
public void undock(String name, Point location)
name
at
the specified screen location.
If the dockable was previously undocked, this method does nothing.name
- The name of the dockable to undock.location
- The location of the floating window containing the
dockable.isDockableUndocked(java.lang.String)
,
undock(String)
public boolean isDockableUndocked(String name)
name
is
undocked.name
- The name of the dockable.true
if the dockable is undocked; false
if the dockable is hidden or docked.isDockableDocked(java.lang.String)
,
isDockableVisible(java.lang.String)
,
getFloatingLocation(java.lang.String)
public Point getFloatingLocation(String name)
name
.name
- The name of the dockable to retrieve the floating location
from.isDockableUndocked(java.lang.String)
returns true
);
null
otherwise.public void setDockableVisibilityAction(String dockableName, String command)
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.public void setMDIPane(String name)
It is recommended that the MDI pane corresponds to the MDI client of the application and does not have the dockable tag.
getMDIPane()
public String getMDIPane()
setMDIPane(java.lang.String)
public void setInnerSensibilityMargin(int margin)
IlvDockable
s
on which you can drop an IlvDockable
in order to dock it.public int getInnerSensibilityMargin()
IlvDockable
s
on which you can drop an IlvDockable
in order to dock it.public void setOuterSensibilityMargin(int margin)
IlvDockingArea
on which you can drop an IlvDockable
in order to dock it.public int getOuterSensibilityMargin()
IlvDockingArea
on which you can drop an IlvDockable
in order to dock it.public boolean removeDockable(String name)
name
from the docking
area.true
if the dockable belongs to the docking
area; false
otherwise.public ActionListener getDefaultCloseActionListener()
actionPerformed
method of the listener hides the panel.public void setCloseActionListener(String dockablePane, ActionListener action)
public void setCloseActionListener(ActionListener action)
public ActionListener getDefaultPinActionListener()
actionPerformed
method of the listener hides the panel.public void setPinActionListener(String dockablePane, ActionListener action)
public void setPinActionListener(ActionListener action)
public void updateComponentTreeUI()
updateUI()
to initialize its UI property with the current look and feel.public void setCursor(Cursor cursor)
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.public void setDefaultFloatingMinimumSize(Dimension d)
public Dimension getDefaultFloatingMinimumSize(Dimension d)
public void setDefaultFloatingMaximumSize(Dimension d)
public Dimension getDefaultFloatingMaximumSize(Dimension d)
public void setUsingPreferredSize(boolean b)
false
,
the size is set to the undocked component size.isUsingPreferredSize()
public boolean isUsingPreferredSize()
setUsingPreferredSize(boolean)
public boolean isReadUserSettings()
setReadUserSettings(boolean)
. If this method
has not been called, this method returns true
.true
if the docking area initializes its content
according to the user settings; false
otherwise.setReadUserSettings(boolean)
,
isWriteUserSettings()
,
setWriteUserSettings(boolean)
public void setReadUserSettings(boolean readUserSettings)
IlvMainWindow.setApplication(ilog.views.appframe.IlvApplication)
for more details.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.isReadUserSettings()
,
isWriteUserSettings()
,
setWriteUserSettings(boolean)
public boolean isWriteUserSettings()
true
if the docking area saves the
layout in the user settings; false
otherwise.isReadUserSettings()
,
setReadUserSettings(boolean)
,
setWriteUserSettings(boolean)
public void setWriteUserSettings(boolean writeUserSettings)
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.isReadUserSettings()
,
setReadUserSettings(boolean)
,
isWriteUserSettings()
public void setComponentOrientation(ComponentOrientation o)
Component.setComponentOrientation(java.awt.ComponentOrientation)
for more details.setComponentOrientation
in class Component
ComponentOrientation
public void setAllowingDocking(boolean allow)
allow
- if true
docking and undocking windows is allowed.
if false
docking and undocking windows is not allowed.public boolean isAllowingDocking()
true
if docking and undocking is allowed, false
otherwise.public void setDockableThreshold(int pixels)
public int getDockableThreshold()
public void setConstraintFloatable(boolean c)
public boolean isConstraintFloatable()
© Copyright Rogue Wave Software, Inc. 1997, 2018. All Rights Reserved.