JOGL 2.3.2 · com.jogamp.newt.event.NEWTEvent

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:

WindowEvent 100..10x
MouseEvent 200..20x
KeyEvent 300..30x
GestureEvent 400..5xx
MonitorEvent 600..60x

Field Summary

Modifier and Type	Field and Description
private Object	attachment
public static final Object	consumedTag See `setConsumed(boolean)` for description.
pack-priv static final boolean	DEBUG
private final short	eventType
private final long	when

Inherited from java.util.EventObject:: source

Access	Constructor and Description
protected	NEWTEvent(final short eventType, final Object source, final long when)

Method Summary

Modifier and Type	Method and Description
public final Object	Returns: The user application specific attachment, or null getAttachment()
public final short	getEventType() Returns the event type of this event.
public final long	getWhen() Returns the timestamp, in milliseconds, of this event.
public final boolean	isConsumed() Returns `true` if this events has been `consumed`, otherwise `false`.
public final void	setAttachment(final Object User application specific object attachment) Attach the passed object to this event.
public final void	setConsumed(final boolean consumed) If `consumed` is `true`, this event is marked as consumed, ie.
public static String	toHexString(final short hex)
public String	toString() Overrides java.util.EventObject.toString. Returns a String representation of this EventObject.
public StringBuilder	toString(StringBuilder sb)

Inherited from java.util.EventObject:: getSource

Field Detail

attachment	back to summary
private Object attachment

consumedTag	back to summary
public static final Object consumedTag See `setConsumed(boolean)` for description.

DEBUG	back to summary
pack-priv static final boolean DEBUG

eventType	back to summary
private final short eventType

when	back to summary
private final long when

Constructor Detail

NEWTEvent	back to summary
protected NEWTEvent(final short eventType, final Object source, final long when)

Method Detail

getAttachment	back to summary
public final Object getAttachment() Returns:Object The user application specific attachment, or null

getEventType	back to summary
public final short getEventType() Returns the event type of this event.

getWhen	back to summary
public final long getWhen() Returns the timestamp, in milliseconds, of this event.

isConsumed back to summary

isConsumed	back to summary
public final boolean isConsumed() Returns `true` if this events has been `consumed`, otherwise `false`. See Also `setConsumed(boolean)`

public final boolean isConsumed()

Returns true if this events has been consumed, otherwise false.

See Also: setConsumed(boolean)

setAttachment	back to summary
public final void 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. Parameters attachment:Object User application specific object

setAttachment

back to summary

public final void 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.

Parameters

attachment:Object: User application specific object

setConsumed back to summary

setConsumed	back to summary
public final void 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]

public final void 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]

toHexString	back to summary
public static String toHexString(final short hex)

toString	back to summary
public String toString() Overrides java.util.EventObject.toString. Doc from java.util.EventObject.toString. Returns a String representation of this EventObject. Returns:String a String representation of this EventObject Annotations @Override

toString

back to summary

public String toString()

Overrides java.util.EventObject.toString.

Doc from java.util.EventObject.toString.

Returns a String representation of this EventObject.

Returns:String

a String representation of this EventObject

Annotations