com.realtime.crossfire.jxclient.gui.map

Class GUIMap

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement

com.realtime.crossfire.jxclient.gui.map.AbstractGUIMap

com.realtime.crossfire.jxclient.gui.map.GUIMap

All Implemented Interfaces:

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

public class GUIMap
extends AbstractGUIMap

Display the map view. It supports both normal sized (32x32 pixel) and double sized (64x64 pixel) sized tiles.

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

Modifier and Type	Field and Description
private CrossfireServerConnection	crossfireServerConnection The CrossfireServerConnection to monitor.
private static long	serialVersionUID The serial version UID.
private int	tileSize The size of one tile.

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
GUIMap(boolean avoidCopyArea, TooltipManager tooltipManager, GUIElementListener elementListener, java.lang.String name, MapUpdaterState mapUpdaterState, FacesProvider facesProvider, CrossfireServerConnection crossfireServerConnection, SmoothFaces smoothFaces, DarknessColors darknessColors) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
int	getPreferredMapHeight() Returns the minimal map height in squares needed to fill the map area.
int	getPreferredMapWidth() Returns the minimal map width in squares needed to fill the map area.
java.awt.Dimension	getPreferredSize()
protected void	markPlayer(java.awt.Graphics g, int dx, int dy) Paints the player location.
void	mouseClicked(java.awt.event.MouseEvent e) Will be called when the user has clicked (pressed+released) this element.
protected void	paintSquareBackground(java.awt.Graphics g, int px, int py, boolean hasImage, CfMapSquare mapSquare) Paints the background of a map square.

Methods inherited from class com.realtime.crossfire.jxclient.gui.map.AbstractGUIMap

dispose, getMapHeight, getMapWidth, getMinimumSize, getOffsetX, getOffsetY, getPlayerX, getPlayerY, paintColoredSquare, paintComponent, redrawSquare, setBounds

Methods inherited from class com.realtime.crossfire.jxclient.gui.gui.AbstractGUIElement

getName, hasTooltipText, isDefault, isIgnore, mouseDragged, mouseEntered, mouseExited, mouseMoved, mousePressed, mouseReleased, setChanged, setChangedListener, setDefault, setIgnore, setTooltipText, setTooltipText, toString

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, getNextFocusableComponent, getPopupLocation, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getUIClassID, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, hide, 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, 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, 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, setComponentOrientation, setCursor, setDropTarget, setFocusable, setFocusTraversalKeysEnabled, setIgnoreRepaint, setLocale, setLocation, setLocation, setName, setSize, setSize, show, show, size, transferFocus, transferFocusBackward, transferFocusUpCycle

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

crossfireServerConnection

@NotNull
private final CrossfireServerConnection crossfireServerConnection

The CrossfireServerConnection to monitor.

serialVersionUID

private static final long serialVersionUID

The serial version UID.

See Also:

Constant Field Values

tileSize

private final int tileSize

The size of one tile.

Constructor Detail

GUIMap

public GUIMap(boolean avoidCopyArea,
              @NotNull
              TooltipManager tooltipManager,
              @NotNull
              GUIElementListener elementListener,
              @NotNull
              java.lang.String name,
              @NotNull
              MapUpdaterState mapUpdaterState,
              @NotNull
              FacesProvider facesProvider,
              @NotNull
              CrossfireServerConnection crossfireServerConnection,
              @NotNull
              SmoothFaces smoothFaces,
              @NotNull
              DarknessColors darknessColors)

Creates a new instance.

Parameters:

avoidCopyArea - whether map scrolling is done by copying pixel areas; if unset, always repaint all map squares

tooltipManager - the tooltip manager to update

elementListener - the element listener to notify

name - the name of this element

mapUpdaterState - the map updater state instance to use

facesProvider - the faces provider for looking up faces

crossfireServerConnection - the server connection to monitor

smoothFaces - the smooth faces to use

darknessColors - the darkness colors instance for converting darkness values into colors

Method Detail

getPreferredMapHeight

public int getPreferredMapHeight()

Returns the minimal map height in squares needed to fill the map area.

Returns:

the map height in squares

getPreferredMapWidth

public int getPreferredMapWidth()

Returns the minimal map width in squares needed to fill the map area.

Returns:

the map width in squares

getPreferredSize

@Nullable
public java.awt.Dimension getPreferredSize()

Overrides:

getPreferredSize in class javax.swing.JComponent

markPlayer

protected void markPlayer(@NotNull
                          java.awt.Graphics g,
                          int dx,
                          int dy)

Paints the player location.

Specified by:

markPlayer in class AbstractGUIMap

Parameters:

g - the graphics to paint to

dx - the x distance to map has just scrolled

dy - the y distance to map has just scrolled

mouseClicked

public void mouseClicked(@NotNull
                         java.awt.event.MouseEvent e)

Will be called when the user has clicked (pressed+released) this element. This event will be delivered after GUIElement.mouseReleased(MouseEvent).

Specified by:

mouseClicked in interface GUIElement

Overrides:

mouseClicked in class AbstractGUIElement

Parameters:

e - the mouse event relative to this element

paintSquareBackground

protected void paintSquareBackground(@NotNull
                                     java.awt.Graphics g,
                                     int px,
                                     int py,
                                     boolean hasImage,
                                     @NotNull
                                     CfMapSquare mapSquare)

Paints the background of a map square.

Specified by:

paintSquareBackground in class AbstractGUIMap

Parameters:

g - the graphics to paint into

px - the x-offset for painting

py - the y-offset for painting

hasImage - whether the square contains at least one image

mapSquare - the map square