OpenJDK 27 · sun.awt.X11.XScrollbar · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
pack-priv int	alignment
public static final int	ALIGNMENT_HORIZONTAL
public static final int	ALIGNMENT_VERTICAL
private static final int	ARROW_IND
pack-priv int	arrowArea
pack-priv int	barLength
pack-priv int	barWidth
private boolean	dragging
pack-priv Polygon	firstArrow
pack-priv int	height
private XScrollRepeater	i_scroller
private int	line
private static PlatformLogger	log
private int	max
private int	min
private static final int	MIN_THUMB_H
pack-priv int	mode
private boolean	needsRepaint
private int	page
private boolean	pressed
private Rectangle	prevThumb
pack-priv XScrollbarClient	sb
private static XScrollRepeater	scroller The thread that asynchronously tells the scrollbar to scroll.
pack-priv Polygon	secondArrow
pack-priv Point	thumbOffset
private int	val
private int	vis
pack-priv int	width

Constructor Summary

Access	Constructor and Description
public	XScrollbar(int alignment, XScrollbarClient sb)

Method Summary

Modifier and Type	Method and Description
pack-priv abstract boolean	beforeThumb(int x, int y)
pack-priv void	calculateArrowWidth()
private int	calculateCursorOffset(int x, int y)
protected Rectangle	calculateThumbRect() Method to calculate the scroll thumb's size and position.
protected Polygon	createArrowShape(boolean vertical, boolean up) Creates oriented directed arrow
pack-priv int	getArrowAreaWidth() Width of the area reserved for arrow
pack-priv int	getArrowWidth() Width of the arrow image
pack-priv int	getBlockIncrement() Gets the block increment for this scrollbar.
pack-priv int	getMaximum() Returns the maximum value of this Scrollbar.
pack-priv int	getMinimum() Returns the minimum value of this Scrollbar.
private double	getScaleFactor() Returns the scale factor for the thumbArea ( thumbAreaH / (max - min)).
protected abstract Rectangle	getThumbArea() Gets the area of the scroll track
pack-priv int	getUnitIncrement() Gets the unit increment for this scrollbar.
pack-priv int	getValue() Returns the current value of this Scrollbar.
pack-priv int	getVisibleAmount() Returns the visible amount of this Scrollbar.
public void	handleMouseEvent(int id, int modifiers, int x, int y)
private void	handleTrackEvent(int x, int y, boolean isAdjusting)
pack-priv boolean	isInArrow(int x, int y)
pack-priv boolean	isInThumb(int x, int y) Is x,y in the scroll thumb?
public boolean	needsRepaint()
pack-priv void	notifyValue(int v)
pack-priv void	notifyValue(int v, final boolean isAdjusting)
pack-priv void	paint(Graphics the graphics context to paint into g, Color[] the colors to use when painting the scrollbar colors, boolean paint the whole scrollbar if true, just the thumb is false paintAll) paint the scrollbar
pack-priv void	paintArrows(Graphics2D g, Color background, Color darkShadow, Color lightShadow)
protected abstract void	rebuildArrows()
pack-priv void	scroll() Scroll one unit.
pack-priv synchronized void	setBlockIncrement(int is the block size for increment or decrement of the value blockSize) Sets the block increment for this scrollbar.
pack-priv synchronized void	setMaximum(int the maximum value of the scrollbar newMaximum) Sets the maximum value for this Scrollbar.
pack-priv synchronized void	setMinimum(int the minimum value of the scrollbar newMinimum) Sets the minimum value for this Scrollbar.
public void	setMode(int mode) The set method for mode property.
public void	setSize(int width, int height)
pack-priv synchronized void	setUnitIncrement(int is the unit size for increment or decrement of the value unitSize) Sets the unit increment for this scrollbar.
pack-priv synchronized void	setValue(int the new value of the Scrollbar. If this value is below the current minimum or above the current maximum minus the visible amount, it becomes the new one of those values, respectively. newValue) Sets the value of this Scrollbar to the specified value.
pack-priv synchronized void	setValues(int is the position in the current window. value, int is the amount visible per page visible, int is the minimum value of the scrollbar minimum, int is the maximum value of the scrollbar maximum) Sets the values for this Scrollbar.
pack-priv synchronized void	setValues(int is the position in the current window. value, int is the amount visible per page visible, int is the minimum value of the scrollbar minimum, int is the maximum value of the scrollbar maximum, int is the unit size for increment or decrement of the value unitSize, int blockSize) Sets param of this Scrollbar to the specified values.
pack-priv synchronized void	setVisibleAmount(int the amount visible per page newAmount) Sets the visible amount of this Scrollbar, which is the range of values represented by the width of the scroll bar's bubble.
pack-priv void	startScrolling() Tell the scroller to start scrolling.
pack-priv void	startScrollingInstance() Tell the instance scroller to start scrolling.
pack-priv void	stopScrollingInstance() Tell the instance scroller to stop scrolling.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

