类 java.awt.Scrollbar

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

public class Scrollbar

extends Component

implements Adjustable

类 Scrollbar 描述一个滚动条,这是用户界面中常见的对象。滚动条提供简捷的方式，允许用户在一个指定范围内实现选择。下列三个垂直滚动条能作为选择红、绿和蓝颜色成分的滚动控制：

此例中的滚动条用与下列类似的代码创建：

 redSlider=new Scrollbar(Scrollbar.VERTICAL, 0, 1, 0, 255);
 add(redSlider);
 

一个滚动条能可选地表示一个范围值。例如，如果一个滚动条用于显示滚动文本， "bubble" 或 "thumb" 的宽度表示可视的文本数。下面是表示一范围的滚动条：

bubble 表示的范围为该滚动条 可视的范围。此例中的水平滚动条用如下代码创建：

 ranger = new Scrollbar(Scrollbar.HORIZONTAL, 0, 64, 0, 255);
 add(ranger);
 

注意最大值 255 是该滚动条的滑动块的最大值。滚动条滑动的实际宽度是 255 + 64。当滚动条设置为最大值时，滑动块的左边值是 255, 右边值是 255 + 64。

通常，用户通过移动鼠标来改变滚动条的值。例如，用户可以上下拖动滚动条的滑动块，或在滚动条的单位增量位置或块增量位置点击。键盘指示符也能映射到滚动条。通过转换，Page Up 和 Page Down 键的功能等价于在滚动条的块增量和块减量区域点击鼠标。

当用户改变滚动条的值时，该滚动条接受到一个 AdjustmentEvent 的实例。滚动条处理此事件，将它传递到任一个已注册的监听者。

希望接收滚动条值变化的任一对象，应实现包 java.awt.event 中定义的 AdjustmentListener 接口。调用 addAdjustmentListener 和 removeAdjustmentListener 方法能动态地添加或删除监听者。

类 AdjustmentEvent 定义了五种调整事件，如下所示：

• 当用户拖动滑动块时发送 AdjustmentEvent.TRACK 事件。
• 当用户在水平滚动条的左箭头上或是在垂直滚动条的上箭头上点击或按下相应的键时，发送 AdjustmentEvent.UNIT_INCREMENT 事件。
• 当用户在水平滚动条的右箭头上或是在垂直滚动条的下箭头上点击或按下相应的功能键时，发送 AdjustmentEvent.UNIT_DECREMENT 事件。
• 当用户在水平滚动条的滑动块的左边，或在垂直滚动条的滑动块的上边点击时，发送 AdjustmentEvent.BLOCK_DECREMENT 事件。如果用户使用定义了 Page Up 功能键的键盘，那么通过转换，在按下 Page Up 功能键时也发送此事件。
• 当用户在水平滚动条的滑动块的右边，或在垂直滚动条的滑动块的下边点击时，发送 AdjustmentEvent.BLOCK_DECREMENT 事件。如果用户使用定义了 Page Down 功能键的键盘，那么通过转换，在按下 Page Down 功能键时也发送此事件。

JDK 1.0 事件系统支持向后兼容，但是新版不鼓励使用它。 JDK 1.1 中提到的五种调整事件，与以前的 JDK 版中的有关滚动条的五种事件对应。下面列表给出调整事件类型和它对应的在 JDK 1.0 中的替换事件类型。

• AdjustmentEvent.TRACK 替换 Event.SCROLL_ABSOLUTE
• AdjustmentEvent.UNIT_INCREMENT 替换 Event.SCROLL_LINE_UP
• AdjustmentEvent.UNIT_DECREMENT 替换 Event.SCROLL_LINE_DOWN
• AdjustmentEvent.BLOCK_INCREMENT 替换 Event.SCROLL_PAGE_UP
• AdjustmentEvent.BLOCK_DECREMENT 替换 Event.SCROLL_PAGE_DOWN

来自：

JDK1.0

参见：

AdjustmentEvent, AdjustmentListener

变量索引

HORIZONTAL

表示一个水平滚动条的常量。

VERTICAL

表示一个垂直滚动条的常量。

构造子索引

Scrollbar()

创建一新垂直滚动条。

Scrollbar(int)

创建一给定方向的新滚动条。

Scrollbar(int, int, int, int, int)

用指定的方向、页尺寸和最小最大值创建一个新滚动条，

方法索引

addAdjustmentListener(AdjustmentListener)

添加指定的调整监听者，接收当前滚动条的 AdjustmentEvent 事件实例。

addNotify()

创建滚动条的同级件。

getBlockIncrement()

获取当前滚动条的块增量。

getLineIncrement()

该方法不推荐使用。

getMaximum()

获取滚动条的最大值。

getMinimum()

获取滚动条的最小值。

getOrientation()

确定滚动条方向。

getPageIncrement()

