java.awt
クラス Scrollbar

java.lang.Object
  java.awt.Component
      java.awt.Scrollbar

すべての実装されたインタフェース:

Adjustable, ImageObserver, MenuContainer, Serializable, Accessible

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

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

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

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

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

• AdjustmentEvent.TRACK。この調整イベントは、ユーザーがスクロールバーのバブルをドラッグしたときに送出される
• AdjustmentEvent.UNIT_INCREMENT。この調整イベントは、ユーザーが水平スクロールバーの左矢印または垂直スクロールバーの上矢印をクリックするか、キーボードからそれに相当するジェスチャーを行なったときに送出される
• AdjustmentEvent.UNIT_DECREMENT。この調整イベントは、ユーザーが水平スクロールバーの右矢印または垂直スクロールバーの下矢印をクリックするか、キーボードからそれに相当するジェスチャーを行なったときに送出される
• AdjustmentEvent.BLOCK_INCREMENT。 この調整イベントは、ユーザーがトラック上で水平スクロールバーのバブルの左側または垂直スクロールバーのバブルの上側をクリックしたときに送出される。Page Up キーが定義されているキーボードをユーザーが使用している場合は、通常、Page Up キーがこれに相当する
• AdjustmentEvent.BLOCK_DECREMENT。 この調整イベントは、ユーザーがトラック上で水平スクロールバーのバブルの右側または垂直スクロールバーのバブルの下側をクリックしたときに送出される。Page Down キーが定義されているキーボードをユーザーが使用している場合は、通常、Page Down キーがこれに相当する

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

注 -Scrollbar は値の選択用にのみ使用することをお勧めします。コンテナ内にスクロール可能なコンポーネントを実装する場合は、ScrollPane を使用することをお勧めします。この目的で Scrollbar を使用すると、ペイント、キー処理、サイズ、位置に関する問題が発生する可能性があります。

導入されたバージョン:

JDK1.0

関連項目:

AdjustmentEvent, AdjustmentListener, 直列化された形式

入れ子のクラスの概要

protected class

Scrollbar.AccessibleAWTScrollBar このクラスは Scrollbar クラス用のアクセシビリティーのサポートを実装しています。

クラス java.awt.Component から継承された入れ子のクラス/インタフェース

Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

フィールドの概要

static int	HORIZONTAL 水平スクロールバーを示す定数です。
static int	VERTICAL 垂直スクロールバーを示す定数です。

クラス java.awt.Component から継承されたフィールド

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

インタフェース java.awt.Adjustable から継承されたフィールド

NO_ORIENTATION

インタフェース 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() Scrollbar のピアを作成します。
AccessibleContext	getAccessibleContext() この Scrollbar に関連付けられた AccessibleContext を返します。
AdjustmentListener[]	getAdjustmentListeners() このスクロールバーに登録されたすべての調整リスナーの配列を返します。
int	getBlockIncrement() このスクロールバーの「ブロック」増分値を返します。
int	getLineIncrement() 推奨されていません。 JDK Version 1.1 以降は、getUnitIncrement() に置き換えられました。
<T extends EventListener> T[]	getListeners(Class<T> listenerType) この Scrollbar に FooListener として、現在登録されているすべてのオブジェクトの配列を返します。
int	getMaximum() このスクロールバーの最大値を返します。
int	getMinimum() このスクロールバーの最小値を返します。
int	getOrientation() このスクロールバーの方向を返します。
int	getPageIncrement() 推奨されていません。 JDK Version 1.1 以降は、getBlockIncrement() に置き換えられました。
int	getUnitIncrement() このスクロールバーの「ユニット」増分値を返します。
int	getValue() このスクロールバーの現在値を返します。
boolean	getValueIsAdjusting() ユーザーがアクションを取得中であるために値の変更が進行している場合に、true を返します。
int	getVisible() 推奨されていません。 JDK Version 1.1 以降は、getVisibleAmount() に置き換えられました。
int	getVisibleAmount() このスクロールバーの可視量を返します。
protected String	paramString() この Scrollbar の状態を表す文字列を返します。
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 Version 1.1 以降は、setUnitIncrement(int) に置き換えられました。
void	setMaximum(int newMaximum) このスクロールバーの最大値を設定します。
void	setMinimum(int newMinimum) このスクロールバーの最小値を設定します。
void	setOrientation(int orientation) このスクロールバーの方向を設定します。
void	setPageIncrement(int v) 推奨されていません。 JDK Version 1.1 以降は、setBlockIncrement() に置き換えられました。
void	setUnitIncrement(int v) このスクロールバーの「ユニット」増分値を設定します。
void	setValue(int newValue) このスクロールバーの値を、指定された値に設定します。
void	setValueIsAdjusting(boolean b) valueIsAdjusting プロパティーを設定します。
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, addMouseWheelListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBaseline, getBaselineResizeBehavior, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeys, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusCycleRoot, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isPreferredSizeSet, 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, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeys, setFocusTraversalKeysEnabled, setFont, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setMaximumSize, setMinimumSize, setName, setPreferredSize, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle, 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()
          throws HeadlessException

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

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

