oracle.adf.view.faces.component
Class UIXTable

java.lang.Object
  |
  +--javax.faces.component.UIComponent
        |
        +--oracle.adf.view.faces.component.UIXComponent
              |
              +--oracle.adf.view.faces.component.UIXComponentBase
                    |
                    +--oracle.adf.view.faces.component.CollectionBase
                          |
                          +--oracle.adf.view.faces.component.TableBase
                                |
                                +--oracle.adf.view.faces.component.UIXTable

All Implemented Interfaces:

CollectionComponent, javax.faces.component.NamingContainer, javax.faces.component.StateHolder

Direct Known Subclasses:

CoreTable

public class UIXTable

extends TableBase

UIXTable is the base abstraction for table components.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	DETAIL_FACET
static PropertyKey	DISCLOSURE_LISTENER_KEY
static PropertyKey	DISCLOSURE_STATE_KEY
static PropertyKey	FIRST_KEY
static PropertyKey	GOTO_LISTENER_KEY
static PropertyKey	IMMEDIATE_KEY
static PropertyKey	ROWS_KEY
static PropertyKey	SELECTION_STATE_KEY
static PropertyKey	SORT_LISTENER_KEY
static FacesBean.Type	TYPE
static PropertyKey	VALUE_KEY
static PropertyKey	VAR_KEY

Fields inherited from class oracle.adf.view.faces.component.UIXComponentBase

ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

UIXTable()
Construct an instance of the UIXTable.

Method Summary

protected FacesBean.Type	getBeanType()
javax.faces.component.UIComponent	getDetail() the component to stamp below every row which is disclosed.
javax.faces.el.MethodBinding	getDisclosureListener() Gets a method reference to a disclosure listener
RowKeySet	getDisclosureState() Gets The detail disclosure model for this component.
java.lang.String	getFamily()
int	getFirst() Gets the index of the first row in the currently range of rows.
javax.faces.el.MethodBinding	getGotoListener() Gets a method reference to a goto listener that will be called when a new range is selected.
int	getRows() Gets the maximum number of rows to display in a single range of rows.
RowKeySet	getSelectionState() Gets The selection state for this component.
javax.faces.el.MethodBinding	getSortListener() Gets a method reference to a sort listener
java.lang.Object	getValue() Gets the data model being displayed by this table.
java.lang.String	getVar() Gets the name of the EL variable that provides access to each row of the table.
boolean	isImmediate() Gets whether or not data validation - client-side or server-side - should take place when events are generated by this component.
void	setDetail(javax.faces.component.UIComponent detailFacet) the component to stamp below every row which is disclosed.
void	setDisclosureListener(javax.faces.el.MethodBinding disclosureListener) Sets a method reference to a disclosure listener
void	setDisclosureState(RowKeySet disclosureState) Sets The detail disclosure model for this component.
void	setFirst(int first) Sets the index of the first row in the currently range of rows.
void	setGotoListener(javax.faces.el.MethodBinding gotoListener) Sets a method reference to a goto listener that will be called when a new range is selected.
void	setImmediate(boolean immediate) Sets whether or not data validation - client-side or server-side - should take place when events are generated by this component.
void	setRows(int rows) Sets the maximum number of rows to display in a single range of rows.
void	setSelectionState(RowKeySet selectionState) Sets The selection state for this component.
void	setSortListener(javax.faces.el.MethodBinding sortListener) Sets a method reference to a sort listener
void	setValue(java.lang.Object value) Sets the data model being displayed by this table.
void	setVar(java.lang.String var) Sets the name of the EL variable that provides access to each row of the table.

Methods inherited from class oracle.adf.view.faces.component.TableBase

addGotoListener, addSortListener, encodeBegin, getGotoListeners, getLocalClientId, getRowCount, getRowData, getRowIndex, getRowKey, getSortBy, getSortListeners, getSortOrder, isRowAvailable, isSortable, processDecodes, processUpdates, removeGotoListener, removeSortListener, restoreState, saveState, setRowIndex, setRowKey, sort

Methods inherited from class oracle.adf.view.faces.component.CollectionBase

broadcast, processValidators, queueEvent

Methods inherited from class oracle.adf.view.faces.component.UIXComponentBase

addFacesListener, createFacesBean, decode, encodeChildren, encodeEnd, findComponent, getAttribute, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getIntProperty, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, setAttribute, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, toString

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final FacesBean.Type TYPE

DISCLOSURE_STATE_KEY

public static final PropertyKey DISCLOSURE_STATE_KEY

SELECTION_STATE_KEY

public static final PropertyKey SELECTION_STATE_KEY

VALUE_KEY

public static final PropertyKey VALUE_KEY

ROWS_KEY

public static final PropertyKey ROWS_KEY

VAR_KEY

public static final PropertyKey VAR_KEY

FIRST_KEY

public static final PropertyKey FIRST_KEY

SORT_LISTENER_KEY

public static final PropertyKey SORT_LISTENER_KEY

IMMEDIATE_KEY

public static final PropertyKey IMMEDIATE_KEY

DISCLOSURE_LISTENER_KEY

public static final PropertyKey DISCLOSURE_LISTENER_KEY

GOTO_LISTENER_KEY

public static final PropertyKey GOTO_LISTENER_KEY

