org.pepstock.charba.client.plugins

Class GlobalPlugins

java.lang.Object

org.pepstock.charba.client.plugins.GlobalPlugins

public final class GlobalPlugins
extends java.lang.Object

Glabal configuration to set plugins at global level.
It maps the CHART.JS object of default, chart.plugins.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
GlobalPlugins()

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getIds() Gets all global registered plugins ids.
boolean	register(Plugin plugin) Registers a plugin as global, to apply to all charts.
boolean	unregister(java.lang.String pluginId) Unregisters a global plugin.

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalPlugins

public GlobalPlugins()

Method Detail

register

public boolean register(Plugin plugin)
                 throws InvalidPluginIdException

Registers a plugin as global, to apply to all charts.

Parameters:

plugin - plugin instance

Returns:

true if registered, otherwise false if the plugin is already registered with the plugin id of plugin instance.

Throws:

InvalidPluginIdException - if the plugin id is not correct.

unregister

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

Unregisters a global plugin. THis is possible ONLY for plugins added as custom ones.

Parameters:

pluginId - plugin instance

Returns:

true if unregistered, otherwise false if the plugin is not a custom one.

Throws:

InvalidPluginIdException - if the plugin id is not correct.

getIds

public java.util.Set<java.lang.String> getIds()

Gets all global registered plugins ids.

Returns:

all global registered plugins ids.