org.apache.myfaces.trinidad.component
Class UIXNavigationHierarchy

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

All Implemented Interfaces:

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

Direct Known Subclasses:

UIXNavigationLevel, UIXNavigationPath, UIXNavigationTree, UIXPage, UIXProcess

public abstract class UIXNavigationHierarchy
extends UIXHierarchy

Base class for the Navigation component.

Work on modeling navigation continues and it is very possible that this class will change in a future release.

Field Summary

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

TYPE, 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

protected	UIXNavigationHierarchy()
protected	UIXNavigationHierarchy(java.lang.String rendererType) Create a Page component with the given render-type

Method Summary

CollectionModel	createCollectionModel(CollectionModel current, java.lang.Object value) Creates the CollectionModel to use with this component.
java.lang.Object	getFocusRowKey() Gets the focus row for the current viewId.
protected MenuModel	getMenuModel() gets the MenuModel that this page is displaying.

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

enterContainer, exitContainer, getAllAncestorContainerRowKeys, getContainerRowKey, getContainerRowKey, getDepth, getDepth, getFirst, getRows, getStamps, getTreeModel, isContainer, isContainerEmpty

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

broadcast, clearCurrencyStringCache, createVarStatusMap, decodeChildrenImpl, encodeBegin, encodeEnd, getClientRowKey, getClientRowKeyManager, getCollectionModel, getCollectionModel, getContainerClientId, getCurrencyString, getRowCount, getRowData, getRowData, getRowIndex, getRowKey, getSortCriteria, getValue, getVar, getVarStatus, invokeOnComponent, isRowAvailable, isRowAvailable, isSortable, postRowDataChange, preRowDataChange, processComponent, processDecodes, processFacetsAndChildren, 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, getBeanType, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getFamily, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, 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

isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

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

Constructor Detail

UIXNavigationHierarchy

protected UIXNavigationHierarchy(java.lang.String rendererType)

Create a Page component with the given render-type

UIXNavigationHierarchy

protected UIXNavigationHierarchy()

Method Detail

createCollectionModel

public CollectionModel createCollectionModel(CollectionModel current,
                                             java.lang.Object value)

Description copied from class: UIXCollection

Creates the CollectionModel to use with this component.

Overrides:

createCollectionModel in class UIXHierarchy

Parameters:

current - the current CollectionModel, or null if there is none.

value - this is the value returned from UIXCollection.getValue()

getMenuModel

protected MenuModel getMenuModel()

gets the MenuModel that this page is displaying.

getFocusRowKey

public java.lang.Object getFocusRowKey()

Gets the focus row for the current viewId.

Specified by:

getFocusRowKey in class UIXHierarchy

Returns:

the focus rowKey for the current viewId

See Also:

MenuModel.getFocusRowKey()