NativeObjectContainer (Charba, GWT wrapper for CHART.JS)

java.lang.Object
- org.pepstock.charba.client.commons.NativeObjectContainer

Direct Known Subclasses:

AbstractModel, AbstractPluginOptions, AnimationItem, BaseBoxItem, CanvasObject, ChartBackgroundColorOptions, ChartPointerOptions, ClearSelection, Data, DataPoint, Dataset, DatasetItem, DatasetMetaItem, DatasetPluginItem, DatasetsItemsSelectorOptions, DatasetViewItem, EventPluginItem, Font, GradientColor, LegendItem, Listeners, Padding, ScalesNode, SizeItem, TooltipBodyItem, TooltipItem, TooltipLabelColor, TooltipModel, TooltipNode, TooltipPluginItem, UpdateConfiguration
```
public abstract class NativeObjectContainer
extends Object
```
Base class for all classes which are wrapping a native java script object.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`NativeObjectContainer()` Creates the object with an empty native object instance.
`protected`	`NativeObjectContainer(NativeObject nativeObject)` Creates the object with native object instance to be wrapped.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected <T extends Array> T`	`getArrayValue(Key key)` Returns a value (array) into embedded JavaScript object at specific property.
`protected NativeObject`	`getNativeObject()` Returns the native object instance.
`protected NativeObject`	`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 CanvasGradient`	`getValue(Key key, CanvasGradient defaultValue)` Returns a value (gradient) into embedded JavaScript object at specific property.
`protected CanvasPattern`	`getValue(Key key, CanvasPattern defaultValue)` Returns a value (pattern) into embedded JavaScript object at specific property.
`protected <T extends Key> T`	`getValue(Key key, Class<T> clazz, T defaultValue)` Returns a value (key) into embedded JavaScript object at specific property.
`protected Date`	`getValue(Key key, 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 ImageElement`	`getValue(Key key, ImageElement defaultValue)` Returns a value (image) 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 String`	`getValue(Key key, String defaultValue)` Returns a value (string) into embedded JavaScript object at specific property.
`protected ArrayGradient`	`getValueOrArray(Key key, CanvasGradient defaultValue)` Returns a value (array) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a gradient.
`protected ArrayPattern`	`getValueOrArray(Key key, CanvasPattern defaultValue)` Returns a value (array) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a pattern.
`protected ArrayDouble`	`getValueOrArray(Key key, double defaultValue)` Returns a value (array) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a double.
`protected ArrayImage`	`getValueOrArray(Key key, ImageElement defaultValue)` Returns a value (array) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a image.
`protected ArrayInteger`	`getValueOrArray(Key key, int defaultValue)` Returns a value (array) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a integer.
`protected ArrayString`	`getValueOrArray(Key key, Key defaultValue)` Returns a value (array) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a key.
`protected ArrayString`	`getValueOrArray(Key key, String defaultValue)` Returns a value (array) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a string.
`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 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`	`setArrayValue(Key key, ArrayObjectContainerList<?> container)` Sets a value (Array from a container list) into embedded JavaScript object at specific property.
`protected <T extends Array> void`	`setArrayValue(Key key, T value)` Sets a value (Array) 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, CallbackProxy.Proxy value)` Sets a value (callback proxy function) into embedded JavaScript object at specific property.
`protected void`	`setValue(Key key, CanvasGradient value)` Sets a value (gradient) into embedded JavaScript object at specific property.
`protected void`	`setValue(Key key, CanvasPattern value)` Sets a value (pattern) into embedded JavaScript object at specific property.
`protected void`	`setValue(Key key, 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, ImageElement value)` Sets a value (image) 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, NativeObject value)` Sets a value (JavaScript Object) into embedded JavaScript object at specific property.
`protected void`	`setValue(Key key, NativeObjectContainer value)` Sets a value (JavaScript Object) into embedded JavaScript object at specific property by object container.
`protected void`	`setValue(Key key, 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.
`protected void`	`setValueOrArray(Key key, CanvasGradient... values)` Sets a value (Array or gradient) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a gradient.
`protected void`	`setValueOrArray(Key key, CanvasPattern... values)` Sets a value (Array or pattern) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a pattern.
`protected void`	`setValueOrArray(Key key, double... values)` Sets a value (Array or double) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a double.
`protected void`	`setValueOrArray(Key key, ImageElement... values)` Sets a value (Array or image) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a image.
`protected void`	`setValueOrArray(Key key, int... values)` Sets a value (Array or integer) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a integer.
`protected void`	`setValueOrArray(Key key, IsColor... values)` Sets a value (Array or string by colors) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a string.
`protected void`	`setValueOrArray(Key key, Key... values)` Sets a value (Array or string by keys) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a string.
`protected void`	`setValueOrArray(Key key, String... values)` Sets a value (Array or string) into embedded JavaScript object at specific property. This must be used when a java script property can contain an array or a string.
`String`	`toJSON()` Returns the string JSON representation of the object.
`protected ObjectType`	`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, toString, wait, wait, wait

