Package VASSAL.build.module.map

Class BoardPicker

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.module.map.BoardPicker

All Implemented Interfaces:

ActionListener, EventListener, Buildable, Configurable, GameComponent, GameSetupStep, PropertyNameSource, CommandEncoder, ValidityChecker, Translatable, ImageSearchTarget

public class BoardPicker
extends AbstractBuildable
implements ActionListener, GameComponent, GameSetupStep, Configurable, CommandEncoder, ValidityChecker

This class is responsible for maintaining the Boards on a Map. As a CommandEncoder, it recognizes Commands that specify the set of boards to be used on a map. As a GameComponent it reacts to the start of a game by prompting the player to select boards if none have been specified.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BoardPicker.SetBoards

Field Summary

Fields

Modifier and Type	Field	Description
static String	ADD_COLUMN_BUTTON_TEXT
static String	ADD_ROW_BUTTON_TEXT
protected JButton	addColumnButton
protected String	addColumnButtonText
protected JButton	addRowButton
protected String	addRowButtonText
protected boolean	allowMultiple
static String	BOARD_PROMPT
protected String	boardPrompt
protected JButton	clearButton
protected JPanel	controls
protected List<Board>	currentBoards
protected String	defaultSetup
static String	DIALOG_TITLE
static String	ID
protected Map	map
static String	MAX_COLUMNS
protected int	maxColumns
protected List<JButton>	multipleButtons
protected ComponentI18nData	myI18nData
protected int	nx
protected int	ny
protected JButton	okButton
protected List<Board>	possibleBoards
protected Dimension	psize
static String	SCALE
static String	SETUP
static String	SLOT_HEIGHT
static String	SLOT_WIDTH
protected JPanel	slotPanel
protected double	slotScale
protected JScrollPane	slotScroll
protected JTextField	status	Deprecated, for removal: This API element is subject to removal in a future version.
protected JLabel	statusLabel
protected String	title
protected JToolBar	toolbar
protected String	version

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
BoardPicker()

Method Summary

Modifier and Type	Method	Description
void	actionPerformed(ActionEvent e)
void	add(Buildable b)	Add a board to the list of those available for the user to choose from
protected JButton	addButton(String s)
protected JButton	addButton(String s, int index)
protected void	addColumn()
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
protected void	addRow()
void	addTo(Buildable b)	Adds this component to its parent.
void	build(Element e)	Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(java.lang.String, java.lang.Object) with the String value of the attribute
Command	decode(String command)	Translate a String into a Command
String	encode(Command c)	Translate a Command into a String
void	finish()	Apply the information gathered via the component to the game in progress
String[]	getAllowableBoardNames()
Class<?>[]	getAllowableConfigureComponents()
String[]	getAllowableLocalizedBoardNames()
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
String	getAttributeValueString(String attr)
Board	getBoard(String boardName)
protected Board	getBoard(String boardName, boolean localized)
String	getBoardDelimiter()
List<Board>	getBoardsFromControls()	Return the list of boards as specified in the current controls
Element	getBuildElement(Document doc)
int	getColumnCount()
Configurable[]	getConfigureComponents()
String	getConfigureName()	The name of this Configurable Object
Configurer	getConfigurer()
static String	getConfigureTypeName()
Component	getControls()	A GUI component that prompts the player for the needed information.
Enumeration<Board>	getCurrentBoards()	Deprecated, for removal: This API element is subject to removal in a future version. Use getSelectedBoards() instead.
Dimension	getDefaultSlotSize()
HelpFile	getHelpFile()
ComponentI18nData	getI18nData()
Board	getLocalizedBoard(String localizedBoardName)
BoardSlot	getNeighbor(BoardSlot slot, int dx, int dy)
Command	getRestoreCommand()	The restore command of a BoardPicker, when executed, sets the boards of its Map to getSelectedBoards()
int	getRowCount()
List<String>	getSelectedBoardNames()
Collection<Board>	getSelectedBoards()
BoardSlot	getSlot(int i)
double	getSlotScale()
String	getStepTitle()	A human-understandable description of this step
protected void	initComponents()
boolean	isAllowMultiple()
boolean	isFinished()
void	pack()	Deprecated, for removal: This API element is subject to removal in a future version. No replacement
Vector<Board>	pickBoards()	Deprecated, for removal: This API element is subject to removal in a future version. Use getBoardsFromControls().
void	remove(Buildable b)	Remove a board from the list of those available for the user to choose from
protected void	removeAllBoards()
void	removeFrom(Buildable parent)	Remove this component from its parent
void	repaint()
void	repaintAll()
void	reset()
protected void	selectBoards(Component c)
void	setAllowMultiple(boolean val)
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setBoards(Collection<Board> c)
void	setBoards(Enumeration<Board> bdEnum)	Deprecated, for removal: This API element is subject to removal in a future version. Use setBoards(Collection) instead.
void	setup(boolean show)	When starting a game, check to see if any boards have been specified (via an encoded Command.
void	validate(Buildable target, ValidationReport report)
void	warn(String s)

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getComponents, getComponentsOf, getPropertyNames

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

Field Details

ID

public static final String ID

See Also:

Constant Field Values

possibleBoards

protected List<Board> possibleBoards

currentBoards

protected List<Board> currentBoards

psize

protected Dimension psize

slotScale

protected double slotScale

status

@Deprecated(since="2020-08-06",
            forRemoval=true)
protected JTextField status

Deprecated, for removal: This API element is subject to removal in a future version.

statusLabel

protected JLabel statusLabel

map

protected Map map

slotPanel

protected JPanel slotPanel

version

protected String version

nx

protected int nx

ny

protected int ny

toolbar

protected JToolBar toolbar

controls

protected JPanel controls

addRowButton

protected JButton addRowButton

addColumnButton

protected JButton addColumnButton

allowMultiple

protected boolean allowMultiple

maxColumns

protected int maxColumns

title

protected String title

addRowButtonText

protected String addRowButtonText

addColumnButtonText

protected String addColumnButtonText

boardPrompt

protected String boardPrompt

defaultSetup

protected String defaultSetup

multipleButtons

protected List<JButton> multipleButtons

SCALE

public static final String SCALE

See Also:

Constant Field Values

SLOT_HEIGHT

public static final String SLOT_HEIGHT

See Also:

Constant Field Values

SLOT_WIDTH

public static final String SLOT_WIDTH

See Also:

Constant Field Values

SETUP

public static final String SETUP

See Also:

Constant Field Values

DIALOG_TITLE

public static final String DIALOG_TITLE

See Also:

Constant Field Values

ADD_ROW_BUTTON_TEXT

public static final String ADD_ROW_BUTTON_TEXT

See Also:

Constant Field Values

ADD_COLUMN_BUTTON_TEXT

public static final String ADD_COLUMN_BUTTON_TEXT

See Also:

Constant Field Values

BOARD_PROMPT

public static final String BOARD_PROMPT

See Also:

Constant Field Values

MAX_COLUMNS

public static final String MAX_COLUMNS

See Also:

Constant Field Values

clearButton

protected JButton clearButton

okButton

protected JButton okButton

myI18nData

protected ComponentI18nData myI18nData

slotScroll

protected JScrollPane slotScroll

Constructor Details

BoardPicker

public BoardPicker()

Method Details

initComponents

protected void initComponents()

getDefaultSlotSize

public Dimension getDefaultSlotSize()

getSlotScale

public double getSlotScale()

Returns:

the zoom factory at which to display boards when selecting them

warn

public void warn(String s)

addTo

public void addTo(Buildable b)

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:

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

build

public void build(Element e)

Description copied from class: AbstractBuildable

Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(java.lang.String, java.lang.Object) with the String value of the attribute

Specified by:

build in interface Buildable

Overrides:

build in class AbstractBuildable

Parameters:

e - the XML element containing the object data

validate

public void validate(Buildable target,
 ValidationReport report)

Specified by:

validate in interface ValidityChecker

Overrides:

validate in class AbstractBuildable

add

public void add(Buildable b)

Add a board to the list of those available for the user to choose from

Specified by:

add in interface Buildable

Overrides:

add in class AbstractBuildable

Parameters:

b - Child to attach to this buildable as a subcomponent

remove

public void remove(Buildable b)

Remove a board from the list of those available for the user to choose from

Specified by:

remove in interface Configurable

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

getConfigureTypeName

public static String getConfigureTypeName()

getConfigureName

public String getConfigureName()

Description copied from interface: Configurable

The name of this Configurable Object

Specified by:

getConfigureName in interface Configurable

getBoardDelimiter

public String getBoardDelimiter()

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

getConfigurer

public Configurer getConfigurer()

Specified by:

getConfigurer in interface Configurable

Returns:

a Configurer object which can be used to set the attributes of this object

getConfigureComponents

public Configurable[] getConfigureComponents()

Specified by:

getConfigureComponents in interface Configurable

Returns:

an array of Configurer objects representing the Configurable children of this Configurable object

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.

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Description copied from interface: Configurable

Add a PropertyChangeListener. A PropertyChangeEvent should be fired with property name Configurable.NAME_PROPERTY when the value returned from Configurable.getConfigureName() has changed

Specified by:

addPropertyChangeListener in interface Configurable

setBoards

public void setBoards(Collection<Board> c)

setBoards

@Deprecated(since="2020-08-06",
            forRemoval=true)
public void setBoards(Enumeration<Board> bdEnum)

Deprecated, for removal: This API element is subject to removal in a future version.

Use setBoards(Collection) instead.

selectBoards

protected void selectBoards(Component c)

getSelectedBoards

public Collection<Board> getSelectedBoards()

Returns:

a Collection of boards that have been selected either by the user via the dialog or from reading a savefile

getSelectedBoardNames

public List<String> getSelectedBoardNames()

Returns:

a List of the names of all boards from which have been selected either by the user via the dialog or from reading a savefile

getCurrentBoards

@Deprecated(since="2020-08-06",
            forRemoval=true)
public Enumeration<Board> getCurrentBoards()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getSelectedBoards() instead.

Returns:

an Enumeration of boards that have been selected either by the user via the dialog or from reading a savefile

getAllowableBoardNames

public String[] getAllowableBoardNames()

Returns:

an array of the names of all boards from which the user may choose

getAllowableLocalizedBoardNames

public String[] getAllowableLocalizedBoardNames()

getBoard

public Board getBoard(String boardName)

Returns:

a Board with the given name.

getLocalizedBoard

public Board getLocalizedBoard(String localizedBoardName)

getBoard

protected Board getBoard(String boardName,
 boolean localized)

setup

public void setup(boolean show)

When starting a game, check to see if any boards have been specified (via an encoded Command. If not, show a dialog to prompt the user for boards. When ending a game, clear the selected boards

Specified by:

setup in interface GameComponent

Parameters:

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

finish

public void finish()

Description copied from interface: GameSetupStep

Apply the information gathered via the component to the game in progress

Specified by:

finish in interface GameSetupStep

getControls

public Component getControls()

Description copied from interface: GameSetupStep

A GUI component that prompts the player for the needed information. If null, then no further information is needed

Specified by:

getControls in interface GameSetupStep

getStepTitle

public String getStepTitle()

Description copied from interface: GameSetupStep

A human-understandable description of this step

Specified by:

getStepTitle in interface GameSetupStep

isFinished

public boolean isFinished()

Specified by:

isFinished in interface GameSetupStep

Returns:

true if this step needs no further information, false if the player should be prompted for more information

getRestoreCommand

public Command getRestoreCommand()

The restore command of a BoardPicker, when executed, sets the boards of its Map to getSelectedBoards()

Specified by:

getRestoreCommand in interface GameComponent

addButton

protected JButton addButton(String s)

addButton

protected JButton addButton(String s,
 int index)

addRow

protected void addRow()

addColumn

protected void addColumn()

actionPerformed

public void actionPerformed(ActionEvent e)

Specified by:

actionPerformed in interface ActionListener

pickBoards

@Deprecated(since="2020-08-06",
            forRemoval=true)
public Vector<Board> pickBoards()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getBoardsFromControls().

getBoardsFromControls

public List<Board> getBoardsFromControls()

Return the list of boards as specified in the current controls

Returns:

List of Boards

reset

public void reset()

getRowCount

public int getRowCount()

getColumnCount

public int getColumnCount()

getNeighbor

public BoardSlot getNeighbor(BoardSlot slot,
 int dx,
 int dy)

getSlot

public BoardSlot getSlot(int i)

repaintAll

public void repaintAll()

removeAllBoards

protected void removeAllBoards()

isAllowMultiple

public boolean isAllowMultiple()

Returns:

true if multiple boards per map window are allowed

setAllowMultiple

public void setAllowMultiple(boolean val)

getBuildElement

public Element getBuildElement(Document doc)

Specified by:

getBuildElement in interface Buildable

Overrides:

getBuildElement in class AbstractBuildable

Parameters:

doc - XML file

Returns:

an XML element from which this component can be built

decode

public Command decode(String command)

Description copied from interface: CommandEncoder

Translate a String into a Command

Specified by:

decode in interface CommandEncoder

encode

public String encode(Command c)

Description copied from interface: CommandEncoder

Translate a Command into a String

Specified by:

encode in interface CommandEncoder

getI18nData

public ComponentI18nData getI18nData()

Specified by:

getI18nData in interface Translatable

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

getAttributeValueString

public String getAttributeValueString(String attr)

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.

repaint

public void repaint()

pack

@Deprecated(since="2020-08-06",
            forRemoval=true)
public void pack()

Deprecated, for removal: This API element is subject to removal in a future version.

No replacement

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 class AbstractBuildable

Returns:

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