java.awt
クラス ScrollPane

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--java.awt.ScrollPane

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

Accessible, ImageObserver, MenuContainer, Serializable

public class ScrollPane

extends Container

implements Accessible

1 つの子コンポーネントに対して、自動水平または垂直スクロールあるいはその両方を実装するコンテナクラスです。スクロールバーの表示ポリシーは、次のどれかに設定することができます。

1. as needed: スクロールバーはスクロールペインが必要としたときにだけ作成され表示されます。
2. always: スクロールバーは作成され、常にスクロールペインによって表示されます。
3. never: スクロールバーは作成されることも、スクロールペインによって表示されることもありません。

水平スクロールバーおよび垂直スクロールバーの状態は、Adjustable インタフェースを実装する 2 つの ScrollPaneAdjustable オブジェクト (次元ごとに 1 つずつ) によって表されます。API は Adjustable オブジェクトの属性 (unitIncrement や value など) を操作できるように、これらのオブジェクトにアクセスするメソッドを提供します。

一部の調節可能なプロパティ (minimum、maximum、blockIncrement、visibleAmount) は、スクロールペインおよびその子のジオメトリに従ってスクロールペインによって内部的に設定されます。これらのプロパティはスクロールペインを使ってプログラムで設定しないでください。

スクロールバーの表示ポリシーが "never" であれば、そのスクロールペインは setScrollPosition() メソッドを使用してプログラム的にスクロールすることができ、スクロールペインは移動して子の内容を適切にクリップします。このポリシーは、プログラムが独自の調節可能なコントロールを作成して管理しなければならないときに便利です。

スクロールバーの配置は、ユーザがプログラムの外で設定するプラットフォーム固有のプロパティで制御されます。

このコンテナの初期サイズは 100×100 に設定されていますが、setSize() を使用して変えることができます。

ホイールマウスのホイールによるスクロールはデフォルトで使用可能です。これは setWheelScrollingEnabled() を使って使用不可にできます。ホイールスクロールは水平および垂直方向の Adjustables の「ブロック」および「ユニット」増分値の設定によりカスタマイズできます。

Insets はスクロールバーが使用する任意の領域およびスクロールペインが作成する任意の境界を定義するために使われます。getInsets() を使用して insets の現在値を得ることができます。scrollbarsAlwaysVisible の値が false であれば、insets の値はスクロールバーが、現在可視状態かどうかによって動的に変化します。

関連項目:

直列化された形式

入れ子クラスの概要

protected class

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

クラス java.awt.Container から継承した入れ子クラス

クラス java.awt.Component から継承した入れ子クラス

Component.BltBufferStrategy, Component.FlipBufferStrategy

フィールドの概要

static int	SCROLLBARS_ALWAYS スクロールペインと子の大きさにかかわらず、常に水平/垂直スクロールバーを表示することを示します。
static int	SCROLLBARS_AS_NEEDED 子の大きさがスクロールペインの水平/垂直方向の大きさを超えるときにだけ、水平/垂直スクロールバーを表示することを示します。
static int	SCROLLBARS_NEVER スクロールペインと子の大きさにかかわらず、常に水平/垂直スクロールバーを表示しないことを示します。

クラス 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

コンストラクタの概要

ScrollPane()
スクロールバー表示ポリシーが "as needed" である新しいスクロールペインコンテナを作成します。

ScrollPane(int scrollbarDisplayPolicy)
新しいスクロールペインコンテナを作成します。

メソッドの概要

protected void	addImpl(Component comp, Object constraints, int index) 指定されたコンポーネントを、このスクロールペインコンテナに追加します。
void	addNotify() スクロールペインのピアを作成します。
void	doLayout() 子のサイズを推奨サイズに変更してこのコンテナをレイアウトします。
protected boolean	eventTypeEnabled(int type) ホイールスクロールが有効な場合、MouseWheelEvents に対して true を返します。
AccessibleContext	getAccessibleContext() この ScrollPane に関連した AccessibleContext を返します。
Adjustable	getHAdjustable() 水平スクロールバーの状態を表す ScrollPaneAdjustable オブジェクトを返します。
int	getHScrollbarHeight() 水平スクロールバーに占める高さを返します。
int	getScrollbarDisplayPolicy() スクロールバーの表示ポリシーを返します。
Point	getScrollPosition() スクロールしたペインのビューポートの 0, 0 位置に表示される子内の現在の x, y 位置を返します。
Adjustable	getVAdjustable() 垂直スクロールバーの状態を表す ScrollPaneAdjustable オブジェクトを返します。
Dimension	getViewportSize() スクロールペインのビューポートの現在のサイズを返します。
int	getVScrollbarWidth() 垂直スクロールバーに占める幅を返します。
boolean	isWheelScrollingEnabled() マウスホイールに応答してスクロールが行われるかどうかを示します。
void	layout() 推奨されていません。 JDK バージョン 1.1 以降は、doLayout() を使用
String	paramString() この ScrollPane の状態を表す文字列を返します。
void	printComponents(Graphics g) このスクロールペイン内のコンポーネントを出力します。
protected void	processMouseWheelEvent(MouseWheelEvent e) この ScrollPane を適切量スクロールして送信されるマウスホイールのイベントを処理します。
void	setLayout(LayoutManager mgr) このコンテナのレイアウトマネージャを設定します。
void	setScrollPosition(int x, int y) 子コンポーネント内の指定された位置へスクロールします。
void	setScrollPosition(Point p) 子コンポーネント内の指定された位置へスクロールします。
void	setWheelScrollingEnabled(boolean handleWheel) マウスホイールの移動に応答してスクロールを有効または無効にします。

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

