Class AxisClickEvent
- java.lang.Object
-
- org.pepstock.charba.client.events.Event
-
- org.pepstock.charba.client.events.AbstractEvent
-
- org.pepstock.charba.client.events.AxisClickEvent
-
public final class AxisClickEvent extends AbstractEvent
Event which is fired when the user clicks on the axis of the chart.- Author:
- Andrea "Stock" Stocchero
-
-
Constructor Summary
Constructors Constructor Description AxisClickEvent(BaseNativeEvent nativeEvent, ScaleItem item, Axis axis, ScaleValueItem value)
Creates the event with axis related to the click
-
Method Summary
All Methods Instance Methods Concrete Methods 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 actionScaleValueItem
getValue()
Returns the scale value related to the click, ornull
if not consistent.-
Methods inherited from class org.pepstock.charba.client.events.AbstractEvent
getChart, getNativeEvent, getType
-
-
-
-
Field Detail
-
TYPE
public static final EventType TYPE
Event type
-
-
Constructor Detail
-
AxisClickEvent
public AxisClickEvent(BaseNativeEvent nativeEvent, ScaleItem item, Axis axis, ScaleValueItem value)
Creates the event with axis related to the click- Parameters:
nativeEvent
- native event of this custom eventitem
- scale item related to the clickaxis
- axis configuration instancevalue
- value instance selected on axis
-
-
Method Detail
-
getValue
public ScaleValueItem getValue()
Returns the scale value related to the click, ornull
if not consistent.- Returns:
- the scale value related to the click, or
null
if not consistent
-
dispatch
protected void dispatch(EventHandler handler)
Description copied from class:Event
Implemented by subclasses to dispatch event on the handler.
-
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 returnnull
.- Returns:
- the axis configuration instance or
null
if no axis configuration has been provided to chart
-
-