scalafx.scene.input.MouseEvent.scala Maven / Gradle / Ivy
The newest version!
/*
* Copyright (c) 2011-2019, 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.input
import javafx.scene.{input => jfxsi}
import scalafx.Includes._
import scalafx.delegate.SFXDelegate
import scalafx.event.{EventTarget, EventType}
import scala.language.implicitConversions
object MouseEvent {
implicit def sfxMouseEvent2jfx(me: MouseEvent): jfxsi.MouseEvent = if (me != null) me.delegate else null
val Any: EventType[jfxsi.MouseEvent] = jfxsi.MouseEvent.ANY
val DragDetected: EventType[jfxsi.MouseEvent] = jfxsi.MouseEvent.DRAG_DETECTED
val MouseClicked: EventType[jfxsi.MouseEvent] = jfxsi.MouseEvent.MOUSE_CLICKED
val MouseDragged: EventType[jfxsi.MouseEvent] = jfxsi.MouseEvent.MOUSE_DRAGGED
val MouseEntered: EventType[jfxsi.MouseEvent] = jfxsi.MouseEvent.MOUSE_ENTERED
val MouseEnteredTarget: EventType[jfxsi.MouseEvent] = jfxsi.MouseEvent.MOUSE_ENTERED_TARGET
val MouseExited: EventType[jfxsi.MouseEvent] = jfxsi.MouseEvent.MOUSE_EXITED
val MouseExitedTarget: EventType[jfxsi.MouseEvent] = jfxsi.MouseEvent.MOUSE_EXITED_TARGET
val MouseMoved: EventType[jfxsi.MouseEvent] = jfxsi.MouseEvent.MOUSE_MOVED
val MousePressed: EventType[jfxsi.MouseEvent] = jfxsi.MouseEvent.MOUSE_PRESSED
val MouseReleased: EventType[jfxsi.MouseEvent] = jfxsi.MouseEvent.MOUSE_RELEASED
}
class MouseEvent(override val delegate: jfxsi.MouseEvent) extends InputEvent(delegate) with SFXDelegate[jfxsi.MouseEvent] {
/**
* Constructs new MouseEvent event with null source and target.
*
* @param eventType The type of the event.
* @param x The x with respect to the scene.
* @param y The y with respect to the scene.
* @param screenX The x coordinate relative to screen.
* @param screenY The y coordinate relative to screen.
* @param button the mouse button used
* @param clickCount number of click counts
* @param shiftDown true if shift modifier was pressed.
* @param controlDown true if control modifier was pressed.
* @param altDown true if alt modifier was pressed.
* @param metaDown true if meta modifier was pressed.
* @param primaryButtonDown true if primary button was pressed.
* @param middleButtonDown true if middle button was pressed.
* @param secondaryButtonDown true if secondary button was pressed.
* @param synthesized if this event was synthesized
* @param popupTrigger whether this event denotes a popup trigger for current platform
* @param stillSincePress see { @link #isStillSincePress() }
* @param pickResult pick result. Can be null, in this case a 2D pick result
* without any further values is constructed
* based on the scene coordinates
* @since JavaFX 8.0
*/
def this(eventType: EventType[_ <: jfxsi.MouseEvent], x: Double, y: Double, screenX: Double, screenY: Double,
button: MouseButton, clickCount: Int, shiftDown: Boolean, controlDown: Boolean, altDown: Boolean,
metaDown: Boolean, primaryButtonDown: Boolean, middleButtonDown: Boolean,
secondaryButtonDown: Boolean, synthesized: Boolean, popupTrigger: Boolean,
stillSincePress: Boolean, pickResult: PickResult) = {
this(new jfxsi.MouseEvent(eventType.delegate, x, y, screenX, screenY, button.delegate, clickCount,
shiftDown, controlDown, altDown, metaDown, primaryButtonDown, middleButtonDown, secondaryButtonDown,
synthesized, popupTrigger, stillSincePress, pickResult.delegate))
}
/**
* Constructs new MouseEvent event.
*
* @param source the source of the event. Can be null.
* @param target the target of the event. Can be null.
* @param eventType The type of the event.
* @param x The x with respect to the source. Should be in scene coordinates if source == null or source is not a Node.
* @param y The y with respect to the source. Should be in scene coordinates if source == null or source is not a Node.
* @param screenX The x coordinate relative to screen.
* @param screenY The y coordinate relative to screen.
* @param button the mouse button used
* @param clickCount number of click counts
* @param shiftDown true if shift modifier was pressed.
* @param controlDown true if control modifier was pressed.
* @param altDown true if alt modifier was pressed.
* @param metaDown true if meta modifier was pressed.
* @param primaryButtonDown true if primary button was pressed.
* @param middleButtonDown true if middle button was pressed.
* @param secondaryButtonDown true if secondary button was pressed.
* @param synthesized if this event was synthesized
* @param popupTrigger whether this event denotes a popup trigger for current platform
* @param stillSincePress see { @link #isStillSincePress() }
* @param pickResult pick result. Can be null, in this case a 2D pick result
* without any further values is constructed
* based on the scene coordinates and target
* @since JavaFX 8.0
*/
def this(source: Any, target: EventTarget, eventType: EventType[_ <: jfxsi.MouseEvent],
x: Double, y: Double, screenX: Double, screenY: Double, button: MouseButton, clickCount: Int,
shiftDown: Boolean, controlDown: Boolean, altDown: Boolean, metaDown: Boolean,
primaryButtonDown: Boolean, middleButtonDown: Boolean, secondaryButtonDown: Boolean,
synthesized: Boolean, popupTrigger: Boolean, stillSincePress: Boolean, pickResult: PickResult) = {
this(new jfxsi.MouseEvent(source, target.delegate, eventType.delegate, x, y, screenX, screenY, button.delegate, clickCount,
shiftDown, controlDown, altDown, metaDown, primaryButtonDown, middleButtonDown, secondaryButtonDown,
synthesized, popupTrigger, stillSincePress, pickResult.delegate))
}
/**
* Which, if any, of the mouse buttons is responsible for this event.
*/
def button: MouseButton = delegate.getButton
/**
* Returns number of mouse clicks associated with this event.
*/
def clickCount: Int = delegate.getClickCount
/** Gets the event type of this event. */
override def eventType: EventType[_ <: jfxsi.MouseEvent] = delegate.getEventType()
/** Returns information about the pick. */
def pickResult: PickResult = delegate.getPickResult
def sceneX: Double = delegate.getSceneX
def sceneY: Double = delegate.getSceneY
def screenX: Double = delegate.getScreenX
def screenY: Double = delegate.getScreenY
def x: Double = delegate.getX
def y: Double = delegate.getY
/** Depth position of the event relative to the origin of the MouseEvent's source. */
def z: Double = delegate.getZ
/**
* Whether or not the Alt modifier is down on this event.
*/
def altDown: Boolean = delegate.isAltDown
/**
* Whether or not the Control modifier is down on this event.
*/
def controlDown: Boolean = delegate.isControlDown
/**
* Determines whether this event will be followed by DRAG_DETECTED event.
*/
def dragDetect: Boolean = delegate.isDragDetect
/**
* Augments drag detection behavior.
*/
def dragDetect_=(detected: Boolean): Unit = {
delegate.setDragDetect(detected)
}
/**
* Whether or not the Meta modifier is down on this event.
*/
def metaDown: Boolean = delegate.isMetaDown
/**
* Returns true if middle button (button 2) is currently pressed.
*/
def middleButtonDown: Boolean = delegate.isMiddleButtonDown
/** Returns true if this mouse event is the popup menu trigger event for the platform. */
def popupTrigger: Boolean = delegate.isPopupTrigger
/**
* Returns true if primary button (button 1, usually the left) is currently pressed.
*/
def primaryButtonDown: Boolean = delegate.isPrimaryButtonDown
/**
* Returns true if secondary button (button 1, usually the right) is currently pressed.
*/
def secondaryButtonDown: Boolean = delegate.isSecondaryButtonDown
/**
* Whether or not the Shift modifier is down on this event.
*/
def shiftDown: Boolean = delegate.isShiftDown
/**
* Returns whether or not the host platform common shortcut modifier is down on this event.
*/
def shortcutDown: Boolean = delegate.isShortcutDown
/**
* Indicates whether the mouse cursor stayed in the system-provided hysteresis area since last pressed event that occurred before this event.
*/
def stillSincePress: Boolean = delegate.isStillSincePress
/** Indicates whether this event is synthesized from using a touch screen instead of usual mouse event source devices like mouse or track pad. */
def synthesized: Boolean = delegate.isSynthesized
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy