dip.gui.order
Class GUIRemove

java.lang.Object
  extended bydip.order.Order
      extended bydip.order.Remove
          extended bydip.gui.order.GUIRemove
All Implemented Interfaces:
GUIOrder, Orderable, java.io.Serializable

public class GUIRemove
extends Remove
implements GUIOrder

GUIOrder implementation of Remove 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
static java.lang.String NO_UNITS_TO_REMOVE
           
 
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 GUIRemove()
          Creates a GUIRemove
protected GUIRemove(Power power, Location source, Unit.Type sourceUnitType)
          Creates a GUIRemove
 
Method Summary
 boolean clearLocations()
          Clear all set locations.
 void deriveFrom(Orderable order)
          This only accepts Remove 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 circle with an X in it
 
Methods inherited from class dip.order.Remove
determineDependencies, equals, evaluate, getBriefName, getDefaultFormat, getFullName, toBriefString, toFullString, validate, verify
 
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
 

Field Detail

NO_UNITS_TO_REMOVE

public static final java.lang.String NO_UNITS_TO_REMOVE
See Also:
Constant Field Values
Constructor Detail

GUIRemove

protected GUIRemove()
Creates a GUIRemove


GUIRemove

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

Method Detail

deriveFrom

public void deriveFrom(Orderable order)
This only accepts Remove 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 circle with an X in it

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


Copyright 2002-2004 Zachary DelProposto / jDip Development Team. All Rights Reserved.