< prev index next >

modules/javafx.graphics/src/main/java/javafx/animation/Timeline.java

Print this page
rev 10443 : 8177341: Fix typos in FX API docs
Reviewed-by:


  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javafx.animation;
  27 
  28 import javafx.collections.ListChangeListener.Change;
  29 import javafx.collections.ObservableList;
  30 import javafx.util.Duration;
  31 
  32 import com.sun.javafx.collections.TrackableObservableList;
  33 import com.sun.scenario.animation.AbstractMasterTimer;
  34 import com.sun.scenario.animation.shared.TimelineClipCore;
  35 
  36 /**
  37  * A {@code Timeline} can be used to define a free form animation of any
  38  * {@link javafx.beans.value.WritableValue}, e.g. all
  39  * {@link javafx.beans.property.Property JavaFX Properties}.
  40  * <p>
  41  * A {@code Timeline}, defined by one or more {@link KeyFrame}s, processes
  42  * individual {@code KeyFrame} sequentially, in the order specified by
  43  * {@code KeyFrame.time}. The animated properties, defined as key values in
  44  * {@code KeyFrame.values}, are interpolated
  45  * to/from the targeted key values at the specified time of the {@code KeyFrame}
  46  * to {@code Timeline}'s initial position, depends on {@code Timeline}'s
  47  * direction.
  48  * <p>
  49  * {@code Timeline} processes individual {@code KeyFrame} at or after specified
  50  * time interval elapsed, it does not guarantee the timing when {@code KeyFrame}
  51  * is processed.
  52  * <p>
  53  * The {@link #cycleDurationProperty()} will be set to the largest time value
  54  * of Timeline's keyFrames.
  55  * <p>
  56  * If a {@code KeyFrame} is not provided for the {@code time==0s} instant, one
  57  * will be synthesized using the target values that are current at the time
  58  * {@link #play()} or {@link #playFromStart()} is called.




  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javafx.animation;
  27 
  28 import javafx.collections.ListChangeListener.Change;
  29 import javafx.collections.ObservableList;
  30 import javafx.util.Duration;
  31 
  32 import com.sun.javafx.collections.TrackableObservableList;
  33 import com.sun.scenario.animation.AbstractMasterTimer;
  34 import com.sun.scenario.animation.shared.TimelineClipCore;
  35 
  36 /**
  37  * A {@code Timeline} can be used to define a free form animation of any
  38  * {@link javafx.beans.value.WritableValue}, for example, all
  39  * {@link javafx.beans.property.Property JavaFX Properties}.
  40  * <p>
  41  * A {@code Timeline}, defined by one or more {@link KeyFrame}s, processes
  42  * individual {@code KeyFrame} sequentially, in the order specified by
  43  * {@code KeyFrame.time}. The animated properties, defined as key values in
  44  * {@code KeyFrame.values}, are interpolated
  45  * to/from the targeted key values at the specified time of the {@code KeyFrame}
  46  * to {@code Timeline}'s initial position, depends on {@code Timeline}'s
  47  * direction.
  48  * <p>
  49  * {@code Timeline} processes individual {@code KeyFrame} at or after specified
  50  * time interval elapsed, it does not guarantee the timing when {@code KeyFrame}
  51  * is processed.
  52  * <p>
  53  * The {@link #cycleDurationProperty()} will be set to the largest time value
  54  * of Timeline's keyFrames.
  55  * <p>
  56  * If a {@code KeyFrame} is not provided for the {@code time==0s} instant, one
  57  * will be synthesized using the target values that are current at the time
  58  * {@link #play()} or {@link #playFromStart()} is called.


< prev index next >