org.eclipse.gmf.runtime.emf.ui.action
Class AbstractModelActionHandler
java.lang.Object
AbstractActionHandler
org.eclipse.gmf.runtime.emf.ui.action.AbstractModelActionHandler
-
public abstract class AbstractModelActionHandler
- extends AbstractActionHandler
The abstract parent of all concrete action handlers that execute model
commands. Concrete subclasses must provide a definition of the
doRun()
method to gather any required input and execute a model
command.
Methods inherited from class java.lang.Object
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
|
AbstractModelActionHandler
protected AbstractModelActionHandler(
IWorkbenchPart workbenchPart)
- Constructs a new model action handler for the specified workbench part.
-
Parameters:
-
workbenchPart
- The workbench part to which this model action
handler applies.
AbstractModelActionHandler
protected AbstractModelActionHandler(
IWorkbenchPage workbenchPage)
- Constructs a new model action handler for the specified workbench page.
-
Parameters:
-
workbenchPage
- The workbench page to which this model action
handler applies.
isSelectionListener
protected boolean isSelectionListener()
-
-
See Also:
-
org.eclipse.gmf.runtime.common.ui.action.AbstractActionHandler#isSelectionListener()
run
public final void run(
IProgressMonitor progressMonitor)
- Runs this model action handler as a read action.
-
-
See Also:
-
IActionWithProgress#run(IProgressMonitor)
getEditingDomain
protected abstract org.eclipse.emf.transaction.TransactionalEditingDomain getEditingDomain()
- Gets my editing domain. Can be
null
if I don't modify
model resources.
-
-
Returns:
- my editing domain.
isReadOnly
protected boolean isReadOnly()
- Answers whether or not I am a read-only action. Returns
false
by default. Subclasses may override.
-
-
Returns:
-
false
getStatus
protected
IStatus getStatus()
- Gets the status of running this action delegate.
-
-
Returns:
- my status
setStatus
protected void setStatus(
IStatus status)
- Sets the action delegate status. Subclasses should set the status when they
execute a command.
-
-
Parameters:
-
status
- the new status
execute
protected
IStatus execute(
IUndoableOperation operation,
IProgressMonitor progressMonitor,
IAdaptable info)
- Convenience method for subclasses to execute an undoable operation on the
action manager's operation history. Sets my status to the status of the
operation execution, and returns that status.
-
-
Parameters:
-
operation
- the operation to be executed -
progressMonitor
- the progress monitor -
info
- the adaptable info, may be null
-
Returns:
- the status of the operation execution.
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.