com.javadocking.dockable
Class DockableState

java.lang.Object
  com.javadocking.dockable.DockableState

public class DockableState
extends java.lang.Object

This class defines the constants for the possible states of a dockable, e.g. closed, normal, maximized and minimized. These constants are integers that can be combined with the bitwise or-operation.

Author:

Heidi Rakels.

Field Summary

static int	ALL_STATES This is the integer that combines all the possible states for a dockable.
static int	CLOSED This is the integer for the state when the dockable is not in a dock.
static int	EXTERNALIZED This is the integer for the state when the dockable is externalized.
static int	MAXIMIZED This is the integer for the state when the dockable is maximized.
static int	MINIMIZED This is the integer for the state when the dockable is minimized.
static int	NORMAL This is the integer for the state when the dockable is in a normal dock.

Method Summary

static int[]	statesAll() Gets an array with the constants DockableState.EXTERNALIZED, DockableState.MINIMIZED, DockableState.MAXIMIZED, DockableState.NORMAL, and DockableState.CLOSED.
static int[]	statesAllExceptClosed() Gets an array with the constants DockableState.EXTERNALIZED, DockableState.MINIMIZED, DockableState.MAXIMIZED, and DockableState.NORMAL.
static int[]	statesClosed() Gets an array with the constant DockableState.CLOSED.

Methods inherited from class java.lang.Object

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

Field Detail

NORMAL

public static final int NORMAL

This is the integer for the state when the dockable is in a normal dock.

See Also:

Constant Field Values

CLOSED

public static final int CLOSED

This is the integer for the state when the dockable is not in a dock.

See Also:

Constant Field Values

MAXIMIZED

public static final int MAXIMIZED

This is the integer for the state when the dockable is maximized.

See Also:

Constant Field Values

MINIMIZED

public static final int MINIMIZED

This is the integer for the state when the dockable is minimized.

See Also:

Constant Field Values

EXTERNALIZED

public static final int EXTERNALIZED

This is the integer for the state when the dockable is externalized.

See Also:

Constant Field Values

ALL_STATES

public static final int ALL_STATES

This is the integer that combines all the possible states for a dockable.

See Also:

Constant Field Values

Method Detail

statesAll

public static int[] statesAll()

Gets an array with the constants DockableState.EXTERNALIZED, DockableState.MINIMIZED, DockableState.MAXIMIZED, DockableState.NORMAL, and DockableState.CLOSED.

Returns:

An array with the constants DockableState.EXTERNALIZED, DockableState.MINIMIZED, DockableState.MAXIMIZED, DockableState.NORMAL, and DockableState.CLOSED.

statesClosed

public static int[] statesClosed()

Gets an array with the constant DockableState.CLOSED.

Returns:

An array with the constant DockableState.CLOSED.

statesAllExceptClosed

public static int[] statesAllExceptClosed()

Gets an array with the constants DockableState.EXTERNALIZED, DockableState.MINIMIZED, DockableState.MAXIMIZED, and DockableState.NORMAL.

Returns:

An array with the constants DockableState.EXTERNALIZED, DockableState.MINIMIZED, DockableState.MAXIMIZED, and DockableState.NORMAL.