MDIMenuFactory (MDIFramework API)

All Known Implementing Classes:

AbstractMDIMenuFactory
```
public interface MDIMenuFactory
```
The interface for the menu factory.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default boolean`	`addToBookmarkedMenu(java.lang.String bookmark, javax.swing.AbstractAction action)` Add an action to a bookmarked menu.
`default boolean`	`addToBookmarkedMenu(java.lang.String bookmark, javax.swing.JComponent comp)` Add a component to a bookmarked menu.
`boolean`	`addToDynamicMenuMap(java.lang.String menuKey, javax.swing.AbstractAction action)` Add the AbstractAction to the dynamic menu Map, under the menuKey key.
`boolean`	`addToDynamicMenuMap(java.lang.String key, javax.swing.JComponent comp)` Add the component to the dynamic menu Map, under the menuKey key.
`default boolean`	`bookmarkMenu(java.lang.String bookmark, javax.swing.JMenu menu)` Bookmark a menu.
`MDIAbout`	`createDefaultMDIAbout(java.lang.String name, boolean modal)` Create a default About component.
`MDISettings`	`createDefaultMDISettings(java.lang.String name)` Create a default settings component.
`void`	`createPopupMenu(javax.swing.JPopupMenu menu)` Create the Popup Menu.
`GUIApplication`	`getApplication()` Return the Application.
`default javax.swing.JMenu`	`getBookmarkedMenu(java.lang.String bookmark)` Return a bookmarked menu.
`java.lang.Object`	`getDynamicMenuComponent(java.lang.String menuKey)` Return the Dynamic Menu Object under the key menu menuKey.
`java.util.Map<java.lang.String,java.lang.Object>`	`getDynamicMenuMap()` Return the Dynamic Menu Map.
`MDIAbout`	`getMDIAbout()` Return the About component.
`MDISettings`	`getMDISettings()` Return the settings component.
`javax.swing.JMenuBar`	`getMenuBar()` Return the MenuBar of the MDIApplication.
`default java.util.Set<java.lang.String>`	`getMenuBookmarks()` Return the bookmarks.
`PluginsMenuFactory`	`getPluginsMenuFactory()` Return the PluginsMenuFactory.
`ProgressInterface`	`getProgressInterface()` Return the progress interface for the menu factory.
`java.util.Map<java.lang.String,javax.swing.JMenu>`	`getStaticMenuMap()` Return the static Menu Map.
`javax.swing.JPanel`	`getToolBarPanel()` Return the ToolBar of the MDIApplication.
`default boolean`	`hasMenuBookmark(java.lang.String key)` Return true if there is a menu bookmark of a specified key.
`void`	`init(GUIApplication appli, boolean hasToolBar)` Initialize the Menu Factory.
`void`	`registerMenus()` Register the Plugins static menus if there are any Plugin.
`boolean`	`resetDynamicMenus()` Reset the dynamic menus (all dynamic menus that have been registered under menu keys).
`void`	`setProgressInterface(ProgressInterface progress)` Set the progress interface for the menu factory.
`default void`	`updateMenus()` Update the MDIMenuFactory menus.
`default void`	`updateUI()` Update the UI of the menus.

- Method Detail
  - getApplication
```
GUIApplication getApplication()
```
    Return the Application.
    
    Returns:
    
    the Application
  - setProgressInterface
```
void setProgressInterface(ProgressInterface progress)
```
    Set the progress interface for the menu factory.
    
    Parameters:
    
    progress - the progress interface
  - getProgressInterface
```
ProgressInterface getProgressInterface()
```
    Return the progress interface for the menu factory.
    
    Returns:
    
    the progress interface
  - init
```
void init(GUIApplication appli,
          boolean hasToolBar)
```
    Initialize the Menu Factory. The factory performs internally the following tasks :
    - create the general settings menu
    - initialize the internal menus
    - register the external menus
    Parameters:
    
    appli - the Application
    
    hasToolBar - true if the Application must have toolbars
  - registerMenus
```
void registerMenus()
```
    Register the Plugins static menus if there are any Plugin.
  - updateMenus
```
default void updateMenus()
```
    Update the MDIMenuFactory menus. Do nothing by default.
  - getPluginsMenuFactory
```
PluginsMenuFactory getPluginsMenuFactory()
```
    Return the PluginsMenuFactory.
    
    Returns:
    
    the PluginsMenuFactory
  - getMDISettings
```
MDISettings getMDISettings()
```
    Return the settings component.
    
    Returns:
    
    the settings component
  - createDefaultMDISettings
```
MDISettings createDefaultMDISettings(java.lang.String name)
```
    Create a default settings component.
    
    Parameters:
    
    name - the component name
    
    Returns:
    
    the settings component
  - getMDIAbout
```
MDIAbout getMDIAbout()
```
    Return the About component.
    
    Returns:
    
    the About component
  - createDefaultMDIAbout
```
MDIAbout createDefaultMDIAbout(java.lang.String name,
                               boolean modal)
