Package space.maxus.flare.ui

Enum Class Dimensions

java.lang.Object

java.lang.Enum<Dimensions>

space.maxus.flare.ui.Dimensions

All Implemented Interfaces:

Serializable, Comparable<Dimensions>, Constable

public enum Dimensions
extends Enum<Dimensions>

Possible dimensions for Flare UIs

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
FIVE_BY_NINE	5x9
FOUR_BY_NINE	4x9
SIX_BY_NINE	6x9
THREE_BY_NINE	3x9
THREE_BY_THREE	3x3 These dimensions are experimental, and may not work as expected.

Method Summary

Modifier and Type	Method	Description
int	getColumns()	Amount of columns in these dimensions
int	getRows()	Amount of rows in these dimensions
int	getTotalSize()	Total size of these dimensions in slots
static Dimensions	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Dimensions[]	values()	Returns an array containing the constants of this enum class, 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

THREE_BY_NINE

public static final Dimensions THREE_BY_NINE

3x9

FOUR_BY_NINE

public static final Dimensions FOUR_BY_NINE

4x9

FIVE_BY_NINE

public static final Dimensions FIVE_BY_NINE

5x9

SIX_BY_NINE

public static final Dimensions SIX_BY_NINE

6x9

THREE_BY_THREE

@Experimental
public static final Dimensions THREE_BY_THREE

3x3
These dimensions are experimental, and may not work as expected.

Method Details

values

public static Dimensions[] 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 Dimensions 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

getTotalSize

public int getTotalSize()

Total size of these dimensions in slots

getRows

public int getRows()

Amount of rows in these dimensions

getColumns

public int getColumns()

Amount of columns in these dimensions