Класс GroupLayout

public class GroupLayout
extends Object
implements LayoutManager2

GroupLayout — это LayoutManager, иерархически группирующий компоненты для их позиционирования в Container. GroupLayout предназначен для использования строителями, но также может быть реализован вручную. Группировка выполняется экземплярами класса Group. GroupLayout поддерживает два типа групп. Последовательная группа позиционирует свои дочерние элементы последовательно, один за другим. Параллельная группа выравнивает свои дочерние элементы одним из четырёх способов.

Каждая группа может содержать любое количество элементов, где элемент — это Group, Component, или пробел. Пробел можно рассматривать как невидимый компонент с минимальным, предпочтительным и максимальным размером. Кроме того, GroupLayout поддерживает предпочтительный пробел, значение которого взято из LayoutStyle.

Элементы подобны пружинам. Каждый элемент имеет диапазон, как указано минимальным, предпочтительным и максимальным размерами. У пробелов есть либо заданный разработчиком диапазон, либо диапазон, определённый LayoutStyle. Диапазон для Component определяется методами Component, getMinimumSize, и getMaximumSize компонента. Кроме того, при добавлении Component вы можете указать конкретный диапазон вместо диапазона компонента. Диапазон для Group определяется типом группы. Диапазон ParallelGroup — это максимальный из диапазонов его элементов. Диапазон SequentialGroup — это сумма диапазонов его элементов.

GroupLayout обрабатывает каждую ось независимо. То есть существует группа, представляющая горизонтальную ось, и группа, представляющая вертикальную ось. Горизонтальная группа отвечает за определение минимального, предпочтительного и максимального размера по горизонтали, а также за установку x и ширины содержащихся в ней компонентов. Вертикальная группа отвечает за определение минимального, предпочтительного и максимального размера по вертикали, а также за установку y и высоты содержащихся в ней компонентов. Каждый Component должен существовать как в горизонтальной, так и в вертикальной группе, иначе во время макета или при запросе минимального, предпочтительного или максимального размера будет брошено исключение IllegalStateException.

На диаграмме показана последовательная группа по горизонтальной оси. Последовательная группа содержит три компонента. По вертикальной оси используется параллельная группа.

Для того чтобы подчеркнуть, что каждая ось обрабатывается независимо, диаграмма показывает диапазон каждой группы и каждого элемента вдоль каждой оси. Диапазон каждого компонента был спроецирован на оси, а группы отображаются синим цветом (горизонталь) и красным (вертикаль). Для лучшей читабельности между элементами последовательной группы есть пробел.

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

По вертикальной оси параллельная группа является максимальной высотой каждого компонента. Поскольку все три компонента имеют одинаковую высоту, параллельная группа имеет одинаковую высоту.

На следующей диаграмме показаны те же три компонента, но с параллельной группой по горизонтальной оси и последовательной группой по вертикальной оси.

Так как c1 — это самый большой из трёх компонентов, параллельная группа имеет размер c1. Поскольку c2 и c3 меньше c1, они выравниваются в соответствии с указанным для компонента выравниванием (если указано) или по умолчанию для параллельной группы. На диаграмме c2 и c3 были созданы с выравниванием LEADING. Если бы ориентация компонента была справа налево, то c2 и c3 были бы размещены с противоположной стороны.

На следующей диаграмме показана последовательная группа как по горизонтальной, так и по вертикальной оси.

GroupLayout предоставляет возможность вставлять пробелы между Component. Размер пробела определяется экземпляром класса LayoutStyle. Это может быть включено с помощью метода setAutoCreateGaps. Аналогично, вы можете использовать метод setAutoCreateContainerGaps для вставки пробелов между компонентами, которые касаются края родительского контейнера и самого контейнера.

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

JComponent panel = ...;
   GroupLayout layout = new GroupLayout(panel);
   panel.setLayout(layout);

   // Turn on automatically adding gaps between components
   layout.setAutoCreateGaps(true);

   // Turn on automatically creating gaps between components that touch
   // the edge of the container and the container.
   layout.setAutoCreateContainerGaps(true);

   // Create a sequential group for the horizontal axis.

   GroupLayout.SequentialGroup hGroup = layout.createSequentialGroup();

   // The sequential group in turn contains two parallel groups.
   // One parallel group contains the labels, the other the text fields.
   // Putting the labels in a parallel group along the horizontal axis
   // positions them at the same x location.
   //
   // Variable indentation is used to reinforce the level of grouping.
   hGroup.addGroup(layout.createParallelGroup().
            addComponent(label1).addComponent(label2));
   hGroup.addGroup(layout.createParallelGroup().
            addComponent(tf1).addComponent(tf2));
   layout.setHorizontalGroup(hGroup);

   // Create a sequential group for the vertical axis.
   GroupLayout.SequentialGroup vGroup = layout.createSequentialGroup();

   // The sequential group contains two parallel groups that align
   // the contents along the baseline. The first parallel group contains
   // the first label and text field, and the second parallel group contains
   // the second label and text field. By using a sequential group
   // the labels and text fields are positioned vertically after one another.
   vGroup.addGroup(layout.createParallelGroup(Alignment.BASELINE).
            addComponent(label1).addComponent(tf1));
   vGroup.addGroup(layout.createParallelGroup(Alignment.BASELINE).
            addComponent(label2).addComponent(tf2));
   layout.setVerticalGroup(vGroup);

При выполнении получится следующее.

Этот макет состоит из следующего.

• Горизонтальная ось состоит из последовательной группы, содержащей две параллельные группы. Первая параллельная группа содержит метки, а вторая — текстовые поля.
• Вертикальная ось состоит из последовательной группы, содержащей две параллельные группы. Параллельные группы настроены на выравнивание своих компонентов по базовой линии. Первая параллельная группа содержит первую метку и первое текстовое поле, а вторая группа состоит из второй метки и второго текстового поля.

Несколько замечаний по этому коду:

• Вам не нужно явно добавлять компоненты в контейнер; это делается косвенно с помощью одного из методов add класса Group.
• Различные методы add возвращают вызывающий объект. Это позволяет легко объединять вызовы. Например, group.addComponent(label1).addComponent(label2); эквивалентно group.addComponent(label1); group.addComponent(label2);.
• Нет публичных конструкторов для Group; вместо этого используйте методы создания в классе GroupLayout.

Поля

DEFAULT_SIZE

public static final int DEFAULT_SIZE

Указывает размер компонента или разрыва, который должен использоваться для определённого значения диапазона.

См. также:

GroupLayout.Group, Значения константных полей

PREFERRED_SIZE

public static final int PREFERRED_SIZE

Указывает предпочтительный размер компонента или разрыва, который должен использоваться для определённого значения диапазона.

См. также:

GroupLayout.Group, Значения константных полей

Конструкторы

GroupLayout

public GroupLayout(Container host)

Создаёт GroupLayout для указанного Container.

Параметры:

host - Container, для которого GroupLayout является LayoutManager

Исключения:

IllegalArgumentException - если хост null

Методы

setHonorsVisibility

public void setHonorsVisibility(boolean honorsVisibility)

Параметры:

honorsVisibility - учитывается ли видимость компонента при определении размеров и позиционировании компонентов

См. также:

setHonorsVisibility(Component,Boolean)

getHonorsVisibility

public boolean getHonorsVisibility()

Возвращает, учитывается ли видимость компонента при определении размеров и позиционировании компонентов.

Возвращает:

учитывается ли видимость компонента при определении размеров и позиционировании компонентов

setHonorsVisibility

public void setHonorsVisibility(Component component,
                                Boolean honorsVisibility)

Параметры:

component - компонент

honorsVisibility - учитывается ли видимость этого component при определении размеров и позиционирования

Исключения:

IllegalArgumentException - если component null

См. также:

setHonorsVisibility(Component,Boolean)

setAutoCreateGaps

public void setAutoCreateGaps(boolean autoCreatePadding)

Устанавливает, должна ли автоматически создаваться пустота между компонентами. Например, если это true, и вы добавляете два компонента в SequentialGroup, пустота между двумя компонентами автоматически создаётся. По умолчанию false.

Параметры:

autoCreatePadding - создаётся ли автоматически пустота между компонентами

getAutoCreateGaps

public boolean getAutoCreateGaps()

Возвращает true, если пробелы между компонентами создаются автоматически.

Возвращает:

true если пробелы между компонентами создаются автоматически

setAutoCreateContainerGaps

public void setAutoCreateContainerGaps(boolean autoCreateContainerPadding)

Устанавливает, должна ли автоматически создаваться пустота между контейнером и компонентами, которые примыкают к границе контейнера. По умолчанию false.

Параметры:

autoCreateContainerPadding - создаётся ли автоматически пустота между контейнером и компонентами, которые примыкают к границе контейнера

getAutoCreateContainerGaps

public boolean getAutoCreateContainerGaps()

Возвращает true, если пробелы между контейнером и компонентами, примыкающими к контейнеру, создаются автоматически.

Возвращает:

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

setHorizontalGroup

public void setHorizontalGroup(GroupLayout.Group group)

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

Параметры:

group - Group, который позиционирует и масштабирует компоненты вдоль горизонтальной оси

Исключения:

IllegalArgumentException - если группа null

