scalafx.event.WeakEventHandler.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-2015, 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.event

import javafx.{event => jfxe}

import scala.language.implicitConversions
import scalafx.delegate.SFXDelegate

/**
 * Object Companion for [[scalafx.event.WeakEventHandler]]
 */
object WeakEventHandler {

  /**
   * Converts a ScalaFX WeakEventHandler to a JavaFX WeakEventHandler.
   *
   * @param weh ScalaFX WeakEventHandler
   * @tparam T JavaFX Event subclass
   * @return JavaFX WeakEventHandler
   */
  implicit def sfxWeakEventHandler2jfx[T <: jfxe.Event](weh: WeakEventHandler[T]): jfxe.WeakEventHandler[T] =
    if (weh != null) weh.delegate else null

}

/**
 * Wraps JavaFX [[http://docs.oracle.com/javase/8/javafx/api/javafx/event/WeakEventHandler.html WeakEventHandler]].
 *
 * @constructor Creates a new ScalaFX WeakEventHandler from a JavaFX WeakEventHandler.
 * @param delegate JavaFX WeakEventHandler to be wrapped
 * @tparam T JavaFX Event subclass
 * @since 8.0
 */
class WeakEventHandler[T <: jfxe.Event](override val delegate: jfxe.WeakEventHandler[T])
  extends SFXDelegate[jfxe.WeakEventHandler[T]] {


  /**
   * Creates a new instance of WeakEventHandler.
   *
   * @param eventHandler The original event handler to which to forward event notifications
   */
  def this(eventHandler: (T) => Unit) = this(new jfxe.WeakEventHandler[T](new jfxe.EventHandler[T] {
    def handle(event: T) = eventHandler(event)
  }))

  /**
   * Indicates whether the associated event handler has been garbage collected.
   */
  def wasGarbageCollected: Boolean = delegate.wasGarbageCollected

  /**
   * Forwards event notification to the associated event handler.
   *
   * @param event The event to be handled
   */
  def handle(event: T): Unit = delegate.handle(event)

}