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

public abstract class AbstractInputEvent extends AbstractGuiseEvent implements InputEvent
An abstract event providing information on input such as a keystroke or a command.
Author:
Garret Wilson
See Also:
  • Constructor Details

    • AbstractInputEvent

      public AbstractInputEvent(Object source)
      Source constructor.
      Parameters:
      source - The object on which the event initially occurred.
      Throws:
      NullPointerException - if the given source is null.
  • Method Details

    • isConsumed

      public boolean isConsumed()
      Specified by:
      isConsumed in interface InputEvent
      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 interface InputEvent