org.argouml.application.api
Interface PluggableMenu

All Superinterfaces:
ArgoModule, Pluggable
All Known Implementing Classes:
ActionExportXMI

public interface PluggableMenu
extends Pluggable

An interface which identifies an ArgoUML plug-in to the menu. Plug-ins are replacements or additions to standard Argo classes. PluggableMenu require two criteria. The first is a JMenuItem. The second is an unlocalized string which identifies the menu requesting the plugin, such as "File" or "Edit".

Since:
0.9.4

Field Summary
static java.lang.String KEY_ARRANGE
          Key looked for in ProjectBrowser for Arrange menu.
static java.lang.String KEY_CREATE_DIAGRAMS
          Key looked for in ProjectBrowser for Create Diagram menu.
static java.lang.String KEY_FILE_IMPORT
          Key looked for in ProjectBrowser for File Import submenu.
static java.lang.String KEY_GENERATE
          Key looked for in ProjectBrowser for Generate menu.
static java.lang.String KEY_HELP
          Key looked for in ProjectBrowser for Help menu.
static java.lang.String KEY_TOOLS
          Key looked for in ProjectBrowser for Tools menu.
static java.lang.String KEY_VIEW
          Key looked for in ProjectBrowser for View menu.
 
Fields inherited from interface org.argouml.application.api.Pluggable
PLUGIN_PREFIX, PLUGIN_TITLE, PLUGIN_VENDOR
 
Fields inherited from interface org.argouml.application.api.ArgoModule
cat, MODULEFILENAME, MODULEFILENAME_ALTERNATE
 
Method Summary
 java.lang.Object[] buildContext(javax.swing.JMenuItem parentMenuItem, java.lang.String menuType)
           
 javax.swing.JMenuItem getMenuItem(java.lang.Object[] context)
          Return the JMenuItem controlled by the plugin under the specific context.
 
Methods inherited from interface org.argouml.application.api.Pluggable
inContext
 
Methods inherited from interface org.argouml.application.api.ArgoModule
getModuleAuthor, getModuleDescription, getModuleKey, getModuleName, getModulePopUpActions, getModuleVersion, initializeModule, isModuleEnabled, setModuleEnabled, shutdownModule
 

Field Detail

KEY_FILE_IMPORT

public static final java.lang.String KEY_FILE_IMPORT
Key looked for in ProjectBrowser for File Import submenu.

See Also:
Constant Field Values

KEY_VIEW

public static final java.lang.String KEY_VIEW
Key looked for in ProjectBrowser for View menu.

See Also:
Constant Field Values

KEY_CREATE_DIAGRAMS

public static final java.lang.String KEY_CREATE_DIAGRAMS
Key looked for in ProjectBrowser for Create Diagram menu.

See Also:
Constant Field Values

KEY_ARRANGE

public static final java.lang.String KEY_ARRANGE
Key looked for in ProjectBrowser for Arrange menu.

See Also:
Constant Field Values

KEY_GENERATE

public static final java.lang.String KEY_GENERATE
Key looked for in ProjectBrowser for Generate menu.

See Also:
Constant Field Values

KEY_TOOLS

public static final java.lang.String KEY_TOOLS
Key looked for in ProjectBrowser for Tools menu.

See Also:
Constant Field Values

KEY_HELP

public static final java.lang.String KEY_HELP
Key looked for in ProjectBrowser for Help menu.

See Also:
Constant Field Values
Method Detail

getMenuItem

public javax.swing.JMenuItem getMenuItem(java.lang.Object[] context)
Return the JMenuItem controlled by the plugin under the specific context. One menu plugin may control multiple menu items.

Parameters:
context - array of objects as created by buildContext(JMenuItem, String).
Returns:
A JMenuItem object controlled by the plug-in.
Since:
ARGO0.11.3

buildContext

public java.lang.Object[] buildContext(javax.swing.JMenuItem parentMenuItem,
                                       java.lang.String menuType)


ArgoUML © 1996-2003 (20030829)ArgoUML Project HomeArgoUML Cookbook