module:baja/nav/NavFileSpace

module:baja/nav/NavFileSpace

new (require("baja/nav/NavFileSpace"))()

Description:

  • The decoded NavFile Space.

Source:
Extends:

Extends

Methods

equals(obj) → {Boolean}

Description:

  • Indicates whether some other object is equal to this one.

Source:
Inherited From:
Parameters:
Name Type Description
obj Object

the reference object with which to compare.
Returns:

true if this object is the same as the obj argument; false otherwise.

Type
Boolean

equivalent(obj) → {Boolean}

Description:

  • 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.

Source:
Inherited From:
Parameters:
Name Type Description
obj
Returns:
Type
Boolean

getAgents(isopt, batchopt) → {Promise}

Description:

  • Returns a promise that resolves to the agent list for this Object.

Source:
Inherited From:
See:
Parameters:
Name Type Attributes Description
is Array.<String> <optional>

An optional array of filters to add to the
agent query.
batch baja.comm.Batch <optional>

An optional object used to batch network
calls together.
Returns:

A promise that will resolve with the Agent Info.

Type
Promise

getIcon() → {baja.Icon}

Description:

  • Return the Object's Icon.

Source:
Inherited From:
Returns:
Type
baja.Icon

getNavChildren()

Description:

  • Access the Nav Children.

Source:
Overrides:
See:

getNavDescription() → {String}

Description:

  • Return the Nav Description.

Source:
Inherited From:
Returns:
Type
String

getNavDisplayName() → {String}

Description:

  • Return the Nav Display Name.

Source:
Overrides:
Returns:
Type
String

getNavIcon() → {baja.Icon}

Description:

  • Return the Nav Icon for this node.

Source:
Inherited From:
Returns:
Type
baja.Icon

getNavName() → {String}

Description:

  • Return the Nav Name.

Source:
Inherited From:
Returns:
Type
String

getNavOrd() → {baja.Ord}

Description:

  • Return the Nav ORD.

Source:
Overrides:
Returns:
Type
baja.Ord

getNavParent() → {baja.NavContainer}

Description:

  • Return the Nav Parent (or null if there's no parent).

Source:
Inherited From:
Returns:
Type
baja.NavContainer

getNavTypeSpec() → {String}

Description:

  • Return the type spec of object this nav node navigates to.

Source:
Inherited From:
Returns:

The nav type spec.

Type
String

getPermissions() → {baja.Permissions}

Source:
Since:
  • Niagara 4.14
Inherited From:
Throws:

if this node is not a BIProtected

Type
Error
Returns:
Type
baja.Permissions

getRootNode()

Description:

  • Return the NavFileRoot.

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

Source:
Returns:

nav file root node (or null if there's no specified NavFile).

getType() → {Type}

Description:

  • Get the type of this instance.

Source:
Inherited From:
Returns:
Type
Type

getTypeDisplayName(cxopt) → {Promise.<string>|string}

Description:

  • Gets the friendly type display name for this object.

Source:
Since:
  • Niagara 4.10
Inherited From:
See:
  • baja.Type#getDisplayName
Parameters:
Name Type Attributes Description
cx Object <optional>

a context to be passed down to Type
Returns:

If no context is provided, the type
display name is returned synchronously as a string. If context provided,
the type display name is resolved via a promise as a string.

Type
Promise.<string> | string

load(obj) → {Promise.<baja.NavNode>}

Description:

  • 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.

Source:
Parameters:
Name Type Description
obj Object

the object literal for the method's arguments.

Properties
Name Type Attributes 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)

Description:

  • Look up the NavNode for the specified Nav ORD.

Source:
Parameters:
Name Type Description
ord String | baja.Ord

the Nav ORD used to look up the Nav ORD.
Returns:

Nav Node

toString(cxopt) → {String|Promise.<String>}

Description:

  • 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 to
      javax.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 in
    Promise.resolve().

Source:
Inherited From:
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
  });
Parameters:
Name Type Attributes Description
cx Object <optional>

optional context information to be used when
formatting the string
Returns:

a string (if no context passed), or
either a string or a Promise (if context passed).

Type
String | Promise.<String>

valueOf() → {*}

Description:

  • Return the inner value of the object.

    By default the object's instance is returned.

Source:
Inherited From:
Returns:

the inner value of the object or just the object's instance.

Type
*