The following items comprise the main JavaFX Ant tasks:
Used to convert CSS files to binary format for faster processing. See also Section 5.4, "Style Sheet Conversion."
Used to assemble the application package for redistribution. By default, the deploy task will generate the base application package, but it can also generate self-contained application packages if requested. See also Section 5.7, "Run the Deploy Task or Command."
Used to create one or more application JAR files. See also Section 5.5, "Create the Main Application JAR File."
Used when the application needs a digital signature. See also Section 5.6, "Sign the JAR Files."
Items are in alphabetical order.
Generates a package for both web deployment and standalone applications. The package includes a set of JAR files, a JNLP file, and an HTML file.
Table 10-2 fx:deploy
| Attribute | Description | Type | Required? |
|---|---|---|---|
|
|
If present, this value will be used for Javascript/HMTL code instead of width/height. Affects only embedded deployment mode. Use it if you want to specify a relative dimension for an embedded application. See Section 5.8.4, "Publishing an Application that Fills the Browser Window." |
String |
No |
|
|
Same description as for |
String |
No |
|
|
If true, embed the JNLP descriptor into the web page. Reduces number of network connections to be made on startup and helps to improve startup time. |
Boolean |
No Default is |
|
|
Treat the files named in |
Boolean |
No Default is |
|
|
Height of the application scene, for embedding applications into a web page. |
String |
Yes |
|
|
If set to |
Boolean |
No Default is |
|
|
Values:
Value |
String |
No Default is |
|
|
If the value is |
Boolean |
Default is |
|
|
Name of the directory in which output files are generated. |
String |
Yes |
|
|
Prefix of the output files, without the extension. |
String |
Yes |
|
|
Placeholder in the web page where the application will be embedded. This is expected to be JavaScript DOM object. |
String |
Yes Either reference or ID of placeholder is required. |
|
|
Used with callbacks. The ID of the placeholder in the web page where application will be embedded. The JavaScript function |
String |
Yes Either the reference or the ID of the placeholder is required. |
|
|
Used for self-contained applications to request that the bundler sign the bundle that is generated. This attribute is ignored by bundlers that do not support signing. At the time of the 8u40 release of the JDK, only OS X bundlers support signing. |
Boolean |
Default depends on the bundler used. |
|
|
Indicates the preferences for when checks for application updates are performed for embedded and Web Start applications. A value of A value of See Section 5.9.1, "Background Update Check for the Application." |
String |
No Default is |
|
|
Width of the application scene, for embedding applications into a web page. |
String |
Yes |
This is a simple example of an <fx:deploy> Ant task. It generates an HTML file and JNLP file into the web-dist directory and uses "Fish" as the prefix for the generated files.
<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>
The following Ant task creates a redistributable package for a simple application with a preloader. Details about the application and its resources are defined in the <fx:application> and <resource> elements in the task.
Note that the location of the output package is defined by the outdir attribute of the <fx:deploy> task. New files are generated using the name prefix specified in the outfile attribute. As a result of execution of this task, the following files are created in the web-dist folder:
preloader.jar
helloworld.jar
App.jnlp
App.html
|
Note: By default, the deployment package uses auxiliary files from java.com to support web deployment. This is the preferred way, because it enables the application to always use the best way to deploy on the web. However, if you want to test your application in a closed network then you can include these files into your application package. To do this, passincludeDT="true" as an attribute in the <fx:deploy> Ant task. |
<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>
This example creates a package for a self-contained application that contains a secondary launcher that can be used to start the application in a memory-constrained environment. The main launcher does not set JVM options. The secondary launcher passes an option to limit the amount of memory used.
<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>
Packages a JavaFX application into a JAR file. The set of files to be included is defined by nested <fx:fileset> parameters. The <fx:jar> task also embeds a JAR manifest into the JAR file.
In addition to creating a JAR archive, this task also:
Embeds the JavaFX launcher, which detects the presence of JavaFX Runtime, sets up the environment, and executes the application.
Embeds the fallback AWT applet, to be used if JavaFX is not available.
Creates a manifest in the JAR file.
The resulting JAR file supports launching by double-clicking.
See Example 10-3 and the following example.
This example shows how to use the <fx:jar> Ant task to create the main application JAR file for a simple application without a custom preloader. The resulting JAR file performs the following two actions:
Starts test.MyApplication with all resources needed on the classpath when launched as java -jar application.jar or by double-clicking the JAR file.
Automatically detects the location of JavaFX Runtime and prompts the user to install it if it is not available, or reports if the platform is not supported.
<!-- 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>
Digitally signs an application JAR file with a certificate.
Signs the JAR file as BLOB. In other words, instead of every entry being signed separately, the JAR file is signed as a single binary object.
This is a new signing method in JavaFX. For traditional signing, the standard Ant signjar task should be used.
Table 10-4 fx:signjar
| Attribute | Description | Type | Required? |
|---|---|---|---|
|
|
The alias for the key |
String |
Yes |
|
|
Location of output file |
String |
Yes |
|
|
Password for the private key |
String |
Yes |
|
|
Keystore file name |
File |
Yes |
|
|
The JAR file to sign* |
String |
No Either this attribute or a nested |
|
|
Password to check integrity of the keystore or unlock the keystore |
String |
Yes |
|
|
Keystore type |
String |
No Default is |
|
|
Enable verbose output. |
Boolean |
No Default is |
*Note that:
<fx:signjar jar="path/to/jar/folder/jarname" .../>
is simply a convenience syntax for the following:
<fx:signjar ...>
<fileset dir="path/to/jar/folder" file="jarname"/>
</fx:signjar>
Helper parameters are types that are used by the JavaFX tasks described in JavaFX Ant Task Reference. This reference page contains the following elements:
Items are in alphabetical order.
Basic application descriptor. It defines the main components and default set of parameters of the application.
Table 10-5 fx:application
| Attribute | Description | Type | Required? |
|---|---|---|---|
|
|
Indicates if the application is installed as a daemon or a service. |
Boolean |
No Default value is |
|
|
AWT-based applet to be used if application fails to launch due to missing FX runtime and installation of JavaFX is not possible. |
String |
No |
|
|
Application ID that can be used to get a JavaScript reference to the application in HTML. The same ID can be used to refer to an application object in the Ant task (using |
String |
No |
|
|
Qualified name of the main application class, which should extend |
String |
Yes |
|
|
Short name of the application. For self-contained applications, also defines the name of the output package. |
String |
No Default value is derived from the main application class. |
|
|
Qualified name of the preloader class, which should extend |
String |
No Default is the preloader that is shipped with the JavaFX Runtime. |
|
|
-- |
Reference |
No |
|
|
Indicates your preference for the application to use a specific UI toolkit. Possible values:
|
String |
No Default value is |
|
|
Version of the application being packaged. |
String |
No Default value is 1.0. |
* If refid is used, then none of the other parameters can be specified.
An unnamed argument that is inserted in the <fx:argument> element in the deployment descriptor. Multiple arguments are added to the list of arguments in the same order as they are listed in the Ant script.
<fx:application name="Sample app"
mainClass="test.MyApplication">
<!-- unnamed arguments -->
<fx:argument>Something</fx:argument>
<!-- value with spaces that are generated at build time -->
<fx:argument>JRE version: ${java.version}</fx:argument>
<!-- example of value using a special character -->
<fx:argument>true & false</fx:argument>
</fx:application>
Associates file extensions or MIME types with a self-contained application. Multiple instances of this element are supported.
Table 10-6 <fx:association>
| Attribute | Description | Type | Required? |
|---|---|---|---|
|
|
Description of the types of tiles that are associated with the application. If no description is provided, then application-name |
String |
No |
|
|
One or more file extensions to associate with the application. Separate values with a space, for example, |
String |
Depends on the bundlerFoot1 |
|
|
MIME type of the files to associate with the application. Wild card symbols are not allowed. Only one value is allowed on Windows, multiple values separated by a space can be provided for Linux or OS X. |
String |
Depends on the bundlerFoot2 |
|
|
Name of the file that contains the icon for files associated with this application. For Windows the icon format must be |
String |
No |
Footnote1Required on Windows. Either extension or mimetype must be provided on OS X.
Footnote2Required on Linux. Either extension or mimetype must be provided on OS X.
This example associates a self-contained application on Windows with files that have the file extension .aaa or .bbb. and provides a description and icon.
<fx:info title="Association example">
<fx:association extension="aaa bbb" description="MyApp Data Files"
icon="MyApp.ico">
</fx:association>
</fx:info>
Specifies an argument for the bundler that is used to create self-contained applications. Each type of bundler has its own set of arguments.
Each type of bundler (OS X, Linux, and Windows) has its own set of arguments.
ID of a <fx:preferences> element to check for JVM options that the user can override.
The path to the default icon to use for launchers and other assists. The file format is .icns.
Prefix that is applied to the signed binary when binaries that lack property list files (plists, which use the extension .plist) or existing signatures are found inside the bundles.
Category for the application. The category must be in the list of categories found on the Apple Developer website.
Value stored in the info.plist file for CFBundleIdentifier. This value must be globally unique and contain only letters, numbers, dots, and dashes. Reverse DNS order is recommended, for example, com.example.application.my-application.
Name of the application as it appears on the Mac Menu Bar. A name of less than 16 characters is recommended. The default is the name attribute of the <fx:application> element.
Version number for the application, used internally. The value must be at least one integer and no more than three integers separated by periods (.) for example, 1.3 or 2.0.1. The value can be different than the value for the version attribute of the <fx:application> element. If the version attribute is specified with a valid value and the mac.CFBundleVersion argument is not specified, then the value for the version attribute is used. If neither value is specified, 100 is used as the version number.
Name of the signing key used for Developer ID or Gatekeeper signing. If you imported a standard key from the Apple Developer Website, then that key is used by default. If no key can be identified, then the application is not signed.
Version number for the application, used internally. The value must be at least one integer and no more than three integers separated by periods (.) for example, 1.3 or 2.0.1. The value can be different than the value for the version attribute of the <fx:application> element. If the version attribute is specified with a valid value and the mac.CFBundleVersion argument is not specified, then the value for the version attribute is used. If neither value is specified, 100 is used as the version number.
Flag that indicates if DMG customization steps that depend on executing AppleScript code are skipped. Set to true to skip the steps. When set to true, the disk window does not have a background image, and the icons are not moved into place. If the systemWide argument is also set to true, then a symbolic link to the root Applications folder is added to the DMG file. If the systemWide argument is set to false, then only the application is added to the DMG file, no link to the desktop is added.
Version number for the application, used internally. The value must be at least one integer and no more than three integers separated by periods (.) for example, 1.3 or 2.0.1. The value can be different than the value for the version attribute of the <fx:application> element. If the version attribute is specified with a valid value and the mac.CFBundleVersion argument is not specified, then the value for the version attribute is used. If neither value is specified, 100 is used as the version number.
Name of the signing key used for Developer ID or Gatekeeper signing. If you imported a standard key from the Apple Developer Website, then that key is used by default. If no key can be identified, then the application is not signed.
Location of the file that contains the entitlements that the application operates under. The file must be in the format specified by Apple. The path to the file can be specified in absolute terms, or relative to your Ant file. If no entitlements are specified, then the application operates in a sandbox that is stricter than the typical applet sandbox, and access to network sockets and all files is prevented.
Version number for the application, used internally. The value must be at least one integer and no more than three integers separated by periods (.) for example, 1.3 or 2.0.1. The value can be different than the value for the version attribute of the <fx:application> element. If the version attribute is specified with a valid value and the mac.CFBundleVersion argument is not specified, then the value for the version attribute is used. If neither value is specified, 100 is used as the version number. If this version is an upgrade for an existing application, the value must be greater than the previous version number.
Name of the application signing key for the Mac App Store. If you imported a standard key from the Apple Developer Website, then that key is used by default. If no key can be identified, then the application is not signed.
Name of the installer signing key for the Mac App Store. If you imported a standard key from the Apple Developer Website, then that key is used by default. If no key can be identified, then the application is not signed.
The path of the default icon to use for launchers and other assists. The file format is .png.
Name of the RPM or DEB package to create.
The path of the default icon to use for launchers and other assists. The file format is .ico.
Menu group in which to install the application when the menu attribute of the <fx:preferences> element is true. This argument is ignored when menu is false.
The following example specifies that the generated Windows Installer Package (MSI file) create a Start Menu shortcut in a menu group named Sample Applications. Note that you must specify that the bundler create an MSI file with the nativeBundles attribute of the <fx:deploy> element.
<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>
Table 10-8 fx:callback
| Attribute | Description | Type | Required? |
|---|---|---|---|
|
|
Name of the event for callback. |
String |
Yes |
|
|
-- |
Reference |
No |
* If refid is used, then none of the other parameters can be specified.
In this example, a callback is used to create an HTML splash screen for an application embedded in a web page. When the event onGetSplash is triggered, the JavaScript function customGetSplash is executed.
<fx:callbacks>
<fx:callback name="onGetSplash">customGetSplash</fx:callback>
</fx:callbacks>
In this example, the callback is defined with JavaScript code in the <fx:callback> element itself.
<fx:callbacks>
<fx:callback name="onLoadHandler">
function () {perfLog(0, "onLoad called");}
</fx:callback>
</fx:callbacks>
<fx:callbacks>
<fx:callback name="onJavascriptReady">callAppFunction</fx:callback>
<fx:callback name="onGetSplash">function(id) {}</fx:callback>
</fx:callbacks>
Extension of the standard Ant FileSet type, which provides the means to specify optional meta information on a selected set of files. This includes:
Type of resource (see the type attribute)
Operating system and architecture for which this resource is applicable
When this resource is needed, which helps to optimize loading order
Depending on type, the resource might not be used by the enclosing task. See Section 5.7.2, "Application Resources" for details.
A fileset of type "jar" is expected to contain a set of JAR files to be added to the classpath.
Resource of type "native" is expected to be a JAR file with a set of native libraries. In most of cases, it makes sense to set the operating system and architecture for this resource too.
Resources of type "jnlp" are expected to contain JNLP files defining external JNLP extensions.
Filesets of type "license" can contain arbitrary files, but additional restrictions can be applied when they are actually used (for example, on Mac it has to be a plain text file, and on Windows it needs to be RTF).
Filesets of type "data" can contain arbitrary files.
Table 10-10 fx:fileset
| Attribute | Description | Type | Required? |
|---|---|---|---|
|
(used only when |
Specifies the architecture for which these resources should be considered. |
String |
No Default is |
|
|
-- |
String |
-- |
|
|
-- |
String |
-- |
|
(used only when |
Specifies the operating systems for which these resources should be considered. |
String |
No Default is |
|
(used only when |
Defines when resources are needed (affects loading priority). Supported values are:
|
String |
No Default is |
|
(used only when |
Type of the resources in the set. Supported values are:
|
String |
No Default is to guess based on extension. |
* If refid is used, then none of the other parameters can be specified.
Parameter to be passed to the embedded or Web Start application from the HTML page. The value of the parameter can be calculated at runtime using JavaScript.
Table 10-11 fx:htmlParam
| Attribute | Description | Type | Required? |
|---|---|---|---|
|
|
Defines how to interpret the value for the values that are passedas string literal (true) or JavaScript variable (false). |
Boolean |
No Default is true, meaning value is treated as string literal. |
|
|
Name of the parameter to be passed to the embedded or Web Start application from the HTML page. |
String |
Yes |
|
|
Value of the parameter. Could also be the name of a JavaScript variable whose value is expected to be passed as parameter. For JavaScript variables, ensure |
String |
Yes |
<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>
Passes an icon to the <fx:deploy> task, other than a splash screen image.
The icon specified in this element is used for Web Start and desktop applications.
Note that in JavaFX 2.2, only icons of type default are used for self-contained applications. For details on how to customize the icon for self-contained applications, see Section 7.3.3, "Customizing the Package Using Drop-In Resources."
Table 10-12 fx:icon
| Attribute | Description | Type | Required? |
|---|---|---|---|
|
|
Color depth of the image in bits-per-pixel. Common values are 8, 16, and 24. |
String |
No |
|
|
Location of image. For self-contained applications, the supported graphic formats depend on the operating system:
Note that if you specify your own icon for a self-contained application, the values of the attributes For Web Start applications, the supported graphic formats are |
String |
Yes |
|
|
Image height in pixels |
String |
No |
|
|
Icon type. Supported values are:
For Web Start applications, this attribute corresponds to the For desktop applications, if this attribute is not specified or set as |
String |
No Default value is |
|
|
Image width in pixels |
String |
No |
Application description for users. These details are shown in the system dialog boxes, if they need to be shown.
Table 10-13 fx:info
| Attribute | Description | Type | Required? |
|---|---|---|---|
|
|
Application category. Creates a link to an application in a specified category. Semantics of the value depends on the format of the package. For example:
|
String |
No |
|
|
Short copyright statement |
String |
No |
|
|
A short statement describing the application. |
String |
No |
|
|
License type (for example, GPL). As of JavaFX 2.2, this attribute is used only for Linux bundles. |
String |
No |
|
|
Title of the application |
String |
Yes |
|
|
Provider of the application |
String |
Yes |
The JVM argument to be set in the JVM, where the application is executed. Can be used multiple times. Note that you do not need to additionally escape values if they contain space characters.
The user overridable JVM argument to be set in the JVM, where the application is executed. Can be used multiple times. Note that you do not need to additionally escape values if they contain space characters.
Parameter to be passed to the application (embedded into application package).
This tag has no impact on standalone applications, including self-contained applications.
<fx:application name="Sample app"
mainClass="test.MyApplication">
<!-- parameter with name 'simpleParam' and fixed string value-->
<param name="simpleParam" value="something"/>
<!-- parameter with name 'complexParam' with value generated
at build time -->
<param name="complexParam" value="Compiled by ${java.version}"/>
<!-- parameter with name 'novalueParam' and no value -->
<param name="novalueParam"/>
</fx:application>
Definition of security permissions needed by application. By default, the application runs in the sandbox. Requesting elevated permissions requires signing the application JAR files.
This option has no impact on standalone applications, including self-contained applications.
Table 10-17 fx:permissions
| Attribute | Description | Type | Required? |
|---|---|---|---|
|
|
If set to true, then the certificate used to sign the JAR files are cached in the deployment descriptor. Caching enables the user to accept elevated permissions earlier in the startup process, which improves startup time. This setting has no effect if the application is run in the sandbox. |
Boolean |
No Default is false. |
|
|
If set to false, the application runs in the sandbox. |
Boolean |
No Default is false. |
See Section 5.9.3, "Embed Signing Certificate into Deployment Descriptor."
<fx:permissions elevated="true" cacheCertificates="true"/>
Table 10-18 fx:platform
| Attribute | Description | Type | Required? |
|---|---|---|---|
|
|
-- |
Reference |
No |
|
|
Minimum version of JavaFX required by the application. |
String |
No Default value matches the release of the JavaFX SDK; for example, if you use the JavaFX 2.2 SDK, the default value is '2.2'. |
|
|
Minimum version of JRE required by the application. |
String |
No Default is any JRE supporting JavaFX. |
* If refid is used, then none of the other parameters can be specified.
In this example, the application needs JavaFX Runtime version 2.1 or later and JRE version 7.0 or later.
<fx:platform javafx="2.1+" j2se="7.0"/>
In this example, the application needs JavaFX Runtime version 2.1 or later and needs to run in a JVM launched with "-Xmx400 -verbose:jni -Dpurpose="sample value".
<fx:platform javafx="2.1+">
<fx:jvmarg value="-Xmx400m"/>
<fx:jvmarg value="-verbose:jni"/>
<property name="purpose" value="sample value"/>
</fx:platform>
In this example, -Xmx768m is passed as a default value for heap size. The user can override this value in a user configuration file.
<fx:platform>
<fx:jvmuserarg name="-Xmx" value="768m" />
</fx:platform>
Deployment preferences for the application. Preferences can be expressed but may not necessarily be satisfied, for example in the following cases:
The packager may ignore a preference if it is not supported for a particular execution mode.
JRE may ignore it if it is not supported.
The user may reject a request, for example if he is prompted whether a desktop shortcut can be created.
Table 10-19 fx:preferences
| Attribute | Description | Type | Required? |
|---|---|---|---|
|
|
Install For self-contained applications, This value is ignored if the packager does not support different types of install packages for the requested package format. |
Boolean |
No For Web Start and embedded applications, default is For self-contained applications, default value is different for various package formats. |
|
|
If |
Boolean |
No Default is |
|
|
-- |
Reference |
No |
|
|
If true then application requests a desktop shortcut to be created. |
Boolean |
No Default is |
* If refid is used, then none of the other parameters can be specified.
This example shows a request to create a desktop shortcut.
<fx:preferences id="p1" shortcut="true"/>
This example does the following:
It requests creation of a web deployment descriptor that will add the application to the Applications Menu and mark it as installed (in other words, the application will be listed in Add/Remove programs.)
If self-contained bundles are created, then they will be installed system-wide and will create an application entry in the Applications menu.
<fx:preferences shortcut="false" install="true" menu="true"/>
This example uses a reference to the <fx:preferences> parameter in <fx:preferences> Parameter to Add a Desktop Shortcut to create the shortcut.
<fx:resource refid="p1"/>
Optional element and can be used multiple times. Java property to be set in the JVM where the application is executed.
The collection of resources used by the application. Defined as a set of JavaFX FileSet filters. Could be reused using id or refid.
Table 10-21 fx:resources
| Attribute | Description | Type | Required? |
|---|---|---|---|
|
|
ID that can be referred from another element with a refid attribute. |
String |
No |
|
|
-- |
Reference |
No |
* If refid is used, then none of the other parameters can be specified.
See also examples in Chapter 5, "Packaging Basics" and Chapter 7, "Self-Contained Application Packaging."
In this example, both <fx:resources> elements define the collection, consisting of s.jar in the dist directory. The first <fx:resources> element uses an id attribute, and the second <fx:resources> element refers to the first with the refid attribute.
<fx:resources id="aaa">
<fx:fileset dir="dist" includes="s.jar"/>
</fx:resources>
<fx:resources refid="aaa"/>
If you mix signed and unsigned JAR files, use an additional <fx:deploy> Ant task to generate an extension descriptor for each JAR file, and refer to the extension descriptors by treating them as resources in the main file, as shown in this example.
<!-- 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>
Identifies a secondary entry point for a self-contained application. This parameter is ignored for standalone applications, applications embedded in a web page, or applications launched from a browser.
This parameter is valid only for Windows and Linux applications.
Table 10-22 <fx:secondaryLauncher>
| Attribute | Description | Type | Required |
|---|---|---|---|
|
|
Brief description of the application. |
String |
No |
|
|
Path to the icon file for the application. |
String |
No |
|
|
Qualified name of the main application class. |
String |
No |
|
|
Flag that indicates if the application is added to the Start menu. The default is Either the |
Boolean |
No |
|
|
Name of the launcher that is used to start the application. |
String |
Yes |
|
|
Flag that indicates if a shortcut to the application is added to the desktop. The default is Either the |
Boolean |
No |
|
|
Title of the application. |
String |
No |
|
|
Name of the vendor that provided the application. |
String |
No |
|
|
Version of the application. |
String |
No |
<fx:bundleArgument>, only the icon argument is valid when used with <fx:secondaryLauncher>
Passes the location of the image to be used as a splash screen. Currently custom splash images can only be passed to Web Start applications, and use of this parameter has no impact on standalone applications or applications embedded into web pages.
Template to preprocess. A template is an HTML file that contains markers to be replaced with the JavaScript or HTML snippets that are required for web deployment. Using templates enables you to deploy your application directly into your own web pages. This simplifies the development process, especially when the application is tightly integrated with the page, for example when the web page uses JavaScript to communicate to the application.
Template markers have one of the following forms:
#XXX#
#XXX(id)#
id is the identifier of an application and XXX is one of following:
DT.SCRIPT.URL
Location of dtjava.js in the Deployment Toolkit. By default, the location is
//java.com/js/dtjava.js.
DT.SCRIPT.CODE
Script element to include dtjava.js of the Deployment Toolkit.
DT.EMBED.CODE.DYNAMIC
Code to embed the application into a given placeholder. It is expected that the code will be wrapped in the function() method.
DT.EMBED.CODE.ONLOAD
All the code needed to embed the application into a web page using the onload hook (except inclusion of dtjava.js).
DT.LAUNCH.CODE
Code needed to launch the application. It is expected that the code will be wrapped in the function() method.
A page with different applications can be processed multiple times, one per application. To avoid confusion, markers must use application IDs with an alphanumeric string and no spaces.
If the input and output files are the same then the template is processed in place.
This example shows a <fx:template> parameter in which both input and output files are specified.
<fx:template file="App_template.html" tofile="App.html"/>
<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>
