playn.scene

Enum Interaction.CaptureMode

java.lang.Object

java.lang.Enum<Interaction.CaptureMode>

playn.scene.Interaction.CaptureMode

All Implemented Interfaces:

Serializable, Comparable<Interaction.CaptureMode>

Enclosing class:

Interaction<E extends Event.XY>

public static enum Interaction.CaptureMode
extends Enum<Interaction.CaptureMode>

Used to configure Interaction.capture().

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABOVE Events are sent to the capturing layer and its parents.
BELOW Events are sent to the capturing layer and its children.
ONLY Events are only sent to the capturing layer.

Method Summary

Modifier and Type	Method and Description
abstract boolean	allow(playn.scene.Interaction.Depth depth)
static Interaction.CaptureMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static Interaction.CaptureMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ONLY

public static final Interaction.CaptureMode ONLY

Events are only sent to the capturing layer.

ABOVE

public static final Interaction.CaptureMode ABOVE

Events are sent to the capturing layer and its parents.

BELOW

public static final Interaction.CaptureMode BELOW

Events are sent to the capturing layer and its children.

Method Detail

values

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

Returns:

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

valueOf

public static Interaction.CaptureMode 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

allow

public abstract boolean allow(playn.scene.Interaction.Depth depth)