Package VASSAL.build.module
Class Inventory
java.lang.Object
VASSAL.build.AbstractBuildable
VASSAL.build.AbstractConfigurable
VASSAL.build.module.Inventory
- All Implemented Interfaces:
AutoConfigurable
,Buildable
,Configurable
,GameComponent
,PlayerRoster.SideChangeListener
,PropertyNameSource
,ValidityChecker
,Translatable
public class Inventory extends AbstractConfigurable 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.class
Inventory.HotKeySender
static class
Inventory.IconConfig
static class
Inventory.PieceFormatConfig
protected static class
Inventory.Selector
Filter to select pieces requiredstatic class
Inventory.SortConfig
Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable
AutoConfigurable.Util
-
Field Summary
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 componentvoid
addTo(Buildable b)
Adds this component to its parent.protected boolean
enabledForPlayersSide()
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 boolean
getBooleanValue(Object o)
protected Component
getComponent()
static String
getConfigureTypeName()
HelpFile
getHelpFile()
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 nullGamePiece
getSelectedCounter()
protected int
getTotalValue(GamePiece p)
protected Component
initButtons()
protected Component
initTree()
Construct an explorer like interface for the selected countersprotected TreeCellRenderer
initTreeCellRenderer()
protected void
inventoryToText()
protected void
launch()
protected Command
myUndoCommand()
void
remove(Buildable b)
Remove a Buildable object from this objectvoid
removeFrom(Buildable b)
Remove this component from its parentprotected Command
sendHotKeyToPieces(KeyStroke keyStroke)
void
setAttribute(String key, Object o)
Sets a buildFile (XML) attribute value for this component.void
setup(boolean gameStarting)
Notify the GameComponent that a game has started/endedprotected void
setupLaunch()
void
sideChanged(String oldSide, String newSide)
Update inventory according to change of side.Methods inherited from class VASSAL.build.AbstractConfigurable
addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, getI18nData, getI18nPrefix, getLocalizedConfigureName, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName
Methods inherited from class VASSAL.build.AbstractBuildable
build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getPropertyNames, validate
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
-
results
-
tree
-
VERSION
- See Also:
- Constant Field Values
-
HOTKEY
- See Also:
- Constant Field Values
-
BUTTON_TEXT
- See Also:
- Constant Field Values
-
NAME
- See Also:
- Constant Field Values
-
ICON
- See Also:
- Constant Field Values
-
TOOLTIP
- See Also:
- Constant Field Values
-
mapSeparator
-
groupSeparator
-
FILTER
- See Also:
- Constant Field Values
-
piecePropertiesFilter
-
GROUP_BY
- See Also:
- Constant Field Values
-
groupBy
-
NON_LEAF_FORMAT
- See Also:
- Constant Field Values
-
nonLeafFormat
-
CENTERONPIECE
- See Also:
- Constant Field Values
-
centerOnPiece
protected boolean centerOnPiece -
FORWARD_KEYSTROKE
- See Also:
- Constant Field Values
-
forwardKeystroke
protected boolean forwardKeystroke -
SHOW_MENU
- See Also:
- Constant Field Values
-
showMenu
protected boolean showMenu -
SIDES
- See Also:
- Constant Field Values
-
sides
-
KEYSTROKE
- See Also:
- Constant Field Values
-
keyStroke
-
CUTBELOWROOT
- See Also:
- Constant Field Values
-
cutBelowRoot
protected int cutBelowRoot -
CUTABOVELEAVES
- See Also:
- Constant Field Values
-
cutAboveLeaves
protected int cutAboveLeaves -
LEAF_FORMAT
- See Also:
- Constant Field Values
-
pieceFormat
-
PIECE_ZOOM
- See Also:
- Constant Field Values
-
pieceZoom
protected double pieceZoom -
DRAW_PIECES
- See Also:
- Constant Field Values
-
drawPieces
protected boolean drawPieces -
FOLDERS_ONLY
- See Also:
- Constant Field Values
-
foldersOnly
protected boolean foldersOnly -
SORT_PIECES
- See Also:
- Constant Field Values
-
sortPieces
protected boolean sortPieces -
SORT_FORMAT
- See Also:
- Constant Field Values
-
sortFormat
-
ALPHA
- See Also:
- Constant Field Values
-
LENGTHALPHA
- See Also:
- Constant Field Values
-
NUMERIC
- See Also:
- Constant Field Values
-
SORT_OPTIONS
-
sortStrategy
-
SORTING
- See Also:
- Constant Field Values
-
frame
-
-
Constructor Details
-
Inventory
public Inventory()
-
-
Method Details
-
getConfigureTypeName
-
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. -
initTree
Construct an explorer like interface for the selected counters -
initTreeCellRenderer
-
initButtons
-
inventoryToText
protected void inventoryToText() -
getSelectedCounter
-
getComponent
-
removeFrom
Description copied from interface:Configurable
Remove this component from its parent- Specified by:
removeFrom
in interfaceConfigurable
-
add
Description copied from class:AbstractConfigurable
Set the owning translatable of this component- Specified by:
add
in interfaceBuildable
- Overrides:
add
in classAbstractConfigurable
-
remove
Description copied from class:AbstractConfigurable
Remove a Buildable object from this object- Specified by:
remove
in interfaceConfigurable
- Overrides:
remove
in classAbstractConfigurable
-
launch
protected void launch() -
getTotalValue
-
getHelpFile
- Specified by:
getHelpFile
in interfaceConfigurable
- Returns:
- a HelpFilte describing how to use and configure this component
-
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
-
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
-
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()
o
- 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()
-
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.
-
getBooleanValue
- Parameters:
o
-
-
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)
.
-
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
-
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
-
setupLaunch
protected void setupLaunch() -
sideChanged
Update inventory according to change of side.- Specified by:
sideChanged
in interfacePlayerRoster.SideChangeListener
-
enabledForPlayersSide
protected boolean enabledForPlayersSide() -
sendHotKeyToPieces
- Returns:
- Command which only has some text in. The actual processing is done within the pieces.
-
myUndoCommand
-