BorderLayout (Java Platform SE 7)

java.lang.Object
- java.awt.BorderLayout

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

LayoutManager, LayoutManager2, Serializable
```
public class BorderLayout
extends Object
implements LayoutManager2, Serializable
```
ボーダーレイアウトは、north (上端)、south (下端)、east (右端)、west (左端)、および center (中央) という 5 つの領域に収まるように、コンポーネントを整列およびサイズ変更して、コンテナに配置します。各領域はコンポーネントを最大 1 つずつ含むことができ、それぞれ対応する定数 NORTH (上端)、SOUTH (下端)、EAST (右端)、WEST (左端)、CENTER (中央) によって識別されます。ボーダレイアウトを使ってコンテナにコンポーネントを追加するときは、次の例のように、5 つの定数のいずれかを使用します。
```
    Panel p = new Panel();
    p.setLayout(new BorderLayout());
    p.add(new Button("Okay"), BorderLayout.SOUTH);
 
```
次に示すように、文字列の指定がない場合には、BorderLayout は定数 CENTER が指定されたと解釈します。
```
    Panel p2 = new Panel();
    p2.setLayout(new BorderLayout());
    p2.add(new TextArea());  // Same as p.add(new TextArea(), BorderLayout.CENTER);
 
```
また、BorderLayout は、PAGE_START、PAGE_END、LINE_START、および LINE_END という相対位置指定定数をサポートします。ComponentOrientation が ComponentOrientation.LEFT_TO_RIGHT に設定されているコンテナでは、これらの定数はそれぞれ NORTH、SOUTH、WEST、EAST にマッピングされます。
以前のリリースとの互換性を保つため、BorderLayout には BEFORE_FIRST_LINE、AFTER_LAST_LINE、BEFORE_LINE_BEGINS、および AFTER_LINE_ENDS という相対位置指定定数も用意されています。これらはそれぞれ PAGE_START、PAGE_END、LINE_START、および LINE_END と同じ意味を持ちます。ほかのコンポーネントの相対位置指定定数との互換性の面から、できるだけあとの 4 つを使用します。
絶対位置指定定数と相対位置指定定数を同時に使用すると、予期せぬ結果が生じることがあります。両方の種類の定数を使用した場合は、相対位置指定定数が優先されます。たとえば、方向が LEFT_TO_RIGHT のコンテナで NORTH 定数と PAGE_START 定数の両方を使ってコンポーネントを追加した場合、PAGE_START だけを使用して配置が行われます。
注:Java 2 プラットフォーム v1.2 では、BorderLayout は垂直方向をサポートしていません。コンテナの ComponentOrientation の isVertical の設定値は無視されます。
コンポーネントはそれらの推奨サイズやコンテナサイズの制約を満たすように配置されます。NORTH コンポーネントおよび SOUTH コンポーネントは水平方向に引き伸ばされます。EAST コンポーネントおよび WEST コンポーネントは垂直方向に引き伸ばされます。CENTER コンポーネントは、スペースを残さないように、水平および垂直の両方向に引き伸ばされます。
次の例では、BorderLayout レイアウトマネージャーを使ってアプレット内に 5 つのボタンが配置されます。

このアプレットのコードは次のとおりです。
```
 import java.awt.*;
 import java.applet.Applet;

 public class buttonDir extends Applet {
   public void init() {
     setLayout(new BorderLayout());
     add(new Button("North"), BorderLayout.NORTH);
     add(new Button("South"), BorderLayout.SOUTH);
     add(new Button("East"), BorderLayout.EAST);
     add(new Button("West"), BorderLayout.WEST);
     add(new Button("Center"), BorderLayout.CENTER);
   }
 }
 
```
導入されたバージョン:

JDK1.0

関連項目:
Container.add(String, Component), ComponentOrientation, 直列化された形式

フィールドのサマリー

フィールド
修飾子と型	フィールドと説明
`static String`	`AFTER_LAST_LINE` PAGE_END と同じ意味を持ちます。
`static String`	`AFTER_LINE_ENDS` LINE_END と同じ意味を持ちます。
`static String`	`BEFORE_FIRST_LINE` PAGE_START と同じ意味を持ちます。
`static String`	`BEFORE_LINE_BEGINS` LINE_START と同じ意味を持ちます。
`static String`	`CENTER` center のレイアウト制約 (コンテナの中央) です。
`static String`	`EAST` east のレイアウト制約 (コンテナの右端) です。
`static String`	`LINE_END` コンポーネントはレイアウトの行方向の最後に配置されます。
`static String`	`LINE_START` コンポーネントはレイアウトの行方向の先頭に配置されます。
`static String`	`NORTH` north のレイアウト制約 (コンテナの上端) です。
`static String`	`PAGE_END` コンポーネントはレイアウトの内容の最終行のあとに配置されます。
`static String`	`PAGE_START` コンポーネントはレイアウトの内容の先頭行の前に配置されます。
`static String`	`SOUTH` south のレイアウト制約 (コンテナの下端) です。
`static String`	`WEST` west のレイアウト制約 (コンテナの左端) です。

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

