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:

DataLabelsOptions, LabelsOptions

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, AbstractPluginOptionsFactory<?> factory, boolean deferredRegistration) Creates new plugin options with its factory, plugin ID and a flag to know if it must register the options to the cache or if it will be postponed. The deferred registration is needed to implement options builder in order do not register options not used.

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 List<String>	getReferences() Returns the list of references of this options. Called by factory in order to manage correctly the cache and removes this option when it doesn't have any reference.
protected void	register() Registers the options to the factory to manage the cache of options.

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

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,
                                AbstractPluginOptionsFactory<?> factory,
                                boolean deferredRegistration)

Creates new plugin options with its factory, plugin ID and a flag to know if it must register the options to the cache or if it will be postponed.
The deferred registration is needed to implement options builder in order do not register options not used.

Parameters:

pluginId - plugin ID

factory - plugin options factory

deferredRegistration - if true the options is not registered

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

getReferences

protected List<String> getReferences()

Returns the list of references of this options.
Called by factory in order to manage correctly the cache and removes this option when it doesn't have any reference.

Returns:

the list of references of this options

register

protected void register()

Registers the options to the factory to manage the cache of options.