Package net.sf.gridarta.gui.map.renderer
Class AbstractMapRenderer<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>>
- java.lang.Object
-
- java.awt.Component
-
- java.awt.Container
-
- javax.swing.JComponent
-
- net.sf.gridarta.gui.map.renderer.AbstractMapRenderer<G,A,R>
-
- All Implemented Interfaces:
java.awt.image.ImageObserver
,java.awt.MenuContainer
,java.io.Serializable
,MapRenderer
- Direct Known Subclasses:
AbstractFlatMapRenderer
,AbstractIsoMapRenderer
,AbstractSimpleIsoMapRenderer
,SimpleFlatMapRenderer
public abstract class AbstractMapRenderer<G extends GameObject<G,A,R>,A extends MapArchObject<A>,R extends Archetype<G,A,R>> extends javax.swing.JComponent implements MapRenderer
Abstract base class for classes implementingMapRenderer
.- See Also:
- Serialized Form
-
-
Field Summary
-
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
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
AbstractMapRenderer(@NotNull MapModel<G,A,R> mapModel, @Nullable GameObjectParser<G,A,R> gameObjectParser)
Creates a new instance.
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
closeNotify()
Must be called when this renderer is not used anymore.@Nullable java.lang.String
getToolTipText(@NotNull java.awt.event.MouseEvent event)
protected boolean
isLightVisible()
Returns whether the setting for lighted map squares should be inverted.void
printFullImage(@NotNull java.io.File file)
Saves an image of the entire view to a file.void
setErroneousMapSquares(@NotNull java.util.Map<MapSquare<G,A,R>,ValidationError<G,A,R>> erroneousMapSquares)
Sets the MapSquares that are known to contain errors.void
setLightVisible(boolean lightVisible)
If set, inverts the setting ofMapViewSettings.isLightVisible()
.-
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, getTopLevelAncestor, getTransferHandler, getUI, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, isDoubleBuffered, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingForPrint, isPaintingOrigin, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, 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, getAccessibleContext, 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, 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, requestFocus, requestFocus, requestFocusInWindow, resize, resize, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setMixingCutoutShape, 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
-
Methods inherited from interface net.sf.gridarta.gui.map.renderer.MapRenderer
addMouseListener, addMouseMotionListener, forceRepaint, getFullImage, getSquareBounds, getSquareLocationAt, removeMouseListener, removeMouseMotionListener, scrollRectToVisible
-
-
-
-
Constructor Detail
-
AbstractMapRenderer
protected AbstractMapRenderer(@NotNull @NotNull MapModel<G,A,R> mapModel, @Nullable @Nullable GameObjectParser<G,A,R> gameObjectParser)
Creates a new instance.- Parameters:
mapModel
- the rendered map modelgameObjectParser
- the game object parser for generating tooltip information ornull
-
-
Method Detail
-
printFullImage
public void printFullImage(@NotNull @NotNull java.io.File file) throws java.io.IOException
Description copied from interface:MapRenderer
Saves an image of the entire view to a file.- Specified by:
printFullImage
in interfaceMapRenderer
- Parameters:
file
- file to write image file to- Throws:
java.io.IOException
- in case of I/O problems
-
setErroneousMapSquares
public void setErroneousMapSquares(@NotNull @NotNull java.util.Map<MapSquare<G,A,R>,ValidationError<G,A,R>> erroneousMapSquares)
Sets the MapSquares that are known to contain errors.- Parameters:
erroneousMapSquares
- the MapSquares that are known to contain errors
-
closeNotify
public abstract void closeNotify()
Must be called when this renderer is not used anymore.
-
getToolTipText
@Nullable public @Nullable java.lang.String getToolTipText(@NotNull @NotNull java.awt.event.MouseEvent event)
- Overrides:
getToolTipText
in classjavax.swing.JComponent
- No Inspection:
- RefusedBequest
-
setLightVisible
public void setLightVisible(boolean lightVisible)
Description copied from interface:MapRenderer
If set, inverts the setting ofMapViewSettings.isLightVisible()
.- Specified by:
setLightVisible
in interfaceMapRenderer
- Parameters:
lightVisible
- whether lighted map squares are inverted
-
isLightVisible
protected boolean isLightVisible()
Returns whether the setting for lighted map squares should be inverted.- Returns:
- whether the setting should be inverted
-
-