oracle.adf.view.faces.bi.component.pivotTable

Class Selection

java.lang.Object

oracle.adf.view.faces.bi.component.pivotTable.Selection

All Implemented Interfaces:

java.io.Serializable

public class Selection
extends java.lang.Object
implements java.io.Serializable

Represents the selection in a Pivot Table. The selection is a set of ranges of cells, where each range is either a single-cell range or a multi-cell range. A valid selection must obey the following restrictions. These restrictions are enforced by the UI at runtime, and must be honored by application-specified selections as well.

• Only one region of the Pivot Table can be selected at a time: either the column header, row header, or databody. In other words, at most one of the three SelectionSets may be non-empty at any time.
• Only one layer within a header can be selected at a time.

Since:

release specific (what release of product did this appear in)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Selection() Creates a new, empty selection.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears the selection, so that nothing is selected.
boolean	equals(java.lang.Object object) Compares the specified object with this selection for equality.
HeaderCellSelectionSet	getColumnHeaderCells() Returns the HeaderCellSelectionSet containing the selected column header cells.
DataCellSelectionSet	getDataCells() Returns the DataCellSelectionSet containing the selected datacells.
protected DataModel	getDataModel() Returns the data model used by this selection.
protected PivotTableModel	getPivotTableModel() Deprecated. Use the getDataModel method instead.
HeaderCellSelectionSet	getRowHeaderCells() Returns the HeaderCellSelectionSet containing the selected row header cells.
int	hashCode()
protected void	setDataModel(DataModel model) Sets the data model on the selection.
protected void	setPivotTableModel(PivotTableModel model) Deprecated. Use the setDataModel method instead.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Selection

public Selection()

Creates a new, empty selection.

Method Detail

clear

public void clear()

Clears the selection, so that nothing is selected.

getColumnHeaderCells

public HeaderCellSelectionSet getColumnHeaderCells()

Returns the HeaderCellSelectionSet containing the selected column header cells.

Returns:

the HeaderCellSelectionSet containing the selected column header cells. Possibly empty, but never null.

getRowHeaderCells

public HeaderCellSelectionSet getRowHeaderCells()

Returns the HeaderCellSelectionSet containing the selected row header cells.

Returns:

the HeaderCellSelectionSet containing the selected row header cells. Possibly empty, but never null.

getDataCells

public DataCellSelectionSet getDataCells()

Returns the DataCellSelectionSet containing the selected datacells.

Returns:

the DataCellSelectionSet containing the selected datacells. Possibly empty, but never null.

setDataModel

protected void setDataModel(DataModel model)

Sets the data model on the selection. Should be the same data model that is set on the component.

Parameters:

model - the data model

getDataModel

protected DataModel getDataModel()

Returns the data model used by this selection.

Returns:

the data model

setPivotTableModel

@Deprecated
protected void setPivotTableModel(PivotTableModel model)

Deprecated. Use the setDataModel method instead.

Parameters:

model - the Pivot Table model

getPivotTableModel

@Deprecated
protected PivotTableModel getPivotTableModel()

Deprecated. Use the getDataModel method instead.

Returns:

the Pivot Table model

equals

public boolean equals(java.lang.Object object)

Compares the specified object with this selection for equality. Returns true if and only if the specified object is a Selection object whose three SelectionSets are equal to those of this Selection, respectively.

Overrides:

equals in class java.lang.Object

Parameters:

object - the object to test for equality

Returns:

true if the specified object is equal to this object; false otherwise

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object