Package org.pepstock.charba.client.callbacks

Class SegmentContext

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.callbacks.ChartContext

org.pepstock.charba.client.callbacks.SegmentContext

public final class SegmentContext
extends ChartContext

The callback or handler context wrapper, created and passed by Segment which contains the line charts references.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor	Description
SegmentContext(NativeObject nativeObject)	Creates the object with native object instance to be wrapped, called by configuration package.

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.
int	getDatasetIndex()	Returns the index of the current data set.
int	getEndDataIndex()	Returns the index of the current data of ending point of segment.
PointElement	getEndPoint()	Returns the PointElement related to the data as ending point of segment.
int	getStartDataIndex()	Returns the index of the current data of starting point of segment.
PointElement	getStartPoint()	Returns the PointElement related to the data as starting point of segment.
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.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, 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, 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

SegmentContext

public SegmentContext(NativeObject nativeObject)

Creates the object with native object instance to be wrapped, called by configuration package.

Parameters:

nativeObject - native object instance to be wrapped.

Method Detail

getStartPoint

public PointElement getStartPoint()

Returns the PointElement related to the data as starting point of segment.

Returns:

the PointElement related to the data as starting point of segment

getEndPoint

public PointElement getEndPoint()

Returns the PointElement related to the data as ending point of segment.

Returns:

the PointElement related to the data as ending point of segment

getDatasetIndex

public int getDatasetIndex()

Returns the index of the current data set.

Returns:

the index of the current data set.

getStartDataIndex

public int getStartDataIndex()

Returns the index of the current data of starting point of segment.

Returns:

the index of the current data of starting point of segment

getEndDataIndex

public int getEndDataIndex()

Returns the index of the current data of ending point of segment.

Returns:

the index of the current data of ending point of segment

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 ChartContext

Parameters:

property - property to use to store a custom attribute

Returns:

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