Класс 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%.

С момента:: 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.
`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 - Следует ли изменять масштаб изображения так, чтобы оно максимально вписывалось в Region; cover - Следует ли изменять масштаб изображения так, чтобы оно "покрывало" Region

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

getWidth

public final double getWidth()

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

Возвращает:: ширину области внутри Region, где должен отображаться связанный BackgroundImage

getHeight

public final double getHeight()

Высота области внутри Region, где должен отображаться связанный BackgroundImage. Если установлено AUTO, то heightAsPercentage игнорируется. Это значение не имеет смысла, если указаны либо contain, либо cover. Это значение не может быть отрицательным, за исключением случая, когда оно установлено в 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, если изображение может полностью покрыть область позиционирования фона

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