prajna.geo

Class GeoCanvas

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

prajna.geo.GeoCanvas

All Implemented Interfaces:

java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable, GeoDisplay

Direct Known Subclasses:

GoogleGeoCanvas, TimerGeoCanvas

public class GeoCanvas
extends javax.swing.JComponent
implements GeoDisplay

Basic implementation of a Geographic display in a JComponent. This class provides the basic methods to implement GeoDisplay, and also provides simple layer and shape searching.

Author:

Edward Swing

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 inherited from class javax.swing.JComponent

accessibleContext, 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

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
GeoCanvas()

Method Summary

Methods

Modifier and Type	Method and Description
void	addLayer(GeoLayer layer) Add a layer to the geographic display
void	addShape(GeoShape newShape) Add a shape to the geographic display.
void	addShapes(java.util.Collection<GeoShape> newShapes) Add a collection of shapes to the geographic display.
void	clearShapes() Remove all shapes directly added to this canvas
GeoLayer	findLayer(java.lang.String name) Find the geographic layer with the given name.
java.awt.Image	getBackgroundImage() Get the background image for this GeoCanvas
GeoBounds	getGeoBounds() Get the geographic bounds
java.util.List<GeoLayer>	getLayers() Get the list of layers.
Projection	getProjection() Get the current projection
GeoShape	getShapeAt(java.awt.geom.Point2D pickPoint) Return the geographic shape at the picked point.
java.awt.Color	getWorldColor() Get the world color.
protected void	paintComponent(java.awt.Graphics g) Paints the geographic canvas.
protected void	paintGeoLayers(java.awt.Graphics2D g2) Paint the geographic layers.
void	setBackgroundImage(java.awt.Image image) Set the background image for this GeoCanvas.
void	setGeoBounds(GeoBounds geoBounds) Set the geographic bounds
void	setLayers(java.util.Collection<GeoLayer> layers) Set the geographic layers.
void	setProjection(Projection proj) Set the current projection
void	setWorldColor(java.awt.Color color) Set the world color.

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, 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, 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, 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, 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, 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, hide, 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

Constructor Detail

GeoCanvas

public GeoCanvas()

Method Detail

addLayer

public void addLayer(GeoLayer layer)

Add a layer to the geographic display

Specified by:

addLayer in interface GeoDisplay

Parameters:

layer - a new geographic layer

addShape

public void addShape(GeoShape newShape)

Add a shape to the geographic display. Any shapes added will be drawn on top of all other features.

Parameters:

newShape - a new geographic shape to display

addShapes

public void addShapes(java.util.Collection<GeoShape> newShapes)

Add a collection of shapes to the geographic display. All shapes added will be drawn on top of all other features.

Parameters:

newShapes - a collection of new shapes to add to the display

clearShapes

public void clearShapes()

Remove all shapes directly added to this canvas

findLayer

public GeoLayer findLayer(java.lang.String name)

Find the geographic layer with the given name. The name is case-insensitive.

Parameters:

name - The name of the layer to locate

Returns:

the named geographic layer, or null if there is no layer with the given name.

getBackgroundImage

public java.awt.Image getBackgroundImage()

Get the background image for this GeoCanvas

Returns:

the background image

getGeoBounds

public GeoBounds getGeoBounds()

Get the geographic bounds

Specified by:

getGeoBounds in interface GeoDisplay

Returns:

the geographic bounds

getLayers

public java.util.List<GeoLayer> getLayers()

Get the list of layers. The list is returned in the order that the layers are drawn, so the first layers in the list will be below later ones. This method returns a defensive copy of the layers.

Specified by:

getLayers in interface GeoDisplay

Returns:

the list of layers.

getProjection

public Projection getProjection()

Get the current projection

Specified by:

getProjection in interface GeoDisplay

Returns:

the current projection

getShapeAt

public GeoShape getShapeAt(java.awt.geom.Point2D pickPoint)

Return the geographic shape at the picked point. This method iterates through the set of geographic layers, and attempts to pick the geographic element in each one. It returns the highest (last drawn) geographic element which contains the pick point.

Parameters:

pickPoint - the point to use to query the geographic layers

Returns:

the highest shape which contains the pick point, or null if no shape contains the pick point.

getWorldColor

public java.awt.Color getWorldColor()

Get the world color. The world color is used to draw the background of the geographic display. Typically, this color is used to draw the oceans.

Returns:

the current world color, or null if the color has not been set.

paintComponent

protected void paintComponent(java.awt.Graphics g)

Paints the geographic canvas. This method first paints the background (world) color, if the world color has been set. It then calls paintGeoLayers to render the individual layers.

Overrides:

paintComponent in class javax.swing.JComponent

Parameters:

g - the graphics context to use for painting

paintGeoLayers

protected void paintGeoLayers(java.awt.Graphics2D g2)

Paint the geographic layers. This method iterates through the geographic layers, and draws each one. It then draws any shapes that were directly added to the graphics display with the addShape method.

Parameters:

g2 - the graphics context to use for painting

setBackgroundImage

public void setBackgroundImage(java.awt.Image image)

Set the background image for this GeoCanvas. If the background image is not null, the worldColor is set to null to prevent it from overwriting the image.

Parameters:

image - the background image

setGeoBounds

public void setGeoBounds(GeoBounds geoBounds)

Set the geographic bounds

Specified by:

setGeoBounds in interface GeoDisplay

Parameters:

geoBounds - the geographic bounds

setLayers

public void setLayers(java.util.Collection<GeoLayer> layers)

Set the geographic layers. The layers will be added to the internal list in iteration order.

Specified by:

setLayers in interface GeoDisplay

Parameters:

layers - the collection of geographic layers

setProjection

public void setProjection(Projection proj)

Set the current projection

Specified by:

setProjection in interface GeoDisplay

Parameters:

proj - the new projection

setWorldColor

public void setWorldColor(java.awt.Color color)

Set the world color. If worldColor is not null, the geographic extent of the world will be colored with the background color prior to drawing all geographic layers.

Parameters:

color - the new world color