コンストラクタ
コンストラクタと説明
`BorderLayout()` コンポーネント間に間隔を設けずに、新しいボーダレイアウトを構築します。
`BorderLayout(int hgap, int vgap)` コンポーネント間に間隔を指定して、新しいボーダレイアウトを構築します。

メソッドのサマリー

メソッド
修飾子と型	メソッドと説明
`void`	`addLayoutComponent(Component comp, Object constraints)` 指定された制約オブジェクトを使って、指定されたコンポーネントをレイアウトに追加します。
`void`	`addLayoutComponent(String name, Component comp)` 非推奨。 `addLayoutComponent(Component, Object)` に置き換えられています。
`Object`	`getConstraints(Component comp)` 指定されたコンポーネントの制約を取得します。
`int`	`getHgap()` コンポーネント間の水平方向の間隔を返します。
`float`	`getLayoutAlignmentX(Container parent)` x 軸方向の配置を返します。
`float`	`getLayoutAlignmentY(Container parent)` y 軸方向の配置を返します。
`Component`	`getLayoutComponent(Container target, Object constraints)` ターゲット `Container` のコンポーネント方向に基づいて、特定の制約の場所に対応するコンポーネントを返します。
`Component`	`getLayoutComponent(Object constraints)` 指定された制約で追加されたコンポーネントを取得します。
`int`	`getVgap()` コンポーネント間の垂直方向の間隔を返します。
`void`	`invalidateLayout(Container target)` レイアウトを無効にします。このとき、レイアウトマネージャーが情報をキャッシュしていればそれを破棄します。
`void`	`layoutContainer(Container target)` このボーダレイアウトを使用してコンテナ引数を配置します。
`Dimension`	`maximumLayoutSize(Container target)` 指定されたターゲットコンテナにコンポーネントが与えられた場合の、レイアウトの最大サイズを返します。
`Dimension`	`minimumLayoutSize(Container target)` このレイアウトマネージャーを使用する `target` コンテナの最小サイズを判定します。
`Dimension`	`preferredLayoutSize(Container target)` コンテナ内のコンポーネントに基づいて、このレイアウトマネージャーを使用する `target` コンテナの優先サイズを判定します。
`void`	`removeLayoutComponent(Component comp)` このボーダレイアウトから、指定されたコンポーネントを削除します。
`void`	`setHgap(int hgap)` コンポーネント間の水平方向の間隔を設定します。
`void`	`setVgap(int vgap)` コンポーネント間の垂直方向の間隔を設定します。
`String`	`toString()` このボーダレイアウトの状態を示す文字列表現を返します。

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- フィールドの詳細
  - NORTH
```
public static final String NORTH
```
    north のレイアウト制約 (コンテナの上端) です。
    
    関連項目:
    定数フィールド値
  - SOUTH
```
public static final String SOUTH
```
    south のレイアウト制約 (コンテナの下端) です。
    
    関連項目:
    定数フィールド値
  - EAST
```
public static final String EAST
```
    east のレイアウト制約 (コンテナの右端) です。
    
    関連項目:
    定数フィールド値
  - WEST
```
public static final String WEST
```
    west のレイアウト制約 (コンテナの左端) です。
    
    関連項目:
    定数フィールド値
  - CENTER
```
public static final String CENTER
```
    center のレイアウト制約 (コンテナの中央) です。
    
    関連項目:
    定数フィールド値
  - BEFORE_FIRST_LINE
```
public static final String BEFORE_FIRST_LINE
```
    PAGE_START と同じ意味を持ちます。以前のバージョンとの互換性のために残されています。できるだけ PAGE_START を使用します。
    
    導入されたバージョン:
    
    1.2
    
    関連項目:
    PAGE_START, 定数フィールド値
  - AFTER_LAST_LINE
```
public static final String AFTER_LAST_LINE
```
    PAGE_END と同じ意味を持ちます。以前のバージョンとの互換性のために残されています。できるだけ PAGE_END を使用します。
    
    導入されたバージョン:
    
    1.2
    
    関連項目:
    PAGE_END, 定数フィールド値
  - BEFORE_LINE_BEGINS
```
public static final String BEFORE_LINE_BEGINS
```
    LINE_START と同じ意味を持ちます。以前のバージョンとの互換性のために残されています。できるだけ LINE_START を使用します。
    
    導入されたバージョン:
    
    1.2
    
    関連項目:
    LINE_START, 定数フィールド値
  - AFTER_LINE_ENDS
```
public static final String AFTER_LINE_ENDS
```
    LINE_END と同じ意味を持ちます。以前のバージョンとの互換性のために残されています。できるだけ LINE_END を使用します。
    
    導入されたバージョン:
    
    1.2
    
    関連項目:
    LINE_END, 定数フィールド値
  - PAGE_START
```
public static final String PAGE_START
```
    コンポーネントはレイアウトの内容の先頭行の前に配置されます。WEST から見て左から右、上から下に配置が行われる場合、これは NORTH と同じになります。
    
    導入されたバージョン:
    
    1.4
    
    関連項目:
    Component.getComponentOrientation(), 定数フィールド値
  - PAGE_END
```
public static final String PAGE_END
```
    コンポーネントはレイアウトの内容の最終行のあとに配置されます。WEST から見て左から右、上から下に配置が行われる場合、これは SOUTH と同じになります。
    
    導入されたバージョン:
    
    1.4
    
    関連項目:
    Component.getComponentOrientation(), 定数フィールド値
  - LINE_START
```
public static final String LINE_START
```
    コンポーネントはレイアウトの行方向の先頭に配置されます。WEST から見て左から右、上から下に配置が行われる場合、これは WEST と同じになります。
    
    導入されたバージョン:
    
    1.4
    
    関連項目:
    Component.getComponentOrientation(), 定数フィールド値
  - LINE_END
```
public static final String LINE_END
```
    コンポーネントはレイアウトの行方向の最後に配置されます。WEST から見て左から右、上から下に配置が行われる場合、これは EAST と同じになります。
    
    導入されたバージョン:
    
    1.4
    
    関連項目:
    Component.getComponentOrientation(), 定数フィールド値
- コンストラクタの詳細
  - BorderLayout
```
public BorderLayout()
```
    コンポーネント間に間隔を設けずに、新しいボーダレイアウトを構築します。
  - BorderLayout
```
public BorderLayout(int hgap,
            int vgap)
```
    コンポーネント間に間隔を指定して、新しいボーダレイアウトを構築します。水平方向の間隔は hgap によって指定され、垂直方向の間隔は vgap によって指定されます。
    
    パラメータ:
    hgap - 水平方向の間隔。
    vgap - 垂直方向の間隔。
- メソッドの詳細
  - getHgap
```
public int getHgap()
```
    コンポーネント間の水平方向の間隔を返します。
    
    導入されたバージョン:
    
    JDK1.1
  - setHgap
```
public void setHgap(int hgap)
```
    コンポーネント間の水平方向の間隔を設定します。
    
    パラメータ:
    hgap - コンポーネント間の水平方向の間隔
    導入されたバージョン:
    
    JDK1.1
  - getVgap
```
public int getVgap()
```
    コンポーネント間の垂直方向の間隔を返します。
    
    導入されたバージョン:
    
    JDK1.1
  - setVgap
```
public void setVgap(int vgap)
```
    コンポーネント間の垂直方向の間隔を設定します。
    
    パラメータ:
    vgap - コンポーネント間の垂直方向の間隔
    導入されたバージョン:
    
    JDK1.1
  - addLayoutComponent
```
public void addLayoutComponent(Component comp,
                      Object constraints)
```
    指定された制約オブジェクトを使って、指定されたコンポーネントをレイアウトに追加します。ボーダーレイアウトでは、制約は、定数 NORTH、SOUTH、EAST、WEST、CENTER のいずれかである必要があります。
    ほとんどのアプリケーションはこのメソッドを直接には呼び出しません。このメソッドは、同じ引数の型で Container.add メソッドを使ってコンポーネントがコンテナに追加されたときに呼び出されます。
    
    定義:
    
    addLayoutComponent、インタフェース: LayoutManager2
    
    パラメータ:
    comp - 追加されるコンポーネント。
    constraints - コンポーネントがレイアウトに追加される方法と場所を指定するオブジェクト
    
    例外:
    
    IllegalArgumentException - 制約オブジェクトが文字列でない場合、または指定された 5 つの定数のどれでもない場合
    導入されたバージョン:
    
    JDK1.1
    
    関連項目:
    Container.add(java.awt.Component, java.lang.Object)
  - addLayoutComponent
```
@Deprecated
public void addLayoutComponent(String name,
                                 Component comp)
```
    非推奨。 addLayoutComponent(Component, Object) に置き換えられています。
    
    次のインタフェースからコピーされた説明: LayoutManager
    
    レイアウトマネージャーがコンポーネントごとの文字列を使用する場合は、レイアウトにコンポーネント comp を追加し、それを name によって指定された文字列に関連付けます。
    
    定義:
    
    addLayoutComponent、インタフェース: LayoutManager
    
    パラメータ:
    name - コンポーネントに関連付けられる文字列
    comp - 追加されるコンポーネント
  - removeLayoutComponent
```
public void removeLayoutComponent(Component comp)
```
    このボーダレイアウトから、指定されたコンポーネントを削除します。このメソッドは、コンテナが remove メソッドまたは removeAll メソッドを呼び出したときに呼び出されます。ほとんどのアプリケーションはこのメソッドを直接には呼び出しません。
    
    定義:
    
    removeLayoutComponent、インタフェース: LayoutManager
    
    パラメータ:
    comp - 削除されるコンポーネント。
    関連項目:
    Container.remove(java.awt.Component), Container.removeAll()
  - getLayoutComponent
```
public Component getLayoutComponent(Object constraints)
```
    指定された制約で追加されたコンポーネントを取得します。
    
    パラメータ:
    constraints - 目的の制約。CENTER、NORTH、SOUTH、WEST、EAST、PAGE_START、PAGE_END、LINE_START、LINE_END のいずれか
    
    戻り値:
    特定の位置にあるコンポーネント、またはその位置が空である場合は null
    
    例外:
    
    IllegalArgumentException - 制約オブジェクトが指定された 9 つの定数のどれでもない場合
    導入されたバージョン:
    
    1.5
    
    関連項目:
    addLayoutComponent(java.awt.Component, java.lang.Object)
  - getLayoutComponent
```
public Component getLayoutComponent(Container target,
                           Object constraints)
```
    ターゲット Container のコンポーネント方向に基づいて、特定の制約の場所に対応するコンポーネントを返します。相対的な制約 PAGE_START、PAGE_END、LINE_START、およびLINE_END を指定して追加されたコンポーネントは、明示的な制約 NORTH、SOUTH、WEST、および EAST を指定して追加されたコンポーネントよりも優先されます。Container のコンポーネント方向は、LINE_START と LINE_END を指定して追加されたコンポーネントの場所を判定するために使用されます。
    
    パラメータ:
    constraints - 目的の絶対位置。CENTER、NORTH、SOUTH、EAST、WEST のいずれか
    target - 制約の場所を取得するために使用する Container。制約の場所は、Container のコンポーネント方向に基づいて判定される
    
    戻り値:
    特定の位置にあるコンポーネント、またはその位置が空である場合は null
    
    例外:
    
    IllegalArgumentException - 制約オブジェクトが指定された 5 つの定数のどれでもない場合
    
    NullPointerException - target パラメータが null の場合
    導入されたバージョン:
    
    1.5
    
    関連項目:
    addLayoutComponent(java.awt.Component, java.lang.Object)
  - getConstraints
```
public Object getConstraints(Component comp)
```
    指定されたコンポーネントの制約を取得します。
    
    パラメータ:
    comp - 照会されるコンポーネント
    
    戻り値:
    指定されたコンポーネントの制約。コンポーネントが null か、このレイアウトに存在しない場合は null
    導入されたバージョン:
    
    1.5
    
    関連項目:
    addLayoutComponent(java.awt.Component, java.lang.Object)
  - minimumLayoutSize
```
public Dimension minimumLayoutSize(Container target)
```
    このレイアウトマネージャーを使用する target コンテナの最小サイズを判定します。
    このメソッドは、コンテナがその getMinimumSize メソッドを呼び出したときに呼び出されます。ほとんどのアプリケーションはこのメソッドを直接には呼び出しません。
    
    定義:
    
    minimumLayoutSize、インタフェース: LayoutManager
    
    パラメータ:
    target - レイアウトが行われるコンテナ。
    
    戻り値:
    指定されたコンテナのサブコンポーネントを配置するために必要な最小の寸法
    関連項目:
    Container, preferredLayoutSize(java.awt.Container), Container.getMinimumSize()
  - preferredLayoutSize
