org.codefx.libfx.dom

Enum DomEventType

java.lang.Object

java.lang.Enum<DomEventType>

org.codefx.libfx.dom.DomEventType

All Implemented Interfaces:

Serializable, Comparable<DomEventType>

public enum DomEventType
extends Enum<DomEventType>

The names of those types of DOM events for which an equivalent hyperlink EventTypes exists.

See Also:

DOM Level 3 Events Specification - Event Type List

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLICK A mouse click.
MOUSE_ENTER The mouse entered an element's boundaries.
MOUSE_LEAVE The mouse left an element's boundaries.

Method Summary

Modifier and Type	Method and Description
static Optional<DomEventType>	byName(String domEventName) Returns the DOM event type for the specified event name.
String	getDomName()
Optional<HyperlinkEvent.EventType>	toHyperlinkEventType() Returns the representation of this DOM event as an HyperlinkEventType if that is possible.
static DomEventType	valueOf(String name) Returns the enum constant of this type with the specified name.
static DomEventType[]	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

Enum Constant Detail

CLICK

public static final DomEventType CLICK

A mouse click.

This event can be canceled.

See Also:

DOM Level 3 Events Specification - CLICK Event

MOUSE_ENTER

public static final DomEventType MOUSE_ENTER

The mouse entered an element's boundaries. Is not dispatched when the mouse moves inside the element between its descendant elements.

This event can not be canceled, i.e. canceling it has no effect.

See Also:

DOM Level 3 Events Specification - MOUSEENTER Event

MOUSE_LEAVE

public static final DomEventType MOUSE_LEAVE

The mouse left an element's boundaries. Is not dispatched when the mouse moves inside the element between its descendant elements.

This event can not be canceled, i.e. canceling it has no effect.

See Also:

DOM Level 3 Events Specification - MOUSELEAVE Event

Method Detail

values

public static DomEventType[] 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 (DomEventType c : DomEventType.values())
    System.out.println(c);

Returns:

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

valueOf

public static DomEventType 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

getDomName

public String getDomName()

Returns:

the name of the event as per DOM Level 3 Events Specification

byName

public static Optional<DomEventType> byName(String domEventName)

Returns the DOM event type for the specified event name.

Parameters:

domEventName - the name of the DOM event as per W3C specification

Returns:

a DomEventType if it could be determined; otherwise Optional.empty()

See Also:

DOM Level 3 Events Specification - Event Type List

toHyperlinkEventType

public Optional<HyperlinkEvent.EventType> toHyperlinkEventType()

Returns the representation of this DOM event as an HyperlinkEventType if that is possible. Otherwise returns an empty Optional.

Returns:

• CLICK → ACTIVATED
• MOUSE_ENTER → ENTERED
• MOUSE_LEAVE → EXITED
• Otherwise → empty