jfig.commands
Class EditCommentCommand

java.lang.Object
  jfig.commands.Command
      jfig.commands.EditCommentCommand

public class EditCommentCommand

extends Command

edit FIG object comments.

EditCommentCommand allows to edit the text comments associated with FIG objects. We use (and recycle) a single text dialog to allow efficent editing of the comments for many FIG objects.

Nested Class Summary

(package private) class

EditCommentCommand.EditCommentDialog

Field Summary

protected static EditCommentCommand.EditCommentDialog	editCommentDialog
protected java.awt.Frame	frame
protected int	n_points
protected java.lang.String	newComment
protected FigObject	object
protected java.lang.String	oldComment
protected java.awt.Point	P1

Fields inherited from class jfig.commands.Command

editor, objectCanvas, ready

Constructor Summary

EditCommentCommand(FigBasicEditor editor, FigCanvas objectCanvas)

Method Summary

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 that has been edited.
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

cancel, isReady, message, notifyEditor, statusMessage

Methods inherited from class java.lang.Object

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

Field Detail

frame

protected java.awt.Frame frame

object

protected FigObject object

P1

protected java.awt.Point P1

n_points

protected int n_points

newComment

protected java.lang.String newComment

oldComment

protected java.lang.String oldComment

editCommentDialog

protected static EditCommentCommand.EditCommentDialog editCommentDialog

Constructor Detail

EditCommentCommand

public EditCommentCommand(FigBasicEditor editor,
                          FigCanvas objectCanvas)

Method Detail

getModifiedObjects

public FigObject[] getModifiedObjects()

return an array-wrapped reference to the FigObject that has been edited. 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

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