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 Details

    • DEFAULT_VALUE

      protected static final Object DEFAULT_VALUE
      Value constant to indicate that the property is to be reset to its default value during execute/redo and undo.
  • Constructor Details

    • SetPropertyValueCommand

      public SetPropertyValueCommand(String propertyLabel, IPropertySource propertySource, Object propertyId, Object newValue)
      Constructs a new SetPropertyValueCommand.
      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 or DEFAULT_VALUE to indicate that the property should be reset.
      Since:
      3.7
  • Method Details

    • canExecute

      public boolean canExecute()
      Overrides:
      canExecute in class Command
      Returns:
      true if the command can be executed
      See Also:
    • execute

      public void execute()
      Description copied from class: Command
      Executes the Command. This method should not be called if the Command is not executable.
      Overrides:
      execute in class Command
      See Also:
    • getNewValue

      protected Object 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.
      Since:
      3.7
    • getOldValue

      protected 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.
      Returns:
      the old value of the property or DEFAULT_VALUE.
      Since:
      3.7
    • getPropertyId

      protected 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 the IPropertySource which provides the property, whose value is to be set.
      Returns:
      the IPropertySource which provides the property.
      Since:
      3.7
    • redo

      public void redo()
      Description copied from class: Command
      Re-executes the Command. This method should only be called after undo() has been called.
      Overrides:
      redo in class Command
      See Also:
    • undo

      public void undo()
      Description copied from class: Command
      Undoes the changes performed during execute(). This method should only be called after execute has been called, and only when canUndo() returns true.
      Overrides:
      undo in class Command
      See Also: