Uses of Interface
VASSAL.build.Configurable
Package
Description
Provides classes for building Java instances automatically from XML
files.
Contains classes that may be added to a
GameModule
.Contains classes that may be added to a
Documentation
.Contains classes that may be added to a
Map
.Contains classes that may be added to a
BoardPicker
.Contains classes that may be added to a
Board
.Contains classes that may be added to a
MapGrid
.Contains classes that can be added to a
Widget
.Provides classes for building "Edit Property" dialogs, and for editing
GameModule
's and ModuleExtension
's.Provides classes that define game pieces.
Provides support for specifying and saving preferences.
Contains various utility classes.
-
Uses of Configurable in VASSAL.build
Modifier and TypeInterfaceDescriptioninterface
A class that implements AutoConfigurable can use theAutoConfigurer
class to automatically build a property editor.Modifier and TypeClassDescriptionclass
An abstract implementation of theConfigurable
interface.class
Abstract class for a Folder component that can contain/organize a particular type of configurable(s).class
Creates an item that is both configurable w/ an edit boxAbstractConfigurable
and buildable from the XML buildFileAbstractBuildable
, but which also has a Toolbar launch button.class
The GameModule class is the base class for a VASSAL module.class
A general-purpose configurable GUI container Widgets areConfigurable
objects that represent AWT components.Modifier and TypeMethodDescriptionAbstractConfigurable.getConfigureComponents()
Configurable.getConfigureComponents()
Widget.getConfigureComponents()
-
Uses of Configurable in VASSAL.build.module
Modifier and TypeClassDescriptionclass
A top-level Widget for displaying Chartsclass
CHESS CLOCK CONTROLLER for VASSAL.class
This component places a button into the controls window toolbar.class
class
This component places a button into the controls window toolbar.class
Represents theHelp
menu of the controls windowclass
This version ofMassKeyCommand
is added directly to aGameModule
and applies to all maps.class
GlobalOptions is a junction point for several flavors of "preferences"-related categories.class
This component places a button into the controls window toolbar.class
class
The Map is the main component for displaying and containingGamePiece
s during play.class
Combines multiple buttons from the toolbar into a single button.class
This is aGameComponent
that allows players to type and save text notes during a game.class
A window from which players can create newGamePiece
s by clicking and dragging from the PieceWindow.class
class
Maintains a list of players involved in the current gameclass
Plugin is a general purpose component for use by Module Plugins that require some sort of initialisation.class
Defines a saved game that is accessible from the File menu.class
A Map that may be configured to be visible only a particular side.class
class
Container for definitions of Game Piece prototypes.class
class
...class
class
class
A Global Key Command that is automatically invoked on game start-up, once the various Key Listeners have been started.class
Takes buttons from the toolbar of a Map or the main module and places them into a popup menuModifier and TypeMethodDescriptionNotesWindow.getConfigureComponents()
PlayerRoster.getConfigureComponents()
PrototypeDefinition.getConfigureComponents()
ExtensionElement.getTargetPath()
Modifier and TypeMethodDescriptionvoid
PrototypeDefinition.Config.initCustomControls
(JDialog d, Configurable target) -
Uses of Configurable in VASSAL.build.module.chessclockcontrol
-
Uses of Configurable in VASSAL.build.module.documentation
Modifier and TypeClassDescriptionclass
Places an entry in theHelp
menu.class
Unpacks a zipped directory stored in the module and displays it in an external browser window.protected class
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
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
Places an entry in theHelp
menu.class
Provides tutorial functionality by reading in a logfileModifier and TypeMethodDescriptionBrowserHelpFile.ConfigSupport.getConfigureComponents()
BrowserHelpFile.getConfigureComponents()
-
Uses of Configurable in VASSAL.build.module.folder
Modifier and TypeClassDescriptionclass
class
class
class
class
-
Uses of Configurable in VASSAL.build.module.gamepieceimage
Modifier and TypeClassDescriptionclass
Container for definitions of Generic Color Definitionsclass
Class that implements a named Color Swatchclass
Container for definitions of Generic Color Definitionsclass
Class that implements a names Font Swatchclass
class
Container for definitions of Generic Counter Definitions.class
class
Container for definitions of Generic Counter Definitions.class
class
class
The base portion of a Counter Layout component.class
Individual override parameters for an instance of anItem
.class
class
class
class
class
class
class
class
-
Uses of Configurable in VASSAL.build.module.map
Modifier and TypeClassDescriptionclass
class
This is aDrawable
class that draws the counters horizontally when the mouse is held over a stack with the control key down.class
This version ofMassKeyCommand
is added to aDrawPile
(which holds aDeck
) and applies to pieces/cards currently in the deck.class
class
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
This is scaled version of aMap
that gives an overview.protected class
class
Handles the drawing of cards in aPlayerHand
.class
This removes all game pieces from the (@link Map) therefore providing an un-cluttered view.class
class
This allows the user to capture a snapshot of the entire map into a PNG file.class
Adds a button to the toolbar to manipulate Game Piece Layersclass
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
A class that allows the user to draw a straight line on a Map (LOS = Line Of Sight).class
Draw shaded regions on a map.class
Adds a button to a map window toolbar.class
Adds a button to a Maps toolbar that moves the view/camera to a specific pointclass
Adds a button to a Maps toolbar that adjusts the positions of all pieces so that their centroid is at the center of the mapclass
class
class
This is the "At-Start Stack" component, which initializes a Map or Board with a specified stack.class
StackMetrics provides the [Stacking options] component of aMap
.class
class
Controls the zooming in/out of aMap
window.Modifier and TypeMethodDescriptionBoardPicker.getConfigureComponents()
GlobalMap.getConfigureComponents()
HidePiecesButton.getConfigureComponents()
LOS_Thread.getConfigureComponents()
Modifier and TypeMethodDescriptionprotected int
SetupStack.recursiveInitializeContents
(Stack s, Configurable[] c, int num) Traverses children components recursively (to support folder structure), adding any pieces found in PieceSlot objects to our stack. -
Uses of Configurable in VASSAL.build.module.map.boardPicker
-
Uses of Configurable in VASSAL.build.module.map.boardPicker.board
Modifier and TypeClassDescriptionclass
A Hexgrid is a map grid composed of hexes.class
class
class
class
-
Uses of Configurable in VASSAL.build.module.map.boardPicker.board.mapgrid
Modifier and TypeClassDescriptionclass
class
Abstract base class for grid numbering classes for hexagonal and rectangular gridsclass
class
class
class
A Class that defines a method of highlighting the a zone in a multi-zoned grid. -
Uses of Configurable in VASSAL.build.module.map.deck
Modifier and TypeClassDescriptionclass
Base class for additional Menu items (with Hotkeys) that can be added to a DrawPile/Deckclass
class
-
Uses of Configurable in VASSAL.build.module.properties
Modifier and TypeClassDescriptionclass
class
class
Adds a toolbar button that changes the value of a global propertyclass
Dummy component that acts as a simple container for GlobalProperty componentsclass
Adds a global property to a Map or Moduleclass
Adds a global property to a Map or Moduleclass
Dummy component that acts as a simple container for GlobalProperty componentsclass
class
class
class
class
-
Uses of Configurable in VASSAL.build.module.turn
Modifier and TypeClassDescriptionclass
class
class
Generic Turn Componentclass
class
class
Generic Turn Counter -
Uses of Configurable in VASSAL.build.widget
Modifier and TypeClassDescriptionclass
class
A CardSlot is identical to a PieceSlot except that it is initialized with a card-like GamePiece.class
A Chart is used for displaying charts and tables for the module.class
An HtmlChart is used for displaying html information for the module.class
A Widget that corresponds to a panel with aJList
sitting to the right of aJPanel
with aCardLayout
layout.class
class
A Widget that corresponds to a JPanel with a GridLayout or BoxLayout layout.class
A Component that displays a GamePiece.class
A Widget that corresponds to a JTabbedPane.class
-
Uses of Configurable in VASSAL.configure
Modifier and TypeFieldDescriptionprotected Configurable
ConfigureTree.selected
protected final Configurable
ConfigureTree.AddAction.target
protected Configurable
EditPropertiesAction.target
Modifier and TypeFieldDescriptionprotected Map
<Configurable, DefaultMutableTreeNode> ConfigureTree.nodes
protected static final Map
<Configurable, PropertiesWindow> EditPropertiesAction.openWindows
Modifier and TypeMethodDescriptionprotected Configurable
ConfigureTree.convertChild
(Configurable parent, Configurable child) Some components need to be converted to a new type before insertion.protected Configurable
ConfigureTree.AddAction.getChild()
protected Configurable
ConfigureTree.ImportAction.getChild()
protected Configurable
ConfigureTree.getParent
(DefaultMutableTreeNode targetNode) protected Configurable
ConfigureTree.getParent
(Configurable target) Find the parent Configurable of a specified ConfigurableChooseComponentPathDialog.getPath()
ExtensionTree.getPath
(DefaultMutableTreeNode node) ChooseComponentDialog.getTarget()
protected Configurable
ConfigureTree.getTarget
(int x, int y) protected Configurable
ConfigureTree.importConfigurable()
Modifier and TypeMethodDescriptionprotected void
ExtensionTree.addToExtension
(Configurable parent, Configurable child) If the parent we are adding an element to is non-editable, then it is part of the base module and we need to add a new ExtensionElement to the Extension to record the location of childprotected Action
ConfigureTree.buildAddAction
(Configurable target, Class<? extends Buildable> newConfig) protected Action
ConfigureTree.buildAddAction
(Configurable target, Class<? extends Buildable> newConfig, String key, int index, Configurable duplicate) protected Action
ExtensionTree.buildAddAction
(Configurable target, Class<? extends Buildable> newConfig) protected Action
ExtensionTree.buildAddAction
(Configurable target, Class<? extends Buildable> newConfig, String key, int index, Configurable duplicate) ConfigureTree.buildAddActionsFor
(Configurable target) ConfigureTree.buildAddActionsFor
(Configurable target, List<Action> peerInserts) 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.buildExportTreeAction
(Configurable target) protected Action
ConfigureTree.buildHelpAction
(Configurable target) protected Action
ConfigureTree.buildImportAction
(Configurable target) protected Action
ExtensionTree.buildImportAction
(Configurable target) protected Action
ConfigureTree.buildImportDeckAction
(Configurable target) protected Action
ConfigureTree.buildImportTreeAction
(Configurable target) protected Action
ConfigureTree.buildMassPieceLoaderAction
(Configurable target) protected Action
ConfigureTree.buildMoveAction
(Configurable target) protected Action
ExtensionTree.buildMoveAction
(Configurable target) protected Action
ConfigureTree.buildOpenPiecesAction
(Configurable target) protected Action
ExtensionTree.buildOpenPiecesAction
(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.protected boolean
ConfigureTree.delete
(Configurable target) Delete removes an item from the tree but ALSO traverses the tree throwing all the children's children manually out the airlock, one by one.protected void
ExtensionTree.deleteFromExtension
(Configurable parent, Configurable child) Delete the corresponding ExtensionElement from the Extension if the parent is non-editable i.e.protected void
ConfigureTree.AddAction.doIt
(Configurable child) void
ConfigureTree.externalInsert
(Configurable parent, Configurable child) Build an AddAction and execute it to request a new component from the uservoid
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 ConfigurableConfigureTree.getTreeNode
(Configurable target) protected boolean
ConfigureTree.hasChild
(Configurable parent, Class<?> childClass) protected boolean
ConfigureTree.importTreeBranch
(Configurable target) void
Configurer.initCustomControls
(JDialog d, Configurable target) Initialize any custom controls / keystrokesprotected 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.isDeleteAllowed
(Configurable target) Is the Component allowed to be deleted?protected boolean
ConfigureTree.isDuplicateAllowed
(Configurable target) Is the Component allowed to be duplicated?boolean
ConfigureTree.isMoveAllowed
(Configurable target) Is the Component allowed to be moved?protected boolean
ConfigureTree.isValidParent
(Configurable parent, Configurable child) protected boolean
ExtensionTree.isValidParent
(Configurable parent, Configurable child) protected boolean
ConfigureTree.isValidPasteTarget
(Configurable target) protected boolean
ConfigureTree.isValidPasteTarget
(Configurable target, DefaultMutableTreeNode sourceNode) protected boolean
ExtensionTree.isValidPasteTarget
(Configurable target) protected boolean
ExtensionTree.isValidPasteTarget
(Configurable target, DefaultMutableTreeNode sourceNode) void
ConfigureTree.jumpToTarget
(Configurable target) void
ConfigureTree.nodeEdited
(Configurable target) Called when the Configurable held by a node has been edited.void
ConfigureTree.nodeUpdated
(Configurable target) protected void
ConfigureTree.postInsertProcessing
(Configurable parent, Configurable child) protected void
ExtensionTree.postInsertProcessing
(Configurable parent, Configurable child) protected void
ConfigureTree.postPasteFixups
(Configurable target) If there are items that need to be adjusted after being pasted (to make sure they don't contain illegal values that will be hard to debug later), we can make them here.protected void
ConfigureTree.postRemoveProcessing
(Configurable parent, Configurable child) protected void
ExtensionTree.postRemoveProcessing
(Configurable parent, Configurable child) protected boolean
ConfigureTree.remove
(Configurable parent, Configurable child) void
Configurer.setContext
(Configurable context) void
ConfigureTree.updateGpIds
(Configurable c) Allocate new PieceSlot Ids to any PieceSlot subcomponentsvoid
ExtensionTree.updateGpIds
(Configurable c) Allocate new PieceSlot Id's to any PieceSlot sub-componentsModifierConstructorDescriptionAddAction
(Configurable target, Class<? extends Buildable> newConfig, String name, int index, Configurable duplicate) ConfigureTree
(Configurable root, HelpWindow helpWindow) Creates new ConfigureTreeConfigureTree
(Configurable root, HelpWindow helpWindow, EditorWindow editorWindow) ConfigureTree
(Configurable root, HelpWindow helpWindow, EditorWindow editorWindow, boolean disableDragAndDrop) EditContainedPiecesAction
(Configurable target, ConfigureTree tree) 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) ImportAction
(Configurable target, String name) OpenContainedPiecesAction
(Configurable target, HelpWindow helpWindow, Frame dialogOwner, ConfigureTree tree) PropertiesWindow
(Frame owner, boolean modal, Configurable target, HelpWindow helpWindow) SimpleConfigurer
(Configurable c, Configurer[] attConfigurers) -
Uses of Configurable in VASSAL.counters
Modifier and TypeMethodDescriptionvoid
PieceDefiner.initCustomControls
(JDialog d, Configurable target) ModifierConstructorDescriptionMassPieceDefiner
(Configurable top, ConfigureTree tree) MassPieceLoader
(ConfigureTree tree, Configurable target) -
Uses of Configurable in VASSAL.i18n
Modifier and TypeClassDescriptionclass
Container for definitions of Translations.class
Singleton class for managing the translation of a module into other languagesclass
class
class
Utility class to allow translation of VASSAL using the Component Translation mechanism.Modifier and TypeFieldDescriptionprotected Configurable
ComponentI18nData.myComponent
protected Configurable
TranslateWindow.MyPropertiesWindow.myTarget
protected Configurable
TranslateAction.target
Modifier and TypeFieldDescriptionprotected static final Map
<Configurable, TranslateWindow> TranslateAction.openWindows
Modifier and TypeMethodDescriptionprotected 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 translationModifierConstructorDescriptionComponentI18nData
(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 PieceSlotMyPropertiesWindow
(Frame owner, boolean modal, Configurable target, HelpWindow helpWindow, TranslateWindow tw) TranslateAction
(Configurable target, HelpWindow helpWindow, ConfigureTree tree) -
Uses of Configurable in VASSAL.launch
Modifier and TypeClassDescriptionclass
Deprecated, for removal: This API element is subject to removal in a future version. -
Uses of Configurable in VASSAL.preferences
Modifier and TypeClassDescriptionclass
Base class for a Module Preference.class
A Checkbox Module Preference.class
A Decimal Number Module Preference.class
A Drop-down list preference.class
A whole number Module Preference.class
A String Module Preference.class
A multi-line textbox Module Preference. -
Uses of Configurable in VASSAL.script
Modifier and TypeClassDescriptionclass
class
class
class
class
Container for Scripts. -
Uses of Configurable in VASSAL.tools
Modifier and TypeMethodDescriptionReturn a list ofConfigurable
components specified by the given identifier.Modifier and TypeMethodDescriptionComponentPathBuilder.getId
(Configurable[] targetPath) Return a string identifying the specifiedConfigurable
components as a path through the configuration parent-child hierarchy.Modifier and TypeMethodDescriptionprotected void
SavedGameUpdater.findPieceSlots
(List<Configurable> l, Properties p) -
Uses of Configurable in VASSAL.tools.icon
Modifier and TypeClassDescriptionclass
An IconFamily is a named set of Icons in the four standard Tango sizes.