Класс BackgroundSize

java.lang.Object

javafx.scene.layout.BackgroundSize

public final class BackgroundSize
extends Object

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

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

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

contain определено как:

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

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

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

Since:: JavaFX 8.0

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

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

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

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

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

Модификатор и тип	Метод	Описание
`double`	`getHeight()`	Высота области в Region, где должно отображаться связанное BackgroundImage.
`double`	`getWidth()`	Ширина области в Region, где должно отображаться связанное BackgroundImage.
`boolean`	`isContain()`	Если true, масштабирует изображение, сохраняя его внутреннее соотношение сторон (если таковое имеется), до наибольшего размера, при котором и ширина, и высота могут поместиться внутри области позиционирования фона.
`boolean`	`isCover()`	Если true, масштабирует изображение, сохраняя его внутреннее соотношение сторон (если таковое имеется), до наименьшего размера, при котором и ширина, и высота могут полностью покрыть область позиционирования фона.
`boolean`	`isHeightAsPercentage()`	Указывает, должно ли значение, содержащееся в `height`, интерпретироваться как процентное или как обычное значение.
`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 игнорируются.

See Also:: Постоянные значения полей

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.

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

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

getWidth

public final double getWidth()

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

Returns:: ширина области в Region, где должно отображаться связанное BackgroundImage

getHeight

public final double getHeight()

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

Returns:: высота области в Region, где должно отображаться связанное BackgroundImage

isWidthAsPercentage

public final boolean isWidthAsPercentage()

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

Returns:: true, если ширина должна интерпретироваться как процент

isHeightAsPercentage

public final boolean isHeightAsPercentage()

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

Returns:: true, если высота должна интерпретироваться как процент

isContain

public final boolean isContain()

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

Returns:: true, если изображение может поместиться внутри области позиционирования фона

isCover

public final boolean isCover()

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

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

© 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.