hu.akarnokd.reactive4java.swing

Class ObservableKeyListener

java.lang.Object

hu.akarnokd.reactive4java.util.DefaultObservable<java.awt.event.KeyEvent>

hu.akarnokd.reactive4java.swing.ObservableKeyListener

All Implemented Interfaces:

BaseObserver, CloseableObservable<java.awt.event.KeyEvent>, Observable<java.awt.event.KeyEvent>, Observer<java.awt.event.KeyEvent>, Subject<java.awt.event.KeyEvent,java.awt.event.KeyEvent>, java.awt.event.KeyListener, java.io.Closeable, java.lang.AutoCloseable, java.util.EventListener

public class ObservableKeyListener
extends DefaultObservable<java.awt.event.KeyEvent>
implements java.awt.event.KeyListener

The observable key listener which collects the keyTyped(), keyPressed(), keyReleased() events and relays it to next(). The original type can be determined by using KeyEvent.getType(). This observable never signals finish() or error().

Constructor Summary

Constructors

Constructor and Description
ObservableKeyListener()

Method Summary

Modifier and Type	Method and Description
void	keyPressed(java.awt.event.KeyEvent e)
void	keyReleased(java.awt.event.KeyEvent e)
void	keyTyped(java.awt.event.KeyEvent e)
static ObservableKeyListener	register(java.lang.Object component) Convenience method to register an action listener on an object which should have an addKeyListener() public method.
ObservableKeyListener	registerWith(java.lang.Object component) Convenience method to register this observable with the target component which must have a public addKeyListener(KeyListener) method.
ObservableKeyListener	unregisterFrom(java.lang.Object component) Convenience method to unregister this observable from the target component which must have a public removeKeyListener(KeyListener) method.

Methods inherited from class hu.akarnokd.reactive4java.util.DefaultObservable

close, error, finish, getObserverCount, next, register, unregister

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ObservableKeyListener

public ObservableKeyListener()

Method Detail

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)

Specified by:

keyTyped in interface java.awt.event.KeyListener

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Specified by:

keyPressed in interface java.awt.event.KeyListener

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Specified by:

keyReleased in interface java.awt.event.KeyListener

register

@Nonnull
public static ObservableKeyListener register(@Nonnull
                                                       java.lang.Object component)

Convenience method to register an action listener on an object which should have an addKeyListener() public method. It uses reflection to detemine the method's existence. Throws IllegalArgumentException if the component is null or does not have the required method.

Parameters:

component - the target component.

Returns:

the observable action listener

registerWith

@Nonnull
public ObservableKeyListener registerWith(@Nonnull
                                                    java.lang.Object component)

Convenience method to register this observable with the target component which must have a public addKeyListener(KeyListener) method.

Parameters:

component - the target component

Returns:

this

unregisterFrom

@Nonnull
public ObservableKeyListener unregisterFrom(@Nonnull
                                                      java.lang.Object component)

Convenience method to unregister this observable from the target component which must have a public removeKeyListener(KeyListener) method.

Parameters:

component - the target component

Returns:

this