org.pepstock.charba.client.options

Class Plugins

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.AbstractModel<Options,Void>

org.pepstock.charba.client.options.Plugins

public final class Plugins
extends AbstractModel<Options,Void>

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
<T extends NativeObjectContainer> T	getOptions(String pluginId, NativeObjectContainerFactory<T> factory) Returns the plugin options, if exist.
<T extends NativeObjectContainer> List<T>	getOptionsAsList(String pluginId, NativeObjectContainerFactory<T> factory) Returns the plugin options as list of object containers, if exist.
ObjectType	getOptionsType(String pluginId) Returns the options type.
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.
void	setEnabled(String pluginId, boolean enabled) Sets if a global plugin must be enabled or not.
<T extends NativeObjectContainer> void	setOptions(String pluginId, List<T> options) Sets the plugin options as array.
<T extends NativeObjectContainer> void	setOptions(String pluginId, T options) Sets the plugin options.

Methods inherited from class org.pepstock.charba.client.options.AbstractModel

checkAndAddToParent, getChildKey, getDefaultValues, getParent, setCallbackToModel, setEventToModel

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

Method Detail

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.

isEnabled

public boolean isEnabled(String pluginId)

Returns if a global plugin is enabled or not.

Parameters:

pluginId - plugin id.

Returns:

false if a global plugin is not enabled otherwise true.

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.

setOptions

public <T extends NativeObjectContainer> 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 native object container to store

Parameters:

pluginId - plugin id.

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

setOptions

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

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

Type Parameters:

T - type of native object container to store

Parameters:

pluginId - plugin id.

options - list of native object container 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.

Parameters:

pluginId - plugin id.

Returns:

true if there is an options, otherwise false.

getOptionsType

public ObjectType getOptionsType(String pluginId)

Returns the options type.

Parameters:

pluginId - plugin id.

Returns:

the options type

getOptions

public <T extends NativeObjectContainer> T getOptions(String pluginId,
                                                      NativeObjectContainerFactory<T> factory)

Returns the plugin 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:

pluginId - plugin id.

factory - factory instance to create a native object container.

Returns:

java script object used to configure the plugin or an empty object if not exist.

getOptionsAsList

public <T extends NativeObjectContainer> List<T> getOptionsAsList(String pluginId,
                                                                  NativeObjectContainerFactory<T> factory)

Returns the plugin options as list of object containers, if exist. It uses a factory instance to create a native object container.

Type Parameters:

T - type of native object container to return

Parameters:

pluginId - plugin id.

factory - factory instance to create a native object container.

Returns:

the plugin options as list of object containers or empty list if not exist.