org.pepstock.charba.client.options

Class Adapters

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.Adapters

All Implemented Interfaces:

IsDefaultAdapters

public final class Adapters
extends NativeObjectContainer
implements IsDefaultAdapters

The following adapters element is used to configure a date adapter, injecting to support time series into CAHRT.JS.

Author:

Andrea "Stock" Stocchero

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.
protected Key	getChildKey() Returns the property name to use to add this element to its parent.
<T extends DateAdapterOptions> T	getDate(DateAdaptersOptionsFactory<T> factory) Returns the date adapter options, if exist. It uses a factory instance to create a date adapter options. If factory argument is not consistent, null is returned.
protected D	getDefaultValues() Returns the default provider instance.
protected P	getParent() Returns the parent element.
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.
<T extends DateAdapterOptions> void	setDate(T options) Sets the date adapters options.
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.commons.NativeObjectContainer

checkValue, empty, getArrayValue, getNativeChart, 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, setArrayValue, setValue, 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

Method Detail

setDate

public <T extends DateAdapterOptions> void setDate(T options)

Sets the date adapters options.

Type Parameters:

T - type of date adapters options to store

Parameters:

options - date adapters options used to configure the adapter

getDate

public <T extends DateAdapterOptions> T getDate(DateAdaptersOptionsFactory<T> factory)

Returns the date adapter options, if exist.
It uses a factory instance to create a date adapter options.
If factory argument is not consistent, null is returned.

Specified by:

getDate in interface IsDefaultAdapters

Type Parameters:

T - type of date adapter options to return

Parameters:

factory - factory instance to create a date adapter options

Returns:

date adapter options used to configure the date adapter or an empty object if not exist.
If factory argument is not consistent, null is returned.

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.