pub.vlsolutions.swing.docking

Class DockableState

java.lang.Object

pub.vlsolutions.swing.docking.DockableState

All Implemented Interfaces:

java.lang.Comparable<DockableState>

public class DockableState
extends java.lang.Object
implements java.lang.Comparable<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.

Version:

1.0

Author:

Lilian Chamontin, vlsolutions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DockableState.Location Possible locations of a dockable

Constructor Summary

Constructors

Constructor and Description
DockableState()
DockableState(DockableState copy, RelativeDockablePosition position) Creates a dockable state based on an existing state, with another relative positionning
DockableState(DockingDesktop desktop, Dockable dockable, DockableState.Location location)
DockableState(DockingDesktop desktop, Dockable dockable, DockableState.Location location, RelativeDockablePosition position)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(DockableState 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
DockableState.Location	getLocation() Returns the current location of the dockable (CLOSED, DOCKED, HIDDEN...).
static DockableState.Location	getLocationFromInt(int state) Utility (compatibility) method used to associate an int to the Location enumeration (opposite to location.ordinal()
RelativeDockablePosition	getPosition() Returns the relative restore position of the dockable when it is not shown (auto-hide or closed).
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

Constructor Detail

DockableState

public DockableState()

DockableState

public DockableState(DockingDesktop desktop,
             Dockable dockable,
             DockableState.Location location)

DockableState

public DockableState(DockingDesktop desktop,
             Dockable dockable,
             DockableState.Location location,
             RelativeDockablePosition position)

DockableState

public DockableState(DockableState copy,
             RelativeDockablePosition position)

Creates a dockable state based on an existing state, with another relative positionning

Method Detail

compareTo

public int compareTo(DockableState object)

Comparable interface, used to sort components by name order.

Specified by:

compareTo in interface java.lang.Comparable<DockableState>

getDockable

public Dockable getDockable()

Returns the dockable this state is for

isDocked

public boolean isDocked()

Convenience method returning wether the dockable is in the DOCKED state

isHidden

public boolean isHidden()

Convenience method returning wether the dockable is in the HIDDEN state

isClosed

public boolean isClosed()

Convenience method returning wether the dockable is in the CLOSED state

isFloating

public boolean isFloating()

Convenience method returning wether the dockable is in the FLOATING state

isMaximized

public boolean isMaximized()

Convenience method returning wether the dockable is in the MAXIMIZED state

getLocation

public DockableState.Location getLocation()

Returns the current location of the dockable (CLOSED, DOCKED, HIDDEN...).

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDesktop

public DockingDesktop getDesktop()

Returns the desktop currently using this dockable, or null if none

Since:

2.1

setDesktop

public void setDesktop(DockingDesktop desktop)

Updates the desktop field (desktop using this dockable)

Since:

2.1

getLocationFromInt

public static DockableState.Location getLocationFromInt(int state)

Utility (compatibility) method used to associate an int to the Location enumeration (opposite to location.ordinal()