org.pepstock.charba.client.enums

Enum Event

java.lang.Object

java.lang.Enum<Event>

org.pepstock.charba.client.enums.Event

All Implemented Interfaces:

Serializable, Comparable<Event>, Key

public enum Event
extends Enum<Event>
implements Key

The events option defines the browser events that the chart, legend, tooltip or plugins should listen to.

Author:

Andrea "Stock" Stocchero

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLICK The user clicks an element
MOUSE_MOVE The user moves the mouse over an element
MOUSE_OUT The user moves the mouse away from an element
POINTER_DOWN Fired when a pointer becomes active. For mouse, it is fired when the device transitions from no buttons depressed to at least one button depressed. For touch, it is fired when physical contact is made with the digitizer. For pen, it is fired when the stylus makes physical contact with the digitizer.
POINTER_ENTER Fires when a pointing device is moved into the hit test boundaries of an element or one of its descendants.
POINTER_LEAVE Fired when a pointing device is moved out of the hit test boundaries of an element. For pen devices, this event is fired when the stylus leaves the hover range detectable by the digitizer.
POINTER_MOVE Fired when a pointer changes coordinates, and the pointer has not been canceled by a browser touch-action.
POINTER_OUT Fired for several reasons including: pointing device is moved out of the hit test boundaries of an element when a pen stylus leaves the hover range detectable by the digitizer
POINTER_UP Fired when a pointer is no longer active.
TOUCH_END Fires when one or more touch points are removed from the touch surface.
TOUCH_MOVE The user touches a point is moved along the touch surface.
TOUCH_START The user touches a point is placed on the touch surface.

Field Summary

Fields

Modifier and Type	Field and Description
static KeyFactory<Event>	FACTORY Key factory instance to use for array set reading.

Method Summary

Modifier and Type	Method and Description
String	value() Returns the name value of property
static Event	valueOf(String name) Returns the enum constant of this type with the specified name.
static Event[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.pepstock.charba.client.commons.Key

checkAndGetIfValid, checkIfValid, compare, create, equals, getKeyByValue, getKeyByValue, hasKeyByValue, isValid

Enum Constant Detail

MOUSE_MOVE

public static final Event MOUSE_MOVE

The user moves the mouse over an element

MOUSE_OUT

public static final Event MOUSE_OUT

The user moves the mouse away from an element

CLICK

public static final Event CLICK

The user clicks an element

TOUCH_START

public static final Event TOUCH_START

The user touches a point is placed on the touch surface.

TOUCH_MOVE

public static final Event TOUCH_MOVE

The user touches a point is moved along the touch surface.

TOUCH_END

public static final Event TOUCH_END

Fires when one or more touch points are removed from the touch surface.

POINTER_ENTER

public static final Event POINTER_ENTER

Fires when a pointing device is moved into the hit test boundaries of an element or one of its descendants.

POINTER_DOWN

public static final Event POINTER_DOWN

Fired when a pointer becomes active.
For mouse, it is fired when the device transitions from no buttons depressed to at least one button depressed.
For touch, it is fired when physical contact is made with the digitizer.
For pen, it is fired when the stylus makes physical contact with the digitizer.

POINTER_MOVE

public static final Event POINTER_MOVE

Fired when a pointer changes coordinates, and the pointer has not been canceled by a browser touch-action.

POINTER_UP

public static final Event POINTER_UP

Fired when a pointer is no longer active.

POINTER_LEAVE

public static final Event POINTER_LEAVE

Fired when a pointing device is moved out of the hit test boundaries of an element.
For pen devices, this event is fired when the stylus leaves the hover range detectable by the digitizer.

POINTER_OUT

public static final Event POINTER_OUT

Fired for several reasons including:

• pointing device is moved out of the hit test boundaries of an element
• when a pen stylus leaves the hover range detectable by the digitizer

Field Detail

FACTORY

public static final KeyFactory<Event> FACTORY

Key factory instance to use for array set reading.

Method Detail

values

public static Event[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (Event c : Event.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Event valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

Description copied from interface: Key

Returns the name value of property

Specified by:

value in interface Key

Returns:

the name value of property