From 2c4d54e6d07a0b3aab74c0a5bafe55f49dabb86d Mon Sep 17 00:00:00 2001 From: Michael Koch Date: Tue, 20 Apr 2004 10:51:42 +0000 Subject: [PATCH] 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/ChangeLog | 9 +++ libjava/javax/swing/JLayeredPane.java | 3 +- .../javax/swing/plaf/BorderUIResource.java | 24 ++++---- libjava/javax/swing/plaf/ComponentUI.java | 34 +++++------ libjava/javax/swing/undo/CompoundEdit.java | 19 +++--- libjava/javax/swing/undo/StateEdit.java | 60 ++++++++++--------- 6 files changed, 79 insertions(+), 70 deletions(-) diff --git a/libjava/ChangeLog b/libjava/ChangeLog index 434e91c1c3c..2388b081901 100644 --- a/libjava/ChangeLog +++ b/libjava/ChangeLog @@ -1,3 +1,12 @@ +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. + 2004-04-20 Michael Koch * javax/print/attribute/EnumSyntax.java diff --git a/libjava/javax/swing/JLayeredPane.java b/libjava/javax/swing/JLayeredPane.java index e82089b25d3..7002b6e0c86 100644 --- a/libjava/javax/swing/JLayeredPane.java +++ b/libjava/javax/swing/JLayeredPane.java @@ -82,16 +82,15 @@ import javax.accessibility.Accessible; *
An offset into a layer's "logical drawing order". Layer position 0 * is drawn last. Layer position -1 is a synonym for the first layer * position (the logical "bottom").
+ * * *

Note: the layer numbering order is the reverse of the * component indexing and position order

* * @author Graydon Hoare */ - public class JLayeredPane extends JComponent implements Accessible { - public static String LAYER_PROPERTY = "LAYER_PROPERTY"; public static Integer FRAME_CONTENT_LAYER = new Integer (-30000); diff --git a/libjava/javax/swing/plaf/BorderUIResource.java b/libjava/javax/swing/plaf/BorderUIResource.java index a3f0db026fd..c0bb2402fe7 100644 --- a/libjava/javax/swing/plaf/BorderUIResource.java +++ b/libjava/javax/swing/plaf/BorderUIResource.java @@ -279,7 +279,7 @@ public class BorderUIResource * *

[An illustration showing raised and lowered BevelBorders] + * alt="[An illustration showing raised and lowered BevelBorders]" />

* * @param bevelType the desired appearance of the border. The value * must be either {@link javax.swing.border.BevelBorder#RAISED} @@ -300,7 +300,7 @@ public class BorderUIResource * *

[An illustration showing BevelBorders that were - * constructed with this method] + * constructed with this method]" />

* * @param bevelType the desired appearance of the border. The value * must be either {@link javax.swing.border.BevelBorder#RAISED} @@ -340,7 +340,7 @@ public class BorderUIResource * *

[An illustration showing BevelBorders that - * were constructed with this method] + * were constructed with this method]" />

* * @param bevelType the desired appearance of the border. The value * must be either {@link javax.swing.border.BevelBorder#RAISED} @@ -432,7 +432,7 @@ public class BorderUIResource * *

[An illustration of EmptyBorder] + * alt="[An illustration of EmptyBorder]" />

* * @author Brian Jones (cbj@gnu.org) * @author Sascha Brawer (brawer@dandelis.ch) @@ -487,7 +487,7 @@ public class BorderUIResource * *

[An illustration of the two EtchedBorder - * variants] + * variants]" />

* * @author Brian Jones (cbj@gnu.org) * @author Sascha Brawer (brawer@dandelis.ch) @@ -514,7 +514,7 @@ public class BorderUIResource * *

[An illustration of the two - * EtchedBorder variants] + * EtchedBorder variants]" />

* * @param etchType the desired appearance of the border. The value * must be either {@link javax.swing.border.EtchedBorder#RAISED} @@ -555,7 +555,7 @@ public class BorderUIResource * *

[An illustration that shows which pixels get - * painted in what color] + * painted in what color]" />

* * @param etchType the desired appearance of the border. The value * must be either {@link javax.swing.border.EtchedBorder#RAISED} @@ -588,7 +588,7 @@ public class BorderUIResource * such as the borders provided by this class. * *

[An illustration of two LineBorders] /> + * height=

* * @author Brian Jones (cbj@gnu.org) * @author Sascha Brawer (brawer@dandelis.ch) @@ -643,7 +643,7 @@ public class BorderUIResource * such as the borders provided by this class. * *

[An illustration of two MatteBorders] /> + * height=

* * @author Brian Jones (cbj@gnu.org) * @author Sascha Brawer (brawer@dandelis.ch) @@ -658,7 +658,7 @@ public class BorderUIResource * *

[A picture of a MatteBorder made by this - * constructor] + * constructor]" />

* * @param top the width of the border at its top edge. * @param left the width of the border at its left edge. @@ -680,7 +680,7 @@ public class BorderUIResource * *

[A picture of a MatteBorder made by this - * constructor] + * constructor]" />

* * @param top the width of the border at its top edge. * @param left the width of the border at its left edge. @@ -704,7 +704,7 @@ public class BorderUIResource * *

[A picture of a MatteBorder made by this - * constructor] + * constructor]" />

* * @param tileIcon an icon for tiling the border area. */ diff --git a/libjava/javax/swing/plaf/ComponentUI.java b/libjava/javax/swing/plaf/ComponentUI.java index 5147ebb9609..a2ca1f00941 100644 --- a/libjava/javax/swing/plaf/ComponentUI.java +++ b/libjava/javax/swing/plaf/ComponentUI.java @@ -52,7 +52,7 @@ import javax.swing.JComponent; * *

[UML diagram illustrating the architecture for pluggable - * look and feels] + * look and feels]" />

* *

Components such as {@link javax.swing.JSlider} do not directly * implement operations related to the look and feel of the user @@ -68,14 +68,14 @@ import javax.swing.JComponent; * services. Soon before the end of its lifecycle, the * ComponentUI will receive an {@link #uninstallUI} * message, at which time the ComponentUI is expected to - * undo any changes. + * undo any changes.

* *

Note that the ui of a JComponent * changes whenever the user switches between look and feels. For * example, the ui property of a JSlider * could change from an instance of MetalSliderUI to an * instance of FooSliderUI. This switch can happen at any - * time, but it will always be performed from inside the Swing thread. + * time, but it will always be performed from inside the Swing thread.

* * @author Sascha Brawer (brawer@dandelis.ch) */ @@ -96,26 +96,24 @@ public abstract class ComponentUI * The delegate object then receives an installUI * message. * - *

This method should perform the following tasks: - * - *

  • Set visual properties such as borders, fonts, colors, or - * icons. However, no change should be performed for those - * properties whose values have been directly set by the client - * application. To allow the distinction, LookAndFeels are expected - * to use values that implement the {@link UIResource} marker - * interface, such as {@link BorderUIResource} or {@link - * ColorUIResource}.
    • + *

    This method should perform the following tasks:

    * + *
      + *
    • Set visual properties such as borders, fonts, colors, or + * icons. However, no change should be performed for those + * properties whose values have been directly set by the client + * application. To allow the distinction, LookAndFeels are expected + * to use values that implement the {@link UIResource} marker + * interface, such as {@link BorderUIResource} or {@link + * ColorUIResource}.
      • *
    • If necessary, install a {@link java.awt.LayoutManager}.
      • - * *
    • Embed custom sub-components. For instance, the UI delegate - * for a {@link javax.swing.JSplitPane} might install a special - * component for the divider.
      • - * + * for a {@link javax.swing.JSplitPane} might install a special + * component for the divider. *
    • Register event listeners.
      • - * *
    • Set up properties related to keyborad navigation, such as - * mnemonics or focus traversal policies.
    + * mnemonics or focus traversal policies. + *
* * @param c the component for which this delegate will provide * services. diff --git a/libjava/javax/swing/undo/CompoundEdit.java b/libjava/javax/swing/undo/CompoundEdit.java index 565a3279b20..730d5b253a1 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 00f1e2d830c..633807b7167 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) -- 2.30.2