pub.vlsolutions.swing.docking

Enum DockableState.Location

java.lang.Object

java.lang.Enum<DockableState.Location>

pub.vlsolutions.swing.docking.DockableState.Location

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DockableState.Location>

Enclosing class:

DockableState

public static enum DockableState.Location
extends java.lang.Enum<DockableState.Location>

Possible locations of a dockable

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSED A constant describing a Dockable that is not visible.
DOCKED A constant describing a Dockable that is visible (displayed in a DockableContainer)
FLOATING A constant describing a Dockable that is currently floating (detached from the desktop)
HIDDEN A constant describing a Dockable that is in auto-hide mode (reduced to a button)
MAXIMIZED A constant describing a Dockable that is currently maximized

Method Summary

Methods

Modifier and Type	Method and Description
static DockableState.Location	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DockableState.Location[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CLOSED

public static final DockableState.Location CLOSED

A constant describing a Dockable that is not visible.

DOCKED

public static final DockableState.Location DOCKED

A constant describing a Dockable that is visible (displayed in a DockableContainer)

HIDDEN

public static final DockableState.Location HIDDEN

A constant describing a Dockable that is in auto-hide mode (reduced to a button)

MAXIMIZED

public static final DockableState.Location MAXIMIZED

A constant describing a Dockable that is currently maximized

FLOATING

public static final DockableState.Location FLOATING

A constant describing a Dockable that is currently floating (detached from the desktop)

Method Detail

values

public static DockableState.Location[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DockableState.Location c : DockableState.Location.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DockableState.Location valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null