ScrollPaneLayout (Java Platform SE 7)

java.lang.Object
- javax.swing.ScrollPaneLayout

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

LayoutManager, Serializable, ScrollPaneConstants

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

ScrollPaneLayout.UIResource
```
public class ScrollPaneLayout
extends Object
implements LayoutManager, ScrollPaneConstants, Serializable
```
JScrollPane が使用するレイアウトマネージャーです。JScrollPaneLayout が扱うコンポーネントは 9 個あります。その内訳は、ビューポート 1 個、スクロールバー 2 個、行ヘッダー 1 個、列ヘッダー 1 個、「コーナー」コンポーネント 4 個です。
警告: このクラスの直列化されたオブジェクトは、今後の Swing リリースとの互換性がなくなる予定です。現在の直列化のサポートは、短期間の格納や、同じバージョンの Swing を実行するアプリケーション間の RMI に適しています。1.4 以降、すべての JavaBeans^TM 用の長期間の格納サポートが java.beans パッケージに追加されています。XMLEncoder を参照してください。

関連項目:
JScrollPane, JViewport

ネストされたクラスのサマリー

ネストされたクラス
修飾子と型クラスと説明

static class ScrollPaneLayout.UIResource
ScrollPaneLayout の UI リソースバージョンです。

ネストされたクラス
修飾子と型	クラスと説明
`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()

コンストラクタ
コンストラクタと説明
`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 の Swing 1.1 以降は、`JScrollPane.getViewportBorderBounds()` に置き換えられています。
`void`	`layoutContainer(Container parent)` スクロールペインを配置します。
`Dimension`	`minimumLayoutSize(Container parent)` `ScrollPane` の最小サイズは、インセットのサイズに、ビューポートの最小サイズ、スクロールペインの viewportBorder インセット、可視ヘッダーの最小サイズ、および displayPolicy が NEVER ではないスクロールバーの最小サイズを加えた値です。
`Dimension`	`preferredLayoutSize(Container parent)` `ScrollPane` の推奨サイズは、インセットのサイズに、ビューポートの推奨サイズ、可視ヘッダーの優先サイズ、および現在のビューと現在のスクロールバーの displayPolicies で表示されるスクロールバーの推奨サイズを加えた値です。
`void`	`removeLayoutComponent(Component c)` 指定されたコンポーネントをレイアウトから削除します。
`void`	`setHorizontalScrollBarPolicy(int x)` 水平スクロールバーの表示ポリシーを設定します。
`void`	`setVerticalScrollBarPolicy(int x)` 垂直スクロールバーの表示ポリシーを設定します。
`void`	`syncWithScrollPane(JScrollPane sp)` このメソッドは、ScrollPaneLayout が `JScrollPane` の LayoutManager として設定されたあとで呼び出されます。

クラス 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
```
    垂直スクロールバーの表示ポリシーです。デフォルトは ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED です。
    このフィールドは現在は使用されていません。代わりに JScrollPane フィールドを使用してください。
    
    関連項目:
    JScrollPane.setVerticalScrollBarPolicy(int)
  - hsbPolicy
```
protected int hsbPolicy
```
    水平スクロールバーの表示ポリシーです。デフォルトは ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED です。
    このフィールドは現在は使用されていません。代わりに JScrollPane フィールドを使用してください。
    
    関連項目:
    JScrollPane.setHorizontalScrollBarPolicy(int)
- コンストラクタの詳細
  - ScrollPaneLayout
```
public ScrollPaneLayout()
```
- メソッドの詳細
  - syncWithScrollPane
```
public void syncWithScrollPane(JScrollPane sp)
```
    このメソッドは、ScrollPaneLayout が JScrollPane の LayoutManager として設定されたあとで呼び出されます。このメソッドは通常、addLayoutComponent によって設定される内部フィールドをすべて初期化します。例を示します。
```
 ScrollPaneLayout mySPLayout = new ScrollPanelLayout() {
     public void layoutContainer(Container p) {
         super.layoutContainer(p);
         // do some extra work here ...
     }
 };
 scrollpane.setLayout(mySPLayout):
 
```
  - addSingletonComponent
```
protected Component addSingletonComponent(Component oldC,
                              Component newC)
```
    既存のコンポーネントを削除します。左隅や垂直スクロールバーなどの新しいコンポーネントを追加すると、既存のコンポーネント (存在する場合) は削除されます。
    このメソッドは newC を返します。oldC が newC と同じでなく、null でもない場合、それは親から削除されます。
    
    パラメータ:
    oldC - 置き換える Component
    newC - 追加する Component
    
    戻り値:
    newC
  - addLayoutComponent
```
public void addLayoutComponent(String s,
                      Component c)
```
    指定されたコンポーネントをレイアウトに追加します。レイアウトは、次のいずれかの値を使用して指定します。
    - ScrollPaneConstants.VIEWPORT
    - ScrollPaneConstants.VERTICAL_SCROLLBAR
    - ScrollPaneConstants.HORIZONTAL_SCROLLBAR
    - ScrollPaneConstants.ROW_HEADER
    - ScrollPaneConstants.COLUMN_HEADER
    - ScrollPaneConstants.LOWER_LEFT_CORNER
    - ScrollPaneConstants.LOWER_RIGHT_CORNER
    - ScrollPaneConstants.UPPER_LEFT_CORNER
    - ScrollPaneConstants.UPPER_RIGHT_CORNER
    定義:
    
    addLayoutComponent、インタフェース: LayoutManager
    
    パラメータ:
    s - コンポーネント識別子
    c - 追加されるコンポーネント
    
    例外:
    
    IllegalArgumentException - s が無効なキーの場合
  - removeLayoutComponent
```
public void removeLayoutComponent(Component c)
```
    指定されたコンポーネントをレイアウトから削除します。
    
    定義:
    
    removeLayoutComponent、インタフェース: LayoutManager
    
    パラメータ:
    c - 削除されるコンポーネント
  - getVerticalScrollBarPolicy
```
public int getVerticalScrollBarPolicy()
```
    垂直スクロールバーの表示ポリシーを返します。
    
    戻り値:
    表示ポリシーを示す整数
    関連項目:
    setVerticalScrollBarPolicy(int)
  - setVerticalScrollBarPolicy
```
public void setVerticalScrollBarPolicy(int x)
```
    垂直スクロールバーの表示ポリシーを設定します。オプションは次のとおりです。
    - ScrollPaneConstants.VERTICAL_SCROLLBAR_AS_NEEDED
    - ScrollPaneConstants.VERTICAL_SCROLLBAR_NEVER
    - ScrollPaneConstants.VERTICAL_SCROLLBAR_ALWAYS
    注: アプリケーションでは、このメソッドの JScrollPane バージョンを使用してください。このメソッドは、Swing 1.0.2 以前のバージョンのクラスに対する下位互換性のためにのみ用意されています。
    パラメータ:
    x - 表示ポリシーを示す整数
    
    例外:
    
    IllegalArgumentException - x が上記のリストに示す有効な垂直スクロールバーポリシーでない場合
  - getHorizontalScrollBarPolicy
```
public int getHorizontalScrollBarPolicy()
```
    水平スクロールバーの表示ポリシーを返します。
    
    戻り値:
    表示ポリシーを示す整数
    関連項目:
    setHorizontalScrollBarPolicy(int)
  - setHorizontalScrollBarPolicy
```
public void setHorizontalScrollBarPolicy(int x)
```
    水平スクロールバーの表示ポリシーを設定します。オプションは次のとおりです。
    - ScrollPaneConstants.HORIZONTAL_SCROLLBAR_AS_NEEDED
    - ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER
    - ScrollPaneConstants.HORIZONTAL_SCROLLBAR_ALWAYS
    注: アプリケーションでは、このメソッドの JScrollPane バージョンを使用してください。このメソッドは、Swing 1.0.2 以前のバージョンのクラスに対する下位互換性のためにのみ用意されています。
    パラメータ:
    x - 表示ポリシーを示す int 値
    
    例外:
    
    IllegalArgumentException - x が上記のリストに示す有効な水平スクロールバーポリシーでない場合
  - 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。key が 4 つのコーナーのうちのいずれでもない場合、null が返される
    関連項目:
    JScrollPane.getCorner(java.lang.String)
  - preferredLayoutSize
```
public Dimension preferredLayoutSize(Container parent)
```
    ScrollPane の推奨サイズは、インセットのサイズに、ビューポートの推奨サイズ、可視ヘッダーの優先サイズ、および現在のビューと現在のスクロールバーの displayPolicies で表示されるスクロールバーの推奨サイズを加えた値です。
    rowHeader は適切な幅の一部として計算され、colHeader は適切なサイズの一部として計算されます。
    
    定義:
    
    preferredLayoutSize、インタフェース: LayoutManager
    
    パラメータ:
    parent - 配置する Container
    
    戻り値:
    ビューポートとスクロールバーの適切なサイズを指定する Dimension オブジェクト
    関連項目:
    ViewportLayout, LayoutManager
  - minimumLayoutSize
```
public Dimension minimumLayoutSize(Container parent)
```
    ScrollPane の最小サイズは、インセットのサイズに、ビューポートの最小サイズ、スクロールペインの viewportBorder インセット、可視ヘッダーの最小サイズ、および displayPolicy が NEVER ではないスクロールバーの最小サイズを加えた値です。
    
    定義:
    
    minimumLayoutSize、インタフェース: LayoutManager
    
    パラメータ:
    parent - 配置する Container
    
    戻り値:
    最小サイズを指定する Dimension オブジェクト
    関連項目:
    LayoutManager.preferredLayoutSize(java.awt.Container)
  - layoutContainer
```
public void layoutContainer(Container parent)
```
    スクロールペインを配置します。各コンポーネントの位置は、次の制約条件によって決まります。
    - 表示されている行ヘッダーは、適切な幅およびビューポートの高さに設定される。
    - 表示されている列ヘッダーは、適切な高さおよびビューポートの幅に設定される。
    - 垂直スクロールバーが必要な場合 (つまり、ビューポートのエクステントの高さがそのビューより低い場合、あるいは displayPolicy が ALWAYS の場合)、スクロールバーはサイズに関して行ヘッダーと同様に扱われ、表示される。
    - 水平スクロールバーが必要な場合は、スクロールバーは列ヘッダーと同様に扱われる (垂直スクロールバーの項を参照)。
    - スクロールペインの viewportBorder が null 以外の場合は、ビューポート境界に領域が割り当てられる。
    - ビューポートには、前回の制約条件が報告されたあとで利用可能な領域が割り当てられる。
    - コーナーコンポーネント (提供されている場合) は、スクロールバーとヘッダーの端にそろえられる。垂直スクロールバーがある場合は右側のコーナーが表示され、水平スクロールバーがある場合は下側のコーナーが表示される。行ヘッダーは左側のコーナーに配置され、列ヘッダーは上側のコーナーに配置される。
    定義:
    
    layoutContainer、インタフェース: LayoutManager
    
    パラメータ:
    parent - レイアウトする Container
  - getViewportBorderBounds
```
@Deprecated
public Rectangle getViewportBorderBounds(JScrollPane scrollpane)
```
    非推奨。JDK の Swing 1.1 以降は、JScrollPane.getViewportBorderBounds() に置き換えられています。
    
    指定されたスクロールペインのビューポート境界の境界を返します。
    
    戻り値:
    ビューポート境界のサイズと位置

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス ScrollPaneLayout

ネストされたクラスのサマリー

フィールドのサマリー

インタフェース javax.swing.ScrollPaneConstants から継承されたフィールド

コンストラクタのサマリー

メソッドのサマリー

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

フィールドの詳細

viewport

vsb

hsb

rowHead

colHead

lowerLeft

lowerRight

upperLeft

upperRight

vsbPolicy

hsbPolicy

コンストラクタの詳細

ScrollPaneLayout

メソッドの詳細

syncWithScrollPane

addSingletonComponent

addLayoutComponent

removeLayoutComponent

getVerticalScrollBarPolicy

setVerticalScrollBarPolicy

getHorizontalScrollBarPolicy

setHorizontalScrollBarPolicy

getViewport

getHorizontalScrollBar

getVerticalScrollBar

getRowHeader

getColumnHeader

getCorner

preferredLayoutSize

minimumLayoutSize

layoutContainer

getViewportBorderBounds