Packageweavejs.api.core
Interfacepublic interface ILinkableDynamicObject extends ILinkableCompositeObject, ILinkableObject
Implementors LinkableDynamicObject

This is an interface for a wrapper around a dynamically created ILinkableObject.


Public Properties
 PropertyDefined By
  foundPlaceholder : Boolean
[read-only] Checks if the target is currently a placeholder for an instance of an async class.
ILinkableDynamicObject
  internalObject : ILinkableObject
[read-only] This is the local or global internal object.
ILinkableDynamicObject
  locked : Boolean
[read-only] This is set to true when lock() is called.
ILinkableDynamicObject
  target : ILinkableObject
This is the local or global internal object.
ILinkableDynamicObject
  targetPath : Array
This is the path that is currently being watched for linkable object targets.
ILinkableDynamicObject
Public Methods
 MethodDefined By
 Inherited
getSessionState():Array
This gets the session state of this composite object.
ILinkableCompositeObject
  
lock():void
This function will lock the internal object in place so it will not be removed.
ILinkableDynamicObject
  
removeObject():void
If the internal object is local, this will remove the object (unless it is locked).
ILinkableDynamicObject
  
requestGlobalObject(name:String, objectType:Class, lockObject:Boolean = false):*
This function creates a global object using the given Class definition if it doesn't already exist.
ILinkableDynamicObject
  
requestLocalObject(objectType:Class, lockObject:Boolean = false):*
This function creates a local object using the given Class definition if it doesn't already exist.
ILinkableDynamicObject
  
requestLocalObjectCopy(objectToCopy:ILinkableObject):void
This function will copy the session state of an ILinkableObject to a new local internalObject of the same type.
ILinkableDynamicObject
 Inherited
setSessionState(newState:Array, removeMissingDynamicObjects:Boolean):void
This sets the session state of this composite object.
ILinkableCompositeObject
Property Detail
foundPlaceholderproperty
foundPlaceholder:Boolean  [read-only]

Checks if the target is currently a placeholder for an instance of an async class.


Implementation
    public function get foundPlaceholder():Boolean

See also

Weave.registerAsyncClass()
internalObjectproperty 
internalObject:ILinkableObject  [read-only]

This is the local or global internal object.


Implementation
    public function get internalObject():ILinkableObject
lockedproperty 
locked:Boolean  [read-only]

This is set to true when lock() is called. Subsequent calls to setSessionState() will have no effect.


Implementation
    public function get locked():Boolean
targetproperty 
target:ILinkableObject

This is the local or global internal object. Setting this will unset the targetPath.


Implementation
    public function get target():ILinkableObject
    public function set target(value:ILinkableObject):void
targetPathproperty 
targetPath:Array

This is the path that is currently being watched for linkable object targets.


Implementation
    public function get targetPath():Array
    public function set targetPath(value:Array):void
Method Detail
lock()method
public function lock():void

This function will lock the internal object in place so it will not be removed.

removeObject()method 
public function removeObject():void

If the internal object is local, this will remove the object (unless it is locked). If the internal object is global, this will remove the link to it.

requestGlobalObject()method 
public function requestGlobalObject(name:String, objectType:Class, lockObject:Boolean = false):*

This function creates a global object using the given Class definition if it doesn't already exist. If the object gets disposed later, this object will still be linked to the global name. If the existing object under the specified name is locked, this function will not modify it.

Parameters

name:String — The name of the global object to link to.
 
objectType:Class — The Class used to initialize the object.
 
lockObject:Boolean (default = false) — If this is true, this object will be locked so the internal object cannot be removed or replaced.

Returns
* — The global object of the requested name and type, or null if the object could not be created.
requestLocalObject()method 
public function requestLocalObject(objectType:Class, lockObject:Boolean = false):*

This function creates a local object using the given Class definition if it doesn't already exist. If this object is locked, this function does nothing.

Parameters

objectType:Class — The Class used to initialize the object.
 
lockObject:Boolean (default = false) — If this is true, this object will be locked so the internal object cannot be removed or replaced.

Returns
* — The local object of the requested type, or null if the object could not be created.
requestLocalObjectCopy()method 
public function requestLocalObjectCopy(objectToCopy:ILinkableObject):void

This function will copy the session state of an ILinkableObject to a new local internalObject of the same type.

Parameters

objectToCopy:ILinkableObject — An object to copy the session state from.





Wed Jun 28 2017, 02:22 PM -04:00