Class NavFileSpace

Extends baja.NavContainer.
The decoded NavFile Space.
Defined in: nav.js.

Class Summary
Constructor Attributes	Constructor Name and Description
<inner>	NavFileSpace()

Method Summary
Method Attributes	Method Name and Description
	getNavChildren(obj) Access the Nav Children.
	getNavDisplayName() Return the Nav Display Name.
	getNavOrd() Return the Nav ORD.
	getRootNode() Return the NavFileRoot.
	load(obj) If the NavFile isn't already loaded, make a network call to load the NavFile across the network.
	lookup(the) Look up the NavNode for the specified Nav ORD.

Methods borrowed from class baja.NavContainer:: $addChildNode, getNavDescription, getNavIcon, getNavName, getNavParent

Class Detail

<inner> NavFileSpace()

Method Detail

getNavChildren(obj)

Access the Nav Children.

{String} getNavDisplayName()

Return the Nav Display Name.

{baja.Ord} getNavOrd()

Return the Nav ORD.

getRootNode()

Return the NavFileRoot.

If there's no NavFile specified for the user, this will return null.

load(obj)

If the NavFile isn't already loaded, make a network call to load the NavFile across the network.

An Object Literal is used for the method's arguments.

Parameters:
{Object} obj: the Object Literal for the method's arguments.
{Function} obj.ok: called once the NavFile has been loaded. The Nav Root Node will be passed to this function when invoked.
{Function} obj.fail Optional: called if any errors occur.
{baja.comm.Batch} obj.batch Optional: if specified, this will batch any network calls.

lookup(the)

Look up the NavNode for the specified Nav ORD.

Classes