|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.4.0) E15995-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface NavigationResource
Used to access the navigation resource metadata. The object implementing this interface is EL accessible as:
#{navigationContext.defaultNavigationModel.currentSelection}
#{navigationContext.currentNavigationModel.currentSelection}
#{navigationContext.navigationModel['modelPath=/oracle/webcenter/portalapp/navigations/default-navigation-model'].currentSelection}
Nested Class Summary | |
---|---|
static class |
NavigationResource.ResourceType Enumeration of type of resource |
Method Summary | |
---|---|
java.util.List<NavigationResource> |
getAncestors() Returns the hierarchy list of ancestors of this node (of type NavigationResource) starting with the root node. EL: #{navigationContext.defaultNavigationModel.currentSelection.ancestors} |
java.util.Map<java.lang.String,java.lang.Object> |
getAttributes() Returns a mutable Map of all the resource attributes EL: #{navigationContext.defaultNavigationModel.currentSelection.attributes['Description']} |
NavigationResource |
getChildByTitle(java.lang.String title) Gets the child by title |
int |
getChildCount() Returns the number of children of this node EL: #{navigationContext.defaultNavigationModel.currentSelection.childCount |
java.util.List<NavigationResource> |
getChildren() Returns the List of children of this resource EL: #{navigationContext.defaultNavigationModel.currentSelection.children} EL: #{navigationContext.defaultNavigationModel.currentSelection.children[0]} |
int |
getDepth() Returns the depth of this node from the root node. |
java.lang.String |
getExternalURL() Returns the URL for the navigation resource of type External Link |
java.lang.String |
getGoLinkPrettyUrl() Returns the URL for goLink destination EL: #{navigationContext.defaultNavigationModel.currentSelection.goLinkPrettyUrl} |
int |
getIndex() Returns the zero-relative index of this node relative to its siblings EL: #{navigationContext.defaultNavigationModel.currentSelection.index |
NavigationModel |
getNavigationModel() Returns the NavigationModel of this resource |
NavigationResource |
getNextSibling() Returns the next sibling in the list (of type NavigationResource) of this node EL: #{navigationContext.defaultNavigationModel.currentSelection.nextSibling |
java.util.Map<java.lang.String,java.lang.String> |
getParameters() Returns a mutable Map of all the resource parameters EL: #{navigationContext.defaultNavigationModel.currentSelection.parameters['StockSymbol']} |
java.util.Map<java.lang.String,java.lang.String> |
getParametersRaw() Returns a mutable Map of all the resource parameters with raw value EL: #{navigationContext.defaultNavigationModel.currentSelection.parametersRaw['StockSymbol']} |
NavigationResource |
getParent() Returns the parent of this this resource EL: #{navigationContext.defaultNavigationModel.currentSelection.parent} |
java.lang.String |
getPath() Returns the path of the resource EL: #{navigationContext.defaultNavigationModel.currentSelection.path} |
java.lang.String |
getPrettyUrl() Returns the PrettyURL of the resource EL: #{navigationContext.defaultNavigationModel.currentSelection.prettyUrl} |
java.util.List<java.lang.String> |
getPrettyUrlPath() Returns a Collection of identifying paths by depth so it can be used as a starting path to drive another navigation view EL: #{navigationContext.defaultNavigationModel.currentSelection.prettyUrlPath} EL: #{navigationContext.defaultNavigationModel.currentSelection.prettyUrlPath[3]} |
NavigationResource |
getPreviousSibling() Returns the previous sibling in the list (of type NavigationResource) of this node EL: #{navigationContext.defaultNavigationModel.currentSelection.previousSibling |
java.util.List<NavigationResource> |
getSiblings() Returns the List of siblings (of type NavigationResource) of this node (inclusive) EL: #{navigationContext.defaultNavigationModel.currentSelection.siblings |
java.lang.String |
getTitle() Returns the title of the resource EL: #{navigationContext.defaultNavigationModel.currentSelection.title} |
java.awt.datatransfer.Transferable |
getTransferable() Returns the Transferable for this resource |
java.lang.Object |
getTransferData(java.awt.datatransfer.DataFlavor dataFlavor) Returns the transfer data for the specified dataFlavor |
NavigationResource.ResourceType |
getType() Returns the type of the resource. |
boolean |
isCurrentlySelected() Returns whether the resource is the currently selected resource and the model is the currently selected model EL: #{navigationContext.defaultNavigationModel.currentSelection.currentlySelected} |
boolean |
isLeaf() Returns whether this resource is a leaf node EL: #{navigationContext.defaultNavigationModel.currentSelection.leaf} |
boolean |
isNavigable() Returns whether the resource can be navigated to EL: #{navigationContext.defaultNavigationModel.currentSelection.navigable} |
boolean |
isOnSelectedPath() Returns whether this node lies on the selected path EL: #{navigationContext.defaultNavigationModel.currentSelection.onSelectedPath} |
boolean |
isSelected() Returns whether the resource is the currently selected resource EL: #{navigationContext.defaultNavigationModel.currentSelection.selected} |
boolean |
isSeparator() Returns whether the resource is a separator EL: #{navigationContext.defaultNavigationModel.currentSelection.separator} |
void |
setChildren(java.util.List<NavigationResource> children) Sets the children of this resource |
Method Detail |
---|
NavigationResource.ResourceType getType()
NavigationResource.ResourceType
boolean isSeparator()
#{navigationContext.defaultNavigationModel.currentSelection.separator}
true
if the resource is separator; false
otherwise.java.lang.String getTitle()
#{navigationContext.defaultNavigationModel.currentSelection.title}
java.lang.String getPath()
#{navigationContext.defaultNavigationModel.currentSelection.path}
java.lang.String getPrettyUrl()
#{navigationContext.defaultNavigationModel.currentSelection.prettyUrl}
java.util.List<java.lang.String> getPrettyUrlPath()
#{navigationContext.defaultNavigationModel.currentSelection.prettyUrlPath}
#{navigationContext.defaultNavigationModel.currentSelection.prettyUrlPath[3]}
For example, assuming the currentSelection is "home/company/products/applications", the following EL: #{..currentSelection.prettyUrlPath[3]} would return "home/company/products"
java.util.Map<java.lang.String,java.lang.Object> getAttributes()
#{navigationContext.defaultNavigationModel.currentSelection.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.String> getParameters()
#{navigationContext.defaultNavigationModel.currentSelection.parameters['StockSymbol']}
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.String> getParametersRaw()
#{navigationContext.defaultNavigationModel.currentSelection.parametersRaw['StockSymbol']}
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).
NavigationResource getChildByTitle(java.lang.String title)
title
-java.util.List<NavigationResource> getChildren()
#{navigationContext.defaultNavigationModel.currentSelection.children}
#{navigationContext.defaultNavigationModel.currentSelection.children[0]}
void setChildren(java.util.List<NavigationResource> children)
children
- the List of children to setNavigationResource getParent()
#{navigationContext.defaultNavigationModel.currentSelection.parent}
java.util.List<NavigationResource> getAncestors()
#{navigationContext.defaultNavigationModel.currentSelection.ancestors}
Eg: assuming the current node is "home/company/products/applications", the following EL: #{node.ancestors[1]} would return the node for "home" #{node.ancestors[3]} would return the node for "home/company/products"
int getDepth()
#{navigationContext.defaultNavigationModel.currentSelection.depth}
java.util.List<NavigationResource> getSiblings()
#{navigationContext.defaultNavigationModel.currentSelection.siblings
NavigationResource getNextSibling()
#{navigationContext.defaultNavigationModel.currentSelection.nextSibling
NavigationResource getPreviousSibling()
#{navigationContext.defaultNavigationModel.currentSelection.previousSibling
int getIndex()
#{navigationContext.defaultNavigationModel.currentSelection.index
boolean isLeaf()
#{navigationContext.defaultNavigationModel.currentSelection.leaf}
true
if the resource is a leaf node; false
otherwise.boolean isOnSelectedPath()
#{navigationContext.defaultNavigationModel.currentSelection.onSelectedPath}
true
if the resource lies on the selected path; false
otherwise.int getChildCount()
#{navigationContext.defaultNavigationModel.currentSelection.childCount
boolean isNavigable()
#{navigationContext.defaultNavigationModel.currentSelection.navigable}
true
if the resource can be navigated to; false
otherwise.boolean isSelected()
#{navigationContext.defaultNavigationModel.currentSelection.selected}
true
if the resource is currently selected; false
otherwise.boolean isCurrentlySelected()
#{navigationContext.defaultNavigationModel.currentSelection.currentlySelected}
true
if the resource and model are currently selected; false
otherwise.java.awt.datatransfer.Transferable getTransferable()
java.lang.Object getTransferData(java.awt.datatransfer.DataFlavor dataFlavor)
dataFlavor
-java.lang.String getExternalURL()
NavigationModel getNavigationModel()
java.lang.String getGoLinkPrettyUrl()
#{navigationContext.defaultNavigationModel.currentSelection.goLinkPrettyUrl}
|
Oracle Fusion Middleware Java API Reference for Oracle WebCenter 11g Release 1 (11.1.1.4.0) E15995-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |