javafx.animation

Class KeyValue

java.lang.Object

javafx.animation.KeyValue

public final class KeyValue
extends java.lang.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

See Also:

Timeline, KeyFrame, Interpolator

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	KeyValue.Type Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Field Summary

Fields

Modifier and Type	Field and Description
private static Interpolator	DEFAULT_INTERPOLATOR
private java.lang.Object	endValue
private Interpolator	interpolator
private WritableValue<?>	target
private KeyValue.Type	type

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

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) Indicates whether some other object is "equal to" this one.
java.lang.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
KeyValue.Type	getType() Deprecated. This is an internal API that is not intended for use and will be removed in the next version
int	hashCode() Returns a hash code for this KeyValue object.
java.lang.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

Field Detail

DEFAULT_INTERPOLATOR

private static final Interpolator DEFAULT_INTERPOLATOR

type

private final KeyValue.Type type

target

private final WritableValue<?> target

endValue

private final java.lang.Object endValue

interpolator

private final Interpolator interpolator

Constructor Detail

KeyValue

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

Creates a KeyValue.

Parameters:

target - the target

endValue - the end value

interpolator - the Interpolator

Throws:

java.lang.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

endValue - the end value

Throws:

java.lang.NullPointerException - if target or interpolator are null

Method Detail

getType

@Deprecated
public KeyValue.Type getType()

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

getTarget

public WritableValue<?> getTarget()

Returns the target of this KeyValue

Returns:

the target

getEndValue

public java.lang.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 java.lang.String toString()

Returns a string representation of this KeyValue object.

Overrides:

toString in class java.lang.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 java.lang.Object

Returns:

a hash code for this KeyValue object.

equals

public boolean equals(java.lang.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 java.lang.Object