Required attributes

The mxmlc task requires the file attribute. The file attribute specifies the MXML file to compile. This attribute does not have a command-line equivalent because it is the default option on the command line.

Unsupported options

The following mxmlc command-line compiler options are not supported by the mxmlc task:

• help

• version

Example

The following example mxmlc task explicitly defines the source-path and library-path options, in addition to other properties such as incremental and keep-generated-actionscript. This example also specifies an output location for the resulting SWF file. This example defines two targets: main and clean. The main target compiles the Main.mxml file into a SWF file. The clean target deletes the output of the main target.

 <?xml version="1.0" encoding="utf-8"?> 
 <!-- myMXMLCBuild.xml --> 
 <project name="My App Builder" basedir="."> 
 	<taskdef resource="flexTasks.tasks" classpath="${basedir}/flexTasks/lib/flexTasks.jar" /> 
 	<property name="FLEX_HOME" value="C:/flex/sdk"/> 
 	<property name="APP_ROOT" value="apps"/> 
 	<property name="DEPLOY_DIR" value="c:/jrun4/servers/default/default-war"/> 
 	<target name="main"> 
 		<mxmlc  
 			file="${APP_ROOT}/Main.mxml"  
 			output="${DEPLOY_DIR}/Main.swf" 
 			actionscript-file-encoding="UTF-8" 
 			keep-generated-actionscript="true" 
 			incremental="true"> 
 			<!-- Get default compiler options. --> 
 			<load-config filename="${FLEX_HOME}/frameworks/flex-config.xml"/> 
  
 			<!-- List of path elements that form the roots of ActionScript 
			class hierarchies. --> 
 			<source-path path-element="${FLEX_HOME}/frameworks"/> 
  
 			<!-- List of SWC files or directories that contain SWC files. --> 
 			<compiler.library-path dir="${FLEX_HOME}/frameworks" append="true"> 
 				<include name="libs" /> 
 				<include name="../bundles/{locale}" /> 
 			</compiler.library-path> 
  
 			<!-- Set size of output SWF file. --> 
 			<default-size width="500" height="600" /> 
 		</mxmlc> 
 	</target> 
 	<target name="clean"> 
 		<delete dir="${APP_ROOT}/generated"/> 
 		<delete> 
 			<fileset dir="${DEPLOY_DIR}" includes="Main.swf"/> 
 		</delete> 
 	</target> 
 </project>

Required attributes

The only required attribute for the compc task is the output attribute, which specifies the name of the SWC file that the compc task creates.

Special attributes

The include-classes attribute takes a space-delimited list of class names. For example:

 <compc include-classes="custom.MyPanel custom.MyButton" ... > 
 	... 
 </compc>

When using the include-resource-bundles attribute, you should not specify them as a comma or space-delimited list in a single entry. Instead, add a separate child tag for each resource bundle that you want to include, as the following example shows:

 <compc output="${swf.output}/compc_rb.swc" locale="en_US"> 
 	<include-resource-bundles bundle="ErrorLog"/> 
 	<include-resource-bundles bundle="LabelResource"/> 
 	<sp path-element="locale/{locale}"/>  
 </compc>

Unsupported options

The following compc command-line compiler options are not supported by the compc task:

• help

• version

Example

The following example compc task builds a new SWC file that contains two custom components and other assets. The components are added to the SWC file by using the include-classes attribute. The source files for the components are in a subdirectory called components. The other assets, including four images and a CSS file, are added to the SWC file by using the include-file element.

This example defines two targets: main and clean. The main target compiles the MyComps.swc file. The clean target deletes the output of the main target.

 <?xml version="1.0" encoding="utf-8"?> 
 <project name="My Component Builder" basedir="."> 
 	<taskdef resource="flexTasks.tasks" classpath="${basedir}/flexTasks/lib/flexTasks.jar" /> 
 	<property name="FLEX_HOME" value="C:/flex/sdk"/> 
 	<property name="DEPLOY_DIR" value="c:/jrun4/servers/default/default-war"/> 
 	<property name="COMPONENT_ROOT" value="components"/> 
 	<target name="main"> 
 		<compc  
 			output="${DEPLOY_DIR}/MyComps.swc" 
 			include-classes="custom.MyButton custom.MyLabel"> 
 			<source-path path-element="${basedir}/components"/> 
 			<include-file name="f1-1.jpg" path="assets/images/f1-1.jpg"/> 
 			<include-file name="f1-2.jpg" path="assets/images/f1-2.jpg"/> 
 			<include-file name="f1-3.jpg" path="assets/images/f1-3.jpg"/> 
 			<include-file name="f1-4.jpg" path="assets/images/f1-4.jpg"/> 
 			<include-file name="main.css" path="assets/css/main.css"/> 
 		</compc> 
 	</target> 
 	<target name="clean"> 
 		<delete> 
 			<fileset dir="${DEPLOY_DIR}" includes="MyComps.swc"/> 
 		</delete> 
 	</target> 
 </project>

Supported attributes

The attributes of the html-wrapper task correspond to some of the arguments in the swfobject.embedSWF() method of the default HTML wrapper.

The following table describes the supported attributes of the html-wrapper task:

application

bgcolor

file

height

history

output

swf

title

version-major

version-minor

version-revision

width

Required attributes

The html-wrapper task requires the swf attribute. If you specify only the swf attribute, the default wrapper will have the following settings:

 title="Flex Application" 
swfVersionStr = "10.0.0"; 
params.quality = "high"; 
params.bgcolor = "white"; 
params.allowscriptaccess = "sameDomain"; 
params.allowfullscreen = "true"; 
attributes.align = "middle"; 
 height="400" 
 width="400" 

Be sure to use the filename only and not the filename plus extension when specifying the value of the swf attribute. The html-wrapper task appends .swf to the end of its value before passing it to the embedSWF() method.

For example, do this:

 swf="Main"

Do not do this:

 swf="Main.swf"

Unsupported options

The html-wrapper task does not support all properties used by SWFObject 2 to embed a SWF file in an HTML wrapper. Parameters you cannot set include quality, allowScriptAccess, classid, pluginspage, and type.

Example

The following example project includes a wrapper target that uses the html-wrapper task to generate a wrapper with deep linking, Player detection, and Express Install logic. This target (wrapper) also sets the height and width of the SWF file. The project also includes a clean target that deletes all the files generated by the wrapper target.

 <?xml version="1.0" encoding="utf-8"?> 
<!-- myWrapperBuild.xml --> 
<project name="My Wrapper Builder" basedir="."> 
	<taskdef resource="flexTasks.tasks" classpath="${basedir}/lib/flexTasks.jar"/> 
	<property name="FLEX_HOME" value="C:/p4/flex/flex/sdk"/> 
	<property name="APP_ROOT" value="c:/temp/ant/wrapper"/> 
	<target name="wrapper"> 
		<html-wrapper 
			title="Welcome to My Flex App" 
			file="index.html" 
			height="300" 
			width="400" 
			application="app" 
			swf="Main" 
			history="true" 
			express-install="true" 
			version-detection="true" 
			output="${APP_ROOT}"/> 
	</target> 
	<target name="clean"> 
		<delete> 
			<!-- Deletes playerProductInstall.swf --> 
			<fileset dir="${APP_ROOT}" 
				includes="playerProductInstall.swf" 
				defaultexcludes="false"/> 
			<!-- Deletes the swfobject.js file --> 
			<fileset dir="${APP_ROOT}" includes="*.js" defaultexcludes="false"/> 
			<!-- Deletes the previously-generated HTML wrapper file --> 
			<fileset dir="${APP_ROOT}" includes="*.html" defaultexcludes="false"/> 
			<!-- Deletes the history files --> 
			<fileset dir="${APP_ROOT}/history" includes="*.*" defaultexcludes="false"/> 
		</delete> 
	</target> 
</project> 

Required attributes

The asdoc Ant task requires that you specify a target class or classes to generate ASDoc for. This must be either a list of one or more classes, a directory of classes, or a namespace. You specify these by using the doc-classes, doc-sources, or doc-namespaces attributes.

If you use the doc-classes or doc-namespaces attributes, you must also specify a source-path argument. If you use the doc-namespaces attribute, you must also specify a namespace attribute.

It's best to specify a value for the output attribute. If you do not specify a value, Ant creates a directory called asdoc-output in the same directory that you launched the command from. Ant then stores the HTML output files in that new directory.

Unsupported options

All options of the asdoc utility are supported by the asdoc Ant task.

