bibliothek.gui.dock.station.stack.tab.layouting

Enum TabPlacement

java.lang.Object

java.lang.Enum<TabPlacement>

bibliothek.gui.dock.station.stack.tab.layouting.TabPlacement

All Implemented Interfaces:

Serializable, Comparable<TabPlacement>

public enum TabPlacement
extends Enum<TabPlacement>

Tells at which side tabs are placed on a TabPane (or a similar ui element).

Author:

Benjamin Sigg

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM_OF_DOCKABLE bottom side, horizontal
LEFT_OF_DOCKABLE to the left, vertical
RIGHT_OF_DOCKABLE to the right, vertical
TOP_OF_DOCKABLE top side, horizontal

Method Summary

Modifier and Type	Method and Description
boolean	isHorizontal() Tells whether this side is a horizontal side.
boolean	isVertical() Tells whether this side is a vertical side.
DockTitle.Orientation	toOrientation() Transforms this into an DockTitle.Orientation.
static TabPlacement	valueOf(String name) Returns the enum constant of this type with the specified name.
static TabPlacement[]	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

TOP_OF_DOCKABLE

public static final TabPlacement TOP_OF_DOCKABLE

top side, horizontal

BOTTOM_OF_DOCKABLE

public static final TabPlacement BOTTOM_OF_DOCKABLE

bottom side, horizontal

LEFT_OF_DOCKABLE

public static final TabPlacement LEFT_OF_DOCKABLE

to the left, vertical

RIGHT_OF_DOCKABLE

public static final TabPlacement RIGHT_OF_DOCKABLE

to the right, vertical

Method Detail

values

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

Returns:

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

valueOf

public static TabPlacement 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 whether this side is a horizontal side.

Returns:

true if TOP_OF_DOCKABLE or BOTTOM_OF_DOCKABLE

isVertical

public boolean isVertical()

Tells whether this side is a vertical side.

Returns:

true if LEFT_OF_DOCKABLE or RIGHT_OF_DOCKABLE

toOrientation

public DockTitle.Orientation toOrientation()

Transforms this into an DockTitle.Orientation.

Returns:

transformed this