该方法不推荐使用。

getUnitIncrement()

获取滚动条的单位增量。

getValue()

获取滚动条的当前值。

getVisible()

该方法不推荐使用。

getVisibleAmount()

获取滚动条的可见数量。

paramString()

返回表示当前滚动条状态的参数串。

processAdjustmentEvent(AdjustmentEvent)

处理发生在当前滚动条上的调整事件，将之分配给任一已登记的 AdjustmentListener 对象。

processEvent(AWTEvent)

处理当前滚动条的事件。

removeAdjustmentListener(AdjustmentListener)

删除指定的调整事件监听者，使之不再接收当前滚动条的 AdjustmentEvent 事件实例。

setBlockIncrement(int)

设置当前滚动条的块增量。

setLineIncrement(int)

该方法不推荐使用。

setMaximum(int)

设置滚动条的最大值。

setMinimum(int)

设置滚动条的最小值。

setOrientation(int)

设置滚动条方向。

setPageIncrement(int)

该方法不推荐使用。

setUnitIncrement(int)

设置当前滚动条的单位增量。

setValue(int)

将滚动条值设置为指定值。

setValues(int, int, int, int)

设置当前滚动条的四个属性值。

setVisibleAmount(int)

设置滚动条的可见数量。

变量

 public static final int HORIZONTAL

表示一个水平滚动条的常量。

 public static final int VERTICAL

表示一个垂直滚动条的常量。

构造子

 public Scrollbar()

创建一新垂直滚动条。

 public Scrollbar(int orientation)

创建一给定方向的新滚动条。

参数 orientation 必定为 Scrollbar.HORIZONTAL, 或 Scrollbar.VERTICAL, 相应地表示一个水平的或垂直的滚动条。

参数：

orientation - 表示滚动条方向。

抛出： IllegalArgumentException

当参数 orientation 的值非法。

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

用指定的方向、页尺寸和最小最大值创建一个新滚动条，

参数 orientation 必定为 Scrollbar.HORIZONTAL, 或 Scrollbar.VERTICAL, 相应地表示一个水平的或垂直的滚动条。

如果指定的最大值比最小值小，那么最大值取此最小值。如果初始值比最小值小，那么将此初始值转换为最小值；如果它比最大值大，那么将它转换为最大值。

参数：

orientation - 表示滚动条方向。

value - 滚动条的初始值

visible - 滚动条的滑动块尺寸，表示可视部分；当进行翻页操作时，滚动条将使用此值。

minimum - 滚动条的最小值

maximum - 滚动条的最大值

方法

 public void addNotify()

创建滚动条的同级件。 该同级件允许在不改变滚动条功能的情况下改变其外观。

覆盖：

类 Component 中的 addNotify

 public int getOrientation()

确定滚动条方向。

返回值：

滚动条的方向，可能为 Scrollbar.HORIZONTAL 或 Scrollbar.VERTICAL。

参见：

setOrientation

 public void setOrientation(int orientation)

设置滚动条方向。

参数：

orientation - 滚动条的方向，可能为 Scrollbar.HORIZONTAL 或 Scrollbar.VERTICAL。

抛出： IllegalArgumentException

如果提供的 orientation 值不是一个合法值。

参见：

getOrientation

 public int getValue()

获取滚动条的当前值。

返回值：

滚动条的当前值。

参见：

getMinimum, getMaximum

 public synchronized void setValue(int newValue)

将滚动条值设置为指定值。

如果指定值比当前的最小值小或比当前的最大值大，那么替换两者之一都是正确的。

通常，程序应调用 setValues 方法改变滚动条值。 setValues 方法将同时同步设置一个滚动条的最小值、最大值、可视数和值属性，直到它们相互保持一致。

参数：

newValue - 滚动条的新值

参见：

setValues, getValue, getMinimum, getMaximum

 public int getMinimum()

获取滚动条的最小值。

返回值：

滚动条的最小值。

参见：

getValue, getMaximum

 public synchronized void setMinimum(int newMinimum)

设置滚动条的最小值。

通常，程序仅能调用 setValues 方法改变滚动条的最小值。 setValues 方法将同时同步设置一个滚动条的最小值、最大值、可视数和值属性，直到它们相互保持一致。

参数：

newMinimum - 滚动条的新的最小值。

参见：

setValues, setMaximum

 public int getMaximum()

获取滚动条的最大值。

返回值：

滚动条的最大值。

参见：

getValue, getMinimum

 public synchronized void setMaximum(int newMaximum)

设置滚动条的最大值。

通常，程序仅能调用 setValues 方法改变滚动条的最大值。 setValues 方法将同时同步设置一个滚动条的最小值、最大值、可视数和值属性，直到它们相互保持一致。

参数：

newMaximum - 滚动条的新的最大值。

参见：

