Spec-Zone.ru › OpenJDK 21

Класс SizeRequirements

java.lang.Object
javax.swing.SizeRequirements
Все реализуемые интерфейсы:
Serializable
public class SizeRequirements extends Object implements Serializable
Для удобства менеджеров компоновки, вычисляет информацию о размере и позиции компонентов. Все методы расчета размера и позиции являются методами класса, которые принимают массивы SizeRequirements в качестве аргументов. Класс SizeRequirements поддерживает два типа компоновки:
плиточная
Компоненты размещаются вплотную, начиная либо с координаты 0 (самое левое или верхнее положение) либо с координаты, представляющей конец выделенного диапазона (самое правое или нижнее положение).
выровненная
Компоненты выравниваются в соответствии со значением выравнивания по оси X или Y каждого компонента.

Каждый объект SizeRequirements содержит информацию о ширине (и выравнивании по оси X) или высоте (и выравнивании по оси Y) отдельного компонента или группы компонентов:

minimum
Минимальная допустимая ширина/высота компонента или группы компонентов, в пикселях.
preferred
Естественная ширина/высота компонента или группы компонентов, в пикселях.
maximum
Максимальная допустимая ширина/высота компонента или группы компонентов, в пикселях.
alignment
Выравнивание по оси X/Y компонента или группы компонентов.

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

С:
1.2
См. также:
  • Component.getMinimumSize()
  • Component.getPreferredSize()
  • Component.getMaximumSize()
  • Component.getAlignmentX()
  • Component.getAlignmentY()

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

Модификатор и тип Поле Описание
float alignment
Выравнивание, заданное как значение от 0,0 до 1,0 включительно.
int maximum
Максимальный разрешённый размер.
int minimum
Минимальный требуемый размер.
int preferred
Предпочтительный (естественный) размер.

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

Конструктор Описание
SizeRequirements()
Создаёт объект SizeRequirements с минимальным, предпочтительным и максимальным размерами, равными нулю, и значением выравнивания 0,5 (по центру).
SizeRequirements(int min, int pref, int max, float a)
Создаёт объект SizeRequirements со заданными минимальным, предпочтительным и максимальным размерами и заданным выравниванием.

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

Модификатор и тип Метод Описание
static int[] adjustSizes(int delta, SizeRequirements[] children)
Изменяет заданный массив размеров на заданную величину.
static void calculateAlignedPositions(int allocated, SizeRequirements total, SizeRequirements[] children, int[] offsets, int[] spans)
Создаёт набор пар смещение/диапазон, определяющих, как выложить набор компонентов с указанными выравниваниями.
static void calculateAlignedPositions(int allocated, SizeRequirements total, SizeRequirements[] children, int[] offsets, int[] spans, boolean normal)
Создаёт набор пар смещение/диапазон, определяющих, как выложить набор компонентов с указанными выравниваниями.
static void calculateTiledPositions(int allocated, SizeRequirements total, SizeRequirements[] children, int[] offsets, int[] spans)
Создаёт набор пар смещение/диапазон, определяющих, как выложить набор компонентов вплотную.
static void calculateTiledPositions(int allocated, SizeRequirements total, SizeRequirements[] children, int[] offsets, int[] spans, boolean forward)
Создаёт набор пар смещение/диапазон, определяющих, как выложить набор компонентов вплотную.
static SizeRequirements getAlignedSizeRequirements(SizeRequirements[] children)
Определяет общее пространство, необходимое для выравнивания набора компонентов.
static SizeRequirements getTiledSizeRequirements(SizeRequirements[] children)
Определяет общее пространство, необходимое для размещения набора компонентов вплотную.
String toString()
Возвращает строку, описывающую минимальные, предпочтительные и максимальные требования к размеру, а также выравнивание.

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

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

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

minimum

public int minimum
Минимальный требуемый размер. Для компонента comp, он должен быть равен либо comp.getMinimumSize().width, либо comp.getMinimumSize().height.

preferred

public int preferred
Предпочтительный (естественный) размер. Для компонента comp, он должен быть равен либо comp.getPreferredSize().width, либо comp.getPreferredSize().height.

maximum

public int maximum
Максимальный разрешённый размер. Для компонента comp, он должен быть равен либо comp.getMaximumSize().width, либо comp.getMaximumSize().height.

alignment

public float alignment
Выравнивание, задаваемое значением от 0,0 до 1,0 включительно. Для задания центрирования, выравнивание должно быть равно 0,5.

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

SizeRequirements

public SizeRequirements()
Создаёт объект SizeRequirements с минимальным, предпочтительным и максимальным размерами, установленными в ноль, и значением выравнивания 0,5 (центрирование).

SizeRequirements

public SizeRequirements(int min, int pref, int max, float a)
Создаёт объект SizeRequirements с указанными минимальным, предпочтительным и максимальным размерами и указанным выравниванием.
Parameters:
min - минимальный размер, >= 0
pref - предпочтительный размер, >= 0
max - максимальный размер, >= 0
a - выравнивание, >= 0.0f и <= 1.0f

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

toString

public String toString()
Возвращает строку, описывающую требования к минимальному, предпочтительному и максимальному размеру, а также выравнивание.
Overrides:
toString в классе Object
Returns:
строку

getTiledSizeRequirements

public static SizeRequirements getTiledSizeRequirements(SizeRequirements[] children)
Определяет общее пространство, необходимое для размещения набора компонентов друг за другом. Требования каждого компонента в наборе представлены в массиве SizeRequirements. Возвращаемый объект SizeRequirements имеет выравнивание 0,5 (центрирование). Требование к пространству никогда не превышает Integer.MAX_VALUE.
Parameters:
children - требования к пространству для набора компонентов. Вектор может быть нулевой длины, что приведёт к возврату объекта SizeRequirements по умолчанию.
Returns:
общие требования к пространству.

getAlignedSizeRequirements

public static SizeRequirements getAlignedSizeRequirements(SizeRequirements[] children)
Определяет общее пространство, необходимое для выравнивания набора компонентов. Требования каждого компонента в наборе представлены в массиве SizeRequirements. Общее требуемое пространство никогда не превысит Integer.MAX_VALUE.
Parameters:
children - набор требований дочерних элементов. Если он имеет нулевую длину, то возвращаемое значение будет экземпляром SizeRequirements по умолчанию.
Returns:
общие требования к пространству.

calculateTiledPositions

public static void calculateTiledPositions(int allocated, SizeRequirements total, SizeRequirements[] children, int[] offsets, int[] spans)
Создаёт набор пар смещение/размер, представляющих способ выкладки набора компонентов друг за другом. Этот метод требует указания общего количества пространства для выделения, требований к размеру каждого компонента для размещения (заданных в массиве SizeRequirements) и общих требований к размеру набора компонентов. Общие требования к размеру можно получить, вызвав метод getTiledSizeRequirements. Компоненты будут выкладываться в прямом направлении, смещения будут увеличиваться от 0.
Parameters:
allocated - общее пространство для выделения, >= 0.
total - общие запросы дочерних элементов. Этот аргумент необязателен и может быть null.
children - требования к размеру каждого компонента.
offsets - смещение от 0 для каждого дочернего элемента, где выделены размеры (определяет размещение размера).
spans - размер, выделенный для каждого дочернего элемента, чтобы получить общий целевой размер.

calculateTiledPositions

public static void calculateTiledPositions(int allocated, SizeRequirements total, SizeRequirements[] children, int[] offsets, int[] spans, boolean forward)
Создаёт набор пар смещение/размер, представляющих способ выкладки набора компонентов друг за другом. Этот метод требует указания общего количества пространства для выделения, требований к размеру каждого компонента для размещения (заданных в массиве SizeRequirements) и общих требований к размеру набора компонентов. Общие требования к размеру можно получить, вызвав метод getTiledSizeRequirements. Этот метод также требует флага, указывающего, должны ли компоненты выкладываться в прямом направлении (смещения увеличиваются от 0) или обратном (смещения уменьшаются от конца выделенного пространства). Прямое направление соответствует выкладке компонентов слева направо или сверху вниз. Обратное направление соответствует выкладке компонентов справа налево или снизу вверх.
Parameters:
allocated - общее пространство для выделения, >= 0.
total - общие запросы дочерних элементов. Этот аргумент необязателен и может быть null.
children - требования к размеру каждого компонента.
offsets - смещение от 0 для каждого дочернего элемента, где выделены размеры (определяет размещение размера).
spans - размер, выделенный для каждого дочернего элемента, чтобы получить общий целевой размер.
forward - выкладывать с увеличивающимися смещениями от 0, если true, и с уменьшающимися смещениями от конца выделенного пространства, если false.
Since:
1.4

calculateAlignedPositions

public static void calculateAlignedPositions(int allocated, SizeRequirements total, SizeRequirements[] children, int[] offsets, int[] spans)
Создаёт набор пар смещение/размер, определяющих способ выкладки набора компонентов с указанными выравниваниями. Результирующие выделения размеров будут перекрываться, при этом каждый из них будет максимально подходить к заданному общему выделению. Этот метод требует указания общего количества пространства для выделения, требований к размеру каждого компонента для размещения (заданных в массиве SizeRequirements) и общих требований к размеру набора компонентов (используется только поле выравнивания). Общие требования к размеру можно получить, вызвав getAlignedSizeRequirements. Нормальное выравнивание выполняется со значением выравнивания 0,0f, обозначающим левый/верхний край компонента.
Parameters:
allocated - общее пространство для выделения, >= 0.
total - общие запросы дочерних элементов.
children - требования к размеру каждого компонента.
offsets - смещение от 0 для каждого дочернего элемента, где выделены размеры (определяет размещение размера).
spans - размер, выделенный для каждого дочернего элемента, чтобы получить общий целевой размер.

calculateAlignedPositions

public static void calculateAlignedPositions(int allocated, SizeRequirements total, SizeRequirements[] children, int[] offsets, int[] spans, boolean normal)
Создаёт набор пар смещение/размер, определяющих способ выкладки набора компонентов с указанными выравниваниями. Результирующие выделения размеров будут перекрываться, при этом каждый из них будет максимально подходить к заданному общему выделению. Этот метод требует указания общего количества пространства для выделения, требований к размеру каждого компонента для размещения (заданных в массиве SizeRequirements) и общих требований к размеру набора компонентов (используется только поле выравнивания) Общие требования к размеру можно получить, вызвав getAlignedSizeRequirements. Этот метод также требует флага, указывающего, следует ли выполнять нормальное или обратное выравнивание. При нормальном выравнивании значение 0,0f означает левый/верхний край компонента. При обратном выравнивании 0,0f означает правый/нижний край.
Parameters:
allocated - общее пространство для выделения, >= 0.
total - общие запросы дочерних элементов.
children - требования к размеру каждого компонента.
offsets - смещение от 0 для каждого дочернего элемента, где выделены размеры (определяет размещение размера).
spans - размер, выделенный для каждого дочернего элемента, чтобы получить общий целевой размер.
normal - если true, значение выравнивания 0,0f означает левый/верхний край; если false, оно означает правый/нижний край.
Since:
1.4

adjustSizes

public static int[] adjustSizes(int delta, SizeRequirements[] children)
Корректирует указанный массив размеров на заданное значение.
Parameters:
delta - целое число, указывающее разницу в размерах
children - массив объектов SizeRequirements
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/javax/swing/SizeRequirements.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API