Packageorg.swizframework.core
Interfacepublic interface ISwizConfig
Implementors SwizConfig



Public Properties
 PropertyDefined By
  defaultDispatcher : String
Default Dispatcher to use for all Mediators and Dispatcher injections.
ISwizConfig
  defaultFaultHandler : Function
Default Fault Handler
ISwizConfig
  eventPackages : Array
When using strict mode, eventPackages allows you to use unqualified class/event names in your [Mediate] metadata.
ISwizConfig
  setUpEventPhase : uint
Swiz will listen for the setUp event in this event phase and perform injections in response.
ISwizConfig
  setUpEventPriority : int
Swiz will listen for the setUp event at the specified priority.
ISwizConfig
  setUpEventType : String
Swiz will listen for this event and process eligible views in response.
ISwizConfig
  strict : Boolean
Flag to enable runtime validation of mediated events.
ISwizConfig
  tearDownEventPhase : uint
Swiz will listen for the injection event at this specified injection event phase and perform injections in response.
ISwizConfig
  tearDownEventPriority : int
Swiz will listen for the tearDown event at the specified priority.
ISwizConfig
  tearDownEventType : String
Swiz will listen for this event and tear down views in response.
ISwizConfig
  viewPackages : Array
If this property is set, Swiz will only introspect and potentially inject into components added to the display list that match a provided package.
ISwizConfig
Property Detail
defaultDispatcherproperty
defaultDispatcher:String

Default Dispatcher to use for all Mediators and Dispatcher injections. Can be overriden with dispatcher property on those metadata tags.

The default value is null.


Implementation
    public function get defaultDispatcher():String
    public function set defaultDispatcher(value:String):void
defaultFaultHandlerproperty 
defaultFaultHandler:Function

Default Fault Handler

The default value is null.


Implementation
    public function get defaultFaultHandler():Function
    public function set defaultFaultHandler(value:Function):void
eventPackagesproperty 
eventPackages:Array

When using strict mode, eventPackages allows you to use unqualified class/event names in your [Mediate] metadata. For example, [Mediate( event="com.foo.events.MyEvent.FOO" )] can be shortened to [Mediate( event="MyEvent.FOO" )] if com.foo.events is provided as an eventPackage.

The default value is [].


Implementation
    public function get eventPackages():Array
    public function set eventPackages(value:Array):void
setUpEventPhaseproperty 
setUpEventPhase:uint

Swiz will listen for the setUp event in this event phase and perform injections in response. Default value is flash.events.EventPhase.CAPTURING_PHASE. Valid options are flash.events.EventPhase.BUBBLING_PHASE and flash.events.EventPhase.CAPTURE_PHASE.

The default value is flash.events.EventPhase.CAPTURING_PHASE.


Implementation
    public function get setUpEventPhase():uint
    public function set setUpEventPhase(value:uint):void
setUpEventPriorityproperty 
setUpEventPriority:int

Swiz will listen for the setUp event at the specified priority. Default value is 50. The priority level of the event listener. The priority is designated by a signed 32-bit integer. The higher the number, the higher the priority.

The default value is 50.


Implementation
    public function get setUpEventPriority():int
    public function set setUpEventPriority(value:int):void
setUpEventTypeproperty 
setUpEventType:String

Swiz will listen for this event and process eligible views in response. Default value is addedToStage. Potential alternatives are preinitialize, initialize, creationComplete and addedToStage. Any event can be used, but you should obviously favor events that happen once per component.

The default value is flash.events.Event.ADDED_TO_STAGE.


Implementation
    public function get setUpEventType():String
    public function set setUpEventType(value:String):void
strictproperty 
strict:Boolean

Flag to enable runtime validation of mediated events. If set to true, [Mediate( event="FooEvent.FOO", properties="username, password" )] will cause Swiz to validate that FooEvent exists, has a constant named FOO and has member variables named username and password.

The default value is false.


Implementation
    public function get strict():Boolean
    public function set strict(value:Boolean):void
tearDownEventPhaseproperty 
tearDownEventPhase:uint

Swiz will listen for the injection event at this specified injection event phase and perform injections in response. Default value is flash.events.EventPhase.CAPTURING_PHASE. Valid options are flash.events.EventPhase.BUBBLING_PHASE and flash.events.EventPhase.CAPTURE_PHASE.

The default value is flash.events.EventPhase.CAPTURING_PHASE.


Implementation
    public function get tearDownEventPhase():uint
    public function set tearDownEventPhase(value:uint):void
tearDownEventPriorityproperty 
tearDownEventPriority:int

Swiz will listen for the tearDown event at the specified priority. Default value is 50. The priority level of the event listener. The priority is designated by a signed 32-bit integer. The higher the number, the higher the priority.

The default value is 50.


Implementation
    public function get tearDownEventPriority():int
    public function set tearDownEventPriority(value:int):void
tearDownEventTypeproperty 
tearDownEventType:String

Swiz will listen for this event and tear down views in response. Default value is removedFromStage.

The default value is flash.events.Event.REMOVED_FROM_STAGE.


Implementation
    public function get tearDownEventType():String
    public function set tearDownEventType(value:String):void
viewPackagesproperty 
viewPackages:Array

If this property is set, Swiz will only introspect and potentially inject into components added to the display list that match a provided package. It is primarily for performance purposes and its use is strongly recommended. Beans declared in an IBeanProvider are always eligible for injection.

The default value is [].


Implementation
    public function get viewPackages():Array
    public function set viewPackages(value:Array):void