|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.core.commands.operations.AbstractOperation
org.eclipse.emf.workspace.AbstractEMFOperation
org.eclipse.gmf.runtime.emf.commands.core.command.AbstractTransactionalCommand
org.eclipse.gmf.runtime.emf.ui.properties.commands.RestoreDefaultPropertyValueCommand
public class RestoreDefaultPropertyValueCommand
Command to restore a property value to its default value using the
IPropertySource.resetPropertyValue(java.lang.Object)
method.
This command is undoable and redoable.
Constructor Summary | |
---|---|
RestoreDefaultPropertyValueCommand(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain,
java.lang.String label,
java.lang.Object affectedObjects,
IPropertySource propertySource,
java.lang.Object propertyId)
Constructs a new command with the property source and the id of the property to be reset. |
Method Summary | |
---|---|
boolean |
canRedo()
|
boolean |
canUndo()
|
protected CommandResult |
doExecuteWithResult(IProgressMonitor progressMonitor,
IAdaptable info)
Implemented by subclasses to perform the model changes. |
protected CommandResult |
doRedoWithResult(IProgressMonitor progressMonitor,
IAdaptable info)
|
protected CommandResult |
doUndoWithResult(IProgressMonitor progressMonitor,
IAdaptable info)
|
protected java.lang.Object |
getPropertyId()
Gets the ID of the property whose default value is to be restored. |
protected IPropertySource |
getPropertySource()
Gets the property source that owns the property to be restored to its default value. |
protected java.lang.Object |
getUndoValue()
Gets the property value which is used when this command execution is undone. |
protected boolean |
isValueResetOnUndo()
Gets the flag that indicates that the property value was reset by this command. |
protected void |
setUndoValue(java.lang.Object object)
Sets the property value which is used when this command execution is undone. |
protected void |
setValueResetOnUndo(boolean b)
Sets the flag that indicates that the property value was reset by this command. |
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 |
---|
didCommit, dispose, execute, getChange, getEditingDomain, getOptions, redo, 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, dispose, execute, getContexts, getLabel, hasContext, redo, removeContext, undo |
Constructor Detail |
---|
public RestoreDefaultPropertyValueCommand(org.eclipse.emf.transaction.TransactionalEditingDomain editingDomain, java.lang.String label, java.lang.Object affectedObjects, IPropertySource propertySource, java.lang.Object propertyId)
editingDomain
- the editing domain in which to make the changelabel
- The label for the command. Appears in the Edit menu items.affectedObjects
- The model operation context for the new model command.propertySource
- The property source that owns the property
whose value is to be reset.propertyId
- The ID of the property to be reset.Method Detail |
---|
public boolean canRedo()
canRedo
in interface IUndoableOperation
canRedo
in class org.eclipse.emf.workspace.AbstractEMFOperation
public boolean canUndo()
canUndo
in interface IUndoableOperation
canUndo
in class org.eclipse.emf.workspace.AbstractEMFOperation
protected CommandResult doExecuteWithResult(IProgressMonitor progressMonitor, IAdaptable info) throws ExecutionException
AbstractTransactionalCommand
doExecuteWithResult
in class AbstractTransactionalCommand
progressMonitor
- the progress monitor provided by the operation historyinfo
- the adaptable provided by the operation history
ExecutionException
- if, for some reason, I fail to complete
the operationprotected CommandResult doRedoWithResult(IProgressMonitor progressMonitor, IAdaptable info) throws ExecutionException
ExecutionException
protected CommandResult doUndoWithResult(IProgressMonitor progressMonitor, IAdaptable info) throws ExecutionException
ExecutionException
protected boolean isValueResetOnUndo()
isPropertySet()
method returns false
.
true
if the property value was reset by this command,
false
otherwise.protected void setValueResetOnUndo(boolean b)
isPropertySet()
method returns false
.
b
- true
if the property value was reset by this command,
false
otherwise.protected IPropertySource getPropertySource()
protected java.lang.Object getPropertyId()
protected java.lang.Object getUndoValue()
protected void setUndoValue(java.lang.Object object)
object
- the undo property value
|
Runtime | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Guidelines for using Eclipse APIs.
Copyright (c) IBM Corp., Borland Software Corp., and others 2005,2006. All rights reserved.