Class SetPropertyValueOperation
java.lang.Object
org.eclipse.core.commands.operations.AbstractOperation
org.eclipse.gef.mvc.fx.ui.properties.SetPropertyValueOperation
- All Implemented Interfaces:
IUndoableOperation
,ITransactionalOperation
An
ITransactionalOperation
used to set or reset the value of a
property.-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final Object
Value constant to indicate that the property is to be reset to its default value during execute/redo and undo. -
Constructor Summary
ConstructorsConstructorDescriptionSetPropertyValueOperation
(String propertyLabel, IPropertySource propertySource, Object propertyId, Object newValue) Constructs a newSetPropertyValueOperation
. -
Method Summary
Modifier and TypeMethodDescriptionboolean
execute
(IProgressMonitor monitor, IAdaptable info) Returns the new value to be set for the property when executing or redoing.After the command has been executed or redone, returns the old value of the property orDEFAULT_VALUE
if the property did not have a value before.Returns the id by which to identify the property whose value is to be set.Returns theIPropertySource
which provides the property, whose value is to be set.boolean
Returnstrue
if thisITransactionalOperation
is actually changing model data (instead of only affecting the visualization).boolean
isNoOp()
Returnstrue
if thisITransactionalOperation
has no effect (in comparison to its initial state).redo
(IProgressMonitor monitor, IAdaptable info) void
setContentRelevant
(boolean isContentRelevant) Sets the content-relevancy of this operation to the given value.undo
(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
-
Field Details
-
DEFAULT_VALUE
Value constant to indicate that the property is to be reset to its default value during execute/redo and undo.
-
-
Constructor Details
-
SetPropertyValueOperation
public SetPropertyValueOperation(String propertyLabel, IPropertySource propertySource, Object propertyId, 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_VALUE
to indicate that the property should be reset.
-
-
Method Details
-
canExecute
public boolean canExecute()- Specified by:
canExecute
in interfaceIUndoableOperation
- Overrides:
canExecute
in classAbstractOperation
-
execute
- Specified by:
execute
in interfaceIUndoableOperation
- Specified by:
execute
in classAbstractOperation
- Throws:
ExecutionException
-
getNewValue
Returns the new value to be set for the property when executing or redoing.- Returns:
- the new value or
DEFAULT_VALUE
to indicate that the default value should be set as the new value.
-
getOldValue
After the command has been executed or redone, returns the old value of the property orDEFAULT_VALUE
if the property did not have a value before.- Returns:
- the old value of the property or
DEFAULT_VALUE
.
-
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
Returns theIPropertySource
which provides the property, whose value is to be set.- Returns:
- the
IPropertySource
which provides the property.
-
isContentRelevant
public boolean isContentRelevant()Description copied from interface:ITransactionalOperation
Returnstrue
if thisITransactionalOperation
is actually changing model data (instead of only affecting the visualization). Otherwise returnsfalse
. The content relevance of anITransactionalOperation
can 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:
isContentRelevant
in interfaceITransactionalOperation
- Returns:
true
if thisITransactionalOperation
is actually changing model data, otherwisefalse
.
-
isNoOp
public boolean isNoOp()Description copied from interface:ITransactionalOperation
Returnstrue
if thisITransactionalOperation
has no effect (in comparison to its initial state). Otherwise returnsfalse
.- Specified by:
isNoOp
in interfaceITransactionalOperation
- Returns:
true
if thisITransactionalOperation
has no effect, otherwisefalse
.
-
redo
- Specified by:
redo
in interfaceIUndoableOperation
- Specified by:
redo
in classAbstractOperation
- Throws:
ExecutionException
-
setContentRelevant
public void setContentRelevant(boolean isContentRelevant) Sets the content-relevancy of this operation to the given value.- Parameters:
isContentRelevant
-true
if this operation is content-relevant,false
otherwise.
-
undo
- Specified by:
undo
in interfaceIUndoableOperation
- Specified by:
undo
in classAbstractOperation
- Throws:
ExecutionException
-