VASSAL.build.widget.PieceSlot

All Implemented Interfaces:: KeyListener, MouseListener, EventListener, AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable

Direct Known Subclasses:: CardSlot

public class PieceSlot
extends Widget
implements MouseListener, KeyListener

A Component that displays a GamePiece. Can be added to any Widget but cannot contain any children Keyboard input on a PieceSlot is forwarded to the GamePiece.keyEvent(javax.swing.KeyStroke) method for the PieceSlot's GamePiece. Clicking on a PieceSlot initiates a drag

Nested Class Summary

Nested Classes

Modifier and Type Class Description

class PieceSlot.Panel

Nested classes/interfaces inherited from class VASSAL.build.Widget
Widget.MyCellRenderer

Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable
AutoConfigurable.Util

Field Summary

Fields
Modifier and Type	Field	Description
`protected GamePiece`	`c`
`protected GamePiece`	`expanded`
`protected static Font`	`FONT`
`static String`	`GP_ID`
`protected String`	`gpId`
`protected GpIdSupport`	`gpidSupport`
`protected int`	`height`
`protected JPanel`	`panel`
`protected String`	`pieceDefinition`
`protected int`	`width`

Fields inherited from class VASSAL.build.Widget

buildElement, HEIGHT, NAME, parent, WIDTH

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

Constructors

Constructor Description

PieceSlot()

PieceSlot(CardSlot card)

PieceSlot(PieceSlot piece)

PieceSlot(GamePiece p)

Method Summary

Modifier and Type	Method	Description
`void`	`addTo(Buildable par)`	Adds this component to its parent.
`void`	`build(Element e)`	When building a PieceSlot, the text contents of the XML element are parsed into a String.
`protected void`	`clearExpandedPiece()`
`protected void`	`copyFrom(PieceSlot piece)`
`protected void`	`doPopup(MouseEvent e)`
`Class<?>[]`	`getAllowableConfigureComponents()`	The allowable Configurable components of a Widget are the same as its parent
`String[]`	`getAttributeDescriptions()`	Return an array of Strings describing the attributes of this object.
`String[]`	`getAttributeNames()`
`Class<?>[]`	`getAttributeTypes()`	Return the Class for the attributes of this object.
`String`	`getAttributeValueString(String attr)`	Return a String representation of the attribute with the given name.
`Element`	`getBuildElement(Document doc)`
`Component`	`getComponent()`
`Configurable[]`	`getConfigureComponents()`
`String`	`getConfigureName()`	The name of this Configurable Object
`Configurer`	`getConfigurer()`	The default `Configurer` of an `AbstractConfigurable` class is an instance of `AutoConfigurer`
`static String`	`getConfigureTypeName()`
`protected GamePiece`	`getExpandedPiece()`	Return defined GamePiece with prototypes fully expanded.
`String`	`getGpId()`
`HelpFile`	`getHelpFile()`
`ComponentI18nData`	`getI18nData()`	Return the i18n data for this component
`GamePiece`	`getPiece()`	Return defined GamePiece with prototypes unexpanded.
`Dimension`	`getPreferredSize()`
`double`	`getScale()`
`void`	`keyPressed(KeyEvent e)`
`void`	`keyReleased(KeyEvent e)`
`void`	`keyTyped(KeyEvent e)`
`void`	`mouseClicked(MouseEvent e)`
`void`	`mouseEntered(MouseEvent e)`
`void`	`mouseExited(MouseEvent e)`
`void`	`mousePressed(MouseEvent e)`
`void`	`mouseReleased(MouseEvent e)`
`void`	`paint(Graphics g)`
`void`	`removeFrom(Buildable parent)`	Remove this component from its parent
`void`	`setAttribute(String name, Object value)`	Sets an attribute value for this component.
`void`	`setGpId(String id)`
`void`	`setPiece(GamePiece p)`
`protected void`	`startDrag()`
`void`	`updateGpId()`	Allocate a new gpid to this PieceSlot, plus to any PlaceMarker or Replace traits.
`void`	`updateGpId(GpIdSupport s)`	Update the gpid for this PieceSlot, using the given `GpIdSupport` to generate the new id.
`void`	`updateGpId(GamePiece piece)`	Allocate new gpid's in the given GamePiece

Methods inherited from class VASSAL.build.Widget

getParent, hasScale, rebuild

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getI18nPrefix, getLocalizedConfigureName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getComponents, getComponentsOf, getPropertyNames, validate

Methods inherited from class java.lang.Object

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

