Uses of Interface
VASSAL.build.Configurable

Packages that use Configurable

Package	Description
VASSAL.build	Provides classes for building Java instances automatically from XML files.
VASSAL.build.module	Contains classes that may be added to a GameModule.
VASSAL.build.module.chessclockcontrol
VASSAL.build.module.documentation	Contains classes that may be added to a Documentation.
VASSAL.build.module.gamepieceimage
VASSAL.build.module.map	Contains classes that may be added to a Map.
VASSAL.build.module.map.boardPicker	Contains classes that may be added to a BoardPicker.
VASSAL.build.module.map.boardPicker.board	Contains classes that may be added to a Board.
VASSAL.build.module.map.boardPicker.board.mapgrid	Contains classes that may be added to a MapGrid.
VASSAL.build.module.properties
VASSAL.build.module.turn
VASSAL.build.widget	Contains classes that can be added to a Widget.
VASSAL.configure	Provides classes for building "Edit Property" dialogs, and for editing GameModule's and ModuleExtension's.
VASSAL.counters	Provides classes that define game pieces.
VASSAL.i18n
VASSAL.launch
VASSAL.preferences	Provides support for specifying and saving preferences.
VASSAL.script
VASSAL.tools	Contains various utility classes.
VASSAL.tools.icon

Uses of Configurable in VASSAL.build

Subinterfaces of Configurable in VASSAL.build

Modifier and Type	Interface	Description
interface	AutoConfigurable	A class that implements AutoConfigurable can use the AutoConfigurer class to automatically build a property editor.

Classes in VASSAL.build that implement Configurable

Modifier and Type	Class	Description
class	AbstractConfigurable	An abstract implementation of the Configurable interface.
class	AbstractToolbarItem	Creates an item that is both configurable w/ an edit box AbstractConfigurable and buildable from the XML buildFile AbstractBuildable, but which also has a Toolbar launch button.
class	GameModule	The GameModule class is the base class for a VASSAL module.
class	Widget	A general-purpose configurable GUI container Widgets are Configurable objects that represent AWT components.

Methods in VASSAL.build that return Configurable

Modifier and Type	Method	Description
Configurable[]	AbstractConfigurable.getConfigureComponents()
Configurable[]	Configurable.getConfigureComponents()
Configurable[]	Widget.getConfigureComponents()

Uses of Configurable in VASSAL.build.module

Classes in VASSAL.build.module that implement Configurable

Modifier and Type	Class	Description
class	ChartWindow	A top-level Widget for displaying Charts
class	ChessClockControl	CHESS CLOCK CONTROLLER for VASSAL.
class	DiceButton	This component places a button into the controls window toolbar.
class	DieManager
class	DoActionButton	This component places a button into the controls window toolbar.
class	Documentation	Represents the Help menu of the controls window
class	GlobalKeyCommand	This version of MassKeyCommand is added directly to a GameModule and applies to all maps.
class	GlobalOptions	GlobalOptions is a junction point for several flavors of "preferences"-related categories.
class	InternetDiceButton	This component places a button into the controls window toolbar.
class	Inventory
class	Map	The Map is the main component for displaying and containing GamePieces during play.
class	MultiActionButton	Combines multiple buttons from the toolbar into a single button.
class	NotesWindow	This is a GameComponent that allows players to type and save text notes during a game.
class	PieceWindow	A window from which players can create new GamePieces by clicking and dragging from the PieceWindow.
class	PlayerHand
class	PlayerRoster	Maintains a list of players involved in the current game
class	Plugin	Plugin is a general purpose component for use by Module Plugins that require some sort of initialisation.
class	PredefinedSetup	Defines a saved game that is accessible from the File menu.
class	PrivateMap	A Map that may be configured to be visible only a particular side.
class	PrototypeDefinition
class	PrototypesContainer	Container for definitions of Game Piece prototypes.
class	RandomTextButton
class	SpecialDiceButton	...
class	SpecialDie
class	SpecialDieFace
class	StartupGlobalKeyCommand	A Global Key Command that is automatically invoked on game start-up, once the various Key Listeners have been started.
class	ToolbarMenu	Takes buttons from the toolbar of a Map or the main module and places them into a popup menu

Methods in VASSAL.build.module that return Configurable

Modifier and Type	Method	Description
Configurable[]	NotesWindow.getConfigureComponents()
Configurable[]	PlayerRoster.getConfigureComponents()
Configurable[]	PrototypeDefinition.getConfigureComponents()
Configurable[]	ExtensionElement.getTargetPath()

Constructors in VASSAL.build.module with parameters of type Configurable

