Класс GridBagConstraints

java.lang.Object
- java.awt.GridBagConstraints

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

public class GridBagConstraints
extends Object
implements Cloneable, Serializable

Класс GridBagConstraints задает ограничения для компонентов, которые размещаются с помощью класса GridBagLayout.

С:: JDK1.0
См. также:: GridBagLayout, Сериализованная форма

Сводка полей

Модификатор и тип	Поле и описание
`static int`	`ABOVE_BASELINE` Возможные значения для поля `anchor`.
`static int`	`ABOVE_BASELINE_LEADING` Возможные значения для поля `anchor`.
`static int`	`ABOVE_BASELINE_TRAILING` Возможные значения для поля `anchor`.
`int`	`anchor` Это поле используется, когда компонент меньше своей области отображения.
`static int`	`BASELINE` Возможные значения для поля `anchor`.
`static int`	`BASELINE_LEADING` Возможные значения для поля `anchor`.
`static int`	`BASELINE_TRAILING` Возможные значения для поля `anchor`.
`static int`	`BELOW_BASELINE` Возможные значения для поля `anchor`.
`static int`	`BELOW_BASELINE_LEADING` Возможные значения для поля `anchor`.
`static int`	`BELOW_BASELINE_TRAILING` Возможные значения для поля `anchor`.
`static int`	`BOTH` Изменение размера компонента по горизонтали и вертикали.
`static int`	`CENTER` Поместить компонент в центр его области отображения.
`static int`	`EAST` Поместить компонент справа от его области отображения, выровненного по вертикали.
`int`	`fill` Это поле используется, когда область отображения компонента больше, чем запрашиваемый размер компонента.
`static int`	`FIRST_LINE_END` Разместить компонент в углу его области отображения, где обычно заканчивается первая строка текста на странице для текущего `ComponentOrientation`.
`static int`	`FIRST_LINE_START` Разместить компонент в углу его области отображения, где обычно начинается первая строка текста на странице для текущего `ComponentOrientation`.
`int`	`gridheight` Указывает количество ячеек в столбце для области отображения компонента.
`int`	`gridwidth` Указывает количество ячеек в строке для области отображения компонента.
`int`	`gridx` Указывает ячейку, содержащую ведущий край области отображения компонента, где первая ячейка в строке имеет `gridx=0`.
`int`	`gridy` Указывает ячейку в верхней части области отображения компонента, где верхняя ячейка имеет `gridy=0`.
`static int`	`HORIZONTAL` Изменение размера компонента по горизонтали, но не по вертикали.
`Insets`	`insets` Это поле задаёт внешний отступ компонента, минимальное расстояние между компонентом и краями его области отображения.
`int`	`ipadx` Это поле задаёт внутренний отступ компонента, сколько места добавить к минимальной ширине компонента.
`int`	`ipady` Это поле задаёт внутренний отступ, то есть сколько места добавить к минимальной высоте компонента.
`static int`	`LAST_LINE_END` Разместить компонент в углу его области отображения, где обычно заканчивается последняя строка текста на странице для текущего `ComponentOrientation`.
`static int`	`LAST_LINE_START` Разместить компонент в углу его области отображения, где обычно начинается последняя строка текста на странице для текущего `ComponentOrientation`.
`static int`	`LINE_END` Разместить компонент, центрированный по краю его области отображения, где строки текста обычно заканчиваются для текущего `ComponentOrientation`.
`static int`	`LINE_START` Разместить компонент, центрированный по краю его области отображения, где строки текста обычно начинаются для текущего `ComponentOrientation`.
`static int`	`NONE` Не изменять размер компонента.
`static int`	`NORTH` Поместить компонент вверху его области отображения, выровненным по горизонтали.
`static int`	`NORTHEAST` Поместить компонент в верхнем правом углу его области отображения.
`static int`	`NORTHWEST` Поместить компонент в верхнем левом углу его области отображения.
`static int`	`PAGE_END` Разместить компонент, центрированный по краю его области отображения, связанной с концом страницы для текущего `ComponentOrientation`.
`static int`	`PAGE_START` Разместить компонент, центрированный по краю его области отображения, связанной с началом страницы для текущего `ComponentOrientation`.
`static int`	`RELATIVE` Указывает, что этот компонент является предпоследним компонентом в своем столбце или строке (`gridwidth`, `gridheight`), или что этот компонент должен быть размещен рядом с ранее добавленным компонентом (`gridx`, `gridy`).
`static int`	`REMAINDER` Указывает, что этот компонент является последним компонентом в своем столбце или строке.
`static int`	`SOUTH` Поместить компонент внизу его области отображения, выровненным по горизонтали.
`static int`	`SOUTHEAST` Поместить компонент в нижнем правом углу его области отображения.
`static int`	`SOUTHWEST` Поместить компонент в нижнем левом углу его области отображения.
`static int`	`VERTICAL` Изменить размер компонента по вертикали, но не по горизонтали.
`double`	`weightx` Указывает, как распределять дополнительное горизонтальное пространство.
`double`	`weighty` Указывает, как распределять дополнительное вертикальное пространство.
`static int`	`WEST` Поместить компонент слева от его области отображения, выровненным по вертикали.

