com.guiseframework.event
Class AbstractInputEvent

java.lang.Object
  java.util.EventObject
      com.globalmentor.event.AbstractEvent
          com.guiseframework.event.AbstractGuiseEvent
              com.guiseframework.event.AbstractInputEvent

All Implemented Interfaces:

com.globalmentor.event.Event, GuiseEvent, InputEvent, java.io.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:

Serialized Form

Field Summary

Fields inherited from class java.util.EventObject

source

Constructor Summary

AbstractInputEvent(java.lang.Object source)
Source constructor.

Method Summary

void	consume() Consumes the input associated with this event.
boolean	isConsumed()

Methods inherited from class com.guiseframework.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.guiseframework.event.InputEvent

getInput

Methods inherited from interface com.guiseframework.event.GuiseEvent

getSession

Methods inherited from interface com.globalmentor.event.Event

getSource

Constructor Detail

AbstractInputEvent

public AbstractInputEvent(java.lang.Object source)

Source constructor.

Parameters:

source - The object on which the event initially occurred.

Throws:

java.lang.NullPointerException - if the given source is null.

Method Detail

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()

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