dip.gui.order
Class GUIOrder.MapInfo

java.lang.Object
  dip.gui.order.GUIOrder.MapInfo

Direct Known Subclasses:

DefaultMapRenderer2.DMRMapInfo

Enclosing class:

GUIOrder

public abstract static class GUIOrder.MapInfo

extends java.lang.Object

Allows GUIOrder objects to ascertain information about other GUIOrders and obtain Map metadata information.

Field Summary

protected TurnState

ts

Constructor Summary

protected	GUIOrder.MapInfo() Do-nothing constructor
	GUIOrder.MapInfo(TurnState ts) Creates a MapInfo object

Method Summary

Power[]	getDisplayablePowers() Array of Powers whose orders are displayed; if not in array, order is hidden.
abstract org.w3c.dom.svg.SVGDocument	getDocument() Gets the SVG Document
abstract MapMetadata	getMapMetadata() Get MapMetadata information
abstract java.lang.String	getPowerCSS(Power power) Gets the CSS style for a given Power
abstract org.w3c.dom.svg.SVGGElement	getPowerSVGGElement(Power p, int z) Gets the SVG G Element for this power, under which an order should be drawn.
abstract java.lang.String	getSymbolName(Unit.Type unitType) Gets the Symbol Name for a given unit type
TurnState	getTurnState() Get TurnState (to get Orders, Phase, Position, etc.)
abstract java.lang.String	getUnitCSS(Power power) Gets the CSS style for a given Power's units
boolean	isReviewMode() Flag indicating if we are in review mode

Methods inherited from class java.lang.Object

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

Field Detail

ts

protected TurnState ts

Constructor Detail

GUIOrder.MapInfo

public GUIOrder.MapInfo(TurnState ts)

Creates a MapInfo object

GUIOrder.MapInfo

protected GUIOrder.MapInfo()

Do-nothing constructor

Method Detail

getMapMetadata

public abstract MapMetadata getMapMetadata()

Get MapMetadata information

getTurnState

public TurnState getTurnState()

Get TurnState (to get Orders, Phase, Position, etc.)

getPowerCSS

public abstract java.lang.String getPowerCSS(Power power)

Gets the CSS style for a given Power

getUnitCSS

public abstract java.lang.String getUnitCSS(Power power)

Gets the CSS style for a given Power's units

getSymbolName

public abstract java.lang.String getSymbolName(Unit.Type unitType)

Gets the Symbol Name for a given unit type

getDocument

public abstract org.w3c.dom.svg.SVGDocument getDocument()

Gets the SVG Document

isReviewMode

public boolean isReviewMode()

Flag indicating if we are in review mode

getDisplayablePowers

public Power[] getDisplayablePowers()

Array of Powers whose orders are displayed; if not in array, order is hidden. Should not return null. If we are in a resolved turnstate, this should reuturn all powers. This method should never return null. This method must be overridden.

getPowerSVGGElement

public abstract org.w3c.dom.svg.SVGGElement getPowerSVGGElement(Power p,
                                                                int z)

Gets the SVG G Element for this power, under which an order should be drawn.