Uses of Class
dip.world.Location

Packages that use Location

dip.gui.map
dip.gui.order
dip.order
dip.order.result
dip.process
dip.world

Uses of Location in dip.gui.map

Methods in dip.gui.map that return Location

abstract Location	MapRenderer2.getLocation(java.lang.String id) Get a location that corresponds to an ID
Location	DefaultMapRenderer2.getLocation(java.lang.String id) Gets the location that corresponds to a given string id Assumes ID is lowercase!

Methods in dip.gui.map with parameters of type Location

void	ViewControlBar.mouseOver(org.w3c.dom.events.MouseEvent me, Location loc) Called when the mouse pointer enters a province
void	ViewControlBar.mouseOut(org.w3c.dom.events.MouseEvent me, Location loc) Called when the mouse pointer leaves a province
void	ViewControlBar.keyPressed(org.apache.batik.dom.events.DOMKeyEvent ke, Location loc) Handles ZoomIn / ZoomOut / Revert key functionality.
void	StatusBarUtils.displayProvinceInfo(Location loc) Convenience version of displayProvinceInfo(Location, null)
void	StatusBarUtils.displayProvinceInfo(Location loc, java.lang.String appendText) Suitable for mouseOver events Displays Province information.
void	OrderControlBar.mouseOver(org.w3c.dom.events.MouseEvent me, Location loc) Dispatch mouse over events
void	OrderControlBar.mouseOut(org.w3c.dom.events.MouseEvent me, Location loc) Dispatch mouse out events
void	OrderControlBar.mouseClicked(org.w3c.dom.events.MouseEvent me, Location loc) Dispatch mouse click events
void	OrderControlBar.doOrder(org.w3c.dom.events.MouseEvent me, Location loc) Called when the user is attempting to start (by clicking or initiating a drag) or complete (by clicking again or dropping) an order.
void	OrderControlBar.mouseDown(org.w3c.dom.events.MouseEvent me, Location loc) Description of the Method
void	OrderControlBar.mouseUp(org.w3c.dom.events.MouseEvent me, Location loc) Description of the Method
void	OrderControlBar.keyPressed(org.apache.batik.dom.events.DOMKeyEvent dke, Location loc) Handle DOM keyPress events
protected void	OrderControlBar.setGUIOrder(Location loc) Creates a new GUIOrder subclass based upon the currently selected order.
void	EditControlBar.mouseOver(org.w3c.dom.events.MouseEvent me, Location loc) Determines if a Province is click-worthy, depending upon the selected mode.
void	EditControlBar.mouseOut(org.w3c.dom.events.MouseEvent me, Location loc) Handles mouseOut()
void	EditControlBar.mouseClicked(org.w3c.dom.events.MouseEvent me, Location loc) Handle mouse clicks on the map
void	EditControlBar.doAction(org.w3c.dom.events.MouseEvent me, Location loc)
boolean	EditControlBar.checkValidity(Location loc)
void	DOMUIEventHandler.keyPressed(org.apache.batik.dom.events.DOMKeyEvent ke, Location loc) Key Pressed event
void	DOMUIEventHandler.mouseOver(org.w3c.dom.events.MouseEvent me, Location loc) Mouse Over event: Mouse over a province
void	DOMUIEventHandler.mouseOut(org.w3c.dom.events.MouseEvent me, Location loc) Mouse Out event: Mouse out of a province
void	DOMUIEventHandler.mouseClicked(org.w3c.dom.events.MouseEvent me, Location loc) Mouse clicked
void	DOMUIEventHandler.mouseDown(org.w3c.dom.events.MouseEvent me, Location loc) Mouse button pressed
void	DOMUIEventHandler.mouseUp(org.w3c.dom.events.MouseEvent me, Location loc) Mouse button released
void	ControlBar.keyPressed(org.apache.batik.dom.events.DOMKeyEvent ke, Location loc) Key Pressed event.
void	ControlBar.mouseOver(org.w3c.dom.events.MouseEvent me, Location loc) Mouse Over event: Mouse over a province.
void	ControlBar.mouseOut(org.w3c.dom.events.MouseEvent me, Location loc) Mouse Out event: Mouse out of a province.
void	ControlBar.mouseClicked(org.w3c.dom.events.MouseEvent me, Location loc) Mouse clicked.
void	ControlBar.mouseDown(org.w3c.dom.events.MouseEvent me, Location loc) Mouse button pressed.
void	ControlBar.mouseUp(org.w3c.dom.events.MouseEvent me, Location loc) Mouse button released.

