oracle.adf.view.faces.bi.event.pivotTable

Enum SortEvent.SortType

java.lang.Object

java.lang.Enum<SortEvent.SortType>

oracle.adf.view.faces.bi.event.pivotTable.SortEvent.SortType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SortEvent.SortType>

Enclosing class:

SortEvent

public static enum SortEvent.SortType
extends java.lang.Enum<SortEvent.SortType>

The type of sort being performed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
COLUMN Sort type used when an end user sorts the data values within a column, e.g.
COLUMN_HEADER Sort type used when an end user sorts the header labels within a layer of the column header.
ROW_HEADER Sort type used when an end user sorts the header labels within a layer of the row header.

Method Summary

Methods

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

COLUMN

public static final SortEvent.SortType COLUMN

Sort type used when an end user sorts the data values within a column, e.g. by clicking on a column sort icon. Note that this operation reorders the rows. When this occurs, the sort properties are:

• COLUMN_SORT_SLICE_PARAM, value is an Integer that indicates the zero-based index of the column being sorted. SORT_DIRECTION_PARAM, value is an Integer, which can either be SORT_ASCENDING or SORT_DESCENDING. COLUMN_SORT_GROUPED_PARAM, value is a Boolean that indicates whether the sort will retain groupings on the row edge.

ROW_HEADER

public static final SortEvent.SortType ROW_HEADER

Sort type used when an end user sorts the header labels within a layer of the row header. Note that this operation reorders the rows. When this occurs, the sort properties are:

• HEADER_SORT_LAYER_PARAM, value is an Integer that indicates the zero-based index of the layer being sorted, where the outermost layer is layer 0. SORT_DIRECTION_PARAM, value is an Integer, which can either be SORT_ASCENDING or SORT_DESCENDING.

COLUMN_HEADER

public static final SortEvent.SortType COLUMN_HEADER

Sort type used when an end user sorts the header labels within a layer of the column header. Note that this operation reorders the columns. When this occurs, the sort properties are:

• HEADER_SORT_LAYER_PARAM, value is an Integer that indicates the zero-based index of the layer being sorted, where the outermost layer is layer 0. SORT_DIRECTION_PARAM, value is an Integer, which can either be SORT_ASCENDING or SORT_DESCENDING.

Method Detail

values

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

Returns:

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

valueOf

public static SortEvent.SortType 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