Eclipse GMF Guide (Galileo) - UpdateGroupLocationCommand (Eclipse GMF Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Runtime

PREV CLASS NEXT CLASS

NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.gmf.runtime.diagram.core.commands
Class UpdateGroupLocationCommand

java.lang.Object
  

org.eclipse.core.commands.operations.AbstractOperation
      org.eclipse.emf.workspace.AbstractEMFOperation
          

org.eclipse.gmf.runtime.emf.commands.core.command.AbstractTransactionalCommand
              
org.eclipse.gmf.runtime.diagram.core.commands.UpdateGroupLocationCommand

All Implemented Interfaces:: IUndoableOperation, ICommand, org.eclipse.gmf.runtime.common.core.internal.command.ICommandWithSettableResult

public class UpdateGroupLocationCommand
extends AbstractTransactionalCommand
extends AbstractTransactionalCommand

This command will relocate the group so that the group's location reflects the location of the top-most and left-most shape. The locations of all the children will also be updated so that they are relative to the new location of the group. It can be used after a shape in the group has been moved, resized, or deleted.

Since:: 2.1

Constructor Summary

UpdateGroupLocationCommand (org.eclipse.emf.transaction.TransactionalEditingDomain domain, View groupView)
          Creates a new instance.

Method Summary

protected CommandResult doExecuteWithResult ( IProgressMonitor monitor, IAdaptable info)
          Implemented by subclasses to perform the model changes.

protected View getGroupView ()
          Gets the group view to be updated.

Methods inherited from class org.eclipse.gmf.runtime.emf.commands.core.command. AbstractTransactionalCommand

aggregateStatuses, cleanup, compose, didRedo, didUndo, doExecute, doRedo, doUndo, getAffectedFiles, getCommandResult, getWorkspaceFiles, getWorkspaceFiles, internalSetResult, reduce, setResult

Methods inherited from class org.eclipse.emf.workspace.AbstractEMFOperation

canRedo, canSetOptions, canUndo, didCommit, dispose, execute, getChange, getEditingDomain, getOptions, isReuseParentTransaction, redo, setOptions, setReuseParentTransaction, undo

Methods inherited from class org.eclipse.core.commands.operations. AbstractOperation

addContext, canExecute, getContexts, getLabel, hasContext, removeContext, setLabel, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.gmf.runtime.common.core.command. ICommand

setLabel

Methods inherited from interface org.eclipse.core.commands.operations. IUndoableOperation

addContext, canExecute, canRedo, canUndo, dispose, execute, getContexts, getLabel, hasContext, redo, removeContext, undo

Constructor Detail

UpdateGroupLocationCommand

public UpdateGroupLocationCommand(org.eclipse.emf.transaction.TransactionalEditingDomain domain,
                                  
View groupView)

Creates a new instance.

Method Detail

getGroupView

protected 
View getGroupView()

Gets the group view to be updated.

Returns:: the group view

doExecuteWithResult

protected 
CommandResult doExecuteWithResult(
IProgressMonitor monitor,
                                            
IAdaptable info)
                                     throws 
ExecutionException

Description copied from class: AbstractTransactionalCommand

Implemented by subclasses to perform the model changes. These changes are applied by manipulation of the EMF metamodel's API, not by executing commands on the editing domain's command stack.

Specified by:: doExecuteWithResult in class AbstractTransactionalCommand

Parameters:: monitor - the progress monitor provided by the operation history; info - the adaptable provided by the operation history
Returns:: the result of the execution
Throws:: ExecutionException - if, for some reason, I fail to complete the operation