AbstractViewer

java.lang.Object
- java.awt.Component
- - java.awt.Container
  - - javax.swing.JComponent
    - - javax.swing.JPanel
      - de.topobyte.jeography.viewer.core.AbstractViewer

All Implemented Interfaces:

MouseUser, ComponentListener, MouseListener, MouseMotionListener, MouseWheelListener, ImageObserver, MenuContainer, Serializable, EventListener, Accessible

Direct Known Subclasses:

SteplessViewer, Viewer
```
public abstract class AbstractViewer
extends JPanel
implements MouseUser, ComponentListener, MouseMotionListener, MouseListener, MouseWheelListener
```
See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
`protected class`	`AbstractViewer.Repainter`

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

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

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

Nested classes/interfaces inherited from class java.awt.Component
Component.AccessibleAWTComponent, Component.BaselineResizeBehavior, Component.BltBufferStrategy, Component.FlipBufferStrategy

Field Summary

Fields

Modifier and Type	Field and Description
`protected Color`	`colorBackground`
`protected Color`	`colorBorder`
`protected Color`	`colorCrosshair`
`protected Color`	`colorTilenumbers`
`protected boolean`	`drawBorder`
`protected boolean`	`drawCrosshair`
`protected boolean`	`drawOverlay`
`protected boolean`	`drawTileNumbers`
`protected boolean`	`mouseActive`
`protected Collection<MouseListener>`	`mouseListeners`
`protected TileConfig`	`overlayTileConfig`
`protected List<PaintListener>`	`paintListeners`
`protected TileConfig`	`tileConfig`
`protected ZoomMode`	`zoomMode`

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
`AbstractViewer()`

Method Summary

All Methods

Instance Methods

Abstract Methods

Concrete Methods
Modifier and Type	Method and Description
`void`	`addOverlayTileConfigListener(TileConfigListener listener)` Add this listener to the set of listeners.
`void`	`addPaintListener(PaintListener paintListener)` Add the given PaintListener to the list of paintListeners
`void`	`addTileConfigListener(TileConfigListener listener)` Add this listener to the set of listeners.
`void`	`componentHidden(ComponentEvent e)`
`void`	`componentMoved(ComponentEvent e)`
`void`	`componentResized(ComponentEvent e)`
`void`	`componentShown(ComponentEvent e)`
`protected void`	`dispatchRepaint()`
`protected void`	`drawCrosshair(Graphics2D g)`
`protected void`	`drawOverlayPoints(Graphics2D g)`
`Color`	`getColorBackground()` Get the color of the background
`Color`	`getColorBorder()` Get the color of the tile borders
`Color`	`getColorCrosshair()` Get the color of the crosshair
`Color`	`getColorTilenumbers()` Get the color of the tile number font
`protected abstract MapWindow`	`getMapWindow()`
`boolean`	`getMouseActive()`
`TileConfig`	`getOverlayTileConfig()` Get the current overlay configuration.
`TileConfig`	`getTileConfig()` Get the current configuration.
`ZoomMode`	`getZoomMode()`
`void`	`gotoOverlayPoints()` Set the viewport to display the overlay points...
`boolean`	`isDrawBorder()`
`boolean`	`isDrawCrosshair()`
`boolean`	`isDrawOverlay()`
`boolean`	`isDrawTileNumbers()`
`void`	`mouseClicked(MouseEvent e)`
`void`	`mouseDragged(MouseEvent e)`
`void`	`mouseEntered(MouseEvent e)`
`void`	`mouseExited(MouseEvent e)`
`void`	`mouseMoved(MouseEvent e)`
`void`	`mousePressed(MouseEvent e)`
`void`	`mouseReleased(MouseEvent e)`
`void`	`mouseWheelMoved(MouseWheelEvent e)`
`void`	`removePaintListener(PaintListener paintListener)` Remove the given PaintListener from the list of paintListeners.
`void`	`setColorBackground(Color color)` Set the color of the background
`void`	`setColorBorder(Color color)` Set the color of the tile borders
`void`	`setColorCrosshair(Color color)` Set the color of the crosshair
`void`	`setColorTilenumbers(Color color)` Set the color of the tile number font
`void`	`setDragGestureListener(DragGestureListener listener)` Set the DragGestureListener to use.
`void`	`setDragging(boolean drag)` Set whether dragging the mouse starts an drag event.
`void`	`setDrawBorder(boolean drawBorder)` Set whether a border shall be drawn around tiles.
`void`	`setDrawCrosshair(boolean drawCrosshair)` Set whether a crosshair shall be drawn in the middle of the viewport.
`void`	`setDrawOverlay(boolean drawOverlay)` Set whether the overlay will be drawn.
`void`	`setDrawTileNumbers(boolean drawTileNumbers)` Set whether the tile's numbers will be drawn.
`void`	`setMouseActive(boolean state)`
`void`	`setMouseListeners(Collection<MouseListener> listeners)`
`void`	`setOverlayPoints(Set<OverlayPoint> points)` Display the given points as an overlay.
`void`	`setZoomMode(ZoomMode zoomMode)`
`protected void`	`triggerOverlayTileConfigListeners()`
`protected void`	`triggerTileConfigListeners()`

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
  - colorBackground
