Package VASSAL.build.module.map

Class SetupStack

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.map.SetupStack

All Implemented Interfaces:

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

Direct Known Subclasses:

DrawPile

public class SetupStack
extends AbstractConfigurable
implements GameComponent, UniqueIdManager.Identifyable

This is the "At-Start Stack" component, which initializes a Map or Board with a specified stack. Because it uses a regular stack, this component is better suited for limited-force-pool collections of counters than a DrawPile

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SetupStack.OwningBoardPrompt
class	SetupStack.StackConfigurer
static class	SetupStack.View

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
protected static String	cachedBoard
static final String	COMMAND_PREFIX
protected JButton	configureButton
protected static final int	DEFAULT_DUMMY_SIZE
protected static final Dimension	DEFAULT_SIZE
protected static final int	DELTA
protected static final int	FAST
protected static final int	FASTER
protected String	id
protected static NewGameIndicator	indicator
protected String	location
static final String	LOCATION
protected Configurer	locationConfig
protected Map	map
static final String	NAME
static final String	OWNING_BOARD
protected String	owningBoardName
protected Buildable	parent
protected Point	pos
static boolean	showOthers
protected SetupStack.StackConfigurer	stackConfigurer
static final String	USE_GRID_LOCATION
protected static String	usedBoardWildcard
protected boolean	useGridLocation
static final String	X_POSITION
protected Configurer	xConfig
static final String	Y_POSITION
protected Configurer	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
SetupStack()

Method Summary

Modifier and Type	Method	Description
void	add(Buildable child)	Set the owning translatable of this component
void	addTo(Buildable parent)	Adds this component to its parent.
protected void	configureStack()
protected Stack	createStack()
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	getCachedBoard()
protected Board	getConfigureBoard()
Board	getConfigureBoard(boolean checkSelectedBoards)
String	getConfigureName()	Setup Stacks with no name will display in editor w/ the name of something inside them that does have a name.
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
static String	getConfigureTypeName()
List<String>	getExpressionList()	SearchTarget
HelpFile	getHelpFile()
ComponentI18nData	getI18nData()
String	getId()
Map	getMap()
String	getOwningBoardName()
Command	getRestoreCommand()	When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null
protected PieceSlot	getTopPiece()
static String	getUsedBoardWildcard()
List<String>	getValidOwningBoards()
protected Stack	initializeContents()
protected boolean	isOwningBoardActive()
static boolean	isShowOthers()
protected boolean	isUseGridLocation()
protected boolean	placeNonStackingSeparately()
void	prepareConfigurer(Board board)
protected int	recursiveInitializeContents(Stack s, Configurable[] c, int num)	Traverses children components recursively (to support folder structure), adding any pieces found in PieceSlot objects to our stack.
void	removeFrom(Buildable parent)	Remove this component from its parent
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
static void	setCachedBoard(String s)
void	setId(String id)
void	setOwningBoardName(String n)
static void	setShowOthers(boolean b)
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended
static void	setUsedBoardWildcard(String s)
protected void	updateConfigureButton()
protected void	updateLocation()
protected void	updatePosition()
void	validate(Buildable target, ValidationReport report)

Methods inherited from class VASSAL.build.AbstractConfigurable

addPropertyChangeListener, getConfigureComponents, getFormattedStringList, getI18nPrefix, getLocalizedConfigureName, getMenuTextList, getNamedKeyStrokeList, getPropertyList, getTypeName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, build, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, getPropertyNames, setAncestor

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

build, getBuildElement, isMandatory, isMovable, isUnique

Field Details

COMMAND_PREFIX

public static final String COMMAND_PREFIX

See Also:

• Constant Field Values

pos

protected Point pos

OWNING_BOARD

public static final String OWNING_BOARD

See Also:

• Constant Field Values

X_POSITION

public static final String X_POSITION

See Also:

• Constant Field Values

Y_POSITION

public static final String Y_POSITION

See Also:

• Constant Field Values

parent

protected Buildable parent

map

protected Map map

owningBoardName

protected String owningBoardName

id

protected String id

NAME

public static final String NAME

See Also:

• Constant Field Values

indicator

protected static NewGameIndicator indicator

stackConfigurer

protected SetupStack.StackConfigurer stackConfigurer

configureButton

protected JButton configureButton

location

protected String location

useGridLocation

protected boolean useGridLocation

LOCATION

public static final String LOCATION

See Also:

• Constant Field Values

USE_GRID_LOCATION

