Package squidpony.squidgrid.gui.gdx

Enum UIUtil.YMoveKind

java.lang.Object

java.lang.Enum<UIUtil.YMoveKind>

squidpony.squidgrid.gui.gdx.UIUtil.YMoveKind

All Implemented Interfaces:

Serializable, Comparable<UIUtil.YMoveKind>, Constable

Enclosing class:

UIUtil

public static enum UIUtil.YMoveKind
extends Enum<UIUtil.YMoveKind>

A vertical move triggered by keyboard keys.

Author:

smelC

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
DOWN	The kind corresponding to arrow down
PAGE_DOWN	The kind corresponding to page down
PAGE_UP	The kind corresponding to page up
UP	The kind corresponding to arrow up

Method Summary

Modifier and Type	Method	Description
boolean	isDown()
static UIUtil.YMoveKind	of(int keycode, boolean vim)
static UIUtil.YMoveKind	valueOf(String name)	Returns the enum constant of this type with the specified name.
static UIUtil.YMoveKind[]	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, 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

UP

public static final UIUtil.YMoveKind UP

The kind corresponding to arrow up

DOWN

public static final UIUtil.YMoveKind DOWN

The kind corresponding to arrow down

PAGE_DOWN

public static final UIUtil.YMoveKind PAGE_DOWN

The kind corresponding to page down

PAGE_UP

public static final UIUtil.YMoveKind PAGE_UP

The kind corresponding to page up

Method Details

values

public static UIUtil.YMoveKind[] 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 UIUtil.YMoveKind 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

isDown

public boolean isDown()

Returns:

true if this is downward.

of

public static UIUtil.YMoveKind of(int keycode, boolean vim)

Parameters:

keycode -

vim - Whether to recognize vim shortcuts (j/k).

Returns:

The move kind corresponding to keycode, or null if none.