public interface NavigationModel
#{navigationContext.defaultNavigationModel}
#{navigationContext.currentNavigationModel}
#{navigationContext.navigationModel['/oracle/webcenter/portalapp/navigations/default-navigation-model']}
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
MODEL_TYPE_LIST
Parameter value to use to return a List of
NavigationResource object |
static java.lang.String |
MODEL_TYPE_MENU
Parameter value to use to return a
ChildPropertyMenuModel object |
static java.lang.String |
MODEL_TYPE_TREE
Parameter value to use to return a
ChildPropertyTreeModel object |
static java.lang.String |
PARAM_EL_DEPTH
Parameter that defines the initial depth of fetching
EL: #{navigationContext.defaultNavigationModel.treeModel['depth=1']} |
static java.lang.String |
PARAM_EL_INCLUDE_START_NODE
Parameter that defines whether to include the starting node
EL: #{navigationContext.defaultNavigationModel.treeModel['includeStartNode=true']} |
static java.lang.String |
PARAM_EL_MODEL_TYPE
Parameter that defines the type of collection you want back as defined by
MODEL_TYPE_* constants. |
static java.lang.String |
PARAM_EL_PREFETCH_ONLY
Parameter that defines whether to return nodes up to the depth level requested initially
EL: #{navigationContext.defaultNavigationModel.treeModel['prefetchOnly=false']} |
static java.lang.String |
PARAM_EL_START_NODE
Parameter that defines the path of the starting node
EL: #{navigationContext.defaultNavigationModel.treeModel['startNode=home']} |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
evalParamExpr(java.util.Map params) |
java.util.Map<java.lang.String,java.lang.String> |
getAttributes()
Returns a mutable Map of all the NavigationModel attributes
EL: #{navigationContext.defaultNavigationModel.attributes['Description']} |
NavigationResource |
getCurrentSelection()
Returns the currently selected NavigationResource
EL: #{navigationContext.defaultNavigationModel.currentSelection} |
java.lang.Object |
getDataModel(java.util.Map params)
Returns a collection object representing the navigation based on the
Map of parameters passed in.
|
java.util.List<NavigationResource> |
getDefaultListModel()
Returns a List with default settings for the navigation model
EL: #{navigationContext.defaultNavigationModel.defaultListModel} |
org.apache.myfaces.trinidad.model.MenuModel |
getDefaultMenuModel()
Returns a MenuModel with default settings for the navigation model
EL: #{navigationContext.defaultNavigationModel.defaultMenuModel} |
java.lang.String |
getDefaultSiteMap()
Returns SiteMap XML based on the default settings.
|
org.apache.myfaces.trinidad.model.TreeModel |
getDefaultTreeModel()
Returns a TreeModel with default settings for the navigation model
EL: #{navigationContext.defaultNavigationModel.defaultTreeModel} |
java.lang.String |
getMetadataId()
Returns the id of the NavigationModel object
|
java.lang.String |
getMetadataScope()
Returns the scope of the NavigationModel object
|
java.util.Map<java.lang.String,java.lang.Object> |
getProperties()
Returns an immutable Map of all the NavigationModel default properties
EL: #{navigationContext.defaultNavigationModel.properties['rootNode']} |
java.util.Map<java.lang.String,java.lang.Object> |
getProperties(java.lang.String propertyNames)
Returns an immutable Map of the NavigationModel properties with names specified in the parameter (in a comma-separated format)
|
NavigationResource |
getResource(java.lang.String resourceId)
Returns the NavigationResource identified by the resource id.
|
java.util.List<NavigationResource> |
getResources(PredicateFilter pFilter,
java.lang.String startNode)
Returns a flattened List of NavigationResource identified by the startNode path
and Filter class.
|
NavigationResource |
getRootNode()
Returns the root node of the NavigationModel
EL: #{navigationContext.defaultNavigationModel.rootNode} |
void |
invalidateCache()
Invalidates the cache maintains by the NavigationModel object
|
void |
setCurrentSelection(NavigationResource navResource)
Set the NavigationResource as the current selection
|
void |
setNewCurrentSelection(java.lang.String nodePath)
Update the current selection given the node path
|
static final java.lang.String PARAM_EL_START_NODE
#{navigationContext.defaultNavigationModel.treeModel['startNode=home']}
This parameter can be used in combination with other parameters. When used in an EL, comma-separate each parameter.
For example, #{navigationContext.defaultNavigationModel.treeModel['startNode=home,includeStartNode=true']}
static final java.lang.String PARAM_EL_INCLUDE_START_NODE
#{navigationContext.defaultNavigationModel.treeModel['includeStartNode=true']}
If true
, include the starting node, otherwise start from its children.
This parameter can be used in combination with other parameters. When used in an EL, comma-separate each parameter.
For example, #{navigationContext.defaultNavigationModel.treeModel['startNode=home,includeStartNode=true']}
static final java.lang.String PARAM_EL_DEPTH
#{navigationContext.defaultNavigationModel.treeModel['depth=1']}
depth=0 means to fetch the entire tree.
This parameter can be used in combination with other parameters. When used in an EL, comma-separate each parameter.
For example, #{navigationContext.defaultNavigationModel.treeModel['startNode=home,includeStartNode=true']}
static final java.lang.String PARAM_EL_PREFETCH_ONLY
#{navigationContext.defaultNavigationModel.treeModel['prefetchOnly=false']}
If true
, deeper level nodes can be returned on demand.
Use false
if you only want the initial sets of nodes.
In which case, it doesn't return deeper nodes later on when requested even when there are deeper nodes
This parameter can be used in combination with other parameters. When used in an EL, comma-separate each parameter.
For example, #{navigationContext.defaultNavigationModel.treeModel['startNode=home,includeStartNode=true']}
static final java.lang.String PARAM_EL_MODEL_TYPE
MODEL_TYPE_*
constants.
This parameter can be used in combination with other parameters. When used in an EL, comma-separate each parameter.
For example, #{navigationContext.defaultNavigationModel.treeModel['startNode=home,includeStartNode=true']}
static final java.lang.String MODEL_TYPE_LIST
NavigationResource
objectPARAM_EL_MODEL_TYPE
,
Constant Field Valuesstatic final java.lang.String MODEL_TYPE_TREE
ChildPropertyTreeModel
objectPARAM_EL_MODEL_TYPE
,
Constant Field Valuesstatic final java.lang.String MODEL_TYPE_MENU
ChildPropertyMenuModel
objectPARAM_EL_MODEL_TYPE
,
Constant Field Valuesjava.lang.String getMetadataScope()
java.lang.String getMetadataId()
void invalidateCache()
NavigationResource getResource(java.lang.String resourceId) throws ResourceNotFoundException
resourceId
- the resource id can be id-driven path or title-driven pathResourceNotFoundException
- if no resource matches the resourceIdjava.util.List<NavigationResource> getResources(PredicateFilter pFilter, java.lang.String startNode) throws ResourceNotFoundException
pFilter
- the PredicateFilter interface which will be applied to the resourcestartNode
- the starting node where we'll get all resources, if NULL will default to root node "/"
startNode can be "id" driven or "title" driven.ResourceNotFoundException
NavigationResource getRootNode()
#{navigationContext.defaultNavigationModel.rootNode}
java.util.Map<java.lang.String,java.lang.String> getAttributes()
#{navigationContext.defaultNavigationModel.attributes['Description']}
The returned Map implements the entire contract for a modifiable map as described in java.util.Map
.
These includes put() (to create/update), get() (to read) and, remove() (to delete).
java.util.Map<java.lang.String,java.lang.Object> getProperties()
#{navigationContext.defaultNavigationModel.properties['rootNode']}
java.util.Map<java.lang.String,java.lang.Object> getProperties(java.lang.String propertyNames)
void setCurrentSelection(NavigationResource navResource)
navResource
- NavigationResource getCurrentSelection()
#{navigationContext.defaultNavigationModel.currentSelection}
java.lang.Object evalParamExpr(java.util.Map params)
java.lang.Object getDataModel(java.util.Map params)
PARAM_EL_*
constantsorg.apache.myfaces.trinidad.model.TreeModel getDefaultTreeModel()
#{navigationContext.defaultNavigationModel.defaultTreeModel}
The default settings are: startPath = / includeStartNode = true depth = 0 (return whole depth)
org.apache.myfaces.trinidad.model.MenuModel getDefaultMenuModel()
#{navigationContext.defaultNavigationModel.defaultMenuModel}
The default settings are: startPath = / includeStartNode = true depth = 0 (return whole depth)
java.util.List<NavigationResource> getDefaultListModel()
#{navigationContext.defaultNavigationModel.defaultListModel}
The default settings are: startPath = / includeStartNode = true depth = 0 (return whole depth)
java.lang.String getDefaultSiteMap()
The default settings are:
startPath = /
includeStartNode = true
EL: #{navigationContext.defaultNavigationModel.defaultSiteMap}
void setNewCurrentSelection(java.lang.String nodePath)
nodePath
- node path to the selected resource