This patch (committed) adds some API docs and fixes a few minor issues in
javax.swing.undo.*:
2006-03-05 David Gilbert <[EMAIL PROTECTED]>
* javax/swing/undo/StateEditable.java
(restoreState): Fixed bad API doc tag,
* javax/swing/undo/UndoableEdit.java: Copied API doc comments from
AbstractUndoableEdit.java,
* javax/swing/undo/UndoableEditSupport.java
(createCompoundEdit): Fixed bad API doc tag,
* javax/swing/undo/UndoManager.java
(editToBeUndone): Fixed bad API doc tag,
(editToBeRedone): Likewise.
Regards,
Dave
Index: javax/swing/undo/StateEditable.java
===================================================================
RCS file: /sources/classpath/classpath/javax/swing/undo/StateEditable.java,v
retrieving revision 1.8
diff -u -r1.8 StateEditable.java
--- javax/swing/undo/StateEditable.java 14 Feb 2006 10:14:25 -0000 1.8
+++ javax/swing/undo/StateEditable.java 5 Mar 2006 20:59:54 -0000
@@ -1,5 +1,5 @@
/* StateEditable.java -- Interface for collaborating with StateEdit.
- Copyright (C) 2002, 2003 Free Software Foundation, Inc.
+ Copyright (C) 2002, 2003, 2006, Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -90,9 +90,9 @@
* from the specified hash table.
*
* <p><b>Note to implementors of this interface:</b> To increase
- * efficiency, the <code>StateEdit</code> class [EMAIL PROTECTED]
- * StateEdit#removeRedundantState() removes redundant state
- * information}. Therefore, implementations of this interface must be
+ * efficiency, the <code>StateEdit</code> class [EMAIL PROTECTED]
+ * StateEdit#removeRedundantState()} removes redundant state
+ * information. Therefore, implementations of this interface must be
* prepared for the case where certain keys were stored into the
* table by [EMAIL PROTECTED] #storeState}, but are not present anymore
* when the <code>restoreState</code> method gets called.
Index: javax/swing/undo/UndoManager.java
===================================================================
RCS file: /sources/classpath/classpath/javax/swing/undo/UndoManager.java,v
retrieving revision 1.6
diff -u -r1.6 UndoManager.java
--- javax/swing/undo/UndoManager.java 2 Jul 2005 20:32:52 -0000 1.6
+++ javax/swing/undo/UndoManager.java 5 Mar 2006 20:59:54 -0000
@@ -1,5 +1,5 @@
-/* AbstractTableModel.java --
- Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc.
+/* UndoManager.java --
+ Copyright (C) 2002, 2004, 2005, 2006, Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -265,7 +265,7 @@
* Determines which significant edit would be undone if [EMAIL PROTECTED]
* #undo()} was called.
*
- * @returns the significant edit that would be undone, or
+ * @return the significant edit that would be undone, or
* <code>null</code> if no significant edit would be affected by
* calling [EMAIL PROTECTED] #undo()}.
*/
@@ -288,7 +288,7 @@
* Determines which significant edit would be redone if [EMAIL PROTECTED]
* #redo()} was called.
*
- * @returns the significant edit that would be redone, or
+ * @return the significant edit that would be redone, or
* <code>null</code> if no significant edit would be affected by
* calling [EMAIL PROTECTED] #redo()}.
*/
Index: javax/swing/undo/UndoableEdit.java
===================================================================
RCS file: /sources/classpath/classpath/javax/swing/undo/UndoableEdit.java,v
retrieving revision 1.4
diff -u -r1.4 UndoableEdit.java
--- javax/swing/undo/UndoableEdit.java 2 Jul 2005 20:32:52 -0000 1.4
+++ javax/swing/undo/UndoableEdit.java 5 Mar 2006 20:59:54 -0000
@@ -1,5 +1,5 @@
-/* AbstractTableModel.java --
- Copyright (C) 2002 Free Software Foundation, Inc.
+/* UndoableEdit.java --
+ Copyright (C) 2002, 2006, Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -38,77 +38,120 @@
package javax.swing.undo;
/**
- * UndoableEdit public interface
+ * An editing operation that supports undo/redoability.
+ *
* @author Andrew Selkirk
*/
-public interface UndoableEdit {
+public interface UndoableEdit
+{
- /**
- * anEdit
- * @param anEdit TODO
- * @returns TODO
- */
- boolean addEdit(UndoableEdit anEdit);
-
- /**
- * canRedo
- * @returns TODO
- */
- boolean canRedo();
-
- /**
- * canRedo
- * @returns TODO
- */
- boolean canUndo();
-
- /**
- * die
- */
- void die();
-
- /**
- * getPresentationName
- * @returns TODO
- */
- String getPresentationName();
-
- /**
- * getRedoPresentationName
- * @returns TODO
- */
- String getRedoPresentationName();
-
- /**
- * getUndoPresentationName
- * @returns TODO
- */
- String getUndoPresentationName();
-
- /**
- * isSignificant
- * @returns TODO
- */
- boolean isSignificant();
-
- /**
- * redo
- * @throws CannotRedoException TODO
- */
- void redo() throws CannotRedoException;
-
- /**
- * replaceEdit
- * @param anEdit TODO
- * @returns TODO
- */
- boolean replaceEdit(UndoableEdit anEdit);
-
- /**
- * undo
- * @throws CannotUndoException TODO
- */
- void undo() throws CannotUndoException;
+ /**
+ * Incorporates another editing action into this one, thus forming a
+ * combined action.
+ *
+ * @param edit the editing action to be incorporated.
+ *
+ * @return <code>true</code> if the edit was combined successfully, and
+ * <code>false</code> if it could not be combined.
+ */
+ boolean addEdit(UndoableEdit edit);
+
+ /**
+ * Determines whether it would be possible to redo this editing
+ * action.
+ *
+ * @return <code>true</code> to indicate that this action can be
+ * redone, <code>false</code> otherwise.
+ *
+ * @see #redo()
+ * @see #canUndo()
+ */
+ boolean canRedo();
+
+ /**
+ * Determines whether it would be possible to undo this editing
+ * action.
+ *
+ * @return <code>true</code> to indicate that this action can be
+ * undone, <code>false</code> otherwise.
+ *
+ * @see #undo()
+ * @see #canRedo()
+ */
+ boolean canUndo();
+
+ /**
+ * Informs this edit action that it will no longer be used. Some
+ * actions might use this information to release resources, for
+ * example open files. Called by [EMAIL PROTECTED] UndoManager} before this
+ * action is removed from the edit queue.
+ */
+ void die();
+
+ /**
+ * Returns a human-readable, localized name that describes this
+ * editing action and can be displayed to the user.
+ *
+ * @return The presentation name.
+ */
+ String getPresentationName();
+
+ /**
+ * Returns the redo presentation name.
+ *
+ * @return The redo presentation name.
+ */
+ String getRedoPresentationName();
+
+ /**
+ * Returns the undo presentation name.
+ *
+ * @return The undo presentation name.
+ */
+ String getUndoPresentationName();
+
+ /**
+ * Determines whether this editing action is significant enough for
+ * being seperately undoable by the user. A typical significant
+ * action would be the resizing of an object. However, changing the
+ * selection in a text document would usually not be considered
+ * significant.
+ *
+ * @return <code>true</code> to indicate that the action is
+ * significant enough for being separately undoable, or
+ * <code>false</code> otherwise.
+ */
+ boolean isSignificant();
+
+ /**
+ * Redoes this editing action.
+ *
+ * @throws CannotRedoException if the edit cannot be undone.
+ *
+ * @see #canRedo()
+ * @see #undo()
+ */
+ void redo() throws CannotRedoException;
+
+ /**
+ * Incorporates another editing action into this one, thus forming a
+ * combined action that replaces the argument action.
+ *
+ * @param edit the editing action to be replaced.
+ *
+ * @return <code>true</code> if the edit is successfully replaced, and
+ * <code>false</code> otherwise.
+ */
+ boolean replaceEdit(UndoableEdit edit);
+
+ /**
+ * Undoes this editing action.
+ *
+ * @throws CannotUndoException if the edit cannot be undone.
+ *
+ * @see #canUndo()
+ * @see #redo()
+ */
+ void undo() throws CannotUndoException;
-
-} // UndoableEdit
+}
Index: javax/swing/undo/UndoableEditSupport.java
===================================================================
RCS file:
/sources/classpath/classpath/javax/swing/undo/UndoableEditSupport.java,v
retrieving revision 1.10
diff -u -r1.10 UndoableEditSupport.java
--- javax/swing/undo/UndoableEditSupport.java 2 Jul 2005 20:32:52 -0000
1.10
+++ javax/swing/undo/UndoableEditSupport.java 5 Mar 2006 20:59:55 -0000
@@ -1,5 +1,5 @@
/* UndoableEditSupport.java --
- Copyright (C) 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
+ Copyright (C) 2002, 2003, 2004, 2005, 2006, Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -238,7 +238,7 @@
* on a specific [EMAIL PROTECTED] #compoundEdit}, it should override this
* method.
*
- * @returns a newly created instance of [EMAIL PROTECTED] CompoundEdit}.
+ * @return a newly created instance of [EMAIL PROTECTED] CompoundEdit}.
*/
protected CompoundEdit createCompoundEdit()
{
