Package org.pepstock.charba.client.labels

Class LabelsContext

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.callbacks.ChartContext

org.pepstock.charba.client.callbacks.AbstractDatasetContext

org.pepstock.charba.client.labels.LabelsContext

public final class LabelsContext
extends AbstractDatasetContext

This object is wrapping the native java script object provided by LabelsPlugin.ID plugin when the callback function is called.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method	Description
protected boolean	checkIfPropertyIsValid(Key property)	Checks if the key passed as argument is a key already used for other context properties.
DataItem	getDataItem()	Returns the value for the data set by a DataItem.
String	getLabel()	Returns the label for the data set.
Label	getLabelOptions()	Returns the label options of plugin.
double	getPercentage()	Returns the percentage for the data set.
protected boolean	isConsistent()	Returns true if the context is consistent. Custom context (the plugin ones) should extend it and check if the context is consistent before invoking the callback.

Methods inherited from class org.pepstock.charba.client.callbacks.AbstractDatasetContext

getDataIndex, getDatasetElement, getDatasetIndex, getDatasetItem, getMode, isActive

Methods inherited from class org.pepstock.charba.client.callbacks.ChartContext

getAttribute, getAttribute, getAttribute, getAttribute, getAttributes, getChart, getType, hasAttributes, setAttribute, setAttribute, setAttribute, setAttribute, setAttributes

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer

checkDefaultValuesArgument, empty, getArrayValue, getElement, getIncrementalId, getNativeChart, getNativeEvent, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, isType, keys, loadNativeObject, remove, remove, setArrayValue, setArrayValue, setArrayValue, setElement, setEmptyValue, setNewIncrementalId, setNewIncrementalId, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object

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

Method Detail

getLabelOptions

public Label getLabelOptions()

Returns the label options of plugin.

Returns:

the label options of the plugin

getLabel

public String getLabel()

Returns the label for the data set.

Returns:

the label for the data set.

getPercentage

public double getPercentage()

Returns the percentage for the data set.

Returns:

the percentage for the data set.

getDataItem

public DataItem getDataItem()

Returns the value for the data set by a DataItem.

Returns:

the value for the data set by a DataItem.

isConsistent

protected boolean isConsistent()

Description copied from class: ChartContext

Returns true if the context is consistent.
Custom context (the plugin ones) should extend it and check if the context is consistent before invoking the callback.

Overrides:

isConsistent in class ChartContext

Returns:

true if the context is consistent

checkIfPropertyIsValid

protected boolean checkIfPropertyIsValid(Key property)

Description copied from class: ChartContext

Checks if the key passed as argument is a key already used for other context properties.

Overrides:

checkIfPropertyIsValid in class AbstractDatasetContext

Parameters:

property - property to use to store a custom attribute

Returns:

true if the property can be used to store an attribute.