Modifier and Type	Class and Description
protected class	JScrollBar.AccessibleJScrollBar This class implements accessibility support for the `JScrollBar` class.
private class	JScrollBar.ModelListener This class listens to ChangeEvents on the model and forwards AdjustmentEvents for the sake of backwards compatibility.

Modifier and Type	Field and Description
protected int	blockIncrement Stores the amount by which the value of the scrollbar is changed upon a block (usually "page") up/down request.
private ChangeListener	fwdAdjustmentEvents All changes from the model are treated as though the user moved the scrollbar knob.
protected BoundedRangeModel	model The model that represents the scrollbar's minimum, maximum, extent (aka "visibleAmount") and current value.
protected int	orientation Orientation of this scrollBar.
private static final String	uiClassID Hides javax.swing.JComponent.uiClassID.
protected int	unitIncrement Stores the amount by which the value of the scrollbar is changed upon a unit up/down request.

Access	Constructor and Description
public	JScrollBar(int an orientation of the `JScrollBar` orientation, int an int giving the current value value, int an int giving the amount by which the value can "jump" extent, int an int giving the minimum value min, int an int giving the maximum value max) Creates a scrollbar with the specified orientation, value, extent, minimum, and maximum.
public	JScrollBar(int an orientation of the `JScrollBar` orientation) Creates a scrollbar with the specified orientation and the following initial values: minimum = 0 maximum = 100 value = 0 extent = 10
public	JScrollBar() Creates a vertical scrollbar with the following initial values: minimum = 0 maximum = 100 value = 0 extent = 10

Method Summary

Modifier and Type	Method and Description
public void	addAdjustmentListener(AdjustmentListener the AdjustmentLister to add l) Implements java.awt.Adjustable.addAdjustmentListener. Adds an AdjustmentListener.
private void	checkOrientation(int orientation)
protected void	fireAdjustmentValueChanged(int an integer indicating the type of event. id, int an integer indicating the adjustment type. type, int the current value of the adjustment value) Notify listeners that the scrollbar's model has changed.
private void	fireAdjustmentValueChanged(int id, int type, int value, boolean isAdjusting) Notify listeners that the scrollbar's model has changed.
public AccessibleContext	Returns: an AccessibleJScrollBar that serves as the AccessibleContext of this JScrollBar getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the AccessibleContext associated with this JScrollBar.
public AdjustmentListener[]	Returns: all of the `AdjustmentListener`s added or an empty array if no listeners have been added getAdjustmentListeners() Returns an array of all the `AdjustmentListener`s added to this JScrollBar with addAdjustmentListener().
public int	Returns: the value of the blockIncrement property getBlockIncrement(int is -1 or 1 for up/down respectively direction) Returns the amount to change the scrollbar's value by, given a block (usually "page") up/down request.
public int	getBlockIncrement() Implements java.awt.Adjustable.getBlockIncrement. For backwards compatibility with java.awt.Scrollbar.
public int	Returns: the value of the model's maximum property getMaximum() Implements java.awt.Adjustable.getMaximum. The maximum value of the scrollbar is maximum - extent.
public Dimension	Returns: the maximum size as specified above getMaximumSize() Overrides javax.swing.JComponent.getMaximumSize. Returns the maximum size for the `JScrollBar`.
public int	Returns: the value of the model's minimum property getMinimum() Implements java.awt.Adjustable.getMinimum. Returns the minimum value supported by the scrollbar (usually zero).
public Dimension	Returns: the minimum size as specified above getMinimumSize() Overrides javax.swing.JComponent.getMinimumSize. Returns the minimum size for the `JScrollBar`.
public BoundedRangeModel	Returns: the data model getModel() Returns data model that handles the scrollbar's four fundamental properties: minimum, maximum, value, extent.
public int	Returns: VERTICAL or HORIZONTAL getOrientation() Implements java.awt.Adjustable.getOrientation. Returns the component's orientation (horizontal or vertical).
public ScrollBarUI	Returns: the scroll bar's current UI. getUI() Overrides javax.swing.JComponent.getUI. Returns the delegate that implements the look and feel for this component.
public String	Returns: the string "ScrollBarUI" getUIClassID() Overrides javax.swing.JComponent.getUIClassID. Returns the name of the LookAndFeel class for this component.
public int	Returns: the value of the unitIncrement property getUnitIncrement(int is -1 or 1 for up/down respectively direction) Returns the amount to change the scrollbar's value by, given a unit up/down request.
public int	getUnitIncrement() Implements java.awt.Adjustable.getUnitIncrement. For backwards compatibility with java.awt.Scrollbar.
public int	Returns: the model's value property getValue() Implements java.awt.Adjustable.getValue. Returns the scrollbar's value.
public boolean	Returns: the value of the model's valueIsAdjusting property getValueIsAdjusting() True if the scrollbar knob is being dragged.
public int	Returns: the value of the model's extent property getVisibleAmount() Implements java.awt.Adjustable.getVisibleAmount. Returns the scrollbar's extent, aka its "visibleAmount".
protected String	Returns: a string representation of this JScrollBar. paramString() Overrides javax.swing.JComponent.paramString. Returns a string representation of this JScrollBar.
public void	removeAdjustmentListener(AdjustmentListener the AdjustmentLister to remove l) Implements java.awt.Adjustable.removeAdjustmentListener. Removes an AdjustmentEvent listener.
public void	setBlockIncrement(int blockIncrement) Implements java.awt.Adjustable.setBlockIncrement. Sets the blockIncrement property.
public void	setEnabled(boolean a boolean value, where true enables the component and false disables it x) Overrides javax.swing.JComponent.setEnabled. Enables the component so that the knob position can be changed.
public void	setMaximum(int maximum) Implements java.awt.Adjustable.setMaximum. Sets the model's maximum property.
public void	setMaximumSize(Dimension the desired maximum allowable size maximumSize) Overrides javax.swing.JComponent.setMaximumSize. Unlike most components, `JScrollBar` derives the maximum size from the preferred size in one axis and a fixed maximum size in the other.
public void	setMinimum(int minimum) Implements java.awt.Adjustable.setMinimum. Sets the model's minimum property.
public void	setMinimumSize(Dimension the new minimum size of this component minimumSize) Overrides javax.swing.JComponent.setMinimumSize. Unlike most components, `JScrollBar` derives the minimum size from the preferred size in one axis and a fixed minimum size in the other.
public void	setModel(BoundedRangeModel a new model newModel) Sets the model that handles the scrollbar's four fundamental properties: minimum, maximum, value, extent.
public void	setOrientation(int an orientation of the `JScrollBar` orientation) Set the scrollbar's orientation to either VERTICAL or HORIZONTAL.
public void	setUI(ScrollBarUI the `ScrollBarUI` L&F object ui) Sets the L&F; object that renders this component.
public void	setUnitIncrement(int unitIncrement) Implements java.awt.Adjustable.setUnitIncrement. Sets the unitIncrement property.
public void	setValue(int value) Implements java.awt.Adjustable.setValue. Sets the scrollbar's value.
public void	setValueIsAdjusting(boolean `true` if the upcoming changes to the value property are part of a series b) Sets the model's valueIsAdjusting property.
public void	setValues(int an int giving the current value newValue, int an int giving the amount by which the value can "jump" newExtent, int an int giving the minimum value newMin, int an int giving the maximum value newMax) Sets the four BoundedRangeModel properties after forcing the arguments to obey the usual constraints: minimum ≤ value ≤ value+extent ≤ maximum
public void	setVisibleAmount(int extent) Implements java.awt.Adjustable.setVisibleAmount. Set the model's extent property.
public void	updateUI() Overrides javax.swing.JComponent.updateUI. Overrides `JComponent.updateUI`.
private void	writeObject(ObjectOutputStream s) Hides javax.swing.JComponent.writeObject. See readObject() and writeObject() in JComponent for more information about serialization in Swing.

Inherited from javax.swing.JComponent:: _paintImmediately addAncestorListener addNotify addVetoableChangeListener alwaysOnTop checkIfChildObscuredBySibling clientPropertyChanged componentInputMapChanged computeVisibleRect computeVisibleRect compWriteObjectNotify contains createToolTip disable dndDone dropLocationForPoint enable firePropertyChange firePropertyChange firePropertyChange fireVetoableChange getActionForKeyStroke getActionMap getActionMap getAlignmentX getAlignmentY getAncestorListeners getAutoscrolls getBaseline getBaselineResizeBehavior getBorder getBounds getClientProperty getComponentGraphics getComponentPopupMenu getConditionForKeyStroke getCreatedDoubleBuffer getDebugGraphicsOptions getDefaultLocale getFontMetrics getGraphics getGraphicsInvoked getHeight getInheritsPopupMenu getInputMap getInputMap getInputMap getInputVerifier getInsets getInsets getListeners getLocation getManagingFocusBackwardTraversalKeys getManagingFocusForwardTraversalKeys getNextFocusableComponent getPopupLocation getPreferredSize getRegisteredKeyStrokes getRootPane getSize getToolTipLocation getToolTipText getToolTipText getTopLevelAncestor getTransferHandler getVerifyInputWhenFocusTarget getVetoableChangeListeners getVisibleRect getWidth getWriteObjCounter getX getY grabFocus hide isDoubleBuffered isLightweightComponent isManagingFocus isOpaque isOptimizedDrawingEnabled isPainting isPaintingForPrint isPaintingOrigin isPaintingTile isRequestFocusEnabled isValidateRoot paint paintBorder paintChildren paintComponent paintForceDoubleBuffered paintImmediately paintImmediately paintToOffscreen print printAll printBorder printChildren printComponent processComponentKeyEvent processKeyBinding processKeyBindings processKeyBindingsForAllComponents processKeyEvent processMouseEvent processMouseMotionEvent putClientProperty rectangleIsObscured registerKeyboardAction registerKeyboardAction removeAncestorListener removeNotify removeVetoableChangeListener repaint repaint requestDefaultFocus requestFocus requestFocus requestFocusInWindow requestFocusInWindow resetKeyboardActions reshape revalidate safelyGetGraphics safelyGetGraphics scrollRectToVisible setActionMap setAlignmentX setAlignmentY setAutoscrolls setBackground setBorder setComponentPopupMenu setCreatedDoubleBuffer setDebugGraphicsOptions setDefaultLocale setDoubleBuffered setDropLocation setFocusTraversalKeys setFont setForeground setInheritsPopupMenu setInputMap setInputVerifier setNextFocusableComponent setOpaque setPaintingChild setPreferredSize setRequestFocusEnabled setToolTipText setTransferHandler setUI setUIProperty setVerifyInputWhenFocusTarget setVisible setWriteObjCounter shouldDebugGraphics superProcessMouseMotionEvent unregisterKeyboardAction update

Field Detail

blockIncrement back to summary

blockIncrement	back to summary
protected int blockIncrement Stores the amount by which the value of the scrollbar is changed upon a block (usually "page") up/down request. See Also `setBlockIncrement`

protected int blockIncrement

Stores the amount by which the value of the scrollbar is changed upon a block (usually "page") up/down request.

See Also: setBlockIncrement

fwdAdjustmentEvents	back to summary
private ChangeListener fwdAdjustmentEvents All changes from the model are treated as though the user moved the scrollbar knob.

