map

Class MapPanel

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

map.MapPanel

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, javax.accessibility.Accessible

public class MapPanel
extends javax.swing.JPanel

Specialized JPanel that displays a WorldWind map of the world. Specialized versions of MapPanel should be subclasses that use the protected accessor methods, providing encapsulated access to manipulations of those protected entities. Do not expose internal data!

Author:

Scott Rixner, Stephen Wong

See Also:

Serialized Form

Nested Class Summary

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

javax.swing.JPanel.AccessibleJPanel

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
private gov.nasa.worldwind.awt.WorldWindowGLCanvas	_wwd Actual Map Canvas
private double	currentAltitude The current altitude of the map.
private java.util.Map<IRightClickAction,java.awt.event.MouseListener>	rightClickActions Map to associate IRightClickActions that have been added with the actual MouseListener that is installed.
private static long	serialVersionUID Serial Version UID

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 java.awt.image.ImageObserver

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

Constructor Summary

Constructors

Constructor and Description
MapPanel() Construct a MapPanel with a flat Earth view.
MapPanel(java.lang.Class<? extends gov.nasa.worldwind.globes.Globe> globeTypeClass) Construct a new MapPanel using the given type of Globe view.

Method Summary

Modifier and Type	Method and Description
void	addLayer(gov.nasa.worldwind.layers.Layer layer) Add a layer of annotations to the map.
void	addRightClickAction(IRightClickAction rightClick) Add an action to be performed upon a right click on the map.
protected double	getCurrentAltitude() Accessor for the current altitude (eye point)
protected gov.nasa.worldwind.awt.WorldWindowGLCanvas	getWWD()
protected void	initconfig(java.lang.Class<? extends gov.nasa.worldwind.globes.Globe> globeTypeClass) Initialize configuration options for WorldWind to operate correctly.
void	insertAtLayer(gov.nasa.worldwind.layers.Layer layer, java.lang.Class<?> layerType, boolean insertBefore) Insert the given Layer before or after the first occurrence of the given layer type.
void	insertAtLayer(gov.nasa.worldwind.layers.Layer layer, gov.nasa.worldwind.layers.Layer targetLayer, boolean insertBefore) Insert the given layer before or after the first occurrence of the given layer object
protected void	insertBeforeCompass(gov.nasa.worldwind.layers.Layer layer) Insert layer just beneath the Compass layer.
void	removeLayer(gov.nasa.worldwind.layers.Layer layer) Remove a layer from the map
void	removeRightClickAction(IRightClickAction rightClickAction) Remove an action that is being performed upon a right click on the map.
protected void	setCurrentAltitude(double currentAltitude) Accessor for the current altitude (eye point)
void	setPosition(gov.nasa.worldwind.geom.Position pos, boolean fly) Set the position of the map to the indicated position.
protected void	setupAnnotationToggling() Add a select listener to toggle ToggleAnnotation objects
protected void	setupSky() Convert gradient sky to color sky.
protected void	setupStatusBar() Set up the status bar, which shows latitude, longitude, altitude, etc.
protected void	setupViewControllers() Setup the controllers in the view which allow navigation around the map.
protected void	setupWWD() Setup the WorldWindow.
void	start() Starts the MapPanel by creating the WWJ Map and showing it.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, 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, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removeVetoableChangeListener, repaint, 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, setVisible, unregisterKeyboardAction, update

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, addComponentListener, addFocusListener, addHierarchyBoundsListener, addHierarchyListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addMouseWheelListener, bounds, checkImage, checkImage, coalesceEvents, contains, createImage, createImage, createVolatileImage, createVolatileImage, disableEvents, dispatchEvent, enable, enableEvents, enableInputMethods, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, 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, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

Serial Version UID

See Also:

Constant Field Values

_wwd

private gov.nasa.worldwind.awt.WorldWindowGLCanvas _wwd

Actual Map Canvas

rightClickActions

private java.util.Map<IRightClickAction,java.awt.event.MouseListener> rightClickActions

Map to associate IRightClickActions that have been added with the actual MouseListener that is installed.

currentAltitude

private double currentAltitude

The current altitude of the map. A hack to get around bug in returned position from _wwd

Constructor Detail

MapPanel

public MapPanel()

