scalafx.scene.input

MouseEvent

class MouseEvent extends InputEvent with SFXDelegate[javafx.scene.input.MouseEvent]

Source
MouseEvent.scala
Linear Supertypes
InputEvent, Event, SFXDelegate[javafx.scene.input.MouseEvent], AnyRef, Any
Known Subclasses
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. MouseEvent
  2. InputEvent
  3. Event
  4. SFXDelegate
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MouseEvent(source: Any, target: EventTarget, eventType: EventType[_ <: javafx.scene.input.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)

    Constructs new MouseEvent event.

    Constructs new MouseEvent event.

    source

    the source of the event. Can be null.

    target

    the target of the event. Can be null.

    eventType

    The type of the event.

    x

    The x with respect to the source. Should be in scene coordinates if source == null or source is not a Node.

    y

    The y with respect to the source. Should be in scene coordinates if source == null or source is not a Node.

    screenX

    The x coordinate relative to screen.

    screenY

    The y coordinate relative to screen.

    button

    the mouse button used

    clickCount

    number of click counts

    shiftDown

    true if shift modifier was pressed.

    controlDown

    true if control modifier was pressed.

    altDown

    true if alt modifier was pressed.

    metaDown

    true if meta modifier was pressed.

    primaryButtonDown

    true if primary button was pressed.

    middleButtonDown

    true if middle button was pressed.

    secondaryButtonDown

    true if secondary button was pressed.

    synthesized

    if this event was synthesized

    popupTrigger

    whether this event denotes a popup trigger for current platform

    stillSincePress

    see { @link #isStillSincePress() }

    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

  2. new MouseEvent(eventType: EventType[_ <: javafx.scene.input.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)

    Constructs new MouseEvent event with null source and target.

    Constructs new MouseEvent event with null source and target.

    eventType

    The type of the event.

    x

    The x with respect to the scene.

    y

    The y with respect to the scene.

    screenX

    The x coordinate relative to screen.

    screenY

    The y coordinate relative to screen.

    button

    the mouse button used

    clickCount

    number of click counts

    shiftDown

    true if shift modifier was pressed.

    controlDown

    true if control modifier was pressed.

    altDown

    true if alt modifier was pressed.

    metaDown

    true if meta modifier was pressed.

    primaryButtonDown

    true if primary button was pressed.

    middleButtonDown

    true if middle button was pressed.

    secondaryButtonDown

    true if secondary button was pressed.

    synthesized

    if this event was synthesized

    popupTrigger

    whether this event denotes a popup trigger for current platform

    stillSincePress

    see { @link #isStillSincePress() }

    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

  3. new MouseEvent(delegate: javafx.scene.input.MouseEvent)

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def altDown: Boolean

    Whether or not the Alt modifier is down on this event.

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  8. def button: MouseButton

    Which, if any, of the mouse buttons is responsible for this event.

  9. def clickCount: Int

    Returns number of mouse clicks associated with this event.

  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  11. def consume(): Unit

    Marks this Event as consumed.

    Marks this Event as consumed. This stops its further propagation.

    Definition Classes
    Event
  12. def consumed: Boolean

    Indicates whether this Event has been consumed by any filter or handler.

    Indicates whether this Event has been consumed by any filter or handler.

    Definition Classes
    Event
  13. def controlDown: Boolean

    Whether or not the Control modifier is down on this event.

  14. def copyFor(newSource: AnyRef, newTarget: EventTarget): Event

    Creates and returns a copy of this event with the specified event source and target.

    Creates and returns a copy of this event with the specified event source and target.

    Definition Classes
    Event
  15. val delegate: javafx.scene.input.MouseEvent

    JavaFX object to be wrapped.

    JavaFX object to be wrapped.

    Definition Classes
    MouseEventInputEventEventSFXDelegate
  16. def dragDetect: Boolean

    Determines whether this event will be followed by DRAG_DETECTED event.

  17. def dragDetect_=(detected: Boolean): Unit

    Augments drag detection behavior.

  18. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  19. 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
  20. def eventType: EventType[_ <: javafx.scene.input.MouseEvent]

    Gets the event type of this event.

    Gets the event type of this event.

    Definition Classes
    MouseEventEvent
  21. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  22. def hashCode(): Int

    returns

    The delegate hashcode

    Definition Classes
    SFXDelegate → AnyRef → Any
  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  24. def metaDown: Boolean

    Whether or not the Meta modifier is down on this event.

  25. def middleButtonDown: Boolean

    Returns true if middle button (button 2) is currently pressed.

  26. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  29. def pickResult: PickResult

    Returns information about the pick.

  30. def popupTrigger: Boolean

    Returns true if this mouse event is the popup menu trigger event for the platform.

  31. def primaryButtonDown: Boolean

    Returns true if primary button (button 1, usually the left) is currently pressed.

  32. def sceneX: Double

  33. def sceneY: Double

  34. def screenX: Double

  35. def screenY: Double

  36. def secondaryButtonDown: Boolean

    Returns true if secondary button (button 1, usually the right) is currently pressed.

  37. def shiftDown: Boolean

    Whether or not the Shift modifier is down on this event.

  38. def shortcutDown: Boolean

    Returns whether or not the host platform common shortcut modifier is down on this event.

  39. def source: AnyRef

    Returns the object on which the Event initially occurred.

    Returns the object on which the Event initially occurred.

    Definition Classes
    Event
  40. def stillSincePress: Boolean

    Indicates whether the mouse cursor stayed in the system-provided hysteresis area since last pressed event that occurred before this event.

  41. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  42. def synthesized: Boolean

    Indicates whether this event is synthesized from using a touch screen instead of usual mouse event source devices like mouse or track pad.

  43. def target: EventTarget

    Returns the event target of this event.

    Returns the event target of this event.

    Definition Classes
    Event
  44. def toString(): String

    returns

    Returns the original delegate's toString() adding a [SFX] prefix.

    Definition Classes
    SFXDelegate → AnyRef → Any
  45. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  46. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. def x: Double

  49. def y: Double

  50. def z: Double

    Depth position of the event relative to the origin of the MouseEvent's source.

Deprecated Value Members

  1. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from InputEvent

Inherited from Event

Inherited from SFXDelegate[javafx.scene.input.MouseEvent]

Inherited from AnyRef

Inherited from Any

Ungrouped