Package org.pepstock.charba.client.events

Class AxisHoverEvent

java.lang.Object

org.pepstock.charba.client.events.Event

org.pepstock.charba.client.events.AbstractEvent

org.pepstock.charba.client.events.AxisHoverEvent

All Implemented Interfaces:

HasNativeEvent

public final class AxisHoverEvent
extends AbstractEvent

Event which is fired when the user is hovering on the axis of the chart.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field	Description
static EventType	TYPE	Event type

Constructor Summary

Constructors

Constructor	Description
AxisHoverEvent(NativeAbstractMouseEvent nativeEvent, ScaleItem item, Axis axis)	Creates the event with axis related to the hover

Method Summary

Modifier and Type	Method	Description
protected void	dispatch(EventHandler handler)	Implemented by subclasses to dispatch event on the handler.
Axis	getAxis()	Returns the axis configuration instance if exists.
ScaleItem	getItem()	Returns the scale item related to the action
NativeAbstractMouseEvent	getNativeMouseEvent()	Returns the native event as NativeMouseEvent.

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

Field Detail

TYPE

public static final EventType TYPE

Event type

Constructor Detail

AxisHoverEvent

public AxisHoverEvent(NativeAbstractMouseEvent nativeEvent,
                      ScaleItem item,
                      Axis axis)

Creates the event with axis related to the hover

Parameters:

nativeEvent - native event of this custom event

item - scale item related to the hover

axis - axis configuration instance

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 ScaleItem getItem()

Returns the scale item related to the action

Returns:

the scale item related to the action

getAxis

public final Axis getAxis()

Returns the axis configuration instance if exists. The chart can be implemented without any axis (using defaults) and therefore can return null.

Returns:

the axis configuration instance or null if no axis configuration has been provided to chart

getNativeMouseEvent

public final NativeAbstractMouseEvent getNativeMouseEvent()

Returns the native event as NativeMouseEvent.

Returns:

the native event as NativeMouseEvent.