Package VASSAL.counters

Class PlaceMarker

java.lang.Object
VASSAL.search.AbstractImageFinder
VASSAL.counters.Decorator
VASSAL.counters.PlaceMarker
All Implemented Interfaces:
PropertyNameSource, PropertySource, EditablePiece, GamePiece, PropertyExporter, StateMergeable, TranslatablePiece, PersistentPropertyContainer, ImageSearchTarget, SearchTarget, RecursionLimiter.Loopable
Direct Known Subclasses:
Replace
public class PlaceMarker extends Decorator implements TranslatablePiece, RecursionLimiter.Loopable
This Decorator defines a key command to places another counter on top of this one.

  • Field Details

  • Constructor Details

    • PlaceMarker

      public PlaceMarker()

    • PlaceMarker

      public PlaceMarker​(String type, GamePiece inner)

  • Method Details

    • boundingBox

      public Rectangle boundingBox()
      Specified by:
      boundingBox in interface GamePiece
      Returns:
      The area which this GamePiece occupies when drawn at the point (0,0)

    • draw

      public void draw​(Graphics g, int x, int y, Component obs, double zoom)
      Description copied from interface: GamePiece
      Draw this GamePiece
      Specified by:
      draw in interface GamePiece
      Parameters:
      g - target Graphics object
      x - x-location of the center of the piece
      y - y-location of the center of the piece
      obs - the Component on which this piece is being drawn
      zoom - the scaling factor.

    • getName

      public String getName()
      Description copied from interface: GamePiece
      The plain English name for this piece
      Specified by:
      getName in interface GamePiece

    • myGetKeyCommands

      protected KeyCommand[] myGetKeyCommands()
      Specified by:
      myGetKeyCommands in class Decorator
      Returns:
      the key commands for this trait alone
      See Also:
      which returns the key commands for this trait AND all inner piece members

    • myGetState

      public String myGetState()
      Description copied from class: Decorator
      The "state information" is "game state" information that can change during the course of a game. State information is saved when the game is saved and is transferred between players on the server. For example, the relative order of pieces in a stack is state information, but whether the stack is expanded is not.
      Specified by:
      myGetState in class Decorator
      Returns:
      the game state information of this trait alone
      See Also:
      which returns state information for all inward piece members as well

    • myGetType

      public String myGetType()
      Description copied from class: Decorator
      The "type information" of a piece or trait is information that does not change during the course of a game. Image file names, context menu strings, etc., all should be reflected in the type. The type information is returned serialized string form, ready to be decoded by a SequenceEncoder#decode.
      Specified by:
      myGetType in class Decorator
      Returns:
      the type information of this trait alone
      See Also:
      BasicCommandEncoder, which returns type information for all inward piece members as well

    • myKeyEvent

      public Command myKeyEvent​(KeyStroke stroke)
      Description copied from class: Decorator
      The response of this trait alone to the given KeyStroke or the virtual keystroke of a NamedKeyStroke. NamedKeyStrokes are allocated a unique internal KeyStroke when they are first used in a module, and that KeyStroke is passed up and down the decorator stack to represent them (see NamedKeyStroke.getKeyStroke()).
      Specified by:
      myKeyEvent in class Decorator
      Parameters:
      stroke - KeyStroke to apply (to apply a Named Keystroke send NamedKeyStroke.getKeyStroke()
      Returns:
      Generated Command to reproduce any changes just made to to the game state, or null if no effect
      See Also:
      Decorator.keyEvent(javax.swing.KeyStroke)

    • placeMarker

      protected Command placeMarker()

    • selectMarker

      protected void selectMarker​(GamePiece marker)

    • createMarker

      public GamePiece createMarker()
      The marker, with prototypes fully expanded
      Returns:
      new Marker

    • createBaseMarker

      public GamePiece createBaseMarker()
      The marker, with prototypes unexpanded
      Returns:
      New Base Marker

    • addImageNamesRecursively

      public void addImageNamesRecursively​(Collection<String> s)
      Description copied from class: Decorator
      ImageSearchTarget Adds all images used by this component AND any children to the collection
      Specified by:
      addImageNamesRecursively in interface ImageSearchTarget
      Overrides:
      addImageNamesRecursively in class Decorator
      Parameters:
      s - Collection to add image names to

    • isMarkerStandalone

      public boolean isMarkerStandalone()
      Returns:
      true if the marker is defined from scratch, false if the marker is defined as a component in the Game Piece Palette

    • mySetState

      public void mySetState​(String newState)
      Description copied from class: Decorator
      Sets the state of this-trait-only (inverse of Decorator.myGetState()). The "state information" is information that can change during the course of a game. State information is saved when the game is saved and is transferred between players on the server. For example, the relative order of pieces in a stack is state information, but whether the stack is expanded is not.
      Specified by:
      mySetState in class Decorator
      Parameters:
      newState - New state information serialized in string form, ready to be passed to a SequenceEncoder#decode.

    • getShape

      public Shape getShape()
      Specified by:
      getShape in interface GamePiece
      Returns:
      The shape of the piece from the user's viewpoint. This defines the area in which the user must click to select or move the piece, for example. Like GamePiece.boundingBox(), it assumes the position is (0,0) -- which to be clear is normally aligned with the CENTER of the piece image -- and must be translated to the actual location where the piece is being drawn. For most ordinary pieces, the shape returned here will simply be equivalent to the bounding box, but see NonRectangular.

    • getDescription

      public String getDescription()
      Description copied from interface: EditablePiece
      A plain-English description of this type of piece
      Specified by:
      getDescription in interface EditablePiece

    • getHelpFile

      public HelpFile getHelpFile()
      Specified by:
      getHelpFile in interface EditablePiece
      Returns:
      the help file for this trait

    • mySetType

      public void mySetType​(String type)
      Description copied from interface: EditablePiece
      Sets the information for this piece. See Decorator.myGetType()
      Specified by:
      mySetType in interface EditablePiece
      Parameters:
      type - a serialized configuration string to set the "type information" of this piece, which is information that doesn't change during the course of a single game (e.g. Image Files, Context Menu strings, etc). Typically ready to be processed e.g. by SequenceEncoder.decode()

    • getEditor

      public PieceEditor getEditor()
      Specified by:
      getEditor in interface EditablePiece
      Overrides:
      getEditor in class Decorator
      Returns:
      the configurer for this trait - the dialog which allows the editing the piece's type information. Default configurer is a SimplePieceEditor, but many traits will want to provide custom versions.

    • getI18nData

      public PieceI18nData getI18nData()
      Description copied from class: Decorator
      Return Internationalization (I18n) data for this piece
      Specified by:
      getI18nData in interface TranslatablePiece
      Overrides:
      getI18nData in class Decorator
      Returns:
      I18n data, used to hold translations of strings

    • getGpId

      public String getGpId()

    • setGpId

      public void setGpId​(String s)

    • updateGpId

      public void updateGpId​(GpIdSupport s)

    • updateGpId

      public void updateGpId()

    • getComponentName

      public String getComponentName()
      Specified by:
      getComponentName in interface RecursionLimiter.Loopable

    • getComponentTypeName

      public String getComponentTypeName()
      Specified by:
      getComponentTypeName in interface RecursionLimiter.Loopable

    • testEquals

      public boolean testEquals​(Object o)
      Description copied from class: Decorator
      Test if this Decorator's Class, Type and State are equal to another trait. Implementations of this method should compare the individual values of the fields that make up the Decorators Type and State. Implementations should NOT compare the values returned by myGetType() or myGetState(). This method is intended to be used by Unit Tests to verify that a trait is unchanged after going through a process such as serialization/deserialization.
      Overrides:
      testEquals in class Decorator
      Parameters:
      o - Object to compare this Decorator to
      Returns:
      true if the Class, type and state all match

    • getNamedKeyStrokeList

      public List<NamedKeyStroke> getNamedKeyStrokeList()
      Description copied from class: Decorator
      SearchTarget
      Specified by:
      getNamedKeyStrokeList in interface SearchTarget
      Overrides:
      getNamedKeyStrokeList in class Decorator
      Returns:
      a list of any Named KeyStrokes referenced in the Decorator, if any (for search)

    • getMenuTextList

      public List<String> getMenuTextList()
      Description copied from class: Decorator
      SearchTarget
      Specified by:
      getMenuTextList in interface SearchTarget
      Overrides:
      getMenuTextList in class Decorator
      Returns:
      a list of any Menu Text strings referenced in the Decorator, if any (for search)