class Timeline extends Animation with SFXDelegate[javafx.animation.Timeline]
- Alphabetic
- By Inheritance
- Timeline
- Animation
- SFXDelegate
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new Timeline(targetFramerate: Double, keyFrames: Seq[_ <: KeyFrame])
The constructor of
Timeline
The constructor of
Timeline
- targetFramerate
The custom target frame rate for this
Timeline
- keyFrames
The scalafx.animation.KeyFrames of this
Timeline
.
- new Timeline(targetFramerate: Double)
The constructor of
Timeline
The constructor of
Timeline
- targetFramerate
The custom target frame rate for this
Timeline
- new Timeline(delegate: javafx.animation.Timeline = new jfxa.Timeline())
Creates a new ScalaFX
Timeline
from a JavaFXTimeline
.Creates a new ScalaFX
Timeline
from a JavaFXTimeline
.- delegate
JavaFX
Timeline
to be delegated.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def autoReverse: BooleanProperty
Defines whether this
Animation
reverses direction on alternating cycles.Defines whether this
Animation
reverses direction on alternating cycles. Default value: false.- Definition Classes
- Animation
- def autoReverse_=(ar: Boolean): Unit
- Definition Classes
- Animation
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def currentRate: ReadOnlyDoubleProperty
Read-only variable to indicate current direction/speed at which the
Animation
is being played.Read-only variable to indicate current direction/speed at which the
Animation
is being played. Default value: 0.0.- Definition Classes
- Animation
- def currentTime: ReadOnlyObjectProperty[Duration]
Defines the
Animation
's play head position.Defines the
Animation
's play head position. Default value: 0ms.- Definition Classes
- Animation
- def cycleCount: IntegerProperty
Defines the number of cycles in this
Animation
.Defines the number of cycles in this
Animation
. Default value: 0ms- Definition Classes
- Animation
- def cycleCount_=(r: Int): Unit
- Definition Classes
- Animation
- def cycleDuration: ReadOnlyObjectProperty[Duration]
Read-only variable to indicate the duration of one cycle of this
Animation
: the time it takes to play from time 0 to the KeyFrame with the largest time.Read-only variable to indicate the duration of one cycle of this
Animation
: the time it takes to play from time 0 to the KeyFrame with the largest time. Default value: 1.0- Definition Classes
- Animation
- def delay: ObjectProperty[Duration]
Delays the start of an
Animation
.Delays the start of an
Animation
. Default value: 0ms.- Definition Classes
- Animation
- def delay_=(d: Duration): Unit
- Definition Classes
- Animation
- val delegate: javafx.animation.Timeline
JavaFX object to be wrapped.
JavaFX object to be wrapped.
- Definition Classes
- Timeline → Animation → SFXDelegate
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(ref: Any): Boolean
Verifies if a object is equals to this delegate.
Verifies if a object is equals to this delegate.
- ref
Object to be compared.
- returns
if the other object is equals to this delegate or not.
- Definition Classes
- SFXDelegate → AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- returns
The delegate hashcode
- Definition Classes
- SFXDelegate → AnyRef → Any
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def jumpTo(cuePoint: String): Unit
Jumps to a predefined position in this
Animation
.Jumps to a predefined position in this
Animation
.- cuePoint
the name of the cue point
- Definition Classes
- Animation
- def jumpTo(time: Duration): Unit
Jumps to a given position in this
Animation
. - def keyFrames: ObservableBuffer[javafx.animation.KeyFrame]
The scalafx.animation.KeyFrames of this
Timeline
. - def keyFrames_=(kfs: Seq[_ <: KeyFrame]): Unit
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def onFinished: ObjectProperty[EventHandler[ActionEvent]]
The action to be executed at the conclusion of this
Animation
.The action to be executed at the conclusion of this
Animation
.- Definition Classes
- Animation
- def onFinished_=(handler: EventHandler[ActionEvent]): Unit
- Definition Classes
- Animation
- def pause(): Unit
Pauses the
Animation
.Pauses the
Animation
.- Definition Classes
- Animation
- def play(): Unit
Plays
Animation
from current position in the direction indicated byrate
.Plays
Animation
from current position in the direction indicated byrate
.- Definition Classes
- Animation
- def playFrom(cuePoint: String): Unit
A convenience method to play this
Animation
from a predefined position.A convenience method to play this
Animation
from a predefined position.- cuePoint
name of the cue point
- Definition Classes
- Animation
- def playFrom(time: Duration): Unit
A convenience method to play this
Animation
from a specific position.A convenience method to play this
Animation
from a specific position.- time
position where to play from
- Definition Classes
- Animation
- def playFromStart(): Unit
Plays an
Animation
from initial position in forward direction.Plays an
Animation
from initial position in forward direction.- Definition Classes
- Animation
- def rate: DoubleProperty
Defines the direction/speed at which the
Animation
is expected to be played.Defines the direction/speed at which the
Animation
is expected to be played. Default value: 1.0- Definition Classes
- Animation
- def rate_=(r: Double): Unit
- Definition Classes
- Animation
- def status: ReadOnlyObjectProperty[Status]
The
status
of theAnimation
.The
status
of theAnimation
.- Definition Classes
- Animation
- def stop(): Unit
Stops the
Animation
and resets the play head to its initial position.Stops the
Animation
and resets the play head to its initial position.- Definition Classes
- Animation
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def targetFramerate: Double
The target framerate is the maximum framerate at which this
Animation
will run, in frames per second.The target framerate is the maximum framerate at which this
Animation
will run, in frames per second.- Definition Classes
- Animation
- def toString(): String
- returns
Returns the original delegate's
toString()
adding a[SFX]
prefix.
- Definition Classes
- SFXDelegate → AnyRef → Any
- def totalDuration: ReadOnlyObjectProperty[Duration]
Read-only variable to indicate the total duration of this
Animation
, including repeats.Read-only variable to indicate the total duration of this
Animation
, including repeats. Default value: 0ms- Definition Classes
- Animation
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
ScalaFX is a UI DSL written within the Scala Language that sits on top of JavaFX 2.x and and JavaFX 8. This means that every ScalaFX application is also a valid Scala application. By extension it supports full interoperability with Java and can run anywhere the Java Virtual Machine (JVM) and JavaFX 2.0 or JavaFX 8 are supported.
Package Structure
ScalaFX package structure corresponds to JavaFX package structure, for instance
scalafx.animation
corresponds tojavafx.animation
.Example Usage
A basic ScalaFX application is created creating an object that is an instance of
JFXApp3
. Following Java FX theatre metaphor, it contains astage
that contains ascene
. Astage
roughly corresponds to a window in a typical UI environment. Thescene
holds UI content presented to the user. In the example below, the content is a pane with a singlelabel
component.