alignment	back to summary
pack-priv int alignment

ALIGNMENT_HORIZONTAL	back to summary
public static final int ALIGNMENT_HORIZONTAL

ALIGNMENT_VERTICAL	back to summary
public static final int ALIGNMENT_VERTICAL

ARROW_IND	back to summary
private static final int ARROW_IND

arrowArea	back to summary
pack-priv int arrowArea

barLength	back to summary
pack-priv int barLength

barWidth	back to summary
pack-priv int barWidth

dragging	back to summary
private boolean dragging

firstArrow	back to summary
pack-priv Polygon firstArrow

height	back to summary
pack-priv int height

i_scroller	back to summary
private XScrollRepeater i_scroller

line	back to summary
private int line

log	back to summary
private static PlatformLogger log

max	back to summary
private int max

min	back to summary
private int min

MIN_THUMB_H	back to summary
private static final int MIN_THUMB_H

mode	back to summary
pack-priv int mode

needsRepaint	back to summary
private boolean needsRepaint

page	back to summary
private int page

pressed	back to summary
private boolean pressed

prevThumb	back to summary
private Rectangle prevThumb

sb	back to summary
pack-priv XScrollbarClient sb

scroller back to summary

scroller	back to summary
private static XScrollRepeater scroller The thread that asynchronously tells the scrollbar to scroll. See Also `startScrolling`

private static XScrollRepeater scroller

The thread that asynchronously tells the scrollbar to scroll.

See Also: startScrolling

secondArrow	back to summary
pack-priv Polygon secondArrow

thumbOffset	back to summary
pack-priv Point thumbOffset

val	back to summary
private int val

vis	back to summary
private int vis

width	back to summary
pack-priv int width

Constructor Detail

XScrollbar	back to summary
public XScrollbar(int alignment, XScrollbarClient sb)

Method Detail

beforeThumb	back to summary
pack-priv abstract boolean beforeThumb(int x, int y)

calculateArrowWidth	back to summary
pack-priv void calculateArrowWidth()

calculateCursorOffset	back to summary
private int calculateCursorOffset(int x, int y)

calculateThumbRect	back to summary
protected Rectangle calculateThumbRect() Method to calculate the scroll thumb's size and position. This is based on CalcSliderRect in ScrollBar.c of Motif source. If we ever cache the thumb rect, we'll need to use a clone in isInThumb().

createArrowShape	back to summary
protected Polygon createArrowShape(boolean vertical, boolean up) Creates oriented directed arrow

getArrowAreaWidth	back to summary
pack-priv int getArrowAreaWidth() Width of the area reserved for arrow

getArrowWidth	back to summary
pack-priv int getArrowWidth() Width of the arrow image

getBlockIncrement	back to summary
pack-priv int getBlockIncrement() Gets the block increment for this scrollbar.

getMaximum back to summary

getMaximum	back to summary
pack-priv int getMaximum() Returns the maximum value of this Scrollbar. See Also `getMinimum`, `getValue`

pack-priv int getMaximum()

Returns the maximum value of this Scrollbar.

See Also: getMinimum, getValue

getMinimum back to summary

getMinimum	back to summary
pack-priv int getMinimum() Returns the minimum value of this Scrollbar. See Also `getMaximum`, `getValue`

pack-priv int getMinimum()

Returns the minimum value of this Scrollbar.

See Also: getMaximum, getValue

getScaleFactor back to summary

getScaleFactor	back to summary
private double getScaleFactor() Returns the scale factor for the thumbArea ( thumbAreaH / (max - min)). See Also `getArrowAreaWidth`

private double getScaleFactor()

Returns the scale factor for the thumbArea ( thumbAreaH / (max - min)).

See Also: getArrowAreaWidth

getThumbArea	back to summary
protected abstract Rectangle getThumbArea() Gets the area of the scroll track

getUnitIncrement	back to summary
pack-priv int getUnitIncrement() Gets the unit increment for this scrollbar.

getValue back to summary

getValue	back to summary
pack-priv int getValue() Returns the current value of this Scrollbar. See Also `getMinimum`, `getMaximum`

pack-priv int getValue()

Returns the current value of this Scrollbar.

See Also: getMinimum, getMaximum

getVisibleAmount	back to summary
pack-priv int getVisibleAmount() Returns the visible amount of this Scrollbar.

