oracle.adf.view.rich.event

Class ColumnSelectionEvent

java.lang.Object

java.util.EventObject

javax.faces.event.FacesEvent

oracle.adf.view.rich.event.ColumnSelectionEvent

All Implemented Interfaces:

Serializable

public class ColumnSelectionEvent
extends javax.faces.event.FacesEvent

ColumnSelectionEvent is fired when a column selection change occurrs in RichTable and RichTreeTable. The 'addedColumns' and 'removedColumns' properties of the event contain column client IDs for the newly selected and newly unselected columns. The getSelectedColumns API (available on the 'source' component) returns client IDs for all currently selected columns.

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
ColumnSelectionEvent(javax.faces.component.UIComponent source, Collection<String> addedColumns, Collection<String> removedColumns) Creates a ColumnSelectionEvent

Method Summary

Modifier and Type	Method and Description
Collection<String>	getAddedColumns() Returns newly selected columns
Collection<String>	getRemovedColumns() Returns newly unselected columns
boolean	isAppropriateListener(javax.faces.event.FacesListener listener)
void	processListener(javax.faces.event.FacesListener 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

Constructor Detail

ColumnSelectionEvent

public ColumnSelectionEvent(javax.faces.component.UIComponent source,
                            Collection<String> addedColumns,
                            Collection<String> removedColumns)

Creates a ColumnSelectionEvent

Parameters:

source - UIComponent firing the event

addedColumns - a Collection of column client IDs that have just been selected.

removedColumns - a Collection of client IDs that have just been unselected.

Method Detail

isAppropriateListener

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

Specified by:

isAppropriateListener in class javax.faces.event.FacesEvent

processListener

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

Specified by:

processListener in class javax.faces.event.FacesEvent

getAddedColumns

public Collection<String> getAddedColumns()

Returns newly selected columns

Returns:

Collection of client IDs for newly selected columns

getRemovedColumns

public Collection<String> getRemovedColumns()

Returns newly unselected columns

Returns:

Collection of client IDs for newly unselected columns