Package VASSAL.build.module.map
Class SetupStack
java.lang.Object
VASSAL.build.AbstractBuildable
VASSAL.build.AbstractConfigurable
VASSAL.build.module.map.SetupStack
- All Implemented Interfaces:
AutoConfigurable
,Buildable
,Configurable
,GameComponent
,PropertyNameSource
,ValidityChecker
,Translatable
,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 static String
COMMAND_PREFIX
protected JButton
configureButton
protected static int
DEFAULT_DUMMY_SIZE
protected static Dimension
DEFAULT_SIZE
protected static int
DELTA
protected static int
FAST
protected static int
FASTER
protected String
id
protected static NewGameIndicator
indicator
protected String
location
static String
LOCATION
protected Configurer
locationConfig
protected Map
map
static String
NAME
static String
OWNING_BOARD
protected String
owningBoardName
protected Point
pos
protected SetupStack.StackConfigurer
stackConfigurer
static String
USE_GRID_LOCATION
protected boolean
useGridLocation
static String
X_POSITION
protected Configurer
xConfig
static 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 componentvoid
addTo(Buildable parent)
Adds this component to its parent.protected void
configureStack()
protected Stack
createStack()
Class<?>[]
getAllowableConfigureComponents()
Return a list of valid sub-component Classes.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 buildFile (XML) attributes of this component.String
getAttributeValueString(String key)
Called by theBuildable.getBuildElement(org.w3c.dom.Document)
method to write the attributes into an XML elementVisibilityCondition
getAttributeVisibility(String name)
By default, all attributes are visibleprotected Board
getConfigureBoard()
protected Board
getConfigureBoard(boolean checkSelectedBoards)
Configurer
getConfigurer()
static String
getConfigureTypeName()
HelpFile
getHelpFile()
ComponentI18nData
getI18nData()
String
getId()
Command
getRestoreCommand()
When saving a game, each GameComponent should return aCommand
that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return nullprotected PieceSlot
getTopPiece()
protected Stack
initializeContents()
protected boolean
isOwningBoardActive()
protected boolean
isUseGridLocation()
protected boolean
placeNonStackingSeparately()
void
removeFrom(Buildable parent)
Remove this component from its parentvoid
setAttribute(String key, Object value)
Sets a buildFile (XML) attribute value for this component.void
setId(String id)
void
setup(boolean gameStarting)
Notify the GameComponent that a game has started/endedprotected void
updateConfigureButton()
protected void
updateLocation()
protected void
updatePosition()
void
validate(Buildable target, ValidationReport report)
Methods inherited from class VASSAL.build.AbstractConfigurable
addPropertyChangeListener, getConfigureComponents, getConfigureName, getI18nPrefix, getLocalizedConfigureName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName
Methods inherited from class VASSAL.build.AbstractBuildable
build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getPropertyNames
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
-
COMMAND_PREFIX
- See Also:
- Constant Field Values
-
pos
-
OWNING_BOARD
- See Also:
- Constant Field Values
-
X_POSITION
- See Also:
- Constant Field Values
-
Y_POSITION
- See Also:
- Constant Field Values
-
map
-
owningBoardName
-
id
-
NAME
- See Also:
- Constant Field Values
-
indicator
-
stackConfigurer
-
configureButton
-
location
-
useGridLocation
protected boolean useGridLocation -
LOCATION
- See Also:
- Constant Field Values
-
USE_GRID_LOCATION
- See Also:
- Constant Field Values
-
xConfig
-
yConfig
-
locationConfig
-
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
-
getAttributeVisibility
Description copied from class:AbstractConfigurable
By default, all attributes are visible- Specified by:
getAttributeVisibility
in interfaceAutoConfigurable
- Overrides:
getAttributeVisibility
in classAbstractConfigurable
- 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
- Specified by:
validate
in interfaceValidityChecker
- Overrides:
validate
in classAbstractBuildable
-
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 interfaceGameComponent
- Parameters:
gameStarting
- if true, a game is starting. If false, then a game is ending
-
placeNonStackingSeparately
protected boolean placeNonStackingSeparately() -
getRestoreCommand
Description copied from interface:GameComponent
When saving a game, each GameComponent should return aCommand
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 interfaceGameComponent
-
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 interfaceAutoConfigurable
- Specified by:
getAttributeDescriptions
in classAbstractConfigurable
- 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
Description copied from class:AbstractConfigurable
Return 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 ofAutoConfigurer
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 inAbstractBuildable.getAttributeNames()
- Specified by:
getAttributeTypes
in interfaceAutoConfigurable
- Specified by:
getAttributeTypes
in classAbstractConfigurable
-
getAttributeNames
Description copied from class:AbstractBuildable
Lists all the buildFile (XML) attribute names for this component. If this component is ALSO anAbstractConfigurable
, then this list of attributes determines the appropriate attribute order forAbstractConfigurable.getAttributeDescriptions()
andAbstractConfigurable.getAttributeTypes()
.- Specified by:
getAttributeNames
in interfaceAutoConfigurable
- Specified by:
getAttributeNames
in classAbstractBuildable
- Returns:
- a list of all buildFile (XML) attribute names for this component
-
getAttributeValueString
Description copied from interface:AutoConfigurable
Called by theBuildable.getBuildElement(org.w3c.dom.Document)
method to write the attributes into an XML element- Specified by:
getAttributeValueString
in interfaceAutoConfigurable
- Specified by:
getAttributeValueString
in interfaceTranslatable
- Specified by:
getAttributeValueString
in classAbstractBuildable
- Parameters:
key
- the name of the attribute. Will be one of those listed inAbstractBuildable.getAttributeNames()
- Returns:
- 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)
.
-
setAttribute
Description copied from class:AbstractBuildable
Sets a buildFile (XML) attribute value for this component. Thekey
parameter will be one of those listed inAbstractBuildable.getAttributeNames()
. If thevalue
parameter is a String, it will be the value returned byAbstractBuildable.getAttributeValueString(java.lang.String)
for the samekey
. If the implementing class extendsAbstractConfigurable
, thenvalue
will be an instance of the corresponding Class listed inAbstractConfigurable.getAttributeTypes()
- Specified by:
setAttribute
in interfaceAutoConfigurable
- Specified by:
setAttribute
in interfaceTranslatable
- Specified by:
setAttribute
in classAbstractBuildable
- Parameters:
key
- the name of the attribute. Will be one of those listed inAbstractBuildable.getAttributeNames()
value
- If thevalue
parameter is a String, it will be the value returned byAbstractBuildable.getAttributeValueString(java.lang.String)
for the samekey
. If the implementing class extendsAbstractConfigurable
, thenvalue
can also be an instance of the corresponding Class listed inAbstractConfigurable.getAttributeTypes()
-
add
Description copied from class:AbstractConfigurable
Set the owning translatable of this component- Specified by:
add
in interfaceBuildable
- Overrides:
add
in classAbstractConfigurable
-
addTo
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. -
getAllowableConfigureComponents
Description copied from interface:Configurable
Return 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 Configuration Window.- Specified by:
getAllowableConfigureComponents
in interfaceConfigurable
-
getHelpFile
- Specified by:
getHelpFile
in interfaceConfigurable
- Returns:
- a HelpFilte describing how to use and configure this component
-
getConfigureTypeName
-
removeFrom
Description copied from interface:Configurable
Remove this component from its parent- Specified by:
removeFrom
in interfaceConfigurable
-
isOwningBoardActive
protected boolean isOwningBoardActive() -
initializeContents
-
createStack
-
setId
- Specified by:
setId
in interfaceUniqueIdManager.Identifyable
-
getId
- Specified by:
getId
in interfaceUniqueIdManager.Identifyable
-
getConfigurer
Description copied from class:AbstractConfigurable
- Specified by:
getConfigurer
in interfaceConfigurable
- Overrides:
getConfigurer
in classAbstractConfigurable
- Returns:
- Configurer for this component
-
updateConfigureButton
protected void updateConfigureButton() -
configureStack
protected void configureStack() -
getTopPiece
-
getConfigureBoard
-
getConfigureBoard
-
getI18nData
- Specified by:
getI18nData
in interfaceTranslatable
- Overrides:
getI18nData
in classAbstractConfigurable
- Returns:
- the i18n data for this component
-