Skip navigation links

org.apache.myfaces.trinidad.component
Class UIXNavigationPath

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.UIXNavigationPath

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder, CollectionComponent, LocalRowKeyIndex, RowKeyIndex, TreeLocalRowKeyIndex

Direct Known Subclasses:

CoreBreadCrumbs

public class UIXNavigationPath

extends UIXNavigationHierarchy

implements javax.faces.component.NamingContainer

A navigationPath component is used in hierarchical site layouts to indicate the path back to the root page of the hierarchy with links.

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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex

LocalRowKeyIndex.Confidence, LocalRowKeyIndex.LocalCachingStrategy

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static java.lang.String	NODE_STAMP_FACET
static FacesBean.Type	TYPE
static PropertyKey	VALUE_KEY
static PropertyKey	VAR_STATUS_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXCollection

VAR_KEY

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

	UIXNavigationPath() Construct an instance of the UIXNavigationPath.
protected	UIXNavigationPath(java.lang.String rendererType) Construct an instance of the UIXNavigationPath.

Method Summary

protected FacesBean.Type	getBeanType()
java.lang.String	getFamily()
javax.faces.component.UIComponent	getNodeStamp() the component to use to stamp each element in the navigation.
java.lang.Object	getValue() Gets the hierarchy of navigation data - must be of type org.apache.myfaces.trinidad.model.MenuModel
java.lang.String	getVarStatus() Gets Name of the EL variable used to reference the varStatus information.
protected void	processFacetsAndChildren(javax.faces.context.FacesContext context, javax.faces.event.PhaseId phaseId) Process this component's facets and children.
void	setNodeStamp(javax.faces.component.UIComponent nodeStampFacet) the component to use to stamp each element in the navigation.
void	setValue(java.lang.Object value) Sets the hierarchy of navigation data - must be of type org.apache.myfaces.trinidad.model.MenuModel
void	setVarStatus(java.lang.String varStatus) Sets Name of the EL variable used to reference the varStatus information.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXNavigationHierarchy

createCollectionModel, getFocusRowKey, getMenuModel

Methods inherited from class org.apache.myfaces.trinidad.component.UIXHierarchy

areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, createVarStatusMap, 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

areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, broadcast, clearCachedRow, clearCachedRow, clearCachedRows, clearCachedRows, clearCurrencyStringCache, clearLocalCache, decodeChildrenImpl, encodeBegin, encodeEnd, ensureRowsAvailable, getCachingStrategy, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getEstimatedRowCount, getEstimatedRowCountConfidence, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getVar, invokeOnComponent, isRowAvailable, isRowAvailable, isRowLocallyAvailable, isRowLocallyAvailable, isSortable, postCreateCollectionModel, 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, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeComponentChangeFilter, 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, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.myfaces.trinidad.component.CollectionComponent

getVar

Methods inherited from interface org.apache.myfaces.trinidad.model.RowKeyIndex

getRowCount, getRowData, getRowData, getRowIndex, getRowKey, 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

Field Detail

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 java.lang.String NODE_STAMP_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

UIXNavigationPath

public UIXNavigationPath()

Construct an instance of the UIXNavigationPath.

UIXNavigationPath

protected UIXNavigationPath(java.lang.String rendererType)

Construct an instance of the UIXNavigationPath.

Method Detail

processFacetsAndChildren

protected void processFacetsAndChildren(javax.faces.context.FacesContext context,
                                        javax.faces.event.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 javax.faces.component.UIComponent getNodeStamp()

the component to use to stamp each element in the navigation. A CommandNavigationItem is expected.

setNodeStamp

public final void setNodeStamp(javax.faces.component.UIComponent nodeStampFacet)

the component to use to stamp each element in the navigation. A CommandNavigationItem is expected.

getValue

public final java.lang.Object getValue()

Gets the hierarchy of navigation 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(java.lang.Object value)

Sets the hierarchy of navigation data - must be of type org.apache.myfaces.trinidad.model.MenuModel

Parameters:

value - the new value value

getVarStatus

public final java.lang.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(java.lang.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 java.lang.String getFamily()

Specified by:

getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXComponentBase

Skip navigation links