model back to summary

model	back to summary
protected BoundedRangeModel model The model that represents the scrollbar's minimum, maximum, extent (aka "visibleAmount") and current value. See Also `setModel`

protected BoundedRangeModel model

The model that represents the scrollbar's minimum, maximum, extent (aka "visibleAmount") and current value.

See Also: setModel

orientation back to summary

orientation	back to summary
protected int orientation Orientation of this scrollBar. See Also `setOrientation`

protected int orientation

Orientation of this scrollBar.

See Also: setOrientation

uiClassID back to summary

uiClassID	back to summary
private static final String uiClassID Hides javax.swing.JComponent.uiClassID. See Also `getUIClassID`, `readObject`

private static final String uiClassID

Hides javax.swing.JComponent.uiClassID.

See Also: getUIClassID, readObject

unitIncrement back to summary

unitIncrement	back to summary
protected int unitIncrement Stores the amount by which the value of the scrollbar is changed upon a unit up/down request. See Also `setUnitIncrement`

protected int unitIncrement

Stores the amount by which the value of the scrollbar is changed upon a unit up/down request.

See Also: setUnitIncrement

Constructor Detail

JScrollBar back to summary

JScrollBar	back to summary
public JScrollBar(int orientation, int value, int extent, int min, int max) Creates a scrollbar with the specified orientation, value, extent, minimum, and maximum. The "extent" is the size of the viewable area. It is also known as the "visible amount". 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. Parameters orientation:int an orientation of the `JScrollBar` value:int an int giving the current value extent:int an int giving the amount by which the value can "jump" min:int an int giving the minimum value max:int an int giving the maximum value Exceptions IllegalArgumentException: if orientation is not one of VERTICAL, HORIZONTAL See Also `setOrientation`, `setValue`, `setVisibleAmount`, `setMinimum`, `setMaximum`

public JScrollBar(int orientation, int value, int extent, int min, int max)

Creates a scrollbar with the specified orientation, value, extent, minimum, and maximum. The "extent" is the size of the viewable area. It is also known as the "visible amount".

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.

Parameters

orientation:int: an orientation of the JScrollBar
value:int: an int giving the current value
extent:int: an int giving the amount by which the value can "jump"
min:int: an int giving the minimum value
max:int: an int giving the maximum value

Exceptions

IllegalArgumentException:: if orientation is not one of VERTICAL, HORIZONTAL

JScrollBar back to summary

JScrollBar	back to summary
public JScrollBar(int orientation) Creates a scrollbar with the specified orientation and the following initial values: minimum = 0 maximum = 100 value = 0 extent = 10 Parameters orientation:int an orientation of the `JScrollBar`

public JScrollBar(int orientation)

Creates a scrollbar with the specified orientation and the following initial values:

minimum = 0
maximum = 100
value = 0
extent = 10

Parameters

orientation:int: an orientation of the JScrollBar

JScrollBar	back to summary
public JScrollBar() Creates a vertical scrollbar with the following initial values: minimum = 0 maximum = 100 value = 0 extent = 10

JScrollBar

back to summary

public JScrollBar()

Creates a vertical scrollbar with the following initial values:

minimum = 0
maximum = 100
value = 0
extent = 10

Method Detail

addAdjustmentListener back to summary

addAdjustmentListener	back to summary
public void addAdjustmentListener(AdjustmentListener l) Implements java.awt.Adjustable.addAdjustmentListener. Adds an AdjustmentListener. Adjustment listeners are notified each time the scrollbar's model changes. Adjustment events are provided for backwards compatibility with java.awt.Scrollbar. 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 to fabricate the origin of the change here. Parameters l:AdjustmentListener the AdjustmentLister to add See Also `removeAdjustmentListener`, `BoundedRangeModel#addChangeListener`

public void addAdjustmentListener(AdjustmentListener l)

Implements java.awt.Adjustable.addAdjustmentListener.

Adds an AdjustmentListener. Adjustment listeners are notified each time the scrollbar's model changes. Adjustment events are provided for backwards compatibility with java.awt.Scrollbar.

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 to fabricate the origin of the change here.

Parameters

l:AdjustmentListener: the AdjustmentLister to add

checkOrientation	back to summary
private void checkOrientation(int orientation)

fireAdjustmentValueChanged back to summary

fireAdjustmentValueChanged	back to summary
protected void fireAdjustmentValueChanged(int id, int type, int value) Notify listeners that the scrollbar's model has changed. Parameters id:int an integer indicating the type of event. type:int an integer indicating the adjustment type. value:int the current value of the adjustment See Also `addAdjustmentListener`, `EventListenerList`

protected void fireAdjustmentValueChanged(int id, int type, int value)

Notify listeners that the scrollbar's model has changed.

Parameters

id:int: an integer indicating the type of event.
type:int: an integer indicating the adjustment type.
value:int: the current value of the adjustment

fireAdjustmentValueChanged back to summary

fireAdjustmentValueChanged	back to summary
private void fireAdjustmentValueChanged(int id, int type, int value, boolean isAdjusting) Notify listeners that the scrollbar's model has changed. See Also `addAdjustmentListener`, `EventListenerList`

private void fireAdjustmentValueChanged(int id, int type, int value, boolean isAdjusting)

Notify listeners that the scrollbar's model has changed.

See Also: addAdjustmentListener, EventListenerList

getAccessibleContext	back to summary
public AccessibleContext getAccessibleContext() Overrides java.awt.Component.getAccessibleContext. Implements javax.accessibility.Accessible.getAccessibleContext. Gets the AccessibleContext associated with this JScrollBar. For JScrollBar, the AccessibleContext takes the form of an AccessibleJScrollBar. A new AccessibleJScrollBar instance is created if necessary. Returns:AccessibleContext an AccessibleJScrollBar that serves as the AccessibleContext of this JScrollBar Annotations @BeanProperty bound:false

getAccessibleContext

back to summary

public AccessibleContext getAccessibleContext()

Overrides java.awt.Component.getAccessibleContext.

Implements javax.accessibility.Accessible.getAccessibleContext.

Gets the AccessibleContext associated with this JScrollBar. For JScrollBar, the AccessibleContext takes the form of an AccessibleJScrollBar. A new AccessibleJScrollBar instance is created if necessary.

Returns:AccessibleContext

an AccessibleJScrollBar that serves as the AccessibleContext of this JScrollBar

Annotations

@BeanProperty
bound:false

getAdjustmentListeners back to summary

getAdjustmentListeners	back to summary
public AdjustmentListener[] getAdjustmentListeners() Returns an array of all the `AdjustmentListener`s added to this JScrollBar with addAdjustmentListener(). Returns:AdjustmentListener[] all of the `AdjustmentListener`s added or an empty array if no listeners have been added Annotations @BeanProperty bound:false Since 1.4

public AdjustmentListener[] getAdjustmentListeners()

Returns an array of all the AdjustmentListeners added to this JScrollBar with addAdjustmentListener().

Returns:AdjustmentListener[]

all of the AdjustmentListeners added or an empty array if no listeners have been added

Annotations

@BeanProperty
bound:false

Since

1.4

getBlockIncrement back to summary

getBlockIncrement	back to summary
public int getBlockIncrement(int direction) Returns the amount to change the scrollbar's value by, given a block (usually "page") up/down request. A ScrollBarUI implementation typically calls this method when the user clicks outside the scrollbar "knob" to scroll up or down by a large amount. Subclasses may override this method to compute a value, e.g. the change required to scroll one paragraph in a text document. 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. Some look and feel implementations that provide custom scrolling behavior ignore this property. Parameters direction:int is -1 or 1 for up/down respectively Returns:int the value of the blockIncrement property See Also `setBlockIncrement`, `setValue`, `Scrollable#getScrollableBlockIncrement`

public int getBlockIncrement(int direction)

Returns the amount to change the scrollbar's value by, given a block (usually "page") up/down request. A ScrollBarUI implementation typically calls this method when the user clicks outside the scrollbar "knob" to scroll up or down by a large amount. Subclasses may override this method to compute a value, e.g. the change required to scroll one paragraph in a text document.

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.

Some look and feel implementations that provide custom scrolling behavior ignore this property.

Parameters

direction:int: is -1 or 1 for up/down respectively

Returns:int

the value of the blockIncrement property

getBlockIncrement back to summary

getBlockIncrement	back to summary
public int getBlockIncrement() Implements java.awt.Adjustable.getBlockIncrement. For backwards compatibility with java.awt.Scrollbar. See Also `Adjustable#getBlockIncrement`, `getBlockIncrement(int)`

public int getBlockIncrement()

Implements java.awt.Adjustable.getBlockIncrement.

For backwards compatibility with java.awt.Scrollbar.

See Also: Adjustable#getBlockIncrement, getBlockIncrement(int)

getMaximum back to summary

getMaximum	back to summary
public int getMaximum() Implements java.awt.Adjustable.getMaximum. The maximum value of the scrollbar is maximum - extent. Returns:int the value of the model's maximum property See Also `setMaximum`

public int getMaximum()

Implements java.awt.Adjustable.getMaximum.

The maximum value of the scrollbar is maximum - extent.

Returns:int: the value of the model's maximum property
See Also: setMaximum

getMaximumSize back to summary

getMaximumSize	back to summary
public Dimension getMaximumSize() Overrides javax.swing.JComponent.getMaximumSize. Returns the maximum size for the `JScrollBar`. The scrollbar is flexible along its scrolling axis and rigid along the other axis. As specified in `setMaximumSize` JScrollBar will derive the maximum size from the preferred size in one axis and a fixed maximum size in the other. Returns:Dimension the maximum size as specified above

public Dimension getMaximumSize()

Overrides javax.swing.JComponent.getMaximumSize.

Returns the maximum size for the JScrollBar. The scrollbar is flexible along its scrolling axis and rigid along the other axis. As specified in setMaximumSize JScrollBar will derive the maximum size from the preferred size in one axis and a fixed maximum size in the other.

Returns:Dimension: the maximum size as specified above

getMinimum back to summary

getMinimum	back to summary
public int getMinimum() Implements java.awt.Adjustable.getMinimum. Returns the minimum value supported by the scrollbar (usually zero). Returns:int the value of the model's minimum property See Also `setMinimum`

public int getMinimum()

Implements java.awt.Adjustable.getMinimum.

Returns the minimum value supported by the scrollbar (usually zero).

Returns:int: the value of the model's minimum property
See Also: setMinimum

getMinimumSize back to summary

getMinimumSize	back to summary
public Dimension getMinimumSize() Overrides javax.swing.JComponent.getMinimumSize. Returns the minimum size for the `JScrollBar`. The scrollbar is flexible along its scrolling axis and rigid along the other axis. As specified in `setMinimumSize` JScrollBar will derive the minimum size from the preferred size in one axis and a fixed minimum size in the other. Returns:Dimension the minimum size as specified above

public Dimension getMinimumSize()

Overrides javax.swing.JComponent.getMinimumSize.

Returns the minimum size for the JScrollBar. The scrollbar is flexible along its scrolling axis and rigid along the other axis. As specified in setMinimumSize JScrollBar will derive the minimum size from the preferred size in one axis and a fixed minimum size in the other.

