Configuration

Page Contents:

Configuration Overview

You configure each Swiz instance using the SwizConfig class. It allows you to modify common settings, and to provide values that allow your tags and code elsewhere to be more concise. Below is an example with all properties shown. Where applicable, they have been set to their default values. However, in most cases, the default values should work fine (see the note below on Configuration Defaults).

<swiz:Swiz>
	<swiz:beanProviders>
		<local:MyBeans />
	</swiz:beanProviders>

	<swiz:loggingTargets>
		<swiz:SwizTraceTarget id="myTraceTarget" />
	</swiz:loggingTargets>

	<swiz:config>
		<swiz:SwizConfig
			setUpEventType="{ Event.ADDED_TO_STAGE }" 
			setUpEventPhase="{ EventPhase.CAPTURING_PHASE }" 
			setUpEventPriority="50"
			tearDownEventType="{ Event.REMOVED_FROM_STAGE }" 
			tearDownEventPhase="{ EventPhase.CAPTURING_PHASE }" 
			tearDownEventPriority="50"
			eventPackages="com.foo.event.*, org.bar.event.*"
			viewPackages="com.foo.view.*, org.bar.view.*"
			defaultFaultHandler="handleUnhandledFaults"
			defaultDispatcher="global" />
	</swiz:config>
</swiz:Swiz>

Configuration Defaults

Unless you are specifying your own set up and tear down values, the only configuration values that commonly need to be set are eventPackages and viewPackages. If you are using Swiz's support for server communication, you may also set defaultFaultHandler.

Specifying Packages

Note that due to limitations in the AS3 reflection API, when you define eventPackages, you must specify each package individually. Children of your specified packages cannot be resolved and must be explicitly set. This limitation does not apply to viewPackages because they are handled differently, but for consistency it may be useful to use the same rules to define both sets of packages.

Logging

As you can see above, Swiz includes a basic logging target called SwizTraceTarget to trace debugging information to the console. Due to the way the MXMLC compiler works, it was not possible to use the built-in Flex logging target(s), because it increases the size of the Swiz swc by an unacceptable amount. If necessary, you can extend the AbstractSwizLoggingTarget to customize the output.

setUpEventType, setUpEventPhase and setUpEventPriority

These properties configure the listener that Swiz will use to trigger the set up of views (assuming they are eligible) to inject dependencies, create event handlers, etc. The default is a capture phase listener (to catch all views regardless of their place in the display list hierarchy) for the Event.ADDED_TO_STAGE event, with a priority of 50.

tearDownEventType, tearDownEventPhase and tearDownEventPriority

These properties configure the listener that Swiz will use to trigger the tearing down of views to clean up injected dependencies, remove event handlers, etc. The default is a capture phase listener for the Event.REMOVED_FROM_STAGE event, with a priority of 50.

Default Dispatcher

The default dispatcher value is "global". This means that in the case where a Swiz instance is the child of another Swiz instance, the child will use the parent dispatcher. This allows for easy communication between Swiz instances, since they all share the same event dispatcher. However, if you want to force a child Swiz to use it's own dispatcher, you can set this value to "local". In most cases, developers should not need to change the default value ("global"). More information on parent-child Swiz instances can be found in the section on Module support.