Сводка конструкторов

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

Сводка методов

Модификатор и тип	Метод и описание
`Object`	`clone()` Создаёт копию этого ограничения сетки.

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

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

Поля

RELATIVE

public static final int RELATIVE

Указывает, что этот компонент является предпоследним компонентом в его столбце или строке (gridwidth, gridheight), или что этот компонент должен быть размещен рядом с ранее добавленным компонентом (gridx, gridy).

См. также:: gridwidth, gridheight, gridx, gridy, Значения константного поля

REMAINDER

public static final int REMAINDER

Указывает, что этот компонент является последним компонентом в его столбце или строке.

См. также:: Значения константного поля

NONE

public static final int NONE

Не изменять размер компонента.

См. также:: Значения константного поля

BOTH

public static final int BOTH

Изменять размер компонента как по горизонтали, так и по вертикали.

См. также:: Значения константного поля

HORIZONTAL

public static final int HORIZONTAL

Изменять размер компонента по горизонтали, но не по вертикали.

См. также:: Значения константного поля

VERTICAL

public static final int VERTICAL

Изменять размер компонента по вертикали, но не по горизонтали.

См. также:: Значения константного поля

CENTER

public static final int CENTER

Поместить компонент по центру его области отображения.

См. также:: Значения константного поля

NORTH

public static final int NORTH

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

См. также:: Значения константного поля

NORTHEAST

public static final int NORTHEAST

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

См. также:: Значения константного поля

EAST

public static final int EAST

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

См. также:: Значения константного поля

SOUTHEAST

public static final int SOUTHEAST

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

См. также:: Значения константного поля

SOUTH

public static final int SOUTH

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

См. также:: Значения константного поля

SOUTHWEST

public static final int SOUTHWEST

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

См. также:: Значения константного поля

WEST

public static final int WEST

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

См. также:: Значения константного поля

NORTHWEST

public static final int NORTHWEST

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

См. также:: Значения константного поля

PAGE_START

public static final int PAGE_START

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

См. также:: Значения константного поля

PAGE_END

public static final int PAGE_END

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

См. также:: Значения константного поля

LINE_START

public static final int LINE_START

Поместить компонент по центру вдоль края его области отображения, где строки текста обычно начинаются для текущего ComponentOrientation. Равно WEST для горизонтальных ориентаций слева направо и EAST для горизонтальных ориентаций справа налево.

См. также:: Значения константного поля

LINE_END

public static final int LINE_END

Поместить компонент по центру вдоль края его области отображения, где строки текста обычно заканчиваются для текущего ComponentOrientation. Равно EAST для горизонтальных ориентаций слева направо и WEST для горизонтальных ориентаций справа налево.

См. также:: Значения константного поля

FIRST_LINE_START

public static final int FIRST_LINE_START

Поместить компонент в угол его области отображения, где обычно начинается первая строка текста на странице для текущего ComponentOrientation. Равно NORTHWEST для горизонтальных ориентаций слева направо и NORTHEAST для горизонтальных ориентаций справа налево.

См. также:: Значения константного поля

FIRST_LINE_END

public static final int FIRST_LINE_END

Поместить компонент в угол его области отображения, где обычно заканчивается первая строка текста на странице для текущего ComponentOrientation. Равно NORTHEAST для горизонтальных ориентаций слева направо и NORTHWEST для горизонтальных ориентаций справа налево.

См. также:: Значения константного поля

LAST_LINE_START

public static final int LAST_LINE_START

