org.pepstock.charba.client.options

Class ExtendedScale

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.Scale

org.pepstock.charba.client.options.ExtendedScale

All Implemented Interfaces:

IsDefaultScale

public final class ExtendedScale
extends Scale

Scale options used internally inside the chart configuration.
Extends the normal scale options with all methods to add callbacks and events.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
ExtendedScale(IsDefaultScale defaultValues) Creates a scale with default provider.

Method Summary

Modifier and Type	Method and Description
protected void	checkAndAddToParent() Called recursively when a property has been set in the item. This is mandatory because it could happen that the parent item is not present, therefore it must be added.
int	getCharbaId() Returns the unique id of scale.
protected Key	getChildKey() Returns the property name to use to add this element to its parent.
protected D	getDefaultValues() Returns the default provider instance.
protected P	getParent() Returns the parent element.
void	setCallback(AbstractTick<?,?> tick, Key property, CallbackProxy.Proxy proxy) Adds a callback proxy function to tick element instance.
void	setCallback(Key property, CallbackProxy.Proxy proxy) This method adds new callback function proxy to the element, as property of native java script object.
void	setCallback(PointLabels pointLabels, Key property, CallbackProxy.Proxy proxy) Adds a callback proxy function to point labels element instance.
protected void	setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy) Adds a proxy function (for callbacks) to a model at the specific key.
protected void	setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy) Adds a proxy function (for events) to a model at the specific key.

Methods inherited from class org.pepstock.charba.client.options.Scale

getAngleLines, getBounds, getDisplay, getDistribution, getGrideLines, getId, getPointLabels, getPosition, getScaleLabel, getTicks, getTime, getType, getWeight, isOffset, isStacked, setBounds, setDisplay, setDisplay, setDistribution, setId, setOffset, setPosition, setStacked, setType, setWeight

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

checkValue, empty, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, 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

ExtendedScale

public ExtendedScale(IsDefaultScale defaultValues)

Creates a scale with default provider. The native object is created empty.

Parameters:

defaultValues - default provider.

Method Detail

getCharbaId

public int getCharbaId()

Returns the unique id of scale.

Returns:

the unique id of scale

setCallback

public void setCallback(Key property,
                        CallbackProxy.Proxy proxy)

This method adds new callback function proxy to the element, as property of native java script object.

Parameters:

property - property name.

proxy - function proxy to activate.

setCallback

public void setCallback(AbstractTick<?,?> tick,
                        Key property,
                        CallbackProxy.Proxy proxy)

Adds a callback proxy function to tick element instance.

Parameters:

tick - tick element instance.

property - property name.

proxy - function proxy to activate.

setCallback

public void setCallback(PointLabels pointLabels,
                        Key property,
                        CallbackProxy.Proxy proxy)

Adds a callback proxy function to point labels element instance.

Parameters:

pointLabels - point labels element instance.

property - property name.

proxy - function proxy to activate.

getChildKey

protected final Key getChildKey()

Returns the property name to use to add this element to its parent.

Returns:

the childKey or null if is a root element.

getParent

protected final P getParent()

Returns the parent element.

Returns:

the parent or null if is a root element.

getDefaultValues

protected final D getDefaultValues()

Returns the default provider instance.

Returns:

the default provider instance.

setEventToModel

protected final void setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                     Key key,
                                     CallbackProxy.Proxy proxy)

Adds a proxy function (for events) to a model at the specific key.

Parameters:

model - element where adding the function proxy

key - property name to use to add the function proxy

proxy - the function proxy instance to add

setCallbackToModel

protected final void setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                        Key key,
                                        CallbackProxy.Proxy proxy)

Adds a proxy function (for callbacks) to a model at the specific key.

Parameters:

model - element where adding the function proxy

key - property name to use to add the function proxy

proxy - the function proxy instance to add

checkAndAddToParent

protected final void checkAndAddToParent()

Called recursively when a property has been set in the item.
This is mandatory because it could happen that the parent item is not present, therefore it must be added.