com.zenjava.javafx.maven.plugin

Class NativeMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.zenjava.javafx.maven.plugin.AbstractJfxToolsMojo

com.zenjava.javafx.maven.plugin.NativeMojo

All Implemented Interfaces:

org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo

public class NativeMojo
extends AbstractJfxToolsMojo

Generates native deployment bundles (MSI, EXE, DMG, RPG, etc). This Mojo simply wraps the JavaFX packaging tools so it has all the problems and limitations of those tools. Most importantly, this will only generate a native bundle for the platform you are building on (e.g. if you're on Windows you will get an MSI and an EXE). Additionally you need to first download and install the 3rd-party tools that the JavaFX packaging tools require (e.g. Wix, Inno, etc).

For detailed information on generating native packages it is best to first read through the official documentation on the JavaFX packaging tools.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	identifier Used as the 'id' of the application, and is used as the CFBundleDisplayName on Mac.
protected File	nativeOutputDir The output directory that the native bundles are to be built into.
protected String	preLoader A custom class that can act as a Pre-Loader for your app.
protected String	vendor The vendor of the application (i.e.

Fields inherited from class com.zenjava.javafx.maven.plugin.AbstractJfxToolsMojo

deployDir, jfxAppOutputDir, jfxMainAppJarName, mainClass, project, verbose

Fields inherited from interface org.apache.maven.plugin.Mojo

ROLE

Constructor Summary

Constructors

Constructor and Description
NativeMojo()

Method Summary

Methods

Modifier and Type	Method and Description
void	execute()

Methods inherited from class com.zenjava.javafx.maven.plugin.AbstractJfxToolsMojo

getPackagerLib

Methods inherited from class org.apache.maven.plugin.AbstractMojo

getLog, getPluginContext, setLog, setPluginContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

identifier

protected String identifier

Used as the 'id' of the application, and is used as the CFBundleDisplayName on Mac. See the official JavaFX Packaging tools documentation for other information on this.

vendor

protected String vendor

The vendor of the application (i.e. you). This is required for some of the installation bundles and it's recommended just to set it from the get-go to avoid problems. This will default to the project.organization.name element in you POM if you have one.

nativeOutputDir

protected File nativeOutputDir

The output directory that the native bundles are to be built into. This will be the base directory only as the JavaFX packaging tools use sub-directories that can't be customised. Generally just have a rummage through the sub-directories until you find what you are looking for.

This defaults to 'target/jfx/native' and the interesting files are usually under 'bundles'.

preLoader

protected String preLoader

A custom class that can act as a Pre-Loader for your app. The Pre-Loader is run before anything else and is useful for showing splash screens or similar 'progress' style windows. For more information on Pre-Loaders, see the official JavaFX packaging documentation.

Constructor Detail

NativeMojo

public NativeMojo()

Method Detail

execute

public void execute()
             throws org.apache.maven.plugin.MojoExecutionException,
                    org.apache.maven.plugin.MojoFailureException

Throws:

org.apache.maven.plugin.MojoExecutionException

org.apache.maven.plugin.MojoFailureException