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

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* cancellable methods return true.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Constructor and Description
AbstractPlugin()

Method Summary

Modifier and Type	Method and Description
void	onAfterDatasetDraw(IsChart chart, DatasetPluginItem item) Called after the 'chart' datasets at the given 'args.index' have been drawn (datasets are drawn in the reverse order).
void	onAfterDatasetsDraw(IsChart chart, double easing) Called after the 'chart' datasets have been drawn.
void	onAfterDatasetsUpdate(IsChart chart) Called after the 'chart' datasets have been updated.
void	onAfterDatasetUpdate(IsChart chart, DatasetPluginItem item) Called after the 'chart' datasets at the given 'args.index' has been updated.
void	onAfterDraw(IsChart chart, double easing) Called after the 'chart' has been drawn for the specific easing value.
void	onAfterEvent(IsChart chart, ChartNativeEvent event) Called after the 'event' has been consumed.
void	onAfterInit(IsChart chart) Called after 'chart' has been initialized and before the first update.
void	onAfterLayout(IsChart chart) Called after the 'chart' has been layed out.
void	onAfterRender(IsChart chart) Called after the 'chart' has been fully rendered (and animation completed).
void	onAfterTooltipDraw(IsChart chart, TooltipPluginItem item) Called after drawing the 'tooltip'.
void	onAfterUpdate(IsChart chart) Called after 'chart' has been updated and before rendering.
boolean	onBeforeDatasetDraw(IsChart chart, DatasetPluginItem item) Called before drawing the 'chart' dataset at the given 'args.index' (datasets are drawn in the reverse order).
boolean	onBeforeDatasetsDraw(IsChart chart, double easing) Called before drawing the 'chart' datasets.
boolean	onBeforeDatasetsUpdate(IsChart chart) Called before updating the 'chart' datasets.
boolean	onBeforeDatasetUpdate(IsChart chart, DatasetPluginItem item) Called before updating the 'chart' dataset at the given 'args.index'.
boolean	onBeforeDraw(IsChart chart, double easing) Called before drawing 'chart' at every animation frame specified by the given easing value.
boolean	onBeforeEvent(IsChart chart, ChartNativeEvent event) Called before processing the specified 'event'.
void	onBeforeInit(IsChart chart) Called before initializing 'chart'.
boolean	onBeforeLayout(IsChart chart) Called before laying out 'chart'.
boolean	onBeforeRender(IsChart chart) Called before rendering 'chart'.
boolean	onBeforeTooltipDraw(IsChart chart, TooltipPluginItem item) Called before drawing the 'tooltip'.
boolean	onBeforeUpdate(IsChart chart) Called before updating 'chart'.
void	onConfigure(IsChart chart) Called before initializing configuration of 'chart'.
void	onDestroy(IsChart chart) Called after the chart as been destroyed.
void	onResize(IsChart chart, SizeItem size) Called after the chart as been resized.
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

getId

Constructor Detail

AbstractPlugin

public AbstractPlugin()

Method Detail

onConfigure

public void onConfigure(IsChart chart)

Description copied from interface: Plugin

Called before initializing configuration of 'chart'.

Specified by:

onConfigure in interface Plugin

Parameters:

chart - the chart instance.

onBeforeInit

public void onBeforeInit(IsChart chart)

Description copied from interface: Plugin

Called before initializing 'chart'.

Specified by:

onBeforeInit in interface Plugin

Parameters:

chart - the chart instance.

onAfterInit

public void onAfterInit(IsChart chart)

Description copied from interface: Plugin

Called after 'chart' has been initialized and before the first update.

Specified by:

onAfterInit in interface Plugin

Parameters:

chart - the chart instance.

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

Parameters:

chart - the chart instance.

Returns:

false to cancel the chart update.

onAfterUpdate

public void onAfterUpdate(IsChart chart)

Description copied from interface: Plugin

