oracle.adf.view.faces.component
Class CollectionBase

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

All Implemented Interfaces:

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

Direct Known Subclasses:

TableBase, TreeBase

public abstract class CollectionBase

extends UIXComponentBase

implements javax.faces.component.NamingContainer

Base class for components that do stamping

Field Summary

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

ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY, TYPE

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

protected

CollectionBase(java.lang.String rendererType)

Method Summary

void	broadcast(javax.faces.event.FacesEvent event) Delivers a wrapped event to the appropriate component.
abstract java.lang.Object	getRowData() Gets the data for the current row.
protected abstract java.lang.String	getRowKey()
abstract java.lang.String	getVar() Gets the EL variable name to use when iterating through the collection's data.
abstract boolean	isRowAvailable() Checks to see if the current row is available.
void	processDecodes(javax.faces.context.FacesContext context) Decodes this component before decoding the facets.
void	processUpdates(javax.faces.context.FacesContext context) Updates this component before updating the facets.
void	processValidators(javax.faces.context.FacesContext context) Validates this component before validating the facets.
void	queueEvent(javax.faces.event.FacesEvent event) Queues an event.
protected abstract void	setRowKey(java.lang.String rowKey)

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

addFacesListener, createFacesBean, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttribute, getAttributes, getBeanType, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getFamily, getId, getIntProperty, getLocalClientId, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreState, saveState, 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

Constructor Detail

CollectionBase

protected CollectionBase(java.lang.String rendererType)

Method Detail

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Queues an event. If there is a currency set on this table, then the event will be wrapped so that when it is finally delivered, the correct currency will be restored.

Overrides:

queueEvent in class UIXComponentBase

Parameters:

event -

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Delivers a wrapped event to the appropriate component. If the event is a special wrapped event, it is unwrapped.

Overrides:

broadcast in class UIXComponentBase

Parameters:

event -

Throws:

javax.faces.event.AbortProcessingException

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)

Decodes this component before decoding the facets. Decodes the children as many times as they are stamped.

Overrides:

processDecodes in class UIXComponentBase

Parameters:

context -

processValidators

public void processValidators(javax.faces.context.FacesContext context)

Validates this component before validating the facets. Validates the children as many times as they are stamped

Overrides:

processValidators in class UIXComponentBase

Parameters:

context -

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)

Updates this component before updating the facets. Updates the children as many times as they are stamped.

Overrides:

processUpdates in class UIXComponentBase

Parameters:

context -

getRowKey

protected abstract java.lang.String getRowKey()

setRowKey

protected abstract void setRowKey(java.lang.String rowKey)

getRowData

public abstract java.lang.Object getRowData()

Gets the data for the current row.

Returns:

null if the current row is unavailable

See Also:

CollectionModel#getRowData

isRowAvailable

public abstract boolean isRowAvailable()

Checks to see if the current row is available. This is useful when the total number of rows is not known.

Returns:

true iff the current row is available.

See Also:

CollectionModel#isRowAvailable

getVar

public abstract java.lang.String getVar()

Gets the EL variable name to use when iterating through the collection's data.