net.sf.cuf.ui

Class SwingConnectionManager

java.lang.Object

net.sf.cuf.ui.SwingConnectionManager

All Implemented Interfaces:

ActionListener, FocusListener, PropertyChangeListener, EventListener, CaretListener, ChangeListener, DocumentListener, ListSelectionListener, TreeSelectionListener

public class SwingConnectionManager
extends Object
implements ActionListener, ChangeListener, ListSelectionListener, TreeSelectionListener, CaretListener, FocusListener, PropertyChangeListener, DocumentListener

The SwingConnectionManager singelton makes the Swing callback handling much more convenient.
Instead of bundeling all callbacks from the various widgets in the actionPerformed()/stateChanged()/valueChanged()/ focusGained()/focusLost()/propertyChange()/changedUpdate()/insertUpdate() removeUpdate() methods, and having a huge if()else()if() cascade inside that method, with SwingConnectionManager any method of a class that matches the

• void pMethodname(java.awt.event.ActionEvent) or
• void pMethodname(javax.swing.event.ChangeEvent) or
• void pMethodname(javax.swing.event.TreeSelectionEvent) or
• void pMethodname(javax.swing.event.ListSelectionEvent) or
• void pMethodname(javax.swing.event.CaretEvent) or
• void pMethodname(java.awt.event.FocusEvent) or
• void pMethodname(java.beans.PropertyChangeEvent) or
• void pMethodname(java.swing.event.DocumentEvent) or
• void pMethodname()

signature can be called. Currently SwingConnectionManager supports all Swing widgets that provide an ActionEvent callback: JComboBox, all Buttons (derived from AbstractButton), and all one line text fields (derived from JTextField). It also provides support for ChangeEvent callbacks coming from JSlider's or any Buttons (derived from AbstractButton), TreeSelectionEvent callbacks coming from JTree's, ListSelectionEvent callbacks coming from JTable's or JList's and CaretEvent callbacks coming from one line text fields (derived from JTextField).
As a special case, the SwingConnectionManager maps both the focusGained() as well as the focusLost() callbacks to a single method, because the delivered FocusEvent contains all needed information to distinguish between lost and gained focus.
Also as a special case the SwingConnectionManager maps all Document related callbacks to a singe method, again because the event contains all necessary information. To support JavaBeans, the SwingConnectionManager also supports propertyChange() callbacks.
SwingConnectionManager can be used completly stand alone, but it provides only "one half" of the dispatch work, that is the call back from a UI element to a business logic object.
For the other half, that one that maps from business logic objects to widgets, have a look at the SwingMapping or SwingXMLBuilder class.
FIXME: currently only one object can be registered for any given source, registering a second will silently remove the first.

Author:

Jürgen Zeller, jzeller@jzeller.eu

Method Summary

Methods

Modifier and Type	Method and Description
void	actionPerformed(ActionEvent pAction) This method is not part of the public API, it's internally used as the Swing callback method and forwards pAction to the registered objekt.
void	caretUpdate(CaretEvent pCaret) This method is not part of the public API, it's internally used as the Swing callback method and forwards pCaret to the registered objekt.
void	changedUpdate(DocumentEvent pDocumentEvent) This method is not part of the public API, it's internally used as the Swing callback method and forwards pFocus to the registered objekt.
static void	createActionConnection(AbstractButton pActionSource, Object pTarget, String pMethodName) This methods provides callback dispatching for all Swing buttons (derived from javax.swing.AbstractButton).
static void	createActionConnection(DispatcherAction pActionSource, Object pTarget, String pMethodName) This methods provides callback dispatching for the DispatcherAction.
static void	createActionConnection(JComboBox pActionSource, Object pTarget, String pMethodName) This methods provides callback dispatching for a Swing JComboBox.
static void	createActionConnection(JTextField pActionSource, Object pTarget, String pMethodName) This methods provides callback dispatching for all Swing one-line text fields (derived from javax.swing.JTextField).
static void	createCaretConnection(JTextComponent pCaretSource, Object pTarget, String pMethodName) This methods provides callback dispatching for all Swing one-line text fields (derived from JTextComponent).
static void	createChangeConnection(AbstractButton pChangeSource, Object pTarget, String pMethodName) This methods provides callback dispatching for all Swing buttons (derived from javax.swing.AbstractButton).
static void	createChangeConnection(JSlider pChangeSource, Object pTarget, String pMethodName) This methods provides callback dispatching for a Swing JSlider.
static void	createChangeConnection(JSpinner pChangeSource, Object pTarget, String pMethodName) This methods provides callback dispatching for a JSpinner.
static void	createChangeConnection(JTabbedPane pChangeSource, Object pTarget, String pMethodName) This methods provides callback dispatching for a JTabbedPane.
static void	createDocumentConnection(Document pDocumentSource, Object pTarget, String pMethodName) This methods provides callback dispatching for a Document.
static void	createDocumentConnection(JTextComponent pDocumentSource, Object pTarget, String pMethodName) This methods provides callback dispatching for the document of a Swing JTextComponent.
static void	createFocusConnection(JComponent pFocusSource, Object pTarget, String pMethodName) This methods provides focus callback dispatching for all JComponent's.
static void	createListSelectionConnection(JList pListSelectionSource, Object pTarget, String pMethodName) This methods provides callback dispatching for JList's.
static void	createListSelectionConnection(JTable pListSelectionSource, Object pTarget, String pMethodName) This methods provides callback dispatching for JTable's.
static void	createPropertyChangeConnection(JComponent pPropertyChangeSource, Object pTarget, String pMethodName) This methods provides property change callback dispatching for all JComponent's.
static void	createTreeSelectionConnection(JTree pTreeSelectionSource, Object pTarget, String pMethodName) This methods provides callback dispatching for JTree's.
void	focusGained(FocusEvent pFocus) This method is not part of the public API, it's internally used as the Swing callback method and forwards pFocus to the registered objekt.
void	focusLost(FocusEvent pFocus) This method is not part of the public API, it's internally used as the Swing callback method and forwards pFocus to the registered objekt.
void	insertUpdate(DocumentEvent pDocumentEvent) This method is not part of the public API, it's internally used as the Swing callback method and forwards pFocus to the registered objekt.
void	propertyChange(PropertyChangeEvent pPropertyChange) This method is not part of the public API, it's internally used as the Swing callback method and forwards pFocus to the registered objekt.
static void	removeConnection(Object pTarget) This methods removes all mappings pointing to the target object.
void	removeUpdate(DocumentEvent pDocumentEvent) This method is not part of the public API, it's internally used as the Swing callback method and forwards pFocus to the registered objekt.
void	stateChanged(ChangeEvent pChange) This method is not part of the public API, it's internally used as the Swing callback method and forwards pChange to the registered objekt.
void	valueChanged(ListSelectionEvent pListSelection) This method is not part of the public API, it's internally used as the Swing callback method and forwards pListSelection to the registered objekt.
void	valueChanged(TreeSelectionEvent pTreeSelection) This method is not part of the public API, it's internally used as the Swing callback method and forwards pTreeSelection to the registered objekt.

Methods inherited from class java.lang.Object

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

Method Detail

createActionConnection

public static void createActionConnection(JComboBox pActionSource,
                          Object pTarget,
                          String pMethodName)

This methods provides callback dispatching for a Swing JComboBox.

Parameters:

pActionSource - the combo box instance triggering the callback

pTarget - the target for the callback

pMethodName - the method of pTarget we should call back

Throws:

IllegalArgumentException - if pActionSource or pTarget or pMethodName is null or pMethodName is not a method of pTarget with the right signature

createActionConnection

public static void createActionConnection(JTextField pActionSource,
                          Object pTarget,
                          String pMethodName)

This methods provides callback dispatching for all Swing one-line text fields (derived from javax.swing.JTextField).

Parameters:

pActionSource - the text field instance triggering the callback

pTarget - the target for the callback

pMethodName - the method of pTarget we should call back

Throws:

IllegalArgumentException - if pActionSource or pTarget or pMethodName is null or pMethodName is not a method of pTarget with the right signature

createActionConnection

public static void createActionConnection(AbstractButton pActionSource,
                          Object pTarget,
                          String pMethodName)

This methods provides callback dispatching for all Swing buttons (derived from javax.swing.AbstractButton).

Parameters:

pActionSource - the button instance triggering the callback

pTarget - the target for the callback

pMethodName - the method of pTarget we should call back

Throws:

IllegalArgumentException - if pActionSource or pTarget or pMethodName is null or pMethodName is not a method of pTarget with the right signature

createActionConnection

public static void createActionConnection(DispatcherAction pActionSource,
                          Object pTarget,
                          String pMethodName)

This methods provides callback dispatching for the DispatcherAction. If the DispatcherAction is not needed, this method can safely be deleted.

Parameters:

pActionSource - the DispatcherAction instance triggering the callback

pTarget - the target for the callback

pMethodName - the method of pTarget we should call back

Throws:

IllegalArgumentException - if pActionSource or pTarget or pMethodName is null or pMethodName is not a method of pTarget with the right signature

