The html-wrapper Flex Ant task generates files that you deploy with your Flex applications. In its simplest form, an HTML wrapper consists of an <object> and an <embed> tag that embed the SWF file in an HTML page.

The html-wrapper task outputs the index.html and AC_OETags.js files for your Flex application. If you enable deep linking support, the html-wrapper task also outputs the deep linking files such as historyFrame.html, history.css, and history.js. If you enable express installation, the html-wrapper task also outputs the playerProductInstall.swf file.

You typically deploy these files, along with your application's SWF file, to a web server. Users request the HTML wrapper, which embeds the SWF file. You can customize the output of the wrapper and its supporting files after it is generated by Ant.

For more information on the HTML wrapper, see Creating a Wrapper.

About the templates

There are six types of HTML wrapper templates that you can generate with the html-wrapper Flex Ant task:

• Client-side detection only -- Provides scripts that detect the version of the client's player and return alternative content if the client's player does not meet the minimum required version.
• Client-side detection with history -- Provides the same scripts as those in the client-side-detection template, but adds deep linking support.
• Express installation -- Provides scripts that support Express Install.
• Express installation with history -- Provides scripts that support Express Install and deep linking support.
• No player detection -- Provides a basic wrapper.
• No player detection with history -- Provides a basic wrapper with deep linking support.

You determine which template is used by using a combination of the history and template attributes of the html-wrapper task.

Supported attributes

The attributes of the html-wrapper task correspond to some of the attributes and parameters of the <object> and <embed> tags in the HTML wrapper. The task also supports some attributes that specify the output location and the type of wrapper to generate. For a complete list of the attributes and parameters of the <object> and <embed> tags in the HTML wrapper, see About the object and embed tags.

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

Required attributes

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

height="400"
width="400"
template="express-installation"
bgcolor="white"
history="false"
title="Flex Application"

Be sure to use only the filename and not the filename and extension when specifying the value of the swf attribute. The html-wrapper task appends .swf to the end of its value.

For example, do this:

swf="Main"

Do not do this:

swf="Main.swf"

Unsupported options

You cannot set all the available <object> and <embed> tag parameters using the html-wrapper task. 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 and player detection logic. This target 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:/flex3/sdk"/>
    <property name="APP_ROOT" value="apps"/>
    <target name="wrapper">
        <html-wrapper 
            title="Welcome to My Flex App"
            file="index.html"
            height="300"
            width="400"
            bgcolor="red"
            application="app"
            swf="Main"
            version-major="9"
            version-minor="0"
            version-revision="0"
            history="true"
            template="express-installation"
            output="${APP_ROOT}"/>
    </target>
    <target name="clean">
        <delete>
            <!-- Deletes playerProductInstall.swf -->
            <fileset dir="${APP_ROOT}" 
                includes="playerProductInstall.swf" 
                defaultexcludes="false"/>
            <!-- Deletes index.html and historyFrame.html -->
            <fileset dir="${APP_ROOT}" includes="*.html" defaultexcludes="false"/>
            <!-- Deletes history.css -->
            <fileset dir="${APP_ROOT}" includes="*.css" defaultexcludes="false"/>
            <!-- Deletes history.js and AC_OETags.js -->
            <fileset dir="${APP_ROOT}" includes="*.js" defaultexcludes="false"/>
        </delete>
    </target>
</project>