org.pepstock.charba.client.commons

Class GenericJavaScriptObject

java.lang.Object

com.google.gwt.core.client.JavaScriptObject

org.pepstock.charba.client.commons.GenericJavaScriptObject

Direct Known Subclasses:

Scales.InternalJavaScriptObject

public class GenericJavaScriptObject
extends com.google.gwt.core.client.JavaScriptObject

A wrapper to a native GWT JavaScript object.
A JavaScriptObject cannot be created directly.
JavaScriptObject should be declared as the return type of a JSNI method that returns native (non-Java) objects.
A JavaScriptObject passed back into JSNI from Java becomes the original object, and can be accessed in JavaScript as expected.

Author:

Andrea "Stock" Stocchero

See Also:

JavaScriptObject

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GenericJavaScriptObject() Needed for GWT injection

Method Summary

Modifier and Type	Method and Description
protected boolean	contains(java.lang.String key) Returns true if this object contains the specified element.
protected boolean	getBoolean(java.lang.String key) Returns the element (boolean) stored in this object at specific key.
protected double	getDouble(java.lang.String key) Returns the element (double) stored in this object at specific key.
protected JsDoubleArrayList	getDoubleArray(java.lang.String key) Returns an array list (doubles) from the JavaScript object.
protected int	getInt(java.lang.String key) Returns the element (int) stored in this object at specific key.
protected JsIntegerArrayList	getIntegerArray(java.lang.String key) Returns an array list (integers) from the JavaScript object.
protected com.google.gwt.core.client.JavaScriptObject	getJavaScriptObject(java.lang.String key) Returns the element (javaScript object instance) stored in this object at specific key.
protected <T extends GenericJavaScriptObject> JsObjectArrayList<T>	getObjectArray(java.lang.String key) Returns an array list (generic JavaScript objects) from the JavaScript object.
protected java.lang.String	getString(java.lang.String key) Returns the element (string) stored in this object at specific key.
protected JsStringArrayList	getStringArray(java.lang.String key) Returns an array list (strings) from the JavaScript object.
protected boolean	isArray(java.lang.String key) Returns true if this object is an array. For further information, refer to this JavaScript documentation: https://developer.mozilla.org/it/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray
protected boolean	isEmpty() Returns true if this object contains no elements.
protected java.lang.String[]	keys() Returns the list of elements names of the object.
protected void	remove(java.lang.String key) Removes the occurrence of the specified element from this object by its property name, if it is present.
protected void	setBoolean(java.lang.String key, boolean value) Sets an element (boolean) in this object by key.
protected void	setDouble(java.lang.String key, double value) Sets an element (double) in this object by key.
protected void	setDoubleArray(java.lang.String key, JsDoubleArrayList list) Stores an array list (doubles) into the JavaScript object.
protected void	setInt(java.lang.String key, int value) Sets an element (int) in this object by key.
protected void	setIntegerArray(java.lang.String key, JsIntegerArrayList list) Stores an array list (integers) into the JavaScript object.
protected void	setJavaScriptObject(java.lang.String key, com.google.gwt.core.client.JavaScriptObject value) Sets an element (javaScript object instance) in this object by key.
protected <T extends GenericJavaScriptObject> void	setObjectArray(java.lang.String key, JsObjectArrayList<T> list) Stores an array list (generic JavaScript objects) into the JavaScript object.
protected void	setString(java.lang.String key, java.lang.String value) Sets an element (string) in this object by key.
protected void	setStringArray(java.lang.String key, JsStringArrayList list) Stores an array list (strings) into the JavaScript object.
protected int	size() Returns the number of elements in this object.
java.lang.String	toJSON() Returns a JSON representation of this object.
protected java.lang.String	typeOf(java.lang.String key) Returns the type of element in this object. TypeResult Undefined"undefined" Null"object" Boolean"boolean" Number"number" String"string" Function"function" Any other object"object" For further information, refer to this JavaScript documentation: https://developer.mozilla.org/it/docs/Web/JavaScript/Reference/Operators/typeof Methods inherited from class com.google.gwt.core.client.JavaScriptObject cast, createArray, createArray, createFunction, createObject, equals, hashCode, toSource, toString Methods inherited from class java.lang.Object clone, finalize, getClass, notify, notifyAll, wait, wait, wait Constructor Detail GenericJavaScriptObject protected GenericJavaScriptObject() Needed for GWT injection Method Detail setIntegerArray protected final void setIntegerArray(java.lang.String key, JsIntegerArrayList list) Stores an array list (integers) into the JavaScript object. Parameters: key - name of the property of JavaScript object where to store the array list. list - array list instance to be stored See Also: JsIntegerArrayList getIntegerArray protected final JsIntegerArrayList getIntegerArray(java.lang.String key) Returns an array list (integers) from the JavaScript object. Parameters: key - key name of the property of JavaScript object. Returns: array list instance stored in this object See Also: JsIntegerArrayList setDoubleArray protected final void setDoubleArray(java.lang.String key, JsDoubleArrayList list) Stores an array list (doubles) into the JavaScript object. Parameters: key - name of the property of JavaScript object where to store the array list. list - array list instance to be stored See Also: JsDoubleArrayList getDoubleArray protected final JsDoubleArrayList getDoubleArray(java.lang.String key) Returns an array list (doubles) from the JavaScript object. Parameters: key - key name of the property of JavaScript object. Returns: array list instance stored in this object See Also: JsDoubleArrayList setStringArray protected final void setStringArray(java.lang.String key, JsStringArrayList list) Stores an array list (strings) into the JavaScript object. Parameters: key - name of the property of JavaScript object where to store the array list. list - array list instance to be stored See Also: JsStringArrayList getStringArray protected final JsStringArrayList getStringArray(java.lang.String key) Returns an array list (strings) from the JavaScript object. Parameters: key - key name of the property of JavaScript object. Returns: array list instance stored in this object See Also: JsStringArrayList setObjectArray protected final <T extends GenericJavaScriptObject> void setObjectArray(java.lang.String key, JsObjectArrayList<T> list) Stores an array list (generic JavaScript objects) into the JavaScript object. Type Parameters: T - type of java script object Parameters: key - name of the property of JavaScript object where to store the array list. list - array list instance to be stored See Also: JsObjectArrayList getObjectArray protected final <T extends GenericJavaScriptObject> JsObjectArrayList<T> getObjectArray(java.lang.String key) Returns an array list (generic JavaScript objects) from the JavaScript object. Type Parameters: T - type of java script object Parameters: key - key name of the property of JavaScript object. Returns: array list instance stored in this object See Also: JsObjectArrayList keys protected final java.lang.String[] keys() Returns the list of elements names of the object. Returns: the list of elements names of the object. isEmpty protected final boolean isEmpty() Returns true if this object contains no elements. Returns: true if this object contains no elements. size protected final int size() Returns the number of elements in this object. Returns: the number of elements in this list. typeOf protected final java.lang.String typeOf(java.lang.String key) Returns the type of element in this object. Type Result Undefined "undefined" Null "object" Boolean "boolean" Number "number" String "string" Function "function" Any other object "object" For further information, refer to this JavaScript documentation: https://developer.mozilla.org/it/docs/Web/JavaScript/Reference/Operators/typeof Parameters: key - name of the property of JavaScript object. Returns: a string value which represents the type of property isArray protected final boolean isArray(java.lang.String key) Returns true if this object is an array. For further information, refer to this JavaScript documentation: https://developer.mozilla.org/it/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray Parameters: key - name of the property of JavaScript object. Returns: true if this object is an array. contains protected final boolean contains(java.lang.String key) Returns true if this object contains the specified element. Parameters: key - name of the property of JavaScript object. Returns: true if this object contains the specified element. remove protected final void remove(java.lang.String key) Removes the occurrence of the specified element from this object by its property name, if it is present. Parameters: key - name of the property of JavaScript object. setBoolean protected final void setBoolean(java.lang.String key, boolean value) Sets an element (boolean) in this object by key. Parameters: key - name of the property of JavaScript object. value - value of element. getBoolean protected final boolean getBoolean(java.lang.String key) Returns the element (boolean) stored in this object at specific key. Parameters: key - name of the property of JavaScript object. Returns: the element stored in this object at specific key. setInt protected final void setInt(java.lang.String key, int value) Sets an element (int) in this object by key. Parameters: key - name of the property of JavaScript object. value - value of element. getInt protected final int getInt(java.lang.String key) Returns the element (int) stored in this object at specific key. Parameters: key - name of the property of JavaScript object. Returns: the element stored in this object at specific key. setDouble protected final void setDouble(java.lang.String key, double value) Sets an element (double) in this object by key. Parameters: key - name of the property of JavaScript object. value - value of element. getDouble protected final double getDouble(java.lang.String key) Returns the element (double) stored in this object at specific key. Parameters: key - name of the property of JavaScript object. Returns: the element stored in this object at specific key. setString protected final void setString(java.lang.String key, java.lang.String value) Sets an element (string) in this object by key. Parameters: key - name of the property of JavaScript object. value - value of element. getString protected final java.lang.String getString(java.lang.String key) Returns the element (string) stored in this object at specific key. Parameters: key - name of the property of JavaScript object. Returns: the element stored in this object at specific key. setJavaScriptObject protected final void setJavaScriptObject(java.lang.String key, com.google.gwt.core.client.JavaScriptObject value) Sets an element (javaScript object instance) in this object by key. Parameters: key - name of the property of JavaScript object. value - value of element. See Also: JavaScriptObject getJavaScriptObject protected final com.google.gwt.core.client.JavaScriptObject getJavaScriptObject(java.lang.String key) Returns the element (javaScript object instance) stored in this object at specific key. Parameters: key - name of the property of JavaScript object. Returns: the element stored in this object at specific key. See Also: JavaScriptObject toJSON public final java.lang.String toJSON() Returns a JSON representation of this object. Returns: a JSON representation of this object Skip navigation links Overview Package Class Use Tree Deprecated Index Help Prev Class Next Class Frames No Frames All Classes Summary: Nested | Field | Constr | Method Detail: Field | Constr | Method