createChangeConnection

public static void createChangeConnection(JSlider pChangeSource,
                          Object pTarget,
                          String pMethodName)

This methods provides callback dispatching for a Swing JSlider.

Parameters:

pChangeSource - the slider instance triggering the callback

pTarget - the target for the callback

pMethodName - the method of pTarget we should call back

Throws:

IllegalArgumentException - if pChangeSource or pTarget or pMethodName is null or pMethodName is not a method of pTarget with the right signature

createChangeConnection

public static void createChangeConnection(AbstractButton pChangeSource,
                          Object pTarget,
                          String pMethodName)

This methods provides callback dispatching for all Swing buttons (derived from javax.swing.AbstractButton).

Parameters:

pChangeSource - the button instance triggering the callback

pTarget - the target for the callback

pMethodName - the method of pTarget we should call back

Throws:

IllegalArgumentException - if pChangeSource or pTarget or pMethodName is null or pMethodName is not a method of pTarget with the right signature

createChangeConnection

public static void createChangeConnection(JTabbedPane pChangeSource,
                          Object pTarget,
                          String pMethodName)

This methods provides callback dispatching for a JTabbedPane.

Parameters:

pChangeSource - the tabbed pane instance triggering the callback

pTarget - the target for the callback

pMethodName - the method of pTarget we should call back

Throws:

IllegalArgumentException - if pChangeSource or pTarget or pMethodName is null or pMethodName is not a method of pTarget with the right signature

createChangeConnection

public static void createChangeConnection(JSpinner pChangeSource,
                          Object pTarget,
                          String pMethodName)

This methods provides callback dispatching for a JSpinner.

Parameters:

pChangeSource - the spinner instance triggering the callback

pTarget - the target for the callback

pMethodName - the method of pTarget we should call back

Throws:

IllegalArgumentException - if pChangeSource or pTarget or pMethodName is null or pMethodName is not a method of pTarget with the right signature

createTreeSelectionConnection

public static void createTreeSelectionConnection(JTree pTreeSelectionSource,
                                 Object pTarget,
                                 String pMethodName)

This methods provides callback dispatching for JTree's.

Parameters:

pTreeSelectionSource - the JTree instance triggering the callback

pTarget - the target for the callback

pMethodName - the method of pTarget we should call back

Throws:

IllegalArgumentException - if pTreeSelectionSource or pTarget or pMethodName is null or pMethodName is not a method of pTarget with the right signature

createListSelectionConnection

public static void createListSelectionConnection(JList pListSelectionSource,
                                 Object pTarget,
                                 String pMethodName)

This methods provides callback dispatching for JList's.

Parameters:

pListSelectionSource - the JList instance triggering the callback

pTarget - the target for the callback

pMethodName - the method of pTarget we should call back

Throws:

IllegalArgumentException - if pListSelectionSource or pTarget or pMethodName is null or pMethodName is not a method of pTarget with the right signature

createListSelectionConnection

public static void createListSelectionConnection(JTable pListSelectionSource,
                                 Object pTarget,
                                 String pMethodName)

This methods provides callback dispatching for JTable's.

Parameters:

pListSelectionSource - the JTable instance triggering the callback

pTarget - the target for the callback

pMethodName - the method of pTarget we should call back

Throws:

IllegalArgumentException - if pListSelectionSource or pTarget or pMethodName is null or pMethodName is not a method of pTarget with the right signature

createCaretConnection

public static void createCaretConnection(JTextComponent pCaretSource,
                         Object pTarget,
                         String pMethodName)

This methods provides callback dispatching for all Swing one-line text fields (derived from JTextComponent).

Parameters:

pCaretSource - the text field instance triggering the callback

pTarget - the target for the callback

pMethodName - the method of pTarget we should call back

Throws:

IllegalArgumentException - if pCaretSource or pTarget or pMethodName is null or pMethodName is not a method of pTarget with the right signature

createFocusConnection

public static void createFocusConnection(JComponent pFocusSource,
                         Object pTarget,
                         String pMethodName)

This methods provides focus callback dispatching for all JComponent's.

Parameters:

pFocusSource - the Swing component triggering the callback

pTarget - the target for the callback

pMethodName - the method of pTarget we should call back

Throws:

IllegalArgumentException - if pFocusSource or pTarget or pMethodName is null or pMethodName is not a method of pTarget with the right signature

createPropertyChangeConnection

public static void createPropertyChangeConnection(JComponent pPropertyChangeSource,
                                  Object pTarget,
                                  String pMethodName)

This methods provides property change callback dispatching for all JComponent's.

Parameters:

pPropertyChangeSource - the Swing component triggering the callback

pTarget - the target for the callback

pMethodName - the method of pTarget we should call back

Throws:

IllegalArgumentException - if pPropertyChangeSource or pTarget or pMethodName is null or pMethodName is not a method of pTarget with the right signature

createDocumentConnection

public static void createDocumentConnection(JTextComponent pDocumentSource,
                            Object pTarget,
                            String pMethodName)

This methods provides callback dispatching for the document of a Swing JTextComponent.

Parameters:

pDocumentSource - the text component containing the document that will trigger the callback

pTarget - the target for the callback

pMethodName - the method of pTarget we should call back

Throws:

IllegalArgumentException - if pChangeSource or pTarget or pMethodName is null or pMethodName is not a method of pTarget with the right signature

createDocumentConnection

public static void createDocumentConnection(Document pDocumentSource,
                            Object pTarget,
                            String pMethodName)

This methods provides callback dispatching for a Document.

Parameters:

pDocumentSource - the text component containing the document that will trigger the callback

pTarget - the target for the callback

pMethodName - the method of pTarget we should call back

Throws:

IllegalArgumentException - if pChangeSource or pTarget or pMethodName is null or pMethodName is not a method of pTarget with the right signature

removeConnection

public static void removeConnection(Object pTarget)

This methods removes all mappings pointing to the target object. If there is no connection for this target, nothing happens.

Parameters:

pTarget - the target all mappings should be removed from

actionPerformed

public void actionPerformed(ActionEvent pAction)

This method is not part of the public API, it's internally used as the Swing callback method and forwards pAction to the registered objekt.

Specified by:

actionPerformed in interface ActionListener

Parameters:

pAction - event describing the action

stateChanged

public void stateChanged(ChangeEvent pChange)

This method is not part of the public API, it's internally used as the Swing callback method and forwards pChange to the registered objekt.

Specified by:

stateChanged in interface ChangeListener

Parameters:

pChange - event describing the change

valueChanged

public void valueChanged(TreeSelectionEvent pTreeSelection)

This method is not part of the public API, it's internally used as the Swing callback method and forwards pTreeSelection to the registered objekt.

Specified by:

valueChanged in interface TreeSelectionListener

Parameters:

pTreeSelection - event describing the new tree selection

valueChanged

public void valueChanged(ListSelectionEvent pListSelection)

This method is not part of the public API, it's internally used as the Swing callback method and forwards pListSelection to the registered objekt.

Specified by:

valueChanged in interface ListSelectionListener

Parameters:

pListSelection - event describing the new list selection

caretUpdate

public void caretUpdate(CaretEvent pCaret)

This method is not part of the public API, it's internally used as the Swing callback method and forwards pCaret to the registered objekt.

Specified by:

caretUpdate in interface CaretListener

Parameters:

pCaret - event describing the new caret position

focusGained

public void focusGained(FocusEvent pFocus)

This method is not part of the public API, it's internally used as the Swing callback method and forwards pFocus to the registered objekt.

Specified by:

focusGained in interface FocusListener

Parameters:

pFocus - event describing the new focus situation

focusLost

public void focusLost(FocusEvent pFocus)

This method is not part of the public API, it's internally used as the Swing callback method and forwards pFocus to the registered objekt.

Specified by:

focusLost in interface FocusListener

Parameters:

pFocus - event describing the new focus situation

propertyChange

public void propertyChange(PropertyChangeEvent pPropertyChange)

This method is not part of the public API, it's internally used as the Swing callback method and forwards pFocus to the registered objekt.

Specified by:

propertyChange in interface PropertyChangeListener

Parameters:

pPropertyChange - event describing the new property situation

insertUpdate

public void insertUpdate(DocumentEvent pDocumentEvent)

This method is not part of the public API, it's internally used as the Swing callback method and forwards pFocus to the registered objekt.

Specified by:

insertUpdate in interface DocumentListener

Parameters:

pDocumentEvent - event describing the new document situation

removeUpdate

public void removeUpdate(DocumentEvent pDocumentEvent)

This method is not part of the public API, it's internally used as the Swing callback method and forwards pFocus to the registered objekt.

Specified by:

removeUpdate in interface DocumentListener

Parameters:

pDocumentEvent - event describing the new document situation

changedUpdate

public void changedUpdate(DocumentEvent pDocumentEvent)

This method is not part of the public API, it's internally used as the Swing callback method and forwards pFocus to the registered objekt.

Specified by:

changedUpdate in interface DocumentListener

Parameters:

pDocumentEvent - event describing the new document situation