Enum Class TWindowElement.CloseOperation

java.lang.Object

java.lang.Enum<TWindowElement.CloseOperation>

com.thecsdev.commonmc.api.client.gui.panel.window.TWindowElement.CloseOperation

All Implemented Interfaces:

Serializable, Comparable<TWindowElement.CloseOperation>, Constable

Enclosing class:

TWindowElement

public static enum TWindowElement.CloseOperation
extends Enum<TWindowElement.CloseOperation>

Constants used to define what happens when TWindowElement.close() is called.

API Note:

Inspired by WindowConstants.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CLOSE_SCREEN	The current screen instance the TWindowElement belongs to is closed.
DISPOSE	TWindowElement is removed from its parent.
DO_NOTHING	Nothing happens.
HIDE	TWindowElement's visibility is set to false.

Method Summary

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

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DO_NOTHING

public static final TWindowElement.CloseOperation DO_NOTHING

Nothing happens. The [X] button has no functionality.

HIDE

public static final TWindowElement.CloseOperation HIDE

TWindowElement's visibility is set to false. It is still present, but no longer visible.

See Also:

• TElement.visibleProperty()

DISPOSE

public static final TWindowElement.CloseOperation DISPOSE

TWindowElement is removed from its parent.

See Also:

• Node.remove()

CLOSE_SCREEN

public static final TWindowElement.CloseOperation CLOSE_SCREEN

The current screen instance the TWindowElement belongs to is closed.

See Also:

• TScreen.close()

Method Details

values

public static TWindowElement.CloseOperation[] 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 TWindowElement.CloseOperation 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