Class SetPropertyValueOperation
- java.lang.Object
-
- org.eclipse.core.commands.operations.AbstractOperation
-
- org.eclipse.gef.mvc.fx.ui.properties.SetPropertyValueOperation
-
- All Implemented Interfaces:
IUndoableOperation,ITransactionalOperation
public class SetPropertyValueOperation extends AbstractOperation implements ITransactionalOperation
AnITransactionalOperationused to set or reset the value of a property.
-
-
Field Summary
Fields Modifier and Type Field Description protected static java.lang.ObjectDEFAULT_VALUEValue constant to indicate that the property is to be reset to its default value during execute/redo and undo.
-
Constructor Summary
Constructors Constructor Description SetPropertyValueOperation(java.lang.String propertyLabel, IPropertySource propertySource, java.lang.Object propertyId, java.lang.Object newValue)Constructs a newSetPropertyValueOperation.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancanExecute()IStatusexecute(IProgressMonitor monitor, IAdaptable info)java.lang.ObjectgetNewValue()Returns the new value to be set for the property when executing or redoing.java.lang.ObjectgetOldValue()After the command has been executed or redone, returns the old value of the property orDEFAULT_VALUEif the property did not have a value before.java.lang.ObjectgetPropertyId()Returns the id by which to identify the property whose value is to be set.IPropertySourcegetPropertySource()Returns theIPropertySourcewhich provides the property, whose value is to be set.booleanisContentRelevant()Returnstrueif thisITransactionalOperationis actually changing model data (instead of only affecting the visualization).booleanisNoOp()Returnstrueif thisITransactionalOperationhas no effect (in comparison to its initial state).IStatusredo(IProgressMonitor monitor, IAdaptable info)voidsetContentRelevant(boolean isContentRelevant)Sets the content-relevancy of this operation to the given value.IStatusundo(IProgressMonitor monitor, IAdaptable info)-
Methods inherited from class org.eclipse.core.commands.operations.AbstractOperation
addContext, canRedo, canUndo, dispose, 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.core.commands.operations.IUndoableOperation
addContext, canRedo, canUndo, dispose, getContexts, getLabel, hasContext, removeContext
-
-
-
-
Constructor Detail
-
SetPropertyValueOperation
public SetPropertyValueOperation(java.lang.String propertyLabel, IPropertySource propertySource, java.lang.Object propertyId, java.lang.Object newValue)Constructs a newSetPropertyValueOperation.- Parameters:
propertyLabel- A label to identify the property whose value is set by this command.propertySource- The property source which provides the property, whose value is to be set.propertyId- The id of the property whose value is to be set.newValue- The new value to set for the property orDEFAULT_VALUEto indicate that the property should be reset.
-
-
Method Detail
-
canExecute
public boolean canExecute()
- Specified by:
canExecutein interfaceIUndoableOperation- Overrides:
canExecutein classAbstractOperation
-
execute
public IStatus execute(IProgressMonitor monitor, IAdaptable info) throws ExecutionException
- Specified by:
executein interfaceIUndoableOperation- Specified by:
executein classAbstractOperation- Throws:
ExecutionException
-
getNewValue
public java.lang.Object getNewValue()
Returns the new value to be set for the property when executing or redoing.- Returns:
- the new value or
DEFAULT_VALUEto indicate that the default value should be set as the new value.
-
getOldValue
public java.lang.Object getOldValue()
After the command has been executed or redone, returns the old value of the property orDEFAULT_VALUEif the property did not have a value before.- Returns:
- the old value of the property or
DEFAULT_VALUE.
-
getPropertyId
public java.lang.Object getPropertyId()
Returns the id by which to identify the property whose value is to be set.- Returns:
- the id of the property whose value is to be set.
-
getPropertySource
public IPropertySource getPropertySource()
Returns theIPropertySourcewhich provides the property, whose value is to be set.- Returns:
- the
IPropertySourcewhich provides the property.
-
isContentRelevant
public boolean isContentRelevant()
Description copied from interface:ITransactionalOperationReturnstrueif thisITransactionalOperationis actually changing model data (instead of only affecting the visualization). Otherwise returnsfalse. The content relevance of anITransactionalOperationcan be checked to determine if the execution of the operation will affect the model, for example, to set an editor's dirty flag.- Specified by:
isContentRelevantin interfaceITransactionalOperation- Returns:
trueif thisITransactionalOperationis actually changing model data, otherwisefalse.
-
isNoOp
public boolean isNoOp()
Description copied from interface:ITransactionalOperationReturnstrueif thisITransactionalOperationhas no effect (in comparison to its initial state). Otherwise returnsfalse.- Specified by:
isNoOpin interfaceITransactionalOperation- Returns:
trueif thisITransactionalOperationhas no effect, otherwisefalse.
-
redo
public IStatus redo(IProgressMonitor monitor, IAdaptable info) throws ExecutionException
- Specified by:
redoin interfaceIUndoableOperation- Specified by:
redoin classAbstractOperation- Throws:
ExecutionException
-
setContentRelevant
public void setContentRelevant(boolean isContentRelevant)
Sets the content-relevancy of this operation to the given value.- Parameters:
isContentRelevant-trueif this operation is content-relevant,falseotherwise.
-
undo
public IStatus undo(IProgressMonitor monitor, IAdaptable info) throws ExecutionException
- Specified by:
undoin interfaceIUndoableOperation- Specified by:
undoin classAbstractOperation- Throws:
ExecutionException
-
-