org.mdi.plugins.swing

Class PluginsMenuFactory

java.lang.Object

org.mdi.plugins.swing.PluginsMenuFactory

public class PluginsMenuFactory
extends java.lang.Object

This class creates the specifics Plugins Menus.

Field Summary

Fields

Modifier and Type	Field and Description
protected GUIApplication	app The GUIApplication.
protected java.util.Map<java.lang.String,java.lang.Boolean>	enabledPlugins
protected PluginMenuHandler	handler The Plugins MenuHandler.
protected MDIAbout	mdiAbout The About component.
protected java.util.List<PluginsManager.PluginPeer>	pluginsClazz The Plugins peers.
protected java.util.Map<java.lang.String,PluginsManager.PluginPeer>	pluginsList The list of Plugin peers.
protected javax.swing.table.DefaultTableModel	pluginsTableModel
protected java.util.List<MDIPlugin<?>>	pluginsVector The list of Plugins.
protected MDISettings	settingsAction The settings component.

Constructor Summary

Constructors

Constructor and Description
PluginsMenuFactory(GUIApplication app) Create the factory.

Method Summary

Modifier and Type	Method and Description
javax.swing.AbstractAction	getAboutPluginsAction() Return the About action for Plugins.
Plugin	getCompatiblePlugin(java.lang.String menuKey, MetaData meta) Return the first Plugin compatible with some MetaData, for the selected menu Key.
java.util.List<java.lang.Object>	getDynamicPluginsMenuItems(SwingFileProperties properties, java.lang.String menuKey) Return the plugins items that must appear under a dynamic menu, for the selected menu Key.
java.util.List<java.lang.Object>	getPluginObjectsForKey(java.lang.String key) Return a specific object associated with plugins.
javax.swing.JComponent	getPluginsAboutPane() Return the Plugins About pane.
java.util.List<javax.swing.AbstractButton>	getPluginsToolBarButtons() Return the list of Plugins toolbar buttons.
void	registerMenus(java.util.Map<java.lang.String,javax.swing.JMenu> staticMenus) Register the main application menu, and the plugins menu.
void	registerPlugins(PluginsManager manager) Register the list of Plugins.
void	setMDIAbout(MDIAbout mdiAbout) Set the about component for using the plugins about list.
void	setMDISettings(MDISettings mdiSettings) Set the settings component to use for plugins Settings.
void	setPluginSettings(PluginsManager.PluginPeer pluginPeer) Add nodes for the selected plugin to the Settings node.
void	setPluginStaticMenu(javax.swing.JMenu menu, java.lang.String menuKey, PluginsManager.PluginPeer pluginPeer) Add to a general menu the selected plugin static menu, for the selected menu key.
void	setSettingsAction(MDISettings mdiSettings) Deprecated. replaced by setMDISettings(org.mdi.bootstrap.swing.MDISettings)
void	updateMenus(MDIPlugin plugin) This method is used to tell to the Plugin that its menus may been modified.Do nothing by default.

Methods inherited from class java.lang.Object

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

Field Detail

pluginsList

protected java.util.Map<java.lang.String,PluginsManager.PluginPeer> pluginsList

The list of Plugin peers.

pluginsVector

protected java.util.List<MDIPlugin<?>> pluginsVector

The list of Plugins.

pluginsTableModel

protected javax.swing.table.DefaultTableModel pluginsTableModel

pluginsClazz

protected java.util.List<PluginsManager.PluginPeer> pluginsClazz

The Plugins peers.

enabledPlugins

protected java.util.Map<java.lang.String,java.lang.Boolean> enabledPlugins

app

protected GUIApplication app

The GUIApplication.

handler

protected PluginMenuHandler handler

The Plugins MenuHandler.

settingsAction

protected MDISettings settingsAction

The settings component.

mdiAbout

protected MDIAbout mdiAbout

The About component.

Constructor Detail

PluginsMenuFactory

public PluginsMenuFactory(GUIApplication app)

Create the factory. Only one factory can be created for an MDIApplication.

Parameters:

app - the Application

Method Detail

setMDISettings

public void setMDISettings(MDISettings mdiSettings)

Set the settings component to use for plugins Settings.

Parameters:

mdiSettings - the settings component

setMDIAbout

public void setMDIAbout(MDIAbout mdiAbout)

Set the about component for using the plugins about list.

Parameters:

mdiAbout - the about component

setSettingsAction

public void setSettingsAction(MDISettings mdiSettings)

Deprecated. replaced by setMDISettings(org.mdi.bootstrap.swing.MDISettings)

Set the settings component to use for plugins Settings.

Parameters:

mdiSettings - the settings component

updateMenus

public void updateMenus(MDIPlugin plugin)

This method is used to tell to the Plugin that its menus may been modified.Do nothing by default.

Parameters:

plugin - the Plugin which is at the origin of the update

registerPlugins

public void registerPlugins(PluginsManager manager)

Register the list of Plugins. Each element of the Map is PluginsManager.PluginPeer

Parameters:

manager - the Plugins Manager

registerMenus

public void registerMenus(java.util.Map<java.lang.String,javax.swing.JMenu> staticMenus)

Register the main application menu, and the plugins menu. The implementation iterates through all Plugins and for each one:

• Add this Plugin specific menu to the Plugins menu
• Create this Plugin About row in the AboutPlugin menuItem
• Add this Plugin specific settings to the settings tree, under the Plugin name node

Parameters:

staticMenus - the static menus, as a Map mapping menu names to JMenus

getAboutPluginsAction

public javax.swing.AbstractAction getAboutPluginsAction()

Return the About action for Plugins.

Returns:

the About action for Plugins

getPluginsAboutPane

public javax.swing.JComponent getPluginsAboutPane()

Return the Plugins About pane.

Returns:

the Plugins About pane

getPluginsToolBarButtons

public java.util.List<javax.swing.AbstractButton> getPluginsToolBarButtons()

Return the list of Plugins toolbar buttons.

Returns:

the list of Plugins toolbar buttons

setPluginSettings

public void setPluginSettings(PluginsManager.PluginPeer pluginPeer)

Add nodes for the selected plugin to the Settings node.

Parameters:

pluginPeer - the plugin peer, where to look for the qtatic menu

setPluginStaticMenu

public void setPluginStaticMenu(javax.swing.JMenu menu,
                                java.lang.String menuKey,
                                PluginsManager.PluginPeer pluginPeer)

Add to a general menu the selected plugin static menu, for the selected menu key.

Parameters:

menu - the menu where to add the plugin static menu

menuKey - the menu key

pluginPeer - the plugin peer, where to look for the static menu

getCompatiblePlugin

public Plugin getCompatiblePlugin(java.lang.String menuKey,
                                  MetaData meta)

Return the first Plugin compatible with some MetaData, for the selected menu Key.

Parameters:

menuKey - the menu key

meta - the MetaData

Returns:

the Plugin

getPluginObjectsForKey

public java.util.List<java.lang.Object> getPluginObjectsForKey(java.lang.String key)

Return a specific object associated with plugins. The method will return null, or the first Object found that match the key for the MDIPlugin.getStaticMenuElements(String).

Parameters:

key - the static menu key

Returns:

the Plugins items for the specified key

getDynamicPluginsMenuItems

public java.util.List<java.lang.Object> getDynamicPluginsMenuItems(SwingFileProperties properties,
                                                                   java.lang.String menuKey)

Return the plugins items that must appear under a dynamic menu, for the selected menu Key.

Parameters:

properties - the FileProperties

menuKey - the menu key

Returns:

a List of any number of the following elements:

• a JMenuItem
• a JMenu
• an AbstractAction