Construct a MapPanel with a flat Earth view. Equivalent to MapPanel(EarthFlat.class)

MapPanel

public MapPanel(java.lang.Class<? extends gov.nasa.worldwind.globes.Globe> globeTypeClass)

Construct a new MapPanel using the given type of Globe view. Possible values for globeTypeClass: Earth.class, EarthFlat.class, EllipsoidalGlobe.class, FlatGlobe.class

Parameters:

globeTypeClass - The Class file for a class/interface extending/implementing Globe which determines the type of view of the Earth.

Method Detail

initconfig

protected void initconfig(java.lang.Class<? extends gov.nasa.worldwind.globes.Globe> globeTypeClass)

Initialize configuration options for WorldWind to operate correctly.

Parameters:

globeTypeClass -

setupWWD

protected void setupWWD()

Setup the WorldWindow.

setupStatusBar

protected void setupStatusBar()

Set up the status bar, which shows latitude, longitude, altitude, etc.

setupViewControllers

protected void setupViewControllers()

Setup the controllers in the view which allow navigation around the map.

setupSky

protected void setupSky()

Convert gradient sky to color sky.

setupAnnotationToggling

protected void setupAnnotationToggling()

Add a select listener to toggle ToggleAnnotation objects

start

public void start()

Starts the MapPanel by creating the WWJ Map and showing it.

insertBeforeCompass

protected void insertBeforeCompass(gov.nasa.worldwind.layers.Layer layer)

Insert layer just beneath the Compass layer.

Parameters:

layer - - layer to insert

addRightClickAction

public void addRightClickAction(IRightClickAction rightClick)

Add an action to be performed upon a right click on the map. Attempting to add the same action object more than once will have no effect. A previously removed action can be re-added. The Point object that is given to the IRightClickAction has been modified so that its getAltitude() method returns the eye point altitude at the time of the right click. getElevation() still returns the vertical position of the ground at that location.

Parameters:

rightClick - - desired action

removeRightClickAction

public void removeRightClickAction(IRightClickAction rightClickAction)

Remove an action that is being performed upon a right click on the map. No-op if the given IRightClickAction was not previously added. The action object can be re-added later if desired.

Parameters:

rightClickAction - - a IRightClickAction that was previously added by addRightClickAction

setPosition

public void setPosition(gov.nasa.worldwind.geom.Position pos,
                        boolean fly)

Set the position of the map to the indicated position. If "fly" is true, the map will animate from the current position to the indicated position, otherwise it will jump there immediately.

Parameters:

pos - - desired destination position

fly - - fly if true, jump if false

addLayer

public void addLayer(gov.nasa.worldwind.layers.Layer layer)

Add a layer of annotations to the map. Layer is added below the compass layer.

Parameters:

layer - layer to add to the map

removeLayer

public void removeLayer(gov.nasa.worldwind.layers.Layer layer)

Remove a layer from the map

Parameters:

layer - layer to remove from the map

insertAtLayer

public void insertAtLayer(gov.nasa.worldwind.layers.Layer layer,
                          java.lang.Class<?> layerType,
                          boolean insertBefore)

Insert the given Layer before or after the first occurrence of the given layer type.

Parameters:

layer - The layer to insert

layerType - The type of layer to insert before or after

insertBefore - Boolean that if true, will all insertion before the given type and if false, will insert after the type has been encountered.

insertAtLayer

public void insertAtLayer(gov.nasa.worldwind.layers.Layer layer,
                          gov.nasa.worldwind.layers.Layer targetLayer,
                          boolean insertBefore)

Insert the given layer before or after the first occurrence of the given layer object

Parameters:

layer - The layer to insert

targetLayer - The layer before or after which the given layer will be inserted

insertBefore - Boolean that if true, will all insertion before the given type and if false, will insert after the type has been encountered.

getWWD

protected gov.nasa.worldwind.awt.WorldWindowGLCanvas getWWD()

Returns:

the internal WorldWindowGLCanvas object

getCurrentAltitude

protected double getCurrentAltitude()

Accessor for the current altitude (eye point)

Returns:

the currentAltitude

setCurrentAltitude

protected void setCurrentAltitude(double currentAltitude)

Accessor for the current altitude (eye point)

Parameters:

currentAltitude - the currentAltitude to set