...

This tutorial introduces the IGB platform by demonstrating a very simple IGB plug-in that adds a new entry to the IGB Tools menu. 

...

Completed Project Example

Before reading through this tutorial, you may want to clone the completed IGB App project so that you can see a complete, working example of the IGB App.

...

The image below shows an example of the IGB Tools Menu with the addition of a Hello World App item in the menu. The tutorial on this page will walk you through the steps required to add a menu item to one of the IGB menus, as seen in the image below. While this may seem trivial, it is not, because by adding a menu item to an IGB menu a developer can create an entry point that their IGB App can hook into.

Build the App

To build your App, open the igb-app-hello-world project into Netbeans, select your project in the Projects tab, and then select Run > Build.

Alternatively, you can build it from the command line by entering:

mvn clean install

Install the App in IGB

Start IGB and add your target directory as a new plugin repository (local App store)

1. Re-open IGB project (double-click it in the Projects tab or use File > Open Project)
2. Open the IGB "main" sub-project; select IGB Project > Modules > main
3. Select Run to run IGB
4. Within IGB, select the Plug-Ins Tab
5. Select Launch App Manager to open the App Manager window
6. Within the App manager, select Manage Repositories... (top right corner). This opens the App Repositories tab in the IGB Preferences window
   1. Image Removed
7. Within the App Repositories tab in the Preferences window, select Add 
8. Enter a name for your repository, and then select the Choose local folder button
   1. Image Removed
9. Select the target directory of your maven project and click submit. The target directory is the actual target directory created by maven when you built your App.
   1. Image Removed
10. Close the Preferences window and return to the IGB App Manager
11. Note that your App should now appear in the left pane of the IGB App Manager. Select it and click the Install button. This will cause the OSGi run-time to instantiate your new menu item and add it to IGB.
    
    1. Image Removed

Run your new App

To run your app:

• Open the Tools menu in IGB. Observe your Hello World App menu item is an option.

Image Removed

• Select Tools > Hello World App to run your App; observe the message that appears:

Image Removed

Next step: Modify your code (optional)

...

To demonstrate how an IGB plugin could hook into and expand the IGB toolbar, you can write a new class that implements the MenuBarEntryProvider interface.

This interface is designed to allow App developers to add new menu items to the IGB application's top level menus.

IGB has seven top-level menus, as seen below:

 Image Added

The MenuBarEntryProvider interface contains the following methods, shown below. To add a new menu item to IGB, you'll create a class that implements this interface. In other words, you'll create a class that provides an IGB menu item to the OSGi run-time, which will add it to IGB as soon as it becomes available.

public interface MenuBarEntryProvider {
    public Optional<List<MenuItem>> getMenuItems();
	public MenuBarParentMenu getMenuExtensionParent();
 }

...

Build the App

To build your App, open the igb-app-hello-world project into Netbeans, select your project in the Projects tab, and then select Run > Build.

Alternatively, you can build it from the command line by entering:

mvn clean install

...

Install the App in IGB

Start IGB and add your target directory as a new plugin repository (local App store)

1. Re-open IGB project (double-click it in the Projects tab or use File > Open Project)
2. Open the IGB "main" sub-project; select IGB Project > Modules > main
3. Select Run to run IGB
4. Within IGB, select the Plug-Ins Tab
5. Select Launch App Manager to open the App Manager window
6. Within the App manager, select Manage Repositories... (top right corner). This opens the App Repositories tab in the IGB Preferences window
   1. Image Added
7. Within the App Repositories tab in the Preferences window, select Add 
8. Enter a name for your repository, and then select the Choose local folder button
   1. Image Added
9. Select the target directory of your maven project and click submit. The target directory is the actual target directory created by maven when you built your App.
   1. Image Added
10. Close the Preferences window and return to the IGB App Manager
11. Note that your App should now appear in the left pane of the IGB App Manager. Select it and click the Install button. This will cause the OSGi run-time to instantiate your new menu item and add it to IGB.
    
    1. Image Added

...

Run your new App

To run your app:

• Open the Tools menu in IGB. Observe your Hello World App menu item is an option.

Image Added

• Select Tools > Hello World App to run your App; observe the message that appears:

Image Added

...

Adding a new item to the IGB Tools menu 

To demonstrate how an IGB plugin could hook into and expand the IGB toolbar, you can write a new class that implements the MenuBarEntryProvider interface.

This interface is designed to allow App developers to add new menu items to the IGB application's top level menus.

IGB (as of this writing) has seven top-level menus, including:

 Image Removed

The MenuBarEntryProvider interface contains the following methods, shown below. To add a new menu item to IGB, you'll create a class that implements this interface. In other words, you'll create a class that provides an IGB menu item to the OSGi run-time, which will add it to IGB as soon as it becomes available.

public interface MenuBarEntryProvider {
    public Optional<List<MenuItem>> getMenuItems();
	public MenuBarParentMenu getMenuExtensionParent();
 }

Note that this interface will likely change in future releases of the IGB API. The getParentMenuName method will likely a custom enum type and not a String literal.  Additionally, we will add "weight" as an attribute to our custom JMenuItem class.  So it is likely this interface will ultimately contain one simple getMenuItem() method.  

...

...

package org.lorainelab.igb.menu.api.example;
import aQute.bnd.annotation.component.Component;
import java.util.Arrays;
import java.util.List;
import java.util.Optional;
import javax.swing.JOptionPane;
import org.lorainelab.igb.menu.api.MenuBarEntryProvider;
import org.lorainelab.igb.menu.api.model.MenuBarParentMenu;
import org.lorainelab.igb.menu.api.model.MenuItem;
@Component(immediate = true)
public class MenuBarExtensionExample implements MenuBarEntryProvider {

    @Override
    public Optional<List<MenuItem>> getMenuItems() {
        MenuItem menuItem = new MenuItem("Hello World App", (Void t) -> {
            JOptionPane.showMessageDialog(null, "Hello IGB World!");
            return t;
        });
        menuItem.setWeight(1000000000);
        return Optional.ofNullable(Arrays.asList(menuItem));
    }

    @Override
    public MenuBarParentMenu getMenuExtensionParent() {
        return MenuBarParentMenu.TOOLS;
    }
}