org.argouml.application.helpers
Class DiagramHelper

java.lang.Object
  org.tigris.gef.base.Diagram
      org.argouml.ui.ArgoDiagram
          org.argouml.application.helpers.DiagramHelper

All Implemented Interfaces:

ArgoModule, EventListener, GraphListener, Pluggable, PluggableDiagram, Serializable

public abstract class DiagramHelper

extends ArgoDiagram

implements PluggableDiagram

Helper object for Diagrams.

Since:

0.9.5

See Also:

Serialized Form

DIAGRAM_BUNDLE

public static final String DIAGRAM_BUNDLE

Default localization key for diagrams.

See Also:

Constant Field Values

DiagramHelper

public DiagramHelper()

The constructor.

setModuleEnabled

public void setModuleEnabled(boolean v)

Description copied from interface: ArgoModule

Called to enable or disable a module programmatically.

Specified by:

setModuleEnabled in interface ArgoModule

Parameters:

v - true to enable module, false to disable

See Also:

ArgoModule.setModuleEnabled(boolean)

initializeModule

public boolean initializeModule()

Description copied from interface: ArgoModule

Method called when Argo is loading a module.

Specified by:

initializeModule in interface ArgoModule

Returns:

true if the module initialized properly.

See Also:

ArgoModule.initializeModule()

inContext

public boolean inContext(Object[] o)

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:

o - 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[])

isModuleEnabled

public boolean isModuleEnabled()

Description copied from interface: ArgoModule

Allows determination if a module is enabled or disabled.

Specified by:

isModuleEnabled in interface ArgoModule

Returns:

true if the module is enabled, otherwise false

See Also:

ArgoModule.isModuleEnabled()

getModulePopUpActions

public Vector getModulePopUpActions(Vector v,
                                    Object o)

Description copied from interface: ArgoModule

Calls all modules to let them add to a popup menu.

Specified by:

getModulePopUpActions in interface ArgoModule

Parameters:

v - Vector of actions

o - which the actions are valid for

Returns:

Vector containing pop-up actions

See Also:

ArgoModule.getModulePopUpActions( java.util.Vector, java.lang.Object)

shutdownModule

public boolean shutdownModule()

Description copied from interface: ArgoModule

Method called when Argo is unloading a module.

Specified by:

shutdownModule in interface ArgoModule

Returns:

true if the module terminated properly.

See Also:

ArgoModule.shutdownModule()

getDiagramMenuItem

public JMenuItem getDiagramMenuItem()

Description copied from interface: PluggableDiagram

Returns the settings tab panel for the plugin.

Specified by:

getDiagramMenuItem in interface PluggableDiagram

Returns:

the menu item.

See Also:

PluggableDiagram.getDiagramMenuItem()

getDiagramResourceBundleKey

public String getDiagramResourceBundleKey()

Returns:

the default localization key for diagrams