org.pepstock.charba.client.data

Class Labels

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

org.pepstock.charba.client.data.Labels

public final class Labels
extends com.google.gwt.core.client.JavaScriptObject

Contains the labels of the chart.
Is able to manage also multi-line labels.

Author:

Andrea "Stock" Stocchero

See Also:

JavaScriptObject, JsArrayMixed

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Labels.Type Types of different elements of internal array. String is single line label, array is multi-line label.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Labels() Needed for GWT injection

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String... values) Adds a multi line label
void	add(java.lang.String value) Adds a single line label
static Labels	build() Builds new label object
java.lang.String	getString(int index) Gets the String at a given index.
java.lang.String[]	getStrings(int index) Returns a multi line label at a specific index.
Labels.Type	getType(int index) Returns the type of a label at specific index.
int	length() Gets the length of the array.
void	load(java.lang.String... values) Loads single line labels.
java.lang.String	toJSON()

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Labels

protected Labels()

Needed for GWT injection

Method Detail

build

public static Labels build()

Builds new label object

Returns:

new label object

load

public final void load(java.lang.String... values)

Loads single line labels.

Parameters:

values - array of labels

add

public final void add(java.lang.String value)

Adds a single line label

Parameters:

value - a single label

add

public final void add(java.lang.String... values)

Adds a multi line label

Parameters:

values - array ofstring which represents a multi line label

getStrings

public final java.lang.String[] getStrings(int index)

Returns a multi line label at a specific index. An array of strings is returned.

Parameters:

index - index of label

Returns:

an array of strings

getType

public final Labels.Type getType(int index)

Returns the type of a label at specific index.

Parameters:

index - index of label

Returns:

the type of label or null if out of range

getString

public final java.lang.String getString(int index)

Gets the String at a given index.

Parameters:

index - the index to be retrieved

Returns:

the object at the given index, or null if none exists

length

public final int length()

Gets the length of the array.

Returns:

the array length

toJSON

public final java.lang.String toJSON()