Package org.eclipse.gef.commands
Class CompoundCommand
- java.lang.Object
-
- org.eclipse.gef.commands.Command
-
- org.eclipse.gef.commands.CompoundCommand
-
- Direct Known Subclasses:
ForwardUndoCompoundCommand
public class CompoundCommand extends Command
An aggregation of multipleCommands
. ACompoundCommand
is executable if all of its contained Commands are executable, and it has at least one contained Command. The same is true for undo. When undo is called, the contained Commands are undone in the reverse order in which they were executed.An empty CompoundCommand is not executable.
A CompoundCommand can be
unwrapped
. Unwrapping returns the simplest equivalent form of the CompoundCommand. So, if a CompoundCommand contains just one Command, that Command is returned.
-
-
Constructor Summary
Constructors Constructor Description CompoundCommand()
Constructs an empty CompoundCommandCompoundCommand(java.lang.String label)
Constructs an empty CompoundCommand with the specified label.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
add(Command command)
Adds the specified command if it is notnull
.boolean
canExecute()
boolean
canRedo()
boolean
canUndo()
void
dispose()
Disposes all contained Commands.void
execute()
Execute the command.For a compound command this means executing all of the commands that it contains.java.lang.Object[]
getChildren()
This is useful when implementingITreeContentProvider.getChildren(Object)
to display the Command's nested structure.java.util.List
getCommands()
java.lang.String
getLabel()
boolean
isEmpty()
void
redo()
Re-executes the Command.int
size()
void
undo()
Undoes the changes performed duringexecute()
.Command
unwrap()
Returns the simplest form of this Command that is equivalent.-
Methods inherited from class org.eclipse.gef.commands.Command
chain, getDebugLabel, setDebugLabel, setLabel
-
-
-
-
Method Detail
-
add
public void add(Command command)
Adds the specified command if it is notnull
.- Parameters:
command
-null
or a Command
-
canRedo
public boolean canRedo()
- Overrides:
canRedo
in classCommand
- Returns:
true
if the command can be redone. This method should only be called afterundo()
has been called.- Since:
- 3.10
- See Also:
Command.canRedo()
-
canExecute
public boolean canExecute()
- Overrides:
canExecute
in classCommand
- Returns:
true
if the command can be executed- See Also:
Command.canExecute()
-
canUndo
public boolean canUndo()
- Overrides:
canUndo
in classCommand
- Returns:
true
if the command can be undone. This method should only be called afterexecute()
orredo()
has been called.- See Also:
Command.canUndo()
-
dispose
public void dispose()
Disposes all contained Commands.- Overrides:
dispose
in classCommand
- See Also:
Command.dispose()
-
execute
public void execute()
Execute the command.For a compound command this means executing all of the commands that it contains.
-
getChildren
public java.lang.Object[] getChildren()
This is useful when implementingITreeContentProvider.getChildren(Object)
to display the Command's nested structure.- Returns:
- returns the Commands as an array of Objects.
-
getCommands
public java.util.List getCommands()
- Returns:
- the List of contained Commands
-
getLabel
public java.lang.String getLabel()
- Overrides:
getLabel
in classCommand
- Returns:
- a String used to describe this command to the User
- See Also:
Command.getLabel()
-
isEmpty
public boolean isEmpty()
- Returns:
true
if the CompoundCommand is empty
-
redo
public void redo()
Description copied from class:Command
Re-executes the Command. This method should only be called afterundo()
has been called.- Overrides:
redo
in classCommand
- See Also:
Command.redo()
-
size
public int size()
- Returns:
- the number of contained Commands
-
undo
public void undo()
Description copied from class:Command
Undoes the changes performed duringexecute()
. This method should only be called afterexecute
has been called, and only whencanUndo()
returnstrue
.- Overrides:
undo
in classCommand
- See Also:
Command.undo()
-
unwrap
public Command unwrap()
Returns the simplest form of this Command that is equivalent. This is useful for removing unnecessary nesting of Commands.- Returns:
- the simplest form of this Command that is equivalent
-
-