|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.vlsolutions.swing.docking.DockableState
public class DockableState
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.
Field Summary | |
---|---|
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 |
Constructor Summary | |
---|---|
DockableState()
|
|
DockableState(DockableState copy,
RelativeDockablePosition position)
Creates a dockable state based on an existing state, with another relative positionning |
|
DockableState(DockingDesktop desktop,
Dockable dockable,
int state)
|
|
DockableState(DockingDesktop desktop,
Dockable dockable,
int state,
RelativeDockablePosition position)
|
Method Summary | |
---|---|
int |
compareTo(java.lang.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 java.lang.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) |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final int STATE_CLOSED
public static final int STATE_DOCKED
public static final int STATE_HIDDEN
public static final int STATE_MAXIMIZED
public static final int STATE_FLOATING
Constructor Detail |
---|
public DockableState()
public DockableState(DockingDesktop desktop, Dockable dockable, int state)
public DockableState(DockingDesktop desktop, Dockable dockable, int state, RelativeDockablePosition position)
public DockableState(DockableState copy, RelativeDockablePosition position)
Method Detail |
---|
public int compareTo(java.lang.Object object)
compareTo
in interface java.lang.Comparable
public Dockable getDockable()
public boolean isDocked()
public boolean isHidden()
public boolean isClosed()
public boolean isFloating()
public boolean isMaximized()
public int getState()
public RelativeDockablePosition getPosition()
Please note that this position is meaningless for visible components (as it is not automatically calculated at every move / resize of the dockable ).
public java.lang.String toString()
toString
in class java.lang.Object
public static java.lang.String getStateName(int state)
public DockingDesktop getDesktop()
public void setDesktop(DockingDesktop desktop)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |