org.pepstock.charba.client.plugins

Class Plugins

java.lang.Object

org.pepstock.charba.client.plugins.Plugins

public final class Plugins
extends java.lang.Object

Is the manager of plugins which can manage the list of plugins and returns them as java script object to store into chart configuration.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
Plugins(AbstractChart<?,?> chart) Builds the object storing the chart instance.

Method Summary

Modifier and Type	Method and Description
void	add(Plugin plugin) Adds a new plugin to the chart. If the chart is already initialized, to get this update teh chart must be drawn again.
JsObjectArrayList<GenericJavaScriptObject>	getArrayList() Creates a java script array (mapped into a list) with all plugins added to the chart.
void	remove(java.lang.String id) Removes a plugin from the chart. If the chart is already initialized, to get this update teh chart must be drawn again.

Methods inherited from class java.lang.Object

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

Constructor Detail

Plugins

public Plugins(AbstractChart<?,?> chart)

Builds the object storing the chart instance.

Parameters:

chart - chart instance

Method Detail

add

public void add(Plugin plugin)
         throws InvalidPluginIdException

Adds a new plugin to the chart.
If the chart is already initialized, to get this update teh chart must be drawn again.

Parameters:

plugin - plugin instance

Throws:

InvalidPluginIdException - if the plugin id is not correct.

remove

public void remove(java.lang.String id)

Removes a plugin from the chart.
If the chart is already initialized, to get this update teh chart must be drawn again.

Parameters:

id - plugin id to remove.

getArrayList

public JsObjectArrayList<GenericJavaScriptObject> getArrayList()

Creates a java script array (mapped into a list) with all plugins added to the chart.

Returns:

a java script array (mapped into a list) with all plugins added to the chart.