org.mdi.app.swing

Class AbstractMDIMenuFactory

java.lang.Object

org.mdi.app.swing.AbstractMDIMenuFactory

All Implemented Interfaces:

MDIMenuFactory

public abstract class AbstractMDIMenuFactory
extends java.lang.Object
implements MDIMenuFactory

This class creates the Menus for an AbstractMDIApplication.

Field Summary

Fields

Modifier and Type	Field and Description
protected MDIAbout	aboutAction The MDIApplication About component, if there is any.
protected GUIApplication	appli The MDIApplication.
protected java.util.Map<java.lang.String,javax.swing.JMenu>	bookmarkedMenus The bookmarked menus.
protected javax.swing.JMenuItem	closeAllItem The default Close all item for MDIApplication tabs.
protected javax.swing.JMenuItem	closeItem The default Close item for MDIApplication tabs.
protected javax.swing.JMenuItem	closeOtherItem The default Close other item for MDIApplication tabs.
protected java.util.Map<java.lang.String,java.lang.Object>	dynamicMenuKeyMap The key map for dynamic menus.
protected javax.swing.AbstractAction	exitAction The default exit Action for the MDIApplication.
protected PluginsMenuFactory	fac The factory for Plugins menus management.
protected javax.swing.JMenuBar	Mbar The Menu bar.
protected ProgressInterface	progress The Splash Screen, if there is any.
protected MDISettings	settingsAction The MDIApplication Settings component, if there is any.
protected java.util.Map<java.lang.String,javax.swing.JMenu>	staticMenuKeyMap The key map for static menus.
protected javax.swing.JPanel	tbarPanel The Tool bar panel.

Constructor Summary

Constructors

Constructor and Description
AbstractMDIMenuFactory() Constructor.

Method Summary

Modifier and Type	Method and Description
void	addPluginsToolBar() Add the Toolbar for the Plugins.
boolean	addToBookmarkedMenu(java.lang.String bookmark, javax.swing.AbstractAction action) Add an action to a bookmarked menu.
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.
protected void	addToDynamicMenus(java.lang.String key, java.lang.Object comp) Add a menu component to the dynamic Menu Map.
protected void	addToStaticMenus(java.lang.String key, javax.swing.JMenu comp) Add a menu to the static Menu Map.
boolean	bookmarkMenu(java.lang.String bookmark, javax.swing.JMenu menu) Bookmark a menu.
protected void	createDefaultClosePopupItems(javax.swing.JPopupMenu menu) Creaate the default close menu items for the popup menu on a tab.
MDIAbout	createDefaultMDIAbout(boolean modal) Create thee default About component.
MDIAbout	createDefaultMDIAbout(java.lang.String name, boolean modal) Create a default About component.
MDISettings	createDefaultMDISettings(java.lang.String name) Create a default settings component.
protected boolean	createDynamicMenu(java.lang.String menuKey) Create the dynamic plugin menu associated with the selected menu Key.
void	createPopupMenu(javax.swing.JPopupMenu menu) Create the Popup Menu.
javax.swing.JMenuItem	createSettingsMenuItem() Create a menu item for the settings action.
javax.swing.JMenuItem	createSettingsMenuItem(java.lang.String name) Create a menu item for the settings action.
protected void	disableStaticMenus() This method will disable high level menus which are registered in the staticMenuKeyMap and which are empty.
GUIApplication	getApplication() Return the Application.
javax.swing.JMenu	getBookmarkedMenu(java.lang.String bookmark) Return a bookmarked menu.
java.util.List<javax.swing.JMenuItem>	getCompatibleMenuItems(MetaData meta, boolean excludeSelected, java.awt.event.ActionListener listener) Return a list of JMenuItems for all the tabs compatible with a specific properties Map.
protected javax.swing.JMenuItem	getDefaultCloseAllItems() Return a default close all item for the selected application tab.
protected javax.swing.JMenuItem	getDefaultCloseAllItems(java.lang.String name) Return a default close item for the selected application tab.
protected javax.swing.JMenuItem	getDefaultCloseItem() Return a default close item for the selected application tab.
protected javax.swing.JMenuItem	getDefaultCloseItem(java.lang.String name) Return a default close item for the selected application tab.
protected javax.swing.JMenuItem	getDefaultCloseOtherItems() Return a default close other item for the selected application tab.
protected javax.swing.JMenuItem	getDefaultCloseOtherItems(java.lang.String name) Return a default close other item for the selected application tab.
protected javax.swing.AbstractAction	getDefaultExitAction() Return a default exit Action for the application.
protected javax.swing.AbstractAction	getDefaultExitAction(java.lang.String name) Return a default exit Action for the application.
java.lang.Object	getDynamicMenuComponent(java.lang.String menuKey) Return the Dynamic Menu Object under the key menu menuKey.
protected java.lang.Object	getDynamicMenuItems(SwingFileProperties prop, java.lang.String menuKey) Return the dynamic menu items for the MDIApplication.
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 MDIApplication settings component.
javax.swing.JMenuBar	getMenuBar() Return the MenuBar of the MDIApplication.
java.util.Set<java.lang.String>	getMenuBookmarks() Return the menu bookmarks keyset.
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.
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.
protected abstract void	initMenus() Construct the MDIApplication internal menus.
protected void	initMenusImpl() The method which is responsible for creating the Menus.
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	setLanguage(java.lang.String lang) Set the menu localization language.
void	setProgressInterface(ProgressInterface progress) Set the progress interface for the menu factory.
void	updateUI() Update the UI of the menus.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.mdi.bootstrap.swing.MDIMenuFactory

