BiAbstractActionThread

This is an abstract class that represents an action thread. Override the methods of this class to invoke your own ActionThread.@remark A BiActionThread can be described as an action instance. It represents exactly one execution and is used to keep track of asynchronous executions.

This class extends BiEventTarget and therefore all methods and fields available for BiEventTarget are also available for BiAbstractActionThread .

Constructor

new BiAbstractActionThread ( oAction )

Parameters

Name	Type	Optional	Default	Descripton
oAction	BiAction			The action called.

Properties

Name	Type	get	set	Descripton
action	Object			The action that created this thread.
arguments	Array			Arguments for this thread.
async	Boolean			Whether to perform this action thread asynchronously
caller	Object			The instance that called this action thread.
children	Array			Array of dependencies(children) of this thread.
completed	Boolean			Whether execution of this action thread is completed.
eventTarget	Object			The Event target that triggered the current chain of execution
eventType	String			The type of the event that triggered the current chain of execution
returns	Object			What is returned by this action thread.
scope	Object			The scope to run the handler function in. I.e. what "this" refers to from inside the function.
threadPrepared	Boolean			Whether dependencies of this action thread are prepared.

Methods

Name	Description
exec	Trigger this thread.
prepare	Prepare thread and it's dependencies. This method must be called before a thread can be executed.
processArguments	This method is used by the exec method to process arguments.
processChildren	This method is used by the exec method to process child actions.
processHandler	This method is used by the exec method to process handler(s).
processReturns	This method is used by the exec method to set what should be returned by the action thread.

Events

Name	Type	Bubbles	Descripton
completed	BiEvent		This event is dispatched when the thread is completed.
exec	BiEvent		This event is dispatched when the thread is executed.

Static Methods

None.

Static Fields

None.

Remarks

None.

Method Details

exec

Trigger this thread.

Syntax

object.exec ( oCaller [ ,oEvent ] )

Parameters

Name	Type	Optional	Default	Descripton
oCaller	Object			The instance that called this action thread.
oEvent	BiEvent			The (optional) event that triggered this chain of actions.

Return Type

Object

prepare

Prepare thread and it's dependencies. This method must be called before a thread can be executed.

Syntax

object.prepare ( oScope [ ,nType ] )

Parameters

Name	Type	Optional	Default	Descripton
oScope	Object			The scope this thread will be executed in.
nType	Number			The (optional) type of this thread.

Return Type

void

processArguments

This method is used by the exec method to process arguments.

Syntax

object.processArguments ( )

Parameters

No arguments.

Return Type

void

processChildren

This method is used by the exec method to process child actions.

Syntax

object.processChildren ( )

Parameters

No arguments.

Return Type

void

processHandler

This method is used by the exec method to process handler(s).

Syntax

object.processHandler ( )

Parameters

No arguments.

Return Type

void

processReturns

This method is used by the exec method to set what should be returned by the action thread.

Syntax

object.processReturns ( )

Parameters

No arguments.

Return Type

void