Package org.pepstock.charba.client.callbacks

Class TooltipContext

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.callbacks.ChartContext

org.pepstock.charba.client.callbacks.TooltipContext

public final class TooltipContext
extends ChartContext

The option context is used to give contextual information when resolving options.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor	Description
TooltipContext(NativeObject nativeObject)	Creates the object with native object instance to be wrapped.

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.
List<TooltipItem>	getItems()	Returns the model of tooltip.
TooltipModel	getModel()	Returns the model of tooltip.

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

getAttribute, getAttribute, getAttribute, getAttribute, getAttributes, getChart, getType, hasAttributes, isConsistent, 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

Constructor Detail

TooltipContext

public TooltipContext(NativeObject nativeObject)

Creates the object with native object instance to be wrapped.

Parameters:

nativeObject - native object instance to be wrapped.

Method Detail

getModel

public TooltipModel getModel()

Returns the model of tooltip.

Returns:

the model of tooltip

getItems

public List<TooltipItem> getItems()

Returns the model of tooltip.

Returns:

the model of tooltip

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 ChartContext

Parameters:

property - property to use to store a custom attribute

Returns:

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