Package VASSAL.build.module

Class Inventory

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.AbstractToolbarItem

VASSAL.build.module.Inventory

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, GameComponent, PlayerRoster.SideChangeListener, PropertyNameSource, ValidityChecker, Translatable, ImageSearchTarget, SearchTarget

public class Inventory
extends AbstractToolbarItem
implements GameComponent, PlayerRoster.SideChangeListener

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Inventory.Counter	Holds static information of and a reference to a gamepiece.
class	Inventory.CounterInventory
class	Inventory.CounterNode	CounterNode for the result tree.
static class	Inventory.FunctionConfig
class	Inventory.HotKeySender
static class	Inventory.IconConfig	Deprecated, for removal: This API element is subject to removal in a future version.
static class	Inventory.PieceFormatConfig
protected static class	Inventory.Selector	Filter to select pieces required
static class	Inventory.SortConfig

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static String	ALPHA
static String	BUTTON_FUNCTION
static String	BUTTON_TEXT	Deprecated, for removal: This API element is subject to removal in a future version.
protected boolean	centerOnPiece
static String	CENTERONPIECE
protected int	cutAboveLeaves
static String	CUTABOVELEAVES
protected int	cutBelowRoot
static String	CUTBELOWROOT
static String	DRAW_PIECES
protected boolean	drawPieces
static String	FILTER
static String	FOLDERS_ONLY
protected boolean	foldersOnly
static String	FORWARD_KEYSTROKE
protected boolean	forwardKeystroke
protected JDialog	frame
static String	FUNCTION_HIDE
static String[]	FUNCTION_KEYS
static String[]	FUNCTION_OPTIONS
static String	FUNCTION_REFRESH
static String	GROUP_BY
protected String[]	groupBy
protected String	groupSeparator
static String	HOTKEY	Deprecated, for removal: This API element is subject to removal in a future version.
static String	ICON	Deprecated, for removal: This API element is subject to removal in a future version.
protected KeyStroke	keyStroke
static String	KEYSTROKE
protected LaunchButton	launch	Deprecated, for removal: This API element is subject to removal in a future version. use launch from the superclass
static String	LAUNCH_FUNCTION
protected String	launchFunction
static String	LEAF_FORMAT
static String	LENGTHALPHA
protected String	mapSeparator
static String	NAME	Deprecated, for removal: This API element is subject to removal in a future version.
static String	NON_LEAF_FORMAT
protected String	nonLeafFormat
static String	NUMERIC
static String	PIECE_ZOOM
protected String	pieceFormat
protected PropertyExpression	piecePropertiesFilter
protected double	pieceZoom
protected Inventory.CounterInventory	results
static String	SHOW_MENU
protected boolean	showMenu
protected String[]	sides
static String	SIDES
static String	SORT_FORMAT
static String[]	SORT_OPTIONS
static String	SORT_PIECES
protected String	sortFormat
static String	SORTING
protected boolean	sortPieces
protected String	sortStrategy
static String	TOOLTIP	Deprecated, for removal: This API element is subject to removal in a future version.
protected JTree	tree
static String	VERSION

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

Method Summary

Modifier and Type	Method	Description
void	add(Buildable b)	Set the owning translatable of this component
void	addTo(Buildable b)	Default behavior adds the button to the module toolbar.
protected boolean	enabledForPlayersSide()
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeDescriptions()	This getAttributeDescriptions() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
String[]	getAttributeNames()	This getAttributeNames() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
Class<?>[]	getAttributeTypes()	This getAttributeTypes() will return the items specific to the Toolbar Button - classes extending this should add their own items as well.
String	getAttributeValueString(String key)	Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
protected boolean	getBooleanValue(Object o)
static String	getConfigureTypeName()
List<String>	getExpressionList()	SearchTarget
List<String>	getFormattedStringList()	SearchTarget
HelpFile	getHelpFile()
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
GamePiece	getSelectedCounter()
protected int	getTotalValue(GamePiece p)
protected Component	initButtons()
protected Component	initTree()	Construct an explorer like interface for the selected counters
protected TreeCellRenderer	initTreeCellRenderer()
protected void	inventoryToText()
protected void	launch()
protected Command	myUndoCommand()
void	remove(Buildable b)	Remove a Buildable object from this object
void	removeFrom(Buildable b)	Default behavior assumes we are removing this from the module toolbar
protected Command	sendHotKeyToPieces(KeyStroke keyStroke)
void	setAttribute(String key, Object o)	Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended
protected void	setupLaunch()
void	sideChanged(String oldSide, String newSide)	Update inventory according to change of side.