add, add, add, add, add, addContainerListener, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getInsets, getLayout, getListeners, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, list, list, locate, minimumSize, paint, paintComponents, preferredSize, print, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, removeNotify, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setFont, transferFocusBackward, transferFocusDownCycle, update, validate, validateTree

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

action, add, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, createVolatileImage, createVolatileImage, disable, disableEvents, dispatchEvent, enable, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, getBackground, getBounds, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphics, getGraphicsConfiguration, getHeight, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isDoubleBuffered, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, printAll, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFocusable, setFocusTraversalKeysEnabled, setForeground, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, transferFocusUpCycle

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

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

フィールドの詳細

SCROLLBARS_AS_NEEDED

public static final int SCROLLBARS_AS_NEEDED

子の大きさがスクロールペインの水平/垂直方向の大きさを超えるときにだけ、水平/垂直スクロールバーを表示することを示します。

関連項目:

定数フィールド値

SCROLLBARS_ALWAYS

public static final int SCROLLBARS_ALWAYS

スクロールペインと子の大きさにかかわらず、常に水平/垂直スクロールバーを表示することを示します。

関連項目:

定数フィールド値

SCROLLBARS_NEVER

public static final int SCROLLBARS_NEVER

スクロールペインと子の大きさにかかわらず、常に水平/垂直スクロールバーを表示しないことを示します。

関連項目:

定数フィールド値

コンストラクタの詳細

ScrollPane

public ScrollPane()
           throws HeadlessException

スクロールバー表示ポリシーが "as needed" である新しいスクロールペインコンテナを作成します。

例外:

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

関連項目:

GraphicsEnvironment.isHeadless()

ScrollPane

public ScrollPane(int scrollbarDisplayPolicy)
           throws HeadlessException

新しいスクロールペインコンテナを作成します。

パラメータ:

scrollbarDisplayPolicy - スクロールバーを表示する場合を示すポリシー

例外:

IllegalArgumentException - 指定されたスクロールバーの表示ポリシーが無効な場合

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

関連項目:

GraphicsEnvironment.isHeadless()

メソッドの詳細

addImpl

protected final void addImpl(Component comp,
                             Object constraints,
                             int index)

指定されたコンポーネントを、このスクロールペインコンテナに追加します。スクロールペインが既存の子コンポーネントを持つ場合、そのコンポーネントが削除され、新しいコンポーネントが追加されます。

オーバーライド:

クラス Container 内の addImpl

パラメータ:

comp - 追加されるコンポーネント

constraints - 適用外

index - 子コンポーネントの位置 (<= 0 でなければならない)

関連項目:

Container.add(Component), Container.add(Component, int), Container.add(Component, java.lang.Object), LayoutManager, LayoutManager2

getScrollbarDisplayPolicy

public int getScrollbarDisplayPolicy()

スクロールバーの表示ポリシーを返します。

戻り値:

スクロールバーの表示ポリシー

getViewportSize

public Dimension getViewportSize()

スクロールペインのビューポートの現在のサイズを返します。

戻り値:

ピクセル単位のビューポートのサイズ

getHScrollbarHeight

public int getHScrollbarHeight()

水平スクロールバーに占める高さを返します。これは、スクロールペインが現在それを表示しているかどうかとは無関係です。

戻り値:

ピクセル単位の水平スクロールバーの高さ

getVScrollbarWidth

public int getVScrollbarWidth()

垂直スクロールバーに占める幅を返します。これは、スクロールペインが現在それを表示しているかどうかとは無関係です。

戻り値:

ピクセル単位の垂直スクロールバーの幅

getVAdjustable

public Adjustable getVAdjustable()

垂直スクロールバーの状態を表す ScrollPaneAdjustable オブジェクトを返します。このメソッドの宣言された戻り値の型は、下位互換を保持するために Adjustable になっています。

関連項目:

ScrollPaneAdjustable

getHAdjustable

public Adjustable getHAdjustable()

水平スクロールバーの状態を表す ScrollPaneAdjustable オブジェクトを返します。このメソッドの宣言された戻り値の型は、下位互換を保持するために Adjustable になっています。

関連項目:

ScrollPaneAdjustable

setScrollPosition

public void setScrollPosition(int x,
                              int y)

