dip.gui.order
Class GUIRetreat

java.lang.Object
  dip.order.Order
      dip.order.Move
          dip.order.Retreat
              dip.gui.order.GUIRetreat

All Implemented Interfaces:

GUIOrder, Orderable, java.io.Serializable

public class GUIRetreat

extends Retreat

implements GUIOrder

GUIOrder subclass of Retreat order.

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class dip.gui.order.GUIOrder

GUIOrder.MapInfo, GUIOrder.Parameter, GUIOrder.StateInfo

Field Summary

Fields inherited from class dip.order.Move

_fmtIsAdjWithConvoy, _hasLandRoute, _isAdjWithPossibleConvoy, _isConvoyIntent, _isViaConvoy, convoyRoutes, dest

Fields inherited from class dip.order.Order

ORD_VAL_BORDER, power, src, srcUnitType

Fields inherited from interface dip.gui.order.GUIOrder

BORDER_INVALID, CANCELED, CLICK_TO_CANCEL, CLICK_TO_ISSUE, COMPLETE, LAYER_HIGHEST, LAYER_LOWEST, LAYER_TYPICAL, NO_DISLODGED_UNIT, NO_UNIT, NOT_IN_PROVINCE, NOT_OWNER

Constructor Summary

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

Method Summary

boolean	clearLocations() Clear all set locations.
void	deriveFrom(Orderable order) This only accepts Retreat orders.
int	getCurrentLocationNum() Returns the current Location set point, or 0 if no Locations have been set.
int	getNumRequiredLocations() Returns the number of required Location set points.
java.lang.Object	getParam(GUIOrder.Parameter param) Always throws an IllegalArgumentException
boolean	isComplete() Returns if all Locations have been set and the order is complete.
boolean	isDependent() Indicates if this order is dependent upon the state of other orders for drawing.
void	removeFromDOM(GUIOrder.MapInfo mapInfo) Removes order from the DOM
boolean	setLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb) Sets the current location.
void	setParam(GUIOrder.Parameter param, java.lang.Object value) Always throws an IllegalArgumentException
boolean	testLocation(GUIOrder.StateInfo stateInfo, Location location, java.lang.StringBuffer sb) Tests if a given location is valid.
void	updateDOM(GUIOrder.MapInfo mapInfo) Draws a line with an arrow.

Methods inherited from class dip.order.Retreat

determineDependencies, equals, evaluate, getFullName, isByConvoy, validate, verify

Methods inherited from class dip.order.Move

formatConvoyRoute, formatConvoyRoute, getBriefName, getConvoyRoute, getConvoyRoutes, getDefaultFormat, getDest, isAdjWithPossibleConvoy, isConvoying, isConvoyIntent, isViaConvoy, toBriefString, toFullString, validateTheoreticalConvoyRoute

Methods inherited from class dip.order.Order

addSupportsOfAndMovesToSource, appendBrief, appendFull, checkPower, checkSeasonAdjustment, checkSeasonMovement, checkSeasonRetreat, getPower, getSource, getSourceUnitType, getValidatedUnitType, toFormattedString, toString, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface dip.order.Orderable

determineDependencies, evaluate, getBriefName, getDefaultFormat, getFullName, getPower, getSource, getSourceUnitType, toBriefString, toFormattedString, toFullString, validate, verify

Constructor Detail

GUIRetreat

protected GUIRetreat()

Creates a GUIRetreat

GUIRetreat

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

Creates a GUIRetreat

Method Detail

deriveFrom

public void deriveFrom(Orderable order)

This only accepts Retreat orders. All others will throw an IllegalArgumentException.

Specified by:

deriveFrom in interface GUIOrder

testLocation

public boolean testLocation(GUIOrder.StateInfo stateInfo,
                            Location location,
                            java.lang.StringBuffer sb)

Description copied from interface: GUIOrder

Tests if a given location is valid. Returns validity, and appends valid/invalid message to StringBuffer.

Specified by:

testLocation in interface GUIOrder

clearLocations

public boolean clearLocations()

Description copied from interface: GUIOrder

Clear all set locations. If no locations have been set, this has no effect.

Specified by:

clearLocations in interface GUIOrder

setLocation

public boolean setLocation(GUIOrder.StateInfo stateInfo,
                           Location location,
                           java.lang.StringBuffer sb)

Description copied from interface: GUIOrder

Sets the current location. Otherwise similar to testLocation.

Specified by:

setLocation in interface GUIOrder

isComplete

public boolean isComplete()

Description copied from interface: GUIOrder

Returns if all Locations have been set and the order is complete.

Specified by:

isComplete in interface GUIOrder

getNumRequiredLocations

public int getNumRequiredLocations()

Description copied from interface: GUIOrder

Returns the number of required Location set points.

Specified by:

getNumRequiredLocations in interface GUIOrder

getCurrentLocationNum

public int getCurrentLocationNum()

Description copied from interface: GUIOrder

Returns the current Location set point, or 0 if no Locations have been set.

Specified by:

getCurrentLocationNum in interface GUIOrder

setParam

public void setParam(GUIOrder.Parameter param,
                     java.lang.Object value)

Always throws an IllegalArgumentException

Specified by:

setParam in interface GUIOrder

getParam

public java.lang.Object getParam(GUIOrder.Parameter param)

Always throws an IllegalArgumentException

Specified by:

getParam in interface GUIOrder

Returns:

set parameter, or null if no parameter has been set.

removeFromDOM

public void removeFromDOM(GUIOrder.MapInfo mapInfo)

Description copied from interface: GUIOrder

Removes order from the DOM

Specified by:

removeFromDOM in interface GUIOrder

updateDOM

public void updateDOM(GUIOrder.MapInfo mapInfo)

Draws a line with an arrow. Unlife a Move, we are not dependent.

Specified by:

updateDOM in interface GUIOrder

isDependent

public boolean isDependent()

Description copied from interface: GUIOrder

Indicates if this order is dependent upon the state of other orders for drawing.

Specified by:

isDependent in interface GUIOrder