<!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_191) on Wed Oct 31 14:01:54 UTC 2018 --> <title>KeyValue (JavaFX 8)</title> <meta name="date" content="2018-10-31"> <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="KeyValue (JavaFX 8)"; } } catch(err) { } //--> var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":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/KeyValue.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/KeyFrame.html" title="class in javafx.animation"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../javafx/animation/KeyValue.Type.html" title="enum in javafx.animation"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../index.html?javafx/animation/KeyValue.html" target="_top">Frames</a></li> <li><a href="KeyValue.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 KeyValue" class="title">Class KeyValue</h2> </div> <div class="contentContainer"> <ul class="inheritance"> <li>java.lang.Object</li> <li> <ul class="inheritance"> <li>javafx.animation.KeyValue</li> </ul> </li> </ul> <div class="description"> <ul class="blockList"> <li class="blockList"> <hr> <br> <pre>public final class <span class="typeNameLabel">KeyValue</span> extends java.lang.Object</pre> <div class="block">Defines a key value to be interpolated for a particular interval along the animation. A <a href="../../javafx/animation/KeyFrame.html" title="class in javafx.animation"><code>KeyFrame</code></a>, which defines a specific point on a timeline, can hold multiple <code>KeyValues</code>. <code>KeyValue</code> is an immutable class. <p> A <code>KeyValue</code> is defined by a target, which is an implementation of <a href="../../javafx/beans/value/WritableValue.html" title="interface in javafx.beans.value"><code>WritableValue</code></a>, an end value and an <a href="../../javafx/animation/Interpolator.html" title="class in javafx.animation"><code>Interpolator</code></a>. <p> Most interpolators define the interpolation between two <code>KeyFrames</code>. (The only exception are tangent-interpolators.) The <code>KeyValue</code> of the second <code>KeyFrame</code> (in forward direction) specifies the interpolator to be used in the interval. <p> Tangent-interpolators define the interpolation to the left and to the right of a <code>KeyFrame</code> (see <a href="../../javafx/animation/Interpolator.html#TANGENT-javafx.util.Duration-double-javafx.util.Duration-double-"><code>Interpolator.TANGENT</code></a>). <p> By default, <a href="../../javafx/animation/Interpolator.html#LINEAR"><code>Interpolator.LINEAR</code></a> is used in the interval.</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/KeyFrame.html" title="class in javafx.animation"><code>KeyFrame</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/KeyValue.html#KeyValue-javafx.beans.value.WritableValue-T-">KeyValue</a></span>(<a href="../../javafx/beans/value/WritableValue.html" title="interface in javafx.beans.value">WritableValue</a><T> target, T endValue)</code> <div class="block">Creates a <code>KeyValue</code> that uses <a href="../../javafx/animation/Interpolator.html#LINEAR"><code>Interpolator.LINEAR</code></a>.</div> </td> </tr> <tr class="rowColor"> <td class="colOne"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyValue.html#KeyValue-javafx.beans.value.WritableValue-T-javafx.animation.Interpolator-">KeyValue</a></span>(<a href="../../javafx/beans/value/WritableValue.html" title="interface in javafx.beans.value">WritableValue</a><T> target, T endValue, <a href="../../javafx/animation/Interpolator.html" title="class in javafx.animation">Interpolator</a> interpolator)</code> <div class="block">Creates a <code>KeyValue</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/KeyValue.html#equals-java.lang.Object-">equals</a></span>(java.lang.Object 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>java.lang.Object</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyValue.html#getEndValue--">getEndValue</a></span>()</code> <div class="block">Returns the end value of this <code>KeyValue</code></div> </td> </tr> <tr id="i2" class="altColor"> <td class="colFirst"><code><a href="../../javafx/animation/Interpolator.html" title="class in javafx.animation">Interpolator</a></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyValue.html#getInterpolator--">getInterpolator</a></span>()</code> <div class="block"><a href="../../javafx/animation/Interpolator.html" title="class in javafx.animation"><code>Interpolator</code></a> to be used for calculating the key value along the particular interval.</div> </td> </tr> <tr id="i3" class="rowColor"> <td class="colFirst"><code><a href="../../javafx/beans/value/WritableValue.html" title="interface in javafx.beans.value">WritableValue</a><?></code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyValue.html#getTarget--">getTarget</a></span>()</code> <div class="block">Returns the target of this <code>KeyValue</code></div> </td> </tr> <tr id="i4" class="altColor"> <td class="colFirst"><code>int</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyValue.html#hashCode--">hashCode</a></span>()</code> <div class="block">Returns a hash code for this <code>KeyValue</code> object.</div> </td> </tr> <tr id="i5" class="rowColor"> <td class="colFirst"><code>java.lang.String</code></td> <td class="colLast"><code><span class="memberNameLink"><a href="../../javafx/animation/KeyValue.html#toString--">toString</a></span>()</code> <div class="block">Returns a string representation of this <code>KeyValue</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.Object</h3> <code>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</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="KeyValue-javafx.beans.value.WritableValue-java.lang.Object-javafx.animation.Interpolator-"> <!-- --> </a><a name="KeyValue-javafx.beans.value.WritableValue-T-javafx.animation.Interpolator-"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>KeyValue</h4> <pre>public KeyValue(<a href="../../javafx/beans/value/WritableValue.html" title="interface in javafx.beans.value">WritableValue</a><T> target, T endValue, <a href="../../javafx/animation/Interpolator.html" title="class in javafx.animation">Interpolator</a> interpolator)</pre> <div class="block">Creates a <code>KeyValue</code>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>target</code> - the target</dd> <dd><code>endValue</code> - the end value</dd> <dd><code>interpolator</code> - the <a href="../../javafx/animation/Interpolator.html" title="class in javafx.animation"><code>Interpolator</code></a></dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if <code>target</code> or <code>interpolator</code> are <code>null</code></dd> </dl> </li> </ul> <a name="KeyValue-javafx.beans.value.WritableValue-java.lang.Object-"> <!-- --> </a><a name="KeyValue-javafx.beans.value.WritableValue-T-"> <!-- --> </a> <ul class="blockListLast"> <li class="blockList"> <h4>KeyValue</h4> <pre>public KeyValue(<a href="../../javafx/beans/value/WritableValue.html" title="interface in javafx.beans.value">WritableValue</a><T> target, T endValue)</pre> <div class="block">Creates a <code>KeyValue</code> that uses <a href="../../javafx/animation/Interpolator.html#LINEAR"><code>Interpolator.LINEAR</code></a>.</div> <dl> <dt><span class="paramLabel">Parameters:</span></dt> <dd><code>target</code> - the target</dd> <dd><code>endValue</code> - the end value</dd> <dt><span class="throwsLabel">Throws:</span></dt> <dd><code>java.lang.NullPointerException</code> - if <code>target</code> or <code>interpolator</code> are <code>null</code></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="getTarget--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getTarget</h4> <pre>public <a href="../../javafx/beans/value/WritableValue.html" title="interface in javafx.beans.value">WritableValue</a><?> getTarget()</pre> <div class="block">Returns the target of this <code>KeyValue</code></div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the target</dd> </dl> </li> </ul> <a name="getEndValue--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getEndValue</h4> <pre>public java.lang.Object getEndValue()</pre> <div class="block">Returns the end value of this <code>KeyValue</code></div> <dl> <dt><span class="returnLabel">Returns:</span></dt> <dd>the end value</dd> </dl> </li> </ul> <a name="getInterpolator--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>getInterpolator</h4> <pre>public <a href="../../javafx/animation/Interpolator.html" title="class in javafx.animation">Interpolator</a> getInterpolator()</pre> <div class="block"><a href="../../javafx/animation/Interpolator.html" title="class in javafx.animation"><code>Interpolator</code></a> to be used for calculating the key value along the particular interval. By default, <a href="../../javafx/animation/Interpolator.html#LINEAR"><code>Interpolator.LINEAR</code></a> is used.</div> </li> </ul> <a name="toString--"> <!-- --> </a> <ul class="blockList"> <li class="blockList"> <h4>toString</h4> <pre>public java.lang.String toString()</pre> <div class="block">Returns a string representation of this <code>KeyValue</code> object.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>toString</code> in class <code>java.lang.Object</code></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a string representation of this <code>KeyValue</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>KeyValue</code> object.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>hashCode</code> in class <code>java.lang.Object</code></dd> <dt><span class="returnLabel">Returns:</span></dt> <dd>a hash code for this <code>KeyValue</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(java.lang.Object obj)</pre> <div class="block">Indicates whether some other object is "equal to" this one. Two <code>KeyValues</code> are considered equal, if their <a href="../../javafx/animation/KeyValue.html#getTarget--"><code>target</code></a>, <a href="../../javafx/animation/KeyValue.html#getEndValue--"><code>endValue</code></a>, and <a href="../../javafx/animation/KeyValue.html#getInterpolator--"><code>interpolator</code></a> are equal.</div> <dl> <dt><span class="overrideSpecifyLabel">Overrides:</span></dt> <dd><code>equals</code> in class <code>java.lang.Object</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/KeyValue.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/KeyFrame.html" title="class in javafx.animation"><span class="typeNameLink">Prev Class</span></a></li> <li><a href="../../javafx/animation/KeyValue.Type.html" title="enum in javafx.animation"><span class="typeNameLink">Next Class</span></a></li> </ul> <ul class="navList"> <li><a href="../../index.html?javafx/animation/KeyValue.html" target="_top">Frames</a></li> <li><a href="KeyValue.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><font size="-1"><a href="http://bugreport.java.com/bugreport/" target="_blank">Submit a bug or feature</a><br>For further API reference and developer documentation, see <a href="https://docs.oracle.com/javase/8/docs/index.html" target="_blank">Java SE Documentation</a>. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.<br> <a href="https://docs.oracle.com/javase/8/docs/legal/cpyr.html" target="_blank">Copyright</a> © 2008, 2018, Oracle and/or its affiliates. All rights reserved. Use is subject to <a href="http://download.oracle.com/otndocs/jcp/java_se-8-mrel-spec/license.html" target="_blank">license terms</a>. Also see the <a target="_blank" href="http://www.oracle.com/technetwork/java/redist-137594.html" target="_blank">documentation redistribution policy</a>.</font></small></p> </body> </html>