updateMenus

Field Detail

fac

protected PluginsMenuFactory fac

The factory for Plugins menus management.

appli

protected GUIApplication appli

The MDIApplication.

progress

protected ProgressInterface progress

The Splash Screen, if there is any.

settingsAction

protected MDISettings settingsAction

The MDIApplication Settings component, if there is any.

aboutAction

protected MDIAbout aboutAction

The MDIApplication About component, if there is any.

Mbar

protected javax.swing.JMenuBar Mbar

The Menu bar.

tbarPanel

protected javax.swing.JPanel tbarPanel

The Tool bar panel.

closeItem

protected javax.swing.JMenuItem closeItem

The default Close item for MDIApplication tabs.

closeAllItem

protected javax.swing.JMenuItem closeAllItem

The default Close all item for MDIApplication tabs.

closeOtherItem

protected javax.swing.JMenuItem closeOtherItem

The default Close other item for MDIApplication tabs.

exitAction

protected javax.swing.AbstractAction exitAction

The default exit Action for the MDIApplication.

staticMenuKeyMap

protected java.util.Map<java.lang.String,javax.swing.JMenu> staticMenuKeyMap

The key map for static menus. It maps String keys to Objectss created by the factory.

dynamicMenuKeyMap

protected java.util.Map<java.lang.String,java.lang.Object> dynamicMenuKeyMap

The key map for dynamic menus. It maps String keys to Objectss created by the factory. These Objects can be of one these types:

• an AbstractAction
• a JButton
• a JMenuItem
• a JMenu

bookmarkedMenus

protected final java.util.Map<java.lang.String,javax.swing.JMenu> bookmarkedMenus

The bookmarked menus.

Constructor Detail

AbstractMDIMenuFactory

public AbstractMDIMenuFactory()

Constructor.

Method Detail

setProgressInterface

public void setProgressInterface(ProgressInterface progress)

Set the progress interface for the menu factory.

Specified by:

setProgressInterface in interface MDIMenuFactory

Parameters:

progress - the progress interface

getProgressInterface

public ProgressInterface getProgressInterface()

Return the progress interface for the menu factory.

Specified by:

getProgressInterface in interface MDIMenuFactory

Returns:

the progress interface

getApplication

public GUIApplication getApplication()

Return the Application.

Specified by:

getApplication in interface MDIMenuFactory

Returns:

the Application

init

public 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

Specified by:

init in interface MDIMenuFactory

Parameters:

appli - the Application

hasToolBar - true if the Application must have toolbars

initMenus

protected abstract void initMenus()

Construct the MDIApplication internal menus.

initMenusImpl

protected final void initMenusImpl()

The method which is responsible for creating the Menus.

setLanguage

public void setLanguage(java.lang.String lang)

Set the menu localization language. It is a shorcut to MenusLocalization.setLocale(java.lang.String).

Specified by:

setLanguage in interface MDIMenuFactory

Parameters:

lang - the language

createDefaultClosePopupItems

protected void createDefaultClosePopupItems(javax.swing.JPopupMenu menu)

Creaate the default close menu items for the popup menu on a tab. It will contain:

• A Close item
• A Close All item if the application has ore than one tab
• A Close Other item if the application has ore than one tab

Parameters:

menu - the menu

createPopupMenu

public void createPopupMenu(javax.swing.JPopupMenu menu)

Create the Popup Menu. Do nothing by Default.

Specified by:

createPopupMenu in interface MDIMenuFactory

Parameters:

menu - the Popup Menu

createSettingsMenuItem

public javax.swing.JMenuItem createSettingsMenuItem()

Create a menu item for the settings action.

Returns:

The menu item

See Also:

