Package docking.widgets

Enum Class EventTrigger

java.lang.Object

java.lang.Enum<EventTrigger>

docking.widgets.EventTrigger

All Implemented Interfaces:

Serializable, Comparable<EventTrigger>, Constable

public enum EventTrigger
extends Enum<EventTrigger>

This class is used to provide information regarding the source of an event. It is often useful for event processing clients to know of the user generated an event through the UI or from an API call, or if the event came from an internal source, like a change to the client's model.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
API_CALL
GUI_ACTION
INTERNAL_ONLY
MODEL_CHANGE

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

GUI_ACTION

public static final EventTrigger GUI_ACTION

API_CALL

public static final EventTrigger API_CALL

MODEL_CHANGE

public static final EventTrigger MODEL_CHANGE

INTERNAL_ONLY

public static final EventTrigger INTERNAL_ONLY

Method Details

values

public static EventTrigger[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static EventTrigger valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null