Field Details
- GP_ID
  
  public static final String GP_ID
  
  See Also:
  
  Constant Field Values
- c
  
  protected GamePiece c
- expanded
  
  protected GamePiece expanded
- pieceDefinition
  
  protected String pieceDefinition
- FONT
  
  protected static final Font FONT
- panel
  
  protected final JPanel panel
- width
  
  protected int width
- height
  
  protected int height
- gpId
  
  protected String gpId
- gpidSupport
  
  protected GpIdSupport gpidSupport
Constructor Details
- PieceSlot
  
  public PieceSlot()
- PieceSlot
  
  public PieceSlot(PieceSlot piece)
- PieceSlot
  
  public PieceSlot(CardSlot card)
- PieceSlot
  
  public PieceSlot(GamePiece p)
Method Details
- getScale
  
  public double getScale()
  
  Overrides:
  
  getScale in class Widget
- copyFrom
  
  protected void copyFrom(PieceSlot piece)
- setPiece
  
  public void setPiece(GamePiece p)
- getExpandedPiece
  
  protected GamePiece getExpandedPiece()
  
  Return defined GamePiece with prototypes fully expanded.
  
  Returns:
  
  expanded piece
- clearExpandedPiece
  
  protected void clearExpandedPiece()
- getPiece
  
  public GamePiece getPiece()
  
  Return defined GamePiece with prototypes unexpanded.
  
  Returns:
  
  unexpanded piece
- paint
  
  public void paint(Graphics g)
- getPreferredSize
  
  public Dimension getPreferredSize()
- startDrag
  
  protected void startDrag()
- doPopup
  
  protected void doPopup(MouseEvent e)
- mousePressed
  
  public void mousePressed(MouseEvent e)
  
  Specified by:
  
  mousePressed in interface MouseListener
- mouseReleased
  
  public void mouseReleased(MouseEvent e)
  
  Specified by:
  
  mouseReleased in interface MouseListener
- mouseClicked
  
  public void mouseClicked(MouseEvent e)
  
  Specified by:
  
  mouseClicked in interface MouseListener
- mouseEntered
  
  public void mouseEntered(MouseEvent e)
  
  Specified by:
  
  mouseEntered in interface MouseListener
- mouseExited
  
  public void mouseExited(MouseEvent e)
  
  Specified by:
  
  mouseExited in interface MouseListener
- keyPressed
  
  public void keyPressed(KeyEvent e)
  
  Specified by:
  
  keyPressed in interface KeyListener
- keyTyped
  
  public void keyTyped(KeyEvent e)
  
  Specified by:
  
  keyTyped in interface KeyListener
- keyReleased
  
  public void keyReleased(KeyEvent e)
  
  Specified by:
  
  keyReleased in interface KeyListener
- getConfigureTypeName
  
  public static String getConfigureTypeName()
- getComponent
  
  public Component getComponent()
  
  Specified by:
  
  getComponent in class Widget
  
  Returns:
  
  the Component for this widget. For efficiency, the Component may be initialized lazily instead of being created in the Buildable.build(org.w3c.dom.Element) method
- build
  
  public void build(Element e)
  
  When building a PieceSlot, the text contents of the XML element are parsed into a String. The String is decoded using GameModule.decode(java.lang.String). The resulting Command should be an instance of AddPiece. The piece referred to in the Command becomes the piece contained in the PieceSlot
  
  Specified by:
  
  build in interface Buildable
  
  Overrides:
  
  build in class Widget
  
  Parameters:
  
  e - the XML element containing the object data
- addTo
  
  public void addTo(Buildable par)
  
  Description copied from interface: Buildable
  
  Adds this component to its parent. In order to make Buildable objects extensible, the child is reponsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.
  
  Specified by:
  
  addTo in interface Buildable
  
  Overrides:
  
  addTo in class Widget
- getBuildElement
  
  public Element getBuildElement(Document doc)
  
  Specified by:
  
  getBuildElement in interface Buildable
  
  Overrides:
  
  getBuildElement in class Widget
  
  Returns:
  
  an XML element from which this component can be built
- removeFrom
  
  public void removeFrom(Buildable parent)
  
  Description copied from interface: Configurable
  
  Remove this component from its parent
  
  Specified by:
  
  removeFrom in interface Configurable
  
  Overrides:
  
  removeFrom in class Widget
- getConfigureName
  
  public String getConfigureName()
  
  Description copied from interface: Configurable
  
  The name of this Configurable Object
  
  Specified by:
  
  getConfigureName in interface Configurable
  
  Overrides:
  
  getConfigureName in class AbstractConfigurable
- getHelpFile
  
  public HelpFile getHelpFile()
  
  Specified by:
  
  getHelpFile in interface Configurable
  
  Overrides:
  
  getHelpFile in class Widget
  
  Returns:
  
  a HelpFilte describing how to use and configure this component
- getAttributeNames
  
  public String[] getAttributeNames()
  
  Specified by:
  
  getAttributeNames in interface AutoConfigurable
  
  Specified by:
  
  getAttributeNames in class AbstractBuildable
  
  Returns:
  
  a list of all attribute names for this component
- getAttributeDescriptions
  
  public String[] getAttributeDescriptions()
  
  Description copied from class: AbstractConfigurable
  
  Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()
  
  Specified by:
  
  getAttributeDescriptions in interface AutoConfigurable
  
  Specified by:
  
  getAttributeDescriptions in class AbstractConfigurable
- getAttributeTypes
  
  public Class<?>[] getAttributeTypes()
  
  Description copied from class: AbstractConfigurable
  
  Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, Color, and KeyStroke The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()
  
  Specified by:
  
  getAttributeTypes in interface AutoConfigurable
  
  Specified by:
  
  getAttributeTypes in class AbstractConfigurable
- setAttribute
  
  public void setAttribute(String name, Object value)
  
  Description copied from class: AbstractBuildable
  
  Sets an attribute value for this component. The key parameter will be one of those listed in AbstractBuildable.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(java.lang.String) for the same key. If the implementing class extends AbstractConfigurable, then value will be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()
  
  Specified by:
  
  setAttribute in interface AutoConfigurable
  
  Specified by:
  
  setAttribute in interface Translatable
  
  Specified by:
  
  setAttribute in class AbstractBuildable
  
  Parameters:
  
  name - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()
- getConfigureComponents
  
  public Configurable[] getConfigureComponents()
  
  Specified by:
  
  getConfigureComponents in interface Configurable
  
  Overrides:
  
  getConfigureComponents in class Widget
  
  Returns:
  
  an array of Configurer objects representing the Buildable children of this Configurable object
- getAllowableConfigureComponents
  
  public Class<?>[] getAllowableConfigureComponents()
  
  Description copied from class: Widget
  
  The allowable Configurable components of a Widget are the same as its parent
  
  Specified by:
  
  getAllowableConfigureComponents in interface Configurable
  
  Overrides:
  
  getAllowableConfigureComponents in class Widget
  
  Returns:
  
  an array of Configurer objects representing all possible classes of Buildable children of this Configurable object
- getAttributeValueString
  
  public String getAttributeValueString(String attr)
  
  Description copied from class: AbstractBuildable
  
  Return a String representation of the attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).
  
  Specified by:
  
  getAttributeValueString in interface AutoConfigurable
  
  Specified by:
  
  getAttributeValueString in interface Translatable
  
  Specified by:
  
  getAttributeValueString in class AbstractBuildable
  
  Parameters:
  
  attr - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()
- getI18nData
  
  public ComponentI18nData getI18nData()
  
  Description copied from class: AbstractConfigurable
  
  Return the i18n data for this component
  
  Specified by:
  
  getI18nData in interface Translatable
  
  Overrides:
  
  getI18nData in class AbstractConfigurable
- getConfigurer
  
  public Configurer getConfigurer()
  
  Description copied from class: AbstractConfigurable
  
  The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
  
  Specified by:
  
  getConfigurer in interface Configurable
  
  Overrides:
  
  getConfigurer in class AbstractConfigurable
- updateGpId
  
  public void updateGpId(GpIdSupport s)
  
  Update the gpid for this PieceSlot, using the given GpIdSupport to generate the new id.
- updateGpId
  
  public void updateGpId()
  
  Allocate a new gpid to this PieceSlot, plus to any PlaceMarker or Replace traits.
- updateGpId
  
  public void updateGpId(GamePiece piece)
  
  Allocate new gpid's in the given GamePiece
  
  Parameters:
  
  piece - GamePiece
- getGpId
  
  public String getGpId()
- setGpId
  
  public void setGpId(String id)

Constructor	Description
`PieceSlot()`
`PieceSlot(CardSlot card)`
`PieceSlot(PieceSlot piece)`
`PieceSlot(GamePiece p)`

Class PieceSlot

Nested Class Summary

Nested classes/interfaces inherited from class VASSAL.build.Widget

Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable