Java Platform, Standard Editionデプロイメント・ガイド
目次    前    次

JavaFX Antタスク・リファレンス

次のアイテムは、主なJavaFX Antタスクを構成します。

アイテムはアルファベット順です。

<fx:deploy>

説明

Webデプロイメントおよびスタンドアロンのアプリケーションの両方のパッケージを生成します。パッケージには、一連のJARファイル、1つのJNLPファイルおよび1つのHTMLファイルが含まれています。

親要素

なし。

パラメータ

表10-2 fx:deploy

属性 説明 型 必須

embeddedHeight

存在する場合、この値は、幅/高さではなく、Javascript/HMTLコードに使用されます。埋込みデプロイメント・モードにのみ影響します。

埋込みアプリケーションの相対ディメンションを指定する場合に使用します。

5.8.4項「ブラウザ・ウィンドウに入力するアプリケーションの公開」を参照してください。

String

いいえ

embeddedWidth

embeddedHeightの説明と同じです。

String

いいえ

embedjnlp

trueの場合、JNLP記述子をWebページに埋め込みます。起動時に作成されるネットワーク接続数を削減し、起動時間の改善に役立てます。

Boolean

いいえ

デフォルトはfalseです。

extension

srcfilesで指定されたファイルを拡張子として扱います。存在する場合、デプロイメント記述子の一部のみが生成され、HTMLファイルは生成されません。

Boolean

いいえ

デフォルトはfalseです。

height

アプリケーションをWebページに埋め込むための、アプリケーション・シーンの高さ。

String

はい

includeDT

trueに設定した場合、配備ツールキットに関連するファイルは、outdirで指定されたディレクトリのweb-filesサブディレクトリにコピーされます。この設定は、オフライン開発には役立ちますが、本番用にはお薦めしません。

Boolean

いいえ

デフォルトはfalseです。

nativeBundles

値:

  • all

  • deb

  • dmg

  • exe

  • image

  • installer

  • mac.appStore

  • msi

  • none

  • pkg

  • rpm

値allは、適用可能なすべての自己完結型アプリケーション・パッケージを生成します。値installerは、インストール可能なパッケージのみを生成します。ディスク・イメージは生成しません。値noneは、自己完結型アプリケーション・パッケージを生成しません。そうしないと、別の値を使用して、特定のパッケージ・インストーラを生成します。

String

いいえ

デフォルトはnoneです。

offlineAllowed

値がtrueの場合、クライアント・システムがネットワークから切断されても、キャッシュされたアプリケーションが稼働できます。

Boolean

デフォルトはtrueです。

outdir

出力ファイルが生成されるディレクトリの名前。

String

はい

outfile

出力ファイルの接頭辞(拡張子なし)。

String

はい

placeholderref

アプリケーションが埋め込まれるWebページのプレースホルダ。これはJavaScript DOMオブジェクトである必要があります。

String

はい

プレースホルダの参照またはIDのいずれかが必要です。

placeholderid

コールバックで使用されます。アプリケーションが埋め込まれるWebページのプレースホルダのID。これを解決するには、JavaScript関数document.getElementById()が使用されます。

String

はい

プレースホルダの参照またはIDのいずれかが必要です。

signBundle

バンドラが生成されたバンドルに署名するよう要求するために、自己完結型アプリケーションで使用します。この属性は、署名をサポートしないバンドラでは無視されます。JDKの8u40リリース時には、OS Xバンドラのみ署名をサポートしています。

Boolean

デフォルト値は、使用しているバンドラによって異なります。

updatemode

埋込みおよびWeb Startアプリケーションでアプリケーション更新の確認が実行される時期についての設定を示します。

alwaysの値は、アプリケーションを起動する前に常に更新の確認を行うことを意味します。

backgroundの値は、バックグラウンドでの更新の確認中にアプリケーションを起動することを意味します。

5.9.1項「アプリケーションのバックグラウンド更新チェック」を参照してください。

String

いいえ

デフォルトはbackgroundです。

width

アプリケーションをWebページに埋め込むための、アプリケーション・シーンの幅。

String

はい

ネストした要素として受け入れるパラメータ

<fx:deploy>タスクの使用例

例1 - 最小限の<fx:deploy>タスク

これは、<fx:deploy> Antタスクの単純な例です。HTMLファイルおよびJNLPファイルをweb-distディレクトリに生成し、生成されたファイルの接頭辞として"Fish"を使用します。

 
<fx:deploy width="600" height="400"
        outdir="web-dist" outfile="Fish" 
        offlineAllowed="false">
    <fx:info title="Sample application"/>
    <fx:application refid="myapp"/>
    <fx:resources refid="myresources"/>
