Package VASSAL.build.module.map

Class DrawPile

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.map.SetupStack

VASSAL.build.module.map.DrawPile

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, GameComponent, PropertyNameSource, PropertySource, ValidityChecker, Translatable, ImageSearchTarget, SearchTarget, UniqueIdManager.Identifyable

public class DrawPile
extends SetupStack
implements PropertySource, PropertyNameSource

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DrawPile.AssignedDeckPrompt	generates a prompt with the names of all decks already defined
static class	DrawPile.FormattedStringConfig
static class	DrawPile.PiecePropertyConfig
static class	DrawPile.Prompt

Nested classes/interfaces inherited from class VASSAL.build.module.map.SetupStack

SetupStack.OwningBoardPrompt, SetupStack.StackConfigurer, SetupStack.View

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALLOW_MULTIPLE
static String	ALLOW_SELECT
static String	ALWAYS
static String	CAN_SAVE
static String	COLOR
static String	COMMAND_NAME
static String	COUNTEXPRESSIONS
static String	DECK_NAME
static String	DRAW
static String	DRAW_FACE_UP
protected Deck	dummy
static String	EMPTY_HOTKEY
static String	EXPRESSIONCOUNTING
static String	FACE_DOWN
static String	FACE_DOWN_HOTKEY
static String	FACE_DOWN_REPORT_FORMAT
static String	HEIGHT
static String	HOTKEY_ON_EMPTY
protected static UniqueIdManager	idMgr
static String	MAXSTACK
protected Deck	myDeck
static String	NEVER
static String	REPORT_FORMAT
protected boolean	reshufflable
static String	RESHUFFLABLE
static String	RESHUFFLE_COMMAND
static String	RESHUFFLE_HOTKEY
static String	RESHUFFLE_MESSAGE
static String	RESHUFFLE_TARGET
static String	RESTRICT_EXPRESSION
static String	RESTRICT_OPTION
static String	REVERSE_COMMAND
static String	REVERSE_HOTKEY
static String	REVERSE_REPORT_FORMAT
static String	REVERSIBLE
static String	SELECT_DISPLAY_PROPERTY
static String	SELECT_SORT_PROPERTY
static String	SHUFFLE
static String	SHUFFLE_COMMAND
static String	SHUFFLE_HOTKEY
static String	SHUFFLE_REPORT_FORMAT
protected PropertySource	source
static String	USE_MENU
static String	WIDTH

Fields inherited from class VASSAL.build.module.map.SetupStack

COMMAND_PREFIX, configureButton, DEFAULT_DUMMY_SIZE, DEFAULT_SIZE, DELTA, FAST, FASTER, id, indicator, location, LOCATION, locationConfig, map, NAME, OWNING_BOARD, owningBoardName, pos, stackConfigurer, USE_GRID_LOCATION, useGridLocation, X_POSITION, xConfig, Y_POSITION, yConfig

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

Method Summary

Modifier and Type	Method	Description
void	addGlobalKeyCommand(DeckGlobalKeyCommand globalCommand)	Decks can contain child Global Key Commands that only apply to cards in the Deck.
void	addTo(Buildable parent)	Adds this component to its parent.
Command	addToContents(GamePiece p)
Rectangle	boundingBox()
protected JPopupMenu	buildPopup()
static DrawPile	findDrawPile(String id)	Return the DrawPile instance with the matching id or name
Class<?>[]	getAllowableConfigureComponents()
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 key)	Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
static String	getConfigureTypeName()
Deck	getDeck()
protected String	getDeckType()
List<String>	getExpressionList()	SearchTarget
List<String>	getFormattedStringList()	SearchTarget
HelpFile	getHelpFile()
ComponentI18nData	getI18nData()
Object	getLocalizedProperty(Object key)	Returns a localized translation of the specified property value, if available.
Map	getMap()
List<String>	getMenuTextList()	SearchTarget
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
Point	getPosition()
Object	getProperty(Object key)	When using this interface a piece's own properties are preferred to those of "Global Properties", and those in turn are searched Zone-first then Map, then Module.
List<String>	getPropertyList()	SearchTarget
List<String>	getPropertyNames()	Implement PropertyNameSource - Expose the numPieces property and any counting properties.
Dimension	getSize()
protected Stack	initializeContents()
boolean	isReshufflable()
protected boolean	placeNonStackingSeparately()
void	removeGlobalKeyCommand(DeckGlobalKeyCommand globalCommand)
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setDeck(Deck deck)
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended

Methods inherited from class VASSAL.build.module.map.SetupStack

add, configureStack, createStack, getConfigureBoard, getConfigureBoard, getConfigurer, getId, getRestoreCommand, getTopPiece, isOwningBoardActive, isUseGridLocation, removeFrom, setId, updateConfigureButton, updateLocation, updatePosition, validate

Methods inherited from class VASSAL.build.AbstractConfigurable

addPropertyChangeListener, getConfigureComponents, getConfigureName, getI18nPrefix, getLocalizedConfigureName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf

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.build.Buildable

build, getBuildElement

Methods inherited from interface VASSAL.tools.UniqueIdManager.Identifyable

getConfigureName

Field Details

dummy

protected Deck dummy

reshufflable

protected boolean reshufflable

myDeck

protected Deck myDeck

source

protected PropertySource source

idMgr

protected static final UniqueIdManager idMgr

WIDTH

public static final String WIDTH

See Also:

Constant Field Values

HEIGHT

public static final String HEIGHT

See Also:

Constant Field Values

ALLOW_MULTIPLE

public static final String ALLOW_MULTIPLE

See Also:

Constant Field Values

ALLOW_SELECT

public static final String ALLOW_SELECT

See Also:

Constant Field Values

SELECT_DISPLAY_PROPERTY

public static final String SELECT_DISPLAY_PROPERTY

See Also:

Constant Field Values

SELECT_SORT_PROPERTY

public static final String SELECT_SORT_PROPERTY

See Also:

Constant Field Values

FACE_DOWN

public static final String FACE_DOWN

See Also:

Constant Field Values

DRAW_FACE_UP

public static final String DRAW_FACE_UP

See Also:

Constant Field Values

FACE_DOWN_REPORT_FORMAT

public static final String FACE_DOWN_REPORT_FORMAT

See Also:

Constant Field Values

FACE_DOWN_HOTKEY

public static final String FACE_DOWN_HOTKEY

See Also:

Constant Field Values

SHUFFLE

public static final String SHUFFLE

See Also:

Constant Field Values

SHUFFLE_REPORT_FORMAT

public static final String SHUFFLE_REPORT_FORMAT

See Also:

Constant Field Values

SHUFFLE_HOTKEY

public static final String SHUFFLE_HOTKEY

See Also:

Constant Field Values

SHUFFLE_COMMAND

public static final String SHUFFLE_COMMAND

See Also:

Constant Field Values

REVERSIBLE

public static final String REVERSIBLE

See Also:

Constant Field Values

REVERSE_REPORT_FORMAT

public static final String REVERSE_REPORT_FORMAT

See Also:

Constant Field Values

REVERSE_HOTKEY

public static final String REVERSE_HOTKEY

See Also:

Constant Field Values

REVERSE_COMMAND

public static final String REVERSE_COMMAND

See Also:

Constant Field Values

DRAW

public static final String DRAW

See Also:

Constant Field Values

COLOR

public static final String COLOR

See Also:

Constant Field Values

MAXSTACK

public static final String MAXSTACK

See Also:

Constant Field Values

EXPRESSIONCOUNTING

public static final String EXPRESSIONCOUNTING

See Also:

Constant Field Values

COUNTEXPRESSIONS

public static final String COUNTEXPRESSIONS

See Also:

Constant Field Values

RESHUFFLABLE

public static final String RESHUFFLABLE

See Also:

Constant Field Values

RESHUFFLE_COMMAND

public static final String RESHUFFLE_COMMAND

See Also:

Constant Field Values

RESHUFFLE_TARGET

public static final String RESHUFFLE_TARGET

See Also:

Constant Field Values

RESHUFFLE_MESSAGE

public static final String RESHUFFLE_MESSAGE

See Also:

Constant Field Values

RESHUFFLE_HOTKEY

public static final String RESHUFFLE_HOTKEY

See Also:

Constant Field Values

REPORT_FORMAT

public static final String REPORT_FORMAT

See Also:

Constant Field Values

CAN_SAVE

public static final String CAN_SAVE

See Also:

Constant Field Values

HOTKEY_ON_EMPTY

public static final String HOTKEY_ON_EMPTY

See Also:

Constant Field Values

EMPTY_HOTKEY

public static final String EMPTY_HOTKEY

See Also:

Constant Field Values

RESTRICT_OPTION

public static final String RESTRICT_OPTION

See Also:

Constant Field Values

RESTRICT_EXPRESSION

public static final String RESTRICT_EXPRESSION

See Also:

Constant Field Values

ALWAYS

public static final String ALWAYS

See Also:

Constant Field Values

NEVER

public static final String NEVER

See Also:

Constant Field Values

USE_MENU

public static final String USE_MENU

See Also:

Constant Field Values

COMMAND_NAME

public static final String COMMAND_NAME

See Also:

Constant Field Values

DECK_NAME

public static final String DECK_NAME

See Also:

Constant Field Values

Constructor Details

DrawPile

public DrawPile()

Method Details

addTo

public void addTo(Buildable parent)

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 SetupStack

Parameters:

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

buildPopup

protected JPopupMenu buildPopup()

addGlobalKeyCommand

public void addGlobalKeyCommand(DeckGlobalKeyCommand globalCommand)

Decks can contain child Global Key Commands that only apply to cards in the Deck. Pass these to the dummy Deck component

removeGlobalKeyCommand

public void removeGlobalKeyCommand(DeckGlobalKeyCommand globalCommand)

findDrawPile

public static DrawPile findDrawPile(String id)

Return the DrawPile instance with the matching id or name

Parameters:

id - the Id or ConfigureName of the target DrawPile

Returns:

the matching DrawPile, or null if none found

See Also:

SetupStack.getId(), AbstractConfigurable.getConfigureName()

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

Overrides:

getAttributeNames in class SetupStack

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

Overrides:

getAttributeDescriptions in class SetupStack

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

Overrides:

getAttributeTypes in class SetupStack

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

isReshufflable

public boolean isReshufflable()

getAttributeValueString

public String getAttributeValueString(String key)

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

Overrides:

getAttributeValueString in class SetupStack

Parameters:

key - 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.

setAttribute

public void setAttribute(String key,
 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

Overrides:

setAttribute in class SetupStack

Parameters:

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

getAttributeVisibility

public VisibilityCondition getAttributeVisibility(String name)

Description copied from class: AbstractConfigurable

By default, all attributes are visible

Specified by:

getAttributeVisibility in interface AutoConfigurable

Overrides:

getAttributeVisibility in class SetupStack

Parameters:

name - Name (key) of one of this component's attributes

Returns:

a VisibilityCondition for this attribute, or null if attribute should always be visible.

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Specified by:

getAllowableConfigureComponents in interface Configurable

Overrides:

getAllowableConfigureComponents in class SetupStack

Returns:

a list of valid sub-component Classes. If a Class appears in this list, then instances of that class may be added to this component from the Editor's ConfigureTree window by right-clicking on the component and selecting the appropriate "Add" option.

getPosition

public Point getPosition()

getMap

public Map getMap()

boundingBox

public Rectangle boundingBox()

addToContents

public Command addToContents(GamePiece p)

initializeContents

protected Stack initializeContents()

Overrides:

initializeContents in class SetupStack

setDeck

public void setDeck(Deck deck)

getDeck

public Deck getDeck()

placeNonStackingSeparately

protected boolean placeNonStackingSeparately()

Overrides:

placeNonStackingSeparately in class SetupStack

getDeckType

protected String getDeckType()

getSize

public Dimension getSize()

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Overrides:

getHelpFile in class SetupStack

Returns:

a HelpFile describing how to use and configure * this component

getConfigureTypeName

public static String getConfigureTypeName()

getI18nData

public ComponentI18nData getI18nData()

Specified by:

getI18nData in interface Translatable

Overrides:

getI18nData in class SetupStack

Returns:

the i18n data for this component

getProperty

public Object getProperty(Object key)

Description copied from interface: PropertySource

When using this interface a piece's own properties are preferred to those of "Global Properties", and those in turn are searched Zone-first then Map, then Module.

Specified by:

getProperty in interface PropertySource

Parameters:

key - String key of property to be returned

Returns:

Object containing value of the specified property

getLocalizedProperty

public Object getLocalizedProperty(Object key)

Description copied from interface: PropertySource

Returns a localized translation of the specified property value, if available. Otherwise returns the non-localized version.

Specified by:

getLocalizedProperty in interface PropertySource

Parameters:

key - String key of property to be returned

Returns:

Object containing localized text of the specified property, if available, otherwise non-localized value

getPropertyNames

public List<String> getPropertyNames()

Implement PropertyNameSource - Expose the numPieces property and any counting properties.

Specified by:

getPropertyNames in interface PropertyNameSource

Overrides:

getPropertyNames in class AbstractBuildable

Returns:

Default implementation of PropertyNameSource - No properties exposed

getExpressionList

public List<String> getExpressionList()

SearchTarget

Specified by:

getExpressionList in interface SearchTarget

Overrides:

getExpressionList in class SetupStack

Returns:

a list of the Configurables string/expression fields if any (for search)

getFormattedStringList

public List<String> getFormattedStringList()

SearchTarget

Specified by:

getFormattedStringList in interface SearchTarget

Overrides:

getFormattedStringList in class AbstractConfigurable

Returns:

a list of any Message Format strings referenced in the Configurable, if any (for search)

getPropertyList

public List<String> getPropertyList()

SearchTarget

Specified by:

getPropertyList in interface SearchTarget

Overrides:

getPropertyList in class AbstractConfigurable

Returns:

a list of any Property Names referenced in the Configurable, if any (for search)

getMenuTextList

public List<String> getMenuTextList()

SearchTarget

Specified by:

getMenuTextList in interface SearchTarget

Overrides:

getMenuTextList in class AbstractConfigurable

Returns:

a list of any Menu/Button/Tooltip Text strings referenced in the Configurable, if any (for search)

setup

public void setup(boolean gameStarting)

Description copied from interface: GameComponent

Notify the GameComponent that a game has started/ended

Specified by:

setup in interface GameComponent

Overrides:

setup in class SetupStack

Parameters:

gameStarting - if true, a game is starting. If false, then a game is ending

getNamedKeyStrokeList

public List<NamedKeyStroke> getNamedKeyStrokeList()

SearchTarget

Specified by:

getNamedKeyStrokeList in interface SearchTarget

Overrides:

getNamedKeyStrokeList in class AbstractConfigurable

Returns:

a list of any Named KeyStrokes referenced in the Configurable, if any (for search)