|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjava.awt.Component
java.awt.Container
javax.swing.JComponent
javax.swing.JScrollBar
public class JScrollBar
An implementation of a scrollbar. The user positions the knob in the scrollbar to determine the contents of the viewing area. The program typically adjusts the display so that the end of the scrollbar represents the end of the displayable contents, or 100% of the contents. The start of the scrollbar is the beginning of the displayable contents, or 0%. The position of the knob within those bounds then translates to the corresponding percentage of the displayable contents.
Typically, as the position of the knob in the scrollbar changes a corresponding change is made to the position of the JViewport on the underlying view, changing the contents of the JViewport.
Warning: Swing is not thread safe. For more information see Swing's Threading Policy.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeansTM
has been added to the java.beans package.
Please see XMLEncoder.
JScrollPane| Nested Class Summary | |
|---|---|
protected class |
JScrollBar.AccessibleJScrollBar
This class implements accessibility support for the JScrollBar class. |
| Nested classes/interfaces inherited from class javax.swing.JComponent |
|---|
JComponent.AccessibleJComponent |
| Nested classes/interfaces inherited from class java.awt.Container |
|---|
Container.AccessibleAWTContainer |
| Nested classes/interfaces inherited from class java.awt.Component |
|---|
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy |
| Field Summary | |
|---|---|
protected int |
blockIncrement
|
protected BoundedRangeModel |
model
The model that represents the scrollbar's minimum, maximum, extent (aka "visibleAmount") and current value. |
protected int |
orientation
|
protected int |
unitIncrement
|
| Fields inherited from class javax.swing.JComponent |
|---|
accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW |
| Fields inherited from class java.awt.Component |
|---|
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT |
| Fields inherited from interface java.awt.Adjustable |
|---|
HORIZONTAL, NO_ORIENTATION, VERTICAL |
| Fields inherited from interface java.awt.image.ImageObserver |
|---|
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH |
| Constructor Summary | |
|---|---|
JScrollBar()
Creates a vertical scrollbar with the following initial values: |
|
JScrollBar(int orientation)
Creates a scrollbar with the specified orientation and the following initial values: |
|
JScrollBar(int orientation,
int value,
int extent,
int min,
int max)
Creates a scrollbar with the specified orientation, value, extent, minimum, and maximum. |
|
| Method Summary | |
|---|---|
void |
addAdjustmentListener(AdjustmentListener l)
Adds an AdjustmentListener. |
protected void |
fireAdjustmentValueChanged(int id,
int type,
int value)
Notify listeners that the scrollbar's model has changed. |
AccessibleContext |
getAccessibleContext()
Gets the AccessibleContext associated with this JScrollBar. |
AdjustmentListener[] |
getAdjustmentListeners()
Returns an array of all the AdjustmentListeners added
to this JScrollBar with addAdjustmentListener(). |
int |
getBlockIncrement()
For backwards compatibility with java.awt.Scrollbar. |
int |
getBlockIncrement(int direction)
Returns the amount to change the scrollbar's value by, given a block (usually "page") up/down request. |
int |
getMaximum()
The maximum value of the scrollbar is maximum - extent. |
Dimension |
getMaximumSize()
The scrollbar is flexible along it's scrolling axis and rigid along the other axis. |
int |
getMinimum()
Returns the minimum value supported by the scrollbar (usually zero). |
Dimension |
getMinimumSize()
The scrollbar is flexible along it's scrolling axis and rigid along the other axis. |
BoundedRangeModel |
getModel()
Returns data model that handles the scrollbar's four fundamental properties: minimum, maximum, value, extent. |
int |
getOrientation()
Returns the component's orientation (horizontal or vertical). |
ScrollBarUI |
getUI()
Returns the delegate that implements the look and feel for this component. |
String |
getUIClassID()
Returns the name of the LookAndFeel class for this component. |
int |
getUnitIncrement()
For backwards compatibility with java.awt.Scrollbar. |
int |
getUnitIncrement(int direction)
Returns the amount to change the scrollbar's value by, given a unit up/down request. |
int |
getValue()
Returns the scrollbar's value. |
boolean |
getValueIsAdjusting()
True if the scrollbar knob is being dragged. |
int |
getVisibleAmount()
Returns the scrollbar's extent, aka its "visibleAmount". |
protected String |
paramString()
Returns a string representation of this JScrollBar. |
void |
removeAdjustmentListener(AdjustmentListener l)
Removes an AdjustmentEvent listener. |
void |
setBlockIncrement(int blockIncrement)
Sets the blockIncrement property. |
void |
setEnabled(boolean x)
Enables the component so that the knob position can be changed. |
void |
setMaximum(int maximum)
Sets the model's maximum property. |
void |
setMinimum(int minimum)
Sets the model's minimum property. |
void |
setModel(BoundedRangeModel newModel)
Sets the model that handles the scrollbar's four fundamental properties: minimum, maximum, value, extent. |
void |
setOrientation(int orientation)
Set the scrollbar's orientation to either VERTICAL or HORIZONTAL. |
void |
setUI(ScrollBarUI ui)
Sets the L&F object that renders this component. |
void |
setUnitIncrement(int unitIncrement)
Sets the unitIncrement property. |
void |
setValue(int value)
Sets the scrollbar's value. |
void |
setValueIsAdjusting(boolean b)
Sets the model's valueIsAdjusting property. |
void |
setValues(int newValue,
int newExtent,
int newMin,
int newMax)
Sets the four BoundedRangeModel properties after forcing the arguments to obey the usual constraints: |
void |
setVisibleAmount(int extent)
Set the model's extent property. |
void |
updateUI()
Overrides JComponent.updateUI. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
protected BoundedRangeModel model
setModel(javax.swing.BoundedRangeModel)protected int orientation
setOrientation(int)protected int unitIncrement
setUnitIncrement(int)protected int blockIncrement
setBlockIncrement(int)| Constructor Detail |
|---|
public JScrollBar(int orientation,
int value,
int extent,
int min,
int max)
Note: Use setBlockIncrement to set the block
increment to a size slightly smaller than the view's extent.
That way, when the user jumps the knob to an adjacent position,
one or two lines of the original contents remain in view.
IllegalArgumentException - if orientation is not one of VERTICAL, HORIZONTALsetOrientation(int),
setValue(int),
setVisibleAmount(int),
setMinimum(int),
setMaximum(int)public JScrollBar(int orientation)
minimum = 0 maximum = 100 value = 0 extent = 10
public JScrollBar()
minimum = 0 maximum = 100 value = 0 extent = 10
| Method Detail |
|---|
public void setUI(ScrollBarUI ui)
ui - the ScrollBarUI L&F objectUIDefaults.getUI(javax.swing.JComponent)public ScrollBarUI getUI()
JComponent.setUI(javax.swing.plaf.ComponentUI)public void updateUI()
JComponent.updateUI.
updateUI in class JComponentJComponent.updateUI()public String getUIClassID()
getUIClassID in class JComponentJComponent.getUIClassID(),
UIDefaults.getUI(javax.swing.JComponent)public int getOrientation()
getOrientation in interface AdjustablesetOrientation(int),
Adjustable.getOrientation()public void setOrientation(int orientation)
IllegalArgumentException - if orientation is not one of VERTICAL, HORIZONTALgetOrientation()public BoundedRangeModel getModel()
setModel(javax.swing.BoundedRangeModel)public void setModel(BoundedRangeModel newModel)
getModel()public int getUnitIncrement(int direction)
The JScrollPane component creates scrollbars (by default) that override this method and delegate to the viewports Scrollable view, if it has one. The Scrollable interface provides a more specialized version of this method.
direction - is -1 or 1 for up/down respectively
setUnitIncrement(int),
setValue(int),
Scrollable.getScrollableUnitIncrement(java.awt.Rectangle, int, int)public void setUnitIncrement(int unitIncrement)
Note, that if the argument is equal to the value of Integer.MIN_VALUE, the most look and feels will not provide the scrolling to the right/down.
setUnitIncrement in interface AdjustableunitIncrement - the unit incrementgetUnitIncrement(int)public int getBlockIncrement(int direction)
The JScrollPane component creates scrollbars (by default) that override this method and delegate to the viewports Scrollable view, if it has one. The Scrollable interface provides a more specialized version of this method.
direction - is -1 or 1 for up/down respectively
setBlockIncrement(int),
setValue(int),
Scrollable.getScrollableBlockIncrement(java.awt.Rectangle, int, int)public void setBlockIncrement(int blockIncrement)
Note, that if the argument is equal to the value of Integer.MIN_VALUE, the most look and feels will not provide the scrolling to the right/down.
setBlockIncrement in interface AdjustableblockIncrement - the block incrementgetBlockIncrement()public int getUnitIncrement()
getUnitIncrement in interface AdjustableAdjustable.getUnitIncrement(),
getUnitIncrement(int)public int getBlockIncrement()
getBlockIncrement in interface AdjustableAdjustable.getBlockIncrement(),
getBlockIncrement(int)public int getValue()
getValue in interface AdjustablesetValue(int)public void setValue(int value)
setValue in interface Adjustablevalue - the current value, between minimum
and maximum - visibleAmountgetValue(),
BoundedRangeModel.setValue(int)public int getVisibleAmount()
getVisibleAmount in interface AdjustablesetVisibleAmount(int)public void setVisibleAmount(int extent)
setVisibleAmount in interface Adjustableextent - the length of the indicatorgetVisibleAmount(),
BoundedRangeModel.setExtent(int)public int getMinimum()
getMinimum in interface AdjustablesetMinimum(int)public void setMinimum(int minimum)
setMinimum in interface Adjustableminimum - the minimum valuegetMinimum(),
BoundedRangeModel.setMinimum(int)public int getMaximum()
getMaximum in interface AdjustablesetMaximum(int)public void setMaximum(int maximum)
setMaximum in interface Adjustablemaximum - the maximum valuegetMaximum(),
BoundedRangeModel.setMaximum(int)public boolean getValueIsAdjusting()
setValueIsAdjusting(boolean)public void setValueIsAdjusting(boolean b)
getValueIsAdjusting(),
BoundedRangeModel.setValueIsAdjusting(boolean)
public void setValues(int newValue,
int newExtent,
int newMin,
int newMax)
minimum <= value <= value+extent <= maximum
BoundedRangeModel.setRangeProperties(int, int, int, int, boolean),
setValue(int),
setVisibleAmount(int),
setMinimum(int),
setMaximum(int)public void addAdjustmentListener(AdjustmentListener l)
Note that the AdjustmentEvents type property will always have a placeholder value of AdjustmentEvent.TRACK because all changes to a BoundedRangeModels value are considered equivalent. To change the value of a BoundedRangeModel one just sets its value property, i.e. model.setValue(123). No information about the origin of the change, e.g. it's a block decrement, is provided. We don't try fabricate the origin of the change here.
addAdjustmentListener in interface Adjustablel - the AdjustmentLister to addremoveAdjustmentListener(java.awt.event.AdjustmentListener),
BoundedRangeModel.addChangeListener(javax.swing.event.ChangeListener)public void removeAdjustmentListener(AdjustmentListener l)
removeAdjustmentListener in interface Adjustablel - the AdjustmentLister to removeaddAdjustmentListener(java.awt.event.AdjustmentListener)public AdjustmentListener[] getAdjustmentListeners()
AdjustmentListeners added
to this JScrollBar with addAdjustmentListener().
AdjustmentListeners added or an empty
array if no listeners have been added
protected void fireAdjustmentValueChanged(int id,
int type,
int value)
addAdjustmentListener(java.awt.event.AdjustmentListener),
EventListenerListpublic Dimension getMinimumSize()
getMinimumSize in class JComponentminimumSize propertyJComponent.setMinimumSize(java.awt.Dimension),
ComponentUIpublic Dimension getMaximumSize()
getMaximumSize in class JComponentmaximumSize propertyJComponent.setMaximumSize(java.awt.Dimension),
ComponentUIpublic void setEnabled(boolean x)
setEnabled in class JComponentx - a boolean value, where true enables the component and
false disables itComponent.isEnabled(),
Component.isLightweight()protected String paramString()
null.
paramString in class JComponentpublic AccessibleContext getAccessibleContext()
getAccessibleContext in interface AccessiblegetAccessibleContext in class JComponent
|
Java™ Platform Standard Ed. 6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Copyright © 1993, 2010, Oracle and/or its affiliates. All rights reserved.