org.pepstock.charba.client.commons

Class JavaScriptObjectContainer

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

Direct Known Subclasses:

AbstractItem, AnimationItem, BaseBoxItem, ChartBackgroundColorOptions, ChartContainer, ChartNode, Context, Data, DataPoint, Dataset, DatasetItem, DatasetMetaItem, DatasetViewItem, DisplayFormats, LegendItem, Plugins, ScalesNode, SizeItem, TickItem, TooltipBodyItem, TooltipItem, TooltipItemArray, TooltipLabelColor, TooltipLabelColor, TooltipModel, TooltipNode, TooltipsCallbacks, UpdateConfiguration

public class JavaScriptObjectContainer
extends java.lang.Object

Contains a GWT JavaScript object. This is used for all configuration items for CHART.JS.

Author:

Andrea "Stock" Stocchero

See Also:

GenericJavaScriptObject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JavaScriptObjectContainer() Creates the object instantiating new java script object.
protected	JavaScriptObjectContainer(GenericJavaScriptObject javaScriptObject) Creates the object wrapping another java script object.

Method Summary

Modifier and Type	Method and Description
protected JsDoubleArrayList	checkAndGetDoubleValues(Key key, boolean isArray) Checks if the value is stored as array (doubles) into the object and accordingly the element.
protected JsStringArrayList	checkAndGetEnumValues(Key key, boolean isArray) Checks if the value is stored as array (EnumValue) into the object and accordingly the element.
protected JsIntegerArrayList	checkAndGetIntegerValues(Key key, boolean isArray) Checks if the value is stored as array (integers) into the object and accordingly the element.
protected JsStringArrayList	checkAndGetStringValues(Key key, boolean isArray) Checks if the value is stored as array (strings) into the object and accordingly the element.
protected boolean	checkAndSetDoubleValues(Key key, JsDoubleArrayList values) Checks if it should set an array list (doubles) or a single value for a specific property.
protected <T extends Key> boolean	checkAndSetEnumValues(Key key, JsEnumValueArrayList<T> values) Checks if it should set an array list (EnumValues) or a single value for a specific property.
protected boolean	checkAndSetIntegerValues(Key key, JsIntegerArrayList values) Checks if it should set an array list (integers) or a single value for a specific property.
protected boolean	checkAndSetStringValues(Key key, JsStringArrayList values) Checks if it should set an array list (strings) or a single value for a specific property.
protected JsDoubleArrayList	getDoubleArray(Key key) Returns a value (double array list) into embedded JavaScript object at specific property.
protected JsIntegerArrayList	getIntegerArray(Key key) Returns a value (integer array list) into embedded JavaScript object at specific property.
protected GenericJavaScriptObject	getJavaScriptObject() Returns the JavaScript object instance
protected java.util.List<GenericJavaScriptObject>	getObjectArray(Key key) Returns a value (generic java script object array list) into embedded JavaScript object at specific property.
protected JsStringArrayList	getStringArray(Key key) Returns a value (string array list) into embedded JavaScript object at specific property.
protected <T extends com.google.gwt.core.client.JavaScriptObject> T	getValue(Key key) Returns a value (JavaScript Object) into embedded JavaScript object at specific property.
protected boolean	getValue(Key key, boolean defaultValue) Returns a value (boolean) into embedded JavaScript object at specific property.
protected <T extends Key> T	getValue(Key key, java.lang.Class<T> clazz, T defaultValue) Returns a value (key) into embedded JavaScript object at specific property.
protected java.util.Date	getValue(Key key, java.util.Date defaultValue) Returns a value (date) into embedded JavaScript object at specific property.
protected double	getValue(Key key, double defaultValue) Returns a value (double) into embedded JavaScript object at specific property.
protected int	getValue(Key key, int defaultValue) Returns a value (int) into embedded JavaScript object at specific property.
protected java.lang.String	getValue(Key key, java.lang.String defaultValue) Returns a value (string) into embedded JavaScript object at specific property.
protected boolean	has(Key... keys) Returns true if the embedded JavaScript object contains an element at all properties.
protected boolean	has(Key key) Returns true if the embedded JavaScript object contains an element at specific property.
protected boolean	hasToBeRegistered(java.lang.Object object, Key... keys) Returns true if the object is present into embedded JavaScript object.
protected boolean	isEmpty() Returns true if the embedded JavaScript object contains no elements.
protected java.util.List<Key>	keys() Returns the list of properties names of the object.
protected void	remove(Key... keys) Removes a set of elements (by keys) from the embedded JavaScript object.
protected void	remove(Key key) Removes an element (by key) from the embedded JavaScript object.
protected void	removeIfExists(Key key) Removes an element (by key) from the embedded JavaScript object if exists.
protected void	setDoubleArray(Key key, JsDoubleArrayList list) Sets a value (double array list) into embedded JavaScript object at specific property.
protected <T extends Key> void	setEnumValueArray(Key key, JsEnumValueArrayList<T> list) Sets a value (EnumValue array list) into embedded JavaScript object at specific property.
protected void	setIntegerArray(Key key, JsIntegerArrayList list) Sets a value (int array list) into embedded JavaScript object at specific property.
protected <T extends GenericJavaScriptObject> void	setObjectArray(Key key, JsObjectArrayList<T> list) Sets a value (JavaScript array list) into embedded JavaScript object at specific property.
protected void	setStringArray(Key key, JsStringArrayList list) Sets a value (string array list) into embedded JavaScript object at specific property.
protected <E> void	setValue(Key key, AbstractList<E> container) Sets a value (JavaScript object container array list) into embedded JavaScript object at specific property.
protected void	setValue(Key key, boolean value) Sets a value (boolean) into embedded JavaScript object at specific property.
protected void	setValue(Key key, java.util.Date value) Sets a value (date) into embedded JavaScript object at specific property.
protected void	setValue(Key key, double value) Sets a value (double) into embedded JavaScript object at specific property.
protected void	setValue(Key key, int value) Sets a value (int) into embedded JavaScript object at specific property.
protected void	setValue(Key key, com.google.gwt.core.client.JavaScriptObject value) Sets a value (JavaScript Object) into embedded JavaScript object at specific property.
protected void	setValue(Key key, JavaScriptObjectContainer container) Sets a value (JavaScript object container) into embedded JavaScript object at specific property.
protected void	setValue(Key key, java.lang.String value) Sets a value (string) into embedded JavaScript object at specific property.
protected <T extends Key> void	setValue(Key key, T value) Sets a value (EnumValue) into embedded JavaScript object at specific property.
java.lang.String	toString()
protected JavaScriptFieldType	type(Key key) Returns the java script type of the property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JavaScriptObjectContainer

