InputEvent (Guise Framework 0.4.0 API)

All Superinterfaces:

com.globalmentor.event.Event, GuiseEvent

All Known Subinterfaces:

FocusedInputEvent, GestureInputEvent, KeyboardEvent, MouseEvent, MouseInputEvent

All Known Implementing Classes:

AbstractFocusedGestureInputEvent, AbstractFocusedInputEvent, AbstractGestureInputEvent, AbstractInputEvent, AbstractKeyboardEvent, AbstractMouseEvent, CommandEvent, KeyPressEvent, KeyReleaseEvent, MouseClickEvent, MouseEnterEvent, MouseExitEvent
```
public interface InputEvent
extends GuiseEvent
```
An event providing information from input such as a keystroke or a command.

Author:

Garret Wilson

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`void`	`consume()`	Consumes the input associated with this event.
`Input`	`getInput()`
`boolean`	`isConsumed()`

Methods inherited from interface com.globalmentor.event.Event
getSource

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

- Method Detail
  - isConsumed
```
boolean isConsumed()
```
    Returns:
    
    Whether the input associated with this event has been consumed.
  - consume
```
void consume()
```
    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.
  - getInput
```
Input getInput()
```
    Returns:
    
    The input associated with this event, or null if there is no input associated with this event.