```
protected Color colorBackground
```
  - colorBorder
```
protected Color colorBorder
```
  - colorTilenumbers
```
protected Color colorTilenumbers
```
  - colorCrosshair
```
protected Color colorCrosshair
```
  - mouseActive
```
protected boolean mouseActive
```
  - zoomMode
```
protected ZoomMode zoomMode
```
  - drawBorder
```
protected boolean drawBorder
```
  - drawCrosshair
```
protected boolean drawCrosshair
```
  - drawOverlay
```
protected boolean drawOverlay
```
  - drawTileNumbers
```
protected boolean drawTileNumbers
```
  - tileConfig
```
protected TileConfig tileConfig
```
  - overlayTileConfig
```
protected TileConfig overlayTileConfig
```
  - paintListeners
```
protected List<PaintListener> paintListeners
```
  - mouseListeners
```
protected Collection<MouseListener> mouseListeners
```
- Constructor Detail
  - AbstractViewer
```
public AbstractViewer()
```
- Method Detail
  - getMapWindow
```
protected abstract MapWindow getMapWindow()
```
  - getMouseActive
```
public boolean getMouseActive()
```
    Specified by:
    
    getMouseActive in interface MouseUser
    
    Returns:
    
    whether to react on mouse events.
  - setMouseActive
```
public void setMouseActive(boolean state)
```
    Specified by:
    
    setMouseActive in interface MouseUser
    
    Parameters:
    
    state - whether to react on mouse events.
  - getZoomMode
```
public ZoomMode getZoomMode()
```
  - setZoomMode
```
public void setZoomMode(ZoomMode zoomMode)
```
  - isDrawBorder
```
public boolean isDrawBorder()
```
    Returns:
    
    whether a border is drawn around tiles.
  - isDrawCrosshair
```
public boolean isDrawCrosshair()
```
    Returns:
    
    whether the crosshair is shown.
  - isDrawOverlay
```
public boolean isDrawOverlay()
```
    Returns:
    
    whether the overlay will be drawn.
  - isDrawTileNumbers
```
public boolean isDrawTileNumbers()
```
    Returns:
    
    whether to draw each tile's number.
  - setDrawBorder
```
public void setDrawBorder(boolean drawBorder)
```
    Set whether a border shall be drawn around tiles.
    
    Parameters:
    
    drawBorder - whether to draw a border around tiles.
  - setDrawCrosshair
```
public void setDrawCrosshair(boolean drawCrosshair)
```
    Set whether a crosshair shall be drawn in the middle of the viewport.
    
    Parameters:
    
    drawCrosshair - whether to draw a crosshair.
  - setDrawOverlay
```
public void setDrawOverlay(boolean drawOverlay)
```
    Set whether the overlay will be drawn.
    
    Parameters:
    
    drawOverlay - whether to draw an overlay.
  - setDrawTileNumbers
```
public void setDrawTileNumbers(boolean drawTileNumbers)
```
    Set whether the tile's numbers will be drawn.
    
    Parameters:
    
    drawTileNumbers - whether to draw each tile's number.
  - getColorBackground
```
public Color getColorBackground()
```
    Get the color of the background
    
    Returns:
    
    a color.
  - setColorBackground
```
public void setColorBackground(Color color)
```
    Set the color of the background
    
    Parameters:
    
    color - the color to set
  - getColorBorder
```
public Color getColorBorder()
```
    Get the color of the tile borders
    
    Returns:
    
    a color.
  - setColorBorder
```
public void setColorBorder(Color color)
```
    Set the color of the tile borders
    
    Parameters:
    
    color - the color to set
  - getColorTilenumbers
```
public Color getColorTilenumbers()
```
    Get the color of the tile number font
    
    Returns:
    
    a color.
  - setColorTilenumbers
```
public void setColorTilenumbers(Color color)
```
    Set the color of the tile number font
    
    Parameters:
    
    color - the color to set
  - getColorCrosshair
```
public Color getColorCrosshair()
```
    Get the color of the crosshair
    
    Returns:
    
    a color.
  - setColorCrosshair
```
public void setColorCrosshair(Color color)
```
    Set the color of the crosshair
    
    Parameters:
    
    color - the color to set
  - getTileConfig
```
public TileConfig getTileConfig()
```
    Get the current configuration.
    
    Returns:
    
    the current tile configuration.
  - getOverlayTileConfig
```
public TileConfig getOverlayTileConfig()
```
    Get the current overlay configuration.
    
    Returns:
    
    the current overlay configuration.
  - dispatchRepaint
```
protected void dispatchRepaint()
```
  - setDragging
```
public void setDragging(boolean drag)
```
    Set whether dragging the mouse starts an drag event.
    
    Parameters:
    
    drag - whether to allow dragging.
  - setDragGestureListener
```
public void setDragGestureListener(DragGestureListener listener)
```
    Set the DragGestureListener to use.
    
    Parameters:
    
    listener - the listener to use after invoking setDragging();
  - addTileConfigListener
```
public void addTileConfigListener(TileConfigListener listener)
```
    Add this listener to the set of listeners.
    
    Parameters:
    
    listener - the listener to add.
  - addOverlayTileConfigListener
```
public void addOverlayTileConfigListener(TileConfigListener listener)
```
    Add this listener to the set of listeners.
    
    Parameters:
    
    listener - the listener to add.
  - triggerTileConfigListeners
```
protected void triggerTileConfigListeners()
```
  - triggerOverlayTileConfigListeners
```
protected void triggerOverlayTileConfigListeners()
```
  - addPaintListener
```
public void addPaintListener(PaintListener paintListener)
```
    Add the given PaintListener to the list of paintListeners
    
    Parameters:
    
    paintListener - the listener to add.
  - removePaintListener
```
public void removePaintListener(PaintListener paintListener)
```
    Remove the given PaintListener from the list of paintListeners.
    
    Parameters:
    
    paintListener - the listener to remove.
  - setMouseListeners
```
public void setMouseListeners(Collection<MouseListener> listeners)
```
    Parameters:
    
    listeners - the collection of mouse listeners to notify about mouse events.
  - componentResized
```
public void componentResized(ComponentEvent e)
```
  - componentMoved
```
public void componentMoved(ComponentEvent e)
```
  - componentShown
```
public void componentShown(ComponentEvent e)
```
  - componentHidden
```
public void componentHidden(ComponentEvent e)
```
  - mouseDragged
```
public void mouseDragged(MouseEvent e)
```
  - mouseMoved
```
public void mouseMoved(MouseEvent e)
```
  - mouseClicked
```
public void mouseClicked(MouseEvent e)
```
  - mousePressed
```
public void mousePressed(MouseEvent e)
```
  - mouseReleased
```
public void mouseReleased(MouseEvent e)
```
  - mouseEntered
```
public void mouseEntered(MouseEvent e)
```
  - mouseExited
```
public void mouseExited(MouseEvent e)
```
  - mouseWheelMoved
```
public void mouseWheelMoved(MouseWheelEvent e)
```
  - drawCrosshair
```
protected void drawCrosshair(Graphics2D g)
```
  - drawOverlayPoints
```
protected void drawOverlayPoints(Graphics2D g)
```
  - setOverlayPoints
```
public void setOverlayPoints(Set<OverlayPoint> points)
```
    Display the given points as an overlay.
    
    Parameters:
    
    points - a set of points to display.
  - gotoOverlayPoints
```
public void gotoOverlayPoints()
```
    Set the viewport to display the overlay points...

Class AbstractViewer

Nested Class Summary

Nested Classes

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

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

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

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

Field Summary

Fields

Fields inherited from class javax.swing.JComponent

Fields inherited from class java.awt.Component

Fields inherited from interface java.awt.image.ImageObserver

Constructor Summary

Constructors

Method Summary

Methods inherited from class javax.swing.JPanel

Methods inherited from class javax.swing.JComponent

Methods inherited from class java.awt.Container

Methods inherited from class java.awt.Component

Methods inherited from class java.lang.Object

Field Detail

colorBackground

colorBorder

colorTilenumbers

colorCrosshair

mouseActive

zoomMode

drawBorder

drawCrosshair

drawOverlay

drawTileNumbers

tileConfig

overlayTileConfig

paintListeners

mouseListeners

Constructor Detail

AbstractViewer

Method Detail

getMapWindow

getMouseActive

setMouseActive

getZoomMode

setZoomMode

isDrawBorder

isDrawCrosshair

isDrawOverlay

isDrawTileNumbers

setDrawBorder

setDrawCrosshair

setDrawOverlay

setDrawTileNumbers

getColorBackground

setColorBackground

getColorBorder

setColorBorder

getColorTilenumbers

setColorTilenumbers

getColorCrosshair

setColorCrosshair

getTileConfig

getOverlayTileConfig

dispatchRepaint

setDragging

setDragGestureListener

addTileConfigListener

addOverlayTileConfigListener

triggerTileConfigListeners

triggerOverlayTileConfigListeners

addPaintListener

removePaintListener

setMouseListeners

componentResized

componentMoved

componentShown

componentHidden

mouseDragged

mouseMoved

mouseClicked

mousePressed

mouseReleased