Uses of Location in dip.gui.order

Methods in dip.gui.order with parameters of type Location

boolean	GUIWaive.testLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUIWaive.setLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUISupport.testLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUISupport.setLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUIRetreat.testLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUIRetreat.setLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUIRemove.testLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUIRemove.setLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
Hold	GUIOrderFactory.createHold(Power power, Location source, Unit.Type sourceUnitType) Creates a GUIHold order
Move	GUIOrderFactory.createMove(Power power, Location source, Unit.Type srcUnitType, Location dest) Creates a GUIMove order
Move	GUIOrderFactory.createMove(Power power, Location source, Unit.Type srcUnitType, Location dest, boolean isConvoying) Creates a GUIMove order
Move	GUIOrderFactory.createMove(Power power, Location src, Unit.Type srcUnitType, Location dest, Province[] convoyRoute) Creates a GUIMove order
Move	GUIOrderFactory.createMove(Power power, Location src, Unit.Type srcUnitType, Location dest, java.util.List routes) Creates a GUIMove order
Support	GUIOrderFactory.createSupport(Power power, Location src, Unit.Type srcUnitType, Location supSrc, Power supPower, Unit.Type supUnitType) Creates a GUISupport order, to Support a unit staying in place.
Support	GUIOrderFactory.createSupport(Power power, Location src, Unit.Type srcUnitType, Location supSrc, Power supPower, Unit.Type supUnitType, Location supDest) Creates a GUISupport order, to Support a unit moving (or staying in place, if supDest == null)
Convoy	GUIOrderFactory.createConvoy(Power power, Location src, Unit.Type srcUnitType, Location convoySrc, Power convoyPower, Unit.Type convoySrcUnitType, Location convoyDest) Creates a GUIConvoy order
Retreat	GUIOrderFactory.createRetreat(Power power, Location source, Unit.Type srcUnitType, Location dest) Creates a GUIRetreat order
Disband	GUIOrderFactory.createDisband(Power power, Location source, Unit.Type sourceUnitType) Creates a GUIDisband order
Build	GUIOrderFactory.createBuild(Power power, Location source, Unit.Type sourceUnitType) Creates a GUIBuild order
Remove	GUIOrderFactory.createRemove(Power power, Location source, Unit.Type sourceUnitType) Creates a GUIRemove order
Waive	GUIOrderFactory.createWaive(Power power, Location source) Creates a GUIWaive order
DefineState	GUIOrderFactory.createDefineState(Power power, Location source, Unit.Type sourceUnitType) Creates a GUIDefineState order
boolean	GUIOrder.testLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb) Tests if a given location is valid.
boolean	GUIOrder.setLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb) Sets the current location.
boolean	GUIMoveExplicit.testLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUIMoveExplicit.setLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUIMove.testLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUIMove.setLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUIHold.testLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUIHold.setLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUIDisband.testLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUIDisband.setLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUIDefineState.testLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb) Always returns false.
boolean	GUIDefineState.setLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb) Always returns false.
boolean	GUIConvoy.testLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUIConvoy.setLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUIBuild.testLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)
boolean	GUIBuild.setLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb)

Constructors in dip.gui.order with parameters of type Location

GUIWaive(Power power, Location source)
Creates a GUIWaive

GUISupport(Power power, Location src, Unit.Type srcUnitType, Location supSrc, Power supPower, Unit.Type supUnitType)
Creates a GUISupport

GUISupport(Power power, Location src, Unit.Type srcUnitType, Location supSrc, Power supPower, Unit.Type supUnitType, Location supDest)
Creates a GUISupport

GUIRetreat(Power power, Location source, Unit.Type sourceUnitType, Location dest)
Creates a GUIRetreat

GUIRemove(Power power, Location source, Unit.Type sourceUnitType)
Creates a GUIRemove

GUIMoveExplicit(Power power, Location source, Unit.Type srcUnitType, Location dest, boolean isConvoying)
Creates a GUIMoveExplicit

