com.gluonhq.charm.glisten.layout.responsive.grid

Enum Offset

java.lang.Object

java.lang.Enum<Offset>

com.gluonhq.charm.glisten.layout.responsive.grid.Offset

All Implemented Interfaces:

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

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

The Offsett enum simply represents how many columns a particular node in offset in the GridLayout. This uses a concept similar to the Bootstrap layout common on the web, where a node can be offset between zero and eleven columns.

Since:

2.0.0

See Also:

GridLayout, GridRow, GridSpan, Span

Enum Constant Summary

Enum Constants

Enum Constant and Description
OFFSET_0 Offset zero columns.
OFFSET_1 Offset one column.
OFFSET_10 Offset ten columns.
OFFSET_11 Offset eleven columns.
OFFSET_2 Offset two columns.
OFFSET_3 Offset three columns.
OFFSET_4 Offset four columns.
OFFSET_5 Offset five columns.
OFFSET_6 Offset six columns.
OFFSET_7 Offset seven columns.
OFFSET_8 Offset eight columns.
OFFSET_9 Offset nine columns.

Method Summary

Modifier and Type	Method and Description
int	getOffset() Returns the offset as an integer value between zero and eleven.
static Offset	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Offset[]	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

OFFSET_0

public static final Offset OFFSET_0

Offset zero columns.

OFFSET_1

public static final Offset OFFSET_1

Offset one column.

OFFSET_2

public static final Offset OFFSET_2

Offset two columns.

OFFSET_3

public static final Offset OFFSET_3

Offset three columns.

OFFSET_4

public static final Offset OFFSET_4

Offset four columns.

OFFSET_5

public static final Offset OFFSET_5

Offset five columns.

OFFSET_6

public static final Offset OFFSET_6

Offset six columns.

OFFSET_7

public static final Offset OFFSET_7

Offset seven columns.

OFFSET_8

public static final Offset OFFSET_8

Offset eight columns.

OFFSET_9

public static final Offset OFFSET_9

Offset nine columns.

OFFSET_10

public static final Offset OFFSET_10

Offset ten columns.

OFFSET_11

public static final Offset OFFSET_11

Offset eleven columns.

Method Detail

values

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

Returns:

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

valueOf

public static Offset 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

getOffset

public final int getOffset()

Returns the offset as an integer value between zero and eleven.

Returns:

The offset value.