Returns:Dimension: the minimum size as specified above

getModel back to summary

getModel	back to summary
public BoundedRangeModel getModel() Returns data model that handles the scrollbar's four fundamental properties: minimum, maximum, value, extent. Returns:BoundedRangeModel the data model See Also `setModel`

public BoundedRangeModel getModel()

Returns data model that handles the scrollbar's four fundamental properties: minimum, maximum, value, extent.

Returns:BoundedRangeModel: the data model
See Also: setModel

getOrientation back to summary

getOrientation	back to summary
public int getOrientation() Implements java.awt.Adjustable.getOrientation. Returns the component's orientation (horizontal or vertical). Returns:int VERTICAL or HORIZONTAL See Also `setOrientation`, `java.awt.Adjustable#getOrientation`

public int getOrientation()

Implements java.awt.Adjustable.getOrientation.

Returns the component's orientation (horizontal or vertical).

Returns:int: VERTICAL or HORIZONTAL
See Also: setOrientation, java.awt.Adjustable#getOrientation

getUI back to summary

getUI	back to summary
public ScrollBarUI getUI() Overrides javax.swing.JComponent.getUI. Returns the delegate that implements the look and feel for this component. Returns:ScrollBarUI the scroll bar's current UI. See Also `JComponent#setUI`

public ScrollBarUI getUI()

Overrides javax.swing.JComponent.getUI.

Returns the delegate that implements the look and feel for this component.

Returns:ScrollBarUI: the scroll bar's current UI.
See Also: JComponent#setUI

getUIClassID back to summary

getUIClassID	back to summary
public String getUIClassID() Overrides javax.swing.JComponent.getUIClassID. Returns the name of the LookAndFeel class for this component. Returns:String the string "ScrollBarUI" Annotations @BeanProperty bound:false See Also `JComponent#getUIClassID`, `UIDefaults#getUI`

public String getUIClassID()

Overrides javax.swing.JComponent.getUIClassID.

Returns the name of the LookAndFeel class for this component.

Returns:String

the string "ScrollBarUI"

Annotations

@BeanProperty
bound:false

getUnitIncrement back to summary

getUnitIncrement	back to summary
public int getUnitIncrement(int direction) Returns the amount to change the scrollbar's value by, given a unit up/down request. A ScrollBarUI implementation typically calls this method when the user clicks on a scrollbar up/down arrow and uses the result to update the scrollbar's value. Subclasses may override this method to compute a value, e.g. the change required to scroll one (variable height) line of text or one row in a table. 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. Some look and feel implementations that provide custom scrolling behavior ignore this property. Parameters direction:int is -1 or 1 for up/down respectively Returns:int the value of the unitIncrement property See Also `setUnitIncrement`, `setValue`, `Scrollable#getScrollableUnitIncrement`

public int getUnitIncrement(int direction)

Returns the amount to change the scrollbar's value by, given a unit up/down request. A ScrollBarUI implementation typically calls this method when the user clicks on a scrollbar up/down arrow and uses the result to update the scrollbar's value. Subclasses may override this method to compute a value, e.g. the change required to scroll one (variable height) line of text or one row in a table.

Some look and feel implementations that provide custom scrolling behavior ignore this property.

Parameters

direction:int: is -1 or 1 for up/down respectively

Returns:int

the value of the unitIncrement property

getUnitIncrement back to summary

getUnitIncrement	back to summary
public int getUnitIncrement() Implements java.awt.Adjustable.getUnitIncrement. For backwards compatibility with java.awt.Scrollbar. See Also `Adjustable#getUnitIncrement`, `getUnitIncrement(int)`

public int getUnitIncrement()

Implements java.awt.Adjustable.getUnitIncrement.

For backwards compatibility with java.awt.Scrollbar.

See Also: Adjustable#getUnitIncrement, getUnitIncrement(int)

getValue back to summary

getValue	back to summary
public int getValue() Implements java.awt.Adjustable.getValue. Returns the scrollbar's value. Returns:int the model's value property See Also `setValue`

public int getValue()

Implements java.awt.Adjustable.getValue.

Returns the scrollbar's value.

Returns:int: the model's value property
See Also: setValue

getValueIsAdjusting back to summary

getValueIsAdjusting	back to summary
public boolean getValueIsAdjusting() True if the scrollbar knob is being dragged. Returns:boolean the value of the model's valueIsAdjusting property See Also `setValueIsAdjusting`

public boolean getValueIsAdjusting()

True if the scrollbar knob is being dragged.

Returns:boolean: the value of the model's valueIsAdjusting property
See Also: setValueIsAdjusting

getVisibleAmount back to summary

getVisibleAmount	back to summary
public int getVisibleAmount() Implements java.awt.Adjustable.getVisibleAmount. Returns the scrollbar's extent, aka its "visibleAmount". In many scrollbar look and feel implementations the size of the scrollbar "knob" or "thumb" is proportional to the extent. Returns:int the value of the model's extent property See Also `setVisibleAmount`

public int getVisibleAmount()

Implements java.awt.Adjustable.getVisibleAmount.

Returns the scrollbar's extent, aka its "visibleAmount". In many scrollbar look and feel implementations the size of the scrollbar "knob" or "thumb" is proportional to the extent.

Returns:int: the value of the model's extent property
See Also: setVisibleAmount

paramString back to summary

