Класс BorderLayout

java.lang.Object

java.awt.BorderLayout

Все реализованные интерфейсы:: LayoutManager, LayoutManager2, Serializable

public class BorderLayout extends Object implements LayoutManager2, Serializable

Макет BorderLayout размещает компоненты контейнера, изменяя и перенастраивая их размер, чтобы они вписались в пять областей: север, юг, восток, запад и центр. Каждая область может содержать не более одного компонента и идентифицируется соответствующей константой: NORTH, SOUTH, EAST, WEST, и CENTER. При добавлении компонента в контейнер с макетом BorderLayout используйте одну из этих пяти констант, например:

    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, соответственно. Для согласованности с константами относительного позиционирования, используемыми другими компонентами, предпочтительнее использовать последние константы.

Смешивание абсолютных и относительных констант позиционирования может привести к непредсказуемым результатам. Если вы используете оба типа, относительные константы будут иметь приоритет. Например, если вы добавляете компоненты, используя как константы NORTH, так и PAGE_START в контейнере, у которого ориентация LEFT_TO_RIGHT, то будет учтён только PAGE_START.

ПРИМЕЧАНИЕ: В настоящее время BorderLayout не поддерживает вертикальную ориентацию. Настройка isVertical в контейнере ComponentOrientation игнорируется.

Компоненты выстраиваются в соответствии с их предпочтительными размерами и ограничениями размера контейнера. Компоненты NORTH и SOUTH могут растягиваться по горизонтали; компоненты EAST и WEST могут растягиваться по вертикали; компонент CENTER может растягиваться как по горизонтали, так и по вертикали, чтобы заполнить оставшееся пространство.

Вот пример пяти кнопок в апплете, выстроенных с помощью менеджера макета BorderLayout:

Diagram of an applet
demonstrating BorderLayout. Each section of the BorderLayout contains a
Button corresponding to its position in the layout, one of: North, West,
Center, East, or South.

Код для этого апплета следующий:

 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);
   }
 }

С:

1.0

См. также:

Краткое описание полей

Модификатор и тип	Поле	Описание
`static final String`	`AFTER_LAST_LINE`	Синоним для PAGE_END.
`static final String`	`AFTER_LINE_ENDS`	Синоним для LINE_END.
`static final String`	`BEFORE_FIRST_LINE`	Синоним для PAGE_START.
`static final String`	`BEFORE_LINE_BEGINS`	Синоним для LINE_START.
`static final String`	`CENTER`	Ограничение макета для центра (середина контейнера).
`static final String`	`EAST`	Ограничение макета для востока (правая сторона контейнера).
`static final String`	`LINE_END`	Компонент располагается в конце направления строки для макета.
`static final String`	`LINE_START`	Компонент располагается в начале направления строки для макета.
`static final String`	`NORTH`	Ограничение макета для севера (верхняя часть контейнера).
`static final String`	`PAGE_END`	Компонент следует за последней строкой содержимого макета.
`static final String`	`PAGE_START`	Компонент предшествует первой строке содержимого макета.
`static final String`	`SOUTH`	Ограничение макета для юга (нижняя часть контейнера).
`static final String`	`WEST`	Ограничение макета для запада (левая сторона контейнера).

Краткое описание конструкторов

Конструктор	Описание
`BorderLayout()`	Создаёт новый макет BorderLayout без отступов между компонентами.
`BorderLayout(int hgap, int vgap)`	Создаёт макет BorderLayout с указанными отступами между компонентами.

Краткое описание методов

Модификатор и тип	Метод	Описание
`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)`	Выстраивает контейнер аргумент, используя этот макет BorderLayout.
`Dimension`	`maximumLayoutSize(Container target)`	Возвращает максимальные размеры для этого макета, учитывая компоненты в указанном контейнере-мишени.
`Dimension`	`minimumLayoutSize(Container target)`	Определяет минимальный размер контейнера `target` с помощью этого менеджера макета.
`Dimension`	`preferredLayoutSize(Container target)`	Определяет предпочтительный размер контейнера `target` с помощью этого менеджера макета, основываясь на компонентах в контейнере.
`void`	`removeLayoutComponent(Component comp)`	Удаляет указанный компонент из этого макета BorderLayout.
`void`	`setHgap(int hgap)`	Устанавливает горизонтальный отступ между компонентами.
`void`	`setVgap(int vgap)`	Устанавливает вертикальный отступ между компонентами.
`String`	`toString()`	Возвращает строковое представление состояния этого макета BorderLayout.

