Класс KeyFrame

java.lang.Object

fx.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 - the time; name - the name; onFinished - the onFinished; values - a ObservableList of KeyValue instances
Исключения:: NullPointerException - if time is null; IllegalArgumentException - if time is invalid (see time)

KeyFrame

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

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

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

Параметры:: time - the time; name - the name; onFinished - the onFinished; values - the KeyValue instances
Исключения:: NullPointerException - if time is null; IllegalArgumentException - if time is invalid (see time)

KeyFrame

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

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

Параметры:: time - the time; onFinished - the onFinished; values - the KeyValue instances
Исключения:: NullPointerException - if time is null; IllegalArgumentException - if time is invalid (see time)

KeyFrame

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

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

Параметры:: time - the time; name - the name; values - the KeyValue instances
Исключения:: NullPointerException - if time is null; IllegalArgumentException - if time is invalid (see time)

KeyFrame

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

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

Параметры:: time - the time; values - the KeyValue instances
Исключения:: NullPointerException - if time is null; IllegalArgumentException - if time is invalid (see time)

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

getTime

public Duration getTime()

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

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

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

getValues

public Set<KeyValue> getValues()

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

Возвращает:: неизменяемый Set из KeyValue instances

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 in class Object
Возвращает:: строковое представление

hashCode

public int hashCode()

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

Overrides:: hashCode in class Object
Возвращает:: хэш-код

equals

public boolean equals(Object obj)

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

Overrides:: equals in class 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.