Modifier	Constructor	Description
	ExtensionElement(Buildable extension, Configurable[] targetPath)

Uses of Configurable in VASSAL.build.module.chessclockcontrol

Classes in VASSAL.build.module.chessclockcontrol that implement Configurable

Modifier and Type	Class	Description
class	ChessClock	CHESS CLOCK class for VASSAL.

Uses of Configurable in VASSAL.build.module.documentation

Classes in VASSAL.build.module.documentation that implement Configurable

Modifier and Type	Class	Description
class	AboutScreen	Places an entry in the Help menu.
class	BrowserHelpFile	Unpacks a zipped directory stored in the module and displays it in an external browser window.
protected class	BrowserHelpFile.ConfigSupport	The attributes we want to expose in the editor are not the same as the ones we want to save to the buildFile, so we use this object to specify the properties in the editor.
class	BrowserPDFFile	Easier-to-use support for opening a single PDF file in the browser (it can be done with BrowserHelpFile, but requires a substantial workaround and weird confusing procedures)
class	HelpFile	Places an entry in the Help menu.
class	Tutorial	Provides tutorial functionality by reading in a logfile

Methods in VASSAL.build.module.documentation that return Configurable

Modifier and Type	Method	Description
Configurable[]	BrowserHelpFile.ConfigSupport.getConfigureComponents()
Configurable[]	BrowserHelpFile.getConfigureComponents()

Uses of Configurable in VASSAL.build.module.gamepieceimage

Classes in VASSAL.build.module.gamepieceimage that implement Configurable

Modifier and Type	Class	Description
class	ColorManager	Container for definitions of Generic Color Definitions
class	ColorSwatch	Class that implements a named Color Swatch
class	FontManager	Container for definitions of Generic Color Definitions
class	FontStyle	Class that implements a names Font Swatch
class	GamePieceImage
class	GamePieceImageDefinitions	Container for definitions of Generic Counter Definitions.
class	GamePieceLayout
class	GamePieceLayoutsContainer	Container for definitions of Generic Counter Definitions.
class	ImageItem
class	ImageItemInstance
class	Item	The base portion of a Counter Layout component.
class	ItemInstance	Individual override parameters for an instance of an Item.
class	ShapeItem
class	ShapeItemInstance
class	SymbolItem
class	SymbolItemInstance
class	TextBoxItem
class	TextBoxItemInstance
class	TextItem
class	TextItemInstance

Uses of Configurable in VASSAL.build.module.map

Classes in VASSAL.build.module.map that implement Configurable

Modifier and Type	Class	Description
class	BoardPicker	This class is responsible for maintaining the Boards on a Map.
class	CounterDetailViewer	This is a Drawable class that draws the counters horizontally when the mouse is held over a stack with the control key down.
class	DeckGlobalKeyCommand	This version of MassKeyCommand is added to a DrawPile (which holds a Deck) and applies to pieces/cards currently in the deck.
class	DrawPile
class	Flare	Allows a player to ping a location ("send up a flare") by clicking on a map with the correct modifier key combination held down (default: Alt+LeftClick).
class	GlobalMap	This is scaled version of a Map that gives an overview.
protected class	GlobalMap.CounterViewer
class	HandMetrics	Handles the drawing of cards in a PlayerHand.
class	HidePiecesButton	This removes all game pieces from the (@link Map) therefore providing an un-cluttered view.
class	HighlightLastMoved
class	ImageSaver	This allows the user to capture a snapshot of the entire map into a PNG file.
class	LayerControl	Adds a button to the toolbar to manipulate Game Piece Layers
class	LayeredPieceCollection	The optional "Game Piece Layers" component of a Map which allows pieces on the map to be assigned to an arbitrary number of visual layers according to a property setting.
class	LOS_Thread	A class that allows the user to draw a straight line on a Map (LOS = Line Of Sight).
class	MapShader	Draw shaded regions on a map.
class	MassKeyCommand	Adds a button to a map window toolbar.
class	PieceRecenterer	Adds a button to a Maps toolbar that adjusts the positions of all pieces so that their centroid is at the center of the map
class	SelectionHighlighter
class	SelectionHighlighters
class	SetupStack	This is the "At-Start Stack" component, which initializes a Map or Board with a specified stack.
class	StackMetrics	StackMetrics provides the [Stacking options] component of a Map.
class	TextSaver
class	Zoomer	Controls the zooming in/out of a Map window.

Methods in VASSAL.build.module.map that return Configurable

Modifier and Type	Method	Description
Configurable[]	BoardPicker.getConfigureComponents()
Configurable[]	GlobalMap.getConfigureComponents()
Configurable[]	HidePiecesButton.getConfigureComponents()
Configurable[]	LOS_Thread.getConfigureComponents()

Uses of Configurable in VASSAL.build.module.map.boardPicker

Classes in VASSAL.build.module.map.boardPicker that implement Configurable

Modifier and Type	Class	Description
class	Board

Uses of Configurable in VASSAL.build.module.map.boardPicker.board

Classes in VASSAL.build.module.map.boardPicker.board that implement Configurable

Modifier and Type	Class	Description
class	HexGrid	A Hexgrid is a map grid composed of hexes.
class	Region
class	RegionGrid
class	SquareGrid
class	ZonedGrid	Map Grid that contains any number of Zones against a background MapGrid

Uses of Configurable in VASSAL.build.module.map.boardPicker.board.mapgrid

Classes in VASSAL.build.module.map.boardPicker.board.mapgrid that implement Configurable

Modifier and Type	Class	Description
class	HexGridNumbering
class	RegularGridNumbering	Abstract base class for grid numbering classes for hexagonal and rectangular grids
class	SquareGridNumbering
class	Zone
class	ZonedGridHighlighter
class	ZoneHighlight	A Class that defines a method of highlighting the a zone in a multi-zoned grid.

Uses of Configurable in VASSAL.build.module.properties

Classes in VASSAL.build.module.properties that implement Configurable

Modifier and Type	Class	Description
class	ChangePropertyButton	Adds a toolbar button that changes the value of a global property
class	GlobalProperties	Dummy component that acts as a simple container for GlobalProperty components
class	GlobalProperty	Adds a global property to a Map or Module
class	GlobalTranslatableMessage	Adds a global property to a Map or Module
class	GlobalTranslatableMessages	Dummy component that acts as a simple container for GlobalProperty components
class	ZoneProperty

Uses of Configurable in VASSAL.build.module.turn

Classes in VASSAL.build.module.turn that implement Configurable

Modifier and Type	Class	Description
class	CounterTurnLevel
class	ListTurnLevel
class	TurnComponent	Generic Turn Component
class	TurnGlobalHotkey
class	TurnLevel
class	TurnTracker	Generic Turn Counter

Uses of Configurable in VASSAL.build.widget

Classes in VASSAL.build.widget that implement Configurable

Modifier and Type	Class	Description
class	BoxWidget	A Widget that corresponds to a panel with a JComboBox above a JPanel with a CardLayout layout.
class	CardSlot	A CardSlot is identical to a PieceSlot except that it is initialized with a card-like GamePiece.
class	Chart	A Chart is used for displaying charts and tables for the module.
class	HtmlChart	An HtmlChart is used for displaying html information for the module.
class	ListWidget	A Widget that corresponds to a panel with a JList sitting to the right of a JPanel with a CardLayout layout.
class	MapWidget
class	PanelWidget	A Widget that corresponds to a JPanel with a GridLayout or BoxLayout layout.
class	PieceSlot	A Component that displays a GamePiece.
class	TabWidget	A Widget that corresponds to a JTabbedPane.
class	WidgetMap

Methods in VASSAL.build.widget that return Configurable

Modifier and Type	Method	Description
Configurable[]	PieceSlot.getConfigureComponents()

Uses of Configurable in VASSAL.configure

Fields in VASSAL.configure declared as Configurable

Modifier and Type	Field	Description
protected Configurable	ConfigureTree.selected
protected Configurable	EditPropertiesAction.target

Fields in VASSAL.configure with type parameters of type Configurable

Modifier and Type	Field	Description
protected Map<Configurable,DefaultMutableTreeNode>	ConfigureTree.nodes
protected static Map<Configurable,PropertiesWindow>	EditPropertiesAction.openWindows

Methods in VASSAL.configure that return Configurable

Modifier and Type	Method	Description
protected Configurable	ConfigureTree.convertChild(Configurable parent, Configurable child)	Some components need to be converted to a new type before insertion.
protected Configurable	ConfigureTree.getParent(DefaultMutableTreeNode targetNode)
protected Configurable	ConfigureTree.getParent(Configurable target)	Find the parent Configurable of a specified Configurable
Configurable[]	ChooseComponentPathDialog.getPath()
Configurable[]	ExtensionTree.getPath(DefaultMutableTreeNode node)
Configurable	ChooseComponentDialog.getTarget()
protected Configurable	ConfigureTree.getTarget(int x, int y)
protected Configurable	ConfigureTree.importConfigurable()

Methods in VASSAL.configure with parameters of type Configurable

Modifier and Type	Method	Description
protected Action	ConfigureTree.buildAddAction(Configurable target, Class<? extends Buildable> newConfig)
protected Action	ExtensionTree.buildAddAction(Configurable target, Class<? extends Buildable> newConfig)
protected Enumeration<Action>	ConfigureTree.buildAddActions(Configurable target)	Deprecated, for removal: This API element is subject to removal in a future version. Use ConfigureTree.buildAddActionsFor(Configurable) instead.
protected List<Action>	ConfigureTree.buildAddActionsFor(Configurable target)
protected Action	ConfigureTree.buildCloneAction(Configurable target)
protected Action	ExtensionTree.buildCloneAction(Configurable target)
protected Action	ConfigureTree.buildCopyAction(Configurable target)
protected Action	ConfigureTree.buildCutAction(Configurable target)
protected Action	ExtensionTree.buildCutAction(Configurable target)
protected Action	ConfigureTree.buildDeleteAction(Configurable target)
protected Action	ExtensionTree.buildDeleteAction(Configurable target)
protected Action	ConfigureTree.buildEditAction(Configurable target)
protected Action	ExtensionTree.buildEditAction(Configurable target)
protected Action	ConfigureTree.buildEditPiecesAction(Configurable target)
protected Action	ExtensionTree.buildEditPiecesAction(Configurable target)
protected Action	ConfigureTree.buildHelpAction(Configurable target)
protected Action	ConfigureTree.buildImportAction(Configurable target)
protected Action	ExtensionTree.buildImportAction(Configurable target)
protected Action	ConfigureTree.buildMassPieceLoaderAction(Configurable target)
protected Action	ConfigureTree.buildMoveAction(Configurable target)
protected Action	ExtensionTree.buildMoveAction(Configurable target)
protected Action	ConfigureTree.buildPasteAction(Configurable target)
protected Action	ExtensionTree.buildPasteAction(Configurable target)
protected JPopupMenu	ConfigureTree.buildPopupMenu(Configurable target)
protected Action	ConfigureTree.buildSearchAction(Configurable target)
protected Action	ConfigureTree.buildTranslateAction(Configurable target)
protected DefaultMutableTreeNode	ConfigureTree.buildTreeNode(Configurable c)
boolean	ConfigureTree.canContainGamePiece(Configurable target)
protected Configurable	ConfigureTree.convertChild(Configurable parent, Configurable child)	Some components need to be converted to a new type before insertion.
void	ConfigureTree.externalInsert(Configurable parent, Configurable child)	Build an AddAction and execute it to request a new component from the user
void	ExtensionTree.externalInsert(Configurable parent, Configurable child)
static String	ConfigureTree.getConfigureName(Configurable c)
protected Configurable	ConfigureTree.getParent(Configurable target)	Find the parent Configurable of a specified Configurable
DefaultMutableTreeNode	ConfigureTree.getTreeNode(Configurable target)
protected boolean	ConfigureTree.hasChild(Configurable parent, Class<?> childClass)
protected void	PropertiesWindow.initialize(Configurable target, HelpWindow helpWindow)
protected boolean	ConfigureTree.insert(Configurable parent, Configurable child, int index)
protected boolean	ConfigureTree.isAllowedChildClass(Configurable parent, Class<?> childClass)
protected boolean	ConfigureTree.isValidParent(Configurable parent, Configurable child)
protected boolean	ExtensionTree.isValidParent(Configurable parent, Configurable child)
protected boolean	ConfigureTree.isValidPasteTarget(Configurable target)
protected boolean	ExtensionTree.isValidPasteTarget(Configurable target)
void	ConfigureTree.nodeEdited(Configurable target)	Called when the Configurable held by a node has been edited.
void	ConfigureTree.nodeUpdated(Configurable target)
protected boolean	ConfigureTree.remove(Configurable parent, Configurable child)
void	ConfigureTree.updateGpIds(Configurable c)	Allocate new PieceSlot Id's to any PieceSlot sub-components
void	ExtensionTree.updateGpIds(Configurable c)	Allocate new PieceSlot Id's to any PieceSlot sub-components

Constructors in VASSAL.configure with parameters of type Configurable

Modifier	Constructor	Description
	ConfigureTree(Configurable root, HelpWindow helpWindow)	Creates new ConfigureTree
	ConfigureTree(Configurable root, HelpWindow helpWindow, EditorWindow editorWindow)
	EditContainedPiecesAction(Configurable target)
	EditPropertiesAction(Configurable target, HelpWindow helpWindow, Frame dialogOwner)
	EditPropertiesAction(Configurable target, HelpWindow helpWindow, Frame dialogOwner, ConfigureTree tree)
	ExtensionTree(Configurable root, HelpWindow helpWindow, ModuleExtension extension, EditorWindow editorWindow)
	PropertiesWindow(Frame owner, boolean modal, Configurable target, HelpWindow helpWindow)
	SimpleConfigurer(Configurable c, Configurer[] attConfigurers)

Uses of Configurable in VASSAL.counters

Fields in VASSAL.counters declared as Configurable

Modifier and Type	Field	Description
protected Configurable	MassPieceLoader.target

Constructors in VASSAL.counters with parameters of type Configurable

Modifier	Constructor	Description
	MassPieceDefiner(Configurable top)
	MassPieceLoader(ConfigureTree tree, Configurable target)

Uses of Configurable in VASSAL.i18n

Classes in VASSAL.i18n that implement Configurable

Modifier and Type	Class	Description
class	Language	Container for definitions of Translations.
class	Localization	Singleton class for managing the translation of a module into other languages
class	TranslatableMarker
class	Translation
class	VassalTranslation	Utility class to allow translation of VASSAL using the Component Translation mechanism.

Fields in VASSAL.i18n declared as Configurable

Modifier and Type	Field	Description
protected Configurable	ComponentI18nData.myComponent
protected Configurable	TranslateWindow.MyPropertiesWindow.myTarget
protected Configurable	TranslateAction.target

Fields in VASSAL.i18n with type parameters of type Configurable

Modifier and Type	Field	Description
protected static Map<Configurable,TranslateWindow>	TranslateAction.openWindows

Methods in VASSAL.i18n with parameters of type Configurable

Modifier and Type	Method	Description
protected void	ComponentI18nData.init(Configurable c, String pfx, String[] names, Class<?>[] types, String[] descriptions)
protected void	ComponentI18nData.init(Configurable c, String pfx, String[] names, String[] descriptions, boolean[] translatable)
protected void	TranslateWindow.refreshTranslationList(Configurable target)	Called from MyPropertiesWindow when the user saves the new translation

Constructors in VASSAL.i18n with parameters of type Configurable

Modifier	Constructor	Description
	ComponentI18nData(Configurable c, String prefix)
	ComponentI18nData(Configurable c, String prefix, Translatable parent)
	ComponentI18nData(Configurable c, String prefix, Translatable parent, String[] names, boolean[] translatable, String[] descriptions)	Build from a Configurable.
	ComponentI18nData(Configurable c, GamePiece piece)	Special build for PrototypeDefinition and PieceSlot
	MyPropertiesWindow(Frame owner, boolean modal, Configurable target, HelpWindow helpWindow, TranslateWindow tw)
	TranslateAction(Configurable target, HelpWindow helpWindow, ConfigureTree tree)

Uses of Configurable in VASSAL.launch

Classes in VASSAL.launch that implement Configurable

Modifier and Type	Class	Description
class	BasicModule	Deprecated, for removal: This API element is subject to removal in a future version.

Uses of Configurable in VASSAL.preferences

Classes in VASSAL.preferences that implement Configurable

Modifier and Type	Class	Description
class	BasicPreference	Base class for a Module Preference.
class	BooleanPreference	A Checkbox Module Preference.
class	DoublePreference	A Decimal Number Module Preference.
class	EnumPreference	A Drop-down list preference.
class	IntegerPreference	A whole number Module Preference.
class	StringPreference	A String Module Preference.
class	TextPreference	A multi-line textbox Module Preference.

Uses of Configurable in VASSAL.script

Classes in VASSAL.script that implement Configurable

Modifier and Type	Class	Description
class	AbstractScript
class	ActionScript
class	BshPlugin
class	GeneralScript
class	ScriptContainer	Container for Scripts.

Uses of Configurable in VASSAL.tools

Methods in VASSAL.tools that return Configurable

Modifier and Type	Method	Description
Configurable[]	ComponentPathBuilder.getPath(String id)	Return a list of Configurable components specified by the given identifier.

Methods in VASSAL.tools with parameters of type Configurable

Modifier and Type	Method	Description
String	ComponentPathBuilder.getId(Configurable[] targetPath)	Return a string identifying the specified Configurable components as a path through the configuration parent-child hierarchy.

Method parameters in VASSAL.tools with type arguments of type Configurable

Modifier and Type	Method	Description
protected void	SavedGameUpdater.findPieceSlots(List<Configurable> l, Properties p)

Uses of Configurable in VASSAL.tools.icon

Classes in VASSAL.tools.icon that implement Configurable

Modifier and Type	Class	Description
class	IconFamily	An IconFamily is a named set of Icons in the four standard Tango sizes.