dip.gui.map
Class MapPanel

java.lang.Object
  java.awt.Component
      java.awt.Container
          javax.swing.JComponent
              javax.swing.JPanel
                  dip.gui.map.MapPanel

All Implemented Interfaces:

javax.accessibility.Accessible, java.awt.image.ImageObserver, java.awt.MenuContainer, java.io.Serializable

public class MapPanel

extends javax.swing.JPanel

The Main Map display component.

Takes care of setting up the Batik rendering component, as well as loading the map (in concert with SymbolInjector)

This is also the container for the Control Bar.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class javax.swing.JPanel

javax.swing.JPanel.AccessibleJPanel

Nested classes inherited from class javax.swing.JComponent

javax.swing.JComponent.AccessibleJComponent

Nested classes inherited from class java.awt.Container

java.awt.Container.AccessibleAWTContainer

Nested classes inherited from class java.awt.Component

java.awt.Component.AccessibleAWTComponent, java.awt.Component.BltBufferStrategy, java.awt.Component.FlipBufferStrategy

Field Summary

static java.awt.Cursor	BAD_ACTION Cursor for display when order input is invalid.
static java.awt.Cursor	CURSOR_DRAG_ARMY
static java.awt.Cursor	CURSOR_DRAG_ARMY_NO
static java.awt.Cursor	CURSOR_DRAG_FLEET
static java.awt.Cursor	CURSOR_DRAG_FLEET_NO
static java.awt.Cursor	CURSOR_DRAG_WING
static java.awt.Cursor	CURSOR_DRAG_WING_NO
static java.awt.Cursor	DEFAULT_CURSOR Default cursor
static float	DEFAULT_SCALE_FACTOR Default scale factor
protected long	startTime
protected StatusBarUtils	statusBarUtils

Fields inherited from class javax.swing.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 java.awt.Component

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

MapPanel(ClientFrame clientFrame)
Creates a MapPanel

Method Summary

void	close() Release any resources held by this component / reset state
ClientFrame	getClientFrame()
ControlBar	getControlBar() Gets the current ControlBar
protected DOMUIEventListener	getDOMUIEventListener() DOMUI event hook
org.apache.batik.swing.JSVGCanvas	getJSVGCanvas() Get JSVGCanvas
MapMetadata	getMapMetadata() Convenience method: get the MapMetadata object
MapRenderer2	getMapRenderer() Convenience method: get the map renderer.
OrderDisplayPanel	getOrderDisplayPanel() Convenience method: get the order display panel.
Position	getPosition() Get the current Position
RenderCommandFactory	getRenderCommandFactory() Convenience method: get map renderer command factory class.
RuleOptions	getRuleOptions() Gets the RuleOptions
float	getScaleFactor() Gets the map scale factor (for zooming)
java.awt.Dimension	getScrollerSize() Get the current Scroller container size
StatusBar	getStatusBar() Convenience method: get the status bar
StatusBarUtils	getStatusBarUtils() Convenience method: get the status bar utility class
org.w3c.dom.svg.SVGDocument	getSVGDocument() Get SVGDocument [may be null!]
TurnState	getTurnState() Get the current TurnState
java.lang.String	getURI() gets URI of current document
World	getWorld() Convenience method: get the World
XJSVGCanvas	getXJSVGCanvas() Get XJSVGCanvas
void	reloadMap() Reloads the map, using the map URI as defined in World.
void	setControlBar(ControlBar cb) Explicitly set a ControlBar.
protected void	setDOMUIEventListener(DOMUIEventListener domEventListener) DOMUI event hook
void	setMapCursor(java.awt.Cursor cursor) Sets the cursor over the JSVGScrollCanvas.
void	updateProvince(Province province) Convenience method: updates the rendering of a province.

Methods inherited from class javax.swing.JPanel

getAccessibleContext, getUI, getUIClassID, paramString, setUI, updateUI

