Home » Java » Desktop Java » How To Write a NetBeans Plugin

About Alan Hamlett

Alan Hamlett
Alan is a full-stack developer who contributes to open source projects. He built WakaTime which is automated analytics for developers with plugins for Eclipse, IntelliJ and NetBeans among others. He writes on entrepreneurship and programming.

How To Write a NetBeans Plugin

Want to add a feature or automate something in your NetBeans IDE? Follow along as we write your first plugin for NetBeans.

Let’s go beyond the simple Toolbar Example and create a plugin which can auto-update itself. This code is based on the WakaTime plugin for NetBeans. Our example plugin will simply print a Hello World statement and update to new versions if available… just enough to get you started.

Create a new Plugin Project

Choose File -> New Project then NetBeans Modules -> Module as the project type.

create-plugin-project

Name your project

name-your-project

Choose a namespace or code name for your plugin

namespace-your-project

Add a Java File

create-java-file

name-java-file

Plugin Starting Point

After creating the new Java Class file, make it extend ModuleInstall and wrap it with @OnShowing so it only runs after the GUI has loaded.

@OnShowing
public class MyPlugin extends ModuleInstall implements Runnable {
}

Press ALT + ENTER with your cursor over OnShowing then select Search Module Dependency for OnShowing to import the Window System API into the project. This will add a new dependency to your project as well as add the necessary import statements to the top of your file. Also do this for ModuleInstall.

search-module-dependency

Sometimes NetBeans misses the org.openide.util dependency, so you might have to add that one manually. To do that, right click on MyPlugin then select Properties.

project-properties

Choose category Libraries then click Add.... Type org.openide.util then click OK. This will add the dependency to your project.xml file.

project-properties-libraries

add-utilities-api

Press ALT + ENTER on your MyPlugin class, then choose Implement all abstract methods.

implement-abstract-methods

One last thing, add this line to your manifest.mf file. OpenIDE-Module-Install: org/myorg/myplugin/MyPlugin.class

openide-module-install

Now the run() method will execute after your plugin has loaded.

plugin-has-loaded

Logging

Let’s make that println output to the NetBeans IDE log. First, setup the logger as an attribute of your MyPlugin class.

public static final Logger log = Logger.getLogger("MyPlugin");

Press ALT + ENTER to import java.util.logging.Logger.

add-logger-import

Replace println with log.info("MyPlugin has loaded.");.

log-line

Updating Your Plugin Automatically

Create a new Java file UpdateHandler.java inside your MyPlugin package.

Replace the contents of this file with UpdateHandler.java. Search the module dependency and add any missing dependencies by pressing ALT + ENTER over each import statement.

Add these lines to your manifest.mf file.

OpenIDE-Module-Layer: org/myorg/myplugin/layer.xml
OpenIDE-Module-Implementation-Version: 201501010101

Create a new XML document in your MyPlugin package.

new-xml-document

name-xml-document

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE filesystem PUBLIC "-//NetBeans//DTD Filesystem 1.2//EN" "http://www.netbeans.org/dtds/filesystem-1_2.dtd">
<filesystem>
    <folder name="Services">
        <folder name="AutoupdateType">
            <file name="org_myorg_myplugin_update_center.instance">
                <attr name="displayName" bundlevalue="org.myorg.myplugin.Bundle#Services/AutoupdateType/org_myorg_myplugin_update_center.instance"/>
                <attr name="enabled" boolvalue="true"/>
                <attr name="instanceCreate" methodvalue="org.netbeans.modules.autoupdate.updateprovider.AutoupdateCatalogFactory.createUpdateProvider"/>
                <attr name="instanceOf" stringvalue="org.netbeans.spi.autoupdate.UpdateProvider"/>
                <attr name="url" bundlevalue="org.myorg.myplugin.Bundle#org_myorg_myplugin_update_center"/>
            </file>
        </folder>
    </folder>
</filesystem>

Add this code to your MyPlugin class inside the run() method.

WindowManager.getDefault().invokeWhenUIReady(new Runnable () {
    @Override
    public void run() {
      UpdateHandler.checkAndHandleUpdates();
    }
});

Add these lines to your Bundle.properties file:

Services/AutoupdateType/org_myorg_myplugin_update_center.instance=MyPlugin
UpdateHandler.NewModules=false
org_myorg_myplugin_update_center=https\://example.com/updates.xml

Now every time NetBeans restarts and launches your plugin, it will check for updates by downloading updates.xml from example.com.

Your updates.xml file tells NetBeans where to get the new NBM of your plugin. To create an NBM for publishing your plugin, right click on your MyPlugin project and select Create NBM. The NBM file is what you will publish to the NetBeans Plugin Portal.

For an example of hosting updates.xml on GitHub, look at update.xml and corrosponding Bundle.properties from the WakaTime NetBeans plugin.

Reference: How To Write a NetBeans Plugin from our JCG partner Alan Hamlett at the Wakatime blog.
(0 rating, 0 votes)
You need to be a registered member to rate this.
Start the discussion Views Tweet it!
Do you want to know how to develop your skillset to become a Java Rockstar?
Subscribe to our newsletter to start Rocking right now!
To get you started we give you our best selling eBooks for FREE!
1. JPA Mini Book
2. JVM Troubleshooting Guide
3. JUnit Tutorial for Unit Testing
4. Java Annotations Tutorial
5. Java Interview Questions
6. Spring Interview Questions
7. Android UI Design
and many more ....
I agree to the Terms and Privacy Policy
Subscribe
Notify of
guest

This site uses Akismet to reduce spam. Learn how your comment data is processed.

0 Comments
Inline Feedbacks
View all comments