org.apache.myfaces.trinidad.component
Class UIXProcess
java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXCollection
org.apache.myfaces.trinidad.component.UIXHierarchy
org.apache.myfaces.trinidad.component.UIXNavigationHierarchy
org.apache.myfaces.trinidad.component.UIXProcess
- All Implemented Interfaces:
- NamingContainer, StateHolder, CollectionComponent, LocalRowKeyIndex, RowKeyIndex, TreeLocalRowKeyIndex
- Direct Known Subclasses:
- CoreProcessChoiceBar, CoreTrain
public class UIXProcess
- extends UIXNavigationHierarchy
Signifies an element that represents a process and binds to a menuModel.
Events:
Type |
Phases |
Description |
org.apache.myfaces.trinidad.event.AttributeChangeEvent |
Invoke Application Apply Request Values |
Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing. |
Constructor Summary |
|
UIXProcess()
Construct an instance of the UIXProcess. |
protected |
UIXProcess(String rendererType)
Construct an instance of the UIXProcess. |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXHierarchy |
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, enterContainer, exitContainer, getAllAncestorContainerRowKeys, getContainerRowKey, getContainerRowKey, getDepth, getDepth, getFirst, getRows, getStamps, getTreeModel, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isContainer, isContainerEmpty |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXCollection |
areRowsAvailable, areRowsAvailable, areRowsAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, broadcast, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, createVarStatusMap, decodeChildrenImpl, encodeBegin, encodeEnd, getCachingStrategy, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowCount, getRowData, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getVar, invokeOnComponent, isRowAvailable, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postRowDataChange, preRowDataChange, processComponent, processDecodes, processSaveState, queueEvent, resetStampState, restoreStampState, restoreState, saveStampState, saveState, setClientRowKey, setCurrencyString, setRowIndex, setRowKey, setSortCriteria, setVar, updateChildrenImpl, validateChildrenImpl |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, encodeAll, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, satisfiesPartialTrigger, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, validateChildren |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent |
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree |
Methods inherited from interface org.apache.myfaces.trinidad.model.RowKeyIndex |
areRowsAvailable, areRowsAvailable, areRowsAvailable, getRowCount, getRowData, getRowData, getRowData, getRowIndex, getRowKey, isRowAvailable, isRowAvailable, isRowAvailable, setRowIndex, setRowKey |
Methods inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex |
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearLocalCache, getCachingStrategy, getEstimatedRowCount, getEstimatedRowCountConfidence, isRowLocallyAvailable, isRowLocallyAvailable |
TYPE
public static final FacesBean.Type TYPE
VALUE_KEY
public static final PropertyKey VALUE_KEY
VAR_STATUS_KEY
public static final PropertyKey VAR_STATUS_KEY
NODE_STAMP_FACET
public static final String NODE_STAMP_FACET
- See Also:
- Constant Field Values
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
COMPONENT_TYPE
public static final String COMPONENT_TYPE
- See Also:
- Constant Field Values
UIXProcess
public UIXProcess()
- Construct an instance of the UIXProcess.
UIXProcess
protected UIXProcess(String rendererType)
- Construct an instance of the UIXProcess.
processFacetsAndChildren
protected void processFacetsAndChildren(FacesContext context,
PhaseId phaseId)
- Description copied from class:
UIXCollection
- Process this component's facets and children.
This method should call
UIXCollection.processComponent(javax.faces.context.FacesContext, javax.faces.component.UIComponent, javax.faces.event.PhaseId)
as many times as necessary for each facet and child.
UIXCollection.processComponent(javax.faces.context.FacesContext, javax.faces.component.UIComponent, javax.faces.event.PhaseId)
may be called repeatedly for the same child if that child is
being stamped.
- Specified by:
processFacetsAndChildren
in class UIXCollection
getNodeStamp
public final UIComponent getNodeStamp()
- the component to use to stamp each element in the
process. A CommandNavigationItem is expected.
setNodeStamp
public final void setNodeStamp(UIComponent nodeStampFacet)
- the component to use to stamp each element in the
process. A CommandNavigationItem is expected.
getValue
public final Object getValue()
- Gets the hierarchy of data - must be of type
org.apache.myfaces.trinidad.model.MenuModel
- Specified by:
getValue
in class UIXCollection
- Returns:
- the new value value
setValue
public final void setValue(Object value)
- Sets the hierarchy of data - must be of type
org.apache.myfaces.trinidad.model.MenuModel
- Parameters:
value
- the new value value
getVarStatus
public final String getVarStatus()
- Gets
Name of the EL variable used to reference the varStatus information.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
The VarStatus provides contextual information about the state of the
component to EL expressions. For components that iterate, varStatus
also provides loop counter information. Please see the this
component's documentation for the specific properties on the varStatus.
The common properties on varStatus include:
- "model" - returns the CollectionModel for this component
- "index" - returns the zero based row index
- Specified by:
getVarStatus
in class UIXCollection
- Returns:
- the new varStatus value
- See Also:
UIXCollection.createVarStatusMap()
setVarStatus
public final void setVarStatus(String varStatus)
- Sets
Name of the EL variable used to reference the varStatus information.
Once this component has completed rendering, this variable is
removed (or reverted back to its previous value).
The VarStatus provides contextual information about the state of the
component to EL expressions. For components that iterate, varStatus
also provides loop counter information. Please see the this
component's documentation for the specific properties on the varStatus.
The common properties on varStatus include:
- "model" - returns the CollectionModel for this component
- "index" - returns the zero based row index
- Parameters:
varStatus
- the new varStatus value
getFamily
public String getFamily()
- Specified by:
getFamily
in class UIXComponentBase
getBeanType
protected FacesBean.Type getBeanType()
- Overrides:
getBeanType
in class UIXComponentBase
Copyright © 2001-2010 The Apache Software Foundation. All Rights Reserved.