Skip to content
This repository has been archived by the owner on Jun 12, 2023. It is now read-only.

Latest commit

 

History

History
279 lines (197 loc) · 10.9 KB

README.md

File metadata and controls

279 lines (197 loc) · 10.9 KB
Raw

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

NetBeansIDE-AfterburnerFX-Plugin.png

Content

Screenshots

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

1. Open the Wizard

plugin-1-open.png

2. Choose File Type

plugin-2-file-type.png

3. Primary Files

plugin-3-primary-files.png

4. Optional Files

plugin-4-optional-files.png

5. Summary

plugin-5-summary.png

6. Generated files

plugin-6-generated-files.png

Features

General
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

Installation

General installation
Manual installation from the plugin in NetBeans IDE
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
Images

Autor

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

Contact