net.sf.jguiraffe.gui.platform.swing.builder.event

Class SwingEventAdapter

java.lang.Object

net.sf.jguiraffe.gui.platform.swing.builder.event.SwingEventAdapter

Direct Known Subclasses:

MouseEventAdapter

public abstract class SwingEventAdapter
extends Object

The base class for Swing event adapters.

An event adapter is responsible for transforming a Swing specific event notification into a platform independent form builder event. This base class provides a great deal of common functionality useful for different event types. Concrete sub classes will deal with specific event types.

This base class already stores important information (e.g. about the component this event adapter is associated with) in member fields. It also supports two different ways to map Swing events to platform-independent events:

• If a FormEventManager is specified, its fireEvent() method is invoked. This automatically calls all listeners registered for specific or all components.
• It is also possible to map the Swing-specific events to a specific event listener which has to be passed to the constructor. In this case only this listener is invoked.

Version:

$Id: SwingEventAdapter.java 205 2012-01-29 18:29:57Z oheger $

Author:

Oliver Heger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SwingEventAdapter(FormEventListener l, ComponentHandler<?> handler, String name) Creates a new instance of SwingEventAdapter that serves a specific event listener.
protected	SwingEventAdapter(FormEventManager eventManager, ComponentHandler<?> handler, String name) Creates a new instance of SwingEventAdapter that uses the FormEventManager to broadcast events.

Method Summary

Modifier and Type	Method and Description
protected void	fireEvent(FormEvent event) Notifies the event manager about a new event.
FormEventListener	getEventListener() Returns the event listener this adapter is associated with.
FormEventManager	getEventManager() Returns a reference to the form event manager.
ComponentHandler<?>	getHandler() Returns a reference to the associated component handler.
protected abstract FormListenerType	getListenerType() Returns the event listener type used by this adapter.
String	getName() Returns the name of the component this adapter is registered at.

Methods inherited from class java.lang.Object

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

Constructor Detail

SwingEventAdapter

protected SwingEventAdapter(FormEventManager eventManager,
                            ComponentHandler<?> handler,
                            String name)

Creates a new instance of SwingEventAdapter that uses the FormEventManager to broadcast events.

Parameters:

eventManager - the event manager (must not be null)

handler - the component handler

name - the component's name

Throws:

IllegalArgumentException - if the FormEventManager is null

SwingEventAdapter

protected SwingEventAdapter(FormEventListener l,
                            ComponentHandler<?> handler,
                            String name)

Creates a new instance of SwingEventAdapter that serves a specific event listener.

Parameters:

l - the event listener (must not be null)

handler - the ComponentHandler

name - the name of the component

Throws:

IllegalArgumentException - if the event listener is null

Method Detail

getEventManager

public FormEventManager getEventManager()

Returns a reference to the form event manager. This can be null if this adapter is not associated with the event manager.

Returns:

the event manager

getEventListener

public FormEventListener getEventListener()

Returns the event listener this adapter is associated with. This can be null if this listener is not associated with an event listener.

Returns:

the event listener

getHandler

public ComponentHandler<?> getHandler()

Returns a reference to the associated component handler.

Returns:

the component handler

getName

public String getName()

Returns the name of the component this adapter is registered at.

Returns:

the component name

fireEvent

protected void fireEvent(FormEvent event)

Notifies the event manager about a new event. With this method an event can be sent to all registered listeners.

Parameters:

event - the event to send

getListenerType

protected abstract FormListenerType getListenerType()

Returns the event listener type used by this adapter. This method must be defined in concrete sub classes.

Returns:

the event listener type