Package | org.swizframework.metadata |
Class | public class MediateMetadataTag |
Inheritance | MediateMetadataTag ![]() ![]() |
[Mediate]
metadata tags.
Property | Defined By | ||
---|---|---|---|
![]() | args : Array
Array of arguments defined in the tag. | BaseMetadataTag | |
![]() | asTag : String [read-only]
String showing what this tag looks like in code. | BaseMetadataTag | |
![]() | defaultArgName : 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 | ||
![]() | host : IMetadataHost
Element (class, method or property) on which the metadata tag is defined. | BaseMetadataTag | |
![]() | name : 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 |
Property | Defined By | ||
---|---|---|---|
![]() | _args : Array
Backing variable for args property. | BaseMetadataTag | |
![]() | _defaultArgName : String
Backing variable for defaultArgName property. | BaseMetadataTag | |
_event : String
Backing variable for read-only event property. | MediateMetadataTag | ||
![]() | _host : IMetadataHost
Backing variable for host property. | BaseMetadataTag | |
![]() | _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 |
Method | Defined By | ||
---|---|---|---|
Constructor sets defaultArgName. | MediateMetadataTag | ||
copyFrom(metadataTag:IMetadataTag):void [override]
Initialize properties based on values provided in [Mediate] tag. | MediateMetadataTag | ||
![]() | getArg(argName:String):MetadataArg | BaseMetadataTag | |
![]() | hasArg(argName:String):Boolean | BaseMetadataTag | |
![]() | toString():String
Utility method useful for development and debugging
that returns string showing what this tag looked like defined in code. | BaseMetadataTag |
_event | property |
protected var _event:String
Backing variable for read-only event
property.
_priority | property |
protected var _priority:int = 0
Backing variable for read-only priority
property.
_properties | property |
protected var _properties:Array
Backing variable for read-only properties
property.
_scope | property |
protected var _scope:String
Backing variable for read-only scope
property.
_stopImmediatePropagation | property |
protected var _stopImmediatePropagation:Boolean = false
Backing variable for read-only stopImmediatePropagation
property.
_stopPropagation | property |
protected var _stopPropagation:Boolean = false
Backing variable for read-only stopPropagation
property.
_useCapture | property |
protected var _useCapture:Boolean = false
Backing variable for read-only useCapture
property.
event | property |
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" )].
public function get event():String
priority | property |
priority:int
[read-only]
Returns priority attribute of [Mediate] tag.
Synonymous to the priority argument of flash.events.IEventDispatcher.addEventListener()
.
public function get priority():int
properties | property |
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.
public function get properties():Array
scope | property |
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
public function get scope():String
stopImmediatePropagation | property |
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
.
public function get stopImmediatePropagation():Boolean
stopPropagation | property |
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
.
public function get stopPropagation():Boolean
useCapture | property |
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
.
public function get useCapture():Boolean
MediateMetadataTag | () | Constructor |
public function MediateMetadataTag()
Constructor sets defaultArgName
.
copyFrom | () | method |
override public function copyFrom(metadataTag:IMetadataTag):void
Initialize properties based on values provided in [Mediate] tag.
Parameters
metadataTag:IMetadataTag |