java.awt
Class Scrollbar

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Scrollbar

All Implemented Interfaces:

java.awt.image.ImageObserver

public class Scrollbar

extends Component

A Scrollbar component.

Field Summary

static int	HORIZONTAL The horizontal Scrollbar variable.
static int	VERTICAL The vertical Scrollbar variable.

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Scrollbar()
Constructs a new vertical Scrollbar.

Scrollbar(int orientation)
Constructs a new Scrollbar with the specified orientation.

Scrollbar(int orientation, int value, int visible, int minimum, int maximum)
Constructs a new Scrollbar with the specified orientation, value, page size, and minumum and maximum values.

Method Summary

void	addNotify() Creates the Scrollbar's peer.
int	getLineIncrement() Gets the line increment for this scrollbar.
int	getMaximum() Returns the maximum value of this Scrollbar.
int	getMinimum() Returns the minimum value of this Scrollbar.
int	getOrientation() Returns the orientation for this Scrollbar.
int	getPageIncrement() Gets the page increment for this scrollbar.
int	getValue() Returns the current value of this Scrollbar.
int	getVisible() Returns the visible amount of the Scrollbar.
protected String	paramString() Returns the String parameters for this Scrollbar.
void	setLineIncrement(int l) Sets the line increment for this scrollbar.
void	setPageIncrement(int l) Sets the page increment for this scrollbar.
void	setValue(int value) Sets the value of this Scrollbar to the specified value.
void	setValues(int value, int visible, int minimum, int maximum) Sets the values for this Scrollbar.

Methods inherited from class java.awt.Component

action, bounds, checkImage, checkImage, createImage, createImage, deliverEvent, disable, enable, enable, getBackground, getColorModel, getFont, getFontMetrics, getForeground, getGraphics, getParent, getPeer, getToolkit, gotFocus, handleEvent, hide, imageUpdate, inside, invalidate, isEnabled, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, removeNotify, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setFont, setForeground, show, show, size, toString, update, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

HORIZONTAL

public static final int HORIZONTAL

The horizontal Scrollbar variable.

See Also:

Constant Field Values

VERTICAL

public static final int VERTICAL

The vertical Scrollbar variable.

See Also:

Constant Field Values

Constructor Detail

Scrollbar

public Scrollbar()

Constructs a new vertical Scrollbar.

Scrollbar

public Scrollbar(int orientation)

Constructs a new Scrollbar with the specified orientation.

Parameters:

orientation - either Scrollbar.HORIZONTAL or Scrollbar.VERTICAL

Throws:

IllegalArgumentException - When an illegal scrollbar orientation is given.

Scrollbar

public Scrollbar(int orientation,
                 int value,
                 int visible,
                 int minimum,
                 int maximum)

Constructs a new Scrollbar with the specified orientation, value, page size, and minumum and maximum values.

Parameters:

orientation - either Scrollbar.HORIZONTAL or Scrollbar.VERTICAL

value - the scrollbar's value

visible - the size of the visible portion of the scrollable area. The scrollbar will use this value when paging up or down by a page.

minimum - the minimum value of the scrollbar

maximum - the maximum value of the scrollbar

Method Detail

addNotify

public void addNotify()

Creates the Scrollbar's peer. The peer allows you to modify the appearance of the Scrollbar without changing any of its functionality.

Overrides:

addNotify in class Component

See Also:

Component.getPeer(), Component.removeNotify()

getOrientation

public int getOrientation()

Returns the orientation for this Scrollbar.

getValue

public int getValue()

Returns the current value of this Scrollbar.

See Also:

getMinimum(), getMaximum()

setValue

public void setValue(int value)

Sets the value of this Scrollbar to the specified value.

Parameters:

value - the new value of the Scrollbar. If this value is below the current minimum or above the current maximum, it becomes the new one of those values, respectively.

See Also:

getValue()

getMinimum

public int getMinimum()

Returns the minimum value of this Scrollbar.

See Also:

getMaximum(), getValue()

getMaximum

public int getMaximum()

Returns the maximum value of this Scrollbar.

See Also:

getMinimum(), getValue()

getVisible

public int getVisible()

Returns the visible amount of the Scrollbar.

setLineIncrement

public void setLineIncrement(int l)

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

getLineIncrement

public int getLineIncrement()

Gets the line increment for this scrollbar.

setPageIncrement

public void setPageIncrement(int l)

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

getPageIncrement

public int getPageIncrement()

Gets the page increment for this scrollbar.

setValues

public void setValues(int value,
                      int visible,
                      int minimum,
                      int maximum)

Sets the values for this Scrollbar.

Parameters:

value - is the position in the current window.

visible - is the amount visible per page

minimum - is the minimum value of the scrollbar

maximum - is the maximum value of the scrollbar

paramString

protected String paramString()

Returns the String parameters for this Scrollbar.

Overrides:

paramString in class Component