org.pepstock.charba.client.options

Class AbstractModel<P extends AbstractModel<?,?>,D>

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.AbstractModel<P,D>

Type Parameters:

P - parent node class

D - defaults provider class

Direct Known Subclasses:

AbstractElement, AngleLines, Animation, DisplayFormats, Elements, FontItem, GridLines, Hover, Layout, Legend, Options, Padding, Plugins, Scale, ScaleLabelPadding, Scales, Time, Tooltips, TooltipsCallbacks

public abstract class AbstractModel<P extends AbstractModel<?,?>,D>
extends NativeObjectContainer

Base class for all options, which will wraps a native object and manages the relations about parent and children elements.
Provides also a set of methods to manages callbacks and events.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractModel(D defaultValues) Creates the object with default provider. This is the root of elements tree and new native object is created.
protected	AbstractModel(D defaultValues, NativeObject nativeObject) Creates the object with default provider and the native object. This is the root of elements tree .
protected	AbstractModel(P parent, Key childKey, D defaultValues) Creates the object with parent element, the key of this element and default values. The native object to map java script properties will be created empty.
protected	AbstractModel(P parent, Key childKey, D defaultValues, NativeObject nativeObject) Creates the object with the parent, the key of this element, default values and native object to map java script properties.

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.
protected D	getDefaultValues() Returns the default provider instance.
protected P	getParent() Returns the parent element.
protected void	setCallbackToModel(AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy) Adds a proxy function (for callbacks) to a model at the specific key.
protected void	setEventToModel(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

getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, 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

AbstractModel

protected AbstractModel(D defaultValues)

Creates the object with default provider.
This is the root of elements tree and new native object is created.

Parameters:

defaultValues - default provider

AbstractModel

protected AbstractModel(P parent,
                        Key childKey,
                        D defaultValues)

Creates the object with parent element, the key of this element and default values.
The native object to map java script properties will be created empty.

Parameters:

parent - parent node to use to add this element where changed

childKey - the property name of this element to use to add it to the parent.

defaultValues - default provider

AbstractModel

protected AbstractModel(D defaultValues,
                        NativeObject nativeObject)

Creates the object with default provider and the native object.
This is the root of elements tree .

Parameters:

defaultValues - default provider

nativeObject - native object to map java script properties

AbstractModel

protected AbstractModel(P parent,
                        Key childKey,
                        D defaultValues,
                        NativeObject nativeObject)

Creates the object with the parent, the key of this element, default values and native object to map java script properties.

Parameters:

parent - parent node to use to add this element where changed

childKey - the property name of this element to use to add it to the parent.

defaultValues - default provider

nativeObject - native object to map java script properties

Method Detail

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(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(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.