Packageorg.swizframework.metadata
Classpublic class MediateMetadataTag
InheritanceMediateMetadataTag Inheritance BaseMetadataTag Inheritance Object

Class to represent [Mediate] metadata tags.



Public Properties
 PropertyDefined By
 Inheritedargs : Array
Array of arguments defined in the tag.
BaseMetadataTag
 InheritedasTag : String
[read-only] String showing what this tag looks like in code.
BaseMetadataTag
 InheriteddefaultArgName : String
Name that will be assumed/used when a default argument value is provided, e.g.
BaseMetadataTag
  event : String
[read-only] Returns event attribute of [Mediate] tag.
MediateMetadataTag
 Inheritedhost : IMetadataHost
Element (class, method or property) on which the metadata tag is defined.
BaseMetadataTag
 Inheritedname : String
Name of the tag, e.g.
BaseMetadataTag
  priority : int
[read-only] Returns priority attribute of [Mediate] tag.
MediateMetadataTag
  properties : Array
[read-only] Returns properties attribute of [Mediate] tag as an Array.
MediateMetadataTag
  scope : String
[read-only] Returns scope attribute of [Mediate] tag as a String.
MediateMetadataTag
  stopImmediatePropagation : Boolean
[read-only] Returns stopImmediatePropagation attribute of [Mediate] tag as a Boolean.
MediateMetadataTag
  stopPropagation : Boolean
[read-only] Returns stopPropagation attribute of [Mediate] tag as a Boolean.
MediateMetadataTag
  useCapture : Boolean
[read-only] Returns useCapture attribute of [Mediate] tag as a Boolean.
MediateMetadataTag
Protected Properties
 PropertyDefined By
 Inherited_args : Array
Backing variable for args property.
BaseMetadataTag
 Inherited_defaultArgName : String
Backing variable for defaultArgName property.
BaseMetadataTag
  _event : String
Backing variable for read-only event property.
MediateMetadataTag
 Inherited_host : IMetadataHost
Backing variable for host property.
BaseMetadataTag
 Inherited_name : String
Backing variable for name property.
BaseMetadataTag
  _priority : int = 0
Backing variable for read-only priority property.
MediateMetadataTag
  _properties : Array
Backing variable for read-only properties property.
MediateMetadataTag
  _scope : String
Backing variable for read-only scope property.
MediateMetadataTag
  _stopImmediatePropagation : Boolean = false
Backing variable for read-only stopImmediatePropagation property.
MediateMetadataTag
  _stopPropagation : Boolean = false
Backing variable for read-only stopPropagation property.
MediateMetadataTag
  _useCapture : Boolean = false
Backing variable for read-only useCapture property.
MediateMetadataTag
Public Methods
 MethodDefined By
  
Constructor sets defaultArgName.
MediateMetadataTag
  
copyFrom(metadataTag:IMetadataTag):void
[override] Initialize properties based on values provided in [Mediate] tag.
MediateMetadataTag
 Inherited
getArg(argName:String):MetadataArg
BaseMetadataTag
 Inherited
hasArg(argName:String):Boolean
BaseMetadataTag
 Inherited
toString():String
Utility method useful for development and debugging that returns string showing what this tag looked like defined in code.
BaseMetadataTag
Property Detail
_eventproperty
protected var _event:String

Backing variable for read-only event property.

_priorityproperty 
protected var _priority:int = 0

Backing variable for read-only priority property.

_propertiesproperty 
protected var _properties:Array

Backing variable for read-only properties property.

_scopeproperty 
protected var _scope:String

Backing variable for read-only scope property.

_stopImmediatePropagationproperty 
protected var _stopImmediatePropagation:Boolean = false

Backing variable for read-only stopImmediatePropagation property.

_stopPropagationproperty 
protected var _stopPropagation:Boolean = false

Backing variable for read-only stopPropagation property.

_useCaptureproperty 
protected var _useCapture:Boolean = false

Backing variable for read-only useCapture property.

eventproperty 
event:String  [read-only]

Returns event attribute of [Mediate] tag. Refers to the event type that will trigger the decorated method. Is the default attribute, meaning [Mediate( "someEvent" )] is equivalent to [Mediate( event="someEvent" )].


Implementation
    public function get event():String
priorityproperty 
priority:int  [read-only]

Returns priority attribute of [Mediate] tag. Synonymous to the priority argument of flash.events.IEventDispatcher.addEventListener().


Implementation
    public function get priority():int
propertiesproperty 
properties:Array  [read-only]

Returns properties attribute of [Mediate] tag as an Array. Lists properties that will be pulled off of the event object and passed to the decorated method.


Implementation
    public function get properties():Array
scopeproperty 
scope:String  [read-only]

Returns scope attribute of [Mediate] tag as a String. Defines which dispatcher to attach this mediator to on the owning Swiz instance. Acceptable values are local, global and [parent], defined as constants on SwizConfig


Implementation
    public function get scope():String
stopImmediatePropagationproperty 
stopImmediatePropagation:Boolean  [read-only]

Returns stopImmediatePropagation attribute of [Mediate] tag as a Boolean. Synonymous to the stopImmediatePropagation method of flash.events.Event.

The default value is false.


Implementation
    public function get stopImmediatePropagation():Boolean
stopPropagationproperty 
stopPropagation:Boolean  [read-only]

Returns stopPropagation attribute of [Mediate] tag as a Boolean. Synonymous to the stopPropagation method of flash.events.Event.

The default value is false.


Implementation
    public function get stopPropagation():Boolean
useCaptureproperty 
useCapture:Boolean  [read-only]

Returns useCapture attribute of [Mediate] tag as a Boolean. Synonymous to the useCapture argument of flash.events.IEventDispatcher.addEventListener().

The default value is false.


Implementation
    public function get useCapture():Boolean
Constructor Detail
MediateMetadataTag()Constructor
public function MediateMetadataTag()

Constructor sets defaultArgName.

Method Detail
copyFrom()method
override public function copyFrom(metadataTag:IMetadataTag):void

Initialize properties based on values provided in [Mediate] tag.

Parameters

metadataTag:IMetadataTag