GridBagLayout クラス

Information

Swingの基本

Layout Mng.

イベント処理

色々なペイン

高度なコンポーネント

その他の機能

関連クラスの利用方法

サンプルアプリケーション

関連ページ

Our Host


GridBagLayout クラス	H.Kamifuji .

はじめに

　GridBagLayoutクラスはコンポーネントを表形式のような形状に配置していくレイアウトマネージャーです。非常に柔軟なレイアウトを作成できる反面で設定は多少複雑です。
　
　ここではGridBagLayoutクラスの定義から実際の利用方法まで詳しく見ていきます。
　
　当ページでは、Linux CentOS7 の Gnome で動作テストしています。

　現在(2021/08)では、JDK-16.0.2 にアップされています。一部、上位互換について、見直しを行っていきます。

　現在(2021/11)では、JDK-17.0.1 にアップされています。一部、上位互換について、見直しを行っていきます。

　現在(2023/04)では、JDK-20.0.1 にアップされています。一部、上位互換について、見直しを行っていきます。

　現在(2024/10)では、JDK-23 にアップされています。一部、上位互換について、見直しを行っていきます。

目　次

GridBagLayoutクラスの定義とコンストラクタ

GridBagConstraintsクラスを使ってコンポーネントを配置する

コンポーネントを配置するセルを設定する

コンポーネントが占めるセル数を設定する

余分な領域の配分方法を設定する

セル内でのコンポーネントの表示位置を設定する

セル内でのコンポーネントのサイズを変更する

GridBagLayoutクラスの定義とコンストラクタ

　
　GridBagLayoutクラスの定義を確認します。クラス図は次のようになっています。

java.lang.Object Ｌ java.awt.GridBagLayout public class GridBagLayout extends Object implements LayoutManager2, Serializable
　

GridBagLayoutクラスのコンストラクタ
　GridBagLayoutクラスをを利用するにはコンストラクタを使ってGridBagLayoutクラスのオブジェクトを作成します。どのようなコンストラクタが用意されているか確認してみます。
　

コンストラクタ

GridBagLayout()
グリッドバッグレイアウトマネージャーを作成します。

　
　コンストラクタは1つ用意されています。ではコンストラクタを確認してみます。
　

GridBagLayout public GridBagLayout()
　グリッドバッグレイアウトマネージャーを作成します。

　
　コンストラクタ自体には何も設定を行う要素がありません。細かい設定は「setConstraints」メソッドを使って行っていきます。
　
　実際の使い方は次のようになります。

JPanel panel = new JPanel(); panel.setLayout(new GridBagLayout());
　実際のサンプルなどは次のページ以降で行っていきます。

[ 目次 ]

GridBagConstraintsクラスを使ってコンポーネントを配置する

　
　GridBagLayoutクラスをレイアウトマネージャーとして設定したコンテナに対してコンポーネントを配置していく方法を確認します。
　
　コンポーネントを配置するには今までのレイアウトマネージャーと同じく「add」メソッドを使ってコンテナに対してコンポーネントを追加しますが、追加するコンポーネントに対してどのように配置されるのかを事前に設定しておく必要があります。コンポーネントに配置方法に関する情報を設定するにはGridBagLayoutクラスで用意されている「setConstraints」メソッドを使います。
　

setConstraints public void setConstraints(Component comp, GridBagConstraints constraints)
　このレイアウトの指定されたコンポーネントに対して制約を設定します。
　
　パラメータ:
　　　comp - 変更されるコンポーネント
　　　constraints - 適用される制約

　
　1番目の引数に配置したいコンポーネントを指定します。そして2番目の引数にどのように配置するのかを表す制約と呼ばれるものを指定します。制約というのはコンポーネントを配置する位置やサイズを拡張するのかどうかを指定するものです。
　
　制約を設定するにはGridBagConstraintsクラスのオブジェクトを作成して指定しますのでまずGridBagConstraintsクラスについて確認しておきましょう。
　

GridBagConstraintsクラス
　GridBagLayoutクラスの定義を確認します。クラス図は次のようになっています。

java.lang.Object Ｌ java.awt.GridBagConstraints public class GridBagConstraints extends Object implements Cloneable, Serializable
　

GridBagConstraintsクラスのコンストラクタ
　GridBagConstraintsクラスをを利用するにはコンストラクタを使ってGridBagConstraintsクラスのオブジェクトを作成します。どのようなコンストラクタが用意されているか確認してみます。
　

コンストラクタ

GridBagConstraints()
すべてのフィールドをデフォルト値に設定して GridBagConstraint オブジェクトを作成します。

GridBagConstraints(int gridx, int gridy, int gridwidth, int gridheight, double weightx, double weighty, int anchor, int fill, Insets insets, int ipadx, int ipady)
すべてのフィールドを渡された引数に設定して GridBagConstraints オブジェクトを作成します。

　
　コンストラクタは2つ用意されています。2つ目のコンストラクタでは非常に多くの引数が用意されていますが、引数の数だけGridBagConstraintsクラスのオブジェクトには設定を行えるようになっています。
　
　まず1番目のコンストラクタを確認してみます。
　

GridBagConstraints public GridBagConstraints()
　すべてのフィールドをデフォルト値に設定して GridBagConstraint オブジェクトを作成します。

　
　全ての設定項目に対してデフォルトの値を使いGridBagConstraintクラスのオブジェクトを作成します。通常はこのコンストラクタを使ってオブジェクトを作成してから必要な項目についてだけ設定を別途行うようにします。
　
　では2番目のコンストラクタを確認しどのような設定項目が用意されているのかを確認してみます。
　