</fx:deploy>
例2 - プリローダーを使用したアプリケーションの<fx:deploy>タスク

次のAntタスクは、プリローダーを使用した単純なアプリケーションの再配布可能なパッケージを作成します。アプリケーションおよびそのリソースの詳細は、タスクの<fx:application>および<resource>要素で定義されます。

出力パッケージの場所は、<fx:deploy>タスクのoutdir属性によって定義されます。新しいファイルは、outfile属性で指定されたname接頭辞を使用して生成されます。このタスクの実行の結果として、次のファイルがweb-distフォルダに作成されます。

  • preloader.jar

  • helloworld.jar

  • App.jnlp

  • App.html


注意:

デフォルトでは、デプロイメント・パッケージは、java.comから補助ファイルを使用して、Webデプロイメントをサポートします。これにより、アプリケーションがWebでデプロイする最適な方法を常に使用できるようになるため、これは優先的な方法です。ただし、閉じているネットワークでアプリケーションをテストする場合、これらのファイルをアプリケーション・パッケージに含めることができます。これを行うには、includeDT="true"を、<fx:deploy> Antタスクの属性として渡します。		 

<fx:deploy width="600" height="400"
        outdir="web-dist" outfile="App">
    <fx:info title="Sample application"/>
    <fx:application name="SampleApp" 
            mainClass="testapp.MainApp"
            preloaderClass="testpreloader.Preloader">
        <fx:param name="testVariable" value="10"/>
    </fx:application>
    <fx:resources>
        <fx:fileset requiredFor="preloader" dir="dist">
            <include name="preloader.jar"/>
        </fx:fileset>
        <fx:fileset dir="dist">
            <include name="helloworld.jar"/>
        </fx:fileset>
    </fx:resources>
</fx:deploy>
例3 - セカンダリ・ランチャでの<fx:deploy>タスク

この例では、メモリー制約のある環境でアプリケーションを起動するために使用できるセカンダリ・ランチャを含む、自己完結型アプリケーションのパッケージを作成します。　メイン・ランチャではJVMオプションは設定されません。セカンダリ・ランチャはオプションを渡して、使用されるメモリー量を制限します。

<fx:deploy outdir="../samples/test/ant" nativeBundles="image">
    <fx:application name="Secondary Launcher Sample"
                    mainClass="hello.Test"/>

    <fx:resources>
        <fx:fileset dir="../samples/test/resources" includes="mainApp.jar"/>
    </fx:resources>

    <fx:info title="Secondary Launcher Test"/>

    <fx:secondaryLauncher
        mainClass="hello.Test"
        name="Standard Launch"/>
 
    <fx:secondaryLauncher name="Memory Constrained">
        <fx:jvmarg="-xmx64m"/>
    </fx:secondaryLauncher>
</fx:deploy>

<fx:jar>

説明

JavaFXアプリケーションをJARファイルにパッケージ化します。含める一連のファイルは、ネストされた<fx:fileset>パラメータによって定義されます。<fx:jar>タスクは、JARファイルへのJARマニフェストの埋込みも行います。

JARアーカイブの作成に加えて、このタスクは次のことも行います。

  • JavaFXランタイムの存在を検出するJavaFX起動ツールを埋め込み、環境を設定し、アプリケーションを実行します。

  • JavaFXが使用できない場合に使用される代替AWTアプレットを埋め込みます。

  • JARファイルでマニフェストを作成します。

生成されるJARファイルは、ダブルクリックによる起動をサポートします。

親要素

なし。

パラメータ

ネストした要素として受け入れるパラメータ

<fx:jar>の使用例

例10-3および次の例を参照してください。

例1 - 単純なアプリケーションの<fx:jar> Antタスク

この例は、<fx:jar> Antタスクを使用して、カスタム・プリローダーなしに単純なアプリケーションのメイン・アプリケーションJARファイルを作成する方法を示しています。生成されるJARファイルは、次の2つのアクションを実行します。

  • java -jar application.jarとして起動時にクラスパスで必要なすべてのリソースを使用して、またはJARファイルをダブルクリックして、test.MyApplicationを起動します。

  • JavaFXランタイムの場所を自動的に検出し、使用できない場合はインストールするようユーザーに要求するか、プラットフォームがサポートされていない場合はレポートします。

<!-- Expect definition of JavaFX ant tasks is already imported -->
 
<fx:jar destfile="dist/application.jar">
    <!-- Details about application -->
    <fx:application name="Sample JavaFX application"
            mainClass="test.MyApplication"/>
 
    <!-- Define what auxilary resources are needed -->
    <fx:resources>
        <fx:fileset dir="dist" includes="lib/*.jar"/>
    </fx:resources>
            
    <!-- What to include into result jar file?
         Everything in the build tree -->
    <fileset dir="build/classes"/>
 
    <!-- Customize jar manifest (optional) -->
    <manifest>
        <attribute name="Implementation-Vendor" value="Samples Team"/>
        <attribute name="Implementation-Version" value="1.0"/>
    </manifest>
</fx:jar>

<fx:signjar>

説明

証明書の付いたアプリケーションJARファイルにデジタル署名します。

BLOBとしてJARファイルに署名します。つまり、すべてのエントリに別々に署名するのではなく、JARファイルは単一のバイナリ・オブジェクトとして署名されます。

これは、JavaFXの新しい署名方法です。従来の署名の場合、標準的なAnt signjarタスクを使用する必要があります。

親要素

なし。

パラメータ

*注意:

<fx:signjar jar="path/to/jar/folder/jarname" .../>

は、次を簡単で便利にした構文です。

<fx:signjar ...>
    <fileset dir="path/to/jar/folder" file="jarname"/> 
</fx:signjar>

ネストした要素として受け入れるパラメータ

<fx:signjar>の使用例

例1 - JARファイルへの署名

次のAntコードのスニペットは、BLOB技術として新しい署名を使用してJARファイルに署名する方法を示しています。

<fx:signjar destdir="dist"
        keyStore="sampleKeystore.jks" storePass="****"
        alias="javafx" keyPass="****">
    <fileset dir='dist/*.jar'/>
</fx:signjar>

JavaFX Antヘルパー・パラメータ・リファレンス

ヘルパー・パラメータは、「JavaFX Antタスク・リファレンス」で説明されているJavaFXタスクによって使用されるタイプです。このリファレンス・ページには次の要素があります。

アイテムはアルファベット順です。

<fx:application>

説明

基本的なアプリケーション記述子。アプリケーションの主なコンポーネントおよびパラメータのデフォルト・セットを定義します。

親要素

パラメータ

表10-5 fx:application

属性 説明 型 必須

daemon

アプリケーションがデーモンまたはサービスとしてインストールされているかどうかを示します。

Boolean

いいえ

デフォルト値はfalseです。

fallbackClass

FXランタイムがなく、JavaFXのインストールが不可能であるため、アプリケーションの起動に失敗した場合に使用される、AWTベースのアプレット。

String

いいえ

id

HTMLでのアプリケーションへのJavaScript参照を取得するために使用できるアプリケーションID。同じIDが、Antタスクのアプリケーション・オブジェクトの参照に使用できます(refidを使用)。

String

いいえ

mainClass

javafx.application.Applicationを拡張する、メイン・アプリケーション・クラスの修飾名。

String

はい

name

アプリケーションの短縮名。自己完結型アプリケーションの場合、出力パッケージの名前も定義します。

String

いいえ

デフォルト値はメイン・アプリケーション・クラスから導出されます。

preloaderClass

javafx.application.Preloaderを拡張する、プリローダー・クラスの修飾名。

String

いいえ

デフォルトは、JavaFXランタイムに付属しているプリローダーです。

refid*

--

参照

いいえ

toolkit

特定のUIツールキットを使用するアプリケーションの設定を示します。使用可能な値は次のとおりです。

  • fx

  • swing

String

いいえ

デフォルト値はfxです。

version

パッケージされているアプリケーションのバージョン。

String

いいえ

デフォルト値は1.0です。

* refidが使用される場合、他のパラメータは指定できません。

ネストした要素として受け入れるパラメータ

<fx:application>の使用例

例10-3を参照してください。

<fx:association>

説明

ファイル拡張子またはMIMEタイプを自己完結型アプリケーションに関連付けます。この要素の複数のインスタンスがサポートされています。

親要素

パラメータ

脚注1Windowsでは必須です。OS Xではextensionまたはmimetypeを指定する必要があります。

脚注2Linuxでは必須です。OS Xではextensionまたはmimetypeを指定する必要があります。

ネストした要素として受け入れるパラメータ

なし。

<fx:association>の使用例

例1 - ファイルと自己完結型アプリケーションの関連付け

この例では、Windows上の自己完結型アプリケーションをファイル拡張子が.aaaまたは.bbbのファイルに関連付けて、説明とアイコンを指定します。

<fx:info title="Association example">
  <fx:association extension="aaa bbb" description="MyApp Data Files"
      icon="MyApp.ico">
  </fx:association>
</fx:info>

<fx:bundleArgument>

説明

自己完結型アプリケーションの作成に使用されるバンドラの引数を指定します。各バンドラ・タイプに、独自の引数セットがあります。

親要素

パラメータ

自己完結型アプリケーション・バンドラの引数

バンドラの各タイプ(OS X、LinuxおよびWindows)には、独自の引数のセットがあります。

OS Xアプリケーション・バンドラ引数

icon

起動ツールおよびその他の支援ツールに使用するデフォルト・アイコンへのパス。ファイル形式は.icnsです。

mac.bundle-id-signing-prefix

プロパティが足りないバイナリがファイル(拡張子.plistを使用するplist)をリストしているか、既存の署名がバンドル内に見つかった場合に、署名付きバイナリに適用される接頭辞。

mac.category

アプリケーションのカテゴリ。カテゴリは、Apple Developer Webサイトにあるカテゴリ・リスト内に含まれている必要があります。

mac.CFBundleIdentifier

CFBundleIdentifierのinfo.plistファイルに格納された値。この値は、グローバルに一意である必要があり、文字、数字、ドットおよびダッシュのみを含む必要があります。DNS順序の反転をお薦めします(例: com.example.application.my-application)。

mac.CFBundleName

Macメニュー・バーに表示されるアプリケーションの名前。16文字未満の名前をお薦めします。デフォルトは、<fx:application>要素のname属性です。

mac.CFBundleVersion

アプリケーションのバージョン番号は内部的に使用されます。値は1つ以上3つ以下の整数である必要があり、1.3や2.0.1のようにピリオド(.)で区切ります。<fx:application>要素のversion属性の値とは別の値を指定できます。version属性に有効な値が指定されていて、mac.CFBundleVersion引数が指定されていない場合、version属性の値が使用されます。どちらも指定されていない場合、100がバージョン番号として使用されます。

mac.signing-key-developer-id-app

開発者IDまたはGatekeeper署名に使用する署名キーの名前。Apple Developer Webサイトから標準のキーをインポートした場合、そのキーがデフォルトで使用されます。キーを識別できない場合、アプリケーションは署名されません。

OS X DMG (ディスク・イメージ)バンドラ引数

mac.CFBundleVersion

アプリケーションのバージョン番号は内部的に使用されます。値は1つ以上3つ以下の整数である必要があり、1.3や2.0.1のようにピリオド(.)で区切ります。<fx:application>要素のversion属性の値とは別の値を指定できます。version属性に有効な値が指定されていて、mac.CFBundleVersion引数が指定されていない場合、version属性の値が使用されます。どちらも指定されていない場合、100がバージョン番号として使用されます。

mac.dmg.simple

AppleScriptコードの実行に依存するDMGカスタマイズ手順をスキップするかどうかを示すフラグ。trueに設定して、手順をスキップします。trueに設定されている場合、ディスク・ウィンドウにバックグラウンド・イメージがないため、アイコンが所定の位置に移動しません。systemWide引数もtrueに設定されている場合、ルート・アプリケーション・フォルダのシンボリック・リンクがDMGファイルに追加されます。systemWide引数がfalseに設定されている場合、アプリケーションのみがDMGファイルに追加され、デスクトップのリンクは追加されません。

OS X PKGバンドラ引数

mac.CFBundleVersion

アプリケーションのバージョン番号は内部的に使用されます。値は1つ以上3つ以下の整数である必要があり、1.3や2.0.1のようにピリオド(.)で区切ります。<fx:application>要素のversion属性の値とは別の値を指定できます。version属性に有効な値が指定されていて、mac.CFBundleVersion引数が指定されていない場合、version属性の値が使用されます。どちらも指定されていない場合、100がバージョン番号として使用されます。

mac.signing-key-developer-id-installer

開発者IDまたはGatekeeper署名に使用する署名キーの名前。Apple Developer Webサイトから標準のキーをインポートした場合、そのキーがデフォルトで使用されます。キーを識別できない場合、アプリケーションは署名されません。

Mac App Storeバンドラ引数

mac.app-store-entitlements

