diff -r 3488710b02f8 -r a3dac373f62d jdk/src/share/classes/java/awt/event/AdjustmentEvent.java --- a/jdk/src/share/classes/java/awt/event/AdjustmentEvent.java Mon Apr 07 16:52:51 2008 +0400 +++ b/jdk/src/share/classes/java/awt/event/AdjustmentEvent.java Tue Apr 08 12:46:39 2008 +0400 @@ -29,7 +29,25 @@ import java.awt.AWTEvent; /** - * The adjustment event emitted by Adjustable objects. + * The adjustment event emitted by Adjustable objects like + * {@link java.awt.Scrollbar} and {@link java.awt.ScrollPane}. + * When the user changes the value of the scrolling component, + * it receives an instance of {@code AdjustmentEvent}. + *
+ * An unspecified behavior will be caused if the {@code id} parameter + * of any particular {@code AdjustmentEvent} instance is not + * in the range from {@code ADJUSTMENT_FIRST} to {@code ADJUSTMENT_LAST}. + *
+ * The {@code type} of any {@code AdjustmentEvent} instance takes one of the following + * values: + *
AdjustmentEvent
object with the
* specified Adjustable
source, event type,
* adjustment type, and value.
- * Note that passing in an invalid id
results in
- * unspecified behavior. This method throws an
+ *
This method throws an
* IllegalArgumentException
if source
* is null
.
*
- * @param source the Adjustable
object where the
+ * @param source The Adjustable
object where the
* event originated
- * @param id the event type
- * @param type the adjustment type
- * @param value the current value of the adjustment
+ * @param id An integer indicating the type of event.
+ * For information on allowable values, see
+ * the class description for {@link AdjustmentEvent}
+ * @param type An integer indicating the adjustment type.
+ * For information on allowable values, see
+ * the class description for {@link AdjustmentEvent}
+ * @param value The current value of the adjustment
* @throws IllegalArgumentException if source
is null
+ * @see #getSource()
+ * @see #getID()
+ * @see #getAdjustmentType()
+ * @see #getValue()
*/
public AdjustmentEvent(Adjustable source, int id, int type, int value) {
this(source, id, type, value, false);
@@ -149,22 +174,29 @@
/**
* Constructs an AdjustmentEvent
object with the
* specified Adjustable source, event type, adjustment type, and value.
- *
Note that passing in an invalid id
results in
- * unspecified behavior. This method throws an
+ *
This method throws an
* IllegalArgumentException
if source
* is null
.
-
*
- * @param source the Adjustable
object where the
+ * @param source The Adjustable
object where the
* event originated
- * @param id the event type
- * @param type the adjustment type
- * @param value the current value of the adjustment
- * @param isAdjusting true
if the event is one
+ * @param id An integer indicating the type of event.
+ * For information on allowable values, see
+ * the class description for {@link AdjustmentEvent}
+ * @param type An integer indicating the adjustment type.
+ * For information on allowable values, see
+ * the class description for {@link AdjustmentEvent}
+ * @param value The current value of the adjustment
+ * @param isAdjusting A boolean that equals true
if the event is one
* of a series of multiple adjusting events,
* otherwise false
* @throws IllegalArgumentException if source
is null
* @since 1.4
+ * @see #getSource()
+ * @see #getID()
+ * @see #getAdjustmentType()
+ * @see #getValue()
+ * @see #getValueIsAdjusting()
*/
public AdjustmentEvent(Adjustable source, int id, int type, int value, boolean isAdjusting) {
super(source, id);