JavaTM 2 Platform
Std. Ed. v1.3

javax.swing
クラス ScrollPaneLayout

java.lang.Object
  |
  +--javax.swing.ScrollPaneLayout
すべての実装インタフェース:
LayoutManager, ScrollPaneConstants, Serializable
直系の既知のサブクラス:
ScrollPaneLayout.UIResource

public class ScrollPaneLayout
extends Object
implements LayoutManager, ScrollPaneConstants, Serializable

JScrollPane が使用するレイアウトマネージャです。ビューポート、2 つのスクロールバー、行ヘッダ、列ヘッダ、および 4 つの「コーナー」コンポーネントを扱います。

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

関連項目:
JScrollPane, JViewport, 直列化された形式

内部クラスの概要
static class ScrollPaneLayout.UIResource
          ScrollPaneLayout の UI リソースバージョンです。
 
フィールドの概要
protected  JViewport colHead
          列ヘッダの子です。
protected  JScrollBar hsb
          スクロールペインの水平スクロールバーの子です。
protected  int hsbPolicy
          水平スクロールバーの表示ポリシーです。
protected  Component lowerLeft
          左下隅に表示するコンポーネントです。
protected  Component lowerRight
          右下隅に表示するコンポーネントです。
protected  JViewport rowHead
          行ヘッダの子です。
protected  Component upperLeft
          左上隅に表示するコンポーネントです。
protected  Component upperRight
          右上隅に表示するコンポーネントです。
protected  JViewport viewport
          スクロールペインのビューポートの子です。
protected  JScrollBar vsb
          スクロールペインの垂直スクロールバーの子です。
protected  int vsbPolicy
          垂直スクロールバーの表示ポリシーです。
 
インタフェース javax.swing.ScrollPaneConstants から継承したフィールド
COLUMN_HEADER, HORIZONTAL_SCROLLBAR, HORIZONTAL_SCROLLBAR_ALWAYS, HORIZONTAL_SCROLLBAR_AS_NEEDED, HORIZONTAL_SCROLLBAR_NEVER, HORIZONTAL_SCROLLBAR_POLICY, LOWER_LEADING_CORNER, LOWER_LEFT_CORNER, LOWER_RIGHT_CORNER, LOWER_TRAILING_CORNER, ROW_HEADER, UPPER_LEADING_CORNER, UPPER_LEFT_CORNER, UPPER_RIGHT_CORNER, UPPER_TRAILING_CORNER, VERTICAL_SCROLLBAR, VERTICAL_SCROLLBAR_ALWAYS, VERTICAL_SCROLLBAR_AS_NEEDED, VERTICAL_SCROLLBAR_NEVER, VERTICAL_SCROLLBAR_POLICY, VIEWPORT
 
コンストラクタの概要
ScrollPaneLayout()
           
 
メソッドの概要
 void addLayoutComponent(String s, Component c)
          指定されたコンポーネントをレイアウトに追加します。
protected  Component addSingletonComponent(Component oldC, Component newC)
          既存のコンポーネントを削除するのに使うメソッドです。
 JViewport getColumnHeader()
          列ヘッダである JViewport オブジェクトを返します。
 Component getCorner(String key)
          指定されたコーナーの Component を返します。
 JScrollBar getHorizontalScrollBar()
          水平スクロールを処理する JScrollBar オブジェクトを返します。
 int getHorizontalScrollBarPolicy()
          水平スクロールバーの表示ポリシーを返します。
 JViewport getRowHeader()
          行ヘッダである JViewport オブジェクトを返します。
 JScrollBar getVerticalScrollBar()
          垂直スクロールを処理する JScrollBar オブジェクトを返します。
 int getVerticalScrollBarPolicy()
          垂直スクロールバーの表示ポリシーを返します。
 JViewport getViewport()
          スクロール可能なコンテンツを表示する JViewport オブジェクトを返します。
 Rectangle getViewportBorderBounds(JScrollPane scrollpane)
          推奨されていません。 JDK バージョン Swing1.1 以降は、JScrollPane.getViewportBorderBounds() に置き換えられました。
 void layoutContainer(Container parent)
          スクロールペインを配置します。
 Dimension minimumLayoutSize(Container parent)
          ScrollPane の最小サイズは、インセットのサイズに、ビューポートの最小サイズ、スクロールペインのビューポート境界のインセット、表示ヘッダの最小サイズ、および表示ポリシーが NEVER ではないスクロールバーの最小サイズを加えた値です。
 Dimension preferredLayoutSize(Container parent)
          ScrollPane の適切なサイズは、インセットのサイズに、ビューポート、表示ヘッダ、および現在のビューと表示ポリシーによって表示されるスクロールバーの適切なサイズを加えた値です。
 void removeLayoutComponent(Component c)
          指定されたコンポーネントをレイアウトから削除します。
 void setHorizontalScrollBarPolicy(int x)
          水平スクロールバーの表示ポリシーを設定します。
 void setVerticalScrollBarPolicy(int x)
          垂直スクロールバーの表示ポリシーを設定します。
 void syncWithScrollPane(JScrollPane sp)
          このメソッドは、JScrollPane のレイアウトマネージャを設定したあとに呼び出さなければなりません。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

