Package | org.swizframework.metadata |
Class | public class Mediator |
Inheritance | Mediator ![]() |
Property | Defined By | ||
---|---|---|---|
metadataTag : MediateMetadataTag [read-only]
The corresponding [Mediate] tag. | Mediator | ||
method : Function [read-only]
The function decorated with the [Mediate] tag. | Mediator |
Property | Defined By | ||
---|---|---|---|
_metadataTag : MediateMetadataTag
Backing variable for metadata property. | Mediator | ||
_method : Function
Backing variable for method property. | Mediator |
Method | Defined By | ||
---|---|---|---|
Mediator(metadataTag:MediateMetadataTag, method:Function)
Constructor
| Mediator | ||
mediate(event:Event):void
Mediate
| Mediator |
Method | Defined By | ||
---|---|---|---|
getEventArgs(event:Event, properties:Array):Array
Get Event Arguments
| Mediator | ||
getParameterCount():int
Get Parameter Count
| Mediator | ||
getParameterType(parameterIndex:int):Class
Get Parameter Type
| Mediator | ||
Get Required Parameter Count
| Mediator | ||
validateEvent(event:Event, properties:Array):Boolean
Validate Event
Evalutes an Event to ensure it has all of the required properties specified in the [Mediate] tag, if applicable. | Mediator |
_metadataTag | property |
protected var _metadataTag:MediateMetadataTag
Backing variable for metadata
property.
_method | property |
protected var _method:Function
Backing variable for method
property.
metadataTag | property |
metadataTag:MediateMetadataTag
[read-only] The corresponding [Mediate] tag.
public function get metadataTag():MediateMetadataTag
method | property |
method:Function
[read-only] The function decorated with the [Mediate] tag.
public function get method():Function
Mediator | () | Constructor |
public function Mediator(metadataTag:MediateMetadataTag, method:Function)
Constructor
ParametersmetadataTag:MediateMetadataTag | |
method:Function |
getEventArgs | () | method |
protected function getEventArgs(event:Event, properties:Array):Array
Get Event Arguments
Parameters
event:Event | |
properties:Array |
Array |
getParameterCount | () | method |
protected function getParameterCount():int
Get Parameter Count
Returnsint |
getParameterType | () | method |
protected function getParameterType(parameterIndex:int):Class
Get Parameter Type
Parameters
parameterIndex:int — The index of parameter of the mediated method.
|
Class |
getRequiredParameterCount | () | method |
protected function getRequiredParameterCount():int
Get Required Parameter Count
Returnsint |
mediate | () | method |
public function mediate(event:Event):void
Mediate
Parameters
event:Event — The Event to mediate.
|
validateEvent | () | method |
protected function validateEvent(event:Event, properties:Array):Boolean
Validate Event Evalutes an Event to ensure it has all of the required properties specified in the [Mediate] tag, if applicable.
Parameters
event:Event — The Event to validate.
| |
properties:Array — The required properties specified in the [Mediate] tag.
|
Boolean |