Package org.pepstock.charba.client.annotation

Enum AnnotationType

java.lang.Object

java.lang.Enum<AnnotationType>

org.pepstock.charba.client.annotation.AnnotationType

All Implemented Interfaces:

Serializable, Comparable<AnnotationType>, Key

public enum AnnotationType
extends Enum<AnnotationType>
implements Key

Defines the type of annotation.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOX	Defines a BOX annotation which draws a box in the a chart.
ELLIPSE	Defines a ELLIPSE annotation which draws an ellipse in the a chart.
LABEL	Defines a LABEL annotation which draws a content in the a chart.
LINE	Defines a LINE annotation which draws a line in the a chart.
POINT	Defines a POINT annotation which draws a point in the a chart.
POLYGON	Defines a POLYGON annotation which draws a polygon in the a chart.

Method Summary

Modifier and Type	Method	Description
AnnotationId	createId()	Creates a unique id for the annotation. The format is:
String	value()	Returns the name value of property
static AnnotationType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static AnnotationType[]	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

LINE

public static final AnnotationType LINE

Defines a LINE annotation which draws a line in the a chart.

LABEL

public static final AnnotationType LABEL

Defines a LABEL annotation which draws a content in the a chart.

BOX

public static final AnnotationType BOX

Defines a BOX annotation which draws a box in the a chart.

ELLIPSE

public static final AnnotationType ELLIPSE

Defines a ELLIPSE annotation which draws an ellipse in the a chart.

POINT

public static final AnnotationType POINT

Defines a POINT annotation which draws a point in the a chart.

POLYGON

public static final AnnotationType POLYGON

Defines a POLYGON annotation which draws a polygon in the a chart.

Method Detail

values

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

Returns:

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

valueOf

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

value

public String value()

Description copied from interface: Key

Returns the name value of property

Specified by:

value in interface Key

Returns:

the name value of property

createId

public AnnotationId createId()

Creates a unique id for the annotation.
The format is:

 
        [annotationType]-[number]
 
 

Returns:

a unique id for the annotation