Enum MouseTracking.Protocol

java.lang.Object

java.lang.Enum<MouseTracking.Protocol>

org.aesh.terminal.tty.MouseTracking.Protocol

All Implemented Interfaces:

Serializable, Comparable<MouseTracking.Protocol>

Enclosing class:

MouseTracking

public static enum MouseTracking.Protocol
extends Enum<MouseTracking.Protocol>

Mouse tracking protocol — controls which events are reported.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANY_MOTION	Any-event tracking: press + release + drag + hover.
BUTTON_MOTION	Button-event tracking: press + release + drag.
NORMAL	Normal tracking: press + release.
X10	X10 compatibility mode: button press only.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

X10

public static final MouseTracking.Protocol X10

X10 compatibility mode: button press only.

NORMAL

public static final MouseTracking.Protocol NORMAL

Normal tracking: press + release.

BUTTON_MOTION

public static final MouseTracking.Protocol BUTTON_MOTION

Button-event tracking: press + release + drag.

ANY_MOTION

public static final MouseTracking.Protocol ANY_MOTION

Any-event tracking: press + release + drag + hover.

Method Details

values

public static MouseTracking.Protocol[] values()

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

Returns:

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

valueOf

public static MouseTracking.Protocol 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