アプリケーションが動作する資格を含むファイルの場所。ファイルは、Appleによって指定されている形式である必要があります。ファイルへのパスは、絶対的な語で指定することも、Antファイルに相対的に指定することもできます。資格を指定しない場合、アプリケーションは、通常のアプレット・サンドボックスよりもより厳しいサンドボックスで動作し、ネットワーク・ソケットおよびすべてのファイルへのアクセスが拒否されます。

mac.CFBundleVersion

アプリケーションのバージョン番号は内部的に使用されます。値は1つ以上3つ以下の整数である必要があり、1.3や2.0.1のようにピリオド(.)で区切ります。<fx:application>要素のversion属性の値とは別の値を指定できます。version属性に有効な値が指定されていて、mac.CFBundleVersion引数が指定されていない場合、version属性の値が使用されます。どちらも指定されていない場合、100がバージョン番号として使用されます。このバージョンが既存のアプリケーションのアップグレードである場合、値は以前のバージョン番号より大きくする必要があります。

mac.signing-key-app

Mac App Storeのアプリケーション署名キーの名前。Apple Developer Webサイトから標準のキーをインポートした場合、そのキーがデフォルトで使用されます。キーを識別できない場合、アプリケーションは署名されません。

mac.signing-key-pkg

Mac App Storeのインストーラ署名キーの名前。Apple Developer Webサイトから標準のキーをインポートした場合、そのキーがデフォルトで使用されます。キーを識別できない場合、アプリケーションは署名されません。

Windows EXEおよびMSIバンドラ引数

icon

起動ツールおよびその他の支援ツールに使用するデフォルト・アイコンのパス。ファイル形式は.icoです。

win.menuGroup

<fx:preferences>要素のmenu属性がtrueの場合、アプリケーションをインストールするメニュー・グループ。menuがfalseの場合、この引数は無視されます。

<fx:bundleArgument>の使用例

次の例では、生成されたWindowsインストーラ・パッケージ(MSIファイル)がサンプル・アプリケーションという名前のメニュー・グループに「スタート メニュー」のショートカットを作成することを指定します。バンドラが<fx:deploy>要素のnativeBundles属性を持つMSIファイルを作成することを指定する必要があります。

<fx:deploy outdir="." outfile="helloworld" nativeBundles="msi">
    <fx:platform basedir="${JAVA_HOME}"/>
    <fx:application refId="HelloWorldID"/>
    <fx:resources refid="appRes"/>
    <fx:info title="Hello World Example" vendor="Oracle Corporation"/>
    <fx:bundleArgument arg="win.menuGroup" value="Sample Applications"/>
</fx:deploy>

<fx:fileset>

説明

標準的なAnt FileSetタイプの拡張子。選択されたファイルのセットに関するオプションのメタ情報を指定するための手段を提供します。このオブジェクトには次のものが含まれます。

  • リソースのタイプ(type属性を参照)

  • このリソースが適用可能なオペレーティング・システムおよびアーキテクチャ

  • このリソースが必要なタイミング。ロード順序の最適化に役立ちます。

タイプに応じて、囲むタスクによってリソースが使用されない場合があります。詳細は、5.7.2項「アプリケーション・リソース」を参照してください。

タイプ"jar"のファイルセットは、クラスパスに追加されるJARファイルのセットを含む必要があります。

タイプ"native"のリソースは、ネイティブ・ライブラリのセットを含むJARファイルである必要があります。また、ほとんどの場合、このリソースのオペレーティング・システムおよびアーキテクチャを設定することは意味があります。

タイプ"jnlp"のリソースは、外部のJNLP拡張子を定義するJNLPファイルを含む必要があります。

タイプ"license"のファイルセットは、任意のファイルを含めることができますが、実際に使用するときは追加の制限事項が適用されることがあります(たとえば、Macではプレーン・テキスト・ファイルである必要があり、WindowsではRTFである必要があるなど)。

タイプ"data"のファイルセットは、任意のファイルを含めることができます。

親要素

パラメータ

表10-10 fx:fileset

属性 説明 型 必須

arch

(<fx:fileset>が<fx:resources>の下でネストされる場合のみ使用されます。)

これらのリソースに対して適切なアーキテクチャを指定します。

String

いいえ

デフォルトはanyです。

excludes

--

String

--

includes

--

String

--

os

(<fx:fileset>が<fx:resources>の下でネストされる場合のみ使用されます。)

これらのリソースに対して適切なオペレーティング・システムを指定します。

String

いいえ

デフォルトはanyです。

requiredFor

(<fx:fileset>が<fx:resources>の下でネストされる場合のみ使用されます。)

リソースが必要なタイミングを定義します(ロードの優先度に影響します)。サポートされる値は次のとおりです。

  • preloader - プリローダーの起動に必要なリソース(最初に実行するもの)。

  • startup - アプリケーションの起動に必要なリソース。

  • runtime - リソースはアプリケーションの起動には重要ではありませんが、後で必要になる可能性があります。

String

いいえ

デフォルトはstartupです。

type

(<fx:fileset>が<fx:resources>の下でネストされる場合のみ使用されます。)

セット内のリソースのタイプ。サポートされる値は次のとおりです。

  • auto (autodetectの場合)

  • data

  • jar

  • jnlp

  • license

  • native (ネイティブ・ライブラリを含むJARファイルの場合)

  • icon

String

いいえ

デフォルトは拡張子に基づいて推測されます。

* refidが使用される場合、他のパラメータは指定できません。

ネストした要素として受け入れるパラメータ

なし(標準的なAnt要素を除く)。

<fx:htmlParam>

説明

HTMLページからの埋込みまたはWeb Startアプリケーションに渡されるパラメータ。パラメータの値は、JavaScriptを使用して実行時に計算できます。

親要素

パラメータ

ネストした要素として受け入れるパラメータ

なし

<fx:htmlParam>タスクの使用例

例1 - HTMLページから渡される様々なパラメータ
<fx:application name="Sample app"
        mainClass="test.MyApplication">
    <!-- Parameters passed from HTML page. Only applicable 
         for embeddeded and Web Start applications and unused when
         run in a standalone and self-contained context.  -->
    <!-- Parameter with name 'fixedParam', whose value is string 
        '(new Date()).getTime()' -->
    <htmlParam name="fixedParam"
           value="(new Date()).getTime()"/>
    <!-- Parameter with name 'dynamicParam', whose value will be 
         the timestamp of the moment when the application is added  
         to the web page (value will be assigned the result 
         of execution of JavaScript code) -->
    <htmlParam name="dynamicParam" escape="false"
            value="(new Date()).getTime()"/>
</fx:application>

<fx:icon>

説明

アイコンを<fx:deploy>タスクに渡します(スプラッシュ画面のイメージ以外)。

この要素で指定されたアイコンは、Web Startおよびデスクトップ・アプリケーションに使用されます。

JavaFX 2.2では、タイプdefaultのアイコンのみが、自己完結型アプリケーションに使用されます。自己完結型アプリケーションのアイコンのカスタマイズ方法の詳細は、7.3.3項「ドロップイン・リソースを使用したパッケージのカスタマイズ」を参照してください。

親要素

パラメータ

表10-12 fx:icon

属性 説明 型 必須

depth

イメージの色深度(ピクセル当たりのビット数)。一般的な値は、8、16および24です。

String

いいえ

href

イメージの場所。

自己完結型アプリケーションの場合、サポートされるグラフィック形式は、オペレーティング・システムに応じて異なります。

  • OS X: .icns

  • Linux: .png

  • Windows: .ico

自己完結型アプリケーションの独自のアイコンを指定する場合、属性height、widthおよびdepthの値は使用されません。カスタム・アイコンのサイズおよび色深度がオペレーティング・システムが必要とするものに対応していることを確認します。

Web Startアプリケーションの場合、サポートされるグラフィック形式は、.gif、.jpg、.pngおよび.icoです。

String

はい

height

イメージの高さ(ピクセル)。

String

いいえ

kind

アイコン・タイプ。サポートされる値は次のとおりです。

  • default

  • disabled

  • rollover

  • selected

  • shortcut

Web Startアプリケーションの場合、この属性は、JNLPファイルのicon要素のkind属性に対応します。

デスクトップ・アプリケーションでは、この属性が指定されていないか、defaultとして設定されている場合、指定されるアイコンは、起動ツール(Windowsでは.exeファイル、OS Xでは.appファイル)のアイコン、タスクバーまたはドック内のアイコン、および一部のインスタンスではインストーラ・パッケージ(DMGパッケージなど)のアイコンです。

String

いいえ

デフォルト値はdefaultです。

width

イメージの幅(ピクセル)。

String

いいえ

ネストした要素として受け入れるパラメータ

なし。

<fx:icon>の使用例

例1 - <fx:icon>の使用
<fx:info title="Sample application">
    <!-- icon to be used by default for anything but splash -->
    <fx:icon href="shortcut.ico" kind="shortcut"
            width="32" height="32" depth="8"/> 
</fx:info>

<fx:info>

説明

