new Command(options)
conbo.Command
Base class for commands to be registered in your Context
using mapCommand(...)
Parameters:
| Name | Type | Description |
|---|---|---|
options |
Object | Object containing optional initialisation options, including 'context' (Context) |
Extends
Members
context :conbo.Context
Application context
Type:
event :conbo.Event
The event that caused this command to execute
Type:
supro
Similar to `super` in ActionScript or Java, this property enables
you to access properties and methods of the super class prototype,
which is the case of JavaScript is the next prototype up the chain
- Inherited From:
- Source:
Methods
bindAll(…methodNameopt) → {this}
Scope all methods of this class instance to this class instance
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
methodName |
string |
<optional> <repeatable> |
Specific method names to bind (all will be bound if none specified) |
- Inherited From:
- Source:
Returns:
- Type
- this
constructor(optionsopt)
Constructor: DO NOT override! (Use initialize instead)
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
options |
Object | conbo.Context |
<optional> |
Options object |
- Inherited From:
- Source:
declarations() → {void}
Declarations is used to declare instance properties used by this class
Parameters:
| Type | Attributes | Description |
|---|---|---|
| * |
<repeatable> |
- Inherited From:
- Source:
Returns:
- Type
- void
destroy() → {void}
Clean everything up ready for garbage collection (you should override in your own classes)
- Inherited From:
- Source:
Returns:
- Type
- void
execute()
Execute: should be overridden
When a Command is called in response to an event registered with the
Context, the class is instantiated, this method is called then the
class instance is destroyed
initialize() → {void}
Initialize (entry point) is called immediately after the constructor has completed
Parameters:
| Type | Attributes | Description |
|---|---|---|
| * |
<repeatable> |
- Inherited From:
- Source:
Returns:
- Type
- void
preinitialize() → {void}
Preinitialize is called before any code in the constructor has been run
Parameters:
| Type | Attributes | Description |
|---|---|---|
| * |
<repeatable> |
- Inherited From:
- Source:
Returns:
- Type
- void
toString() → {string}
String representation of the current class
- Overrides:
- Source:
Returns:
- Type
- string