viewport

protected JViewport viewport
スクロールペインのビューポートの子です。デフォルトは空の JViewport です。
関連項目:
JScrollPane.setViewport(javax.swing.JViewport)

vsb

protected JScrollBar vsb
スクロールペインの垂直スクロールバーの子です。デフォルトは JScrollBar です。
関連項目:
JScrollPane.setVerticalScrollBar(javax.swing.JScrollBar)

hsb

protected JScrollBar hsb
スクロールペインの水平スクロールバーの子です。デフォルトは JScrollBar です。
関連項目:
JScrollPane.setHorizontalScrollBar(javax.swing.JScrollBar)

rowHead

protected JViewport rowHead
行ヘッダの子です。デフォルトは null です。
関連項目:
JScrollPane.setRowHeader(javax.swing.JViewport)

colHead

protected JViewport colHead
列ヘッダの子です。デフォルトは null です。
関連項目:
JScrollPane.setColumnHeader(javax.swing.JViewport)

lowerLeft

protected Component lowerLeft
左下隅に表示するコンポーネントです。デフォルトは null です。
関連項目:
JScrollPane.setCorner(java.lang.String, java.awt.Component)

lowerRight

protected Component lowerRight
右下隅に表示するコンポーネントです。デフォルトは null です。
関連項目:
JScrollPane.setCorner(java.lang.String, java.awt.Component)

upperLeft

protected Component upperLeft
左上隅に表示するコンポーネントです。デフォルトは null です。
関連項目:
JScrollPane.setCorner(java.lang.String, java.awt.Component)

upperRight

protected Component upperRight
右上隅に表示するコンポーネントです。デフォルトは null です。
関連項目:
JScrollPane.setCorner(java.lang.String, java.awt.Component)

vsbPolicy

protected int vsbPolicy
垂直スクロールバーの表示ポリシーです。デフォルトは JScrollPane.VERTICAL_SCROLLBAR_AS_NEEDED です。

このフィールドは現在は使用されていません。代わりに JScrollPane フィールドを使用してください。

関連項目:
JScrollPane.setVerticalScrollBarPolicy(int)

hsbPolicy

protected int hsbPolicy
水平スクロールバーの表示ポリシーです。デフォルトは JScrollPane.HORIZONTAL_SCROLLBAR_AS_NEEDED です。

このフィールドは現在は使用されていません。代わりに JScrollPane フィールドを使用してください。

関連項目:
JScrollPane.setHorizontalScrollBarPolicy(int)
コンストラクタの詳細

ScrollPaneLayout

public ScrollPaneLayout()
メソッドの詳細

syncWithScrollPane

public void syncWithScrollPane(JScrollPane sp)
このメソッドは、JScrollPane のレイアウトマネージャを設定したあとに呼び出さなければなりません。このメソッドは、通常は addLayoutComponent() によって設定される内部フィールドをすべて初期化します。次に例を示します。
 ScrollPaneLayout mySPLayout = new ScrollPanelLayout() {
     public void layoutContainer(Container p) {
         super.layoutContainer(p);
         // do some extra work here ...
     }
 };
 scrollpane.setLayout(mySPLayout):
 mySPLayout.syncWithScrollPane(scrollpane);

addSingletonComponent

protected Component addSingletonComponent(Component oldC,
                                          Component newC)
既存のコンポーネントを削除するのに使うメソッドです。左隅や垂直スクロールバーなどを 1 つしか配置できないためです。したがって、各サブコンポーネントは 1 つだけ配置され、新しいコンポーネントが追加されると、既存のコンポーネント (存在する場合) は削除されます。

このメソッドは newC を返します。oldCnewC と同じでなく、null でもない場合、oldC は親から削除されます。

パラメータ:
oldC - 置き換える Component
newC - 追加する Component
戻り値:
newC

addLayoutComponent

public void addLayoutComponent(String s,
                               Component c)
指定されたコンポーネントをレイアウトに追加します。レイアウトは、次のどれかの値を使って指定します。
定義:
インタフェース LayoutManager 内の addLayoutComponent
パラメータ:
s - コンポーネント識別子
comp - 追加されるコンポーネント

removeLayoutComponent

public void removeLayoutComponent(Component c)
指定されたコンポーネントをレイアウトから削除します。
定義:
インタフェース LayoutManager 内の removeLayoutComponent
パラメータ:
c - 削除するコンポーネント

getVerticalScrollBarPolicy

public int getVerticalScrollBarPolicy()
垂直スクロールバーの表示ポリシーを返します。
戻り値:
表示ポリシーを示す int 値
関連項目:
setVerticalScrollBarPolicy(int)

setVerticalScrollBarPolicy

public void setVerticalScrollBarPolicy(int x)
垂直スクロールバーの表示ポリシーを設定します。オプションは次のとおりです。 注: アプリケーションでは、このメソッドの JScrollPane バージョンを使用してください。このメソッドは、Swing 1.0.2 以前のバージョンのクラスに対する下位互換性のためにのみ用意されています。
パラメータ:
x - 表示ポリシーを示す int 値

getHorizontalScrollBarPolicy

public int getHorizontalScrollBarPolicy()
水平スクロールバーの表示ポリシーを返します。
戻り値:
表示ポリシーを示す int 値
関連項目:
setHorizontalScrollBarPolicy(int)

setHorizontalScrollBarPolicy

public void setHorizontalScrollBarPolicy(int x)
水平スクロールバーの表示ポリシーを設定します。オプションは次のとおりです。 注: アプリケーションでは、このメソッドの JScrollPane バージョンを使用してください。このメソッドは、Swing 1.0.2 以前のバージョンのクラスに対する下位互換性のためにのみ用意されています。
パラメータ:
x - 表示ポリシーを示す int 値

getViewport

public JViewport getViewport()
スクロール可能なコンテンツを表示する JViewport オブジェクトを返します。
戻り値:
スクロール可能なコンテンツを表示する JViewport オブジェクト
関連項目:
JScrollPane.getViewport()

getHorizontalScrollBar

public JScrollBar getHorizontalScrollBar()
水平スクロールを処理する JScrollBar オブジェクトを返します。
戻り値:
水平スクロールを処理する JScrollBar オブジェクト
関連項目:
JScrollPane.getHorizontalScrollBar()

getVerticalScrollBar

public JScrollBar getVerticalScrollBar()
垂直スクロールを処理する JScrollBar オブジェクトを返します。
戻り値:
垂直スクロールを処理する JScrollBar オブジェクト
関連項目:
JScrollPane.getVerticalScrollBar()

getRowHeader

public JViewport getRowHeader()
行ヘッダである JViewport オブジェクトを返します。
戻り値:
行ヘッダである JViewport オブジェクト
関連項目:
JScrollPane.getRowHeader()

getColumnHeader

public JViewport getColumnHeader()
列ヘッダである JViewport オブジェクトを返します。
戻り値:
列ヘッダである JViewport オブジェクト
関連項目:
JScrollPane.getColumnHeader()

getCorner

public Component getCorner(String key)
指定されたコーナーの Component を返します。
パラメータ:
key - コーナーを指定する String
戻り値:
ScrollPaneConstants で定義されている、指定されたコーナーの Component
関連項目:
JScrollPane.getCorner(java.lang.String)

preferredLayoutSize

public Dimension preferredLayoutSize(Container parent)
ScrollPane の適切なサイズは、インセットのサイズに、ビューポート、表示ヘッダ、および現在のビューと表示ポリシーによって表示されるスクロールバーの適切なサイズを加えた値です。
定義:
インタフェース LayoutManager 内の preferredLayoutSize
パラメータ:
parent - 配置する Container
戻り値:
ビューポートおよびスクロールバーの適切なサイズを指定する Dimension オブジェクト
関連項目:
ViewportLayout, LayoutManager

minimumLayoutSize

public Dimension minimumLayoutSize(Container parent)
ScrollPane の最小サイズは、インセットのサイズに、ビューポートの最小サイズ、スクロールペインのビューポート境界のインセット、表示ヘッダの最小サイズ、および表示ポリシーが NEVER ではないスクロールバーの最小サイズを加えた値です。
定義:
インタフェース LayoutManager 内の minimumLayoutSize
パラメータ:
parent - 配置する Container
戻り値:
最小サイズを指定する Dimension オブジェクト

layoutContainer

public void layoutContainer(Container parent)
スクロールペインを配置します。各コンポーネントの位置は、次の制約条件によって決まります。
定義:
インタフェース LayoutManager 内の layoutContainer
パラメータ:
parent - レイアウトするコンテナ

getViewportBorderBounds

public Rectangle getViewportBorderBounds(JScrollPane scrollpane)
推奨されていません。 JDK バージョン Swing1.1 以降は、JScrollPane.getViewportBorderBounds() に置き換えられました。

指定されたスクロールペインのビューポート境界の境界を返します。
戻り値:
ビューポート境界のサイズと位置

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.