KeyFrame (JavaFX 8)

java.lang.Object
- javafx.animation.KeyFrame

```
public final class KeyFrame
extends Object
```
Timelineに沿って補間される一連の変数に対して、特定の時点におけるターゲット値を定義します。
開発者は、各変数に関連付けられたターゲット値およびInterpolatorを指定することによって、連続するキー・フレーム間の間隔に対する一連の変数の補間を制御します。変数は、指定された時間にターゲット値に到達するように補間されます。 onFinished関数が指定されている場合は、各KeyFrameで呼び出されます。 KeyFrameにはオプションでnameを指定でき、指定した場合、キュー・ポイントがTimelineに自動的に追加されるようになります。

導入されたバージョン:

JavaFX 2.0

関連項目:

Timeline, KeyValue, Interpolator

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明
`KeyFrame(Duration time, EventHandler<ActionEvent> onFinished, KeyValue... values)` `KeyFrame`のコンストラクタ
`KeyFrame(Duration time, 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, String name, KeyValue... values)` `KeyFrame`のコンストラクタ

メソッドのサマリー

すべてのメソッドインスタンス・メソッド具象メソッド
修飾子と型	メソッドと説明
`boolean`	`equals(Object obj)` このオブジェクトと他のオブジェクトが等しいかどうかを示します。
`String`	`getName()` この`KeyFrame`の`name`を返します。
`EventHandler<ActionEvent>`	`getOnFinished()` この`KeyFrame`の`onFinished`イベント・ハンドラを返します。
`Duration`	`getTime()` この`KeyFrame`の時間オフセットを返します。
`Set<KeyValue>`	`getValues()` `KeyValue`インスタンスの不変の`Set`を返します。
`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-handler
    
    values - KeyValueインスタンスのObservableList
    
    例外:
    
    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-handler
    
    values - KeyValueインスタンス
    
    例外:
    
    NullPointerException - timeがnullの場合
    
    IllegalArgumentException - timeが無効な場合(timeを参照)
  - KeyFrame
```
public KeyFrame(Duration time,
                EventHandler<ActionEvent> onFinished,
                KeyValue... values)
```
    KeyFrameのコンストラクタ
    
    パラメータ:
    
    time - time
    
    onFinished - onFinished-handler
    
    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のtimeは、Duration.ZERO以上にする必要があり、Duration.UNKNOWNには設定できません。ノート: timeの単位はミリ秒ですが、粒度は基礎となるオペレーティング・システムによって異なり、一般的には大きくなります。たとえば、デスクトップ・システム上のアニメーションは、通常、最大60fpsで実行され、その粒度は最大17ミリ秒になります。
  - getValues
```
public Set<KeyValue> getValues()
```
    KeyValueインスタンスの不変のSetを返します。 KeyValueでは、このKeyFrameの指定時間に補間されるようにする必要がある、ターゲットと目的の値を定義します。
  - getOnFinished
```
public EventHandler<ActionEvent> getOnFinished()
```
    このKeyFrameのonFinishedイベント・ハンドラを返します。 onFinishedイベント・ハンドラは、サイクルの経過時間がこのKeyFrameの指定時間を超えたときに呼び出される関数です。 onFinished関数変数は、時間値に正確に一致することがなくても、経過時間が指定値を超えたときに呼び出されます。
  - getName
```
public String getName()
```
    このKeyFrameのnameを返します。指定したKeyFrameがTimelineに追加されると、そのKeyFrameのnameおよびtimeを持つキュー・ポイントが自動的に追加されます。 KeyFrameが削除されると、キュー・ポイントも削除されます。
  - toString
```
public String toString()
```
    このKeyFrameオブジェクトの文字列表現を返します。
    
    オーバーライド:
    
    toString、クラスObject
    
    戻り値:
    
    このKeyFrameオブジェクトの文字列表現。
  - hashCode
```
public int hashCode()
```
    このKeyFrameオブジェクトのハッシュ・コードを返します。
    
    オーバーライド:
    
    hashCode、クラスObject
    
    戻り値:
    
    このKeyFrameオブジェクトのハッシュ・コード。
  - equals
```
public boolean equals(Object obj)
```
    このオブジェクトと他のオブジェクトが等しいかどうかを示します。 time、onFinishedおよびvaluesが等しい場合、2つのKeyFramesは等しいとみなされます。
    
    オーバーライド:
    
    equals、クラスObject

クラスKeyFrame

コンストラクタのサマリー

メソッドのサマリー

クラス java.lang.Objectから継承されたメソッド

コンストラクタの詳細

KeyFrame

KeyFrame

KeyFrame

KeyFrame

KeyFrame

メソッドの詳細

getTime

getValues

getOnFinished

getName

toString

hashCode

equals