Class baja.ComponentSpace

Extends baja.NavContainer.
Represents a baja:ComponentSpace in BajaScript.
Defined in: comp.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	baja.ComponentSpace(ordInSession, host)

Fields borrowed from class baja.Object:: equivalent, getIcon

Method Summary
Method Attributes	Method Name and Description
<private>	$fw(x, a, b, c) Private framework handler for a Component Space.
<private>	findByHandle(handle) Find the Component via its handle (null if not found).
	getAbsoluteOrd() Return absolute ORD for the Component Space.
<private>	getCallbacks() Return the Space Callbacks.
	getNavChildren(obj) Access the Nav Children.
	getNavIcon() Return the Nav Icon.
<private>	getNavOrd() Return the Nav ORD of the Root Component.
	getOrdInSession() Return the ORD in Session for the Component Space.
	getRootComponent() Return the root Component of the Component Space.
<private>	hasCallbacks() Return true if this Component Space has Space callbacks.
<private>	init() Called to initialize the Component Space.
<private>	resolveByHandle(obj) Find the Component via its handle (null if not found).
	sync(obj) Sync the Component Space.

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

Class Detail

baja.ComponentSpace(ordInSession, host)

Parameters:
{String} ordInSession
host

Method Detail

<private> $fw(x, a, b, c)

Private framework handler for a Component Space.

This is a private internal method for framework developers.

Parameters:
x
a
b
c

<private> findByHandle(handle)

Find the Component via its handle (null if not found).

This method does not result in any network calls.

Parameters:
{String} handle: the Component's handle.

Returns:: the Component via its handle (null if not found).

{baja.Ord} getAbsoluteOrd()

Return absolute ORD for the Component Space.

Returns:: {baja.Ord}

<private> getCallbacks()

Return the Space Callbacks.

Returns:: Space Callbacks

{String} getNavChildren(obj)

Access the Nav Children.

Parameters:
obj

Returns:: {String}

See:: baja.NavContainer#getNavChildren

{baja.Icon} getNavIcon()

Return the Nav Icon.

Returns:: {baja.Icon}

<private> {baja.Ord} getNavOrd()

Return the Nav ORD of the Root Component.

Returns:: {baja.Ord}

{baja.Ord} getOrdInSession()

Return the ORD in Session for the Component Space.

Returns:: {baja.Ord}

getRootComponent()

Return the root Component of the Component Space.

Returns:: the root Component for the Space.

<private> {Boolean} hasCallbacks()

Return true if this Component Space has Space callbacks.

Space callbacks are normally used to make network calls.

Returns:: {Boolean}

<private> init()

Called to initialize the Component Space.

<private> resolveByHandle(obj)

Find the Component via its handle (null if not found).

This method may result in an asynchronous network call if the Component can't be found locally and the Space is a Proxy.

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

Parameters:
{Object} obj Optional: the Object Literal for the method's arguments.
{Function} obj.ok Optional: the ok callback. Called if the Component is resolved. The Component instance will be passed to this function.
{Function} obj.fail Optional: the fail callback. Call if there's an error or the Component can't be resolved.
{baja.comm.Batch} obj.batch Optional: if defined, any network calls will be batched into this object.

sync(obj)

Sync the Component Space.

If the Space is a Proxy, this method will result in an asynchronous network call to sync the master Space with this one.

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

Parameters:
{Object} obj Optional: the Object Literal for the method's arguments.
{Function} obj.ok Optional: the ok callback. Called once the Component Space has been successfully synchronized with the Server.
{Function} obj.fail Optional: the fail callback. Called If the Component Space can't be synchronized.
{baja.comm.Batch} obj.batch Optional: if defined, any network calls will be batched into this object.

Classes

Class baja.ComponentSpace