Class CardSlot

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.Widget

VASSAL.build.widget.PieceSlot

VASSAL.build.widget.CardSlot

All Implemented Interfaces:

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

public class CardSlot
extends PieceSlot

A CardSlot is identical to a PieceSlot except that it is initialized with a card-like GamePiece.

Nested Class Summary

Nested classes/interfaces inherited from class PieceSlot

PieceSlot.Panel

Modifier and Type	Class	Description
class	PieceSlot.Panel

Nested classes/interfaces inherited from class Widget

Widget.MyCellRenderer

Modifier and Type	Class	Description
static class	Widget.MyCellRenderer

Nested classes/interfaces inherited from interface AutoConfigurable

AutoConfigurable.Util

Modifier and Type	Interface	Description
static class	AutoConfigurable.Util

Field Summary

Fields inherited from class PieceSlot

c, expanded, FONT, GP_ID, gpId, gpidSupport, height, panel, PIECE_PALETTE_SCALE, pieceDefinition, width

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 Widget

buildElement, description, DESCRIPTION, HEIGHT, NAME, parent, WIDTH

Modifier and Type	Field	Description
protected Element	buildElement
protected String	description
static final String	DESCRIPTION
static final String	HEIGHT
static final String	NAME
protected Widget	parent
static final String	WIDTH

Fields inherited from class AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Modifier and Type	Field	Description
protected PropertyChangeSupport	changeSupport
protected Configurer	config
protected String	localizedName
protected ComponentI18nData	myI18nData
protected String	name

Fields inherited from class AbstractBuildable

buildComponents, validator

Modifier and Type	Field	Description
protected List<Buildable>	buildComponents
protected ValidityChecker	validator

Fields inherited from interface Configurable

NAME_PROPERTY

Modifier and Type	Field	Description
static final String	NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
CardSlot()
CardSlot(PieceSlot piece)

Method Summary

Modifier and Type	Method	Description
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
static String	getConfigureTypeName()

Methods inherited from class PieceSlot

addImageNamesRecursively, addTo, build, clearCache, clearExpandedPiece, copyFrom, doPopup, getAllowableConfigureComponents, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getAttributeValueString, getBuildElement, getComponent, getConfigureComponents, getConfigureName, getExpandedPiece, getGpId, getHelpFile, getI18nData, getLocalizedConfigureName, getName, getPiece, getPieceDefinition, getPreferredSize, getScale, isValid, keyPressed, keyReleased, keyTyped, mouseClicked, mouseEntered, mouseExited, mousePressed, mouseReleased, paint, removeFrom, setAttribute, setGpId, setGpidSupport, setPiece, startDrag, updateGpId, updateGpId, updateGpId

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(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.
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 Widget

getChildAllowableConfigureComponents, getDescription, getParent, hasScalablePieces, hasScale, rebuild

Modifier and Type	Method	Description
Class<?>[]	getChildAllowableConfigureComponents()	Allowable components for a CHILD of this class - default is to ask our parent for this list.
String	getDescription()
Widget	getParent()
boolean	hasScalablePieces()
boolean	hasScale()
protected void	rebuild()	Perform the build of this Buildable component using the element stored from when the the Widget.build(Element) method was invoked

Methods inherited from class AbstractConfigurable

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

Modifier and Type	Method	Description
void	add(Buildable b)	Set the owning translatable of this component
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
List<String>	getExpressionList()	SearchTarget
List<String>	getFormattedStringList()	SearchTarget
protected String	getI18nPrefix()
List<String>	getMenuTextList()	SearchTarget
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
List<String>	getPropertyList()	SearchTarget
String	getTypeName()	Returns the name of the configurable type for display purposes.
void	remove(Buildable b)	Remove a Buildable object from this object
void	removePropertyChangeListener(PropertyChangeListener l)
protected void	setAllAttributesUntranslatable()	Sets all attributes untranslatable.
protected void	setAttributeTranslatable(String attr, boolean b)	Over-ride the default attribute translatability.
void	setConfigureName(String s)	Sets the name and fires a PropertyChangeEvent

Methods inherited from class AbstractBuildable

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

Modifier and Type	Method	Description
String	buildString()
<T> List<T>	getAllDescendantComponentsOf(Class<T> target)	Recursively descend the build tree and return a List of all components that are instances of the given class
Buildable	getAncestor()
List<Buildable>	getBuildables()
Enumeration<Buildable>	getBuildComponents()	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getBuildables() instead.
<T> Enumeration<T>	getComponents(Class<T> target)	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getComponentsOf(Class) instead.
<T> List<T>	getComponentsOf(Class<T> target)
Buildable	getNonFolderAncestor()
List<String>	getPropertyNames()	Override this method to provide a list of properties to be exposed for use by expressions in the module.
void	setAncestor(Buildable ancestor)
void	validate(Buildable target, ValidationReport report)

Methods inherited from class AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	Classes extending AbstractImageFinder should override this method in order to add the names of any image files they use to the collection.
SortedSet<String>	getAllImageNames()
SortedSet<String>	getLocalImageNames()

Methods inherited from class Object

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

Methods inherited from interface Auditable

getComponentName, getComponentTypeName

Modifier and Type	Method	Description
default String	getComponentName()	Return the name of the trait or Component an Auditable is
default String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is

Methods inherited from interface Buildable

isMandatory, isMovable, isUnique

Modifier and Type	Method	Description
default boolean	isMandatory()	Is this component a reqired component within its parent?
default boolean	isMovable()	Is this component allowed to be moved around the Configure Tree?
default boolean	isUnique()	Does this component need to be unique within it's parent?

Constructor Details

CardSlot

public CardSlot()

CardSlot

public CardSlot(PieceSlot piece)

Method Details

getConfigureTypeName

public static String getConfigureTypeName()

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 PieceSlot

Returns:

Configurer for this component