NetBeansIDE-AfterburnerFX-Plugin

Intention

The NetBeansIDE-AfterburnerFX-Plugin is a NetBeans IDE plugin which supports the file generation in convention with the library afterburner.fx in a JavaFX project.

The following primary files [FileName].fxml, [FileName]Presenter.java, [FileName]View.java and optional [FileName].css, [FileName].properties and configuration.properties can be created in a new wizard.
One conditional is that [FileName].toLowerCase() must be equals with the last choosen package name.

Press

• Interview with Adam Bien about me and the plugin: afterburner.fx NetBeans plugin release - an interview
• Adam Bien introduced my plugin in one of his videos DI, IoC and MVP With Java FX -- afterburner.fx Deep Dive (see at 48:00)):

Content

• Screenshots
• Features
  • General
  • Generated Files
  • Injection from the Optional Files
  • Validation from user input
• Requirements
• Installation
  • General installation
  • Manual installation from the plugin in NetBeans IDE
  • Plugin installation through the Update Center from NetBeans IDE
• Contribution
• License
• Autor
• Contact

Screenshots

The following screenshots shows the workflow to create the new 'AfterburnerFX Files'. The screenshots are taken under Windows 10.

1. Open the Wizard

2. Choose File Type

3. Primary Files

4. Optional Files

5. Summary

6. Generated files

Features

General

• The plugin create a new wizard in NetBeans IDE which allowed the fast generation from the Model-View-Controller files for your JavaFX project in convention with the library afterburner.fx.
• The plugin is developed with the NetBeans IDE 8.0.2.
• The plugin is a NetBeans IDE plugin .
• The plugin is an Open Source project.
• The plugin is tested with JUnit tests.

Generated Files

Following files can be created in the new wizard:

• Primary files are [FileName].fxml, [FileName]Presenter.java and [FileName]View.java where [FileName].toLowerCase() must be equals with the last choosen package name.
  • Additional option: File [FileName].fxml should be lowercase.
• Optional files are [FileName].css, [FileName].properties and configuration.properties.
  • Additional options: File [FileName].css and/or file [FileName].properties and/or configuration.properties should be lowercase.
• The optional files can also additional injected into following files:
  • The [FileName].css file can additional injected into the [FileName].fxml file.
  • The [FileName].properties can additional injected into into the [FileName]Presenter.java file.

Injection from the Optional Files

Comparison with/without injection from the Optional File ImportDialog.css in ImportDialog.fxml.

Without injection:

<AnchorPane id="AnchorPane" prefHeight="400.0" prefWidth="600.0" xmlns:fx="http://javafx.com/fxml/1" fx:controller="org.my.demoapplication.importdialog.ImportdialogPresenter">

</AnchorPane>

With injection:

<AnchorPane id="AnchorPane" prefHeight="400.0" prefWidth="600.0" styleClass="mainFxmlClass" xmlns:fx="http://javafx.com/fxml/1" fx:controller="org.my.demoapplication.importdialog.ImportdialogPresenter">
    <stylesheets>
        <URL value="@Importdialog.css"/>
    </stylesheets>
</AnchorPane>

Comparison with/without injection from the Optional File ImportDialog.properties in ImportDialogPresenter.java`.

Without injection:

public class ImportdialogPresenter implements Initializable {

    @Override
    public void initialize(URL location, ResourceBundle resources) {
        
    }
}

With injection:

public class ImportdialogPresenter implements Initializable {

    private ResourceBundle resources = null;
    
    @Override
    public void initialize(URL location, ResourceBundle resources) {
        this.resources = resources;
    }
}

Validation from user input

• The wizard gives the user feedback if the choosen [FileName] and package name aren't in convention with the library afterburner.fx. The [FileName].toLowerCase() and the last choosen package name must be equals.
• Feedback is also given if the choosen [FileName] and / or package name doesn't follow the rules from the Java Naming Convention.

Requirements

• On your system you need JRE 8 or JDK 8 installed.
• You should use NetBeans IDE as your development ide .
• The plugin should be installed in your NetBeans IDE .
• In your JavaFX project the library afterburner.fx should be injected .

Installation

General installation

• If not installed download the JRE 8 or the JDK 8.
  • Optional: To work better with FXML files in a JavaFX application download the JavaFX Scene Builder in the section 'Additional Resources'.
• If not installed download the NetBeans IDE.

Manual installation from the plugin in NetBeans IDE

• Download the plugin from here NetBeansIDE-AfterburnerFX-Plugin.nbm (GitHub) or from here NetBeansIDE-AfterburnerFX-Plugin.nbm (NetBeans Plugin Portal).
• Click in the toolbar from the NetBeans IDE on Tools, then Plugins.
• In the opened dialog click on the tab 'Downloaded`.
• Click on the button Add Plugins... and select then downloaded plugin.
• Clicking Install will prompt the dialog Verify Certifcate.
  • Optional: You can view the certificate with the button Show certificate.
  • Click the button Continue for installing the plugin.

Plugin installation through the Update Center from NetBeans IDE

• Click on Tool -> Plugins action in the IDE.
• Click on the tab Available Plugins and then Check for Newest.
• Search and checked the plugin in the list from available plugins.
• Clicking Install will prompt the dialog Verify Certifcate.
  • Optional: You can view the certificate with the button Show certificate.
  • Click the button Continue for installing the plugin.

Contribution

• If you find a Bug I will be glad if you will report an Issue.
• If you want to contribute to the project plz fork the project and do a Pull Request.

License

Project

• The project NetBeansIDE-AfterburnerFX-Plugin is licensed under General Public License 3.0.

Images

• The smilys in this document are from famfamfam. Click famfamfam ReadMe for more information.
• The action icon is the changed NetBeans IDE class.png icon from the modul java.source.

Autor

• The project NetBeansIDE-AfterburnerFX-Plugin is maintained by me, Peter Rogge. See Contact.

Contact

• You can reach me under [email protected].