Methods inherited from class javax.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, disable, enable, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getActionForKeyStroke, getActionMap, getAlignmentX, getAlignmentY, getAncestorListeners, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getDefaultLocale, getGraphics, getHeight, getInputMap, getInputMap, getInputVerifier, getInsets, getInsets, getListeners, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getPropertyChangeListeners, getPropertyChangeListeners, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getTransferHandler, getVerifyInputWhenFocusTarget, getVetoableChangeListeners, getVisibleRect, getWidth, getX, getY, grabFocus, isDoubleBuffered, isLightweightComponent, isManagingFocus, isMaximumSizeSet, isMinimumSizeSet, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isPreferredSizeSet, isRequestFocusEnabled, isValidateRoot, paint, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, print, printAll, printBorder, printChildren, printComponent, processComponentKeyEvent, processKeyBinding, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, requestFocus, requestFocusInWindow, requestFocusInWindow, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setActionMap, setAlignmentX, setAlignmentY, setAutoscrolls, setBackground, setBorder, setDebugGraphicsOptions, setDefaultLocale, setDoubleBuffered, setEnabled, setFont, setForeground, 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, applyComponentOrientation, areFocusTraversalKeysSet, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getComponent, getComponentAt, getComponentAt, getComponentCount, getComponents, getContainerListeners, getFocusTraversalKeys, getFocusTraversalPolicy, getLayout, insets, invalidate, isAncestorOf, isFocusCycleRoot, isFocusCycleRoot, isFocusTraversalPolicySet, layout, list, list, locate, minimumSize, paintComponents, preferredSize, printComponents, processContainerEvent, processEvent, remove, remove, removeAll, removeContainerListener, setFocusCycleRoot, setFocusTraversalKeys, setFocusTraversalPolicy, setLayout, transferFocusBackward, 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, getBackground, getBounds, getColorModel, getComponentListeners, getComponentOrientation, getCursor, getDropTarget, getFocusCycleRootAncestor, getFocusListeners, getFocusTraversalKeysEnabled, getFont, getFontMetrics, getForeground, getGraphicsConfiguration, getHierarchyBoundsListeners, getHierarchyListeners, getIgnoreRepaint, getInputContext, getInputMethodListeners, getInputMethodRequests, getKeyListeners, getLocale, getLocation, getLocationOnScreen, getMouseListeners, getMouseMotionListeners, getMouseWheelListeners, getName, getParent, getPeer, getSize, getToolkit, getTreeLock, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, isBackgroundSet, isCursorSet, isDisplayable, isEnabled, isFocusable, isFocusOwner, isFocusTraversable, isFontSet, isForegroundSet, isLightweight, 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, processMouseEvent, processMouseWheelEvent, remove, removeComponentListener, removeFocusListener, removeHierarchyBoundsListener, removeHierarchyListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeMouseWheelListener, 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 java.lang.Object

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

Field Detail

DEFAULT_CURSOR

public static final java.awt.Cursor DEFAULT_CURSOR

Default cursor

BAD_ACTION

public static final java.awt.Cursor BAD_ACTION

Cursor for display when order input is invalid.

CURSOR_DRAG_ARMY

public static final java.awt.Cursor CURSOR_DRAG_ARMY

CURSOR_DRAG_FLEET

public static final java.awt.Cursor CURSOR_DRAG_FLEET

CURSOR_DRAG_WING

public static final java.awt.Cursor CURSOR_DRAG_WING

CURSOR_DRAG_ARMY_NO

public static final java.awt.Cursor CURSOR_DRAG_ARMY_NO

CURSOR_DRAG_FLEET_NO

public static final java.awt.Cursor CURSOR_DRAG_FLEET_NO

CURSOR_DRAG_WING_NO

public static final java.awt.Cursor CURSOR_DRAG_WING_NO

DEFAULT_SCALE_FACTOR

public static final float DEFAULT_SCALE_FACTOR

Default scale factor

See Also:

Constant Field Values

statusBarUtils

protected final StatusBarUtils statusBarUtils

startTime

protected long startTime

Constructor Detail

MapPanel

public MapPanel(ClientFrame clientFrame)

Creates a MapPanel

Method Detail

getScrollerSize

public java.awt.Dimension getScrollerSize()

Get the current Scroller container size

getURI

public java.lang.String getURI()

gets URI of current document

getJSVGCanvas

public org.apache.batik.swing.JSVGCanvas getJSVGCanvas()

Get JSVGCanvas

getXJSVGCanvas

public XJSVGCanvas getXJSVGCanvas()

Get XJSVGCanvas

getScaleFactor

public float getScaleFactor()

Gets the map scale factor (for zooming)

getClientFrame

public final ClientFrame getClientFrame()

getOrderDisplayPanel

public OrderDisplayPanel getOrderDisplayPanel()

Convenience method: get the order display panel.

getMapRenderer

public MapRenderer2 getMapRenderer()

Convenience method: get the map renderer.

getMapMetadata

public MapMetadata getMapMetadata()

Convenience method: get the MapMetadata object

getRenderCommandFactory

public RenderCommandFactory getRenderCommandFactory()

Convenience method: get map renderer command factory class.

getStatusBar

public StatusBar getStatusBar()

Convenience method: get the status bar

getStatusBarUtils

public StatusBarUtils getStatusBarUtils()

Convenience method: get the status bar utility class

getWorld

public World getWorld()

Convenience method: get the World

setDOMUIEventListener

protected void setDOMUIEventListener(DOMUIEventListener domEventListener)

DOMUI event hook

getDOMUIEventListener

protected DOMUIEventListener getDOMUIEventListener()

DOMUI event hook

setControlBar

public void setControlBar(ControlBar cb)

Explicitly set a ControlBar. If null, uses the default ControlBar, which has no buttons and does nothing.

getControlBar

public ControlBar getControlBar()

Gets the current ControlBar

setMapCursor

public void setMapCursor(java.awt.Cursor cursor)

Sets the cursor over the JSVGScrollCanvas.

NOTE: this is currently disabled for OS X due to weird bugs.

getSVGDocument

public org.w3c.dom.svg.SVGDocument getSVGDocument()

Get SVGDocument [may be null!]

getPosition

public Position getPosition()

Get the current Position

getTurnState

public TurnState getTurnState()

Get the current TurnState

getRuleOptions

public RuleOptions getRuleOptions()

Gets the RuleOptions

close

public void close()

Release any resources held by this component / reset state

updateProvince

public void updateProvince(Province province)

Convenience method: updates the rendering of a province.

reloadMap

public void reloadMap()

Reloads the map, using the map URI as defined in World. This is most useful if the map URI has changed.