Field Detail

• CONTEXT_MENU_REQUESTED

  public static final EventType<ContextMenuEvent> CONTEXT_MENU_REQUESTED

  This event occurs when a context menu is requested.

• ANY

  public static final EventType<ContextMenuEvent> ANY

  Common supertype for all context menu event types.

  Since:

  JavaFX 8.0

Constructor Detail

• ContextMenuEvent

  public ContextMenuEvent​(Object source,
                          EventTarget target,
                          EventType<ContextMenuEvent> eventType,
                          double x,
                          double y,
                          double screenX,
                          double screenY,
                          boolean keyboardTrigger,
                          PickResult pickResult)

  Constructs new ContextMenu event.

  Parameters:

  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 scene

  y - The y with respect to the scene

  screenX - The x coordinate relative to screen.

  screenY - The y coordinate relative to screen.

  keyboardTrigger - true if this event was triggered by keyboard.

  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 the target

  Since:

  JavaFX 8.0

• ContextMenuEvent

  public ContextMenuEvent​(EventType<ContextMenuEvent> eventType,
                          double x,
                          double y,
                          double screenX,
                          double screenY,
                          boolean keyboardTrigger,
                          PickResult pickResult)

  Constructs new ContextMenu event with empty source and target.

  Parameters:

  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.

  keyboardTrigger - true if this event was triggered by keyboard.

  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

Method Detail

• copyFor

  public ContextMenuEvent copyFor​(Object newSource,
                                  EventTarget newTarget)

  Description copied from class: Event
  Creates and returns a copy of this event with the specified event source and target. If the source or target is set to null, it is replaced by the NULL_SOURCE_TARGET value.

  Overrides:

  copyFor in class Event

  Parameters:

  newSource - the new source of the copied event

  newTarget - the new target of the copied event

  Returns:

  the event copy with the new source and target

• getEventType

  public EventType<ContextMenuEvent> getEventType()

  Description copied from class: Event
  Gets the event type of this event. Objects of the same Event class can have different event types. These event types further specify what kind of event occurred.

  Overrides:

  getEventType in class InputEvent

  Returns:

  the event type

• isKeyboardTrigger

  public boolean isKeyboardTrigger()

  Determines whether this event originated from the keyboard.

  Returns:

  true if the event was caused by the keyboard

• getX

  public final double getX()

  Horizontal position of the event relative to the origin of the ContextMenuEvent's source. For more information about this event's coordinate semantics please see the general description of ContextMenuEvent.

  Returns:

  horizontal position of the event relative to the origin of the ContextMenuEvent's source.

• getY

  public final double getY()

  Vertical position of the event relative to the origin of the ContextMenuEvent's source. For more information about this event's coordinate semantics please see the general description of ContextMenuEvent.

  Returns:

  vertical position of the event relative to the origin of the ContextMenuEvent's source.

• getZ

  public final double getZ()

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

  Returns:

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

  Since:

  JavaFX 8.0

• getScreenX

  public final double getScreenX()

  Returns absolute horizontal position of the event. For more information about this event's coordinate semantics please see the general description of ContextMenuEvent.

  Returns:

  absolute horizontal position of the event

• getScreenY

  public final double getScreenY()

  Returns absolute vertical position of the event. For more information about this event's coordinate semantics please see the general description of ContextMenuEvent.

  Returns:

  absolute vertical position of the event

• getSceneX

  public final double getSceneX()

  Returns horizontal position of the event relative to the origin of the Scene that contains the ContextMenuEvent's source. If the node is not in a Scene, then the value is relative to the boundsInParent of the root-most parent of the ContextMenuEvent's node. For more information about this event's coordinate semantics please see the general description of ContextMenuEvent. Note that in 3D scene, this represents the flat coordinates after applying the projection transformations.

  Returns:

  horizontal position of the event relative to the origin of the Scene that contains the ContextMenuEvent's source

• getSceneY

  public final double getSceneY()

  Returns vertical position of the event relative to the origin of the Scene that contains the ContextMenuEvent's source. If the node is not in a Scene, then the value is relative to the boundsInParent of the root-most parent of the ContextMenuEvent's node. For more information about this event's coordinate semantics please see the general description of ContextMenuEvent. Note that in 3D scene, this represents the flat coordinates after applying the projection transformations.

  Returns:

  vertical position of the event relative to the origin of the Scene that contains the ContextMenuEvent's source

• getPickResult

  public final PickResult getPickResult()

  Returns information about the pick.

  Returns:

  new PickResult object that contains information about the pick

  Since:

  JavaFX 8.0

• toString

  public String toString()

  Returns a string representation of this ContextMenuEvent object.

  Overrides:

  toString in class EventObject

  Returns:

  a string representation of this ContextMenuEvent object.