scalafx.scene.SnapshotResult.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.scene

import javafx.{scene => jfxs}

import scala.language.implicitConversions
import scalafx.Includes._
import scalafx.delegate.SFXDelegate
import scalafx.scene.image.WritableImage

object SnapshotResult {
  implicit def sfxSnapshotResult2jfx(sr: SnapshotResult): jfxs.SnapshotResult = if (sr != null) sr.delegate else null
}

/**
 * Wraps JavaFX's `[[http://docs.oracle.com/javase/8/javafx/api/javafx/scene/SnapshotResult.html SnapshotResult]]`. 
 * How the original Java class does not have public constructors, it is not possible instantiate in Scala.
 *
 * @since 2.2
 */
class SnapshotResult(override val delegate: jfxs.SnapshotResult)
  extends SFXDelegate[jfxs.SnapshotResult] {

  /**
   * Gets the image generated by the snapshot operation.
   */
  def image: WritableImage = delegate.getImage

  /**
   * Gets a copy of the SnapshotParameters used to generate the snapshot.
   */
  def snapshotParameters: SnapshotParameters = delegate.getSnapshotParameters

  /**
   * Gets the source Node or Scene on which the snapshot was called.
   */
  def source: AnyRef = delegate.getSource

}