heronarts.lx.command

Class LXCommandEngine

java.lang.Object

heronarts.lx.command.LXCommandEngine

public class LXCommandEngine
extends Object

The LX command engine keeps track of high-level UI commands that have been performed. A stack is maintained which enables Undo operations to take place.

Field Summary

Fields

Modifier and Type	Field and Description
BooleanParameter	dirty
MutableParameter	redoChanged
MutableParameter	undoChanged

Constructor Summary

Constructors

Constructor and Description
LXCommandEngine(LX lx)

Method Summary

Modifier and Type	Method and Description
LXCommandEngine	clear()
LXCommand	getRedoCommand()
LXCommand	getUndoCommand()
boolean	isDirty()
LXCommandEngine	perform(LXCommand command) Performs a command and pushes it onto the undo stack.
LXCommandEngine	redo() When possible, re-does an operation that has been undone.
LXCommandEngine	setDirty(boolean dirty)
LXCommandEngine	undo() Undoes the last command on the undo stack, if there is any.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

undoChanged

public final MutableParameter undoChanged

redoChanged

public final MutableParameter redoChanged

dirty

public final BooleanParameter dirty

Constructor Detail

LXCommandEngine

public LXCommandEngine(LX lx)

Method Detail

perform

public LXCommandEngine perform(LXCommand command)

Performs a command and pushes it onto the undo stack.

Parameters:

command - Command to perform and push onto the undo stack

Returns:

this

isDirty

public boolean isDirty()

setDirty

public LXCommandEngine setDirty(boolean dirty)

getUndoCommand

public LXCommand getUndoCommand()

getRedoCommand

public LXCommand getRedoCommand()

clear

public LXCommandEngine clear()

undo

public LXCommandEngine undo()

Undoes the last command on the undo stack, if there is any. If the undo stack is empty then this is a no-op.

Returns:

this

redo

public LXCommandEngine redo()

When possible, re-does an operation that has been undone.

Returns:

this