The NavigationNode object represents a node in the navigation tree. This object is received as a parameter or returned by most of the Navigation API methods.
The following table lists properties and methods of the NavigationNode object:
Property/Method |
Description |
---|---|
getTitle |
Returns the node title (display name) |
getNodeURI |
Returns the node URI |
getName |
Returns the node name (ID) |
getType |
Returns the node type: 0: iView 1: page 2: folder |
getShowType |
Returns the node display mode: 0: in place 1: in a new standalone window 2: in a new portal window 3: in a new headerless window 6: hidden mode (the window is hidden, only its content is displayed) |
getWinFeatures |
Returns the new window attributes, such as width or height |
getParent |
Returns the parent node of the node |
isFirstLevel |
Returns true if this is a first level node |
getCollections |
Returns navigation collections related to the node, such as related services, related links or common tasks |
hasChildren |
Returns true if the node has child nodes |
getChildren |
Returns an array of child nodes (NavigationNode objects) |
getAttributeValue |
Returns the value of an attribute by its key |
getAttribute |
Returns the attribute object by its key |
setAttributeValue |
Sets the value of an attribute by its key |
getAttributes |
Returns all attributes of the node |
getExpireTime |
Returns the expiration time of the node |