- 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, 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()
このKeyFrame
のname
を返します。EventHandler<ActionEvent>
getOnFinished()
このKeyFrame
のonFinished
イベント・ハンドラを返します。Duration
getTime()
このKeyFrame
の時間オフセットを返します。Set<KeyValue>
getValues()
KeyValue
インスタンスの不変のSet
を返します。int
hashCode()
このKeyFrame
オブジェクトのハッシュ・コードを返します。String
toString()
このKeyFrame
オブジェクトの文字列表現を返します。
-
-
-
コンストラクタの詳細
-
KeyFrame
public KeyFrame(Duration time, String name, EventHandler<ActionEvent> onFinished, Collection<KeyValue> values)
KeyFrame
のコンストラクタ渡された
KeyValue
がnull
か、重複している場合は無視されます。- パラメータ:
time
-time
name
-name
onFinished
-onFinished
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
values
-KeyValue
インスタンス- 例外:
NullPointerException
-time
がnullの場合IllegalArgumentException
-time
が無効な場合(time
を参照)
-
KeyFrame
public KeyFrame(Duration time, EventHandler<ActionEvent> onFinished, KeyValue... values)
KeyFrame
のコンストラクタ- パラメータ:
time
-time
onFinished
-onFinished
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
の指定時間に補間されるようにする必要がある、ターゲットと目的の値を定義します。- 戻り値:
KeyValue
インスタンスの不変のSet
-
getOnFinished
public EventHandler<ActionEvent> getOnFinished()
このKeyFrame
のonFinished
イベント・ハンドラを返します。onFinished
イベント・ハンドラは、サイクルの経過時間がこのKeyFrame
の指定時間を超えたときに呼び出される関数です。onFinished
関数変数は、時間値に正確に一致することがなくても、経過時間が指定値を超えたときに呼び出されます。- 戻り値:
onFinished
イベント・ハンドラ
-
getName
public String getName()
このKeyFrame
のname
を返します。 指定したKeyFrame
がTimeline
に追加されると、そのKeyFrame
のname
およびtime
を持つキュー・ポイントが自動的に追加されます。KeyFrame
が削除されると、キュー・ポイントも削除されます。- 戻り値:
name
-
toString
public String toString()
このKeyFrame
オブジェクトの文字列表現を返します。
-
hashCode
public int hashCode()
このKeyFrame
オブジェクトのハッシュ・コードを返します。- オーバーライド:
hashCode
、クラス:Object
- 戻り値:
- ハッシュ・コード
- 関連項目:
Object.equals(java.lang.Object)
,System.identityHashCode(java.lang.Object)
-
equals
public boolean equals(Object obj)
このオブジェクトと他のオブジェクトが等しいかどうかを示します。time
、onFinished
およびvalues
が等しい場合、2つのKeyFrames
は等しいとみなされます。- オーバーライド:
equals
、クラス:Object
- パラメータ:
obj
- 比較対象の参照オブジェクト。- 戻り値:
true
がobjと同じ場合はそれを、それ以外の場合はfalse
- 関連項目:
Object.hashCode()
、HashMap
-
-