Eclipse GMF Guide (Galileo) - GetEditContextCommand (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.emf.type.core.commands
Class GetEditContextCommand

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.emf.type.core.commands.EditElementCommand
                  
org.eclipse.gmf.runtime.emf.type.core.commands.GetEditContextCommand

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

public class GetEditContextCommand
extends EditElementCommand
extends EditElementCommand

Command to get the edit context for a given request.

Constructor Summary

GetEditContextCommand ( GetEditContextRequest request)
          Constructs a new command.

Method Summary

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

java.lang.Object getEditContext ()
          Gets the edit context.

void setEditContext (java.lang.Object editContext)
          Sets the edit context.

Methods inherited from class org.eclipse.gmf.runtime.emf.type.core.commands. EditElementCommand

canExecute, getAffectedFiles, getEClass, getEClassToEdit, getElementToEdit, getRequest, isOK, setEClass, setElementToEdit

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, 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, canRedo, canUndo, dispose, execute, getContexts, getLabel, hasContext, redo, removeContext, undo

Constructor Detail

GetEditContextCommand

public GetEditContextCommand(
GetEditContextRequest request)

Constructs a new command. Automatically initializes the edit context with that carried in the request.

Parameters:: request - the command request

Method Detail

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

getEditContext

public java.lang.Object getEditContext()

Gets the edit context.

Returns:: the edit context

setEditContext

public void setEditContext(java.lang.Object editContext)

Sets the edit context.

Parameters:: editContext - the edit context