Класс BackgroundSize

java.lang.Object

javafx.scene.layout.BackgroundSize

Все реализуемые интерфейсы:: Interpolatable<BackgroundSize>

public final class BackgroundSize extends Object implements Interpolatable<BackgroundSize>

Определяет размер области, которую BackgroundImage должен заполнить относительно Region, которую он стилизует. Существуют несколько свойств, значения которых имеют приоритет над другими. В частности, есть 4 ключевых свойства, width, height, contain и cover. Ширина и высота независимы друг от друга, однако обе взаимодействуют с contain и cover.

Согласно спецификации CSS, cover определяется как:

Масштабировать изображение, сохраняя его исходное соотношение сторон (если таковое имеется), до наименьшего размера, при котором как ширина, так и высота могут полностью покрыть область размещения фона.

contain определяется как:

Масштабировать изображение, сохраняя его исходное соотношение сторон (если таковое имеется), до наибольшего размера, при котором как ширина, так и высота могут поместиться внутри области размещения фона.

А ширина и высота оба задают (в абсолютных значениях или процентах) размер, который нужно использовать. Эти два свойства применяются только в том случае, если cover и contain имеют значение false. Если оба cover и contain имеют значение true, то cover будет использоваться.

Ширина и высота также могут быть установлены в AUTO, что указывает на то, что область должна быть размером, чтобы использовать исходный размер изображения, или, если его невозможно определить, 100%.

С момента:: JavaFX 8.0

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

Модификатор и тип	Поле	Описание
`static final double`	`AUTO`	Согласно спецификации CSS: значение "auto" для одного измерения определяется с использованием соотношения сторон изображения и размера другого измерения, или, если это не удаётся, используя исходный размер изображения, или, если это не удаётся, рассматривая его как 100%.
`static final BackgroundSize`	`DEFAULT`	Значение BackgroundSize по умолчанию, используемое BackgroundImages, когда явных размеров не определено.

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

Конструктор	Описание
`BackgroundSize(double width, double height, boolean widthAsPercentage, boolean heightAsPercentage, boolean contain, boolean cover)`	Создаёт новый BackgroundSize.

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

Модификатор и тип	Метод	Описание
`final double`	`getHeight()`	Высота области внутри Region, где должно отображаться связанное BackgroundImage.
`final double`	`getWidth()`	Ширина области внутри Region, где должно отображаться связанное BackgroundImage.
`BackgroundSize`	`interpolate(BackgroundSize endValue, double t)`	Возвращает промежуточное значение между значением этого `Interpolatable` и заданным `endValue` с использованием линейного коэффициента интерполяции `t`, изменяющегося от 0 (включительно) до 1 (включительно).
`final boolean`	`isContain()`	Если true, масштабирует изображение, сохраняя его исходное соотношение сторон (если таковое имеется), до наибольшего размера, при котором как ширина, так и высота могут поместиться внутри области размещения фона.
`final boolean`	`isCover()`	Если true, масштабирует изображение, сохраняя его исходное соотношение сторон (если таковое имеется), до наименьшего размера, при котором как ширина, так и высота могут полностью покрыть область размещения фона.
`final boolean`	`isHeightAsPercentage()`	Указывает, должно ли значение, содержащееся в `height`, интерпретироваться как процент или как обычное значение.
`final boolean`	`isWidthAsPercentage()`	Указывает, должно ли значение, содержащееся в `width`, интерпретироваться как процент или как обычное значение.

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

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

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

AUTO

public static final double AUTO

Из спецификации CSS:

Значение "auto" для одной размерности определяется с использованием внутреннего соотношения изображения и размера другой размерности или, если это не удаётся, с использованием внутреннего размера изображения, или, если это не удаётся, рассматривается как 100%.
Если оба значения равны "auto", то используется внутренняя ширина и/или высота изображения, если они есть; отсутствующая размерность (если есть) обрабатывается как "auto" так, как описано выше. Если у изображения нет ни внутренней ширины, ни внутренней высоты, его размер определяется так же, как для "contain".

При установке в AUTO значения widthAsPercentage и heightAsPercentage игнорируются.

См. также:

DEFAULT

public static final BackgroundSize DEFAULT

Значение BackgroundSize по умолчанию, используемое BackgroundImages, когда явных размеров не определено. По умолчанию BackgroundSize равен AUTO, AUTO для ширины и высоты, и не является ни cover, ни contain.

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

BackgroundSize

public BackgroundSize(double width, double height, boolean widthAsPercentage, boolean heightAsPercentage, boolean contain, boolean cover)

Создаёт новый BackgroundSize.

Параметры:: width - Ширина. Не может быть меньше 0, за исключением значения AUTO.; height - Высота. Не может быть меньше 0, за исключением значения AUTO.; widthAsPercentage - Является ли ширина процентом; heightAsPercentage - Является ли высота процентом; contain - Должно ли изображение быть размером, максимально подходящим для области; cover - Должно ли изображение быть размером "cover" для области

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

getWidth

public final double getWidth()

Ширина области внутри Region, где должно отображаться связанное BackgroundImage. Если установлено значение AUTO, то widthAsPercentage игнорируется. Это значение не имеет смысла, если указаны либо contain, либо cover. Это значение не может быть отрицательным, за исключением значения AUTO.

Тип интерполяции:: дискретный если cover или contain установлено, если одно значение является абсолютным, а другое — процентом percentage, или если ширина равна AUTO; в противном случае линейный
Возвращает:: ширину области внутри Region, где должно отображаться связанное BackgroundImage

getHeight

public final double getHeight()

Высота области внутри Region, где должно отображаться связанное BackgroundImage. Если установлено значение AUTO, то heightAsPercentage игнорируется. Это значение не имеет смысла, если указаны либо contain, либо cover. Это значение не может быть отрицательным, за исключением значения AUTO.

Тип интерполяции:: дискретный если cover или contain установлено, если одно значение является абсолютным, а другое — процентом percentage, или если высота равна AUTO; в противном случае линейный
Возвращает:: высоту области внутри Region, где должно отображаться связанное BackgroundImage

isWidthAsPercentage

public final boolean isWidthAsPercentage()

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

Тип интерполяции:: дискретный
Возвращает:: true, если ширина должна интерпретироваться как процент

isHeightAsPercentage

public final boolean isHeightAsPercentage()

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

Тип интерполяции:: дискретный
Возвращает:: true, если высота должна интерпретироваться как процент

isContain

public final boolean isContain()

Если true, масштабирует изображение, сохраняя его внутреннее соотношение сторон (если таковое имеется), до наибольшего размера, при котором и ширина, и высота могут поместиться внутри области позиционирования фона.

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

isCover

public final boolean isCover()

Если true, масштабирует изображение, сохраняя его внутреннее соотношение сторон (если таковое имеется), до наименьшего размера, при котором и ширина, и высота могут полностью покрыть область позиционирования фона.

Тип интерполяции:: дискретный
Возвращает:: true, если изображение может полностью покрыть область позиционирования фона

interpolate

public BackgroundSize interpolate(BackgroundSize endValue, double t)

Возвращает промежуточное значение между значением этого Interpolatable и указанным endValue с использованием линейного коэффициента интерполяции t, изменяющегося от 0 (включительно) до 1 (включительно).

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

Определено в:: interpolate в интерфейсе Interpolatable<BackgroundSize>
Параметры:: endValue - целевое значение; t - коэффициент интерполяции
Возвращает:: промежуточное значение
Исключения:: NullPointerException - если endValue является null
С:: 24

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.