Package io.guise.framework.event

Class AbstractGestureInputEvent

java.lang.Object

java.util.EventObject

com.globalmentor.event.AbstractEvent

io.guise.framework.event.AbstractGuiseEvent

io.guise.framework.event.AbstractInputEvent

io.guise.framework.event.AbstractGestureInputEvent

All Implemented Interfaces:

com.globalmentor.event.Event, GestureInputEvent, GuiseEvent, InputEvent, java.io.Serializable

Direct Known Subclasses:

AbstractFocusedGestureInputEvent, AbstractMouseEvent

public abstract class AbstractGestureInputEvent
extends AbstractInputEvent
implements GestureInputEvent

An abstract event providing information on input from a user gesture.

Author:

Garret Wilson

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
AbstractGestureInputEvent(java.lang.Object source, Key... keys)	Source constructor.

Method Summary

Modifier and Type	Method	Description
java.util.Set<Key>	getKeys()
boolean	hasAltKey()	Determines whether an Alt key was pressed when this event was generated.
boolean	hasControlKey()	Determines whether a Control key was pressed when this event was generated.
boolean	hasShiftKey()	Determines whether a Shift key was pressed when this event was generated.

Methods inherited from class io.guise.framework.event.AbstractInputEvent

consume, isConsumed

Methods inherited from class io.guise.framework.event.AbstractGuiseEvent

getSession

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.globalmentor.event.Event

getSource

Methods inherited from interface io.guise.framework.event.GestureInputEvent

getInput

Methods inherited from interface io.guise.framework.event.GuiseEvent

getSession

Methods inherited from interface io.guise.framework.event.InputEvent

consume, isConsumed

Constructor Detail

AbstractGestureInputEvent

public AbstractGestureInputEvent(java.lang.Object source,
                                 Key... keys)

Source constructor.

Parameters:

source - The object on which the event initially occurred.

keys - The keys that were pressed when this event was generated.

Throws:

java.lang.NullPointerException - if the given source and/or keys is null.

Method Detail

getKeys

public java.util.Set<Key> getKeys()

Specified by:

getKeys in interface GestureInputEvent

Returns:

The keys that were pressed when this event was generated.

hasAltKey

public boolean hasAltKey()

Description copied from interface: GestureInputEvent

Determines whether an Alt key was pressed when this event was generated.

Specified by:

hasAltKey in interface GestureInputEvent

Returns:

true if one of the Alt keys were pressed when this event was generated.

See Also:

GestureInputEvent.getKeys()

hasControlKey

public boolean hasControlKey()

Description copied from interface: GestureInputEvent

Determines whether a Control key was pressed when this event was generated.

Specified by:

hasControlKey in interface GestureInputEvent

Returns:

true if one of the Control keys were pressed when this event was generated.

See Also:

GestureInputEvent.getKeys()

hasShiftKey

public boolean hasShiftKey()

Description copied from interface: GestureInputEvent

Determines whether a Shift key was pressed when this event was generated.

Specified by:

hasShiftKey in interface GestureInputEvent

Returns:

true if one of the Shift keys were pressed when this event was generated.

See Also:

GestureInputEvent.getKeys()