Methods inherited from class VASSAL.build.AbstractToolbarItem

addLocalImageNames, getComponent, getLaunchButton, getMenuTextList, getNamedKeyStrokeList, makeLaunchButton, setButtonTextKey, setHotKeyKey, setIconKey, setLaunchButton, setNameKey, setTooltipKey

Methods inherited from class VASSAL.build.AbstractConfigurable

addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, getI18nData, getI18nPrefix, getLocalizedConfigureName, getPropertyList, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

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

Methods inherited from class VASSAL.search.AbstractImageFinder

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

Field Details

launch

@Deprecated(since="2021-04-03",
            forRemoval=true)
protected LaunchButton launch

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

use launch from the superclass

results

protected Inventory.CounterInventory results

tree

protected JTree tree

VERSION

public static final String VERSION

See Also:

Constant Field Values

mapSeparator

protected String mapSeparator

groupSeparator

protected String groupSeparator

FILTER

public static final String FILTER

See Also:

Constant Field Values

piecePropertiesFilter

protected PropertyExpression piecePropertiesFilter

GROUP_BY

public static final String GROUP_BY

See Also:

Constant Field Values

groupBy

protected String[] groupBy

NON_LEAF_FORMAT

public static final String NON_LEAF_FORMAT

See Also:

Constant Field Values

nonLeafFormat

protected String nonLeafFormat

CENTERONPIECE

public static final String CENTERONPIECE

See Also:

Constant Field Values

centerOnPiece

protected boolean centerOnPiece

FORWARD_KEYSTROKE

public static final String FORWARD_KEYSTROKE

See Also:

Constant Field Values

forwardKeystroke

protected boolean forwardKeystroke

SHOW_MENU

public static final String SHOW_MENU

See Also:

Constant Field Values

showMenu

protected boolean showMenu

SIDES

public static final String SIDES

See Also:

Constant Field Values

sides

protected String[] sides

KEYSTROKE

public static final String KEYSTROKE

See Also:

Constant Field Values

keyStroke

protected KeyStroke keyStroke

CUTBELOWROOT

public static final String CUTBELOWROOT

See Also:

Constant Field Values

cutBelowRoot

protected int cutBelowRoot

CUTABOVELEAVES

public static final String CUTABOVELEAVES

See Also:

Constant Field Values

cutAboveLeaves

protected int cutAboveLeaves

LEAF_FORMAT

public static final String LEAF_FORMAT

See Also:

Constant Field Values

pieceFormat

protected String pieceFormat

PIECE_ZOOM

public static final String PIECE_ZOOM

See Also:

Constant Field Values

pieceZoom

protected double pieceZoom

DRAW_PIECES

public static final String DRAW_PIECES

See Also:

Constant Field Values

drawPieces

protected boolean drawPieces

FOLDERS_ONLY

public static final String FOLDERS_ONLY

See Also:

Constant Field Values

foldersOnly

protected boolean foldersOnly

SORT_PIECES

public static final String SORT_PIECES

See Also:

Constant Field Values

sortPieces

protected boolean sortPieces

SORT_FORMAT

public static final String SORT_FORMAT

See Also:

Constant Field Values

sortFormat

protected String sortFormat

ALPHA

public static final String ALPHA

See Also:

Constant Field Values

LENGTHALPHA

public static final String LENGTHALPHA

See Also:

Constant Field Values

NUMERIC

public static final String NUMERIC

See Also:

Constant Field Values

SORT_OPTIONS

public static final String[] SORT_OPTIONS

LAUNCH_FUNCTION

public static final String LAUNCH_FUNCTION

See Also:

Constant Field Values

FUNCTION_REFRESH

public static final String FUNCTION_REFRESH

See Also:

Constant Field Values

FUNCTION_HIDE

public static final String FUNCTION_HIDE

See Also:

Constant Field Values

FUNCTION_OPTIONS

public static final String[] FUNCTION_OPTIONS

FUNCTION_KEYS

public static final String[] FUNCTION_KEYS

launchFunction

protected String launchFunction

sortStrategy

protected String sortStrategy

SORTING

public static final String SORTING

See Also:

Constant Field Values

BUTTON_FUNCTION

public static final String BUTTON_FUNCTION

See Also:

Constant Field Values

frame

protected JDialog frame

HOTKEY

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String HOTKEY

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

See Also:

Constant Field Values

BUTTON_TEXT

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String BUTTON_TEXT

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

See Also:

Constant Field Values

NAME

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String NAME

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

See Also:

Constant Field Values

