Class Index | File Index

Classes


Class baja.BoxComponentSpace


Extends baja.ComponentSpace.
BOX Component Space.

A BOX Component Space is a Proxy Component Space that's linked to another Component Space in another host elsewhere.
Defined in: boxcs.js.

Class Summary
Constructor Attributes Constructor Name and Description
<private>  
baja.BoxComponentSpace(name, 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>  
init(batch)
Call to initialize a Component Space.
<private>  
Find the Component via its handle (null if not found).
<private>  
sync(obj)
Sync the Component Space.
Methods borrowed from class baja.ComponentSpace:
findByHandle, getAbsoluteOrd, getCallbacks, getNavChildren, getNavIcon, getNavOrd, getOrdInSession, getRootComponent, hasCallbacks
Methods borrowed from class baja.NavContainer:
$addChildNode, getNavDescription, getNavDisplayName, getNavName, getNavParent
Class Detail
<private> baja.BoxComponentSpace(name, ordInSession, host)
Parameters:
{String} name
{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> init(batch)
Call to initialize a Component Space.
Parameters:
{baja.comm.Batch} batch

<private> resolveByHandle(obj)
Find the Component via its handle (null if not found).

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.

<private> sync(obj)
Sync the Component Space.

This method will result in a 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.

Documentation generated by JsDoc Toolkit 2.3.2