Packageweavejs.core
Classpublic class LinkableHashMap
InheritanceLinkableHashMap Inheritance CallbackCollection Inheritance Object
Implements ILinkableHashMap

Allows dynamically creating instances of objects implementing ILinkableObject at runtime. The session state is an Array of DynamicState objects.

See also

weave.core.DynamicState

Public Properties
 PropertyDefined By
 InheritedcallbacksAreDelayed : Boolean
[read-only]
CallbackCollection
  childListCallbacks : IChildListCallbackInterface
[read-only]
LinkableHashMap
 Inherited_linkableObject : ILinkableObject
CallbackCollection
 InheritedtriggerCounter : uint
[read-only]
CallbackCollection
  typeRestriction : Class
[read-only]
LinkableHashMap
 InheritedwasDisposed : Boolean
[read-only] This flag becomes true after dispose() is called.
CallbackCollection
Protected Properties
 PropertyDefined By
 Inherited_preCallback : Function = null
This is the function that gets called immediately before every callback.
CallbackCollection
Public Methods
 MethodDefined By
  
LinkableHashMap(typeRestriction:Class = null)
Constructor.
LinkableHashMap
 Inherited
addDisposeCallback(relevantContext:Object, callback:Function, allowDelay:Boolean = false):void
CallbackCollection
 Inherited
addGroupedCallback(relevantContext:Object, groupedCallback:Function, triggerCallbackNow:Boolean = false, delayWhileBusy:Boolean = true):void
CallbackCollection
 Inherited
addImmediateCallback(relevantContext:Object, callback:Function, runCallbackNow:Boolean = false, alwaysCallLast:Boolean = false):void
CallbackCollection
 Inherited
delayCallbacks():void
CallbackCollection
  
dispose():void
[override] This function removes all objects from this LinkableHashMap.
LinkableHashMap
  
generateUniqueName(baseName:String):String
LinkableHashMap
  
getName(object:ILinkableObject):String
LinkableHashMap
  
getNames(filter:Class = null, filterIncludesPlaceholders:Boolean = false):Array
LinkableHashMap
  
getObject(name:String):ILinkableObject
LinkableHashMap
  
getObjects(filter:Class = null, filterIncludesPlaceholders:Boolean = false):Array
LinkableHashMap
  
getSessionState():Array
LinkableHashMap
  
objectIsLocked(name:String):Boolean
LinkableHashMap
  
removeAllObjects():void
LinkableHashMap
 Inherited
removeCallback(relevantContext:Object, callback:Function):void
CallbackCollection
  
removeObject(name:String):void
LinkableHashMap
  
renameObject(oldName:String, newName:String):ILinkableObject
LinkableHashMap
  
requestObject(name:String, classDef:Class, lockObject:Boolean = false):*
LinkableHashMap
  
requestObjectCopy(name:String, objectToCopy:ILinkableObject):ILinkableObject
LinkableHashMap
 Inherited
resumeCallbacks():void
CallbackCollection
  
setNameOrder(newOrder:Array):void
LinkableHashMap
  
setObject(name:String, object:ILinkableObject, lockObject:Boolean = false):void
LinkableHashMap
  
setSessionState(newStateArray:Array, removeMissingDynamicObjects:Boolean):void
LinkableHashMap
  
toMap(filter:Class = null, filterIncludesPlaceholders:Boolean = false):Object
LinkableHashMap
  
toObject(filter:Class = null, filterIncludesPlaceholders:Boolean = false):Object
LinkableHashMap
 Inherited
triggerCallbacks():void
CallbackCollection
Protected Methods
 MethodDefined By
 Inherited
_runCallbacksImmediately(... preCallbackParams):void
This function runs callbacks immediately, ignoring any delays.
CallbackCollection
Public Constants
 ConstantDefined By
 InheritedDEFAULT_TRIGGER_COUNT : uint = 1
[static] This is the default value of triggerCounter.
CallbackCollection
 InheritedSTACK_TRACE_TRIGGER : String = This is the stack trace from when the callbacks were last triggered.
[static]
CallbackCollection
Property Detail
childListCallbacksproperty
childListCallbacks:IChildListCallbackInterface  [read-only]


Implementation
    public function get childListCallbacks():IChildListCallbackInterface
typeRestrictionproperty 
typeRestriction:Class  [read-only]


Implementation
    public function get typeRestriction():Class
Constructor Detail
LinkableHashMap()Constructor
public function LinkableHashMap(typeRestriction:Class = null)

Constructor.

Parameters
typeRestriction:Class (default = null) — If specified, this will limit the type of objects that can be added to this LinkableHashMap.
Method Detail
dispose()method
override public function dispose():void

This function removes all objects from this LinkableHashMap.

generateUniqueName()method 
public function generateUniqueName(baseName:String):String

Parameters

baseName:String

Returns
String
getName()method 
public function getName(object:ILinkableObject):String

Parameters

object:ILinkableObject

Returns
String
getNames()method 
public function getNames(filter:Class = null, filterIncludesPlaceholders:Boolean = false):Array

Parameters

filter:Class (default = null)
 
filterIncludesPlaceholders:Boolean (default = false)

Returns
Array
getObject()method 
public function getObject(name:String):ILinkableObject

Parameters

name:String

Returns
ILinkableObject
getObjects()method 
public function getObjects(filter:Class = null, filterIncludesPlaceholders:Boolean = false):Array

Parameters

filter:Class (default = null)
 
filterIncludesPlaceholders:Boolean (default = false)

Returns
Array
getSessionState()method 
public function getSessionState():Array

Returns
Array
objectIsLocked()method 
public function objectIsLocked(name:String):Boolean

Parameters

name:String

Returns
Boolean
removeAllObjects()method 
public function removeAllObjects():void

removeObject()method 
public function removeObject(name:String):void

Parameters

name:String

renameObject()method 
public function renameObject(oldName:String, newName:String):ILinkableObject

Parameters

oldName:String
 
newName:String

Returns
ILinkableObject
requestObject()method 
public function requestObject(name:String, classDef:Class, lockObject:Boolean = false):*

Parameters

name:String
 
classDef:Class
 
lockObject:Boolean (default = false)

Returns
*
requestObjectCopy()method 
public function requestObjectCopy(name:String, objectToCopy:ILinkableObject):ILinkableObject

Parameters

name:String
 
objectToCopy:ILinkableObject

Returns
ILinkableObject
setNameOrder()method 
public function setNameOrder(newOrder:Array):void

Parameters

newOrder:Array

setObject()method 
public function setObject(name:String, object:ILinkableObject, lockObject:Boolean = false):void

Parameters

name:String
 
object:ILinkableObject
 
lockObject:Boolean (default = false)

setSessionState()method 
public function setSessionState(newStateArray:Array, removeMissingDynamicObjects:Boolean):void

Parameters

newStateArray:Array
 
removeMissingDynamicObjects:Boolean

toMap()method 
public function toMap(filter:Class = null, filterIncludesPlaceholders:Boolean = false):Object

Parameters

filter:Class (default = null)
 
filterIncludesPlaceholders:Boolean (default = false)

Returns
Object
toObject()method 
public function toObject(filter:Class = null, filterIncludesPlaceholders:Boolean = false):Object

Parameters

filter:Class (default = null)
 
filterIncludesPlaceholders:Boolean (default = false)

Returns
Object




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