org.havi.ui.HEventMulticaster Maven / Gradle / Ivy
package org.havi.ui;
/*
* Copyright 2000-2003 by HAVi, Inc. Java is a trademark of Sun
* Microsystems, Inc. All rights reserved.
*/
import java.awt.event.ActionEvent;
import java.awt.event.FocusEvent;
import java.awt.event.KeyEvent;
import java.awt.event.WindowEvent;
import java.awt.event.WindowListener;
import java.util.EventListener;
import org.davic.resources.ResourceStatusEvent;
import org.davic.resources.ResourceStatusListener;
import org.havi.ui.event.HActionListener;
import org.havi.ui.event.HAdjustmentEvent;
import org.havi.ui.event.HAdjustmentListener;
import org.havi.ui.event.HBackgroundImageEvent;
import org.havi.ui.event.HBackgroundImageListener;
import org.havi.ui.event.HFocusListener;
import org.havi.ui.event.HItemEvent;
import org.havi.ui.event.HItemListener;
import org.havi.ui.event.HKeyListener;
import org.havi.ui.event.HScreenConfigurationEvent;
import org.havi.ui.event.HScreenConfigurationListener;
import org.havi.ui.event.HScreenLocationModifiedEvent;
import org.havi.ui.event.HScreenLocationModifiedListener;
import org.havi.ui.event.HTextEvent;
import org.havi.ui.event.HTextListener;
/**
The HEventMulticaster class is intended to assist
platform or subclass implementers with the handling of HAVi
events. Implementations are not required to use this class to
dispatch HAVi events. Applications should not extend the
HEventMulticaster class and implementations are not required to
behave correctly if an application does extend this class. If an
extended multicaster is desired, AWTEventMulticaster should
be used rather than HEventMulticaster
The HEventMulticaster class
is intended to handle event dispatching for the following
HAVi events:
- {@link org.havi.ui.event.HBackgroundImageEvent HBackgroundImageEvent}
- {@link org.havi.ui.event.HScreenConfigurationEvent
HScreenConfigurationEvent}
- {@link org.havi.ui.event.HScreenLocationModifiedEvent
HScreenLocationModifiedEvent}
- {@link org.havi.ui.event.HActionEvent HActionEvent}
- {@link org.havi.ui.event.HFocusEvent HFocusEvent}
- {@link org.havi.ui.event.HItemEvent HItemEvent}
- {@link org.havi.ui.event.HTextEvent HTextEvent}
- {@link org.havi.ui.event.HKeyEvent HKeyEvent}
- {@link org.havi.ui.event.HAdjustmentEvent HAdjustmentEvent}
- java.awt.event.WindowEvent
- org.davic.resources.ResourceStatusEvent
It is an implementation option for this class to insert other
classes in the inheritance tree
(for example java.awt.AWTEventMulticaster). It is allowed that this
may result in
HEventMulticaster inheriting additional methods beyond those
specified here. If this class does extend
java.awt.AWTEventMulticaster,
it is allowed for the fields defined in this class to be inherited
from that parent class.
Note: the org.davic.resources.ResourceStatusListener specification does not require EventListener
to be present. In a HAVi UI implementation, ResourceStatusListener shall extend EventListener.
The parameters to the constructors are as follows, in cases where
parameters are not used, then the constructor should use the default
values.
Default parameter values exposed in the constructors
Parameter Description Default value
Set method Get method None.
Default parameter values not exposed in the constructors
Description Default value Set method
Get method None.
@see org.havi.ui.event.HBackgroundImageListener
@see org.havi.ui.event.HScreenConfigurationListener
@see org.havi.ui.event.HScreenLocationModifiedListener
@see org.havi.ui.event.HActionListener
@see org.havi.ui.event.HAdjustmentListener
@see org.havi.ui.event.HFocusListener
@see org.havi.ui.event.HItemListener
@see org.havi.ui.event.HTextListener
@see org.havi.ui.event.HKeyListener
@see java.awt.event.WindowListener
@see org.davic.resources.ResourceStatusListener
*/
public class HEventMulticaster implements
HBackgroundImageListener, HScreenConfigurationListener, HScreenLocationModifiedListener,
java.awt.event.WindowListener, HActionListener, HAdjustmentListener, HFocusListener, HItemListener,
HTextListener, HKeyListener, ResourceStatusListener
{
protected final EventListener a;
protected final EventListener b;
/**
* Creates an event multicaster instance which chains listener-a
* with listener-b. The parameters a and b passed to the
* constructor shall be used to populate the fields a and b of the
* instance.
* @param a listener-a
* @param b listener-b
*/
protected HEventMulticaster(EventListener a, EventListener b)
{this.a = a; this.b = b;}
/**
* Removes a listener from this multicaster and returns the
* result.
* @param oldl the listener to be removed
*/
protected EventListener remove(EventListener oldl) {
return null;
}
/**
* Returns the resulting multicast listener from adding listener-a
* and listener-b together.
* If listener-a is null, it returns listener-b;
* If listener-b is null, it returns listener-a
* If neither are null, then it creates and returns
* a new HEventMulticaster instance which chains a with b.
* @param a event listener-a
* @param b event listener-b
*/
protected static EventListener addInternal(EventListener a, EventListener b) {
return null;
}
/**
* Returns the resulting multicast listener after removing the
* old listener from listener-l.
* If listener-l equals the old listener OR listener-l is null,
* returns null.
* Else if listener-l is an instance of HEventMulticaster,
* then it removes the old listener from it.
* Else, returns listener l.
* @param l the listener being removed from
* @param oldl the listener being removed
*/
protected static EventListener removeInternal(EventListener l, EventListener oldl) {
return null;
}
/**
* Adds {@link org.havi.ui.event.HBackgroundImageListener HBackgroundImageListener}-a with {@link org.havi.ui.event.HBackgroundImageListener HBackgroundImageListener}-b and
* returns the resulting multicast listener.
* @param a HBackgroundImageListener-a
* @param b HBackgroundImageListener-b
*/
public static HBackgroundImageListener add(HBackgroundImageListener a, HBackgroundImageListener b)
{
return null;
}
/**
* Removes the old {@link org.havi.ui.event.HBackgroundImageListener HBackgroundImageListener} from {@link org.havi.ui.event.HBackgroundImageListener HBackgroundImageListener}-l and
* returns the resulting multicast listener.
* @param l HBackgroundImageListener-l
* @param oldl the HBackgroundImageListener being removed
*/
public static HBackgroundImageListener remove(HBackgroundImageListener l, HBackgroundImageListener oldl) {
return null;
}
/**
* Adds WindowListener-a with WindowListener-b and
* returns the resulting multicast listener.
* @param a WindowListener-a
* @param b WindowListener-b
*/
public static WindowListener add(WindowListener a, WindowListener b)
{
return null;
}
/**
* Removes the old WindowListener from WindowListener-l and
* returns the resulting multicast listener.
* @param l WindowListener-l
* @param oldl the WindowListener being removed
*/
public static WindowListener remove(WindowListener l, WindowListener oldl)
{
return null;
}
/**
* Adds {@link org.havi.ui.event.HScreenConfigurationListener HScreenConfigurationListener}-a with {@link org.havi.ui.event.HScreenConfigurationListener HScreenConfigurationListener}-b and
* returns the resulting multicast listener.
* @param a HScreenConfigurationListener-a
* @param b HScreenConfigurationListener-b
*/
public static HScreenConfigurationListener add(HScreenConfigurationListener a, HScreenConfigurationListener b)
{
return null;
}
/**
* Adds {@link org.havi.ui.event.HScreenConfigurationListener HScreenConfigurationListener}-a with
* {@link org.havi.ui.event.HScreenConfigurationListener HScreenConfigurationListener}-b,
* which is notified when
* the {@link org.havi.ui.HScreenDevice HScreenDevice's} configuration is modified so that it is no longer compatible with the
* {@link org.havi.ui.HScreenConfigTemplate HScreenConfigTemplate} tb.
* It returns the resulting multicast listener.
* @param a HScreenConfigurationListener-a
* @param b HScreenConfigurationListener-b
* @param tb HScreenConfigTemplate associated with HScreenConfigurationListener-b
*/
public static HScreenConfigurationListener add(HScreenConfigurationListener a, HScreenConfigurationListener b, HScreenConfigTemplate tb)
{
return null;
}
/**
* Removes the old {@link org.havi.ui.event.HScreenConfigurationListener HScreenConfigurationListener} from {@link org.havi.ui.event.HScreenConfigurationListener HScreenConfigurationListener}-l and
* returns the resulting multicast listener.
* @param l HScreenConfigurationListener-l
* @param oldl the HScreenConfigurationListener being removed
*/
public static HScreenConfigurationListener remove(HScreenConfigurationListener l, HScreenConfigurationListener oldl) {
return null;
}
/**
* Adds {@link org.havi.ui.event.HScreenLocationModifiedListener HScreenLocationModifiedListener}-a with {@link org.havi.ui.event.HScreenLocationModifiedListener HScreenLocationModifiedListener}-b and
* returns the resulting multicast listener.
* @param a HScreenLocationModifiedListener-a
* @param b HScreenLocationModifiedListener-b
*/
public static HScreenLocationModifiedListener add(HScreenLocationModifiedListener a, HScreenLocationModifiedListener b)
{
return null;
}
/**
* Removes the old {@link org.havi.ui.event.HScreenLocationModifiedListener HScreenLocationModifiedListener} from {@link org.havi.ui.event.HScreenLocationModifiedListener HScreenLocationModifiedListener}-l and
* returns the resulting multicast listener.
* @param l HScreenLocationModifiedListener-l
* @param oldl the HScreenLocationModifiedListener being removed
*/
public static HScreenLocationModifiedListener remove(HScreenLocationModifiedListener l, HScreenLocationModifiedListener oldl) {
return null;
}
/**
* Handles the {@link org.havi.ui.event.HBackgroundImageEvent HBackgroundImageEvent} by invoking the
* {@link org.havi.ui.event.HBackgroundImageListener#imageLoaded imageLoaded} methods on listener-a and listener-b.
* @param e the HBackgroundImageEvent event
*/
public void imageLoaded(HBackgroundImageEvent e){
}
/**
* Handles the {@link org.havi.ui.event.HBackgroundImageEvent HBackgroundImageEvent} by invoking the
* {@link org.havi.ui.event.HBackgroundImageListener#imageLoadFailed imageLoadFailed} methods on listener-a and listener-b.
* @param e the HBackgroundImageEvent event
*/
public void imageLoadFailed(HBackgroundImageEvent e){
}
/**
* Handles the {@link org.havi.ui.event.HScreenConfigurationEvent HScreenConfigurationEvent} by invoking the
* {@link org.havi.ui.event.HScreenConfigurationListener#report report} methods on listener-a and listener-b.
* @param e the HScreenConfigurationEvent event
*/
public void report(HScreenConfigurationEvent e){
}
/**
* Handles the {@link org.havi.ui.event.HScreenLocationModifiedEvent HScreenLocationModifiedEvent} by invoking the
* {@link org.havi.ui.event.HScreenLocationModifiedListener#report report} methods on listener-a and listener-b.
* @param e the HScreenLocationModifiedEvent event
*/
public void report(HScreenLocationModifiedEvent e){
}
/**
* Handles the windowOpened event by invoking the
* windowOpened methods on listener-a and listener-b.
* @param e the window event
*/
public void windowOpened(WindowEvent e) {
}
/**
* Handles the windowClosing event by invoking the
* windowClosing methods on listener-a and listener-b.
* @param e the window event
*/
public void windowClosing(WindowEvent e) {
}
/**
* Handles the windowClosed event by invoking the
* windowClosed methods on listener-a and listener-b.
* @param e the window event
*/
public void windowClosed(WindowEvent e) {
}
/**
* Handles the windowIconified event by invoking the
* windowIconified methods on listener-a and listener-b.
* @param e the window event
*/
public void windowIconified(WindowEvent e) {
}
/**
* Handles the windowDeiconified event by invoking the
* windowDeiconified methods on listener-a and listener-b.
* @param e the window event
*/
public void windowDeiconified(WindowEvent e) {
}
/**
* Handles the windowActivated event by invoking the
* windowActivated methods on listener-a and listener-b.
* @param e the window event
*/
public void windowActivated(WindowEvent e) {
}
/**
* Handles the windowDeactivated event by invoking the
* windowDeactivated methods on listener-a and listener-b.
* @param e the window event
*/
public void windowDeactivated(WindowEvent e) {
}
/**
* Handles the ActionEvent by invoking the
* actionPerformed methods on listener-a and listener-b.
* @param e the ActionEvent event
*/
public void actionPerformed(ActionEvent e) {}
/**
* Handles the FocusEvent by invoking the
* focusLost methods on listener-a and listener-b.
* @param e the FocusEvent event
*/
public void focusLost(FocusEvent e){}
/**
* Handles the FocusEvent by invoking the
* focusGained methods on listener-a and listener-b.
* @param e the FocusEvent event
*/
public void focusGained(FocusEvent e) {}
/**
* Handles the {@link org.havi.ui.event.HAdjustmentEvent HAdjustmentEvent} by invoking the
* {@link org.havi.ui.event.HAdjustmentListener#valueChanged valueChanged} methods on listener-a and listener-b.
* @param e the HAdjustmentEvent event
*/
public void valueChanged(HAdjustmentEvent e){}
/**
* Handles the {@link org.havi.ui.event.HItemEvent HItemEvent} by invoking the
* {@link org.havi.ui.event.HItemListener#selectionChanged selectionChanged} methods on listener-a and listener-b.
* @param e the HItemEvent event
*/
public void selectionChanged(HItemEvent e) {}
/**
* Handles the {@link org.havi.ui.event.HItemEvent HItemEvent} by invoking the
* {@link org.havi.ui.event.HItemListener#currentItemChanged currentItemChanged} methods on listener-a and listener-b.
* @param e the HItemEvent event
*/
public void currentItemChanged(HItemEvent e) {}
/**
* Handles the {@link org.havi.ui.event.HTextEvent HTextEvent} by invoking the
* {@link org.havi.ui.event.HTextListener#textChanged textChanged} methods on listener-a and listener-b.
* @param e the HTextEvent event
*/
public void textChanged(HTextEvent e){}
/**
* Handles the {@link org.havi.ui.event.HTextEvent HTextEvent} by invoking the
* {@link org.havi.ui.event.HTextListener#caretMoved caretMoved} methods on listener-a and listener-b.
* @param e the HTextEvent event
*/
public void caretMoved(HTextEvent e){}
/**
* Handles the {@link org.havi.ui.event.HKeyEvent HKeyEvent} by invoking the
* {@link org.havi.ui.event.HKeyListener#keyTyped keyTyped} methods on listener-a and listener-b.
* @param e the HKeyEvent event
*/
public void keyTyped(KeyEvent e)
{}
/**
* Handles the {@link org.havi.ui.event.HKeyEvent HKeyEvent} by invoking the
* {@link org.havi.ui.event.HKeyListener#keyPressed keyPressed} methods on listener-a and listener-b.
* @param e the HKeyEvent event
*/
public void keyPressed(KeyEvent e)
{}
/**
* Handles the {@link org.havi.ui.event.HKeyEvent HKeyEvent} by invoking the
* {@link org.havi.ui.event.HKeyListener#keyReleased keyReleased} methods on listener-a and listener-b.
* @param e the HKeyEvent event
*/
public void keyReleased(KeyEvent e)
{}
/**
* Adds {@link org.havi.ui.event.HTextListener HTextListener}-a with {@link org.havi.ui.event.HTextListener HTextListener}-b and
* returns the resulting multicast listener.
* @param a HTextListener-a
* @param b HTextListener-b
*/
public static HTextListener add(HTextListener a, HTextListener b)
{
return null;
}
/**
* Removes the old {@link org.havi.ui.event.HTextListener HTextListener} from {@link org.havi.ui.event.HTextListener HTextListener}-l and
* returns the resulting multicast listener.
* @param l HTextListener-l
* @param oldl the HTextListener being removed
*/
public static HTextListener remove(HTextListener l, HTextListener oldl)
{
return null;
}
/**
* Adds {@link org.havi.ui.event.HItemListener HItemListener}-a with {@link org.havi.ui.event.HItemListener HItemListener}-b and
* returns the resulting multicast listener.
* @param a HItemListener-a
* @param b HItemListener-b
*/
public static HItemListener add(HItemListener a, HItemListener b)
{
return null;
}
/**
* Removes the old {@link org.havi.ui.event.HItemListener HItemListener} from {@link org.havi.ui.event.HItemListener HItemListener}-l and
* returns the resulting multicast listener.
* @param l HItemListener-l
* @param oldl the HItemListener being removed
*/
public static HItemListener remove(HItemListener l, HItemListener oldl)
{
return null;
}
/**
* Adds {@link org.havi.ui.event.HFocusListener HFocusListener}-a with {@link org.havi.ui.event.HFocusListener HFocusListener}-b and
* returns the resulting multicast listener.
* @param a HFocusListener-a
* @param b HFocusListener-b
*/
public static HFocusListener add(HFocusListener a, HFocusListener b)
{
return null;
}
/**
* Removes the old {@link org.havi.ui.event.HFocusListener HFocusListener} from {@link org.havi.ui.event.HFocusListener HFocusListener}-l and
* returns the resulting multicast listener.
* @param l HFocusListener-l
* @param oldl the HFocusListener being removed
*/
public static HFocusListener remove(HFocusListener l, HFocusListener oldl)
{
return null;
}
/**
* Adds {@link org.havi.ui.event.HAdjustmentListener HAdjustmentListener}-a with {@link org.havi.ui.event.HAdjustmentListener HAdjustmentListener}-b and
* returns the resulting multicast listener.
* @param a HAdjustmentListener-a
* @param b HAdjustmentListener-b
*/
public static HAdjustmentListener add(HAdjustmentListener a, HAdjustmentListener b)
{
return null;
}
/**
* Removes the old {@link org.havi.ui.event.HAdjustmentListener HAdjustmentListener} from {@link org.havi.ui.event.HAdjustmentListener HAdjustmentListener}-l and
* returns the resulting multicast listener.
* @param l HAdjustmentListener-l
* @param oldl the HAdjustmentListener being removed
*/
public static HAdjustmentListener remove(HAdjustmentListener l, HAdjustmentListener oldl)
{
return null;
}
/**
* Adds {@link org.havi.ui.event.HActionListener HActionListener}-a with {@link org.havi.ui.event.HActionListener HActionListener}-b and
* returns the resulting multicast listener.
* @param a HActionListener-a
* @param b HActionListener-b
*/
public static HActionListener add(HActionListener a, HActionListener b)
{
return null;
}
/**
* Removes the old {@link org.havi.ui.event.HActionListener HActionListener} from {@link org.havi.ui.event.HActionListener HActionListener}-l and
* returns the resulting multicast listener.
* @param l HActionListener-l
* @param oldl the HActionListener being removed
*/
public static HActionListener remove(HActionListener l, HActionListener oldl)
{
return null;
}
/**
* Adds {@link org.havi.ui.event.HKeyListener HKeyListener}-a with {@link org.havi.ui.event.HKeyListener HKeyListener}-b and
* returns the resulting multicast listener.
* @param a HKeyListener-a
* @param b HKeyListener-b
*/
public static HKeyListener add(HKeyListener a, HKeyListener b)
{
return null;
}
/**
* Removes the old {@link org.havi.ui.event.HKeyListener HKeyListener} from {@link org.havi.ui.event.HKeyListener HKeyListener}-l and
* returns the resulting multicast listener.
* @param l HKeyListener-l
* @param oldl the HKeyListener being removed
*/
public static HKeyListener remove(HKeyListener l, HKeyListener oldl)
{
return null;
}
/**
* Handles the ResourceStatusEvent by invoking the
* statusChanged methods on listener-a and listener-b.
* @param e the ResourceStatusEvent event
*/
public void statusChanged(ResourceStatusEvent e) {
}
/**
* Adds ResourceStatusListener-a with listener-b and
* returns the resulting multicast listener. In a HAVi UI implementation, ResourceStatusListener shall extend EventListener.
* @param a listener-a
* @param b listener-b
*/
public static ResourceStatusListener add(ResourceStatusListener a, ResourceStatusListener b) {
return null;
}
/**
* Removes the old ResourceStatusListener from ResourceStatusListener-l and
* returns the resulting multicast listener. In a HAVi UI implementation, ResourceStatusListener shall extend EventListener.
* @param l ResourceStatusListener-l
* @param oldl the ResourceStatusListener being removed
*/
public static ResourceStatusListener remove(ResourceStatusListener l, ResourceStatusListener oldl) {
return null;
}
}