Called after 'chart' has been updated and before rendering. Note that this hook will not be called if the chart update has been previously cancelled.

Specified by:

onAfterUpdate in interface Plugin

Parameters:

chart - the chart instance.

onBeforeLayout

public boolean onBeforeLayout(IsChart chart)

Description copied from interface: Plugin

Called before laying out 'chart'. If any plugin returns false, the layout update is cancelled until another 'update' is triggered.

Specified by:

onBeforeLayout in interface Plugin

Parameters:

chart - the chart instance.

Returns:

false to cancel the chart layout.

onAfterLayout

public void onAfterLayout(IsChart chart)

Description copied from interface: Plugin

Called after the 'chart' has been layed out. Note that this hook will not be called if the layout update has been previously cancelled.

Specified by:

onAfterLayout in interface Plugin

Parameters:

chart - the chart instance.

onBeforeDatasetsUpdate

public boolean onBeforeDatasetsUpdate(IsChart chart)

Description copied from interface: Plugin

Called before updating the 'chart' datasets. If any plugin returns false, the datasets update is cancelled until another 'update' is triggered.

Specified by:

onBeforeDatasetsUpdate in interface Plugin

Parameters:

chart - the chart instance.

Returns:

false to cancel the datasets update.

onAfterDatasetsUpdate

public void onAfterDatasetsUpdate(IsChart chart)

Description copied from interface: Plugin

Called after the 'chart' datasets have been updated. Note that this hook will not be called if the datasets update has been previously cancelled.

Specified by:

onAfterDatasetsUpdate in interface Plugin

Parameters:

chart - the chart instance.

onBeforeDatasetUpdate

public boolean onBeforeDatasetUpdate(IsChart chart,
                                     DatasetPluginItem item)

Description copied from interface: Plugin

Called before updating the 'chart' dataset at the given 'args.index'. If any plugin returns false, the datasets update is cancelled until another 'update' is triggered.

Specified by:

onBeforeDatasetUpdate in interface Plugin

Parameters:

chart - the chart instance.

item - the dataset item.

Returns:

false to cancel the chart datasets drawing.

onAfterDatasetUpdate

public void onAfterDatasetUpdate(IsChart chart,
                                 DatasetPluginItem item)

Description copied from interface: Plugin

Called after the 'chart' datasets at the given 'args.index' has been updated. Note that this hook will not be called if the datasets update has been previously cancelled.

Specified by:

onAfterDatasetUpdate in interface Plugin

Parameters:

chart - the chart instance.

item - the dataset item.

onBeforeRender

public boolean onBeforeRender(IsChart chart)

Description copied from interface: Plugin

Called before rendering 'chart'. If any plugin returns false, the rendering is cancelled until another 'render' is triggered.

Specified by:

onBeforeRender in interface Plugin

Parameters:

chart - the chart instance.

Returns:

false to cancel the chart rendering.

onAfterRender

public void onAfterRender(IsChart chart)

Description copied from interface: Plugin

Called after the 'chart' has been fully rendered (and animation completed). Note that this hook will not be called if the rendering has been previously cancelled.

Specified by:

onAfterRender in interface Plugin

Parameters:

chart - the chart instance.

onBeforeDraw

public boolean onBeforeDraw(IsChart chart,
                            double easing)

Description copied from interface: Plugin

Called before drawing 'chart' at every animation frame specified by the given easing value. If any plugin returns false, the frame drawing is cancelled until another 'render' is triggered.

Specified by:

onBeforeDraw in interface Plugin

Parameters:

chart - the chart instance.

easing - The current animation value, between 0.0 and 1.0.

Returns:

false to cancel the chart drawing.

onAfterDraw

public void onAfterDraw(IsChart chart,
                        double easing)

Description copied from interface: Plugin

Called after the 'chart' has been drawn for the specific easing value. Note that this hook will not be called if the drawing has been previously cancelled.

Specified by:

onAfterDraw in interface Plugin

Parameters:

chart - the chart instance.