子コンポーネント内の指定された位置へスクロールします。このメソッドの呼び出しはスクロールペインが子を含む場合にだけ有効です。子が許されるスクロール範囲外の位置を指定した場合、もっとも近い許される位置へスクロールします。許される範囲は、矩形 x = 0、y = 0、幅 = (子の幅 - ビューポート幅)、高さ = (子の高さ - ビューポートの高さ) で定義されます。これはスクロールバーの状態を表す Adjustable オブジェクトとのインタフェースを持つ便利なメソッドです。

パラメータ:

x - スクロール先の x 位置

y - スクロール先の y 位置

例外:

NullPointerException - スクロールペインが子を含まない場合

setScrollPosition

public void setScrollPosition(Point p)

子コンポーネント内の指定された位置へスクロールします。このメソッドの呼び出しはスクロールペインが子を含む場合にだけ有効です。子が許されるスクロール範囲外の位置を指定した場合、もっとも近い許される位置へスクロールします。許される範囲は、矩形 x =0、y = 0、幅 = (子の幅 - ビューポート幅)、高さ = (子の高さ - ビューポートの高さ) で定義されます。これはスクロールバーの状態を表す Adjustable オブジェクトとのインタフェースを持つ便利なメソッドです。

パラメータ:

p - スクロール先の位置を表す点

getScrollPosition

public Point getScrollPosition()

スクロールしたペインのビューポートの 0, 0 位置に表示される子内の現在の x, y 位置を返します。これはスクロールバーの状態を表す Adjustable オブジェクトとのインタフェースを持つ便利なメソッドです。

戻り値:

現在のスクロール位置の座標位置

例外:

NullPointerException - スクロールペインが子を含まない場合

setLayout

public final void setLayout(LayoutManager mgr)

このコンテナのレイアウトマネージャを設定します。レイアウトマネージャが設定されるのを防ぐにはこのメソッドをオーバーライドします。

オーバーライド:

クラス Container 内の setLayout

パラメータ:

mgr - 指定されたレイアウトマネージャ

関連項目:

Container.doLayout(), Container.getLayout()

doLayout

public void doLayout()

子のサイズを推奨サイズに変更してこのコンテナをレイアウトします。子の新しい推奨サイズでは現在のスクロール位置が不正になる場合、スクロール位置はもっとも近い許される位置に設定されます。

オーバーライド:

クラス Container 内の doLayout

関連項目:

Component.validate()

layout

public void layout()

推奨されていません。 JDK バージョン 1.1 以降は、doLayout() を使用

オーバーライド:

クラス Container 内の layout

printComponents

public void printComponents(Graphics g)

このスクロールペイン内のコンポーネントを出力します。

オーバーライド:

クラス Container 内の printComponents

パラメータ:

g - 指定された Graphics ウィンドウ

関連項目:

Component.print(java.awt.Graphics), Component.printAll(java.awt.Graphics)

addNotify

public void addNotify()

スクロールペインのピアを作成します。

オーバーライド:

クラス Container 内の addNotify

関連項目:

Component.isDisplayable(), Container.removeNotify()

paramString

public String paramString()

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

オーバーライド:

クラス Container 内の paramString

戻り値:

このスクロールペインのパラメータ文字列

processMouseWheelEvent

protected void processMouseWheelEvent(MouseWheelEvent e)

この ScrollPane を適切量スクロールして送信されるマウスホイールのイベントを処理します。

イベントパラメータが null の場合、動作が指定されず例外が発生することに注意してください。

オーバーライド:

クラス Component 内の processMouseWheelEvent

パラメータ:

e - マウスホイールイベント

導入されたバージョン:

1.4

関連項目:

MouseWheelEvent, MouseWheelListener, Component.addMouseWheelListener(java.awt.event.MouseWheelListener), Component.enableEvents(long)

eventTypeEnabled

protected boolean eventTypeEnabled(int type)

ホイールスクロールが有効な場合、MouseWheelEvents に対して true を返します。

オーバーライド:

クラス Component 内の eventTypeEnabled

導入されたバージョン:

1.4

setWheelScrollingEnabled

public void setWheelScrollingEnabled(boolean handleWheel)

マウスホイールの移動に応答してスクロールを有効または無効にします。ホイールスクロールはデフォルトで有効です。

パラメータ:

handleWheel - MouseWheelEvent に対してスクロールが自動的に行われる場合は true、そうでない場合は false

導入されたバージョン:

1.4

関連項目:

isWheelScrollingEnabled(), MouseWheelEvent, MouseWheelListener

isWheelScrollingEnabled

public boolean isWheelScrollingEnabled()

マウスホイールに応答してスクロールが行われるかどうかを示します。ホイールスクロールはデフォルトで有効です。

導入されたバージョン:

1.4

関連項目:

setWheelScrollingEnabled(boolean)

getAccessibleContext

public AccessibleContext getAccessibleContext()

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

定義:

インタフェース Accessible 内の getAccessibleContext

オーバーライド:

クラス Component 内の getAccessibleContext

戻り値:

この ScrollPane の AccessibleContext として機能する AccessibleAWTScrollPane