org.pepstock.charba.client.plugins

Class AbstractPluginCachedOptionsFactory<T extends AbstractPluginCachedOptions>

java.lang.Object

org.pepstock.charba.client.AbstractChartsLifecycleListener

org.pepstock.charba.client.plugins.AbstractPluginCachedOptionsFactory<T>

All Implemented Interfaces:

ChartsLifecycleListener, NativeObjectContainerFactory<T>

Direct Known Subclasses:

DataLabelsOptionsFactory, LabelsOptionsFactory

public abstract class AbstractPluginCachedOptionsFactory<T extends AbstractPluginCachedOptions>
extends AbstractChartsLifecycleListener
implements NativeObjectContainerFactory<T>

Factory to get the plugin options (form chart, from datasets or from default global ones) related to the plugin.

Author:

Andrea "Stock" Stocchero

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractPluginCachedOptionsFactory(String pluginId) Adds itself as charts life cycle listener to manage the cache of plugin options, in order to clean the instances when the charts will be destroy.

Method Summary

Modifier and Type	Method and Description
protected AbstractPluginCachedOptions	getOptions(NativeObject nativeObject) Returns the cached plugin options instance if there is, otherwise returns null.
String	getPluginId() Returns the plugin id related to this options.
void	onAfterInit(IsChart chart) Called after 'chart' has been initialized and before the first update.
void	onBeforeDestroy(IsChart chart) Called before the chart has been destroyed.

Methods inherited from class org.pepstock.charba.client.AbstractChartsLifecycleListener

onAfterDestroy, onBeforeInit

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepstock.charba.client.commons.NativeObjectContainerFactory

create, create

Constructor Detail

AbstractPluginCachedOptionsFactory

protected AbstractPluginCachedOptionsFactory(String pluginId)

Adds itself as charts life cycle listener to manage the cache of plugin options, in order to clean the instances when the charts will be destroy.

Parameters:

pluginId - plugin id

Method Detail

getPluginId

public final String getPluginId()

Returns the plugin id related to this options.

Returns:

the plugin id related to this options

onAfterInit

public final void onAfterInit(IsChart chart)

Description copied from interface: ChartsLifecycleListener

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

Specified by:

onAfterInit in interface ChartsLifecycleListener

Overrides:

onAfterInit in class AbstractChartsLifecycleListener

Parameters:

chart - the chart instance.

onBeforeDestroy

public final void onBeforeDestroy(IsChart chart)

Description copied from interface: ChartsLifecycleListener

Called before the chart has been destroyed.

Specified by:

onBeforeDestroy in interface ChartsLifecycleListener

Overrides:

onBeforeDestroy in class AbstractChartsLifecycleListener

Parameters:

chart - the chart instance.

getOptions

protected final AbstractPluginCachedOptions getOptions(NativeObject nativeObject)

Returns the cached plugin options instance if there is, otherwise returns null.

Parameters:

nativeObject - native object instance to be read

Returns:

the cached plugin options instance if there is, otherwise returns null.