com.ibm.xtools.mmi.ui.actions

Class AbstractAddToNewDiagramAction

java.lang.Object

org.eclipse.gmf.runtime.common.ui.action.AbstractActionDelegate

com.ibm.xtools.mmi.ui.actions.AbstractAddToNewDiagramAction

All Implemented Interfaces:

org.eclipse.gmf.runtime.common.ui.action.IActionWithProgress, org.eclipse.ui.IActionDelegate, org.eclipse.ui.IObjectActionDelegate, org.eclipse.ui.IPartListener, org.eclipse.ui.IWorkbenchWindowActionDelegate

Direct Known Subclasses:

AddToCurrentDiagramAction

public abstract class AbstractAddToNewDiagramAction
extends org.eclipse.gmf.runtime.common.ui.action.AbstractActionDelegate
implements org.eclipse.ui.IWorkbenchWindowActionDelegate, org.eclipse.ui.IObjectActionDelegate

An abstract implementation to add currently selected domain element to a new diagram of a particular kind. Subclassers must implement createDiagramEditPart() which creates the new diagram which the view(s) representing the selection will be added to. Subclassers must also implement getUIContext() which returns the IUIContext describing the diagram type for which this action is applicable.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.gmf.runtime.common.ui.action.IActionWithProgress

org.eclipse.gmf.runtime.common.ui.action.IActionWithProgress.WorkIndicatorType

Constructor Summary

Constructors

Constructor and Description
AbstractAddToNewDiagramAction()

Method Summary

Modifier and Type	Method and Description
protected abstract org.eclipse.gmf.runtime.diagram.ui.editparts.DiagramEditPart	createDiagramEditPart(java.util.List targetEl, org.eclipse.core.runtime.IProgressMonitor monitor) This method will create a new file and open the editor up
void	doRun(org.eclipse.core.runtime.IProgressMonitor progressMonitor)
protected org.eclipse.gef.Request	getDropRequest(java.util.List targetElements) Gets the request for dropping the target elements onto the new class diagram.
protected org.eclipse.gmf.runtime.diagram.ui.editparts.DiagramEditPart	getOpenedDiagramEditPart() Return the DiagramEditPart in the new editor that the shape was added to.
protected org.eclipse.jface.viewers.ISelection	getSelection() This method returns the current selection for the action delegate.
protected abstract IUIContext	getUIContext() Subclassers must override to return a UI context corresponding to the diagram type that this selection will be added to, i.e.
protected org.eclipse.ui.IWorkbenchWindow	getWindow() Obtains the workbench window from the part's site and returns it.
org.eclipse.gmf.runtime.common.ui.action.IActionWithProgress.WorkIndicatorType	getWorkIndicatorType()
protected boolean	isToSaveDiagram() Returns true if the changes to the diagram edit part should be saved to file.
void	selectionChanged(org.eclipse.jface.action.IAction action, org.eclipse.jface.viewers.ISelection selection)
protected void	setSelection(org.eclipse.jface.viewers.ISelection selection) Sets the currentSelection to the given selection.

Methods inherited from class org.eclipse.gmf.runtime.common.ui.action.AbstractActionDelegate

dispose, getAction, getActionManager, getLabel, getOperationHistory, getStructuredSelection, getWorkbenchPart, getWorkbenchWindow, handle, init, init, init, isRunnable, isSetup, needsSetup, openErrorDialog, partActivated, partBroughtToTop, partClosed, partDeactivated, partOpened, refresh, run, run, runWithEvent, setAction, setActiveEditor, setActivePart, setSetup, setup, setWorkbenchPart, setWorkbenchWindow

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.ui.IWorkbenchWindowActionDelegate

dispose, init

Methods inherited from interface org.eclipse.ui.IObjectActionDelegate

setActivePart

Methods inherited from interface org.eclipse.ui.IActionDelegate

run

Constructor Detail

AbstractAddToNewDiagramAction

public AbstractAddToNewDiagramAction()

Method Detail

getSelection

protected org.eclipse.jface.viewers.ISelection getSelection()

This method returns the current selection for the action delegate.

Overrides:

getSelection in class org.eclipse.gmf.runtime.common.ui.action.AbstractActionDelegate

Returns:

ISelection representing the current selection.

setSelection

protected void setSelection(org.eclipse.jface.viewers.ISelection selection)

Sets the currentSelection to the given selection.

Parameters:

selection - the ISelection to set the currentSelection to.

getWindow

protected org.eclipse.ui.IWorkbenchWindow getWindow()

Obtains the workbench window from the part's site and returns it.

Returns:

IWorkbenchWindow obtained from the part's site.

getOpenedDiagramEditPart

protected org.eclipse.gmf.runtime.diagram.ui.editparts.DiagramEditPart getOpenedDiagramEditPart()

Return the DiagramEditPart in the new editor that the shape was added to.

Returns:

DiagramEditPart in the new editor that the shape was added to.

doRun

public void doRun(org.eclipse.core.runtime.IProgressMonitor progressMonitor)

Specified by:

doRun in class org.eclipse.gmf.runtime.common.ui.action.AbstractActionDelegate

See Also:

IActionDelegate.run(IAction)

getDropRequest

protected org.eclipse.gef.Request getDropRequest(java.util.List targetElements)

Gets the request for dropping the target elements onto the new class diagram. Subclasses may override to provide a different kind of request.

Parameters:

targetElements - the elements to be added to the new class diagram.

Returns:

the request for adding the elements to the new class diagram.

isToSaveDiagram

protected boolean isToSaveDiagram()

Returns true if the changes to the diagram edit part should be saved to file. False otherwise. This method added in order to force a save when creating new diagrams for a selection.

Returns:

boolean isToSaveDiagram

getWorkIndicatorType

public org.eclipse.gmf.runtime.common.ui.action.IActionWithProgress.WorkIndicatorType getWorkIndicatorType()

Specified by:

getWorkIndicatorType in interface org.eclipse.gmf.runtime.common.ui.action.IActionWithProgress

Overrides:

getWorkIndicatorType in class org.eclipse.gmf.runtime.common.ui.action.AbstractActionDelegate

selectionChanged

public void selectionChanged(org.eclipse.jface.action.IAction action,
                             org.eclipse.jface.viewers.ISelection selection)

Specified by:

selectionChanged in interface org.eclipse.ui.IActionDelegate

Overrides:

selectionChanged in class org.eclipse.gmf.runtime.common.ui.action.AbstractActionDelegate

createDiagramEditPart

protected abstract org.eclipse.gmf.runtime.diagram.ui.editparts.DiagramEditPart createDiagramEditPart(java.util.List targetEl,
                                                                                                      org.eclipse.core.runtime.IProgressMonitor monitor)

This method will create a new file and open the editor up

Parameters:

targetEl - List with element that is the target used to derive the filename and diagram path.

monitor - ProgressMonitor to track the creation of diagram edit part.

Returns:

DiagramEditPart The Edit part for the editor that was created. Returns null is not successful.

getUIContext

protected abstract IUIContext getUIContext()

Subclassers must override to return a UI context corresponding to the diagram type that this selection will be added to, i.e. new UIContext(IUIContextConstants.DIAGRAM_TYPE, diagramTypeString);

Returns:

IUIConetxt corresponding to the diagram type that applies to this selection