Class HexMap

java.lang.Object

java.awt.Component

java.awt.Container

javax.swing.JComponent

javax.swing.JPanel

net.sf.colossus.client.HexMap

All Implemented Interfaces:

ImageObserver, MenuContainer, Serializable, Accessible

Direct Known Subclasses:

BattleMap, PickEntrySide, ShowBattleMap

public class HexMap
extends JPanel

Class HexMap displays a basic battle map.

Author:

David Ripton, Romain Dolbeau

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

Modifier and Type	Field	Description
private String	basicName
protected final int	cx
protected final int	cy
private String	displayName
private final GUIBattleHex[]	entrances	ne, e, se, sw, w, nw
protected final GUIBattleHex[][]	h
protected final List<GUIBattleHex>	hexes
private static final Logger	LOGGER
private final MasterHex	masterHex
private final int	scale
private String	subtitle
static final boolean[][]	VISIBLE_HEXES

Fields inherited from class JComponent

listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class Component

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

Constructors

Constructor	Description
HexMap(MasterHex masterHex)
HexMap(MasterHex masterHex, boolean doSetup)

Method Summary

Modifier and Type	Method	Description
protected Set<BattleHex>	getAllHexes()
String	getBasicName()
String	getDisplayName()
protected GUIBattleHex	getGUIHexByModelHex(BattleHex battleHex)	Do a brute-force search through the hex array, looking for a match.
BattleHex	getHexByLabel(String hexLabel)
protected GUIBattleHex	getHexContainingPoint(Point point)	Return the GUIBattleHex that contains the given point, or null if none does.
protected MasterHex	getMasterHex()
Dimension	getMinimumSize()
Dimension	getPreferredSize()
String	getSubtitle()
void	paintComponent(Graphics g)
protected void	selectHex(BattleHex battleHex)
protected void	selectHexes(Set<BattleHex> battleHexes)
void	setBasicName(String basicName)
void	setDisplayName(String displayName)
void	setSubtitle(String subtitle)
private void	setupEntrances()
private void	setupEntrancesGUI()
protected void	setupHexes()
private static void	setupHexesGameState(MasterBoardTerrain masterBoardTerrain, GUIBattleHex[][] h, boolean serverSideFirstLoad)	Add terrain, hexsides, elevation, and exits to hexes.
protected final void	setupHexesGUI()
protected static final void	setupNeighbors(GUIBattleHex[][] h)	Add references to neighbor hexes.
protected void	unselectAllHexes()
protected void	unselectHex(BattleHex battleHex)

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, getNextFocusableComponent, getPopupLocation, 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, 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, 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, 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 Object

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

Field Details

LOGGER

private static final Logger LOGGER

masterHex

private final MasterHex masterHex

h

protected final GUIBattleHex[][] h

hexes

protected final List<GUIBattleHex> hexes

entrances

private final GUIBattleHex[] entrances

ne, e, se, sw, w, nw

VISIBLE_HEXES

public static final boolean[][] VISIBLE_HEXES

scale

private final int scale

cx

protected final int cx

cy

protected final int cy

displayName

private String displayName

basicName

private String basicName

subtitle

private String subtitle

Constructor Details

HexMap

public HexMap(MasterHex masterHex)

HexMap

public HexMap(MasterHex masterHex,
 boolean doSetup)

Method Details

getMasterHex

protected MasterHex getMasterHex()

setupHexes

protected void setupHexes()

setupHexesGUI

protected final void setupHexesGUI()

setupHexesGameState

private static void setupHexesGameState(MasterBoardTerrain masterBoardTerrain,
 GUIBattleHex[][] h,
 boolean serverSideFirstLoad)

Add terrain, hexsides, elevation, and exits to hexes. Cliffs are bidirectional; other hexside obstacles are noted only on the high side, since they only interfere with uphill movement.

setupNeighbors

protected static final void setupNeighbors(GUIBattleHex[][] h)

Add references to neighbor hexes.

setupEntrances

private void setupEntrances()

setupEntrancesGUI

private void setupEntrancesGUI()

unselectAllHexes

protected void unselectAllHexes()

unselectHex

protected void unselectHex(BattleHex battleHex)

selectHex

protected void selectHex(BattleHex battleHex)

selectHexes

protected void selectHexes(Set<BattleHex> battleHexes)

getGUIHexByModelHex

protected GUIBattleHex getGUIHexByModelHex(BattleHex battleHex)

Do a brute-force search through the hex array, looking for a match. Return the hex, or null.

getHexByLabel

public BattleHex getHexByLabel(String hexLabel)

getHexContainingPoint

protected GUIBattleHex getHexContainingPoint(Point point)

Return the GUIBattleHex that contains the given point, or null if none does.

getAllHexes

protected Set<BattleHex> getAllHexes()

paintComponent

public void paintComponent(Graphics g)

Overrides:

paintComponent in class JComponent

getMinimumSize

public Dimension getMinimumSize()

Overrides:

getMinimumSize in class JComponent

getPreferredSize

public Dimension getPreferredSize()

Overrides:

getPreferredSize in class JComponent

getBasicName

public String getBasicName()

Returns:

the basicName

setBasicName

public void setBasicName(String basicName)

Parameters:

basicName - the basicName to set

getDisplayName

public String getDisplayName()

Returns:

the displayName

setDisplayName

public void setDisplayName(String displayName)

Parameters:

displayName - the displayName to set

getSubtitle

public String getSubtitle()

Returns:

the subtitle

setSubtitle

public void setSubtitle(String subtitle)

Parameters:

subtitle - the subtitle to set