easing - The current animation value, between 0.0 and 1.0.

onBeforeDatasetsDraw

public boolean onBeforeDatasetsDraw(IsChart chart,
                                    double easing)

Description copied from interface: Plugin

Called before drawing the 'chart' datasets. If any plugin returns false, the datasets drawing is cancelled until another 'render' is triggered.

Specified by:

onBeforeDatasetsDraw in interface Plugin

Parameters:

chart - the chart instance.

easing - The current animation value, between 0.0 and 1.0.

Returns:

false to cancel the chart datasets drawing.

onAfterDatasetsDraw

public void onAfterDatasetsDraw(IsChart chart,
                                double easing)

Description copied from interface: Plugin

Called after the 'chart' datasets have been drawn. Note that this hook will not be called if the datasets drawing has been previously cancelled.

Specified by:

onAfterDatasetsDraw in interface Plugin

Parameters:

chart - the chart instance.

easing - The current animation value, between 0.0 and 1.0.

onBeforeDatasetDraw

public boolean onBeforeDatasetDraw(IsChart chart,
                                   DatasetPluginItem item)

Description copied from interface: Plugin

Called before drawing the 'chart' dataset at the given 'args.index' (datasets are drawn in the reverse order). If any plugin returns false, the datasets drawing is cancelled until another 'render' is triggered.

Specified by:

onBeforeDatasetDraw in interface Plugin

Parameters:

chart - the chart instance.

item - the dataset item.

Returns:

false to cancel the chart datasets drawing.

onAfterDatasetDraw

public void onAfterDatasetDraw(IsChart chart,
                               DatasetPluginItem item)

Description copied from interface: Plugin

Called after the 'chart' datasets at the given 'args.index' have been drawn (datasets are drawn in the reverse order). Note that this hook will not be called if the datasets drawing has been previously cancelled.

Specified by:

onAfterDatasetDraw in interface Plugin

Parameters:

chart - the chart instance.

item - the dataset item.

onBeforeTooltipDraw

public boolean onBeforeTooltipDraw(IsChart chart,
                                   TooltipPluginItem item)

Description copied from interface: Plugin

Called before drawing the 'tooltip'. If any plugin returns false, the tooltip drawing is cancelled until another 'render' is triggered.

Specified by:

onBeforeTooltipDraw in interface Plugin

Parameters:

chart - the chart instance.

item - The tooltip instance.

Returns:

false to cancel the chart tooltip drawing.

onAfterTooltipDraw

public void onAfterTooltipDraw(IsChart chart,
                               TooltipPluginItem item)

Description copied from interface: Plugin

Called after drawing the 'tooltip'. Note that this hook will not be called if the tooltip drawing has been previously cancelled.

Specified by:

onAfterTooltipDraw in interface Plugin

Parameters:

chart - the chart instance.

item - The tooltip instance.

onBeforeEvent

public boolean onBeforeEvent(IsChart chart,
                             ChartNativeEvent event)

Description copied from interface: Plugin

Called before processing the specified 'event'. If any plugin returns false, the event will be discarded.

Specified by:

onBeforeEvent in interface Plugin

Parameters:

chart - the chart instance.

event - The event object.

Returns:

false to discard the event.

onAfterEvent

public void onAfterEvent(IsChart chart,
                         ChartNativeEvent 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

Parameters:

chart - the chart instance.

event - The event object.

onResize

public void onResize(IsChart chart,
                     SizeItem size)

Description copied from interface: Plugin

Called after the chart as been resized.

Specified by:

onResize in interface Plugin

Parameters:

chart - the chart instance.

size - The new canvas display size (eq. canvas.style width and height).

onDestroy

public void onDestroy(IsChart chart)

Description copied from interface: Plugin

Called after the chart as been destroyed.

Specified by:

onDestroy in interface Plugin

Parameters:

chart - the chart instance.

toString

public final String toString()

Overrides:

toString in class Object