Package limn.components.table

Enum Class SortOrder

java.lang.Object

java.lang.Enum<SortOrder>

limn.components.table.SortOrder

All Implemented Interfaces:

Serializable, Comparable<SortOrder>, Constable

public enum SortOrder
extends Enum<SortOrder>

How a Table is ordered on one of its columns.

A 1.x minor release may add constants to this enum: a switch over it needs a default branch.

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
ASCENDING	Smallest first.
DESCENDING	Largest first.
NONE	The model's own order.

Method Summary

Modifier and Type	Method	Description
SortOrder	next()	What a click on a header cycles to: ascending, then descending, then the model's order.
static SortOrder	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SortOrder[]	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

NONE

public static final SortOrder NONE

The model's own order.

ASCENDING

public static final SortOrder ASCENDING

Smallest first.

DESCENDING

public static final SortOrder DESCENDING

Largest first.

Method Details

values

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

next

public SortOrder next()

What a click on a header cycles to: ascending, then descending, then the model's order.

Returns:

the next order in that cycle