org.controlsfx.control

Enum ButtonBar.ButtonType

java.lang.Object

java.lang.Enum<ButtonBar.ButtonType>

org.controlsfx.control.ButtonBar.ButtonType

All Implemented Interfaces:

Serializable, Comparable<ButtonBar.ButtonType>

Enclosing class:

ButtonBar

public static enum ButtonBar.ButtonType
extends Enum<ButtonBar.ButtonType>

An enumeration of all available button types. By designating every button in a ButtonBar as one of these types, the buttons will be appropriately positioned relative to all other buttons in the ButtonBar.

For details on the button order code for each button type, refer to the javadoc comment for that type.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPLY A tag for the "apply" button.
BACK_PREVIOUS A tag for the "back" or "previous" button.
BIG_GAP A glue push gap that will take as much space as it can and at least an "unrelated" gap.
CANCEL_CLOSE A tag for the "cancel" or "close" button.
FINISH A tag for the "finish".
HELP A tag for the "help" button that normally is supposed to be on the right.
HELP_2 A tag for the "help2" button that normally is supposed to be on the left.
LEFT Buttons with this style tag will statically end up on the left end of the bar.
NEXT_FORWARD A tag for the "next" or "forward" button.
NO A tag for the "no" button.
OK_DONE A tag for the "ok" or "done" button.
OTHER All Uncategorized, Other, or "Unknown" buttons.
RIGHT Buttons with this style tag will statically end up on the right end of the bar.
SMALL_GAP An "unrelated" gap.
YES A tag for the "yes" button.

Method Summary

Modifier and Type	Method and Description
String	getTypeCode()
static ButtonBar.ButtonType	valueOf(String name) Returns the enum constant of this type with the specified name.
static ButtonBar.ButtonType[]	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 ButtonBar.ButtonType LEFT

Buttons with this style tag will statically end up on the left end of the bar.

Button order code: L

RIGHT

public static final ButtonBar.ButtonType RIGHT

Buttons with this style tag will statically end up on the right end of the bar.

Button order code: R

HELP

public static final ButtonBar.ButtonType HELP

A tag for the "help" button that normally is supposed to be on the right.

Button order code: H

HELP_2

public static final ButtonBar.ButtonType HELP_2

A tag for the "help2" button that normally is supposed to be on the left.

Button order code: E

YES

public static final ButtonBar.ButtonType YES

A tag for the "yes" button.

Button order code: Y

NO

public static final ButtonBar.ButtonType NO

A tag for the "no" button.

Button order code: N

NEXT_FORWARD

public static final ButtonBar.ButtonType NEXT_FORWARD

A tag for the "next" or "forward" button.

Button order code: X

BACK_PREVIOUS

public static final ButtonBar.ButtonType BACK_PREVIOUS

A tag for the "back" or "previous" button.

Button order code: B

FINISH

public static final ButtonBar.ButtonType FINISH

A tag for the "finish".

Button order code: I

APPLY

public static final ButtonBar.ButtonType APPLY

A tag for the "apply" button.

Button order code: A

CANCEL_CLOSE

public static final ButtonBar.ButtonType CANCEL_CLOSE

A tag for the "cancel" or "close" button.

Button order code: C

OK_DONE

public static final ButtonBar.ButtonType OK_DONE

A tag for the "ok" or "done" button.

Button order code: O

OTHER

public static final ButtonBar.ButtonType OTHER

All Uncategorized, Other, or "Unknown" buttons. Tag will be "other".

Button order code: U

BIG_GAP

public static final ButtonBar.ButtonType BIG_GAP

A glue push gap that will take as much space as it can and at least an "unrelated" gap. (Platform dependent)

Button order code: +

SMALL_GAP

public static final ButtonBar.ButtonType SMALL_GAP

An "unrelated" gap. (Platform dependent)

Button order code: _ (underscore)

Method Detail

values

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

Returns:

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

valueOf

public static ButtonBar.ButtonType 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

getTypeCode

public String getTypeCode()