setVerticalGroup

public void setVerticalGroup(GroupLayout.Group group)

Устанавливает Group, который позиционирует и масштабирует компоненты вдоль вертикальной оси.

Параметры:

group - Group, который позиционирует и масштабирует компоненты вдоль вертикальной оси

Исключения:

IllegalArgumentException - если группа null

createSequentialGroup

public GroupLayout.SequentialGroup createSequentialGroup()

Создаёт и возвращает SequentialGroup.

Возвращает:

новый SequentialGroup

createParallelGroup

public GroupLayout.ParallelGroup createParallelGroup()

Создаёт и возвращает ParallelGroup с выравниванием Alignment.LEADING. Это метод-обёртка для более общего метода createParallelGroup(Alignment).

Возвращает:

новый ParallelGroup

См. также:

createParallelGroup(Alignment)

createParallelGroup

public GroupLayout.ParallelGroup createParallelGroup(GroupLayout.Alignment alignment)

Создаёт и возвращает ParallelGroup с указанным выравниванием. Это метод-обёртка для более общего метода createParallelGroup(Alignment,boolean) с true в качестве второго аргумента.

Параметры:

alignment - выравнивание элементов группы

Возвращает:

новый ParallelGroup

Исключения:

IllegalArgumentException - если alignment null

См. также:

createBaselineGroup(boolean, boolean), GroupLayout.ParallelGroup

createParallelGroup

public GroupLayout.ParallelGroup createParallelGroup(GroupLayout.Alignment alignment,
                                                     boolean resizable)

Параметры:

alignment - выравнивание элементов группы

resizable - true, если группа изменяет размер; если группа не изменяет размер, размер по умолчанию используется для минимального и максимального размера группы

Возвращает:

новый ParallelGroup

Исключения:

IllegalArgumentException - если alignment null

См. также:

createBaselineGroup(boolean, boolean), GroupLayout.ParallelGroup

createBaselineGroup

public GroupLayout.ParallelGroup createBaselineGroup(boolean resizable,
                                                     boolean anchorBaselineToTop)

Создаёт и возвращает ParallelGroup для выравнивания элементов по базовой линии.

Параметры:

resizable - изменяет ли группа размер

anchorBaselineToTop - привязана ли базовую линия к верхней или нижней части группы

См. также:

createBaselineGroup(boolean, boolean), GroupLayout.ParallelGroup

linkSize

public void linkSize(Component... components)

Параметры:

components - Component для которых должен быть одинаковый размер

Исключения:

IllegalArgumentException - если components null, или содержит null

См. также:

linkSize(int,Component[])

linkSize

public void linkSize(int axis,
                     Component... components)

Параметры:

components - Components, которые должны иметь одинаковый размер

axis - ось, по которой нужно связать размер; одна из SwingConstants.HORIZONTAL или SwingConstans.VERTICAL

Исключения:

IllegalArgumentException - если components имеет значение null, или содержит null; или axis не является SwingConstants.HORIZONTAL или SwingConstants.VERTICAL

replace

public void replace(Component existingComponent,
                    Component newComponent)

Заменяет существующий компонент новым.

Параметры:

existingComponent - компонент, который нужно удалить и заменить на newComponent

newComponent - компонент, который нужно поместить на место existingComponent

Исключения:

IllegalArgumentException - если любой из компонентов является null, или existingComponent не управляется этим менеджером компоновки

setLayoutStyle

public void setLayoutStyle(LayoutStyle layoutStyle)

Устанавливает LayoutStyle для расчета предпочтительных отступов между компонентами. Значение null указывает на использование общего экземпляра LayoutStyle.

Параметры:

layoutStyle - используемый LayoutStyle

См. также:

LayoutStyle

getLayoutStyle

public LayoutStyle getLayoutStyle()

Возвращает LayoutStyle для расчета предпочтительных отступов между компонентами. Возвращает значение, заданное для setLayoutStyle, которое может быть null.

Возвращает:

LayoutStyle используемый для расчета предпочтительных отступов между компонентами

addLayoutComponent

public void addLayoutComponent(String name,
                               Component component)

Уведомление о добавлении Component в контейнер-родитель. Не следует вызывать этот метод напрямую, вместо этого следует использовать один из методов Group для добавления Component.

Определено в:

addLayoutComponent в интерфейсе LayoutManager

Параметры:

name - строка, которая должна быть ассоциирована с компонентом

component - добавляемый Component

removeLayoutComponent

public void removeLayoutComponent(Component component)

Уведомление об удалении Component из контейнера-родителя. Не следует вызывать этот метод напрямую, а следует вызвать remove в родительском Container.

Определено в:

removeLayoutComponent в интерфейсе LayoutManager

Параметры:

component - удаляемый компонент

См. также:

Component.remove(java.awt.MenuComponent)

preferredLayoutSize

public Dimension preferredLayoutSize(Container parent)

Возвращает предпочтительный размер для указанного контейнера.

Определено в:

preferredLayoutSize в интерфейсе LayoutManager

Параметры:

parent - контейнер, для которого нужно вернуть предпочтительный размер

Возвращает:

предпочтительный размер для parent

Исключения:

IllegalArgumentException - если parent не совпадает с Container используемым для создания этого объекта

IllegalStateException - если любой из добавленных в компоновку компонентов не входит как в горизонтальную, так и в вертикальную группы

См. также:

Container.getPreferredSize()

minimumLayoutSize

public Dimension minimumLayoutSize(Container parent)

Возвращает минимальный размер для указанного контейнера.

Определено в:

minimumLayoutSize в интерфейсе LayoutManager

Параметры:

parent - контейнер, для которого нужно вернуть размер

Возвращает:

минимальный размер для parent

Исключения:

IllegalArgumentException - если parent не совпадает с Container используемым для создания этого объекта

IllegalStateException - если любой из добавленных в компоновку компонентов не входит как в горизонтальную, так и в вертикальную группы

См. также:

Container.getMinimumSize()

layoutContainer

public void layoutContainer(Container parent)

Компонует указанный контейнер.

Определено в:

layoutContainer в интерфейсе LayoutManager

Параметры:

parent - контейнер, который нужно компоновать

Исключения:

IllegalStateException - если любой из добавленных в компоновку компонентов не входит как в горизонтальную, так и в вертикальную группы

addLayoutComponent

public void addLayoutComponent(Component component,
                               Object constraints)

Уведомление о добавлении Component в контейнер-родитель. Не следует вызывать этот метод напрямую, вместо этого следует использовать один из методов Group для добавления Component.

Определено в:

addLayoutComponent в интерфейсе LayoutManager2

Параметры:

component - добавленный компонент

constraints - описание расположения компонента

maximumLayoutSize

public Dimension maximumLayoutSize(Container parent)

Возвращает максимальный размер для указанного контейнера.

Определено в:

maximumLayoutSize в интерфейсе LayoutManager2

Параметры:

parent - контейнер, для которого нужно вернуть размер

Возвращает:

максимальный размер для parent

Исключения:

IllegalArgumentException - если parent не совпадает с Container используемым для создания этого объекта

IllegalStateException - если любой из добавленных в компоновку компонентов не входит как в горизонтальную, так и в вертикальную группы

См. также:

Container.getMaximumSize()

getLayoutAlignmentX

public float getLayoutAlignmentX(Container parent)

Возвращает выравнивание по оси x. Это указывает, как компонент хотел бы выровняться относительно других компонентов. Значение должно быть числом от 0 до 1, где 0 соответствует выравниванию по началу координат, 1 — выравниванию как можно дальше от начала координат, 0,5 — центрированию и т. д.

Определено в:

getLayoutAlignmentX в интерфейсе LayoutManager2

Параметры:

parent - контейнер, содержащий этот Container

Возвращает:

выравнивание; эта реализация возвращает .5

Исключения:

IllegalArgumentException - если parent не совпадает с Container используемым для создания этого объекта

getLayoutAlignmentY

public float getLayoutAlignmentY(Container parent)

Возвращает выравнивание по оси y. Это указывает, как компонент хотел бы выровняться относительно других компонентов. Значение должно быть числом от 0 до 1, где 0 соответствует выравниванию по началу координат, 1 — выравниванию как можно дальше от начала координат, 0,5 — центрированию и т. д.

Определено в:

getLayoutAlignmentY в интерфейсе LayoutManager2

Параметры:

parent - контейнер, содержащий этот Container

Возвращает:

выравнивание; эта реализация возвращает .5

Исключения:

IllegalArgumentException - если parent не совпадает с Container используемым для создания этого объекта

invalidateLayout

public void invalidateLayout(Container parent)

Делает компоновку недействительной, указывая, что если менеджер компоновки кэшировал информацию, он должен её отбросить.

Определено в:

invalidateLayout в интерфейсе LayoutManager2

Параметры:

parent - контейнер, содержащий этот менеджер компоновки

Исключения:

IllegalArgumentException - если parent не совпадает с Container используемым для создания этого объекта

toString

public String toString()

Возвращает строковое представление этого GroupLayout. Этот метод предназначен для отладки, и содержимое и формат возвращаемой строки могут отличаться в разных реализациях.

Переопределяет:

toString в классе Object

Возвращает:

строковое представление этого GroupLayout