javafx-maven-plugin

by openjfx

Maven plugin to run JavaFX 11+ applications

169 Stars 30 Forks Last release: over 1 year ago (0.0.2) Apache License 2.0 105 Commits 3 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

Maven plugin for JavaFX

Maven Central Travis CI Apache License

Maven plugin to run JavaFX 11+ applications

Install

The plugin is available via Maven Central.

In case you want to build and install the latest snapshot, you can clone the project, set JDK 11 and run

mvn install

Usage

Create a new Maven project, use an existing one like HelloFX, or use an archetype.

The project can be modular or non-modular.

JavaFX dependencies are added as usual:

    org.openjfx
    javafx-controls
    12.0.2

Add the plugin:

    org.openjfx
    javafx-maven-plugin
    0.0.4
    
        hellofx/org.openjfx.App
    

To compile the project (optional):

mvn javafx:compile

Alternatively, the

maven-compiler-plugin
can be used:
mvn compile

Note that including this plugin is convenient for a better project integration within your IDE.

To run the project:

mvn javafx:run

For modular projects, to create and run a custom image:

mvn javafx:jlink

target/image/bin/java -m hellofx/org.openjfx.App

javafx:compile options

When compiling with

javafx:compile
, the source level, target level and/or the release level for the Java compiler can be set. The default value is 11.

This configuration changes these levels to 12, for instance:

    org.openjfx
    javafx-maven-plugin
    0.0.4
    
        12
        12
        12
        org.openjfx.hellofx/org.openjfx.App
    

If required, compiler arguments can be set. For instance:

    org.openjfx
    javafx-maven-plugin
    0.0.4
    
        
            --add-exports
            javafx.graphics/com.sun.glass.ui=org.openjfx.hellofx
        
        org.openjfx.hellofx/org.openjfx.App
    

javafx:run options

The plugin includes by default:

--module-path
,
--add-modules
and
-classpath
options.

Optionally, the configuration can be modified with:

  • mainClass
    : The main class, fully qualified name, with or without module name
  • workingDirectory
    : The current working directory
  • skip
    : Skip the execution. Values: false (default), true
  • outputFile
    File to redirect the process output
  • options
    : A list of VM options passed to the executable.
  • commandlineArgs
    : Arguments separated by space for the executed program
  • includePathExceptionsInClasspath
    : When resolving the module-path, setting this value to true will include the dependencies that generate path exceptions in the classpath. By default the value is false, and these dependencies won't be included.

For instance, the following configuration adds some VM options and a command line argument:

    org.openjfx
    javafx-maven-plugin
    0.0.4
    
        org.openjfx.hellofx/org.openjfx.App
        
            --add-opens
            java.base/java.lang=org.openjfx.hellofx
        
        -Xmx1024m
    

Note

It is possible to use a local SDK instead of Maven Central. This is helpful for developers trying to test a local build of OpenJFX. Since transitive dependencies are not resolved, all the required jars needs to be added as a separate dependency, like:

    /path/to/javafx-sdk



    
        org.openjfx
        javafx.base
        1.0
        system
        ${sdk}/lib/javafx.base.jar
    
    ...

javafx:jlink options

The same command line options for

jlink
can be set:
  • stripDebug
    : Strips debug information out. Values: false (default) or true
  • stripJavaDebugAttributes
    : Strip Java debug attributes out (since Java 13), Values: false (default) or true
  • compress
    : Compression level of the resources being used. Values: 0 (default), 1, 2.
  • noHeaderFiles
    : Removes the
    includes
    directory in the resulting runtime image. Values: false (default) or true
  • noManPages
    : Removes the
    man
    directory in the resulting runtime image. Values: false (default) or true
  • bindServices
    : Adds the option to bind services. Values: false (default) or true
  • ignoreSigningInformation
    : Adds the option to ignore signing information. Values: false (default) or true
  • jlinkVerbose
    : Adds the verbose option. Values: false (default) or true
  • launcher
    : Adds a launcher script with the given name.
    • If
      options
      are defined, these will be passed to the launcher script as vm options.
    • If
      commandLineArgs
      are defined, these will be passed to the launcher script as command line arguments.
  • jlinkImageName
    : The name of the folder with the resulting runtime image
  • jlinkZipName
    : When set, creates a zip of the resulting runtime image
  • jlinkExecutable
    : The
    jlink
    executable. It can be a full path or the name of the executable, if it is in the PATH.
  • jmodsPath
    : When using a local JavaFX SDK, sets the path to the local JavaFX jmods

For instance, with the following configuration:

    org.openjfx
    javafx-maven-plugin
    0.0.4
    
        true
        2
        true
        true
        hellofx
        hello
        hellozip
        hellofx/org.openjfx.MainApp
    

a custom image can be created and run as:

mvn clean javafx:jlink

target/hello/bin/hellofx

Issues and Contributions

Issues can be reported to the Issue tracker.

Contributions can be submitted via Pull requests, providing you have signed the Gluon Individual Contributor License Agreement (CLA).

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.