Commit 2c4d54e6 by Michael Koch Committed by Michael Koch

JLayeredPane.java, [...]: Fixed HTML tags in javadocs all over.

2004-04-20  Michael Koch  <konqueror@gmx.de>

	* 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
parent 5589f3e5
2004-04-20 Michael Koch <konqueror@gmx.de> 2004-04-20 Michael Koch <konqueror@gmx.de>
* 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 <konqueror@gmx.de>
* javax/print/attribute/EnumSyntax.java * javax/print/attribute/EnumSyntax.java
(getOffset): Made protected. (getOffset): Made protected.
* javax/print/attribute/HashAttributeSet.java * javax/print/attribute/HashAttributeSet.java
......
...@@ -82,16 +82,15 @@ import javax.accessibility.Accessible; ...@@ -82,16 +82,15 @@ import javax.accessibility.Accessible;
* <dd>An offset into a layer's "logical drawing order". Layer position 0 * <dd>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 * is drawn last. Layer position -1 is a synonym for the first layer
* position (the logical "bottom").</dd> * position (the logical "bottom").</dd>
* </dl>
* *
* <p><b>Note:</b> the layer numbering order is the <em>reverse</em> of the * <p><b>Note:</b> the layer numbering order is the <em>reverse</em> of the
* component indexing and position order</p> * component indexing and position order</p>
* *
* @author Graydon Hoare <graydon@redhat.com> * @author Graydon Hoare <graydon@redhat.com>
*/ */
public class JLayeredPane extends JComponent implements Accessible public class JLayeredPane extends JComponent implements Accessible
{ {
public static String LAYER_PROPERTY = "LAYER_PROPERTY"; public static String LAYER_PROPERTY = "LAYER_PROPERTY";
public static Integer FRAME_CONTENT_LAYER = new Integer (-30000); public static Integer FRAME_CONTENT_LAYER = new Integer (-30000);
......
...@@ -279,7 +279,7 @@ public class BorderUIResource ...@@ -279,7 +279,7 @@ public class BorderUIResource
* *
* <p><img src="../border/doc-files/BevelBorder-1.png" * <p><img src="../border/doc-files/BevelBorder-1.png"
* width="500" height="150" * width="500" height="150"
* alt="[An illustration showing raised and lowered BevelBorders]" /> * alt="[An illustration showing raised and lowered BevelBorders]" /></p>
* *
* @param bevelType the desired appearance of the border. The value * @param bevelType the desired appearance of the border. The value
* must be either {@link javax.swing.border.BevelBorder#RAISED} * must be either {@link javax.swing.border.BevelBorder#RAISED}
...@@ -300,7 +300,7 @@ public class BorderUIResource ...@@ -300,7 +300,7 @@ public class BorderUIResource
* *
* <p><img src="../border/doc-files/BevelBorder-2.png" width="500" * <p><img src="../border/doc-files/BevelBorder-2.png" width="500"
* height="150" alt="[An illustration showing BevelBorders that were * height="150" alt="[An illustration showing BevelBorders that were
* constructed with this method]" /> * constructed with this method]" /></p>
* *
* @param bevelType the desired appearance of the border. The value * @param bevelType the desired appearance of the border. The value
* must be either {@link javax.swing.border.BevelBorder#RAISED} * must be either {@link javax.swing.border.BevelBorder#RAISED}
...@@ -340,7 +340,7 @@ public class BorderUIResource ...@@ -340,7 +340,7 @@ public class BorderUIResource
* *
* <p><img src="../border/doc-files/BevelBorder-3.png" width="500" * <p><img src="../border/doc-files/BevelBorder-3.png" width="500"
* height="150" alt="[An illustration showing BevelBorders that * height="150" alt="[An illustration showing BevelBorders that
* were constructed with this method]" /> * were constructed with this method]" /></p>
* *
* @param bevelType the desired appearance of the border. The value * @param bevelType the desired appearance of the border. The value
* must be either {@link javax.swing.border.BevelBorder#RAISED} * must be either {@link javax.swing.border.BevelBorder#RAISED}
...@@ -432,7 +432,7 @@ public class BorderUIResource ...@@ -432,7 +432,7 @@ public class BorderUIResource
* *
* <p><img src="../border/doc-files/EmptyBorder-1.png" * <p><img src="../border/doc-files/EmptyBorder-1.png"
* width="290" height="200" * width="290" height="200"
* alt="[An illustration of EmptyBorder]" /> * alt="[An illustration of EmptyBorder]" /></p>
* *
* @author Brian Jones (cbj@gnu.org) * @author Brian Jones (cbj@gnu.org)
* @author Sascha Brawer (brawer@dandelis.ch) * @author Sascha Brawer (brawer@dandelis.ch)
...@@ -487,7 +487,7 @@ public class BorderUIResource ...@@ -487,7 +487,7 @@ public class BorderUIResource
* *
* <p><img src="../border/doc-files/EtchedBorder-1.png" width="500" * <p><img src="../border/doc-files/EtchedBorder-1.png" width="500"
* height="200" alt="[An illustration of the two EtchedBorder * height="200" alt="[An illustration of the two EtchedBorder
* variants]" /> * variants]" /></p>
* *
* @author Brian Jones (cbj@gnu.org) * @author Brian Jones (cbj@gnu.org)
* @author Sascha Brawer (brawer@dandelis.ch) * @author Sascha Brawer (brawer@dandelis.ch)
...@@ -514,7 +514,7 @@ public class BorderUIResource ...@@ -514,7 +514,7 @@ public class BorderUIResource
* *
* <p><img src="../border/doc-files/EtchedBorder-1.png" * <p><img src="../border/doc-files/EtchedBorder-1.png"
* width="500" height="200" alt="[An illustration of the two * width="500" height="200" alt="[An illustration of the two
* EtchedBorder variants]" /> * EtchedBorder variants]" /></p>
* *
* @param etchType the desired appearance of the border. The value * @param etchType the desired appearance of the border. The value
* must be either {@link javax.swing.border.EtchedBorder#RAISED} * must be either {@link javax.swing.border.EtchedBorder#RAISED}
...@@ -555,7 +555,7 @@ public class BorderUIResource ...@@ -555,7 +555,7 @@ public class BorderUIResource
* *
* <p><img src="../border/doc-files/EtchedBorder-2.png" width="500" * <p><img src="../border/doc-files/EtchedBorder-2.png" width="500"
* height="200" alt="[An illustration that shows which pixels get * height="200" alt="[An illustration that shows which pixels get
* painted in what color]" /> * painted in what color]" /></p>
* *
* @param etchType the desired appearance of the border. The value * @param etchType the desired appearance of the border. The value
* must be either {@link javax.swing.border.EtchedBorder#RAISED} * must be either {@link javax.swing.border.EtchedBorder#RAISED}
...@@ -588,7 +588,7 @@ public class BorderUIResource ...@@ -588,7 +588,7 @@ public class BorderUIResource
* such as the borders provided by this class. * such as the borders provided by this class.
* *
* <p><img src="../border/doc-files/LineBorder-1.png" width="500" * <p><img src="../border/doc-files/LineBorder-1.png" width="500"
* height="200" alt="[An illustration of two LineBorders] /> * height="200" alt="[An illustration of two LineBorders]" /></p>
* *
* @author Brian Jones (cbj@gnu.org) * @author Brian Jones (cbj@gnu.org)
* @author Sascha Brawer (brawer@dandelis.ch) * @author Sascha Brawer (brawer@dandelis.ch)
...@@ -643,7 +643,7 @@ public class BorderUIResource ...@@ -643,7 +643,7 @@ public class BorderUIResource
* such as the borders provided by this class. * such as the borders provided by this class.
* *
* <p><img src="../border/doc-files/MatteBorder-1.png" width="500" * <p><img src="../border/doc-files/MatteBorder-1.png" width="500"
* height="150" alt="[An illustration of two MatteBorders] /> * height="150" alt="[An illustration of two MatteBorders]" /></p>
* *
* @author Brian Jones (cbj@gnu.org) * @author Brian Jones (cbj@gnu.org)
* @author Sascha Brawer (brawer@dandelis.ch) * @author Sascha Brawer (brawer@dandelis.ch)
...@@ -658,7 +658,7 @@ public class BorderUIResource ...@@ -658,7 +658,7 @@ public class BorderUIResource
* *
* <p><img src="../border/doc-files/MatteBorder-2.png" width="500" * <p><img src="../border/doc-files/MatteBorder-2.png" width="500"
* height="150" alt="[A picture of a MatteBorder made by this * height="150" alt="[A picture of a MatteBorder made by this
* constructor]" /> * constructor]" /></p>
* *
* @param top the width of the border at its top edge. * @param top the width of the border at its top edge.
* @param left the width of the border at its left edge. * @param left the width of the border at its left edge.
...@@ -680,7 +680,7 @@ public class BorderUIResource ...@@ -680,7 +680,7 @@ public class BorderUIResource
* *
* <p><img src="../border/doc-files/MatteBorder-4.png" width="500" * <p><img src="../border/doc-files/MatteBorder-4.png" width="500"
* height="150" alt="[A picture of a MatteBorder made by this * height="150" alt="[A picture of a MatteBorder made by this
* constructor]" /> * constructor]" /></p>
* *
* @param top the width of the border at its top edge. * @param top the width of the border at its top edge.
* @param left the width of the border at its left edge. * @param left the width of the border at its left edge.
...@@ -704,7 +704,7 @@ public class BorderUIResource ...@@ -704,7 +704,7 @@ public class BorderUIResource
* *
* <p><img src="../border/doc-files/MatteBorder-6.png" width="500" * <p><img src="../border/doc-files/MatteBorder-6.png" width="500"
* height="150" alt="[A picture of a MatteBorder made by this * height="150" alt="[A picture of a MatteBorder made by this
* constructor]" /> * constructor]" /></p>
* *
* @param tileIcon an icon for tiling the border area. * @param tileIcon an icon for tiling the border area.
*/ */
......
...@@ -52,7 +52,7 @@ import javax.swing.JComponent; ...@@ -52,7 +52,7 @@ import javax.swing.JComponent;
* *
* <p><img src="doc-files/ComponentUI-1.png" width="700" height="550" * <p><img src="doc-files/ComponentUI-1.png" width="700" height="550"
* alt="[UML diagram illustrating the architecture for pluggable * alt="[UML diagram illustrating the architecture for pluggable
* look and feels]" /> * look and feels]" /></p>
* *
* <p>Components such as {@link javax.swing.JSlider} do not directly * <p>Components such as {@link javax.swing.JSlider} do not directly
* implement operations related to the look and feel of the user * implement operations related to the look and feel of the user
...@@ -68,14 +68,14 @@ import javax.swing.JComponent; ...@@ -68,14 +68,14 @@ import javax.swing.JComponent;
* services. Soon before the end of its lifecycle, the * services. Soon before the end of its lifecycle, the
* <code>ComponentUI</code> will receive an {@link #uninstallUI} * <code>ComponentUI</code> will receive an {@link #uninstallUI}
* message, at which time the <code>ComponentUI</code> is expected to * message, at which time the <code>ComponentUI</code> is expected to
* undo any changes. * undo any changes.</p>
* *
* <p>Note that the <code>ui</code> of a <code>JComponent</code> * <p>Note that the <code>ui</code> of a <code>JComponent</code>
* changes whenever the user switches between look and feels. For * changes whenever the user switches between look and feels. For
* example, the <code>ui</code> property of a <code>JSlider</code> * example, the <code>ui</code> property of a <code>JSlider</code>
* could change from an instance of <code>MetalSliderUI</code> to an * could change from an instance of <code>MetalSliderUI</code> to an
* instance of <code>FooSliderUI</code>. This switch can happen at any * instance of <code>FooSliderUI</code>. 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.</p>
* *
* @author Sascha Brawer (brawer@dandelis.ch) * @author Sascha Brawer (brawer@dandelis.ch)
*/ */
...@@ -96,26 +96,24 @@ public abstract class ComponentUI ...@@ -96,26 +96,24 @@ public abstract class ComponentUI
* The delegate object then receives an <code>installUI</code> * The delegate object then receives an <code>installUI</code>
* message. * message.
* *
* <p>This method should perform the following tasks: * <p>This method should perform the following tasks:</p>
*
* <ul><li>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}.</li>
* *
* <ul>
* <li>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}.</li>
* <li>If necessary, install a {@link java.awt.LayoutManager}.</li> * <li>If necessary, install a {@link java.awt.LayoutManager}.</li>
*
* <li>Embed custom sub-components. For instance, the UI delegate * <li>Embed custom sub-components. For instance, the UI delegate
* for a {@link javax.swing.JSplitPane} might install a special * for a {@link javax.swing.JSplitPane} might install a special
* component for the divider.</li> * component for the divider.</li>
*
* <li>Register event listeners.</li> * <li>Register event listeners.</li>
*
* <li>Set up properties related to keyborad navigation, such as * <li>Set up properties related to keyborad navigation, such as
* mnemonics or focus traversal policies.</li></ul> * mnemonics or focus traversal policies.</li>
* </ul>
* *
* @param c the component for which this delegate will provide * @param c the component for which this delegate will provide
* services. * services.
......
...@@ -45,17 +45,18 @@ import java.util.Vector; ...@@ -45,17 +45,18 @@ import java.util.Vector;
* <code>UndoableEdits</code>. * <code>UndoableEdits</code>.
* *
* <p>The use of a <code>CompoundEdit</code> is divided in two separate * <p>The use of a <code>CompoundEdit</code> is divided in two separate
* phases. * phases.</p>
*
* <ol><li>In the first phase, the <code>CompoundEdit</code> is
* initialized. After a new instance of <code>CompoundEdit</code> has
* been created, {@link #addEdit(UndoableEdit)} is called for each
* element of the compound. To terminate the initialization phase,
* call {@link #end()}.</li>
* *
* <ol>
* <li>In the first phase, the <code>CompoundEdit</code> is
* initialized. After a new instance of <code>CompoundEdit</code> has
* been created, {@link #addEdit(UndoableEdit)} is called for each
* element of the compound. To terminate the initialization phase,
* call {@link #end()}.</li>
* <li>In the second phase, the the <code>CompoundEdit</code> can be * <li>In the second phase, the the <code>CompoundEdit</code> can be
* used, typically by invoking {@link #undo()} and {@link * used, typically by invoking {@link #undo()} and
* #redo()}.</li></ol> * {@link #redo()}.</li>
* </ol>
* *
* @author Andrew Selkirk (aselkirk@sympatico.ca) * @author Andrew Selkirk (aselkirk@sympatico.ca)
* @author Sascha Brawer (brawer@dandelis.ch) * @author Sascha Brawer (brawer@dandelis.ch)
......
...@@ -44,52 +44,54 @@ import java.util.Iterator; ...@@ -44,52 +44,54 @@ import java.util.Iterator;
/** /**
* A helper class, making it easy to support undo and redo. * A helper class, making it easy to support undo and redo.
* *
* <p>The following example shows how to use this class. * <p>The following example shows how to use this class.</p>
* *
* <pre> Foo foo; // class Foo implements {@link StateEditable} * <pre>
* StateEdit edit; * Foo foo; // class Foo implements {@link StateEditable}
* StateEdit edit;
* *
* edit = new StateEdit(foo, "Name Change"); * edit = new StateEdit(foo, "Name Change");
* foo.setName("Jane Doe"); * foo.setName("Jane Doe");
* edit.end(); * edit.end();
* undoManager.addEdit(edit);</pre> * undoManager.addEdit(edit);
* </pre>
* *
* <p>If <code>Foo</code>&#x2019;s implementation of {@link * <p>If <code>Foo</code>&#x2019;s implementation of {@link
* StateEditable} considers the name as part of the editable state, * StateEditable} considers the name as part of the editable state,
* the user can now choose &#x201c;Undo Name Change&#x201d; or * the user can now choose &#x201c;Undo Name Change&#x201d; or
* &#x201c;Redo Name Change&#x201d; from the respective menu. No * &#x201c;Redo Name Change&#x201d; from the respective menu. No
* further undo support is needed from the application. * further undo support is needed from the application.</p>
* *
* <p>The following explains what happens in the example. * <p>The following explains what happens in the example.</p>
*
* <p><ol><li>When a <code>StateEdit</code> is created, the associated
* {@link StateEditable} gets asked to store its state into a hash
* table, {@link #preState}.</li>
* *
* <ol>
* <li>When a <code>StateEdit</code> is created, the associated
* {@link StateEditable} gets asked to store its state into a hash
* table, {@link #preState}.</li>
* <li>The application will now perform some changes to the edited * <li>The application will now perform some changes to the edited
* object. This typically happens by invoking methods on the edited * object. This typically happens by invoking methods on the edited
* object.</li> * object.</li>
*
* <li>The editing phase is terminated by invoking the {@link #end()} * <li>The editing phase is terminated by invoking the {@link #end()}
* method of the <code>StateEdit</code>. The <code>end()</code> method * method of the <code>StateEdit</code>. The <code>end()</code> method
* does two things. * does two things.
*
* <ul><li>The edited object receives a second request for storing
* its state. This time, it will use a different hash table, {@link
* #postState}.</li>
*
* <li>To increase efficiency, the <code>StateEdit</code> 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 <code>equals</code> method inherited from
* {@link java.lang.Object}.</li></ul></li>
* *
* <ul>
* <li>The edited object receives a second request for storing
* its state. This time, it will use a different hash table, {@link
* #postState}.</li>
* <li>To increase efficiency, the <code>StateEdit</code> 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 <code>equals</code> method inherited from
* {@link java.lang.Object}.</li>
* </ul></li>
* <li>When the user later chooses to undo the <code>StateEdit</code>, * <li>When the user later chooses to undo the <code>StateEdit</code>,
* the edited object is asked to {@linkplain StateEditable#restoreState * the edited object is asked to {@linkplain StateEditable#restoreState
* restore its state} from the {@link #preState} table. Similarly, * restore its state} from the {@link #preState} table. Similarly,
* when the user chooses to <i>redo</i> the <code>StateEdit</code>, * when the user chooses to <i>redo</i> the <code>StateEdit</code>,
* the edited object gets asked to restore its state from the {@link * the edited object gets asked to restore its state from the {@link
* #postState}.</li></ol> * #postState}.</li>
* </ol>
* *
* @author Andrew Selkirk (aselkirk@sympatico.ca) * @author Andrew Selkirk (aselkirk@sympatico.ca)
* @author Sascha Brawer (brawer@dandelis.ch) * @author Sascha Brawer (brawer@dandelis.ch)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment