|
GEF (MVC) 3.8.1.201211122107 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.gef.commands.Command
org.eclipse.gef.ui.properties.SetPropertyValueCommand
public class SetPropertyValueCommand
A command used to set or reset the value of a property.
Field Summary | |
---|---|
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 Summary | |
---|---|
SetPropertyValueCommand(java.lang.String propertyLabel,
IPropertySource propertySource,
java.lang.Object propertyId,
java.lang.Object newValue)
Constructs a new SetPropertyValueCommand . |
Method Summary | |
---|---|
boolean |
canExecute()
|
void |
execute()
executes the Command. |
protected java.lang.Object |
getNewValue()
Returns the new value to be set for the property when executing or redoing. |
protected 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. |
protected java.lang.Object |
getPropertyId()
Returns the id by which to identify the property whose value is to be set. |
protected IPropertySource |
getPropertySource()
Returns the IPropertySource which provides the property, whose
value is to be set. |
void |
redo()
Re-executes the Command. |
void |
undo()
Undoes the changes performed during execute() . |
Methods inherited from class org.eclipse.gef.commands.Command |
---|
canUndo, chain, dispose, getDebugLabel, getLabel, setDebugLabel, setLabel |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final java.lang.Object DEFAULT_VALUE
Constructor Detail |
---|
public SetPropertyValueCommand(java.lang.String propertyLabel, IPropertySource propertySource, java.lang.Object propertyId, java.lang.Object newValue)
SetPropertyValueCommand
.
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.Method Detail |
---|
public boolean canExecute()
canExecute
in class Command
true
if the command can be executedCommand.canExecute()
public void execute()
Command
execute
in class Command
Command.execute()
protected java.lang.Object getNewValue()
DEFAULT_VALUE
to indicate that the
default value should be set as the new value.protected java.lang.Object getOldValue()
DEFAULT_VALUE
if the property did not have a
value before.
DEFAULT_VALUE
.protected java.lang.Object getPropertyId()
protected IPropertySource getPropertySource()
IPropertySource
which provides the property, whose
value is to be set.
IPropertySource
which provides the property.public void redo()
Command
undo()
has been called.
redo
in class Command
Command.redo()
public void undo()
Command
execute()
. This method
should only be called after execute
has been called, and
only when canUndo()
returns true
.
undo
in class Command
Command.undo()
|
GEF (MVC) 3.8.1.201211122107 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |