org.pepstock.charba.client.labels.enums

Enum Position

java.lang.Object

java.lang.Enum<Position>

org.pepstock.charba.client.labels.enums.Position

All Implemented Interfaces:

Serializable, Comparable<Position>

public enum Position
extends Enum<Position>

Enumeration of available positions to use to configure LABELS plugin.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
border The labels are located on border.
defaults In labels plugin is named 'default', inside the chart.
outside The labels are located outisde of the chart.

Method Summary

Modifier and Type	Method and Description
static Position	getPositionByValue(String value) Returns the position enumeration item by its value.
String	getValue() Returns the real value to set to configure LABELS plugin.
static Position	valueOf(String name) Returns the enum constant of this type with the specified name.
static Position[]	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

defaults

public static final Position defaults

In labels plugin is named 'default', inside the chart.

border

public static final Position border

The labels are located on border.

outside

public static final Position outside

The labels are located outisde of the chart.

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public String getValue()

Returns the real value to set to configure LABELS plugin.

Returns:

the value the real value to set to configure LABELS plugin

getPositionByValue

public static final Position getPositionByValue(String value)

Returns the position enumeration item by its value.

Parameters:

value - the real value to set to configure LABELS plugin

Returns:

the position enumeration item or defaults is the value is wrong.