org.pepstock.charba.client.events

Class ChartHoverEvent

java.lang.Object

com.google.web.bindery.event.shared.Event<H>

com.google.gwt.event.shared.GwtEvent<H>

org.pepstock.charba.client.events.AbstractEvent<H>

org.pepstock.charba.client.events.ChartHoverEvent

All Implemented Interfaces:

IsChartEvent, IsCommonChartEvent

public final class ChartHoverEvent
extends AbstractEvent<H>
implements IsChartEvent

Event which is fired when the user hovers on the chart.

Author:

Andrea "Stock" Stocchero

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.event.shared.GwtEvent

GwtEvent.Type<H>

Field Summary

Fields

Modifier and Type	Field and Description
static GwtEvent.Type<ChartHoverEventHandler>	TYPE Event type

Constructor Summary

Constructors

Constructor and Description
ChartHoverEvent(NativeEvent nativeEvent, Chart functionContext, List<DatasetItem> items) Creates the event with a list of items with dataset metadata related to the hover

Method Summary

Modifier and Type	Method and Description
protected void	dispatch(ChartHoverEventHandler handler)
GwtEvent.Type<ChartHoverEventHandler>	getAssociatedType()
Chart	getContext() Returns the java script function context of CHART.JS events.
List<DatasetItem>	getItems() Returns a list of items with dataset metadata related to the hover
Key	getKey() Returns the options key where default function is stored.

Methods inherited from class org.pepstock.charba.client.events.AbstractEvent

getChart, getNativeEvent

Methods inherited from class com.google.gwt.event.shared.GwtEvent

assertLive, getSource, isLive, kill, revive

Methods inherited from class com.google.web.bindery.event.shared.Event

setSource, toDebugString, 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.events.IsCommonChartEvent

getChart, getContext, getKey, getNativeEvent

Field Detail

TYPE

public static final GwtEvent.Type<ChartHoverEventHandler> TYPE

Event type

Constructor Detail

ChartHoverEvent

public ChartHoverEvent(NativeEvent nativeEvent,
                       Chart functionContext,
                       List<DatasetItem> items)

Creates the event with a list of items with dataset metadata related to the hover

Parameters:

nativeEvent - native event of this custom event

functionContext - function context provided by CHART.JS

items - a list of items with dataset metadata related to the hover

Method Detail

getItems

public List<DatasetItem> getItems()

Returns a list of items with dataset metadata related to the hover

Specified by:

getItems in interface IsChartEvent

Returns:

a list of items with dataset metadata related to the hover

getAssociatedType

public GwtEvent.Type<ChartHoverEventHandler> getAssociatedType()

Overrides:

getAssociatedType in class GwtEvent<ChartHoverEventHandler>

dispatch

protected void dispatch(ChartHoverEventHandler handler)

Specified by:

dispatch in class GwtEvent<ChartHoverEventHandler>

getContext

public final Chart getContext()

Returns the java script function context of CHART.JS events.

Returns:

the java script function context of CHART.JS events.

getKey

public final Key getKey()

Returns the options key where default function is stored.

Returns:

the options key where default function is stored