- Constructor Detail
  - NativeObjectContainer
```
protected NativeObjectContainer()
```
    Creates the object with an empty native object instance.
  - NativeObjectContainer
```
protected NativeObjectContainer(NativeObject nativeObject)
```
    Creates the object with native object instance to be wrapped.
    
    Parameters:
    
    nativeObject - native object instance to be wrapped.
- Method Detail
  - getNativeObject
```
protected final NativeObject getNativeObject()
```
    Returns the native object instance.
    
    Returns:
    
    the native object instance.
  - toJSON
```
public final String toJSON()
```
    Returns the string JSON representation of the object.
    
    Returns:
    
    the string JSON representation of the object.
  - has
```
protected final 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
  - has
```
protected final 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.
  - keys
```
protected final List<Key> keys()
```
    Returns the list of properties names of the object.
    
    Returns:
    
    the list of properties names of the object.
  - type
```
protected final ObjectType 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 final 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.
  - remove
```
protected final void remove(Key key)
```
    Removes an element (by key) from the embedded JavaScript object.
    
    Parameters:
    
    key - key of the property of JavaScript object.
  - remove
```
protected final 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.
  - setValue
```
protected final 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
  - getValue
```
protected final 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
  - setValueOrArray
```
protected final void setValueOrArray(Key key,
                                     int... values)
```
    Sets a value (Array or integer) into embedded JavaScript object at specific property.
    This must be used when a java script property can contain an array or a integer.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    values - values of integers to be set
  - getValueOrArray
```
protected final ArrayInteger getValueOrArray(Key key,
                                             int defaultValue)
```
    Returns a value (array) into embedded JavaScript object at specific property.
    This must be used when a java script property can contain an array or a integer.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    defaultValue - default value if the value was stored as single number value
    
    Returns:
    
    value of the property (by array)
  - setValue
```
protected final 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
  - getValue
```
protected final 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
  - setValueOrArray
```
protected final void setValueOrArray(Key key,
                                     double... values)
```
    Sets a value (Array or double) into embedded JavaScript object at specific property.
    This must be used when a java script property can contain an array or a double.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    values - values of doubles to be set
  - getValueOrArray
```
protected final ArrayDouble getValueOrArray(Key key,
                                            double defaultValue)
```
    Returns a value (array) into embedded JavaScript object at specific property.
    This must be used when a java script property can contain an array or a double.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    defaultValue - default value if the value was stored as single number value
    
    Returns:
    
    value of the property (by array)
  - setValue
```
protected final 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
  - getValue
```
protected final 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
  - getValue
```
protected final String getValue(Key key,
                                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
  - setValue
```
protected final void setValue(Key key,
                              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
  - setValueOrArray
```
protected final void setValueOrArray(Key key,
                                     String... values)
```
    Sets a value (Array or string) into embedded JavaScript object at specific property.
    This must be used when a java script property can contain an array or a string.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    values - values of strings to be set
  - getValueOrArray
```
protected final ArrayString getValueOrArray(Key key,
                                            String defaultValue)
```
    Returns a value (array) into embedded JavaScript object at specific property.
    This must be used when a java script property can contain an array or a string.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    defaultValue - default value if the value was stored as single string value
    
    Returns:
    
    value of the property (by array)
  - getValue
```
protected final Date getValue(Key key,
                              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
  - setValue
```
protected final void setValue(Key key,
                              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
  - getValue
```
protected final NativeObject getValue(Key key)
```
    Returns a value (JavaScript Object) into embedded JavaScript object at specific property.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    Returns:
    
    value of the property or null if not there
  - setValue
```
protected final void setValue(Key key,
                              NativeObject 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
  - setValue
```
protected final void setValue(Key key,
                              NativeObjectContainer value)
```
    Sets a value (JavaScript Object) into embedded JavaScript object at specific property by object container.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    value - value to be set
  - setArrayValue
```
protected final void setArrayValue(Key key,
                                   ArrayObjectContainerList<?> container)
```
    Sets a value (Array from a container list) into embedded JavaScript object at specific property.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    container - container of array
  - setValue
```
protected final void setValue(Key key,
                              CallbackProxy.Proxy value)
```
    Sets a value (callback proxy function) into embedded JavaScript object at specific property.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    value - value to be set
  - getValue
```
protected final ImageElement getValue(Key key,
                                      ImageElement defaultValue)
```
    Returns a value (image) 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
  - setValue
```
protected final void setValue(Key key,
                              ImageElement value)
```
    Sets a value (image) into embedded JavaScript object at specific property.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    value - value to be set
  - setValueOrArray
```
protected final void setValueOrArray(Key key,
                                     ImageElement... values)
```
    Sets a value (Array or image) into embedded JavaScript object at specific property.
    This must be used when a java script property can contain an array or a image.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    values - images to be set
  - getValueOrArray
```
protected final ArrayImage getValueOrArray(Key key,
                                           ImageElement defaultValue)
```
    Returns a value (array) into embedded JavaScript object at specific property.
    This must be used when a java script property can contain an array or a image.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    defaultValue - default value if the value was stored as single image value
    
    Returns:
    
    value of the property (by array)
  - getValue
```
protected final CanvasGradient getValue(Key key,
                                        CanvasGradient defaultValue)
```
    Returns a value (gradient) 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
  - setValue
```
protected final void setValue(Key key,
                              CanvasGradient value)
```
    Sets a value (gradient) into embedded JavaScript object at specific property.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    value - value to be set
  - setValueOrArray
```
protected final void setValueOrArray(Key key,
                                     CanvasGradient... values)
```
    Sets a value (Array or gradient) into embedded JavaScript object at specific property.
    This must be used when a java script property can contain an array or a gradient.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    values - images to be set
  - getValueOrArray
```
protected final ArrayGradient getValueOrArray(Key key,
                                              CanvasGradient defaultValue)
```
    Returns a value (array) into embedded JavaScript object at specific property.
    This must be used when a java script property can contain an array or a gradient.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    defaultValue - default value if the value was stored as single gradient value
    
    Returns:
    
    value of the property (by array) or an empty array if not exist
  - getValue
```
protected final CanvasPattern getValue(Key key,
                                       CanvasPattern defaultValue)
```
    Returns a value (pattern) 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
  - setValue
```
protected final void setValue(Key key,
                              CanvasPattern value)
```
    Sets a value (pattern) into embedded JavaScript object at specific property.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    value - value to be set
  - setValueOrArray
```
protected final void setValueOrArray(Key key,
                                     CanvasPattern... values)
```
    Sets a value (Array or pattern) into embedded JavaScript object at specific property.
    This must be used when a java script property can contain an array or a pattern.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    values - images to be set
  - getValueOrArray
```
protected final ArrayPattern getValueOrArray(Key key,
                                             CanvasPattern defaultValue)
```
    Returns a value (array) into embedded JavaScript object at specific property.
    This must be used when a java script property can contain an array or a pattern.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    defaultValue - default value if the value was stored as single pattern value
    
    Returns:
    
    value of the property (by array)
  - getValue
```
protected final <T extends Key> T getValue(Key key,
                                           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
  - setValue
```
protected final <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
  - setValueOrArray
```
protected final void setValueOrArray(Key key,
                                     Key... values)
```
    Sets a value (Array or string by keys) into embedded JavaScript object at specific property.
    This must be used when a java script property can contain an array or a string.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    values - value of keys to be set
  - getValueOrArray
```
protected final ArrayString getValueOrArray(Key key,
                                            Key defaultValue)
```
    Returns a value (array) into embedded JavaScript object at specific property.
    This must be used when a java script property can contain an array or a key.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    defaultValue - default value if the value was stored as single key value
    
    Returns:
    
    value of the property (by array) or null if not exist
  - getArrayValue
```
protected final <T extends Array> T getArrayValue(Key key)
```
    Returns a value (array) into embedded JavaScript object at specific property.
    
    Type Parameters:
    
    T - type of array
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    Returns:
    
    value of the property or null if not exist
  - setArrayValue
```
protected final <T extends Array> void setArrayValue(Key key,
                                                     T value)
```
    Sets a value (Array) into embedded JavaScript object at specific property.
    
    Type Parameters:
    
    T - type of array
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    value - value to be set
  - setValueOrArray
```
protected final void setValueOrArray(Key key,
                                     IsColor... values)
```
    Sets a value (Array or string by colors) into embedded JavaScript object at specific property.
    This must be used when a java script property can contain an array or a string.
    
    Parameters:
    
    key - key of the property of JavaScript object.
    
    values - values of colors to be set

Class NativeObjectContainer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NativeObjectContainer

NativeObjectContainer

Method Detail

getNativeObject

toJSON

has

has

keys

type

removeIfExists

remove

remove

setValue

getValue

setValueOrArray

getValueOrArray

setValue

getValue

setValueOrArray

getValueOrArray

setValue

getValue

getValue

setValue

setValueOrArray

getValueOrArray

getValue

setValue

getValue

setValue

setValue

setArrayValue

setValue

getValue

setValue

setValueOrArray

getValueOrArray

getValue

setValue

setValueOrArray

getValueOrArray

getValue

setValue

setValueOrArray

getValueOrArray

getValue

setValue

setValueOrArray

getValueOrArray

getArrayValue

setArrayValue

setValueOrArray