javafx.scene.input

Class ContextMenuEvent

java.lang.Object

java.util.EventObject

javafx.event.Event

javafx.scene.input.InputEvent

javafx.scene.input.ContextMenuEvent

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ContextMenuEvent
extends InputEvent

When the user requests a context menu, this event occurs. Context menus can be triggered by the mouse or the keyboard. The exact sequence of mouse or keyboard events that is used to request a menu is platform specific. For example, on Windows, Shift+F10 requests a context menu.

The event coordinates contain default position for the context menu. For mouse-triggered events it is the position of the mouse cursor, for keyboard-triggered events it is a point inside of bounds of current focus owner (which is the event's target).

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static EventType<ContextMenuEvent>	CONTEXT_MENU_REQUESTED This event occurs when a context menu is requested.

Fields inherited from class javafx.scene.input.InputEvent

ANY

Fields inherited from class javafx.event.Event

consumed, eventType, NULL_SOURCE_TARGET, target

Fields inherited from class java.util.EventObject

source

Method Summary

Methods

Modifier and Type	Method and Description
Event	copyFor(java.lang.Object newSource, EventTarget newTarget) Creates and returns a copy of this event with the specified event source and target.
double	getSceneX() Returns horizontal position of the event relative to the origin of the Scene that contains the ContextMenuEvent's source.
double	getSceneY() Returns vertical position of the event relative to the origin of the Scene that contains the ContextMenuEvent's source.
double	getScreenX() Returns absolute horizontal position of the event.
double	getScreenY() Returns absolute vertical position of the event.
double	getX() Horizontal position of the event relative to the origin of the ContextMenuEvent's source.
double	getY() Vertical position of the event relative to the origin of the ContextMenuEvent's source.
boolean	isKeyboardTrigger() Determines whether this event originated from the keyboard.
java.lang.String	toString() Returns a string representation of this ContextMenuEvent object.

Methods inherited from class javafx.event.Event

clone, consume, fireEvent, getEventType, getTarget, isConsumed

Methods inherited from class java.util.EventObject

getSource

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CONTEXT_MENU_REQUESTED

public static final EventType<ContextMenuEvent> CONTEXT_MENU_REQUESTED

This event occurs when a context menu is requested.

Method Detail

copyFor

public Event copyFor(java.lang.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

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.

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.

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.

Returns:

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

toString

public java.lang.String toString()

Returns a string representation of this ContextMenuEvent object.

Overrides:

toString in class java.util.EventObject

Returns:

a string representation of this ContextMenuEvent object.