public static final String USE_GRID_LOCATION

See Also:

• Constant Field Values

showOthers

public static boolean showOthers

usedBoardWildcard

protected static String usedBoardWildcard

cachedBoard

protected static String cachedBoard

xConfig

protected Configurer xConfig

yConfig

protected Configurer yConfig

locationConfig

protected Configurer locationConfig

DEFAULT_SIZE

protected static final Dimension DEFAULT_SIZE

DELTA

protected static final int DELTA

See Also:

• Constant Field Values

FAST

protected static final int FAST

See Also:

• Constant Field Values

FASTER

protected static final int FASTER

See Also:

• Constant Field Values

DEFAULT_DUMMY_SIZE

protected static final int DEFAULT_DUMMY_SIZE

See Also:

• Constant Field Values

Constructor Details

SetupStack

public SetupStack()

Method Details

isShowOthers

public static boolean isShowOthers()

setShowOthers

public static void setShowOthers(boolean b)

getUsedBoardWildcard

public static String getUsedBoardWildcard()

getCachedBoard

public static String getCachedBoard()

setUsedBoardWildcard

public static void setUsedBoardWildcard(String s)

setCachedBoard

public static void setCachedBoard(String s)

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 AbstractConfigurable

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.

isUseGridLocation

protected boolean isUseGridLocation()

updatePosition

protected void updatePosition()

validate

public void validate(Buildable target,
 ValidationReport report)

Specified by:

validate in interface ValidityChecker

Overrides:

validate in class AbstractBuildable

updateLocation

protected void updateLocation()

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

Parameters:

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

placeNonStackingSeparately

protected boolean placeNonStackingSeparately()

getOwningBoardName

public String getOwningBoardName()

setOwningBoardName

public void setOwningBoardName(String n)

getRestoreCommand

public Command getRestoreCommand()

Description copied from interface: GameComponent

When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null

Specified by:

getRestoreCommand in interface GameComponent

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

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

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

Specified by:

getAttributeValueString in class AbstractBuildable

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

Specified by:

setAttribute in class AbstractBuildable

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

getConfigureName

public String getConfigureName()

Setup Stacks with no name will display in editor w/ the name of something inside them that does have a name.

Specified by:

getConfigureName in interface Configurable

Specified by:

getConfigureName in interface UniqueIdManager.Identifyable

Overrides:

getConfigureName in class AbstractConfigurable

Returns:

Configure name of the Setup Stack

add

public void add(Buildable child)

Description copied from class: AbstractConfigurable

Set the owning translatable of this component

Specified by:

add in interface Buildable

Overrides:

add in class AbstractConfigurable

Parameters:

child - Child to attach to this buildable as a subcomponent

getMap

public Map getMap()

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

Parameters:

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

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Specified by:

getAllowableConfigureComponents in interface Configurable

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.

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

getConfigureTypeName

public static String getConfigureTypeName()

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

isOwningBoardActive

protected boolean isOwningBoardActive()

recursiveInitializeContents

protected int recursiveInitializeContents(Stack s,
 Configurable[] c,
 int num)

Traverses children components recursively (to support folder structure), adding any pieces found in PieceSlot objects to our stack.

Parameters:

s - The stack we are creating

c - Next layer of configurables to traverse

num - Incoming pieceslot count for error reporting

Returns:

resulting pieceslot count for error reporting

initializeContents

protected Stack initializeContents()

createStack

protected Stack createStack()

setId

public void setId(String id)

Specified by:

setId in interface UniqueIdManager.Identifyable

getId

public String getId()

Specified by:

getId in interface UniqueIdManager.Identifyable

getValidOwningBoards

public List<String> getValidOwningBoards()

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

updateConfigureButton

protected void updateConfigureButton()

prepareConfigurer

public void prepareConfigurer(Board board)

configureStack

protected void configureStack()

getTopPiece

protected PieceSlot getTopPiece()

getConfigureBoard

public Board getConfigureBoard(boolean checkSelectedBoards)

getConfigureBoard

protected Board getConfigureBoard()

getI18nData

public ComponentI18nData getI18nData()

Specified by:

getI18nData in interface Translatable

Overrides:

getI18nData in class AbstractConfigurable

Returns:

the i18n data for this component

getExpressionList

public List<String> getExpressionList()

SearchTarget

Specified by:

getExpressionList in interface SearchTarget

Overrides:

getExpressionList in class AbstractConfigurable

Returns:

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