Класс BackgroundPosition

java.lang.Object

fx.scene.layout.BackgroundPosition

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

public final class BackgroundPosition extends Object implements Interpolatable<BackgroundPosition>

Представляет положение BackgroundImage внутри области рисования Region.

BackgroundImage может быть позиционирован как слева, так и справа по горизонтальной оси, и сверху или снизу по вертикальной. Свойства horizontalSide и verticalSide определяют, к какой стороне относятся остальные свойства. Свойство horizontalPosition указывает расстояние BackgroundImage от соответствующей стороны Region, а horizontalAsPercentage указывает, является ли это значением или процентом. Аналогичные свойства используются для указания размера относительно вертикальной оси.

Например, предположим, что у меня есть BackgroundPosition со значением horizontalSide Side.RIGHT, значением horizontalPosition 0.05, и значением horizontalAsPercentage true. В этом случае правая сторона BackgroundImage будет расположена на 5% ширины Region от правого края Region.

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

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

Модификатор и тип	Поле	Описание
`static final BackgroundPosition`	`CENTER`	BackgroundPosition, который центрирует BackgroundImage.
`static final BackgroundPosition`	`DEFAULT`	Значение BackgroundPosition по умолчанию для любого BackgroundImage.

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

Конструктор	Описание
`BackgroundPosition(Side horizontalSide, double horizontalPosition, boolean horizontalAsPercentage, Side verticalSide, double verticalPosition, boolean verticalAsPercentage)`	Создает новый BackgroundPosition.

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

Модификатор и тип	Метод	Описание
`final double`	`getHorizontalPosition()`	Значение, указывающее положение BackgroundImage относительно Region по стороне, указанной свойством `horizontalSide`.
`final Side`	`getHorizontalSide()`	Сторона по горизонтали, к которой привязывается BackgroundImage.
`final double`	`getVerticalPosition()`	Значение, указывающее положение BackgroundImage относительно Region по стороне, указанной свойством `verticalSide`.
`final Side`	`getVerticalSide()`	Сторона по вертикали, к которой привязывается BackgroundImage.
`BackgroundPosition`	`interpolate(BackgroundPosition endValue, double t)`	Возвращает промежуточное значение между значением этого `Interpolatable` и указанным `endValue` с использованием линейного коэффициента интерполяции `t`, изменяющегося от 0 (включительно) до 1 (включительно).
`final boolean`	`isHorizontalAsPercentage()`	Указывает, должно ли значение `horizontalPosition` интерпретироваться как числовое значение или как процент.
`final boolean`	`isVerticalAsPercentage()`	Указывает, должно ли значение `verticalPosition` интерпретироваться как числовое значение или как процент.

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

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

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

DEFAULT

public static final BackgroundPosition DEFAULT

По умолчанию BackgroundPosition для любого BackgroundImage. По умолчанию нет отступов, и значение задано как 0% и 0%. То есть, позиция находится в верхнем левом углу.

CENTER

public static final BackgroundPosition CENTER

BackgroundPosition, который центрирует BackgroundImage.

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

BackgroundPosition

public BackgroundPosition(Side horizontalSide, double horizontalPosition, boolean horizontalAsPercentage, Side verticalSide, double verticalPosition, boolean verticalAsPercentage)

Создает новый BackgroundPosition.

Параметры:: horizontalSide - Горизонтальная сторона, должна быть либо null, LEFT, или RIGHT. Если null, используется LEFT. Если указаны TOP или BOTTOM, выбрасывается IllegalArgumentException.; horizontalPosition - Значение горизонтальной позиции.; horizontalAsPercentage - Необходимо ли интерпретировать горизонтальную позицию как десятичное число или процентное значение; verticalSide - Вертикальная сторона, должна быть либо null, TOP, или BOTTOM. Если null, используется TOP. Если указаны LEFT или RIGHT, выбрасывается IllegalArgumentException.; verticalPosition - Значение вертикальной позиции.; verticalAsPercentage - Необходимо ли интерпретировать вертикальную позицию как десятичное число или процентное значение

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

getHorizontalSide

public final Side getHorizontalSide()

Сторона по горизонтальной оси, к которой привязано BackgroundImage. Будет либо LEFT, либо RIGHT, никогда не null.

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

getVerticalSide

public final Side getVerticalSide()

Сторона по вертикальной оси, к которой привязано BackgroundImage. Будет либо TOP, либо BOTTOM, никогда не null.

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

getHorizontalPosition

public final double getHorizontalPosition()

Значение, указывающее положение BackgroundImage относительно области по стороне, указанной свойством horizontalSide. Это значение может быть значением или процентом, в зависимости от свойства horizontalAsPercentage. Допустимы отрицательные значения.

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

getVerticalPosition

public final double getVerticalPosition()

Значение, указывающее положение BackgroundImage относительно области по стороне, указанной свойством verticalSide. Это значение может быть значением или процентом, в зависимости от свойства verticalAsPercentage. Допустимы отрицательные значения.

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

isHorizontalAsPercentage

public final boolean isHorizontalAsPercentage()

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

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

isVerticalAsPercentage

public final boolean isVerticalAsPercentage()

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

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

interpolate

public BackgroundPosition interpolate(BackgroundPosition endValue, double t)

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

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

Определено в:: interpolate в интерфейсе Interpolatable<BackgroundPosition>
Параметры:: 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.