ICON

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String ICON

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

See Also:

Constant Field Values

TOOLTIP

@Deprecated(since="2020-10-21",
            forRemoval=true)
public static final String TOOLTIP

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

See Also:

Constant Field Values

Constructor Details

Inventory

public Inventory()

Method Details

getConfigureTypeName

public static String getConfigureTypeName()

addTo

public void addTo(Buildable b)

Description copied from class: AbstractToolbarItem

Default behavior adds the button to the module toolbar.

Specified by:

addTo in interface Buildable

Overrides:

addTo in class AbstractToolbarItem

Parameters:

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

initTree

protected Component initTree()

Construct an explorer like interface for the selected counters

initTreeCellRenderer

protected TreeCellRenderer initTreeCellRenderer()

initButtons

protected Component initButtons()

inventoryToText

protected void inventoryToText()

getSelectedCounter

public GamePiece getSelectedCounter()

removeFrom

public void removeFrom(Buildable b)

Description copied from class: AbstractToolbarItem

Default behavior assumes we are removing this from the module toolbar

Specified by:

removeFrom in interface Configurable

Overrides:

removeFrom in class AbstractToolbarItem

Parameters:

b - parent

add

public void add(Buildable b)

Description copied from class: AbstractConfigurable

Set the owning translatable of this component

Specified by:

add in interface Buildable

Overrides:

add in class AbstractConfigurable

Parameters:

b - Child to attach to this buildable as a subcomponent

remove

public void remove(Buildable b)

Description copied from class: AbstractConfigurable

Remove a Buildable object from this object

Specified by:

remove in interface Configurable

Overrides:

remove in class AbstractConfigurable

launch

protected void launch()

getTotalValue

protected int getTotalValue(GamePiece p)

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

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.

getAttributeDescriptions

public String[] getAttributeDescriptions()

Description copied from class: AbstractToolbarItem

This getAttributeDescriptions() will return the items specific to the Toolbar Button - classes extending this should add their own items as well. If the "nameKey" is blank, then no "name" configure entry will be generated. Extending classes can use ArrayUtils.addAll(super.getAttributeDescriptions(), key1, ..., keyN), or supply their own order from scratch.

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Overrides:

getAttributeDescriptions in class AbstractToolbarItem

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 class: AbstractToolbarItem

This getAttributeTypes() will return the items specific to the Toolbar Button - classes extending this should add their own items as well. If the "nameKey" is blank, then no "name" configure entry will be generated. Extending classes can use ArrayUtils.addAll(super.getAttributeTypes(), key1, ..., keyN), or supply their own order from scratch.

Specified by:

getAttributeTypes in interface AutoConfigurable

Overrides:

getAttributeTypes in class AbstractToolbarItem

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: AbstractToolbarItem

This getAttributeNames() will return the items specific to the Toolbar Button - classes extending this should add their own items as well. If the "nameKey" is blank, then no "name" configure entry will be generated. Extending classes can use ArrayUtils.addAll(super.getAttributeNames(), key1, ..., keyN), or supply their own order from scratch.

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 AbstractToolbarItem

Returns:

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

setAttribute

public void setAttribute(String key,
 Object o)

Description copied from class: AbstractToolbarItem

Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button. Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractToolbarItem.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractToolbarItem.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 AbstractToolbarItem

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractToolbarItem.getAttributeNames()

o - If the value parameter is a String, it will be the value returned by AbstractToolbarItem.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 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.

getBooleanValue

protected boolean getBooleanValue(Object o)

Parameters:

o - object

getAttributeValueString

public String getAttributeValueString(String key)

Description copied from class: AbstractToolbarItem

Classes extending AbstractToolbarItem can call this as a super() method after checking for their own keys, to avoid needing to deal with the nitty gritty of the toolbar button.

Specified by:

getAttributeValueString in interface AutoConfigurable

Specified by:

getAttributeValueString in interface Translatable

Overrides:

getAttributeValueString in class AbstractToolbarItem

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractToolbarItem.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 AbstractToolbarItem.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.

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

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

setupLaunch

protected void setupLaunch()

sideChanged

public void sideChanged(String oldSide,
 String newSide)

Update inventory according to change of side.

Specified by:

sideChanged in interface PlayerRoster.SideChangeListener

enabledForPlayersSide

protected boolean enabledForPlayersSide()

sendHotKeyToPieces

protected Command sendHotKeyToPieces(KeyStroke keyStroke)

Returns:

Command which only has some text in. The actual processing is done within the pieces.

myUndoCommand

protected Command myUndoCommand()

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)

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)