org.pepstock.charba.client.options

Class Plugins

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.Plugins

All Implemented Interfaces:

IsDefaultPlugins

public final class Plugins
extends NativeObjectContainer
implements IsDefaultPlugins

Definitions about plugins options. This is used to configure plugins (mainly the global ones).
Every plugin could have own configuration structure.
The java script object key is the plugin id.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
protected void	checkAndAddToParent() Called recursively when a property has been set in the item. This is mandatory because it could happen that the parent item is not present, therefore it must be added.
List<Key>	getAllIds() Returns the unmodifiable list of registered plugin ids.
protected Key	getChildKey() Returns the property name to use to add this element to its parent.
protected D	getDefaultValues() Returns the default provider instance.
<T extends AbstractPluginOptions> T	getOptions(AbstractPluginOptionsFactory<T> factory) Returns the plugin options, if exist. It uses a factory instance to create a plugin options. If factory argument is not consistent, null is returned.
<T extends AbstractPluginOptions> T	getOptions(String pluginId, AbstractPluginOptionsFactory<T> factory) Returns the plugin options, if exist. It uses a factory instance to create a plugin options. If factory argument is not consistent, null is returned.
<T extends AbstractPluginOptions> List<T>	getOptionsAsList(AbstractPluginOptionsFactory<T> factory) Returns the plugin options as list, if exist. It uses a factory instance to create a plugin options.
<T extends AbstractPluginOptions> List<T>	getOptionsAsList(String pluginId, AbstractPluginOptionsFactory<T> factory) Returns the plugin options as list, if exist. It uses a factory instance to create a plugin options.
ObjectType	getOptionsType(String pluginId) Returns the options type.
protected P	getParent() Returns the parent element.
boolean	hasEnabled(String pluginId) Returns if a global plugin has been set or not.
boolean	hasOptions(String pluginId) Checks if there is any options for a specific plugin, by its id.
boolean	isEnabled(String pluginId) Returns if a global plugin is enabled or not.
boolean	isForcedlyDisabled(DefaultPlugin plugin) Returns if a default CHART.JS plugin is enabled or not, forced directly by global plugin manager
boolean	isForcedlyDisabled(String pluginId) Returns if a global plugin is enabled or not, forced directly by global plugin manager
void	removeOptions(String pluginId) Removes the plugin options.
protected void	setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy) Adds a proxy function (for callbacks) to a model at the specific key.
void	setEnabled(DefaultPlugin plugin, boolean enabled) Sets if a default CHART.JS plugin must be enabled or not.
void	setEnabled(String pluginId, boolean enabled) Sets if a global plugin must be enabled or not.
protected void	setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model, Key key, CallbackProxy.Proxy proxy) Adds a proxy function (for events) to a model at the specific key.
<T extends AbstractPluginOptions> void	setOptions(List<T> options) Sets the plugin options as list. If the list is empty, it does nothing
<T extends AbstractPluginOptions> void	setOptions(String pluginId, List<T> options) Sets the plugin options as list. If passed options is null, the configuration of plugin will be removed.
<T extends AbstractPluginOptions> void	setOptions(String pluginId, T options) Sets the plugin options. If passed options is null, the configuration of plugin will be removed.
<T extends AbstractPluginOptions> void	setOptions(T options) Sets the plugin options.

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

checkValue, empty, getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, getValueForMultipleKeyTypes, 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

Method Detail

getAllIds

public List<Key> getAllIds()

Returns the unmodifiable list of registered plugin ids.

Returns:

the unmodifiable list of registered plugin ids

setEnabled

public void setEnabled(String pluginId,
                       boolean enabled)

Sets if a global plugin must be enabled or not.

Parameters:

pluginId - plugin id.

enabled - false disable a global plugin.

setEnabled

public void setEnabled(DefaultPlugin plugin,
                       boolean enabled)

Sets if a default CHART.JS plugin must be enabled or not.

Parameters:

plugin - default CHART.JS plugin instance.

enabled - false disable a default CHART.JS plugin.

isEnabled

public boolean isEnabled(String pluginId)

Returns if a global plugin is enabled or not.

Specified by:

isEnabled in interface IsDefaultPlugins

Parameters:

pluginId - plugin id.

Returns:

false if a global plugin is not enabled otherwise true.

isForcedlyDisabled

public boolean isForcedlyDisabled(String pluginId)

Returns if a global plugin is enabled or not, forced directly by global plugin manager

Parameters:

pluginId - plugin id.

Returns:

true if a global plugin is not enabled otherwise false.

isForcedlyDisabled

public boolean isForcedlyDisabled(DefaultPlugin plugin)

Returns if a default CHART.JS plugin is enabled or not, forced directly by global plugin manager

Parameters:

plugin - a default CHART.JS plugin.

Returns:

true if a default CHART.JS plugin is not enabled otherwise false.

hasEnabled

public boolean hasEnabled(String pluginId)

Returns if a global plugin has been set or not.

Parameters:

pluginId - plugin id.

Returns:

false if a global plugin has not been set otherwise true.

removeOptions

public void removeOptions(String pluginId)

Removes the plugin options.

Parameters:

pluginId - plugin id.

setOptions

public <T extends AbstractPluginOptions> void setOptions(T options)

Sets the plugin options.

Type Parameters:

T - type of plugin options to store

Parameters:

options - plugin options used to configure the plugin

setOptions

public <T extends AbstractPluginOptions> void setOptions(List<T> options)

Sets the plugin options as list.
If the list is empty, it does nothing

Type Parameters:

T - type of plugin options to store

Parameters:

options - list of plugin options used to configure the plugin.

setOptions

public <T extends AbstractPluginOptions> void setOptions(String pluginId,
                                                         T options)

Sets the plugin options.
If passed options is null, the configuration of plugin will be removed.

Type Parameters:

T - type of plugin options to store

Parameters:

pluginId - plugin id.

options - plugin options used to configure the plugin.
Pass null to remove the configuration if exist.

setOptions

public <T extends AbstractPluginOptions> void setOptions(String pluginId,
                                                         List<T> options)

Sets the plugin options as list.
If passed options is null, the configuration of plugin will be removed.

Type Parameters:

T - type of plugin options to store

Parameters:

pluginId - plugin id.

options - list of plugin options used to configure the plugin.
Pass null to remove the configuration if exist.

hasOptions

public boolean hasOptions(String pluginId)

Checks if there is any options for a specific plugin, by its id.

Specified by:

hasOptions in interface IsDefaultPlugins

Parameters:

pluginId - plugin id.

Returns:

true if there is an options, otherwise false.

getOptionsType

public ObjectType getOptionsType(String pluginId)

Returns the options type.

Specified by:

getOptionsType in interface IsDefaultPlugins

Parameters:

pluginId - plugin id.

Returns:

the options type

getOptions

public <T extends AbstractPluginOptions> T getOptions(AbstractPluginOptionsFactory<T> factory)

Returns the plugin options, if exist.
It uses a factory instance to create a plugin options.
If factory argument is not consistent, null is returned.

Type Parameters:

T - type of plugin options to return

Parameters:

factory - factory instance to create a plugin options

Returns:

plugin options used to configure the plugin or an empty object if not exist.
If factory argument is not consistent, null is returned.

getOptions

public <T extends AbstractPluginOptions> T getOptions(String pluginId,
                                                      AbstractPluginOptionsFactory<T> factory)

Returns the plugin options, if exist.
It uses a factory instance to create a plugin options.
If factory argument is not consistent, null is returned.

Specified by:

getOptions in interface IsDefaultPlugins

Type Parameters:

T - type of plugin options to return

Parameters:

pluginId - plugin id.

factory - factory instance to create a plugin options

Returns:

plugin options used to configure the plugin or an empty object if not exist.
If factory argument is not consistent, null is returned.

getOptionsAsList

public <T extends AbstractPluginOptions> List<T> getOptionsAsList(AbstractPluginOptionsFactory<T> factory)

Returns the plugin options as list, if exist.
It uses a factory instance to create a plugin options.

Type Parameters:

T - type of plugin options to return

Parameters:

factory - factory instance to create a plugin options.

Returns:

the plugin options as list or empty list if not exist.

getOptionsAsList

public <T extends AbstractPluginOptions> List<T> getOptionsAsList(String pluginId,
                                                                  AbstractPluginOptionsFactory<T> factory)

Returns the plugin options as list, if exist.
It uses a factory instance to create a plugin options.

Specified by:

getOptionsAsList in interface IsDefaultPlugins

Type Parameters:

T - type of plugin options to return

Parameters:

pluginId - plugin id.

factory - factory instance to create a plugin options.

Returns:

the plugin options as list or empty list if not exist.

getChildKey

protected final Key getChildKey()

Returns the property name to use to add this element to its parent.

Returns:

the childKey or null if is a root element.

getParent

protected final P getParent()

Returns the parent element.

Returns:

the parent or null if is a root element.

getDefaultValues

protected final D getDefaultValues()

Returns the default provider instance.

Returns:

the default provider instance.

setEventToModel

protected final void setEventToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                     Key key,
                                     CallbackProxy.Proxy proxy)

Adds a proxy function (for events) to a model at the specific key.

Parameters:

model - element where adding the function proxy

key - property name to use to add the function proxy

proxy - the function proxy instance to add

setCallbackToModel

protected final void setCallbackToModel(org.pepstock.charba.client.options.AbstractModel<?,?> model,
                                        Key key,
                                        CallbackProxy.Proxy proxy)

Adds a proxy function (for callbacks) to a model at the specific key.

Parameters:

model - element where adding the function proxy

key - property name to use to add the function proxy

proxy - the function proxy instance to add

checkAndAddToParent

protected final void checkAndAddToParent()

Called recursively when a property has been set in the item.
This is mandatory because it could happen that the parent item is not present, therefore it must be added.