com.alee.extended.dock

Class WebDockablePane

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.alee.extended.WebComponent<C,U>

com.alee.extended.WebContainer<WebDockablePane,WDockablePaneUI>

com.alee.extended.dock.WebDockablePane

All Implemented Interfaces:

LanguageEventMethods, LanguageMethods, SettingsMethods, Styleable, ToolTipMethods, ContainerMethods<WebDockablePane>, EventMethods, FontMethods<WebDockablePane>, MethodExtension, SizeMethods<WebDockablePane>, ImageObserver, MenuContainer, Serializable

public class WebDockablePane
extends WebContainer<WebDockablePane,WDockablePaneUI>

Implementation of a pane containing WebDockableFrames. WebDockableFrames can be added to the pane, repositioned within it, minimized, previewed, made floating or closed. Note that closing the frame doesn't remove it from the pane, but only changes it's state to DockableFrameState.closed. Positioning of the frames is handled by the currently installed DockablePaneModel implementation. Resize of the WebDockableFrames and their drop position while dragged is handled by the DockablePaneGlassLayer. This component should never be used with a non-Web UIs as it might cause an unexpected behavior. You could still use that component even if WebLaF is not your application LaF as this component will use Web-UI in any case.

Author:

Mikle Garin

See Also:

How to use WebDockablePane, WebDockablePaneModel, DockablePaneModel, DockablePaneGlassLayer, DockablePaneDescriptor, WDockablePaneUI, WebDockablePaneUI, IDockablePanePainter, DockablePanePainter, WebContainer, 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
protected JComponent	content Content component.
static String	CONTENT_PROPERTY
static String	CONTENT_SPACING_PROPERTY
protected int	contentSpacing Spacing between content elements.
static String	FRAME_PROPERTY
protected List<WebDockableFrame>	frames List of frames added to this WebDockablePane.
static String	FRAMES_PROPERTY
static String	GLASS_LAYER_PROPERTY
protected JComponent	glassLayer Glass layer component.
static String	GROUP_ELEMENTS_PROPERTY
protected boolean	groupElements Whether or not dockable pane elements should be visually grouped.
static String	MINIMUM_ELEMENT_SIZE_PROPERTY
protected Dimension	minimumElementSize Minimum size of WebDockableFrame or content component added onto the dockable pane.
protected DockablePaneModel	model Model containing information about dockable pane elements.
static String	MODEL_PROPERTY
static String	MODEL_STATE_PROPERTY
static String	OCCUPY_MINIMUM_SIZE_FOR_CHILDREN_PROPERTY
protected boolean	occupyMinimumSizeForChildren Whether containers minimum size should include children minimum sizes or simply be equal to minimumElementSize.
static String	RESIZE_GRIPPER_WIDTH_PROPERTY
protected int	resizeGripperWidth Content elements resize gripper width.
static String	SIDEBAR_BUTTON_ACTION_PROPERTY
static String	SIDEBAR_BUTTON_VISIBILITY_PROPERTY Component properties.
static String	SIDEBAR_SPACING_PROPERTY
protected SidebarButtonAction	sidebarButtonAction Sidebar button action.
protected SidebarButtonVisibility	sidebarButtonVisibility Sidebar buttons visibility type.
protected int	sidebarSpacing Spacing between sidebars elements and other elements.

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 com.alee.utils.swing.extensions.SizeMethods

UNDEFINED

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
WebDockablePane() Constructs new dockable pane.
WebDockablePane(StyleId id) Constructs new dockable pane.

Method Summary

Modifier and Type	Method and Description
void	addDockablePaneListener(DockablePaneListener listener) Adds new DockablePaneListener.
WebDockableFrame	addFrame(WebDockableFrame frame) Adds specified WebDockableFrame into this WebDockablePane.
void	applyComponentOrientation(ComponentOrientation orientation)
protected DockablePaneModel	createDefaultModel() Returns default DockablePaneModel implementation to be used.
WebDockableFrame	findFrame(String id) Returns WebDockableFrame with the specified identifier or null if it doesn't exist within WebDockablePane.
void	fireFrameAdded(WebDockableFrame frame, WebDockablePane dockablePane) Informs listeners about WebDockableFrame being added.
void	fireFrameMoved(WebDockableFrame frame, CompassDirection position) Informs listeners about WebDockableFrame being moved.
void	fireFrameRemoved(WebDockableFrame frame, WebDockablePane dockablePane) Informs listeners about WebDockableFrame being removed.
void	fireFrameStateChanged(WebDockableFrame frame, DockableFrameState oldState, DockableFrameState newState) Informs listeners about WebDockableFrame state change.
JComponent	getContent() Returns current content JComponent.
int	getContentSpacing() Returns spacing between content elements.
StyleId	getDefaultStyleId() Returns default component StyleId.
WebDockableFrame	getFrame(String id) Returns WebDockableFrame with the specified identifier.
List<WebDockableFrame>	getFrames() Returns list of dockable frames added to this WebDockablePane.
List<WebDockableFrame>	getFrames(CompassDirection position) Returns List of WebDockableFrames added to this WebDockablePane and positioned on the specified side.
JComponent	getGlassLayer() Returns glass layer component.
WebDockableFrame	getMaximizedFrame() Returns currently maximized WebDockableFrame or null if none maximized.
Dimension	getMinimumElementSize() Returns minimum size of WebDockableFrame or content component added onto the dockable pane.
DockablePaneModel	getModel() Returns model containing information about dockable pane elements.
int	getResizeGripperWidth() Returns content elements resize gripper width.
SidebarButtonAction	getSidebarButtonAction() Returns sidebar button action.
SidebarButtonVisibility	getSidebarButtonVisibility() Returns SidebarButtons visibility condition.
int	getSidebarSpacing() Returns spacing between sidebars elements and other elements.
DockableContainer	getState() Returns dockable pane element states data.
WDockablePaneUI	getUI() Returns the look and feel (LaF) object that renders this component.
String	getUIClassID()
boolean	isGroupElements() Returns whether or not dockable pane elements should be visually grouped.
boolean	isOccupyMinimumSizeForChildren() Returns whether containers minimum size should include children sizes or simply be equal to minimumElementSize.
void	removeDockablePaneListener(DockablePaneListener listener) Removes specified DockablePaneListener.
WebDockableFrame	removeFrame(WebDockableFrame frame) Removes specified WebDockableFrame from this WebDockablePane.
JComponent	setContent(JComponent content) Sets content JComponent.
WebDockablePane	setContentSpacing(int spacing) Sets spacing between content elements.
WebDockablePane	setGlassLayer(JComponent glassLayer) Sets glass layer component.
WebDockablePane	setGroupElements(boolean group) Sets whether or not dockable pane elements should be visually grouped.
WebDockablePane	setMinimumElementSize(Dimension size) Sets minimum size of WebDockableFrame or content component added onto the dockable pane.
WebDockablePane	setModel(DockablePaneModel model) Sets model containing information about dockable pane elements.
WebDockablePane	setOccupyMinimumSizeForChildren(boolean occupy) Sets whether containers minimum size should include children sizes or simply be equal to minimumElementSize.
WebDockablePane	setResizeGripperWidth(int resizeGripperWidth) Sets content elements resize gripper width.
WebDockablePane	setSidebarButtonAction(SidebarButtonAction action) Sets sidebar button action.
WebDockablePane	setSidebarButtonVisibility(SidebarButtonVisibility condition) Sets SidebarButtons visibility condition.
WebDockablePane	setSidebarSpacing(int spacing) Sets spacing between sidebars elements and other elements.
WebDockablePane	setState(DockableContainer state) Sets dockable pane element states data.
void	setUI(WDockablePaneUI ui) Sets the LaF object that renders this component.
void	updateUI()

Methods inherited from class com.alee.extended.WebContainer

add, add, add, add, add, contains, equalizeComponentsHeight, equalizeComponentsSize, equalizeComponentsWidth, forEach, getFirstComponent, getLastComponent, remove, remove, removeAll

Methods inherited from class com.alee.extended.WebComponent