setValues, setMinimum

 public int getVisibleAmount()

获取滚动条的可见数量。

滚动条的可见数量是它的滑动块宽度表示的相应范围值。用于决定滚动条的块增量。

返回值：

滚动条的可见数。

参见：

setVisibleAmount

 public int getVisible()

注释：不推荐使用 getVisible() 方法。 同 JDK 1.1 版，用 getVisibleAmount() 方法替换。

 public synchronized void setVisibleAmount(int newAmount)

设置滚动条的可见数量。

滚动条的可见数量是它的滑动块宽度表示的相应范围值。 用于决定滚动条的块增量。

通常，程序应调用 setValues 方法改变滚动条值。 setValues 方法将同时同步设置一个滚动条的最小值、最大值、可视数和值属性，直到它们相互保持一致。

参数：

newAmount - 每页中的可见部分。

参见：

getVisibleAmount, setValues

 public synchronized void setUnitIncrement(int v)

设置当前滚动条的单位增量。

当用户激活滚动条的单位增量区时，被添加的单位增量，通常通过鼠标或键盘使滚动条接收一个调整事件。

参数：

v - 滚动条值的增量。

参见：

getUnitIncrement

 public void setLineIncrement(int v)

注释：不推荐使用 setLineIncrement() 方法。 同 JDK 1.1 版类似, 用 setUnitIncrement(int) 方法替换。

 public int getUnitIncrement()

获取滚动条的单位增量。

当用户激活滚动条的单位增量区时，被添加(或减少)的单位增量，通常通过鼠标或键盘使滚动条接收一个调整事件。

返回值：

滚动条的单位增量。

参见：

setUnitIncrement

 public int getLineIncrement()

注释：不推荐使用 getLineIncrement() 方法。 同 JDK 1.1 版，用 getUnitIncrement() 方法替换。

 public synchronized void setBlockIncrement(int v)

设置当前滚动条的块增量。

当用户激活滚动条的块增量区时，被添加(或减少)的块增量，通常通过鼠标或键盘使滚动条接收一个调整事件。

参数：

v - 滚动条值的增量。

参见：

getBlockIncrement

 public void setPageIncrement(int v)

注释：不推荐使用 setPageIncrement() 方法。 同 JDK 1.1 版，用 setBlockIncrement() 方法替换。

 public int getBlockIncrement()

获取当前滚动条的块增量。

当用户激活滚动条的块增量区时，被添加(或减少)的块增量，通常通过鼠标或键盘使滚动条接收一个调整事件。

返回值：

滚动条的块增量。

参见：

setBlockIncrement

 public int getPageIncrement()

注释：不推荐使用 getPageIncrement() 方法。 同 JDK 1.1 版，用 getBlockIncrement() 方法替换。

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

设置当前滚动条的四个属性值。

此方法同时同步设置滚动条的四个参数值，以使他们保持一致。它强制使最大值不能小于最小值，滚动条的取值不能小于最小值、大于最大值。

参数：

value - 当前窗口中的位置。

visible - 每页中的可见部分。

minimum - 滚动条的最小值

maximum - 滚动条的最大值

 public synchronized void addAdjustmentListener(AdjustmentListener l)

添加指定的调整监听者，接收当前滚动条的 AdjustmentEvent 事件实例。

参数：

l - 调整事件的监听者。

参见：

AdjustmentEvent, AdjustmentListener, removeAdjustmentListener

 public synchronized void removeAdjustmentListener(AdjustmentListener l)

删除指定的调整事件监听者，使之不再接收当前滚动条的 AdjustmentEvent 事件实例。

参数：

l - 调整事件的监听者。

参见：

AdjustmentEvent, AdjustmentListener, addAdjustmentListener

 protected void processEvent(AWTEvent e)

处理当前滚动条的事件。 若事件是 AdjustmentEvent 的一个实例，该方法调用 processAdjustmentEvent 方法。 否则，它调用它的父类的 processEvent 方法。

参数：

e - 事件。

覆盖：

processEvent 类 Component 中的

参见：

AdjustmentEvent, processAdjustmentEvent

 protected void processAdjustmentEvent(AdjustmentEvent e)

处理发生在当前滚动条上的调整事件，将之分配给任一已登记的 AdjustmentListener 对象。

除非调整事件对此组件是有效的，否则不能调用此方法。 当如下条件之一发生时，调整事件是有效的：

• 通过 addActionListener 方法，登记了一个 ActionListener 对象。
• 通过执行 enableEvents 方法使动作事件有效。

参数：

e - 调整事件。

参见：

AdjustmentEvent, AdjustmentListener, addAdjustmentListener, enableEvents

 protected String paramString()

返回表示当前滚动条状态的参数串。 该字符串对调试有用。

返回值：

表示滚动条的参数串。

覆盖:

> 类 Component 中的 paramString