Класс KeyFrame

java.lang.Object

javafx.animation.KeyFrame

public final class KeyFrame
extends Object

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

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

Since:: JavaFX 2.0
См. также:: Timeline, KeyValue, Interpolator

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

Конструкторы
Конструктор	Описание
`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()

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

Возвращает:: неизменяемую коллекцию экземпляров KeyValue

getOnFinished

public EventHandler<ActionEvent> getOnFinished()

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

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

getName

public String getName()

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

Возвращает:: имя name

toString

public String toString()

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

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

hashCode

public int hashCode()

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

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

equals

public boolean equals(Object obj)

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

Переопределяет:: 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.