addDictionaryListener, addLanguageListener, addStyleListener, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, addToolTip, changeFontSize, getCustomPainter, getFontName, getFontSize, getLanguage, getMargin, getMaximumHeight, getMaximumSize, getMaximumWidth, getMinimumHeight, getMinimumSize, getMinimumWidth, getOriginalMaximumSize, getOriginalMinimumSize, getOriginalPreferredSize, getPadding, getPainterShape, getPreferredHeight, getPreferredSize, getPreferredWidth, getSkin, getStyleId, isBoldFont, isItalicFont, isLanguageSet, isPlainFont, isShapeDetectionEnabled, loadSettings, onDoubleClick, onDragStart, onDragStart, onFocusGain, onFocusLoss, onKeyPress, onKeyPress, onKeyRelease, onKeyRelease, onKeyType, onKeyType, onMenuTrigger, onMouseClick, onMouseClick, onMouseDrag, onMouseDrag, onMouseEnter, onMouseExit, onMousePress, onMousePress, registerSettings, registerSettings, removeDictionaryListener, removeDictionaryListeners, removeLanguage, removeLanguageListener, removeLanguageListeners, removeLanguageUpdater, removeStyleListener, removeToolTip, removeToolTips, removeToolTips, removeToolTips, resetCustomPainter, resetSkin, resetStyleId, saveSettings, setBoldFont, setBoldFont, setCustomPainter, setFontName, setFontSize, setFontSizeAndStyle, setFontSizeAndStyle, setFontStyle, setFontStyle, setItalicFont, setItalicFont, setLanguage, setLanguageUpdater, setMargin, setMargin, setMargin, setMaximumHeight, setMaximumSize, setMaximumWidth, setMinimumHeight, setMinimumSize, setMinimumWidth, setPadding, setPadding, setPadding, setPlainFont, setPlainFont, setPreferredHeight, setPreferredSize, setPreferredWidth, setShapeDetectionEnabled, setSkin, setSkin, setStyleId, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, setToolTip, unregisterSettings, updateLanguage, updateLanguage

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, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, 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

Methods inherited from class java.awt.Container

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

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, 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, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SIDEBAR_BUTTON_VISIBILITY_PROPERTY

public static final String SIDEBAR_BUTTON_VISIBILITY_PROPERTY

Component properties.

See Also:

Constant Field Values

SIDEBAR_BUTTON_ACTION_PROPERTY

public static final String SIDEBAR_BUTTON_ACTION_PROPERTY

See Also:

Constant Field Values

GROUP_ELEMENTS_PROPERTY

public static final String GROUP_ELEMENTS_PROPERTY

See Also:

Constant Field Values

SIDEBAR_SPACING_PROPERTY

public static final String SIDEBAR_SPACING_PROPERTY

See Also:

Constant Field Values

CONTENT_SPACING_PROPERTY

public static final String CONTENT_SPACING_PROPERTY

See Also:

Constant Field Values

RESIZE_GRIPPER_WIDTH_PROPERTY

public static final String RESIZE_GRIPPER_WIDTH_PROPERTY

See Also:

Constant Field Values

MINIMUM_ELEMENT_SIZE_PROPERTY

public static final String MINIMUM_ELEMENT_SIZE_PROPERTY

See Also:

Constant Field Values

OCCUPY_MINIMUM_SIZE_FOR_CHILDREN_PROPERTY

public static final String OCCUPY_MINIMUM_SIZE_FOR_CHILDREN_PROPERTY

See Also:

Constant Field Values

MODEL_PROPERTY

public static final String MODEL_PROPERTY

See Also:

Constant Field Values

MODEL_STATE_PROPERTY

public static final String MODEL_STATE_PROPERTY

See Also:

Constant Field Values

GLASS_LAYER_PROPERTY

public static final String GLASS_LAYER_PROPERTY

See Also:

Constant Field Values

FRAMES_PROPERTY

public static final String FRAMES_PROPERTY

See Also:

Constant Field Values

FRAME_PROPERTY

public static final String FRAME_PROPERTY

See Also:

Constant Field Values

CONTENT_PROPERTY

public static final String CONTENT_PROPERTY

See Also:

Constant Field Values

sidebarButtonVisibility

@NotNull
protected SidebarButtonVisibility sidebarButtonVisibility

Sidebar buttons visibility type.

See Also:

SidebarButtonVisibility

sidebarButtonAction

@NotNull
protected SidebarButtonAction sidebarButtonAction

Sidebar button action.

groupElements

protected boolean groupElements

Whether or not dockable pane elements should be visually grouped. This will only work with zero contentSpacing as there is no point to visually group elements otherwise. Also note that sidebarSpacing value will have no effect on this setting as it is used to provide correct padding.

sidebarSpacing

protected int sidebarSpacing

Spacing between sidebars elements and other elements. todo Remove once sidebars are properly implemented as separate containers, it will be covered by container's padding

contentSpacing

protected int contentSpacing

Spacing between content elements. todo Move into DockablePaneLayout once it's separated from the model

resizeGripperWidth

protected int resizeGripperWidth

Content elements resize gripper width. This setting represents actual draggable area width and not visual representation width. It can be larger than contentSpacing and will overlap elements in that case blocking their mouse events.

minimumElementSize

@NotNull
protected Dimension minimumElementSize

Minimum size of WebDockableFrame or content component added onto the dockable pane.

occupyMinimumSizeForChildren

protected boolean occupyMinimumSizeForChildren

Whether containers minimum size should include children minimum sizes or simply be equal to minimumElementSize.

model

protected DockablePaneModel model

Model containing information about dockable pane elements. It stores all information on frames and content location specifics.

glassLayer

protected JComponent glassLayer

Glass layer component. It usually handles frames resize and displays frame placement locations while any frame is being dragged.

frames

protected final List<WebDockableFrame> frames

List of frames added to this WebDockablePane. This list only contains frames opened frames. Upon closing frame it gets removed from the pane and this list.

content

protected JComponent content

Content component. Content takes all free space left after frames positioning.

Constructor Detail

WebDockablePane

public WebDockablePane()

Constructs new dockable pane.

WebDockablePane

public WebDockablePane(@NotNull
                       StyleId id)

Constructs new dockable pane.

Parameters:

id - StyleId

Method Detail

getDefaultStyleId

@NotNull
public StyleId getDefaultStyleId()

Description copied from interface: Styleable

Returns default component StyleId. This method is asked when initial component StyleId have to be provided.

Returns:

default component StyleId

getSidebarButtonVisibility

@NotNull
public SidebarButtonVisibility getSidebarButtonVisibility()

Returns SidebarButtons visibility condition.

Returns:

SidebarButtons visibility condition

setSidebarButtonVisibility

@NotNull
public WebDockablePane setSidebarButtonVisibility(@NotNull
                                                           SidebarButtonVisibility condition)

Sets SidebarButtons visibility condition.

Parameters:

condition - SidebarButtons visibility condition

Returns:

this WebDockablePane

getSidebarButtonAction

@NotNull
public SidebarButtonAction getSidebarButtonAction()

Returns sidebar button action.

Returns:

sidebar button action

setSidebarButtonAction

@NotNull
public WebDockablePane setSidebarButtonAction(@NotNull
                                                       SidebarButtonAction action)

Sets sidebar button action.

Parameters:

action - sidebar button action

Returns:

this WebDockablePane

isGroupElements

public boolean isGroupElements()

Returns whether or not dockable pane elements should be visually grouped.

Returns:

true if dockable pane elements should be visually grouped, false otherwise

setGroupElements

@NotNull
public WebDockablePane setGroupElements(boolean group)

Sets whether or not dockable pane elements should be visually grouped. Note that this will only work with zero contentSpacing as there is no point to visually group elements otherwise. Also note that sidebarSpacing value will have no effect on this setting as it is used to provide correct padding.

Parameters:

group - whether or not dockable pane elements should be visually grouped

Returns:

this WebDockablePane

getSidebarSpacing

public int getSidebarSpacing()

Returns spacing between sidebars elements and other elements.

Returns:

spacing between sidebars elements and other elements

setSidebarSpacing

@NotNull
public WebDockablePane setSidebarSpacing(int spacing)

Sets spacing between sidebars elements and other elements.

Parameters:

spacing - spacing between sidebars elements and other elements

Returns:

this WebDockablePane

getContentSpacing

public int getContentSpacing()

Returns spacing between content elements.

Returns:

spacing between content elements

setContentSpacing

@NotNull
public WebDockablePane setContentSpacing(int spacing)

Sets spacing between content elements.

Parameters:

spacing - spacing between content elements

Returns:

this WebDockablePane

getResizeGripperWidth

public int getResizeGripperWidth()

Returns content elements resize gripper width.

Returns:

content elements resize gripper width

setResizeGripperWidth

@NotNull
public WebDockablePane setResizeGripperWidth(int resizeGripperWidth)

Sets content elements resize gripper width.

Parameters:

resizeGripperWidth - content elements resize gripper width

Returns:

this WebDockablePane

getMinimumElementSize

@NotNull
public Dimension getMinimumElementSize()

Returns minimum size of WebDockableFrame or content component added onto the dockable pane.

Returns:

minimum size of WebDockableFrame or content component added onto the dockable pane

setMinimumElementSize

@NotNull
public WebDockablePane setMinimumElementSize(@NotNull
                                                      Dimension size)

Sets minimum size of WebDockableFrame or content component added onto the dockable pane.

Parameters:

size - minimum size of WebDockableFrame or content component added onto the dockable pane

Returns:

this WebDockablePane

isOccupyMinimumSizeForChildren

public boolean isOccupyMinimumSizeForChildren()

Returns whether containers minimum size should include children sizes or simply be equal to minimumElementSize.

Returns:

true if containers minimum size should include children sizes, false if it should be equal to minimumElementSize

setOccupyMinimumSizeForChildren

@NotNull
public WebDockablePane setOccupyMinimumSizeForChildren(boolean occupy)

Sets whether containers minimum size should include children sizes or simply be equal to minimumElementSize.

Parameters:

occupy - whether containers minimum size should include children sizes or simply be equal to minimumElementSize

Returns:

this WebDockablePane

getModel

@NotNull
public DockablePaneModel getModel()

Returns model containing information about dockable pane elements.

Returns:

model containing information about dockable pane elements

setModel

@NotNull
public WebDockablePane setModel(@NotNull
                                         DockablePaneModel model)

Sets model containing information about dockable pane elements.

Parameters:

model - model containing information about dockable pane elements

Returns:

this WebDockablePane

createDefaultModel

@NotNull
protected DockablePaneModel createDefaultModel()

Returns default DockablePaneModel implementation to be used.

Returns:

default DockablePaneModel implementation to be used

getState

@NotNull
public DockableContainer getState()

Returns dockable pane element states data. It contains data which can be used to restore dockable element states.

Returns:

dockable pane element states data

See Also:

setState(DockableContainer)

setState

@NotNull
public WebDockablePane setState(@NotNull
                                         DockableContainer state)

Sets dockable pane element states data. This data can be retrieved from dockable pane at any time in runtime.

Parameters:

state - dockable pane element states data

Returns:

this WebDockablePane

See Also:

getState()

getGlassLayer

@Nullable
public JComponent getGlassLayer()

Returns glass layer component.

Returns:

glass layer component

setGlassLayer

@NotNull
public WebDockablePane setGlassLayer(@Nullable
                                              JComponent glassLayer)

Sets glass layer component.

Parameters:

glassLayer - glass layer component

Returns:

this WebDockablePane

getFrames

@NotNull
public List<WebDockableFrame> getFrames()

Returns list of dockable frames added to this WebDockablePane.

Returns:

list of dockable frames added to this WebDockablePane

getFrames

@NotNull
public List<WebDockableFrame> getFrames(@NotNull
                                                 CompassDirection position)

Returns List of WebDockableFrames added to this WebDockablePane and positioned on the specified side.

Parameters:

position - frames position relative to content area

Returns:

List of WebDockableFrames added to this WebDockablePane and positioned on the specified side

See Also:

WebDockableFrame.getPosition()

getFrame

@NotNull
public WebDockableFrame getFrame(@NotNull
                                          String id)

Returns WebDockableFrame with the specified identifier.

Parameters:

