net.sf.doolin.gui.docking
Enum DockType

java.lang.Object
  java.lang.Enum<DockType>
      net.sf.doolin.gui.docking.DockType

All Implemented Interfaces:

Serializable, Comparable<DockType>

public enum DockType
extends Enum<DockType>

List of docks that can be created.

Author:

Damien Coraboeuf

Enum Constant Summary

BORDER

FLOAT

LINE

SINGLE

SPLIT

Method Summary

com.javadocking.dock.Dock	createDock() Creates a dock.
static DockType	getDockType(com.javadocking.dock.Dock dock) Gets the dock type from the class
static DockType	valueOf(String name) Returns the enum constant of this type with the specified name.
static DockType[]	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

SPLIT

public static final DockType SPLIT

See Also:

SplitDock

BORDER

public static final DockType BORDER

See Also:

BorderDock

LINE

public static final DockType LINE

See Also:

LineDock

SINGLE

public static final DockType SINGLE

See Also:

SingleDock

FLOAT

public static final DockType FLOAT

See Also:

FloatDock

Method Detail

values

public static DockType[] 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 (DockType c : DockType.values())
    System.out.println(c);

Returns:

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

valueOf

public static DockType valueOf(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:

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

NullPointerException - if the argument is null

getDockType

public static DockType getDockType(com.javadocking.dock.Dock dock)

Gets the dock type from the class

Parameters:

dock - Dock

Returns:

Dock type

createDock

public com.javadocking.dock.Dock createDock()

Creates a dock.

Returns:

New dock.