JavaTM 2 Platform
Std. Ed. v1.3

java.awt
クラス Scrollbar

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Scrollbar
すべての実装インタフェース:
Accessible, Adjustable, ImageObserver, MenuContainer, Serializable

public class Scrollbar
extends Component
implements Adjustable, Accessible

Scrollbar クラスは、よく使用されるユーザインタフェースオブジェクトであるスクロールバーを実現します。スクロールバーは、ユーザが値の範囲から値を選択できるようにするための便利な手段を提供します。次の 3 つの垂直スクロールバーは、赤、緑、青の色成分を選択するためのスライダコントロールとして使用できます。

この例のスクロールバーは、それぞれ次のようなコードを使って作成できます。


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

また、スクロールバーは一定の値の範囲を表すことができます。たとえば、スクロールバーがテキストをスクロールするために使用される場合は、「バブル」または「サム」の幅は可視のテキストの量を表すことができます。範囲を表すスクロールバーの例を次に示します。

バブルによって表される値の範囲は、スクロールバーの可視範囲になります。この例の水平スクロールバーは次のようなコードで作成できます。


 ranger = new Scrollbar(Scrollbar.HORIZONTAL, 0, 60, 0, 300);
 add(ranger);

スクロールバーの実際の最大値は、maximum から visible を引いた値です。上記の例では、maximum が 300 で、visible が 60 なので、実際の最大値は 240 です。スクロールバーのトラックの範囲は、0 〜 300 です。バブルの左端は、スクロールバーの値を示します。

通常、ユーザは、マウスを使ったジェスチャーを行うことによりスクロールバーの値を変更します。たとえば、ユーザはスクロールバーのバブルを上下にドラッグしたり、スクロールバーの「ユニット」増分値領域または「ブロック」増分値領域をクリックしたりすることができます。また、キーボードジェスチャーをスクロールバーにマッピングすることもできます。通常、Page Up キーおよび Page Down キーは、スクロールバーの「ブロック」増分値領域および「ブロック」減分値領域のクリックに相当します。

ユーザがスクロールバーの値を変更すると、スクロールバーは AdjustmentEvent のインスタンスを受け取ります。スクロールバーはこのイベントを処理し、登録されているすべてのリスナーに渡します。

スクロールバーの値が変更されたときに通知を必要とするオブジェクトは、java.awt.event パッケージで定義されるインタフェース AdjustmentListener を実装する必要があります。addAdjustmentListener メソッドおよび removeAdjustmentListener メソッドを呼び出すことによって動的にリスナーを追加したり削除したりすることができます。

AdjustmentEvent クラスは、次に示す 5 つのタイプの調整イベントを定義します。

JDK 1.0 のイベントシステムは、下位互換性のためにサポートされていますが、新しいバージョンのプラットフォームでは使用しないでください。JDK 1.1 で導入された 5 つのタイプの調整イベントは、以前のバージョンのプラットフォームでスクロールバーに関連している 5 つのイベントタイプに対応しています。次のリストに、調整イベントタイプと、それらによって置き換えられた対応する JDK 1.0 イベントタイプを示します。

導入されたバージョン:
JDK1.0
関連項目:
AdjustmentEvent, AdjustmentListener, 直列化された形式

内部クラスの概要
protected  class Scrollbar.AccessibleAWTScrollBar
          このクラスは Scrollbar クラス用のユーザ補助機能のサポートを実装しています。
 
クラス java.awt.Component から継承した内部クラス
Component.AccessibleAWTComponent
 
フィールドの概要
static int HORIZONTAL
          水平スクロールバーを示す定数です。
static int VERTICAL
          垂直スクロールバーを示す定数です。
 
クラス java.awt.Component から継承したフィールド
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
インタフェース java.awt.image.ImageObserver から継承したフィールド
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
コンストラクタの概要
Scrollbar()
          新しい垂直スクロールバーを構築します。
Scrollbar(int orientation)
          指定された方向の新しいスクロールバーを構築します。
Scrollbar(int orientation, int value, int visible, int minimum, int maximum)
          指定された方向、初期値、ページサイズ、最小値、および最大値を持つ新しいスクロールバーを構築します。
 
メソッドの概要
 void addAdjustmentListener(AdjustmentListener l)
          このスクロールバーから AdjustmentEvent のインスタンスを受け取るために、指定された調整リスナーを追加します。
 void addNotify()
          スクロールバーのピアを作成します。
 AccessibleContext getAccessibleContext()
          この Scrollbar に関連した AccessibleContext を返します。
 int getBlockIncrement()
          このスクロールバーの「ブロック」増分値を返します。
 int getLineIncrement()
          推奨されていません。 JDK バージョン 1.1 以降は、getUnitIncrement() に置き換えられました。
 EventListener[] getListeners(Class listenerType)
          addXXXListener() によって Scrollbar に追加された全リスナーの配列を返します。
 int getMaximum()
          このスクロールバーの最大値を返します。
 int getMinimum()
          このスクロールバーの最小値を返します。
 int getOrientation()
          このスクロールバーの方向を判定します。
 int getPageIncrement()
          推奨されていません。 JDK バージョン 1.1 以降は、getBlockIncrement() に置き換えられました。
 int getUnitIncrement()
          このスクロールバーの「ユニット」増分値を返します。
 int getValue()
          このスクロールバーの現在値を返します。
 int getVisible()
          推奨されていません。 JDK バージョン 1.1 以降は、getVisibleAmount() に置き換えられました。
 int getVisibleAmount()
          このスクロールバーの可視量を返します。
protected  String paramString()
          このスクロールバーの状態を表すパラメータ文字列を返します。
protected  void processAdjustmentEvent(AdjustmentEvent e)
          このスクロールバーで発生する調整イベントを、登録されている AdjustmentListener オブジェクトにディスパッチすることにより、調整イベントを処理します。
protected  void processEvent(AWTEvent e)
          このスクロールバーのイベントを処理します。
 void removeAdjustmentListener(AdjustmentListener l)
          このスクロールバーから AdjustmentEvent のインスタンスを受け取らないように、指定された調整リスナーを削除します。
 void setBlockIncrement(int v)
          このスクロールバーの「ブロック」増分値を設定します。
 void setLineIncrement(int v)
          推奨されていません。 JDK バージョン 1.1 以降は、setUnitIncrement(int) に置き換えられました。
 void setMaximum(int newMaximum)
          このスクロールバーの最大値を設定します。
 void setMinimum(int newMinimum)
          このスクロールバーの最小値を設定します。
 void setOrientation(int orientation)
          このスクロールバーの方向を設定します。
 void setPageIncrement(int v)
          推奨されていません。 JDK バージョン 1.1 以降は、setBlockIncrement() に置き換えられました。
 void setUnitIncrement(int v)
          このスクロールバーの「ユニット」増分値を設定します。
 void setValue(int newValue)
          このスクロールバーの値を、指定された値に設定します。
 void setValues(int value, int visible, int minimum, int maximum)
          このスクロールバーの 4 つのプロパティの値を設定します。
 void setVisibleAmount(int newAmount)
          このスクロールバーの可視量を設定します。
 
クラス java.awt.Component から継承したメソッド
action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getName, getParent, getPeer, getPreferredSize, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paint, paintAll, postEvent, preferredSize, prepareImage, prepareImage, print, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFont, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, update, validate
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

HORIZONTAL

public static final int HORIZONTAL
水平スクロールバーを示す定数です。

VERTICAL

public static final int VERTICAL
垂直スクロールバーを示す定数です。
コンストラクタの詳細

Scrollbar

public Scrollbar()
新しい垂直スクロールバーを構築します。次の表は、スクロールバーのデフォルトプロパティを示しています。

プロパティ 説明 デフォルト値
orientation スクロールバーが垂直か水平かを示す Scrollbar.VERTICAL
value スクロールバーのバブルの位置 を制御する値 0
minimum スクロールバーの最小値 0
maximum スクロールバーの最大値 100
unit increment Page Up キーまたは Page Down キーが 押されたとき、またはスクロールバー の末尾の矢印がクリックされた場合に 値が変化する量 1
block increment Page Up キーまたは Page Down キーが 押されたとき、スクロールバーの トラックがバブルの片側でクリック された場合に値が変化する量 10

Scrollbar

public Scrollbar(int orientation)
指定された方向の新しいスクロールバーを構築します。

orientation 引数は、水平スクロールバーを示す値である Scrollbar.HORIZONTAL または垂直スクロールバーを示す値である Scrollbar.VERTICAL のどちらかでなければなりません。

パラメータ:
orientation - スクロールバーの方向を示す
例外:
IllegalArgumentException - orientation 引数に不正な値が指定された場合

Scrollbar

public Scrollbar(int orientation,
                 int value,
                 int visible,
                 int minimum,
                 int maximum)
指定された方向、初期値、ページサイズ、最小値、および最大値を持つ新しいスクロールバーを構築します。