handleMouseEvent	back to summary
public void handleMouseEvent(int id, int modifiers, int x, int y) Annotations @SuppressWarnings:deprecation See Also `MouseEvent.MOUSE_CLICKED MouseEvent.MOUSE_PRESSED MouseEvent.MOUSE_RELEASED MouseEvent.MOUSE_MOVED MouseEvent.MOUSE_ENTERED MouseEvent.MOUSE_EXITED MouseEvent.MOUSE_DRAGGED`

handleTrackEvent	back to summary
private void handleTrackEvent(int x, int y, boolean isAdjusting)

isInArrow	back to summary
pack-priv boolean isInArrow(int x, int y)

isInThumb	back to summary
pack-priv boolean isInThumb(int x, int y) Is x,y in the scroll thumb? If we ever cache the thumb rect, we may need to clone the result of calculateThumbRect().

needsRepaint	back to summary
public boolean needsRepaint()

notifyValue	back to summary
pack-priv void notifyValue(int v)

notifyValue	back to summary
pack-priv void notifyValue(int v, final boolean isAdjusting)

paint

back to summary

pack-priv void paint(Graphics g, Color[] colors, boolean paintAll)

paint the scrollbar

Parameters

g:Graphics: the graphics context to paint into
colors:Color[]: the colors to use when painting the scrollbar
paintAll:boolean: paint the whole scrollbar if true, just the thumb is false

paintArrows	back to summary
pack-priv void paintArrows(Graphics2D g, Color background, Color darkShadow, Color lightShadow)

rebuildArrows	back to summary
protected abstract void rebuildArrows()

scroll back to summary

pack-priv void scroll()

Scroll one unit.

See Also: notifyValue

setBlockIncrement

back to summary

pack-priv synchronized void setBlockIncrement(int blockSize)

Sets the block increment for this scrollbar. This is the value that will be added (subtracted) when the user hits the block down (up) gadgets.

Parameters

blockSize:int: is the block size for increment or decrement of the value

setMaximum

back to summary

pack-priv synchronized void setMaximum(int newMaximum)

Sets the maximum value for this Scrollbar.

Parameters

newMaximum:int: the maximum value of the scrollbar

setMinimum

back to summary

pack-priv synchronized void setMinimum(int newMinimum)

Sets the minimum value for this Scrollbar.

Parameters

newMinimum:int: the minimum value of the scrollbar

setMode	back to summary
public void setMode(int mode) The set method for mode property. See 6243382 for more information

setSize	back to summary
public void setSize(int width, int height)

setUnitIncrement

back to summary

pack-priv synchronized void setUnitIncrement(int unitSize)

Sets the unit increment for this scrollbar. This is the value that will be added (subtracted) when the user hits the unit down (up) gadgets.

Parameters

unitSize:int: is the unit size for increment or decrement of the value

setValue back to summary

pack-priv synchronized void setValue(int newValue)

Sets the value of this Scrollbar to the specified value.

Parameters

newValue:int: the new value of the Scrollbar. If this value is below the current minimum or above the current maximum minus the visible amount, it becomes the new one of those values, respectively.

See Also

getValue

setValues

back to summary

pack-priv synchronized void setValues(int value, int visible, int minimum, int maximum)

Sets the values for this Scrollbar. This method enforces the same constraints as in java.awt.Scrollbar:

The maximum must be greater than the minimum
The value must be greater than or equal to the minimum and less than or equal to the maximum minus the visible amount
The visible amount must be greater than 1 and less than or equal to the difference between the maximum and minimum values.

Values which do not meet these criteria are quietly coerced to the appropriate boundary value.

Parameters

value:int: is the position in the current window.
visible:int: is the amount visible per page
minimum:int: is the minimum value of the scrollbar
maximum:int: is the maximum value of the scrollbar

setValues back to summary

pack-priv synchronized void setValues(int value, int visible, int minimum, int maximum, int unitSize, int blockSize)

Sets param of this Scrollbar to the specified values.

Parameters

value:int: is the position in the current window.
visible:int: is the amount visible per page
minimum:int: is the minimum value of the scrollbar
maximum:int: is the maximum value of the scrollbar
unitSize:int: is the unit size for increment or decrement of the value

See Also

setValues

setVisibleAmount

back to summary

pack-priv synchronized void setVisibleAmount(int newAmount)

Sets the visible amount of this Scrollbar, which is the range of values represented by the width of the scroll bar's bubble.

Parameters

newAmount:int: the amount visible per page

startScrolling	back to summary
pack-priv void startScrolling() Tell the scroller to start scrolling.

startScrollingInstance	back to summary
pack-priv void startScrollingInstance() Tell the instance scroller to start scrolling. See 6243382 for more information

stopScrollingInstance	back to summary
pack-priv void stopScrollingInstance() Tell the instance scroller to stop scrolling. See 6243382 for more information

toString back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

pack-priv abstract Class XScrollbar

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail