jfig.commands
Class UpdateCommand

java.lang.Object
  jfig.commands.Command
      jfig.commands.UpdateCommand

public class UpdateCommand

extends Command

update jfig object attributes.

UpdateCommand allows the user to update object attributes, e.g. object color, line style, or text font size. The command object provides the xfig-style editor mode, where the new attributes are taken from the global editor attributes together wht the global update-masks. Therefore, the user can easily control which object attributes to update, and which not. Use the update-mask button to enable/disable/invert the update masks.

Use the middle mouse button to "pick up" the attributes from an object; the object's attributes are then made the current editor global attributes and can be used to update other objects.

To allow for Undo/Redo, copies of both the old and the new object attributes are stored inside the UpdateCommand, with the corresponding memory overhead.

Field Summary

protected int	n_points
protected FigAttribs	newAttribs
protected FigObject	object
protected java.awt.Point	P1
protected FigAttribs	savedAttribs

Fields inherited from class jfig.commands.Command

editor, objectCanvas, ready

Constructor Summary

UpdateCommand(FigBasicEditor editor, FigCanvas objectCanvas)

Method Summary

void	cancel() cancel the current editor command
void	execute() execute the current editor command
java.lang.String	getDescription() one-line description of this command
FigObject[]	getModifiedObjects() return an array-wrapped reference to the FigObject whose attributes are (to be) updated.
void	mousePressed(FigCanvasEvent evt) react to a mouse click on the editor canvas
java.lang.String	toString() return a (possibly verbose) description of this Command object
void	undo() undo this command

Methods inherited from class jfig.commands.Command

isReady, message, notifyEditor, statusMessage

Methods inherited from class java.lang.Object

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

Field Detail

object

protected FigObject object

savedAttribs

protected FigAttribs savedAttribs

newAttribs

protected FigAttribs newAttribs

P1

protected java.awt.Point P1

n_points

protected int n_points

Constructor Detail

UpdateCommand

public UpdateCommand(FigBasicEditor editor,
                     FigCanvas objectCanvas)

Method Detail

getModifiedObjects

public FigObject[] getModifiedObjects()

return an array-wrapped reference to the FigObject whose attributes are (to be) updated. The FigObject reference may be null.

Overrides:

getModifiedObjects in class Command

execute

public void execute()

Description copied from class: Command

execute the current editor command

This method is empty for class Command.

Overrides:

execute in class Command

undo

public void undo()

Description copied from class: Command

undo this command

Try to undo this command as far as possible. Don't try to undo() a command that has never been execute()d before. This method is empty for class Command.

Overrides:

undo in class Command

cancel

public void cancel()

Description copied from class: Command

cancel the current editor command

cancel and cleanup the current command. Note that this method is empty for class Command, but might be implemented by subclasses.

Overrides:

cancel in class Command

mousePressed

public void mousePressed(FigCanvasEvent evt)

Description copied from class: Command

react to a mouse click on the editor canvas

This method provides the central callback from the editor to its current command object. Passing a FigCanvasEvent parameter, the editor provides information both about the screen coordinates and the world coordinates of the mouse event.

Naturally, mouse presses are ignored for class Command.

Overrides:

mousePressed in class Command

getDescription

public java.lang.String getDescription()

Description copied from class: Command

one-line description of this command

return a one-line desription of this command, e.g. to label the undo/redo buttons, if any

Overrides:

getDescription in class Command

toString

public java.lang.String toString()

Description copied from class: Command

return a (possibly verbose) description of this Command object

Overrides:

toString in class Command