| |
|
| java.lang.Object
 java.awt.Component
java.awt.Scrollbar
| Scrollbar | | public class Scrollbar extends Component implements Adjustable,Accessible(Code) | | The 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 ScrollPane . If you use a
Scrollbar for this purpose, you are likely to
encounter issues with painting, key handling, sizing and
positioning.
version:
1.119, 05/05/07
author:
Sami Shaio
See Also: java.awt.event.AdjustmentEvent
See Also: java.awt.event.AdjustmentListener
since:
JDK1.0 |
| Inner Class :protected class AccessibleAWTScrollBar extends AccessibleAWTComponent implements AccessibleValue | |
| Field Summary | |
| final public static int | HORIZONTAL
A constant that indicates a horizontal scroll bar. | | final public static int | VERTICAL
A constant that indicates a vertical scroll bar. | | transient AdjustmentListener | adjustmentListener
| | transient boolean | isAdjusting
The adjusting status of the Scrollbar. | | int | lineIncrement
The amount by which the scrollbar value will change when going
up or down by a line.
This value must be greater than zero. | | int | maximum
The maximum value of the Scrollbar. | | int | minimum
The minimum value of the Scrollbar. | | int | orientation
The Scrollbar's orientation--being either horizontal
or vertical. | | int | pageIncrement
The amount by which the scrollbar value will change when going
up or down by a page.
This value must be greater than zero. | | int | value
The value of the Scrollbar. | | int | visibleAmount
The size of the Scrollbar's bubble. |
| Constructor Summary | |
| public | Scrollbar()
Constructs a new vertical scroll bar. | | public | Scrollbar(int orientation)
Constructs a new scroll bar with the specified orientation. | | public | Scrollbar(int orientation, int value, int visible, int minimum, int maximum)
Constructs a new scroll bar with the specified orientation,
initial value, visible amount, and minimum and maximum values.
The orientation argument must take one of the two
values Scrollbar.HORIZONTAL,
or Scrollbar.VERTICAL,
indicating a horizontal or vertical scroll bar, respectively.
The parameters supplied to this constructor are subject to the
constraints described in
Scrollbar.setValues(int,int,int,int) . |
| Method Summary | |
| public synchronized void | addAdjustmentListener(AdjustmentListener l)
Adds the specified adjustment listener to receive instances of
AdjustmentEvent from this scroll bar. | | public void | addNotify()
Creates the Scrollbar's peer. | | String | constructComponentName()
Constructs a name for this component. | | boolean | eventEnabled(AWTEvent e)
| | public AccessibleContext | getAccessibleContext()
Gets the AccessibleContext associated with this
Scrollbar. | | public synchronized AdjustmentListener[] | getAdjustmentListeners()
Returns an array of all the adjustment listeners
registered on this scrollbar. | | public int | getBlockIncrement()
Gets the block increment of this scroll bar.
The block increment is the value that is added or subtracted
when the user activates the block increment area of the
scroll bar, generally through a mouse or keyboard gesture
that the scroll bar receives as an adjustment event.
The block increment must be greater than zero. | | public int | getLineIncrement()
| | public T[] | getListeners(Class<T> listenerType)
Returns an array of all the objects currently registered
as FooListeners
upon this Scrollbar. | | public int | getMaximum()
Gets the maximum value of this scroll bar. | | public int | getMinimum()
Gets the minimum value of this scroll bar. | | public int | getOrientation()
Returns the orientation of this scroll bar. | | public int | getPageIncrement()
| | public int | getUnitIncrement()
Gets the unit increment for this scrollbar.
The unit increment is the value that is added or subtracted
when the user activates the unit increment area of the
scroll bar, generally through a mouse or keyboard gesture
that the scroll bar receives as an adjustment event.
The unit increment must be greater than zero. | | public int | getValue()
Gets the current value of this scroll bar. | | public boolean | getValueIsAdjusting()
Returns true if the value is in the process of changing as a
result of actions being taken by the user. | | public int | getVisible()
| | public int | getVisibleAmount()
Gets the visible amount of this scroll bar.
When a scroll bar is used to select a range of values,
the visible amount is used to represent the range of values
that are currently visible. | | protected String | paramString()
Returns a string representing the state of this 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. | | protected void | processAdjustmentEvent(AdjustmentEvent e)
Processes adjustment events occurring on this
scrollbar by dispatching them to any registered
AdjustmentListener objects.
This method is not called unless adjustment events are
enabled for this component. | | protected void | processEvent(AWTEvent e)
Processes events on this scroll bar. | | public synchronized void | removeAdjustmentListener(AdjustmentListener l)
Removes the specified adjustment listener so that it no longer
receives instances of AdjustmentEvent from this scroll bar. | | public void | setBlockIncrement(int v)
Sets the block increment for this scroll bar.
The block increment is the value that is added or subtracted
when the user activates the block increment area of the
scroll bar, generally through a mouse or keyboard gesture
that the scroll bar receives as an adjustment event.
The block increment must be greater than zero. | | public synchronized void | setLineIncrement(int v)
| | public void | setMaximum(int newMaximum)
Sets the maximum value of this scroll bar. | | public void | setMinimum(int newMinimum)
Sets the minimum value of this scroll bar.
When 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. | | public void | setOrientation(int orientation)
Sets the orientation for this scroll bar. | | public synchronized void | setPageIncrement(int v)
| | public void | setUnitIncrement(int v)
Sets the unit increment for this scroll bar.
The unit increment is the value that is added or subtracted
when the user activates the unit increment area of the
scroll bar, generally through a mouse or keyboard gesture
that the scroll bar receives as an adjustment event.
The unit increment must be greater than zero. | | public void | setValue(int newValue)
Sets the value of this scroll bar to the specified value. | | public void | setValueIsAdjusting(boolean b)
Sets the valueIsAdjusting property. | | public void | setValues(int value, int visible, int minimum, int maximum)
Sets the values of four properties for this scroll bar:
value, visibleAmount,
minimum, and maximum.
If the values supplied for these properties are inconsistent
or incorrect, they will be changed to ensure consistency. | | public void | setVisibleAmount(int newAmount)
Sets the visible amount of this scroll bar.
When a scroll bar is used to select a range of values,
the visible amount is used to represent the range of values
that are currently visible. |
| HORIZONTAL | | final public static int HORIZONTAL(Code) | | A constant that indicates a horizontal scroll bar.
|
| VERTICAL | | final public static int VERTICAL(Code) | | A constant that indicates a vertical scroll bar.
|
| orientation | | int orientation(Code) | | The Scrollbar's orientation--being either horizontal
or vertical.
This value should be specified when the scrollbar is created.
orientation can be either : VERTICAL or
HORIZONTAL only.
See Also: Scrollbar.getOrientation
See Also: Scrollbar.setOrientation |
| value | | int value(Code) | | The value of the Scrollbar.
This property must be greater than or equal to minimum
and less than or equal to
maximum - visibleAmount
See Also: Scrollbar.getValue
See Also: Scrollbar.setValue |
| visibleAmount | | int visibleAmount(Code) | | The size of the Scrollbar's bubble.
When a scroll bar is used to select a range of values,
the visibleAmount represents the size of this range.
This is visually indicated by the size of the bubble.
See Also: Scrollbar.getVisibleAmount
See Also: Scrollbar.setVisibleAmount |
| Scrollbar | | public Scrollbar() throws HeadlessException(Code) | | Constructs a new vertical scroll bar.
The default properties of the scroll bar are listed in
the following table:
| Property |
Description |
Default Value |
| orientation |
indicates whether the scroll bar is vertical
or horizontal |
Scrollbar.VERTICAL |
| value |
value which controls the location
of the scroll bar's bubble |
0 |
| visible amount |
visible amount of the scroll bar's range,
typically represented by the size of the
scroll bar's bubble |
10 |
| minimum |
minimum value of the scroll bar |
0 |
| maximum |
maximum value of the scroll bar |
100 |
| unit increment |
amount the value changes when the
Line Up or Line Down key is pressed,
or when the end arrows of the scrollbar
are clicked |
1 |
| block increment |
amount the value changes when the
Page Up or Page Down key is pressed,
or when the scrollbar track is clicked
on either side of the bubble |
10 |
exception:
HeadlessException - if GraphicsEnvironment.isHeadless()returns true.
See Also: java.awt.GraphicsEnvironment.isHeadless |
| Scrollbar | | public Scrollbar(int orientation) throws HeadlessException(Code) | | Constructs a new scroll bar with the specified orientation.
The orientation argument must take one of the two
values Scrollbar.HORIZONTAL,
or Scrollbar.VERTICAL,
indicating a horizontal or vertical scroll bar, respectively.
Parameters:
orientation - indicates the orientation of the scroll bar
exception:
IllegalArgumentException - when an illegal value forthe orientation argument is supplied
exception:
HeadlessException - if GraphicsEnvironment.isHeadless()returns true.
See Also: java.awt.GraphicsEnvironment.isHeadless |
| Scrollbar | | public Scrollbar(int orientation, int value, int visible, int minimum, int maximum) throws HeadlessException(Code) | | Constructs a new scroll bar with the specified orientation,
initial value, visible amount, and minimum and maximum values.
The orientation argument must take one of the two
values Scrollbar.HORIZONTAL,
or Scrollbar.VERTICAL,
indicating a horizontal or vertical scroll bar, respectively.
The parameters supplied to this constructor are subject to the
constraints described in
Scrollbar.setValues(int,int,int,int) .
Parameters:
orientation - indicates the orientation of the scroll bar.
Parameters:
value - the initial value of the scroll bar
Parameters:
visible - the visible amount of the scroll bar, typically represented by the size of the bubble
Parameters:
minimum - the minimum value of the scroll bar
Parameters:
maximum - the maximum value of the scroll bar
exception:
IllegalArgumentException - when an illegal value forthe orientation argument is supplied
exception:
HeadlessException - if GraphicsEnvironment.isHeadless()returns true.
See Also: Scrollbar.setValues
See Also: java.awt.GraphicsEnvironment.isHeadless |
| addNotify | | public void addNotify()(Code) | | Creates the Scrollbar's peer. The peer allows you to modify
the appearance of the Scrollbar without changing any of its
functionality.
|
| constructComponentName | | String constructComponentName()(Code) | | Constructs a name for this component. Called by getName
when the name is null.
|
| getAccessibleContext | | public AccessibleContext getAccessibleContext()(Code) | | Gets the AccessibleContext associated with this
Scrollbar. For scrollbars, the
AccessibleContext takes the form of an
AccessibleAWTScrollBar. A new
AccessibleAWTScrollBar instance is created if necessary.
an AccessibleAWTScrollBar that serves as the AccessibleContext of this ScrollBar
since:
1.3 |
| getBlockIncrement | | public int getBlockIncrement()(Code) | | Gets the block increment of this scroll bar.
The block increment is the value that is added or subtracted
when the user activates the block increment area of the
scroll bar, generally through a mouse or keyboard gesture
that the scroll bar receives as an adjustment event.
The block increment must be greater than zero.
the block increment of this scroll bar
See Also: java.awt.Scrollbar.setBlockIncrement
since:
JDK1.1 |
| getLineIncrement | | public int getLineIncrement()(Code) | | |
| getListeners | | public T[] getListeners(Class<T> listenerType)(Code) | | Returns an array of all the objects currently registered
as FooListeners
upon this Scrollbar.
FooListeners are registered using the
addFooListener method.
You can specify the listenerType argument
with a class literal, such as
FooListener.class.
For example, you can query a
Scrollbar c
for its mouse listeners with the following code:
MouseListener[] mls = (MouseListener[])(c.getListeners(MouseListener.class));
If no such listeners exist, this method returns an empty array.
Parameters:
listenerType - the type of listeners requested; this parametershould specify an interface that descends fromjava.util.EventListener an array of all objects registered asFooListeners on this component,or an empty array if no such listeners have been added
exception:
ClassCastException - if listenerTypedoesn't specify a class or interface that implementsjava.util.EventListener
since:
1.3 |
| getOrientation | | public int getOrientation()(Code) | | Returns the orientation of this scroll bar.
the orientation of this scroll bar, eitherScrollbar.HORIZONTAL orScrollbar.VERTICAL
See Also: java.awt.Scrollbar.setOrientation |
| getPageIncrement | | public int getPageIncrement()(Code) | | |
| getUnitIncrement | | public int getUnitIncrement()(Code) | | Gets the unit increment for this scrollbar.
The unit increment is the value that is added or subtracted
when the user activates the unit increment area of the
scroll bar, generally through a mouse or keyboard gesture
that the scroll bar receives as an adjustment event.
The unit increment must be greater than zero.
the unit increment of this scroll bar
See Also: java.awt.Scrollbar.setUnitIncrement
since:
JDK1.1 |
| getValueIsAdjusting | | public boolean getValueIsAdjusting()(Code) | | Returns true if the value is in the process of changing as a
result of actions being taken by the user.
the value of the valueIsAdjusting property
See Also: Scrollbar.setValueIsAdjusting
since:
1.4 |
| getVisible | | public int getVisible()(Code) | | |
| getVisibleAmount | | public int getVisibleAmount()(Code) | | Gets the visible amount of this scroll bar.
When a scroll bar is used to select a range of values,
the visible amount is used to represent the range of values
that are currently visible. The size of the scroll bar's
bubble (also called a thumb or scroll box), usually gives a
visual representation of the relationship of the visible
amount to the range of the scroll bar.
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 getVisibleAmount.
the visible amount of this scroll bar
See Also: java.awt.Scrollbar.setVisibleAmount
since:
JDK1.1 |
| paramString | | protected String paramString()(Code) | | Returns a string representing the state of this 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
null.
the parameter string of this scroll bar |
| processAdjustmentEvent | | protected void processAdjustmentEvent(AdjustmentEvent e)(Code) | | Processes adjustment events occurring on this
scrollbar by dispatching them to any registered
AdjustmentListener objects.
This method is not called unless adjustment events are
enabled for this component. Adjustment events are enabled
when one of the following occurs:
- An
AdjustmentListener object is registered
via addAdjustmentListener.
- Adjustment events are enabled via
enableEvents.
Note that if the event parameter is null
the behavior is unspecified and may result in an
exception.
Parameters:
e - the adjustment event
See Also: java.awt.event.AdjustmentEvent
See Also: java.awt.event.AdjustmentListener
See Also: java.awt.Scrollbar.addAdjustmentListener
See Also: java.awt.Component.enableEvents
since:
JDK1.1 |
| processEvent | | protected void processEvent(AWTEvent e)(Code) | | Processes events on this scroll bar. If the event is an
instance of AdjustmentEvent, it invokes the
processAdjustmentEvent method.
Otherwise, it invokes its superclass's
processEvent method.
Note that if the event parameter is null
the behavior is unspecified and may result in an
exception.
Parameters:
e - the event
See Also: java.awt.event.AdjustmentEvent
See Also: java.awt.Scrollbar.processAdjustmentEvent
since:
JDK1.1 |
| setBlockIncrement | | public void setBlockIncrement(int v)(Code) | | Sets the block increment for this scroll bar.
The block increment is the value that is added or subtracted
when the user activates the block increment area of the
scroll bar, generally through a mouse or keyboard gesture
that the scroll bar receives as an adjustment event.
The block increment must be greater than zero.
Attepts to set the block increment to a value lower than 1
will result in a value of 1 being set.
Parameters:
v - the amount by which to increment or decrementthe scroll bar's value
See Also: java.awt.Scrollbar.getBlockIncrement
since:
JDK1.1 |
| setLineIncrement | | public synchronized void setLineIncrement(int v)(Code) | | |
| setMaximum | | public void setMaximum(int newMaximum)(Code) | | Sets the maximum value of this scroll bar.
When 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.
Normally, a program should change a scroll bar's maximum
value only by calling setValues.
The setValues method simultaneously
and synchronously sets the minimum, maximum, visible amount,
and value properties of a scroll bar, so that they are
mutually consistent.
Note that setting the maximum value to Integer.MIN_VALUE
will result in the new maximum value being set to
Integer.MIN_VALUE + 1.
Parameters:
newMaximum - the new maximum valuefor this scroll bar
See Also: java.awt.Scrollbar.setValues
See Also: java.awt.Scrollbar.setMinimum
since:
JDK1.1 |
| setMinimum | | public void setMinimum(int newMinimum)(Code) | | Sets the minimum value of this scroll bar.
When 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.
Normally, a program should change a scroll bar's minimum
value only by calling setValues.
The setValues method simultaneously
and synchronously sets the minimum, maximum, visible amount,
and value properties of a scroll bar, so that they are
mutually consistent.
Note that setting the minimum value to Integer.MAX_VALUE
will result in the new minimum value being set to
Integer.MAX_VALUE - 1.
Parameters:
newMinimum - the new minimum value for this scroll bar
See Also: java.awt.Scrollbar.setValues
See Also: java.awt.Scrollbar.setMaximum
since:
JDK1.1 |
| setOrientation | | public void setOrientation(int orientation)(Code) | | Sets the orientation for this scroll bar.
Parameters:
orientation - the orientation of this scroll bar, eitherScrollbar.HORIZONTAL orScrollbar.VERTICAL
See Also: java.awt.Scrollbar.getOrientation
exception:
IllegalArgumentException - if the value suppliedfor orientation is not alegal value
since:
JDK1.1 |
| setPageIncrement | | public synchronized void setPageIncrement(int v)(Code) | | |
| setUnitIncrement | | public void setUnitIncrement(int v)(Code) | | Sets the unit increment for this scroll bar.
The unit increment is the value that is added or subtracted
when the user activates the unit increment area of the
scroll bar, generally through a mouse or keyboard gesture
that the scroll bar receives as an adjustment event.
The unit increment must be greater than zero.
Attepts to set the unit increment to a value lower than 1
will result in a value of 1 being set.
Parameters:
v - the amount by which to increment or decrementthe scroll bar's value
See Also: java.awt.Scrollbar.getUnitIncrement
since:
JDK1.1 |
| setValue | | public void setValue(int newValue)(Code) | | Sets the value of this scroll bar to the specified value.
If the value supplied is less than the current minimum
or greater than the current maximum - visibleAmount,
then either minimum or maximum - visibleAmount
is substituted, as appropriate.
Normally, a program should change a scroll bar's
value only by calling setValues.
The setValues method simultaneously
and synchronously sets the minimum, maximum, visible amount,
and value properties of a scroll bar, so that they are
mutually consistent.
Calling this method does not fire an
AdjustmentEvent.
Parameters:
newValue - the new value of the scroll bar
See Also: java.awt.Scrollbar.setValues
See Also: java.awt.Scrollbar.getValue
See Also: java.awt.Scrollbar.getMinimum
See Also: java.awt.Scrollbar.getMaximum |
| setValueIsAdjusting | | public void setValueIsAdjusting(boolean b)(Code) | | Sets the valueIsAdjusting property.
Parameters:
b - new adjustment-in-progress status
See Also: Scrollbar.getValueIsAdjusting
since:
1.4 |
| setValues | | public void setValues(int value, int visible, int minimum, int maximum)(Code) | | Sets the values of four properties for this scroll bar:
value, visibleAmount,
minimum, and maximum.
If the values supplied for these properties are inconsistent
or incorrect, they will be changed to ensure consistency.
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:
maximum must be greater than minimum,
maximum - minimum must not be greater
than Integer.MAX_VALUE,
visibleAmount must be greater than zero.
visibleAmount must not be greater than
maximum - minimum,
value must not be less than minimum,
and value must not be greater than
maximum - visibleAmount
Calling this method does not fire an
AdjustmentEvent.
Parameters:
value - is the position in the current window
Parameters:
visible - is the visible amount of the scroll bar
Parameters:
minimum - is the minimum value of the scroll bar
Parameters:
maximum - is the maximum value of the scroll bar
See Also: Scrollbar.setMinimum
See Also: Scrollbar.setMaximum
See Also: Scrollbar.setVisibleAmount
See Also: Scrollbar.setValue |
| setVisibleAmount | | public void setVisibleAmount(int newAmount)(Code) | | Sets the visible amount of this scroll bar.
When a scroll bar is used to select a range of values,
the visible amount is used to represent the range of values
that are currently visible. The size of the scroll bar's
bubble (also called a thumb or scroll box), usually gives a
visual representation of the relationship of the visible
amount to the range of the scroll bar.
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 getVisibleAmount.
If the visible amount supplied is less than one
or greater than the current maximum - minimum,
then either one or maximum - minimum
is substituted, as appropriate.
Normally, a program should change a scroll bar's
value only by calling setValues.
The setValues method simultaneously
and synchronously sets the minimum, maximum, visible amount,
and value properties of a scroll bar, so that they are
mutually consistent.
Parameters:
newAmount - the new visible amount
See Also: java.awt.Scrollbar.getVisibleAmount
See Also: java.awt.Scrollbar.setValues
since:
JDK1.1 |
| Methods inherited from java.awt.Component | public boolean action(Event evt, Object what)(Code)(Java Doc)
public void add(PopupMenu popup)(Code)(Java Doc)
public synchronized void addComponentListener(ComponentListener l)(Code)(Java Doc)
public synchronized void addFocusListener(FocusListener l)(Code)(Java Doc)
public void addHierarchyBoundsListener(HierarchyBoundsListener l)(Code)(Java Doc)
public void addHierarchyListener(HierarchyListener l)(Code)(Java Doc)
public synchronized void addInputMethodListener(InputMethodListener l)(Code)(Java Doc)
public synchronized void addKeyListener(KeyListener l)(Code)(Java Doc)
public synchronized void addMouseListener(MouseListener l)(Code)(Java Doc)
public synchronized void addMouseMotionListener(MouseMotionListener l)(Code)(Java Doc)
public synchronized void addMouseWheelListener(MouseWheelListener l)(Code)(Java Doc)
public void addNotify()(Code)(Java Doc)
public synchronized void addPropertyChangeListener(PropertyChangeListener listener)(Code)(Java Doc)
public synchronized void addPropertyChangeListener(String propertyName, PropertyChangeListener listener)(Code)(Java Doc)
void adjustListeningChildrenOnParent(long mask, int num)(Code)(Java Doc)
public void applyComponentOrientation(ComponentOrientation orientation)(Code)(Java Doc)
public boolean areFocusTraversalKeysSet(int id)(Code)(Java Doc)
boolean areInputMethodsEnabled()(Code)(Java Doc)
void autoProcessMouseWheel(MouseWheelEvent e)(Code)(Java Doc)
public Rectangle bounds()(Code)(Java Doc)
final boolean canBeFocusOwner()(Code)(Java Doc)
void checkGD(String stringID)(Code)(Java Doc)
public int checkImage(Image image, ImageObserver observer)(Code)(Java Doc)
public int checkImage(Image image, int width, int height, ImageObserver observer)(Code)(Java Doc)
boolean checkWindowClosingException()(Code)(Java Doc)
void clearCurrentFocusCycleRootOnHide()(Code)(Java Doc)
void clearMostRecentFocusOwnerOnHide()(Code)(Java Doc)
protected AWTEvent coalesceEvents(AWTEvent existingEvent, AWTEvent newEvent)(Code)(Java Doc)
String constructComponentName()(Code)(Java Doc)
public boolean contains(int x, int y)(Code)(Java Doc)
public boolean contains(Point p)(Code)(Java Doc)
boolean containsFocus()(Code)(Java Doc)
int countHierarchyMembers()(Code)(Java Doc)
void createBufferStrategy(int numBuffers)(Code)(Java Doc)
void createBufferStrategy(int numBuffers, BufferCapabilities caps) throws AWTException(Code)(Java Doc)
int createHierarchyEvents(int id, Component changed, Container changedParent, long changeFlags, boolean enabledOnToolkit)(Code)(Java Doc)
public Image createImage(ImageProducer producer)(Code)(Java Doc)
public Image createImage(int width, int height)(Code)(Java Doc)
public VolatileImage createVolatileImage(int width, int height)(Code)(Java Doc)
public VolatileImage createVolatileImage(int width, int height, ImageCapabilities caps) throws AWTException(Code)(Java Doc)
public void deliverEvent(Event e)(Code)(Java Doc)
public void disable()(Code)(Java Doc)
final protected void disableEvents(long eventsToDisable)(Code)(Java Doc)
final public void dispatchEvent(AWTEvent e)(Code)(Java Doc)
void dispatchEventImpl(AWTEvent e)(Code)(Java Doc)
boolean dispatchMouseWheelToAncestor(MouseWheelEvent e)(Code)(Java Doc)
public void doLayout()(Code)(Java Doc)
public void enable()(Code)(Java Doc)
public void enable(boolean b)(Code)(Java Doc)
final protected void enableEvents(long eventsToEnable)(Code)(Java Doc)
public void enableInputMethods(boolean enable)(Code)(Java Doc)
boolean eventEnabled(AWTEvent e)(Code)(Java Doc)
boolean eventTypeEnabled(int type)(Code)(Java Doc)
Component findUnderMouseInWindow(PointerInfo pi)(Code)(Java Doc)
protected void firePropertyChange(String propertyName, Object oldValue, Object newValue)(Code)(Java Doc)
protected void firePropertyChange(String propertyName, boolean oldValue, boolean newValue)(Code)(Java Doc)
protected void firePropertyChange(String propertyName, int oldValue, int newValue)(Code)(Java Doc)
public void firePropertyChange(String propertyName, byte oldValue, byte newValue)(Code)(Java Doc)
public void firePropertyChange(String propertyName, char oldValue, char newValue)(Code)(Java Doc)
public void firePropertyChange(String propertyName, short oldValue, short newValue)(Code)(Java Doc)
public void firePropertyChange(String propertyName, long oldValue, long newValue)(Code)(Java Doc)
public void firePropertyChange(String propertyName, float oldValue, float newValue)(Code)(Java Doc)
public void firePropertyChange(String propertyName, double oldValue, double newValue)(Code)(Java Doc)
public AccessibleContext getAccessibleContext()(Code)(Java Doc)
int getAccessibleIndexInParent()(Code)(Java Doc)
AccessibleStateSet getAccessibleStateSet()(Code)(Java Doc)
public float getAlignmentX()(Code)(Java Doc)
public float getAlignmentY()(Code)(Java Doc)
Image getBackBuffer()(Code)(Java Doc)
public Color getBackground()(Code)(Java Doc)
public int getBaseline(int width, int height)(Code)(Java Doc)
public BaselineResizeBehavior getBaselineResizeBehavior()(Code)(Java Doc)
public Rectangle getBounds()(Code)(Java Doc)
public Rectangle getBounds(Rectangle rv)(Code)(Java Doc)
int getBoundsOp()(Code)(Java Doc)
BufferStrategy getBufferStrategy()(Code)(Java Doc)
public ColorModel getColorModel()(Code)(Java Doc)
public Component getComponentAt(int x, int y)(Code)(Java Doc)
public Component getComponentAt(Point p)(Code)(Java Doc)
public synchronized ComponentListener[] getComponentListeners()(Code)(Java Doc)
public ComponentOrientation getComponentOrientation()(Code)(Java Doc)
Window getContainingWindow()(Code)(Java Doc)
static Window getContainingWindow(Component comp)(Code)(Java Doc)
public Cursor getCursor()(Code)(Java Doc)
final Cursor getCursor_NoClientCode()(Code)(Java Doc)
public synchronized DropTarget getDropTarget()(Code)(Java Doc)
public Container getFocusCycleRootAncestor()(Code)(Java Doc)
public synchronized FocusListener[] getFocusListeners()(Code)(Java Doc)
public Set<AWTKeyStroke> getFocusTraversalKeys(int id)(Code)(Java Doc)
public boolean getFocusTraversalKeysEnabled()(Code)(Java Doc)
final Set getFocusTraversalKeys_NoIDCheck(int id)(Code)(Java Doc)
public Font getFont()(Code)(Java Doc)
public FontMetrics getFontMetrics(Font font)(Code)(Java Doc)
final Font getFont_NoClientCode()(Code)(Java Doc)
public Color getForeground()(Code)(Java Doc)
public Graphics getGraphics()(Code)(Java Doc)
public GraphicsConfiguration getGraphicsConfiguration()(Code)(Java Doc)
final GraphicsConfiguration getGraphicsConfiguration_NoClientCode()(Code)(Java Doc)
final Graphics getGraphics_NoClientCode()(Code)(Java Doc)
public int getHeight()(Code)(Java Doc)
public synchronized HierarchyBoundsListener[] getHierarchyBoundsListeners()(Code)(Java Doc)
public synchronized HierarchyListener[] getHierarchyListeners()(Code)(Java Doc)
public boolean getIgnoreRepaint()(Code)(Java Doc)
public InputContext getInputContext()(Code)(Java Doc)
public synchronized InputMethodListener[] getInputMethodListeners()(Code)(Java Doc)
public InputMethodRequests getInputMethodRequests()(Code)(Java Doc)
public synchronized KeyListener[] getKeyListeners()(Code)(Java Doc)
public T[] getListeners(Class<T> listenerType)(Code)(Java Doc)
public Locale getLocale()(Code)(Java Doc)
public Point getLocation()(Code)(Java Doc)
public Point getLocation(Point rv)(Code)(Java Doc)
public Point getLocationOnScreen()(Code)(Java Doc)
final Point getLocationOnScreen_NoTreeLock()(Code)(Java Doc)
public Dimension getMaximumSize()(Code)(Java Doc)
public Dimension getMinimumSize()(Code)(Java Doc)
public synchronized MouseListener[] getMouseListeners()(Code)(Java Doc)
public synchronized MouseMotionListener[] getMouseMotionListeners()(Code)(Java Doc)
public Point getMousePosition() throws HeadlessException(Code)(Java Doc)
public synchronized MouseWheelListener[] getMouseWheelListeners()(Code)(Java Doc)
public String getName()(Code)(Java Doc)
Container getNativeContainer()(Code)(Java Doc)
public Container getParent()(Code)(Java Doc)
final Container getParent_NoClientCode()(Code)(Java Doc)
public ComponentPeer getPeer()(Code)(Java Doc)
public Dimension getPreferredSize()(Code)(Java Doc)
public synchronized PropertyChangeListener[] getPropertyChangeListeners()(Code)(Java Doc)
public synchronized PropertyChangeListener[] getPropertyChangeListeners(String propertyName)(Code)(Java Doc)
public Dimension getSize()(Code)(Java Doc)
public Dimension getSize(Dimension rv)(Code)(Java Doc)
public Toolkit getToolkit()(Code)(Java Doc)
final Toolkit getToolkitImpl()(Code)(Java Doc)
Container getTraversalRoot()(Code)(Java Doc)
final public Object getTreeLock()(Code)(Java Doc)
public int getWidth()(Code)(Java Doc)
public int getX()(Code)(Java Doc)
public int getY()(Code)(Java Doc)
public boolean gotFocus(Event evt, Object what)(Code)(Java Doc)
public boolean handleEvent(Event evt)(Code)(Java Doc)
public boolean hasFocus()(Code)(Java Doc)
public void hide()(Code)(Java Doc)
public boolean imageUpdate(Image img, int infoflags, int x, int y, int w, int h)(Code)(Java Doc)
void initializeFocusTraversalKeys()(Code)(Java Doc)
public boolean inside(int x, int y)(Code)(Java Doc)
public void invalidate()(Code)(Java Doc)
public boolean isBackgroundSet()(Code)(Java Doc)
final boolean isCoalescingEnabled()(Code)(Java Doc)
public boolean isCursorSet()(Code)(Java Doc)
public boolean isDisplayable()(Code)(Java Doc)
public boolean isDoubleBuffered()(Code)(Java Doc)
public boolean isEnabled()(Code)(Java Doc)
final boolean isEnabledImpl()(Code)(Java Doc)
public boolean isFocusCycleRoot(Container container)(Code)(Java Doc)
public boolean isFocusOwner()(Code)(Java Doc)
public boolean isFocusTraversable()(Code)(Java Doc)
final boolean isFocusTraversableOverridden()(Code)(Java Doc)
public boolean isFocusable()(Code)(Java Doc)
public boolean isFontSet()(Code)(Java Doc)
public boolean isForegroundSet()(Code)(Java Doc)
static boolean isInstanceOf(Object obj, String className)(Code)(Java Doc)
public boolean isLightweight()(Code)(Java Doc)
public boolean isMaximumSizeSet()(Code)(Java Doc)
public boolean isMinimumSizeSet()(Code)(Java Doc)
public boolean isOpaque()(Code)(Java Doc)
public boolean isPreferredSizeSet()(Code)(Java Doc)
boolean isRecursivelyVisible()(Code)(Java Doc)
boolean isSameOrAncestorOf(Component comp, boolean allowChildren)(Code)(Java Doc)
public boolean isShowing()(Code)(Java Doc)
public boolean isValid()(Code)(Java Doc)
public boolean isVisible()(Code)(Java Doc)
final boolean isVisible_NoClientCode()(Code)(Java Doc)
public boolean keyDown(Event evt, int key)(Code)(Java Doc)
public boolean keyUp(Event evt, int key)(Code)(Java Doc)
public void layout()(Code)(Java Doc)
void lightweightPaint(Graphics g)(Code)(Java Doc)
void lightweightPrint(Graphics g)(Code)(Java Doc)
public void list()(Code)(Java Doc)
public void list(PrintStream out)(Code)(Java Doc)
public void list(PrintStream out, int indent)(Code)(Java Doc)
public void list(PrintWriter out)(Code)(Java Doc)
public void list(PrintWriter out, int indent)(Code)(Java Doc)
public Component locate(int x, int y)(Code)(Java Doc)
public Point location()(Code)(Java Doc)
public boolean lostFocus(Event evt, Object what)(Code)(Java Doc)
public Dimension minimumSize()(Code)(Java Doc)
public boolean mouseDown(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseDrag(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseEnter(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseExit(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseMove(Event evt, int x, int y)(Code)(Java Doc)
public boolean mouseUp(Event evt, int x, int y)(Code)(Java Doc)
public void move(int x, int y)(Code)(Java Doc)
public void nextFocus()(Code)(Java Doc)
int numListening(long mask)(Code)(Java Doc)
public void paint(Graphics g)(Code)(Java Doc)
public void paintAll(Graphics g)(Code)(Java Doc)
void paintHeavyweightComponents(Graphics g)(Code)(Java Doc)
protected String paramString()(Code)(Java Doc)
Point pointRelativeToComponent(Point absolute)(Code)(Java Doc)
public boolean postEvent(Event e)(Code)(Java Doc)
static boolean postNextFocusHelper(Component toFocus, CausedFocusEvent.Cause cause)(Code)(Java Doc)
boolean postsOldMouseEvents()(Code)(Java Doc)
final Component preNextFocusHelper()(Code)(Java Doc)
public Dimension preferredSize()(Code)(Java Doc)
public boolean prepareImage(Image image, ImageObserver observer)(Code)(Java Doc)
public boolean prepareImage(Image image, int width, int height, ImageObserver observer)(Code)(Java Doc)
public void print(Graphics g)(Code)(Java Doc)
public void printAll(Graphics g)(Code)(Java Doc)
void printHeavyweightComponents(Graphics g)(Code)(Java Doc)
protected void processComponentEvent(ComponentEvent e)(Code)(Java Doc)
protected void processEvent(AWTEvent e)(Code)(Java Doc)
protected void processFocusEvent(FocusEvent e)(Code)(Java Doc)
protected void processHierarchyBoundsEvent(HierarchyEvent e)(Code)(Java Doc)
protected void processHierarchyEvent(HierarchyEvent e)(Code)(Java Doc)
protected void processInputMethodEvent(InputMethodEvent e)(Code)(Java Doc)
protected void processKeyEvent(KeyEvent e)(Code)(Java Doc)
protected void processMouseEvent(MouseEvent e)(Code)(Java Doc)
protected void processMouseMotionEvent(MouseEvent e)(Code)(Java Doc)
protected void processMouseWheelEvent(MouseWheelEvent e)(Code)(Java Doc)
public void remove(MenuComponent popup)(Code)(Java Doc)
public synchronized void removeComponentListener(ComponentListener l)(Code)(Java Doc)
public synchronized void removeFocusListener(FocusListener l)(Code)(Java Doc)
public void removeHierarchyBoundsListener(HierarchyBoundsListener l)(Code)(Java Doc)
public void removeHierarchyListener(HierarchyListener l)(Code)(Java Doc)
public synchronized void removeInputMethodListener(InputMethodListener l)(Code)(Java Doc)
public synchronized void removeKeyListener(KeyListener l)(Code)(Java Doc)
public synchronized void removeMouseListener(MouseListener l)(Code)(Java Doc)
public synchronized void removeMouseMotionListener(MouseMotionListener l)(Code)(Java Doc)
public synchronized void removeMouseWheelListener(MouseWheelListener l)(Code)(Java Doc)
public void removeNotify()(Code)(Java Doc)
public synchronized void removePropertyChangeListener(PropertyChangeListener listener)(Code)(Java Doc)
public synchronized void removePropertyChangeListener(String propertyName, PropertyChangeListener listener)(Code)(Java Doc)
public void repaint()(Code)(Java Doc)
public void repaint(long tm)(Code)(Java Doc)
public void repaint(int x, int y, int width, int height)(Code)(Java Doc)
public void repaint(long tm, int x, int y, int width, int height)(Code)(Java Doc)
public void requestFocus()(Code)(Java Doc)
void requestFocus(CausedFocusEvent.Cause cause)(Code)(Java Doc)
protected boolean requestFocus(boolean temporary)(Code)(Java Doc)
boolean requestFocus(boolean temporary, CausedFocusEvent.Cause cause)(Code)(Java Doc)
final boolean requestFocusHelper(boolean temporary, boolean focusedWindowChangeAllowed)(Code)(Java Doc)
final boolean requestFocusHelper(boolean temporary, boolean focusedWindowChangeAllowed, CausedFocusEvent.Cause cause)(Code)(Java Doc)
public boolean requestFocusInWindow()(Code)(Java Doc)
boolean requestFocusInWindow(CausedFocusEvent.Cause cause)(Code)(Java Doc)
protected boolean requestFocusInWindow(boolean temporary)(Code)(Java Doc)
boolean requestFocusInWindow(boolean temporary, CausedFocusEvent.Cause cause)(Code)(Java Doc)
void resetGC()(Code)(Java Doc)
public void reshape(int x, int y, int width, int height)(Code)(Java Doc)
public void resize(int width, int height)(Code)(Java Doc)
public void resize(Dimension d)(Code)(Java Doc)
public void setBackground(Color c)(Code)(Java Doc)
public void setBounds(int x, int y, int width, int height)(Code)(Java Doc)
public void setBounds(Rectangle r)(Code)(Java Doc)
void setBoundsOp(int op)(Code)(Java Doc)
public void setComponentOrientation(ComponentOrientation o)(Code)(Java Doc)
public void setCursor(Cursor cursor)(Code)(Java Doc)
public synchronized void setDropTarget(DropTarget dt)(Code)(Java Doc)
public void setEnabled(boolean b)(Code)(Java Doc)
public void setFocusTraversalKeys(int id, Set<? extends AWTKeyStroke> keystrokes)(Code)(Java Doc)
public void setFocusTraversalKeysEnabled(boolean focusTraversalKeysEnabled)(Code)(Java Doc)
final void setFocusTraversalKeys_NoIDCheck(int id, Set<? extends AWTKeyStroke> keystrokes)(Code)(Java Doc)
public void setFocusable(boolean focusable)(Code)(Java Doc)
public void setFont(Font f)(Code)(Java Doc)
public void setForeground(Color c)(Code)(Java Doc)
void setGCFromPeer()(Code)(Java Doc)
public void setIgnoreRepaint(boolean ignoreRepaint)(Code)(Java Doc)
public void setLocale(Locale l)(Code)(Java Doc)
public void setLocation(int x, int y)(Code)(Java Doc)
public void setLocation(Point p)(Code)(Java Doc)
public void setMaximumSize(Dimension maximumSize)(Code)(Java Doc)
public void setMinimumSize(Dimension minimumSize)(Code)(Java Doc)
public void setName(String name)(Code)(Java Doc)
public void setPreferredSize(Dimension preferredSize)(Code)(Java Doc)
static synchronized void setRequestFocusController(RequestFocusController requestController)(Code)(Java Doc)
public void setSize(int width, int height)(Code)(Java Doc)
public void setSize(Dimension d)(Code)(Java Doc)
public void setVisible(boolean b)(Code)(Java Doc)
public void show()(Code)(Java Doc)
public void show(boolean b)(Code)(Java Doc)
public Dimension size()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
public void transferFocus()(Code)(Java Doc)
public void transferFocusBackward()(Code)(Java Doc)
public void transferFocusUpCycle()(Code)(Java Doc)
public void update(Graphics g)(Code)(Java Doc)
final void updateCursorImmediately()(Code)(Java Doc)
public void validate()(Code)(Java Doc)
|
|
|
|