Package org.jboss.hal.ballroom.table

Enum RefreshMode

java.lang.Object

java.lang.Enum<RefreshMode>

org.jboss.hal.ballroom.table.RefreshMode

All Implemented Interfaces:

Serializable, Comparable<RefreshMode>

public enum RefreshMode
extends Enum<RefreshMode>

Typesafe enum for the paging parameter of Api.draw(String).

See Also:

https://datatables.net/reference/api/draw()

Enum Constant Summary

Enum Constants

Enum Constant	Description
HOLD	The ordering and search will be recalculated and the rows redrawn in their new positions.
PAGE	Ordering and search will not be updated and the paging position held where is was.
RESET	The ordering and search will be recalculated and the rows redrawn in their new positions.

Method Summary

Modifier and Type	Method	Description
String	mode()
static RefreshMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static RefreshMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RESET

public static final RefreshMode RESET

The ordering and search will be recalculated and the rows redrawn in their new positions. The paging will be reset back to the first page.

HOLD

public static final RefreshMode HOLD

The ordering and search will be recalculated and the rows redrawn in their new positions. The paging will not be reset - i.e. the current page will still be shown.

PAGE

public static final RefreshMode PAGE

Ordering and search will not be updated and the paging position held where is was. This is useful for paging when data has not been changed between draws.

Method Detail

values

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

Returns:

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

valueOf

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

mode

public String mode()