com.zenjava.javafx.maven.plugin

Class AbstractJfxToolsMojo

java.lang.Object

org.apache.maven.plugin.AbstractMojo

com.zenjava.javafx.maven.plugin.AbstractJfxToolsMojo

All Implemented Interfaces:

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

Direct Known Subclasses:

JarMojo, NativeMojo, WebMojo

public abstract class AbstractJfxToolsMojo
extends org.apache.maven.plugin.AbstractMojo

Base Mojo that any other Mojo wanting to access the JavaFX Packager tools should extend from. This provides convenience methods for accessing the JavaFX Packager tools in a standard and simple way.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	deployDir The directory contain deployment specific files, such as icons and splash screen images.
protected File	jfxAppOutputDir The 'app' output directory.
protected String	jfxMainAppJarName The name of the JavaFX packaged JAR to be built into the 'app' directory.
protected String	mainClass The main JavaFX application class that acts as the entry point to the JavaFX application.
protected org.apache.maven.project.MavenProject	project The Maven Project Object
protected Boolean	verbose Flag to turn on verbose logging.

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

ROLE

Constructor Summary

Constructors

Constructor and Description
AbstractJfxToolsMojo()

Method Summary

Methods

Modifier and Type	Method and Description
com.sun.javafx.tools.packager.PackagerLib	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

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

execute

Field Detail

project

protected org.apache.maven.project.MavenProject project

The Maven Project Object

verbose

protected Boolean verbose

Flag to turn on verbose logging. Set this to true if you are having problems and what more detailed information.

mainClass

protected String mainClass

The main JavaFX application class that acts as the entry point to the JavaFX application.

jfxAppOutputDir

protected File jfxAppOutputDir

The 'app' output directory. This is where the base executable JavaFX jar is built into, along with any dependent libraries (place in the 'lib' sub-directory). The resulting JAR in this directory will be ready for distribution, including Pre-Loaders, signing, etc. This JAR will also be the one bundled into the other distribution bundles (i.e. web or native) if you run the relevant commands for that.

This defaults to 'target/jfx/app' and in most cases there is no real need to change this.

jfxMainAppJarName

protected String jfxMainAppJarName

The name of the JavaFX packaged JAR to be built into the 'app' directory. By default this will be the finalName as set in your project with a '-jfx' suffix. Change this if you want something nicer. Note, that changing this value does not affect the regular old, non-JFX modified JAR (built in the 'target' directory).

deployDir

protected String deployDir

The directory contain deployment specific files, such as icons and splash screen images. This directory is added to the classpath of the Mojo when it runs, so that any files within this directory are accessible to the JavaFX packaging tools.

This defaults to src/main/deploy and typically this is good enough. Just put your deployment specific files in this directory and they will be automatically picked up.

The most common usage for this is to provide platform specific icons for native bundles. In this case you need to follow the convention of the JavaFX packaging tools to ensure your icons get picked up.

• for windows put an icon at src/main/deploy/package/windows/your-app-name.ico
• for mac put an icon at src/main/deploy/package/macosx/your-app-name.icns

Constructor Detail

AbstractJfxToolsMojo

public AbstractJfxToolsMojo()

Method Detail

getPackagerLib

public com.sun.javafx.tools.packager.PackagerLib getPackagerLib()
                                                         throws org.apache.maven.plugin.MojoExecutionException

Throws:

org.apache.maven.plugin.MojoExecutionException