|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.2.0) E17492-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
java.util.EventObject
javax.faces.event.FacesEvent
javax.faces.event.ActionEvent
oracle.adf.view.faces.bi.event.pivotTable.SortEvent
public class SortEvent
An event fired when a sort has occurred or is about to to occur.
Nested Class Summary | |
---|---|
static class |
SortEvent.SortType The type of sort being performed. |
Field Summary | |
---|---|
static java.lang.Integer |
COLUMN_SORT_ASCENDING A value indicating that the sort is in order of increasing values. |
static java.lang.Integer |
COLUMN_SORT_DESCENDING A value indicating that the sort is in order of decreasing values. |
static java.lang.String |
COLUMN_SORT_DIRECTION_PARAM The name of the parameter whose value can either be COLUMN_SORT_ASCENDING or COLUMN_SORT_DESCENDING , indicating the direction of the sort. |
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 index of the column being sorted. |
Fields inherited from class java.util.EventObject |
---|
source |
Constructor Summary | |
---|---|
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 | |
---|---|
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 |
---|
public static final java.lang.String COLUMN_SORT_SLICE_PARAM
Integer
that indicates the index of the column being sorted.
public static final java.lang.String COLUMN_SORT_DIRECTION_PARAM
COLUMN_SORT_ASCENDING
or COLUMN_SORT_DESCENDING
, indicating the direction of the sort.
public static final java.lang.String COLUMN_SORT_GROUPED_PARAM
Boolean
that indicates whether the sort will retain groupings on the row edge.
public static final java.lang.Integer COLUMN_SORT_ASCENDING
public static final java.lang.Integer COLUMN_SORT_DESCENDING
Constructor Detail |
---|
public SortEvent(javax.faces.component.UIComponent component, SortEvent.SortType type, java.util.Map<java.lang.String,java.lang.Object> properties)
component
- the component that was sortedtype
- the type of sort that was performedproperties
- additional information about the sortMethod Detail |
---|
public SortEvent.SortType getType()
public java.util.Map<java.lang.String,java.lang.Object> getProperties()
public boolean isAppropriateListener(javax.faces.event.FacesListener listener)
SortListener
.isAppropriateListener
in class javax.faces.event.ActionEvent
listener
- the listener to checktrue
if the listener is appropriate for this event, false/code> otherwise
processListener
public void processListener(javax.faces.event.FacesListener listener)
Calls the appropriate callback method of the listener.
Overrides:
processListener
in class javax.faces.event.ActionEvent
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.2.0) E17492-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |