| Package | com.threerings.util |
| Class | public class CommandEvent |
| Inheritance | CommandEvent  flash.events.Event |
| Property | Defined by | ||
|---|---|---|---|
| arg : Object An optional argument.
| CommandEvent | ||
| command : String The command.
| CommandEvent | ||
| Property | Defined by | ||
|---|---|---|---|
| _blockConstructor : Boolean = true [static] Used to prevent unauthorized construction.
| CommandEvent | ||
| Method | Defined by | ||
|---|---|---|---|
|
CommandEvent(command:String, arg:Object)
Command events may not be directly constructed, use the dispatch
method to do your work.
| CommandEvent | ||
|
clone():Event
| CommandEvent | ||
|
configureBridge(source:IEventDispatcher, target:IEventDispatcher):void
[static]
Configure a bridge from something like a pop-up window to an alternate target.
| CommandEvent | ||
|
dispatch(disp:IEventDispatcher, cmdOrFn:Object, arg:Object = null):void
[static]
Use this method to dispatch CommandEvents.
| CommandEvent | ||
|
markAsHandled():void
Mark this command as handled, stopping its propagation up the
hierarchy.
| CommandEvent | ||
|
toString():String
| CommandEvent | ||
| Method | Defined by | ||
|---|---|---|---|
|
create(cmd:String, arg:Object):CommandEvent
[static]
A factory method for privately creating command events.
| CommandEvent | ||
| Constant | Defined by | ||
|---|---|---|---|
| COMMAND : String = "commandEvt" [static] The event type for all controller events.
| CommandEvent | ||
| arg | property |
public var arg:ObjectAn optional argument.
| _blockConstructor | property |
protected static var _blockConstructor:Boolean = trueUsed to prevent unauthorized construction.
| command | property |
public var command:StringThe command.
| CommandEvent | () | constructor |
public function CommandEvent(command:String, arg:Object)Command events may not be directly constructed, use the dispatch method to do your work.
Parameterscommand:String |
|
arg:Object |
| clone | () | method |
public override function clone():Event
Returns
Event |
| configureBridge | () | method |
public static function configureBridge(source:IEventDispatcher, target:IEventDispatcher):voidConfigure a bridge from something like a pop-up window to an alternate target.
Parameterssource:IEventDispatcher |
|
target:IEventDispatcher |
| create | () | method |
protected static function create(cmd:String, arg:Object):CommandEventA factory method for privately creating command events.
Parameterscmd:String |
|
arg:Object |
CommandEvent |
| dispatch | () | method |
public static function dispatch(disp:IEventDispatcher, cmdOrFn:Object, arg:Object = null):voidUse this method to dispatch CommandEvents.
Parametersdisp:IEventDispatcher |
|
cmdOrFn:Object |
|
arg:Object (default = null) |
| markAsHandled | () | method |
public function markAsHandled():voidMark this command as handled, stopping its propagation up the hierarchy.
| toString | () | method |
public override function toString():String
Returns
String |
| COMMAND | constant |
public static const COMMAND:String = "commandEvt"The event type for all controller events.