org.apache.myfaces.tobago.event

Enum PageAction

java.lang.Object

java.lang.Enum<PageAction>

org.apache.myfaces.tobago.event.PageAction

All Implemented Interfaces:

Serializable, Comparable<PageAction>

public enum PageAction
extends Enum<PageAction>

Enum Constant Summary

Enum Constants

Enum Constant and Description
FIRST First page is requested
LAST Last page is requested
NEXT Next page is requested
PREV Previous page is requested
TO_PAGE A specified page is requested
TO_ROW A specified row is requested

Method Summary

Methods

Modifier and Type	Method and Description
String	getToken()
static PageAction	parse(String name)
static PageAction	valueOf(String name) Returns the enum constant of this type with the specified name.
static PageAction[]	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

FIRST

public static final PageAction FIRST

First page is requested

NEXT

public static final PageAction NEXT

Next page is requested

PREV

public static final PageAction PREV

Previous page is requested

LAST

public static final PageAction LAST

Last page is requested

TO_ROW

public static final PageAction TO_ROW

A specified row is requested

TO_PAGE

public static final PageAction TO_PAGE

A specified page is requested

Method Detail

values

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

Returns:

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

valueOf

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

getToken

public String getToken()

parse

public static PageAction parse(String name)
                        throws IllegalArgumentException

Parameters:

name - Name of the PageAction

Returns:

The matching page action (can't be null).

Throws:

IllegalArgumentException - When the name doesn't match any PageAction.