org.mdi.plugins.swing

Class PluginMenuHandler

java.lang.Object

org.mdi.plugins.swing.PluginMenuHandler

All Implemented Interfaces:

PluginElementTypes

public class PluginMenuHandler
extends java.lang.Object
implements PluginElementTypes

This class handles the returned menus from plugins.

Field Summary

Fields inherited from interface org.mdi.plugins.PluginElementTypes

OPEN_ACTIONS, PLUGIN_MENU, PROPERTY_DATE, PROPERTY_DEPEND, PROPERTY_DESC, PROPERTY_UNSUPPORTED, PROPERTY_VERSION, SAVEAS_ACTIONS, SETTINGS, SETTINGS_MENU, TOOLBAR

Constructor Summary

Constructors

Constructor and Description
PluginMenuHandler()

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Object>	getPluginObjectsForKey(java.lang.String menuKey, java.util.List<MDIPlugin<?>> plugins) Return a specific object associated with plugins.
java.util.List<java.lang.Object>	getPluginsDynamicMenuElements(java.lang.String key, FileProperties prop, java.util.List<MDIPlugin<?>> plugins) Return a dynamic plugins menu items for all plugins.
java.util.List<java.lang.Object>	getPluginStaticMenuElements(java.lang.String menuKey, MDIPlugin plugin) Encapsulate the import of plugin menus.
void	setApplication(MDIApplication appli) Set the application.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginMenuHandler

public PluginMenuHandler()

Method Detail

setApplication

public void setApplication(MDIApplication appli)

Set the application.

Parameters:

appli - the application.

getPluginsDynamicMenuElements

public java.util.List<java.lang.Object> getPluginsDynamicMenuElements(java.lang.String key,
                                                                      FileProperties prop,
                                                                      java.util.List<MDIPlugin<?>> plugins)

Return a dynamic plugins menu items for all plugins.

The List contains any number of the following elements:

• JMenuItems
• JMenus
• JButtons
• AbstractActions

Parameters:

key - the dynamic menu key

prop - the FileProperties for which we want to get the dynamic plugins menu items

plugins - the list of Plugins

Returns:

the list of dynamic plugins menu items

getPluginObjectsForKey

public java.util.List<java.lang.Object> getPluginObjectsForKey(java.lang.String menuKey,
                                                               java.util.List<MDIPlugin<?>> plugins)

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:

menuKey - the static menu key

plugins - the list of Plugins

Returns:

the list of static plugins menu items for the menu key

getPluginStaticMenuElements

public java.util.List<java.lang.Object> getPluginStaticMenuElements(java.lang.String menuKey,
                                                                    MDIPlugin plugin)

Encapsulate the import of plugin menus. If any Exception appear during the import, a null Object will be returned.

Parameters:

menuKey - the static menu key

plugin - the Plugin

Returns:

the list of static plugins menu items for the menu key, for the specified Plugin