Класс GridBagLayout

Каждый компонент, управляемый объектом GridBagLayout, связан с экземпляром GridBagConstraints. Объект ограничений указывает, где на сетке должна располагаться область отображения компонента и как компонент следует разместить в пределах этой области. Помимо объекта ограничений, GridBagLayout учитывает минимальный и предпочтительный размеры каждого компонента, чтобы определить его размер.

Общая ориентация сетки зависит от свойства ComponentOrientation контейнера. При горизонтальной ориентации слева направо координата сетки (0,0) находится в верхнем левом углу контейнера, значение x увеличивается вправо, а значение y — вниз. При горизонтальной ориентации справа налево координата сетки (0,0) находится в верхнем правом углу контейнера, значение x увеличивается влево, а значение y — вниз.

Чтобы эффективно использовать компоновку GridBag, необходимо настроить один или несколько объектов GridBagConstraints, связанных с компонентами. Настройка объекта GridBagConstraints выполняется путём задания значений одной или нескольких его переменных экземпляра:

GridBagConstraints.gridx, GridBagConstraints.gridy

Указывает ячейку, содержащую начальный угол области отображения компонента. Ячейка в начале координат сетки имеет адрес gridx = 0, gridy = 0. При компоновке слева направо начальным углом компонента является его верхний левый угол. При компоновке справа налево начальным углом компонента является его верхний правый угол. Используйте GridBagConstraints.RELATIVE (значение по умолчанию), чтобы указать, что компонент следует разместить сразу после компонента, добавленного в контейнер непосредственно перед ним (вдоль оси x для gridx или оси y для gridy).

GridBagConstraints.gridwidth, GridBagConstraints.gridheight

Указывает количество ячеек в строке (для gridwidth) или столбце (для gridheight), занимаемых областью отображения компонента. Значение по умолчанию — 1. Используйте GridBagConstraints.REMAINDER, чтобы указать, что область отображения компонента должна простираться от gridx до последней ячейки строки (для gridwidth) или от gridy до последней ячейки столбца (для gridheight). Используйте GridBagConstraints.RELATIVE, чтобы указать, что область отображения компонента должна простираться от gridx до предпоследней ячейки строки (для gridwidth) или от gridy до предпоследней ячейки столбца (для gridheight).

GridBagConstraints.fill

Используется, если область отображения компонента больше запрошенного размера компонента, чтобы определить, следует ли и как именно изменить размер компонента. Возможные значения: GridBagConstraints.NONE (значение по умолчанию), GridBagConstraints.HORIZONTAL (растянуть компонент по горизонтали до ширины области отображения, не меняя его высоту), GridBagConstraints.VERTICAL (растянуть компонент по вертикали до высоты области отображения, не меняя его ширину) и GridBagConstraints.BOTH (растянуть компонент на всю область отображения).

GridBagConstraints.ipadx, GridBagConstraints.ipady

Указывает внутренние отступы компонента в компоновке — величину, добавляемую к минимальному размеру компонента. Ширина компонента будет не меньше его минимальной ширины плюс ipadx пикселей. Аналогично высота компонента будет не меньше его минимальной высоты плюс ipady пикселей.

GridBagConstraints.insets

Указывает внешние отступы компонента — минимальное расстояние между компонентом и границами его области отображения.

GridBagConstraints.anchor

Указывает, где следует разместить компонент в его области отображения. Возможны три вида значений: абсолютные, относительные к ориентации и относительные к базовой линии. Значения, относительные к ориентации, интерпретируются относительно свойства ComponentOrientation контейнера, тогда как абсолютные значения от него не зависят. Значения, относительные к базовой линии, рассчитываются относительно базовой линии. Допустимые значения:

• Абсолютные значения:
  • GridBagConstraints.NORTH
  • GridBagConstraints.SOUTH
  • GridBagConstraints.WEST
  • GridBagConstraints.EAST
  • GridBagConstraints.NORTHWEST
  • GridBagConstraints.NORTHEAST
  • GridBagConstraints.SOUTHWEST
  • GridBagConstraints.SOUTHEAST
  • GridBagConstraints.CENTER (по умолчанию)
• Значения, относительные к ориентации:
  • GridBagConstraints.PAGE_START
  • GridBagConstraints.PAGE_END
  • GridBagConstraints.LINE_START
  • GridBagConstraints.LINE_END
  • GridBagConstraints.FIRST_LINE_START
  • GridBagConstraints.FIRST_LINE_END
  • GridBagConstraints.LAST_LINE_START
  • GridBagConstraints.LAST_LINE_END
• Значения, относительные к базовой линии:
  • GridBagConstraints.BASELINE
  • GridBagConstraints.BASELINE_LEADING
  • GridBagConstraints.BASELINE_TRAILING
  • GridBagConstraints.ABOVE_BASELINE
  • GridBagConstraints.ABOVE_BASELINE_LEADING
  • GridBagConstraints.ABOVE_BASELINE_TRAILING
  • GridBagConstraints.BELOW_BASELINE
  • GridBagConstraints.BELOW_BASELINE_LEADING
  • GridBagConstraints.BELOW_BASELINE_TRAILING

GridBagConstraints.weightx, GridBagConstraints.weighty

Используется для определения распределения пространства, что важно при задании поведения при изменении размеров. Если не задать вес хотя бы для одного компонента в строке (weightx) и столбце (weighty), все компоненты будут сгруппированы в центре контейнера. Это происходит потому, что при нулевом весе (значение по умолчанию) объект GridBagLayout размещает всё свободное пространство между сеткой ячеек и границами контейнера.

У каждой строки может быть базовая линия; она определяется компонентами этой строки, у которых есть допустимая базовая линия и которые выровнены по ней (значение anchor компонента равно одному из BASELINE, BASELINE_LEADING или BASELINE_TRAILING). Если ни у одного компонента строки нет допустимой базовой линии, у строки базовой линии нет.

Если компонент охватывает несколько строк, он выравнивается либо по базовой линии начальной строки (если поведение при изменении размера относительно базовой линии равно CONSTANT_ASCENT), либо по базовой линии конечной строки (если это поведение равно CONSTANT_DESCENT). Строка, по которой выравнивается компонент, называется определяющей строкой.

На следующем рисунке показана компоновка по базовой линии, включающая компонент, охватывающий несколько строк:

• Панель, начинающаяся в строке 0 и заканчивающаяся в строке 1. Для панели задано поведение при изменении размера относительно базовой линии CONSTANT_DESCENT и anchor BASELINE. Поскольку поведение при изменении размера относительно базовой линии равно CONSTANT_DESCENT, определяющей строкой для панели является строка 1.
• Две кнопки, для каждой из которых задано поведение при изменении размера относительно базовой линии CENTER_OFFSET и anchor BASELINE.

Компоненты, размещённые с использованием одного из значений, относительных к базовой линии, при изменении размера ведут себя иначе, чем при размещении с использованием абсолютного значения или значения, относительного к ориентации. Изменение размеров компонентов определяется тем, как изменяется базовая линия определяющей строки. Базовая линия привязана к нижней границе области отображения, если у какого-либо компонента с той же определяющей строкой поведение при изменении размера относительно базовой линии равно CONSTANT_DESCENT; в противном случае базовая линия привязана к верхней границе области отображения. Поведение при изменении размера определяется следующими правилами:

• Компоненты с изменяемым размером, расположенные над базовой линией, могут увеличиваться по высоте только до её уровня. Например, если базовая линия находится на отметке 100 и привязана к верхней границе, компонент с изменяемым размером, расположенный над базовой линией, не может вырасти более чем на 100 единиц.
• Аналогично, компоненты с изменяемым размером, расположенные под базовой линией, могут увеличиваться по высоте только на величину, равную разнице между высотой области отображения и положением базовой линии.
• Компоненты с поведением при изменении размера относительно базовой линии OTHER, расположенные на базовой линии, изменяют размер только в том случае, если базовая линия при новом размере помещается в область отображения. Если базовая линия не помещается в область отображения, размер компонента не меняется.
• Компоненты, расположенные на базовой линии и не имеющие поведения при изменении размера относительно базовой линии OTHER, могут увеличиваться по высоте только до display height - baseline + baseline of component.

На следующих рисунках показаны десять компонентов (все — кнопки), управляемых компоновкой GridBag. На рисунке 2 показана компоновка для контейнера с горизонтальной ориентацией слева направо, а на рисунке 3 — для контейнера с горизонтальной ориентацией справа налево.

Для каждого из десяти компонентов поле fill связанного с ним объекта GridBagConstraints установлено в значение GridBagConstraints.BOTH. Кроме того, для компонентов заданы следующие нестандартные ограничения:

• Button1, Button2, Button3: weightx = 1.0
• Button4: weightx = 1.0, gridwidth = GridBagConstraints.REMAINDER
• Button5: gridwidth = GridBagConstraints.REMAINDER
• Button6: gridwidth = GridBagConstraints.RELATIVE
• Button7: gridwidth = GridBagConstraints.REMAINDER
• Button8: gridheight = 2, weighty = 1.0
• Button9, Button 10: gridwidth = GridBagConstraints.REMAINDER

Ниже приведён код, реализующий показанный выше пример:

import java.awt.Button;
import java.awt.EventQueue;
import java.awt.Frame;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;

public class GridBagLayoutExample {

    private static void addButton(String name,
                                  GridBagLayout gridbag,
                                  GridBagConstraints c,
                                  Frame frame) {
        Button button = new Button(name);
        gridbag.setConstraints(button, c);
        frame.add(button);
    }

    public static void main(String[] args) throws Exception {
        EventQueue.invokeAndWait(() -> {
            Frame frame = new Frame("GridBagLayout");
            GridBagLayout gridbag = new GridBagLayout();
            GridBagConstraints c = new GridBagConstraints();
            frame.setLayout(gridbag);

            c.fill = GridBagConstraints.BOTH;
            c.weightx = 1.0;
            addButton("Button1", gridbag, c, frame);
            addButton("Button2", gridbag, c, frame);
            addButton("Button3", gridbag, c, frame);

            c.gridwidth = GridBagConstraints.REMAINDER; //end row
            addButton("Button4", gridbag, c, frame);

            c.weightx = 0.0;                //reset to the default
            addButton("Button5", gridbag, c, frame); //another row

            c.gridwidth = GridBagConstraints.RELATIVE; //next-to-last in row
            addButton("Button6", gridbag, c, frame);

            c.gridwidth = GridBagConstraints.REMAINDER; //end row
            addButton("Button7", gridbag, c, frame);

            c.gridwidth = 1;                //reset to the default
            c.gridheight = 2;
            c.weighty = 1.0;
            addButton("Button8", gridbag, c, frame);

            c.weighty = 0.0;                //reset to the default
            c.gridwidth = GridBagConstraints.REMAINDER; //end row
            c.gridheight = 1;               //reset to the default
            addButton("Button9", gridbag, c, frame);
            addButton("Button10", gridbag, c, frame);

            frame.pack();
            frame.setVisible(true);
        });
    }
}