GUIMoveExplicit(Power power, Location src, Unit.Type srcUnitType, Location dest, Province[] convoyRoute)
Creates a GUIMoveExplicit

GUIMoveExplicit(Power power, Location src, Unit.Type srcUnitType, Location dest, java.util.List routes)
Creates a GUIMoveExplicit

GUIMove(Power power, Location source, Unit.Type srcUnitType, Location dest, boolean isConvoying)
Creates a GUIMove

GUIMove(Power power, Location src, Unit.Type srcUnitType, Location dest, Province[] convoyRoute)
Creates a GUIMove

GUIMove(Power power, Location src, Unit.Type srcUnitType, Location dest, java.util.List routes)
Creates a GUIMove

GUIHold(Power power, Location source, Unit.Type sourceUnitType)
Creates a GUIHold

GUIDisband(Power power, Location source, Unit.Type sourceUnitType)
Creates a GUIDisband

GUIDefineState(Power power, Location source, Unit.Type sourceUnitType)
Creates a GUIDefineState

GUIConvoy(Power power, Location src, Unit.Type srcUnitType, Location convoySrc, Power convoyPower, Unit.Type convoySrcUnitType, Location convoyDest)
Creates a GUIConvoy

GUIBuild(Power power, Location source, Unit.Type sourceUnitType)
Creates a GUIBuild

Uses of Location in dip.order

Fields in dip.order declared as Location

protected Location	Support.supSrc
protected Location	Support.supDest
protected Location	Order.src Location of the ordered unit
protected Location	Move.dest
protected Location	Convoy.convoySrc
protected Location	Convoy.convoyDest

Methods in dip.order that return Location

Location	Support.getSupportedSrc() Returns the Location of the Unit we are Supporting
Location	Support.getSupportedDest() Returns the Location that we are Supporting into; if this is a non-move Support, this will return the same (referentially!)
Location	Orderable.getSource() Gets the Location of the ordered unit
Location	Order.getSource()
Location	Move.getDest() Returns the destination Location of this Move
Location	Convoy.getConvoySrc() Returns the Location of the Unit to be Convoyed
Location	Convoy.getConvoyDest() Returns the Location of the Convoy destination

Methods in dip.order with parameters of type Location

static java.lang.String	OrderFormat.format(OrderFormatOptions ofo, Location loc) Format a Location given the order formatting parameters.
abstract Hold	OrderFactory.createHold(Power power, Location source, Unit.Type sourceUnitType) Creates a Hold order
abstract Move	OrderFactory.createMove(Power power, Location source, Unit.Type srcUnitType, Location dest) Creates a Move order
abstract Move	OrderFactory.createMove(Power power, Location source, Unit.Type srcUnitType, Location dest, boolean isConvoying) Creates a Move order
abstract Move	OrderFactory.createMove(Power power, Location src, Unit.Type srcUnitType, Location dest, Province[] convoyRoute) Creates a Move order
abstract Move	OrderFactory.createMove(Power power, Location src, Unit.Type srcUnitType, Location dest, java.util.List routes) Creates a Move order
abstract Support	OrderFactory.createSupport(Power power, Location src, Unit.Type srcUnitType, Location supSrc, Power supPower, Unit.Type supUnitType) Creates a Support order, to Support a unit staying in place.
abstract Support	OrderFactory.createSupport(Power power, Location src, Unit.Type srcUnitType, Location supSrc, Power supPower, Unit.Type supUnitType, Location supDest) Creates a Support order, to Support a unit moving (or staying in place, if supDest == null)
abstract Convoy	OrderFactory.createConvoy(Power power, Location src, Unit.Type srcUnitType, Location convoySrc, Power convoyPower, Unit.Type convoySrcUnitType, Location convoyDest) Creates a Convoy order
abstract Retreat	OrderFactory.createRetreat(Power power, Location source, Unit.Type srcUnitType, Location dest) Creates a Retreat order
abstract Disband	OrderFactory.createDisband(Power power, Location source, Unit.Type sourceUnitType) Creates a Disband order
abstract Build	OrderFactory.createBuild(Power power, Location source, Unit.Type sourceUnitType) Creates a Build order
abstract Remove	OrderFactory.createRemove(Power power, Location source, Unit.Type sourceUnitType) Creates a Remove order
abstract Waive	OrderFactory.createWaive(Power power, Location source) Creates a Waive order
abstract DefineState	OrderFactory.createDefineState(Power power, Location source, Unit.Type sourceUnitType) Creates a DefineState order