例外:

HeadlessException - GraphicsEnvironment.isHeadless() が true を返す場合

関連項目:

GraphicsEnvironment.isHeadless()

Scrollbar

public Scrollbar(int orientation)
          throws HeadlessException

指定された方向の新しいスクロールバーを構築します。

orientation 引数は、水平スクロールバーを示す値である Scrollbar.HORIZONTAL または垂直スクロールバーを示す値である Scrollbar.VERTICAL のどちらかである必要があります。

パラメータ:

orientation - スクロールバーの方向を示す

例外:

IllegalArgumentException - orientation 引数に不正な値が指定された場合

HeadlessException - GraphicsEnvironment.isHeadless() が true を返す場合

関連項目:

GraphicsEnvironment.isHeadless()

Scrollbar

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

指定された方向、初期値、可視量、最小値、および最大値を持つ新しいスクロールバーを構築します。

orientation 引数は、水平スクロールバーを示す値である Scrollbar.HORIZONTAL または垂直スクロールバーを示す値である Scrollbar.VERTICAL のどちらかである必要があります。

このコンストラクタに指定されるパラメータは setValues(int, int, int, int) に記述された制約に従います。

パラメータ:

orientation - スクロールバーの方向を示す

value - スクロールバーの初期値

visible - このスクロールバーの可視量。一般にバブルのサイズで表される

minimum - スクロールバーの最小値

maximum - スクロールバーの最大値

例外:

IllegalArgumentException - orientation 引数に不正な値が指定された場合

HeadlessException - GraphicsEnvironment.isHeadless() が true を返す場合

関連項目:

setValues(int, int, int, int), GraphicsEnvironment.isHeadless()

メソッドの詳細

addNotify

public void addNotify()

Scrollbar のピアを作成します。ピアは Scrollbar の機能を変更せずに外観を変更できます。

オーバーライド:

クラス Component 内の addNotify

関連項目:

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)

このスクロールバーの値を、指定された値に設定します。

指定された値が現在の visibleAmount の minimum より小さい場合、または現在の maximum より大きい場合は、visibleAmount の minimum または maximum が適切な値に置き換えられます。

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

このメソッドを呼び出しても AdjustmentEvent はトリガーしません。

定義:

インタフェース 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)

このスクロールバーの最小値を設定します。

setMinimum を呼び出して、最小値を変更すると、その他の値 (最大値、可視量、および現在のスクロールバーの値) が新しい最小値に合わせて変更されます。

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

最小値を Integer.MAX_VALUE に設定すると、新しい最小値が Integer.MAX_VALUE - 1 に設定されます。

定義:

インタフェース 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)

このスクロールバーの最大値を設定します。

setMaximum を呼び出して、最大値を変更すると、その他の値 (最小値、可視量、および現在のスクロールバーの値) が新しい最大値に合わせて変更されます。

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

最大値を Integer.MIN_VALUE に設定すると、新しい最大値が Integer.MIN_VALUE + 1 に設定されます。

定義:

インタフェース Adjustable 内の setMaximum

パラメータ:

newMaximum - このスクロールバーの新しい最大値

導入されたバージョン:

JDK1.1

関連項目:

setValues(int, int, int, int), setMinimum(int)

getVisibleAmount

public int getVisibleAmount()

このスクロールバーの可視量を返します。

値の範囲の選択にスクロールバーを使用する場合、可視量を使用して、現在可視の値の範囲を表します。通常、スクロールバーのバブル (サムまたはスクロールボックスとも言う) のサイズによって、スクロールバーの範囲と可視量の関係を視覚的に表現します。

スクロールバーのバブルが移動不可能である場合 (バブルがスクロールバーのトラックの全体の長さを占める場合やスクロールバーが無効にされている場合など)、バブルが表示されないことがあります。バブルが表示されているかどうかは、getVisibleAmount によって返される値に関係ありません。

定義:

インタフェース Adjustable 内の getVisibleAmount

戻り値:

このスクロールバーの可視量

導入されたバージョン:

JDK1.1

関連項目:

setVisibleAmount(int)

getVisible

@Deprecated
public int getVisible()

推奨されていません。 JDK Version 1.1 以降は、getVisibleAmount() に置き換えられました。

setVisibleAmount

public void setVisibleAmount(int newAmount)

このスクロールバーの可視量を設定します。

値の範囲の選択にスクロールバーを使用する場合、可視量を使用して、現在可視の値の範囲を表します。通常、スクロールバーのバブル (サムまたはスクロールボックスとも言う) のサイズによって、スクロールバーの範囲と可視量の関係を視覚的に表現します。

スクロールバーのバブルが移動不可能である場合 (バブルがスクロールバーのトラックの全体の長さを占める場合やスクロールバーが無効にされている場合など)、バブルが表示されないことがあります。バブルが表示されているかどうかは、getVisibleAmount によって返される値に関係ありません。

指定された可視量が one より小さい場合、または現在の maximum - minimum の値より大きい場合は、one または maximum - minimum が適切な値に置き換えられます。

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

定義:

インタフェース Adjustable 内の setVisibleAmount

パラメータ:

newAmount - 新しい可視量

導入されたバージョン:

JDK1.1

関連項目:

getVisibleAmount(), setValues(int, int, int, int)

setUnitIncrement

public void setUnitIncrement(int v)

このスクロールバーの「ユニット」増分値を設定します。

ユニット増分値は、ユーザーがスクロールバーのユニット増分値領域をアクティブ化したときに加算または減算される値です。 これは通常、スクロールバーが調整イベントとして受け取るマウスジェスチャーまたはキーボードジェスチャーを通じて行われます。ユニット増分値はゼロより大きくなければいけません。ユニット増分値を 1 より小さい値に設定しようとすると、値 1 が設定されます。

定義:

インタフェース Adjustable 内の setUnitIncrement

パラメータ:

v - スクロールバーの値を増分または減分する量

導入されたバージョン:

JDK1.1

関連項目:

getUnitIncrement()

setLineIncrement

@Deprecated
public void setLineIncrement(int v)

推奨されていません。 JDK Version 1.1 以降は、setUnitIncrement(int) に置き換えられました。

getUnitIncrement

public int getUnitIncrement()

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

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

定義:

インタフェース Adjustable 内の getUnitIncrement

戻り値:

このスクロールバーの「ユニット」増分値

導入されたバージョン:

JDK1.1

関連項目:

setUnitIncrement(int)

getLineIncrement

@Deprecated
public int getLineIncrement()

推奨されていません。 JDK Version 1.1 以降は、getUnitIncrement() に置き換えられました。

setBlockIncrement

public void setBlockIncrement(int v)

このスクロールバーの「ブロック」増分値を設定します。

ブロック増分値は、ユーザーがスクロールバーのブロック増分値領域をアクティブ化したときに加算または減算される値です。 これは通常、スクロールバーが調整イベントとして受け取るマウスジェスチャーまたはキーボードジェスチャーを通じて行われます。ブロック増分値はゼロより大きくなければいけません。ブロック増分値を 1 より小さい値に設定しようとすると、値 1 が設定されます。

定義:

インタフェース Adjustable 内の setBlockIncrement

パラメータ:

v - スクロールバーの値を増分または減分する量

導入されたバージョン:

JDK1.1

関連項目:

getBlockIncrement()

setPageIncrement

@Deprecated
public void setPageIncrement(int v)

推奨されていません。 JDK Version 1.1 以降は、setBlockIncrement() に置き換えられました。

getBlockIncrement

public int getBlockIncrement()

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

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

定義:

インタフェース Adjustable 内の getBlockIncrement

戻り値:

このスクロールバーの「ブロック」増分値

導入されたバージョン:

JDK1.1

関連項目:

setBlockIncrement(int)

getPageIncrement

@Deprecated
public int getPageIncrement()

推奨されていません。 JDK Version 1.1 以降は、getBlockIncrement() に置き換えられました。

setValues

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

このスクロールバーの次の 4 つのプロパティーの値を設定します。value、visibleAmount、minimum、および maximum です。これらのプロパティーに設定された値が整合性がないかまたは不正な場合は、整合性を確保するよう変更されます。

このメソッドは、同時かつ同期的にこれら 4 つのスクロールバーのプロパティーの値を設定し、これらのプロパティーの値が相互に整合するようにします。これには、次の制約を適用する必要があります。この制約では、maximum は minimum より大きく、maximum - minimum は Integer.MAX_VALUE より大きく、visibleAmount はゼロより大きく、visibleAmount は maximum - minimum より大きくなく、value は minimum より小さくなく、value は maximum - visibleAmount より大きくないことが要求されます。

このメソッドを呼び出しても AdjustmentEvent はトリガーしません。

パラメータ:

value - 現在のウィンドウ内の位置

visible - スクロールバーの可視量

minimum - スクロールバーの最小値

maximum - スクロールバーの最大値

関連項目:

setMinimum(int), setMaximum(int), setVisibleAmount(int), setValue(int)

getValueIsAdjusting

public boolean getValueIsAdjusting()

ユーザーがアクションを取得中であるために値の変更が進行している場合に、true を返します。

戻り値:

valueIsAdjusting プロパティーの値

導入されたバージョン:

1.4

関連項目:

setValueIsAdjusting(boolean)

setValueIsAdjusting

public void setValueIsAdjusting(boolean b)

valueIsAdjusting プロパティーを設定します。

パラメータ:

b - 調整が進行中の新しい状態

導入されたバージョン:

1.4

関連項目:

getValueIsAdjusting()

addAdjustmentListener

public void addAdjustmentListener(AdjustmentListener l)

このスクロールバーから AdjustmentEvent のインスタンスを受け取るために、指定された調整リスナーを追加します。l が null の場合、例外はスローされず、処理も実行されません。

AWT スレッドモデルの詳細については、「AWT Threading Issues」を参照してください。

定義:

インタフェース Adjustable 内の addAdjustmentListener

パラメータ:

l - 調整リスナー

導入されたバージョン:

JDK1.1

関連項目:

removeAdjustmentListener(java.awt.event.AdjustmentListener), getAdjustmentListeners(), AdjustmentEvent, AdjustmentListener

removeAdjustmentListener

public void removeAdjustmentListener(AdjustmentListener l)

このスクロールバーから AdjustmentEvent のインスタンスを受け取らないように、指定された調整リスナーを削除します。l が null の場合、例外はスローされず、処理も実行されません。

AWT スレッドモデルの詳細については、「AWT Threading Issues」を参照してください。

定義:

インタフェース Adjustable 内の removeAdjustmentListener

パラメータ:

l - 調整リスナー

導入されたバージョン:

JDK1.1

関連項目:

addAdjustmentListener(java.awt.event.AdjustmentListener), getAdjustmentListeners(), AdjustmentEvent, AdjustmentListener

