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.
String	getId() Plugins must define a unique id in order to be configurable. Returns the plugin id.
void	onAfterEvent(IsChart chart, BaseNativeEvent event) Called after the 'event' has been consumed.
boolean	onBeforeUpdate(IsChart chart) Called before updating 'chart'.
void	onDestroy(IsChart chart) Called after the chart as been destroyed.

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

onAfterDatasetDraw, onAfterDatasetsDraw, onAfterDatasetsUpdate, onAfterDatasetUpdate, onAfterDraw, onAfterInit, onAfterLayout, onAfterRender, onAfterTooltipDraw, onAfterUpdate, onBeforeDatasetDraw, onBeforeDatasetsDraw, onBeforeDatasetsUpdate, onBeforeDatasetUpdate, onBeforeDraw, onBeforeEvent, onBeforeInit, onBeforeLayout, onBeforeRender, onBeforeTooltipDraw, onConfigure, onResize, toString

Methods inherited from class java.lang.Object

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

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

getId

public 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

Returns:

the plugin id.

onBeforeUpdate

public boolean onBeforeUpdate(IsChart chart)

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.

Specified by:

onBeforeUpdate in interface Plugin

Overrides:

onBeforeUpdate in class AbstractPlugin

Parameters:

chart - the chart instance.

Returns:

false to cancel the chart update.

onAfterEvent

public void onAfterEvent(IsChart chart,
                         BaseNativeEvent event)

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.

Specified by:

onAfterEvent in interface Plugin

Overrides:

onAfterEvent in class AbstractPlugin

Parameters:

chart - the chart instance.

event - The event object.

onDestroy

public void onDestroy(IsChart chart)

Description copied from interface: Plugin

Called after the chart as been destroyed.

Specified by:

onDestroy in interface Plugin

Overrides:

onDestroy in class AbstractPlugin

Parameters:

chart - the chart instance.