JavaFX 24 · javafx.animation.KeyValue · APIdia, the JavaDoc alternative

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 javafx.beans.value.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.

Modifier and Type	Field and Description
private static final Interpolator	DEFAULT_INTERPOLATOR
private final Object	endValue
private final Interpolator	interpolator
private final WritableValue<?>	target
private final KeyValueType	type

Constructor Summary

Access	Constructor and Description
public < the type of the `KeyValue` T>	KeyValue(WritableValue<T> the target target, T the end value endValue, Interpolator the `Interpolator` interpolator) Creates a `KeyValue`.
public < the type of the `KeyValue` T>	KeyValue(WritableValue<T> the target target, T the end value endValue) Creates a `KeyValue` that uses `Interpolator#LINEAR`.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public Object	Returns: the end value getEndValue() Returns the end value of this `KeyValue`
public Interpolator	Returns: the interpolator to be used for calculating the key value along the particular interval getInterpolator() `Interpolator` to be used for calculating the key value along the particular interval.
public WritableValue<?>	Returns: the target getTarget() Returns the target of this `KeyValue`
pack-priv KeyValueType	getType()
public int	Returns: the hash code hashCode() Overrides java.lang.Object.hashCode. Returns a hash code for this `KeyValue` object.
public String	Returns: the string representation toString() Overrides java.lang.Object.toString. Returns a string representation of this `KeyValue` object.

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll wait wait wait

Field Detail

DEFAULT_INTERPOLATOR	back to summary
private static final Interpolator DEFAULT_INTERPOLATOR

endValue	back to summary
private final Object endValue

interpolator	back to summary
private final Interpolator interpolator

target	back to summary
private final WritableValue<?> target

type	back to summary
private final KeyValueType type

Constructor Detail

KeyValue back to summary

KeyValue	back to summary
public <T> KeyValue(WritableValue<T> target, T endValue, Interpolator interpolator) Creates a `KeyValue`. Parameters <T> the type of the `KeyValue` target:WritableValue<T> the target endValue:T the end value interpolator:Interpolator the `Interpolator` Exceptions NullPointerException: if `target` or `interpolator` are `null`

public <T> KeyValue(WritableValue<T> target, T endValue, Interpolator interpolator)

Creates a KeyValue.

Parameters

<T>: the type of the KeyValue
target:WritableValue<T>: the target
endValue:T: the end value
interpolator:Interpolator: the Interpolator

Exceptions

NullPointerException:: if target or interpolator are null

KeyValue back to summary

KeyValue	back to summary
public <T> KeyValue(WritableValue<T> target, T endValue) Creates a `KeyValue` that uses `Interpolator#LINEAR`. Parameters <T> the type of the `KeyValue` target:WritableValue<T> the target endValue:T the end value Exceptions NullPointerException: if `target` or `interpolator` are `null`

public <T> KeyValue(WritableValue<T> target, T endValue)

Creates a KeyValue that uses Interpolator#LINEAR.

Parameters

<T>: the type of the KeyValue
target:WritableValue<T>: the target
endValue:T: the end value

Exceptions

NullPointerException:: if target or interpolator are null

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object obj) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one. Two `KeyValues` are considered equal, if their `target`, `endValue`, and `interpolator` are equal. Parameters obj:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object obj)

Overrides java.lang.Object.equals.

Indicates whether some other object is "equal to" this one. Two KeyValues are considered equal, if their target, endValue, and interpolator are equal.

Parameters

obj:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

getEndValue back to summary

getEndValue	back to summary
public Object getEndValue() Returns the end value of this `KeyValue` Returns:Object the end value

public Object getEndValue()

Returns the end value of this KeyValue

Returns:Object: the end value

getInterpolator back to summary

getInterpolator	back to summary
public Interpolator getInterpolator() `Interpolator` to be used for calculating the key value along the particular interval. By default, `Interpolator#LINEAR` is used. Returns:Interpolator the interpolator to be used for calculating the key value along the particular interval

public Interpolator getInterpolator()

Interpolator to be used for calculating the key value along the particular interval. By default, Interpolator#LINEAR is used.

Returns:Interpolator: the interpolator to be used for calculating the key value along the particular interval

getTarget back to summary

getTarget	back to summary
public WritableValue<?> getTarget() Returns the target of this `KeyValue` Returns:WritableValue<?> the target

public WritableValue<?> getTarget()

Returns the target of this KeyValue

Returns:WritableValue<?>: the target

getType	back to summary
pack-priv KeyValueType getType()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Returns a hash code for this `KeyValue` object. Returns:int the hash code Annotations @Override

public int hashCode()

Overrides java.lang.Object.hashCode.

Returns a hash code for this KeyValue object.

Returns:int

the hash code

Annotations

@Override

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Returns a string representation of this `KeyValue` object. Returns:String the string representation Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Returns a string representation of this KeyValue object.

Returns:String

the string representation

Annotations

@Override

public final Class KeyValue

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail