javax.swing
クラス JScrollBar

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--javax.swing.JComponent
                    |
                    +--javax.swing.JScrollBar

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

Accessible, Adjustable, ImageObserver, MenuContainer, Serializable

直系の既知のサブクラス:

JScrollPane.ScrollBar

public class JScrollBar

extends JComponent

implements Adjustable, Accessible

スクロールバーの実装です。ユーザはスクロールバーのノブを移動して表示するコンテンツ領域を決めます。プログラムは、通常、スクロールバーの終端が表示可能コンテンツの終端または 100% になるように表示を調整します。スクロールバーの先端は表示可能コンテンツの先端または 0% になります。そのような境界内でのノブの位置は対応する表示可能コンテンツのパーセンテージに変換されます。

通常、スクロールバー内でのノブの位置が変更されると、基になるビュー内での JViewPort の位置に対して変更が行われ、JViewPort のコンテンツが変更されます。

警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースと互換ではなくなる予定です。現在の直列化のサポートは、短期間の運用や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。今後の Swing リリースでは、長期間の持続性をサポートする予定です。

関連項目:

JScrollPane, 直列化された形式

内部クラスの概要

protected class

JScrollBar.AccessibleJScrollBar このクラスは JScrollBar クラス用のユーザ補助機能のサポートを実装しています。

クラス javax.swing.JComponent から継承した内部クラス

JComponent.AccessibleJComponent

クラス java.awt.Container から継承した内部クラス

Container.AccessibleAWTContainer

クラス java.awt.Component から継承した内部クラス

Component.AccessibleAWTComponent

フィールドの概要

protected int	blockIncrement
protected BoundedRangeModel	model スクロールバーの最小値、最大値、長さ (可視量とも呼ぶ)、および現在値を表すモデルです。
protected int	orientation
protected int	unitIncrement

クラス javax.swing.JComponent から継承したフィールド

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

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

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

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

HORIZONTAL, VERTICAL

インタフェース java.awt.image.ImageObserver から継承したフィールド

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

コンストラクタの概要

JScrollBar()
以下の初期値を指定して垂直スクロールバーを作成します。

JScrollBar(int orientation)
方向と以下の初期値を指定してスクロールバーを作成します。

JScrollBar(int orientation, int value, int extent, int min, int max)
方向、値、長さ、最小値、最大値を指定してスクロールバーを作成します。

メソッドの概要

void	addAdjustmentListener(AdjustmentListener l) AdjustmentListener を追加します。
protected void	fireAdjustmentValueChanged(int id, int type, int value)
AccessibleContext	getAccessibleContext() この JScrollBar に関連した AccessibleContext を返します。
int	getBlockIncrement() java.awt.Scrollbar との下位互換性のために提供されるメソッドです。
int	getBlockIncrement(int direction) ブロック (通常は「ページ」) アップ/ダウン要求に対応する、スクロールバーの値を変更する量を返します。
int	getMaximum() スクロールバーの最大値は、最大値 - 長さになります。
Dimension	getMaximumSize() スクロールバーはスクロール軸に沿った方向では自由にサイズ変更できますが、もう一方の軸の方向のサイズは固定になります。
int	getMinimum() スクロールバーによってサポートされている最小値を返します (通常は 0)。
Dimension	getMinimumSize() スクロールバーはスクロール軸に沿った方向では自由にサイズ変更できますが、もう一方の軸の方向のサイズは固定になります。
BoundedRangeModel	getModel() 最小値、最大値、値、長さという、スクロールバーの 4 つの基本プロパティを処理するデータモデルを返します。
int	getOrientation() コンポーネントの方向 (水平または垂直) を返します。
ScrollBarUI	getUI() コンポーネントの Look & Feel を実装する委譲オブジェクトを返します。
String	getUIClassID() このコンポーネントの LookAndFeel クラスの名前を返します。
int	getUnitIncrement() java.awt.Scrollbar との下位互換性のために提供されるメソッドです。
int	getUnitIncrement(int direction) ユニットアップ/ダウン要求に対応するスクロールバーの値を変更する量を返します。
int	getValue() スクロールバーの値を返します。
boolean	getValueIsAdjusting() スクロールバーのノブがドラッグされている場合に true を返します。
int	getVisibleAmount() スクロールバーの長さ、つまり 「visibleAmount」を返します。
boolean	isFocusTraversable() このコンポーネントがフォーカスを受け取れるかどうかを判定します。
protected String	paramString() この JScrollBar の文字列表現を返します。
void	removeAdjustmentListener(AdjustmentListener l) AdjustmentEvent リスナーを削除します。
void	setBlockIncrement(int blockIncrement) blockIncrement プロパティを設定します。
void	setEnabled(boolean x) コンポーネントを使用可能にして、ノブの位置が変更できるようにします。
void	setMaximum(int maximum) モデルの最大値プロパティを設定します。
void	setMinimum(int minimum) モデルの最小値プロパティを設定します。
void	setModel(BoundedRangeModel newModel) 最小値、最大値、値、長さという、スクロールバーの 4 つの基本プロパティを処理するデータモデルを設定します。
void	setOrientation(int orientation) スクロールバーの方向を水平または垂直に設定します。
void	setUnitIncrement(int unitIncrement) unitIncrement プロパティを設定します。
void	setValue(int value) スクロールバーの値を設定します。
void	setValueIsAdjusting(boolean b) モデルの valueIsAdjusting プロパティを設定します。
void	setValues(int newValue, int newExtent, int newMin, int newMax) 引数が次の通常の制約に従うように強制したあとで、4 つの BoundedRangeModel プロパティを設定します。
void	setVisibleAmount(int extent) モデルの長さプロパティを設定します。
void	updateUI() JComponent.updateUI をオーバーライドします。

クラス javax.swing.JComponent から継承したメソッド

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getVerifyInputWhenFocusTarget, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, hide, isDoubleBuffered, isFocusCycleRoot, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processFocusEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDoubleBuffered, setFont, setForeground, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVerifyInputWhenFocusTarget, setVisible, unregisterKeyboardAction, update

クラス java.awt.Container から継承したメソッド

add, add, add, add, add, addContainerListener, addImpl, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getLayout, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setLayout, validate, validateTree

クラス java.awt.Component から継承したメソッド

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, getBackground, getBounds, getColorModel, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocationOnScreen, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, imageUpdate, inside, isDisplayable, isEnabled, isLightweight, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus

クラス java.lang.Object から継承したメソッド

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

フィールドの詳細

model

protected BoundedRangeModel model

スクロールバーの最小値、最大値、長さ (可視量とも呼ぶ)、および現在値を表すモデルです。

関連項目:

setModel(javax.swing.BoundedRangeModel)

orientation

protected int orientation

関連項目:

setOrientation(int)

unitIncrement

protected int unitIncrement

関連項目:

setUnitIncrement(int)

blockIncrement

protected int blockIncrement

関連項目:

setBlockIncrement(int)

コンストラクタの詳細

JScrollBar

public JScrollBar(int orientation,
                  int value,
                  int extent,
                  int min,
                  int max)

方向、値、長さ、最小値、最大値を指定してスクロールバーを作成します。「長さ」とは、表示可能領域のサイズのことで、「可視量」とも呼びます。

注: setBlockIncrement を使うと、「ブロック」増分値をビューの長さより少し小さいサイズに設定できます。その場合、ユーザがノブを隣の位置に移動すると、元のコンテンツの 1 行または 2 行がビューに残ります。

例外:

IllegalArgumentException - 方向が VERTICAL、HORIZONTAL のどちらでもない場合

関連項目:

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

JScrollBar

public JScrollBar(int orientation)

方向と以下の初期値を指定してスクロールバーを作成します。

 minimum = 0 
 maximum = 100 
 value = 0
 extent = 10

JScrollBar

public JScrollBar()

以下の初期値を指定して垂直スクロールバーを作成します。

 minimum = 0 
 maximum = 100 
 value = 0
 extent = 10

メソッドの詳細

getUI

public ScrollBarUI getUI()

コンポーネントの Look & Feel を実装する委譲オブジェクトを返します。

関連項目:

JComponent.setUI(javax.swing.plaf.ComponentUI)

updateUI

public void updateUI()

JComponent.updateUI をオーバーライドします。

オーバーライド:

クラス JComponent 内の updateUI

関連項目:

JComponent.updateUI()

getUIClassID

public String getUIClassID()

このコンポーネントの LookAndFeel クラスの名前を返します。

オーバーライド:

クラス JComponent 内の getUIClassID

戻り値:

ScrollBarUI

関連項目:

JComponent.getUIClassID(), UIDefaults.getUI(javax.swing.JComponent)

getOrientation

public int getOrientation()

コンポーネントの方向 (水平または垂直) を返します。

定義:

インタフェース Adjustable 内の getOrientation

戻り値:

HORIZONTAL または VERTICAL

関連項目:

setOrientation(int), Adjustable.getOrientation()

setOrientation

public void setOrientation(int orientation)

スクロールバーの方向を水平または垂直に設定します。

例外:

IllegalArgumentException - 方向が VERTICAL、HORIZONTAL のどちらでもない場合

関連項目:

getOrientation()

getModel

public BoundedRangeModel getModel()

最小値、最大値、値、長さという、スクロールバーの 4 つの基本プロパティを処理するデータモデルを返します。

関連項目:

setModel(javax.swing.BoundedRangeModel)

setModel

public void setModel(BoundedRangeModel newModel)

最小値、最大値、値、長さという、スクロールバーの 4 つの基本プロパティを処理するデータモデルを設定します。

関連項目:

getModel()

getUnitIncrement

public int getUnitIncrement(int direction)

ユニットアップ/ダウン要求に対応するスクロールバーの値を変更する量を返します。通常 ScrollBarUI の実装は、ユーザがスクロールバーの上矢印または下矢印をクリックして、その結果を使ってスクロールバーの値を更新したときにこのメソッドを呼び出します。サブクラスはこのメソッドをオーバーライドして、値、たとえば、1 (可変の高さ) 行のテキストまたはテーブルの 1 行を上下にスクロールするのに必要な変更量を算出することもあります。

JScrollPane コンポーネントは、このメソッドをオーバーライドし、ビューポートの Scrollable ビューがあればそれに委譲するスクロールバーを作成します (デフォルト)。Scrollable インタフェースは、このメソッドのより特殊なバージョンを提供します。

パラメータ:

direction - アップの場合は -1、ダウンの場合は 1

戻り値:

unitIncrement プロパティの値

関連項目:

setUnitIncrement(int), setValue(int), Scrollable.getScrollableUnitIncrement(java.awt.Rectangle, int, int)

setUnitIncrement

public void setUnitIncrement(int unitIncrement)

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

定義:

インタフェース Adjustable 内の setUnitIncrement

関連項目:

getUnitIncrement(int)

getBlockIncrement

public int getBlockIncrement(int direction)

ブロック (通常は「ページ」) アップ/ダウン要求に対応する、スクロールバーの値を変更する量を返します。ScrollBarUI の実装は、通常、ユーザがスクロールバーの「ノブ」の上下をクリックして大量に上下に値を変更したときにこのメソッドを呼び出します。サブクラスはこのメソッドをオーバーライドして値、たとえばテキストドキュメント内で 1 段落上または下にスクロールするのに必要な変更量を算出することもあります。

JScrollPane コンポーネントは、このメソッドをオーバーライドし、ビューポートの Scrollable ビューがあればそれに委譲するスクロールバーを作成します (デフォルト)。Scrollable インタフェースは、このメソッドのより特殊なバージョンを提供します。

パラメータ:

direction - アップの場合は -1、ダウンの場合は 1

戻り値:

blockIncrement プロパティの値

関連項目:

setBlockIncrement(int), setValue(int), Scrollable.getScrollableBlockIncrement(java.awt.Rectangle, int, int)

setBlockIncrement

public void setBlockIncrement(int blockIncrement)

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

定義:

インタフェース Adjustable 内の setBlockIncrement

関連項目:

getBlockIncrement()

getUnitIncrement

public int getUnitIncrement()

java.awt.Scrollbar との下位互換性のために提供されるメソッドです。

定義:

インタフェース Adjustable 内の getUnitIncrement

関連項目:

Adjustable.getUnitIncrement(), getUnitIncrement(int)

getBlockIncrement

public int getBlockIncrement()

java.awt.Scrollbar との下位互換性のために提供されるメソッドです。

定義:

インタフェース Adjustable 内の getBlockIncrement

関連項目:

Adjustable.getBlockIncrement(), getBlockIncrement(int)

getValue

public int getValue()

スクロールバーの値を返します。

定義:

インタフェース Adjustable 内の getValue

戻り値:

モデルの値プロパティ

関連項目:

setValue(int)

setValue

public void setValue(int value)

スクロールバーの値を設定します。このメソッドは値をモデルに転送するだけです。

定義:

インタフェース Adjustable 内の setValue

関連項目:

getValue(), BoundedRangeModel.setValue(int)

getVisibleAmount

public int getVisibleAmount()

スクロールバーの長さ、つまり 「visibleAmount」を返します。多くのスクロールバーの Look & Feel の実装で、スクロールバーの「ノブ」または「サム」のサイズはスクロールバーの長さに比例します。

定義:

インタフェース Adjustable 内の getVisibleAmount

戻り値:

モデルの長さプロパティの値

関連項目:

setVisibleAmount(int)

setVisibleAmount

public void setVisibleAmount(int extent)

モデルの長さプロパティを設定します。

定義:

インタフェース Adjustable 内の setVisibleAmount

関連項目:

getVisibleAmount(), BoundedRangeModel.setExtent(int)

getMinimum

public int getMinimum()

スクロールバーによってサポートされている最小値を返します (通常は 0)。

定義:

インタフェース Adjustable 内の getMinimum

戻り値:

モデルの最小値プロパティの値

関連項目:

setMinimum(int)

setMinimum

public void setMinimum(int minimum)

モデルの最小値プロパティを設定します。

定義:

インタフェース Adjustable 内の setMinimum

関連項目:

getMinimum(), BoundedRangeModel.setMinimum(int)

getMaximum

public int getMaximum()

スクロールバーの最大値は、最大値 - 長さになります。

定義:

インタフェース Adjustable 内の getMaximum

戻り値:

モデルの最大値プロパティの値

関連項目:

setMaximum(int)

setMaximum

public void setMaximum(int maximum)

モデルの最大値プロパティを設定します。スクロールバーの値は、最大値 - 長さまでしか設定できないことに注意してください。

定義:

インタフェース Adjustable 内の setMaximum

関連項目:

getMaximum(), BoundedRangeModel.setMaximum(int)

getValueIsAdjusting

public boolean getValueIsAdjusting()

スクロールバーのノブがドラッグされている場合に true を返します。

戻り値:

モデルの valueIsAdjusting プロパティの値

関連項目:

setValueIsAdjusting(boolean)

setValueIsAdjusting

public void setValueIsAdjusting(boolean b)

モデルの valueIsAdjusting プロパティを設定します。スクロールバーの Look & Feel の実装は、ノブのドラッグが開始されるとこのプロパティを true に設定し、ドラッグが終了すると false に設定します。valueIsAdjusting が true の場合、スクロールバーモデルは ChangeEvent を生成しません。

関連項目:

getValueIsAdjusting(), BoundedRangeModel.setValueIsAdjusting(boolean)

setValues

public void setValues(int newValue,
                      int newExtent,
                      int newMin,
                      int newMax)

引数が次の通常の制約に従うように強制したあとで、4 つの BoundedRangeModel プロパティを設定します。

 minimum <= value <= value+extent <= maximum

関連項目:

BoundedRangeModel.setRangeProperties(int, int, int, int, boolean), setValue(int), setVisibleAmount(int), setMinimum(int), setMaximum(int)

addAdjustmentListener

public void addAdjustmentListener(AdjustmentListener l)

AdjustmentListener を追加します。調整リスナーは、スクロールバーのモデルが変更されるたびに通知を受けます。Adjustment イベントは java.awt.Scrollbar との下位互換性のために提供されています。

AdjustmentEvent タイプのプロパティは、常に AdjustmentEvent.TRACK のプレースホルダ値を持つことに注意してください。これは BoundedRangeModel 値に対する変更はすべて等価と見なされるためです。BoundedRangeModel の値を変更するには、値プロパティ、つまり model.setValue(123) を設定するだけです。たとえばブロックデクリメントであるなど、変更の原因についての情報は提供されません。ここで変更の原因を作り出すこともしません。

定義:

インタフェース Adjustable 内の addAdjustmentListener

パラメータ:

l - 追加する AdjustmentLister

関連項目:

removeAdjustmentListener(java.awt.event.AdjustmentListener), BoundedRangeModel.addChangeListener(javax.swing.event.ChangeListener)

removeAdjustmentListener

public void removeAdjustmentListener(AdjustmentListener l)

AdjustmentEvent リスナーを削除します。

定義:

インタフェース Adjustable 内の removeAdjustmentListener

パラメータ:

l - 削除する AdjustmentLister

関連項目:

addAdjustmentListener(java.awt.event.AdjustmentListener)

fireAdjustmentValueChanged

protected void fireAdjustmentValueChanged(int id,
                                          int type,
                                          int value)

getMinimumSize

public Dimension getMinimumSize()

スクロールバーはスクロール軸に沿った方向では自由にサイズ変更できますが、もう一方の軸の方向のサイズは固定になります。

オーバーライド:

クラス JComponent 内の getMinimumSize

クラス javax.swing.JComponent からコピーされたタグ:

戻り値:

minimumSize プロパティの値

関連項目:

JComponent.setMinimumSize(java.awt.Dimension)

getMaximumSize

public Dimension getMaximumSize()

スクロールバーはスクロール軸に沿った方向では自由にサイズ変更できますが、もう一方の軸の方向のサイズは固定になります。

オーバーライド:

クラス JComponent 内の getMaximumSize

クラス javax.swing.JComponent からコピーされたタグ:

戻り値:

maximumSize プロパティの値

関連項目:

JComponent.setMaximumSize(java.awt.Dimension)

setEnabled

public void setEnabled(boolean x)

コンポーネントを使用可能にして、ノブの位置が変更できるようにします。使用可能でない場合は、ノブの位置は変更できません。

オーバーライド:

クラス JComponent 内の setEnabled

パラメータ:

b - boolean 値。true の場合はコンポーネントは使用可能で、false の場合は使用不可

isFocusTraversable

public boolean isFocusTraversable()

このコンポーネントがフォーカスを受け取れるかどうかを判定します。JScrollBar がフォーカストラバーサルに関係しないと false を返します。

オーバーライド:

クラス JComponent 内の isFocusTraversable

戻り値:

このコンポーネントがフォーカスを受け取れる場合は true

paramString

protected String paramString()

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

オーバーライド:

クラス JComponent 内の paramString

戻り値:

この JScrollBar の文字列表現

getAccessibleContext

public AccessibleContext getAccessibleContext()

この JScrollBar に関連した AccessibleContext を返します。JScrollBar の場合、AccessibleContext は AccessibleJScrollBar の形式を取ります。必要に応じて新規の AccessibleJScrollBar インスタンスが作成されます。

定義:

インタフェース Accessible 内の getAccessibleContext

オーバーライド:

クラス JComponent 内の getAccessibleContext

戻り値:

この JScroolBar の AccessibleContext として機能する AccessibleJScrollBar