com.vlsolutions.swing.docking
Class DockableState
java.lang.Object
com.vlsolutions.swing.docking.DockableState
- Comparable
public class DockableState
extends java.lang.Object
implements Comparable
General information about the current state of a dockable component.
This class is a simple record of a dockable and its current display state.
It is used together with DockableStateChangeEvents (and listeners) to
track changes of Dockable visibility.
static int | STATE_CLOSED - A constant describing a Dockable that is not visible.
|
static int | STATE_DOCKED - A constant describing a Dockable that is visible (displayed in a DockableContainer)
|
static int | STATE_FLOATING - A constant describing a Dockable that is currently floating (detached from the desktop)
|
static int | STATE_HIDDEN - A constant describing a Dockable that is in auto-hide mode (reduced to a button)
|
static int | STATE_MAXIMIZED - A constant describing a Dockable that is currently maximized
|
int | compareTo(Object object) - Comparable interface, used to sort components by name order.
|
DockingDesktop | getDesktop() - Returns the desktop currently using this dockable, or null if none
|
Dockable | getDockable() - Returns the dockable this state is for
|
RelativeDockablePosition | getPosition() - Returns the relative restore position of the dockable when it is not shown (auto-hide
or closed).
|
int | getState() - Returns the current state of the dockable (CLOSED, DOCKED, HIDDEN...).
|
static String | getStateName(int state) - Returns a litteral representation of the given state
|
boolean | isClosed() - Convenience method returning wether the dockable is in the CLOSED state
|
boolean | isDocked() - Convenience method returning wether the dockable is in the DOCKED state
|
boolean | isFloating() - Convenience method returning wether the dockable is in the FLOATING state
|
boolean | isHidden() - Convenience method returning wether the dockable is in the HIDDEN state
|
boolean | isMaximized() - Convenience method returning wether the dockable is in the MAXIMIZED state
|
void | setDesktop(DockingDesktop desktop) - Updates the desktop field (desktop using this dockable)
|
String | toString()
|
STATE_CLOSED
public static final int STATE_CLOSED
A constant describing a Dockable that is not visible.
STATE_DOCKED
public static final int STATE_DOCKED
A constant describing a Dockable that is visible (displayed in a DockableContainer)
STATE_FLOATING
public static final int STATE_FLOATING
A constant describing a Dockable that is currently floating (detached from the desktop)
STATE_HIDDEN
public static final int STATE_HIDDEN
A constant describing a Dockable that is in auto-hide mode (reduced to a button)
STATE_MAXIMIZED
public static final int STATE_MAXIMIZED
A constant describing a Dockable that is currently maximized
DockableState
public DockableState()
compareTo
public int compareTo(Object object)
Comparable interface, used to sort components by name order.
getDesktop
public DockingDesktop getDesktop()
Returns the desktop currently using this dockable, or null if none
getDockable
public Dockable getDockable()
Returns the dockable this state is for
getPosition
public RelativeDockablePosition getPosition()
Returns the relative restore position of the dockable when it is not shown (auto-hide
or closed).
Please note that this position is meaningless for visible components
(as it is not automatically calculated at every move / resize of the dockable ).
getState
public int getState()
Returns the current state of the dockable (CLOSED, DOCKED, HIDDEN...).
getStateName
public static String getStateName(int state)
Returns a litteral representation of the given state
isClosed
public boolean isClosed()
Convenience method returning wether the dockable is in the CLOSED state
isDocked
public boolean isDocked()
Convenience method returning wether the dockable is in the DOCKED state
isFloating
public boolean isFloating()
Convenience method returning wether the dockable is in the FLOATING state
isHidden
public boolean isHidden()
Convenience method returning wether the dockable is in the HIDDEN state
isMaximized
public boolean isMaximized()
Convenience method returning wether the dockable is in the MAXIMIZED state
setDesktop
public void setDesktop(DockingDesktop desktop)
Updates the desktop field (desktop using this dockable)
toString
public String toString()
© Copyright 2004-2006 VLSolutions. All Rights Reserved.
www.vlsolutions.com : Java Components - Smart Client Applications