Поместить компонент в угол его области отображения, где обычно начинается последняя строка текста на странице для текущего ComponentOrientation. Равно SOUTHWEST для горизонтальных ориентаций слева направо и SOUTHEAST для горизонтальных ориентаций справа налево.

См. также:: Значения константного поля

LAST_LINE_END

public static final int LAST_LINE_END

Поместить компонент в угол его области отображения, где обычно заканчивается последняя строка текста на странице для текущего ComponentOrientation. Равно SOUTHEAST для горизонтальных ориентаций слева направо и SOUTHWEST для горизонтальных ориентаций справа налево.

См. также:: Значения константного поля

BASELINE

public static final int BASELINE

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

С:: 1.6
См. также:: Значения константного поля

BASELINE_LEADING

public static final int BASELINE_LEADING

Возможные значения для поля anchor. Указывает, что компонент должен быть размещен по ведущему краю. Для компонентов с ориентацией слева направо ведущим краем является левый край. По вертикали компонент выравнивается по линии основания текущей строки. Если у компонента нет линии основания, он будет центрирован по вертикали.

С:: 1.6
См. также:: Значения константного поля

BASELINE_TRAILING

public static final int BASELINE_TRAILING

Возможные значения для поля anchor. Указывает, что компонент должен быть размещен по ведомом краю. Для компонентов с ориентацией слева направо ведомым краем является правый край. По вертикали компонент выравнивается по линии основания текущей строки. Если у компонента нет линии основания, он будет центрирован по вертикали.

С:: 1.6
См. также:: Значения константного поля

ABOVE_BASELINE

public static final int ABOVE_BASELINE

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

С:: 1.6
См. также:: Значения константного поля

ABOVE_BASELINE_LEADING

public static final int ABOVE_BASELINE_LEADING

Возможные значения для поля anchor. Указывает, что компонент должен быть размещен по горизонтали вдоль ведущего края. Для компонентов с ориентацией слева направо ведущий край — это левый край. По вертикали компонент позиционируется так, что его нижний край касается базовой линии начальной строки. Если у начальной строки нет базовой линии, компонент будет вертикально центрирован.

С момента:: 1.6
См. также:: Значения константных полей

ABOVE_BASELINE_TRAILING

public static final int ABOVE_BASELINE_TRAILING

Возможные значения для поля anchor. Указывает, что компонент должен быть размещен по горизонтали вдоль хвостового края. Для компонентов с ориентацией слева направо хвостовой край — это правый край. По вертикали компонент позиционируется так, что его нижний край касается базовой линии начальной строки. Если у начальной строки нет базовой линии, компонент будет вертикально центрирован.

С момента:: 1.6
См. также:: Значения константных полей

BELOW_BASELINE

public static final int BELOW_BASELINE

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

С момента:: 1.6
См. также:: Значения константных полей

BELOW_BASELINE_LEADING

public static final int BELOW_BASELINE_LEADING

Возможные значения для поля anchor. Указывает, что компонент должен быть размещен по горизонтали вдоль ведущего края. Для компонентов с ориентацией слева направо ведущий край — это левый край. По вертикали компонент позиционируется так, что его верхний край касается базовой линии начальной строки. Если у начальной строки нет базовой линии, компонент будет вертикально центрирован.

С момента:: 1.6
См. также:: Значения константных полей

BELOW_BASELINE_TRAILING

public static final int BELOW_BASELINE_TRAILING

Возможные значения для поля anchor. Указывает, что компонент должен быть размещен по горизонтали вдоль хвостового края. Для компонентов с ориентацией слева направо хвостовой край — это правый край. По вертикали компонент позиционируется так, что его верхний край касается базовой линии начальной строки. Если у начальной строки нет базовой линии, компонент будет вертикально центрирован.

С момента:: 1.6
См. также:: Значения константных полей

gridx

public int gridx

Указывает ячейку, содержащую ведущий край области отображения компонента, где первая ячейка в строке имеет gridx=0. Ведущий край области отображения компонента — это его левый край для горизонтального контейнера слева направо и его правый край для горизонтального контейнера справа налево. Значение RELATIVE указывает, что компонент должен быть размещен сразу после компонента, который был добавлен в контейнер непосредственно перед добавлением этого компонента.

Значение по умолчанию — RELATIVE. gridx должно быть неотрицательным значением.

См. также:: clone(), gridy, ComponentOrientation

gridy

public int gridy

Указывает ячейку в верхней части области отображения компонента, где самая верхняя ячейка имеет gridy=0. Значение RELATIVE указывает, что компонент должен быть размещен непосредственно под компонентом, который был добавлен в контейнер непосредственно перед добавлением этого компонента.

Значение по умолчанию — RELATIVE. gridy должно быть неотрицательным значением.

См. также:: clone(), gridx

gridwidth

public int gridwidth

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

Используйте REMAINDER для указания того, что область отображения компонента будет от gridx до последней ячейки в строке. Используйте RELATIVE для указания того, что область отображения компонента будет от gridx до предпоследней в своей строке.

gridwidth должно быть неотрицательным, значение по умолчанию — 1.

См. также:: clone(), gridheight

gridheight

public int gridheight

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

Используйте REMAINDER для указания того, что область отображения компонента будет от gridy до последней ячейки в столбце. Используйте RELATIVE для указания того, что область отображения компонента будет от gridy до предпоследней в своем столбце.

gridheight должно быть неотрицательным, значение по умолчанию — 1.

См. также:: clone(), gridwidth

weightx

public double weightx

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

Менеджер компоновки Grid Bag вычисляет вес столбца как максимальное weightx всех компонентов в столбце. Если полученный макет меньше горизонтального размера области, которую он должен заполнить, дополнительное пространство распределяется по столбцам пропорционально их весу. Столбец с весом ноль не получает дополнительного пространства.

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

Значение по умолчанию для этого поля — 0. weightx должно быть неотрицательным значением.

См. также:: clone(), weighty

weighty

public double weighty

Указывает, как распределять дополнительное вертикальное пространство.

Менеджер компоновки Grid Bag вычисляет вес строки как максимальное weighty всех компонентов в строке. Если полученный макет меньше вертикального размера области, которую он должен заполнить, дополнительное пространство распределяется по строкам пропорционально их весу. Строка с весом ноль не получает дополнительного пространства.

Если все веса равны нулю, всё дополнительное пространство появляется между сетками ячейки и верхним и нижним краями.

Значение по умолчанию для этого поля — 0. weighty должно быть неотрицательным значением.

См. также:: clone(), weightx

anchor

public int anchor

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

Существует три типа возможных значений: относительные к ориентации, относительные к базовой линии и абсолютные. Значения, относительные к ориентации, интерпретируются относительно свойства ориентации компонента контейнера, значения, относительные к базовой линии, интерпретируются относительно базовой линии, а абсолютные — нет. Абсолютные значения: 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.

См. также:: clone(), ComponentOrientation

fill

public int fill

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

Следующие значения допустимы для fill:

NONE: Не изменять размер компонента.
HORIZONTAL: Увеличить ширину компонента до заполнения горизонтальной области отображения, но не изменять высоту.
VERTICAL: Увеличить высоту компонента до заполнения вертикальной области отображения, но не изменять ширину.
BOTH: Заполнить область отображения компонента полностью.

Значение по умолчанию — NONE.

См. также:: clone()

insets

public Insets insets

Это поле определяет внешний отступ компонента, минимальное расстояние между компонентом и краями его области отображения.

Значение по умолчанию — new Insets(0, 0, 0, 0).

См. также:: clone()

ipadx

public int ipadx

Это поле определяет внутренний отступ компонента, сколько пространства добавить к минимальной ширине компонента. Ширина компонента не меньше его минимальной ширины плюс ipadx пикселей.

Значение по умолчанию — 0.

См. также:: clone(), ipady

ipady

public int ipady

Это поле определяет внутренний отступ, то есть сколько места добавить к минимальной высоте компонента. Высота компонента — это по меньшей мере его минимальная высота плюс ipady пикселей.

Значение по умолчанию — 0.

См. также:: clone(), ipadx

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

GridBagConstraints

public GridBagConstraints()

Создает объект GridBagConstraint со всеми полями, установленными в их значения по умолчанию.

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.
С:: 1.2
См. также:: gridx, gridy, gridwidth, gridheight, weightx, weighty, anchor, fill, insets, ipadx, ipady

Методы

clone

public Object clone()

Создает копию этого ограничения сетки.

Переопределяет:: clone в классе Object
Возвращает:: копию этого ограничения сетки
См. также:: Cloneable

© 1993, 2020, 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.