|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--java.awt.Component | +--java.awt.Container | +--javax.swing.JComponent | +--javax.swing.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 postion 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: 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. A future release of Swing will provide support for long term persistence.
JScrollPane
, Serialized FormInner Class Summary | |
protected class |
JScrollBar.AccessibleJScrollBar
The class used to obtain the accessible role for this object. |
Inner classes inherited from class javax.swing.JComponent |
JComponent.AccessibleJComponent |
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,
VERTICAL |
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, mimimum, and maximum. |
Method Summary | |
void |
addAdjustmentListener(AdjustmentListener l)
Adds an AdjustmentListener. |
protected void |
fireAdjustmentValueChanged(int id,
int type,
int value)
|
AccessibleContext |
getAccessibleContext()
Get the AccessibleContext associated with this JComponent |
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 |
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.awt.Container |
add,
add,
add,
add,
add,
addContainerListener,
addImpl,
countComponents,
deliverEvent,
doLayout,
findComponentAt,
findComponentAt,
getComponent,
getComponentAt,
getComponentAt,
getComponentCount,
getComponents,
getLayout,
insets,
invalidate,
isAncestorOf,
layout,
list,
list,
locate,
minimumSize,
paintComponents,
preferredSize,
print,
printComponents,
processContainerEvent,
processEvent,
remove,
remove,
removeAll,
removeContainerListener,
setCursor,
setLayout,
validate,
validateTree |
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.
setOrientation(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 ScrollBarUI getUI()
public void updateUI()
JComponent.updateUI
.JComponent.updateUI()
public String getUIClassID()
JComponent.getUIClassID()
,
UIDefaults.getUI(javax.swing.JComponent)
public int getOrientation()
setOrientation(int)
,
Adjustable.getOrientation()
public void setOrientation(int orientation)
getOrientation()
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 respectivelysetUnitIncrement(int)
,
setValue(int)
,
Scrollable.getScrollableUnitIncrement(java.awt.Rectangle, int, int)
public void setUnitIncrement(int unitIncrement)
getUnitIncrement(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 respectivelysetBlockIncrement(int)
,
setValue(int)
,
Scrollable.getScrollableBlockIncrement(java.awt.Rectangle, int, int)
public void setBlockIncrement(int blockIncrement)
getBlockIncrement()
public int getUnitIncrement()
public int getBlockIncrement()
public int getValue()
setValue(int)
public void setValue(int value)
getValue()
,
BoundedRangeModel.setValue(int)
public int getVisibleAmount()
setVisibleAmount(int)
public void setVisibleAmount(int extent)
public int getMinimum()
setMinimum(int)
public void setMinimum(int minimum)
getMinimum()
,
BoundedRangeModel.setMinimum(int)
public int getMaximum()
setMaximum(int)
public void setMaximum(int maximum)
getMaximum()
,
BoundedRangeModel.setMaximum(int)
public boolean getValueIsAdjusting()
setValueIsAdjusting(boolean)
public void setValueIsAdjusting(boolean b)
public void setValues(int newValue, int newExtent, int newMin, int newMax)
minimum <= value <= value+extent <= maximum
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.
l
- the AdjustmentLister to addremoveAdjustmentListener(java.awt.event.AdjustmentListener)
,
BoundedRangeModel.addChangeListener(javax.swing.event.ChangeListener)
public void removeAdjustmentListener(AdjustmentListener l)
l
- the AdjustmentLister to removeaddAdjustmentListener(java.awt.event.AdjustmentListener)
protected void fireAdjustmentValueChanged(int id, int type, int value)
public Dimension getMinimumSize()
JComponent.setMinimumSize(java.awt.Dimension)
public Dimension getMaximumSize()
JComponent.setMaximumSize(java.awt.Dimension)
public void setEnabled(boolean x)
b
- a boolean value, where true enables the component and
false disables itprotected String paramString()
null
.public AccessibleContext getAccessibleContext()
|
JavaTM 2 Platform Standard Edition |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |