<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> <!-- NewPage --> <html lang="en"> <head> <!-- Generated by javadoc (1.8.0_77) on Fri Apr 22 13:46:46 UTC 2016 --> <title>KeyFrame (JavaFX 8)</title> <meta name="date" content="2016-04-22"> <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> <script type="text/javascript" src="../../script.js"></script> </head> <body> <script type="text/javascript"><!-- try { if (location.href.indexOf('is-external=true') == -1) { parent.document.title="KeyFrame (JavaFX 8)"; } } catch(err) { } //--> var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; var altColor = "altColor"; var rowColor = "rowColor"; var tableTab = "tableTab"; var activeTableTab = "activeTableTab"; </script> <noscript> <div>JavaScript is disabled on your browser.</div> </noscript> <!-- ========= START OF TOP NAVBAR ======= --> <div class="topNav"><a name="navbar.top"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.top.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/KeyFrame.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../deprecated-list.html">Deprecated</a></li> <li><a href="../../index-all.html">Index</a></li> <li><a href="../../help-doc.html">Help</a></li> </ul> <div class="aboutLanguage">JavaFX 8</div> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../javafx/animation/Interpolator.html" title="class in javafx.animation"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../index.html?javafx/animation/KeyFrame.html" target="_top">Frames</a></li> <li><a href="KeyFrame.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_top"> <li><a href="../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_top"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.top"> <!-- --> </a></div> <!-- ========= END OF TOP NAVBAR ========= --> <!-- ======== START OF CLASS DATA ======== --> <div class="header"> <div class="subTitle">javafx.animation</div> <h2 title="Class KeyFrame" class="title">Class KeyFrame</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> <li> <ul class="inheritance"> <li>javafx.animation.KeyFrame</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public final class <span class="typeNameLabel">KeyFrame</span> extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre> <div class="block">Defines target values at a specified point in time for a set of variables that are interpolated along a <a href="../../javafx/animation/Timeline.html" title="class in javafx.animation"><code>Timeline</code></a>. <p> The developer controls the interpolation of a set of variables for the interval between successive key frames by providing a target value and an <a href="../../javafx/animation/Interpolator.html" title="class in javafx.animation"><code>Interpolator</code></a> associated with each variable. The variables are interpolated such that they will reach their target value at the specified time. An <a href="../../javafx/animation/KeyFrame.html#onFinished"><code>onFinished</code></a> function is invoked on each <code>KeyFrame</code> if one is provided. A <code>KeyFrame</code> can optionally have a <a href="../../javafx/animation/KeyFrame.html#name"><code>name</code></a>, which will result in a cuepoint that is automatically added to the <code>Timeline</code>.</div> <dl> <dt><span class="simpleTagLabel">Since:</span></dt> <dd>JavaFX 2.0</dd> <dt><span class="seeLabel">See Also:</span></dt> <dd><a href="../../javafx/animation/Timeline.html" title="class in javafx.animation"><code>Timeline</code></a>, <a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation"><code>KeyValue</code></a>, <a href="../../javafx/animation/Interpolator.html" title="class in javafx.animation"><code>Interpolator</code></a></dd> </dl> </li> </ul> </div> <div class="summary"> <ul class="blockList"> <li class="blockList"> <!-- ======== CONSTRUCTOR SUMMARY ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.summary"> <!-- --> </a> <h3>Constructor Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> <caption><span>Constructors</span><span class="tabEnd"> </span></caption> <tr> <th class="colOne" scope="col">Constructor and Description</th> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyFrame.html#KeyFrame-javafx.util.Duration-javafx.event.EventHandler-javafx.animation.KeyValue...-">KeyFrame</a></span>(<a href="../../javafx/util/Duration.html" title="class in javafx.util">Duration</a> time, <a href="../../javafx/event/EventHandler.html" title="interface in javafx.event">EventHandler</a><<a href="../../javafx/event/ActionEvent.html" title="class in javafx.event">ActionEvent</a>> onFinished, <a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation">KeyValue</a>... values)</code> <div class="block">Constructor of <code>KeyFrame</code></div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyFrame.html#KeyFrame-javafx.util.Duration-javafx.animation.KeyValue...-">KeyFrame</a></span>(<a href="../../javafx/util/Duration.html" title="class in javafx.util">Duration</a> time, <a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation">KeyValue</a>... values)</code> <div class="block">Constructor of <code>KeyFrame</code></div> </td> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyFrame.html#KeyFrame-javafx.util.Duration-java.lang.String-javafx.event.EventHandler-java.util.Collection-">KeyFrame</a></span>(<a href="../../javafx/util/Duration.html" title="class in javafx.util">Duration</a> time, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, <a href="../../javafx/event/EventHandler.html" title="interface in javafx.event">EventHandler</a><<a href="../../javafx/event/ActionEvent.html" title="class in javafx.event">ActionEvent</a>> onFinished, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation">KeyValue</a>> values)</code> <div class="block">Constructor of <code>KeyFrame</code></div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyFrame.html#KeyFrame-javafx.util.Duration-java.lang.String-javafx.event.EventHandler-javafx.animation.KeyValue...-">KeyFrame</a></span>(<a href="../../javafx/util/Duration.html" title="class in javafx.util">Duration</a> time, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, <a href="../../javafx/event/EventHandler.html" title="interface in javafx.event">EventHandler</a><<a href="../../javafx/event/ActionEvent.html" title="class in javafx.event">ActionEvent</a>> onFinished, <a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation">KeyValue</a>... values)</code> <div class="block">Constructor of <code>KeyFrame</code></div> </td> </tr> <tr class="altColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyFrame.html#KeyFrame-javafx.util.Duration-java.lang.String-javafx.animation.KeyValue...-">KeyFrame</a></span>(<a href="../../javafx/util/Duration.html" title="class in javafx.util">Duration</a> time, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, <a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation">KeyValue</a>... values)</code> <div class="block">Constructor of <code>KeyFrame</code></div> </td> </tr> </table> </li> </ul> <!-- ========== METHOD SUMMARY =========== --> <ul class="blockList"> <li class="blockList"><a name="method.summary"> <!-- --> </a> <h3>Method Summary</h3> <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> <tr> <th class="colFirst" scope="col">Modifier and Type</th> <th class="colLast" scope="col">Method and Description</th> </tr> <tr id="i0" class="altColor"> <td class="colFirst"><code>boolean</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyFrame.html#equals-java.lang.Object-">equals</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</code> <div class="block">Indicates whether some other object is "equal to" this one.</div> </td> </tr> <tr id="i1" class="rowColor"> <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyFrame.html#getName--">getName</a></span>()</code> <div class="block">Returns the <code>name</code> of this <code>KeyFrame</code>.</div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code><a href="../../javafx/event/EventHandler.html" title="interface in javafx.event">EventHandler</a><<a href="../../javafx/event/ActionEvent.html" title="class in javafx.event">ActionEvent</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyFrame.html#getOnFinished--">getOnFinished</a></span>()</code> <div class="block">Returns the <code>onFinished</code> event handler of this <code>KeyFrame</code>.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code><a href="../../javafx/util/Duration.html" title="class in javafx.util">Duration</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyFrame.html#getTime--">getTime</a></span>()</code> <div class="block">Returns the time offset of this <code>KeyFrame</code>.</div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation">KeyValue</a>></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyFrame.html#getValues--">getValues</a></span>()</code> <div class="block">Returns an immutable <code>Set</code> of <a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation"><code>KeyValue</code></a> instances.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyFrame.html#hashCode--">hashCode</a></span>()</code> <div class="block">Returns a hash code for this <code>KeyFrame</code> object.</div> </td> </tr> <tr id="i6" class="altColor"> <td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyFrame.html#toString--">toString</a></span>()</code> <div class="block">Returns a string representation of this <code>KeyFrame</code> object.</div> </td> </tr> </table> <ul class="blockList"> <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> <!-- --> </a> <h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> </ul> </li> </ul> </li> </ul> </div> <div class="details"> <ul class="blockList"> <li class="blockList"> <!-- ========= CONSTRUCTOR DETAIL ======== --> <ul class="blockList"> <li class="blockList"><a name="constructor.detail"> <!-- --> </a> <h3>Constructor Detail</h3> <a name="KeyFrame-javafx.util.Duration-java.lang.String-javafx.event.EventHandler-java.util.Collection-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>KeyFrame</h4> <pre>public KeyFrame(<a href="../../javafx/util/Duration.html" title="class in javafx.util">Duration</a> time, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, <a href="../../javafx/event/EventHandler.html" title="interface in javafx.event">EventHandler</a><<a href="../../javafx/event/ActionEvent.html" title="class in javafx.event">ActionEvent</a>> onFinished, <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a><<a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation">KeyValue</a>> values)</pre> <div class="block">Constructor of <code>KeyFrame</code> <p> If a passed in <code>KeyValue</code> is <code>null</code> or a duplicate, it will be ignored.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>time</code> - the <a href="../../javafx/animation/KeyFrame.html#time"><code>time</code></a></dd> <dd><code>name</code> - the <a href="../../javafx/animation/KeyFrame.html#name"><code>name</code></a></dd> <dd><code>onFinished</code> - the <a href="../../javafx/animation/KeyFrame.html#onFinished"><code>onFinished-handler</code></a></dd> <dd><code>values</code> - a <a href="../../javafx/collections/ObservableList.html" title="interface in javafx.collections"><code>ObservableList</code></a> of <a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation"><code>KeyValue</code></a> instances</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>time</code> is null</dd> <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>time</code> is invalid (see <a href="../../javafx/animation/KeyFrame.html#time"><code>time</code></a>)</dd> </dl> </li> </ul> <a name="KeyFrame-javafx.util.Duration-java.lang.String-javafx.event.EventHandler-javafx.animation.KeyValue...-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>KeyFrame</h4> <pre>public KeyFrame(<a href="../../javafx/util/Duration.html" title="class in javafx.util">Duration</a> time, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, <a href="../../javafx/event/EventHandler.html" title="interface in javafx.event">EventHandler</a><<a href="../../javafx/event/ActionEvent.html" title="class in javafx.event">ActionEvent</a>> onFinished, <a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation">KeyValue</a>... values)</pre> <div class="block">Constructor of <code>KeyFrame</code> <p> If a passed in <code>KeyValue</code> is <code>null</code> or a duplicate, it will be ignored.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>time</code> - the <a href="../../javafx/animation/KeyFrame.html#time"><code>time</code></a></dd> <dd><code>name</code> - the <a href="../../javafx/animation/KeyFrame.html#name"><code>name</code></a></dd> <dd><code>onFinished</code> - the <a href="../../javafx/animation/KeyFrame.html#onFinished"><code>onFinished-handler</code></a></dd> <dd><code>values</code> - the <a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation"><code>KeyValue</code></a> instances</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>time</code> is null</dd> <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>time</code> is invalid (see <a href="../../javafx/animation/KeyFrame.html#time"><code>time</code></a>)</dd> </dl> </li> </ul> <a name="KeyFrame-javafx.util.Duration-javafx.event.EventHandler-javafx.animation.KeyValue...-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>KeyFrame</h4> <pre>public KeyFrame(<a href="../../javafx/util/Duration.html" title="class in javafx.util">Duration</a> time, <a href="../../javafx/event/EventHandler.html" title="interface in javafx.event">EventHandler</a><<a href="../../javafx/event/ActionEvent.html" title="class in javafx.event">ActionEvent</a>> onFinished, <a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation">KeyValue</a>... values)</pre> <div class="block">Constructor of <code>KeyFrame</code></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>time</code> - the <a href="../../javafx/animation/KeyFrame.html#time"><code>time</code></a></dd> <dd><code>onFinished</code> - the <a href="../../javafx/animation/KeyFrame.html#onFinished"><code>onFinished-handler</code></a></dd> <dd><code>values</code> - the <a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation"><code>KeyValue</code></a> instances</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>time</code> is null</dd> <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>time</code> is invalid (see <a href="../../javafx/animation/KeyFrame.html#time"><code>time</code></a>)</dd> </dl> </li> </ul> <a name="KeyFrame-javafx.util.Duration-java.lang.String-javafx.animation.KeyValue...-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>KeyFrame</h4> <pre>public KeyFrame(<a href="../../javafx/util/Duration.html" title="class in javafx.util">Duration</a> time, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name, <a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation">KeyValue</a>... values)</pre> <div class="block">Constructor of <code>KeyFrame</code></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>time</code> - the <a href="../../javafx/animation/KeyFrame.html#time"><code>time</code></a></dd> <dd><code>name</code> - the <a href="../../javafx/animation/KeyFrame.html#name"><code>name</code></a></dd> <dd><code>values</code> - the <a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation"><code>KeyValue</code></a> instances</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>time</code> is null</dd> <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>time</code> is invalid (see <a href="../../javafx/animation/KeyFrame.html#time"><code>time</code></a>)</dd> </dl> </li> </ul> <a name="KeyFrame-javafx.util.Duration-javafx.animation.KeyValue...-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>KeyFrame</h4> <pre>public KeyFrame(<a href="../../javafx/util/Duration.html" title="class in javafx.util">Duration</a> time, <a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation">KeyValue</a>... values)</pre> <div class="block">Constructor of <code>KeyFrame</code></div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>time</code> - the <a href="../../javafx/animation/KeyFrame.html#time"><code>time</code></a></dd> <dd><code>values</code> - the <a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation"><code>KeyValue</code></a> instances</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>time</code> is null</dd> <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>time</code> is invalid (see <a href="../../javafx/animation/KeyFrame.html#time"><code>time</code></a>)</dd> </dl> </li> </ul> </li> </ul> <!-- ============ METHOD DETAIL ========== --> <ul class="blockList"> <li class="blockList"><a name="method.detail"> <!-- --> </a> <h3>Method Detail</h3> <a name="getTime--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getTime</h4> <pre>public <a href="../../javafx/util/Duration.html" title="class in javafx.util">Duration</a> getTime()</pre> <div class="block">Returns the time offset of this <code>KeyFrame</code>. The returned <a href="../../javafx/util/Duration.html" title="class in javafx.util"><code>Duration</code></a> defines the time offset within a single cycle of a <a href="../../javafx/animation/Timeline.html" title="class in javafx.animation"><code>Timeline</code></a> at which the <a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation"><code>KeyValues</code></a> will be set and at which the <a href="../../javafx/animation/KeyFrame.html#onFinished"><code>onFinished</code></a> function variable will be called. <p> The <code>time</code> of a <code>KeyFrame</code> has to be greater than or equal to <a href="../../javafx/util/Duration.html#ZERO"><code>Duration.ZERO</code></a> and it cannot be <a href="../../javafx/util/Duration.html#UNKNOWN"><code>Duration.UNKNOWN</code></a>. Note: While the unit of <code>time</code> is a millisecond, the granularity depends on the underlying operating system and will in general be larger. For example animations on desktop systems usually run with a maximum of 60fps which gives a granularity of ~17 ms.</div> </li> </ul> <a name="getValues--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getValues</h4> <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/util/Set.html?is-external=true" title="class or interface in java.util">Set</a><<a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation">KeyValue</a>> getValues()</pre> <div class="block">Returns an immutable <code>Set</code> of <a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation"><code>KeyValue</code></a> instances. A <code>KeyValue</code> defines a target and the desired value that should be interpolated at the specified time of this <code>KeyFrame</code>.</div> </li> </ul> <a name="getOnFinished--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getOnFinished</h4> <pre>public <a href="../../javafx/event/EventHandler.html" title="interface in javafx.event">EventHandler</a><<a href="../../javafx/event/ActionEvent.html" title="class in javafx.event">ActionEvent</a>> getOnFinished()</pre> <div class="block">Returns the <code>onFinished</code> event handler of this <code>KeyFrame</code>. The <code>onFinished</code> event handler is a function that is called when the elapsed time on a cycle passes the specified time of this <code>KeyFrame</code>. The <code>onFinished</code> function variable will be called if the elapsed time passes the indicated value, even if it never equaled the time value exactly.</div> </li> </ul> <a name="getName--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getName</h4> <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getName()</pre> <div class="block">Returns the <code>name</code> of this <code>KeyFrame</code>. If a named <code>KeyFrame</code> is added to a <a href="../../javafx/animation/Timeline.html" title="class in javafx.animation"><code>Timeline</code></a>, a cuepoint with the <code>name</code> and the <a href="../../javafx/animation/KeyFrame.html#time"><code>time</code></a> of the <code>KeyFrame</code> will be added automatically. If the <code>KeyFrame</code> is removed, the cuepoint will also be removed.</div> </li> </ul> <a name="toString--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>toString</h4> <pre>public <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> toString()</pre> <div class="block">Returns a string representation of this <code>KeyFrame</code> object.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a string representation of this <code>KeyFrame</code> object.</dd> </dl> </li> </ul> <a name="hashCode--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>hashCode</h4> <pre>public int hashCode()</pre> <div class="block">Returns a hash code for this <code>KeyFrame</code> object.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a hash code for this <code>KeyFrame</code> object.</dd> </dl> </li> </ul> <a name="equals-java.lang.Object-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>equals</h4> <pre>public boolean equals(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> obj)</pre> <div class="block">Indicates whether some other object is "equal to" this one. Two <code>KeyFrames</code> are considered equal, if their <a href="../../javafx/animation/KeyFrame.html#getTime--"><code>time</code></a>, <a href="../../javafx/animation/KeyFrame.html#onFinished"><code>onFinished</code></a>, and <a href="../../javafx/animation/KeyFrame.html#getValues--"><code>values</code></a> are equal.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code> in class <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> </dl> </li> </ul> </li> </ul> </li> </ul> </div> </div> <!-- ========= END OF CLASS DATA ========= --> <!-- ======= START OF BOTTOM NAVBAR ====== --> <div class="bottomNav"><a name="navbar.bottom"> <!-- --> </a> <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> <a name="navbar.bottom.firstrow"> <!-- --> </a> <ul class="navList" title="Navigation"> <li><a href="../../overview-summary.html">Overview</a></li> <li><a href="package-summary.html">Package</a></li> <li class="navBarCell1Rev">Class</li> <li><a href="class-use/KeyFrame.html">Use</a></li> <li><a href="package-tree.html">Tree</a></li> <li><a href="../../deprecated-list.html">Deprecated</a></li> <li><a href="../../index-all.html">Index</a></li> <li><a href="../../help-doc.html">Help</a></li> </ul> <div class="aboutLanguage">JavaFX 8</div> </div> <div class="subNav"> <ul class="navList"> <li><a href="../../javafx/animation/Interpolator.html" title="class in javafx.animation"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../javafx/animation/KeyValue.html" title="class in javafx.animation"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../index.html?javafx/animation/KeyFrame.html" target="_top">Frames</a></li> <li><a href="KeyFrame.html" target="_top">No Frames</a></li> </ul> <ul class="navList" id="allclasses_navbar_bottom"> <li><a href="../../allclasses-noframe.html">All Classes</a></li> </ul> <div> <script type="text/javascript"><!-- allClassesLink = document.getElementById("allclasses_navbar_bottom"); if(window==top) { allClassesLink.style.display = "block"; } else { allClassesLink.style.display = "none"; } //--> </script> </div> <div> <ul class="subNavList"> <li>Summary: </li> <li>Nested | </li> <li>Field | </li> <li><a href="#constructor.summary">Constr</a> | </li> <li><a href="#method.summary">Method</a></li> </ul> <ul class="subNavList"> <li>Detail: </li> <li>Field | </li> <li><a href="#constructor.detail">Constr</a> | </li> <li><a href="#method.detail">Method</a></li> </ul> </div> <a name="skip.navbar.bottom"> <!-- --> </a></div> <!-- ======== END OF BOTTOM NAVBAR ======= --> <p class="legalCopy"><small><small><a href="https://docs.oracle.com/javase/8/docs/legal/cpyr.html">Copyright</a> (c) 2008, 2016, Oracle and/or its affiliates. All rights reserved.</small></small></p> </body> </html>