Package org.pepstock.charba.client.plugins

Class AbstractPlugin

java.lang.Object

org.pepstock.charba.client.plugins.AbstractPlugin

All Implemented Interfaces:

Plugin

Direct Known Subclasses:

ChartBackgroundColor, ChartPointer, ColorSchemes, DatasetsItemsSelector, HtmlLegend

public abstract class AbstractPlugin
extends Object
implements Plugin

Implements a plugin interface to help who will create a plugin do not create all methods.
The only method not implemented is getId which must implemented.
All onBefore* cancelable methods return true.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPlugin(String pluginId)	Creates the plugin sing the id passed as argument.

Method Summary

Modifier and Type	Method	Description
String	getId()	Plugins must define a unique id in order to be configurable. Returns the plugin id.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepstock.charba.client.Plugin

onAfterBuildTicks, onAfterDataLimits, onAfterDatasetDraw, onAfterDatasetsDraw, onAfterDatasetsUpdate, onAfterDatasetUpdate, onAfterDraw, onAfterEvent, onAfterInit, onAfterLayout, onAfterRender, onAfterTooltipDraw, onAfterUpdate, onBeforeBuildTicks, onBeforeDataLimits, onBeforeDatasetDraw, onBeforeDatasetsDraw, onBeforeDatasetsUpdate, onBeforeDatasetUpdate, onBeforeDraw, onBeforeElementsUpdate, onBeforeEvent, onBeforeInit, onBeforeLayout, onBeforeRender, onBeforeTooltipDraw, onBeforeUpdate, onBeginDrawing, onConfigure, onDestroy, onEndDrawing, onInstall, onReset, onResize, onStart, onStop, onUninstall

Constructor Detail

AbstractPlugin

protected AbstractPlugin(String pluginId)

Creates the plugin sing the id passed as argument.

Parameters:

pluginId - plugin id to use

Method Detail

getId

public final String getId()

Description copied from interface: Plugin

Plugins must define a unique id in order to be configurable.
Returns the plugin id. A plugin id

• can not start with a dot or an underscore
• can not contain any non-URL-safe characters
• cannot contain upper-case letters
• should be something short, but also reasonably descriptive

Specified by:

getId in interface Plugin

Returns:

the plugin id.

toString

public final String toString()

Overrides:

toString in class Object