ユーザーへのアプリケーションの説明。これらの詳細は、システムのダイアログ・ボックスに表示されます(表示する必要がある場合)。

親要素

パラメータ

ネストした要素として受け入れるパラメータ

<fx:info>の使用例

例1 - <fx:deploy>タスクで使用される<fx:info>パラメータ
<fx:info vendor="Uncle Joe" description="Test program"/>

<fx:permissions>

説明

アプリケーションで必要なセキュリティ権限の定義。デフォルトでは、アプリケーションはサンドボックスで実行されます。高い権限を要求するには、アプリケーションJARファイルへの署名が必要です。

このオプションは、自己完結型アプリケーションを含むスタンドアロン・アプリケーションには影響しません。

親要素

パラメータ

ネストした要素として受け入れるパラメータ

なし。

<fx:permissions>の使用例

例1 - デプロイメント記述子への署名証明書の埋込み

5.9.3項「デプロイメント記述子への署名証明書の埋込み」を参照してください。

<fx:permissions elevated="true" cacheCertificates="true"/>

<fx:platform>

説明

アプリケーションのプラットフォーム要件を定義します。

親要素

パラメータ

* refidが使用される場合、他のパラメータは指定できません。

ネストした要素として受け入れるパラメータ

<fx:platform>の使用例

例1 - バージョンを指定する<fx:platform>パラメータ

この例では、アプリケーションは、JavaFXランタイム・バージョン2.1以降、およびJREバージョン7.0以降が必要です。

<fx:platform javafx="2.1+" j2se="7.0"/>
例2 - JVMオプションを指定する<fx:platform>パラメータ

この例では、アプリケーションは、JavaFXランタイム・バージョン2.1以降が必要で、"-Xmx400 -verbose:jni -Dpurpose="sample value"を使用して起動されたJVMで実行する必要があります。

<fx:platform javafx="2.1+">
    <fx:jvmarg value="-Xmx400m"/>
    <fx:jvmarg value="-verbose:jni"/>
    <property name="purpose" value="sample value"/>
</fx:platform>
例3 - ユーザーがオーバーライド可能なJVMオプションを指定する<fx:platform>パラメータ

この例では、ヒープ・サイズのデフォルト値として-Xmx768mが渡されます。ユーザーは、ユーザー構成ファイルでこの値をオーバーライドできます。

            <fx:platform>
              <fx:jvmuserarg name="-Xmx" value="768m" />
            </fx:platform>

<fx:preferences>

説明

アプリケーションのデプロイメント・プリファレンス。プリファレンスを表すことはできますが、たとえば次の場合のように、必ずしも満たされているわけではありません。

  • あるプリファレンスが特定の実行モードでサポートされていない場合、パッケージャはそれを無視することがあります。

  • あるプリファレンスがサポートされていない場合、JREはそれを無視することがあります。

  • たとえば、ユーザーがデスクトップ・ショートカットを作成できるかどうかを求められた場合、要求を拒否することがあります。

親要素

パラメータ

* refidが使用される場合、他のパラメータは指定できません。

ネストした要素として受け入れるパラメータ

なし。

<fx:preferences>の使用例

例1 - デスクトップ・ショートカットを追加する<fx:preferences>パラメータ

この例では、デスクトップ・ショートカットを作成する要求を示します。

<fx:preferences id="p1" shortcut="true"/>
例2 - インストール済とマークする<fx:preferences>パラメータ

この例では、次の操作を行います。

  • アプリケーションをアプリケーション・メニューに追加し、インストール済としてマークする(つまり、アプリケーションが「プログラムの追加と削除」にリストされる)Webデプロイメント記述子の作成を要求します。

  • 自己完結型バンドルが作成された場合、システム全体にインストールされ、アプリケーション・エントリをアプリケーション・メニューに作成します。

<fx:preferences shortcut="false" install="true" menu="true"/>
例3 - <fx:preferences>パラメータへのrefidの使用

この例では、「デスクトップ・ショートカットを追加する<fx:preferences>パラメータ」の<fx:preferences>パラメータへの参照を使用して、ショートカットを作成します。

<fx:resource refid="p1"/>

<fx:resources>

説明

アプリケーションで使用するリソースのコレクション。一連のJavaFXファイルセット・フィルタとして定義されます。idまたはrefidを使用して再利用できます。

親要素

パラメータ

* refidが使用される場合、他のパラメータは指定できません。

ネストした要素として受け入れるパラメータ

<fx:resources>の使用例

