org.pepstock.charba.client.commons

Class NativeExtendedObject

java.lang.Object

org.pepstock.charba.client.commons.NativeExtendedObject

Direct Known Subclasses:

ScriptableContext

@JsType(isNative=true,
        name="Object",
        namespace="<global>")
public abstract class NativeExtendedObject
extends Object

Base native object which can be extended by native object where additional properties could be needed, added as java script object into a property called 'options'.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NativeExtendedObject() To avoid any instantiation

Method Summary

Modifier and Type	Method and Description
protected NativeObject	getNativeOptions() Returns the options property by native object.
<T extends NativeObjectContainer> T	getOptions(NativeObjectContainerFactory<T> factory) Returns the options, if exist.
boolean	hasOptions() Checks if there is any options.
protected void	setNativeOptions(NativeObject options) Sets the options property into native object.
<T extends NativeObjectContainer> void	setOptions(T options) Sets the additional options.

Methods inherited from class java.lang.Object

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

Constructor Detail

NativeExtendedObject

protected NativeExtendedObject()

To avoid any instantiation

Method Detail

getNativeOptions

@JsProperty(name="options")
protected NativeObject getNativeOptions()

Returns the options property by native object.

Returns:

the options property by native object.

setNativeOptions

@JsProperty(name="options")
protected void setNativeOptions(NativeObject options)

Sets the options property into native object.

Parameters:

options - the options property into native object.

setOptions

@JsOverlay
public final <T extends NativeObjectContainer> void setOptions(T options)

Sets the additional options.

Type Parameters:

T - type of native object container to store

Parameters:

options - additional options instance.

hasOptions

@JsOverlay
public final boolean hasOptions()

Checks if there is any options.

Returns:

true if there is an options, otherwise false.

getOptions

@JsOverlay
public final <T extends NativeObjectContainer> T getOptions(NativeObjectContainerFactory<T> factory)

Returns the options, if exist. It uses a factory instance to create a native object container.

Type Parameters:

T - type of native object container to return

Parameters:

factory - factory instance to create a native object container.

Returns:

java script object used to map the options or an empty object if not exist.