GridBagConstraints public GridBagConstraints(int gridx, int gridy, int gridwidth, int gridheight, double weightx, double weighty, int anchor, int fill, Insets insets, int ipadx, int ipady)
　すべてのフィールドを渡された引数に設定して GridBagConstraints オブジェクトを作成します。注:このコンストラクタを使用するとソースコードが読みにくくなるので、このコンストラクタは自動ソースコード生成ツールでのみ使用してください。
　
　パラメータ:
　　　gridx - 初期 gridx 値
　　　gridy - 初期 gridy 値
　　　gridwidth - 初期 gridwidth 値
　　　gridheight - 初期 gridheight 値
　　　weightx - 初期 weightx 値
　　　weighty - 初期 weighty 値
　　　anchor - 初期 anchor 値
　　　fill - 初期 fill 値
　　　insets - 初期 insets 値
　　　ipadx - 初期 ipadx 値
　　　ipady - 初期 ipady 値

　
　大きく分類すると設定項目は「gridx, gridy, gridwidth, gridheight」「weightx, weighty」「anchor」「fill」「insets」「ipadx, ipady」の6つの項目に分けられます。先ほども記述したとおり、こちらのコンストラクタを使って全ての項目を一度に設定してオブジェクトを作成することはあまりありません。
　
　実際に設定を行うには各設定項目に対応したフィールドが用意されていますのでフィールドに値を設定することで行います。
　

フィールド名設定内容

gridx コンポーネントの表示領域のリーディングエッジを含むセルを指定します。

gridy コンポーネントの表示領域の上部にセルを指定します。

gridwidth コンポーネントの表示領域の 1 行のセル数を指定します。

gridheight コンポーネントの表示領域の 1 列のセル数を指定します。

weightx 余分の水平スペースを分配する方法を指定します。

weighty 垂直の余分なスペースを分配する方法を指定します。

anchor このフィールドはコンポーネントがその表示領域より小さい場合に使用されます。

fill コンポーネントの表示領域がコンポーネントの必須サイズよりも大きいときに使用されます。

insets コンポーネントの外側のパディング、つまりコンポーネントとその表示領域の端までの領域の最小値を指定します。

ipadx コンポーネントの内側のパディング、つまりコンポーネントの最小幅に追加する領域の値を指定します。

ipady コンポーネントの内側のパディング、つまりコンポーネントの最小の高さに追加する領域の値を指定します。

　
　実際の使い方は次のようになります。

JPanel panel = new JPanel(); panel.setLayout(new GridBagLayout()); JButton button = new JButton("button"); GridBagConstraints gbc = new GridBagConstraints(); gbc.gridx = 0; gbc.gridy = 0; layout.setConstraints(button, gbc); p.add(button);
　では次のページ以降でそれぞれのフィールドに関する解説と利用方法を確認します。

[ 目次 ]

コンポーネントを配置するセルを設定する

　
　GridBagLayoutをレイアウトマネージャーとして利用する場合、まず対象のコンテナをいくつかのセルに分割して考えます。少し分かりにくいのですが領域全体を何行×何列に分割するわけではありません。どのように考えるのかは次を見て下さい。
　
　(1)まずコンポーネント1を1つ配置します。このコンポーネントを配置した場所を(0,0)とします。
　

　
　(2)次にコンポーネント2をコンポーネント1の右側に配置します。この場合、配置した場所は(1,0)となります。
　

　
　(3)次にコンポーネント3をコンポーネント2の下型に配置します。この場合、配置した場所は(1,1)となります。
　

　
　(4)最後にコンポーネント4をコンポーネント3の右側に配置します。この場合、配置した場所は(2,1)となります。
　

　
　今回のようにコンポーネントを配置した場合は3行×2列のグリッドが作成されています。各行や各列はその中に含まれる最大のコンポーネントの幅や高さに合わせられます。また1つ1つのセルの中では中央にコンポーネントは配置されます(これらは別のフィールドで設定できます)。
　
　またデフォルトの設定ではこのグリッド全体は、レイアウトマネージャーを設定したパネルやフレームの中央に配置されます。
　

　
　注意頂きたいのは事前に領域を何行×何列に分割すると設定しているわけではなく、追加されたコンポーネントの数に応じて自動的にグリッドが分けられていくということです。
　

gridxフィールドとgridyフィールドでセルを指定する
　実際にコンポーネントをどのセルに配置するかを設定するには「gridx」フィールドと「gridy」フィールドに設定します。
　

gridx public int gridx
　コンポーネントの表示領域のリーディングエッジを含むセルを指定します。この場合、行の最初のセルは gridx=0 を持ちます。コンポーネントの表示領域のリーディングエッジは、水平方向に左から右方向のコンテナに対して左端、および水平方向に右から左方向のコンテナに対して右端になります。値 RELATIVEは、コンポーネントを、このコンポーネントが追加される直前にコンテナに追加されたコンポーネントの直後に配置するように指定します。
　
　デフォルト値は RELATIVE です。gridx には負の値を指定することはできません。

　
　

gridy public int gridy
　コンポーネントの表示領域の上部にセルを指定します。上端のセルは gridy=0 を持ちます。値 RELATIVE は、このコンポーネントを直前にコンテナに追加されたコンポーネントの真下に配置するように指定します。
　
　デフォルト値は RELATIVE です。gridy には負の値を指定することはできません。

　
　実際の使い方は次のようになります。

JPanel panel = new JPanel(); panel.setLayout(new GridBagLayout()); JButton button1 = new JButton("button1"); JButton button2 = new JButton("button2"); JButton button3 = new JButton("button3"); JButton button4 = new JButton("button4"); GridBagConstraints gbc = new GridBagConstraints(); gbc.gridx = 0; gbc.gridy = 0; layout.setConstraints(button1, gbc); gbc.gridx = 1; gbc.gridy = 0; layout.setConstraints(button2, gbc); gbc.gridx = 1; gbc.gridy = 1; layout.setConstraints(button3, gbc); gbc.gridx = 2; gbc.gridy = 1; layout.setConstraints(button4, gbc); p.add(button1); p.add(button2); p.add(button3); p.add(button4);
　この例のようにGridBagConstraintsクラスのオブジェクトは「setConstraints」メソッドを使ってコンポーネントに対する制約を設定した後で別の値に書き換えてしまっても既に設定した制約には影響はありません。その為、一度作成したGridBagConstraintsクラスのオブジェクトを使いまわして利用することが出来ます。
　
　ただし使いまわしする場合はそれまでに設定した値がクリアされるわけではないので注意して下さい。先ほどの例は次のように書いても大丈夫です。

JPanel panel = new JPanel(); panel.setLayout(new GridBagLayout()); JButton button1 = new JButton("button1"); JButton button2 = new JButton("button2"); JButton button3 = new JButton("button3"); JButton button4 = new JButton("button4"); GridBagConstraints gbc = new GridBagConstraints(); gbc.gridx = 0; gbc.gridy = 0; layout.setConstraints(button1, gbc); gbc.gridx = 1; layout.setConstraints(button2, gbc); gbc.gridy = 1; layout.setConstraints(button3, gbc); gbc.gridx = 2; layout.setConstraints(button4, gbc); p.add(button1); p.add(button2); p.add(button3); p.add(button4);
　

サンプルプログラム
　下記のサンプルを実行してみよう。

/** * コンポーネントを配置するセルを設定する */ import javax.swing.*; import java.awt.Font; import java.awt.GridBagLayout; import java.awt.GridBagConstraints; import java.awt.BorderLayout; public class GridBagLayoutTest1 extends JFrame{ public static void main(String[] args){ GridBagLayoutTest1 frame = new GridBagLayoutTest1(); frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); frame.setBounds(10, 10, 300, 200); frame.setTitle("タイトル"); frame.setVisible(true); } GridBagLayoutTest1(){ GridBagLayout layout = new GridBagLayout(); JPanel p = new JPanel(); p.setLayout(layout); GridBagConstraints gbc = new GridBagConstraints(); JButton button1 = new JButton("Google"); gbc.gridx = 0; gbc.gridy = 0; layout.setConstraints(button1, gbc); JButton button2 = new JButton("Yahoo!"); button2.setFont(new Font("Arial", Font.PLAIN, 30)); gbc.gridx = 1; gbc.gridy = 0; layout.setConstraints(button2, gbc); JButton button3 = new JButton("MSN"); gbc.gridx = 1; gbc.gridy = 1; layout.setConstraints(button3, gbc); p.add(button1); p.add(button2); p.add(button3); getContentPane().add(p, BorderLayout.CENTER); } }
　上記をコンパイルした後で実行すると次のように表示されます。
　

　
　実際にどのように配置されているのかを線を描いています。
　

[ 目次 ]

コンポーネントが占めるセル数を設定する

　
　前項の「gridx」フィールド及び「gridy」フィールドでは配置したいコンポーネントがグリッド内のどのセルに配置するかを指定しました。ここでは複数のセル位置にまたがってコンポーネントを配置する方法を確認します。「gridx」フィールド及び「gridy」フィールドで指定したセル位置から水平方向及び垂直方向にいくつのセルにまたがってコンポーネントを配置するのかを指定します。
　
　水平方向及び垂直方向にいくつのセルにまたがるのかを指定するには「gridwidth」フィールドと「gridheight」フィールドに設定します。
　

gridwidth public int gridwidth
　コンポーネントの表示領域の 1 行のセル数を指定します。
　
　REMAINDER を使用して、コンポーネントの表示領域が gridx から行の最後のセルまでであることを指定します。RELATIVE を使用して、コンポーネントの表示領域が gridx からその行の最後の 1 つ手前のセルまでであることを指定します。
　
　gridwidth には負の値を指定することはできません。デフォルト値は 1 です。

　
　

gridheight public int gridheight
　コンポーネントの表示領域の 1 列のセル数を指定します。
　
　REMAINDER を使用して、コンポーネントの表示領域が gridy から列の最後のセルまでであることを指定します。RELATIVE を使用して、コンポーネントの表示領域が gridy からその列の最後の 1 つ手前のセルまでであることを指定します。
　
　gridheight には負の値を指定することはできません。デフォルト値は 1 です。

　
　「gridwidth」フィールドには対象のコンポーネントが占める水平方向のセル数を指定します。また「gridheight」フィールドには同じく垂直方向のセル数を指定します。デフォルトはどちらも「1」です。
　
　実際の使い方は次のようになります。

JPanel panel = new JPanel(); panel.setLayout(new GridBagLayout()); JButton button1 = new JButton("button1"); JButton button2 = new JButton("button2"); GridBagConstraints gbc = new GridBagConstraints(); gbc.gridx = 0; gbc.gridy = 0; gbc.gridwidth = 1; gbc.gridheight = 2; layout.setConstraints(button1, gbc); gbc.gridx = 1; gbc.gridy = 0; gbc.gridwidth = 1; gbc.gridheight = 1; layout.setConstraints(button2, gbc); p.add(button1); p.add(button2);
　また次のように書いても大丈夫です。

JPanel panel = new JPanel(); panel.setLayout(new GridBagLayout()); JButton button1 = new JButton("button1"); JButton button2 = new JButton("button2"); JButton button3 = new JButton("button3"); JButton button4 = new JButton("button4"); GridBagConstraints gbc = new GridBagConstraints(); gbc.gridx = 0; gbc.gridy = 0; gbc.gridheight = 2; layout.setConstraints(button1, gbc); gbc.gridx = 1; gbc.gridheight = 1; layout.setConstraints(button2, gbc); gbc.gridy = 1; layout.setConstraints(button3, gbc); gbc.gridx = 2; layout.setConstraints(button4, gbc); p.add(button1); p.add(button2); p.add(button3); p.add(button4);
　

サンプルプログラム
　下記のサンプルを実行してみよう。

/** * コンポーネントが占めるセル数を設定する */ import javax.swing.*; import java.awt.Font; import java.awt.GridBagLayout; import java.awt.GridBagConstraints; import java.awt.BorderLayout; public class GridBagLayoutTest2 extends JFrame{ public static void main(String[] args){ GridBagLayoutTest2 frame = new GridBagLayoutTest2(); frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); frame.setBounds(10, 10, 300, 200); frame.setTitle("タイトル"); frame.setVisible(true); } GridBagLayoutTest2(){ GridBagLayout layout = new GridBagLayout(); JPanel p = new JPanel(); p.setLayout(layout); GridBagConstraints gbc = new GridBagConstraints(); JButton button1 = new JButton("Google"); gbc.gridx = 0; gbc.gridy = 0; gbc.gridheight = 2; layout.setConstraints(button1, gbc); JButton button2 = new JButton("Yahoo!"); button2.setFont(new Font("Arial", Font.PLAIN, 30)); gbc.gridx = 1; gbc.gridy = 0; gbc.gridheight = 1; layout.setConstraints(button2, gbc); JButton button3 = new JButton("MSN"); gbc.gridx = 1; gbc.gridy = 1; layout.setConstraints(button3, gbc); p.add(button1); p.add(button2); p.add(button3); getContentPane().add(p, BorderLayout.CENTER); } }
　上記をコンパイルした後で実行すると次のように表示されます。
　

　
　実際にどのように配置されているのかを線を描いています。
　

　
　今回は一番左のコンポーネントが縦方向に2つのセルを占めるように設定してあります。このコンポーネントは2つのセルを結合したセルの中で中央に表示されています。

[ 目次 ]

余分な領域の配分方法を設定する

　
　デフォルトの設定では各コンポーネントを配置したグリッド全体はフレームやパネルの中央に配置されました。
　

　
　今回設定を行う余分な領域とはコンポーネントなどが配置されているグリッド全体とフレームやパネルなどのコンテナとの間の何も配置されていない領域のことです。具体的には次の図のピンクの部分となります。
　

　
　この余分な領域をどのコンポーネントに割り振るのかを設定する方法を確認します。水平方向の設定には「weightx」フィールドに設定し垂直方向の設定には「weighty」フィールドに設定します。
　

weightx public double weightx
　余分の水平スペースを分配する方法を指定します。
　
　グリッドバッグレイアウトマネージャーは、1 列のウェイトが 1 列のすべてのコンポーネントの最大の weightx になるように計算します。結果のレイアウトが塗りつぶす必要のある領域の幅より小さい場合、余分のスペースが各列のウェイトに比例して分配されます。ウェイトがゼロの列には、余分のスペースは分配されません。
　
　すべてのウェイトがゼロの場合、すべての余分のスペースがセルのグリッドと左右両端の間に表示されます。
　
　このフィールドのデフォルト値は 0 です。weightx には負の値を指定することはできません。

　
　

weighty public double weighty
　垂直の余分なスペースを分配する方法を指定します。
　
　グリッドバッグレイアウトマネージャーは、1 行のウェイトが 1 行のすべてのコンポーネントの最大の weighty になるように計算します。結果のレイアウトが塗りつぶす必要のある領域の高さより小さい場合、余分のスペースが各行のウェイトに比例して分配されます。ウェイトがゼロの行には、余分のスペースは分配されません。
　
　すべてのウェイトがゼロの場合、すべての余分のスペースがセルのグリッドと上下の両端の間に表示されます。
　
　このフィールドのデフォルト値は 0 です。weighty には負の値を指定することはできません。

　
　引数にはコンポーネントに設定する重み付けの値をdouble型の値で指定します。
　
　例として水平方向で考えてみます。
　

　
　各コンポーネントに「weightx」を使って水平方向の重み付けを行います。同じ列に含まれるコンポーネントの場合は最大のコンポーネントの重み付けが有効となりますので2列目は「0.5d」が有効です。
　
　余分な領域の配分方法はこの重み付けの比率に従って割り振られます。一番左の水色のコンポーネントは1.0d/(1.0d+0.5d+0.6d)=0.48となりますので余分な領域の約半分は水色に割り振られます。そして2列目と3列目には概ね1/4ずつの領域が割り振られることになります。
　
　全てのコンポーネントの重み付けが「0」だった場合には、コンポーネント全体の左右(又は上下)にそれぞれ余分な領域が配置されます。これがデフォルトの場合の動作です。
　
　実際の使い方は次のようになります。

