Package | com.soma.core.controller |
Class | public class Command |
Inheritance | Command ![]() |
Implements | flash.events.IEventDispatcher |
Subclasses | ParallelCommand, SequenceCommand |
Author: Romuald Quantin - www.soundstep.com
Resources: http://www.soundstep.com/downloads/somacore
Actionscript version: 3.0
Copyright: Mozilla Public License 1.1 (MPL 1.1) http://www.opensource.org/licenses/mozilla1.1.php
Command class that will be instantiated when a registered event is dispatched, the framework will automatically call the execute method.See also
Property | Defined By | ||
---|---|---|---|
injector : ISomaInjector [read-only] | Command | ||
instance : ISoma [read-only]
Retrieves the instance of the framework. | Command | ||
mediators : SomaMediators [read-only] | Command | ||
stage : Stage [read-only]
Get the stage that has been registered to the framework. | Command |
Method | Defined By | ||
---|---|---|---|
Command()
Create an instance of the Command class. | Command | ||
addCommand(commandName:String, command:Class):void
Registers a command to the framework. | Command | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. | Command | ||
Registers a model to the framework. | Command | ||
addView(viewName:String, view:Object):Object
Registers a view to the framework. | Command | ||
Registers a wire to the framework. | Command | ||
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow. | Command | ||
getCommand(commandName:String):Class
Retrieves the command class that has been registered with a command name. | Command | ||
getCommands():Array
Retrieves all the command names (event type) that have been registered to the framework. | Command | ||
Retrieves the last sequence command that has been instantiated in the framework. | Command | ||
Retrieves the model instance that has been registered using its name. | Command | ||
getModels():Dictionary
Retrieves all the model instances that have been registered to the framework. | Command | ||
getRunningSequencers():Array
Retrieves all the sequence command instances that are running. | Command | ||
getSequencer(event:Event):ISequenceCommand
Retrieves the sequence command instance using an event instance that has been created from this sequence command. | Command | ||
getView(viewName:String):Object
Retrieves the view instance that has been registered using its name. | Command | ||
getViews():Dictionary
Retrieves all the view instances that have been registered to the framework. | Command | ||
Retrieves the wire instance that has been registered using its name. | Command | ||
getWires():Dictionary
Retrieves all the wire instances that have been registered to the framework. | Command | ||
hasCommand(commandName:String):Boolean
Indicates wether a command has been registered to the framework. | Command | ||
hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | Command | ||
hasModel(modelName:String):Boolean
Indicates wether a model has been registered to the framework. | Command | ||
hasView(viewName:String):Boolean
Indicates wether a view has been registered to the framework. | Command | ||
hasWire(wireName:String):Boolean
Indicates wether a wire has been registered to the framework. | Command | ||
isPartOfASequence(event:Event):Boolean
Indicates wether an event has been instantiated from a ISequenceCommand class. | Command | ||
removeCommand(commandName:String):void
Removes a command from the framework. | Command | ||
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object. | Command | ||
removeModel(modelName:String):void
Removes a model from the framework and call the dispose method of this model. | Command | ||
removeView(viewName:String):void
Removes a view from the framework and call the (optional) dispose method of this view. | Command | ||
removeWire(wireName:String):void
Removes a wire from the framework and call the dispose method of this wire. | Command | ||
stopAllSequencers():void
Stops all the sequence command instances that are running. | Command | ||
stopSequencer(sequencer:ISequenceCommand):Boolean
Stops a sequence command using the sequence command instance itself. | Command | ||
stopSequencerWithEvent(event:Event):Boolean
Stops a sequence command using an event instance that has been created from this sequence command. | Command | ||
willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | Command |
Method | Defined By | ||
---|---|---|---|
initialize():void
Method that you can optionally overwrite and that is called after the command has been registered with the framework. | Command |
injector | property |
instance | property |
instance:ISoma
[read-only] Retrieves the instance of the framework.
public function get instance():ISoma
var myExtendedSomaClass:SomaApplication = SomaApplication(instance);
mediators | property |
stage | property |
stage:Stage
[read-only] Get the stage that has been registered to the framework.
public function get stage():Stage
Command | () | Constructor |
public function Command()
Create an instance of the Command class. Should not be directly instantiated, the framework will instantiate the class.
addCommand | () | method |
public final function addCommand(commandName:String, command:Class):void
Registers a command to the framework.
Parameters
commandName:String — Event type that is used as a command name.
| |
command:Class — Class that will be executed when a command has been dispatched.
|
See also
addCommand(MyEvent.DOSOMETHING, MyCommand);
addEventListener | () | method |
public final function addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
Parameters
type:String — The type of event.
| |
listener:Function — The listener function that processes the event.
| |
useCapture:Boolean (default = false ) — Determines whether the listener works in the capture phase or the target and bubbling phases.
| |
priority:int (default = 0 ) — The priority level of the event listener.
| |
useWeakReference:Boolean (default = false ) — Determines whether the reference to the listener is strong or weak.
|
addModel | () | method |
public final function addModel(modelName:String, model:IModel):IModel
Registers a model to the framework.
Parameters
modelName:String — Name of the model.
| |
model:IModel — Instance of the model.
|
IModel — The model instance.
|
See also
addModel(MyModel.NAME, new MyModel());
addView | () | method |
public final function addView(viewName:String, view:Object):Object
Registers a view to the framework.
Parameters
viewName:String — Name of the view.
| |
view:Object — Instance of the view.
|
Object — The view instance.
|
See also
addView(MySprite.NAME, new MySprite());
addWire | () | method |
public final function addWire(wireName:String, wire:IWire):IWire
Registers a wire to the framework.
Parameters
wireName:String — Name of the wire.
| |
wire:IWire — Instance of the wire.
|
IWire — The wire instance.
|
See also
addWire(MyWire.NAME, new MyWire());
dispatchEvent | () | method |
public final function dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow. The event target is the EventDispatcher object upon which dispatchEvent() is called.
Parameters
event:Event — The event object dispatched into the event flow.
|
Boolean — A value of true unless preventDefault() is called on the event, in which case it returns false.
|
getCommand | () | method |
public final function getCommand(commandName:String):Class
Retrieves the command class that has been registered with a command name.
Parameters
commandName:String — Event type that is used as a command name.
|
Class — A class.
|
See also
var commandClass:ICommand = getCommand(MyEvent.DOSOMETHING) as ICommand;
getCommands | () | method |
public final function getCommands():Array
Retrieves all the command names (event type) that have been registered to the framework.
ReturnsArray — An Array of String (command name).
|
See also
var commands:Array = getCommands();
getLastSequencer | () | method |
public final function getLastSequencer():ISequenceCommand
Retrieves the last sequence command that has been instantiated in the framework.
ReturnsISequenceCommand — An ISequenceCommand instance.
|
See also
var lastSequencer:ISequenceCommand = getLastSequencer();
getModel | () | method |
public final function getModel(modelName:String):IModel
Retrieves the model instance that has been registered using its name.
Parameters
modelName:String — Name of the model.
|
IModel — A IModel instance.
|
See also
var myModel:MyModel = getModel(MyModel.NAME) as MyModel;
getModels | () | method |
public final function getModels():Dictionary
Retrieves all the model instances that have been registered to the framework.
ReturnsDictionary — A Dictionary (the key of the Dictionary is the name used for the registration).
|
See also
var models:Dictionary = getModels();
getRunningSequencers | () | method |
public final function getRunningSequencers():Array
Retrieves all the sequence command instances that are running.
ReturnsArray — An Array of ISequenceCommand instances.
|
See also
var sequencers:Array = getRunningSequencers();
getSequencer | () | method |
public final function getSequencer(event:Event):ISequenceCommand
Retrieves the sequence command instance using an event instance that has been created from this sequence command.
Parameters
event:Event — Event instance.
|
ISequenceCommand — A sequencer (ISequenceCommand).
|
See also
var sequencer:ISequenceCommand = getSequencer(myEvent);
getView | () | method |
public final function getView(viewName:String):Object
Retrieves the view instance that has been registered using its name.
Parameters
viewName:String — Name of the view.
|
Object — An Object instance.
|
See also
var mySprite:MySprite = getView(MySprite.NAME) as MySprite;
getViews | () | method |
public final function getViews():Dictionary
Retrieves all the view instances that have been registered to the framework.
ReturnsDictionary — A Dictionary (the key of the Dictionary is the name used for the registration).
|
See also
var sprites:Dictionary = getViews();
getWire | () | method |
public final function getWire(wireName:String):IWire
Retrieves the wire instance that has been registered using its name.
Parameters
wireName:String — Name of the wire.
|
IWire — A wire instance.
|
See also
var myWire:MyWire = getWire(MyWire.NAME) as MyWire;
getWires | () | method |
public final function getWires():Dictionary
Retrieves all the wire instances that have been registered to the framework.
ReturnsDictionary — A Dictionary (the key of the Dictionary is the name used for the registration).
|
See also
var wires:Dictionary = getWires();
hasCommand | () | method |
public final function hasCommand(commandName:String):Boolean
Indicates wether a command has been registered to the framework.
Parameters
commandName:String — Event type that is used as a command name.
|
Boolean — A Boolean.
|
See also
hasCommand(MyEvent.DOSOMETHING);
hasEventListener | () | method |
public final function hasEventListener(type:String):Boolean
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
Parameters
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type is registered; false otherwise.
|
hasModel | () | method |
public final function hasModel(modelName:String):Boolean
Indicates wether a model has been registered to the framework.
Parameters
modelName:String — Name of the model.
|
Boolean — A Boolean.
|
See also
hasModel(MyModel.NAME);
hasView | () | method |
public final function hasView(viewName:String):Boolean
Indicates wether a view has been registered to the framework.
Parameters
viewName:String — Name of the view.
|
Boolean — A Boolean.
|
See also
hasView(MySprite.NAME);
hasWire | () | method |
public final function hasWire(wireName:String):Boolean
Indicates wether a wire has been registered to the framework.
Parameters
wireName:String — Name of the wire.
|
Boolean — A Boolean.
|
See also
hasWire(MyWire.NAME);
initialize | () | method |
protected function initialize():void
Method that you can optionally overwrite and that is called after the command has been registered with the framework.
See also
isPartOfASequence | () | method |
public final function isPartOfASequence(event:Event):Boolean
Indicates wether an event has been instantiated from a ISequenceCommand class.
Parameters
event:Event |
Boolean — A Boolean.
|
See also
var inSequence:Boolean = isPartOfASequence(myEvent);
removeCommand | () | method |
public final function removeCommand(commandName:String):void
Removes a command from the framework.
Parameters
commandName:String — Event type that is used as a command name.
|
See also
removeCommand(MyEvent.DOSOMETHING);
removeEventListener | () | method |
public final function removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object. If there is no matching listener registered with the EventDispatcher object, a call to this method has no effect.
Parameters
type:String — The type of event.
| |
listener:Function — The listener object to remove.
| |
useCapture:Boolean (default = false ) — Specifies whether the listener was registered for the capture phase or the target and bubbling phases.
|
removeModel | () | method |
public final function removeModel(modelName:String):void
Removes a model from the framework and call the dispose method of this model.
Parameters
modelName:String — Name of the model.
|
See also
removeModel(MyModel.NAME);
removeView | () | method |
public final function removeView(viewName:String):void
Removes a view from the framework and call the (optional) dispose method of this view.
Parameters
viewName:String — Name of the view.
|
See also
removeView(MySprite.NAME);
removeWire | () | method |
public final function removeWire(wireName:String):void
Removes a wire from the framework and call the dispose method of this wire.
Parameters
wireName:String — Name of the wire.
|
See also
removeWire(MyWire.NAME);
stopAllSequencers | () | method |
public final function stopAllSequencers():void
Stops all the sequence command instances that are running.
See also
stopAllSequencers();
stopSequencer | () | method |
public final function stopSequencer(sequencer:ISequenceCommand):Boolean
Stops a sequence command using the sequence command instance itself.
Parameters
sequencer:ISequenceCommand — The sequence command instance.
|
Boolean — A Boolean (true if the sequence command has been stopped).
|
See also
var success:Boolean = stopSequencer(mySequenceCommand);
stopSequencerWithEvent | () | method |
public final function stopSequencerWithEvent(event:Event):Boolean
Stops a sequence command using an event instance that has been created from this sequence command.
Parameters
event:Event — Event instance.
|
Boolean — A Boolean (true if a sequence command has been stopped).
|
See also
var success:Boolean = stopSequencerWithEvent(myEvent);
willTrigger | () | method |
public final function willTrigger(type:String):Boolean
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
Parameters
type:String — The type of event.
|
Boolean — A value of true if a listener of the specified type will be triggered; false otherwise.
|
addCommand(MyEvent.DOSOMETHING, CommandExample); dispatchEvent(new MyEvent(MyEvent.DOSOMETHING));
package { import flash.events.Event; import com.soma.core.interfaces.ICommand; import com.soma.core.controller.Command; public class CommandExample extends Command implements ICommand { public function execute(event:Event):void { } } }
package { import flash.events.Event; import com.soma.core.interfaces.ICommandASync; import com.soma.core.controller.Command; public class CommandASyncExample extends Command implements ICommandASync { public function CommandASyncExample() { } public function execute(event:Event):void { } public function fault(info:Object):void { } public function result(data:Object):void { } } }