org.pepstock.charba.client.impl.plugins

Class ChartPointer

java.lang.Object

org.pepstock.charba.client.plugins.AbstractPlugin

org.pepstock.charba.client.impl.plugins.ChartPointer

All Implemented Interfaces:

Plugin

public final class ChartPointer
extends AbstractPlugin

This plugin is changing the cursor when mouse over on dataset, title on canvas if a dataset selection, title handler have been defined.

Author:

Andrea "Stock" Stocchero

See Also:

CursorType

Field Summary

Fields

Modifier and Type	Field and Description
static ChartPointerOptionsFactory	FACTORY The factory to create options for plugin.
static String	ID Plugin ID "charbacursorpointer".

Method Summary

Modifier and Type	Method and Description
static ChartPointer	get() Returns the singleton instance of plugin.
void	onAfterEvent(IsChart chart, PluginEventArgument argument) Called after the 'event' has been consumed. Note that this hook will not be called if the 'event' has been previously discarded.
boolean	onBeforeUpdate(IsChart chart, PluginUpdateArgument argument) Called before updating 'chart'. If any plugin returns false, the update is cancelled (and thus subsequent render(s)) until another 'update' is triggered.
void	onDestroy(IsChart chart) Called after the chart as been destroyed.

Methods inherited from class org.pepstock.charba.client.plugins.AbstractPlugin

getId, 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, onAfterInit, onAfterLayout, onAfterRender, onAfterTooltipDraw, onAfterUpdate, onBeforeBuildTicks, onBeforeDataLimits, onBeforeDatasetDraw, onBeforeDatasetsDraw, onBeforeDatasetsUpdate, onBeforeDatasetUpdate, onBeforeDraw, onBeforeElementsUpdate, onBeforeEvent, onBeforeInit, onBeforeLayout, onBeforeRender, onBeforeTooltipDraw, onBeginDrawing, onConfigure, onEndDrawing, onInstall, onReset, onResize, onStart, onStop, onUninstall

Field Detail

ID

public static final String ID

Plugin ID "charbacursorpointer".

See Also:

Constant Field Values

FACTORY

public static final ChartPointerOptionsFactory FACTORY

The factory to create options for plugin.

Method Detail

get

public static ChartPointer get()

Returns the singleton instance of plugin.

Returns:

the singleton instance of plugin

onBeforeUpdate

public boolean onBeforeUpdate(IsChart chart,
                              PluginUpdateArgument argument)

Description copied from interface: Plugin

Called before updating 'chart'.
If any plugin returns false, the update is cancelled (and thus subsequent render(s)) until another 'update' is triggered.

Parameters:

chart - the chart instance.

argument - the argument passed for update

Returns:

false to cancel the chart update.

onAfterEvent

public void onAfterEvent(IsChart chart,
                         PluginEventArgument argument)

Description copied from interface: Plugin

Called after the 'event' has been consumed.
Note that this hook will not be called if the 'event' has been previously discarded.

Parameters:

chart - the chart instance.

argument - instance which contains event context

onDestroy

public void onDestroy(IsChart chart)

Description copied from interface: Plugin

Called after the chart as been destroyed.

Parameters:

chart - the chart instance.