|
JOGL v2.6.0-rc-20250712
JOGL, High-Performance Graphics Binding for Java (public API).
|
NEWT events are provided for notification purposes ONLY;
The NEWT will automatically handle the event semantics internally, regardless of whether a program is receiving these events or not.
More...
Public Member Functions | |
| final short | getEventType () |
| Returns the event type of this event. More... | |
| final long | getWhen () |
| Returns the timestamp, in milliseconds, of this event. More... | |
| final void | setAttachment (final Object attachment) |
| Attach the passed object to this event. More... | |
| final Object | getAttachment () |
| final boolean | isConsumed () |
Returns true if this events has been consumed, otherwise false. More... | |
| final void | setConsumed (final boolean consumed) |
If consumed is true, this event is marked as consumed, ie. More... | |
| String | toString () |
| StringBuilder | toString (StringBuilder sb) |
Static Public Member Functions | |
| static String | toHexString (final short hex) |
Static Public Attributes | |
| static final Object | consumedTag = new Object() |
See setConsumed(boolean) for description. More... | |
Protected Member Functions | |
| NEWTEvent (final short eventType, final Object source, final long when) | |
NEWT events are provided for notification purposes ONLY;
The NEWT will automatically handle the event semantics internally, regardless of whether a program is receiving these events or not.
The actual event semantic is processed before the event is send.
Event type registry:
100..10x 200..20x 300..30x 400..5xx 600..60x
Definition at line 52 of file NEWTEvent.java.
|
protected |
Definition at line 64 of file NEWTEvent.java.
| final Object com.jogamp.newt.event.NEWTEvent.getAttachment | ( | ) |
Definition at line 96 of file NEWTEvent.java.
| final short com.jogamp.newt.event.NEWTEvent.getEventType | ( | ) |
Returns the event type of this event.
Definition at line 72 of file NEWTEvent.java.
| final long com.jogamp.newt.event.NEWTEvent.getWhen | ( | ) |
Returns the timestamp, in milliseconds, of this event.
Definition at line 77 of file NEWTEvent.java.
| final boolean com.jogamp.newt.event.NEWTEvent.isConsumed | ( | ) |
Returns true if this events has been consumed, otherwise false.
Definition at line 105 of file NEWTEvent.java.
| final void com.jogamp.newt.event.NEWTEvent.setAttachment | ( | final Object | attachment | ) |
Attach the passed object to this event.
If an object was previously attached, it will be replaced.
Attachments to NEWT events allow users to pass on information from one custom listener to another, ie custom listener to listener communication.
| attachment | User application specific object |
Definition at line 89 of file NEWTEvent.java.
| final void com.jogamp.newt.event.NEWTEvent.setConsumed | ( | final boolean | consumed | ) |
If consumed is true, this event is marked as consumed, ie.
the event will not be propagated any further to potential other event listener. Otherwise the event will be propagated to other event listener, the default.
The event is marked as being consumed while attaching the consumedTag.
Events with platform specific actions will be supressed if marked as consumed. Examples are:
KeyEvent#VK_ESCAPE on Android's BACK button w/ Activity::finish() KeyEvent#VK_HOME on Android's HOME button w/ Intend.ACTION_MAIN[Intend.CATEGORY_HOME] Definition at line 126 of file NEWTEvent.java.
|
static |
Definition at line 146 of file NEWTEvent.java.
| String com.jogamp.newt.event.NEWTEvent.toString | ( | ) |
Reimplemented in com.jogamp.newt.event.GestureHandler.GestureEvent, com.jogamp.newt.event.InputEvent, com.jogamp.newt.event.KeyEvent, com.jogamp.newt.event.MonitorEvent, com.jogamp.newt.event.MouseEvent, com.jogamp.newt.event.PinchToZoomGesture.ZoomEvent, com.jogamp.newt.event.WindowEvent, and com.jogamp.newt.event.WindowUpdateEvent.
Definition at line 135 of file NEWTEvent.java.
| StringBuilder com.jogamp.newt.event.NEWTEvent.toString | ( | StringBuilder | sb | ) |
Reimplemented in com.jogamp.newt.event.InputEvent, com.jogamp.newt.event.KeyEvent, com.jogamp.newt.event.MonitorEvent, com.jogamp.newt.event.MouseEvent, com.jogamp.newt.event.WindowEvent, and com.jogamp.newt.event.WindowUpdateEvent.
Definition at line 139 of file NEWTEvent.java.
|
static |
See setConsumed(boolean) for description.
Definition at line 56 of file NEWTEvent.java.