Package org.pushingpixels.flamingo.api.common

Enum JCommandButton.CommandButtonLocationOrderKind

java.lang.Object

java.lang.Enum<JCommandButton.CommandButtonLocationOrderKind>

org.pushingpixels.flamingo.api.common.JCommandButton.CommandButtonLocationOrderKind

Enclosing class:

JCommandButton

public static enum JCommandButton.CommandButtonLocationOrderKind
extends java.lang.Enum<JCommandButton.CommandButtonLocationOrderKind>

Enumerates the available values for the location order kind. This is used for buttons placed in command button strips or for buttons that need the visuals of segmented strips.

Enum Constant Summary

Enum Constants

Enum Constant	Description
FIRST	Indicates that this button is the first button in the strip.
LAST	Indicates that this button is the last button in the strip.
MIDDLE	Indicates that this button is in the middle of the strip.
ONLY	Indicates that this button is the only button in the strip.

Method Summary

Modifier and Type	Method	Description
static JCommandButton.CommandButtonLocationOrderKind	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static JCommandButton.CommandButtonLocationOrderKind[]	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

ONLY

public static final JCommandButton.CommandButtonLocationOrderKind ONLY

Indicates that this button is the only button in the strip.

FIRST

public static final JCommandButton.CommandButtonLocationOrderKind FIRST

Indicates that this button is the first button in the strip.

MIDDLE

public static final JCommandButton.CommandButtonLocationOrderKind MIDDLE

Indicates that this button is in the middle of the strip.

LAST

public static final JCommandButton.CommandButtonLocationOrderKind LAST

Indicates that this button is the last button in the strip.

Method Detail

values

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

Returns:

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

valueOf

public static JCommandButton.CommandButtonLocationOrderKind 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