Class/Object

scalafx.scene.input

MouseEvent

Related Docs: object MouseEvent | package input

Permalink

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
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
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)

    Permalink

    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)

    Permalink

    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)

    Permalink

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. def altDown: Boolean

    Permalink

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

  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def button: MouseButton

    Permalink

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

  7. def clickCount: Int

    Permalink

    Returns number of mouse clicks associated with this event.

  8. def clone(): AnyRef

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

    Permalink

    Marks this Event as consumed.

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

    Definition Classes
    Event
  10. def consumed: Boolean

    Permalink

    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
  11. def controlDown: Boolean

    Permalink

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

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

    Permalink

    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
  13. val delegate: javafx.scene.input.MouseEvent

    Permalink

    JavaFX object to be wrapped.

    JavaFX object to be wrapped.

    Definition Classes
    MouseEvent → InputEvent → Event → SFXDelegate
  14. def dragDetect: Boolean

    Permalink

    Determines whether this event will be followed by DRAG_DETECTED event.

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

    Permalink

    Augments drag detection behavior.

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

    Permalink
    Definition Classes
    AnyRef
  17. def equals(ref: Any): Boolean

    Permalink

    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
  18. def eventType: EventType[_ <: javafx.scene.input.MouseEvent]

    Permalink

    Gets the event type of this event.

    Gets the event type of this event.

    Definition Classes
    MouseEvent → Event
  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Permalink

    returns

    The delegate hashcode

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

    Permalink
    Definition Classes
    Any
  23. def metaDown: Boolean

    Permalink

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

  24. def middleButtonDown: Boolean

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. def pickResult: PickResult

    Permalink

    Returns information about the pick.

  29. def popupTrigger: Boolean

    Permalink

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

  30. def primaryButtonDown: Boolean

    Permalink

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

  31. def sceneX: Double

    Permalink
  32. def sceneY: Double

    Permalink
  33. def screenX: Double

    Permalink
  34. def screenY: Double

    Permalink
  35. def secondaryButtonDown: Boolean

    Permalink

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

  36. def shiftDown: Boolean

    Permalink

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

  37. def shortcutDown: Boolean

    Permalink

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

  38. def source: AnyRef

    Permalink

    Returns the object on which the Event initially occurred.

    Returns the object on which the Event initially occurred.

    Definition Classes
    Event
  39. def stillSincePress: Boolean

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef
  41. def synthesized: Boolean

    Permalink

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

  42. def target: EventTarget

    Permalink

    Returns the event target of this event.

    Returns the event target of this event.

    Definition Classes
    Event
  43. def toString(): String

    Permalink

    returns

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

    Definition Classes
    SFXDelegate → AnyRef → Any
  44. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  45. final def wait(arg0: Long, arg1: Int): Unit

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

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

    Permalink
  48. def y: Double

    Permalink
  49. def z: Double

    Permalink

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

Inherited from InputEvent

Inherited from Event

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

Inherited from AnyRef

Inherited from Any

Ungrouped