javafx.animation

Class KeyValue

java.lang.Object

javafx.animation.KeyValue

public final class KeyValue
extends Object

Defines a key value to be interpolated for a particular interval along the animation. A KeyFrame, which defines a specific point on a timeline, can hold multiple KeyValues. KeyValue is an immutable class.

A KeyValue is defined by a target, which is an implementation of WritableValue, an end value and an Interpolator.

Most interpolators define the interpolation between two KeyFrames. (The only exception are tangent-interpolators.) The KeyValue of the second KeyFrame (in forward direction) specifies the interpolator to be used in the interval.

Tangent-interpolators define the interpolation to the left and to the right of a KeyFrame (see Interpolator.TANGENT).

By default, Interpolator.LINEAR is used in the interval.

Since:

JavaFX 2.0

Constructor Summary

Constructors
Constructor and Description
`KeyValue(WritableValue<T> target, T endValue)` Creates a `KeyValue` that uses `Interpolator.LINEAR`.
`KeyValue(WritableValue<T> target, T endValue, Interpolator interpolator)` Creates a `KeyValue`.

Method Summary

All MethodsInstance MethodsConcrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`Object`	`getEndValue()` Returns the end value of this `KeyValue`
`Interpolator`	`getInterpolator()` `Interpolator` to be used for calculating the key value along the particular interval.
`WritableValue<?>`	`getTarget()` Returns the target of this `KeyValue`
`int`	`hashCode()` Returns a hash code for this `KeyValue` object.
`String`	`toString()` Returns a string representation of this `KeyValue` object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- KeyValue
```
public KeyValue(WritableValue<T> target,
                T endValue,
                Interpolator interpolator)
```
  Creates a KeyValue.
  
  Parameters:
  
  target - the target
  
  Throws:
  
  NullPointerException - if target or interpolator are null
- KeyValue
```
public KeyValue(WritableValue<T> target,
                T endValue)
```
  Creates a KeyValue that uses Interpolator.LINEAR.
  
  Parameters:
  
  target - the target
  
  Throws:
  
  NullPointerException - if target or interpolator are null

Method Detail
- getTarget
```
public WritableValue<?> getTarget()
```
  Returns the target of this KeyValue
  
  Returns:
  
  the target
- getEndValue
```
public Object getEndValue()
```
  Returns the end value of this KeyValue
  
  Returns:
  
  the end value
- getInterpolator
```
public Interpolator getInterpolator()
```
  Interpolator to be used for calculating the key value along the particular interval. By default, Interpolator.LINEAR is used.
- toString
```
public String toString()
```
  Returns a string representation of this KeyValue object.
  
  Overrides:
  
  toString in class Object
  
  Returns:
  
  a string representation of this KeyValue object.
- hashCode
```
public int hashCode()
```
  Returns a hash code for this KeyValue object.
  
  Overrides:
  
  hashCode in class Object
  
  Returns:
  
  a hash code for this KeyValue object.
- equals
```
public boolean equals(Object obj)
```
  Indicates whether some other object is "equal to" this one. Two KeyValues are considered equal, if their target, endValue, and interpolator are equal.
  
  Overrides:
  
  equals in class Object

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

Class KeyValue

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

KeyValue

KeyValue

Method Detail

getTarget

getEndValue

getInterpolator

toString

hashCode

equals