Defines NavFileSpace
(not exposed on baja
namespace).
new (require("baja/nav/NavFileSpace"))()
The decoded NavFile Space.
Extends:
Methods
-
equals(obj)
-
Indicates whether some other object is equal to this one.
Parameters:
Name Type Description obj
Object the reference object with which to compare.
- Inherited From:
Returns:
true if this object is the same as the obj argument; false otherwise.
- Type
- Boolean
-
equivalent(obj)
-
Equivalence test.
equivalent()
is used to compare if two Objects have equivalent
state, but might not want to return true for equals since it
it has implied semantics for many operations. The default
implementation returns the result of baja.Object#equals.Parameters:
Name Type Description obj
- Inherited From:
Returns:
- Type
- Boolean
-
getAgents( [is], batch)
-
Returns a promise that resolves to the agent list for this Object.
Parameters:
Name Type Argument Description is
Array.<String> <optional>
An optional array of filters to add to the
agent query.batch
baja.comm.Batch An optional object used to batch network
calls together.- Inherited From:
- See:
Returns:
A promise that will resolve with the Agent Info.
- Type
- Promise
-
getIcon()
-
Return the Object's Icon.
- Inherited From:
Returns:
- Type
- baja.Icon
-
getNavChildren()
-
Access the Nav Children.
- Overrides:
- See:
-
getNavDescription()
-
Return the Nav Description.
- Inherited From:
Returns:
- Type
- String
-
getNavDisplayName()
-
Return the Nav Display Name.
- Overrides:
Returns:
- Type
- String
-
getNavIcon()
-
Return the Nav Icon for this node.
- Inherited From:
Returns:
- Type
- baja.Icon
-
getNavName()
-
Return the Nav Name.
- Inherited From:
Returns:
- Type
- String
-
getNavOrd()
-
Return the Nav ORD.
- Overrides:
Returns:
- Type
- baja.Ord
-
getNavParent()
-
Return the Nav Parent (or null if there's no parent).
- Inherited From:
Returns:
- Type
- baja.NavContainer
-
getNavTypeSpec()
-
Return the type spec of object this nav node navigates too.
- Inherited From:
Returns:
The nav type spec.
- Type
- String
-
getRootNode()
-
Return the NavFileRoot.
If there's no NavFile specified for the user or the space is unloaded, this will return null.
Returns:
nav file root node (or null if there's no specified NavFile).
-
getType()
-
Get the type of this instance.
- Inherited From:
Returns:
- Type
- Type
-
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:
Name Type Description obj
Object the object literal for the method's arguments.
Properties
Name Type Argument Description ok
function <optional>
(Deprecated: use Promise) called once the
NavFile has been loaded. The Nav Root Node will be passed to this function
when invoked.fail
function <optional>
(Deprecated: use Promise) called if any errors
occur.batch
baja.comm.Batch <optional>
if specified, this will batch any
network calls.Returns:
a promise that will be resolved once the
root nav file node has been retrieved.- Type
- Promise.<baja.NavNode>
-
lookup(ord)
-
Look up the NavNode for the specified Nav ORD.
Parameters:
Name Type Description ord
String | baja.Ord the Nav ORD used to look up the Nav ORD.
Returns:
Nav Node
-
toString( [cx])
-
Returns the String representation of this Object.
When implementing
toString()
on one of your own Objects, it should
adhere to the following contract.- When called with no arguments, it must return a string directly.
- It can also be called with an object literal. In this case, it may
return a Promise to be resolved with a string, or it may return a string
directly as normal. This case is sort of analogous tojavax.baja.sys.Localizable#toString(Context)
.
Therefore, when calling
toString()
on an Object of unknown Type using an
object literal as an argument, it's important to wrap the call inPromise.resolve()
.Parameters:
Name Type Argument Description cx
Object <optional>
optional context information to be used when
formatting the string- Inherited From:
Returns:
a string (if no context passed), or
either a string or a Promise (if context passed).Examples
When no context is passed, toString() must always return a string directly.
var bool = comp.get('boolean'); baja.outln(bool.toString()); // 'false'
When a context is passed, some Objects may return a Promise.
var bool = comp.get('boolean'); bool.toString({ trueText: 'Yes', falseText: 'No' }) .then(function (str) { baja.outln(str); // 'No' });
If you don't know the type of the Object, use Promise.resolve() for safety.
var displayFacets = comp.get('displayFacets'), value = comp.get('value'); Promise.resolve(value.toString(displayFacets.toObject())) .then(function (str) { baja.outln(str); // formatted according to displayFacets });
-
valueOf()
-
Return the inner value of the object.
By default the object's instance is returned.
- Inherited From:
Returns:
the inner value of the object or just the object's instance.
- Type
- *