AbstractKeyboardEvent (Guise Framework 0.4.0 API)

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
        
        io.guise.framework.event.AbstractFocusedGestureInputEvent
        
        io.guise.framework.event.AbstractKeyboardEvent

All Implemented Interfaces:

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

Direct Known Subclasses:

KeyPressEvent, KeyReleaseEvent
```
public abstract class AbstractKeyboardEvent
extends AbstractFocusedGestureInputEvent
implements KeyboardEvent
```
An abstract event providing information on a keyboard key event.

Author:

Garret Wilson

See Also:

Serialized Form

- Field Summary
  - Fields inherited from class java.util.EventObject
    source
- Constructor Summary
  
  Constructors
  Constructor Description
  
  AbstractKeyboardEvent(java.lang.Object source, Key key, Key... keys)
  Source constructor.
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  Key getKey()
  - Methods inherited from class io.guise.framework.event.AbstractGestureInputEvent
    getKeys, hasAltKey, hasControlKey, hasShiftKey
  - 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
    getKeys, hasAltKey, hasControlKey, hasShiftKey
  - Methods inherited from interface io.guise.framework.event.GuiseEvent
    getSession
  - Methods inherited from interface io.guise.framework.event.InputEvent
    consume, isConsumed
  - Methods inherited from interface io.guise.framework.event.KeyboardEvent
    getInput

- Constructor Detail
  - AbstractKeyboardEvent
```
public AbstractKeyboardEvent(java.lang.Object source,
                             Key key,
                             Key... keys)
```
    Source constructor.
    
    Parameters:
    
    source - The object on which the event initially occurred.
    
    key - The key that was pressed.
    
    keys - The keys that were pressed when this event was generated.
    
    Throws:
    
    java.lang.NullPointerException - if the given source, key, and/or keys is null.
- Method Detail
  - getKey
```
public Key getKey()
```
    Specified by:
    
    getKey in interface KeyboardEvent
    
    Returns:
    
    The key that was pressed.