org.geotools.gui.swing.map.map2d
Class AbstractMap2D

Object
  Component
      Container
          JComponent
              JPanel
                  AbstractMap2D

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible, Map2D

Direct Known Subclasses:

JStreamNavMap

public abstract class AbstractMap2D
extends JPanel
implements Map2D

Default implementation of Map2D

Author:

Johann Sorel

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

protected AbstractMap2D

THIS_MAP Map2D reference , same as "this" but needed to explicitly point to the map2d object when coding a private class

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

AbstractMap2D()
create a default JDefaultMap2D

Method Summary

void	addDecoration(int index, MapDecoration deco) insert a MapDecoration at a specific index
void	addDecoration(MapDecoration deco) add a Decoration between the map and the information top decoration
protected void	addMapDecoration(MapDecoration deco) add a MapDecoration between the map and the user MapDecoration those MapDecoration can not be removed because they are important for edition/selection/navigation.
MapDecoration	getBackgroundDecoration() get the decoration behind the map
Component	getComponent() get the visual component
int	getDecorationIndex(MapDecoration deco) get the index of a MapDecoration
MapDecoration[]	getDecorations() get an array of all MapDecoration
InformationDecoration	getInformationDecoration() get the top InformationDecoration of the map2d widget
void	removeDecoration(MapDecoration deco) remove a MapDecoration
void	setBackgroundDecoration(MapDecoration back) set the decoration behind the map
void	setInformationDecoration(InformationDecoration info) set the top InformationDecoration of the map2d widget
protected void	setMapComponent(Component comp)
protected void	setRendering(boolean render)

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

Methods inherited from interface Map2D

dispose

Field Detail

THIS_MAP

protected final AbstractMap2D THIS_MAP

Map2D reference , same as "this" but needed to explicitly point to the map2d object when coding a private class

Constructor Detail

AbstractMap2D

public AbstractMap2D()

create a default JDefaultMap2D

Method Detail

setMapComponent

protected void setMapComponent(Component comp)

setRendering

protected void setRendering(boolean render)

setInformationDecoration

public void setInformationDecoration(InformationDecoration info)

Description copied from interface: Map2D

set the top InformationDecoration of the map2d widget

Specified by:

setInformationDecoration in interface Map2D

Parameters:

info - , can't be null

getInformationDecoration

public InformationDecoration getInformationDecoration()

Description copied from interface: Map2D

get the top InformationDecoration of the map2d widget

Specified by:

getInformationDecoration in interface Map2D

Returns:

InformationDecoration

setBackgroundDecoration

public void setBackgroundDecoration(MapDecoration back)

Description copied from interface: Map2D

set the decoration behind the map

Specified by:

setBackgroundDecoration in interface Map2D

Parameters:

back - : MapDecoration, can't be null

getBackgroundDecoration

public MapDecoration getBackgroundDecoration()

Description copied from interface: Map2D

get the decoration behind the map

Specified by:

getBackgroundDecoration in interface Map2D

Returns:

MapDecoration : or null if no back decoration

addDecoration

public void addDecoration(MapDecoration deco)

Description copied from interface: Map2D

add a Decoration between the map and the information top decoration

Specified by:

addDecoration in interface Map2D

Parameters:

deco - : MapDecoration to add

addDecoration

public void addDecoration(int index,
                          MapDecoration deco)

Description copied from interface: Map2D

insert a MapDecoration at a specific index

Specified by:

addDecoration in interface Map2D

Parameters:

index - : index where to isert the decoration

deco - : MapDecoration to add

getDecorationIndex

public int getDecorationIndex(MapDecoration deco)

Description copied from interface: Map2D

get the index of a MapDecoration

Specified by:

getDecorationIndex in interface Map2D

Parameters:

deco - : MapDecoration to find

Returns:

index of the MapDecoration

removeDecoration

public void removeDecoration(MapDecoration deco)

Description copied from interface: Map2D

remove a MapDecoration

Specified by:

removeDecoration in interface Map2D

Parameters:

deco - : MapDecoration to remove

getDecorations

public MapDecoration[] getDecorations()

Description copied from interface: Map2D

get an array of all MapDecoration

Specified by:

getDecorations in interface Map2D

Returns:

array of MapDecoration

addMapDecoration

protected void addMapDecoration(MapDecoration deco)

add a MapDecoration between the map and the user MapDecoration those MapDecoration can not be removed because they are important for edition/selection/navigation.

Parameters:

deco - : MapDecoration to add

getComponent

public Component getComponent()

Description copied from interface: Map2D

get the visual component

Specified by:

getComponent in interface Map2D

Returns:

Component