com.bbn.openmap.event
Class NullMouseMode

java.lang.Object
  extended by com.bbn.openmap.MapHandlerChild
      extended by com.bbn.openmap.OMComponent
          extended by com.bbn.openmap.event.AbstractMouseMode
              extended by com.bbn.openmap.event.NullMouseMode
All Implemented Interfaces:
MapMouseMode, PaintListener, LightMapHandlerChild, PropertyConsumer, java.awt.event.MouseListener, java.awt.event.MouseMotionListener, java.awt.event.MouseWheelListener, java.beans.beancontext.BeanContextChild, java.beans.beancontext.BeanContextMembershipListener, java.io.Serializable, java.util.EventListener

public class NullMouseMode
extends AbstractMouseMode

The NullMouseMode takes no action on mouse events and does not keep a list of map mouse listeners. It is intended to be used when you need a mouse mode that does nothing as an alternative to one that does something. If you don't have one that does something you don't need any MouseModes at all.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.bbn.openmap.event.AbstractMouseMode
AbstractMouseMode.MouseWheelTimerListener
 
Field Summary
static java.lang.String modeID
          Mouse Mode identifier, which is "None".
 
Fields inherited from class com.bbn.openmap.event.AbstractMouseMode
cursor, CursorIDProperty, guiIcon, iconName, IconProperty, ID, IDProperty, logger, mouseSupport, mouseTimer, mouseWheelListener, MouseWheelListenerProperty, mouseWheelTimerInterval, MouseWheelTimerIntervalProperty, mouseWheelTimerListener, MouseWheelZoomProperty, noMouseWheelListenerTimer, NoMouseWheelListenerTimerProperty, prettyName, PrettyNameProperty, propertyChangeSupport, visible, ZOOM_IN, ZOOM_OUT, zoomWhenMouseWheelUp
 
Fields inherited from class com.bbn.openmap.OMComponent
i18n, propertyPrefix
 
Fields inherited from class com.bbn.openmap.MapHandlerChild
beanContextChildSupport, isolated
 
Fields inherited from interface com.bbn.openmap.PropertyConsumer
EditorProperty, initPropertiesProperty, LabelEditorProperty, ScopedEditorProperty
 
Constructor Summary
NullMouseMode()
          Construct a NullMouseMode.
NullMouseMode(java.lang.String id, boolean consumeEvents)
          Construct a NullMouseMode.
 
Method Summary
 void addMapMouseListener(MapMouseListener mml)
          IGNORED.
 void removeMapMouseListener(MapMouseListener mml)
          IGNORED.
 
Methods inherited from class com.bbn.openmap.event.AbstractMouseMode
actAsProxyFor, actAsProxyFor, addPropertyChangeListener, getClassToUseForIconRetrieval, getGUIIcon, getIconName, getID, getModeCursor, getMouseSupport, getMouseWheelTimerInterval, getNoMouseWheelListener, getPrettyName, getProperties, getPropertyInfo, getProxied, getProxyDistributionMask, isConsumeEvents, isMouseWheelListener, isNoMouseWheelListenerTimer, isProxyFor, isVisible, isZoomWhenMouseWheelUp, listenerPaint, mouseClicked, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, releaseProxy, removeAllMapMouseListeners, removePropertyChangeListener, setActive, setConsumeEvents, setGUIIcon, setIconName, setID, setModeCursor, setModeCursor, setMouseSupport, setMouseWheelListener, setMouseWheelTimerInterval, setNoMouseWheelListener, setNoMouseWheelListenerTimer, setPrettyName, setProperties, setProxyDistributionMask, setVisible, setZoomWhenMouseWheelUp, updateMouseWheelMoved
 
Methods inherited from class com.bbn.openmap.OMComponent
getPropertyPrefix, setProperties, setPropertyPrefix
 
Methods inherited from class com.bbn.openmap.MapHandlerChild
addPropertyChangeListener, addVetoableChangeListener, childrenAdded, childrenRemoved, findAndInit, findAndInit, findAndUndo, firePropertyChange, fireVetoableChange, getBeanContext, isIsolated, removePropertyChangeListener, removeVetoableChangeListener, setBeanContext, setIsolated
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

modeID

public static final transient java.lang.String modeID
Mouse Mode identifier, which is "None".

See Also:
Constant Field Values
Constructor Detail

NullMouseMode

public NullMouseMode()
Construct a NullMouseMode. Default constructor sets the ID to the modeID string and the consume events parameter to true.


NullMouseMode

public NullMouseMode(java.lang.String id,
                     boolean consumeEvents)
Construct a NullMouseMode. Constructor that lets you set the name and the consume mode.

Parameters:
id - the ID name.
consumeEvents - the consume mode.
Method Detail

addMapMouseListener

public void addMapMouseListener(MapMouseListener mml)
IGNORED.

Specified by:
addMapMouseListener in interface MapMouseMode
Overrides:
addMapMouseListener in class AbstractMouseMode
Parameters:
mml - the MapMouseListener to add.

removeMapMouseListener

public void removeMapMouseListener(MapMouseListener mml)
IGNORED.

Specified by:
removeMapMouseListener in interface MapMouseMode
Overrides:
removeMapMouseListener in class AbstractMouseMode
Parameters:
mml - the MapMouseListener to remove.


Copyright (C) BBNT Solutions LLC; See http://openmap.bbn.com/ for details