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:
Each scroll bar in this example could be created with code similar to the following:
redSlider=new Scrollbar(Scrollbar.VERTICAL, 0, 1, 0, 255); add(redSlider);
Alternatively, a scroll bar can represent a range of values. For example, if a scroll bar is used for scrolling through text, the width of the "bubble" (also called the "thumb" or "scroll box") can be used to represent the amount of text that is visible. Here is an example of a scroll bar that represents a range:
The value range represented by the bubble in this example is the visible amount. The horizontal scroll bar in this example could be created with code like the following:
ranger = new Scrollbar(Scrollbar.HORIZONTAL, 0, 60, 0, 300); add(ranger);
Note that the actual maximum value of the scroll bar is the
maximum minus the visible amount.
In the previous example, because the maximum is
300 and the 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.
Normally, the user changes the value of the scroll bar by making a gesture with the mouse. For example, the user can drag the scroll bar's bubble up and down, or click in the scroll bar's unit increment or block increment areas. Keyboard gestures can also be mapped to the scroll bar. By convention, the Page Up and Page Down keys are equivalent to clicking in the scroll bar's block increment and block decrement areas.
When the user changes the value of the scroll bar, the scroll bar
receives an instance of AdjustmentEvent.
The scroll bar processes this event, passing it along to
any registered listeners.
Any object that wishes to be notified of changes to the
scroll bar's value should implement
AdjustmentListener, an interface defined in
the package java.awt.event.
Listeners can be added and removed dynamically by calling
the methods addAdjustmentListener and
removeAdjustmentListener.
The AdjustmentEvent class defines five types
of adjustment event, listed here:
AdjustmentEvent.TRACK is sent out when the
user drags the scroll bar's bubble.
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.
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.
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 Page Up
key is equivalent, if the user is using a keyboard that
defines a Page Up key.
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 Page Down
key is equivalent, if the user is using a keyboard that
defines a Page Down key.
The JDK 1.0 event system is supported for backwards compatibility, but its use with newer versions of the platform is discouraged. The five types of adjustment events introduced with JDK 1.1 correspond to the five event types 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.
AdjustmentEvent.TRACK replaces
Event.SCROLL_ABSOLUTE
AdjustmentEvent.UNIT_INCREMENT replaces
Event.SCROLL_LINE_UP
AdjustmentEvent.UNIT_DECREMENT replaces
Event.SCROLL_LINE_DOWN
AdjustmentEvent.BLOCK_INCREMENT replaces
Event.SCROLL_PAGE_UP
AdjustmentEvent.BLOCK_DECREMENT replaces
Event.SCROLL_PAGE_DOWN
Note
We recommend using a Scrollbar
for value selection only. If you want to implement
a scrollable component inside a container, we recommend you use
a ScrollPane. If you use a
Scrollbar for this purpose, you are likely to
encounter issues with painting, key handling, sizing and
positioning.
java.awt.event.AdjustmentEvent , java.awt.event.AdjustmentListener
| Modifier and Type | Class and Description |
|---|---|
| protected class | Scrollbar.
This class implements accessibility support for the
|
| Modifier and Type | Field and Description |
|---|---|
| pack-priv transient AdjustmentListener | |
| private static final String | |
| public static final int | HORIZONTAL
A constant that indicates a horizontal scroll bar.
|
| pack-priv transient boolean | isAdjusting
The adjusting status of the |
| pack-priv int | lineIncrement
The amount by which the scrollbar value will change when going up or down by a line. |
| pack-priv int | maximum
The maximum value of the |
| pack-priv int | minimum
The minimum value of the |
| private static int | |
| pack-priv int | orientation
The |
| pack-priv int | pageIncrement
The amount by which the scrollbar value will change when going up or down by a page. |
| private int | scrollbarSerializedDataVersion
The scroll bar's serialized Data Version. |
| private static final long | serialVersionUID
Use serialVersionUID from JDK 1.1 for interoperability.
|
| pack-priv int | value
The value of the |
| public static final int | VERTICAL
Hides java. |
| pack-priv int | visibleAmount
The size of the |
| Access | Constructor and Description |
|---|---|
| public | |
| public | Scrollbar(int
indicates the orientation of the scroll bar orientation)Constructs a new scroll bar with the specified orientation. |
| public | Scrollbar(int
indicates the orientation of the scroll bar. orientation, int the initial value of the scroll bar value, int the visible amount of the scroll bar, typically
represented by the size of the bubble visible, int the minimum value of the scroll bar minimum, int the maximum value of the scroll bar maximum)Constructs a new scroll bar with the specified orientation, initial value, visible amount, and minimum and maximum values. |
| Modifier and Type | Method and Description |
|---|---|
| public synchronized void | addAdjustmentListener(AdjustmentListener
the adjustment listener l)Implements java. Adds the specified adjustment listener to receive instances of
|
| public void | |
| pack-priv String | constructComponentName()
Overrides java. Constructs a name for this component. |
| pack-priv boolean | |
| public AccessibleContext | Returns: anAccessibleAWTScrollBar that serves as the
AccessibleContext of this ScrollBarOverrides java. Implements javax. Gets the |
| public synchronized AdjustmentListener[] | Returns: all of this scrollbar'sAdjustmentListeners
or an empty array if no adjustment
listeners are currently registeredReturns an array of all the adjustment listeners registered on this scrollbar. |
| public int | Returns: the block increment of this scroll barImplements java. Gets the block increment of this scroll bar. |
| public int | Returns: the unit increment for this scrollbar
Deprecated
As of JDK version 1.1,
replaced by
getUnitIncrement().
Returns the unit increment for this scrollbar. |
| public <T extends EventListener> T[] | Returns: an array of all objects registered asFooListeners on this component,
or an empty array if no such listeners have been addedthe type of listeners requested; this parameter
should specify an interface that descends from
listenerType)java.util.EventListenerOverrides java. Returns an array of all the objects currently registered
as |
| public int | Returns: the maximum value of this scroll barImplements java. Gets the maximum value of this scroll bar. |
| public int | Returns: the minimum value of this scroll barImplements java. Gets the minimum value of this scroll bar. |
| public int | Returns: the orientation of this scroll bar, eitherScrollbar.HORIZONTAL or
Scrollbar.VERTICALImplements java. Returns the orientation of this scroll bar. |
| public int | Returns: the block increment of this scroll bar
Deprecated
As of JDK version 1.1,
replaced by
getBlockIncrement().
Returns the block increment of this scroll bar. |
| public int | Returns: the unit increment of this scroll barImplements java. Gets the unit increment for this scrollbar. |
| public int | Returns: the current value of this scroll barImplements java. Gets the current value of this scroll bar. |
| public boolean | Returns: the value of thevalueIsAdjusting propertyReturns true if the value is in the process of changing as a result of actions being taken by the user. |
| public int | Returns: the visible amount of this scroll bar
Deprecated
As of JDK version 1.1,
replaced by
getVisibleAmount().
Returns the visible amount of this scroll bar. |
| public int | Returns: the visible amount of this scroll barImplements java. Gets the visible amount of this scroll bar. |
| private static native void | |
| protected String | Returns: the parameter string of this scroll barOverrides java. Returns a string representing the state of this |
| protected void | processAdjustmentEvent(AdjustmentEvent
the adjustment event e)Processes adjustment events occurring on this
scrollbar by dispatching them to any registered
|
| protected void | processEvent(AWTEvent
the event e)Overrides java. Processes events on this scroll bar. |
| private void | readObject(ObjectInputStream
the s)ObjectInputStream to readHides java. Reads the |
| public synchronized void | removeAdjustmentListener(AdjustmentListener
the adjustment listener l)Implements java. Removes the specified adjustment listener so that it no longer
receives instances of |
| public void | setBlockIncrement(int
the amount by which to increment or decrement
the scroll bar's value v)Implements java. Sets the block increment for this scroll bar. |
| public synchronized void | setLineIncrement(int
the increment value v)
Deprecated
As of JDK version 1.1,
replaced by
setUnitIncrement(int).
Sets the unit increment for this scroll bar. |
| public void | setMaximum(int
the new maximum value
for this scroll bar newMaximum)Implements java. Sets the maximum value of this scroll bar. |
| public void | setMinimum(int
the new minimum value for this scroll bar newMinimum)Implements java. Sets the minimum value of this scroll bar. |
| public void | setOrientation(int
the orientation of this scroll bar, either
orientation)Scrollbar.HORIZONTAL or
Scrollbar.VERTICALSets the orientation for this scroll bar. |
| public synchronized void | setPageIncrement(int
the block increment v)
Deprecated
As of JDK version 1.1,
replaced by
setBlockIncrement().
Sets the block increment for this scroll bar. |
| public void | setUnitIncrement(int
the amount by which to increment or decrement
the scroll bar's value v)Implements java. Sets the unit increment for this scroll bar. |
| public void | setValue(int
the new value of the scroll bar newValue)Implements java. Sets the value of this scroll bar to the specified value. |
| public void | |
| public void | setValues(int
is the position in the current window value, int is the visible amount of the scroll bar visible, int is the minimum value of the scroll bar minimum, int is the maximum value of the scroll bar maximum)Sets the values of four properties for this scroll bar:
|
| public void | setVisibleAmount(int
the new visible amount newAmount)Implements java. Sets the visible amount of this scroll bar. |
| private void | writeObject(ObjectOutputStream
the s)ObjectOutputStream to writeHides java. Writes default serializable fields to stream. |