getAdjustmentListeners

public AdjustmentListener[] getAdjustmentListeners()

このスクロールバーに登録されたすべての調整リスナーの配列を返します。

戻り値:

このスクロールバーのすべての AdjustmentListener、または現在調整リスナーが登録されていない場合は空の配列

導入されたバージョン:

1.4

関連項目:

addAdjustmentListener(java.awt.event.AdjustmentListener), removeAdjustmentListener(java.awt.event.AdjustmentListener), AdjustmentEvent, AdjustmentListener

getListeners

public <T extends EventListener> T[] getListeners(Class<T> listenerType)

この Scrollbar に FooListener として、現在登録されているすべてのオブジェクトの配列を返します。FooListener は、addFooListener メソッドを使用して登録します。

FooListener.class といったクラスリテラルを使用して、listenerType 引数を指定できます。たとえば、次のコードを使用して、そのマウスリスナーの Scrollbar c を照会できます。

MouseListener[] mls = (MouseListener[])(c.getListeners(MouseListener.class));

このようなリスナーがない場合は空の配列を返します。

オーバーライド:

クラス Component 内の getListeners

パラメータ:

listenerType - 要求されるリスナーの型。java.util.EventListener の下位インタフェースを指定

戻り値:

コンポーネントに FooListener として登録されているすべてのオブジェクトの配列。リスナーが登録されていない場合は空の配列を返す

例外:

ClassCastException - listenerType が java.util.EventListener を実装するクラスまたはインタフェースを指定しない場合

導入されたバージョン:

1.3

関連項目:

Component.getComponentListeners(), Component.getFocusListeners(), Component.getHierarchyListeners(), Component.getHierarchyBoundsListeners(), Component.getKeyListeners(), Component.getMouseListeners(), Component.getMouseMotionListeners(), Component.getMouseWheelListeners(), Component.getInputMethodListeners(), Component.getPropertyChangeListeners()

processEvent

protected void processEvent(AWTEvent e)

このスクロールバーのイベントを処理します。イベントが AdjustmentEvent のインスタンスである場合は、processAdjustmentEvent メソッドを呼び出します。そうでない場合は、スーパークラスの processEvent メソッドを呼び出します。

イベントパラメータが null の場合の動作は定義されていないため例外がスローされます。

オーバーライド:

クラス Component 内の processEvent

パラメータ:

e - イベント

導入されたバージョン:

JDK1.1

関連項目:

AdjustmentEvent, processAdjustmentEvent(java.awt.event.AdjustmentEvent)

processAdjustmentEvent

protected void processAdjustmentEvent(AdjustmentEvent e)

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

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

• AdjustmentListener オブジェクトが addAdjustmentListener によって登録されている
• enableEvents によって調整イベントが使用可能になっている

イベントパラメータが null の場合の動作は定義されていないため例外がスローされます。

パラメータ:

e - 調整イベント

導入されたバージョン:

JDK1.1

関連項目:

AdjustmentEvent, AdjustmentListener, addAdjustmentListener(java.awt.event.AdjustmentListener), Component.enableEvents(long)

paramString

protected String paramString()

この Scrollbar の状態を表す文字列を返します。このメソッドはデバッグ専用であり、返される文字列の内容および形式は実装によって異なります。返される文字列は空の場合がありますが、null にはなりません。

オーバーライド:

クラス Component 内の paramString

戻り値:

このスクロールバーのパラメータ文字列

getAccessibleContext

public AccessibleContext getAccessibleContext()

この Scrollbar に関連付けられた AccessibleContext を返します。スクロールバーの場合、AccessibleContext は AccessibleAWTScrollBar の形式を取ります。必要に応じて、新しい AccessibleAWTScrollBar インスタンスが作成されます。

定義:

インタフェース Accessible 内の getAccessibleContext

オーバーライド:

クラス Component 内の getAccessibleContext

戻り値:

この ScrollBar の AccessibleContext として機能する AccessibleAWTScrollBar

導入されたバージョン:

1.3