Package | org.swizframework.utils.commands |
Class | public class CommandMap |
Inheritance | CommandMap ![]() |
Implements | ISwizAware |
Property | Defined By | ||
---|---|---|---|
swiz : ISwiz [write-only]
Setter to satisfy ISwizAware interface contract. | CommandMap |
Property | Defined By | ||
---|---|---|---|
map : Dictionary
Dictionary to hold mappings. | CommandMap | ||
_swiz : ISwiz
Backing variable for swiz setter. | CommandMap |
Method | Defined By | ||
---|---|---|---|
handleCommandEvent(event:Event):void
Handler method triggered when a mapped event is caught. | CommandMap | ||
mapCommand(eventType:String, commandClass:Class, eventClass:Class = null, oneTime:Boolean = false):void
Method that performs actual event to command mapping. | CommandMap | ||
mapCommands():void
Abstract method that sub classes should override and populate with calls to mapCommand(). | CommandMap |
_swiz | property |
protected var _swiz:ISwiz
Backing variable for swiz setter.
map | property |
protected var map:Dictionary
Dictionary to hold mappings.
swiz | property |
swiz:ISwiz
[write-only] Setter to satisfy ISwizAware interface contract.
public function set swiz(value:ISwiz):void
See also
handleCommandEvent | () | method |
protected function handleCommandEvent(event:Event):void
Handler method triggered when a mapped event is caught.
Parameters
event:Event |
mapCommand | () | method |
protected function mapCommand(eventType:String, commandClass:Class, eventClass:Class = null, oneTime:Boolean = false):void
Method that performs actual event to command mapping.
Parameters
eventType:String | |
commandClass:Class | |
eventClass:Class (default = null )
| |
oneTime:Boolean (default = false )
|
mapCommands | () | method |
protected function mapCommands():void
Abstract method that sub classes should override and populate with calls to mapCommand()
.
Mapping commands here (and letting it be called for you) ensures all the necessary pieces have
been provided before attempting to create any mappings.