com.softwarefx.chartfx.server.annotation
Enum AnnCommandID

java.lang.Object
  java.lang.Enum<AnnCommandID>
      com.softwarefx.chartfx.server.annotation.AnnCommandID

All Implemented Interfaces:

Serializable, Comparable<AnnCommandID>

public enum AnnCommandID
extends Enum<AnnCommandID>

Defines the valid pre-defined annotation commands for the Annotation Toolbar

Enum Constant Summary

ATTACH
Displays Attach Menu.

ATTACH_CENTER
Defines attachment method as Center.

ATTACH_ELASTIC
Defines attachment method as Elastic.

BORDER_COLOR
Allows user to define Border Color for an annotation object.

BORDER_STYLE
Allows user to define border style for an annotation object.

BORDER_WIDTH
Allows user to define border width for an annotation object.

BRING_TO_FRONT
Bring annotation object to front.

CHANGE_FONT
Allows user to change the font of an annotation object.

COPY
Copy.

CUT
Cut.

DELETE
Deletes annotation object.

DETACH
Detaches selected annotation.

FILL_COLOR
Allows user to define Fill Color for an annotation object.

FIRST_COMMAND
When selecting the ID for a custom command, check First Command (ID) as well as Last Command (ID) and select an ID outside of this range.

FLIP_HORIZONTAL
Flips selected annotation horizontally.

FLIP_VERTICAL
Flips selected annotation vertically.

GROUP
Group selected annotation objects.

LAST_COMMAND
When selecting the ID for a custom command, check First Command as well as Last Command and select an ID outside of this range.

LOAD_PICTURE
Loads the picture for an annotation image.

LOCK
Locks annotation object.

NEW_ARC
Creates new Arc Annotation.

NEW_ARROW
Creates new Arrow Annotation.

NEW_BALLOON
Creates new Balloon Annotation.

NEW_CIRCLE
Creates new Circle Annotation.

NEW_PICTURE
Creates new Picture Annotation.

NEW_POLYGON
Creates new Polygon Annotation.

NEW_RECTANGLE
Creates new Rectangle Annotation.

NEW_TEXT
Creates new Text Annotation.

OBJECT
Displays Object Menu.

PASTE
Paste.

RESERVED
Reserved.

ROTATE_LEFT
Rotates selected annotation to the left.

ROTATE_RIGHT
Rotates selected annotation to the right.

SELECTOR
Selector arrow.

SEND_TO_BACK
Send annotation object to back.

UNGROUP
Ungroup selected annotation objects.

Method Summary

static EnumSet<AnnCommandID>	getEnumSetValue(int value) Returns a EnumSet that represents the given numeric value.
static AnnCommandID	getEnumValue(int value) Returns a Enum Item that represents the given numeric value.
static int	getUnderlyingValue(AnnCommandID value) Returns a numeric value that represents the given EnumSet or Enum item.
static int	getUnderlyingValue(EnumSet<AnnCommandID> value) Returns a numeric value that represents the given EnumSet or Enum item.
static AnnCommandID	valueOf(String name) Returns the enum constant of this type with the specified name.
static AnnCommandID[]	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

FIRST_COMMAND

public static final AnnCommandID FIRST_COMMAND

When selecting the ID for a custom command, check First Command (ID) as well as Last Command (ID) and select an ID outside of this range.

RESERVED

public static final AnnCommandID RESERVED

Reserved.

LAST_COMMAND

public static final AnnCommandID LAST_COMMAND

When selecting the ID for a custom command, check First Command as well as Last Command and select an ID outside of this range.

SELECTOR

public static final AnnCommandID SELECTOR

Selector arrow.

NEW_RECTANGLE

public static final AnnCommandID NEW_RECTANGLE

Creates new Rectangle Annotation.

NEW_CIRCLE

public static final AnnCommandID NEW_CIRCLE

Creates new Circle Annotation.

NEW_ARROW

public static final AnnCommandID NEW_ARROW

Creates new Arrow Annotation.

NEW_ARC

public static final AnnCommandID NEW_ARC

Creates new Arc Annotation.

NEW_PICTURE

public static final AnnCommandID NEW_PICTURE

Creates new Picture Annotation.

NEW_TEXT

public static final AnnCommandID NEW_TEXT

Creates new Text Annotation.

NEW_BALLOON

public static final AnnCommandID NEW_BALLOON

Creates new Balloon Annotation.

NEW_POLYGON

public static final AnnCommandID NEW_POLYGON

Creates new Polygon Annotation.

FILL_COLOR

public static final AnnCommandID FILL_COLOR

Allows user to define Fill Color for an annotation object.

BORDER_COLOR

public static final AnnCommandID BORDER_COLOR

Allows user to define Border Color for an annotation object.

CUT

public static final AnnCommandID CUT

Cut.

COPY

public static final AnnCommandID COPY

Copy.

PASTE

public static final AnnCommandID PASTE

Paste.

BRING_TO_FRONT

public static final AnnCommandID BRING_TO_FRONT

Bring annotation object to front.

SEND_TO_BACK

public static final AnnCommandID SEND_TO_BACK

Send annotation object to back.

GROUP

public static final AnnCommandID GROUP

Group selected annotation objects.

UNGROUP

public static final AnnCommandID UNGROUP

Ungroup selected annotation objects.

FLIP_VERTICAL

public static final AnnCommandID FLIP_VERTICAL

Flips selected annotation vertically.

FLIP_HORIZONTAL

public static final AnnCommandID FLIP_HORIZONTAL

Flips selected annotation horizontally.

ROTATE_RIGHT

public static final AnnCommandID ROTATE_RIGHT

Rotates selected annotation to the right.

ROTATE_LEFT

public static final AnnCommandID ROTATE_LEFT

Rotates selected annotation to the left.

ATTACH

public static final AnnCommandID ATTACH

Displays Attach Menu.

DETACH

public static final AnnCommandID DETACH

Detaches selected annotation.

ATTACH_CENTER

public static final AnnCommandID ATTACH_CENTER

Defines attachment method as Center.

ATTACH_ELASTIC

public static final AnnCommandID ATTACH_ELASTIC

Defines attachment method as Elastic.

LOCK

public static final AnnCommandID LOCK

Locks annotation object.

DELETE

public static final AnnCommandID DELETE

Deletes annotation object.

OBJECT

public static final AnnCommandID OBJECT

Displays Object Menu.

BORDER_WIDTH

public static final AnnCommandID BORDER_WIDTH

Allows user to define border width for an annotation object.

BORDER_STYLE

public static final AnnCommandID BORDER_STYLE

Allows user to define border style for an annotation object.

CHANGE_FONT

public static final AnnCommandID CHANGE_FONT

Allows user to change the font of an annotation object.

LOAD_PICTURE

public static final AnnCommandID LOAD_PICTURE

Loads the picture for an annotation image.

Method Detail

values

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

Returns:

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

valueOf

public static AnnCommandID 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<AnnCommandID> getEnumSetValue(int value)

Returns a EnumSet that represents the given numeric value.

Parameters:

value - numeric representation of the Enumset.

getEnumValue

public static AnnCommandID 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(AnnCommandID 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<AnnCommandID> value)

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

Parameters:

value - A Enum Item or EnumSet.