Constructors in dip.order with parameters of type Location

Waive(Power power, Location src)
Creates a Waive order

Support(Power power, Location src, Unit.Type srcUnit, Location supSrc, Power supPower, Unit.Type supUnit)
Creates a Support order, for supporting a Hold or other non-movement order.

Support(Power power, Location src, Unit.Type srcUnit, Location supSrc, Power supPower, Unit.Type supUnit, Location supDest)
Creates a Support order, for Supporting a Move order.

Retreat(Power power, Location src, Unit.Type srcUnitType, Location dest)
Creates a Retreat order

Remove(Power power, Location src, Unit.Type srcUnit)
Creates a Remove order

Order(Power power, Location src, Unit.Type srcUnit)
Constructor for the Order object

Move(Power power, Location src, Unit.Type srcUnitType, Location dest)
Creates a Move order

Move(Power power, Location src, Unit.Type srcUnitType, Location dest, boolean isConvoying)
Creates a Move order, with optional convoy preference.

Move(Power power, Location src, Unit.Type srcUnitType, Location dest, Province[] convoyRoute)
Creates a Move order with an explicit convoy route.

Move(Power power, Location src, Unit.Type srcUnitType, Location dest, java.util.List routes)
Creates a Move order with multiple explicit convoy routes.

Hold(Power power, Location src, Unit.Type srcUnit)
Creates a Hold order

Disband(Power power, Location src, Unit.Type srcUnit)
Creates a Disband order

DefineState(Power power, Location src, Unit.Type srcUnit)

Convoy(Power power, Location src, Unit.Type srcUnit, Location convoySrc, Power convoyPower, Unit.Type convoyUnitType, Location convoyDest)
Creates a Convoy order

Build(Power power, Location src, Unit.Type srcUnit)
Creates a Build order

Uses of Location in dip.order.result

Methods in dip.order.result that return Location

Location[]

DislodgedResult.getRetreatLocations() Returns the valid retreat locations, if set.

Constructors in dip.order.result with parameters of type Location

DislodgedResult(Orderable order, Location[] retreatLocations)

DislodgedResult(Orderable order, java.lang.String message, Location[] retreatLocations)

Uses of Location in dip.process

Methods in dip.process that return Location

Location[]	RetreatChecker.getValidLocations(Location from) Gets all valid locations to which this unit may retreat.
Location	OrderState.getSource() Convenicent method: get the order source Location

Methods in dip.process with parameters of type Location

OrderState	StdAdjudicator.findOrderStateBySrc(Location location) Find the OrderState with the given source Province.
boolean	RetreatChecker.isValid(Location from, Location to) Determines if the unit located in from can retreat to the Location to
Location[]	RetreatChecker.getValidLocations(Location from) Gets all valid locations to which this unit may retreat.
boolean	RetreatChecker.hasRetreats(Location from) Returns 'true' if at least one valid retreat exists for the dislodged unit in 'from'
OrderState	Adjudicator.findOrderStateBySrc(Location location) Find the OrderState with the given source Province.

Uses of Location in dip.world

Fields in dip.world declared as Location

static Location[]

Location.EMPTY Constant defining an empty array of Location() objects

Methods in dip.world that return Location

Location[]	Province.getAllAdjacent() Get all the Locations that are adjacent to this province.
Location[]	Province.getAdjacentLocations(Coast coast) Gets the Locations adjacent to this province, given the specified coast.
protected Location[]	Province.Adjacency.getLocations(Coast coast) Gets the locations which are adjacent to the coast.
Location	Map.parseLocation(java.lang.String input) Parses text into a Location.
Location	Location.getValidatedWithMove(Unit.Type unitType, Location from) This extends the simple validate method, be performing additional checking for move orders.
Location	Location.getValidatedAndDerived(Unit.Type unitType, Unit existingUnit) This extends the simple getValidated() method, by performing additional validation/checking given turnstate information.
Location	Location.getValidatedSetup(Unit.Type unitType) This is mainly used for game setup (WorldFactory).
Location	Location.getValidated(Unit.Type unitType) Simple Validate This is typically used for support destinations, e.g.

Methods in dip.world with parameters of type Location

boolean	Province.isAdjacent(Coast sourceCoast, Location dest) Checks connectivity between this and another province This method only determines if the current Province with the specified coast is connected to the destination Province and Coast.
boolean	Province.canTransit(Location fromLoc, Unit.Type unit, Phase phase, java.lang.Class orderClass) Checks if unit can transit from a Location to this Province.
Border	Province.getTransit(Location fromLoc, Unit.Type unit, Phase phase, java.lang.Class orderClass) Checks if unit can transit from a Location to this Province.
int	Province.getBaseMoveModifier(Location fromLoc) Looks through borders to determine if there is a baseMoveModifier.
protected void	Province.Adjacency.setLocations(Coast coast, Location[] locations) Sets which locations are adjacent to the specified coast.
Tristate	Path.getConvoyRouteEvaluation(Move move, Location invalidLoc, java.util.List actualPath) Convenience Method.
static boolean	Path.isRouteValid(Position pos, Location src, Location dest, Province[] route) Checks a convoy route to see if it is 'theoretically' valid; this is true iff: route is non-null and length of 3 or more first and last route provinces match src and dest Location provinces first and last provinces are land all other provinces are convoyable (sea or convoyable coast) all convoyable locations have a fleet present route is composed of adjacent spaces
static Tristate	Path.evaluateRoutes(Adjudicator adj, java.util.List routes, Location invalid) Determines the adjudication status of static convoy route(s), that are both valid and legal (verified).
boolean	Path.isPossibleConvoyRoute(Location src, Location dest) Returns if there is a "theoretical" convoy route between src and dest.
java.util.List	Path.getConvoyRoute(Location src, Location dest) Returns a path (the first valid path) of a theoretical convoy route between src and dest.
boolean	Path.isLegalConvoyRoute(Location src, Location dest) Find if a true convoy route exists between src & dest; all fleets must have: a Convoy order, with convoy src/dest matching the src/dest given the evaluation state of the Convoy order must not be Tristate.FAILURE
java.util.List	Path.getLegalConvoyRoute(Location src, Location dest) Returns the true convoy route between src & dest; all fleets must have: a Convoy order, with convoy src/dest matching the src/dest given the evaluation state of the Convoy order must not be Tristate.FAILURE
Tristate	Path.getConvoyRouteEvaluation(Location src, Location dest, java.util.List validPath) Convenience version of getConvoyRouteEvaluation() where the 'invalid' Location is set to null.
Tristate	Path.getConvoyRouteEvaluation(Location src, Location dest, Location invalid, java.util.List validPath) The convoying fleet specified in 'invalid' is considered to fail.
protected boolean	Path.findPathBreadthFirst(Location src, Location dest, Location current, java.util.List path, Path.PathEvaluator pathEvaluator) Generalized recursive Path-Finder, Breadth-First search.
boolean	Path.PathEvaluator.evaluate(Location location)
boolean	Path.PathEvaluator.isAdjacentToDest(Location current, Location dest)
boolean	Path.AnyConvoyPathEvaluator.evaluate(Location location)
boolean	Path.AnyConvoyPathEvaluator.isAdjacentToDest(Location current, Location dest)
boolean	Location.isAdjacent(Location location) Determines if the two locations are adjacent (connected), taking coasts into account as well.
boolean	Location.isProvinceEqual(Location location) Returns true if the Province in both locations is equal, ignoring the coasts.
boolean	Location.equalsLoosely(Location loc) Determines if two Locations are "loosely" equal.
Location	Location.getValidatedWithMove(Unit.Type unitType, Location from) This extends the simple validate method, be performing additional checking for move orders.
boolean	Border.canTransit(Location fromLoc, Unit.Type unit, Phase phase, java.lang.Class orderClass) Determines if a unit can transit from a location to this location.
int	Border.getBaseMoveModifier(Location moveFrom) Gets the base move modifier.

Constructors in dip.world with parameters of type Location

Border(java.lang.String id, java.lang.String description, java.lang.String units, Location[] from, java.lang.String orders, java.lang.String baseMoveModifier, java.lang.String season, java.lang.String phase, java.lang.String year)
Constructor.