orientation 引数は、水平スクロールバーを示す値である Scrollbar.HORIZONTAL または垂直スクロールバーを示す値である Scrollbar.VERTICAL のどちらかでなければなりません。

指定された最大値が最小値より小さい場合、最大値は最小値と同じ値に変更されます。初期値が最小値より小さい場合、初期値は最小値と同じ値に変更されます。初期値が最大値より大きい場合、初期値は最大値と同じ値に変更されます。

パラメータ:
orientation - スクロールバーの方向を示す
value - スクロールバーの初期値
visible - 可視部分を表すスクロールバーのバブルのサイズ。スクロールバーはページ単位でスクロールするときにこの値を使用する
minimum - スクロールバーの最小値
maximum - スクロールバーの最大値
メソッドの詳細

addNotify

public void addNotify()
スクロールバーのピアを作成します。ピアはスクロールバーの機能を変更せずに外観を変更できます。
オーバーライド:
クラス Component 内の addNotify
クラス java.awt.Component からコピーされたタグ:
関連項目:
Component.isDisplayable(), Component.removeNotify()

getOrientation

public int getOrientation()
このスクロールバーの方向を判定します。
定義:
インタフェース Adjustable 内の getOrientation
戻り値:
このスクロールバーの方向。Scrollbar.HORIZONTAL または Scrollbar.VERTICAL
関連項目:
setOrientation(int)

setOrientation

public void setOrientation(int orientation)
このスクロールバーの方向を設定します。
パラメータ:
orientation - このスクロールバーの方向。Scrollbar.HORIZONTAL または Scrollbar.VERTICAL
例外:
IllegalArgumentException - orientation に指定された値が不正な値である場合
導入されたバージョン:
JDK1.1
関連項目:
getOrientation()

getValue

public int getValue()
このスクロールバーの現在値を返します。
定義:
インタフェース Adjustable 内の getValue
戻り値:
このスクロールバーの現在の値
関連項目:
getMinimum(), getMaximum()

setValue

public void setValue(int newValue)
このスクロールバーの値を、指定された値に設定します。

指定された値が現在の最小値より小さい場合、この値は現在の最小値に置き換えられます。また、指定された値が現在の最大値より大きい場合、この値は現在の最大値に置き換えられます。

通常、プログラムは setValues を呼び出すことによってのみ、スクロールバーの値を変更します。setValues メソッドは、スクロールバーの最小値、最大値、可視量、および値プロパティを、互いに矛盾しないように同時に、同期的に設定します。

定義:
インタフェース Adjustable 内の setValue
パラメータ:
newValue - スクロールバーの新しい値
関連項目:
setValues(int, int, int, int), getValue(), getMinimum(), getMaximum()

getMinimum

public int getMinimum()
このスクロールバーの最小値を返します。
定義:
インタフェース Adjustable 内の getMinimum
戻り値:
このスクロールバーの最小値
関連項目:
getValue(), getMaximum()

setMinimum

public void setMinimum(int newMinimum)
このスクロールバーの最小値を設定します。

通常、プログラムは setValues を呼び出すことによってのみ、スクロールバーの最小値を変更します。setValues メソッドは、スクロールバーの最小値、最大値、可視量、および値プロパティを、互いに矛盾しないように同時に、同期的に設定します。

定義:
インタフェース Adjustable 内の setMinimum
パラメータ:
newMinimum - このスクロールバーの新しい最小値
導入されたバージョン:
JDK1.1
関連項目:
setValues(int, int, int, int), setMaximum(int)

getMaximum

public int getMaximum()
このスクロールバーの最大値を返します。
定義:
インタフェース Adjustable 内の getMaximum
戻り値:
このスクロールバーの最大値
関連項目:
getValue(), getMinimum()

setMaximum

public void setMaximum(int newMaximum)
このスクロールバーの最大値を設定します。

通常、プログラムは setValues を呼び出すことによってのみ、スクロールバーの最大値を変更します。setValues メソッドは、スクロールバーの最小値、最大値、可視量、および値プロパティを、互いに矛盾しないように同時に、同期的に設定します。

定義:
インタフェース Adjustable 内の setMaximum
パラメータ:
newMaximum - このスクロールバーの新しい最大値
導入されたバージョン:
JDK1.1
関連項目:
setValues(int, int, int, int), setMinimum(int)

getVisibleAmount

public int getVisibleAmount()
このスクロールバーの可視量を返します。

スクロールバーの可視量は、スクロールバーのバブルの幅によって表される値の範囲です。これはスクロールバーの「ブロック」増分値を判定するために使用されます。