第5章「パッケージ化の基本」および第7章「自己完結型アプリケーションのパッケージ化」の例も参照してください。

例1 - idおよびrefid属性とともに使用される<fx:resources>パラメータ

この例では、両方の<fx:resources>要素がコレクションを定義し、distディレクトリのs.jarで構成されます。最初の<fx:resources>要素はid属性を使用し、2番目の<fx:resources>要素はrefid属性を使用して最初の要素を参照します。

<fx:resources id="aaa">
    <fx:fileset dir="dist" includes="s.jar"/>
</fx:resources>
<fx:resources refid="aaa"/>
例2 - 拡張記述子の<fx:resources>の使用

署名および無署名のJARファイルを混在させる場合、この例に示すように、追加の<fx:deploy> Antタスクを使用して、各JARファイルに拡張記述子を生成し、メイン・ファイルのリソースとして処理することによって拡張記述子を参照します。

<!-- Prepare extension -->
<fx:deploy extension="true"
        outdir="dist" outfile="other">
    ...
<fx:deploy>
 
<!-- Use it in the main descriptor -->
<fx:deploy outdir="web-dist" ...>
    ...
    <fx:resources>
        <fx:fileset dir="dist" includes="other.jnlp"/>
            ...
    </fx:resources>
<fx:deploy>

<fx:secondaryLauncher>

説明

自己完結型アプリケーションのセカンダリ・エントリ・ポイントを識別します。スタンドアロン・アプリケーション、Webページに埋め込まれたアプリケーション、ブラウザから起動されたアプリケーションでは、このパラメータは無視されます。

このパラメータは、WindowsおよびLinuxアプリケーションに対してのみ有効です。

親要素

パラメータ

ネストした要素として受け入れるパラメータ

<fx:secondaryLauncher>の使用例

「セカンダリ・ランチャでの<fx:deploy>タスク」を参照してください。

<fx:template>

説明

前処理を行うテンプレート。テンプレートは、Webデプロイメントに必要なJavaScriptまたはHTMLスニペットに置き換えられるマーカーを含むHTMLファイルです。テンプレートの使用によって、アプリケーションを独自のWebページに直接デプロイできます。特にアプリケーションがページに密接に統合されている場合(たとえばWebページがアプリケーションへの通信にJavaScriptを使用する場合など)は、これにより開発プロセスが簡略化されます。

テンプレート・マーカーには、次のいずれかの形式があります。

  • #XXX#

  • #XXX(id)#

idはアプリケーションの識別子で、XXXは次のいずれかです。

  • DT.SCRIPT.URL

    配備ツールキット内のdtjava.jsの場所。デフォルトの場所は次のとおりです

    https://java.com/js/dtjava.js.

  • DT.SCRIPT.CODE

    配備ツールキットのdtjava.jsを組み込むスクリプト要素。

  • DT.EMBED.CODE.DYNAMIC

    アプリケーションを特定のプレースホルダに埋め込むコード。コードをfunction()メソッド内にラップすることが期待されます。

  • DT.EMBED.CODE.ONLOAD

    onloadフックを使用してアプリケーションをWebページに埋め込むために必要なすべてのコード(dtjava.jsの組込みを除く)。

  • DT.LAUNCH.CODE

    アプリケーションを起動するために必要なコード。コードをfunction()メソッド内にラップすることが期待されます。

異なるアプリケーションを含むページを複数回処理できます(アプリケーション当たり1回)。混乱を避けるために、マーカーは、英数字の文字列で空白なしのアプリケーションIDを使用する必要があります。

入力ファイルと出力ファイルが同じ場合、テンプレートは適切な場所で処理されます。

親要素

パラメータ

ネストした要素として受け入れるパラメータ

なし

<fx:template>の使用例

例1 - <fx:deploy>タスクで使用される<fx:template>パラメータ

この例では、入力ファイルと出力ファイルの両方が指定される<fx:template>パラメータを示します。

<fx:template file="App_template.html" tofile="App.html"/>
例2 - コンテキスト内の<fx:template>パラメータ
<fx:deploy placeholderId="ZZZ"
        width="600" height="400"
        outdir="dist-web" outfile="App1">
    <fx:application id="myApp" name="Demo"
            mainClass="fish.FishApplication"/>
    <fx:template file="src/templates/EmbedApp_template.html"
            tofile="dist-web/EmbedApp.html"/>
    <fx:resources>
        <fx:fileset requiredFor="startup" dir="dist" includes="*.jar"/>
    </fx:resources>
</fx:deploy>
目次   前   次
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved.