Package VASSAL.build.widget

Class PieceSlot

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.Widget

VASSAL.build.widget.PieceSlot

All Implemented Interfaces:

KeyListener, MouseListener, EventListener, AutoConfigurable, Buildable, Configurable, PropertyNameSource, ComponentDescription, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget

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 final Font	FONT
static final String	GP_ID
protected String	gpId
protected GpIdSupport	gpidSupport
protected int	height
protected final JPanel	panel
static final String	PIECE_PALETTE_SCALE
protected String	pieceDefinition
protected int	width

Fields inherited from class VASSAL.build.Widget

buildElement, description, DESCRIPTION, 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	addImageNamesRecursively(Collection<String> s)	Adds all images used by this component AND any subcomponents to the collection
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.
void	clearCache()
protected void	clearExpandedPiece()
protected void	copyFrom(PieceSlot piece)
protected void	doPopup(MouseEvent e)
Class<?>[]	getAllowableConfigureComponents()	The allowable Configurable components of a Widget determined by its parent's Child-Allowable method.
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
Class<?>[]	getAttributeTypes()	Return the Class for the attributes of this object.
String	getAttributeValueString(String attr)	Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
Element	getBuildElement(Document doc)
Component	getComponent()
Configurable[]	getConfigureComponents()
String	getConfigureName()	ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.
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()
String	getLocalizedConfigureName()
String	getName()
GamePiece	getPiece()	Return defined GamePiece with prototypes unexpanded.
String	getPieceDefinition()
Dimension	getPreferredSize()
double	getScale()
boolean	isValid()	Has the PieceSlot been rendered for the first time yet?
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 a buildFile (XML) attribute value for this component.
void	setGpId(String id)
void	setGpidSupport(GpIdSupport s)
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 gpids in the given GamePiece

Methods inherited from class VASSAL.build.Widget

getChildAllowableConfigureComponents, getDescription, getParent, hasScalablePieces, hasScale, rebuild

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getExpressionList, getFormattedStringList, getI18nPrefix, getMenuTextList, getNamedKeyStrokeList, getPropertyList, getTypeName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getComponents, getComponentsOf, getNonFolderAncestor, getPropertyNames, setAncestor, validate

Methods inherited from class VASSAL.search.AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.script.expression.Auditable

getComponentName, getComponentTypeName

Methods inherited from interface VASSAL.build.Buildable

isMandatory, isMovable, isUnique

Field Details

GP_ID

public static final String GP_ID

See Also:

• Constant Field Values

PIECE_PALETTE_SCALE

public static final String PIECE_PALETTE_SCALE

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

getName

public String getName()

getPieceDefinition

public String getPieceDefinition()

getScale

public double getScale()

Overrides:

getScale in class Widget

copyFrom

protected void copyFrom(PieceSlot piece)

isValid

public boolean isValid()

Has the PieceSlot been rendered for the first time yet?

Returns:

true if slot has been rendered

setPiece

public void setPiece(GamePiece p)

getExpandedPiece

protected GamePiece getExpandedPiece()

Return defined GamePiece with prototypes fully expanded. Do NOT cache the expanded piece unless Translation is complete, it may change under us.

Returns:

expanded piece

clearExpandedPiece

protected void clearExpandedPiece()

clearCache

public void clearCache()

getPiece

public GamePiece getPiece()

Return defined GamePiece with prototypes unexpanded.

Returns:

unexpanded piece

addImageNamesRecursively

public void addImageNamesRecursively(Collection<String> s)

Description copied from class: AbstractBuildable

Adds all images used by this component AND any subcomponents to the collection

Specified by:

addImageNamesRecursively in interface ImageSearchTarget

Overrides:

addImageNamesRecursively in class AbstractBuildable

Parameters:

s - Collection to add image names to

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 responsible 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

Parameters:

par - parent Buildable to add this component to as a subcomponent.

getBuildElement

public Element getBuildElement(Document doc)

Specified by:

getBuildElement in interface Buildable

Overrides:

getBuildElement in class Widget

Parameters:

doc - XML file

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 class: AbstractConfigurable

ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.

Specified by:

getConfigureName in interface Configurable

Overrides:

getConfigureName in class AbstractConfigurable

Returns:

The language-independent name of this component used for programmatic identification (including within Modules by e.g. Traits and module components)

getLocalizedConfigureName

public String getLocalizedConfigureName()

Overrides:

getLocalizedConfigureName in class AbstractConfigurable

Returns:

The localized name for on-screen display

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Overrides:

getHelpFile in class Widget

Returns:

a HelpFile describing how to use and configure * this component

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractBuildable

Lists all the buildFile (XML) attribute names for this component. If this component is ALSO an AbstractConfigurable, then this list of attributes determines the appropriate attribute order for AbstractConfigurable.getAttributeDescriptions() and AbstractConfigurable.getAttributeTypes().

Specified by:

getAttributeNames in interface AutoConfigurable

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

a list of all buildFile (XML) attribute names for this component

getAttributeDescriptions

public String[] getAttributeDescriptions()

Description copied from interface: AutoConfigurable

Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object.

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Specified by:

getAttributeDescriptions in class AbstractConfigurable

Returns:

an array of Strings describing the buildFile (XML) attributes of this component. These strings are used as prompts in the Properties window for this object, when the component is configured in the Editor. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from interface: AutoConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, File, Color, and KeyStroke

Specified by:

getAttributeTypes in interface AutoConfigurable

Specified by:

getAttributeTypes in class AbstractConfigurable

Returns:

the Class for the buildFile (XML) attributes of this component. Valid classes include: String, Integer, Double, Boolean, Image, Color, and KeyStroke, along with any class for which a Configurer exists in VASSAL.configure. The class determines, among other things, which type of AutoConfigurer will be used to configure the attribute when the object is configured in the Editor. The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()

setAttribute

public void setAttribute(String name,
 Object value)

Description copied from class: AbstractBuildable

Sets a buildFile (XML) 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()

value - 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 can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

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 determined by its parent's Child-Allowable method.

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 interface: AutoConfigurable

Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element

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()

Returns:

a String representation of the XML buildFile attribute with the given name. When initializing a module, this String value will loaded from the XML and passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.

getI18nData

public ComponentI18nData getI18nData()

Specified by:

getI18nData in interface Translatable

Overrides:

getI18nData in class AbstractConfigurable

Returns:

the i18n data for this component

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

Returns:

Configurer for this component

updateGpId

public void updateGpId(GpIdSupport s)

Update the gpid for this PieceSlot, using the given GpIdSupport to generate the new id.

setGpidSupport

public void setGpidSupport(GpIdSupport s)

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 gpids in the given GamePiece

Parameters:

piece - GamePiece

getGpId

public String getGpId()

setGpId

public void setGpId(String id)