Packageweavejs.core
Classpublic class LinkableString
InheritanceLinkableString Inheritance LinkableVariable Inheritance CallbackCollection Inheritance Object
Subclasses LinkableFunction

This is a LinkableVariable which limits its session state to String values.

See also

weave.core.LinkableVariable

Public Properties
 PropertyDefined By
 InheritedcallbacksAreDelayed : Boolean
[read-only]
CallbackCollection
 Inherited_linkableObject : ILinkableObject
CallbackCollection
 Inheritedlocked : Boolean
[read-only] This is set to true when lock() is called.
LinkableVariable
 Inheritedstate : Object
LinkableVariable
 InheritedtriggerCounter : uint
[read-only]
CallbackCollection
  value : String
LinkableString
 InheritedwasDisposed : Boolean
[read-only] This flag becomes true after dispose() is called.
CallbackCollection
Protected Properties
 PropertyDefined By
 Inherited_bypassDiff : Boolean = true
If true, session states will be altered to bypass the diff calculation on DynamicState Arrays.
LinkableVariable
 Inherited_locked : Boolean = false
This is set to true when lock() is called.
LinkableVariable
 Inherited_preCallback : Function = null
This is the function that gets called immediately before every callback.
CallbackCollection
 Inherited_primitiveType : Boolean = false
This is true if the _sessionStateType is a primitive type.
LinkableVariable
 Inherited_sessionStateExternal : * = undefined
Available externally via getSessionState()
LinkableVariable
 Inherited_sessionStateInternal : * = undefined
Cannot be modified externally because it is not returned by getSessionState()
LinkableVariable
 Inherited_sessionStateType : Class = null
Type restriction passed in to the constructor.
LinkableVariable
 Inherited_sessionStateWasSet : Boolean = false
This is true if the session state has been set at least once.
LinkableVariable
 Inherited_verifier : Function = null
This function is used to prevent the session state from having unwanted values.
LinkableVariable
Public Methods
 MethodDefined By
  
LinkableString(defaultValue:String = null, verifier:Function = null, defaultValueTriggersCallbacks:Boolean = true)
LinkableString
 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
 Inherited
detectChanges():void
This function may be called to detect change to a non-primitive session state in case it has been modified externally.
LinkableVariable
 Inherited
dispose():void
[override]
LinkableVariable
 Inherited
getSessionState():Object
LinkableVariable
 Inherited
getSessionStateType():Class
The type restriction passed in to the constructor.
LinkableVariable
 Inherited
lock():void
Call this function when you do not want to allow any more changes to the value of this sessioned property.
LinkableVariable
 Inherited
removeCallback(relevantContext:Object, callback:Function):void
CallbackCollection
 Inherited
resumeCallbacks():void
CallbackCollection
  
setSessionState(value:Object):void
[override]
LinkableString
 Inherited
triggerCallbacks():void
CallbackCollection
 Inherited
verifyValue(value:Object):Boolean
This function will verify if a given value is a valid session state for this linkable variable.
LinkableVariable
Protected Methods
 MethodDefined By
 Inherited
_runCallbacksImmediately(... preCallbackParams):void
This function runs callbacks immediately, ignoring any delays.
CallbackCollection
 Inherited
sessionStateEquals(otherSessionState:*):Boolean
This function is used in setSessionState() to determine if the value has changed or not.
LinkableVariable
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
valueproperty
value:String


Implementation
    public function get value():String
    public function set value(value:String):void
Constructor Detail
LinkableString()Constructor
public function LinkableString(defaultValue:String = null, verifier:Function = null, defaultValueTriggersCallbacks:Boolean = true)



Parameters
defaultValue:String (default = null)
 
verifier:Function (default = null)
 
defaultValueTriggersCallbacks:Boolean (default = true)
Method Detail
setSessionState()method
override public function setSessionState(value:Object):void

Parameters

value:Object





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