Class baja.NavContainer
Extends
baja.Object.
NavContainer is a generic NavNode.
Defined in: nav.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
- Fields borrowed from class baja.Object:
- equivalent, getIcon
| Method Attributes | Method Name and Description |
|---|---|
| <private> |
$addChildNode(node)
Add a child node to this container.
|
|
getNavChildren(obj)
Access the Nav Children.
|
|
|
Return the Nav Description.
|
|
|
Return the Nav Display Name.
|
|
|
Return the Nav Icon for this node.
|
|
|
Return the Nav Name.
|
|
|
Return the Nav ORD.
|
|
|
Return the Nav Parent (or null if there's no parent).
|
Method Detail
<private>
$addChildNode(node)
Add a child node to this container.
Please note, this is a private method and should only be used by Tridium developers.
- Parameters:
- node
- Returns:
- node
{Array}
getNavChildren(obj)
Access the Nav Children.
This method takes an Object Literal the method arguments or an ok function.
container.getNavChildren(function (kids) {
// Process children
});
// or...
container.getNavChildren({
ok: function (kids) {
// Process children
},
fail: function (err) {
baja.error(err);
}
});
- Parameters:
- {Object} obj
- the Object Literal for the method's arguments.
- {Function} obj.ok
- called when we have the Nav Children. An array of Nav Children is is passed as an argument into this function.
- {Function} obj.fail Optional
- called if the function fails to complete.
- Returns:
- {Array}
{String}
getNavDescription()
Return the Nav Description.
- Returns:
- {String}
{String}
getNavDisplayName()
Return the Nav Display Name.
- Returns:
- {String}
{baja.Icon}
getNavIcon()
Return the Nav Icon for this node.
- Returns:
- {baja.Icon}
{String}
getNavName()
Return the Nav Name.
- Returns:
- {String}
{baja.Ord}
getNavOrd()
Return the Nav ORD.
- Returns:
- {baja.Ord}
getNavParent()
Return the Nav Parent (or null if there's no parent).
- Returns:
- nav parent