全パッケージ  クラス階層  このパッケージ  前項目  次項目  インデックス

クラス java.awt.ScrollPane

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

public class ScrollPane
extends Container
1つの子コンポーネントに対して、自動水平または垂直スクローリングあるいはその両方を実装するコンテナクラスです。スクロールバーの表示ポリシーは、次のいずれかに設定することができます。
  1. as needed:スクロールバーはスクロールペインが必要としたときのみ作られ表示されます。
  2. always:スクロールバーは作られ、常にスクロールペインが表示します。
  3. never:スクロールバーは作られることもスクロールペインが表示することもありません。

子コンポーネントの位置合わせ状態は、Adjustable インタフェースを実装する 2 つのオブジェクト(各 dimension に1つ)で表されます。API は Adjustable オブジェクトの属性(unitIncrement や value など)を操作できるように、これらのオブジェクトをアクセスするメソッドを提供します。

特定の adjustable プロパティ(minimum、maximum、および visibleAmount)は、スクロールペインがスクロールペインとその子の geometry をもとに、内部的に設定するのでプログラムでスクロールペインを使用して設定しないでください。

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

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

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

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


Variable Index

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

Constructor Index

 o ScrollPane()
スクロールバー表示ポリシーが "as needed" の新しいスクロールペインコンテナを作る。
 o ScrollPane(int)
新しいスクロールペインコンテナを作る。

Method Index

 o addImpl(Component, Object, int)
指定されたコンポーネントをこのスクロールペインに追加する。
 o addNotify()
スクロールペインのピアを作る。
 o doLayout()
子のサイズを推奨サイズに変えて、このコンテナをレイアウトする。
 o getHAdjustable()
水平スクロールバーの状態を表す Adjustable オブジェクトを返す。
 o getHScrollbarHeight()
水平スクロールバーが占める高さを返す。これはスクロールペインが現在それを表示しているかどうかは無関係である。
 o getScrollbarDisplayPolicy()
スクロールバーの表示ポリシーを返す。
 o getScrollPosition()
スクロールされたパネルのビューポートの 0,0 位置に表示されている子の中の現在の x, y 位置を返す。
 o getVAdjustable()
垂直スクロールバーの状態を表す Adjustable オブジェクトを返す。
 o getViewportSize()
スクロールペインのビューポートの現在のサイズを返す。
 o getVScrollbarWidth()
垂直スクロールバーが占める幅を返す。これはスクロールペインが現在、それを表示しているかどうかは無関係である。
 o layout()
推奨されない。
 o paramString()
このコンテナのパラメータ String を返す。
 o printComponents(Graphics)
このスクロールペイン内のコンポーネントをプリントする。
 o setLayout(LayoutManager)
このコンテナのレイアウトマネージャを設定する。
 o setScrollPosition(int, int)
子コンポーネント内の指定された位置へスクロールする。
 o setScrollPosition(Point)
子コンポーネント内の指定された位置へスクロールする。

Variables

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

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

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

Constructors

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

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

パラメータ:
scrollbarDisplayPolicy - スクロールバーを表示する場合を示すポリシー

Methods

 o addImpl
  protected final void addImpl(Component comp,
                               Object constraints,
                               int index)
指定されたコンポーネントを、このスクロールペインコンテナに追加します。スクロールペインが既存の子コンポーネントを持つ場合、そのコンポーネントが取り除かれ、新しいコンポーネントが追加されます。

パラメータ:
comp - 追加するコンポーネント
constraints - 適用外
index - 子コンポーネントの位置 (<= 0 でなければならない)
オーバーライド:
クラス ContaineraddImpl
 o getScrollbarDisplayPolicy
  public int getScrollbarDisplayPolicy()
スクロールバーの表示ポリシーを返します。

返り値:
スクロールバーの表示ポリシー
 o getViewportSize
  public Dimension getViewportSize()
スクロールペインのビューポートの現在のサイズを返します。

返り値:
ピクセル単位のビューポートのサイズ
 o getHScrollbarHeight
  public int getHScrollbarHeight()
水平スクロールバーに占める高さを返します。これはスクロールペインが現在それを表示しているかどうかは無関係です。

返り値:
ピクセル単位の水平スクロールバーの高さ
 o getVScrollbarWidth
  public int getVScrollbarWidth()
垂直スクロールバーに占める幅を返します。これはスクロールペインが、現在それを表示しているかどうかは無関係です。

返り値:
ピクセル単位の垂直スクロールバーの幅
 o getVAdjustable
  public Adjustable getVAdjustable()
垂直スクロールバーの状態を表す Adjustable オブジェクトを返します。

 o getHAdjustable
  public Adjustable getHAdjustable()
垂直スクロールバーの状態を表す Adjustable オブジェクトを返します。

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

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

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

返り値:
現在のスクロール位置の座標位置
 o setLayout
  public final void setLayout(LayoutManager mgr)
このコンテナのレイアウトマネージャを設定します。レイアウトマネージャが設定されるのを防ぐにはこのメソッドをオーバーライドします。

パラメータ:
mgr - 指定するレイアウトマネージャ
オーバーライド:
クラス ContainersetLayout
 o doLayout
  public void doLayout()
子のサイズを推奨サイズに変更してこのコンテナをレイアウトします。子の新しい推奨サイズでは現在のスクロール位置が不正になる場合、スクロール位置は最も近い許される位置に設定されます。

オーバーライド:
クラス ContainerdoLayout
参照:
validate
 o layout
  public void layout()
注:layout() は推奨されません。 JDK バージョン 1.1 からは doLayout() で置き換わりました。

オーバーライド:
クラス Containerlayout
 o printComponents
  public void printComponents(Graphics g)
このスクロールペイン内のコンポーネントをプリントします。

パラメータ:
g - 指定グラフィックスウィンドウ
オーバーライド:
クラス ContainerprintComponents
参照:
print, printAll
 o addNotify
  public void addNotify()
スクロールペインのピアを作ります。

オーバーライド:
クラス ContaineraddNotify
 o paramString
  public String paramString()
このコンテナのパラメータ String を返します。

オーバーライド:
クラス ContainerparamString

全パッケージ  クラス階層  このパッケージ  前項目  次項目  インデックス