From 2c4d54e6d07a0b3aab74c0a5bafe55f49dabb86d Mon Sep 17 00:00:00 2001 From: Michael Koch Date: Tue, 20 Apr 2004 10:51:42 +0000 Subject: JLayeredPane.java, [...]: Fixed HTML tags in javadocs all over. 2004-04-20 Michael Koch * javax/swing/JLayeredPane.java, javax/swing/plaf/BorderUIResource.java, javax/swing/plaf/ComponentUI.java, javax/swing/undo/CompoundEdit.java, javax/swing/undo/StateEdit.java: Fixed HTML tags in javadocs all over. From-SVN: r80893 --- libjava/javax/swing/undo/CompoundEdit.java | 19 +++++----- libjava/javax/swing/undo/StateEdit.java | 60 +++++++++++++++--------------- 2 files changed, 41 insertions(+), 38 deletions(-) (limited to 'libjava/javax/swing/undo') diff --git a/libjava/javax/swing/undo/CompoundEdit.java b/libjava/javax/swing/undo/CompoundEdit.java index 565a327..730d5b2 100644 --- a/libjava/javax/swing/undo/CompoundEdit.java +++ b/libjava/javax/swing/undo/CompoundEdit.java @@ -45,17 +45,18 @@ import java.util.Vector; * UndoableEdits. * *

The use of a CompoundEdit is divided in two separate - * phases. - * - *

  1. In the first phase, the CompoundEdit is - * initialized. After a new instance of CompoundEdit has - * been created, {@link #addEdit(UndoableEdit)} is called for each - * element of the compound. To terminate the initialization phase, - * call {@link #end()}.
    2. + * phases.

    * + *
      + *
    1. In the first phase, the CompoundEdit is + * initialized. After a new instance of CompoundEdit has + * been created, {@link #addEdit(UndoableEdit)} is called for each + * element of the compound. To terminate the initialization phase, + * call {@link #end()}.
      2. *
    2. In the second phase, the the CompoundEdit can be - * used, typically by invoking {@link #undo()} and {@link - * #redo()}.
    + * used, typically by invoking {@link #undo()} and + * {@link #redo()}. + *
* * @author Andrew Selkirk (aselkirk@sympatico.ca) * @author Sascha Brawer (brawer@dandelis.ch) diff --git a/libjava/javax/swing/undo/StateEdit.java b/libjava/javax/swing/undo/StateEdit.java index 00f1e2d..633807b 100644 --- a/libjava/javax/swing/undo/StateEdit.java +++ b/libjava/javax/swing/undo/StateEdit.java @@ -44,52 +44,54 @@ import java.util.Iterator; /** * A helper class, making it easy to support undo and redo. * - *

The following example shows how to use this class. + *

The following example shows how to use this class.

* - * 
  Foo foo; // class Foo implements {@link StateEditable}
- *  StateEdit edit;
+ * 
+ * Foo foo; // class Foo implements {@link StateEditable}
+ * StateEdit edit;
  *
- *  edit = new StateEdit(foo, "Name Change");
- *  foo.setName("Jane Doe");
- *  edit.end();
- *  undoManager.addEdit(edit);

+ * edit = new StateEdit(foo, "Name Change");
+ * foo.setName("Jane Doe");
+ * edit.end();
+ * undoManager.addEdit(edit);
+ *
* *

If Foo’s implementation of {@link * StateEditable} considers the name as part of the editable state, * the user can now choose “Undo Name Change” or * “Redo Name Change” from the respective menu. No - * further undo support is needed from the application. + * further undo support is needed from the application.

* - *

The following explains what happens in the example. - * - *

  1. When a StateEdit is created, the associated - * {@link StateEditable} gets asked to store its state into a hash - * table, {@link #preState}.
    2. + *

    The following explains what happens in the example.

    * + *
      + *
    1. When a StateEdit is created, the associated + * {@link StateEditable} gets asked to store its state into a hash + * table, {@link #preState}.
      2. *
    2. The application will now perform some changes to the edited - * object. This typically happens by invoking methods on the edited - * object.
      3. - * + * object. This typically happens by invoking methods on the edited + * object. *
    3. The editing phase is terminated by invoking the {@link #end()} - * method of the StateEdit. The end() method - * does two things. - * - *
      • The edited object receives a second request for storing - * its state. This time, it will use a different hash table, {@link - * #postState}.
        • - * - *
      • To increase efficiency, the StateEdit now removes - * any entries from {@link #preState} and {@link #postState} that have - * the same key, and whose values are equal. Equality is determined - * by invoking the equals method inherited from - * {@link java.lang.Object}.
      4. + * method of the StateEdit. The end() method + * does two things. * + *
        + *
      • The edited object receives a second request for storing + * its state. This time, it will use a different hash table, {@link + * #postState}.
        • + *
      • To increase efficiency, the StateEdit now removes + * any entries from {@link #preState} and {@link #postState} that have + * the same key, and whose values are equal. Equality is determined + * by invoking the equals method inherited from + * {@link java.lang.Object}.
        • + *
      *
    4. When the user later chooses to undo the StateEdit, * the edited object is asked to {@linkplain StateEditable#restoreState * restore its state} from the {@link #preState} table. Similarly, * when the user chooses to redo the StateEdit, * the edited object gets asked to restore its state from the {@link - * #postState}.
    + * #postState}. + *
* * @author Andrew Selkirk (aselkirk@sympatico.ca) * @author Sascha Brawer (brawer@dandelis.ch) -- cgit v1.1