```
    Create a default About component.
    
    Parameters:
    
    name - the component name
    
    modal - true if the dialog is modal
    
    Returns:
    
    the About component
  - getMenuBar
```
javax.swing.JMenuBar getMenuBar()
```
    Return the MenuBar of the MDIApplication.
    
    Returns:
    
    the MenuBar
  - getToolBarPanel
```
javax.swing.JPanel getToolBarPanel()
```
    Return the ToolBar of the MDIApplication.
    
    Returns:
    
    the ToolBar
  - createPopupMenu
```
void createPopupMenu(javax.swing.JPopupMenu menu)
```
    Create the Popup Menu. Do nothing by Default.
    
    Parameters:
    
    menu - the Popup Menu
  - getStaticMenuMap
```
java.util.Map<java.lang.String,javax.swing.JMenu> getStaticMenuMap()
```
    Return the static Menu Map. This Map maps menu keys to elements which can be:
    - an AbstractAction
    - a JButton
    - a JMenuItem
    - a JMenu
    Note that by default static menus which are defined in this map and don't have any associated submenus or menu items will be disabled.
    Returns:
    
    the static Menu Map
  - getDynamicMenuMap
```
java.util.Map<java.lang.String,java.lang.Object> getDynamicMenuMap()
```
    Return the Dynamic Menu Map. This Map maps menu keys to elements which can be:
    - an AbstractAction
    - a JButton
    - a JMenuItem
    - a JMenu
    Returns:
    
    the Dynamic Menu Map
  - getDynamicMenuComponent
```
java.lang.Object getDynamicMenuComponent(java.lang.String menuKey)
```
    Return the Dynamic Menu Object under the key menu menuKey. This element can be:
    - an AbstractAction
    - a JButton
    - a JMenuItem
    - a JMenu
    Parameters:
    
    menuKey - the menu key
    
    Returns:
    
    the Dynamic Menu Object under the key menu menuKey
  - addToDynamicMenuMap
```
boolean addToDynamicMenuMap(java.lang.String key,
                            javax.swing.JComponent comp)
```
    Add the component to the dynamic menu Map, under the menuKey key.
    
    Parameters:
    
    key - the menu key
    
    comp - the component
    
    Returns:
    
    true if the component could be added, false if there was already a dynamic menu with the same key
  - addToDynamicMenuMap
```
boolean addToDynamicMenuMap(java.lang.String menuKey,
                            javax.swing.AbstractAction action)
```
    Add the AbstractAction to the dynamic menu Map, under the menuKey key.
    
    Parameters:
    
    menuKey - the menu key
    
    action - the Action
    
    Returns:
    
    true if the action could be added, false if there was already a dynamic menu with the same key
  - hasMenuBookmark
```
default boolean hasMenuBookmark(java.lang.String key)
```
    Return true if there is a menu bookmark of a specified key. Return false by default.
    
    Parameters:
    
    key - the bookmark key
    
    Returns:
    
    true if there is a menu bookmark of the specified key
  - getMenuBookmarks
```
default java.util.Set<java.lang.String> getMenuBookmarks()
```
    Return the bookmarks. Return an empty set by default.
    
    Returns:
    
    the bookmarks
  - bookmarkMenu
```
default boolean bookmarkMenu(java.lang.String bookmark,
                             javax.swing.JMenu menu)
```
    Bookmark a menu. Return false by default.
    
    Parameters:
    
    bookmark - the bookmark
    
    menu - the menu
    
    Returns:
    
    true if the bookmark could be created, false if a bookmark with the same name already existed
  - getBookmarkedMenu
```
default javax.swing.JMenu getBookmarkedMenu(java.lang.String bookmark)
```
    Return a bookmarked menu. Return null by default.
    
    Parameters:
    
    bookmark - the bookmark
    
    Returns:
    
    the menu
  - addToBookmarkedMenu
```
default boolean addToBookmarkedMenu(java.lang.String bookmark,
                                    javax.swing.AbstractAction action)
```
    Add an action to a bookmarked menu. Return false by default.
    
    Parameters:
    
    bookmark - the bookmark
    
    action - the action
    
    Returns:
    
    true if the menu exists, and the action could be added
  - addToBookmarkedMenu
```
default boolean addToBookmarkedMenu(java.lang.String bookmark,
                                    javax.swing.JComponent comp)
```
    Add a component to a bookmarked menu. Return false by default. This element can be:
    - a JButton
    - a JMenuItem
    - a JMenu
    Parameters:
    
    bookmark - the bookmark
    
    comp - the component
    
    Returns:
    
    true if the menu exists, and the component could be added
  - resetDynamicMenus
```
boolean resetDynamicMenus()
```
    Reset the dynamic menus (all dynamic menus that have been registered under menu keys).
    
    Returns:
    
    true if some menus where reset
  - updateUI
```
default void updateUI()
```
    Update the UI of the menus. Do nothing by default.

Interface MDIMenuFactory

Method Summary

Method Detail

getApplication

setProgressInterface

getProgressInterface

init

registerMenus

updateMenus

getPluginsMenuFactory

getMDISettings

createDefaultMDISettings

getMDIAbout

createDefaultMDIAbout

getMenuBar

getToolBarPanel

createPopupMenu

getStaticMenuMap

getDynamicMenuMap

getDynamicMenuComponent

addToDynamicMenuMap

addToDynamicMenuMap

hasMenuBookmark

getMenuBookmarks

bookmarkMenu

getBookmarkedMenu

addToBookmarkedMenu

addToBookmarkedMenu

resetDynamicMenus

updateUI