org.pepstock.charba.client.options

Class Plugins

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.options.Plugins

public final class Plugins
extends JavaScriptObjectContainer

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
com.google.gwt.core.client.JavaScriptObject	getOptions(java.lang.String pluginId) Returns the plugin options, if exist.
boolean	isEnabled(java.lang.String pluginId) Returns if a global plugin is enabled or not.
void	setEnabled(java.lang.String pluginId, boolean enabled) Sets if a global plugin must be enabled or not.
void	setOptions(java.lang.String pluginId, com.google.gwt.core.client.JavaScriptObject options) Sets the plugin options.

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

checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

Methods inherited from class java.lang.Object

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

Method Detail

setEnabled

public void setEnabled(java.lang.String pluginId,
                       boolean enabled)
                throws InvalidPluginIdException

Sets if a global plugin must be enabled or not.

Parameters:

pluginId - plugin id.

enabled - false disable a gloabl plugin.

Throws:

InvalidPluginIdException - occurs if the plugin id is invalid.

isEnabled

public boolean isEnabled(java.lang.String pluginId)
                  throws InvalidPluginIdException

Returns if a global plugin is enabled or not.

Parameters:

pluginId - plugin id.

Returns:

false if a gloabl plugin is not enabled otherwise true.

Throws:

InvalidPluginIdException - occurs if the plugin id is invalid.

setOptions

public void setOptions(java.lang.String pluginId,
                       com.google.gwt.core.client.JavaScriptObject options)
                throws InvalidPluginIdException

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

Parameters:

pluginId - plugin id.

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

Throws:

InvalidPluginIdException - occurs if the plugin id is invalid.

getOptions

public com.google.gwt.core.client.JavaScriptObject getOptions(java.lang.String pluginId)
                                                       throws InvalidPluginIdException

Returns the plugin options, if exist.

Parameters:

pluginId - plugin id.

Returns:

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

Throws:

InvalidPluginIdException - occurs if the plugin id is invalid.