paramString	back to summary
protected String paramString() Overrides javax.swing.JComponent.paramString. Returns a string representation of this JScrollBar. 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`. Returns:String a string representation of this JScrollBar.

protected String paramString()

Overrides javax.swing.JComponent.paramString.

Returns a string representation of this JScrollBar. 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.

Returns:String: a string representation of this JScrollBar.

removeAdjustmentListener back to summary

removeAdjustmentListener	back to summary
public void removeAdjustmentListener(AdjustmentListener l) Implements java.awt.Adjustable.removeAdjustmentListener. Removes an AdjustmentEvent listener. Parameters l:AdjustmentListener the AdjustmentLister to remove See Also `addAdjustmentListener`

public void removeAdjustmentListener(AdjustmentListener l)

Implements java.awt.Adjustable.removeAdjustmentListener.

Removes an AdjustmentEvent listener.

Parameters

l:AdjustmentListener: the AdjustmentLister to remove

See Also

addAdjustmentListener

setBlockIncrement back to summary

setBlockIncrement	back to summary
public void setBlockIncrement(int blockIncrement) Implements java.awt.Adjustable.setBlockIncrement. Sets the blockIncrement property. Note, that if the argument is equal to the value of Integer.MIN_VALUE, then most look and feel implementations will not provide scrolling to the right/down. Some look and feel implementations that provide custom scrolling behavior ignore this property. Annotations @BeanProperty preferred:true description:The scrollbar\'s block increment. See Also `getBlockIncrement()`

public void setBlockIncrement(int blockIncrement)

Implements java.awt.Adjustable.setBlockIncrement.

Sets the blockIncrement property.

Note, that if the argument is equal to the value of Integer.MIN_VALUE, then most look and feel implementations will not provide scrolling to the right/down.

Some look and feel implementations that provide custom scrolling behavior ignore this property.

Annotations

@BeanProperty
preferred:true
description:The scrollbar\'s block increment.

See Also

getBlockIncrement()

setEnabled	back to summary
public void setEnabled(boolean x) Overrides javax.swing.JComponent.setEnabled. Enables the component so that the knob position can be changed. When the disabled, the knob position cannot be changed. Parameters x:boolean a boolean value, where true enables the component and false disables it

setEnabled

back to summary

public void setEnabled(boolean x)

Overrides javax.swing.JComponent.setEnabled.

Enables the component so that the knob position can be changed. When the disabled, the knob position cannot be changed.

Parameters

x:boolean: a boolean value, where true enables the component and false disables it

setMaximum back to summary

setMaximum	back to summary
public void setMaximum(int maximum) Implements java.awt.Adjustable.setMaximum. Sets the model's maximum property. Note that the scrollbar's value can only be set to maximum - extent. Annotations @BeanProperty bound:false preferred:true description:The scrollbar\'s maximum value. See Also `getMaximum`, `BoundedRangeModel#setMaximum`

public void setMaximum(int maximum)

Implements java.awt.Adjustable.setMaximum.

Sets the model's maximum property. Note that the scrollbar's value can only be set to maximum - extent.

Annotations

@BeanProperty
bound:false
preferred:true
description:The scrollbar\'s maximum value.

setMaximumSize back to summary

setMaximumSize	back to summary
public void setMaximumSize(Dimension maximumSize) Overrides javax.swing.JComponent.setMaximumSize. Unlike most components, `JScrollBar` derives the maximum size from the preferred size in one axis and a fixed maximum size in the other. Thus, it overrides `JComponent.setMaximumSize` contract that subsequent calls to `getMaximumSize` will return the same value as set in `JComponent.setMaximumSize`. Parameters maximumSize:Dimension the desired maximum allowable size

public void setMaximumSize(Dimension maximumSize)

Overrides javax.swing.JComponent.setMaximumSize.

Unlike most components, JScrollBar derives the maximum size from the preferred size in one axis and a fixed maximum size in the other. Thus, it overrides JComponent.setMaximumSize contract that subsequent calls to getMaximumSize will return the same value as set in JComponent.setMaximumSize.

Parameters

maximumSize:Dimension: the desired maximum allowable size

setMinimum back to summary

setMinimum	back to summary
public void setMinimum(int minimum) Implements java.awt.Adjustable.setMinimum. Sets the model's minimum property. Annotations @BeanProperty bound:false preferred:true description:The scrollbar\'s minimum value. See Also `getMinimum`, `BoundedRangeModel#setMinimum`

public void setMinimum(int minimum)

Implements java.awt.Adjustable.setMinimum.

Sets the model's minimum property.

Annotations

@BeanProperty
bound:false
preferred:true
description:The scrollbar\'s minimum value.

setMinimumSize back to summary

setMinimumSize	back to summary
public void setMinimumSize(Dimension minimumSize) Overrides javax.swing.JComponent.setMinimumSize. Unlike most components, `JScrollBar` derives the minimum size from the preferred size in one axis and a fixed minimum size in the other. Thus, it overrides `JComponent.setMinimumSize` contract that subsequent calls to `getMinimumSize` will return the same value as set in `JComponent.setMinimumSize`. Parameters minimumSize:Dimension the new minimum size of this component

public void setMinimumSize(Dimension minimumSize)

Overrides javax.swing.JComponent.setMinimumSize.

Unlike most components, JScrollBar derives the minimum size from the preferred size in one axis and a fixed minimum size in the other. Thus, it overrides JComponent.setMinimumSize contract that subsequent calls to getMinimumSize will return the same value as set in JComponent.setMinimumSize.

Parameters

minimumSize:Dimension: the new minimum size of this component

setModel back to summary

setModel	back to summary
public void setModel(BoundedRangeModel newModel) Sets the model that handles the scrollbar's four fundamental properties: minimum, maximum, value, extent. Parameters newModel:BoundedRangeModel a new model Annotations @BeanProperty expert:true description:The scrollbar\'s BoundedRangeModel. See Also `getModel`

public void setModel(BoundedRangeModel newModel)

Sets the model that handles the scrollbar's four fundamental properties: minimum, maximum, value, extent.

Parameters

newModel:BoundedRangeModel: a new model

Annotations

@BeanProperty
expert:true
description:The scrollbar\'s BoundedRangeModel.

See Also

getModel

setOrientation back to summary

setOrientation	back to summary
public void setOrientation(int orientation) Set the scrollbar's orientation to either VERTICAL or HORIZONTAL. Parameters orientation:int an orientation of the `JScrollBar` Annotations @BeanProperty preferred:true visualUpdate:true enumerationValues:JScrollBar.VERTICAL, JScrollBar.HORIZONTAL description:The scrollbar\'s orientation. Exceptions IllegalArgumentException: if orientation is not one of VERTICAL, HORIZONTAL See Also `getOrientation`

public void setOrientation(int orientation)

Set the scrollbar's orientation to either VERTICAL or HORIZONTAL.

Parameters

orientation:int: an orientation of the JScrollBar

Annotations

@BeanProperty
preferred:true
visualUpdate:true
enumerationValues:JScrollBar.VERTICAL, JScrollBar.HORIZONTAL
description:The scrollbar\'s orientation.

Exceptions

IllegalArgumentException:: if orientation is not one of VERTICAL, HORIZONTAL

See Also

getOrientation

setUI back to summary

setUI	back to summary
public void setUI(ScrollBarUI ui) Sets the L&F object that renders this component. Parameters ui:ScrollBarUI the `ScrollBarUI` L&F object Annotations @BeanProperty hidden:true visualUpdate:true description:The UI object that implements the Component\'s LookAndFeel Since 1.4 See Also `UIDefaults#getUI`

public void setUI(ScrollBarUI ui)

Sets the L&F object that renders this component.

Parameters

ui:ScrollBarUI: the ScrollBarUI L&F object

Annotations

@BeanProperty
hidden:true
visualUpdate:true
description:The UI object that implements the Component\'s LookAndFeel

Since

1.4

See Also

UIDefaults#getUI

setUnitIncrement back to summary

setUnitIncrement	back to summary
public void setUnitIncrement(int unitIncrement) Implements java.awt.Adjustable.setUnitIncrement. Sets the unitIncrement property. Note, that if the argument is equal to the value of Integer.MIN_VALUE, then most look and feel implementations will not provide scrolling to the right/down. Some look and feel implementations that provide custom scrolling behavior ignore this property. Annotations @BeanProperty preferred:true description:The scrollbar\'s unit increment. See Also `getUnitIncrement`

public void setUnitIncrement(int unitIncrement)

Implements java.awt.Adjustable.setUnitIncrement.

Sets the unitIncrement property.

Note, that if the argument is equal to the value of Integer.MIN_VALUE, then most look and feel implementations will not provide scrolling to the right/down.

Some look and feel implementations that provide custom scrolling behavior ignore this property.

Annotations

@BeanProperty
preferred:true
description:The scrollbar\'s unit increment.

See Also

getUnitIncrement

setValue back to summary

setValue	back to summary
public void setValue(int value) Implements java.awt.Adjustable.setValue. Sets the scrollbar's value. This method just forwards the value to the model. Annotations @BeanProperty bound:false preferred:true description:The scrollbar\'s current value. See Also `getValue`, `BoundedRangeModel#setValue`

public void setValue(int value)

Implements java.awt.Adjustable.setValue.

Sets the scrollbar's value. This method just forwards the value to the model.

Annotations

@BeanProperty
bound:false
preferred:true
description:The scrollbar\'s current value.

setValueIsAdjusting back to summary

setValueIsAdjusting	back to summary
public void setValueIsAdjusting(boolean b) Sets the model's valueIsAdjusting property. Scrollbar look and feel implementations should set this property to true when a knob drag begins, and to false when the drag ends. The scrollbar model will not generate ChangeEvents while valueIsAdjusting is true. Parameters b:boolean `true` if the upcoming changes to the value property are part of a series Annotations @BeanProperty bound:false expert:true description:True if the scrollbar thumb is being dragged. See Also `getValueIsAdjusting`, `BoundedRangeModel#setValueIsAdjusting`

public void setValueIsAdjusting(boolean b)

Sets the model's valueIsAdjusting property. Scrollbar look and feel implementations should set this property to true when a knob drag begins, and to false when the drag ends. The scrollbar model will not generate ChangeEvents while valueIsAdjusting is true.

Parameters

b:boolean: true if the upcoming changes to the value property are part of a series

Annotations

@BeanProperty
bound:false
expert:true
description:True if the scrollbar thumb is being dragged.

setValues back to summary

setValues	back to summary
public void setValues(int newValue, int newExtent, int newMin, int newMax) Sets the four BoundedRangeModel properties after forcing the arguments to obey the usual constraints: minimum ≤ value ≤ value+extent ≤ maximum Parameters newValue:int an int giving the current value newExtent:int an int giving the amount by which the value can "jump" newMin:int an int giving the minimum value newMax:int an int giving the maximum value See Also `BoundedRangeModel#setRangeProperties`, `setValue`, `setVisibleAmount`, `setMinimum`, `setMaximum`

public void setValues(int newValue, int newExtent, int newMin, int newMax)

Sets the four BoundedRangeModel properties after forcing the arguments to obey the usual constraints:

minimum ≤ value ≤ value+extent ≤ maximum

Parameters

newValue:int: an int giving the current value
newExtent:int: an int giving the amount by which the value can "jump"
newMin:int: an int giving the minimum value
newMax:int: an int giving the maximum value

setVisibleAmount back to summary

setVisibleAmount	back to summary
public void setVisibleAmount(int extent) Implements java.awt.Adjustable.setVisibleAmount. Set the model's extent property. Annotations @BeanProperty bound:false preferred:true description:The amount of the view that is currently visible. See Also `getVisibleAmount`, `BoundedRangeModel#setExtent`

public void setVisibleAmount(int extent)

Implements java.awt.Adjustable.setVisibleAmount.

Set the model's extent property.

Annotations

@BeanProperty
bound:false
preferred:true
description:The amount of the view that is currently visible.

updateUI back to summary

public void updateUI()

Overrides javax.swing.JComponent.updateUI.

Overrides JComponent.updateUI.

See Also: JComponent#updateUI

writeObject

back to summary

private void writeObject(ObjectOutputStream s) throws IOException

Hides javax.swing.JComponent.writeObject.

See readObject() and writeObject() in JComponent for more information about serialization in Swing.

Annotations

@Serial

Exceptions

IOException:

Doc from java.awt.Container.writeObject.

if an I/O error occurs

javax.swing back to summary

protected Class JScrollBar.AccessibleJScrollBar

Class Inheritance

extends AccessibleJComponent
implements AccessibleValue

java.lang.Object
javax.accessibility.AccessibleContext
java.awt.Component.AccessibleAWTComponent
java.awt.Container.AccessibleAWTContainer
javax.swing.JComponent.AccessibleJComponent
javax.swing.JScrollBar.AccessibleJScrollBar

All Implemented Interfaces

javax.accessibility.AccessibleValue

Annotations

@SuppressWarnings:serial

This class implements accessibility support for the JScrollBar class. It provides an implementation of the Java Accessibility API appropriate to scroll bar user-interface elements.

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 JavaBeans has been added to the java.beans package. Please see java.beans.XMLEncoder.

Field Summary

Inherited from javax.swing.JComponent.AccessibleJComponent:: accessibleFocusHandler

Constructor Summary

Access	Constructor and Description
protected	AccessibleJScrollBar() Constructs an `AccessibleJScrollBar`.

Method Summary

Modifier and Type	Method and Description
public AccessibleRole	Returns: an instance of AccessibleRole describing the role of the object getAccessibleRole() Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleRole. Get the role of this object.
public AccessibleStateSet	Returns: an instance of AccessibleState containing the current state of the object getAccessibleStateSet() Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleStateSet. Get the state set of this object.
public AccessibleValue	Returns: this object getAccessibleValue() Overrides javax.accessibility.AccessibleContext.getAccessibleValue. Get the AccessibleValue associated with this object.
public Number	Returns: The current value of this object. getCurrentAccessibleValue() Implements javax.accessibility.AccessibleValue.getCurrentAccessibleValue. Get the accessible value of this object.
public Number	Returns: The maximum value of this object. getMaximumAccessibleValue() Implements javax.accessibility.AccessibleValue.getMaximumAccessibleValue. Get the maximum accessible value of this object.
public Number	Returns: The minimum value of this object. getMinimumAccessibleValue() Implements javax.accessibility.AccessibleValue.getMinimumAccessibleValue. Get the minimum accessible value of this object.
public boolean	Returns: True if the value was set. setCurrentAccessibleValue(Number n) Implements javax.accessibility.AccessibleValue.setCurrentAccessibleValue. Set the value of this object as a Number.

Inherited from javax.swing.JComponent.AccessibleJComponent:: addPropertyChangeListener getAccessibleChild getAccessibleChildrenCount getAccessibleDescription getAccessibleExtendedComponent getAccessibleKeyBinding getAccessibleName getBorderTitle getTitledBorderText getToolTipText removePropertyChangeListener

Constructor Detail

AccessibleJScrollBar	back to summary
protected AccessibleJScrollBar() Constructs an `AccessibleJScrollBar`.

Method Detail

getAccessibleRole

back to summary

public AccessibleRole getAccessibleRole()

Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleRole.

Get the role of this object.

Returns:AccessibleRole: an instance of AccessibleRole describing the role of the object

getAccessibleStateSet back to summary

public AccessibleStateSet getAccessibleStateSet()

Overrides javax.swing.JComponent.AccessibleJComponent.getAccessibleStateSet.

Get the state set of this object.

Returns:AccessibleStateSet: an instance of AccessibleState containing the current state of the object
See Also: AccessibleState

getAccessibleValue

back to summary

public AccessibleValue getAccessibleValue()

Overrides javax.accessibility.AccessibleContext.getAccessibleValue.

Get the 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 AccessibleValue interface on behalf of itself.

Returns:AccessibleValue: this object

getCurrentAccessibleValue

back to summary

public Number getCurrentAccessibleValue()

Implements javax.accessibility.AccessibleValue.getCurrentAccessibleValue.

Get the accessible value of this object.

Returns:Number: The current value of this object.

getMaximumAccessibleValue

back to summary

public Number getMaximumAccessibleValue()

Implements javax.accessibility.AccessibleValue.getMaximumAccessibleValue.

Get the maximum accessible value of this object.

Returns:Number: The maximum value of this object.

getMinimumAccessibleValue

back to summary

public Number getMinimumAccessibleValue()

Implements javax.accessibility.AccessibleValue.getMinimumAccessibleValue.

Get the minimum accessible value of this object.

Returns:Number: The minimum value of this object.

setCurrentAccessibleValue

back to summary

public boolean setCurrentAccessibleValue(Number n)

Implements javax.accessibility.AccessibleValue.setCurrentAccessibleValue.

Set the value of this object as a Number.

Returns:boolean: True if the value was set.

public Class JScrollBar

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

protected Class JScrollBar.AccessibleJScrollBar

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail

private Class JScrollBar.ModelListener

Constructor Summary

Method Summary

Constructor Detail

Method Detail