ActionExportXMI (ArgoUML Javadoc for internal use)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.argouml.ui
Class ActionExportXMI

java.lang.Object
  javax.swing.AbstractAction
      org.argouml.uml.ui.UMLAction
          org.argouml.ui.ActionExportXMI

All Implemented Interfaces:: Action, ActionListener, ArgoModule, Cloneable, EventListener, Pluggable, PluggableMenu, Serializable

public final class ActionExportXMI
extends UMLAction
implements PluggableMenu

Exports the xmi of a project to a file choosen by the user.

See Also:: Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.AbstractAction

Field Summary
`private static ActionExportXMI`	`instance`
`private static Logger`	`LOG` logger

Fields inherited from class org.argouml.uml.ui.UMLAction

HAS_ICON, NO_ICON

Fields inherited from class javax.swing.AbstractAction

changeSupport, enabled

Fields inherited from interface org.argouml.application.api.PluggableMenu

KEY_ARRANGE, KEY_CREATE_DIAGRAMS, KEY_FILE_IMPORT, KEY_GENERATE, KEY_HELP, KEY_TOOLS, KEY_VIEW

Fields inherited from interface org.argouml.application.api.Pluggable

PLUGIN_PREFIX, PLUGIN_TITLE, PLUGIN_VENDOR

Fields inherited from interface org.argouml.application.api.ArgoModule

MODULEFILENAME, MODULEFILENAME_ALTERNATE

Fields inherited from interface javax.swing.Action

ACCELERATOR_KEY, ACTION_COMMAND_KEY, DEFAULT, LONG_DESCRIPTION, MNEMONIC_KEY, NAME, SHORT_DESCRIPTION, SMALL_ICON

Constructor Summary
`private`	`ActionExportXMI()` Constructor.

Method Summary
`void`	`actionPerformed(ActionEvent e)` Perform the work the action is supposed to do.
`Object[]`	`buildContext(JMenuItem parentMenuItem, String menuType)` Helper to create a context recognized by `Pluggable.inContext(Object[])`.
`static ActionExportXMI`	`getInstance()` Singleton instance method
`JMenuItem`	`getMenuItem(Object[] context)` Return the JMenuItem controlled by the plugin under the specific context.
`String`	`getModuleAuthor()` The module author.
`String`	`getModuleDescription()` Textual description of the module.
`String`	`getModuleKey()` The module identifying key.
`String`	`getModuleName()` Display name of the module.
`Vector`	`getModulePopUpActions(Vector popUpActions, Object context)` Calls all modules to let them add to a popup menu.
`String`	`getModuleVersion()` The module version.
`boolean`	`inContext(Object[] context)` A function which allows a plug-in to decide if it is available under a specific context.
`boolean`	`initializeModule()` Method called when Argo is loading a module.
`boolean`	`isModuleEnabled()` Allows determination if a module is enabled or disabled.
`void`	`setModuleEnabled(boolean tf)` Called to enable or disable a module programmatically.
`boolean`	`shutdownModule()` Method called when Argo is unloading a module.

Methods inherited from class org.argouml.uml.ui.UMLAction

getMnemonic, getValue, isEnabled, putValue, shouldBeEnabled, updateEnabled, updateEnabled

Methods inherited from class javax.swing.AbstractAction

addPropertyChangeListener, clone, firePropertyChange, getKeys, getPropertyChangeListeners, removePropertyChangeListener, setEnabled

Methods inherited from class java.lang.Object

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

Field Detail

LOG

private static final Logger LOG

logger

instance

private static ActionExportXMI instance

Constructor Detail

ActionExportXMI

private ActionExportXMI()

Constructor.

Method Detail

getInstance

public static ActionExportXMI getInstance()

Singleton instance method

Returns:: the singleton instance

getMenuItem

public JMenuItem getMenuItem(Object[] context)

Description copied from interface: PluggableMenu

Return the JMenuItem controlled by the plugin under the specific context. One menu plugin may control multiple menu items.

Specified by:: getMenuItem in interface PluggableMenu

Parameters:: context - array of objects as created by PluggableMenu.buildContext(JMenuItem, String).
Returns:: A JMenuItem object controlled by the plug-in.
See Also:: PluggableMenu.getMenuItem(java.lang.Object[])

buildContext

public Object[] buildContext(JMenuItem parentMenuItem,
                             String menuType)

Description copied from interface: PluggableMenu

Helper to create a context recognized by Pluggable.inContext(Object[]).

Specified by:: buildContext in interface PluggableMenu

Parameters:: parentMenuItem - menu item; menuType - menu name
Returns:: the proper context array.
See Also:: PluggableMenu.buildContext(javax.swing.JMenuItem, String)

inContext

public boolean inContext(Object[] context)

Description copied from interface: Pluggable

A function which allows a plug-in to decide if it is available under a specific context. One example of a plugin with multiple criteria is the PluggableMenu. PluggableMenu requires the first context to be a JMenuItem which wants the PluggableMenu attached to as the context, so that it can determine that it would attach to a menu. The second context is an internal (non-localized) description of the menu such as "File" or "View" so that the plugin can further decide.

Specified by:: inContext in interface Pluggable

Parameters:: context - An identification of the context. The interpretation of criteria is specific to the plug-in type, but must be consistent across that type. The plug-in must want to be exposed to all contexts.
Returns:: True if the plug-in wants to make itself available for this context, otherwise false.
See Also:: Pluggable.inContext(java.lang.Object[])