State.java

// **********************************************************************
// 
// <copyright>
// 
//  BBN Technologies
//  10 Moulton Street
//  Cambridge, MA 02138
//  (617) 873-8000
// 
//  Copyright (C) BBNT Solutions LLC. All rights reserved.
// 
// </copyright>
// **********************************************************************
// 
// $Source: /cvs/distapps/openmap/src/openmap/com/bbn/openmap/layer/util/stateMachine/State.java,v $
// $RCSfile: State.java,v $
// $Revision: 1.4 $
// $Date: 2005/08/10 22:19:45 $
// $Author: dietrick $
// 
// **********************************************************************

package com.bbn.openmap.util.stateMachine;

import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.AdjustmentEvent;
import java.awt.event.AdjustmentListener;
import java.awt.event.ComponentEvent;
import java.awt.event.ComponentListener;
import java.awt.event.ContainerEvent;
import java.awt.event.ContainerListener;
import java.awt.event.FocusEvent;
import java.awt.event.FocusListener;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.awt.event.KeyEvent;
import java.awt.event.KeyListener;
import java.awt.event.MouseEvent;
import java.awt.event.TextEvent;
import java.awt.event.TextListener;
import java.awt.event.WindowEvent;
import java.awt.event.WindowListener;

import com.bbn.openmap.Environment;
import com.bbn.openmap.I18n;
import com.bbn.openmap.event.MapMouseListener;

/**
 * The state is intended to be a abstract juncture in a pattern of
 * events. The idea is that for a given state, an event will call a
 * unique response. This class lets you define this juncture, and can
 * be used as a Java adapter to define only the listener responses you
 * care about. The state, as defined in your implementation, can reset
 * the StateMachine to it's new state after it responds to an event.
 * <P>
 * 
 * Since this state machine can be used in OpenMap, the
 * Mouse/MouseMotion Listeners are MapMouseListeners. This is to let
 * OpenMap know not to send the result on to other layers that like to
 * hear about events. This State class has a setting on how you want
 * the unused MapMouseListener functions to respond to events. The
 * default is false, and this means that other layers will have a
 * chance to respond to events. If you want other layer's event
 * reception to pause a little, set the mapMouseListenerResponse to
 * true.
 */
public abstract class State implements ActionListener, AdjustmentListener,
        ComponentListener, ContainerListener, FocusListener, ItemListener,
        KeyListener, MapMouseListener, TextListener, WindowListener {

    /** The default response for the MapMouseListener methods. */
    boolean mapMouseListenerResponse = false;

    /** To read local settings */
    protected I18n i18n = Environment.getI18n();

    /**
     * Set the MapMouseListener method default response value. If
     * value is true, other layers on the map will not receive mouse
     * events.
     */
    public void setMapMouseListenerResponse(boolean value) {
        mapMouseListenerResponse = value;
    }

    /**
     * Get the value of the default response to MapMouseListener
     * methods.
     */
    public boolean getMapMouseListenerResponse() {
        return mapMouseListenerResponse;
    }

    // / ActionListener interface
    public void actionPerformed(ActionEvent e) {}

    // / AdjustmentListener interface
    public void adjustmentValueChanged(AdjustmentEvent e) {}

    // / ComponentListener interface
    public void componentResized(ComponentEvent e) {}

    public void componentMoved(ComponentEvent e) {}

    public void componentShown(ComponentEvent e) {}

    public void componentHidden(ComponentEvent e) {}

    // / ContainerListener interface
    public void componentAdded(ContainerEvent e) {}

    public void componentRemoved(ContainerEvent e) {}

    // / FocusListener interface
    public void focusGained(FocusEvent e) {}

    public void focusLost(FocusEvent e) {}

    // / ItemListener interface
    public void itemStateChanged(ItemEvent e) {}

    // / KeyListener interface
    public void keyTyped(KeyEvent e) {}

    public void keyPressed(KeyEvent e) {}

    public void keyReleased(KeyEvent e) {}

    // / MapMouseListener
    public String[] getMouseModeServiceList() {
        return null;
    }

    public boolean mousePressed(MouseEvent e) {
        return mapMouseListenerResponse;
    }

    public boolean mouseReleased(MouseEvent e) {
        return mapMouseListenerResponse;
    }

    public boolean mouseClicked(MouseEvent e) {
        return mapMouseListenerResponse;
    }

    public void mouseEntered(MouseEvent e) {}

    public void mouseExited(MouseEvent e) {}

    public boolean mouseDragged(MouseEvent e) {
        return mapMouseListenerResponse;
    }

    public boolean mouseMoved(MouseEvent e) {
        return mapMouseListenerResponse;
    }

    public void mouseMoved() {}

    // / TextListener interface
    public void textValueChanged(TextEvent e) {}

    // / WindowListener interface
    public void windowOpened(WindowEvent e) {}

    public void windowClosing(WindowEvent e) {}

    public void windowClosed(WindowEvent e) {}

    public void windowIconified(WindowEvent e) {}

    public void windowDeiconified(WindowEvent e) {}

    public void windowActivated(WindowEvent e) {}

    public void windowDeactivated(WindowEvent e) {}

}