weavejs.core.LinkableFunction

	Property	Defined By
		callbacksAreDelayed : Boolean [read-only]	CallbackCollection
		debug : Boolean = false [static] Debug mode.	LinkableFunction
		_linkableObject : ILinkableObject	CallbackCollection
		locked : Boolean [read-only] This is set to true when lock() is called.	LinkableVariable
		state : Object	LinkableVariable
		triggerCounter : uint [read-only]	CallbackCollection
		value : String	LinkableString
		wasDisposed : Boolean [read-only] This flag becomes true after dispose() is called.	CallbackCollection

Protected Properties

	Property		Defined By
		_bypassDiff : Boolean = true If true, session states will be altered to bypass the diff calculation on DynamicState Arrays.	LinkableVariable
		_locked : Boolean = false This is set to true when lock() is called.	LinkableVariable
		_preCallback : Function = null This is the function that gets called immediately before every callback.	CallbackCollection
		_primitiveType : Boolean = false This is true if the _sessionStateType is a primitive type.	LinkableVariable
		_sessionStateExternal : * = undefined Available externally via getSessionState()	LinkableVariable
		_sessionStateInternal : * = undefined Cannot be modified externally because it is not returned by getSessionState()	LinkableVariable
		_sessionStateType : Class = null Type restriction passed in to the constructor.	LinkableVariable
		_sessionStateWasSet : Boolean = false This is true if the session state has been set at least once.	LinkableVariable
		_verifier : Function = null This function is used to prevent the session state from having unwanted values.	LinkableVariable

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		LinkableFunction(defaultValue:String = null, ignoreRuntimeErrors:Boolean = false, paramNames:Array = null)	LinkableFunction
		addDisposeCallback(relevantContext:Object, callback:Function, allowDelay:Boolean = false):void	CallbackCollection
		addGroupedCallback(relevantContext:Object, groupedCallback:Function, triggerCallbackNow:Boolean = false, delayWhileBusy:Boolean = true):void	CallbackCollection
		addImmediateCallback(relevantContext:Object, callback:Function, runCallbackNow:Boolean = false, alwaysCallLast:Boolean = false):void	CallbackCollection
		apply(thisArg:* = null, argArray:Array = null):* This will evaluate the function with the specified parameters.	LinkableFunction
		call(thisArg:* = null, ... args):* This will evaluate the function with the specified parameters.	LinkableFunction
		delayCallbacks():void	CallbackCollection
		detectChanges():void This function may be called to detect change to a non-primitive session state in case it has been modified externally.	LinkableVariable
		dispose():void [override]	LinkableVariable
		getSessionState():Object	LinkableVariable
		getSessionStateType():Class The type restriction passed in to the constructor.	LinkableVariable
		lock():void Call this function when you do not want to allow any more changes to the value of this sessioned property.	LinkableVariable
		removeCallback(relevantContext:Object, callback:Function):void	CallbackCollection
		resumeCallbacks():void	CallbackCollection
		setSessionState(value:Object):void [override]	LinkableString
		triggerCallbacks():void	CallbackCollection
		validate():void This will attempt to compile the function.	LinkableFunction
		verifyValue(value:Object):Boolean This function will verify if a given value is a valid session state for this linkable variable.	LinkableVariable

	Method	Defined By
		_runCallbacksImmediately(... preCallbackParams):void This function runs callbacks immediately, ignoring any delays.	CallbackCollection
		sessionStateEquals(otherSessionState:*):Boolean This function is used in setSessionState() to determine if the value has changed or not.	LinkableVariable

	Constant	Defined By
		DEFAULT_TRIGGER_COUNT : uint = 1 [static] This is the default value of triggerCounter.	CallbackCollection
		STACK_TRACE_TRIGGER : String = This is the stack trace from when the callbacks were last triggered. [static]	CallbackCollection

Property Detail

debug

property

public static var debug:Boolean = false

Debug mode.

Constructor Detail

LinkableFunction

()

Constructor

public function LinkableFunction(defaultValue:String = null, ignoreRuntimeErrors:Boolean = false, paramNames:Array = null)

Parameters

	`defaultValue:String` (default = `null`) — The default function definition.

	`ignoreRuntimeErrors:Boolean` (default = `false`) — If this is true, errors thrown during evaluation of the function will be caught and values of undefined will be returned.

	`paramNames:Array` (default = `null`) — When true, variable lookups will be evaluated as if the function were in the scope of the thisArg passed to the apply() function.

Method Detail

apply

()

method

public function apply(thisArg:* = null, argArray:Array = null):*

This will evaluate the function with the specified parameters.

Parameters

	`thisArg:*` (default = `null`) — The value of 'this' to be used when evaluating the function.

	`argArray:Array` (default = `null`) — An Array of arguments to be passed to the compiled function.

Returns

* — The result of evaluating the function.

call

()

method

public function call(thisArg:* = null, ... args):*

This will evaluate the function with the specified parameters.

Parameters

	`thisArg:*` (default = `null`) — The value of 'this' to be used when evaluating the function.

	`... args` — Arguments to be passed to the compiled function.

Returns

* — The result of evaluating the function.

validate

()

method

public function validate():void

This will attempt to compile the function. An Error will be thrown if this fails.

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

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
LinkableFunction	Properties \| Methods \| Constants

Package	weavejs.core
Class	public class LinkableFunction
Inheritance	LinkableFunction LinkableString LinkableVariable CallbackCollection Object