bibliothek.gui.dock.title

Enum DockTitle.Orientation

java.lang.Object

java.lang.Enum<DockTitle.Orientation>

bibliothek.gui.dock.title.DockTitle.Orientation

All Implemented Interfaces:

Serializable, Comparable<DockTitle.Orientation>

Enclosing interface:

DockTitle

public static enum DockTitle.Orientation
extends Enum<DockTitle.Orientation>

How to layout a DockTitle

Enum Constant Summary

Enum Constants

Enum Constant and Description
EAST_SIDED The title is at the east side of some panel.
FREE_HORIZONTAL The title is somehow horizontal oriented.
FREE_VERTICAL The title is somehow vertical oriented.
NORTH_SIDED The title is at the north side of some panel.
SOUTH_SIDED The title is at the south side of some panel.
WEST_SIDED The title is at the west side of some panel.

Method Summary

Modifier and Type	Method and Description
boolean	isHorizontal() Tells a DockTitle that its preferred height should be smaller than its preferred width
boolean	isVertical() Tells a DockTitle that its preferred width should be smaller than its preferred height
static DockTitle.Orientation	valueOf(String name) Returns the enum constant of this type with the specified name.
static DockTitle.Orientation[]	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

NORTH_SIDED

public static final DockTitle.Orientation NORTH_SIDED

The title is at the north side of some panel.

SOUTH_SIDED

public static final DockTitle.Orientation SOUTH_SIDED

The title is at the south side of some panel.

EAST_SIDED

public static final DockTitle.Orientation EAST_SIDED

The title is at the east side of some panel.

WEST_SIDED

public static final DockTitle.Orientation WEST_SIDED

The title is at the west side of some panel.

FREE_VERTICAL

public static final DockTitle.Orientation FREE_VERTICAL

The title is somehow vertical oriented.

FREE_HORIZONTAL

public static final DockTitle.Orientation FREE_HORIZONTAL

The title is somehow horizontal oriented.

Method Detail

values

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

Returns:

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

valueOf

public static DockTitle.Orientation 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

isHorizontal

public boolean isHorizontal()

Tells a DockTitle that its preferred height should be smaller than its preferred width

Returns:

true if the title lays horizontal

isVertical

public boolean isVertical()

Tells a DockTitle that its preferred width should be smaller than its preferred height

Returns:

true if the title lays vertical