Package org.eclipse.gef.ui.properties
Class SetPropertyValueCommand
- java.lang.Object
-
- org.eclipse.gef.commands.Command
-
- org.eclipse.gef.ui.properties.SetPropertyValueCommand
-
public class SetPropertyValueCommand extends Command
A command used to set or reset the value of a property.- Since:
- 3.7
-
-
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 SetPropertyValueCommand(java.lang.String propertyLabel, IPropertySource propertySource, java.lang.Object propertyId, java.lang.Object newValue)Constructs a newSetPropertyValueCommand.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleancanExecute()voidexecute()Executes the Command.protected java.lang.ObjectgetNewValue()Returns the new value to be set for the property when executing or redoing.protected 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.protected java.lang.ObjectgetPropertyId()Returns the id by which to identify the property whose value is to be set.protected IPropertySourcegetPropertySource()Returns theIPropertySourcewhich provides the property, whose value is to be set.voidredo()Re-executes the Command.voidundo()Undoes the changes performed duringexecute().-
Methods inherited from class org.eclipse.gef.commands.Command
canRedo, canUndo, chain, dispose, getDebugLabel, getLabel, setDebugLabel, setLabel
-
-
-
-
Constructor Detail
-
SetPropertyValueCommand
public SetPropertyValueCommand(java.lang.String propertyLabel, IPropertySource propertySource, java.lang.Object propertyId, java.lang.Object newValue)Constructs a newSetPropertyValueCommand.- 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.- Since:
- 3.7
-
-
Method Detail
-
canExecute
public boolean canExecute()
- Overrides:
canExecutein classCommand- Returns:
trueif the command can be executed- See Also:
Command.canExecute()
-
execute
public void execute()
Description copied from class:CommandExecutes the Command. This method should not be called if the Command is not executable.- Overrides:
executein classCommand- See Also:
Command.execute()
-
getNewValue
protected 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. - Since:
- 3.7
-
getOldValue
protected 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. - Since:
- 3.7
-
getPropertyId
protected 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.
- Since:
- 3.7
-
getPropertySource
protected IPropertySource getPropertySource()
Returns theIPropertySourcewhich provides the property, whose value is to be set.- Returns:
- the
IPropertySourcewhich provides the property. - Since:
- 3.7
-
redo
public void redo()
Description copied from class:CommandRe-executes the Command. This method should only be called afterundo()has been called.- Overrides:
redoin classCommand- See Also:
Command.redo()
-
undo
public void undo()
Description copied from class:CommandUndoes the changes performed duringexecute(). This method should only be called afterexecutehas been called, and only whencanUndo()returnstrue.- Overrides:
undoin classCommand- See Also:
Command.undo()
-
-