Package io.guise.framework.event
Class AbstractInputEvent
java.lang.Object
java.util.EventObject
com.globalmentor.event.AbstractEvent
io.guise.framework.event.AbstractGuiseEvent
io.guise.framework.event.AbstractInputEvent
- All Implemented Interfaces:
com.globalmentor.event.Event
,GuiseEvent
,InputEvent
,Serializable
- Direct Known Subclasses:
AbstractFocusedInputEvent
,AbstractGestureInputEvent
An abstract event providing information on input such as a keystroke or a command.
- Author:
- Garret Wilson
- See Also:
-
Field Summary
Fields inherited from class java.util.EventObject
source
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
consume()
Consumes the input associated with this event.boolean
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.GuiseEvent
getSession
Methods inherited from interface io.guise.framework.event.InputEvent
getInput
-
Constructor Details
-
AbstractInputEvent
Source constructor.- Parameters:
source
- The object on which the event initially occurred.- Throws:
NullPointerException
- if the given source isnull
.
-
-
Method Details
-
isConsumed
public boolean isConsumed()- Specified by:
isConsumed
in interfaceInputEvent
- Returns:
- Whether the input associated with this event has been consumed.
-
consume
public void consume()Description copied from interface:InputEvent
Consumes the input associated with this event. The event is marked as consumed so that other listeners will be on notice not to consume the input.- Specified by:
consume
in interfaceInputEvent
-