Package org.opencms.workplace.list

Class CmsListOrderEnum

java.lang.Object

org.opencms.workplace.list.CmsListOrderEnum

public final class CmsListOrderEnum
extends Object

Wrapper class for the different types of table cell horizontal alignments.

The possibles values are:

• AscendingOrder
• DescendingOrder
• NoneOrder

Since:

6.0.0

Field Summary

Fields

Modifier and Type	Field	Description
static final CmsListOrderEnum	ORDER_ASCENDING	Constant for ascending ordering.
static final CmsListOrderEnum	ORDER_DESCENDING	Constant for descending ordering.
static final CmsListOrderEnum	ORDER_NONE	Constant for none ordering.
static final List<CmsListOrderEnum>	VALUES	List of ordering constants.

Method Summary

Modifier and Type	Method	Description
String	getOrder()	Returns the order string.
String	toString()
static CmsListOrderEnum	valueOf(String value)	Parses an string into an element of this enumeration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

ORDER_ASCENDING

public static final CmsListOrderEnum ORDER_ASCENDING

Constant for ascending ordering.

ORDER_DESCENDING

public static final CmsListOrderEnum ORDER_DESCENDING

Constant for descending ordering.

ORDER_NONE

public static final CmsListOrderEnum ORDER_NONE

Constant for none ordering.

VALUES

public static final List<CmsListOrderEnum> VALUES

List of ordering constants.

Method Details

valueOf

public static CmsListOrderEnum valueOf(String value)
                                throws org.opencms.main.CmsIllegalArgumentException

Parses an string into an element of this enumeration.

Parameters:

value - the align to parse

Returns:

the enumeration element

Throws:

org.opencms.main.CmsIllegalArgumentException - if the given value could not be matched against a CmsListColumnAlignEnum type.

getOrder

public String getOrder()

Returns the order string.

Returns:

the order string

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()