org.pepstock.charba.client.enums

Class AbsoluteDatasetIndexFill

java.lang.Object

org.pepstock.charba.client.enums.AbsoluteDatasetIndexFill

All Implemented Interfaces:

Key, IsFill

public final class AbsoluteDatasetIndexFill
extends Object

Fill object to configure chart to use an absolute dataset index.
Absolute dataset index, as integer, is composed by integer value which must be greater than 0.
Here are same examples: (1,2,3,...).

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_VALUE_AS_INT Default value for absolute dataset index, 0.

Method Summary

Modifier and Type	Method and Description
FillingMode	getMode() Returns the type of filling.
String	getValue() Returns the value as string (valid ONLY for relative dataset index and predefined), otherwise UndefinedValues.STRING.
int	getValueAsInt() Returns the value as integer (valid ONLY for absolute dataset index), otherwise UndefinedValues.INTEGER.
String	value() Returns the name value of property

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.pepstock.charba.client.enums.IsFill

isValid

Methods inherited from interface org.pepstock.charba.client.commons.Key

checkIfValid, compare, create, equals, getKeyByValue, getKeyByValue, hasKeyByValue, isValid

Field Detail

DEFAULT_VALUE_AS_INT

public static final int DEFAULT_VALUE_AS_INT

Default value for absolute dataset index, 0.

See Also:

Constant Field Values

Method Detail

value

public String value()

Description copied from interface: Key

Returns the name value of property

Returns:

the name value of property

getMode

public final FillingMode getMode()

Description copied from interface: IsFill

Returns the type of filling.

Specified by:

getMode in interface IsFill

Returns:

the type of filling.

getValueAsInt

public int getValueAsInt()

Description copied from interface: IsFill

Returns the value as integer (valid ONLY for absolute dataset index), otherwise UndefinedValues.INTEGER.

Specified by:

getValueAsInt in interface IsFill

Returns:

the value as integer (valid ONLY for absolute dataset index), otherwise UndefinedValues.INTEGER.

getValue

public String getValue()

Description copied from interface: IsFill

Returns the value as string (valid ONLY for relative dataset index and predefined), otherwise UndefinedValues.STRING.

Specified by:

getValue in interface IsFill

Returns:

the value as string (valid ONLY for relative dataset index and predefined), otherwise UndefinedValues.STRING.