org.pepstock.charba.client.configuration

Class EventProvider<T extends NativeObjectContainer>

java.lang.Object

org.pepstock.charba.client.configuration.EventProvider<T>

Type Parameters:

T - options element to store chart configuration

All Implemented Interfaces:

EventHandler, AddHandlerEventHandler, RemoveHandlerEventHandler

Direct Known Subclasses:

Animation, ConfigurationOptions, Legend

public abstract class EventProvider<T extends NativeObjectContainer>
extends Object
implements AddHandlerEventHandler, RemoveHandlerEventHandler

Is a JavaScript object container, which contains the chart instance and options element to store chart configuration, which will manage chart events to events handlers.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
protected abstract <H extends EventHandler> void	addHandler(GwtEvent.Type<H> type) Notifies the event provider when a new handler has been added.
AbstractChart<?,?>	getChart() Returns the chart instance
protected T	getConfiguration() Returns the configuration element.
void	onAdd(AddHandlerEvent event) Invoked when a new event handler is added.
void	onRemove(RemoveHandlerEvent event) Invoked when a chart event handler is removed.
protected abstract <H extends EventHandler> void	removeHandler(GwtEvent.Type<H> type) Notifies the event provider when a new handler has been unregistered
protected void	setConfiguration(T configuration)
String	toJSON() Returns the JSON representation of the object.

Methods inherited from class java.lang.Object

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

Method Detail

onRemove

public void onRemove(RemoveHandlerEvent event)

Description copied from interface: RemoveHandlerEventHandler

Invoked when a chart event handler is removed.

Specified by:

onRemove in interface RemoveHandlerEventHandler

Parameters:

event - event to be consumed

onAdd

public final void onAdd(AddHandlerEvent event)

Description copied from interface: AddHandlerEventHandler

Invoked when a new event handler is added.

Specified by:

onAdd in interface AddHandlerEventHandler

Parameters:

event - event to be consumed

addHandler

protected abstract <H extends EventHandler> void addHandler(GwtEvent.Type<H> type)

Notifies the event provider when a new handler has been added.

Type Parameters:

H - type of event handler

Parameters:

type - type of event

removeHandler

protected abstract <H extends EventHandler> void removeHandler(GwtEvent.Type<H> type)

Notifies the event provider when a new handler has been unregistered

Type Parameters:

H - type of event handler

Parameters:

type - type of event handler

setConfiguration

protected final void setConfiguration(T configuration)

Parameters:

configuration - the configuration to set

getConfiguration

protected final T getConfiguration()

Returns the configuration element.

Returns:

the configuration element.

toJSON

public final String toJSON()

Returns the JSON representation of the object.

Returns:

the JSON representation of the object.

getChart

public final AbstractChart<?,?> getChart()

Returns the chart instance

Returns:

the chart