DETAIL_FACET

public static final java.lang.String DETAIL_FACET

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

UIXTable

public UIXTable()

Construct an instance of the UIXTable.

Method Detail

getDetail

public final javax.faces.component.UIComponent getDetail()

the component to stamp below every row which is disclosed. Adding a detail facet will automatically cause the detail column to be displayed. This child is not supported on the following agent types: pda.

Specified by:

getDetail in class TableBase

setDetail

public final void setDetail(javax.faces.component.UIComponent detailFacet)

the component to stamp below every row which is disclosed. Adding a detail facet will automatically cause the detail column to be displayed. This child is not supported on the following agent types: pda.

getDisclosureState

public final RowKeySet getDisclosureState()

Gets The detail disclosure model for this component.

Specified by:

getDisclosureState in class TableBase

setDisclosureState

public final void setDisclosureState(RowKeySet disclosureState)

Sets The detail disclosure model for this component.

Specified by:

setDisclosureState in class TableBase

Parameters:

disclosureState - the new disclosure state.

getSelectionState

public final RowKeySet getSelectionState()

Gets The selection state for this component.

Specified by:

getSelectionState in interface CollectionComponent

Specified by:

getSelectionState in class TableBase

setSelectionState

public final void setSelectionState(RowKeySet selectionState)

Sets The selection state for this component.

Specified by:

setSelectionState in class TableBase

Parameters:

selectionState - the new selection state

getValue

public final java.lang.Object getValue()

Gets the data model being displayed by this table. The specific model class is oracle.adf.view.faces.model.CollectionModel. You may also use other model instances, e.g., java.util.List , array, and javax.faces.model.DataModel. The Table will automatically convert the instance into a CollectionModel.

Specified by:

getValue in class TableBase

setValue

public final void setValue(java.lang.Object value)

Sets the data model being displayed by this table. The specific model class is oracle.adf.view.faces.model.CollectionModel. You may also use other model instances, e.g., java.util.List , array, and javax.faces.model.DataModel. The Table will automatically convert the instance into a CollectionModel.

getRows

public final int getRows()

Gets the maximum number of rows to display in a single range of rows. Some ranges might have fewer than the number of rows specified by this attribute (eg: the last range might have an insufficient number of rows). To display all rows at once, set this attribute to 0.

Specified by:

getRows in interface CollectionComponent

Specified by:

getRows in class TableBase

Returns:

zero if all rows are displayed.

setRows

public final void setRows(int rows)

Sets the maximum number of rows to display in a single range of rows. Some ranges might have fewer than the number of rows specified by this attribute (eg: the last range might have an insufficient number of rows). To display all rows at once, set this attribute to 0.

getVar

public final java.lang.String getVar()

Gets the name of the EL variable that provides access to each row of the table.

This is a required property on the bean.

Specified by:

getVar in interface CollectionComponent

Specified by:

getVar in class CollectionBase

setVar

public final void setVar(java.lang.String var)

Sets the name of the EL variable that provides access to each row of the table.

This is a required property on the bean.

getFirst

public final int getFirst()

Gets the index of the first row in the currently range of rows. This index is zero-based. This attribute is used to control which range of rows to display to the user.

Specified by:

getFirst in interface CollectionComponent

Specified by:

getFirst in class TableBase

Returns:

zero-based index of the first visible row.

setFirst

public final void setFirst(int first)

Sets the index of the first row in the currently range of rows. This index is zero-based. This attribute is used to control which range of rows to display to the user.

Specified by:

setFirst in class TableBase

Parameters:

first - zero-based index of the first visible row.

getSortListener

public final javax.faces.el.MethodBinding getSortListener()

Gets a method reference to a sort listener

Specified by:

getSortListener in class TableBase

setSortListener

public final void setSortListener(javax.faces.el.MethodBinding sortListener)

Sets a method reference to a sort listener

isImmediate

public final boolean isImmediate()

Gets whether or not data validation - client-side or server-side - should take place when events are generated by this component. When immediate is true, the default ActionListener provided by the JavaServer Faces implementation should be executed during Apply Request Values phase of the request processing lifecycle, rather than waiting until the Invoke Application phase.

Specified by:

isImmediate in class TableBase

Returns:

whether the table is immediate

setImmediate

public final void setImmediate(boolean immediate)

Sets whether or not data validation - client-side or server-side - should take place when events are generated by this component. When immediate is true, the default ActionListener provided by the JavaServer Faces implementation should be executed during Apply Request Values phase of the request processing lifecycle, rather than waiting until the Invoke Application phase.

getDisclosureListener

public final javax.faces.el.MethodBinding getDisclosureListener()

Gets a method reference to a disclosure listener

Specified by:

getDisclosureListener in class TableBase

setDisclosureListener

public final void setDisclosureListener(javax.faces.el.MethodBinding disclosureListener)

Sets a method reference to a disclosure listener

getGotoListener

public final javax.faces.el.MethodBinding getGotoListener()

Gets a method reference to a goto listener that will be called when a new range is selected.

Specified by:

getGotoListener in class TableBase

setGotoListener

public final void setGotoListener(javax.faces.el.MethodBinding gotoListener)

Sets a method reference to a goto listener that will be called when a new range is selected.

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXComponentBase