< prev index next >
src/java.desktop/share/classes/java/awt/Scrollbar.java
Print this page
*** 32,42 ****
import java.io.IOException;
import javax.accessibility.*;
/**
! * The <code>Scrollbar</code> class embodies a scroll bar, a
* familiar user-interface object. A scroll bar provides a
* convenient means for allowing a user to select from a
* range of values. The following three vertical
* scroll bars could be used as slider controls to pick
* the red, green, and blue components of a color:
--- 32,42 ----
import java.io.IOException;
import javax.accessibility.*;
/**
! * The {@code Scrollbar} class embodies a scroll bar, a
* familiar user-interface object. A scroll bar provides a
* convenient means for allowing a user to select from a
* range of values. The following three vertical
* scroll bars could be used as slider controls to pick
* the red, green, and blue components of a color:
*** 70,82 ****
* ranger = new Scrollbar(Scrollbar.HORIZONTAL, 0, 60, 0, 300);
* add(ranger);
* </pre></blockquote><hr>
* <p>
* Note that the actual maximum value of the scroll bar is the
! * <code>maximum</code> minus the <code>visible amount</code>.
! * In the previous example, because the <code>maximum</code> is
! * 300 and the <code>visible amount</code> is 60, the actual maximum
* value is 240. The range of the scrollbar track is 0 - 300.
* The left side of the bubble indicates the value of the
* scroll bar.
* <p>
* Normally, the user changes the value of the scroll bar by
--- 70,82 ----
* ranger = new Scrollbar(Scrollbar.HORIZONTAL, 0, 60, 0, 300);
* add(ranger);
* </pre></blockquote><hr>
* <p>
* Note that the actual maximum value of the scroll bar is the
! * {@code maximum} minus the {@code visible amount}.
! * In the previous example, because the {@code maximum} is
! * 300 and the {@code visible amount} is 60, the actual maximum
* value is 240. The range of the scrollbar track is 0 - 300.
* The left side of the bubble indicates the value of the
* scroll bar.
* <p>
* Normally, the user changes the value of the scroll bar by
*** 87,129 ****
* the <b>Page Up</b> and <b>Page Down</b>
* keys are equivalent to clicking in the scroll bar's block
* increment and block decrement areas.
* <p>
* When the user changes the value of the scroll bar, the scroll bar
! * receives an instance of <code>AdjustmentEvent</code>.
* The scroll bar processes this event, passing it along to
* any registered listeners.
* <p>
* Any object that wishes to be notified of changes to the
* scroll bar's value should implement
! * <code>AdjustmentListener</code>, an interface defined in
! * the package <code>java.awt.event</code>.
* Listeners can be added and removed dynamically by calling
! * the methods <code>addAdjustmentListener</code> and
! * <code>removeAdjustmentListener</code>.
* <p>
! * The <code>AdjustmentEvent</code> class defines five types
* of adjustment event, listed here:
*
* <ul>
! * <li><code>AdjustmentEvent.TRACK</code> is sent out when the
* user drags the scroll bar's bubble.
! * <li><code>AdjustmentEvent.UNIT_INCREMENT</code> is sent out
* when the user clicks in the left arrow of a horizontal scroll
* bar, or the top arrow of a vertical scroll bar, or makes the
* equivalent gesture from the keyboard.
! * <li><code>AdjustmentEvent.UNIT_DECREMENT</code> is sent out
* when the user clicks in the right arrow of a horizontal scroll
* bar, or the bottom arrow of a vertical scroll bar, or makes the
* equivalent gesture from the keyboard.
! * <li><code>AdjustmentEvent.BLOCK_INCREMENT</code> is sent out
* when the user clicks in the track, to the left of the bubble
* on a horizontal scroll bar, or above the bubble on a vertical
* scroll bar. By convention, the <b>Page Up</b>
* key is equivalent, if the user is using a keyboard that
* defines a <b>Page Up</b> key.
! * <li><code>AdjustmentEvent.BLOCK_DECREMENT</code> is sent out
* when the user clicks in the track, to the right of the bubble
* on a horizontal scroll bar, or below the bubble on a vertical
* scroll bar. By convention, the <b>Page Down</b>
* key is equivalent, if the user is using a keyboard that
* defines a <b>Page Down</b> key.
--- 87,129 ----
* the <b>Page Up</b> and <b>Page Down</b>
* keys are equivalent to clicking in the scroll bar's block
* increment and block decrement areas.
* <p>
* When the user changes the value of the scroll bar, the scroll bar
! * receives an instance of {@code AdjustmentEvent}.
* The scroll bar processes this event, passing it along to
* any registered listeners.
* <p>
* Any object that wishes to be notified of changes to the
* scroll bar's value should implement
! * {@code AdjustmentListener}, an interface defined in
! * the package {@code java.awt.event}.
* Listeners can be added and removed dynamically by calling
! * the methods {@code addAdjustmentListener} and
! * {@code removeAdjustmentListener}.
* <p>
! * The {@code AdjustmentEvent} class defines five types
* of adjustment event, listed here:
*
* <ul>
! * <li>{@code AdjustmentEvent.TRACK} is sent out when the
* user drags the scroll bar's bubble.
! * <li>{@code AdjustmentEvent.UNIT_INCREMENT} is sent out
* when the user clicks in the left arrow of a horizontal scroll
* bar, or the top arrow of a vertical scroll bar, or makes the
* equivalent gesture from the keyboard.
! * <li>{@code AdjustmentEvent.UNIT_DECREMENT} is sent out
* when the user clicks in the right arrow of a horizontal scroll
* bar, or the bottom arrow of a vertical scroll bar, or makes the
* equivalent gesture from the keyboard.
! * <li>{@code AdjustmentEvent.BLOCK_INCREMENT} is sent out
* when the user clicks in the track, to the left of the bubble
* on a horizontal scroll bar, or above the bubble on a vertical
* scroll bar. By convention, the <b>Page Up</b>
* key is equivalent, if the user is using a keyboard that
* defines a <b>Page Up</b> key.
! * <li>{@code AdjustmentEvent.BLOCK_DECREMENT} is sent out
* when the user clicks in the track, to the right of the bubble
* on a horizontal scroll bar, or below the bubble on a vertical
* scroll bar. By convention, the <b>Page Down</b>
* key is equivalent, if the user is using a keyboard that
* defines a <b>Page Down</b> key.
*** 136,162 ****
* that are associated with scroll bars in previous platform versions.
* The following list gives the adjustment event type,
* and the corresponding JDK 1.0 event type it replaces.
*
* <ul>
! * <li><code>AdjustmentEvent.TRACK</code> replaces
! * <code>Event.SCROLL_ABSOLUTE</code>
! * <li><code>AdjustmentEvent.UNIT_INCREMENT</code> replaces
! * <code>Event.SCROLL_LINE_UP</code>
! * <li><code>AdjustmentEvent.UNIT_DECREMENT</code> replaces
! * <code>Event.SCROLL_LINE_DOWN</code>
! * <li><code>AdjustmentEvent.BLOCK_INCREMENT</code> replaces
! * <code>Event.SCROLL_PAGE_UP</code>
! * <li><code>AdjustmentEvent.BLOCK_DECREMENT</code> replaces
! * <code>Event.SCROLL_PAGE_DOWN</code>
* </ul>
* <p>
! * <b>Note</b>: We recommend using a <code>Scrollbar</code>
* for value selection only. If you want to implement
* a scrollable component inside a container, we recommend you use
* a {@link ScrollPane ScrollPane}. If you use a
! * <code>Scrollbar</code> for this purpose, you are likely to
* encounter issues with painting, key handling, sizing and
* positioning.
*
* @author Sami Shaio
* @see java.awt.event.AdjustmentEvent
--- 136,162 ----
* that are associated with scroll bars in previous platform versions.
* The following list gives the adjustment event type,
* and the corresponding JDK 1.0 event type it replaces.
*
* <ul>
! * <li>{@code AdjustmentEvent.TRACK} replaces
! * {@code Event.SCROLL_ABSOLUTE}
! * <li>{@code AdjustmentEvent.UNIT_INCREMENT} replaces
! * {@code Event.SCROLL_LINE_UP}
! * <li>{@code AdjustmentEvent.UNIT_DECREMENT} replaces
! * {@code Event.SCROLL_LINE_DOWN}
! * <li>{@code AdjustmentEvent.BLOCK_INCREMENT} replaces
! * {@code Event.SCROLL_PAGE_UP}
! * <li>{@code AdjustmentEvent.BLOCK_DECREMENT} replaces
! * {@code Event.SCROLL_PAGE_DOWN}
* </ul>
* <p>
! * <b>Note</b>: We recommend using a {@code Scrollbar}
* for value selection only. If you want to implement
* a scrollable component inside a container, we recommend you use
* a {@link ScrollPane ScrollPane}. If you use a
! * {@code Scrollbar} for this purpose, you are likely to
* encounter issues with painting, key handling, sizing and
* positioning.
*
* @author Sami Shaio
* @see java.awt.event.AdjustmentEvent
*** 174,218 ****
* A constant that indicates a vertical scroll bar.
*/
public static final int VERTICAL = 1;
/**
! * The value of the <code>Scrollbar</code>.
! * This property must be greater than or equal to <code>minimum</code>
* and less than or equal to
! * <code>maximum - visibleAmount</code>
*
* @serial
* @see #getValue
* @see #setValue
*/
int value;
/**
! * The maximum value of the <code>Scrollbar</code>.
! * This value must be greater than the <code>minimum</code>
* value.<br>
*
* @serial
* @see #getMaximum
* @see #setMaximum
*/
int maximum;
/**
! * The minimum value of the <code>Scrollbar</code>.
! * This value must be less than the <code>maximum</code>
* value.<br>
*
* @serial
* @see #getMinimum
* @see #setMinimum
*/
int minimum;
/**
! * The size of the <code>Scrollbar</code>'s bubble.
* When a scroll bar is used to select a range of values,
* the visibleAmount represents the size of this range.
* Depending on platform, this may be visually indicated
* by the size of the bubble.
*
--- 174,218 ----
* A constant that indicates a vertical scroll bar.
*/
public static final int VERTICAL = 1;
/**
! * The value of the {@code Scrollbar}.
! * This property must be greater than or equal to {@code minimum}
* and less than or equal to
! * {@code maximum - visibleAmount}
*
* @serial
* @see #getValue
* @see #setValue
*/
int value;
/**
! * The maximum value of the {@code Scrollbar}.
! * This value must be greater than the {@code minimum}
* value.<br>
*
* @serial
* @see #getMaximum
* @see #setMaximum
*/
int maximum;
/**
! * The minimum value of the {@code Scrollbar}.
! * This value must be less than the {@code maximum}
* value.<br>
*
* @serial
* @see #getMinimum
* @see #setMinimum
*/
int minimum;
/**
! * The size of the {@code Scrollbar}'s bubble.
* When a scroll bar is used to select a range of values,
* the visibleAmount represents the size of this range.
* Depending on platform, this may be visually indicated
* by the size of the bubble.
*
*** 221,235 ****
* @see #setVisibleAmount
*/
int visibleAmount;
/**
! * The <code>Scrollbar</code>'s orientation--being either horizontal
* or vertical.
* This value should be specified when the scrollbar is created.<BR>
! * orientation can be either : <code>VERTICAL</code> or
! * <code>HORIZONTAL</code> only.
*
* @serial
* @see #getOrientation
* @see #setOrientation
*/
--- 221,235 ----
* @see #setVisibleAmount
*/
int visibleAmount;
/**
! * The {@code Scrollbar}'s orientation--being either horizontal
* or vertical.
* This value should be specified when the scrollbar is created.<BR>
! * orientation can be either : {@code VERTICAL} or
! * {@code HORIZONTAL} only.
*
* @serial
* @see #getOrientation
* @see #setOrientation
*/
*** 256,266 ****
* @see #setPageIncrement
*/
int pageIncrement = 10;
/**
! * The adjusting status of the <code>Scrollbar</code>.
* True if the value is in the process of changing as a result of
* actions being taken by the user.
*
* @see #getValueIsAdjusting
* @see #setValueIsAdjusting
--- 256,266 ----
* @see #setPageIncrement
*/
int pageIncrement = 10;
/**
! * The adjusting status of the {@code Scrollbar}.
* True if the value is in the process of changing as a result of
* actions being taken by the user.
*
* @see #getValueIsAdjusting
* @see #setValueIsAdjusting
*** 304,314 ****
* </tr>
* <tr>
* <td>orientation</td>
* <td>indicates whether the scroll bar is vertical
* <br>or horizontal</td>
! * <td><code>Scrollbar.VERTICAL</code></td>
* </tr>
* <tr>
* <td>value</td>
* <td>value which controls the location
* <br>of the scroll bar's bubble</td>
--- 304,314 ----
* </tr>
* <tr>
* <td>orientation</td>
* <td>indicates whether the scroll bar is vertical
* <br>or horizontal</td>
! * <td>{@code Scrollbar.VERTICAL}</td>
* </tr>
* <tr>
* <td>value</td>
* <td>value which controls the location
* <br>of the scroll bar's bubble</td>
*** 358,375 ****
}
/**
* Constructs a new scroll bar with the specified orientation.
* <p>
! * The <code>orientation</code> argument must take one of the two
! * values <code>Scrollbar.HORIZONTAL</code>,
! * or <code>Scrollbar.VERTICAL</code>,
* indicating a horizontal or vertical scroll bar, respectively.
*
* @param orientation indicates the orientation of the scroll bar
* @exception IllegalArgumentException when an illegal value for
! * the <code>orientation</code> argument is supplied
* @exception HeadlessException if GraphicsEnvironment.isHeadless()
* returns true.
* @see java.awt.GraphicsEnvironment#isHeadless
*/
public Scrollbar(int orientation) throws HeadlessException {
--- 358,375 ----
}
/**
* Constructs a new scroll bar with the specified orientation.
* <p>
! * The {@code orientation} argument must take one of the two
! * values {@code Scrollbar.HORIZONTAL},
! * or {@code Scrollbar.VERTICAL},
* indicating a horizontal or vertical scroll bar, respectively.
*
* @param orientation indicates the orientation of the scroll bar
* @exception IllegalArgumentException when an illegal value for
! * the {@code orientation} argument is supplied
* @exception HeadlessException if GraphicsEnvironment.isHeadless()
* returns true.
* @see java.awt.GraphicsEnvironment#isHeadless
*/
public Scrollbar(int orientation) throws HeadlessException {
*** 378,390 ****
/**
* Constructs a new scroll bar with the specified orientation,
* initial value, visible amount, and minimum and maximum values.
* <p>
! * The <code>orientation</code> argument must take one of the two
! * values <code>Scrollbar.HORIZONTAL</code>,
! * or <code>Scrollbar.VERTICAL</code>,
* indicating a horizontal or vertical scroll bar, respectively.
* <p>
* The parameters supplied to this constructor are subject to the
* constraints described in {@link #setValues(int, int, int, int)}.
*
--- 378,390 ----
/**
* Constructs a new scroll bar with the specified orientation,
* initial value, visible amount, and minimum and maximum values.
* <p>
! * The {@code orientation} argument must take one of the two
! * values {@code Scrollbar.HORIZONTAL},
! * or {@code Scrollbar.VERTICAL},
* indicating a horizontal or vertical scroll bar, respectively.
* <p>
* The parameters supplied to this constructor are subject to the
* constraints described in {@link #setValues(int, int, int, int)}.
*
*** 393,403 ****
* @param visible the visible amount of the scroll bar, typically
* represented by the size of the bubble
* @param minimum the minimum value of the scroll bar
* @param maximum the maximum value of the scroll bar
* @exception IllegalArgumentException when an illegal value for
! * the <code>orientation</code> argument is supplied
* @exception HeadlessException if GraphicsEnvironment.isHeadless()
* returns true.
* @see #setValues
* @see java.awt.GraphicsEnvironment#isHeadless
*/
--- 393,403 ----
* @param visible the visible amount of the scroll bar, typically
* represented by the size of the bubble
* @param minimum the minimum value of the scroll bar
* @param maximum the maximum value of the scroll bar
* @exception IllegalArgumentException when an illegal value for
! * the {@code orientation} argument is supplied
* @exception HeadlessException if GraphicsEnvironment.isHeadless()
* returns true.
* @see #setValues
* @see java.awt.GraphicsEnvironment#isHeadless
*/
*** 414,435 ****
}
setValues(value, visible, minimum, maximum);
}
/**
! * Constructs a name for this component. Called by <code>getName</code>
! * when the name is <code>null</code>.
*/
String constructComponentName() {
synchronized (Scrollbar.class) {
return base + nameCounter++;
}
}
/**
! * Creates the <code>Scrollbar</code>'s peer. The peer allows you to modify
! * the appearance of the <code>Scrollbar</code> without changing any of its
* functionality.
*/
public void addNotify() {
synchronized (getTreeLock()) {
if (peer == null)
--- 414,435 ----
}
setValues(value, visible, minimum, maximum);
}
/**
! * Constructs a name for this component. Called by {@code getName}
! * when the name is {@code null}.
*/
String constructComponentName() {
synchronized (Scrollbar.class) {
return base + nameCounter++;
}
}
/**
! * Creates the {@code Scrollbar}'s peer. The peer allows you to modify
! * the appearance of the {@code Scrollbar} without changing any of its
* functionality.
*/
public void addNotify() {
synchronized (getTreeLock()) {
if (peer == null)
*** 440,466 ****
/**
* Returns the orientation of this scroll bar.
*
* @return the orientation of this scroll bar, either
! * <code>Scrollbar.HORIZONTAL</code> or
! * <code>Scrollbar.VERTICAL</code>
* @see java.awt.Scrollbar#setOrientation
*/
public int getOrientation() {
return orientation;
}
/**
* Sets the orientation for this scroll bar.
*
* @param orientation the orientation of this scroll bar, either
! * <code>Scrollbar.HORIZONTAL</code> or
! * <code>Scrollbar.VERTICAL</code>
* @see java.awt.Scrollbar#getOrientation
* @exception IllegalArgumentException if the value supplied
! * for <code>orientation</code> is not a
* legal value
* @since 1.1
*/
public void setOrientation(int orientation) {
synchronized (getTreeLock()) {
--- 440,466 ----
/**
* Returns the orientation of this scroll bar.
*
* @return the orientation of this scroll bar, either
! * {@code Scrollbar.HORIZONTAL} or
! * {@code Scrollbar.VERTICAL}
* @see java.awt.Scrollbar#setOrientation
*/
public int getOrientation() {
return orientation;
}
/**
* Sets the orientation for this scroll bar.
*
* @param orientation the orientation of this scroll bar, either
! * {@code Scrollbar.HORIZONTAL} or
! * {@code Scrollbar.VERTICAL}
* @see java.awt.Scrollbar#getOrientation
* @exception IllegalArgumentException if the value supplied
! * for {@code orientation} is not a
* legal value
* @since 1.1
*/
public void setOrientation(int orientation) {
synchronized (getTreeLock()) {
*** 504,527 ****
}
/**
* Sets the value of this scroll bar to the specified value.
* <p>
! * If the value supplied is less than the current <code>minimum</code>
! * or greater than the current <code>maximum - visibleAmount</code>,
! * then either <code>minimum</code> or <code>maximum - visibleAmount</code>
* is substituted, as appropriate.
* <p>
* Normally, a program should change a scroll bar's
! * value only by calling <code>setValues</code>.
! * The <code>setValues</code> method simultaneously
* and synchronously sets the minimum, maximum, visible amount,
* and value properties of a scroll bar, so that they are
* mutually consistent.
* <p>
* Calling this method does not fire an
! * <code>AdjustmentEvent</code>.
*
* @param newValue the new value of the scroll bar
* @see java.awt.Scrollbar#setValues
* @see java.awt.Scrollbar#getValue
* @see java.awt.Scrollbar#getMinimum
--- 504,527 ----
}
/**
* Sets the value of this scroll bar to the specified value.
* <p>
! * If the value supplied is less than the current {@code minimum}
! * or greater than the current {@code maximum - visibleAmount},
! * then either {@code minimum} or {@code maximum - visibleAmount}
* is substituted, as appropriate.
* <p>
* Normally, a program should change a scroll bar's
! * value only by calling {@code setValues}.
! * The {@code setValues} method simultaneously
* and synchronously sets the minimum, maximum, visible amount,
* and value properties of a scroll bar, so that they are
* mutually consistent.
* <p>
* Calling this method does not fire an
! * {@code AdjustmentEvent}.
*
* @param newValue the new value of the scroll bar
* @see java.awt.Scrollbar#setValues
* @see java.awt.Scrollbar#getValue
* @see java.awt.Scrollbar#getMinimum
*** 545,569 ****
}
/**
* Sets the minimum value of this scroll bar.
* <p>
! * When <code>setMinimum</code> is called, the minimum value
* is changed, and other values (including the maximum, the
* visible amount, and the current scroll bar value)
* are changed to be consistent with the new minimum.
* <p>
* Normally, a program should change a scroll bar's minimum
! * value only by calling <code>setValues</code>.
! * The <code>setValues</code> method simultaneously
* and synchronously sets the minimum, maximum, visible amount,
* and value properties of a scroll bar, so that they are
* mutually consistent.
* <p>
! * Note that setting the minimum value to <code>Integer.MAX_VALUE</code>
* will result in the new minimum value being set to
! * <code>Integer.MAX_VALUE - 1</code>.
*
* @param newMinimum the new minimum value for this scroll bar
* @see java.awt.Scrollbar#setValues
* @see java.awt.Scrollbar#setMaximum
* @since 1.1
--- 545,569 ----
}
/**
* Sets the minimum value of this scroll bar.
* <p>
! * When {@code setMinimum} is called, the minimum value
* is changed, and other values (including the maximum, the
* visible amount, and the current scroll bar value)
* are changed to be consistent with the new minimum.
* <p>
* Normally, a program should change a scroll bar's minimum
! * value only by calling {@code setValues}.
! * The {@code setValues} method simultaneously
* and synchronously sets the minimum, maximum, visible amount,
* and value properties of a scroll bar, so that they are
* mutually consistent.
* <p>
! * Note that setting the minimum value to {@code Integer.MAX_VALUE}
* will result in the new minimum value being set to
! * {@code Integer.MAX_VALUE - 1}.
*
* @param newMinimum the new minimum value for this scroll bar
* @see java.awt.Scrollbar#setValues
* @see java.awt.Scrollbar#setMaximum
* @since 1.1
*** 589,613 ****
}
/**
* Sets the maximum value of this scroll bar.
* <p>
! * When <code>setMaximum</code> is called, the maximum value
* is changed, and other values (including the minimum, the
* visible amount, and the current scroll bar value)
* are changed to be consistent with the new maximum.
* <p>
* Normally, a program should change a scroll bar's maximum
! * value only by calling <code>setValues</code>.
! * The <code>setValues</code> method simultaneously
* and synchronously sets the minimum, maximum, visible amount,
* and value properties of a scroll bar, so that they are
* mutually consistent.
* <p>
! * Note that setting the maximum value to <code>Integer.MIN_VALUE</code>
* will result in the new maximum value being set to
! * <code>Integer.MIN_VALUE + 1</code>.
*
* @param newMaximum the new maximum value
* for this scroll bar
* @see java.awt.Scrollbar#setValues
* @see java.awt.Scrollbar#setMinimum
--- 589,613 ----
}
/**
* Sets the maximum value of this scroll bar.
* <p>
! * When {@code setMaximum} is called, the maximum value
* is changed, and other values (including the minimum, the
* visible amount, and the current scroll bar value)
* are changed to be consistent with the new maximum.
* <p>
* Normally, a program should change a scroll bar's maximum
! * value only by calling {@code setValues}.
! * The {@code setValues} method simultaneously
* and synchronously sets the minimum, maximum, visible amount,
* and value properties of a scroll bar, so that they are
* mutually consistent.
* <p>
! * Note that setting the maximum value to {@code Integer.MIN_VALUE}
* will result in the new maximum value being set to
! * {@code Integer.MIN_VALUE + 1}.
*
* @param newMaximum the new maximum value
* for this scroll bar
* @see java.awt.Scrollbar#setValues
* @see java.awt.Scrollbar#setMinimum
*** 643,653 ****
* <p>
* The scroll bar's bubble may not be displayed when it is not
* moveable (e.g. when it takes up the entire length of the
* scroll bar's track, or when the scroll bar is disabled).
* Whether the bubble is displayed or not will not affect
! * the value returned by <code>getVisibleAmount</code>.
*
* @return the visible amount of this scroll bar
* @see java.awt.Scrollbar#setVisibleAmount
* @since 1.1
*/
--- 643,653 ----
* <p>
* The scroll bar's bubble may not be displayed when it is not
* moveable (e.g. when it takes up the entire length of the
* scroll bar's track, or when the scroll bar is disabled).
* Whether the bubble is displayed or not will not affect
! * the value returned by {@code getVisibleAmount}.
*
* @return the visible amount of this scroll bar
* @see java.awt.Scrollbar#setVisibleAmount
* @since 1.1
*/
*** 658,668 ****
/**
* Returns the visible amount of this scroll bar.
*
* @return the visible amount of this scroll bar
* @deprecated As of JDK version 1.1,
! * replaced by <code>getVisibleAmount()</code>.
*/
@Deprecated
public int getVisible() {
return visibleAmount;
}
--- 658,668 ----
/**
* Returns the visible amount of this scroll bar.
*
* @return the visible amount of this scroll bar
* @deprecated As of JDK version 1.1,
! * replaced by {@code getVisibleAmount()}.
*/
@Deprecated
public int getVisible() {
return visibleAmount;
}
*** 681,700 ****
* <p>
* The scroll bar's bubble may not be displayed when it is not
* moveable (e.g. when it takes up the entire length of the
* scroll bar's track, or when the scroll bar is disabled).
* Whether the bubble is displayed or not will not affect
! * the value returned by <code>getVisibleAmount</code>.
* <p>
! * If the visible amount supplied is less than <code>one</code>
! * or greater than the current <code>maximum - minimum</code>,
! * then either <code>one</code> or <code>maximum - minimum</code>
* is substituted, as appropriate.
* <p>
* Normally, a program should change a scroll bar's
! * value only by calling <code>setValues</code>.
! * The <code>setValues</code> method simultaneously
* and synchronously sets the minimum, maximum, visible amount,
* and value properties of a scroll bar, so that they are
* mutually consistent.
*
* @param newAmount the new visible amount
--- 681,700 ----
* <p>
* The scroll bar's bubble may not be displayed when it is not
* moveable (e.g. when it takes up the entire length of the
* scroll bar's track, or when the scroll bar is disabled).
* Whether the bubble is displayed or not will not affect
! * the value returned by {@code getVisibleAmount}.
* <p>
! * If the visible amount supplied is less than {@code one}
! * or greater than the current {@code maximum - minimum},
! * then either {@code one} or {@code maximum - minimum}
* is substituted, as appropriate.
* <p>
* Normally, a program should change a scroll bar's
! * value only by calling {@code setValues}.
! * The {@code setValues} method simultaneously
* and synchronously sets the minimum, maximum, visible amount,
* and value properties of a scroll bar, so that they are
* mutually consistent.
*
* @param newAmount the new visible amount
*** 735,745 ****
* Sets the unit increment for this scroll bar.
*
* @param v the increment value
*
* @deprecated As of JDK version 1.1,
! * replaced by <code>setUnitIncrement(int)</code>.
*/
@Deprecated
public synchronized void setLineIncrement(int v) {
int tmp = (v < 1) ? 1 : v;
--- 735,745 ----
* Sets the unit increment for this scroll bar.
*
* @param v the increment value
*
* @deprecated As of JDK version 1.1,
! * replaced by {@code setUnitIncrement(int)}.
*/
@Deprecated
public synchronized void setLineIncrement(int v) {
int tmp = (v < 1) ? 1 : v;
*** 777,787 ****
/**
* Returns the unit increment for this scrollbar.
*
* @return the unit increment for this scrollbar
* @deprecated As of JDK version 1.1,
! * replaced by <code>getUnitIncrement()</code>.
*/
@Deprecated
public int getLineIncrement() {
return lineIncrement;
}
--- 777,787 ----
/**
* Returns the unit increment for this scrollbar.
*
* @return the unit increment for this scrollbar
* @deprecated As of JDK version 1.1,
! * replaced by {@code getUnitIncrement()}.
*/
@Deprecated
public int getLineIncrement() {
return lineIncrement;
}
*** 809,819 ****
/**
* Sets the block increment for this scroll bar.
*
* @param v the block increment
* @deprecated As of JDK version 1.1,
! * replaced by <code>setBlockIncrement()</code>.
*/
@Deprecated
public synchronized void setPageIncrement(int v) {
int tmp = (v < 1) ? 1 : v;
--- 809,819 ----
/**
* Sets the block increment for this scroll bar.
*
* @param v the block increment
* @deprecated As of JDK version 1.1,
! * replaced by {@code setBlockIncrement()}.
*/
@Deprecated
public synchronized void setPageIncrement(int v) {
int tmp = (v < 1) ? 1 : v;
*** 849,888 ****
* Returns the block increment of this scroll bar.
*
* @return the block increment of this scroll bar
*
* @deprecated As of JDK version 1.1,
! * replaced by <code>getBlockIncrement()</code>.
*/
@Deprecated
public int getPageIncrement() {
return pageIncrement;
}
/**
* Sets the values of four properties for this scroll bar:
! * <code>value</code>, <code>visibleAmount</code>,
! * <code>minimum</code>, and <code>maximum</code>.
* If the values supplied for these properties are inconsistent
* or incorrect, they will be changed to ensure consistency.
* <p>
* This method simultaneously and synchronously sets the values
* of four scroll bar properties, assuring that the values of
* these properties are mutually consistent. It enforces the
* following constraints:
! * <code>maximum</code> must be greater than <code>minimum</code>,
! * <code>maximum - minimum</code> must not be greater
! * than <code>Integer.MAX_VALUE</code>,
! * <code>visibleAmount</code> must be greater than zero.
! * <code>visibleAmount</code> must not be greater than
! * <code>maximum - minimum</code>,
! * <code>value</code> must not be less than <code>minimum</code>,
! * and <code>value</code> must not be greater than
! * <code>maximum - visibleAmount</code>
* <p>
* Calling this method does not fire an
! * <code>AdjustmentEvent</code>.
*
* @param value is the position in the current window
* @param visible is the visible amount of the scroll bar
* @param minimum is the minimum value of the scroll bar
* @param maximum is the maximum value of the scroll bar
--- 849,888 ----
* Returns the block increment of this scroll bar.
*
* @return the block increment of this scroll bar
*
* @deprecated As of JDK version 1.1,
! * replaced by {@code getBlockIncrement()}.
*/
@Deprecated
public int getPageIncrement() {
return pageIncrement;
}
/**
* Sets the values of four properties for this scroll bar:
! * {@code value}, {@code visibleAmount},
! * {@code minimum}, and {@code maximum}.
* If the values supplied for these properties are inconsistent
* or incorrect, they will be changed to ensure consistency.
* <p>
* This method simultaneously and synchronously sets the values
* of four scroll bar properties, assuring that the values of
* these properties are mutually consistent. It enforces the
* following constraints:
! * {@code maximum} must be greater than {@code minimum},
! * {@code maximum - minimum} must not be greater
! * than {@code Integer.MAX_VALUE},
! * {@code visibleAmount} must be greater than zero.
! * {@code visibleAmount} must not be greater than
! * {@code maximum - minimum},
! * {@code value} must not be less than {@code minimum},
! * and {@code value} must not be greater than
! * {@code maximum - visibleAmount}
* <p>
* Calling this method does not fire an
! * {@code AdjustmentEvent}.
*
* @param value is the position in the current window
* @param visible is the visible amount of the scroll bar
* @param minimum is the minimum value of the scroll bar
* @param maximum is the maximum value of the scroll bar
*** 941,960 ****
/**
* Returns true if the value is in the process of changing as a
* result of actions being taken by the user.
*
! * @return the value of the <code>valueIsAdjusting</code> property
* @see #setValueIsAdjusting
* @since 1.4
*/
public boolean getValueIsAdjusting() {
return isAdjusting;
}
/**
! * Sets the <code>valueIsAdjusting</code> property.
*
* @param b new adjustment-in-progress status
* @see #getValueIsAdjusting
* @since 1.4
*/
--- 941,960 ----
/**
* Returns true if the value is in the process of changing as a
* result of actions being taken by the user.
*
! * @return the value of the {@code valueIsAdjusting} property
* @see #setValueIsAdjusting
* @since 1.4
*/
public boolean getValueIsAdjusting() {
return isAdjusting;
}
/**
! * Sets the {@code valueIsAdjusting} property.
*
* @param b new adjustment-in-progress status
* @see #getValueIsAdjusting
* @since 1.4
*/
*** 976,987 ****
/**
* Adds the specified adjustment listener to receive instances of
! * <code>AdjustmentEvent</code> from this scroll bar.
! * If l is <code>null</code>, no exception is thrown and no
* action is performed.
* <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
* >AWT Threading Issues</a> for details on AWT's threading model.
*
* @param l the adjustment listener
--- 976,987 ----
/**
* Adds the specified adjustment listener to receive instances of
! * {@code AdjustmentEvent} from this scroll bar.
! * If l is {@code null}, no exception is thrown and no
* action is performed.
* <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
* >AWT Threading Issues</a> for details on AWT's threading model.
*
* @param l the adjustment listener
*** 999,1010 ****
newEventsOnly = true;
}
/**
* Removes the specified adjustment listener so that it no longer
! * receives instances of <code>AdjustmentEvent</code> from this scroll bar.
! * If l is <code>null</code>, no exception is thrown and no action
* is performed.
* <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
* >AWT Threading Issues</a> for details on AWT's threading model.
*
* @param l the adjustment listener
--- 999,1010 ----
newEventsOnly = true;
}
/**
* Removes the specified adjustment listener so that it no longer
! * receives instances of {@code AdjustmentEvent} from this scroll bar.
! * If l is {@code null}, no exception is thrown and no action
* is performed.
* <p>Refer to <a href="doc-files/AWTThreadIssues.html#ListenersThreads"
* >AWT Threading Issues</a> for details on AWT's threading model.
*
* @param l the adjustment listener
*** 1023,1033 ****
/**
* Returns an array of all the adjustment listeners
* registered on this scrollbar.
*
! * @return all of this scrollbar's <code>AdjustmentListener</code>s
* or an empty array if no adjustment
* listeners are currently registered
* @see #addAdjustmentListener
* @see #removeAdjustmentListener
* @see java.awt.event.AdjustmentEvent
--- 1023,1033 ----
/**
* Returns an array of all the adjustment listeners
* registered on this scrollbar.
*
! * @return all of this scrollbar's {@code AdjustmentListener}s
* or an empty array if no adjustment
* listeners are currently registered
* @see #addAdjustmentListener
* @see #removeAdjustmentListener
* @see java.awt.event.AdjustmentEvent
*** 1039,1072 ****
}
/**
* Returns an array of all the objects currently registered
* as <code><em>Foo</em>Listener</code>s
! * upon this <code>Scrollbar</code>.
* <code><em>Foo</em>Listener</code>s are registered using the
* <code>add<em>Foo</em>Listener</code> method.
* <p>
! * You can specify the <code>listenerType</code> argument
* with a class literal, such as
* <code><em>Foo</em>Listener.class</code>.
* For example, you can query a
! * <code>Scrollbar</code> <code>c</code>
* for its mouse listeners with the following code:
*
* <pre>MouseListener[] mls = (MouseListener[])(c.getListeners(MouseListener.class));</pre>
*
* If no such listeners exist, this method returns an empty array.
*
* @param listenerType the type of listeners requested; this parameter
* should specify an interface that descends from
! * <code>java.util.EventListener</code>
* @return an array of all objects registered as
* <code><em>Foo</em>Listener</code>s on this component,
* or an empty array if no such listeners have been added
! * @exception ClassCastException if <code>listenerType</code>
* doesn't specify a class or interface that implements
! * <code>java.util.EventListener</code>
*
* @since 1.3
*/
public <T extends EventListener> T[] getListeners(Class<T> listenerType) {
EventListener l = null;
--- 1039,1072 ----
}
/**
* Returns an array of all the objects currently registered
* as <code><em>Foo</em>Listener</code>s
! * upon this {@code Scrollbar}.
* <code><em>Foo</em>Listener</code>s are registered using the
* <code>add<em>Foo</em>Listener</code> method.
* <p>
! * You can specify the {@code listenerType} argument
* with a class literal, such as
* <code><em>Foo</em>Listener.class</code>.
* For example, you can query a
! * {@code Scrollbar c}
* for its mouse listeners with the following code:
*
* <pre>MouseListener[] mls = (MouseListener[])(c.getListeners(MouseListener.class));</pre>
*
* If no such listeners exist, this method returns an empty array.
*
* @param listenerType the type of listeners requested; this parameter
* should specify an interface that descends from
! * {@code java.util.EventListener}
* @return an array of all objects registered as
* <code><em>Foo</em>Listener</code>s on this component,
* or an empty array if no such listeners have been added
! * @exception ClassCastException if {@code listenerType}
* doesn't specify a class or interface that implements
! * {@code java.util.EventListener}
*
* @since 1.3
*/
public <T extends EventListener> T[] getListeners(Class<T> listenerType) {
EventListener l = null;
*** 1090,1104 ****
return super.eventEnabled(e);
}
/**
* Processes events on this scroll bar. If the event is an
! * instance of <code>AdjustmentEvent</code>, it invokes the
! * <code>processAdjustmentEvent</code> method.
* Otherwise, it invokes its superclass's
! * <code>processEvent</code> method.
! * <p>Note that if the event parameter is <code>null</code>
* the behavior is unspecified and may result in an
* exception.
*
* @param e the event
* @see java.awt.event.AdjustmentEvent
--- 1090,1104 ----
return super.eventEnabled(e);
}
/**
* Processes events on this scroll bar. If the event is an
! * instance of {@code AdjustmentEvent}, it invokes the
! * {@code processAdjustmentEvent} method.
* Otherwise, it invokes its superclass's
! * {@code processEvent} method.
! * <p>Note that if the event parameter is {@code null}
* the behavior is unspecified and may result in an
* exception.
*
* @param e the event
* @see java.awt.event.AdjustmentEvent
*** 1114,1134 ****
}
/**
* Processes adjustment events occurring on this
* scrollbar by dispatching them to any registered
! * <code>AdjustmentListener</code> objects.
* <p>
* This method is not called unless adjustment events are
* enabled for this component. Adjustment events are enabled
* when one of the following occurs:
* <ul>
! * <li>An <code>AdjustmentListener</code> object is registered
! * via <code>addAdjustmentListener</code>.
! * <li>Adjustment events are enabled via <code>enableEvents</code>.
* </ul>
! * <p>Note that if the event parameter is <code>null</code>
* the behavior is unspecified and may result in an
* exception.
*
* @param e the adjustment event
* @see java.awt.event.AdjustmentEvent
--- 1114,1134 ----
}
/**
* Processes adjustment events occurring on this
* scrollbar by dispatching them to any registered
! * {@code AdjustmentListener} objects.
* <p>
* This method is not called unless adjustment events are
* enabled for this component. Adjustment events are enabled
* when one of the following occurs:
* <ul>
! * <li>An {@code AdjustmentListener} object is registered
! * via {@code addAdjustmentListener}.
! * <li>Adjustment events are enabled via {@code enableEvents}.
* </ul>
! * <p>Note that if the event parameter is {@code null}
* the behavior is unspecified and may result in an
* exception.
*
* @param e the adjustment event
* @see java.awt.event.AdjustmentEvent
*** 1143,1157 ****
listener.adjustmentValueChanged(e);
}
}
/**
! * Returns a string representing the state of this <code>Scrollbar</code>.
* This method is intended to be used only for debugging purposes, and the
* content and format of the returned string may vary between
* implementations. The returned string may be empty but may not be
! * <code>null</code>.
*
* @return the parameter string of this scroll bar
*/
protected String paramString() {
return super.paramString() +
--- 1143,1157 ----
listener.adjustmentValueChanged(e);
}
}
/**
! * Returns a string representing the state of this {@code Scrollbar}.
* This method is intended to be used only for debugging purposes, and the
* content and format of the returned string may vary between
* implementations. The returned string may be empty but may not be
! * {@code null}.
*
* @return the parameter string of this scroll bar
*/
protected String paramString() {
return super.paramString() +
*** 1174,1194 ****
*/
private int scrollbarSerializedDataVersion = 1;
/**
* Writes default serializable fields to stream. Writes
! * a list of serializable <code>AdjustmentListeners</code>
* as optional data. The non-serializable listeners are
* detected and no attempt is made to serialize them.
*
! * @param s the <code>ObjectOutputStream</code> to write
! * @serialData <code>null</code> terminated sequence of 0
! * or more pairs; the pair consists of a <code>String</code>
! * and an <code>Object</code>; the <code>String</code> indicates
* the type of object and is one of the following:
! * <code>adjustmentListenerK</code> indicating an
! * <code>AdjustmentListener</code> object
*
* @see AWTEventMulticaster#save(ObjectOutputStream, String, EventListener)
* @see java.awt.Component#adjustmentListenerK
* @see #readObject(ObjectInputStream)
*/
--- 1174,1194 ----
*/
private int scrollbarSerializedDataVersion = 1;
/**
* Writes default serializable fields to stream. Writes
! * a list of serializable {@code AdjustmentListeners}
* as optional data. The non-serializable listeners are
* detected and no attempt is made to serialize them.
*
! * @param s the {@code ObjectOutputStream} to write
! * @serialData {@code null} terminated sequence of 0
! * or more pairs; the pair consists of a {@code String}
! * and an {@code Object}; the {@code String} indicates
* the type of object and is one of the following:
! * {@code adjustmentListenerK} indicating an
! * {@code AdjustmentListener} object
*
* @see AWTEventMulticaster#save(ObjectOutputStream, String, EventListener)
* @see java.awt.Component#adjustmentListenerK
* @see #readObject(ObjectInputStream)
*/
*** 1200,1219 ****
AWTEventMulticaster.save(s, adjustmentListenerK, adjustmentListener);
s.writeObject(null);
}
/**
! * Reads the <code>ObjectInputStream</code> and if
! * it isn't <code>null</code> adds a listener to
* receive adjustment events fired by the
! * <code>Scrollbar</code>.
* Unrecognized keys or values will be ignored.
*
! * @param s the <code>ObjectInputStream</code> to read
* @exception HeadlessException if
! * <code>GraphicsEnvironment.isHeadless</code> returns
! * <code>true</code>
* @see java.awt.GraphicsEnvironment#isHeadless
* @see #writeObject(ObjectOutputStream)
*/
private void readObject(ObjectInputStream s)
throws ClassNotFoundException, IOException, HeadlessException
--- 1200,1219 ----
AWTEventMulticaster.save(s, adjustmentListenerK, adjustmentListener);
s.writeObject(null);
}
/**
! * Reads the {@code ObjectInputStream} and if
! * it isn't {@code null} adds a listener to
* receive adjustment events fired by the
! * {@code Scrollbar}.
* Unrecognized keys or values will be ignored.
*
! * @param s the {@code ObjectInputStream} to read
* @exception HeadlessException if
! * {@code GraphicsEnvironment.isHeadless} returns
! * {@code true}
* @see java.awt.GraphicsEnvironment#isHeadless
* @see #writeObject(ObjectOutputStream)
*/
private void readObject(ObjectInputStream s)
throws ClassNotFoundException, IOException, HeadlessException
*** 1237,1254 ****
/////////////////
// Accessibility support
////////////////
/**
! * Gets the <code>AccessibleContext</code> associated with this
! * <code>Scrollbar</code>. For scrollbars, the
! * <code>AccessibleContext</code> takes the form of an
! * <code>AccessibleAWTScrollBar</code>. A new
! * <code>AccessibleAWTScrollBar</code> instance is created if necessary.
*
! * @return an <code>AccessibleAWTScrollBar</code> that serves as the
! * <code>AccessibleContext</code> of this <code>ScrollBar</code>
* @since 1.3
*/
public AccessibleContext getAccessibleContext() {
if (accessibleContext == null) {
accessibleContext = new AccessibleAWTScrollBar();
--- 1237,1254 ----
/////////////////
// Accessibility support
////////////////
/**
! * Gets the {@code AccessibleContext} associated with this
! * {@code Scrollbar}. For scrollbars, the
! * {@code AccessibleContext} takes the form of an
! * {@code AccessibleAWTScrollBar}. A new
! * {@code AccessibleAWTScrollBar} instance is created if necessary.
*
! * @return an {@code AccessibleAWTScrollBar} that serves as the
! * {@code AccessibleContext} of this {@code ScrollBar}
* @since 1.3
*/
public AccessibleContext getAccessibleContext() {
if (accessibleContext == null) {
accessibleContext = new AccessibleAWTScrollBar();
*** 1256,1266 ****
return accessibleContext;
}
/**
* This class implements accessibility support for the
! * <code>Scrollbar</code> class. It provides an implementation of
* the Java Accessibility API appropriate to scrollbar
* user-interface elements.
* @since 1.3
*/
protected class AccessibleAWTScrollBar extends AccessibleAWTComponent
--- 1256,1266 ----
return accessibleContext;
}
/**
* This class implements accessibility support for the
! * {@code Scrollbar} class. It provides an implementation of
* the Java Accessibility API appropriate to scrollbar
* user-interface elements.
* @since 1.3
*/
protected class AccessibleAWTScrollBar extends AccessibleAWTComponent
*** 1272,1282 ****
private static final long serialVersionUID = -344337268523697807L;
/**
* Get the state set of this object.
*
! * @return an instance of <code>AccessibleState</code>
* containing the current state of the object
* @see AccessibleState
*/
public AccessibleStateSet getAccessibleStateSet() {
AccessibleStateSet states = super.getAccessibleStateSet();
--- 1272,1282 ----
private static final long serialVersionUID = -344337268523697807L;
/**
* Get the state set of this object.
*
! * @return an instance of {@code AccessibleState}
* containing the current state of the object
* @see AccessibleState
*/
public AccessibleStateSet getAccessibleStateSet() {
AccessibleStateSet states = super.getAccessibleStateSet();
*** 1292,1314 ****
}
/**
* Get the role of this object.
*
! * @return an instance of <code>AccessibleRole</code>
* describing the role of the object
*/
public AccessibleRole getAccessibleRole() {
return AccessibleRole.SCROLL_BAR;
}
/**
! * Get the <code>AccessibleValue</code> associated with this
* object. In the implementation of the Java Accessibility
* API for this class, return this object, which is
* responsible for implementing the
! * <code>AccessibleValue</code> interface on behalf of itself.
*
* @return this object
*/
public AccessibleValue getAccessibleValue() {
return this;
--- 1292,1314 ----
}
/**
* Get the role of this object.
*
! * @return an instance of {@code AccessibleRole}
* describing the role of the object
*/
public AccessibleRole getAccessibleRole() {
return AccessibleRole.SCROLL_BAR;
}
/**
! * Get the {@code AccessibleValue} associated with this
* object. In the implementation of the Java Accessibility
* API for this class, return this object, which is
* responsible for implementing the
! * {@code AccessibleValue} interface on behalf of itself.
*
* @return this object
*/
public AccessibleValue getAccessibleValue() {
return this;
< prev index next >