定義:
インタフェース Adjustable 内の getVisibleAmount
戻り値:
このスクロールバーの可視量
導入されたバージョン:
JDK1.1
関連項目:
setVisibleAmount(int)

getVisible

public int getVisible()
推奨されていません。 JDK バージョン 1.1 以降は、getVisibleAmount() に置き換えられました。


setVisibleAmount

public void setVisibleAmount(int newAmount)
このスクロールバーの可視量を設定します。

スクロールバーの可視量は、スクロールバーのバブルの幅によって表される値の範囲です。これはスクロールバーの「ブロック」増分値を判定するために使用されます。

通常、プログラムは setValues を呼び出すことによってのみ、スクロールバーの値を変更します。setValues メソッドは、スクロールバーの最小値、最大値、可視量、および値プロパティを、互いに矛盾しないように同時に、同期的に設定します。

定義:
インタフェース Adjustable 内の setVisibleAmount
パラメータ:
newAmount - 1 ページ当りの表示量
導入されたバージョン:
JDK1.1
関連項目:
getVisibleAmount(), setValues(int, int, int, int)

setUnitIncrement

public void setUnitIncrement(int v)
このスクロールバーの「ユニット」増分値を設定します。

「ユニット」増分値は、ユーザがスクロールバーの「ユニット」増分値領域をアクティブ化したときに加算または減算される値です。これは通常、スクロールバーが調整イベントとして受け取るマウスジェスチャーまたはキーボードジェスチャーを通じて行われます。

定義:
インタフェース Adjustable 内の setUnitIncrement
パラメータ:
v - スクロールバーの値を増分または減分する量
導入されたバージョン:
JDK1.1
関連項目:
getUnitIncrement()

setLineIncrement

public void setLineIncrement(int v)
推奨されていません。 JDK バージョン 1.1 以降は、setUnitIncrement(int) に置き換えられました。


getUnitIncrement

public int getUnitIncrement()
このスクロールバーの「ユニット」増分値を返します。

「ユニット」増分値は、ユーザがスクロールバーの「ユニット」増分値領域をアクティブ化したときに加算または減算される値です。これは通常、スクロールバーが調整イベントとして受け取るマウスジェスチャーまたはキーボードジェスチャーを通じて行われます。

定義:
インタフェース Adjustable 内の getUnitIncrement
戻り値:
このスクロールバーの「ユニット」増分値
導入されたバージョン:
JDK1.1
関連項目:
setUnitIncrement(int)

getLineIncrement

public int getLineIncrement()
推奨されていません。 JDK バージョン 1.1 以降は、getUnitIncrement() に置き換えられました。


setBlockIncrement

public void setBlockIncrement(int v)
このスクロールバーの「ブロック」増分値を設定します。

「ブロック」増分値は、ユーザがスクロールバーの「ブロック」増分値領域をアクティブ化したときに加算または減算される値です。これは通常、スクロールバーが調整イベントとして受け取るマウスジェスチャーまたはキーボードジェスチャーを通じて行われます。

定義:
インタフェース Adjustable 内の setBlockIncrement
パラメータ:
v - スクロールバーの値を増分または減分する量
導入されたバージョン:
JDK1.1
関連項目:
getBlockIncrement()

setPageIncrement

public void setPageIncrement(int v)
推奨されていません。 JDK バージョン 1.1 以降は、setBlockIncrement() に置き換えられました。


getBlockIncrement

public int getBlockIncrement()
このスクロールバーの「ブロック」増分値を返します。

「ブロック」増分値は、ユーザがスクロールバーの「ブロック」増分値領域をアクティブ化したときに加算または減算される値です。これは通常、スクロールバーが調整イベントとして受け取るマウスジェスチャーまたはキーボードジェスチャーを通じて行われます。

定義:
インタフェース Adjustable 内の getBlockIncrement
戻り値:
このスクロールバーの「ブロック」増分値
導入されたバージョン:
JDK1.1
関連項目:
setBlockIncrement(int)

getPageIncrement

public int getPageIncrement()
推奨されていません。 JDK バージョン 1.1 以降は、getBlockIncrement() に置き換えられました。


setValues

public void setValues(int value,
                      int visible,
                      int minimum,
                      int maximum)
このスクロールバーの 4 つのプロパティの値を設定します。

このメソッドは、これらのプロパティの値が互いに矛盾しないことが保証されるように、スクロールバーの 4 つのプロパティ値を同時に、同期的に設定します。このメソッドは、最大値を最小値より小さくすることはできず、値を最小値より小さくしたり、最大値より大きくしたりできないという制約を適用します。

