public class SetPropertyValueOperation extends AbstractOperation implements ITransactionalOperation
ITransactionalOperation
used to set or reset the value of a
property.Modifier and Type | Field and Description |
---|---|
protected static java.lang.Object |
DEFAULT_VALUE
Value constant to indicate that the property is to be reset to its
default value during execute/redo and undo.
|
Constructor and Description |
---|
SetPropertyValueOperation(java.lang.String propertyLabel,
IPropertySource propertySource,
java.lang.Object propertyId,
java.lang.Object newValue)
Constructs a new
SetPropertyValueOperation . |
Modifier and Type | Method and Description |
---|---|
boolean |
canExecute() |
IStatus |
execute(IProgressMonitor monitor,
IAdaptable info) |
java.lang.Object |
getNewValue()
Returns the new value to be set for the property when executing or
redoing.
|
java.lang.Object |
getOldValue()
After the command has been executed or redone, returns the old value of
the property or
DEFAULT_VALUE if the property did not have a
value before. |
java.lang.Object |
getPropertyId()
Returns the id by which to identify the property whose value is to be
set.
|
IPropertySource |
getPropertySource()
Returns the
IPropertySource which provides the property, whose
value is to be set. |
boolean |
isContentRelevant()
Returns
true if this ITransactionalOperation is
actually changing model data (instead of only affecting the
visualization). |
boolean |
isNoOp()
Returns
true if this ITransactionalOperation has no
effect (in comparison to its initial state). |
IStatus |
redo(IProgressMonitor monitor,
IAdaptable info) |
IStatus |
undo(IProgressMonitor monitor,
IAdaptable info) |
addContext, canRedo, canUndo, dispose, getContexts, getLabel, hasContext, removeContext, setLabel, toString
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addContext, canRedo, canUndo, dispose, getContexts, getLabel, hasContext, removeContext
protected static final java.lang.Object DEFAULT_VALUE
public SetPropertyValueOperation(java.lang.String propertyLabel, IPropertySource propertySource, java.lang.Object propertyId, java.lang.Object newValue)
SetPropertyValueOperation
.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 or
DEFAULT_VALUE
to indicate that the property should be
reset.public boolean canExecute()
canExecute
in interface IUndoableOperation
canExecute
in class AbstractOperation
public IStatus execute(IProgressMonitor monitor, IAdaptable info) throws ExecutionException
execute
in interface IUndoableOperation
execute
in class AbstractOperation
ExecutionException
public java.lang.Object getNewValue()
DEFAULT_VALUE
to indicate that the
default value should be set as the new value.public java.lang.Object getOldValue()
DEFAULT_VALUE
if the property did not have a
value before.DEFAULT_VALUE
.public java.lang.Object getPropertyId()
public IPropertySource getPropertySource()
IPropertySource
which provides the property, whose
value is to be set.IPropertySource
which provides the property.public boolean isContentRelevant()
ITransactionalOperation
true
if this ITransactionalOperation
is
actually changing model data (instead of only affecting the
visualization). Otherwise returns false
. The content
relevancy of an ITransactionalOperation
can be checked to
determine if the execution of the operation will affect the model, for
example, to set an editor's dirty flag.isContentRelevant
in interface ITransactionalOperation
true
if this ITransactionalOperation
is
actually changing model data, otherwise false
.public boolean isNoOp()
ITransactionalOperation
true
if this ITransactionalOperation
has no
effect (in comparison to its initial state). Otherwise returns
false
.isNoOp
in interface ITransactionalOperation
true
if this ITransactionalOperation
has no
effect, otherwise false
.public IStatus redo(IProgressMonitor monitor, IAdaptable info) throws ExecutionException
redo
in interface IUndoableOperation
redo
in class AbstractOperation
ExecutionException
public IStatus undo(IProgressMonitor monitor, IAdaptable info) throws ExecutionException
undo
in interface IUndoableOperation
undo
in class AbstractOperation
ExecutionException
Copyright (c) 2014 itemis AG and others. All rights reserved.