org.pepstock.charba.client.events

Class LegendHoverEvent

java.lang.Object

org.pepstock.charba.client.events.Event

org.pepstock.charba.client.events.AbstractEvent

org.pepstock.charba.client.events.LegendHoverEvent

All Implemented Interfaces:

IsCommonChartEvent, IsLegendEvent

public final class LegendHoverEvent
extends AbstractEvent

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

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static EventType	TYPE Event type

Constructor Summary

Constructors

Constructor and Description
LegendHoverEvent(BaseNativeEvent nativeEvent, Chart functionContext, LegendItem item) Creates the event with legend item related to the hover

Method Summary

Modifier and Type	Method and Description
protected void	dispatch(EventHandler handler) Implemented by subclasses to dispatch event on the handler.
Chart	getContext() Returns the java script function context of CHART.JS events.
LegendItem	getItem() Returns the legend item related to the click
Key	getKey() Returns the options key where default function is stored.

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

getChart, getNativeEvent, getType

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

getSource, setSource

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.events.IsCommonChartEvent

getChart, getContext, getKey, getNativeEvent

Field Detail

TYPE

public static final EventType TYPE

Event type

Constructor Detail

LegendHoverEvent

public LegendHoverEvent(BaseNativeEvent nativeEvent,
                        Chart functionContext,
                        LegendItem item)

Creates the event with legend item related to the hover

Parameters:

nativeEvent - native event of this custom event

functionContext - function context provided by CHART.JS

item - legend item related to the hover

Method Detail

dispatch

protected void dispatch(EventHandler handler)

Description copied from class: Event

Implemented by subclasses to dispatch event on the handler.

Specified by:

dispatch in class Event

Parameters:

handler - handler instance

getItem

public final LegendItem getItem()

Returns the legend item related to the click

Specified by:

getItem in interface IsLegendEvent

Returns:

the legend item related to the click

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