edu.stanford.smi.protegex.owl.ui.menu.code
Class SourceCodeAction

java.lang.Object
  edu.stanford.smi.protegex.owl.ui.actions.AbstractOWLModelAction
      edu.stanford.smi.protegex.owl.ui.menu.code.SourceCodeAction

All Implemented Interfaces:

edu.stanford.smi.protege.util.Disposable, IconOwner, OWLModelAction

public class SourceCodeAction

extends AbstractOWLModelAction

An Action to display a SourceCodeDialog.

Author:

Daniel Stoeckli , Holger Knublauch

Field Summary

Fields inherited from class edu.stanford.smi.protegex.owl.ui.actions.AbstractOWLModelAction

CODE_MENU, OWL_MENU, PROJECT_MENU, TOOLS_MENU

Fields inherited from interface edu.stanford.smi.protegex.owl.ui.actions.OWLModelAction

ICON, NAME, PATH_SEPARATOR, SUITABILITY

Constructor Summary

SourceCodeAction()

Method Summary

String	getIconFileName() Gets the relative name of an (optional) icon.
String	getMenubarPath() Gets a path to the menu bar location of this action.
String	getName() Gets the human readable name of this action, to be used as menu item text and tool bar button tool tip text.
String	getToolbarPath() Gets the path to the tool bar location of this action.
boolean	isSuitable(OWLModel owlModel) Determines whether this action shall be used for the given OWLModel.
void	run(OWLModel owlModel) Called when the action is executed by the user.

Methods inherited from class edu.stanford.smi.protegex.owl.ui.actions.AbstractOWLModelAction

addPropertyChangeListener, dispose, getIconResourceClass, notifyPropertyChangeListeners, removePropertyChangeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

SourceCodeAction

public SourceCodeAction()

Method Detail

getIconFileName

public String getIconFileName()

Description copied from interface: IconOwner

Gets the relative name of an (optional) icon.

Specified by:

getIconFileName in interface IconOwner

Overrides:

getIconFileName in class AbstractOWLModelAction

getMenubarPath

public String getMenubarPath()

Description copied from interface: OWLModelAction

Gets a path to the menu bar location of this action. This method determines where the menu item will show up, if at all. The path consists of a menu name with an optional group name. There must be a '/' character (PATH_SEPARATOR) between the menu and group name.

Returns:

the path for the menu or null if this shall not appear in the menu

getName

public String getName()

Description copied from interface: OWLModelAction

Gets the human readable name of this action, to be used as menu item text and tool bar button tool tip text.

Returns:

the name (must not be null)

getToolbarPath

public String getToolbarPath()

Description copied from interface: OWLModelAction

Gets the path to the tool bar location of this action. This is either null (to not show up in the tool bar), or a group name. Actions that shall be grouped together should get the same path.

Specified by:

getToolbarPath in interface OWLModelAction

Overrides:

getToolbarPath in class AbstractOWLModelAction

isSuitable

public boolean isSuitable(OWLModel owlModel)

Description copied from interface: OWLModelAction

Determines whether this action shall be used for the given OWLModel. This allows programmers to veto the use of their action in OWLDatabaseModels or projects that don't import SWRL etc.

Specified by:

isSuitable in interface OWLModelAction

Overrides:

isSuitable in class AbstractOWLModelAction

run

public void run(OWLModel owlModel)

Description copied from interface: OWLModelAction

Called when the action is executed by the user.

Parameters:

owlModel - the OWLModel to operate on