scalafx.animation.KeyFrame.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scalafx_2.12.0-M5 Show documentation
The ScalaFX framework
The newest version!
/*
 * Copyright (c) 2011-2014, ScalaFX Project
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the ScalaFX Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE SCALAFX PROJECT OR ITS CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package scalafx.animation

import javafx.{animation => jfxa, event => jfxe}

import scala.collection.JavaConversions._
import scala.language.implicitConversions
import scalafx.delegate.SFXDelegate
import scalafx.util.Duration

/**
 * Companion Object for [[scalafx.animation.KeyFrame]].
 *
 * @define KF `KeyFrame`
 */
object KeyFrame {

  /**
   * Converts a ScalaFX $KF to a JavaFX [[http://docs.oracle.com/javase/8/javafx/api/javafx/animation/KeyFrame.html $KF]],
   * extracting its delegate.
   *
   * @param v ScalaFX $KF
   * @return JavaFX $KF extracted from `v`.
   */
  implicit def sfxKeyFrame2jfx(v: KeyFrame): jfxa.KeyFrame = if (v != null) v.delegate else null

  /**
   * Creates a new $KF instance
   *
   * @param time the time
   * @param name the Name. Default Value: `null`.
   * @param onFinished the onFinished-handler. Default Value: `null`.
   * @param values a `Set` of [[scalafx.animation.KeyValue]] instances. Default Value: empty Set.
   * @return A new $KF
   */
  def apply(time: Duration,
            name: String = null,
            onFinished: jfxe.EventHandler[jfxe.ActionEvent] = null,
            values: Set[_ <: KeyValue[_, _]] = Set.empty) = {
    val mappedValues: Set[jfxa.KeyValue] = values.map((x: KeyValue[_, _]) => x.delegate)
    new KeyFrame(new jfxa.KeyFrame(time, name, onFinished, mappedValues))
  }

}

/**
 * Wraps a [[http://docs.oracle.com/javase/8/javafx/api/javafx/animation/KeyFrame.html $KF]].
 *
 * @constructor Creates a new ScalaFX $KF from a JavaFX $KF.
 * @param delegate JavaFX $KF to be delegated.
 *
 * @define KF `KeyFrame`
 */
class KeyFrame(override val delegate: jfxa.KeyFrame)
  extends SFXDelegate[jfxa.KeyFrame] {

  /**
   * Returns the time offset of this $KF.
   */
  def time = new Duration(delegate.getTime)

  /**
   * Returns the name of this $KF.
   */
  def name = delegate.getName

  /**
   * Returns the onFinished event handler of this $KF.
   */
  def onFinished = delegate.getOnFinished

  /**
   * Returns an immutable Set of [[http://docs.oracle.com/javase/8/javafx/api/javafx/animation/KeyValue.html `KeyValue`]]
   * instances.
   */
  def values = delegate.getValues

}