| Package | org.springextensions.actionscript.core.command |
| SVN browsing | ICompositeCommand.as |
| Fisheye | ICompositeCommand.as |
| Interface | public interface ICompositeCommand extends ICommand, IOperation, flash.events.IEventDispatcher |
| Implementors | CompositeCommand |
Documentation reference: composite commands
| Property | Defined by | ||
|---|---|---|---|
 | error : *
The error of this operation or
null if no error occurred during this operation. | IOperation | |
| kind : CompositeCommandKind
[read-only]
| ICompositeCommand | ||
| numCommands : uint [read-only]
The number of pending commands.
| ICompositeCommand | ||
| result : *
The result of this operation or
null if the operation does not have a result. | IOperation | |
| timeout : int
The timeout in milliseconds.
| IOperation | |
| Method | Defined by | ||
|---|---|---|---|
|
Adds an
ICommand to the current ICompositeCommand. | ICompositeCommand | ||
|
addCompleteListener(listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Convenience method for adding a listener to the OperationEvent.COMPLETE event.
| IOperation | |
|
addErrorListener(listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Convenience method for adding a listener to the OperationEvent.ERROR event.
| IOperation | |
|
addOperation(operationClass:Class, ... constructorArgs):ICompositeCommand
Adds a
Class that is an IOperation implementation along with its optional cosntructor arguments. | ICompositeCommand | ||
|
addTimeoutListener(listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Convenience method for adding a listener to the OperationEvent.TIMEOUT event.
| IOperation | |
|
execute():*
Executes the command.
| ICommand | |
|
removeCompleteListener(listener:Function, useCapture:Boolean = false):void
Convenience method for removing a listener from the OperationEvent.COMPLETE event.
| IOperation | |
|
removeErrorListener(listener:Function, useCapture:Boolean = false):void
Convenience method for removing a listener from the OperationEvent.ERROR event.
| IOperation | |
|
removeTimeoutListener(listener:Function, useCapture:Boolean = false):void
Convenience method for removing a listener from the OperationEvent.TIMEOUT event.
| IOperation | |
| Event | Summary | Defined by | ||
|---|---|---|---|---|
Dispatched after an ICommand from the collection was executed. | ICompositeCommand | |||
Dispatched before an ICommand from the collection is executed. | ICompositeCommand | |||
Dispatched when the CompositeCommand is finised executing its collection of ICommands
| ICompositeCommand | |||
Dispatched when the CompositeCommand encounters an error. | ICompositeCommand | |||
|
Dispatched when the current IOperation completed successfully. | IOperation | ||
|
Dispatched when the current IOperation encountered an error. | IOperation | ||
|
Dispatched when the current IOperation timed out. | IOperation | ||
| kind | property |
| numCommands | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesnumCommands:uint [read-only]The number of pending commands.
Implementation public function get numCommands():uint
| addCommand | () | method |
public function addCommand(command:ICommand):ICompositeCommand
Adds an ICommand to the current ICompositeCommand.
command:ICommand |
ICompositeCommand —
The current ICompositeCommand, this way calls to addCommand() can be chained.
|
| addOperation | () | method |
public function addOperation(operationClass:Class, ... constructorArgs):ICompositeCommand
Adds a Class that is an IOperation implementation along with its optional cosntructor arguments.
Upon execution this class will be instantiated when the current ICompositeCommand reaches it in its execution logic.
operationClass:Class — The specified Class.
|
|
... constructorArgs — The optional constructor arguments for the operation Class.
|
ICompositeCommand —
The current ICompositeCommand, this way calls to addCommand() can be chained.
|
| compositeCommandAfterExecuteCommand | event |
org.springextensions.actionscript.core.command.event.CompositeCommandEvent
Dispatched after an ICommand from the collection was executed.
| compositeCommandBeforeExecuteCommand | event |
org.springextensions.actionscript.core.command.event.CompositeCommandEvent
Dispatched before an ICommand from the collection is executed.
| compositeCommandComplete | event |
org.springextensions.actionscript.core.command.event.CompositeCommandEvent
Dispatched when the CompositeCommand is finised executing its collection of ICommands
| compositeCommandError | event |
org.springextensions.actionscript.core.command.event.CompositeCommandEvent
Dispatched when the CompositeCommand encounters an error.