```
public Dimension preferredLayoutSize(Container target)
```
    コンテナ内のコンポーネントに基づいて、このレイアウトマネージャーを使用する target コンテナの優先サイズを判定します。
    ほとんどのアプリケーションはこのメソッドを直接には呼び出しません。このメソッドは、コンテナがその getPreferredSize メソッドを呼び出したときに呼び出されます。
    
    定義:
    
    preferredLayoutSize、インタフェース: LayoutManager
    
    パラメータ:
    target - レイアウトが行われるコンテナ。
    
    戻り値:
    指定されたコンテナのサブコンポーネントを配置するための望ましい寸法
    関連項目:
    Container, minimumLayoutSize(java.awt.Container), Container.getPreferredSize()
  - maximumLayoutSize
```
public Dimension maximumLayoutSize(Container target)
```
    指定されたターゲットコンテナにコンポーネントが与えられた場合の、レイアウトの最大サイズを返します。
    
    定義:
    
    maximumLayoutSize、インタフェース: LayoutManager2
    
    パラメータ:
    target - レイアウトが必要なコンポーネント
    関連項目:
    Container, minimumLayoutSize(java.awt.Container), preferredLayoutSize(java.awt.Container)
  - getLayoutAlignmentX
```
public float getLayoutAlignmentX(Container parent)
```
    x 軸方向の配置を返します。これは、そのコンポーネントがほかのコンポーネントに対してどのように配置されるべきかを指定したものです。この値は 0 から 1 の間の数値で、0 は原点に沿った配置を表し、1 は原点からもっとも遠いところに、0.5 は中央に配置されます。
    
    定義:
    
    getLayoutAlignmentX、インタフェース: LayoutManager2
  - getLayoutAlignmentY
```
public float getLayoutAlignmentY(Container parent)
```
    y 軸方向の配置を返します。これは、そのコンポーネントがほかのコンポーネントに対してどのように配置されるべきかを指定したものです。この値は 0 から 1 の間の数値で、0 は原点に沿った配置を表し、1 は原点からもっとも遠いところに、0.5 は中央に配置されます。
    
    定義:
    
    getLayoutAlignmentY、インタフェース: LayoutManager2
  - invalidateLayout
```
public void invalidateLayout(Container target)
```
    レイアウトを無効にします。このとき、レイアウトマネージャーが情報をキャッシュしていればそれを破棄します。
    
    定義:
    
    invalidateLayout、インタフェース: LayoutManager2
  - layoutContainer
```
public void layoutContainer(Container target)
```
    このボーダレイアウトを使用してコンテナ引数を配置します。
    実際にはこのメソッドは、この BorderLayout オブジェクトの制約を満たすために、指定されたコンテナ内のコンポーネントの形状を変更します。NORTH コンポーネントおよび SOUTH コンポーネントがある場合、それらはコンテナのそれぞれ上部および下部に配置されます。WEST コンポーネントおよび EAST コンポーネントは、それぞれ左および右に配置されます。CENTER オブジェクトは中央の残りのスペースに配置されます。
    ほとんどのアプリケーションはこのメソッドを直接には呼び出しません。このメソッドは、コンテナがその doLayout メソッドを呼び出したときに呼び出されます。
    
    定義:
    
    layoutContainer、インタフェース: LayoutManager
    
    パラメータ:
    target - レイアウトが行われるコンテナ。
    関連項目:
    Container, Container.doLayout()
  - toString
```
public String toString()
```
    このボーダレイアウトの状態を示す文字列表現を返します。
    
    オーバーライド:
    
    toString、クラス: Object
    
    戻り値:
    このボーダレイアウトの文字列表現

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

クラス BorderLayout

フィールドのサマリー

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

メソッドのサマリー

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

フィールドの詳細

NORTH

SOUTH

EAST

WEST

CENTER

BEFORE_FIRST_LINE

AFTER_LAST_LINE

BEFORE_LINE_BEGINS

AFTER_LINE_ENDS

PAGE_START

PAGE_END

LINE_START

LINE_END

コンストラクタの詳細

BorderLayout

BorderLayout

メソッドの詳細

getHgap

setHgap

getVgap

setVgap

addLayoutComponent

addLayoutComponent

removeLayoutComponent

getLayoutComponent

getLayoutComponent

getConstraints

minimumLayoutSize

preferredLayoutSize

maximumLayoutSize

getLayoutAlignmentX

getLayoutAlignmentY

invalidateLayout

layoutContainer

toString