protected JavaScriptObjectContainer()

Creates the object instantiating new java script object.

JavaScriptObjectContainer

protected JavaScriptObjectContainer(GenericJavaScriptObject javaScriptObject)

Creates the object wrapping another java script object.

Parameters:

javaScriptObject - java script object to be wrapped

Method Detail

getJavaScriptObject

protected final GenericJavaScriptObject getJavaScriptObject()

Returns the JavaScript object instance

Returns:

the JavaScript object instance

isEmpty

protected boolean isEmpty()

Returns true if the embedded JavaScript object contains no elements.

Returns:

true if the embedded JavaScript object contains no elements.

has

protected boolean has(Key key)

Returns true if the embedded JavaScript object contains an element at specific property.

Parameters:

key - key of the property of JavaScript object.

Returns:

true if the embedded JavaScript object contains an element at specific property

See Also:

Key

has

protected boolean has(Key... keys)

Returns true if the embedded JavaScript object contains an element at all properties.

Parameters:

keys - set of keys of the properties of JavaScript object.

Returns:

true if the embedded JavaScript object contains an element at all properties.

See Also:

Key

keys

protected java.util.List<Key> keys()

Returns the list of properties names of the object.

Returns:

the list of properties names of the object.

type

protected JavaScriptFieldType type(Key key)

Returns the java script type of the property.

Parameters:

key - name of the java script property.

Returns:

the java script type of the property.

removeIfExists

protected void removeIfExists(Key key)

Removes an element (by key) from the embedded JavaScript object if exists.

Parameters:

key - key of the property of JavaScript object.

See Also:

Key

remove

protected void remove(Key key)

Removes an element (by key) from the embedded JavaScript object.

Parameters:

key - key of the property of JavaScript object.

See Also:

Key

remove

protected void remove(Key... keys)

Removes a set of elements (by keys) from the embedded JavaScript object.

Parameters:

keys - set of keys of the properties of JavaScript object.

See Also:

Key

hasToBeRegistered

protected boolean hasToBeRegistered(java.lang.Object object,
                                    Key... keys)

Returns true if the object is present into embedded JavaScript object.

Parameters:

object - object to be set

keys - set of keys of the properties of JavaScript object.

Returns:

true if the object is NOT present.

See Also:

Key

setValue

protected void setValue(Key key,
                        int value)

Sets a value (int) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

value - value to be set

See Also:

Key

getValue

protected int getValue(Key key,
                       int defaultValue)

Returns a value (int) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

defaultValue - default value if the property is missing

Returns:

value of the property

See Also:

Key

setValue

protected void setValue(Key key,
                        double value)

Sets a value (double) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

value - value to be set

See Also:

Key

getValue

protected double getValue(Key key,
                          double defaultValue)

Returns a value (double) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

defaultValue - default value if the property is missing

Returns:

value of the property

See Also:

Key

setValue

protected void setValue(Key key,
                        boolean value)

Sets a value (boolean) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

value - value to be set

See Also:

Key

getValue

protected boolean getValue(Key key,
                           boolean defaultValue)

Returns a value (boolean) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

defaultValue - default value if the property is missing

Returns:

value of the property

See Also:

Key

getValue

protected java.lang.String getValue(Key key,
                                    java.lang.String defaultValue)

Returns a value (string) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

defaultValue - default value if the property is missing

Returns:

value of the property

See Also:

Key

setValue

protected void setValue(Key key,
                        java.lang.String value)

Sets a value (string) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

value - value to be set

See Also:

Key

getValue

protected java.util.Date getValue(Key key,
                                  java.util.Date defaultValue)

Returns a value (date) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

defaultValue - default value if the property is missing

Returns:

value of the property

See Also:

Key

setValue

protected void setValue(Key key,
                        java.util.Date value)

Sets a value (date) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

value - value to be set

See Also:

Key

getValue

protected <T extends com.google.gwt.core.client.JavaScriptObject> T getValue(Key key)

Returns a value (JavaScript Object) into embedded JavaScript object at specific property.

Type Parameters:

T - type of java script object

Parameters:

key - key of the property of JavaScript object.

Returns:

value of the property or null if not there

See Also:

Key, JavaScriptObject

setValue

protected void setValue(Key key,
                        com.google.gwt.core.client.JavaScriptObject value)

Sets a value (JavaScript Object) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

value - value to be set

See Also:

JavaScriptObject, Key

getValue

protected <T extends Key> T getValue(Key key,
                                     java.lang.Class<T> clazz,
                                     T defaultValue)

Returns a value (key) into embedded JavaScript object at specific property.

Type Parameters:

T - type of key

Parameters:

key - key of the property of JavaScript object.

clazz - class of object to get all enumeration values

defaultValue - default value if the property is missing

Returns:

value of the property

See Also:

Key

setValue

protected <T extends Key> void setValue(Key key,
                                        T value)

Sets a value (EnumValue) into embedded JavaScript object at specific property.

Type Parameters:

T - type of key

Parameters:

key - key of the property of JavaScript object.

value - value to be set

See Also:

Key

setDoubleArray

protected final void setDoubleArray(Key key,
                                    JsDoubleArrayList list)

Sets a value (double array list) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

list - value to be set

See Also:

Key, JsDoubleArrayList

getDoubleArray

protected final JsDoubleArrayList getDoubleArray(Key key)

Returns a value (double array list) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

Returns:

value of the property or empty list if not there

See Also:

Key, JsDoubleArrayList

checkAndSetDoubleValues

protected boolean checkAndSetDoubleValues(Key key,
                                          JsDoubleArrayList values)

Checks if it should set an array list (doubles) or a single value for a specific property.

Parameters:

key - key of the property of JavaScript object.

values - array list to set

Returns:

true if the complete list has been set otherwise false

See Also:

JsDoubleArrayList

checkAndGetDoubleValues

protected JsDoubleArrayList checkAndGetDoubleValues(Key key,
                                                    boolean isArray)

Checks if the value is stored as array (doubles) into the object and accordingly the element.

Parameters:

key - key of the property of JavaScript object.

isArray - true if the value has been stored as an array

Returns:

an array list of elements

See Also:

JsDoubleArrayList

setStringArray

protected final void setStringArray(Key key,
                                    JsStringArrayList list)

Sets a value (string array list) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

list - value to be set

See Also:

Key, JsStringArrayList

getStringArray

protected final JsStringArrayList getStringArray(Key key)

Returns a value (string array list) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

Returns:

value of the property or empty list if not there

See Also:

Key, JsStringArrayList

checkAndSetStringValues

protected boolean checkAndSetStringValues(Key key,
                                          JsStringArrayList values)

Checks if it should set an array list (strings) or a single value for a specific property.

Parameters:

key - key of the property of JavaScript object.

values - array list to set

Returns:

true if the complete list has been set otherwise false

See Also:

JsStringArrayList

checkAndGetStringValues

protected JsStringArrayList checkAndGetStringValues(Key key,
                                                    boolean isArray)

Checks if the value is stored as array (strings) into the object and accordingly the element.

Parameters:

key - key of the property of JavaScript object.

isArray - true if the value has been stored as an array

Returns:

an array list of elements

See Also:

JsStringArrayList

setEnumValueArray

protected final <T extends Key> void setEnumValueArray(Key key,
                                                       JsEnumValueArrayList<T> list)

Sets a value (EnumValue array list) into embedded JavaScript object at specific property.

Type Parameters:

T - type of key

Parameters:

key - key of the property of JavaScript object.

list - value to be set

See Also:

Key, JsEnumValueArrayList

checkAndSetEnumValues

protected <T extends Key> boolean checkAndSetEnumValues(Key key,
                                                        JsEnumValueArrayList<T> values)

Checks if it should set an array list (EnumValues) or a single value for a specific property.

Type Parameters:

T - type of key

Parameters:

key - key of the property of JavaScript object.

values - array list to set

Returns:

true if the complete list has been set otherwise false

See Also:

JsEnumValueArrayList

checkAndGetEnumValues

protected JsStringArrayList checkAndGetEnumValues(Key key,
                                                  boolean isArray)

Checks if the value is stored as array (EnumValue) into the object and accordingly the element.

Parameters:

key - key of the property of JavaScript object.

isArray - true if the value has been stored as an array

Returns:

an array list of elements

See Also:

JsStringArrayList

setIntegerArray

protected final void setIntegerArray(Key key,
                                     JsIntegerArrayList list)

Sets a value (int array list) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

list - value to be set

See Also:

Key, JsIntegerArrayList

getIntegerArray

protected final JsIntegerArrayList getIntegerArray(Key key)

Returns a value (integer array list) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

Returns:

value of the property or empty list if not there

See Also:

Key, JsIntegerArrayList

checkAndSetIntegerValues

protected boolean checkAndSetIntegerValues(Key key,
                                           JsIntegerArrayList values)

Checks if it should set an array list (integers) or a single value for a specific property.

Parameters:

key - key of the property of JavaScript object.

values - array list to set

Returns:

true if the complete list has been set otherwise false

See Also:

JsIntegerArrayList

checkAndGetIntegerValues

protected JsIntegerArrayList checkAndGetIntegerValues(Key key,
                                                      boolean isArray)

Checks if the value is stored as array (integers) into the object and accordingly the element.

Parameters:

key - key of the property of JavaScript object.

isArray - true if the value has been stored as an array

Returns:

an array list of elements

See Also:

JsIntegerArrayList

setObjectArray

protected final <T extends GenericJavaScriptObject> void setObjectArray(Key key,
                                                                        JsObjectArrayList<T> list)

Sets a value (JavaScript array list) into embedded JavaScript object at specific property.

Type Parameters:

T - type of java script object

Parameters:

key - key of the property of JavaScript object.

list - value to be set

See Also:

Key, JsObjectArrayList

setValue

protected void setValue(Key key,
                        JavaScriptObjectContainer container)

Sets a value (JavaScript object container) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

container - value to be set

See Also:

Key, JavaScriptObjectContainer

setValue

protected <E> void setValue(Key key,
                            AbstractList<E> container)

Sets a value (JavaScript object container array list) into embedded JavaScript object at specific property.

Type Parameters:

E - type of java script object

Parameters:

key - key of the property of JavaScript object.

container - value to be set

See Also:

Key, AbstractList

getObjectArray

protected java.util.List<GenericJavaScriptObject> getObjectArray(Key key)

Returns a value (generic java script object array list) into embedded JavaScript object at specific property.

Parameters:

key - key of the property of JavaScript object.

Returns:

value of the property or an emtpy list if not there

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object