Packageorg.swizframework.metadata
Classpublic class Mediator
InheritanceMediator Inheritance Object

Represents a deferred request for mediation.



Public Properties
 PropertyDefined By
  metadataTag : MediateMetadataTag
[read-only] The corresponding [Mediate] tag.
Mediator
  method : Function
[read-only] The function decorated with the [Mediate] tag.
Mediator
Protected Properties
 PropertyDefined By
  _metadataTag : MediateMetadataTag
Backing variable for metadata property.
Mediator
  _method : Function
Backing variable for method property.
Mediator
Public Methods
 MethodDefined By
  
Mediator(metadataTag:MediateMetadataTag, method:Function)
Constructor
Mediator
  
mediate(event:Event):void
Mediate
Mediator
Protected Methods
 MethodDefined By
  
getEventArgs(event:Event, properties:Array):Array
Get Event Arguments
Mediator
  
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
Property Detail
_metadataTagproperty
protected var _metadataTag:MediateMetadataTag

Backing variable for metadata property.

_methodproperty 
protected var _method:Function

Backing variable for method property.

metadataTagproperty 
metadataTag:MediateMetadataTag  [read-only]

The corresponding [Mediate] tag.


Implementation
    public function get metadataTag():MediateMetadataTag
methodproperty 
method:Function  [read-only]

The function decorated with the [Mediate] tag.


Implementation
    public function get method():Function
Constructor Detail
Mediator()Constructor
public function Mediator(metadataTag:MediateMetadataTag, method:Function)

Constructor

Parameters
metadataTag:MediateMetadataTag
 
method:Function
Method Detail
getEventArgs()method
protected function getEventArgs(event:Event, properties:Array):Array

Get Event Arguments

Parameters

event:Event
 
properties:Array

Returns
Array
getParameterCount()method 
protected function getParameterCount():int

Get Parameter Count

Returns
int
getParameterType()method 
protected function getParameterType(parameterIndex:int):Class

Get Parameter Type

Parameters

parameterIndex:int — The index of parameter of the mediated method.

Returns
Class
getRequiredParameterCount()method 
protected function getRequiredParameterCount():int

Get Required Parameter Count

Returns
int
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.

Returns
Boolean