パラメータ:
value - 現在のウィンドウ内の位置
visible - 1 ページ当りの表示量
minimum - スクロールバーの最小値
maximum - スクロールバーの最大値

addAdjustmentListener

public void addAdjustmentListener(AdjustmentListener l)
このスクロールバーから AdjustmentEvent のインスタンスを受け取るために、指定された調整リスナーを追加します。l が null の場合、例外はスローされず、処理も実行されません。
定義:
インタフェース Adjustable 内の addAdjustmentListener
パラメータ:
l - 調整リスナー
導入されたバージョン:
JDK1.1
関連項目:
AdjustmentEvent, AdjustmentListener, removeAdjustmentListener(java.awt.event.AdjustmentListener)

removeAdjustmentListener

public void removeAdjustmentListener(AdjustmentListener l)
このスクロールバーから AdjustmentEvent のインスタンスを受け取らないように、指定された調整リスナーを削除します。l が null の場合、例外はスローされず、処理も実行されません。
定義:
インタフェース Adjustable 内の removeAdjustmentListener
パラメータ:
l - 調整リスナー
導入されたバージョン:
JDK1.1
関連項目:
AdjustmentEvent, AdjustmentListener, addAdjustmentListener(java.awt.event.AdjustmentListener)

getListeners

public EventListener[] getListeners(Class listenerType)
addXXXListener() によって Scrollbar に追加された全リスナーの配列を返します。XXX は listenerType の引数の名前です。たとえば、指定された Scrollbar s の AdjustmentListener(s) をすべて取得するには、次のように記述します。
 AdjustmentListener[] als = (AdjustmentListener[])(s.getListeners(AdjustmentListener.class))
該当するリスナーリストが存在しない場合は、空の配列が返されます。
オーバーライド:
クラス Component 内の getListeners
パラメータ:
listenerType - 要求されたリスナーのタイプ
戻り値:
このスクロールバーによってサポートされる、指定されたタイプのすべてのリスナー
導入されたバージョン:
1.3

processEvent

protected void processEvent(AWTEvent e)
このスクロールバーのイベントを処理します。イベントが AdjustmentEvent のインスタンスである場合は、processAdjustmentEvent メソッドを呼び出します。そうでない場合は、スーパークラスの processEvent メソッドを呼び出します。
オーバーライド:
クラス Component 内の processEvent
パラメータ:
e - イベント
導入されたバージョン:
JDK1.1
関連項目:
AdjustmentEvent, processAdjustmentEvent(java.awt.event.AdjustmentEvent)

processAdjustmentEvent

protected void processAdjustmentEvent(AdjustmentEvent e)
このスクロールバーで発生する調整イベントを、登録されている AdjustmentListener オブジェクトにディスパッチすることにより、調整イベントを処理します。

このコンポーネントに対して調整イベントが使用可能でない限り、このメソッドは呼び出されません。調整イベントは、次のどちらかの場合に使用可能になります。

パラメータ:
e - 調整イベント
導入されたバージョン:
JDK1.1
関連項目:
AdjustmentEvent, AdjustmentListener, addAdjustmentListener(java.awt.event.AdjustmentListener), Component.enableEvents(long)

paramString

protected String paramString()
このスクロールバーの状態を表すパラメータ文字列を返します。この文字列はデバッグの際に使用します。
オーバーライド:
クラス Component 内の paramString
戻り値:
このスクロールバーのパラメータ文字列

getAccessibleContext

public AccessibleContext getAccessibleContext()
この Scrollbar に関連した AccessibleContext を返します。スクロールバーの場合、AccessibleContext は AccessibleAWTScrollBar の形式を取ります。必要に応じて新しい AccessibleAWTScrollBar インスタンスを作成します。
定義:
インタフェース Accessible 内の getAccessibleContext
オーバーライド:
クラス Component 内の getAccessibleContext
戻り値:
この ScrollBar の AccessibleContext として機能する AccessibleAWTScrollBar

JavaTM 2 Platform
Std. Ed. v1.3

バグや機能要求の報告
さらに詳しい API リファレンスおよび開発者ドキュメントについては、 Java 2 SDK SE Developer Documentation を参照してください。このドキュメントには、概念、用語の定義、回避策、 実用的なコード例など、開発者を対象にした詳細な解説が掲載されています。

Java、Java 2D、JDBC は、米国およびその他の国における米国 Sun Microsystems, Inc. の商標もしくは登録商標です。
Copyright 1993-2000 Sun Microsystems, Inc. 901 San Antonio Road,
Palo Alto, California, 94303, U.S.A. All Rights Reserved.