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

Class SortEvent

java.lang.Object

java.util.EventObject

javax.faces.event.FacesEvent

javax.faces.event.ActionEvent

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

All Implemented Interfaces:

java.io.Serializable

public class SortEvent
extends javax.faces.event.ActionEvent

An event fired when a sort has occurred or is about to to occur.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SortEvent.SortType The type of sort being performed.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	COLUMN_SORT_ASCENDING Synonym for SORT_ASCENDING, which is preferred over this constant.
static java.lang.Integer	COLUMN_SORT_DESCENDING Synonym for SORT_DESCENDING, which is preferred over this constant.
static java.lang.String	COLUMN_SORT_DIRECTION_PARAM Synonym for SORT_DIRECTION_PARAM, which is preferred over this constant.
static java.lang.String	COLUMN_SORT_GROUPED_PARAM The name of the parameter whose value is a Boolean that indicates whether the sort will retain groupings on the row edge.
static java.lang.String	COLUMN_SORT_SLICE_PARAM The name of the parameter whose value is an Integer that indicates the zero-based index of the column being sorted.
static java.lang.String	HEADER_SORT_LAYER_PARAM The name of the parameter whose value is an Integer that indicates the zero-based index of the layer being sorted, where the outermost layer is layer 0.
static java.lang.Integer	SORT_ASCENDING A value indicating that the sort is in order of increasing values.
static java.lang.Integer	SORT_DESCENDING A value indicating that the sort is in order of decreasing values.
static java.lang.String	SORT_DIRECTION_PARAM The name of the parameter whose value can either be SORT_ASCENDING or SORT_DESCENDING, indicating the direction of the sort.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
SortEvent(javax.faces.component.UIComponent component, SortEvent.SortType type, java.util.Map<java.lang.String,java.lang.Object> properties) Creates a new sort event.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getProperties() Returns a map of properties for the sort event.
SortEvent.SortType	getType() Returns the type of sort event.
boolean	isAppropriateListener(javax.faces.event.FacesListener listener) Indicates whether the listener is an appropriate listener for this event, that is, an instance of SortListener.
void	processListener(javax.faces.event.FacesListener listener) Calls the appropriate callback method of the listener.

Methods inherited from class javax.faces.event.FacesEvent

getComponent, getPhaseId, queue, setPhaseId

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

SORT_DIRECTION_PARAM

public static final java.lang.String SORT_DIRECTION_PARAM

The name of the parameter whose value can either be SORT_ASCENDING or SORT_DESCENDING, indicating the direction of the sort.

See Also:

Constant Field Values

SORT_ASCENDING

public static final java.lang.Integer SORT_ASCENDING

A value indicating that the sort is in order of increasing values.

SORT_DESCENDING

public static final java.lang.Integer SORT_DESCENDING

A value indicating that the sort is in order of decreasing values.

HEADER_SORT_LAYER_PARAM

public static final java.lang.String HEADER_SORT_LAYER_PARAM

The name of the parameter whose value is an Integer that indicates the zero-based index of the layer being sorted, where the outermost layer is layer 0. Applies to header sorts only.

See Also:

Constant Field Values

COLUMN_SORT_SLICE_PARAM

public static final java.lang.String COLUMN_SORT_SLICE_PARAM

The name of the parameter whose value is an Integer that indicates the zero-based index of the column being sorted.

See Also:

Constant Field Values

COLUMN_SORT_DIRECTION_PARAM

public static final java.lang.String COLUMN_SORT_DIRECTION_PARAM

Synonym for SORT_DIRECTION_PARAM, which is preferred over this constant.

See Also:

Constant Field Values

COLUMN_SORT_GROUPED_PARAM

public static final java.lang.String COLUMN_SORT_GROUPED_PARAM

The name of the parameter whose value is a Boolean that indicates whether the sort will retain groupings on the row edge.

See Also:

Constant Field Values

COLUMN_SORT_ASCENDING

public static final java.lang.Integer COLUMN_SORT_ASCENDING

Synonym for SORT_ASCENDING, which is preferred over this constant.

COLUMN_SORT_DESCENDING

public static final java.lang.Integer COLUMN_SORT_DESCENDING

Synonym for SORT_DESCENDING, which is preferred over this constant.

Constructor Detail

SortEvent

public SortEvent(javax.faces.component.UIComponent component,
         SortEvent.SortType type,
         java.util.Map<java.lang.String,java.lang.Object> properties)

Creates a new sort event.

Parameters:

component - the component that was sorted

type - the type of sort that was performed

properties - additional information about the sort. Must be Serializable.

Method Detail

getType

public SortEvent.SortType getType()

Returns the type of sort event.

Returns:

the type of sort event

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

Returns a map of properties for the sort event.

Returns:

a Map of properties for the sort event

isAppropriateListener

public boolean isAppropriateListener(javax.faces.event.FacesListener listener)

Indicates whether the listener is an appropriate listener for this event, that is, an instance of SortListener.

Overrides:

isAppropriateListener in class javax.faces.event.ActionEvent

Parameters:

listener - the listener to check

Returns:

true if the listener is appropriate for this event, false otherwise

processListener

public void processListener(javax.faces.event.FacesListener listener)

Calls the appropriate callback method of the listener.