Package heronarts.lx.command

Class LXCommand.Palette.SetSwatch

java.lang.Object

heronarts.lx.command.LXCommand

heronarts.lx.command.LXCommand.Palette.SetSwatch

Enclosing class:

LXCommand.Palette

public static class LXCommand.Palette.SetSwatch
extends LXCommand

Nested Class Summary

Nested classes/interfaces inherited from class heronarts.lx.command.LXCommand

LXCommand.Channel, LXCommand.Clip, LXCommand.ComponentReference<T extends LXComponent>, LXCommand.Device, LXCommand.InvalidCommandException, LXCommand.Midi, LXCommand.Mixer, LXCommand.Modulation, LXCommand.Palette, LXCommand.Parameter, LXCommand.ParameterReference<T extends LXParameter>, LXCommand.RemoveComponent, LXCommand.Snapshots, LXCommand.Structure

Constructor Summary

Constructors

Constructor	Description
SetSwatch(LXSwatch swatch)

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Short description of a command, to explain it to the user
boolean	isIgnored()	May return true if a command should be ignore for the purposes of undo
void	perform(LX lx)	Perform the given command
void	undo(LX lx)	Undo the command, after it has been performed

Methods inherited from class java.lang.Object

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

Constructor Details

SetSwatch

public SetSwatch(LXSwatch swatch)

Method Details

getDescription

public String getDescription()

Description copied from class: LXCommand

Short description of a command, to explain it to the user

Specified by:

getDescription in class LXCommand

Returns:

short description of command

perform

public void perform(LX lx)
             throws LXCommand.InvalidCommandException

Description copied from class: LXCommand

Perform the given command

Specified by:

perform in class LXCommand

Parameters:

lx - LX instance

Throws:

LXCommand.InvalidCommandException - if the command is invalid

undo

public void undo(LX lx)
          throws LXCommand.InvalidCommandException

Description copied from class: LXCommand

Undo the command, after it has been performed

Specified by:

undo in class LXCommand

Parameters:

lx - LX instance

Throws:

LXCommand.InvalidCommandException - if the command is invalid

isIgnored

public boolean isIgnored()

Description copied from class: LXCommand

May return true if a command should be ignore for the purposes of undo

Overrides:

isIgnored in class LXCommand

Returns:

Whether to ignore command for purposes of undo