Методы, объявленные в классе java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Подробное описание полей

NORTH

public static final String NORTH

Ограничение расположения по горизонтали (верх контейнера).

См. также:

SOUTH

public static final String SOUTH

Ограничение расположения по горизонтали (низ контейнера).

См. также:

EAST

public static final String EAST

Ограничение расположения по горизонтали (правая сторона контейнера).

См. также:

WEST

public static final String WEST

Ограничение расположения по горизонтали (левая сторона контейнера).

См. также:

CENTER

public static final String CENTER

Ограничение расположения по горизонтали (центр контейнера).

См. также:

BEFORE_FIRST_LINE

public static final String BEFORE_FIRST_LINE

Синоним для PAGE_START. Существует для совместимости с предыдущими версиями. PAGE_START предпочтительнее.

С:

1.2

См. также:

AFTER_LAST_LINE

public static final String AFTER_LAST_LINE

Синоним для PAGE_END. Существует для совместимости с предыдущими версиями. PAGE_END предпочтительнее.

С:

1.2

См. также:

BEFORE_LINE_BEGINS

public static final String BEFORE_LINE_BEGINS

Синоним для LINE_START. Существует для совместимости с предыдущими версиями. LINE_START предпочтительнее.

С:

1.2

См. также:

AFTER_LINE_ENDS

public static final String AFTER_LINE_ENDS

Синоним для LINE_END. Существует для совместимости с предыдущими версиями. LINE_END предпочтительнее.

С:

1.2

См. также:

PAGE_START

public static final String PAGE_START

Компонент располагается перед первой строкой содержимого макета. Для западных, слева-направо и сверху-вниз ориентаций, это эквивалентно NORTH.

С:

1.4

См. также:

PAGE_END

public static final String PAGE_END

Компонент располагается после последней строки содержимого макета. Для западных, слева-направо и сверху-вниз ориентаций, это эквивалентно SOUTH.

С:

1.4

См. также:

LINE_START

public static final String LINE_START

Компонент размещается в начале направления строки для макета. Для западных, слева-направо и сверху-вниз ориентаций, это эквивалентно WEST.

С:

1.4

См. также:

LINE_END

public static final String LINE_END

Компонент размещается в конце направления строки для макета. Для западных, слева-направо и сверху-вниз ориентаций, это эквивалентно EAST.

С:

1.4

См. также:

Подробное описание конструкторов

BorderLayout

public BorderLayout()

Создаёт новый макет границы без отступов между компонентами.

BorderLayout

public BorderLayout(int hgap, int vgap)

Создаёт макет границы с заданными отступами между компонентами. Горизонтальный отступ задаётся значением hgap, а вертикальный - vgap.

Параметры:: hgap - горизонтальный отступ.; vgap - вертикальный отступ.

Подробное описание методов

getHgap

public int getHgap()

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

Возвращает:: горизонтальный отступ между компонентами
С:: 1.1

setHgap

public void setHgap(int hgap)

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

Параметры:: hgap - горизонтальный отступ между компонентами
С:: 1.1

getVgap

public int getVgap()

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

Возвращает:: вертикальный отступ между компонентами
С:: 1.1

setVgap

public void setVgap(int vgap)

Устанавливает вертикальный отступ между компонентами.

Параметры:: vgap - вертикальный отступ между компонентами
С:: 1.1

addLayoutComponent

public void addLayoutComponent(Component comp, Object constraints)

Добавляет указанный компонент в макет, используя указанный объект ограничения. Для макетов с границей, ограничение должно быть одной из следующих констант: NORTH, SOUTH, EAST, WEST, или CENTER.

Большинство приложений не вызывают этот метод напрямую. Этот метод вызывается, когда компонент добавляется в контейнер с использованием метода Container.add с теми же типами аргументов.

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

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

Параметры:

comp - добавляемый компонент.

constraints - объект, указывающий, как и куда компонент добавляется в макет.

Исключения:

IllegalArgumentException - если объект ограничения не является строкой или не является одной из пяти указанных констант.

С:

1.1

См. также:

addLayoutComponent

@Deprecated public void addLayoutComponent(String name, Component comp)

Устарело.

заменено на addLayoutComponent(Component, Object).

Описание скопировано из интерфейса:

Если менеджер макета использует строку для каждого компонента, добавляет компонент comp в макет, связывая его со строкой, указанной в name.

Определено в:: addLayoutComponent в интерфейсе LayoutManager
Параметры:: name - строка, которая связывается с компонентом; comp - добавляемый компонент

removeLayoutComponent

public void removeLayoutComponent(Component comp)

Удаляет указанный компонент из этой компоновки по границам. Этот метод вызывается, когда контейнер вызывает свои методы remove или removeAll. Большинство приложений не вызывают этот метод напрямую.

Specified by:

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

Parameters:

comp - компонент, который нужно удалить.

See Also:

getLayoutComponent

public Component getLayoutComponent(Object constraints)

Возвращает компонент, добавленный с заданным ограничением.

Parameters:

constraints - желаемое ограничение, одно из CENTER, NORTH, SOUTH, WEST, EAST, PAGE_START, PAGE_END, LINE_START, LINE_END

Returns:

компонент в заданном месте или null, если место пустое

Throws:

IllegalArgumentException - если объект ограничения не является одним из девяти указанных констант

Since:

1.5

See Also:

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.

Parameters:

target - Container для получения местоположения ограничения на основе ориентации компонентов целевого Container.

constraints - желаемое абсолютное положение, одно из CENTER, NORTH, SOUTH, EAST, WEST

Returns:

компонент в заданном месте или null, если место пустое

Throws:

IllegalArgumentException - если объект ограничения не является одной из пяти указанных констант

NullPointerException - если параметр target равен null

Since:

1.5

See Also:

getConstraints

public Object getConstraints(Component comp)

Получает ограничения для указанного компонента

Parameters:

comp - запрашиваемый компонент

Returns:

ограничение для указанного компонента или null, если компонент равен null или отсутствует в этой компоновке

Since:

1.5

See Also:

minimumLayoutSize

public Dimension minimumLayoutSize(Container target)

Определяет минимальный размер контейнера target с помощью этого менеджера компоновки.

Этот метод вызывается, когда контейнер вызывает свой метод getMinimumSize. Большинство приложений не вызывают этот метод напрямую.

Specified by:

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

Parameters:

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

Returns:

минимальные размеры, необходимые для компоновки подкомпонентов указанного контейнера.

See Also:

preferredLayoutSize

public Dimension preferredLayoutSize(Container target)

Определяет предпочтительный размер контейнера target с помощью этого менеджера компоновки, исходя из компонентов в контейнере.

Большинство приложений не вызывают этот метод напрямую. Этот метод вызывается, когда контейнер вызывает свой метод getPreferredSize.

Specified by:

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

Parameters:

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

Returns:

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

See Also:

maximumLayoutSize

public Dimension maximumLayoutSize(Container target)

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

Specified by:

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

Parameters:

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

Returns:

максимальный размер контейнера

See Also:

getLayoutAlignmentX

public float getLayoutAlignmentX(Container parent)

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

Specified by:: getLayoutAlignmentX в интерфейсе LayoutManager2
Parameters:: parent - целевой контейнер
Returns:: предпочтение выравнивания по оси X

getLayoutAlignmentY

public float getLayoutAlignmentY(Container parent)

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

Specified by:: getLayoutAlignmentY в интерфейсе LayoutManager2
Parameters:: parent - целевой контейнер
Returns:: предпочтение выравнивания по оси Y

invalidateLayout

public void invalidateLayout(Container target)

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

Specified by:: invalidateLayout в интерфейсе LayoutManager2
Parameters:: target - целевой контейнер

layoutContainer

public void layoutContainer(Container target)

Компонует контейнер argument с помощью компоновки по границам.

Этот метод фактически изменяет форму компонентов в указанном контейнере, чтобы удовлетворить ограничениям этого объекта BorderLayout. Компоненты NORTH и SOUTH, если таковые имеются, размещаются соответственно вверху и внизу контейнера. Затем компоненты WEST и EAST размещаются слева и справа соответственно. Наконец, объект CENTER размещается в оставшемся пространстве посередине.

Большинство приложений не вызывают этот метод напрямую. Этот метод вызывается, когда контейнер вызывает свой метод doLayout.

Specified by:

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

Parameters:

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

See Also:

toString

public String toString()

Возвращает строковое представление состояния этой компоновки по границам.

Overrides:: toString в классе Object
Returns:: строковое представление этой компоновки по границам.

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/java/awt/BorderLayout.html