Menu factory

The MDIMenuFactory and its abstract implementation AbstractMDIMenuFactory allows to manage menus in a GUI application. Note that there is only one MDIMenuFactory for the application.

Implementing the menu factory

The only method you need to implement is the AbstractMDIMenuFactory.initMenus() method. This method allows to create menus under the menuBar and Toolbars under the Toolbar panel of the application:

• The AbstractMDIMenuFactory.Mbar is the menuBar of the application
• The AbstractMDIMenuFactory.tbarPanel is the Toolbar panel of the application

Adding a Splash screen

The MDIMenuFactory.setProgressInterface(ProgressInterface) allows to add a component which will show the progress of the initialization of the application before the application has fully started.

The SplashScreen is a default Swing progress interface which allows to show a Splash screen with a background image, and the version and date of the application.

Adding the menu factory to the application

To use the menu factory in the application, you need to call one of the following methods:

• The AbstractMDIApplication.preparePanels(int, MDIMenuFactory) with a default MessageArea, a Toolbar, and a Status bar
• The AbstractMDIApplication.preparePanels(int, boolean, boolean, MDIMenuFactory) with a default MessageArea in the application
• The AbstractMDIApplication.preparePanels(SwingMessageArea, boolean, boolean, MDIMenuFactory) with a custom MessageArea

These methods should be called after the application configuration has been initialized and the plugins have been registered.

For example:

      public class SimpleMDI extends AbstractMDIApplication {
        public SimpleMDI() {
          super("MDISimpleExample");

          // plugins will be in the same directory as the main application jar
          pluginsDir = new File(System.getProperty("user.dir"));

          // initialize configuration without Preferences
          this.initConfiguration();
          // register plugins in the plugins directory (same as main application jar directory)
          this.registerPlugins();

          // create the menus with the Application menu factory
          mfactory = new SimpleMenuFactory();
          // in this case:
          // - there is a default message area with 5 lines
          // - there is a toolbar
          // - there is a status bar
          super.preparePanels(4, true, true, mfactory);
          // set the size of the Application window
          this.setSize(500, 500);
        }
      }

Adding menus to the application GUI in the application

Two fields maintain the menubar and the toolbar of the application:

• The AbstractMDIMenuFactory.Mbar is the menuBar of the application. You can also use the MDIMenuFactory.getMenuBar() method to get the menu bar
• The AbstractMDIMenuFactory.tbarPanel is the Toolbar panel of the application. You can also use the MDIMenuFactory.getToolBarPanel() mzethod to get the toolbar

You can use the menubar and the toolbar as you wish in the menu factory.

Adding menus and toolbar buttons to the application GUI in Plugins

If you want to add menus in Plugins, you need to make the application high-level menus available by the application.

There are several ways to do that:

• Either by adding a static menu by AbstractMDIMenuFactory.addToStaticMenus(String, JMenu).
• Either by adding a dynamic menu MDIMenuFactory.addToDynamicMenuMap(String, JComponent) or MDIMenuFactory.addToDynamicMenuMap(String, AbstractAction).
• Either by setting a bookmark for any menu by AbstractMDIMenuFactory.bookmarkMenu(String, JMenu).

Adding an About dialog

Updating menus at runtime

It is possible to update the menus at runtime by implementing the MDIMenuFactory.updateMenus() method. This method can also be called by the GUIApplication.updateMenus(MDIPlugin) method:

• If the argument is null, the MDIMenuFactory.updateMenus() method will be called, and the MDIPlugin.updateMenus() method will be called for all the Plugins
• If the argument is not null, only the MDIPlugin.updateMenus() method will be called for the Plugin used as argument