org.pepstock.charba.client.options

Class ExtendedOptions

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.Options

org.pepstock.charba.client.options.ScaledOptions

org.pepstock.charba.client.options.ExtendedOptions

All Implemented Interfaces:

IsDefaultOptions, IsDefaultScaledOptions

public final class ExtendedOptions
extends ScaledOptions

Options used internally inside the chart configuration. This is the root element of configuration.
Extends the normal options (with scales) with all methods to add callbacks and events.
It provides also the method to set the CHARBA id when new chart is created.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
ExtendedOptions(IsChart chart, IsDefaultScaledOptions defaultValues) Creates an options with default provider.
ExtendedOptions(IsChart chart, IsDefaultScaledOptions defaultValues, OptionsEnvelop envelop) Creates an options 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.
IsChart	getChart() Returns the chart instance which is using the options.
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(Key property, CallbackProxy.Proxy proxy) This method adds new callback function proxy to the element, as property of native java script object.
void	setCallback(LegendLabels labels, Key property, CallbackProxy.Proxy proxy) Adds a event proxy function to legend labels element instance.
void	setCallback(TooltipsCallbacks tooltips, Key property, CallbackProxy.Proxy proxy) Adds a event proxy function to tooltips callbacks element instance.
void	setCallback(Tooltips tooltips, Key property, CallbackProxy.Proxy proxy) Adds a event proxy function to tooltips 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.
void	setCharbaId(String id) Sets the CHARBA id when new chart instance is created.
void	setEvent(Animation animation, Key property, CallbackProxy.Proxy proxy) Adds a event proxy function to animation element instance.
void	setEvent(Key property, CallbackProxy.Proxy proxy) This method adds new event function proxy to the element, as property of native java script object.
void	setEvent(Legend legend, Key property, CallbackProxy.Proxy proxy) Adds a event proxy function to legend element instance.
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.ScaledOptions

getScale, getScales, setScale

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

getAnimation, getAspectRatio, getCharbaId, getCircumference, getCutoutPercentage, getDefaultColor, getDefaultColorAsString, getDefaultFontColor, getDefaultFontColorAsString, getDefaultFontFamily, getDefaultFontSize, getDefaultFontStyle, getDefaultLineHeight, getDevicePixelRatio, getElements, getEvents, getHover, getLayout, getLegend, getPlugins, getResponsiveAnimationDuration, getRotation, getStartAngle, getTitle, getTooltips, isDestroyOnDetach, isDrawOnAttach, isMaintainAspectRatio, isResponsive, isShowLines, isSpanGaps, setAspectRatio, setCircumference, setCutoutPercentage, setDefaultColor, setDefaultColor, setDefaultFontColor, setDefaultFontColor, setDefaultFontFamily, setDefaultFontSize, setDefaultFontStyle, setDefaultLineHeight, setDestroyOnDetach, setDevicePixelRatio, setDrawOnAttach, setEvents, setMaintainAspectRatio, setResponsive, setResponsiveAnimationDuration, setRotation, setShowLines, setSpanGaps, setStartAngle

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

Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultOptions

getAnimation, getAspectRatio, getCircumference, getCutoutPercentage, getDefaultColorAsString, getDefaultFontColorAsString, getDefaultFontFamily, getDefaultFontSize, getDefaultFontStyle, getDefaultLineHeight, getDevicePixelRatio, getElements, getHover, getLayout, getLegend, getPlugins, getResponsiveAnimationDuration, getRotation, getStartAngle, getTitle, getTooltips, isDestroyOnDetach, isDrawOnAttach, isMaintainAspectRatio, isResponsive, isShowLines, isSpanGaps

Constructor Detail

ExtendedOptions

public ExtendedOptions(IsChart chart,
                       IsDefaultScaledOptions defaultValues)

Creates an options with default provider. The native object is created empty.

Parameters:

chart - chart instance

defaultValues - default provider.

ExtendedOptions

public ExtendedOptions(IsChart chart,
                       IsDefaultScaledOptions defaultValues,
                       OptionsEnvelop envelop)

Creates an options with default provider. The native object is created empty.

Parameters:

chart - chart instance

defaultValues - default provider

envelop - the envelop for options as native options

Method Detail

getChart

public IsChart getChart()

Returns the chart instance which is using the options.

Returns:

the chart instance which is using the options

setCharbaId

public void setCharbaId(String id)

Sets the CHARBA id when new chart instance is created.

Parameters:

id - CHARBA id.

setEvent

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

This method adds new event 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(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.

setEvent

public void setEvent(Animation animation,
                     Key property,
                     CallbackProxy.Proxy proxy)

Adds a event proxy function to animation element instance.

Parameters:

animation - animation element instance.

property - property name.

proxy - function proxy to activate.

setEvent

public void setEvent(Legend legend,
                     Key property,
                     CallbackProxy.Proxy proxy)

Adds a event proxy function to legend element instance.

Parameters:

legend - legend element instance

property - property name.

proxy - function proxy to activate.

setCallback

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

Adds a event proxy function to legend labels element instance.

Parameters:

labels - legend labels element instance.

property - property name.

proxy - function proxy to activate.

setCallback

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

Adds a event proxy function to tooltips element instance.

Parameters:

tooltips - tooltips element instance.

property - property name.

proxy - function proxy to activate.

setCallback

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

Adds a event proxy function to tooltips callbacks element instance.

Parameters:

tooltips - tooltips callbacks 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.