org.ka2ddo.yaac.gui.rastermap

Class RasterMapOverlay

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.bbn.openmap.Layer

org.ka2ddo.yaac.gui.rastermap.RasterMapOverlay

All Implemented Interfaces:

com.bbn.openmap.event.MapMouseListener, com.bbn.openmap.event.ProjectionListener, com.bbn.openmap.ProjectionPainter, com.bbn.openmap.PropertyConsumer, java.awt.event.ActionListener, java.awt.event.ComponentListener, java.awt.event.KeyListener, java.awt.image.ImageObserver, java.awt.MenuContainer, java.beans.beancontext.BeanContextChild, java.beans.beancontext.BeanContextMembershipListener, java.io.Serializable, java.lang.Runnable, java.util.EventListener, MouseWheelCanZoomMap

public class RasterMapOverlay
extends com.bbn.openmap.Layer
implements java.awt.event.ComponentListener, java.lang.Runnable, com.bbn.openmap.event.MapMouseListener, java.awt.event.KeyListener, MouseWheelCanZoomMap

This class renders raster maps properly rescaled and translated to fit into the Mercator projection used by the MapBean.

Author:

Andrew Pavlin, KA2DDO

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes/interfaces inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes/interfaces inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BaselineResizeBehavior, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
static com.bbn.openmap.event.SelectMouseMode	YAAC_RASTER_MODE
static java.lang.String	YAAC_RASTER_PIN_MODE

Fields inherited from class com.bbn.openmap.Layer

addAsBackground, AddAsBackgroundProperty, addToBeanContext, AddToBeanContextProperty, attributes, autoPalette, AutoPaletteProperty, beanContextChildSupport, coordTransform, DataPathPrefixProperty, DisplayPaletteCmd, DisplayPropertiesCmd, doHack, HidePaletteCmd, i18n, localHackList, maxScale, MaxScaleProperty, minScale, MinScaleProperty, palette, paletteListener, PrettyNameProperty, propertyPrefix, readyToPaint, RedrawCmd, removable, RemovableProperty, SWING_PACKAGE, TransformProperty, windowSupport

Fields inherited from class javax.swing.JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

accessibleContext, BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Fields inherited from interface com.bbn.openmap.PropertyConsumer

EditorProperty, initPropertiesProperty, LabelEditorProperty, ScopedEditorProperty

Fields inherited from interface java.awt.image.ImageObserver

ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH

Constructor Summary

Constructors

Constructor and Description
RasterMapOverlay(com.bbn.openmap.MouseDelegator mouseDelegator, GeoMapGuiIfc2 geoMap) Create an overlay layer for displaying rescaled raster images.

Method Summary

Modifier and Type	Method and Description
void	componentHidden(java.awt.event.ComponentEvent e) DO NOT CALL.
void	componentMoved(java.awt.event.ComponentEvent e) DO NOT CALL.
void	componentResized(java.awt.event.ComponentEvent e) DO NOT CALL.
void	componentShown(java.awt.event.ComponentEvent e) DO NOT CALL.
GeoMapGuiIfc2	getGeoMap() Get the actual map window associated with this overlay.
com.bbn.openmap.event.MapMouseListener	getMapMouseListener() Get the object that should receive MapMouse events when this Layer is active for mouse input.
java.lang.String[]	getMouseModeServiceList() Specify what map mouse service this Layer provides.
RasterMapCatalog	getRasterMapCatalog() Get the collection of raster images used by this map overlay.
boolean	isMouseWheelZooming() Test whether this map or Layer will zoom the map if the mouse wheel is adjusted.
boolean	isShowRasterMaps() Identify whether raster overlays should be rendered on the map window.
void	keyPressed(java.awt.event.KeyEvent e) Invoked when a key has been pressed.
void	keyReleased(java.awt.event.KeyEvent e) Invoked when a key has been released.
void	keyTyped(java.awt.event.KeyEvent e) Invoked when a key has been typed.
boolean	mouseClicked(java.awt.event.MouseEvent mouseEvent) Handle mouse click events on this Layer.
boolean	mouseDragged(java.awt.event.MouseEvent mouseEvent) Handle mouse drag events on this Layer.
void	mouseEntered(java.awt.event.MouseEvent mouseEvent) Handle mouse enter events on this Layer.
void	mouseExited(java.awt.event.MouseEvent mouseEvent) Handle mouse exit events on this Layer.
void	mouseMoved() No-op.
boolean	mouseMoved(java.awt.event.MouseEvent mouseEvent) Handle mouse move events on this Layer.
boolean	mousePressed(java.awt.event.MouseEvent mouseEvent) Handle mouse press events on this Layer.
boolean	mouseReleased(java.awt.event.MouseEvent mouseEvent) Handle mouse release events on this Layer.
protected void	paintComponent(java.awt.Graphics g) Draw the enabled raster maps on the map window.
void	projectionChanged(com.bbn.openmap.event.ProjectionEvent e) Handle when the current map Projection is modified.
void	registerMouseMode(com.bbn.openmap.MouseDelegator mouseDelegator) Specify the identifier for when this Layer should receive MapMouseEvents.
void	repaint() Repaints this component.
void	run() DO NOT CALL.
void	setMouseWheelZooming(boolean zoomEnabled) Specify whether this map or Layer will zoom the map if the mouse wheel is adjusted.
void	setPinningRasterMapEntry(RasterMapEntry pinningRME) Specify what raster image is to be pinned to the map coordinate system.
void	setShowRasterMaps(boolean showRasterMaps) Specify whether raster overlays should be rendered on the map window.
void	startRegenerate() Start regenerating the raster map overlay layer based on the current Projection.
void	stopRegenerate(int offsetX, int offsetY) Stop regenerating the raster overlay.
RasterMapEntry	unsetPinningRasterMapEntry() Complete a raster pinning operation.

Methods inherited from class com.bbn.openmap.Layer

actionPerformed, addComponentListener, added, addInfoDisplayListener, addLayerStatusListener, addMouseListener, addVetoableChangeListener, childrenAdded, childrenRemoved, clearListeners, connectToBeanContext, createWindowSupport, disconnectFromBeanContext, dispose, finalize, findAndInit, findAndInit, findAndUndo, fireHideToolTip, firePaletteEvent, fireRequestBrowserContent, fireRequestBrowserContent, fireRequestCursor, fireRequestInfoLine, fireRequestInfoLine, fireRequestInfoLine, fireRequestMessage, fireRequestMessage, fireRequestToolTip, fireRequestToolTip, fireRequestURL, fireRequestURL, fireStatusUpdate, fireStatusUpdate, fireVetoableChange, getAddAsBackground, getAddToBeanContext, getAttribute, getBeanContext, getCoordTransform, getGUI, getIcon, getMaxScale, getMinScale, getPackage, getPalette, getProjection, getProperties, getPropertyInfo, getPropertyPrefix, getWindowSupport, hasGUI, hidePalette, isAutoPalette, isProjectionOK, isReadyToPaint, isRemovable, notifyHideHack, prependDataPathPrefix, putAttribute, removeComponentListener, removeConfirmed, removed, removeInfoDisplayListener, removeLayerStatusListener, removeVetoableChangeListener, renderDataForProjection, repaint, resetPalette, setAddAsBackground, setAddToBeanContext, setAutoPalette, setBeanContext, setCoordTransform, setIcon, setLayerProperties, setMaxScale, setMinScale, setName, setPaletteVisible, setProjection, setProjection, setProperties, setProperties, setPropertyPrefix, setReadyToPaint, setRemovable, setVisible, setWindowSupport, showPalette

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBaseline, getBaselineResizeBehavior, getBorder, getBounds, getClientProperty, getComponentGraphics, getComponentPopupMenu, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getFontMetrics, getGraphics, getHeight, getInheritsPopupMenu, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPopupLocation, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintImmediately, paintImmediately, paramString, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setComponentPopupMenu, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFocusTraversalKeys, setFont, setForeground, setInheritsPopupMenu, setInputMap, setInputVerifier, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setTransferHandler, setUI, setVerifyInputWhenFocusTarget, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addPropertyChangeListener, addPropertyChangeListener, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getComponentZOrder, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, getMousePosition, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicyProvider, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setComponentZOrder, setFocusCycleRoot, setFocusTraversalPolicy, setFocusTraversalPolicyProvider, setLayout, transferFocusDownCycle, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, getAccessibleContext, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMousePosition, getMouseWheelListeners, getName, getParent, getPeer, getPropertyChangeListeners, getPropertyChangeListeners, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, isMaximumSizeSet, isMinimumSizeSet, isPreferredSizeSet, isShowing, isValid, isVisible, keyDown, keyUp, list, list, list, location, lostFocus, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, postEvent, prepareImage, prepareImage, processComponentEvent, processFocusEvent, processHierarchyBoundsEvent, processHierarchyEvent, processInputMethodEvent, processMouseWheelEvent, remove, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.beans.beancontext.BeanContextChild

addPropertyChangeListener, removePropertyChangeListener

Field Detail

YAAC_RASTER_PIN_MODE

public static final java.lang.String YAAC_RASTER_PIN_MODE

See Also:

Constant Field Values

YAAC_RASTER_MODE

public static final com.bbn.openmap.event.SelectMouseMode YAAC_RASTER_MODE

Constructor Detail

RasterMapOverlay

public RasterMapOverlay(com.bbn.openmap.MouseDelegator mouseDelegator,
                        GeoMapGuiIfc2 geoMap)

Create an overlay layer for displaying rescaled raster images.

Parameters:

mouseDelegator - MouseDelegator that will control which layer will get mouse events

geoMap - GeoMapGuiIfc2 that will contain this RasterMapOverlay

Method Detail

registerMouseMode

public void registerMouseMode(com.bbn.openmap.MouseDelegator mouseDelegator)

Specify the identifier for when this Layer should receive MapMouseEvents.

Parameters:

mouseDelegator - the MouseDelegator to receive the registration info

isShowRasterMaps

public boolean isShowRasterMaps()

Identify whether raster overlays should be rendered on the map window.

Returns:

boolean true if the collected rasters should be rendered

setShowRasterMaps

public void setShowRasterMaps(boolean showRasterMaps)

Specify whether raster overlays should be rendered on the map window.

Parameters:

showRasterMaps - boolean true if the collected rasters should be rendered

isMouseWheelZooming

public boolean isMouseWheelZooming()

Test whether this map or Layer will zoom the map if the mouse wheel is adjusted.

Specified by:

isMouseWheelZooming in interface MouseWheelCanZoomMap

Returns:

boolean true if mouse wheel motion zooms the map

setMouseWheelZooming

public void setMouseWheelZooming(boolean zoomEnabled)

Specify whether this map or Layer will zoom the map if the mouse wheel is adjusted.

Specified by:

setMouseWheelZooming in interface MouseWheelCanZoomMap

Parameters:

zoomEnabled - boolean true if mouse wheel motion zooms the map

getRasterMapCatalog

public RasterMapCatalog getRasterMapCatalog()

Get the collection of raster images used by this map overlay.

Returns:

RasterMapCatalog

getGeoMap

public GeoMapGuiIfc2 getGeoMap()

Get the actual map window associated with this overlay.

Returns:

GeographicalMap this overlay is rendered in

Since:

PROVIDER_API_VERSION == 56

unsetPinningRasterMapEntry

public RasterMapEntry unsetPinningRasterMapEntry()

Complete a raster pinning operation.

Returns:

the pinned RasterMapEntry

setPinningRasterMapEntry

public void setPinningRasterMapEntry(RasterMapEntry pinningRME)

Specify what raster image is to be pinned to the map coordinate system.

Parameters:

pinningRME - RasterMapEntry to be pinned

projectionChanged

public void projectionChanged(com.bbn.openmap.event.ProjectionEvent e)

Handle when the current map Projection is modified.

Specified by:

projectionChanged in interface com.bbn.openmap.event.ProjectionListener

Parameters:

e - ProjectEvent describing the change in geometrical projection

paintComponent

protected void paintComponent(java.awt.Graphics g)

Draw the enabled raster maps on the map window.

Overrides:

paintComponent in class javax.swing.JComponent

Parameters:

g - Graphics object to use for rendering

stopRegenerate

public void stopRegenerate(int offsetX,
                           int offsetY)

Stop regenerating the raster overlay.

Parameters:

offsetX - X offset for drawing the existing overlay on a dragged map

offsetY - Y offset for drawing the existing overlay on a dragged map

startRegenerate

public void startRegenerate()

Start regenerating the raster map overlay layer based on the current Projection.

run

public final void run()

DO NOT CALL. Background thread body for rendering the raster image overlay layer.

Specified by:

run in interface java.lang.Runnable

componentHidden

public void componentHidden(java.awt.event.ComponentEvent e)

DO NOT CALL. No-op.

Specified by:

componentHidden in interface java.awt.event.ComponentListener

Parameters:

e - ComponentEvent

componentMoved

public void componentMoved(java.awt.event.ComponentEvent e)

DO NOT CALL. No-op.

Specified by:

componentMoved in interface java.awt.event.ComponentListener

Parameters:

e - ComponentEvent

componentResized

public void componentResized(java.awt.event.ComponentEvent e)

DO NOT CALL. Listener callback to regenerate raster map overlay when map widget is resized.

Specified by:

componentResized in interface java.awt.event.ComponentListener

Parameters:

e - ComponentEvent

componentShown

public void componentShown(java.awt.event.ComponentEvent e)

DO NOT CALL. No-op.

Specified by:

componentShown in interface java.awt.event.ComponentListener

Parameters:

e - ComponentEvent

getMapMouseListener

public com.bbn.openmap.event.MapMouseListener getMapMouseListener()

Get the object that should receive MapMouse events when this Layer is active for mouse input.

Overrides:

getMapMouseListener in class com.bbn.openmap.Layer

Returns:

this Layer object

getMouseModeServiceList

public java.lang.String[] getMouseModeServiceList()

Specify what map mouse service this Layer provides.

Specified by:

getMouseModeServiceList in interface com.bbn.openmap.event.MapMouseListener

Returns:

array of service name Strings

mousePressed

public boolean mousePressed(java.awt.event.MouseEvent mouseEvent)

Handle mouse press events on this Layer.

Specified by:

mousePressed in interface com.bbn.openmap.event.MapMouseListener

Parameters:

mouseEvent - MouseEvent describing the press

Returns:

boolean true if press was fully consumed by this Layer

mouseReleased

public boolean mouseReleased(java.awt.event.MouseEvent mouseEvent)

Handle mouse release events on this Layer.

Specified by:

mouseReleased in interface com.bbn.openmap.event.MapMouseListener

Parameters:

mouseEvent - MouseEvent describing the release

Returns:

boolean true if release was fully consumed by this Layer

mouseClicked

public boolean mouseClicked(java.awt.event.MouseEvent mouseEvent)

Handle mouse click events on this Layer.

Specified by:

mouseClicked in interface com.bbn.openmap.event.MapMouseListener

Parameters:

mouseEvent - MouseEvent describing the click

Returns:

always false

mouseEntered

public void mouseEntered(java.awt.event.MouseEvent mouseEvent)

Handle mouse enter events on this Layer.

Specified by:

mouseEntered in interface com.bbn.openmap.event.MapMouseListener

Parameters:

mouseEvent - MouseEvent describing the enter

mouseExited

public void mouseExited(java.awt.event.MouseEvent mouseEvent)

Handle mouse exit events on this Layer.

Specified by:

mouseExited in interface com.bbn.openmap.event.MapMouseListener

Parameters:

mouseEvent - MouseEvent describing the exit

mouseDragged

public boolean mouseDragged(java.awt.event.MouseEvent mouseEvent)

Handle mouse drag events on this Layer.

Specified by:

mouseDragged in interface com.bbn.openmap.event.MapMouseListener

Parameters:

mouseEvent - MouseEvent describing the drag

Returns:

boolean true if drag was fully consumed by this Layer

mouseMoved

public boolean mouseMoved(java.awt.event.MouseEvent mouseEvent)

Handle mouse move events on this Layer.

Specified by:

mouseMoved in interface com.bbn.openmap.event.MapMouseListener

Parameters:

mouseEvent - MouseEvent describing the move

Returns:

always false

mouseMoved

public void mouseMoved()

No-op. Handles generic report of mouse being moved across the Layer.

Specified by:

mouseMoved in interface com.bbn.openmap.event.MapMouseListener

keyPressed

public void keyPressed(java.awt.event.KeyEvent e)

Invoked when a key has been pressed. See the class description for KeyEvent for a definition of a key pressed event.

Specified by:

keyPressed in interface java.awt.event.KeyListener

keyTyped

public void keyTyped(java.awt.event.KeyEvent e)

Invoked when a key has been typed. See the class description for KeyEvent for a definition of a key typed event.

Specified by:

keyTyped in interface java.awt.event.KeyListener

keyReleased

public void keyReleased(java.awt.event.KeyEvent e)

Invoked when a key has been released. See the class description for KeyEvent for a definition of a key released event.

Specified by:

keyReleased in interface java.awt.event.KeyListener

repaint

public void repaint()

Repaints this component.

Overrides:

repaint in class java.awt.Component