Package org.jdesktop.swingx

Enum JXCollapsiblePane.Direction

java.lang.Object

java.lang.Enum<JXCollapsiblePane.Direction>

org.jdesktop.swingx.JXCollapsiblePane.Direction

All Implemented Interfaces:

Serializable, Comparable<JXCollapsiblePane.Direction>

Enclosing class:

JXCollapsiblePane

public static enum JXCollapsiblePane.Direction
extends Enum<JXCollapsiblePane.Direction>

The direction defines how the collapsible pane will collapse. The constant names were designed by choosing a fixed point and then determining the collapsing direction from that fixed point. This means RIGHT expands to the right and this is probably the best expansion for a component in BorderLayout.EAST.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DOWN	Collapses down.
LEFT	Collapses left.
RIGHT	Collapses right.
UP	Collapses up.

Method Summary

Modifier and Type	Method	Description
boolean	isVertical()	Gets the orientation for this direction.
static JXCollapsiblePane.Direction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static JXCollapsiblePane.Direction[]	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

LEFT

public static final JXCollapsiblePane.Direction LEFT

Collapses left. Suitable for BorderLayout.WEST.

RIGHT

public static final JXCollapsiblePane.Direction RIGHT

Collapses right. Suitable for BorderLayout.EAST.

UP

public static final JXCollapsiblePane.Direction UP

Collapses up. Suitable for BorderLayout.NORTH.

DOWN

public static final JXCollapsiblePane.Direction DOWN

Collapses down. Suitable for BorderLayout.SOUTH.

Method Detail

values

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

Returns:

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

valueOf

public static JXCollapsiblePane.Direction 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

isVertical

public boolean isVertical()

Gets the orientation for this direction.

Returns:

true if the direction is vertical, false otherwise