getMDISettings()

createSettingsMenuItem

public javax.swing.JMenuItem createSettingsMenuItem(java.lang.String name)

Create a menu item for the settings action.

Parameters:

name - the settings component name

Returns:

The menu item

See Also:

getMDISettings()

createDefaultMDISettings

public MDISettings createDefaultMDISettings(java.lang.String name)

Create a default settings component.

Specified by:

createDefaultMDISettings in interface MDIMenuFactory

Parameters:

name - the settings component name

Returns:

the settings component

getMDIAbout

public MDIAbout getMDIAbout()

Return the About component.

Specified by:

getMDIAbout in interface MDIMenuFactory

Returns:

the About component

createDefaultMDIAbout

public MDIAbout createDefaultMDIAbout(boolean modal)

Create thee default About component.

Parameters:

modal - true if the dialog is modal

Returns:

the About component

createDefaultMDIAbout

public MDIAbout createDefaultMDIAbout(java.lang.String name,
                                      boolean modal)

Create a default About component.

Specified by:

createDefaultMDIAbout in interface MDIMenuFactory

Parameters:

name - the component name

modal - true if the dialog is modal

Returns:

the About component

addToDynamicMenuMap

public boolean addToDynamicMenuMap(java.lang.String key,
                                   javax.swing.JComponent comp)

Add the component to the dynamic menu Map, under the menuKey key.

Specified by:

addToDynamicMenuMap in interface MDIMenuFactory

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

bookmarkMenu

public boolean bookmarkMenu(java.lang.String bookmark,
                            javax.swing.JMenu menu)

Bookmark a menu.

Specified by:

bookmarkMenu in interface MDIMenuFactory

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

hasMenuBookmark

public boolean hasMenuBookmark(java.lang.String key)

Return true if there is a menu bookmark of a specified key.

Specified by:

hasMenuBookmark in interface MDIMenuFactory

Parameters:

key - the bookmark key

Returns:

true if there is a menu bookmark of the specified key

getMenuBookmarks

public java.util.Set<java.lang.String> getMenuBookmarks()

Return the menu bookmarks keyset. Note that the keyset in the bookmarks map will be copied. it means that if you change the set contents the initial Map will not be modified.

Specified by:

getMenuBookmarks in interface MDIMenuFactory

Returns:

the bookmarks keyset

getBookmarkedMenu

public javax.swing.JMenu getBookmarkedMenu(java.lang.String bookmark)

Return a bookmarked menu.

Specified by:

getBookmarkedMenu in interface MDIMenuFactory

Parameters:

bookmark - the bookmark

Returns:

the menu

addToBookmarkedMenu

public boolean addToBookmarkedMenu(java.lang.String bookmark,
                                   javax.swing.AbstractAction action)

Add an action to a bookmarked menu. Return false by default.

Specified by:

addToBookmarkedMenu in interface MDIMenuFactory

Parameters:

bookmark - the bookmark

action - the action

Returns:

true if the menu exists

addToBookmarkedMenu

public boolean addToBookmarkedMenu(java.lang.String bookmark,
                                   javax.swing.JComponent comp)

Add a component to a bookmarked menu. This element can be:

• a JButton
• a JMenuItem
• a JMenu

Specified by:

addToBookmarkedMenu in interface MDIMenuFactory

Parameters:

bookmark - the bookmark

comp - the component

Returns:

true if the menu exists, and the component can be added

addToDynamicMenuMap

public boolean addToDynamicMenuMap(java.lang.String menuKey,
                                   javax.swing.AbstractAction action)

Add the AbstractAction to the dynamic menu Map, under the menuKey key.

Specified by:

addToDynamicMenuMap in interface MDIMenuFactory

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

getDynamicMenuComponent

public 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

Specified by:

getDynamicMenuComponent in interface MDIMenuFactory

Parameters:

menuKey - the menu key

Returns:

the Dynamic Menu Object under the key menu menuKey

getDynamicMenuMap

public 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

Specified by:

getDynamicMenuMap in interface MDIMenuFactory

Returns:

the Dynamic Menu Map

addToDynamicMenus

protected void addToDynamicMenus(java.lang.String key,
                                 java.lang.Object comp)

Add a menu component to the dynamic Menu Map. This Map maps menu keys to elements which can be:

• an AbstractAction
• a JButton
• a JMenuItem
• a JMenu

Note that by default dynamic menus which are defined in this map and don't have any associated submenus or menu items.

Parameters:

key - the menu key

comp - the menu component

getStaticMenuMap

public java.util.Map<java.lang.String,javax.swing.JMenu> getStaticMenuMap()

