mirror of
https://github.com/openjdk/jdk.git
synced 2026-06-06 02:33:12 +00:00
8133134: docs: replace <tt> tags (obsolete in html5) for java.desktop
Reviewed-by: alexsch
This commit is contained in:
parent
23438be9c4
commit
ae92e55c99
@ -55,8 +55,8 @@ public interface AppletContext {
|
||||
AudioClip getAudioClip(URL url);
|
||||
|
||||
/**
|
||||
* Returns an <code>Image</code> object that can then be painted on
|
||||
* the screen. The <code>url</code> argument that is
|
||||
* Returns an {@code Image} object that can then be painted on
|
||||
* the screen. The {@code url} argument that is
|
||||
* passed as an argument must specify an absolute URL.
|
||||
* <p>
|
||||
* This method always returns immediately, whether or not the image
|
||||
@ -73,10 +73,10 @@ public interface AppletContext {
|
||||
/**
|
||||
* Finds and returns the applet in the document represented by this
|
||||
* applet context with the given name. The name can be set in the
|
||||
* HTML tag by setting the <code>name</code> attribute.
|
||||
* HTML tag by setting the {@code name} attribute.
|
||||
*
|
||||
* @param name an applet name.
|
||||
* @return the applet with the given name, or <code>null</code> if
|
||||
* @return the applet with the given name, or {@code null} if
|
||||
* not found.
|
||||
*/
|
||||
Applet getApplet(String name);
|
||||
@ -92,7 +92,7 @@ public interface AppletContext {
|
||||
|
||||
/**
|
||||
* Requests that the browser or applet viewer show the Web page
|
||||
* indicated by the <code>url</code> argument. The browser or
|
||||
* indicated by the {@code url} argument. The browser or
|
||||
* applet viewer determines which window or frame to display the
|
||||
* Web page. This method may be ignored by applet contexts that
|
||||
* are not browsers.
|
||||
@ -103,22 +103,22 @@ public interface AppletContext {
|
||||
|
||||
/**
|
||||
* Requests that the browser or applet viewer show the Web page
|
||||
* indicated by the <code>url</code> argument. The
|
||||
* <code>target</code> argument indicates in which HTML frame the
|
||||
* indicated by the {@code url} argument. The
|
||||
* {@code target} argument indicates in which HTML frame the
|
||||
* document is to be displayed.
|
||||
* The target argument is interpreted as follows:
|
||||
*
|
||||
* <center><table border="3" summary="Target arguments and their descriptions">
|
||||
* <tr><th>Target Argument</th><th>Description</th></tr>
|
||||
* <tr><td><code>"_self"</code> <td>Show in the window and frame that
|
||||
* <tr><td>{@code "_self"} <td>Show in the window and frame that
|
||||
* contain the applet.</tr>
|
||||
* <tr><td><code>"_parent"</code><td>Show in the applet's parent frame. If
|
||||
* <tr><td>{@code "_parent"}<td>Show in the applet's parent frame. If
|
||||
* the applet's frame has no parent frame,
|
||||
* acts the same as "_self".</tr>
|
||||
* <tr><td><code>"_top"</code> <td>Show in the top-level frame of the applet's
|
||||
* <tr><td>{@code "_top"} <td>Show in the top-level frame of the applet's
|
||||
* window. If the applet's frame is the
|
||||
* top-level frame, acts the same as "_self".</tr>
|
||||
* <tr><td><code>"_blank"</code> <td>Show in a new, unnamed
|
||||
* <tr><td>{@code "_blank"} <td>Show in a new, unnamed
|
||||
* top-level window.</tr>
|
||||
* <tr><td><i>name</i><td>Show in the frame or window named <i>name</i>. If
|
||||
* a target named <i>name</i> does not already exist, a
|
||||
@ -126,10 +126,10 @@ public interface AppletContext {
|
||||
* and the document is shown there.</tr>
|
||||
* </table> </center>
|
||||
* <p>
|
||||
* An applet viewer or browser is free to ignore <code>showDocument</code>.
|
||||
* An applet viewer or browser is free to ignore {@code showDocument}.
|
||||
*
|
||||
* @param url an absolute URL giving the location of the document.
|
||||
* @param target a <code>String</code> indicating where to display
|
||||
* @param target a {@code String} indicating where to display
|
||||
* the page.
|
||||
*/
|
||||
public void showDocument(URL url, String target);
|
||||
@ -155,7 +155,7 @@ public interface AppletContext {
|
||||
*
|
||||
* @param key key with which the specified value is to be associated.
|
||||
* @param stream stream to be associated with the specified key. If this
|
||||
* parameter is <code>null</code>, the specified key is removed
|
||||
* parameter is {@code null}, the specified key is removed
|
||||
* in this applet context.
|
||||
* @throws IOException if the stream size exceeds a certain
|
||||
* size limit. Size limit is decided by the implementor of this
|
||||
@ -166,7 +166,7 @@ public interface AppletContext {
|
||||
|
||||
/**
|
||||
* Returns the stream to which specified key is associated within this
|
||||
* applet context. Returns <tt>null</tt> if the applet context contains
|
||||
* applet context. Returns {@code null} if the applet context contains
|
||||
* no stream for this key.
|
||||
* <p>
|
||||
* For security reasons, mapping of streams and keys exists for each
|
||||
|
||||
@ -28,7 +28,7 @@ import java.net.URL;
|
||||
|
||||
/**
|
||||
* When an applet is first created, an applet stub is attached to it
|
||||
* using the applet's <code>setStub</code> method. This stub
|
||||
* using the applet's {@code setStub} method. This stub
|
||||
* serves as the interface between the applet and the browser
|
||||
* environment or applet viewer environment in which the application
|
||||
* is running.
|
||||
@ -40,11 +40,11 @@ import java.net.URL;
|
||||
public interface AppletStub {
|
||||
/**
|
||||
* Determines if the applet is active. An applet is active just
|
||||
* before its <code>start</code> method is called. It becomes
|
||||
* inactive just before its <code>stop</code> method is called.
|
||||
* before its {@code start} method is called. It becomes
|
||||
* inactive just before its {@code stop} method is called.
|
||||
*
|
||||
* @return <code>true</code> if the applet is active;
|
||||
* <code>false</code> otherwise.
|
||||
* @return {@code true} if the applet is active;
|
||||
* {@code false} otherwise.
|
||||
*/
|
||||
boolean isActive();
|
||||
|
||||
@ -85,12 +85,12 @@ public interface AppletStub {
|
||||
* </applet>
|
||||
* </pre></blockquote>
|
||||
* <p>
|
||||
* then a call to <code>getParameter("Color")</code> returns the
|
||||
* value <code>"blue"</code>.
|
||||
* then a call to {@code getParameter("Color")} returns the
|
||||
* value {@code "blue"}.
|
||||
*
|
||||
* @param name a parameter name.
|
||||
* @return the value of the named parameter,
|
||||
* or <tt>null</tt> if not set.
|
||||
* or {@code null} if not set.
|
||||
*/
|
||||
String getParameter(String name);
|
||||
|
||||
|
||||
@ -30,14 +30,14 @@ import java.beans.ConstructorProperties;
|
||||
import java.lang.annotation.Native;
|
||||
|
||||
/**
|
||||
* The <code>BasicStroke</code> class defines a basic set of rendering
|
||||
* The {@code BasicStroke} class defines a basic set of rendering
|
||||
* attributes for the outlines of graphics primitives, which are rendered
|
||||
* with a {@link Graphics2D} object that has its Stroke attribute set to
|
||||
* this <code>BasicStroke</code>.
|
||||
* The rendering attributes defined by <code>BasicStroke</code> describe
|
||||
* this {@code BasicStroke}.
|
||||
* The rendering attributes defined by {@code BasicStroke} describe
|
||||
* the shape of the mark made by a pen drawn along the outline of a
|
||||
* {@link Shape} and the decorations applied at the ends and joins of
|
||||
* path segments of the <code>Shape</code>.
|
||||
* path segments of the {@code Shape}.
|
||||
* These rendering attributes include:
|
||||
* <dl>
|
||||
* <dt><i>width</i>
|
||||
@ -73,32 +73,32 @@ import java.lang.annotation.Native;
|
||||
* </dl>
|
||||
* All attributes that specify measurements and distances controlling
|
||||
* the shape of the returned outline are measured in the same
|
||||
* coordinate system as the original unstroked <code>Shape</code>
|
||||
* argument. When a <code>Graphics2D</code> object uses a
|
||||
* <code>Stroke</code> object to redefine a path during the execution
|
||||
* of one of its <code>draw</code> methods, the geometry is supplied
|
||||
* in its original form before the <code>Graphics2D</code> transform
|
||||
* coordinate system as the original unstroked {@code Shape}
|
||||
* argument. When a {@code Graphics2D} object uses a
|
||||
* {@code Stroke} object to redefine a path during the execution
|
||||
* of one of its {@code draw} methods, the geometry is supplied
|
||||
* in its original form before the {@code Graphics2D} transform
|
||||
* attribute is applied. Therefore, attributes such as the pen width
|
||||
* are interpreted in the user space coordinate system of the
|
||||
* <code>Graphics2D</code> object and are subject to the scaling and
|
||||
* {@code Graphics2D} object and are subject to the scaling and
|
||||
* shearing effects of the user-space-to-device-space transform in that
|
||||
* particular <code>Graphics2D</code>.
|
||||
* particular {@code Graphics2D}.
|
||||
* For example, the width of a rendered shape's outline is determined
|
||||
* not only by the width attribute of this <code>BasicStroke</code>,
|
||||
* not only by the width attribute of this {@code BasicStroke},
|
||||
* but also by the transform attribute of the
|
||||
* <code>Graphics2D</code> object. Consider this code:
|
||||
* <blockquote><tt>
|
||||
* {@code Graphics2D} object. Consider this code:
|
||||
* <blockquote><pre>{@code
|
||||
* // sets the Graphics2D object's Transform attribute
|
||||
* g2d.scale(10, 10);
|
||||
* // sets the Graphics2D object's Stroke attribute
|
||||
* g2d.setStroke(new BasicStroke(1.5f));
|
||||
* </tt></blockquote>
|
||||
* }</pre></blockquote>
|
||||
* Assuming there are no other scaling transforms added to the
|
||||
* <code>Graphics2D</code> object, the resulting line
|
||||
* {@code Graphics2D} object, the resulting line
|
||||
* will be approximately 15 pixels wide.
|
||||
* As the example code demonstrates, a floating-point line
|
||||
* offers better precision, especially when large transforms are
|
||||
* used with a <code>Graphics2D</code> object.
|
||||
* used with a {@code Graphics2D} object.
|
||||
* When a line is diagonal, the exact width depends on how the
|
||||
* rendering pipeline chooses which pixels to fill as it traces the
|
||||
* theoretical widened outline. The choice of which pixels to turn
|
||||
@ -107,7 +107,7 @@ import java.lang.annotation.Native;
|
||||
* partially-covered pixels.
|
||||
* <p>
|
||||
* For more information on the user space coordinate system and the
|
||||
* rendering process, see the <code>Graphics2D</code> class comments.
|
||||
* rendering process, see the {@code Graphics2D} class comments.
|
||||
* @see Graphics2D
|
||||
* @author Jim Graham
|
||||
*/
|
||||
@ -161,30 +161,30 @@ public class BasicStroke implements Stroke {
|
||||
float dash_phase;
|
||||
|
||||
/**
|
||||
* Constructs a new <code>BasicStroke</code> with the specified
|
||||
* Constructs a new {@code BasicStroke} with the specified
|
||||
* attributes.
|
||||
* @param width the width of this <code>BasicStroke</code>. The
|
||||
* @param width the width of this {@code BasicStroke}. The
|
||||
* width must be greater than or equal to 0.0f. If width is
|
||||
* set to 0.0f, the stroke is rendered as the thinnest
|
||||
* possible line for the target device and the antialias
|
||||
* hint setting.
|
||||
* @param cap the decoration of the ends of a <code>BasicStroke</code>
|
||||
* @param cap the decoration of the ends of a {@code BasicStroke}
|
||||
* @param join the decoration applied where path segments meet
|
||||
* @param miterlimit the limit to trim the miter join. The miterlimit
|
||||
* must be greater than or equal to 1.0f.
|
||||
* @param dash the array representing the dashing pattern
|
||||
* @param dash_phase the offset to start the dashing pattern
|
||||
* @throws IllegalArgumentException if <code>width</code> is negative
|
||||
* @throws IllegalArgumentException if <code>cap</code> is not either
|
||||
* @throws IllegalArgumentException if {@code width} is negative
|
||||
* @throws IllegalArgumentException if {@code cap} is not either
|
||||
* CAP_BUTT, CAP_ROUND or CAP_SQUARE
|
||||
* @throws IllegalArgumentException if <code>miterlimit</code> is less
|
||||
* than 1 and <code>join</code> is JOIN_MITER
|
||||
* @throws IllegalArgumentException if <code>join</code> is not
|
||||
* @throws IllegalArgumentException if {@code miterlimit} is less
|
||||
* than 1 and {@code join} is JOIN_MITER
|
||||
* @throws IllegalArgumentException if {@code join} is not
|
||||
* either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER
|
||||
* @throws IllegalArgumentException if <code>dash_phase</code>
|
||||
* is negative and <code>dash</code> is not <code>null</code>
|
||||
* @throws IllegalArgumentException if {@code dash_phase}
|
||||
* is negative and {@code dash} is not {@code null}
|
||||
* @throws IllegalArgumentException if the length of
|
||||
* <code>dash</code> is zero
|
||||
* {@code dash} is zero
|
||||
* @throws IllegalArgumentException if dash lengths are all zero.
|
||||
*/
|
||||
@ConstructorProperties({ "lineWidth", "endCap", "lineJoin", "miterLimit", "dashArray", "dashPhase" })
|
||||
@ -231,18 +231,18 @@ public class BasicStroke implements Stroke {
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a solid <code>BasicStroke</code> with the specified
|
||||
* Constructs a solid {@code BasicStroke} with the specified
|
||||
* attributes.
|
||||
* @param width the width of the <code>BasicStroke</code>
|
||||
* @param cap the decoration of the ends of a <code>BasicStroke</code>
|
||||
* @param width the width of the {@code BasicStroke}
|
||||
* @param cap the decoration of the ends of a {@code BasicStroke}
|
||||
* @param join the decoration applied where path segments meet
|
||||
* @param miterlimit the limit to trim the miter join
|
||||
* @throws IllegalArgumentException if <code>width</code> is negative
|
||||
* @throws IllegalArgumentException if <code>cap</code> is not either
|
||||
* @throws IllegalArgumentException if {@code width} is negative
|
||||
* @throws IllegalArgumentException if {@code cap} is not either
|
||||
* CAP_BUTT, CAP_ROUND or CAP_SQUARE
|
||||
* @throws IllegalArgumentException if <code>miterlimit</code> is less
|
||||
* than 1 and <code>join</code> is JOIN_MITER
|
||||
* @throws IllegalArgumentException if <code>join</code> is not
|
||||
* @throws IllegalArgumentException if {@code miterlimit} is less
|
||||
* than 1 and {@code join} is JOIN_MITER
|
||||
* @throws IllegalArgumentException if {@code join} is not
|
||||
* either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER
|
||||
*/
|
||||
public BasicStroke(float width, int cap, int join, float miterlimit) {
|
||||
@ -250,17 +250,17 @@ public class BasicStroke implements Stroke {
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a solid <code>BasicStroke</code> with the specified
|
||||
* attributes. The <code>miterlimit</code> parameter is
|
||||
* Constructs a solid {@code BasicStroke} with the specified
|
||||
* attributes. The {@code miterlimit} parameter is
|
||||
* unnecessary in cases where the default is allowable or the
|
||||
* line joins are not specified as JOIN_MITER.
|
||||
* @param width the width of the <code>BasicStroke</code>
|
||||
* @param cap the decoration of the ends of a <code>BasicStroke</code>
|
||||
* @param width the width of the {@code BasicStroke}
|
||||
* @param cap the decoration of the ends of a {@code BasicStroke}
|
||||
* @param join the decoration applied where path segments meet
|
||||
* @throws IllegalArgumentException if <code>width</code> is negative
|
||||
* @throws IllegalArgumentException if <code>cap</code> is not either
|
||||
* @throws IllegalArgumentException if {@code width} is negative
|
||||
* @throws IllegalArgumentException if {@code cap} is not either
|
||||
* CAP_BUTT, CAP_ROUND or CAP_SQUARE
|
||||
* @throws IllegalArgumentException if <code>join</code> is not
|
||||
* @throws IllegalArgumentException if {@code join} is not
|
||||
* either JOIN_ROUND, JOIN_BEVEL, or JOIN_MITER
|
||||
*/
|
||||
public BasicStroke(float width, int cap, int join) {
|
||||
@ -268,18 +268,18 @@ public class BasicStroke implements Stroke {
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a solid <code>BasicStroke</code> with the specified
|
||||
* Constructs a solid {@code BasicStroke} with the specified
|
||||
* line width and with default values for the cap and join
|
||||
* styles.
|
||||
* @param width the width of the <code>BasicStroke</code>
|
||||
* @throws IllegalArgumentException if <code>width</code> is negative
|
||||
* @param width the width of the {@code BasicStroke}
|
||||
* @throws IllegalArgumentException if {@code width} is negative
|
||||
*/
|
||||
public BasicStroke(float width) {
|
||||
this(width, CAP_SQUARE, JOIN_MITER, 10.0f, null, 0.0f);
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a new <code>BasicStroke</code> with defaults for all
|
||||
* Constructs a new {@code BasicStroke} with defaults for all
|
||||
* attributes.
|
||||
* The default attributes are a solid line of width 1.0, CAP_SQUARE,
|
||||
* JOIN_MITER, a miter limit of 10.0.
|
||||
@ -290,10 +290,10 @@ public class BasicStroke implements Stroke {
|
||||
|
||||
|
||||
/**
|
||||
* Returns a <code>Shape</code> whose interior defines the
|
||||
* stroked outline of a specified <code>Shape</code>.
|
||||
* @param s the <code>Shape</code> boundary be stroked
|
||||
* @return the <code>Shape</code> of the stroked outline.
|
||||
* Returns a {@code Shape} whose interior defines the
|
||||
* stroked outline of a specified {@code Shape}.
|
||||
* @param s the {@code Shape} boundary be stroked
|
||||
* @return the {@code Shape} of the stroked outline.
|
||||
*/
|
||||
public Shape createStrokedShape(Shape s) {
|
||||
sun.java2d.pipe.RenderingEngine re =
|
||||
@ -305,9 +305,9 @@ public class BasicStroke implements Stroke {
|
||||
/**
|
||||
* Returns the line width. Line width is represented in user space,
|
||||
* which is the default-coordinate space used by Java 2D. See the
|
||||
* <code>Graphics2D</code> class comments for more information on
|
||||
* {@code Graphics2D} class comments for more information on
|
||||
* the user space coordinate system.
|
||||
* @return the line width of this <code>BasicStroke</code>.
|
||||
* @return the line width of this {@code BasicStroke}.
|
||||
* @see Graphics2D
|
||||
*/
|
||||
public float getLineWidth() {
|
||||
@ -316,8 +316,8 @@ public class BasicStroke implements Stroke {
|
||||
|
||||
/**
|
||||
* Returns the end cap style.
|
||||
* @return the end cap style of this <code>BasicStroke</code> as one
|
||||
* of the static <code>int</code> values that define possible end cap
|
||||
* @return the end cap style of this {@code BasicStroke} as one
|
||||
* of the static {@code int} values that define possible end cap
|
||||
* styles.
|
||||
*/
|
||||
public int getEndCap() {
|
||||
@ -326,8 +326,8 @@ public class BasicStroke implements Stroke {
|
||||
|
||||
/**
|
||||
* Returns the line join style.
|
||||
* @return the line join style of the <code>BasicStroke</code> as one
|
||||
* of the static <code>int</code> values that define possible line
|
||||
* @return the line join style of the {@code BasicStroke} as one
|
||||
* of the static {@code int} values that define possible line
|
||||
* join styles.
|
||||
*/
|
||||
public int getLineJoin() {
|
||||
@ -336,7 +336,7 @@ public class BasicStroke implements Stroke {
|
||||
|
||||
/**
|
||||
* Returns the limit of miter joins.
|
||||
* @return the limit of miter joins of the <code>BasicStroke</code>.
|
||||
* @return the limit of miter joins of the {@code BasicStroke}.
|
||||
*/
|
||||
public float getMiterLimit() {
|
||||
return miterlimit;
|
||||
@ -346,7 +346,7 @@ public class BasicStroke implements Stroke {
|
||||
* Returns the array representing the lengths of the dash segments.
|
||||
* Alternate entries in the array represent the user space lengths
|
||||
* of the opaque and transparent segments of the dashes.
|
||||
* As the pen moves along the outline of the <code>Shape</code>
|
||||
* As the pen moves along the outline of the {@code Shape}
|
||||
* to be stroked, the user space
|
||||
* distance that the pen travels is accumulated. The distance
|
||||
* value is used to index into the dash array.
|
||||
@ -368,7 +368,7 @@ public class BasicStroke implements Stroke {
|
||||
* represents an offset into the dashing pattern. In other words, the dash
|
||||
* phase defines the point in the dashing pattern that will correspond to
|
||||
* the beginning of the stroke.
|
||||
* @return the dash phase as a <code>float</code> value.
|
||||
* @return the dash phase as a {@code float} value.
|
||||
*/
|
||||
public float getDashPhase() {
|
||||
return dash_phase;
|
||||
@ -397,15 +397,15 @@ public class BasicStroke implements Stroke {
|
||||
* stroking operation as the given argument.
|
||||
*/
|
||||
/**
|
||||
* Tests if a specified object is equal to this <code>BasicStroke</code>
|
||||
* by first testing if it is a <code>BasicStroke</code> and then comparing
|
||||
* Tests if a specified object is equal to this {@code BasicStroke}
|
||||
* by first testing if it is a {@code BasicStroke} and then comparing
|
||||
* its width, join, cap, miter limit, dash, and dash phase attributes with
|
||||
* those of this <code>BasicStroke</code>.
|
||||
* those of this {@code BasicStroke}.
|
||||
* @param obj the specified object to compare to this
|
||||
* <code>BasicStroke</code>
|
||||
* @return <code>true</code> if the width, join, cap, miter limit, dash, and
|
||||
* {@code BasicStroke}
|
||||
* @return {@code true} if the width, join, cap, miter limit, dash, and
|
||||
* dash phase are the same for both objects;
|
||||
* <code>false</code> otherwise.
|
||||
* {@code false} otherwise.
|
||||
*/
|
||||
public boolean equals(Object obj) {
|
||||
if (!(obj instanceof BasicStroke)) {
|
||||
|
||||
@ -25,10 +25,10 @@
|
||||
package java.awt;
|
||||
|
||||
/**
|
||||
* The <code>CheckboxGroup</code> class is used to group together
|
||||
* a set of <code>Checkbox</code> buttons.
|
||||
* The {@code CheckboxGroup} class is used to group together
|
||||
* a set of {@code Checkbox} buttons.
|
||||
* <p>
|
||||
* Exactly one check box button in a <code>CheckboxGroup</code> can
|
||||
* Exactly one check box button in a {@code CheckboxGroup} can
|
||||
* be in the "on" state at any given time. Pushing any
|
||||
* button sets its state to "on" and forces any other button that
|
||||
* is in the "on" state into the "off" state.
|
||||
@ -69,7 +69,7 @@ public class CheckboxGroup implements java.io.Serializable {
|
||||
private static final long serialVersionUID = 3729780091441768983L;
|
||||
|
||||
/**
|
||||
* Creates a new instance of <code>CheckboxGroup</code>.
|
||||
* Creates a new instance of {@code CheckboxGroup}.
|
||||
*/
|
||||
public CheckboxGroup() {
|
||||
}
|
||||
@ -78,10 +78,10 @@ public class CheckboxGroup implements java.io.Serializable {
|
||||
* Gets the current choice from this check box group.
|
||||
* The current choice is the check box in this
|
||||
* group that is currently in the "on" state,
|
||||
* or <code>null</code> if all check boxes in the
|
||||
* or {@code null} if all check boxes in the
|
||||
* group are off.
|
||||
* @return the check box that is currently in the
|
||||
* "on" state, or <code>null</code>.
|
||||
* "on" state, or {@code null}.
|
||||
* @see java.awt.Checkbox
|
||||
* @see java.awt.CheckboxGroup#setSelectedCheckbox
|
||||
* @since 1.1
|
||||
@ -96,7 +96,7 @@ public class CheckboxGroup implements java.io.Serializable {
|
||||
*
|
||||
* @return the selected checkbox
|
||||
* @deprecated As of JDK version 1.1,
|
||||
* replaced by <code>getSelectedCheckbox()</code>.
|
||||
* replaced by {@code getSelectedCheckbox()}.
|
||||
*/
|
||||
@Deprecated
|
||||
public Checkbox getCurrent() {
|
||||
@ -109,11 +109,11 @@ public class CheckboxGroup implements java.io.Serializable {
|
||||
* This method sets the state of that check box to "on" and
|
||||
* sets all other check boxes in the group to be off.
|
||||
* <p>
|
||||
* If the check box argument is <tt>null</tt>, all check boxes
|
||||
* If the check box argument is {@code null}, all check boxes
|
||||
* in this check box group are deselected. If the check box argument
|
||||
* belongs to a different check box group, this method does
|
||||
* nothing.
|
||||
* @param box the <code>Checkbox</code> to set as the
|
||||
* @param box the {@code Checkbox} to set as the
|
||||
* current selection.
|
||||
* @see java.awt.Checkbox
|
||||
* @see java.awt.CheckboxGroup#getSelectedCheckbox
|
||||
@ -130,7 +130,7 @@ public class CheckboxGroup implements java.io.Serializable {
|
||||
* @param box the {@code Checkbox} to set as the
|
||||
* current selection.
|
||||
* @deprecated As of JDK version 1.1,
|
||||
* replaced by <code>setSelectedCheckbox(Checkbox)</code>.
|
||||
* replaced by {@code setSelectedCheckbox(Checkbox)}.
|
||||
*/
|
||||
@Deprecated
|
||||
public synchronized void setCurrent(Checkbox box) {
|
||||
|
||||
@ -26,7 +26,7 @@
|
||||
package java.awt;
|
||||
|
||||
/**
|
||||
* The <code>GridLayout</code> class is a layout manager that
|
||||
* The {@code GridLayout} class is a layout manager that
|
||||
* lays out a container's components in a rectangular grid.
|
||||
* The container is divided into equal-sized rectangles,
|
||||
* and one component is placed in each rectangle.
|
||||
@ -50,9 +50,9 @@ package java.awt;
|
||||
* }
|
||||
* </pre></blockquote><hr>
|
||||
* <p>
|
||||
* If the container's <code>ComponentOrientation</code> property is horizontal
|
||||
* If the container's {@code ComponentOrientation} property is horizontal
|
||||
* and left-to-right, the above example produces the output shown in Figure 1.
|
||||
* If the container's <code>ComponentOrientation</code> property is horizontal
|
||||
* If the container's {@code ComponentOrientation} property is horizontal
|
||||
* and right-to-left, the example produces the output shown in Figure 2.
|
||||
*
|
||||
* <table style="float:center" WIDTH=600 summary="layout">
|
||||
@ -77,7 +77,7 @@ package java.awt;
|
||||
* <p>
|
||||
* When both the number of rows and the number of columns have
|
||||
* been set to non-zero values, either by a constructor or
|
||||
* by the <tt>setRows</tt> and <tt>setColumns</tt> methods, the number of
|
||||
* by the {@code setRows} and {@code setColumns} methods, the number of
|
||||
* columns specified is ignored. Instead, the number of
|
||||
* columns is determined from the specified number of rows
|
||||
* and the total number of components in the layout. So, for
|
||||
@ -154,7 +154,7 @@ public class GridLayout implements LayoutManager, java.io.Serializable {
|
||||
* Creates a grid layout with the specified number of rows and
|
||||
* columns. All components in the layout are given equal size.
|
||||
* <p>
|
||||
* One, but not both, of <code>rows</code> and <code>cols</code> can
|
||||
* One, but not both, of {@code rows} and {@code cols} can
|
||||
* be zero, which means that any number of objects can be placed in a
|
||||
* row or in a column.
|
||||
* @param rows the rows, with the value zero meaning
|
||||
@ -175,11 +175,11 @@ public class GridLayout implements LayoutManager, java.io.Serializable {
|
||||
* of the columns. Vertical gaps are placed between each of
|
||||
* the rows.
|
||||
* <p>
|
||||
* One, but not both, of <code>rows</code> and <code>cols</code> can
|
||||
* One, but not both, of {@code rows} and {@code cols} can
|
||||
* be zero, which means that any number of objects can be placed in a
|
||||
* row or in a column.
|
||||
* <p>
|
||||
* All <code>GridLayout</code> constructors defer to this one.
|
||||
* All {@code GridLayout} constructors defer to this one.
|
||||
* @param rows the rows, with the value zero meaning
|
||||
* any number of rows
|
||||
* @param cols the columns, with the value zero meaning
|
||||
@ -187,7 +187,7 @@ public class GridLayout implements LayoutManager, java.io.Serializable {
|
||||
* @param hgap the horizontal gap
|
||||
* @param vgap the vertical gap
|
||||
* @exception IllegalArgumentException if the value of both
|
||||
* <code>rows</code> and <code>cols</code> is
|
||||
* {@code rows} and {@code cols} is
|
||||
* set to zero
|
||||
*/
|
||||
public GridLayout(int rows, int cols, int hgap, int vgap) {
|
||||
@ -213,7 +213,7 @@ public class GridLayout implements LayoutManager, java.io.Serializable {
|
||||
* Sets the number of rows in this layout to the specified value.
|
||||
* @param rows the number of rows in this layout
|
||||
* @exception IllegalArgumentException if the value of both
|
||||
* <code>rows</code> and <code>cols</code> is set to zero
|
||||
* {@code rows} and {@code cols} is set to zero
|
||||
* @since 1.1
|
||||
*/
|
||||
public void setRows(int rows) {
|
||||
@ -236,12 +236,12 @@ public class GridLayout implements LayoutManager, java.io.Serializable {
|
||||
* Sets the number of columns in this layout to the specified value.
|
||||
* Setting the number of columns has no affect on the layout
|
||||
* if the number of rows specified by a constructor or by
|
||||
* the <tt>setRows</tt> method is non-zero. In that case, the number
|
||||
* the {@code setRows} method is non-zero. In that case, the number
|
||||
* of columns displayed in the layout is determined by the total
|
||||
* number of components and the number of rows specified.
|
||||
* @param cols the number of columns in this layout
|
||||
* @exception IllegalArgumentException if the value of both
|
||||
* <code>rows</code> and <code>cols</code> is set to zero
|
||||
* {@code rows} and {@code cols} is set to zero
|
||||
* @since 1.1
|
||||
*/
|
||||
public void setColumns(int cols) {
|
||||
@ -405,7 +405,7 @@ public class GridLayout implements LayoutManager, java.io.Serializable {
|
||||
* <p>
|
||||
* This method reshapes the components in the specified target
|
||||
* container in order to satisfy the constraints of the
|
||||
* <code>GridLayout</code> object.
|
||||
* {@code GridLayout} object.
|
||||
* <p>
|
||||
* The grid layout manager determines the size of individual
|
||||
* components by dividing the free space in the container into
|
||||
|
||||
@ -43,11 +43,11 @@ import sun.awt.AWTAccessor;
|
||||
import sun.awt.AWTAccessor.DropTargetContextAccessor;
|
||||
|
||||
/**
|
||||
* A <code>DropTargetContext</code> is created
|
||||
* A {@code DropTargetContext} is created
|
||||
* whenever the logical cursor associated
|
||||
* with a Drag and Drop operation coincides with the visible geometry of
|
||||
* a <code>Component</code> associated with a <code>DropTarget</code>.
|
||||
* The <code>DropTargetContext</code> provides
|
||||
* a {@code Component} associated with a {@code DropTarget}.
|
||||
* The {@code DropTargetContext} provides
|
||||
* the mechanism for a potential receiver
|
||||
* of a drop operation to both provide the end user with the appropriate
|
||||
* drag under feedback, but also to effect the subsequent data transfer
|
||||
@ -74,8 +74,8 @@ public class DropTargetContext implements Serializable {
|
||||
});
|
||||
}
|
||||
/**
|
||||
* Construct a <code>DropTargetContext</code>
|
||||
* given a specified <code>DropTarget</code>.
|
||||
* Construct a {@code DropTargetContext}
|
||||
* given a specified {@code DropTarget}.
|
||||
*
|
||||
* @param dt the DropTarget to associate with
|
||||
*/
|
||||
@ -87,17 +87,17 @@ public class DropTargetContext implements Serializable {
|
||||
}
|
||||
|
||||
/**
|
||||
* This method returns the <code>DropTarget</code> associated with this
|
||||
* <code>DropTargetContext</code>.
|
||||
* This method returns the {@code DropTarget} associated with this
|
||||
* {@code DropTargetContext}.
|
||||
*
|
||||
* @return the <code>DropTarget</code> associated with this <code>DropTargetContext</code>
|
||||
* @return the {@code DropTarget} associated with this {@code DropTargetContext}
|
||||
*/
|
||||
|
||||
public DropTarget getDropTarget() { return dropTarget; }
|
||||
|
||||
/**
|
||||
* This method returns the <code>Component</code> associated with
|
||||
* this <code>DropTargetContext</code>.
|
||||
* This method returns the {@code Component} associated with
|
||||
* this {@code DropTargetContext}.
|
||||
*
|
||||
* @return the Component associated with this Context
|
||||
*/
|
||||
@ -105,7 +105,7 @@ public class DropTargetContext implements Serializable {
|
||||
public Component getComponent() { return dropTarget.getComponent(); }
|
||||
|
||||
/**
|
||||
* Called when disassociated with the <code>DropTargetContextPeer</code>.
|
||||
* Called when disassociated with the {@code DropTargetContextPeer}.
|
||||
*/
|
||||
void reset() {
|
||||
dropTargetContextPeer = null;
|
||||
@ -114,9 +114,9 @@ public class DropTargetContext implements Serializable {
|
||||
|
||||
/**
|
||||
* This method sets the current actions acceptable to
|
||||
* this <code>DropTarget</code>.
|
||||
* this {@code DropTarget}.
|
||||
*
|
||||
* @param actions an <code>int</code> representing the supported action(s)
|
||||
* @param actions an {@code int} representing the supported action(s)
|
||||
*/
|
||||
|
||||
protected void setTargetActions(int actions) {
|
||||
@ -132,10 +132,10 @@ public class DropTargetContext implements Serializable {
|
||||
}
|
||||
|
||||
/**
|
||||
* This method returns an <code>int</code> representing the
|
||||
* current actions this <code>DropTarget</code> will accept.
|
||||
* This method returns an {@code int} representing the
|
||||
* current actions this {@code DropTarget} will accept.
|
||||
*
|
||||
* @return the current actions acceptable to this <code>DropTarget</code>
|
||||
* @return the current actions acceptable to this {@code DropTarget}
|
||||
*/
|
||||
|
||||
protected int getTargetActions() {
|
||||
@ -215,11 +215,11 @@ public class DropTargetContext implements Serializable {
|
||||
|
||||
/**
|
||||
* get the available DataFlavors of the
|
||||
* <code>Transferable</code> operand of this operation.
|
||||
* {@code Transferable} operand of this operation.
|
||||
*
|
||||
* @return a <code>DataFlavor[]</code> containing the
|
||||
* supported <code>DataFlavor</code>s of the
|
||||
* <code>Transferable</code> operand.
|
||||
* @return a {@code DataFlavor[]} containing the
|
||||
* supported {@code DataFlavor}s of the
|
||||
* {@code Transferable} operand.
|
||||
*/
|
||||
|
||||
protected DataFlavor[] getCurrentDataFlavors() {
|
||||
@ -229,11 +229,11 @@ public class DropTargetContext implements Serializable {
|
||||
|
||||
/**
|
||||
* This method returns a the currently available DataFlavors
|
||||
* of the <code>Transferable</code> operand
|
||||
* as a <code>java.util.List</code>.
|
||||
* of the {@code Transferable} operand
|
||||
* as a {@code java.util.List}.
|
||||
*
|
||||
* @return the currently available
|
||||
* DataFlavors as a <code>java.util.List</code>
|
||||
* DataFlavors as a {@code java.util.List}
|
||||
*/
|
||||
|
||||
protected List<DataFlavor> getCurrentDataFlavorsAsList() {
|
||||
@ -241,13 +241,13 @@ public class DropTargetContext implements Serializable {
|
||||
}
|
||||
|
||||
/**
|
||||
* This method returns a <code>boolean</code>
|
||||
* indicating if the given <code>DataFlavor</code> is
|
||||
* supported by this <code>DropTargetContext</code>.
|
||||
* This method returns a {@code boolean}
|
||||
* indicating if the given {@code DataFlavor} is
|
||||
* supported by this {@code DropTargetContext}.
|
||||
*
|
||||
* @param df the <code>DataFlavor</code>
|
||||
* @param df the {@code DataFlavor}
|
||||
*
|
||||
* @return if the <code>DataFlavor</code> specified is supported
|
||||
* @return if the {@code DataFlavor} specified is supported
|
||||
*/
|
||||
|
||||
protected boolean isDataFlavorSupported(DataFlavor df) {
|
||||
@ -259,7 +259,7 @@ public class DropTargetContext implements Serializable {
|
||||
*
|
||||
* @throws InvalidDnDOperationException if a drag is not outstanding/extant
|
||||
*
|
||||
* @return the <code>Transferable</code>
|
||||
* @return the {@code Transferable}
|
||||
*/
|
||||
|
||||
protected Transferable getTransferable() throws InvalidDnDOperationException {
|
||||
@ -282,7 +282,7 @@ public class DropTargetContext implements Serializable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the <code>DropTargetContextPeer</code>
|
||||
* Get the {@code DropTargetContextPeer}
|
||||
*
|
||||
* @return the platform peer
|
||||
*/
|
||||
@ -301,10 +301,10 @@ public class DropTargetContext implements Serializable {
|
||||
* Creates a TransferableProxy to proxy for the specified
|
||||
* Transferable.
|
||||
*
|
||||
* @param t the <tt>Transferable</tt> to be proxied
|
||||
* @param local <tt>true</tt> if <tt>t</tt> represents
|
||||
* @param t the {@code Transferable} to be proxied
|
||||
* @param local {@code true} if {@code t} represents
|
||||
* the result of a local drag-n-drop operation.
|
||||
* @return the new <tt>TransferableProxy</tt> instance.
|
||||
* @return the new {@code TransferableProxy} instance.
|
||||
*/
|
||||
protected Transferable createTransferableProxy(Transferable t, boolean local) {
|
||||
return new TransferableProxy(t, local);
|
||||
@ -314,9 +314,9 @@ public class DropTargetContext implements Serializable {
|
||||
|
||||
|
||||
/**
|
||||
* <code>TransferableProxy</code> is a helper inner class that implements
|
||||
* <code>Transferable</code> interface and serves as a proxy for another
|
||||
* <code>Transferable</code> object which represents data transfer for
|
||||
* {@code TransferableProxy} is a helper inner class that implements
|
||||
* {@code Transferable} interface and serves as a proxy for another
|
||||
* {@code Transferable} object which represents data transfer for
|
||||
* a particular drag-n-drop operation.
|
||||
* <p>
|
||||
* The proxy forwards all requests to the encapsulated transferable
|
||||
@ -327,14 +327,14 @@ public class DropTargetContext implements Serializable {
|
||||
protected class TransferableProxy implements Transferable {
|
||||
|
||||
/**
|
||||
* Constructs a <code>TransferableProxy</code> given
|
||||
* a specified <code>Transferable</code> object representing
|
||||
* Constructs a {@code TransferableProxy} given
|
||||
* a specified {@code Transferable} object representing
|
||||
* data transfer for a particular drag-n-drop operation and
|
||||
* a <code>boolean</code> which indicates whether the
|
||||
* a {@code boolean} which indicates whether the
|
||||
* drag-n-drop operation is local (within the same JVM).
|
||||
*
|
||||
* @param t the <code>Transferable</code> object
|
||||
* @param local <code>true</code>, if <code>t</code> represents
|
||||
* @param t the {@code Transferable} object
|
||||
* @param local {@code true}, if {@code t} represents
|
||||
* the result of local drag-n-drop operation
|
||||
*/
|
||||
TransferableProxy(Transferable t, boolean local) {
|
||||
@ -358,8 +358,8 @@ public class DropTargetContext implements Serializable {
|
||||
* Returns whether or not the specified data flavor is supported by
|
||||
* the encapsulated transferable.
|
||||
* @param flavor the requested flavor for the data
|
||||
* @return <code>true</code> if the data flavor is supported,
|
||||
* <code>false</code> otherwise
|
||||
* @return {@code true} if the data flavor is supported,
|
||||
* {@code false} otherwise
|
||||
*/
|
||||
public boolean isDataFlavorSupported(DataFlavor flavor) {
|
||||
return proxy.isDataFlavorSupported(flavor);
|
||||
@ -397,13 +397,13 @@ public class DropTargetContext implements Serializable {
|
||||
// public constructor.
|
||||
|
||||
/**
|
||||
* The encapsulated <code>Transferable</code> object.
|
||||
* The encapsulated {@code Transferable} object.
|
||||
*/
|
||||
protected Transferable transferable;
|
||||
|
||||
/**
|
||||
* A <code>boolean</code> indicating if the encapsulated
|
||||
* <code>Transferable</code> object represents the result
|
||||
* A {@code boolean} indicating if the encapsulated
|
||||
* {@code Transferable} object represents the result
|
||||
* of local drag-n-drop operation (within the same JVM).
|
||||
*/
|
||||
protected boolean isLocal;
|
||||
|
||||
@ -31,16 +31,16 @@ import java.awt.ActiveEvent;
|
||||
import java.awt.AWTEvent;
|
||||
|
||||
/**
|
||||
* An event which executes the <code>run()</code> method on a <code>Runnable
|
||||
* </code> when dispatched by the AWT event dispatcher thread. This class can
|
||||
* be used as a reference implementation of <code>ActiveEvent</code> rather
|
||||
* than declaring a new class and defining <code>dispatch()</code>.<p>
|
||||
* An event which executes the {@code run()} method on a {@code Runnable
|
||||
* } when dispatched by the AWT event dispatcher thread. This class can
|
||||
* be used as a reference implementation of {@code ActiveEvent} rather
|
||||
* than declaring a new class and defining {@code dispatch()}.<p>
|
||||
*
|
||||
* Instances of this class are placed on the <code>EventQueue</code> by calls
|
||||
* to <code>invokeLater</code> and <code>invokeAndWait</code>. Client code
|
||||
* can use this fact to write replacement functions for <code>invokeLater
|
||||
* </code> and <code>invokeAndWait</code> without writing special-case code
|
||||
* in any <code>AWTEventListener</code> objects.
|
||||
* Instances of this class are placed on the {@code EventQueue} by calls
|
||||
* to {@code invokeLater} and {@code invokeAndWait}. Client code
|
||||
* can use this fact to write replacement functions for {@code invokeLater
|
||||
* } and {@code invokeAndWait} without writing special-case code
|
||||
* in any {@code AWTEventListener} objects.
|
||||
* <p>
|
||||
* An unspecified behavior will be caused if the {@code id} parameter
|
||||
* of any particular {@code InvocationEvent} instance is not
|
||||
@ -106,7 +106,7 @@ public class InvocationEvent extends AWTEvent implements ActiveEvent {
|
||||
private final Runnable listener;
|
||||
|
||||
/**
|
||||
* Indicates whether the <code>run()</code> method of the <code>runnable</code>
|
||||
* Indicates whether the {@code run()} method of the {@code runnable}
|
||||
* was executed or not.
|
||||
*
|
||||
* @see #isDispatched
|
||||
@ -149,20 +149,21 @@ public class InvocationEvent extends AWTEvent implements ActiveEvent {
|
||||
private static final long serialVersionUID = 436056344909459450L;
|
||||
|
||||
/**
|
||||
* Constructs an <code>InvocationEvent</code> with the specified
|
||||
* source which will execute the runnable's <code>run</code>
|
||||
* Constructs an {@code InvocationEvent} with the specified
|
||||
* source which will execute the runnable's {@code run}
|
||||
* method when dispatched.
|
||||
* <p>This is a convenience constructor. An invocation of the form
|
||||
* <tt>InvocationEvent(source, runnable)</tt>
|
||||
* {@code InvocationEvent(source, runnable)}
|
||||
* behaves in exactly the same way as the invocation of
|
||||
* <tt>{@link #InvocationEvent(Object, Runnable, Object, boolean) InvocationEvent}(source, runnable, null, false)</tt>.
|
||||
* <p> This method throws an <code>IllegalArgumentException</code>
|
||||
* if <code>source</code> is <code>null</code>.
|
||||
* {@link #InvocationEvent(Object, Runnable, Object, boolean)
|
||||
* InvocationEvent(source, runnable, null, false)}.
|
||||
* <p> This method throws an {@code IllegalArgumentException}
|
||||
* if {@code source} is {@code null}.
|
||||
*
|
||||
* @param source The <code>Object</code> that originated the event
|
||||
* @param runnable The <code>Runnable</code> whose <code>run</code>
|
||||
* @param source The {@code Object} that originated the event
|
||||
* @param runnable The {@code Runnable} whose {@code run}
|
||||
* method will be executed
|
||||
* @throws IllegalArgumentException if <code>source</code> is null
|
||||
* @throws IllegalArgumentException if {@code source} is null
|
||||
*
|
||||
* @see #getSource()
|
||||
* @see #InvocationEvent(Object, Runnable, Object, boolean)
|
||||
@ -172,35 +173,36 @@ public class InvocationEvent extends AWTEvent implements ActiveEvent {
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs an <code>InvocationEvent</code> with the specified
|
||||
* source which will execute the runnable's <code>run</code>
|
||||
* method when dispatched. If notifier is non-<code>null</code>,
|
||||
* <code>notifyAll()</code> will be called on it
|
||||
* immediately after <code>run</code> has returned or thrown an exception.
|
||||
* <p>An invocation of the form <tt>InvocationEvent(source,
|
||||
* runnable, notifier, catchThrowables)</tt>
|
||||
* Constructs an {@code InvocationEvent} with the specified
|
||||
* source which will execute the runnable's {@code run}
|
||||
* method when dispatched. If notifier is non-{@code null},
|
||||
* {@code notifyAll()} will be called on it
|
||||
* immediately after {@code run} has returned or thrown an exception.
|
||||
* <p>An invocation of the form
|
||||
* {@code InvocationEvent(source, runnable, notifier, catchThrowables)}
|
||||
* behaves in exactly the same way as the invocation of
|
||||
* <tt>{@link #InvocationEvent(Object, int, Runnable, Object, boolean) InvocationEvent}(source, InvocationEvent.INVOCATION_DEFAULT, runnable, notifier, catchThrowables)</tt>.
|
||||
* <p>This method throws an <code>IllegalArgumentException</code>
|
||||
* if <code>source</code> is <code>null</code>.
|
||||
* {@link #InvocationEvent(Object, int, Runnable, Object, boolean)
|
||||
* InvocationEvent(source, InvocationEvent.INVOCATION_DEFAULT, runnable, notifier, catchThrowables)}.
|
||||
* <p>This method throws an {@code IllegalArgumentException}
|
||||
* if {@code source} is {@code null}.
|
||||
*
|
||||
* @param source The <code>Object</code> that originated
|
||||
* @param source The {@code Object} that originated
|
||||
* the event
|
||||
* @param runnable The <code>Runnable</code> whose
|
||||
* <code>run</code> method will be
|
||||
* @param runnable The {@code Runnable} whose
|
||||
* {@code run} method will be
|
||||
* executed
|
||||
* @param notifier The {@code Object} whose <code>notifyAll</code>
|
||||
* @param notifier The {@code Object} whose {@code notifyAll}
|
||||
* method will be called after
|
||||
* <code>Runnable.run</code> has returned or
|
||||
* {@code Runnable.run} has returned or
|
||||
* thrown an exception or after the event was
|
||||
* disposed
|
||||
* @param catchThrowables Specifies whether <code>dispatch</code>
|
||||
* @param catchThrowables Specifies whether {@code dispatch}
|
||||
* should catch Throwable when executing
|
||||
* the <code>Runnable</code>'s <code>run</code>
|
||||
* the {@code Runnable}'s {@code run}
|
||||
* method, or should instead propagate those
|
||||
* Throwables to the EventDispatchThread's
|
||||
* dispatch loop
|
||||
* @throws IllegalArgumentException if <code>source</code> is null
|
||||
* @throws IllegalArgumentException if {@code source} is null
|
||||
*
|
||||
* @see #getSource()
|
||||
* @see #InvocationEvent(Object, int, Runnable, Object, boolean)
|
||||
@ -211,31 +213,31 @@ public class InvocationEvent extends AWTEvent implements ActiveEvent {
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs an <code>InvocationEvent</code> with the specified
|
||||
* source which will execute the runnable's <code>run</code>
|
||||
* method when dispatched. If listener is non-<code>null</code>,
|
||||
* <code>listener.run()</code> will be called immediately after
|
||||
* <code>run</code> has returned, thrown an exception or the event
|
||||
* Constructs an {@code InvocationEvent} with the specified
|
||||
* source which will execute the runnable's {@code run}
|
||||
* method when dispatched. If listener is non-{@code null},
|
||||
* {@code listener.run()} will be called immediately after
|
||||
* {@code run} has returned, thrown an exception or the event
|
||||
* was disposed.
|
||||
* <p>This method throws an <code>IllegalArgumentException</code>
|
||||
* if <code>source</code> is <code>null</code>.
|
||||
* <p>This method throws an {@code IllegalArgumentException}
|
||||
* if {@code source} is {@code null}.
|
||||
*
|
||||
* @param source The <code>Object</code> that originated
|
||||
* @param source The {@code Object} that originated
|
||||
* the event
|
||||
* @param runnable The <code>Runnable</code> whose
|
||||
* <code>run</code> method will be
|
||||
* @param runnable The {@code Runnable} whose
|
||||
* {@code run} method will be
|
||||
* executed
|
||||
* @param listener The <code>Runnable</code>Runnable whose
|
||||
* <code>run()</code> method will be called
|
||||
* @param listener The {@code Runnable}Runnable whose
|
||||
* {@code run()} method will be called
|
||||
* after the {@code InvocationEvent}
|
||||
* was dispatched or disposed
|
||||
* @param catchThrowables Specifies whether <code>dispatch</code>
|
||||
* @param catchThrowables Specifies whether {@code dispatch}
|
||||
* should catch Throwable when executing
|
||||
* the <code>Runnable</code>'s <code>run</code>
|
||||
* the {@code Runnable}'s {@code run}
|
||||
* method, or should instead propagate those
|
||||
* Throwables to the EventDispatchThread's
|
||||
* dispatch loop
|
||||
* @throws IllegalArgumentException if <code>source</code> is null
|
||||
* @throws IllegalArgumentException if {@code source} is null
|
||||
*/
|
||||
public InvocationEvent(Object source, Runnable runnable, Runnable listener,
|
||||
boolean catchThrowables) {
|
||||
@ -243,34 +245,34 @@ public class InvocationEvent extends AWTEvent implements ActiveEvent {
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs an <code>InvocationEvent</code> with the specified
|
||||
* source and ID which will execute the runnable's <code>run</code>
|
||||
* method when dispatched. If notifier is non-<code>null</code>,
|
||||
* <code>notifyAll</code> will be called on it immediately after
|
||||
* <code>run</code> has returned or thrown an exception.
|
||||
* Constructs an {@code InvocationEvent} with the specified
|
||||
* source and ID which will execute the runnable's {@code run}
|
||||
* method when dispatched. If notifier is non-{@code null},
|
||||
* {@code notifyAll} will be called on it immediately after
|
||||
* {@code run} has returned or thrown an exception.
|
||||
* <p>This method throws an
|
||||
* <code>IllegalArgumentException</code> if <code>source</code>
|
||||
* is <code>null</code>.
|
||||
* {@code IllegalArgumentException} if {@code source}
|
||||
* is {@code null}.
|
||||
*
|
||||
* @param source The <code>Object</code> that originated
|
||||
* @param source The {@code Object} that originated
|
||||
* the event
|
||||
* @param id An integer indicating the type of event.
|
||||
* For information on allowable values, see
|
||||
* the class description for {@link InvocationEvent}
|
||||
* @param runnable The <code>Runnable</code> whose
|
||||
* <code>run</code> method will be executed
|
||||
* @param notifier The <code>Object</code> whose <code>notifyAll</code>
|
||||
* @param runnable The {@code Runnable} whose
|
||||
* {@code run} method will be executed
|
||||
* @param notifier The {@code Object} whose {@code notifyAll}
|
||||
* method will be called after
|
||||
* <code>Runnable.run</code> has returned or
|
||||
* {@code Runnable.run} has returned or
|
||||
* thrown an exception or after the event was
|
||||
* disposed
|
||||
* @param catchThrowables Specifies whether <code>dispatch</code>
|
||||
* @param catchThrowables Specifies whether {@code dispatch}
|
||||
* should catch Throwable when executing the
|
||||
* <code>Runnable</code>'s <code>run</code>
|
||||
* {@code Runnable}'s {@code run}
|
||||
* method, or should instead propagate those
|
||||
* Throwables to the EventDispatchThread's
|
||||
* dispatch loop
|
||||
* @throws IllegalArgumentException if <code>source</code> is null
|
||||
* @throws IllegalArgumentException if {@code source} is null
|
||||
* @see #getSource()
|
||||
* @see #getID()
|
||||
*/
|
||||
@ -289,8 +291,8 @@ public class InvocationEvent extends AWTEvent implements ActiveEvent {
|
||||
this.when = System.currentTimeMillis();
|
||||
}
|
||||
/**
|
||||
* Executes the Runnable's <code>run()</code> method and notifies the
|
||||
* notifier (if any) when <code>run()</code> has returned or thrown an exception.
|
||||
* Executes the Runnable's {@code run()} method and notifies the
|
||||
* notifier (if any) when {@code run()} has returned or thrown an exception.
|
||||
*
|
||||
* @see #isDispatched
|
||||
*/
|
||||
@ -316,8 +318,8 @@ public class InvocationEvent extends AWTEvent implements ActiveEvent {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns any Exception caught while executing the Runnable's <code>run()
|
||||
* </code> method.
|
||||
* Returns any Exception caught while executing
|
||||
* the Runnable's {@code run()} method.
|
||||
*
|
||||
* @return A reference to the Exception if one was thrown; null if no
|
||||
* Exception was thrown or if this InvocationEvent does not
|
||||
@ -328,8 +330,8 @@ public class InvocationEvent extends AWTEvent implements ActiveEvent {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns any Throwable caught while executing the Runnable's <code>run()
|
||||
* </code> method.
|
||||
* Returns any Throwable caught while executing
|
||||
* the Runnable's {@code run()} method.
|
||||
*
|
||||
* @return A reference to the Throwable if one was thrown; null if no
|
||||
* Throwable was thrown or if this InvocationEvent does not
|
||||
|
||||
@ -78,26 +78,26 @@ import sun.awt.SunToolkit;
|
||||
* </ul>
|
||||
* </ul>
|
||||
* <P>
|
||||
* A <code>MouseEvent</code> object is passed to every
|
||||
* <code>MouseListener</code>
|
||||
* or <code>MouseAdapter</code> object which is registered to receive
|
||||
* A {@code MouseEvent} object is passed to every
|
||||
* {@code MouseListener}
|
||||
* or {@code MouseAdapter} object which is registered to receive
|
||||
* the "interesting" mouse events using the component's
|
||||
* <code>addMouseListener</code> method.
|
||||
* (<code>MouseAdapter</code> objects implement the
|
||||
* <code>MouseListener</code> interface.) Each such listener object
|
||||
* gets a <code>MouseEvent</code> containing the mouse event.
|
||||
* {@code addMouseListener} method.
|
||||
* ({@code MouseAdapter} objects implement the
|
||||
* {@code MouseListener} interface.) Each such listener object
|
||||
* gets a {@code MouseEvent} containing the mouse event.
|
||||
* <P>
|
||||
* A <code>MouseEvent</code> object is also passed to every
|
||||
* <code>MouseMotionListener</code> or
|
||||
* <code>MouseMotionAdapter</code> object which is registered to receive
|
||||
* A {@code MouseEvent} object is also passed to every
|
||||
* {@code MouseMotionListener} or
|
||||
* {@code MouseMotionAdapter} object which is registered to receive
|
||||
* mouse motion events using the component's
|
||||
* <code>addMouseMotionListener</code>
|
||||
* method. (<code>MouseMotionAdapter</code> objects implement the
|
||||
* <code>MouseMotionListener</code> interface.) Each such listener object
|
||||
* gets a <code>MouseEvent</code> containing the mouse motion event.
|
||||
* {@code addMouseMotionListener}
|
||||
* method. ({@code MouseMotionAdapter} objects implement the
|
||||
* {@code MouseMotionListener} interface.) Each such listener object
|
||||
* gets a {@code MouseEvent} containing the mouse motion event.
|
||||
* <P>
|
||||
* When a mouse button is clicked, events are generated and sent to the
|
||||
* registered <code>MouseListener</code>s.
|
||||
* registered {@code MouseListener}s.
|
||||
* The state of modal keys can be retrieved using {@link InputEvent#getModifiers}
|
||||
* and {@link InputEvent#getModifiersEx}.
|
||||
* The button mask returned by {@link InputEvent#getModifiers} reflects
|
||||
@ -111,31 +111,31 @@ import sun.awt.SunToolkit;
|
||||
* <P>
|
||||
* For example, if the first mouse button is pressed, events are sent in the
|
||||
* following order:
|
||||
* <PRE>
|
||||
* <b >id </b > <b >modifiers </b > <b >button </b >
|
||||
* <code>MOUSE_PRESSED</code>: <code>BUTTON1_MASK</code> <code>BUTTON1</code>
|
||||
* <code>MOUSE_RELEASED</code>: <code>BUTTON1_MASK</code> <code>BUTTON1</code>
|
||||
* <code>MOUSE_CLICKED</code>: <code>BUTTON1_MASK</code> <code>BUTTON1</code>
|
||||
* </PRE>
|
||||
* <pre><b>
|
||||
* id modifiers button</b>{@code
|
||||
* MOUSE_PRESSED: BUTTON1_MASK BUTTON1
|
||||
* MOUSE_RELEASED: BUTTON1_MASK BUTTON1
|
||||
* MOUSE_CLICKED: BUTTON1_MASK BUTTON1
|
||||
* }</pre>
|
||||
* When multiple mouse buttons are pressed, each press, release, and click
|
||||
* results in a separate event.
|
||||
* <P>
|
||||
* For example, if the user presses <b>button 1</b> followed by
|
||||
* <b>button 2</b>, and then releases them in the same order,
|
||||
* the following sequence of events is generated:
|
||||
* <PRE>
|
||||
* <b >id </b > <b >modifiers </b > <b >button </b >
|
||||
* <code>MOUSE_PRESSED</code>: <code>BUTTON1_MASK</code> <code>BUTTON1</code>
|
||||
* <code>MOUSE_PRESSED</code>: <code>BUTTON2_MASK</code> <code>BUTTON2</code>
|
||||
* <code>MOUSE_RELEASED</code>: <code>BUTTON1_MASK</code> <code>BUTTON1</code>
|
||||
* <code>MOUSE_CLICKED</code>: <code>BUTTON1_MASK</code> <code>BUTTON1</code>
|
||||
* <code>MOUSE_RELEASED</code>: <code>BUTTON2_MASK</code> <code>BUTTON2</code>
|
||||
* <code>MOUSE_CLICKED</code>: <code>BUTTON2_MASK</code> <code>BUTTON2</code>
|
||||
* </PRE>
|
||||
* <pre><b>
|
||||
* id modifiers button</b>{@code
|
||||
* MOUSE_PRESSED: BUTTON1_MASK BUTTON1
|
||||
* MOUSE_PRESSED: BUTTON2_MASK BUTTON2
|
||||
* MOUSE_RELEASED: BUTTON1_MASK BUTTON1
|
||||
* MOUSE_CLICKED: BUTTON1_MASK BUTTON1
|
||||
* MOUSE_RELEASED: BUTTON2_MASK BUTTON2
|
||||
* MOUSE_CLICKED: BUTTON2_MASK BUTTON2
|
||||
* }</pre>
|
||||
* If <b>button 2</b> is released first, the
|
||||
* <code>MOUSE_RELEASED</code>/<code>MOUSE_CLICKED</code> pair
|
||||
* for <code>BUTTON2_MASK</code> arrives first,
|
||||
* followed by the pair for <code>BUTTON1_MASK</code>.
|
||||
* {@code MOUSE_RELEASED}/{@code MOUSE_CLICKED} pair
|
||||
* for {@code BUTTON2_MASK} arrives first,
|
||||
* followed by the pair for {@code BUTTON1_MASK}.
|
||||
* <p>
|
||||
* Some extra mouse buttons are added to extend the standard set of buttons
|
||||
* represented by the following constants:{@code BUTTON1}, {@code BUTTON2}, and {@code BUTTON3}.
|
||||
@ -154,20 +154,20 @@ import sun.awt.SunToolkit;
|
||||
* Drag&Drop operation.
|
||||
*
|
||||
* In a multi-screen environment mouse drag events are delivered to the
|
||||
* <code>Component</code> even if the mouse position is outside the bounds of the
|
||||
* <code>GraphicsConfiguration</code> associated with that
|
||||
* <code>Component</code>. However, the reported position for mouse drag events
|
||||
* {@code Component} even if the mouse position is outside the bounds of the
|
||||
* {@code GraphicsConfiguration} associated with that
|
||||
* {@code Component}. However, the reported position for mouse drag events
|
||||
* in this case may differ from the actual mouse position:
|
||||
* <ul>
|
||||
* <li>In a multi-screen environment without a virtual device:
|
||||
* <br>
|
||||
* The reported coordinates for mouse drag events are clipped to fit within the
|
||||
* bounds of the <code>GraphicsConfiguration</code> associated with
|
||||
* the <code>Component</code>.
|
||||
* bounds of the {@code GraphicsConfiguration} associated with
|
||||
* the {@code Component}.
|
||||
* <li>In a multi-screen environment with a virtual device:
|
||||
* <br>
|
||||
* The reported coordinates for mouse drag events are clipped to fit within the
|
||||
* bounds of the virtual device associated with the <code>Component</code>.
|
||||
* bounds of the virtual device associated with the {@code Component}.
|
||||
* </ul>
|
||||
* <p>
|
||||
* An unspecified behavior will be caused if the {@code id} parameter
|
||||
@ -200,51 +200,51 @@ public class MouseEvent extends InputEvent {
|
||||
public static final int MOUSE_LAST = 507;
|
||||
|
||||
/**
|
||||
* The "mouse clicked" event. This <code>MouseEvent</code>
|
||||
* The "mouse clicked" event. This {@code MouseEvent}
|
||||
* occurs when a mouse button is pressed and released.
|
||||
*/
|
||||
public static final int MOUSE_CLICKED = MOUSE_FIRST;
|
||||
|
||||
/**
|
||||
* The "mouse pressed" event. This <code>MouseEvent</code>
|
||||
* The "mouse pressed" event. This {@code MouseEvent}
|
||||
* occurs when a mouse button is pushed down.
|
||||
*/
|
||||
public static final int MOUSE_PRESSED = 1 + MOUSE_FIRST; //Event.MOUSE_DOWN
|
||||
|
||||
/**
|
||||
* The "mouse released" event. This <code>MouseEvent</code>
|
||||
* The "mouse released" event. This {@code MouseEvent}
|
||||
* occurs when a mouse button is let up.
|
||||
*/
|
||||
public static final int MOUSE_RELEASED = 2 + MOUSE_FIRST; //Event.MOUSE_UP
|
||||
|
||||
/**
|
||||
* The "mouse moved" event. This <code>MouseEvent</code>
|
||||
* The "mouse moved" event. This {@code MouseEvent}
|
||||
* occurs when the mouse position changes.
|
||||
*/
|
||||
public static final int MOUSE_MOVED = 3 + MOUSE_FIRST; //Event.MOUSE_MOVE
|
||||
|
||||
/**
|
||||
* The "mouse entered" event. This <code>MouseEvent</code>
|
||||
* The "mouse entered" event. This {@code MouseEvent}
|
||||
* occurs when the mouse cursor enters the unobscured part of component's
|
||||
* geometry.
|
||||
*/
|
||||
public static final int MOUSE_ENTERED = 4 + MOUSE_FIRST; //Event.MOUSE_ENTER
|
||||
|
||||
/**
|
||||
* The "mouse exited" event. This <code>MouseEvent</code>
|
||||
* The "mouse exited" event. This {@code MouseEvent}
|
||||
* occurs when the mouse cursor exits the unobscured part of component's
|
||||
* geometry.
|
||||
*/
|
||||
public static final int MOUSE_EXITED = 5 + MOUSE_FIRST; //Event.MOUSE_EXIT
|
||||
|
||||
/**
|
||||
* The "mouse dragged" event. This <code>MouseEvent</code>
|
||||
* The "mouse dragged" event. This {@code MouseEvent}
|
||||
* occurs when the mouse position changes while a mouse button is pressed.
|
||||
*/
|
||||
public static final int MOUSE_DRAGGED = 6 + MOUSE_FIRST; //Event.MOUSE_DRAG
|
||||
|
||||
/**
|
||||
* The "mouse wheel" event. This is the only <code>MouseWheelEvent</code>.
|
||||
* The "mouse wheel" event. This is the only {@code MouseWheelEvent}.
|
||||
* It occurs when a mouse equipped with a wheel has its wheel rotated.
|
||||
* @since 1.4
|
||||
*/
|
||||
@ -320,10 +320,10 @@ public class MouseEvent extends InputEvent {
|
||||
* Indicates the number of quick consecutive clicks of
|
||||
* a mouse button.
|
||||
* clickCount will be valid for only three mouse events :<BR>
|
||||
* <code>MOUSE_CLICKED</code>,
|
||||
* <code>MOUSE_PRESSED</code> and
|
||||
* <code>MOUSE_RELEASED</code>.
|
||||
* For the above, the <code>clickCount</code> will be at least 1.
|
||||
* {@code MOUSE_CLICKED},
|
||||
* {@code MOUSE_PRESSED} and
|
||||
* {@code MOUSE_RELEASED}.
|
||||
* For the above, the {@code clickCount} will be at least 1.
|
||||
* For all other events the count will be 0.
|
||||
*
|
||||
* @serial
|
||||
@ -365,8 +365,8 @@ public class MouseEvent extends InputEvent {
|
||||
/**
|
||||
* A property used to indicate whether a Popup Menu
|
||||
* should appear with a certain gestures.
|
||||
* If <code>popupTrigger</code> = <code>false</code>,
|
||||
* no popup menu should appear. If it is <code>true</code>
|
||||
* If {@code popupTrigger} = {@code false},
|
||||
* no popup menu should appear. If it is {@code true}
|
||||
* then a popup menu should appear.
|
||||
*
|
||||
* @serial
|
||||
@ -415,7 +415,7 @@ public class MouseEvent extends InputEvent {
|
||||
* Otherwise, these coordinates are relative to the coordinate system
|
||||
* associated with the Component's GraphicsConfiguration.
|
||||
*
|
||||
* @return a <code>Point</code> object containing the absolute x
|
||||
* @return a {@code Point} object containing the absolute x
|
||||
* and y coordinates.
|
||||
*
|
||||
* @see java.awt.GraphicsConfiguration
|
||||
@ -460,7 +460,7 @@ public class MouseEvent extends InputEvent {
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a <code>MouseEvent</code> object with the
|
||||
* Constructs a {@code MouseEvent} object with the
|
||||
* specified source component,
|
||||
* type, time, modifiers, coordinates, click count, popupTrigger flag,
|
||||
* and button number.
|
||||
@ -469,19 +469,19 @@ public class MouseEvent extends InputEvent {
|
||||
* as by using more than one of the old _MASKs, or modifier/button
|
||||
* values which don't match) results in unspecified behavior.
|
||||
* An invocation of the form
|
||||
* <tt>MouseEvent(source, id, when, modifiers, x, y, clickCount, popupTrigger, button)</tt>
|
||||
* {@code MouseEvent(source, id, when, modifiers, x, y, clickCount, popupTrigger, button)}
|
||||
* behaves in exactly the same way as the invocation
|
||||
* <tt> {@link #MouseEvent(Component, int, long, int, int, int,
|
||||
* int, int, int, boolean, int) MouseEvent}(source, id, when, modifiers,
|
||||
* x, y, xAbs, yAbs, clickCount, popupTrigger, button)</tt>
|
||||
* {@link #MouseEvent(Component, int, long, int, int, int,
|
||||
* int, int, int, boolean, int) MouseEvent(source, id, when, modifiers,
|
||||
* x, y, xAbs, yAbs, clickCount, popupTrigger, button)}
|
||||
* where xAbs and yAbs defines as source's location on screen plus
|
||||
* relative coordinates x and y.
|
||||
* xAbs and yAbs are set to zero if the source is not showing.
|
||||
* This method throws an
|
||||
* <code>IllegalArgumentException</code> if <code>source</code>
|
||||
* is <code>null</code>.
|
||||
* {@code IllegalArgumentException} if {@code source}
|
||||
* is {@code null}.
|
||||
*
|
||||
* @param source The <code>Component</code> that originated the event
|
||||
* @param source The {@code Component} that originated the event
|
||||
* @param id An integer indicating the type of event.
|
||||
* For information on allowable values, see
|
||||
* the class description for {@link MouseEvent}
|
||||
@ -527,16 +527,16 @@ public class MouseEvent extends InputEvent {
|
||||
* if the mouse has more than three buttons.
|
||||
* </ul>
|
||||
* @throws IllegalArgumentException if {@code button} is less then zero
|
||||
* @throws IllegalArgumentException if <code>source</code> is null
|
||||
* @throws IllegalArgumentException if {@code source} is null
|
||||
* @throws IllegalArgumentException if {@code button} is greater then BUTTON3 and the support for extended mouse buttons is
|
||||
* {@link Toolkit#areExtraMouseButtonsEnabled() disabled} by Java
|
||||
* @throws IllegalArgumentException if {@code button} is greater then the
|
||||
* {@link java.awt.MouseInfo#getNumberOfButtons() current number of buttons} and the support
|
||||
* for extended mouse buttons is {@link Toolkit#areExtraMouseButtonsEnabled() enabled}
|
||||
* by Java
|
||||
* @throws IllegalArgumentException if an invalid <code>button</code>
|
||||
* @throws IllegalArgumentException if an invalid {@code button}
|
||||
* value is passed in
|
||||
* @throws IllegalArgumentException if <code>source</code> is null
|
||||
* @throws IllegalArgumentException if {@code source} is null
|
||||
* @see #getSource()
|
||||
* @see #getID()
|
||||
* @see #getWhen()
|
||||
@ -565,22 +565,22 @@ public class MouseEvent extends InputEvent {
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a <code>MouseEvent</code> object with the
|
||||
* Constructs a {@code MouseEvent} object with the
|
||||
* specified source component,
|
||||
* type, modifiers, coordinates, click count, and popupTrigger flag.
|
||||
* An invocation of the form
|
||||
* <tt>MouseEvent(source, id, when, modifiers, x, y, clickCount, popupTrigger)</tt>
|
||||
* {@code MouseEvent(source, id, when, modifiers, x, y, clickCount, popupTrigger)}
|
||||
* behaves in exactly the same way as the invocation
|
||||
* <tt> {@link #MouseEvent(Component, int, long, int, int, int,
|
||||
* int, int, int, boolean, int) MouseEvent}(source, id, when, modifiers,
|
||||
* x, y, xAbs, yAbs, clickCount, popupTrigger, MouseEvent.NOBUTTON)</tt>
|
||||
* {@link #MouseEvent(Component, int, long, int, int, int,
|
||||
* int, int, int, boolean, int) MouseEvent(source, id, when, modifiers,
|
||||
* x, y, xAbs, yAbs, clickCount, popupTrigger, MouseEvent.NOBUTTON)}
|
||||
* where xAbs and yAbs defines as source's location on screen plus
|
||||
* relative coordinates x and y.
|
||||
* xAbs and yAbs are set to zero if the source is not showing.
|
||||
* This method throws an <code>IllegalArgumentException</code>
|
||||
* if <code>source</code> is <code>null</code>.
|
||||
* This method throws an {@code IllegalArgumentException}
|
||||
* if {@code source} is {@code null}.
|
||||
*
|
||||
* @param source The <code>Component</code> that originated the event
|
||||
* @param source The {@code Component} that originated the event
|
||||
* @param id An integer indicating the type of event.
|
||||
* For information on allowable values, see
|
||||
* the class description for {@link MouseEvent}
|
||||
@ -605,7 +605,7 @@ public class MouseEvent extends InputEvent {
|
||||
* is not recommended
|
||||
* @param popupTrigger A boolean that equals {@code true} if this event
|
||||
* is a trigger for a popup menu
|
||||
* @throws IllegalArgumentException if <code>source</code> is null
|
||||
* @throws IllegalArgumentException if {@code source} is null
|
||||
* @see #getSource()
|
||||
* @see #getID()
|
||||
* @see #getWhen()
|
||||
@ -637,7 +637,7 @@ public class MouseEvent extends InputEvent {
|
||||
}
|
||||
|
||||
/**
|
||||
* Constructs a <code>MouseEvent</code> object with the
|
||||
* Constructs a {@code MouseEvent} object with the
|
||||
* specified source component,
|
||||
* type, time, modifiers, coordinates, absolute coordinates, click count, popupTrigger flag,
|
||||
* and button number.
|
||||
@ -649,10 +649,10 @@ public class MouseEvent extends InputEvent {
|
||||
* passed to the constructor, the mouse event instance is still
|
||||
* created and no exception is thrown.
|
||||
* This method throws an
|
||||
* <code>IllegalArgumentException</code> if <code>source</code>
|
||||
* is <code>null</code>.
|
||||
* {@code IllegalArgumentException} if {@code source}
|
||||
* is {@code null}.
|
||||
*
|
||||
* @param source The <code>Component</code> that originated the event
|
||||
* @param source The {@code Component} that originated the event
|
||||
* @param id An integer indicating the type of event.
|
||||
* For information on allowable values, see
|
||||
* the class description for {@link MouseEvent}
|
||||
@ -702,16 +702,16 @@ public class MouseEvent extends InputEvent {
|
||||
* if the mouse has more than three buttons.
|
||||
* </ul>
|
||||
* @throws IllegalArgumentException if {@code button} is less then zero
|
||||
* @throws IllegalArgumentException if <code>source</code> is null
|
||||
* @throws IllegalArgumentException if {@code source} is null
|
||||
* @throws IllegalArgumentException if {@code button} is greater then BUTTON3 and the support for extended mouse buttons is
|
||||
* {@link Toolkit#areExtraMouseButtonsEnabled() disabled} by Java
|
||||
* @throws IllegalArgumentException if {@code button} is greater then the
|
||||
* {@link java.awt.MouseInfo#getNumberOfButtons() current number of buttons} and the support
|
||||
* for extended mouse buttons is {@link Toolkit#areExtraMouseButtonsEnabled() enabled}
|
||||
* by Java
|
||||
* @throws IllegalArgumentException if an invalid <code>button</code>
|
||||
* @throws IllegalArgumentException if an invalid {@code button}
|
||||
* value is passed in
|
||||
* @throws IllegalArgumentException if <code>source</code> is null
|
||||
* @throws IllegalArgumentException if {@code source} is null
|
||||
* @see #getSource()
|
||||
* @see #getID()
|
||||
* @see #getWhen()
|
||||
@ -803,7 +803,7 @@ public class MouseEvent extends InputEvent {
|
||||
/**
|
||||
* Returns the x,y position of the event relative to the source component.
|
||||
*
|
||||
* @return a <code>Point</code> object containing the x and y coordinates
|
||||
* @return a {@code Point} object containing the x and y coordinates
|
||||
* relative to the source component
|
||||
*
|
||||
*/
|
||||
@ -819,7 +819,7 @@ public class MouseEvent extends InputEvent {
|
||||
|
||||
/**
|
||||
* Translates the event's coordinates to a new position
|
||||
* by adding specified <code>x</code> (horizontal) and <code>y</code>
|
||||
* by adding specified {@code x} (horizontal) and {@code y}
|
||||
* (vertical) offsets.
|
||||
*
|
||||
* @param x the horizontal x value to add to the current x
|
||||
@ -901,9 +901,9 @@ public class MouseEvent extends InputEvent {
|
||||
* Returns whether or not this mouse event is the popup menu
|
||||
* trigger event for the platform.
|
||||
* <p><b>Note</b>: Popup menus are triggered differently
|
||||
* on different systems. Therefore, <code>isPopupTrigger</code>
|
||||
* should be checked in both <code>mousePressed</code>
|
||||
* and <code>mouseReleased</code>
|
||||
* on different systems. Therefore, {@code isPopupTrigger}
|
||||
* should be checked in both {@code mousePressed}
|
||||
* and {@code mouseReleased}
|
||||
* for proper cross-platform functionality.
|
||||
*
|
||||
* @return boolean, true if this event is the popup menu trigger
|
||||
@ -914,16 +914,16 @@ public class MouseEvent extends InputEvent {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns a <code>String</code> instance describing the modifier keys and
|
||||
* Returns a {@code String} instance describing the modifier keys and
|
||||
* mouse buttons that were down during the event, such as "Shift",
|
||||
* or "Ctrl+Shift". These strings can be localized by changing
|
||||
* the <code>awt.properties</code> file.
|
||||
* the {@code awt.properties} file.
|
||||
* <p>
|
||||
* Note that the <code>InputEvent.ALT_MASK</code> and
|
||||
* <code>InputEvent.BUTTON2_MASK</code> have equal values,
|
||||
* Note that the {@code InputEvent.ALT_MASK} and
|
||||
* {@code InputEvent.BUTTON2_MASK} have equal values,
|
||||
* so the "Alt" string is returned for both modifiers. Likewise,
|
||||
* the <code>InputEvent.META_MASK</code> and
|
||||
* <code>InputEvent.BUTTON3_MASK</code> have equal values,
|
||||
* the {@code InputEvent.META_MASK} and
|
||||
* {@code InputEvent.BUTTON3_MASK} have equal values,
|
||||
* so the "Meta" string is returned for both modifiers.
|
||||
* <p>
|
||||
* Note that passing negative parameter is incorrect,
|
||||
|
||||
@ -99,7 +99,7 @@ public class PixelGrabber implements ImageConsumer {
|
||||
* The pixels are stored into the array in the default RGB ColorModel.
|
||||
* The RGB data for pixel (i, j) where (i, j) is inside the rectangle
|
||||
* (x, y, w, h) is stored in the array at
|
||||
* <tt>pix[(j - y) * scansize + (i - x) + off]</tt>.
|
||||
* {@code pix[(j - y) * scansize + (i - x) + off]}.
|
||||
* @see ColorModel#getRGBdefault
|
||||
* @param img the image to retrieve pixels from
|
||||
* @param x the x coordinate of the upper left corner of the rectangle
|
||||
@ -127,8 +127,8 @@ public class PixelGrabber implements ImageConsumer {
|
||||
* The pixels are stored into the array in the default RGB ColorModel.
|
||||
* The RGB data for pixel (i, j) where (i, j) is inside the rectangle
|
||||
* (x, y, w, h) is stored in the array at
|
||||
* <tt>pix[(j - y) * scansize + (i - x) + off]</tt>.
|
||||
* @param ip the <code>ImageProducer</code> that produces the
|
||||
* {@code pix[(j - y) * scansize + (i - x) + off]}.
|
||||
* @param ip the {@code ImageProducer} that produces the
|
||||
* image from which to retrieve pixels
|
||||
* @param x the x coordinate of the upper left corner of the rectangle
|
||||
* of pixels to retrieve from the image, relative to the default
|
||||
@ -231,13 +231,13 @@ public class PixelGrabber implements ImageConsumer {
|
||||
* wait for all of the pixels in the rectangle of interest to be
|
||||
* delivered or until the specified timeout has elapsed. This method
|
||||
* behaves in the following ways, depending on the value of
|
||||
* <code>ms</code>:
|
||||
* {@code ms}:
|
||||
* <ul>
|
||||
* <li> If {@code ms == 0}, waits until all pixels are delivered
|
||||
* <li> If {@code ms > 0}, waits until all pixels are delivered
|
||||
* as timeout expires.
|
||||
* <li> If {@code ms < 0}, returns <code>true</code> if all pixels
|
||||
* are grabbed, <code>false</code> otherwise and does not wait.
|
||||
* <li> If {@code ms < 0}, returns {@code true} if all pixels
|
||||
* are grabbed, {@code false} otherwise and does not wait.
|
||||
* </ul>
|
||||
* @param ms the number of milliseconds to wait for the image pixels
|
||||
* to arrive before timing out
|
||||
@ -420,7 +420,7 @@ public class PixelGrabber implements ImageConsumer {
|
||||
* this class to retrieve pixels from an image should avoid calling
|
||||
* this method directly since that operation could result in problems
|
||||
* with retrieving the requested pixels.
|
||||
* @param model the specified <code>ColorModel</code>
|
||||
* @param model the specified {@code ColorModel}
|
||||
* @see #getColorModel
|
||||
*/
|
||||
public void setColorModel(ColorModel model) {
|
||||
@ -461,7 +461,7 @@ public class PixelGrabber implements ImageConsumer {
|
||||
* of the area of pixels to be set
|
||||
* @param srcW the width of the area of pixels
|
||||
* @param srcH the height of the area of pixels
|
||||
* @param model the specified <code>ColorModel</code>
|
||||
* @param model the specified {@code ColorModel}
|
||||
* @param pixels the array of pixels
|
||||
* @param srcOff the offset into the pixels array
|
||||
* @param srcScan the distance from one row of pixels to the next
|
||||
@ -548,7 +548,7 @@ public class PixelGrabber implements ImageConsumer {
|
||||
* of the area of pixels to be set
|
||||
* @param srcW the width of the area of pixels
|
||||
* @param srcH the height of the area of pixels
|
||||
* @param model the specified <code>ColorModel</code>
|
||||
* @param model the specified {@code ColorModel}
|
||||
* @param pixels the array of pixels
|
||||
* @param srcOff the offset into the pixels array
|
||||
* @param srcScan the distance from one row of pixels to the next
|
||||
@ -658,7 +658,7 @@ public class PixelGrabber implements ImageConsumer {
|
||||
* Returns the status of the pixels. The ImageObserver flags
|
||||
* representing the available pixel information are returned.
|
||||
* This method and {@link #getStatus() getStatus} have the
|
||||
* same implementation, but <code>getStatus</code> is the
|
||||
* same implementation, but {@code getStatus} is the
|
||||
* preferred method because it conforms to the convention of
|
||||
* naming information-retrieval methods with the form
|
||||
* "getXXX".
|
||||
|
||||
@ -54,16 +54,16 @@ public class EventSetDescriptor extends FeatureDescriptor {
|
||||
private boolean inDefaultEventSet = true;
|
||||
|
||||
/**
|
||||
* Creates an <TT>EventSetDescriptor</TT> assuming that you are
|
||||
* Creates an {@code EventSetDescriptor} assuming that you are
|
||||
* following the most simple standard design pattern where a named
|
||||
* event "fred" is (1) delivered as a call on the single method of
|
||||
* event "fred" is (1) delivered as a call on the single method of
|
||||
* interface FredListener, (2) has a single argument of type FredEvent,
|
||||
* and (3) where the FredListener may be registered with a call on an
|
||||
* addFredListener method of the source component and removed with a
|
||||
* call on a removeFredListener method.
|
||||
*
|
||||
* @param sourceClass The class firing the event.
|
||||
* @param eventSetName The programmatic name of the event. E.g. "fred".
|
||||
* @param eventSetName The programmatic name of the event. E.g. "fred".
|
||||
* Note that this should normally start with a lower-case character.
|
||||
* @param listenerType The target interface that events
|
||||
* will get delivered to.
|
||||
@ -100,7 +100,7 @@ public class EventSetDescriptor extends FeatureDescriptor {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an <TT>EventSetDescriptor</TT> from scratch using
|
||||
* Creates an {@code EventSetDescriptor} from scratch using
|
||||
* string names.
|
||||
*
|
||||
* @param sourceClass The class firing the event.
|
||||
@ -199,8 +199,8 @@ public class EventSetDescriptor extends FeatureDescriptor {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an <TT>EventSetDescriptor</TT> from scratch using
|
||||
* <TT>java.lang.reflect.Method</TT> and <TT>java.lang.Class</TT> objects.
|
||||
* Creates an {@code EventSetDescriptor} from scratch using
|
||||
* {@code java.lang.reflect.Method} and {@code java.lang.Class} objects.
|
||||
*
|
||||
* @param eventSetName The programmatic name of the event set.
|
||||
* @param listenerType The Class for the listener interface.
|
||||
@ -267,8 +267,8 @@ public class EventSetDescriptor extends FeatureDescriptor {
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an <TT>EventSetDescriptor</TT> from scratch using
|
||||
* <TT>java.lang.reflect.MethodDescriptor</TT> and <TT>java.lang.Class</TT>
|
||||
* Creates an {@code EventSetDescriptor} from scratch using
|
||||
* {@code java.lang.reflect.MethodDescriptor} and {@code java.lang.Class}
|
||||
* objects.
|
||||
*
|
||||
* @param eventSetName The programmatic name of the event set.
|
||||
@ -299,7 +299,7 @@ public class EventSetDescriptor extends FeatureDescriptor {
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the <TT>Class</TT> object for the target interface.
|
||||
* Gets the {@code Class} object for the target interface.
|
||||
*
|
||||
* @return The Class object for the target interface that will
|
||||
* get invoked when the event is fired.
|
||||
@ -317,7 +317,7 @@ public class EventSetDescriptor extends FeatureDescriptor {
|
||||
/**
|
||||
* Gets the methods of the target listener interface.
|
||||
*
|
||||
* @return An array of <TT>Method</TT> objects for the target methods
|
||||
* @return An array of {@code Method} objects for the target methods
|
||||
* within the target listener interface that will get called when
|
||||
* events are fired.
|
||||
*/
|
||||
@ -355,9 +355,9 @@ public class EventSetDescriptor extends FeatureDescriptor {
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the <code>MethodDescriptor</code>s of the target listener interface.
|
||||
* Gets the {@code MethodDescriptor}s of the target listener interface.
|
||||
*
|
||||
* @return An array of <code>MethodDescriptor</code> objects for the target methods
|
||||
* @return An array of {@code MethodDescriptor} objects for the target methods
|
||||
* within the target listener interface that will get called when
|
||||
* events are fired.
|
||||
*/
|
||||
@ -442,30 +442,30 @@ public class EventSetDescriptor extends FeatureDescriptor {
|
||||
* Normally event sources are multicast. However there are some
|
||||
* exceptions that are strictly unicast.
|
||||
*
|
||||
* @return <TT>true</TT> if the event set is unicast.
|
||||
* Defaults to <TT>false</TT>.
|
||||
* @return {@code true} if the event set is unicast.
|
||||
* Defaults to {@code false}.
|
||||
*/
|
||||
public boolean isUnicast() {
|
||||
return unicast;
|
||||
}
|
||||
|
||||
/**
|
||||
* Marks an event set as being in the "default" set (or not).
|
||||
* By default this is <TT>true</TT>.
|
||||
* Marks an event set as being in the "default" set (or not).
|
||||
* By default this is {@code true}.
|
||||
*
|
||||
* @param inDefaultEventSet <code>true</code> if the event set is in
|
||||
* the "default" set,
|
||||
* <code>false</code> if not
|
||||
* @param inDefaultEventSet {@code true} if the event set is in
|
||||
* the "default" set,
|
||||
* {@code false} if not
|
||||
*/
|
||||
public void setInDefaultEventSet(boolean inDefaultEventSet) {
|
||||
this.inDefaultEventSet = inDefaultEventSet;
|
||||
}
|
||||
|
||||
/**
|
||||
* Reports if an event set is in the "default" set.
|
||||
* Reports if an event set is in the "default" set.
|
||||
*
|
||||
* @return <TT>true</TT> if the event set is in
|
||||
* the "default" set. Defaults to <TT>true</TT>.
|
||||
* @return {@code true} if the event set is in
|
||||
* the "default" set. Defaults to {@code true}.
|
||||
*/
|
||||
public boolean isInDefaultEventSet() {
|
||||
return inDefaultEventSet;
|
||||
|
||||
@ -91,9 +91,9 @@ public class BeanContextChildSupport implements BeanContextChild, BeanContextSer
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the <code>BeanContext</code> for
|
||||
* this <code>BeanContextChildSupport</code>.
|
||||
* @param bc the new value to be assigned to the <code>BeanContext</code>
|
||||
* Sets the {@code BeanContext} for
|
||||
* this {@code BeanContextChildSupport}.
|
||||
* @param bc the new value to be assigned to the {@code BeanContext}
|
||||
* property
|
||||
* @throws PropertyVetoException if the change is rejected
|
||||
*/
|
||||
@ -137,10 +137,10 @@ public class BeanContextChildSupport implements BeanContextChild, BeanContextSer
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the nesting <code>BeanContext</code>
|
||||
* for this <code>BeanContextChildSupport</code>.
|
||||
* @return the nesting <code>BeanContext</code> for
|
||||
* this <code>BeanContextChildSupport</code>.
|
||||
* Gets the nesting {@code BeanContext}
|
||||
* for this {@code BeanContextChildSupport}.
|
||||
* @return the nesting {@code BeanContext} for
|
||||
* this {@code BeanContextChildSupport}.
|
||||
*/
|
||||
public synchronized BeanContext getBeanContext() { return beanContext; }
|
||||
|
||||
@ -149,11 +149,11 @@ public class BeanContextChildSupport implements BeanContextChild, BeanContextSer
|
||||
* The same listener object may be added more than once. For each
|
||||
* property, the listener will be invoked the number of times it was added
|
||||
* for that property.
|
||||
* If <code>name</code> or <code>pcl</code> is null, no exception is thrown
|
||||
* If {@code name} or {@code pcl} is null, no exception is thrown
|
||||
* and no action is taken.
|
||||
*
|
||||
* @param name The name of the property to listen on
|
||||
* @param pcl The <code>PropertyChangeListener</code> to be added
|
||||
* @param pcl The {@code PropertyChangeListener} to be added
|
||||
*/
|
||||
public void addPropertyChangeListener(String name, PropertyChangeListener pcl) {
|
||||
pcSupport.addPropertyChangeListener(name, pcl);
|
||||
@ -161,12 +161,12 @@ public class BeanContextChildSupport implements BeanContextChild, BeanContextSer
|
||||
|
||||
/**
|
||||
* Remove a PropertyChangeListener for a specific property.
|
||||
* If <code>pcl</code> was added more than once to the same event
|
||||
* If {@code pcl} was added more than once to the same event
|
||||
* source for the specified property, it will be notified one less time
|
||||
* after being removed.
|
||||
* If <code>name</code> is null, no exception is thrown
|
||||
* If {@code name} is null, no exception is thrown
|
||||
* and no action is taken.
|
||||
* If <code>pcl</code> is null, or was never added for the specified
|
||||
* If {@code pcl} is null, or was never added for the specified
|
||||
* property, no exception is thrown and no action is taken.
|
||||
*
|
||||
* @param name The name of the property that was listened on
|
||||
@ -181,28 +181,28 @@ public class BeanContextChildSupport implements BeanContextChild, BeanContextSer
|
||||
* The same listener object may be added more than once. For each
|
||||
* property, the listener will be invoked the number of times it was added
|
||||
* for that property.
|
||||
* If <code>name</code> or <code>vcl</code> is null, no exception is thrown
|
||||
* If {@code name} or {@code vcl} is null, no exception is thrown
|
||||
* and no action is taken.
|
||||
*
|
||||
* @param name The name of the property to listen on
|
||||
* @param vcl The <code>VetoableChangeListener</code> to be added
|
||||
* @param vcl The {@code VetoableChangeListener} to be added
|
||||
*/
|
||||
public void addVetoableChangeListener(String name, VetoableChangeListener vcl) {
|
||||
vcSupport.addVetoableChangeListener(name, vcl);
|
||||
}
|
||||
|
||||
/**
|
||||
* Removes a <code>VetoableChangeListener</code>.
|
||||
* If <code>pcl</code> was added more than once to the same event
|
||||
* Removes a {@code VetoableChangeListener}.
|
||||
* If {@code pcl} was added more than once to the same event
|
||||
* source for the specified property, it will be notified one less time
|
||||
* after being removed.
|
||||
* If <code>name</code> is null, no exception is thrown
|
||||
* If {@code name} is null, no exception is thrown
|
||||
* and no action is taken.
|
||||
* If <code>vcl</code> is null, or was never added for the specified
|
||||
* If {@code vcl} is null, or was never added for the specified
|
||||
* property, no exception is thrown and no action is taken.
|
||||
*
|
||||
* @param name The name of the property that was listened on
|
||||
* @param vcl The <code>VetoableChangeListener</code> to be removed
|
||||
* @param vcl The {@code VetoableChangeListener} to be removed
|
||||
*/
|
||||
public void removeVetoableChangeListener(String name, VetoableChangeListener vcl) {
|
||||
vcSupport.removeVetoableChangeListener(name, vcl);
|
||||
@ -213,7 +213,7 @@ public class BeanContextChildSupport implements BeanContextChild, BeanContextSer
|
||||
*
|
||||
* Subclasses may override this method in order to implement their own
|
||||
* behaviors.
|
||||
* @param bcsre The <code>BeanContextServiceRevokedEvent</code> fired as a
|
||||
* @param bcsre The {@code BeanContextServiceRevokedEvent} fired as a
|
||||
* result of a service being revoked
|
||||
*/
|
||||
public void serviceRevoked(BeanContextServiceRevokedEvent bcsre) { }
|
||||
@ -230,10 +230,10 @@ public class BeanContextChildSupport implements BeanContextChild, BeanContextSer
|
||||
public void serviceAvailable(BeanContextServiceAvailableEvent bcsae) { }
|
||||
|
||||
/**
|
||||
* Gets the <tt>BeanContextChild</tt> associated with this
|
||||
* <tt>BeanContextChildSupport</tt>.
|
||||
* Gets the {@code BeanContextChild} associated with this
|
||||
* {@code BeanContextChildSupport}.
|
||||
*
|
||||
* @return the <tt>BeanContextChild</tt> peer of this class
|
||||
* @return the {@code BeanContextChild} peer of this class
|
||||
*/
|
||||
public BeanContextChild getBeanContextChildPeer() { return beanContextChildPeer; }
|
||||
|
||||
@ -283,7 +283,7 @@ public class BeanContextChildSupport implements BeanContextChild, BeanContextSer
|
||||
* PropertyVetoException.
|
||||
* @param newValue the new value that has been requested for
|
||||
* the BeanContext property
|
||||
* @return <code>true</code> if the change operation is to be vetoed
|
||||
* @return {@code true} if the change operation is to be vetoed
|
||||
*/
|
||||
public boolean validatePendingSetBeanContext(BeanContext newValue) {
|
||||
return true;
|
||||
@ -345,20 +345,20 @@ public class BeanContextChildSupport implements BeanContextChild, BeanContextSer
|
||||
*/
|
||||
|
||||
/**
|
||||
* The <code>BeanContext</code> in which
|
||||
* this <code>BeanContextChild</code> is nested.
|
||||
* The {@code BeanContext} in which
|
||||
* this {@code BeanContextChild} is nested.
|
||||
*/
|
||||
public BeanContextChild beanContextChildPeer;
|
||||
|
||||
/**
|
||||
* The <tt>PropertyChangeSupport</tt> associated with this
|
||||
* <tt>BeanContextChildSupport</tt>.
|
||||
* The {@code PropertyChangeSupport} associated with this
|
||||
* {@code BeanContextChildSupport}.
|
||||
*/
|
||||
protected PropertyChangeSupport pcSupport;
|
||||
|
||||
/**
|
||||
* The <tt>VetoableChangeSupport</tt> associated with this
|
||||
* <tt>BeanContextChildSupport</tt>.
|
||||
* The {@code VetoableChangeSupport} associated with this
|
||||
* {@code BeanContextChildSupport}.
|
||||
*/
|
||||
protected VetoableChangeSupport vcSupport;
|
||||
|
||||
@ -369,7 +369,7 @@ public class BeanContextChildSupport implements BeanContextChild, BeanContextSer
|
||||
|
||||
/**
|
||||
* A flag indicating that there has been
|
||||
* at least one <code>PropertyChangeVetoException</code>
|
||||
* at least one {@code PropertyChangeVetoException}
|
||||
* thrown for the attempted setBeanContext operation.
|
||||
*/
|
||||
protected transient boolean rejectedSetBCOnce;
|
||||
|
||||
@ -134,10 +134,10 @@ public class BeanContextServicesSupport extends BeanContextSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the <tt>BeanContextServices</tt> associated with this
|
||||
* <tt>BeanContextServicesSupport</tt>.
|
||||
* Gets the {@code BeanContextServices} associated with this
|
||||
* {@code BeanContextServicesSupport}.
|
||||
*
|
||||
* @return the instance of <tt>BeanContext</tt>
|
||||
* @return the instance of {@code BeanContext}
|
||||
* this object is providing the implementation for.
|
||||
*/
|
||||
public BeanContextServices getBeanContextServicesPeer() {
|
||||
@ -1001,7 +1001,7 @@ public class BeanContextServicesSupport extends BeanContextSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the <tt>BeanContextServicesListener</tt> (if any) of the specified
|
||||
* Gets the {@code BeanContextServicesListener} (if any) of the specified
|
||||
* child.
|
||||
*
|
||||
* @param child the specified child
|
||||
@ -1084,7 +1084,7 @@ public class BeanContextServicesSupport extends BeanContextSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Fires a <tt>BeanContextServiceEvent</tt> notifying of a new service.
|
||||
* Fires a {@code BeanContextServiceEvent} notifying of a new service.
|
||||
* @param serviceClass the service class
|
||||
*/
|
||||
protected final void fireServiceAdded(Class<?> serviceClass) {
|
||||
@ -1094,10 +1094,10 @@ public class BeanContextServicesSupport extends BeanContextSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Fires a <tt>BeanContextServiceAvailableEvent</tt> indicating that a new
|
||||
* Fires a {@code BeanContextServiceAvailableEvent} indicating that a new
|
||||
* service has become available.
|
||||
*
|
||||
* @param bcssae the <tt>BeanContextServiceAvailableEvent</tt>
|
||||
* @param bcssae the {@code BeanContextServiceAvailableEvent}
|
||||
*/
|
||||
protected final void fireServiceAdded(BeanContextServiceAvailableEvent bcssae) {
|
||||
Object[] copy;
|
||||
@ -1110,9 +1110,9 @@ public class BeanContextServicesSupport extends BeanContextSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Fires a <tt>BeanContextServiceEvent</tt> notifying of a service being revoked.
|
||||
* Fires a {@code BeanContextServiceEvent} notifying of a service being revoked.
|
||||
*
|
||||
* @param bcsre the <tt>BeanContextServiceRevokedEvent</tt>
|
||||
* @param bcsre the {@code BeanContextServiceRevokedEvent}
|
||||
*/
|
||||
protected final void fireServiceRevoked(BeanContextServiceRevokedEvent bcsre) {
|
||||
Object[] copy;
|
||||
@ -1125,7 +1125,7 @@ public class BeanContextServicesSupport extends BeanContextSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Fires a <tt>BeanContextServiceRevokedEvent</tt>
|
||||
* Fires a {@code BeanContextServiceRevokedEvent}
|
||||
* indicating that a particular service is
|
||||
* no longer available.
|
||||
* @param serviceClass the service class
|
||||
@ -1235,25 +1235,25 @@ public class BeanContextServicesSupport extends BeanContextSupport
|
||||
*/
|
||||
|
||||
/**
|
||||
* all accesses to the <code> protected transient HashMap services </code>
|
||||
* all accesses to the {@code protected transient HashMap services}
|
||||
* field should be synchronized on that object
|
||||
*/
|
||||
protected transient HashMap<Object, BCSSServiceProvider> services;
|
||||
|
||||
/**
|
||||
* The number of instances of a serializable <tt>BeanContextServceProvider</tt>.
|
||||
* The number of instances of a serializable {@code BeanContextServceProvider}.
|
||||
*/
|
||||
protected transient int serializable = 0;
|
||||
|
||||
|
||||
/**
|
||||
* Delegate for the <tt>BeanContextServiceProvider</tt>.
|
||||
* Delegate for the {@code BeanContextServiceProvider}.
|
||||
*/
|
||||
protected transient BCSSProxyServiceProvider proxy;
|
||||
|
||||
|
||||
/**
|
||||
* List of <tt>BeanContextServicesListener</tt> objects.
|
||||
* List of {@code BeanContextServicesListener} objects.
|
||||
*/
|
||||
protected transient ArrayList<BeanContextServicesListener> bcsListeners;
|
||||
}
|
||||
|
||||
@ -85,16 +85,16 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
* Construct a BeanContextSupport instance
|
||||
*
|
||||
*
|
||||
* @param peer The peer <tt>BeanContext</tt> we are
|
||||
* @param peer The peer {@code BeanContext} we are
|
||||
* supplying an implementation for,
|
||||
* or <tt>null</tt>
|
||||
* or {@code null}
|
||||
* if this object is its own peer
|
||||
* @param lcle The current Locale for this BeanContext. If
|
||||
* <tt>lcle</tt> is <tt>null</tt>, the default locale
|
||||
* is assigned to the <tt>BeanContext</tt> instance.
|
||||
* {@code lcle} is {@code null}, the default locale
|
||||
* is assigned to the {@code BeanContext} instance.
|
||||
* @param dTime The initial state,
|
||||
* <tt>true</tt> if in design mode,
|
||||
* <tt>false</tt> if runtime.
|
||||
* {@code true} if in design mode,
|
||||
* {@code false} if runtime.
|
||||
* @param visible The initial visibility.
|
||||
* @see java.util.Locale#getDefault()
|
||||
* @see java.util.Locale#setDefault(java.util.Locale)
|
||||
@ -112,15 +112,15 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
/**
|
||||
* Create an instance using the specified Locale and design mode.
|
||||
*
|
||||
* @param peer The peer <tt>BeanContext</tt> we
|
||||
* @param peer The peer {@code BeanContext} we
|
||||
* are supplying an implementation for,
|
||||
* or <tt>null</tt> if this object is its own peer
|
||||
* @param lcle The current Locale for this <tt>BeanContext</tt>. If
|
||||
* <tt>lcle</tt> is <tt>null</tt>, the default locale
|
||||
* is assigned to the <tt>BeanContext</tt> instance.
|
||||
* @param dtime The initial state, <tt>true</tt>
|
||||
* or {@code null} if this object is its own peer
|
||||
* @param lcle The current Locale for this {@code BeanContext}. If
|
||||
* {@code lcle} is {@code null}, the default locale
|
||||
* is assigned to the {@code BeanContext} instance.
|
||||
* @param dtime The initial state, {@code true}
|
||||
* if in design mode,
|
||||
* <tt>false</tt> if runtime.
|
||||
* {@code false} if runtime.
|
||||
* @see java.util.Locale#getDefault()
|
||||
* @see java.util.Locale#setDefault(java.util.Locale)
|
||||
*/
|
||||
@ -133,13 +133,13 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
*
|
||||
* @param peer The peer BeanContext we are
|
||||
* supplying an implementation for,
|
||||
* or <tt>null</tt> if this object
|
||||
* or {@code null} if this object
|
||||
* is its own peer
|
||||
* @param lcle The current Locale for this
|
||||
* <tt>BeanContext</tt>. If
|
||||
* <tt>lcle</tt> is <tt>null</tt>,
|
||||
* {@code BeanContext}. If
|
||||
* {@code lcle} is {@code null},
|
||||
* the default locale
|
||||
* is assigned to the <tt>BeanContext</tt>
|
||||
* is assigned to the {@code BeanContext}
|
||||
* instance.
|
||||
* @see java.util.Locale#getDefault()
|
||||
* @see java.util.Locale#setDefault(java.util.Locale)
|
||||
@ -151,9 +151,9 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
/**
|
||||
* Create an instance using with a default locale
|
||||
*
|
||||
* @param peer The peer <tt>BeanContext</tt> we are
|
||||
* @param peer The peer {@code BeanContext} we are
|
||||
* supplying an implementation for,
|
||||
* or <tt>null</tt> if this object
|
||||
* or {@code null} if this object
|
||||
* is its own peer
|
||||
*/
|
||||
public BeanContextSupport(BeanContext peer) {
|
||||
@ -169,7 +169,7 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the instance of <tt>BeanContext</tt> that
|
||||
* Gets the instance of {@code BeanContext} that
|
||||
* this object is providing the implementation for.
|
||||
* @return the BeanContext instance
|
||||
*/
|
||||
@ -180,7 +180,7 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
* The instantiateChild method is a convenience hook
|
||||
* in BeanContext to simplify
|
||||
* the task of instantiating a Bean, nested,
|
||||
* into a <tt>BeanContext</tt>.
|
||||
* into a {@code BeanContext}.
|
||||
* </p>
|
||||
* <p>
|
||||
* The semantics of the beanName parameter are defined by java.beans.Beans.instantiate.
|
||||
@ -213,8 +213,8 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
|
||||
/**
|
||||
* Reports whether or not this
|
||||
* <tt>BeanContext</tt> is empty.
|
||||
* A <tt>BeanContext</tt> is considered
|
||||
* {@code BeanContext} is empty.
|
||||
* A {@code BeanContext} is considered
|
||||
* empty when it contains zero
|
||||
* nested children.
|
||||
* @return if there are not children
|
||||
@ -227,7 +227,7 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
|
||||
/**
|
||||
* Determines whether or not the specified object
|
||||
* is currently a child of this <tt>BeanContext</tt>.
|
||||
* is currently a child of this {@code BeanContext}.
|
||||
* @param o the Object in question
|
||||
* @return if this object is a child
|
||||
*/
|
||||
@ -239,7 +239,7 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
|
||||
/**
|
||||
* Determines whether or not the specified object
|
||||
* is currently a child of this <tt>BeanContext</tt>.
|
||||
* is currently a child of this {@code BeanContext}.
|
||||
* @param o the Object in question
|
||||
* @return if this object is a child
|
||||
*/
|
||||
@ -250,9 +250,9 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets all JavaBean or <tt>BeanContext</tt> instances
|
||||
* currently nested in this <tt>BeanContext</tt>.
|
||||
* @return an <tt>Iterator</tt> of the nested children
|
||||
* Gets all JavaBean or {@code BeanContext} instances
|
||||
* currently nested in this {@code BeanContext}.
|
||||
* @return an {@code Iterator} of the nested children
|
||||
*/
|
||||
public Iterator<Object> iterator() {
|
||||
synchronized(children) {
|
||||
@ -261,7 +261,7 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets all JavaBean or <tt>BeanContext</tt>
|
||||
* Gets all JavaBean or {@code BeanContext}
|
||||
* instances currently nested in this BeanContext.
|
||||
*/
|
||||
public Object[] toArray() {
|
||||
@ -272,7 +272,7 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
|
||||
/**
|
||||
* Gets an array containing all children of
|
||||
* this <tt>BeanContext</tt> that match
|
||||
* this {@code BeanContext} that match
|
||||
* the types contained in arry.
|
||||
* @param arry The array of object
|
||||
* types that are of interest.
|
||||
@ -362,7 +362,7 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
/************************************************************************/
|
||||
|
||||
/**
|
||||
* Adds/nests a child within this <tt>BeanContext</tt>.
|
||||
* Adds/nests a child within this {@code BeanContext}.
|
||||
* <p>
|
||||
* Invoked as a side effect of java.beans.Beans.instantiate().
|
||||
* If the child object is not valid for adding then this method
|
||||
@ -371,7 +371,7 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
*
|
||||
*
|
||||
* @param targetChild The child objects to nest
|
||||
* within this <tt>BeanContext</tt>
|
||||
* within this {@code BeanContext}
|
||||
* @return true if the child was added successfully.
|
||||
* @see #validatePendingAdd
|
||||
*/
|
||||
@ -485,12 +485,12 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
|
||||
/**
|
||||
* internal remove used when removal caused by
|
||||
* unexpected <tt>setBeanContext</tt> or
|
||||
* by <tt>remove()</tt> invocation.
|
||||
* unexpected {@code setBeanContext} or
|
||||
* by {@code remove()} invocation.
|
||||
* @param targetChild the JavaBean, BeanContext, or Object to be removed
|
||||
* @param callChildSetBC used to indicate that
|
||||
* the child should be notified that it is no
|
||||
* longer nested in this <tt>BeanContext</tt>.
|
||||
* longer nested in this {@code BeanContext}.
|
||||
* @return whether or not was present before being removed
|
||||
*/
|
||||
protected boolean remove(Object targetChild, boolean callChildSetBC) {
|
||||
@ -558,13 +558,13 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
|
||||
/**
|
||||
* Tests to see if all objects in the
|
||||
* specified <tt>Collection</tt> are children of
|
||||
* this <tt>BeanContext</tt>.
|
||||
* @param c the specified <tt>Collection</tt>
|
||||
* specified {@code Collection} are children of
|
||||
* this {@code BeanContext}.
|
||||
* @param c the specified {@code Collection}
|
||||
*
|
||||
* @return <tt>true</tt> if all objects
|
||||
* @return {@code true} if all objects
|
||||
* in the collection are children of
|
||||
* this <tt>BeanContext</tt>, false if not.
|
||||
* this {@code BeanContext}, false if not.
|
||||
*/
|
||||
@SuppressWarnings("rawtypes")
|
||||
public boolean containsAll(Collection c) {
|
||||
@ -698,7 +698,7 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets the new design time value for this <tt>BeanContext</tt>.
|
||||
* Sets the new design time value for this {@code BeanContext}.
|
||||
* @param dTime the new designTime value
|
||||
*/
|
||||
public synchronized void setDesignTime(boolean dTime) {
|
||||
@ -713,15 +713,15 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
/**
|
||||
* Reports whether or not this object is in
|
||||
* currently in design time mode.
|
||||
* @return <tt>true</tt> if in design time mode,
|
||||
* <tt>false</tt> if not
|
||||
* @return {@code true} if in design time mode,
|
||||
* {@code false} if not
|
||||
*/
|
||||
public synchronized boolean isDesignTime() { return designTime; }
|
||||
|
||||
/**
|
||||
* Sets the locale of this BeanContext.
|
||||
* @param newLocale the new locale. This method call will have
|
||||
* no effect if newLocale is <CODE>null</CODE>.
|
||||
* no effect if newLocale is {@code null}.
|
||||
* @throws PropertyVetoException if the new value is rejected
|
||||
*/
|
||||
public synchronized void setLocale(Locale newLocale) throws PropertyVetoException {
|
||||
@ -738,9 +738,9 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the locale for this <tt>BeanContext</tt>.
|
||||
* Gets the locale for this {@code BeanContext}.
|
||||
*
|
||||
* @return the current Locale of the <tt>BeanContext</tt>
|
||||
* @return the current Locale of the {@code BeanContext}
|
||||
*/
|
||||
public synchronized Locale getLocale() { return locale; }
|
||||
|
||||
@ -754,7 +754,7 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
* to determine if they are either Containers, Components, or if they implement
|
||||
* Visibility and return needsGui() == true.
|
||||
* </p>
|
||||
* @return <tt>true</tt> if the implementor needs a GUI
|
||||
* @return {@code true} if the implementor needs a GUI
|
||||
*/
|
||||
public synchronized boolean needsGui() {
|
||||
BeanContext bc = getBeanContextPeer();
|
||||
@ -823,7 +823,7 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Used to determine if the <tt>BeanContext</tt>
|
||||
* Used to determine if the {@code BeanContext}
|
||||
* child is avoiding using its GUI.
|
||||
* @return is this instance avoiding using its GUI?
|
||||
* @see Visibility
|
||||
@ -833,16 +833,16 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
}
|
||||
|
||||
/**
|
||||
* Is this <tt>BeanContext</tt> in the
|
||||
* Is this {@code BeanContext} in the
|
||||
* process of being serialized?
|
||||
* @return if this <tt>BeanContext</tt> is
|
||||
* @return if this {@code BeanContext} is
|
||||
* currently being serialized
|
||||
*/
|
||||
public boolean isSerializing() { return serializing; }
|
||||
|
||||
/**
|
||||
* Returns an iterator of all children
|
||||
* of this <tt>BeanContext</tt>.
|
||||
* of this {@code BeanContext}.
|
||||
* @return an iterator for all the current BCSChild values
|
||||
*/
|
||||
protected Iterator<BCSChild> bcsChildren() { synchronized(children) { return children.values().iterator(); } }
|
||||
@ -895,9 +895,9 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
|
||||
/**
|
||||
* Used by writeObject to serialize a Collection.
|
||||
* @param oos the <tt>ObjectOutputStream</tt>
|
||||
* @param oos the {@code ObjectOutputStream}
|
||||
* to use during serialization
|
||||
* @param coll the <tt>Collection</tt> to serialize
|
||||
* @param coll the {@code Collection} to serialize
|
||||
* @throws IOException if serialization failed
|
||||
*/
|
||||
protected final void serialize(ObjectOutputStream oos, Collection<?> coll) throws IOException {
|
||||
@ -943,8 +943,8 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
|
||||
/**
|
||||
* Used to serialize all children of
|
||||
* this <tt>BeanContext</tt>.
|
||||
* @param oos the <tt>ObjectOutputStream</tt>
|
||||
* this {@code BeanContext}.
|
||||
* @param oos the {@code ObjectOutputStream}
|
||||
* to use during serialization
|
||||
* @throws IOException if serialization failed
|
||||
*/
|
||||
@ -1375,7 +1375,7 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
|
||||
|
||||
/**
|
||||
* all accesses to the <code> protected HashMap children </code> field
|
||||
* all accesses to the {@code protected HashMap children} field
|
||||
* shall be synchronized on that object.
|
||||
*/
|
||||
protected transient HashMap<Object, BCSChild> children;
|
||||
@ -1383,7 +1383,7 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
private int serializable = 0; // children serializable
|
||||
|
||||
/**
|
||||
* all accesses to the <code> protected ArrayList bcmListeners </code> field
|
||||
* all accesses to the {@code protected ArrayList bcmListeners} field
|
||||
* shall be synchronized on that object.
|
||||
*/
|
||||
protected transient ArrayList<BeanContextMembershipListener> bcmListeners;
|
||||
@ -1396,14 +1396,14 @@ public class BeanContextSupport extends BeanContextChildSupport
|
||||
protected Locale locale;
|
||||
|
||||
/**
|
||||
* A <tt>boolean</tt> indicating if this
|
||||
* A {@code boolean} indicating if this
|
||||
* instance may now render a GUI.
|
||||
*/
|
||||
protected boolean okToUseGui;
|
||||
|
||||
|
||||
/**
|
||||
* A <tt>boolean</tt> indicating whether or not
|
||||
* A {@code boolean} indicating whether or not
|
||||
* this object is currently in design time mode.
|
||||
*/
|
||||
protected boolean designTime;
|
||||
|
||||
@ -43,7 +43,7 @@ below.
|
||||
<A NAME="Accessible"></A><A HREF="Accessible.html">Interface Accessible</A></H3>
|
||||
<A HREF="Accessible.html">Interface Accessible</A> is the main interface
|
||||
of the Java Accessibility API. All components that support the Java Accessibility
|
||||
API must implement this interface. It contains a single method, <TT>getAccessibleContext</TT>,
|
||||
API must implement this interface. It contains a single method, <code>getAccessibleContext</code>,
|
||||
that returns an instance of the class <A HREF="#AccessibleContext">AccessibleContext</A>.
|
||||
Sun thinks that implementing this interface is the absolute minimum requirement
|
||||
of every object that is part of the user interface of a Java application,
|
||||
@ -53,7 +53,7 @@ if that program is to be compatible with assistive technologies.
|
||||
AccessibleContext</A></H3>
|
||||
<A HREF="AccessibleContext.html">AccessibleContext</A> represents the minimum
|
||||
information all accessible objects return and is obtained by calling the
|
||||
<TT>getAccessibleContext</TT> method on an object that implements the <A HREF="#Accessible">Accessible</A>
|
||||
<code>getAccessibleContext</code> method on an object that implements the <A HREF="#Accessible">Accessible</A>
|
||||
interface. This information includes the accessible name, description,
|
||||
<A HREF="#AccessibleRole">role</A>, and <A HREF="#AccessibleState">state</A>
|
||||
of the object, as well as information about the parent and children of
|
||||
@ -69,7 +69,7 @@ an object that implements one or more of the following interfaces:
|
||||
perform one or more actions. This interface provides the standard mechanism
|
||||
for an assistive technology to determine what those actions are and tell
|
||||
the object to perform those actions. Any object that can be manipulated
|
||||
should return an object that implements this interface when the <TT>getAccessibleAction</TT>
|
||||
should return an object that implements this interface when the <code>getAccessibleAction</code>
|
||||
method is called on an AccessibleContext.</LI>
|
||||
|
||||
<LI>
|
||||
@ -77,7 +77,7 @@ method is called on an AccessibleContext.</LI>
|
||||
has a graphical representation. This interface provides the standard mechanism
|
||||
for an assistive technology to determine and set the graphical representation
|
||||
of the object. Any object that is rendered on the screen should return
|
||||
an object that implements this interface when the <TT>getAccessibleComponent</TT>
|
||||
an object that implements this interface when the <code>getAccessibleComponent</code>
|
||||
method is called on an AccessibleContext.</LI>
|
||||
|
||||
<LI>
|
||||
@ -86,7 +86,7 @@ allows its children to be selected. This interface provides the standard
|
||||
mechanism for an assistive technology to determine the currently selected
|
||||
children as well as modify the selection set. Any object that has children
|
||||
that can be selected should return an object that implements this interface
|
||||
when the <TT>getAccessibleSelection</TT> method is called on an AccessibleContext.</LI>
|
||||
when the <code>getAccessibleSelection</code> method is called on an AccessibleContext.</LI>
|
||||
|
||||
<LI>
|
||||
<B><A HREF="#AccessibleText">AccessibleText</A></B> - the object presents
|
||||
@ -94,7 +94,7 @@ editable textual information on the display. This interface provides the
|
||||
standard mechanism for an assistive technology to access that text via
|
||||
its content, attributes, and spatial location. Any object that contains
|
||||
editable text should return an object that implements this interface when
|
||||
the <TT>getAccessibleText</TT> method is called on an AccessibleContext.</LI>
|
||||
the <code>getAccessibleText</code> method is called on an AccessibleContext.</LI>
|
||||
|
||||
<LI>
|
||||
<B><A HREF="#AccessibleHypertext">AccessibleHypertext</A></B> - the object
|
||||
@ -102,25 +102,25 @@ presents hypertext information on the display. This interface provides
|
||||
the standard mechanism for an assistive technology to access that hypertext
|
||||
via its content, attributes, and spatial location. Any object that contains
|
||||
hypertext should return an object that implements this interface when the
|
||||
<TT>getAccessibleText</TT> method is called on an AccessibleContext.</LI>
|
||||
<code>getAccessibleText</code> method is called on an AccessibleContext.</LI>
|
||||
|
||||
<LI>
|
||||
<B><A HREF="#AccessibleValue">AccessibleValue</A></B> - the object supports
|
||||
a numerical value. This interface provides the standard mechanism for an
|
||||
assistive technology to determine and set the current value of the object,
|
||||
as well as the minimum and maximum values. Any object that supports a numerical
|
||||
value should return an object that implements this interface when the <TT>getAccessibleValue</TT>
|
||||
value should return an object that implements this interface when the <code>getAccessibleValue</code>
|
||||
method is called on an AccessibleContext.</LI>
|
||||
</UL>
|
||||
|
||||
<H3>
|
||||
<A NAME="AccessibleRole"></A><A HREF="AccessibleRole.html">Class AccessibleRole</A></H3>
|
||||
This class encapsulates the Accessible object's role in the user interface
|
||||
and is obtained by calling the <TT>getAccessibleRole</TT> method on an
|
||||
and is obtained by calling the <code>getAccessibleRole</code> method on an
|
||||
<A HREF="#AccessibleContext">AccessibleContext</A>. Accessible roles include
|
||||
"Check box", "Menu Item", "Panel", etc. These roles are identified by the
|
||||
constants in this class such as <TT>AccessibleRole.CHECK_BOX, AccessibleRole.MENU_ITEM,</TT>
|
||||
and <TT>AccessibleRole.PANEL</TT>. The constants in this class present
|
||||
constants in this class such as <code>AccessibleRole.CHECK_BOX, AccessibleRole.MENU_ITEM,</code>
|
||||
and <code>AccessibleRole.PANEL</code>. The constants in this class present
|
||||
a strongly typed enumeration of common object roles. A public constructor
|
||||
for this class has been purposely omitted and applications should use one
|
||||
of the constants from this class. Although this class pre-defines a large
|
||||
@ -131,10 +131,10 @@ roles can be added in the future without needing to modify the base class.
|
||||
<A NAME="AccessibleState"></A><A HREF="AccessibleState.html">Class AccessibleState</A></H3>
|
||||
This class encapsulates a particular state of the Accessible object. Accessible
|
||||
states include things like "Armed", "Busy", "Checked", "Focused", etc.
|
||||
These roles are identified by the constants in this class such as <TT>AccessibleState.ARMED,
|
||||
AccessibleState.BUSY, AccessibleState.CHECKED,</TT> and <TT>AccessibleState.FOCUSED</TT>.
|
||||
These roles are identified by the constants in this class such as <code>AccessibleState.ARMED,
|
||||
AccessibleState.BUSY, AccessibleState.CHECKED,</code> and <code>AccessibleState.FOCUSED</code>.
|
||||
The sum of all the states of an Accessible object is called the <A HREF="#AccessibleStateSet">AccessibleStateSet</A>,
|
||||
and can be obtained by calling the <TT>getAccessibleStateSet</TT> method
|
||||
and can be obtained by calling the <code>getAccessibleStateSet</code> method
|
||||
on an <A HREF="#AccessibleContext">AccessibleContext</A>.
|
||||
|
||||
<P>The constants in this class present a strongly typed enumeration of
|
||||
@ -148,7 +148,7 @@ needing to modify the base class.
|
||||
<A NAME="AccessibleStateSet"></A><A HREF="AccessibleStateSet.html">Class
|
||||
AccessibleStateSet</A></H3>
|
||||
This class encapsulates a collection of states of the Accessible object
|
||||
and is obtained by calling the <TT>getAccessibleStateSet</TT> method on
|
||||
and is obtained by calling the <code>getAccessibleStateSet</code> method on
|
||||
an <A HREF="#AccessibleContext">AccessibleContext</A>. Since an object
|
||||
might have multiple states (e.g. it might be both "Checked" and "Focused"),
|
||||
this class is needed to encapsulate a collection of these states. Methods
|
||||
@ -173,7 +173,7 @@ Any object that can be manipulated should support this interface.
|
||||
|
||||
<P>Applications can determine if an object supports the AccessibleAction
|
||||
interface by first obtaining its <A HREF="#AccessibleContext">AccessibleContext</A>
|
||||
(see <A HREF="#Accessible">Accessible</A>) and then calling the <TT>getAccessibleAction</TT>
|
||||
(see <A HREF="#Accessible">Accessible</A>) and then calling the <code>getAccessibleAction</code>
|
||||
method of <A HREF="#AccessibleContext">AccessibleContext</A>. If the return
|
||||
value is not null, the object supports this interface.
|
||||
<H3>
|
||||
@ -186,7 +186,7 @@ determine and set the graphical representation of an object.
|
||||
|
||||
<P>Applications can determine if an object supports the AccessibleComponent
|
||||
interface by first obtaining its <A HREF="#AccessibleContext">AccessibleContext</A>
|
||||
(see <A HREF="#Accessible">Accessible</A>) and then calling the <TT>getAccessibleComponent</TT>
|
||||
(see <A HREF="#Accessible">Accessible</A>) and then calling the <code>getAccessibleComponent</code>
|
||||
method of <A HREF="#AccessibleContext">AccessibleContext</A>. If the return
|
||||
value is not null, the object supports this interface.
|
||||
<H3>
|
||||
@ -200,7 +200,7 @@ the AccessibleSelection interface.
|
||||
|
||||
<P>Applications can determine if an object supports the AccessibleSelection
|
||||
interface by first obtaining its <A HREF="#AccessibleContext">AccessibleContext</A>
|
||||
(see <A HREF="#Accessible">Accessible</A>) and then calling the <TT>getAccessibleSelection</TT>
|
||||
(see <A HREF="#Accessible">Accessible</A>) and then calling the <code>getAccessibleSelection</code>
|
||||
method of <A HREF="#AccessibleContext">AccessibleContext</A>. If the return
|
||||
value is not null, the object supports this interface.
|
||||
<H3>
|
||||
@ -222,7 +222,7 @@ the text caret.
|
||||
|
||||
<P>Applications can determine if an object supports the AccessibleText
|
||||
interface by first obtaining its <A HREF="#AccessibleContext">AccessibleContext</A>
|
||||
(see <A HREF="#Accessible">Accessible</A>) and then calling the <TT>getAccessibleText</TT>
|
||||
(see <A HREF="#Accessible">Accessible</A>) and then calling the <code>getAccessibleText</code>
|
||||
method of <A HREF="#AccessibleContext">AccessibleContext</A>. If the return
|
||||
value is not null, the object supports this interface.
|
||||
<H3><A NAME="AccessibleHypertext"></A>
|
||||
@ -256,7 +256,7 @@ maximum values.
|
||||
|
||||
<P>Applications can determine if an object supports the AccessibleValue
|
||||
interface by first obtaining its <A HREF="#AccessibleContext">AccessibleContext</A>
|
||||
(see <A HREF="#Accessible">Accessible</A>) and then calling the <TT>getAccessibleValue</TT>
|
||||
(see <A HREF="#Accessible">Accessible</A>) and then calling the <code>getAccessibleValue</code>
|
||||
method of <A HREF="#AccessibleContext">AccessibleContext</A>. If the return
|
||||
value is not null, the object supports this interface.
|
||||
|
||||
|
||||
@ -111,7 +111,7 @@ public interface AttributeSet {
|
||||
|
||||
/**
|
||||
* Returns the attribute value which this attribute set contains in the
|
||||
* given attribute category. Returns <tt>null</tt> if this attribute set
|
||||
* given attribute category. Returns {@code null} if this attribute set
|
||||
* does not contain any attribute value in the given attribute category.
|
||||
*
|
||||
* @param category Attribute category whose associated attribute value
|
||||
@ -121,14 +121,14 @@ public interface AttributeSet {
|
||||
* Attribute}.
|
||||
*
|
||||
* @return The attribute value in the given attribute category contained
|
||||
* in this attribute set, or <tt>null</tt> if this attribute set
|
||||
* in this attribute set, or {@code null} if this attribute set
|
||||
* does not contain any attribute value in the given attribute
|
||||
* category.
|
||||
*
|
||||
* @throws NullPointerException
|
||||
* (unchecked exception) Thrown if the <CODE>category</CODE> is null.
|
||||
* (unchecked exception) Thrown if the {@code category} is null.
|
||||
* @throws ClassCastException
|
||||
* (unchecked exception) Thrown if the <CODE>category</CODE> is not a
|
||||
* (unchecked exception) Thrown if the {@code category} is not a
|
||||
* {@link java.lang.Class Class} that implements interface {@link
|
||||
* Attribute Attribute}.
|
||||
*/
|
||||
@ -141,74 +141,74 @@ public interface AttributeSet {
|
||||
*
|
||||
* @param attribute Attribute value to be added to this attribute set.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set changed as a result of the
|
||||
* @return {@code true} if this attribute set changed as a result of the
|
||||
* call, i.e., the given attribute value was not already a member
|
||||
* of this attribute set.
|
||||
*
|
||||
* @throws NullPointerException
|
||||
* (unchecked exception) Thrown if the <CODE>attribute</CODE> is null.
|
||||
* (unchecked exception) Thrown if the {@code attribute} is null.
|
||||
* @throws UnmodifiableSetException
|
||||
* (unchecked exception) Thrown if this attribute set does not support
|
||||
* the <CODE>add()</CODE> operation.
|
||||
* the {@code add()} operation.
|
||||
*/
|
||||
public boolean add(Attribute attribute);
|
||||
|
||||
|
||||
/**
|
||||
* Removes any attribute for this category from this attribute set if
|
||||
* present. If <CODE>category</CODE> is null, then
|
||||
* <CODE>remove()</CODE> does nothing and returns <tt>false</tt>.
|
||||
* present. If {@code category} is null, then
|
||||
* {@code remove()} does nothing and returns {@code false}.
|
||||
*
|
||||
* @param category Attribute category to be removed from this
|
||||
* attribute set.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set changed as a result of the
|
||||
* @return {@code true} if this attribute set changed as a result of the
|
||||
* call, i.e., the given attribute value had been a member of this
|
||||
* attribute set.
|
||||
*
|
||||
* @throws UnmodifiableSetException
|
||||
* (unchecked exception) Thrown if this attribute set does not support
|
||||
* the <CODE>remove()</CODE> operation.
|
||||
* the {@code remove()} operation.
|
||||
*/
|
||||
public boolean remove(Class<?> category);
|
||||
|
||||
/**
|
||||
* Removes the specified attribute from this attribute set if
|
||||
* present. If <CODE>attribute</CODE> is null, then
|
||||
* <CODE>remove()</CODE> does nothing and returns <tt>false</tt>.
|
||||
* present. If {@code attribute} is null, then
|
||||
* {@code remove()} does nothing and returns {@code false}.
|
||||
*
|
||||
* @param attribute Attribute value to be removed from this attribute set.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set changed as a result of the
|
||||
* @return {@code true} if this attribute set changed as a result of the
|
||||
* call, i.e., the given attribute value had been a member of this
|
||||
* attribute set.
|
||||
*
|
||||
* @throws UnmodifiableSetException
|
||||
* (unchecked exception) Thrown if this attribute set does not support
|
||||
* the <CODE>remove()</CODE> operation.
|
||||
* the {@code remove()} operation.
|
||||
*/
|
||||
public boolean remove(Attribute attribute);
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if this attribute set contains an
|
||||
* Returns {@code true} if this attribute set contains an
|
||||
* attribute for the specified category.
|
||||
*
|
||||
* @param category whose presence in this attribute set is
|
||||
* to be tested.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set contains an attribute
|
||||
* @return {@code true} if this attribute set contains an attribute
|
||||
* value for the specified category.
|
||||
*/
|
||||
public boolean containsKey(Class<?> category);
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if this attribute set contains the given
|
||||
* Returns {@code true} if this attribute set contains the given
|
||||
* attribute value.
|
||||
*
|
||||
* @param attribute Attribute value whose presence in this
|
||||
* attribute set is to be tested.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set contains the given
|
||||
* @return {@code true} if this attribute set contains the given
|
||||
* attribute value.
|
||||
*/
|
||||
public boolean containsValue(Attribute attribute);
|
||||
@ -219,11 +219,11 @@ public interface AttributeSet {
|
||||
* {@link #add(Attribute) add(Attribute)}
|
||||
* operation had been applied to this attribute set successively with each
|
||||
* element from the specified set.
|
||||
* The behavior of the <CODE>addAll(AttributeSet)</CODE>
|
||||
* The behavior of the {@code addAll(AttributeSet)}
|
||||
* operation is unspecified if the specified set is modified while
|
||||
* the operation is in progress.
|
||||
* <P>
|
||||
* If the <CODE>addAll(AttributeSet)</CODE> operation throws an exception,
|
||||
* If the {@code addAll(AttributeSet)} operation throws an exception,
|
||||
* the effect on this attribute set's state is implementation dependent;
|
||||
* elements from the specified set before the point of the exception may
|
||||
* or may not have been added to this attribute set.
|
||||
@ -231,12 +231,12 @@ public interface AttributeSet {
|
||||
* @param attributes whose elements are to be added to this attribute
|
||||
* set.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set changed as a result of the
|
||||
* @return {@code true} if this attribute set changed as a result of the
|
||||
* call.
|
||||
*
|
||||
* @throws UnmodifiableSetException
|
||||
* (Unchecked exception) Thrown if this attribute set does not support
|
||||
* the <tt>addAll(AttributeSet)</tt> method.
|
||||
* the {@code addAll(AttributeSet)} method.
|
||||
* @throws NullPointerException
|
||||
* (Unchecked exception) Thrown if some element in the specified
|
||||
* set is null.
|
||||
@ -247,8 +247,8 @@ public interface AttributeSet {
|
||||
|
||||
/**
|
||||
* Returns the number of attributes in this attribute set. If this
|
||||
* attribute set contains more than <tt>Integer.MAX_VALUE</tt> elements,
|
||||
* returns <tt>Integer.MAX_VALUE</tt>.
|
||||
* attribute set contains more than {@code Integer.MAX_VALUE} elements,
|
||||
* returns {@code Integer.MAX_VALUE}.
|
||||
*
|
||||
* @return The number of attributes in this attribute set.
|
||||
*/
|
||||
@ -267,7 +267,7 @@ public interface AttributeSet {
|
||||
*
|
||||
* @throws UnmodifiableSetException
|
||||
* (unchecked exception) Thrown if this attribute set does not support
|
||||
* the <CODE>clear()</CODE> operation.
|
||||
* the {@code clear()} operation.
|
||||
*/
|
||||
public void clear();
|
||||
|
||||
@ -280,15 +280,15 @@ public interface AttributeSet {
|
||||
|
||||
/**
|
||||
* Compares the specified object with this attribute set for equality.
|
||||
* Returns <tt>true</tt> if the given object is also an attribute set and
|
||||
* Returns {@code true} if the given object is also an attribute set and
|
||||
* the two attribute sets contain the same attribute category-attribute
|
||||
* value mappings. This ensures that the
|
||||
* <tt>equals()</tt> method works properly across different
|
||||
* {@code equals()} method works properly across different
|
||||
* implementations of the AttributeSet interface.
|
||||
*
|
||||
* @param object to be compared for equality with this attribute set.
|
||||
*
|
||||
* @return <tt>true</tt> if the specified object is equal to this
|
||||
* @return {@code true} if the specified object is equal to this
|
||||
* attribute set.
|
||||
*/
|
||||
public boolean equals(Object object);
|
||||
@ -297,9 +297,9 @@ public interface AttributeSet {
|
||||
* Returns the hash code value for this attribute set. The hash code of an
|
||||
* attribute set is defined to be the sum of the hash codes of each entry
|
||||
* in the AttributeSet.
|
||||
* This ensures that <tt>t1.equals(t2)</tt> implies that
|
||||
* <tt>t1.hashCode()==t2.hashCode()</tt> for any two attribute sets
|
||||
* <tt>t1</tt> and <tt>t2</tt>, as required by the general contract of
|
||||
* This ensures that {@code t1.equals(t2)} implies that
|
||||
* {@code t1.hashCode()==t2.hashCode()} for any two attribute sets
|
||||
* {@code t1} and {@code t2}, as required by the general contract of
|
||||
* {@link java.lang.Object#hashCode() Object.hashCode()}.
|
||||
*
|
||||
* @return The hash code value for this attribute set.
|
||||
|
||||
@ -54,19 +54,19 @@ public interface DocAttributeSet extends AttributeSet {
|
||||
*
|
||||
* @param attribute Attribute value to be added to this attribute set.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set changed as a result of
|
||||
* @return {@code true} if this attribute set changed as a result of
|
||||
* the call, i.e., the given attribute value was not already a
|
||||
* member of this attribute set.
|
||||
*
|
||||
* @throws UnmodifiableSetException
|
||||
* (unchecked exception) Thrown if this attribute set does not
|
||||
* support the <CODE>add()</CODE> operation.
|
||||
* support the {@code add()} operation.
|
||||
* @throws ClassCastException
|
||||
* (unchecked exception) Thrown if the <CODE>attribute</CODE> is
|
||||
* (unchecked exception) Thrown if the {@code attribute} is
|
||||
* not an instance of interface
|
||||
* {@link DocAttribute DocAttribute}.
|
||||
* @throws NullPointerException
|
||||
* (unchecked exception) Thrown if the <CODE>attribute</CODE> is null.
|
||||
* (unchecked exception) Thrown if the {@code attribute} is null.
|
||||
*/
|
||||
public boolean add(Attribute attribute);
|
||||
|
||||
@ -77,13 +77,13 @@ public interface DocAttributeSet extends AttributeSet {
|
||||
* operation had been applied to this attribute set successively with
|
||||
* each element from the specified set. If none of the categories in the
|
||||
* specified set are the same as any categories in this attribute set,
|
||||
* the <tt>addAll()</tt> operation effectively modifies this attribute
|
||||
* the {@code addAll()} operation effectively modifies this attribute
|
||||
* set so that its value is the <i>union</i> of the two sets.
|
||||
* <P>
|
||||
* The behavior of the <CODE>addAll()</CODE> operation is unspecified if
|
||||
* The behavior of the {@code addAll()} operation is unspecified if
|
||||
* the specified set is modified while the operation is in progress.
|
||||
* <P>
|
||||
* If the <CODE>addAll()</CODE> operation throws an exception, the effect
|
||||
* If the {@code addAll()} operation throws an exception, the effect
|
||||
* on this attribute set's state is implementation dependent; elements
|
||||
* from the specified set before the point of the exception may or
|
||||
* may not have been added to this attribute set.
|
||||
@ -91,12 +91,12 @@ public interface DocAttributeSet extends AttributeSet {
|
||||
* @param attributes whose elements are to be added to this attribute
|
||||
* set.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set changed as a result of
|
||||
* @return {@code true} if this attribute set changed as a result of
|
||||
* the call.
|
||||
*
|
||||
* @throws UnmodifiableSetException
|
||||
* (Unchecked exception) Thrown if this attribute set does not
|
||||
* support the <tt>addAll()</tt> method.
|
||||
* support the {@code addAll()} method.
|
||||
* @throws ClassCastException
|
||||
* (Unchecked exception) Thrown if some element in the specified
|
||||
* set is not an instance of interface {@link DocAttribute
|
||||
|
||||
@ -32,7 +32,7 @@ import java.io.Serializable;
|
||||
import java.util.HashMap;
|
||||
|
||||
/**
|
||||
* Class HashAttributeSet provides an <code>AttributeSet</code>
|
||||
* Class HashAttributeSet provides an {@code AttributeSet}
|
||||
* implementation with characteristics of a hash map.
|
||||
*
|
||||
* @author Alan Kaminsky
|
||||
@ -104,7 +104,7 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
* @param attribute Attribute value to add to the set.
|
||||
*
|
||||
* @exception NullPointerException
|
||||
* (unchecked exception) Thrown if <CODE>attribute</CODE> is null.
|
||||
* (unchecked exception) Thrown if {@code attribute} is null.
|
||||
*/
|
||||
public HashAttributeSet(Attribute attribute) {
|
||||
this (attribute, Attribute.class);
|
||||
@ -114,7 +114,7 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
* Construct a new attribute set,
|
||||
* initially populated with the values from the
|
||||
* given array. The new attribute set is populated by
|
||||
* adding the elements of <CODE>attributes</CODE> array to the set in
|
||||
* adding the elements of {@code attributes} array to the set in
|
||||
* sequence, starting at index 0. Thus, later array elements may replace
|
||||
* earlier array elements if the array contains duplicate attribute
|
||||
* values or attribute categories.
|
||||
@ -124,7 +124,7 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
*
|
||||
* @exception NullPointerException
|
||||
* (unchecked exception) Thrown if any element of
|
||||
* <CODE>attributes</CODE> is null.
|
||||
* {@code attributes} is null.
|
||||
*/
|
||||
public HashAttributeSet(Attribute[] attributes) {
|
||||
this (attributes, Attribute.class);
|
||||
@ -171,11 +171,11 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
* subinterface thereof.
|
||||
*
|
||||
* @exception NullPointerException
|
||||
* (unchecked exception) Thrown if <CODE>attribute</CODE> is null.
|
||||
* (unchecked exception) Thrown if {@code attribute} is null.
|
||||
* @exception NullPointerException if interfaceName is null.
|
||||
* @exception ClassCastException
|
||||
* (unchecked exception) Thrown if <CODE>attribute</CODE> is not an
|
||||
* instance of <CODE>interfaceName</CODE>.
|
||||
* (unchecked exception) Thrown if {@code attribute} is not an
|
||||
* instance of {@code interfaceName}.
|
||||
*/
|
||||
protected HashAttributeSet(Attribute attribute, Class<?> interfaceName) {
|
||||
if (interfaceName == null) {
|
||||
@ -189,7 +189,7 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
* Construct a new attribute set, where the members of the attribute
|
||||
* set are restricted to the given interface.
|
||||
* The new attribute set is populated
|
||||
* by adding the elements of <CODE>attributes</CODE> array to the set in
|
||||
* by adding the elements of {@code attributes} array to the set in
|
||||
* sequence, starting at index 0. Thus, later array elements may replace
|
||||
* earlier array elements if the array contains duplicate attribute
|
||||
* values or attribute categories.
|
||||
@ -203,12 +203,12 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
*
|
||||
* @exception NullPointerException
|
||||
* (unchecked exception) Thrown if any element of
|
||||
* <CODE>attributes</CODE> is null.
|
||||
* {@code attributes} is null.
|
||||
* @exception NullPointerException if interfaceName is null.
|
||||
* @exception ClassCastException
|
||||
* (unchecked exception) Thrown if any element of
|
||||
* <CODE>attributes</CODE> is not an instance of
|
||||
* <CODE>interfaceName</CODE>.
|
||||
* {@code attributes} is not an instance of
|
||||
* {@code interfaceName}.
|
||||
*/
|
||||
protected HashAttributeSet(Attribute[] attributes, Class<?> interfaceName) {
|
||||
if (interfaceName == null) {
|
||||
@ -235,8 +235,8 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
*
|
||||
* @exception ClassCastException
|
||||
* (unchecked exception) Thrown if any element of
|
||||
* <CODE>attributes</CODE> is not an instance of
|
||||
* <CODE>interfaceName</CODE>.
|
||||
* {@code attributes} is not an instance of
|
||||
* {@code interfaceName}.
|
||||
*/
|
||||
protected HashAttributeSet(AttributeSet attributes, Class<?> interfaceName) {
|
||||
myInterface = interfaceName;
|
||||
@ -251,7 +251,7 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
|
||||
/**
|
||||
* Returns the attribute value which this attribute set contains in the
|
||||
* given attribute category. Returns <tt>null</tt> if this attribute set
|
||||
* given attribute category. Returns {@code null} if this attribute set
|
||||
* does not contain any attribute value in the given attribute category.
|
||||
*
|
||||
* @param category Attribute category whose associated attribute value
|
||||
@ -261,14 +261,14 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
* Attribute}.
|
||||
*
|
||||
* @return The attribute value in the given attribute category contained
|
||||
* in this attribute set, or <tt>null</tt> if this attribute set
|
||||
* in this attribute set, or {@code null} if this attribute set
|
||||
* does not contain any attribute value in the given attribute
|
||||
* category.
|
||||
*
|
||||
* @throws NullPointerException
|
||||
* (unchecked exception) Thrown if the <CODE>category</CODE> is null.
|
||||
* (unchecked exception) Thrown if the {@code category} is null.
|
||||
* @throws ClassCastException
|
||||
* (unchecked exception) Thrown if the <CODE>category</CODE> is not a
|
||||
* (unchecked exception) Thrown if the {@code category} is not a
|
||||
* {@link java.lang.Class Class} that implements interface {@link
|
||||
* Attribute Attribute}.
|
||||
*/
|
||||
@ -285,15 +285,15 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
*
|
||||
* @param attribute Attribute value to be added to this attribute set.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set changed as a result of the
|
||||
* @return {@code true} if this attribute set changed as a result of the
|
||||
* call, i.e., the given attribute value was not already a
|
||||
* member of this attribute set.
|
||||
*
|
||||
* @throws NullPointerException
|
||||
* (unchecked exception) Thrown if the <CODE>attribute</CODE> is null.
|
||||
* (unchecked exception) Thrown if the {@code attribute} is null.
|
||||
* @throws UnmodifiableSetException
|
||||
* (unchecked exception) Thrown if this attribute set does not support
|
||||
* the <CODE>add()</CODE> operation.
|
||||
* the {@code add()} operation.
|
||||
*/
|
||||
public boolean add(Attribute attribute) {
|
||||
Object oldAttribute =
|
||||
@ -305,19 +305,19 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
|
||||
/**
|
||||
* Removes any attribute for this category from this attribute set if
|
||||
* present. If <CODE>category</CODE> is null, then
|
||||
* <CODE>remove()</CODE> does nothing and returns <tt>false</tt>.
|
||||
* present. If {@code category} is null, then
|
||||
* {@code remove()} does nothing and returns {@code false}.
|
||||
*
|
||||
* @param category Attribute category to be removed from this
|
||||
* attribute set.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set changed as a result of the
|
||||
* @return {@code true} if this attribute set changed as a result of the
|
||||
* call, i.e., the given attribute category had been a member of
|
||||
* this attribute set.
|
||||
*
|
||||
* @throws UnmodifiableSetException
|
||||
* (unchecked exception) Thrown if this attribute set does not
|
||||
* support the <CODE>remove()</CODE> operation.
|
||||
* support the {@code remove()} operation.
|
||||
*/
|
||||
public boolean remove(Class<?> category) {
|
||||
return
|
||||
@ -329,18 +329,18 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
|
||||
/**
|
||||
* Removes the specified attribute from this attribute set if
|
||||
* present. If <CODE>attribute</CODE> is null, then
|
||||
* <CODE>remove()</CODE> does nothing and returns <tt>false</tt>.
|
||||
* present. If {@code attribute} is null, then
|
||||
* {@code remove()} does nothing and returns {@code false}.
|
||||
*
|
||||
* @param attribute Attribute value to be removed from this attribute set.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set changed as a result of the
|
||||
* @return {@code true} if this attribute set changed as a result of the
|
||||
* call, i.e., the given attribute value had been a member of
|
||||
* this attribute set.
|
||||
*
|
||||
* @throws UnmodifiableSetException
|
||||
* (unchecked exception) Thrown if this attribute set does not
|
||||
* support the <CODE>remove()</CODE> operation.
|
||||
* support the {@code remove()} operation.
|
||||
*/
|
||||
public boolean remove(Attribute attribute) {
|
||||
return
|
||||
@ -349,13 +349,13 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if this attribute set contains an
|
||||
* Returns {@code true} if this attribute set contains an
|
||||
* attribute for the specified category.
|
||||
*
|
||||
* @param category whose presence in this attribute set is
|
||||
* to be tested.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set contains an attribute
|
||||
* @return {@code true} if this attribute set contains an attribute
|
||||
* value for the specified category.
|
||||
*/
|
||||
public boolean containsKey(Class<?> category) {
|
||||
@ -367,13 +367,13 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if this attribute set contains the given
|
||||
* Returns {@code true} if this attribute set contains the given
|
||||
* attribute.
|
||||
*
|
||||
* @param attribute value whose presence in this attribute set is
|
||||
* to be tested.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set contains the given
|
||||
* @return {@code true} if this attribute set contains the given
|
||||
* attribute value.
|
||||
*/
|
||||
public boolean containsValue(Attribute attribute) {
|
||||
@ -389,11 +389,11 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
* {@link #add(Attribute) add(Attribute)}
|
||||
* operation had been applied to this attribute set successively with
|
||||
* each element from the specified set.
|
||||
* The behavior of the <CODE>addAll(AttributeSet)</CODE>
|
||||
* The behavior of the {@code addAll(AttributeSet)}
|
||||
* operation is unspecified if the specified set is modified while
|
||||
* the operation is in progress.
|
||||
* <P>
|
||||
* If the <CODE>addAll(AttributeSet)</CODE> operation throws an exception,
|
||||
* If the {@code addAll(AttributeSet)} operation throws an exception,
|
||||
* the effect on this attribute set's state is implementation dependent;
|
||||
* elements from the specified set before the point of the exception may
|
||||
* or may not have been added to this attribute set.
|
||||
@ -401,12 +401,12 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
* @param attributes whose elements are to be added to this attribute
|
||||
* set.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set changed as a result of the
|
||||
* @return {@code true} if this attribute set changed as a result of the
|
||||
* call.
|
||||
*
|
||||
* @throws UnmodifiableSetException
|
||||
* (Unchecked exception) Thrown if this attribute set does not
|
||||
* support the <tt>addAll(AttributeSet)</tt> method.
|
||||
* support the {@code addAll(AttributeSet)} method.
|
||||
* @throws NullPointerException
|
||||
* (Unchecked exception) Thrown if some element in the specified
|
||||
* set is null, or the set is null.
|
||||
@ -429,8 +429,8 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
|
||||
/**
|
||||
* Returns the number of attributes in this attribute set. If this
|
||||
* attribute set contains more than <tt>Integer.MAX_VALUE</tt> elements,
|
||||
* returns <tt>Integer.MAX_VALUE</tt>.
|
||||
* attribute set contains more than {@code Integer.MAX_VALUE} elements,
|
||||
* returns {@code Integer.MAX_VALUE}.
|
||||
*
|
||||
* @return The number of attributes in this attribute set.
|
||||
*/
|
||||
@ -455,7 +455,7 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
*
|
||||
* @throws UnmodifiableSetException
|
||||
* (unchecked exception) Thrown if this attribute set does not support
|
||||
* the <CODE>clear()</CODE> operation.
|
||||
* the {@code clear()} operation.
|
||||
*/
|
||||
public void clear() {
|
||||
attrMap.clear();
|
||||
@ -472,15 +472,15 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
|
||||
/**
|
||||
* Compares the specified object with this attribute set for equality.
|
||||
* Returns <tt>true</tt> if the given object is also an attribute set and
|
||||
* Returns {@code true} if the given object is also an attribute set and
|
||||
* the two attribute sets contain the same attribute category-attribute
|
||||
* value mappings. This ensures that the
|
||||
* <tt>equals()</tt> method works properly across different
|
||||
* {@code equals()} method works properly across different
|
||||
* implementations of the AttributeSet interface.
|
||||
*
|
||||
* @param object to be compared for equality with this attribute set.
|
||||
*
|
||||
* @return <tt>true</tt> if the specified object is equal to this
|
||||
* @return {@code true} if the specified object is equal to this
|
||||
* attribute set.
|
||||
*/
|
||||
|
||||
@ -507,9 +507,9 @@ public class HashAttributeSet implements AttributeSet, Serializable {
|
||||
* Returns the hash code value for this attribute set.
|
||||
* The hash code of an attribute set is defined to be the sum
|
||||
* of the hash codes of each entry in the AttributeSet.
|
||||
* This ensures that <tt>t1.equals(t2)</tt> implies that
|
||||
* <tt>t1.hashCode()==t2.hashCode()</tt> for any two attribute sets
|
||||
* <tt>t1</tt> and <tt>t2</tt>, as required by the general contract of
|
||||
* This ensures that {@code t1.equals(t2)} implies that
|
||||
* {@code t1.hashCode()==t2.hashCode()} for any two attribute sets
|
||||
* {@code t1} and {@code t2}, as required by the general contract of
|
||||
* {@link java.lang.Object#hashCode() Object.hashCode()}.
|
||||
*
|
||||
* @return The hash code value for this attribute set.
|
||||
|
||||
@ -52,19 +52,19 @@ public interface PrintJobAttributeSet extends AttributeSet {
|
||||
*
|
||||
* @param attribute Attribute value to be added to this attribute set.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set changed as a result of
|
||||
* @return {@code true} if this attribute set changed as a result of
|
||||
* the call, i.e., the given attribute value was not already a
|
||||
* member of this attribute set.
|
||||
*
|
||||
* @throws UnmodifiableSetException
|
||||
* (unchecked exception) Thrown if this attribute set does not
|
||||
* support the <CODE>add()</CODE> operation.
|
||||
* support the {@code add()} operation.
|
||||
* @throws ClassCastException
|
||||
* (unchecked exception) Thrown if the <CODE>attribute</CODE> is
|
||||
* (unchecked exception) Thrown if the {@code attribute} is
|
||||
* not an instance of interface
|
||||
* {@link PrintJobAttribute PrintJobAttribute}.
|
||||
* @throws NullPointerException
|
||||
* (unchecked exception) Thrown if the <CODE>attribute</CODE> is null.
|
||||
* (unchecked exception) Thrown if the {@code attribute} is null.
|
||||
*/
|
||||
public boolean add(Attribute attribute);
|
||||
|
||||
@ -75,13 +75,13 @@ public interface PrintJobAttributeSet extends AttributeSet {
|
||||
* operation had been applied to this attribute set successively with
|
||||
* each element from the specified set. If none of the categories in the
|
||||
* specified set are the same as any categories in this attribute set,
|
||||
* the <tt>addAll()</tt> operation effectively modifies this attribute
|
||||
* the {@code addAll()} operation effectively modifies this attribute
|
||||
* set so that its value is the <i>union</i> of the two sets.
|
||||
* <P>
|
||||
* The behavior of the <CODE>addAll()</CODE> operation is unspecified if
|
||||
* The behavior of the {@code addAll()} operation is unspecified if
|
||||
* the specified set is modified while the operation is in progress.
|
||||
* <P>
|
||||
* If the <CODE>addAll()</CODE> operation throws an exception, the effect
|
||||
* If the {@code addAll()} operation throws an exception, the effect
|
||||
* on this attribute set's state is implementation dependent; elements
|
||||
* from the specified set before the point of the exception may or
|
||||
* may not have been added to this attribute set.
|
||||
@ -89,12 +89,12 @@ public interface PrintJobAttributeSet extends AttributeSet {
|
||||
* @param attributes whose elements are to be added to this attribute
|
||||
* set.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set changed as a result of
|
||||
* @return {@code true} if this attribute set changed as a result of
|
||||
* the call.
|
||||
*
|
||||
* @throws UnmodifiableSetException
|
||||
* (Unchecked exception) Thrown if this attribute set does not
|
||||
* support the <tt>addAll()</tt> method.
|
||||
* support the {@code addAll()} method.
|
||||
* @throws ClassCastException
|
||||
* (Unchecked exception) Thrown if some element in the specified
|
||||
* set is not an instance of interface {@link PrintJobAttribute
|
||||
|
||||
@ -53,19 +53,19 @@ public interface PrintRequestAttributeSet extends AttributeSet {
|
||||
*
|
||||
* @param attribute Attribute value to be added to this attribute set.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set changed as a result of
|
||||
* @return {@code true} if this attribute set changed as a result of
|
||||
* the call, i.e., the given attribute value was not already a
|
||||
* member of this attribute set.
|
||||
*
|
||||
* @throws UnmodifiableSetException
|
||||
* (unchecked exception) Thrown if this attribute set does not
|
||||
* support the <CODE>add()</CODE> operation.
|
||||
* support the {@code add()} operation.
|
||||
* @throws ClassCastException
|
||||
* (unchecked exception) Thrown if the <CODE>attribute</CODE> is
|
||||
* (unchecked exception) Thrown if the {@code attribute} is
|
||||
* not an instance of interface
|
||||
* {@link PrintRequestAttribute PrintRequestAttribute}.
|
||||
* @throws NullPointerException
|
||||
* (unchecked exception) Thrown if the <CODE>attribute</CODE> is null.
|
||||
* (unchecked exception) Thrown if the {@code attribute} is null.
|
||||
*/
|
||||
public boolean add(Attribute attribute);
|
||||
|
||||
@ -76,13 +76,13 @@ public interface PrintRequestAttributeSet extends AttributeSet {
|
||||
* operation had been applied to this attribute set successively with
|
||||
* each element from the specified set. If none of the categories in the
|
||||
* specified set are the same as any categories in this attribute set,
|
||||
* the <tt>addAll()</tt> operation effectively modifies this attribute
|
||||
* the {@code addAll()} operation effectively modifies this attribute
|
||||
* set so that its value is the <i>union</i> of the two sets.
|
||||
* <P>
|
||||
* The behavior of the <CODE>addAll()</CODE> operation is unspecified if
|
||||
* The behavior of the {@code addAll()} operation is unspecified if
|
||||
* the specified set is modified while the operation is in progress.
|
||||
* <P>
|
||||
* If the <CODE>addAll()</CODE> operation throws an exception, the effect
|
||||
* If the {@code addAll()} operation throws an exception, the effect
|
||||
* on this attribute set's state is implementation dependent; elements
|
||||
* from the specified set before the point of the exception may or
|
||||
* may not have been added to this attribute set.
|
||||
@ -90,12 +90,12 @@ public interface PrintRequestAttributeSet extends AttributeSet {
|
||||
* @param attributes whose elements are to be added to this attribute
|
||||
* set.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set changed as a result of
|
||||
* @return {@code true} if this attribute set changed as a result of
|
||||
* the call.
|
||||
*
|
||||
* @throws UnmodifiableSetException
|
||||
* (Unchecked exception) Thrown if this attribute set does not
|
||||
* support the <tt>addAll()</tt> method.
|
||||
* support the {@code addAll()} method.
|
||||
* @throws ClassCastException
|
||||
* (Unchecked exception) Thrown if some element in the specified
|
||||
* set is not an instance of interface {@link PrintRequestAttribute
|
||||
|
||||
@ -57,19 +57,19 @@ public interface PrintServiceAttributeSet extends AttributeSet {
|
||||
*
|
||||
* @param attribute Attribute value to be added to this attribute set.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set changed as a result of
|
||||
* @return {@code true} if this attribute set changed as a result of
|
||||
* the call, i.e., the given attribute value was not already a
|
||||
* member of this attribute set.
|
||||
*
|
||||
* @throws UnmodifiableSetException
|
||||
* (unchecked exception) Thrown if this attribute set does not
|
||||
* support the <CODE>add()</CODE> operation.
|
||||
* support the {@code add()} operation.
|
||||
* @throws ClassCastException
|
||||
* (unchecked exception) Thrown if the <CODE>attribute</CODE> is
|
||||
* (unchecked exception) Thrown if the {@code attribute} is
|
||||
* not an instance of interface
|
||||
* {@link PrintServiceAttribute PrintServiceAttribute}.
|
||||
* @throws NullPointerException
|
||||
* (unchecked exception) Thrown if the <CODE>attribute</CODE> is null.
|
||||
* (unchecked exception) Thrown if the {@code attribute} is null.
|
||||
*/
|
||||
public boolean add(Attribute attribute);
|
||||
|
||||
@ -80,13 +80,13 @@ public interface PrintServiceAttributeSet extends AttributeSet {
|
||||
* operation had been applied to this attribute set successively with
|
||||
* each element from the specified set. If none of the categories in the
|
||||
* specified set are the same as any categories in this attribute set,
|
||||
* the <tt>addAll()</tt> operation effectively modifies this attribute
|
||||
* the {@code addAll()} operation effectively modifies this attribute
|
||||
* set so that its value is the <i>union</i> of the two sets.
|
||||
* <P>
|
||||
* The behavior of the <CODE>addAll()</CODE> operation is unspecified if
|
||||
* The behavior of the {@code addAll()} operation is unspecified if
|
||||
* the specified set is modified while the operation is in progress.
|
||||
* <P>
|
||||
* If the <CODE>addAll()</CODE> operation throws an exception, the effect
|
||||
* If the {@code addAll()} operation throws an exception, the effect
|
||||
* on this attribute set's state is implementation dependent; elements
|
||||
* from the specified set before the point of the exception may or
|
||||
* may not have been added to this attribute set.
|
||||
@ -94,12 +94,12 @@ public interface PrintServiceAttributeSet extends AttributeSet {
|
||||
* @param attributes whose elements are to be added to this attribute
|
||||
* set.
|
||||
*
|
||||
* @return <tt>true</tt> if this attribute set changed as a result of
|
||||
* @return {@code true} if this attribute set changed as a result of
|
||||
* the call.
|
||||
*
|
||||
* @throws UnmodifiableSetException
|
||||
* (Unchecked exception) Thrown if this attribute set does not
|
||||
* support the <tt>addAll()</tt> method.
|
||||
* support the {@code addAll()} method.
|
||||
* @throws ClassCastException
|
||||
* (Unchecked exception) Thrown if some element in the specified
|
||||
* set is not an instance of interface {@link PrintServiceAttribute
|
||||
|
||||
@ -59,8 +59,8 @@ import javax.print.attribute.PrintJobAttribute;
|
||||
* java.util.Collections}).
|
||||
* <P>
|
||||
* <B>IPP Compatibility:</B> The string value returned by each individual {@link
|
||||
* JobStateReason JobStateReason} object's <CODE>toString()</CODE> method gives
|
||||
* the IPP keyword value. The category name returned by <CODE>getName()</CODE>
|
||||
* JobStateReason JobStateReason} object's {@code toString()} method gives
|
||||
* the IPP keyword value. The category name returned by {@code getName()}
|
||||
* gives the IPP attribute name.
|
||||
*
|
||||
* @author Alan Kaminsky
|
||||
@ -114,11 +114,11 @@ public final class JobStateReasons
|
||||
* @param collection Collection to copy.
|
||||
*
|
||||
* @exception NullPointerException
|
||||
* (unchecked exception) Thrown if <CODE>collection</CODE> is null or
|
||||
* if any element in <CODE>collection</CODE> is null.
|
||||
* (unchecked exception) Thrown if {@code collection} is null or
|
||||
* if any element in {@code collection} is null.
|
||||
* @throws ClassCastException
|
||||
* (unchecked exception) Thrown if any element in
|
||||
* <CODE>collection</CODE> is not an instance of class {@link
|
||||
* {@code collection} is not an instance of class {@link
|
||||
* JobStateReason JobStateReason}.
|
||||
*/
|
||||
public JobStateReasons(Collection<JobStateReason> collection) {
|
||||
@ -130,11 +130,11 @@ public final class JobStateReasons
|
||||
* not already present. The element to be added must be an instance of class
|
||||
* {@link JobStateReason JobStateReason}. If this job state reasons
|
||||
* attribute already contains the specified element, the call leaves this
|
||||
* job state reasons attribute unchanged and returns <tt>false</tt>.
|
||||
* job state reasons attribute unchanged and returns {@code false}.
|
||||
*
|
||||
* @param o Element to be added to this job state reasons attribute.
|
||||
*
|
||||
* @return <tt>true</tt> if this job state reasons attribute did not
|
||||
* @return {@code true} if this job state reasons attribute did not
|
||||
* already contain the specified element.
|
||||
*
|
||||
* @throws NullPointerException
|
||||
@ -169,7 +169,7 @@ public final class JobStateReasons
|
||||
* instance.
|
||||
* <P>
|
||||
* For class JobStateReasons, the category
|
||||
* name is <CODE>"job-state-reasons"</CODE>.
|
||||
* name is {@code "job-state-reasons"}.
|
||||
*
|
||||
* @return Attribute category name.
|
||||
*/
|
||||
|
||||
@ -72,10 +72,10 @@ import javax.print.attribute.PrintServiceAttribute;
|
||||
* <P>
|
||||
* <B>IPP Compatibility:</B> The string values returned by each individual
|
||||
* {@link PrinterStateReason PrinterStateReason} object's and the associated
|
||||
* {@link Severity Severity} object's <CODE>toString()</CODE> methods,
|
||||
* {@link Severity Severity} object's {@code toString()} methods,
|
||||
* concatenated
|
||||
* together with a hyphen (<CODE>"-"</CODE>) in between, gives the IPP keyword
|
||||
* value. The category name returned by <CODE>getName()</CODE> gives the IPP
|
||||
* together with a hyphen ({@code "-"}) in between, gives the IPP keyword
|
||||
* value. The category name returned by {@code getName()} gives the IPP
|
||||
* attribute name.
|
||||
*
|
||||
* @author Alan Kaminsky
|
||||
@ -133,12 +133,12 @@ public final class PrinterStateReasons
|
||||
* @param map Map to copy.
|
||||
*
|
||||
* @exception NullPointerException
|
||||
* (unchecked exception) Thrown if <CODE>map</CODE> is null or if any
|
||||
* key or value in <CODE>map</CODE> is null.
|
||||
* (unchecked exception) Thrown if {@code map} is null or if any
|
||||
* key or value in {@code map} is null.
|
||||
* @throws ClassCastException
|
||||
* (unchecked exception) Thrown if any key in <CODE>map</CODE> is not
|
||||
* (unchecked exception) Thrown if any key in {@code map} is not
|
||||
* an instance of class {@link PrinterStateReason PrinterStateReason} or
|
||||
* if any value in <CODE>map</CODE> is not an instance of class
|
||||
* if any value in {@code map} is not an instance of class
|
||||
* {@link Severity Severity}.
|
||||
*/
|
||||
public PrinterStateReasons(Map<PrinterStateReason,Severity> map) {
|
||||
@ -159,16 +159,16 @@ public final class PrinterStateReasons
|
||||
* an instance of class {@link Severity Severity}.
|
||||
*
|
||||
* @return Previous severity associated with the given printer state
|
||||
* reason, or <tt>null</tt> if the given printer state reason was
|
||||
* reason, or {@code null} if the given printer state reason was
|
||||
* not present.
|
||||
*
|
||||
* @throws NullPointerException
|
||||
* (unchecked exception) Thrown if <CODE>reason</CODE> is null or
|
||||
* <CODE>severity</CODE> is null.
|
||||
* (unchecked exception) Thrown if {@code reason} is null or
|
||||
* {@code severity} is null.
|
||||
* @throws ClassCastException
|
||||
* (unchecked exception) Thrown if <CODE>reason</CODE> is not an
|
||||
* (unchecked exception) Thrown if {@code reason} is not an
|
||||
* instance of class {@link PrinterStateReason PrinterStateReason} or if
|
||||
* <CODE>severity</CODE> is not an instance of class {@link Severity
|
||||
* {@code severity} is not an instance of class {@link Severity
|
||||
* Severity}.
|
||||
* @since 1.5
|
||||
*/
|
||||
@ -201,7 +201,7 @@ public final class PrinterStateReasons
|
||||
* instance.
|
||||
* <P>
|
||||
* For class PrinterStateReasons, the
|
||||
* category name is <CODE>"printer-state-reasons"</CODE>.
|
||||
* category name is {@code "printer-state-reasons"}.
|
||||
*
|
||||
* @return Attribute category name.
|
||||
*/
|
||||
@ -228,7 +228,7 @@ public final class PrinterStateReasons
|
||||
* Severity} level.
|
||||
*
|
||||
* @exception NullPointerException
|
||||
* (unchecked exception) Thrown if <CODE>severity</CODE> is null.
|
||||
* (unchecked exception) Thrown if {@code severity} is null.
|
||||
*/
|
||||
public Set<PrinterStateReason> printerStateReasonSet(Severity severity) {
|
||||
if (severity == null) {
|
||||
|
||||
@ -54,28 +54,28 @@ import java.io.PrintStream;
|
||||
* <p> The BoxLayout manager is constructed with an axis parameter that
|
||||
* specifies the type of layout that will be done. There are four choices:
|
||||
*
|
||||
* <blockquote><b><tt>X_AXIS</tt></b> - Components are laid out horizontally
|
||||
* <blockquote><b>{@code X_AXIS}</b> - Components are laid out horizontally
|
||||
* from left to right.</blockquote>
|
||||
*
|
||||
* <blockquote><b><tt>Y_AXIS</tt></b> - Components are laid out vertically
|
||||
* <blockquote><b>{@code Y_AXIS}</b> - Components are laid out vertically
|
||||
* from top to bottom.</blockquote>
|
||||
*
|
||||
* <blockquote><b><tt>LINE_AXIS</tt></b> - Components are laid out the way
|
||||
* <blockquote><b>{@code LINE_AXIS}</b> - Components are laid out the way
|
||||
* words are laid out in a line, based on the container's
|
||||
* <tt>ComponentOrientation</tt> property. If the container's
|
||||
* <tt>ComponentOrientation</tt> is horizontal then components are laid out
|
||||
* {@code ComponentOrientation} property. If the container's
|
||||
* {@code ComponentOrientation} is horizontal then components are laid out
|
||||
* horizontally, otherwise they are laid out vertically. For horizontal
|
||||
* orientations, if the container's <tt>ComponentOrientation</tt> is left to
|
||||
* orientations, if the container's {@code ComponentOrientation} is left to
|
||||
* right then components are laid out left to right, otherwise they are laid
|
||||
* out right to left. For vertical orientations components are always laid out
|
||||
* from top to bottom.</blockquote>
|
||||
*
|
||||
* <blockquote><b><tt>PAGE_AXIS</tt></b> - Components are laid out the way
|
||||
* <blockquote><b>{@code PAGE_AXIS}</b> - Components are laid out the way
|
||||
* text lines are laid out on a page, based on the container's
|
||||
* <tt>ComponentOrientation</tt> property. If the container's
|
||||
* <tt>ComponentOrientation</tt> is horizontal then components are laid out
|
||||
* {@code ComponentOrientation} property. If the container's
|
||||
* {@code ComponentOrientation} is horizontal then components are laid out
|
||||
* vertically, otherwise they are laid out horizontally. For horizontal
|
||||
* orientations, if the container's <tt>ComponentOrientation</tt> is left to
|
||||
* orientations, if the container's {@code ComponentOrientation} is left to
|
||||
* right then components are laid out left to right, otherwise they are laid
|
||||
* out right to left. For vertical orientations components are always
|
||||
* laid out from top to bottom.</blockquote>
|
||||
@ -102,10 +102,10 @@ import java.io.PrintStream;
|
||||
* BoxLayout attempts to make all components in the column
|
||||
* as wide as the widest component.
|
||||
* If that fails, it aligns them horizontally
|
||||
* according to their X alignments. For <code>PAGE_AXIS</code> layout,
|
||||
* according to their X alignments. For {@code PAGE_AXIS} layout,
|
||||
* horizontal alignment is done based on the leading edge of the component.
|
||||
* In other words, an X alignment value of 0.0 means the left edge of a
|
||||
* component if the container's <code>ComponentOrientation</code> is left to
|
||||
* component if the container's {@code ComponentOrientation} is left to
|
||||
* right and it means the right edge of the component otherwise.
|
||||
* <p>
|
||||
* Instead of using BoxLayout directly, many programs use the Box class.
|
||||
@ -125,7 +125,7 @@ import java.io.PrintStream;
|
||||
* appropriate for short term storage or RMI between applications running
|
||||
* the same version of Swing. As of 1.4, support for long term storage
|
||||
* of all JavaBeans™
|
||||
* has been added to the <code>java.beans</code> package.
|
||||
* has been added to the {@code java.beans} package.
|
||||
* Please see {@link java.beans.XMLEncoder}.
|
||||
*
|
||||
* @see Box
|
||||
@ -152,14 +152,14 @@ public class BoxLayout implements LayoutManager2, Serializable {
|
||||
/**
|
||||
* Specifies that components should be laid out in the direction of
|
||||
* a line of text as determined by the target container's
|
||||
* <code>ComponentOrientation</code> property.
|
||||
* {@code ComponentOrientation} property.
|
||||
*/
|
||||
public static final int LINE_AXIS = 2;
|
||||
|
||||
/**
|
||||
* Specifies that components should be laid out in the direction that
|
||||
* lines flow across a page as determined by the target container's
|
||||
* <code>ComponentOrientation</code> property.
|
||||
* {@code ComponentOrientation} property.
|
||||
*/
|
||||
public static final int PAGE_AXIS = 3;
|
||||
|
||||
@ -169,12 +169,10 @@ public class BoxLayout implements LayoutManager2, Serializable {
|
||||
*
|
||||
* @param target the container that needs to be laid out
|
||||
* @param axis the axis to lay out components along. Can be one of:
|
||||
* <code>BoxLayout.X_AXIS</code>,
|
||||
* <code>BoxLayout.Y_AXIS</code>,
|
||||
* <code>BoxLayout.LINE_AXIS</code> or
|
||||
* <code>BoxLayout.PAGE_AXIS</code>
|
||||
* {@code BoxLayout.X_AXIS, BoxLayout.Y_AXIS,
|
||||
* BoxLayout.LINE_AXIS} or {@code BoxLayout.PAGE_AXIS}
|
||||
*
|
||||
* @exception AWTError if the value of <code>axis</code> is invalid
|
||||
* @exception AWTError if the value of {@code axis} is invalid
|
||||
*/
|
||||
@ConstructorProperties({"target", "axis"})
|
||||
public BoxLayout(Container target, int axis) {
|
||||
@ -192,10 +190,8 @@ public class BoxLayout implements LayoutManager2, Serializable {
|
||||
*
|
||||
* @param target the container that needs to be laid out
|
||||
* @param axis the axis to lay out components along. Can be one of:
|
||||
* <code>BoxLayout.X_AXIS</code>,
|
||||
* <code>BoxLayout.Y_AXIS</code>,
|
||||
* <code>BoxLayout.LINE_AXIS</code> or
|
||||
* <code>BoxLayout.PAGE_AXIS</code>
|
||||
* {@code BoxLayout.X_AXIS, BoxLayout.Y_AXIS,
|
||||
* BoxLayout.LINE_AXIS} or {@code BoxLayout.PAGE_AXIS}
|
||||
*
|
||||
* @param dbg the stream to which debugging messages should be sent,
|
||||
* null if none
|
||||
@ -219,10 +215,8 @@ public class BoxLayout implements LayoutManager2, Serializable {
|
||||
/**
|
||||
* Returns the axis that was used to lay out components.
|
||||
* Returns one of:
|
||||
* <code>BoxLayout.X_AXIS</code>,
|
||||
* <code>BoxLayout.Y_AXIS</code>,
|
||||
* <code>BoxLayout.LINE_AXIS</code> or
|
||||
* <code>BoxLayout.PAGE_AXIS</code>
|
||||
* {@code BoxLayout.X_AXIS, BoxLayout.Y_AXIS,
|
||||
* BoxLayout.LINE_AXIS} or {@code BoxLayout.PAGE_AXIS}
|
||||
*
|
||||
* @return the axis that was used to lay out components
|
||||
*
|
||||
|
||||
@ -30,8 +30,8 @@ import java.util.Enumeration;
|
||||
* A generic interface for a mutable collection of unique attributes.
|
||||
*
|
||||
* Implementations will probably want to provide a constructor of the
|
||||
* form:<tt>
|
||||
* public XXXAttributeSet(ConstAttributeSet source);</tt>
|
||||
* form: <pre>{@code
|
||||
* public XXXAttributeSet(ConstAttributeSet source);}</pre>
|
||||
*
|
||||
*/
|
||||
public interface MutableAttributeSet extends AttributeSet {
|
||||
@ -55,21 +55,21 @@ public interface MutableAttributeSet extends AttributeSet {
|
||||
public void addAttributes(AttributeSet attributes);
|
||||
|
||||
/**
|
||||
* Removes an attribute with the given <code>name</code>.
|
||||
* Removes an attribute with the given {@code name}.
|
||||
*
|
||||
* @param name the attribute name
|
||||
*/
|
||||
public void removeAttribute(Object name);
|
||||
|
||||
/**
|
||||
* Removes an attribute set with the given <code>names</code>.
|
||||
* Removes an attribute set with the given {@code names}.
|
||||
*
|
||||
* @param names the set of names
|
||||
*/
|
||||
public void removeAttributes(Enumeration<?> names);
|
||||
|
||||
/**
|
||||
* Removes a set of attributes with the given <code>name</code>.
|
||||
* Removes a set of attributes with the given {@code name}.
|
||||
*
|
||||
* @param attributes the set of attributes
|
||||
*/
|
||||
|
||||
@ -33,33 +33,33 @@ import java.util.List;
|
||||
import java.util.RandomAccess;
|
||||
|
||||
/**
|
||||
* Resizable-array implementation of the <tt>List</tt> interface. Implements
|
||||
* Resizable-array implementation of the {@code List} interface. Implements
|
||||
* all optional list operations, and permits all elements, including
|
||||
* <tt>null</tt>. In addition to implementing the <tt>List</tt> interface,
|
||||
* {@code null}. In addition to implementing the {@code List} interface,
|
||||
* this class provides methods to manipulate the size of the array that is
|
||||
* used internally to store the list. (This class is roughly equivalent to
|
||||
* <tt>Vector</tt>, except that it is unsynchronized.)<p>
|
||||
* {@code Vector}, except that it is unsynchronized.)<p>
|
||||
*
|
||||
* The <tt>size</tt>, <tt>isEmpty</tt>, <tt>get</tt>, <tt>set</tt>,
|
||||
* <tt>iterator</tt>, and <tt>listIterator</tt> operations run in constant
|
||||
* time. The <tt>add</tt> operation runs in <i>amortized constant time</i>,
|
||||
* The {@code size}, {@code isEmpty}, {@code get}, {@code set},
|
||||
* {@code iterator}, and {@code listIterator} operations run in constant
|
||||
* time. The {@code add} operation runs in <i>amortized constant time</i>,
|
||||
* that is, adding n elements requires O(n) time. All of the other operations
|
||||
* run in linear time (roughly speaking). The constant factor is low compared
|
||||
* to that for the <tt>LinkedList</tt> implementation.<p>
|
||||
* to that for the {@code LinkedList} implementation.<p>
|
||||
*
|
||||
* Each <tt>IdentityArrayList</tt> instance has a <i>capacity</i>. The capacity is
|
||||
* Each {@code IdentityArrayList} instance has a <i>capacity</i>. The capacity is
|
||||
* the size of the array used to store the elements in the list. It is always
|
||||
* at least as large as the list size. As elements are added to an IdentityArrayList,
|
||||
* its capacity grows automatically. The details of the growth policy are not
|
||||
* specified beyond the fact that adding an element has constant amortized
|
||||
* time cost.<p>
|
||||
*
|
||||
* An application can increase the capacity of an <tt>IdentityArrayList</tt> instance
|
||||
* before adding a large number of elements using the <tt>ensureCapacity</tt>
|
||||
* An application can increase the capacity of an {@code IdentityArrayList} instance
|
||||
* before adding a large number of elements using the {@code ensureCapacity}
|
||||
* operation. This may reduce the amount of incremental reallocation.
|
||||
*
|
||||
* <p><strong>Note that this implementation is not synchronized.</strong>
|
||||
* If multiple threads access an <tt>IdentityArrayList</tt> instance concurrently,
|
||||
* If multiple threads access an {@code IdentityArrayList} instance concurrently,
|
||||
* and at least one of the threads modifies the list structurally, it
|
||||
* <i>must</i> be synchronized externally. (A structural modification is
|
||||
* any operation that adds or deletes one or more elements, or explicitly
|
||||
@ -73,10 +73,10 @@ import java.util.RandomAccess;
|
||||
* unsynchronized access to the list:<pre>
|
||||
* List list = Collections.synchronizedList(new IdentityArrayList(...));</pre>
|
||||
*
|
||||
* <p>The iterators returned by this class's <tt>iterator</tt> and
|
||||
* <tt>listIterator</tt> methods are <i>fail-fast</i>: if the list is
|
||||
* <p>The iterators returned by this class's {@code iterator} and
|
||||
* {@code listIterator} methods are <i>fail-fast</i>: if the list is
|
||||
* structurally modified at any time after the iterator is created, in any way
|
||||
* except through the iterator's own <tt>remove</tt> or <tt>add</tt> methods,
|
||||
* except through the iterator's own {@code remove} or {@code add} methods,
|
||||
* the iterator will throw a {@link ConcurrentModificationException}. Thus, in
|
||||
* the face of concurrent modification, the iterator fails quickly and cleanly,
|
||||
* rather than risking arbitrary, non-deterministic behavior at an undetermined
|
||||
@ -85,7 +85,7 @@ import java.util.RandomAccess;
|
||||
* Note that the fail-fast behavior of an iterator cannot be guaranteed
|
||||
* as it is, generally speaking, impossible to make any hard guarantees in the
|
||||
* presence of unsynchronized concurrent modification. Fail-fast iterators
|
||||
* throw <tt>ConcurrentModificationException</tt> on a best-effort basis.
|
||||
* throw {@code ConcurrentModificationException} on a best-effort basis.
|
||||
* Therefore, it would be wrong to write a program that depended on this
|
||||
* exception for its correctness: <i>the fail-fast behavior of iterators
|
||||
* should be used only to detect bugs.</i><p>
|
||||
@ -149,9 +149,9 @@ public class IdentityArrayList<E> extends AbstractList<E>
|
||||
}
|
||||
|
||||
/**
|
||||
* Trims the capacity of this <tt>IdentityArrayList</tt> instance to be the
|
||||
* Trims the capacity of this {@code IdentityArrayList} instance to be the
|
||||
* list's current size. An application can use this operation to minimize
|
||||
* the storage of an <tt>IdentityArrayList</tt> instance.
|
||||
* the storage of an {@code IdentityArrayList} instance.
|
||||
*/
|
||||
public void trimToSize() {
|
||||
modCount++;
|
||||
@ -162,7 +162,7 @@ public class IdentityArrayList<E> extends AbstractList<E>
|
||||
}
|
||||
|
||||
/**
|
||||
* Increases the capacity of this <tt>IdentityArrayList</tt> instance, if
|
||||
* Increases the capacity of this {@code IdentityArrayList} instance, if
|
||||
* necessary, to ensure that it can hold at least the number of elements
|
||||
* specified by the minimum capacity argument.
|
||||
*
|
||||
@ -191,22 +191,22 @@ public class IdentityArrayList<E> extends AbstractList<E>
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if this list contains no elements.
|
||||
* Returns {@code true} if this list contains no elements.
|
||||
*
|
||||
* @return <tt>true</tt> if this list contains no elements
|
||||
* @return {@code true} if this list contains no elements
|
||||
*/
|
||||
public boolean isEmpty() {
|
||||
return size == 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if this list contains the specified element.
|
||||
* More formally, returns <tt>true</tt> if and only if this list contains
|
||||
* at least one element <tt>e</tt> such that
|
||||
* <tt>(o==null ? e==null : o == e)</tt>.
|
||||
* Returns {@code true} if this list contains the specified element.
|
||||
* More formally, returns {@code true} if and only if this list contains
|
||||
* at least one element {@code e} such that
|
||||
* {@code Objects.equals(o, e)}.
|
||||
*
|
||||
* @param o element whose presence in this list is to be tested
|
||||
* @return <tt>true</tt> if this list contains the specified element
|
||||
* @return {@code true} if this list contains the specified element
|
||||
*/
|
||||
public boolean contains(Object o) {
|
||||
return indexOf(o) >= 0;
|
||||
@ -215,8 +215,8 @@ public class IdentityArrayList<E> extends AbstractList<E>
|
||||
/**
|
||||
* Returns the index of the first occurrence of the specified element
|
||||
* in this list, or -1 if this list does not contain the element.
|
||||
* More formally, returns the lowest index <tt>i</tt> such that
|
||||
* <tt>(o==null ? get(i)==null : o == get(i))</tt>,
|
||||
* More formally, returns the lowest index {@code i} such that
|
||||
* {@code Objects.equals(o, get(i))},
|
||||
* or -1 if there is no such index.
|
||||
*/
|
||||
public int indexOf(Object o) {
|
||||
@ -231,8 +231,8 @@ public class IdentityArrayList<E> extends AbstractList<E>
|
||||
/**
|
||||
* Returns the index of the last occurrence of the specified element
|
||||
* in this list, or -1 if this list does not contain the element.
|
||||
* More formally, returns the highest index <tt>i</tt> such that
|
||||
* <tt>(o==null ? get(i)==null : o == get(i))</tt>,
|
||||
* More formally, returns the highest index {@code i} such that
|
||||
* {@code Objects.equals(o, get(i))},
|
||||
* or -1 if there is no such index.
|
||||
*/
|
||||
public int lastIndexOf(Object o) {
|
||||
@ -273,7 +273,7 @@ public class IdentityArrayList<E> extends AbstractList<E>
|
||||
* <p>If the list fits in the specified array with room to spare
|
||||
* (i.e., the array has more elements than the list), the element in
|
||||
* the array immediately following the end of the collection is set to
|
||||
* <tt>null</tt>. (This is useful in determining the length of the
|
||||
* {@code null}. (This is useful in determining the length of the
|
||||
* list <i>only</i> if the caller knows that the list does not contain
|
||||
* any null elements.)
|
||||
*
|
||||
@ -336,7 +336,7 @@ public class IdentityArrayList<E> extends AbstractList<E>
|
||||
* Appends the specified element to the end of this list.
|
||||
*
|
||||
* @param e element to be appended to this list
|
||||
* @return <tt>true</tt> (as specified by {@link Collection#add})
|
||||
* @return {@code true} (as specified by {@link Collection#add})
|
||||
*/
|
||||
public boolean add(E e) {
|
||||
ensureCapacity(size + 1); // Increments modCount!!
|
||||
@ -392,14 +392,13 @@ public class IdentityArrayList<E> extends AbstractList<E>
|
||||
* Removes the first occurrence of the specified element from this list,
|
||||
* if it is present. If the list does not contain the element, it is
|
||||
* unchanged. More formally, removes the element with the lowest index
|
||||
* <tt>i</tt> such that
|
||||
* <tt>(o==null ? get(i)==null : o == get(i))</tt>
|
||||
* (if such an element exists). Returns <tt>true</tt> if this list
|
||||
* {@code i} such that {@code Objects.equals(o, get(i))}
|
||||
* (if such an element exists). Returns {@code true} if this list
|
||||
* contained the specified element (or equivalently, if this list
|
||||
* changed as a result of the call).
|
||||
*
|
||||
* @param o element to be removed from this list, if present
|
||||
* @return <tt>true</tt> if this list contained the specified element
|
||||
* @return {@code true} if this list contained the specified element
|
||||
*/
|
||||
public boolean remove(Object o) {
|
||||
for (int index = 0; index < size; index++) {
|
||||
@ -448,7 +447,7 @@ public class IdentityArrayList<E> extends AbstractList<E>
|
||||
* list is nonempty.)
|
||||
*
|
||||
* @param c collection containing elements to be added to this list
|
||||
* @return <tt>true</tt> if this list changed as a result of the call
|
||||
* @return {@code true} if this list changed as a result of the call
|
||||
* @throws NullPointerException if the specified collection is null
|
||||
*/
|
||||
public boolean addAll(Collection<? extends E> c) {
|
||||
@ -471,7 +470,7 @@ public class IdentityArrayList<E> extends AbstractList<E>
|
||||
* @param index index at which to insert the first element from the
|
||||
* specified collection
|
||||
* @param c collection containing elements to be added to this list
|
||||
* @return <tt>true</tt> if this list changed as a result of the call
|
||||
* @return {@code true} if this list changed as a result of the call
|
||||
* @throws IndexOutOfBoundsException {@inheritDoc}
|
||||
* @throws NullPointerException if the specified collection is null
|
||||
*/
|
||||
@ -494,10 +493,10 @@ public class IdentityArrayList<E> extends AbstractList<E>
|
||||
|
||||
/**
|
||||
* Removes from this list all of the elements whose index is between
|
||||
* <tt>fromIndex</tt>, inclusive, and <tt>toIndex</tt>, exclusive.
|
||||
* {@code fromIndex}, inclusive, and {@code toIndex}, exclusive.
|
||||
* Shifts any succeeding elements to the left (reduces their index).
|
||||
* This call shortens the list by <tt>(toIndex - fromIndex)</tt> elements.
|
||||
* (If <tt>toIndex==fromIndex</tt>, this operation has no effect.)
|
||||
* This call shortens the list by {@code (toIndex - fromIndex)} elements.
|
||||
* (If {@code toIndex==fromIndex}, this operation has no effect.)
|
||||
*
|
||||
* @param fromIndex index of first element to be removed
|
||||
* @param toIndex index after last element to be removed
|
||||
|
||||
@ -35,18 +35,18 @@ import java.util.ListIterator;
|
||||
import java.util.NoSuchElementException;
|
||||
|
||||
/**
|
||||
* Linked list implementation of the <tt>List</tt> interface. Implements all
|
||||
* Linked list implementation of the {@code List} interface. Implements all
|
||||
* optional list operations, and permits all elements (including
|
||||
* <tt>null</tt>). In addition to implementing the <tt>List</tt> interface,
|
||||
* the <tt>IdentityLinkedList</tt> class provides uniformly named methods to
|
||||
* <tt>get</tt>, <tt>remove</tt> and <tt>insert</tt> an element at the
|
||||
* {@code null}). In addition to implementing the {@code List} interface,
|
||||
* the {@code IdentityLinkedList} class provides uniformly named methods to
|
||||
* {@code get}, {@code remove} and {@code insert} an element at the
|
||||
* beginning and end of the list. These operations allow linked lists to be
|
||||
* used as a stack, {@linkplain java.util.Queue queue}, or {@linkplain Deque
|
||||
* double-ended queue}. <p>
|
||||
*
|
||||
* The class implements the <tt>Deque</tt> interface, providing
|
||||
* first-in-first-out queue operations for <tt>add</tt>,
|
||||
* <tt>poll</tt>, along with other stack and deque operations.<p>
|
||||
* The class implements the {@code Deque} interface, providing
|
||||
* first-in-first-out queue operations for {@code add},
|
||||
* {@code poll}, along with other stack and deque operations.<p>
|
||||
*
|
||||
* All of the operations perform as could be expected for a doubly-linked
|
||||
* list. Operations that index into the list will traverse the list from
|
||||
@ -67,11 +67,11 @@ import java.util.NoSuchElementException;
|
||||
* unsynchronized access to the list:<pre>
|
||||
* List list = Collections.synchronizedList(new IdentityLinkedList(...));</pre>
|
||||
*
|
||||
* <p>The iterators returned by this class's <tt>iterator</tt> and
|
||||
* <tt>listIterator</tt> methods are <i>fail-fast</i>: if the list is
|
||||
* <p>The iterators returned by this class's {@code iterator} and
|
||||
* {@code listIterator} methods are <i>fail-fast</i>: if the list is
|
||||
* structurally modified at any time after the iterator is created, in
|
||||
* any way except through the Iterator's own <tt>remove</tt> or
|
||||
* <tt>add</tt> methods, the iterator will throw a {@link
|
||||
* any way except through the Iterator's own {@code remove} or
|
||||
* {@code add} methods, the iterator will throw a {@link
|
||||
* ConcurrentModificationException}. Thus, in the face of concurrent
|
||||
* modification, the iterator fails quickly and cleanly, rather than
|
||||
* risking arbitrary, non-deterministic behavior at an undetermined
|
||||
@ -80,7 +80,7 @@ import java.util.NoSuchElementException;
|
||||
* <p>Note that the fail-fast behavior of an iterator cannot be guaranteed
|
||||
* as it is, generally speaking, impossible to make any hard guarantees in the
|
||||
* presence of unsynchronized concurrent modification. Fail-fast iterators
|
||||
* throw <tt>ConcurrentModificationException</tt> on a best-effort basis.
|
||||
* throw {@code ConcurrentModificationException} on a best-effort basis.
|
||||
* Therefore, it would be wrong to write a program that depended on this
|
||||
* exception for its correctness: <i>the fail-fast behavior of iterators
|
||||
* should be used only to detect bugs.</i>
|
||||
@ -180,13 +180,13 @@ public class IdentityLinkedList<E>
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns <tt>true</tt> if this list contains the specified element.
|
||||
* More formally, returns <tt>true</tt> if and only if this list contains
|
||||
* at least one element <tt>e</tt> such that
|
||||
* <tt>(o==null ? e==null : o == e)</tt>.
|
||||
* Returns {@code true} if this list contains the specified element.
|
||||
* More formally, returns {@code true} if and only if this list contains
|
||||
* at least one element {@code e} such that
|
||||
* {@code Objects.equals(o, e)}.
|
||||
*
|
||||
* @param o element whose presence in this list is to be tested
|
||||
* @return <tt>true</tt> if this list contains the specified element
|
||||
* @return {@code true} if this list contains the specified element
|
||||
*/
|
||||
public boolean contains(Object o) {
|
||||
return indexOf(o) != -1;
|
||||
@ -207,7 +207,7 @@ public class IdentityLinkedList<E>
|
||||
* <p>This method is equivalent to {@link #addLast}.
|
||||
*
|
||||
* @param e element to be appended to this list
|
||||
* @return <tt>true</tt> (as specified by {@link Collection#add})
|
||||
* @return {@code true} (as specified by {@link Collection#add})
|
||||
*/
|
||||
public boolean add(E e) {
|
||||
addBefore(e, header);
|
||||
@ -218,13 +218,13 @@ public class IdentityLinkedList<E>
|
||||
* Removes the first occurrence of the specified element from this list,
|
||||
* if it is present. If this list does not contain the element, it is
|
||||
* unchanged. More formally, removes the element with the lowest index
|
||||
* <tt>i</tt> such that <tt>get(i)==o</tt>
|
||||
* (if such an element exists). Returns <tt>true</tt> if this list
|
||||
* {@code i} such that {@code get(i)==o}
|
||||
* (if such an element exists). Returns {@code true} if this list
|
||||
* contained the specified element (or equivalently, if this list
|
||||
* changed as a result of the call).
|
||||
*
|
||||
* @param o element to be removed from this list, if present
|
||||
* @return <tt>true</tt> if this list contained the specified element
|
||||
* @return {@code true} if this list contained the specified element
|
||||
*/
|
||||
public boolean remove(Object o) {
|
||||
for (Entry<E> e = header.next; e != header; e = e.next) {
|
||||
@ -245,7 +245,7 @@ public class IdentityLinkedList<E>
|
||||
* this list, and it's nonempty.)
|
||||
*
|
||||
* @param c collection containing elements to be added to this list
|
||||
* @return <tt>true</tt> if this list changed as a result of the call
|
||||
* @return {@code true} if this list changed as a result of the call
|
||||
* @throws NullPointerException if the specified collection is null
|
||||
*/
|
||||
public boolean addAll(Collection<? extends E> c) {
|
||||
@ -263,7 +263,7 @@ public class IdentityLinkedList<E>
|
||||
* @param index index at which to insert the first element
|
||||
* from the specified collection
|
||||
* @param c collection containing elements to be added to this list
|
||||
* @return <tt>true</tt> if this list changed as a result of the call
|
||||
* @return {@code true} if this list changed as a result of the call
|
||||
* @throws IndexOutOfBoundsException {@inheritDoc}
|
||||
* @throws NullPointerException if the specified collection is null
|
||||
*/
|
||||
@ -388,8 +388,8 @@ public class IdentityLinkedList<E>
|
||||
/**
|
||||
* Returns the index of the first occurrence of the specified element
|
||||
* in this list, or -1 if this list does not contain the element.
|
||||
* More formally, returns the lowest index <tt>i</tt> such that
|
||||
* <tt>get(i)==o</tt>,
|
||||
* More formally, returns the lowest index {@code i} such that
|
||||
* {@code get(i)==o},
|
||||
* or -1 if there is no such index.
|
||||
*
|
||||
* @param o element to search for
|
||||
@ -410,8 +410,8 @@ public class IdentityLinkedList<E>
|
||||
/**
|
||||
* Returns the index of the last occurrence of the specified element
|
||||
* in this list, or -1 if this list does not contain the element.
|
||||
* More formally, returns the highest index <tt>i</tt> such that
|
||||
* <tt>get(i)==o</tt>,
|
||||
* More formally, returns the highest index {@code i} such that
|
||||
* {@code get(i)==o},
|
||||
* or -1 if there is no such index.
|
||||
*
|
||||
* @param o element to search for
|
||||
@ -433,7 +433,7 @@ public class IdentityLinkedList<E>
|
||||
|
||||
/**
|
||||
* Retrieves, but does not remove, the head (first element) of this list.
|
||||
* @return the head of this list, or <tt>null</tt> if this list is empty
|
||||
* @return the head of this list, or {@code null} if this list is empty
|
||||
* @since 1.5
|
||||
*/
|
||||
public E peek() {
|
||||
@ -454,7 +454,7 @@ public class IdentityLinkedList<E>
|
||||
|
||||
/**
|
||||
* Retrieves and removes the head (first element) of this list
|
||||
* @return the head of this list, or <tt>null</tt> if this list is empty
|
||||
* @return the head of this list, or {@code null} if this list is empty
|
||||
* @since 1.5
|
||||
*/
|
||||
public E poll() {
|
||||
@ -478,7 +478,7 @@ public class IdentityLinkedList<E>
|
||||
* Adds the specified element as the tail (last element) of this list.
|
||||
*
|
||||
* @param e the element to add
|
||||
* @return <tt>true</tt> (as specified by {@link java.util.Queue#offer})
|
||||
* @return {@code true} (as specified by {@link java.util.Queue#offer})
|
||||
* @since 1.5
|
||||
*/
|
||||
public boolean offer(E e) {
|
||||
@ -490,7 +490,7 @@ public class IdentityLinkedList<E>
|
||||
* Inserts the specified element at the front of this list.
|
||||
*
|
||||
* @param e the element to insert
|
||||
* @return <tt>true</tt> (as specified by {@link Deque#offerFirst})
|
||||
* @return {@code true} (as specified by {@link Deque#offerFirst})
|
||||
* @since 1.6
|
||||
*/
|
||||
public boolean offerFirst(E e) {
|
||||
@ -502,7 +502,7 @@ public class IdentityLinkedList<E>
|
||||
* Inserts the specified element at the end of this list.
|
||||
*
|
||||
* @param e the element to insert
|
||||
* @return <tt>true</tt> (as specified by {@link Deque#offerLast})
|
||||
* @return {@code true} (as specified by {@link Deque#offerLast})
|
||||
* @since 1.6
|
||||
*/
|
||||
public boolean offerLast(E e) {
|
||||
@ -512,9 +512,9 @@ public class IdentityLinkedList<E>
|
||||
|
||||
/**
|
||||
* Retrieves, but does not remove, the first element of this list,
|
||||
* or returns <tt>null</tt> if this list is empty.
|
||||
* or returns {@code null} if this list is empty.
|
||||
*
|
||||
* @return the first element of this list, or <tt>null</tt>
|
||||
* @return the first element of this list, or {@code null}
|
||||
* if this list is empty
|
||||
* @since 1.6
|
||||
*/
|
||||
@ -526,9 +526,9 @@ public class IdentityLinkedList<E>
|
||||
|
||||
/**
|
||||
* Retrieves, but does not remove, the last element of this list,
|
||||
* or returns <tt>null</tt> if this list is empty.
|
||||
* or returns {@code null} if this list is empty.
|
||||
*
|
||||
* @return the last element of this list, or <tt>null</tt>
|
||||
* @return the last element of this list, or {@code null}
|
||||
* if this list is empty
|
||||
* @since 1.6
|
||||
*/
|
||||
@ -540,9 +540,9 @@ public class IdentityLinkedList<E>
|
||||
|
||||
/**
|
||||
* Retrieves and removes the first element of this list,
|
||||
* or returns <tt>null</tt> if this list is empty.
|
||||
* or returns {@code null} if this list is empty.
|
||||
*
|
||||
* @return the first element of this list, or <tt>null</tt> if
|
||||
* @return the first element of this list, or {@code null} if
|
||||
* this list is empty
|
||||
* @since 1.6
|
||||
*/
|
||||
@ -554,9 +554,9 @@ public class IdentityLinkedList<E>
|
||||
|
||||
/**
|
||||
* Retrieves and removes the last element of this list,
|
||||
* or returns <tt>null</tt> if this list is empty.
|
||||
* or returns {@code null} if this list is empty.
|
||||
*
|
||||
* @return the last element of this list, or <tt>null</tt> if
|
||||
* @return the last element of this list, or {@code null} if
|
||||
* this list is empty
|
||||
* @since 1.6
|
||||
*/
|
||||
@ -600,7 +600,7 @@ public class IdentityLinkedList<E>
|
||||
* does not contain the element, it is unchanged.
|
||||
*
|
||||
* @param o element to be removed from this list, if present
|
||||
* @return <tt>true</tt> if the list contained the specified element
|
||||
* @return {@code true} if the list contained the specified element
|
||||
* @since 1.6
|
||||
*/
|
||||
public boolean removeFirstOccurrence(Object o) {
|
||||
@ -613,7 +613,7 @@ public class IdentityLinkedList<E>
|
||||
* does not contain the element, it is unchanged.
|
||||
*
|
||||
* @param o element to be removed from this list, if present
|
||||
* @return <tt>true</tt> if the list contained the specified element
|
||||
* @return {@code true} if the list contained the specified element
|
||||
* @since 1.6
|
||||
*/
|
||||
public boolean removeLastOccurrence(Object o) {
|
||||
@ -629,19 +629,19 @@ public class IdentityLinkedList<E>
|
||||
/**
|
||||
* Returns a list-iterator of the elements in this list (in proper
|
||||
* sequence), starting at the specified position in the list.
|
||||
* Obeys the general contract of <tt>List.listIterator(int)</tt>.<p>
|
||||
* Obeys the general contract of {@code List.listIterator(int)}.<p>
|
||||
*
|
||||
* The list-iterator is <i>fail-fast</i>: if the list is structurally
|
||||
* modified at any time after the Iterator is created, in any way except
|
||||
* through the list-iterator's own <tt>remove</tt> or <tt>add</tt>
|
||||
* through the list-iterator's own {@code remove} or {@code add}
|
||||
* methods, the list-iterator will throw a
|
||||
* <tt>ConcurrentModificationException</tt>. Thus, in the face of
|
||||
* {@code ConcurrentModificationException}. Thus, in the face of
|
||||
* concurrent modification, the iterator fails quickly and cleanly, rather
|
||||
* than risking arbitrary, non-deterministic behavior at an undetermined
|
||||
* time in the future.
|
||||
*
|
||||
* @param index index of the first element to be returned from the
|
||||
* list-iterator (by a call to <tt>next</tt>)
|
||||
* list-iterator (by a call to {@code next})
|
||||
* @return a ListIterator of the elements in this list (in proper
|
||||
* sequence), starting at the specified position in the list
|
||||
* @throws IndexOutOfBoundsException {@inheritDoc}
|
||||
@ -834,7 +834,7 @@ public class IdentityLinkedList<E>
|
||||
*
|
||||
* <p>If the list fits in the specified array with room to spare (i.e.,
|
||||
* the array has more elements than the list), the element in the array
|
||||
* immediately following the end of the list is set to <tt>null</tt>.
|
||||
* immediately following the end of the list is set to {@code null}.
|
||||
* (This is useful in determining the length of the list <i>only</i> if
|
||||
* the caller knows that the list does not contain any null elements.)
|
||||
*
|
||||
@ -843,15 +843,15 @@ public class IdentityLinkedList<E>
|
||||
* precise control over the runtime type of the output array, and may,
|
||||
* under certain circumstances, be used to save allocation costs.
|
||||
*
|
||||
* <p>Suppose <tt>x</tt> is a list known to contain only strings.
|
||||
* <p>Suppose {@code x} is a list known to contain only strings.
|
||||
* The following code can be used to dump the list into a newly
|
||||
* allocated array of <tt>String</tt>:
|
||||
* allocated array of {@code String}:
|
||||
*
|
||||
* <pre>
|
||||
* String[] y = x.toArray(new String[0]);</pre>
|
||||
*
|
||||
* Note that <tt>toArray(new Object[0])</tt> is identical in function to
|
||||
* <tt>toArray()</tt>.
|
||||
* Note that {@code toArray(new Object[0])} is identical in function to
|
||||
* {@code toArray()}.
|
||||
*
|
||||
* @param a the array into which the elements of the list are to
|
||||
* be stored, if it is big enough; otherwise, a new array of the
|
||||
|
||||
@ -72,7 +72,7 @@ import java.util.concurrent.FutureTask;
|
||||
*/
|
||||
public class SwingUtilities2 {
|
||||
/**
|
||||
* The <code>AppContext</code> key for our one <code>LAFState</code>
|
||||
* The {@code AppContext} key for our one {@code LAFState}
|
||||
* instance.
|
||||
*/
|
||||
public static final Object LAF_STATE_KEY =
|
||||
@ -180,7 +180,7 @@ public class SwingUtilities2 {
|
||||
|
||||
/**
|
||||
* Key used in client properties used to indicate that the
|
||||
* <code>ComponentUI</code> of the JComponent instance should be returned.
|
||||
* {@code ComponentUI} of the JComponent instance should be returned.
|
||||
*/
|
||||
public static final Object COMPONENT_UI_PROPERTY_KEY =
|
||||
new StringBuffer("ComponentUIPropertyKey");
|
||||
@ -221,8 +221,8 @@ public class SwingUtilities2 {
|
||||
* @param text characters to be tested
|
||||
* @param start start
|
||||
* @param limit limit
|
||||
* @return <tt>true</tt> if TextLayout is required
|
||||
* <tt>false</tt> if TextLayout is not required
|
||||
* @return {@code true} if TextLayout is required
|
||||
* {@code false} if TextLayout is not required
|
||||
*/
|
||||
public static final boolean isComplexLayout(char[] text, int start, int limit) {
|
||||
return FontUtilities.isComplexText(text, start, limit);
|
||||
@ -374,7 +374,7 @@ public class SwingUtilities2 {
|
||||
|
||||
/**
|
||||
* Returns the width of the passed in String.
|
||||
* If the passed String is <code>null</code>, returns zero.
|
||||
* If the passed String is {@code null}, returns zero.
|
||||
*
|
||||
* @param c JComponent that will display the string, may be null
|
||||
* @param fm FontMetrics used to measure the String width
|
||||
@ -761,7 +761,7 @@ public class SwingUtilities2 {
|
||||
|
||||
/**
|
||||
* Request focus on the given component if it doesn't already have it
|
||||
* and <code>isRequestFocusEnabled()</code> returns true.
|
||||
* and {@code isRequestFocusEnabled()} returns true.
|
||||
*/
|
||||
public static void adjustFocus(JComponent c) {
|
||||
if (!c.hasFocus() && c.isRequestFocusEnabled()) {
|
||||
@ -1200,9 +1200,9 @@ public class SwingUtilities2 {
|
||||
|
||||
/**
|
||||
* LSBCacheEntry is used to cache the left side bearing (lsb) for
|
||||
* a particular <code>Font</code> and <code>FontRenderContext</code>.
|
||||
* a particular {@code Font} and {@code FontRenderContext}.
|
||||
* This only caches characters that fall in the range
|
||||
* <code>MIN_CHAR_INDEX</code> to <code>MAX_CHAR_INDEX</code>.
|
||||
* {@code MIN_CHAR_INDEX} to {@code MAX_CHAR_INDEX}.
|
||||
*/
|
||||
private static class LSBCacheEntry {
|
||||
// Used to indicate a particular entry in lsb has not been set.
|
||||
@ -1472,20 +1472,20 @@ public class SwingUtilities2 {
|
||||
}
|
||||
|
||||
/**
|
||||
* Utility method that creates a <code>UIDefaults.LazyValue</code> that
|
||||
* creates an <code>ImageIcon</code> <code>UIResource</code> for the
|
||||
* Utility method that creates a {@code UIDefaults.LazyValue} that
|
||||
* creates an {@code ImageIcon} {@code UIResource} for the
|
||||
* specified image file name. The image is loaded using
|
||||
* <code>getResourceAsStream</code>, starting with a call to that method
|
||||
* {@code getResourceAsStream}, starting with a call to that method
|
||||
* on the base class parameter. If it cannot be found, searching will
|
||||
* continue through the base class' inheritance hierarchy, up to and
|
||||
* including <code>rootClass</code>.
|
||||
* including {@code rootClass}.
|
||||
*
|
||||
* @param baseClass the first class to use in searching for the resource
|
||||
* @param rootClass an ancestor of <code>baseClass</code> to finish the
|
||||
* @param rootClass an ancestor of {@code baseClass} to finish the
|
||||
* search at
|
||||
* @param imageFile the name of the file to be found
|
||||
* @return a lazy value that creates the <code>ImageIcon</code>
|
||||
* <code>UIResource</code> for the image,
|
||||
* @return a lazy value that creates the {@code ImageIcon}
|
||||
* {@code UIResource} for the image,
|
||||
* or null if it cannot be found
|
||||
*/
|
||||
public static Object makeIcon(final Class<?> baseClass,
|
||||
@ -1495,22 +1495,22 @@ public class SwingUtilities2 {
|
||||
}
|
||||
|
||||
/**
|
||||
* Utility method that creates a <code>UIDefaults.LazyValue</code> that
|
||||
* creates an <code>ImageIcon</code> <code>UIResource</code> for the
|
||||
* Utility method that creates a {@code UIDefaults.LazyValue} that
|
||||
* creates an {@code ImageIcon} {@code UIResource} for the
|
||||
* specified image file name. The image is loaded using
|
||||
* <code>getResourceAsStream</code>, starting with a call to that method
|
||||
* {@code getResourceAsStream}, starting with a call to that method
|
||||
* on the base class parameter. If it cannot be found, searching will
|
||||
* continue through the base class' inheritance hierarchy, up to and
|
||||
* including <code>rootClass</code>.
|
||||
* including {@code rootClass}.
|
||||
*
|
||||
* Finds an image with a given name without privileges enabled.
|
||||
*
|
||||
* @param baseClass the first class to use in searching for the resource
|
||||
* @param rootClass an ancestor of <code>baseClass</code> to finish the
|
||||
* @param rootClass an ancestor of {@code baseClass} to finish the
|
||||
* search at
|
||||
* @param imageFile the name of the file to be found
|
||||
* @return a lazy value that creates the <code>ImageIcon</code>
|
||||
* <code>UIResource</code> for the image,
|
||||
* @return a lazy value that creates the {@code ImageIcon}
|
||||
* {@code UIResource} for the image,
|
||||
* or null if it cannot be found
|
||||
*/
|
||||
public static Object makeIcon_Unprivileged(final Class<?> baseClass,
|
||||
@ -1604,11 +1604,11 @@ public class SwingUtilities2 {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an integer from the defaults table. If <code>key</code> does
|
||||
* not map to a valid <code>Integer</code>, or can not be convered from
|
||||
* a <code>String</code> to an integer, the value 0 is returned.
|
||||
* Returns an integer from the defaults table. If {@code key} does
|
||||
* not map to a valid {@code Integer}, or can not be convered from
|
||||
* a {@code String} to an integer, the value 0 is returned.
|
||||
*
|
||||
* @param key an <code>Object</code> specifying the int.
|
||||
* @param key an {@code Object} specifying the int.
|
||||
* @return the int
|
||||
*/
|
||||
public static int getUIDefaultsInt(Object key) {
|
||||
@ -1617,13 +1617,13 @@ public class SwingUtilities2 {
|
||||
|
||||
/**
|
||||
* Returns an integer from the defaults table that is appropriate
|
||||
* for the given locale. If <code>key</code> does not map to a valid
|
||||
* <code>Integer</code>, or can not be convered from a <code>String</code>
|
||||
* for the given locale. If {@code key} does not map to a valid
|
||||
* {@code Integer}, or can not be convered from a {@code String}
|
||||
* to an integer, the value 0 is returned.
|
||||
*
|
||||
* @param key an <code>Object</code> specifying the int. Returned value
|
||||
* is 0 if <code>key</code> is not available,
|
||||
* @param l the <code>Locale</code> for which the int is desired
|
||||
* @param key an {@code Object} specifying the int. Returned value
|
||||
* is 0 if {@code key} is not available,
|
||||
* @param l the {@code Locale} for which the int is desired
|
||||
* @return the int
|
||||
*/
|
||||
public static int getUIDefaultsInt(Object key, Locale l) {
|
||||
@ -1631,14 +1631,14 @@ public class SwingUtilities2 {
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns an integer from the defaults table. If <code>key</code> does
|
||||
* not map to a valid <code>Integer</code>, or can not be convered from
|
||||
* a <code>String</code> to an integer, <code>default</code> is
|
||||
* Returns an integer from the defaults table. If {@code key} does
|
||||
* not map to a valid {@code Integer}, or can not be convered from
|
||||
* a {@code String} to an integer, {@code default} is
|
||||
* returned.
|
||||
*
|
||||
* @param key an <code>Object</code> specifying the int. Returned value
|
||||
* is 0 if <code>key</code> is not available,
|
||||
* @param defaultValue Returned value if <code>key</code> is not available,
|
||||
* @param key an {@code Object} specifying the int. Returned value
|
||||
* is 0 if {@code key} is not available,
|
||||
* @param defaultValue Returned value if {@code key} is not available,
|
||||
* or is not an Integer
|
||||
* @return the int
|
||||
*/
|
||||
@ -1648,14 +1648,14 @@ public class SwingUtilities2 {
|
||||
|
||||
/**
|
||||
* Returns an integer from the defaults table that is appropriate
|
||||
* for the given locale. If <code>key</code> does not map to a valid
|
||||
* <code>Integer</code>, or can not be convered from a <code>String</code>
|
||||
* to an integer, <code>default</code> is returned.
|
||||
* for the given locale. If {@code key} does not map to a valid
|
||||
* {@code Integer}, or can not be convered from a {@code String}
|
||||
* to an integer, {@code default} is returned.
|
||||
*
|
||||
* @param key an <code>Object</code> specifying the int. Returned value
|
||||
* is 0 if <code>key</code> is not available,
|
||||
* @param l the <code>Locale</code> for which the int is desired
|
||||
* @param defaultValue Returned value if <code>key</code> is not available,
|
||||
* @param key an {@code Object} specifying the int. Returned value
|
||||
* is 0 if {@code key} is not available,
|
||||
* @param l the {@code Locale} for which the int is desired
|
||||
* @param defaultValue Returned value if {@code key} is not available,
|
||||
* or is not an Integer
|
||||
* @return the int
|
||||
*/
|
||||
@ -1749,7 +1749,7 @@ public class SwingUtilities2 {
|
||||
* @param task the task to submit
|
||||
* @param result the result to return upon successful completion
|
||||
* @return a Future representing pending completion of the task,
|
||||
* and whose <tt>get()</tt> method will return the given
|
||||
* and whose {@code get()} method will return the given
|
||||
* result value upon completion
|
||||
* @throws NullPointerException if the task is null
|
||||
*/
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user