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

Modifier and Type	Class and Description
public static interface	InputEvent.InputClass Interface marking class of input types
public static interface	InputEvent.InputType Interface marking type of input devices

Field Summary

Modifier and Type	Field and Description
public static final int	ALT_GRAPH_MASK
public static final int	ALT_MASK
public static final int	AUTOREPEAT_MASK Event is caused by auto-repeat.
public static final int	BUTTON1_MASK
public static final int	BUTTON2_MASK
public static final int	BUTTON3_MASK
public static final int	BUTTON4_MASK
public static final int	BUTTON5_MASK
public static final int	BUTTON6_MASK
public static final int	BUTTON7_MASK
public static final int	BUTTON8_MASK
public static final int	BUTTON9_MASK
public static final int	BUTTONALL_MASK
public static final int	BUTTONLAST_MASK
public static final int	CONFINED_MASK Pointer is confined, see `Window#confinePointer(boolean)`.
public static final int	CTRL_MASK
public static final int	INVISIBLE_MASK Pointer is invisible, see `Window#setPointerVisible(boolean)`.
public static final int	META_MASK
private final int	modifiers
public static final int	SHIFT_MASK

Inherited from com.jogamp.newt.event.NEWTEvent:: consumedTag DEBUG

Access	Constructor and Description
protected	InputEvent(final short eventType, final Object source, final long when, final int modifiers)

Method Summary

Modifier and Type	Method and Description
public final int	getButtonDownCount() Returns the number of pressed buttons by counting the set bits: getBitCount(modifiers & BUTTONALL_MASK);
public static final int	getButtonMask(final int button) Returns the corresponding button mask for the given button.
public final short[]	Returns: Array of pressed mouse buttons [`MouseEvent#BUTTON1` .. `MouseEvent#BUTTON6`]. If none is down, the resulting array is of length 0. getButtonsDown() See also `MouseEvent`'s section about Multiple-Pointer Events.
public final int	getModifiers() Return the modifier bits of this event, e.g. see `SHIFT_MASK` ..
public final StringBuilder	getModifiersString(StringBuilder sb)
public final boolean	isAltDown() `getModifiers()` contains `ALT_MASK`.
public final boolean	isAltGraphDown() `getModifiers()` contains `ALT_GRAPH_MASK`.
public final boolean	isAnyButtonDown() Returns true if at least one button is pressed, otherwise false: 0 != ( modifiers & BUTTONALL_MASK )
public final boolean	isAutoRepeat() `getModifiers()` contains `AUTOREPEAT_MASK`.
public final boolean	Returns: true if the given button is down isButtonDown(final int the button to test button) See also `MouseEvent`'s section about Multiple-Pointer Events.
public final boolean	isConfined() `getModifiers()` contains `CONFINED_MASK`.
public final boolean	isControlDown() `getModifiers()` contains `CTRL_MASK`.
public final boolean	isInvisible() `getModifiers()` contains `INVISIBLE_MASK`.
public final boolean	isMetaDown() `getModifiers()` contains `META_MASK`.
public final boolean	isShiftDown() `getModifiers()` contains `SHIFT_MASK`.
public String	toString() Overrides com.jogamp.newt.event.NEWTEvent.toString. Returns a String representation of this EventObject.
public StringBuilder	toString(StringBuilder sb) Overrides com.jogamp.newt.event.NEWTEvent.toString.

Inherited from com.jogamp.newt.event.NEWTEvent:: getAttachment getEventType getWhen isConsumed setAttachment setConsumed toHexString

Field Detail

ALT_GRAPH_MASK	back to summary
public static final int ALT_GRAPH_MASK

ALT_MASK	back to summary
public static final int ALT_MASK

AUTOREPEAT_MASK	back to summary
public static final int AUTOREPEAT_MASK Event is caused by auto-repeat.

BUTTON1_MASK	back to summary
public static final int BUTTON1_MASK

BUTTON2_MASK	back to summary
public static final int BUTTON2_MASK

BUTTON3_MASK	back to summary
public static final int BUTTON3_MASK

BUTTON4_MASK	back to summary
public static final int BUTTON4_MASK

BUTTON5_MASK	back to summary
public static final int BUTTON5_MASK

BUTTON6_MASK	back to summary
public static final int BUTTON6_MASK

BUTTON7_MASK	back to summary
public static final int BUTTON7_MASK

BUTTON8_MASK	back to summary
public static final int BUTTON8_MASK

BUTTON9_MASK	back to summary
public static final int BUTTON9_MASK

BUTTONALL_MASK	back to summary
public static final int BUTTONALL_MASK

BUTTONLAST_MASK	back to summary
public static final int BUTTONLAST_MASK

CONFINED_MASK	back to summary
public static final int CONFINED_MASK Pointer is confined, see `Window#confinePointer(boolean)`.

CTRL_MASK	back to summary
public static final int CTRL_MASK

INVISIBLE_MASK	back to summary
public static final int INVISIBLE_MASK Pointer is invisible, see `Window#setPointerVisible(boolean)`.

META_MASK	back to summary
public static final int META_MASK

modifiers	back to summary
private final int modifiers

SHIFT_MASK	back to summary
public static final int SHIFT_MASK

Constructor Detail

InputEvent	back to summary
protected InputEvent(final short eventType, final Object source, final long when, final int modifiers)

Method Detail

getButtonDownCount back to summary

getButtonDownCount	back to summary
public final int getButtonDownCount() Returns the number of pressed buttons by counting the set bits: getBitCount(modifiers & BUTTONALL_MASK); See also `MouseEvent`'s section about Multiple-Pointer Events. See Also `Bitfield.Util#bitCount(int)`, `BUTTONALL_MASK`

public final int getButtonDownCount()

Returns the number of pressed buttons by counting the set bits:

    getBitCount(modifiers & BUTTONALL_MASK);

See also MouseEvent's section about Multiple-Pointer Events.

See Also: Bitfield.Util#bitCount(int), BUTTONALL_MASK

getButtonMask back to summary

getButtonMask	back to summary
public static final int getButtonMask(final int button) Returns the corresponding button mask for the given button. In case the given button lies outside of the valid range [`MouseEvent#BUTTON1` .. `MouseEvent#BUTTON_COUNT`], null is returned.

public static final int getButtonMask(final int button)

Returns the corresponding button mask for the given button.

In case the given button lies outside of the valid range [MouseEvent#BUTTON1 .. MouseEvent#BUTTON_COUNT], null is returned.

getButtonsDown back to summary

getButtonsDown	back to summary
public final short[] getButtonsDown() See also `MouseEvent`'s section about Multiple-Pointer Events. Returns:short[] Array of pressed mouse buttons [`MouseEvent#BUTTON1` .. `MouseEvent#BUTTON6`]. If none is down, the resulting array is of length 0.

public final short[] getButtonsDown()

See also MouseEvent's section about Multiple-Pointer Events.

Returns:short[]: Array of pressed mouse buttons [MouseEvent#BUTTON1 .. MouseEvent#BUTTON6]. If none is down, the resulting array is of length 0.

getModifiers	back to summary
public final int getModifiers() Return the modifier bits of this event, e.g. see `SHIFT_MASK` .. etc.

getModifiersString	back to summary
public final StringBuilder getModifiersString(StringBuilder sb)

isAltDown	back to summary
public final boolean isAltDown() `getModifiers()` contains `ALT_MASK`.

isAltGraphDown	back to summary
public final boolean isAltGraphDown() `getModifiers()` contains `ALT_GRAPH_MASK`.

isAnyButtonDown back to summary

isAnyButtonDown	back to summary
public final boolean isAnyButtonDown() Returns true if at least one button is pressed, otherwise false: 0 != ( modifiers & BUTTONALL_MASK ) See also `MouseEvent`'s section about Multiple-Pointer Events. See Also `Bitfield.Util#bitCount(int)`, `BUTTONALL_MASK`

public final boolean isAnyButtonDown()

Returns true if at least one button is pressed, otherwise false:

    0 != ( modifiers & BUTTONALL_MASK )

See also MouseEvent's section about Multiple-Pointer Events.

See Also: Bitfield.Util#bitCount(int), BUTTONALL_MASK

isAutoRepeat	back to summary
public final boolean isAutoRepeat() `getModifiers()` contains `AUTOREPEAT_MASK`.

isButtonDown back to summary

isButtonDown	back to summary
public final boolean isButtonDown(final int button) See also `MouseEvent`'s section about Multiple-Pointer Events. Parameters button:int the button to test Returns:boolean true if the given button is down

public final boolean isButtonDown(final int button)

See also MouseEvent's section about Multiple-Pointer Events.

Parameters

button:int: the button to test

Returns:boolean

true if the given button is down

isConfined	back to summary
public final boolean isConfined() `getModifiers()` contains `CONFINED_MASK`. Pointer is confined, see `Window#confinePointer(boolean)`.

isControlDown	back to summary
public final boolean isControlDown() `getModifiers()` contains `CTRL_MASK`.

isInvisible	back to summary
public final boolean isInvisible() `getModifiers()` contains `INVISIBLE_MASK`. Pointer is invisible, see `Window#setPointerVisible(boolean)`.

isMetaDown	back to summary
public final boolean isMetaDown() `getModifiers()` contains `META_MASK`.

isShiftDown	back to summary
public final boolean isShiftDown() `getModifiers()` contains `SHIFT_MASK`.

toString	back to summary
public String toString() Overrides com.jogamp.newt.event.NEWTEvent.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 com.jogamp.newt.event.NEWTEvent.toString.

Doc from java.util.EventObject.toString.

Returns a String representation of this EventObject.

Returns:String

a String representation of this EventObject

Annotations