org.pepstock.charba.client.plugins

Class AbstractPluginOptions

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.plugins.AbstractPluginOptions

Direct Known Subclasses:

AbstractPluginCachedOptions, ChartPointerOptions, ColorSchemesOptions, DatasetsItemsSelectorOptions, HtmlLegendOptions

public abstract class AbstractPluginOptions
extends NativeObjectContainer

Abstract plugin options where to set all the configuration needed to the plugin.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPluginOptions(String pluginId) Creates new plugin options with plugin ID, creating new native options.
protected	AbstractPluginOptions(String pluginId, NativeObject nativeObject) Creates new plugin options with plugin ID, using a native object instance.

Method Summary

Modifier and Type	Method and Description
int	getId() Returns the unique ID of the options.
String	getPluginId() Returns the plugin id related to this options.
protected <T extends NativeObjectContainer> T	loadGlobalsPluginOptions(NativeObjectContainerFactory<T> factory) Loads the default plugin options from defaults.
void	store() Stores this options into default global plugins options.
void	store(IsChart chart) Stores this options into chart plugins options.

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer

checkValue, 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

AbstractPluginOptions

protected AbstractPluginOptions(String pluginId)

Creates new plugin options with plugin ID, creating new native options.

Parameters:

pluginId - plugin ID

AbstractPluginOptions

protected AbstractPluginOptions(String pluginId,
                                NativeObject nativeObject)

Creates new plugin options with plugin ID, using a native object instance.

Parameters:

pluginId - plugin ID

nativeObject - native object which represents the plugin options as native object

Method Detail

getId

public final int getId()

Returns the unique ID of the options.

Returns:

the unique ID of the options.

getPluginId

public final String getPluginId()

Returns the plugin id related to this options.

Returns:

the plugin id related to this options

loadGlobalsPluginOptions

protected final <T extends NativeObjectContainer> T loadGlobalsPluginOptions(NativeObjectContainerFactory<T> factory)

Loads the default plugin options from defaults. If factory, passed as argument, is null, returns null.

Type Parameters:

T - type of native object container

Parameters:

factory - factory to load options

Returns:

the defaults plugin options or new options instance if not exist. If factory is null, returns null.

store

public void store()

Stores this options into default global plugins options.

store

public final void store(IsChart chart)

Stores this options into chart plugins options.

Parameters:

chart - chart instance