Return the static Menu Map. 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 (see disableStaticMenus()).

Specified by:

getStaticMenuMap in interface MDIMenuFactory

Returns:

the static Menu Map

addToStaticMenus

protected void addToStaticMenus(java.lang.String key,
                                javax.swing.JMenu comp)

Add a menu to the static Menu Map. 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 (see disableStaticMenus()).

Parameters:

key - the menu key

comp - the menu component

registerMenus

public void registerMenus()

Register the Plugins static menus if there are any Plugin.

Specified by:

registerMenus in interface MDIMenuFactory

disableStaticMenus

protected void disableStaticMenus()

This method will disable high level menus which are registered in the staticMenuKeyMap and which are empty.

resetDynamicMenus

public boolean resetDynamicMenus()

Reset the dynamic menus (all dynamic menus that have been registered under menu keys).

Specified by:

resetDynamicMenus in interface MDIMenuFactory

Returns:

true if some menus where reset

getDynamicMenuItems

protected java.lang.Object getDynamicMenuItems(SwingFileProperties prop,
                                               java.lang.String menuKey)

Return the dynamic menu items for the MDIApplication. Return null by default.

Parameters:

menuKey - the PluginElementTypes type to retrieve

prop - the properties of the panel

Returns:

the dynamic menu items

createDynamicMenu

protected boolean createDynamicMenu(java.lang.String menuKey)

Create the dynamic plugin menu associated with the selected menu Key.

Parameters:

menuKey - the menu key

Returns:

true if any dynamic menu has been created or modified

getMDISettings

public MDISettings getMDISettings()

Return the MDIApplication settings component.

Specified by:

getMDISettings in interface MDIMenuFactory

Returns:

the MDIApplication settings component

getDefaultCloseItem

protected final javax.swing.JMenuItem getDefaultCloseItem()

Return a default close item for the selected application tab.

Returns:

the Close item

getDefaultCloseAllItems

protected final javax.swing.JMenuItem getDefaultCloseAllItems()

Return a default close all item for the selected application tab.

Returns:

the Close all item

getDefaultCloseOtherItems

protected final javax.swing.JMenuItem getDefaultCloseOtherItems()

Return a default close other item for the selected application tab.

Returns:

the Close other item

getDefaultCloseOtherItems

protected final javax.swing.JMenuItem getDefaultCloseOtherItems(java.lang.String name)

Return a default close other item for the selected application tab.

Parameters:

name - the tab name

Returns:

the Close item

getDefaultCloseAllItems

protected final javax.swing.JMenuItem getDefaultCloseAllItems(java.lang.String name)

Return a default close item for the selected application tab.

Parameters:

name - the tab name

Returns:

the Close item

getDefaultCloseItem

protected final javax.swing.JMenuItem getDefaultCloseItem(java.lang.String name)

Return a default close item for the selected application tab.

Parameters:

name - the tab name

Returns:

the Close item

getDefaultExitAction

protected final javax.swing.AbstractAction getDefaultExitAction()

Return a default exit Action for the application.

Returns:

a default exit Action for the application

getDefaultExitAction

protected final javax.swing.AbstractAction getDefaultExitAction(java.lang.String name)

Return a default exit Action for the application.

Parameters:

name - the action name

Returns:

a default exit Action for the application

getPluginsMenuFactory

public PluginsMenuFactory getPluginsMenuFactory()

Return the PluginsMenuFactory.

Specified by:

getPluginsMenuFactory in interface MDIMenuFactory

Returns:

the PluginsMenuFactory

getToolBarPanel

public javax.swing.JPanel getToolBarPanel()

Return the ToolBar of the MDIApplication.

Specified by:

getToolBarPanel in interface MDIMenuFactory

Returns:

the ToolBar

getMenuBar

public javax.swing.JMenuBar getMenuBar()

Return the MenuBar of the MDIApplication.

Specified by:

getMenuBar in interface MDIMenuFactory

Returns:

the MenuBar

addPluginsToolBar

public void addPluginsToolBar()

Add the Toolbar for the Plugins.

updateUI

public void updateUI()

Update the UI of the menus.

Specified by:

updateUI in interface MDIMenuFactory

getCompatibleMenuItems

public java.util.List<javax.swing.JMenuItem> getCompatibleMenuItems(MetaData meta,
                                                                    boolean excludeSelected,
                                                                    java.awt.event.ActionListener listener)

Return a list of JMenuItems for all the tabs compatible with a specific properties Map.

Parameters:

meta - the properties Map

excludeSelected - true if the currently selected tab must be excluded from the list

listener - an ActionListener that listen to JMenuItems selection

Returns:

the list of JMenuItems