com.softwarefx.chartfx.server
Enum CommandStyles

java.lang.Object
  java.lang.Enum<CommandStyles>
      com.softwarefx.chartfx.server.CommandStyles

All Implemented Interfaces:

Serializable, Comparable<CommandStyles>

public enum CommandStyles
extends Enum<CommandStyles>

Define the command styles.

Enum Constant Summary

CHILD_IMAGE
Specifies that when a subcommand is selected, the command image will be replaced by the subcommand image.

GROUP
The command belongs to a group that starts with the GroupHead flag.

GROUP_HEAD
The command belongs to a group and this command points to the beginning of the group.

HEAD
May be combined with the Group enumeration to create the GroupHead equivalent.

NONE
No command style.

OWNER_DRAW
For internal use.

PREFER_IMAGE
Whenever possible, shows the image and not the text associated with the command.

SELECTOR
Indicates the command is a selector that shows the actual selection.

SELECTOR_CHILD
Specifies that the command will be one of the subcommands of a selector.

SHOW_TEXT_ONLY
Only text will be shown for the command icon, no image will be used.

SMART_LIST
Specifies that only one item in a collection of subcommands must be selected.

TRANSPOSED
Indicates to transpose the items in a command selector.

TWO_STATE
The command is two-state, that can be checked or unchecked according to certain condition in the chart.

VIRTUAL_LIST
For internal use.

Method Summary

static EnumSet<CommandStyles>	getEnumSetValue(int value) Returns a EnumSet that represents the given numeric value.
static CommandStyles	getEnumValue(int value) Returns a Enum Item that represents the given numeric value.
static int	getUnderlyingValue(CommandStyles value) Returns a numeric value that represents the given EnumSet or Enum item.
static int	getUnderlyingValue(EnumSet<CommandStyles> value) Returns a numeric value that represents the given EnumSet or Enum item.
static CommandStyles	valueOf(String name) Returns the enum constant of this type with the specified name.
static CommandStyles[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final CommandStyles NONE

No command style.

TWO_STATE

public static final CommandStyles TWO_STATE

The command is two-state, that can be checked or unchecked according to certain condition in the chart. For example, the Chart FX 3D button is a two state that indicates whethe if the chart is in 2D or 3D mode).

GROUP

public static final CommandStyles GROUP

The command belongs to a group that starts with the GroupHead flag.

HEAD

public static final CommandStyles HEAD

May be combined with the Group enumeration to create the GroupHead equivalent. Should never be used alone.

GROUP_HEAD

public static final CommandStyles GROUP_HEAD

The command belongs to a group and this command points to the beginning of the group.

SELECTOR

public static final CommandStyles SELECTOR

Indicates the command is a selector that shows the actual selection. For example, the gallery button in the Chart FX Toolbar is a selector, where a drop-down list appears with the chart types available and when it is closed, the actual selection, chart type is displayed.

PREFER_IMAGE

public static final CommandStyles PREFER_IMAGE

Whenever possible, shows the image and not the text associated with the command.

OWNER_DRAW

public static final CommandStyles OWNER_DRAW

For internal use.

CHILD_IMAGE

public static final CommandStyles CHILD_IMAGE

Specifies that when a subcommand is selected, the command image will be replaced by the subcommand image. (such as the ChartFX Gallery Command)

VIRTUAL_LIST

public static final CommandStyles VIRTUAL_LIST

For internal use.

SMART_LIST

public static final CommandStyles SMART_LIST

Specifies that only one item in a collection of subcommands must be selected. (such as the ChartFX Gallery Command)

SHOW_TEXT_ONLY

public static final CommandStyles SHOW_TEXT_ONLY

Only text will be shown for the command icon, no image will be used.

SELECTOR_CHILD

public static final CommandStyles SELECTOR_CHILD

Specifies that the command will be one of the subcommands of a selector.

TRANSPOSED

public static final CommandStyles TRANSPOSED

Indicates to transpose the items in a command selector.

Method Detail

values

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

Returns:

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

valueOf

public static CommandStyles 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

getEnumSetValue

public static EnumSet<CommandStyles> getEnumSetValue(int value)

Returns a EnumSet that represents the given numeric value.

Parameters:

value - numeric representation of the Enumset.

getEnumValue

public static CommandStyles getEnumValue(int value)

Returns a Enum Item that represents the given numeric value.

Parameters:

value - numeric representation of the Enum item.

getUnderlyingValue

public static int getUnderlyingValue(CommandStyles value)

Returns a numeric value that represents the given EnumSet or Enum item.

Parameters:

value - A Enum Item or EnumSet.

getUnderlyingValue

public static int getUnderlyingValue(EnumSet<CommandStyles> value)

Returns a numeric value that represents the given EnumSet or Enum item.

Parameters:

value - A Enum Item or EnumSet.