html-wrapper Flex Ant タスクは、Flex アプリケーションと共に展開するファイルを生成します。もっともシンプルな形式では、HTML ラッパーは、HTML ページに SWF ファイルを埋め込む <object> と <embed> の各タグで構成されます。

html-wrapper タスクは、Flex アプリケーションで使用される index.html と AC_OETags.js ファイルを出力します。ディープリンクサポートを有効にすると、html-wrapper タスクは、さらに historyFrame.html、history.css、history.js などのディープリンクファイルを出力します。高速インストールを有効にすると、html-wrapper タスクは playerProductInstall.swf ファイルも出力します。

通常は、これらの出力ファイルは、アプリケーションの SWF ファイルと共に Web サーバーに展開されます。ユーザーは、SWF ファイルが埋め込まれる HTML ラッパーを要求します。Ant によってラッパーとそのサポートファイルが出力されたら、それらをカスタマイズすることができます。

HTML ラッパーの詳細については、ラッパーの作成を参照してください。

テンプレートについて

html-wrapper Flex Ant タスクでは、次の 6 種類 の HTML ラッパーテンプレートを生成できます。

• クライアントサイド検出のみ。クライアントのプレーヤーのバージョンを検出し、クライアントのプレーヤーが必要最小限のバージョンを満たしていない場合に、代替コンテンツを返します。
• 履歴付きのクライアントサイド検出。クライアントサイド検出のみのテンプレートと同じスクリプトを提供し、さらにディープリンクサポートを提供します。
• 高速インストール。高速インストールをサポートするスクリプトを提供します。
• 履歴付き高速インストール。高速インストールとディープリンクをサポートするスクリプトを提供します。
• プレーヤー検出なし。基本のラッパーを提供します。
• 履歴付きプレーヤー検出なし。ディープリンクサポート付きの基本のラッパーを提供します。

履歴と html-wrapper タスクのテンプレート属性の組み合わせを使用して、使用テンプレートを決定します。

サポート対象の属性

html-wrapper タスクの属性は、HTML ラッパーの <object> タグおよび <embed> タグのパラメータと属性の一部に対応しています。このタスクは、出力場所と生成するラッパーのタイプを指定する属性もサポートしています。HTML ラッパー内の <object> タグと <embed> タグのすべての属性とパラメータについては、object タグと embed タグについてを参照してください。

次の表に、html-wrapper タスクでサポートされる属性を説明します。

必須属性

html-wrapper タスクには swf 属性が必要です。さらに、swf 属性のみを指定した場合、デフォルトのラッパーには次のデフォルト設定が指定されます。

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

swf 属性の値を指定する場合は、ファイル名のみを使用し、ファイル名に拡張子を足したものは使用しないでください。html-wrapper タスクは、値の最後に .swf を付加します。

そのためには、例えば次のように記述します。

swf="Main"

次のように記述しないでください。

swf="Main.swf"

サポート対象外のオプション

html-wrapper タスクを使用して、使用可能な <object> および <embed> タグパラメータのすべてを設定できるわけではできません。設定できないパラメータには、quality、allowScriptAccess、classid、pluginspage および type などがあります。

例

次のプロジェクトの例には、html-wrapper タスクを使用してディープリンクとプレーヤー検出ロジック付きのラッパーを生成するための wrapper ターゲットが含まれています。また、このターゲットは、SWF ファイルの高さと幅を設定します。このプロジェクトには、wrapper ターゲットによって生成されたすべてのファイルを削除する wrapper ターゲットも含まれています。

<?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>