org.springextensions.actionscript.core.task.support.ForBlock

Public Properties

	Property		Defined by
		context : Object An anonymous object that can be used to store values that can be accessed by other client code to pass around these values between commands.	Task
		countProvider : ICountProvider	ForBlock
		error : * The error of this operation or `null` if no error occurred during this operation.	AbstractOperation
		failOnFault : Boolean = true Determines if the entire controlflow of the current `ITask` will be aborted if an error occurs.	Task
		isClosed : Boolean	AbstractTaskBlock
		isDisposed : Boolean Returns `true` if the `dispose()` has already been invoked before.	Task
		parent : ITask	Task
		result : * The result of this operation or `null` if the operation does not have a result.	AbstractOperation
		timeout : int The timeout in milliseconds.	AbstractOperation

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined by
		commandList : Array Internal `Array` of the commands, tasks and controlflow objects that will be executed.	Task
		currentCommand : ICommand The current `ICommand` instance that is being executed.	Task
		finishedCommandList : Array Internal `Array` of the commands, tasks and controlflow objects that have been executed.	Task

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		ForBlock(countProvider:ICountProvider) Creates a new `ForBlock` instance.	ForBlock
		addCompleteListener(listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Convenience method for adding a listener to the OperationEvent.COMPLETE event.	AbstractOperation
		addErrorListener(listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Convenience method for adding a listener to the OperationEvent.ERROR event.	AbstractOperation
		addTimeoutListener(listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Convenience method for adding a listener to the OperationEvent.TIMEOUT event.	AbstractOperation
		and(item:Object, ... constructorArgs):ITask Adds an `ICommand` that will be executed in parallel.	Task
		break_():ITask	Task
		continue_():ITask	Task
		dispatchCompleteEvent(result:* = null):Boolean Convenience method for dispatching a `OperationEvent.COMPLETE` event.	AbstractOperation
		dispatchErrorEvent(error:* = null):Boolean Convenience method for dispatching a `OperationEvent.ERROR` event.	AbstractOperation
		dispatchTimeoutEvent():Boolean Convenience method for dispatching a `OperationEvent.TIMEOUT` event.	AbstractOperation
		dispose():void Release any resources that the current object might hold a reference to.	Task
		else_():IIfElseBlock Switches the current `IIfElseBlock` control flow to its else block.	Task
		end():ITask	AbstractTaskBlock
		execute():*	ForBlock
		exit():ITask Stops the execution chain completely.	Task
		for_(count:uint, countProvider:ICountProvider = null, forBlock:IForBlock = null):IForBlock Adds a repeating execution block which will be executed a specified number of times, determined by the specified `count` or `ICountProvider` parameters.	Task
		if_(conditionProvider:IConditionProvider = null, ifElseBlock:IIfElseBlock = null):IIfElseBlock Adds a conditional execution block to the current `ITask` which will only be executed if the specified `IConditionProvider` return `true`.	Task
		next(item:Object, ... constructorArgs):ITask Adds an `ICommand` that will be executed in sequence.	Task
		pause(duration:uint, pauseCommand:ICommand = null):ITask Pauses the current `ITask` for the specified amount of milliseconds.	Task
		removeCompleteListener(listener:Function, useCapture:Boolean = false):void Convenience method for removing a listener from the OperationEvent.COMPLETE event.	AbstractOperation
		removeErrorListener(listener:Function, useCapture:Boolean = false):void Convenience method for removing a listener from the OperationEvent.ERROR event.	AbstractOperation
		removeTimeoutListener(listener:Function, useCapture:Boolean = false):void Convenience method for removing a listener from the OperationEvent.TIMEOUT event.	AbstractOperation
		reset(doHardReset:Boolean = false):ITask Restarts the execution of the current `ITask`.	Task
		while_(conditionProvider:IConditionProvider = null, whileBlock:IWhileBlock = null):IWhileBlock Adds a repeating execution block which will be executed until the specified `IConditionProvider` returns false.	Task

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined by
		addCommand(command:ICommand, kind:CompositeCommandKind):ITask Examines the current `ICommand` in the controlflow and based on that either adds the specified `ICommand` to the current `ICommand` or creates a new `TaskCommand` and adds it to this.	Task
		addCommandListeners(asyncCommand:IOperation):void	Task
		addCountListeners(asyncCommand:IOperation):void	ForBlock
		addTaskCommand(kind:CompositeCommandKind):CompositeCommand Adds a new `TaskCommand` with the specified `ComposeiteCommandKind` to the controlflow of the current `ITask`.	Task
		addToCommandList(command:ICommand):void Adds the specified `ICommand` instance to the control flow of the current `ITask`, if the specified `ICommand` is also an implementation of `ITask`, the current `ITask` will be set as its parent.	Task
		completeExecution():void	Task
		dispatchTaskEvent(eventType:String, command:ICommand = null):void	Task
		doFlowControlCheck(flowControl:ITaskFlowControl):Boolean	AbstractTaskBlock
		executeBlock():void	ForBlock
		executeCommand(command:ICommand):void	ForBlock
		executeFlowControl(kind:TaskFlowControlKind):Boolean	AbstractTaskBlock
		executeNextCommand():void	Task
		exit_handler(event:TaskFlowControlEvent):void	Task
		exitExecution():void	AbstractTaskBlock
		initTask():void	Task
		onCommandFault(event:OperationEvent):void	Task
		onCommandResult(event:OperationEvent):void	Task
		onCountFault(event:OperationEvent):void	ForBlock
		onCountResult(event:OperationEvent):void	ForBlock
		redispatchCompositeCommand(event:CompositeCommandEvent):void	Task
		redispatchTaskEvent(event:TaskEvent):void	Task
		removeCommandListeners(asyncCommand:IOperation):void	Task
		removeCountListeners(asyncCommand:IOperation):void	ForBlock
		resetCommandList():void	Task
		restartExecution():void	ForBlock
		startExecution():void	ForBlock
		startTimeout():void	AbstractOperation
		TaskFlowControlEvent_handler(event:TaskFlowControlEvent):void	ForBlock

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined by
operationComplete	Dispatched when the current `AbstractOperation` has completed its functionality successfully.	AbstractOperation
operationError	Dispatched when the current `AbstractOperation` encountered an error.	AbstractOperation
operationTimeout	Dispatched when the current `AbstractOperation` timed out.	AbstractOperation

Property detail

countProvider

property

countProvider:ICountProvider  [read-write]Implementation
    public function get countProvider():ICountProvider
    public function set countProvider(value:ICountProvider):void

Constructor detail

ForBlock

()

constructor

public function ForBlock(countProvider:ICountProvider)

Creates a new ForBlock instance.

Parameters

countProvider:ICountProvider — an ICountProvider that will determine whether the current ForBlock's logic will be executed or not.

Method detail

addCountListeners

()

method

protected function addCountListeners(asyncCommand:IOperation):voidParameters

asyncCommand:IOperation

execute

()

method

public override function execute():*

Returns

*

executeBlock

()

method

protected function executeBlock():void

executeCommand

()

method

protected override function executeCommand(command:ICommand):voidParameters

command:ICommand

onCountFault

()

method

protected function onCountFault(event:OperationEvent):voidParameters

event:OperationEvent

onCountResult

()

method

protected function onCountResult(event:OperationEvent):voidParameters

event:OperationEvent

removeCountListeners

()

method

protected function removeCountListeners(asyncCommand:IOperation):voidParameters

asyncCommand:IOperation

restartExecution

()

method

protected override function restartExecution():void

startExecution

()

method

protected function startExecution():void

TaskFlowControlEvent_handler

()

method

protected override function TaskFlowControlEvent_handler(event:TaskFlowControlEvent):voidParameters

event:TaskFlowControlEvent

Spring Actionscript API documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class ForBlock	Properties \| Methods \| Events

Package	org.springextensions.actionscript.core.task.support
SVN browsing	ForBlock.as
Fisheye	ForBlock.as
Class	public class ForBlock
Inheritance	ForBlock AbstractTaskBlock Task AbstractOperation flash.events.EventDispatcher
Implements	IForBlock