Класс BoxLayout

public class BoxLayout
extends Object
implements LayoutManager2, Serializable

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

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

Менеджер BoxLayout создаётся с параметром оси, определяющим тип компоновки. Существует четыре варианта:

X_AXIS — Компоненты выстраиваются горизонтально слева направо.

Y_AXIS — Компоненты выстраиваются вертикально сверху вниз.

LINE_AXIS - Components are laid out the way words are laid out in a line, based on the container's ComponentOrientation property. If the container's ComponentOrientation is horizontal then components are laid out horizontally, otherwise they are laid out vertically. For horizontal orientations, if the container's ComponentOrientation is left to right then components are laid out left to right, otherwise they are laid out right to left. For vertical orientations components are always laid out from top to bottom.

PAGE_AXIS - Components are laid out the way text lines are laid out on a page, based on the container's ComponentOrientation property. If the container's ComponentOrientation is horizontal then components are laid out vertically, otherwise they are laid out horizontally. For horizontal orientations, if the container's ComponentOrientation is left to right then components are laid out left to right, otherwise they are laid out right to left. For vertical orientations components are always laid out from top to bottom.

Во всех направлениях компоненты располагаются в том же порядке, в котором они были добавлены в контейнер.

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

Аналогично, для вертикальной компоновки BoxLayout пытается сделать все компоненты в столбце такой же ширины, как и самый широкий компонент. Если это не удаётся, он выравнивает их по горизонтали в соответствии с их горизонтальными выравниваниями. Для PAGE_AXIS компоновки горизонтальное выравнивание выполняется на основе ведущего края компонента. Другими словами, значение горизонтального выравнивания 0,0 означает левый край компонента, если ориентация контейнера ComponentOrientation слева направо, и это означает правый край компонента в противном случае.

Вместо непосредственного использования BoxLayout, многие программы используют класс Box. Класс Box — это лёгкий контейнер, который использует BoxLayout. Он также предоставляет удобные методы для эффективного использования BoxLayout. Добавление компонентов в несколько вложенных боксов — мощный способ получить желаемую компоновку.

Дополнительную информацию и примеры см. в Руководстве по использованию BoxLayout в Руководстве Java.

Предупреждение: Сериализованные объекты этого класса не будут совместимы с будущими версиями Swing. Текущая поддержка сериализации подходит для краткосрочного хранения или RMI между приложениями, использующими одну и ту же версию Swing. Начиная с версии 1.4, добавлена поддержка долгосрочного хранения всех JavaBeans™ в пакете java.beans. См. XMLEncoder.

Поля

X_AXIS

public static final int X_AXIS

Указывает, что компоненты должны быть расположены слева направо.

См. также:

Значения постоянных полей

Y_AXIS

public static final int Y_AXIS

Указывает, что компоненты должны быть расположены сверху вниз.

См. также:

Значения постоянных полей

LINE_AXIS

public static final int LINE_AXIS

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

См. также:

Значения постоянных полей

PAGE_AXIS

public static final int PAGE_AXIS

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

См. также:

Значения постоянных полей

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

BoxLayout

@ConstructorProperties(value={"target","axis"})
public BoxLayout(Container target,
                                                                 int axis)

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

Параметры:

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

axis - ось для размещения компонентов. Может быть одним из: BoxLayout.X_AXIS, BoxLayout.Y_AXIS, BoxLayout.LINE_AXIS или BoxLayout.PAGE_AXIS

Исключения:

AWTError - если значение axis некорректно

Методы

getTarget

public final Container getTarget()

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

Возвращает:

контейнер, который использует этот менеджер компоновки

С тех пор:

1.6

getAxis

public final int getAxis()

Возвращает ось, которая использовалась для размещения компонентов. Возвращает один из: BoxLayout.X_AXIS, BoxLayout.Y_AXIS, BoxLayout.LINE_AXIS или BoxLayout.PAGE_AXIS

Возвращает:

ось, которая использовалась для размещения компонентов

С тех пор:

1.6

invalidateLayout

public void invalidateLayout(Container target)

Задано:

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

Параметры:

target - затронутый контейнер

Исключения:

AWTError - если целевой объект не является контейнером, указанным в конструкторе BoxLayout

addLayoutComponent

public void addLayoutComponent(String name,
                               Component comp)

В этом классе не используется.

Задано:

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

Параметры:

name - имя компонента

comp - компонент

removeLayoutComponent

public void removeLayoutComponent(Component comp)

В этом классе не используется.

Задано:

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

Параметры:

comp - компонент

addLayoutComponent

public void addLayoutComponent(Component comp,
                               Object constraints)

В этом классе не используется.

Задано:

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

Параметры:

comp - компонент

constraints - ограничения

preferredLayoutSize

public Dimension preferredLayoutSize(Container target)

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

Задано:

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

Параметры:

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

Возвращает:

размеры >= 0 && <= Integer.MAX_VALUE

Исключения:

AWTError - если целевой объект не является контейнером, указанным в конструкторе BoxLayout

См. также:

Container, minimumLayoutSize(java.awt.Container), maximumLayoutSize(java.awt.Container)

minimumLayoutSize

public Dimension minimumLayoutSize(Container target)

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

Задано:

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

Параметры:

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

Возвращает:

размеры >= 0 && <= Integer.MAX_VALUE

Исключения:

AWTError - если целевой объект не является контейнером, указанным в конструкторе BoxLayout

См. также:

preferredLayoutSize(java.awt.Container), maximumLayoutSize(java.awt.Container)

maximumLayoutSize

public Dimension maximumLayoutSize(Container target)

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

Задано:

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

Параметры:

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

Возвращает:

размеры >= 0 && <= Integer.MAX_VALUE

Исключения:

AWTError - если целевой объект не является контейнером, указанным в конструкторе BoxLayout

См. также:

preferredLayoutSize(java.awt.Container), minimumLayoutSize(java.awt.Container)

getLayoutAlignmentX

public float getLayoutAlignmentX(Container target)

Возвращает выравнивание по оси X для контейнера. Если коробка горизонтальная, возвращается значение по умолчанию. В противном случае, возвращается выравнивание, необходимое для размещения дочерних элементов по оси X.

Задано:

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

Параметры:

target - контейнер

Возвращает:

выравнивание >= 0.0f && <= 1.0f

Исключения:

AWTError - если целевой объект не является контейнером, указанным в конструкторе BoxLayout

getLayoutAlignmentY

public float getLayoutAlignmentY(Container target)

Возвращает выравнивание по оси Y для контейнера. Если коробка вертикальная, возвращается значение по умолчанию. В противном случае, возвращается выравнивание, необходимое для размещения дочерних элементов по оси Y.

Задано:

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

Параметры:

target - контейнер

Возвращает:

выравнивание >= 0.0f && <= 1.0f

Исключения:

AWTError - если целевой объект не является контейнером, указанным в конструкторе BoxLayout

layoutContainer

public void layoutContainer(Container target)

Вызывается AWT, когда нужно расположить указанный контейнер.

Задано:

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

Параметры:

target - контейнер для размещения

Исключения:

AWTError - если целевой объект не является контейнером, указанным в конструкторе BoxLayout