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, java.util.EventListener, org.tigris.gef.graph.GraphListener, Pluggable, PluggableDiagram, java.io.Serializable

public abstract class DiagramHelper

extends ArgoDiagram

implements PluggableDiagram

Helper object for Diagrams

Since:

0.9.5

See Also:

Serialized Form

Field Summary

protected java.lang.String	_bundle String naming the resource bundle to use for localization.
static java.lang.String	DIAGRAM_BUNDLE Default localization key for diagrams

Fields inherited from class org.argouml.ui.ArgoDiagram

TheInstance

Fields inherited from class org.tigris.gef.base.Diagram

_comments, _lay, _name, _toolBar, vetoListeners

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

Constructor Summary

DiagramHelper()

Method Summary

javax.swing.JMenuItem	getDiagramMenuItem() Returns the settings tab panel for the plugin.
java.lang.String	getDiagramResourceBundleKey()
java.util.Vector	getModulePopUpActions(java.util.Vector v, java.lang.Object o)
boolean	inContext(java.lang.Object[] o) A function which allows a plug-in to decide if it is available under a specific context.
boolean	initializeModule()
boolean	isModuleEnabled()
void	setModuleEnabled(boolean v)
boolean	shutdownModule()

Methods inherited from class org.argouml.ui.ArgoDiagram

addChangeRegistryAsListener, damage, getContainingFig, getEdges, getItemUID, getNodes, getVetoMessage, initialize, removeChangeRegistryAsListener, setItemUID, setName

Methods inherited from class org.tigris.gef.base.Diagram

add, addVetoableChangeListener, bringForward, bringToFront, countContained, edgeAdded, edgeRemoved, elements, elementsIn, fireVetoableChange, fireVetoableChange, fireVetoableChange, getClassAndModelID, getComments, getGraphController, getGraphModel, getLayer, getName, getToolBar, graphChanged, hit, initToolBar, nodeAdded, nodeRemoved, postLoad, postSave, preSave, presentationFor, remove, removeAll, removeVetoableChangeListener, reorder, sendBackward, sendToBack, setComments, setGraphModel, setLayer, setToolBar

Methods inherited from class java.lang.Object

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

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

getModuleAuthor, getModuleDescription, getModuleKey, getModuleName, getModuleVersion

Field Detail

DIAGRAM_BUNDLE

public static final java.lang.String DIAGRAM_BUNDLE

Default localization key for diagrams

See Also:

Constant Field Values

_bundle

protected java.lang.String _bundle

String naming the resource bundle to use for localization.

Constructor Detail

DiagramHelper

public DiagramHelper()

Method Detail

setModuleEnabled

public void setModuleEnabled(boolean v)

Specified by:

setModuleEnabled in interface ArgoModule

initializeModule

public boolean initializeModule()

Specified by:

initializeModule in interface ArgoModule

inContext

public boolean inContext(java.lang.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.

isModuleEnabled

public boolean isModuleEnabled()

Specified by:

isModuleEnabled in interface ArgoModule

getModulePopUpActions

public java.util.Vector getModulePopUpActions(java.util.Vector v,
                                              java.lang.Object o)

Specified by:

getModulePopUpActions in interface ArgoModule

shutdownModule

public boolean shutdownModule()

Specified by:

shutdownModule in interface ArgoModule

getDiagramMenuItem

public javax.swing.JMenuItem getDiagramMenuItem()

Description copied from interface: PluggableDiagram

Returns the settings tab panel for the plugin.

Specified by:

getDiagramMenuItem in interface PluggableDiagram

getDiagramResourceBundleKey

public java.lang.String getDiagramResourceBundleKey()