org.pepstock.charba.client.events

Class DatasetRangeSelectionEvent

java.lang.Object

org.pepstock.charba.client.events.Event

org.pepstock.charba.client.events.AbstractEvent

org.pepstock.charba.client.events.DatasetRangeSelectionEvent

public final class DatasetRangeSelectionEvent
extends AbstractEvent

Event which is fired when the user selects an area on the chart, by DatasetsItemsSelector.ID plugin.

Author:

Andrea "Stock" Stocchero

Field Summary

Fields

Modifier and Type	Field and Description
static int	CLEAR_SELECTION Value -2147483648 of FROM and TO when the event is representing a clear of selection
static EventType	TYPE Event type

Constructor Summary

Constructors

Constructor and Description
DatasetRangeSelectionEvent(BaseNativeEvent nativeEvent) Creates the event when the clear of current selection has been requested.
DatasetRangeSelectionEvent(BaseNativeEvent nativeEvent, int from, int to) Creates the event with start and end index of selected datasets.

Method Summary

Modifier and Type	Method and Description
protected void	dispatch(EventHandler handler) Implemented by subclasses to dispatch event on the handler.
int	getFrom() Returns the starting index of of selected datasets items. If equals to CLEAR_SELECTION, the event is related to a clear of selection area.
int	getTo() Returns the ending index of of selected datasets items. If equals to CLEAR_SELECTION, the event is related to a clear of selection area.

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

CLEAR_SELECTION

public static final int CLEAR_SELECTION

Value -2147483648 of FROM and TO when the event is representing a clear of selection

See Also:

Constant Field Values

TYPE

public static final EventType TYPE

Event type

Constructor Detail

DatasetRangeSelectionEvent

public DatasetRangeSelectionEvent(BaseNativeEvent nativeEvent)

Creates the event when the clear of current selection has been requested.

Parameters:

nativeEvent - native event of this custom event

DatasetRangeSelectionEvent

public DatasetRangeSelectionEvent(BaseNativeEvent nativeEvent,
                                  int from,
                                  int to)

Creates the event with start and end index of selected datasets.

Parameters:

nativeEvent - native event of this custom event

from - starting index of selected dataset

to - ending index of selected dataset

Method Detail

getFrom

public int getFrom()

Returns the starting index of of selected datasets items.
If equals to CLEAR_SELECTION, the event is related to a clear of selection area.

Returns:

the starting index of of selected datasets items.

getTo

public int getTo()

Returns the ending index of of selected datasets items.
If equals to CLEAR_SELECTION, the event is related to a clear of selection area.

Returns:

the to the ending index of of selected datasets items.

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