Класс KeyFrame

java.lang.Object

javafx.animation.KeyFrame

public final class KeyFrame extends Object

Определяет целевые значения в заданный момент времени для набора переменных, которые интерполируются вдоль Timeline.

Разработчик контролирует интерполяцию набора переменных для интервала между последовательными ключевыми кадрами, предоставляя целевое значение и Interpolator, связанный с каждой переменной. Переменные интерполируются таким образом, чтобы они достигли своего целевого значения в указанное время. Функция onFinished вызывается для каждого KeyFrame, если она предоставлена. KeyFrame может необязательно иметь name, что приведет к добавлению метки в Timeline.

Since:

JavaFX 2.0

См. также:

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

Конструктор	Описание
`KeyFrame(Duration time, String name, KeyValue... values)`	Конструктор `KeyFrame`
`KeyFrame(Duration time, String name, EventHandler<ActionEvent> onFinished, Collection<KeyValue> values)`	Конструктор `KeyFrame`
`KeyFrame(Duration time, String name, EventHandler<ActionEvent> onFinished, KeyValue... values)`	Конструктор `KeyFrame`
`KeyFrame(Duration time, KeyValue... values)`	Конструктор `KeyFrame`
`KeyFrame(Duration time, EventHandler<ActionEvent> onFinished, KeyValue... values)`	Конструктор `KeyFrame`

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

Модификатор и тип	Метод	Описание
`boolean`	`equals(Object obj)`	Указывает, является ли другой объект "равным" этому.
`String`	`getName()`	Возвращает `name` этого `KeyFrame`.
`EventHandler<ActionEvent>`	`getOnFinished()`	Возвращает обработчик события `onFinished` этого `KeyFrame`.
`Duration`	`getTime()`	Возвращает временной сдвиг этого `KeyFrame`.
`Set<KeyValue>`	`getValues()`	Возвращает неизменяемый `Set` экземпляров `KeyValue`.
`int`	`hashCode()`	Возвращает хэш-код для этого объекта `KeyFrame`.
`String`	`toString()`	Возвращает строковое представление этого объекта `KeyFrame`.

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

KeyFrame

public KeyFrame(Duration time, String name, EventHandler<ActionEvent> onFinished, Collection<KeyValue> values)

Конструктор KeyFrame

Если переданный KeyValue является null или дубликатом, он будет проигнорирован.

Параметры:: time - time; name - name; onFinished - onFinished; values - ObservableList экземпляров KeyValue
Исключения:: NullPointerException - если time равно null; IllegalArgumentException - если time некорректно (см. time)

KeyFrame

public KeyFrame(Duration time, String name, EventHandler<ActionEvent> onFinished, KeyValue... values)

Конструктор KeyFrame

Если переданный KeyValue является null или дубликатом, он будет проигнорирован.

Параметры:: time - time; name - name; onFinished - onFinished; values - экземпляры KeyValue
Исключения:: NullPointerException - если time равно null; IllegalArgumentException - если time некорректно (см. time)

KeyFrame

public KeyFrame(Duration time, EventHandler<ActionEvent> onFinished, KeyValue... values)

Конструктор KeyFrame

Параметры:: time - time; onFinished - onFinished; values - экземпляры KeyValue
Исключения:: NullPointerException - если time равно null; IllegalArgumentException - если time некорректно (см. time)

KeyFrame

public KeyFrame(Duration time, String name, KeyValue... values)

Конструктор KeyFrame

Параметры:: time - time; name - name; values - экземпляры KeyValue
Исключения:: NullPointerException - если time равно null; IllegalArgumentException - если time некорректно (см. time)

KeyFrame

public KeyFrame(Duration time, KeyValue... values)

Конструктор KeyFrame

Параметры:: time - time; values - экземпляры KeyValue
Исключения:: NullPointerException - если time равно null; IllegalArgumentException - если time некорректно (см. time)

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

getTime

public Duration getTime()

Возвращает смещение времени для этого KeyFrame. Возвращаемый Duration определяет смещение времени в рамках одного цикла Timeline, в котором будет установлено значение KeyValues и будет вызвана функция onFinished.

Смещение времени для KeyFrame должно быть больше или равно Duration.ZERO и не может быть Duration.UNKNOWN. Примечание: хотя единицей измерения time является миллисекунда, точность зависит от операционной системы и, как правило, будет больше. Например, анимации на настольных системах обычно выполняются с максимальной частотой 60 кадров в секунду, что обеспечивает точность около 17 мс.

Возвращает:: смещение времени

getValues

public Set<KeyValue> getValues()

Возвращает неизменяемый Set экземпляров KeyValue. KeyValue определяет целевой объект и желаемое значение, которое должно быть интерполировано в указанное время этого KeyFrame.

Возвращает:: неизменяемый Set экземпляров KeyValue

getOnFinished

public EventHandler<ActionEvent> getOnFinished()

Возвращает обработчик события onFinished этого KeyFrame. Обработчик события onFinished — это функция, которая вызывается, когда затраченное время на цикл превышает указанное время этого KeyFrame. Функция onFinished будет вызвана, если затраченное время превысит указанное значение, даже если оно никогда не равнялось этому значению точно.

Возвращает:: обработчик события onFinished

getName

public String getName()

Возвращает name этого KeyFrame. Если именованный KeyFrame добавлен в Timeline, автоматически будет добавлен отметка с name и time KeyFrame. Если KeyFrame удален, отметка также будет удалена.

Возвращает:: name

toString

public String toString()

Возвращает строковое представление этого объекта KeyFrame.

Overrides:: toString в классе Object
Возвращает:: строковое представление

hashCode

public int hashCode()

Возвращает код хэширования для этого объекта KeyFrame.

Overrides:: hashCode в классе Object
Возвращает:: код хэширования

equals

public boolean equals(Object obj)

Указывает, является ли другой объект "равным" этому. Два KeyFrames считаются равными, если их time, onFinished и values равны.

Overrides:: equals в классе Object
Возвращает:: true, если это то же самое, что и obj, иначе false

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