id - WebDockableFrame identifier

Returns:

WebDockableFrame with the specified identifier

findFrame

@Nullable
public WebDockableFrame findFrame(@NotNull
                                            String id)

Returns WebDockableFrame with the specified identifier or null if it doesn't exist within WebDockablePane.

Parameters:

id - WebDockableFrame identifier

Returns:

WebDockableFrame with the specified identifier or null if it doesn't exist within WebDockablePane

getMaximizedFrame

@Nullable
public WebDockableFrame getMaximizedFrame()

Returns currently maximized WebDockableFrame or null if none maximized.

Returns:

currently maximized WebDockableFrame or null if none maximized

addFrame

@NotNull
public WebDockableFrame addFrame(@NotNull
                                          WebDockableFrame frame)

Adds specified WebDockableFrame into this WebDockablePane. Position of WebDockableFrame will get restored by its identifier if it's state was saved at least once before. Note that WebDockableFrame might be in closed state, in that case it will still not be visible.

Parameters:

frame - WebDockableFrame to add

Returns:

added WebDockableFrame

removeFrame

@NotNull
public WebDockableFrame removeFrame(@NotNull
                                             WebDockableFrame frame)

Removes specified WebDockableFrame from this WebDockablePane. This will completely remove WebDockableFrame and its data from WebDockablePaneModel.

Parameters:

frame - WebDockableFrame to remove

Returns:

removed WebDockableFrame

getContent

@Nullable
public JComponent getContent()

Returns current content JComponent.

Returns:

current content JComponent

setContent

@Nullable
public JComponent setContent(@Nullable
                                       JComponent content)

Sets content JComponent.

Parameters:

content - content JComponent

Returns:

previous content JComponent

addDockablePaneListener

public void addDockablePaneListener(@NotNull
                                    DockablePaneListener listener)

Adds new DockablePaneListener.

Parameters:

listener - DockablePaneListener to add

removeDockablePaneListener

public void removeDockablePaneListener(@NotNull
                                       DockablePaneListener listener)

Removes specified DockablePaneListener.

Parameters:

listener - DockablePaneListener to remove

fireFrameAdded

public void fireFrameAdded(@NotNull
                           WebDockableFrame frame,
                           @NotNull
                           WebDockablePane dockablePane)

Informs listeners about WebDockableFrame being added.

Parameters:

frame - WebDockableFrame which was added

dockablePane - WebDockablePane where frame was added

fireFrameStateChanged

public void fireFrameStateChanged(@NotNull
                                  WebDockableFrame frame,
                                  @NotNull
                                  DockableFrameState oldState,
                                  @NotNull
                                  DockableFrameState newState)

Informs listeners about WebDockableFrame state change.

Parameters:

frame - WebDockableFrame

oldState - previous frame state

newState - current frame state

fireFrameMoved

public void fireFrameMoved(@NotNull
                           WebDockableFrame frame,
                           @NotNull
                           CompassDirection position)

Informs listeners about WebDockableFrame being moved.

Parameters:

frame - WebDockableFrame

position - current frame position relative to content

fireFrameRemoved

public void fireFrameRemoved(@NotNull
                             WebDockableFrame frame,
                             @NotNull
                             WebDockablePane dockablePane)

Informs listeners about WebDockableFrame being removed.

Parameters:

frame - WebDockableFrame which was removed

dockablePane - WebDockablePane where frame was removed from

applyComponentOrientation

public void applyComponentOrientation(@NotNull
                                      ComponentOrientation orientation)

Overrides:

applyComponentOrientation in class Container

getUI

public WDockablePaneUI getUI()

Returns the look and feel (LaF) object that renders this component.

Returns:

the WDockablePaneUI object that renders this component

setUI

public void setUI(WDockablePaneUI ui)

Sets the LaF object that renders this component.

Parameters:

ui - WDockablePaneUI

updateUI

public void updateUI()

Specified by:

updateUI in class WebComponent<WebDockablePane,WDockablePaneUI>

getUIClassID

@NotNull
public String getUIClassID()

Specified by:

getUIClassID in class WebComponent<WebDockablePane,WDockablePaneUI>