new ComponentSpace(name, ordInSession, host)
Represents a baja:ComponentSpace
in BajaScript.
Parameters:
Name | Type | Description |
---|---|---|
name |
String | |
ordInSession |
String | |
host |
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
-
getAbsoluteOrd()
-
Return absolute ORD for the Component Space.
Returns:
- Type
- baja.Ord
-
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:
Returns:
promise a promise that will be resolved once the callbacks have been invoked.
-
getNavDescription()
-
Return the Nav Description.
- Inherited From:
Returns:
- Type
- String
-
getNavDisplayName()
-
Return the Nav Display Name.
- Inherited From:
Returns:
- Type
- String
-
getNavIcon()
-
Return the Nav Icon.
- Overrides:
Returns:
- Type
- baja.Icon
-
getNavName()
-
Return the Nav Name.
- Inherited From:
Returns:
- Type
- String
-
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
-
getOrdInSession()
-
Return the ORD in Session for the Component Space.
Returns:
- Type
- baja.Ord
-
getRootComponent()
-
Return the root
Component
of the Component Space.Returns:
the root Component for the Space.
- Type
- baja.Component
-
getType()
-
Get the type of this instance.
- Inherited From:
Returns:
- Type
- Type
-
isSpaceReadonly()
-
Return true if the entire ComponentSpace is readonly.
Returns:
true if readonly.
- Type
- Boolean
-
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.Parameters:
Name Type Argument Description obj
Object <optional>
the object literal for the method's arguments.
Properties
Name Type Argument Description ok
function <optional>
(Deprecated: use Promise) the ok callback.
Called once the Component Space has been successfully synchronized with the
Server.fail
function <optional>
(Deprecated: use Promise) the fail callback.
Called If the Component Space can't be synchronized.batch
baja.comm.Batch <optional>
if defined, any network calls will be
batched into this object.Returns:
a promise that will be resolved once the space has been
synced.- Type
- Promise
-
toEnabledMixIns( [obj])
-
Resolve to a list of enabled mix-in Types for the Component Space.
An Object Literal is used for the method's arguments.
Parameters:
Name Type Argument Description obj
Object <optional>
the Object Literal for the method's arguments.
Properties
Name Type Argument Description ok
function <optional>
(Deprecated: use Promise) Callback handler
invoked once the enabled mix-in Types have been resolved.fail
function <optional>
(Deprecated: use Promise) the fail callback.
batch
baja.comm.Batch <optional>
if defined, any network calls will be
batched into this object.Returns:
a promise that will be resolved once
the mixin information has been retrieved.- Type
- Promise.<Array.<Object>>
-
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
- *