hu.akarnokd.reactive4java.swing

Class ObservableMouseListener

java.lang.Object

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

hu.akarnokd.reactive4java.swing.ObservableMouseListener

All Implemented Interfaces:

BaseObserver, CloseableObservable<java.awt.event.MouseEvent>, Observable<java.awt.event.MouseEvent>, Observer<java.awt.event.MouseEvent>, Subject<java.awt.event.MouseEvent,java.awt.event.MouseEvent>, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.io.Closeable, java.lang.AutoCloseable, java.util.EventListener

public class ObservableMouseListener
extends DefaultObservable<java.awt.event.MouseEvent>
implements java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener

The observable mouse listener which relays all mouse related events (movement, clicks, wheel) to next(). events and relays it to next(). The original type can be determined by using MouseEvent.getID() which can be one of the following value:

• MouseListener events
  • MouseEvent.MOUSE_CLICKED
  • MouseEvent.MOUSE_PRESSED
  • MouseEvent.MOUSE_RELEASED
  • MouseEvent.MOUSE_ENTERED
  • MouseEvent.MOUSE_EXITED
• MouseMotionListener events
  • MouseEvent.MOUSE_MOVED
  • MouseEvent.MOUSE_DRAGGED
• MouseWheelListener events
  • MouseEvent.MOUSE_WHEEL

This observable never signals finish() or error().

Constructor Summary

Constructors

Constructor and Description
ObservableMouseListener()

Method Summary

Modifier and Type	Method and Description
void	mouseClicked(java.awt.event.MouseEvent e)
void	mouseDragged(java.awt.event.MouseEvent e)
void	mouseEntered(java.awt.event.MouseEvent e)
void	mouseExited(java.awt.event.MouseEvent e)
void	mouseMoved(java.awt.event.MouseEvent e)
void	mousePressed(java.awt.event.MouseEvent e)
void	mouseReleased(java.awt.event.MouseEvent e)
void	mouseWheelMoved(java.awt.event.MouseWheelEvent e)
static ObservableMouseListener	register(java.awt.Component component) Convenience method to register an observer on the component for all mouse event types.
ObservableMouseListener	registerWith(java.awt.Component component) Convenience method to register this observer with the target component for all mouse event types.
ObservableMouseListener	registerWith(java.awt.Component component, boolean normal, boolean motion, boolean wheel) Convenience method to register this observer with the target component for any mouse event types.
ObservableMouseListener	unregisterFrom(java.awt.Component component) Unregister all mouse events from the given component.

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

ObservableMouseListener

public ObservableMouseListener()

Method Detail

mouseClicked

public void mouseClicked(java.awt.event.MouseEvent e)

Specified by:

mouseClicked in interface java.awt.event.MouseListener

mousePressed

public void mousePressed(java.awt.event.MouseEvent e)

Specified by:

mousePressed in interface java.awt.event.MouseListener

mouseReleased

public void mouseReleased(java.awt.event.MouseEvent e)

Specified by:

mouseReleased in interface java.awt.event.MouseListener

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent e)

Specified by:

mouseEntered in interface java.awt.event.MouseListener

mouseExited

public void mouseExited(java.awt.event.MouseEvent e)

Specified by:

mouseExited in interface java.awt.event.MouseListener

mouseWheelMoved

public void mouseWheelMoved(java.awt.event.MouseWheelEvent e)

Specified by:

mouseWheelMoved in interface java.awt.event.MouseWheelListener

mouseDragged

public void mouseDragged(java.awt.event.MouseEvent e)

Specified by:

mouseDragged in interface java.awt.event.MouseMotionListener

mouseMoved

public void mouseMoved(java.awt.event.MouseEvent e)

Specified by:

mouseMoved in interface java.awt.event.MouseMotionListener

register

@Nonnull
public static ObservableMouseListener register(@Nonnull
                                                         java.awt.Component component)

Convenience method to register an observer on the component for all mouse event types. To unregister, use the Component.removeMouseListener(), Component.removeMouseMotionListener() and Component.removeMouseWheelListener() methods.

Parameters:

component - the target component.

Returns:

the new observable

registerWith

@Nonnull
public ObservableMouseListener registerWith(@Nonnull
                                                      java.awt.Component component)

Convenience method to register this observer with the target component for all mouse event types. To deregister this observable, use the unregisterFrom().

Parameters:

component - the target component

Returns:

this

registerWith

@Nonnull
public ObservableMouseListener registerWith(@Nonnull
                                                      java.awt.Component component,
                                                      boolean normal,
                                                      boolean motion,
                                                      boolean wheel)

Convenience method to register this observer with the target component for any mouse event types. To deregister this observable, use the unregisterFrom().

Parameters:

component - the target component

normal - register for normal events?

motion - register for motion events?

wheel - register for wheel events?

Returns:

this

unregisterFrom

@Nonnull
public ObservableMouseListener unregisterFrom(@Nonnull
                                                        java.awt.Component component)

Unregister all mouse events from the given component.

Parameters:

component - the target component

Returns:

this