JPanel panel = new JPanel(); panel.setLayout(new GridBagLayout()); JButton button1 = new JButton("button1"); JButton button2 = new JButton("button2"); GridBagConstraints gbc = new GridBagConstraints(); gbc.gridx = 0; gbc.gridy = 0; gbc.gridwidth = 1; gbc.gridheight = 2; gbc.weightx = 1.0d; gbc.weighty = 1.0d; layout.setConstraints(button1, gbc); gbc.gridx = 1; gbc.gridy = 0; gbc.gridwidth = 1; gbc.gridheight = 1; gbc.weightx = 0.5d; gbc.weighty = 0.0d; layout.setConstraints(button2, gbc); p.add(button1); p.add(button2);
　

サンプルプログラム
　下記のサンプルを実行してみよう。

/** * 余分な領域の配分方法を設定する */ import javax.swing.*; import java.awt.Font; import java.awt.GridBagLayout; import java.awt.GridBagConstraints; import java.awt.BorderLayout; public class GridBagLayoutTest3 extends JFrame{ public static void main(String[] args){ GridBagLayoutTest3 frame = new GridBagLayoutTest3(); frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); frame.setBounds(10, 10, 300, 200); frame.setTitle("タイトル"); frame.setVisible(true); } GridBagLayoutTest3(){ GridBagLayout layout = new GridBagLayout(); JPanel p = new JPanel(); p.setLayout(layout); GridBagConstraints gbc = new GridBagConstraints(); JButton button1 = new JButton("Google"); gbc.gridx = 0; gbc.gridy = 0; gbc.gridheight = 2; gbc.weightx = 1.0d; gbc.weighty = 1.0d; layout.setConstraints(button1, gbc); JButton button2 = new JButton("Yahoo!"); button2.setFont(new Font("Arial", Font.PLAIN, 30)); gbc.gridx = 1; gbc.gridy = 0; gbc.gridheight = 1; gbc.weightx = 1.0d; gbc.weighty = 1.0d; layout.setConstraints(button2, gbc); JButton button3 = new JButton("MSN"); gbc.gridx = 1; gbc.gridy = 1; gbc.weightx = 1.0d; gbc.weighty = 1.0d; layout.setConstraints(button3, gbc); p.add(button1); p.add(button2); p.add(button3); getContentPane().add(p, BorderLayout.CENTER); } }
　上記をコンパイルした後で実行すると次のように表示されます。
　

　
　今回は全てのコンポーネントの水平方向及び垂直方向に同じ重み付けを設定してあります。その為、水平方向及び垂直方向の余分な領域は各コンポーネントに均等に割り当てられています。実際にどのように配置されているのかを線を描くと次のようになります。
　

　

他のサンプルプログラム
　ではもう一つ別のサンプルを試してみます。
　

サンプルプログラム
　下記のサンプルを実行してみよう。

import javax.swing.*; import java.awt.Font; import java.awt.GridBagLayout; import java.awt.GridBagConstraints; import java.awt.BorderLayout; public class GridBagLayoutTest4 extends JFrame{ public static void main(String[] args){ GridBagLayoutTest4 frame = new GridBagLayoutTest4(); frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); frame.setBounds(10, 10, 300, 200); frame.setTitle("タイトル"); frame.setVisible(true); } GridBagLayoutTest4(){ GridBagLayout layout = new GridBagLayout(); JPanel p = new JPanel(); p.setLayout(layout); GridBagConstraints gbc = new GridBagConstraints(); JButton button1 = new JButton("Google"); gbc.gridx = 0; gbc.gridy = 0; gbc.gridheight = 2; gbc.weightx = 1.0d; gbc.weighty = 0.0d; layout.setConstraints(button1, gbc); JButton button2 = new JButton("Yahoo!"); button2.setFont(new Font("Arial", Font.PLAIN, 30)); gbc.gridx = 1; gbc.gridy = 0; gbc.gridheight = 1; gbc.weightx = 0.0d; gbc.weighty = 1.0d; layout.setConstraints(button2, gbc); JButton button3 = new JButton("MSN"); gbc.gridx = 1; gbc.gridy = 1; gbc.weightx = 0.0d; gbc.weighty = 0.5d; layout.setConstraints(button3, gbc); p.add(button1); p.add(button2); p.add(button3); getContentPane().add(p, BorderLayout.CENTER); } }
　上記をコンパイルした後で実行すると次のように表示されます。
　

　
　今度のサンプルでは水平方向の重み付けを1列目のコンポーネントに100％となるようにしました。その為、水平方向の余分な領域は全て1列目のコンポーネントに割り当てられています。
　
　垂直方向の重み付けは2列目の1行目にあるコンポーネントを2に対して2行目のコンポーネントを1にしました。よって垂直方向の余分な領域は全体の2/3が1行目のコンポーネントに割り当てられ全体の1/3が2行目のコンポーネントに割り当てられます。
　

[ 目次 ]

セル内でのコンポーネントの表示位置を設定する

　
　コンポーネントをセルに配置する場合、セルの大きさよりもコンポーネントの大きさが小さい時にはセルの中央にコンポーネントが配置されます。このようにセルの大きさとコンポーネントの大きさが異なる場合にセル内のどの位置にコンポーネントを表示するのかを指定することが出来ます。
　
　セル内の表示位置を設定するには「anchor」フィールドに設定します。
　

anchor public int anchor
　このフィールドはコンポーネントがその表示領域より小さい場合に使用されます。これは表示領域内にコンポーネントを配置する場所を指定します。
　
　方向相対値、ベースライン相対値、および絶対値の 3 種類の値があります。方向相対値は、コンテナのコンポーネントの方向プロパティーを基準に解釈され、ベースライン相対値はベースラインを基準に解釈されます。絶対値の解釈はありません。
　
　絶対値には以下のものがあります。CENTER、NORTH、NORTHEAST、EAST、SOUTHEAST、SOUTH、SOUTHWEST、WEST、および NORTHWEST です。
　
　方向相対値には以下のものがあります。PAGE_START、PAGE_END、LINE_START、LINE_END、FIRST_LINE_START、FIRST_LINE_END、LAST_LINE_START、および LAST_LINE_END です。
　
　ベースライン相対値には以下のものがあります。BASELINE、BASELINE_LEADING、BASELINE_TRAILING、ABOVE_BASELINE、ABOVE_BASELINE_LEADING、ABOVE_BASELINE_TRAILING、BELOW_BASELINE、BELOW_BASELINE_LEADING、および BELOW_BASELINE_TRAILING です。デフォルト値は CENTER です。

　
　指定方法は絶対値/方向相対値/ベースライン相対値の3種類がありますがどれか統一して使っておけば結構です。
　
　絶対値の指定方法：
　

NORTHWEST NORTH NORTHEAST

WEST CENTER EAST

SOUTHWEST SOUTH SOUTHEAST

　
　方向相対値の指定方法：
　

FIRST_LINE_START PAGE_START FIRST_LINE_END

LINE_START CENTER LINE_END

LAST_LINE_START PAGE_END LAST_LINE

　
　実際の使い方は次のようになります。

JPanel panel = new JPanel(); panel.setLayout(new GridBagLayout()); JButton button1 = new JButton("button1"); JButton button2 = new JButton("button2"); GridBagConstraints gbc = new GridBagConstraints(); gbc.gridx = 0; gbc.gridy = 0; gbc.gridwidth = 1; gbc.gridheight = 2; gbc.weightx = 1.0d; gbc.anchor = GridBagConstraints.NORTH; layout.setConstraints(button1, gbc); gbc.gridx = 1; gbc.gridy = 0; gbc.gridwidth = 1; gbc.gridheight = 1; gbc.weightx = 1.0d; gbc.anchor = GridBagConstraints.CENTER; layout.setConstraints(button2, gbc); p.add(button1); p.add(button2);
　

サンプルプログラム
　下記のサンプルを実行してみよう。

/** * セル内でのコンポーネントの表示位置を設定する */ import javax.swing.*; import java.awt.Font; import java.awt.GridBagLayout; import java.awt.GridBagConstraints; import java.awt.BorderLayout; public class GridBagLayoutTest5 extends JFrame{ public static void main(String[] args){ GridBagLayoutTest5 frame = new GridBagLayoutTest5(); frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); frame.setBounds(10, 10, 300, 200); frame.setTitle("タイトル"); frame.setVisible(true); } GridBagLayoutTest5(){ GridBagLayout layout = new GridBagLayout(); JPanel p = new JPanel(); p.setLayout(layout); GridBagConstraints gbc = new GridBagConstraints(); JButton button1 = new JButton("Google"); gbc.gridx = 0; gbc.gridy = 0; gbc.gridheight = 2; gbc.weightx = 1.0d; gbc.weighty = 1.0d; gbc.anchor = GridBagConstraints.NORTHWEST; layout.setConstraints(button1, gbc); JButton button2 = new JButton("Yahoo!"); button2.setFont(new Font("Arial", Font.PLAIN, 30)); gbc.gridx = 1; gbc.gridy = 0; gbc.gridheight = 1; gbc.weightx = 1.0d; gbc.weighty = 1.0d; gbc.anchor = GridBagConstraints.NORTHEAST; layout.setConstraints(button2, gbc); JButton button3 = new JButton("MSN"); gbc.gridx = 1; gbc.gridy = 1; gbc.weightx = 1.0d; gbc.weighty = 1.0d; gbc.anchor = GridBagConstraints.SOUTH; layout.setConstraints(button3, gbc); p.add(button1); p.add(button2); p.add(button3); getContentPane().add(p, BorderLayout.CENTER); } }
　上記をコンパイルした後で実行すると次のように表示されます。
　

　
　今回は左上、右上、中央下にそれぞれコンポーネントを配置しました。分かりやすいように線を引いてみました。
　

[ 目次 ]

セル内でのコンポーネントのサイズを変更する

　
　コンポーネントをセルに配置する場合、セルの大きさよりもコンポーネントの大きさが小さい時にコンポーネントのサイズを変更するかどうかを指定します。
　
　コンポーネントのサイズを変更するには「fill」フィールドに設定します。
　

fill public int fill
　コンポーネントの表示領域がコンポーネントの必須サイズよりも大きいときに使用されます。これは、コンポーネントをサイズ変更するかどうかを指定し、サイズ変更を行う場合にはその方法も指定します。
　
　fill には、次の値が有効です。
　
　
　　　NONE:コンポーネントのサイズを変更しません。
　　　HORIZONTAL:コンポーネントの幅を水平表示領域の最大サイズにし、高さは変更しません。
　　　VERTICAL:コンポーネントの高さを垂直表示領域の最大サイズにし、幅は変更しません。
　　　BOTH:コンポーネントを表示領域の最大サイズにします。
　
　デフォルト値は NONE です。

　
　サイズを調整するかどうかを表す値を指定します。指定可能な値は次の通りです。
　

値サイズの変更方法

GridBagConstraints.NONE サイズを変更しません

GridBagConstraints.HORIZONTAL 水平方向にいっぱいまで拡大する

GridBagConstraints.VERTICAL 垂直方向にいっぱいまで拡大する

GridBagConstraints.BOTH 水平及び垂直方向にいっぱいまで拡大する

　
　実際の使い方は次のようになります。

JPanel panel = new JPanel(); panel.setLayout(new GridBagLayout()); JButton button1 = new JButton("button1"); JButton button2 = new JButton("button2"); GridBagConstraints gbc = new GridBagConstraints(); gbc.gridx = 0; gbc.gridy = 0; gbc.gridwidth = 1; gbc.gridheight = 2; gbc.weightx = 1.0d; gbc.fill = GridBagConstraints.BOTH; layout.setConstraints(button1, gbc); gbc.gridx = 1; gbc.gridy = 0; gbc.gridwidth = 1; gbc.gridheight = 1; gbc.weightx = 1.0d; gbc.fill = GridBagConstraints.HORIZONTAL; layout.setConstraints(button2, gbc); p.add(button1); p.add(button2);
　

サンプルプログラム
　下記のサンプルを実行してみよう。

/** * セル内でのコンポーネントのサイズを変更する */ import javax.swing.*; import java.awt.Font; import java.awt.GridBagLayout; import java.awt.GridBagConstraints; import java.awt.BorderLayout; public class GridBagLayoutTest6 extends JFrame{ public static void main(String[] args){ GridBagLayoutTest6 frame = new GridBagLayoutTest6(); frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); frame.setBounds(10, 10, 300, 200); frame.setTitle("タイトル"); frame.setVisible(true); } GridBagLayoutTest6(){ GridBagLayout layout = new GridBagLayout(); JPanel p = new JPanel(); p.setLayout(layout); GridBagConstraints gbc = new GridBagConstraints(); JButton button1 = new JButton("Google"); gbc.gridx = 0; gbc.gridy = 0; gbc.gridheight = 2; gbc.weightx = 1.0d; gbc.weighty = 1.0d; gbc.fill = GridBagConstraints.VERTICAL; layout.setConstraints(button1, gbc); JButton button2 = new JButton("Yahoo!"); button2.setFont(new Font("Arial", Font.PLAIN, 30)); gbc.gridx = 1; gbc.gridy = 0; gbc.gridheight = 1; gbc.weightx = 1.0d; gbc.weighty = 1.0d; gbc.fill = GridBagConstraints.BOTH; layout.setConstraints(button2, gbc); JButton button3 = new JButton("MSN"); gbc.gridx = 1; gbc.gridy = 1; gbc.weightx = 1.0d; gbc.weighty = 1.0d; gbc.fill = GridBagConstraints.HORIZONTAL; layout.setConstraints(button3, gbc); p.add(button1); p.add(button2); p.add(button3); getContentPane().add(p, BorderLayout.CENTER); } }
　上記をコンパイルした後で実行すると次のように表示されます。
　

　
　今回は全てのコンポーネントをデフォルトの中央に表示した状態で左側のコンポーネントは垂直方向に拡大し、右上のコンポーネントは水平及び垂直方向に拡大、右下のコンポーネントは水平方向に拡大しています。分かりやすいように各セルを線で囲んで表示すると次のようになります。
　

[ 目次 ]

コンポーネントの余白を設定する

　
　コンポーネントをセルに配置する場合、コンポーネントとセルとの間の余白の最小値を設定します。例えばセル内でコンポーネントを最大に拡大した場合でも少なくとも設定される余白となります。あくまで余白の最小値ですので、コンポーネントのサイズに余白を足した領域が配置するセルの領域よりも小さかったとしてもコンポーネントが拡大されるということはありません。
　
　コンポーネントの余白を設定するには「insets」フィールドに設定します。
　

insets public Insets insets
　コンポーネントの外側のパディング、つまりコンポーネントとその表示領域の端までの領域の最小値を指定します。
　
　デフォルト値は new Insets(0, 0, 0, 0) です。

　
　余白のサイズをInsetsクラスのオブジェクトを使って設定します。Insetsクラスについては『Insetsクラス』を参照して下さい。
　
　実際の使い方は次のようになります。

JPanel panel = new JPanel(); panel.setLayout(new GridBagLayout()); JButton button1 = new JButton("button1"); JButton button2 = new JButton("button2"); GridBagConstraints gbc = new GridBagConstraints(); gbc.gridx = 0; gbc.gridy = 0; gbc.gridwidth = 1; gbc.gridheight = 2; gbc.weightx = 1.0d; gbc.fill = GridBagConstraints.BOTH; gbc.insets = new Insets(10, 10, 10, 10); layout.setConstraints(button1, gbc); gbc.gridx = 1; gbc.gridy = 0; gbc.gridwidth = 1; gbc.gridheight = 1; gbc.weightx = 1.0d; gbc.fill = GridBagConstraints.VERTICAL; gbc.insets = new Insets(10, 0, 10, 0); layout.setConstraints(button2, gbc); p.add(button1); p.add(button2);
　

サンプルプログラム
　下記のサンプルを実行してみよう。

/** * コンポーネントの余白を設定する */ import javax.swing.*; import java.awt.Font; import java.awt.Insets; import java.awt.GridBagLayout; import java.awt.GridBagConstraints; import java.awt.BorderLayout; public class GridBagLayoutTest7 extends JFrame{ public static void main(String[] args){ GridBagLayoutTest7 frame = new GridBagLayoutTest7(); frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); frame.setBounds(10, 10, 300, 200); frame.setTitle("タイトル"); frame.setVisible(true); } GridBagLayoutTest7(){ GridBagLayout layout = new GridBagLayout(); JPanel p = new JPanel(); p.setLayout(layout); GridBagConstraints gbc = new GridBagConstraints(); JButton button1 = new JButton("Google"); gbc.gridx = 0; gbc.gridy = 0; gbc.gridheight = 2; gbc.weightx = 1.0d; gbc.weighty = 1.0d; gbc.fill = GridBagConstraints.VERTICAL; gbc.insets = new Insets(30, 0, 30, 0); layout.setConstraints(button1, gbc); JButton button2 = new JButton("Yahoo!"); button2.setFont(new Font("Arial", Font.PLAIN, 30)); gbc.gridx = 1; gbc.gridy = 0; gbc.gridheight = 1; gbc.weightx = 1.0d; gbc.weighty = 1.0d; gbc.fill = GridBagConstraints.BOTH; gbc.insets = new Insets(15, 15, 15, 15); layout.setConstraints(button2, gbc); JButton button3 = new JButton("MSN"); gbc.gridx = 1; gbc.gridy = 1; gbc.weightx = 1.0d; gbc.weighty = 1.0d; gbc.fill = GridBagConstraints.HORIZONTAL; gbc.insets = new Insets(0, 0, 0, 0); layout.setConstraints(button3, gbc); p.add(button1); p.add(button2); p.add(button3); getContentPane().add(p, BorderLayout.CENTER); } }
　上記をコンパイルした後で実行すると次のように表示されます。
　

　
　今回は左側のコンポーネントは垂直方向に拡大させた状態で上と下に10ピクセルの余白を設定しています。また右上のコンポーネントは水平及び垂直方向に拡大させた状態で上下左右に5ピクセルの余白を設定しています。分かりやすいように各セルを線で囲んで表示すると次のようになります。
　

[ 目次 ]

コンポーネントの最小サイズを変更する

　
　コンポーネントが本来持っているサイズに対して水平方向及び垂直方向のパディングを設定しコンポーネントの最小サイズを変更する方法を確認します。コンポーネントは本来のサイズにこのフィールドで設定した値を加えた値がが最小のサイズとなります。
　
　コンポーネントのパディングを設定するには「ipadx」フィールド及び「ipady」フィールドに設定します。
　

ipadx public int ipadx
　コンポーネントの内側のパディング、つまりコンポーネントの最小幅に追加する領域の値を指定します。コンポーネントの幅は、少なくともその最小幅に ipadx ピクセルを足したものです。
　
　デフォルト値は 0 です。

　
　

ipady public int ipady
　コンポーネントの内側のパディング、つまりコンポーネントの最小の高さに追加する領域の値を指定します。コンポーネントの高さは、少なくともその最小の高さに ipady ピクセルを足したものです。
　
　デフォルト値は 0 です。

　
　水平方向及び垂直方向の追加するパディングの大きさをint型の値で指定します。単位はピクセルです。
　
　実際の使い方は次のようになります。

JPanel panel = new JPanel(); panel.setLayout(new GridBagLayout()); JButton button1 = new JButton("button1"); JButton button2 = new JButton("button2"); GridBagConstraints gbc = new GridBagConstraints(); gbc.gridx = 0; gbc.gridy = 0; gbc.ipadx = 5; gbc.ipady = 5; layout.setConstraints(button1, gbc); gbc.gridx = 1; gbc.gridy = 0; gbc.ipadx = 0; gbc.ipady = 0; layout.setConstraints(button2, gbc); p.add(button1); p.add(button2);
　

サンプルプログラム
　下記のサンプルを実行してみよう。

/** * コンポーネントの最小サイズを変更する */ import javax.swing.*; import java.awt.Font; import java.awt.GridBagLayout; import java.awt.GridBagConstraints; import java.awt.BorderLayout; public class GridBagLayoutTest8 extends JFrame{ public static void main(String[] args){ GridBagLayoutTest8 frame = new GridBagLayoutTest8(); frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE); frame.setBounds(10, 10, 300, 200); frame.setTitle("タイトル"); frame.setVisible(true); } GridBagLayoutTest8(){ GridBagLayout layout = new GridBagLayout(); JPanel p = new JPanel(); p.setLayout(layout); GridBagConstraints gbc = new GridBagConstraints(); JButton button1 = new JButton("Google"); gbc.gridx = 0; gbc.gridy = 0; gbc.gridheight = 2; gbc.ipadx = 10; layout.setConstraints(button1, gbc); JButton button2 = new JButton("Yahoo!"); button2.setFont(new Font("Arial", Font.PLAIN, 30)); gbc.gridx = 1; gbc.gridy = 0; gbc.gridheight = 1; gbc.ipadx = 0; gbc.ipady = 20; layout.setConstraints(button2, gbc); JButton button3 = new JButton("MSN"); gbc.gridx = 1; gbc.gridy = 1; gbc.ipady = 0; layout.setConstraints(button3, gbc); p.add(button1); p.add(button2); p.add(button3); getContentPane().add(p, BorderLayout.CENTER); } }
　上記をコンパイルした後で実行すると次のように表示されます。
　

　
　今回は左側のコンポーネントは水平方向に10ピクセル、右上のコンポーネントは垂直方向に20ピクセル、パディングを設定しています。設定したパディングの大きさだけコンポーネントのサイズは大きくなっています。
　
　下記は同じ設定で「ipadx」フィールド及び「ipady」フィールドが「0」の場合です。見比べてみて下さい。
　

[ 目次 ]

リリースノート

2024/10/11 Ver=2.04 JDK_23 で確認
2023/04/22 Ver=2.03 JDK_20 で確認
2021/11/29 Ver=1.04 JDK_17 で確認
2021/08/06 Ver=1.03 JDK_16 で確認
2020/10/20 Ver=1.02 JDK_15 で確認
2017/01/08 Ver=1.01 初版リリース

[ 目次 ]

関連ページ

[ 目次 ]