org.geotools.swing
Class JMapPane

Object
  extended by Component
      extended by Container
          extended by JComponent
              extended by JPanel
                  extended by AbstractMapPane
                      extended by JMapPane
All Implemented Interfaces:
ImageObserver, MenuContainer, Serializable, EventListener, Accessible, MapBoundsListener, MapLayerListListener, MapPane, RenderingExecutorListener

public class JMapPane
extends AbstractMapPane

A lightweight map pane which uses a single renderer and backing image. Used by JMapFrame for the GeoTools tutorial applications.

Since:
2.6
Author:
Michael Bedward, Ian Turton
See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class JPanel
JPanel.AccessibleJPanel
 
Nested classes/interfaces inherited from class JComponent
JComponent.AccessibleJComponent
 
Nested classes/interfaces inherited from class Container
Container.AccessibleAWTContainer
 
Nested classes/interfaces inherited from class Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy
 
Field Summary
 
Fields inherited from class AbstractMapPane
acceptRepaintRequests, baseImageMoved, clearLabelCache, currentCursorTool, DEFAULT_BACKGROUND_COLOR, DEFAULT_PAINT_DELAY, dragBox, drawingLock, fullExtent, imageMovedFuture, imageOrigin, keyHandler, labelCache, listeners, mapContent, mouseEventDispatcher, paintDelay, paneTaskExecutor, paramsLock, pendingDisplayArea, renderingExecutor, resizedFuture
 
Fields inherited from class 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 Component
BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT
 
Fields inherited from interface ImageObserver
ABORT, ALLBITS, ERROR, FRAMEBITS, HEIGHT, PROPERTIES, SOMEBITS, WIDTH
 
Constructor Summary
JMapPane()
          Creates a new map pane.
JMapPane(MapContent content)
          Creates a new map pane.
JMapPane(MapContent content, RenderingExecutor executor, GTRenderer renderer)
          Creates a new map pane.
 
Method Summary
protected  void drawLayers(boolean createNewImage)
          Draws layers into one or more images which will then be displayed by the map pane.
 RenderedImage getBaseImage()
          Retrieve the map pane's current base image.
 GTRenderer getRenderer()
          Gets the renderer, creating a default one if required.
protected  void paintComponent(Graphics g)
           
 void setMapContent(MapContent content)
          Sets the MapContent instance containing the layers to display.
 void setRenderer(GTRenderer renderer)
          Sets the renderer to be used by this map pane.
 
Methods inherited from class AbstractMapPane
addMapPaneListener, addMouseListener, afterImageMoved, doSetDisplayArea, getCursorTool, getDisplayArea, getKeyHandler, getMapContent, getMouseEventDispatcher, getPaintDelay, getRenderingExecutor, getScreenToWorldTransform, getWorldToScreenTransform, isAcceptingRepaints, layerAdded, layerChanged, layerMoved, layerPreDispose, layerRemoved, mapBoundsChanged, moveImage, onImageMoved, onRenderingCompleted, onRenderingFailed, onRenderingStarted, onShownOrResized, publishEvent, removeMapPaneListener, removeMouseListener, reset, setCursorTool, setDisplayArea, setForNewSize, setFullExtent, setIgnoreRepaint, setKeyHandler, setMouseEventDispatcher, setPaintDelay, setRenderingExecutor
 
Methods inherited from class JPanel
getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI
 
Methods inherited from class 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, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, 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 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, transferFocusBackward, transferFocusDownCycle, validate, validateTree
 
Methods inherited from class 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, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, toString, transferFocus, transferFocusUpCycle
 
Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

JMapPane

public JMapPane()
Creates a new map pane.


JMapPane

public JMapPane(MapContent content)
Creates a new map pane.

Parameters:
content - the map content containing the layers to display (may be null)

JMapPane

public JMapPane(MapContent content,
                RenderingExecutor executor,
                GTRenderer renderer)
Creates a new map pane. Any or all arguments may be null

Parameters:
content - the map content containing the layers to display
executor - the rendering executor to manage drawing
renderer - the renderer to use for drawing layers
Method Detail

setMapContent

public void setMapContent(MapContent content)
Sets the MapContent instance containing the layers to display.

Specified by:
setMapContent in interface MapPane
Overrides:
setMapContent in class AbstractMapPane
Parameters:
content - the map content

getRenderer

public GTRenderer getRenderer()
Gets the renderer, creating a default one if required.

Returns:
the renderer

setRenderer

public void setRenderer(GTRenderer renderer)
Sets the renderer to be used by this map pane.

Parameters:
renderer - the renderer to use

getBaseImage

public RenderedImage getBaseImage()
Retrieve the map pane's current base image.

The map pane caches the most recent rendering of map layers as an image to avoid time-consuming rendering requests whenever possible. The base image will be re-drawn whenever there is a change to map layer data, style or visibility; and it will be replaced by a new image when the pane is resized.

This method returns a live reference to the current base image. Use with caution.

Returns:
a live reference to the current base image

paintComponent

protected void paintComponent(Graphics g)
Overrides:
paintComponent in class JComponent

drawLayers

protected void drawLayers(boolean createNewImage)
Description copied from class: AbstractMapPane
Draws layers into one or more images which will then be displayed by the map pane.

Specified by:
drawLayers in class AbstractMapPane


Copyright © 1996-2014 Geotools. All Rights Reserved.