Example

<?xml version="1.0" encoding="utf-8"?> 
<project name="ASDoc Builder" basedir="."> 
	<property name="FLEX_HOME" value="C:/p4/flex/flex/sdk"/> 
	<property name="OUTPUT_DIR" value="C:/temp/ant/asdoc"/> 
	<taskdef resource="flexTasks.tasks" classpath="${FLEX_HOME}/ant/lib/flexTasks.jar" /> 
	<target name="doc"> 
		<asdoc output="${OUTPUT_DIR}" lenient="true" failonerror="true"> 
			<doc-sources 
				path-element="${FLEX_HOME}/frameworks/projects/spark/src/spark/components/Button.as"/> 
			<doc-sources 
				path-element="${FLEX_HOME}/frameworks/projects/framework/src/mx/controls/Button.as"/> 
		</asdoc> 
	</target> 
	<target name="clean"> 
		<delete includeEmptyDirs="true"> 
			<fileset dir="${OUTPUT_DIR}" includes="**/*"/> 
		</delete> 
	</target> 
</project>

You will have to change the values of the Flex home and output directory to match the locations of the directories on your file system.

To run this example, you can use the following Ant command:

ant clean doc

This example generates simple ASDoc output for the Spark and MX Button controls by using the doc-sources attribute. The output does not include all the parent classes that provide the inherited methods, properties, events, and other members of the Button controls.

To generate ASDoc that includes the parent classes of the Button controls, you can use an Ant task that uses the doc-classes attribute. When you do this, you must be sure to also define the source-path for the classes.

<?xml version="1.0" encoding="utf-8"?> 
<project name="ASDoc Builder" basedir="."> 
	<property name="FLEX_HOME" value="C:/p4/flex/flex/sdk"/> 
	<property name="OUTPUT_DIR" value="C:/temp/ant/asdoc"/> 
	<taskdef resource="flexTasks.tasks" classpath="${FLEX_HOME}/ant/lib/flexTasks.jar" /> 
	<target name="doc"> 
		<asdoc output="${OUTPUT_DIR}" lenient="true" failonerror="true"> 
			<compiler.source-path 
				path-element="${FLEX_HOME}/frameworks/projects/framework/src"/> 
			<doc-classes class="mx.controls.Button"/> 
		</asdoc> 
	</target> 
	<target name="clean"> 
		<delete includeEmptyDirs="true"> 
			<fileset dir="${OUTPUT_DIR}" includes="**/*"/> 
		</delete> 
	</target> 
</project>

You can also define an asdoc Ant task that includes all components in a particular namespace by using the doc-namespaces attribute. When you want to document all classes in a namespace, you must also point to the manifest file for that namespace by using the namespace attribute.

<?xml version="1.0" encoding="utf-8"?> 
<project name="ASDoc Builder" basedir="."> 
	<property name="FLEX_HOME" value="C:/p4/flex/flex/sdk"/> 
	<property name="OUTPUT_DIR" value="C:/temp/ant/asdoc"/> 
	<taskdef resource="flexTasks.tasks" classpath="${FLEX_HOME}/ant/lib/flexTasks.jar" /> 
	<target name="doc"> 
		<asdoc output="${OUTPUT_DIR}" lenient="true" failonerror="true"> 
			<compiler.source-path 
				path-element="${FLEX_HOME}/frameworks/projects/spark/src"/> 
			<doc-namespaces uri="library://ns.adobe.com/flex/spark"/> 
			<namespace 
				uri="library://ns.adobe.com/flex/spark" 
				manifest="${FLEX_HOME}/frameworks/projects/spark/manifest.xml"/> 
		</asdoc> 
	</target> 
	<target name="clean"> 
		<delete includeEmptyDirs="true"> 
			<fileset dir="${OUTPUT_DIR}" includes="**/*"/> 
		</delete> 
	</target> 
</project>

In this example, only the members that are inherited from other classes in the Spark namespace are added to the ASDoc output.

The flex-config.xml file contains a list of predefined namespace URIs and the locations of their manifest files. As a result, if you use the asdoc Ant task to generate ASDoc for one of these namespaces, and not a custom namespace, then you are not required to define the location of the manifest file. This is because the asdoc Ant task reads in their definitions. It is, however, best practice to define the manifest file location for all namespaces.