forestry.api.gui.events

Enum GuiEventOrigin

java.lang.Object

java.lang.Enum<GuiEventOrigin>

forestry.api.gui.events.GuiEventOrigin

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GuiEventOrigin>

public enum GuiEventOrigin
extends java.lang.Enum<GuiEventOrigin>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANY
DIRECT_CHILD
PARENT
SELF

Method Summary

Modifier and Type	Method and Description
abstract boolean	isOrigin(IGuiElement origin, IGuiElement element)
static GuiEventOrigin	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GuiEventOrigin[]	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

ANY

public static final GuiEventOrigin ANY

SELF

public static final GuiEventOrigin SELF

PARENT

public static final GuiEventOrigin PARENT

DIRECT_CHILD

public static final GuiEventOrigin DIRECT_CHILD

Method Detail

values

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

Returns:

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

valueOf

public static GuiEventOrigin valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

isOrigin

public abstract boolean isOrigin(IGuiElement origin,
                                 @Nullable
                                 IGuiElement element)