|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.model.DataModel
org.apache.myfaces.trinidad.model.CollectionModel
org.apache.myfaces.trinidad.model.TreeModel
org.apache.myfaces.trinidad.model.MenuModel
org.apache.myfaces.trinidad.model.BaseMenuModel
org.apache.myfaces.trinidad.model.ViewIdPropertyMenuModel
public class ViewIdPropertyMenuModel
Creates a MenuModel from a TreeModel where nodes in the treeModel contain viewId information.
Each node must have either a bean getter method or a Map property that returns a viewId. There are several restrictions on the data:
Assuming that NavigationTree is a tree of beans with a vieId getter, an example of creating a MenuModel with this class might look like:
CollectionModel collectionModel = ModelUtils.toCollectionModel(new NavigationTree());
TreeModel treeModel = new ChildPropertyTreeModel(collectionModel, "children");
MenuModel menuModel = new ViewIdPropertyMenuModel(treeModel, "viewId");
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.apache.myfaces.trinidad.model.LocalRowKeyIndex |
---|
LocalRowKeyIndex.Confidence, LocalRowKeyIndex.LocalCachingStrategy |
Constructor Summary | |
---|---|
ViewIdPropertyMenuModel()
No-arg constructor for use with managed-beans. |
|
ViewIdPropertyMenuModel(Object instance,
String viewIdProperty)
|
Method Summary | |
---|---|
void |
addViewId(String newViewId,
String aliasedViewId)
Maps the focusPath returned when the viewId is newViewId to the focusPath returned when the viewId is aliasedViewId. |
protected String |
getCurrentViewId()
Returns the current viewId. |
Object |
getFocusRowKey()
Returns the rowKey to the current viewId. |
String |
getViewIdProperty()
Gets the property to use to retrieve a viewId from a node in the tree |
void |
setViewIdProperty(String viewIdProperty)
Sets the property to use to retrieve a viewId from a node in the tree |
void |
setWrappedData(Object data)
|
Methods inherited from class org.apache.myfaces.trinidad.model.BaseMenuModel |
---|
enterContainer, exitContainer, getContainerRowKey, getRowCount, getRowData, getRowIndex, getRowKey, getWrappedData, isContainer, isRowAvailable, setRowIndex, setRowKey |
Methods inherited from class org.apache.myfaces.trinidad.model.TreeModel |
---|
areRowsLocallyAvailable, areRowsLocallyAvailable, areRowsLocallyAvailable, getAllAncestorContainerRowKeys, getContainerRowKey, getDepth, getDepth, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isChildCollectionLocallyAvailable, isContainerEmpty |
Methods inherited from class javax.faces.model.DataModel |
---|
addDataModelListener, getDataModelListeners, iterator, removeDataModelListener |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ViewIdPropertyMenuModel()
setViewIdProperty(java.lang.String)
and
setWrappedData(java.lang.Object)
methods after constructing this instance.
public ViewIdPropertyMenuModel(Object instance, String viewIdProperty) throws IntrospectionException
instance
- a treeModel. This object will be passed to
ModelUtils.toTreeModel(java.lang.Object)
viewIdProperty
- the property to use to retrieve a viewId
from a node in the tree
IntrospectionException
Method Detail |
---|
public void setWrappedData(Object data)
setWrappedData
in class BaseMenuModel
public Object getFocusRowKey()
The getFocusRowKey method
getFocusRowKey
in class MenuModel
public void addViewId(String newViewId, String aliasedViewId)
newViewId
- the view id to add a focus path foraliasedViewId
- the view id to use to get the focusPath to use for newViewIdpublic String getViewIdProperty()
public void setViewIdProperty(String viewIdProperty)
protected String getCurrentViewId()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |