Uses of Interface
VASSAL.build.Configurable
Packages that use 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
Subinterfaces of Configurable in VASSAL.buildModifier and TypeInterfaceDescriptioninterfaceA class that implements AutoConfigurable can use theAutoConfigurerclass to automatically build a property editor.Classes in VASSAL.build that implement ConfigurableModifier and TypeClassDescriptionclassAn abstract implementation of theConfigurableinterface.classAbstract class for a Folder component that can contain/organize a particular type of configurable(s).classCreates an item that is both configurable w/ an edit boxAbstractConfigurableand buildable from the XML buildFileAbstractBuildable, but which also has a Toolbar launch button.classThe GameModule class is the base class for a VASSAL module.classA general-purpose configurable GUI container Widgets areConfigurableobjects that represent AWT components.Methods in VASSAL.build that return ConfigurableModifier and TypeMethodDescriptionAbstractConfigurable.getConfigureComponents()Configurable.getConfigureComponents()Widget.getConfigureComponents() -
Uses of Configurable in VASSAL.build.module
Classes in VASSAL.build.module that implement ConfigurableModifier and TypeClassDescriptionclassA top-level Widget for displaying ChartsclassCHESS CLOCK CONTROLLER for VASSAL.classThis component places a button into the controls window toolbar.classclassThis component places a button into the controls window toolbar.classRepresents theHelpmenu of the controls windowclassThis version ofMassKeyCommandis added directly to aGameModuleand applies to all maps.classGlobalOptions is a junction point for several flavors of "preferences"-related categories.classThis component places a button into the controls window toolbar.classclassThe Map is the main component for displaying and containingGamePieces during play.classCombines multiple buttons from the toolbar into a single button.classThis is aGameComponentthat allows players to type and save text notes during a game.classA window from which players can create newGamePieces by clicking and dragging from the PieceWindow.classclassMaintains a list of players involved in the current gameclassPlugin is a general purpose component for use by Module Plugins that require some sort of initialisation.classDefines a saved game that is accessible from the File menu.classA Map that may be configured to be visible only a particular side.classclassContainer for definitions of Game Piece prototypes.classclass...classclassclassA Global Key Command that is automatically invoked on game start-up, once the various Key Listeners have been started.classTakes buttons from the toolbar of a Map or the main module and places them into a popup menuMethods in VASSAL.build.module that return ConfigurableModifier and TypeMethodDescriptionNotesWindow.getConfigureComponents()PlayerRoster.getConfigureComponents()PrototypeDefinition.getConfigureComponents()ExtensionElement.getTargetPath()Methods in VASSAL.build.module with parameters of type ConfigurableModifier and TypeMethodDescriptionvoidPrototypeDefinition.Config.initCustomControls(JDialog d, Configurable target) Constructors in VASSAL.build.module with parameters of type Configurable -
Uses of Configurable in VASSAL.build.module.chessclockcontrol
Classes in VASSAL.build.module.chessclockcontrol that implement Configurable -
Uses of Configurable in VASSAL.build.module.documentation
Classes in VASSAL.build.module.documentation that implement ConfigurableModifier and TypeClassDescriptionclassPlaces an entry in theHelpmenu.classUnpacks a zipped directory stored in the module and displays it in an external browser window.protected classThe 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.classEasier-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)classPlaces an entry in theHelpmenu.classProvides tutorial functionality by reading in a logfileMethods in VASSAL.build.module.documentation that return ConfigurableModifier and TypeMethodDescriptionBrowserHelpFile.ConfigSupport.getConfigureComponents()BrowserHelpFile.getConfigureComponents() -
Uses of Configurable in VASSAL.build.module.folder
Classes in VASSAL.build.module.folder that implement ConfigurableModifier and TypeClassDescriptionclassclassclassclassclass -
Uses of Configurable in VASSAL.build.module.gamepieceimage
Classes in VASSAL.build.module.gamepieceimage that implement ConfigurableModifier and TypeClassDescriptionclassContainer for definitions of Generic Color DefinitionsclassClass that implements a named Color SwatchclassContainer for definitions of Generic Color DefinitionsclassClass that implements a names Font SwatchclassclassContainer for definitions of Generic Counter Definitions.classclassContainer for definitions of Generic Counter Definitions.classclassclassThe base portion of a Counter Layout component.classIndividual override parameters for an instance of anItem.classclassclassclassclassclassclassclass -
Uses of Configurable in VASSAL.build.module.map
Classes in VASSAL.build.module.map that implement ConfigurableModifier and TypeClassDescriptionclassclassThis is aDrawableclass that draws the counters horizontally when the mouse is held over a stack with the control key down.classThis version ofMassKeyCommandis added to aDrawPile(which holds aDeck) and applies to pieces/cards currently in the deck.classclassAllows 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).classThis is scaled version of aMapthat gives an overview.protected classclassHandles the drawing of cards in aPlayerHand.classThis removes all game pieces from the (@link Map) therefore providing an un-cluttered view.classclassThis allows the user to capture a snapshot of the entire map into a PNG file.classAdds a button to the toolbar to manipulate Game Piece LayersclassThe 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.classA class that allows the user to draw a straight line on a Map (LOS = Line Of Sight).classDraw shaded regions on a map.classAdds a button to a map window toolbar.classAdds a button to a Maps toolbar that moves the view/camera to a specific pointclassAdds a button to a Maps toolbar that adjusts the positions of all pieces so that their centroid is at the center of the mapclassclassclassThis is the "At-Start Stack" component, which initializes a Map or Board with a specified stack.classStackMetrics provides the [Stacking options] component of aMap.classclassControls the zooming in/out of aMapwindow.Methods in VASSAL.build.module.map that return ConfigurableModifier and TypeMethodDescriptionBoardPicker.getConfigureComponents()GlobalMap.getConfigureComponents()HidePiecesButton.getConfigureComponents()LOS_Thread.getConfigureComponents()Methods in VASSAL.build.module.map with parameters of type ConfigurableModifier and TypeMethodDescriptionprotected intSetupStack.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
Classes in VASSAL.build.module.map.boardPicker that implement Configurable -
Uses of Configurable in VASSAL.build.module.map.boardPicker.board
Classes in VASSAL.build.module.map.boardPicker.board that implement ConfigurableModifier and TypeClassDescriptionclassA Hexgrid is a map grid composed of hexes.classclassclassclass -
Uses of Configurable in VASSAL.build.module.map.boardPicker.board.mapgrid
Classes in VASSAL.build.module.map.boardPicker.board.mapgrid that implement ConfigurableModifier and TypeClassDescriptionclassclassAbstract base class for grid numbering classes for hexagonal and rectangular gridsclassclassclassclassA Class that defines a method of highlighting the a zone in a multi-zoned grid. -
Uses of Configurable in VASSAL.build.module.map.deck
Classes in VASSAL.build.module.map.deck that implement ConfigurableModifier and TypeClassDescriptionclassBase class for additional Menu items (with Hotkeys) that can be added to a DrawPile/Deckclassclass -
Uses of Configurable in VASSAL.build.module.properties
Classes in VASSAL.build.module.properties that implement ConfigurableModifier and TypeClassDescriptionclassclassclassAdds a toolbar button that changes the value of a global propertyclassDummy component that acts as a simple container for GlobalProperty componentsclassAdds a global property to a Map or ModuleclassAdds a global property to a Map or ModuleclassDummy component that acts as a simple container for GlobalProperty componentsclassclassclassclassclass -
Uses of Configurable in VASSAL.build.module.turn
Classes in VASSAL.build.module.turn that implement ConfigurableModifier and TypeClassDescriptionclassclassclassGeneric Turn ComponentclassclassclassGeneric Turn Counter -
Uses of Configurable in VASSAL.build.widget
Classes in VASSAL.build.widget that implement ConfigurableModifier and TypeClassDescriptionclassclassA CardSlot is identical to a PieceSlot except that it is initialized with a card-like GamePiece.classA Chart is used for displaying charts and tables for the module.classAn HtmlChart is used for displaying html information for the module.classA Widget that corresponds to a panel with aJListsitting to the right of aJPanelwith aCardLayoutlayout.classclassA Widget that corresponds to a JPanel with a GridLayout or BoxLayout layout.classA Component that displays a GamePiece.classA Widget that corresponds to a JTabbedPane.classMethods in VASSAL.build.widget that return Configurable -
Uses of Configurable in VASSAL.configure
Fields in VASSAL.configure declared as ConfigurableModifier and TypeFieldDescriptionprotected ConfigurableConfigureTree.selectedprotected final ConfigurableConfigureTree.AddAction.targetprotected ConfigurableEditPropertiesAction.targetFields in VASSAL.configure with type parameters of type ConfigurableModifier and TypeFieldDescriptionprotected Map<Configurable,DefaultMutableTreeNode> ConfigureTree.nodesprotected static final Map<Configurable,PropertiesWindow> EditPropertiesAction.openWindowsMethods in VASSAL.configure that return ConfigurableModifier and TypeMethodDescriptionprotected ConfigurableConfigureTree.convertChild(Configurable parent, Configurable child) Some components need to be converted to a new type before insertion.protected ConfigurableConfigureTree.AddAction.getChild()protected ConfigurableConfigureTree.ImportAction.getChild()protected ConfigurableConfigureTree.getParent(DefaultMutableTreeNode targetNode) protected ConfigurableConfigureTree.getParent(Configurable target) Find the parent Configurable of a specified ConfigurableChooseComponentPathDialog.getPath()ExtensionTree.getPath(DefaultMutableTreeNode node) ChooseComponentDialog.getTarget()protected ConfigurableConfigureTree.getTarget(int x, int y) protected ConfigurableConfigureTree.importConfigurable()Methods in VASSAL.configure with parameters of type ConfigurableModifier and TypeMethodDescriptionprotected voidExtensionTree.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 ActionConfigureTree.buildAddAction(Configurable target, Class<? extends Buildable> newConfig) protected ActionConfigureTree.buildAddAction(Configurable target, Class<? extends Buildable> newConfig, String key, int index, Configurable duplicate) protected ActionExtensionTree.buildAddAction(Configurable target, Class<? extends Buildable> newConfig) protected ActionExtensionTree.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 ActionConfigureTree.buildCloneAction(Configurable target) protected ActionExtensionTree.buildCloneAction(Configurable target) protected ActionConfigureTree.buildCopyAction(Configurable target) protected ActionConfigureTree.buildCutAction(Configurable target) protected ActionExtensionTree.buildCutAction(Configurable target) protected ActionConfigureTree.buildDeleteAction(Configurable target) protected ActionExtensionTree.buildDeleteAction(Configurable target) protected ActionConfigureTree.buildEditAction(Configurable target) protected ActionExtensionTree.buildEditAction(Configurable target) protected ActionConfigureTree.buildEditPiecesAction(Configurable target) protected ActionExtensionTree.buildEditPiecesAction(Configurable target) protected ActionConfigureTree.buildExportTreeAction(Configurable target) protected ActionConfigureTree.buildHelpAction(Configurable target) protected ActionConfigureTree.buildImportAction(Configurable target) protected ActionExtensionTree.buildImportAction(Configurable target) protected ActionConfigureTree.buildImportDeckAction(Configurable target) protected ActionConfigureTree.buildImportTreeAction(Configurable target) protected ActionConfigureTree.buildMassPieceLoaderAction(Configurable target) protected ActionConfigureTree.buildMoveAction(Configurable target) protected ActionExtensionTree.buildMoveAction(Configurable target) protected ActionConfigureTree.buildOpenPiecesAction(Configurable target) protected ActionExtensionTree.buildOpenPiecesAction(Configurable target) protected ActionConfigureTree.buildPasteAction(Configurable target) protected ActionExtensionTree.buildPasteAction(Configurable target) protected JPopupMenuConfigureTree.buildPopupMenu(Configurable target) protected ActionConfigureTree.buildSearchAction(Configurable target) protected ActionConfigureTree.buildTranslateAction(Configurable target) protected DefaultMutableTreeNodeConfigureTree.buildTreeNode(Configurable c) booleanConfigureTree.canContainGamePiece(Configurable target) protected ConfigurableConfigureTree.convertChild(Configurable parent, Configurable child) Some components need to be converted to a new type before insertion.protected booleanConfigureTree.delete(Configurable target) Delete removes an item from the tree but ALSO traverses the tree throwing all the childrens' children manually out the airlock, one by one.protected voidExtensionTree.deleteFromExtension(Configurable parent, Configurable child) Delete the corresponding ExtensionElement from the Extension if the parent is non-editable i.e.protected voidConfigureTree.AddAction.doIt(Configurable child) voidConfigureTree.externalInsert(Configurable parent, Configurable child) Build an AddAction and execute it to request a new component from the uservoidExtensionTree.externalInsert(Configurable parent, Configurable child) static StringConfigureTree.getConfigureName(Configurable c) protected ConfigurableConfigureTree.getParent(Configurable target) Find the parent Configurable of a specified ConfigurableConfigureTree.getTreeNode(Configurable target) protected booleanConfigureTree.hasChild(Configurable parent, Class<?> childClass) protected booleanConfigureTree.importTreeBranch(Configurable target) voidConfigurer.initCustomControls(JDialog d, Configurable target) Initialize any custom controls / keystrokesprotected voidPropertiesWindow.initialize(Configurable target, HelpWindow helpWindow) protected booleanConfigureTree.insert(Configurable parent, Configurable child, int index) protected booleanConfigureTree.isAllowedChildClass(Configurable parent, Class<?> childClass) protected booleanConfigureTree.isDeleteAllowed(Configurable target) Is the Component allowed to be deleted? A mandatory component can be deleted if there is more than one of them with the same parentprotected booleanConfigureTree.isDuplicateAllowed(Configurable target) Is the Component allowed to be duplicated?booleanConfigureTree.isMoveAllowed(Configurable target) Is the Component allowed to be moved?protected booleanConfigureTree.isValidParent(Configurable parent, Configurable child) protected booleanExtensionTree.isValidParent(Configurable parent, Configurable child) protected booleanConfigureTree.isValidPasteTarget(Configurable target) protected booleanConfigureTree.isValidPasteTarget(Configurable target, DefaultMutableTreeNode sourceNode) protected booleanExtensionTree.isValidPasteTarget(Configurable target) protected booleanExtensionTree.isValidPasteTarget(Configurable target, DefaultMutableTreeNode sourceNode) voidConfigureTree.jumpToTarget(Configurable target) voidConfigureTree.nodeEdited(Configurable target) Called when the Configurable held by a node has been edited.voidConfigureTree.nodeUpdated(Configurable target) protected voidConfigureTree.postInsertProcessing(Configurable parent, Configurable child) protected voidExtensionTree.postInsertProcessing(Configurable parent, Configurable child) protected voidConfigureTree.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 voidConfigureTree.postRemoveProcessing(Configurable parent, Configurable child) protected voidExtensionTree.postRemoveProcessing(Configurable parent, Configurable child) protected booleanConfigureTree.remove(Configurable parent, Configurable child) voidConfigurer.setContext(Configurable context) voidConfigureTree.updateGpIds(Configurable c) Allocate new PieceSlot Id's to any PieceSlot sub-componentsvoidExtensionTree.updateGpIds(Configurable c) Allocate new PieceSlot Id's to any PieceSlot sub-componentsConstructors in VASSAL.configure with parameters of type ConfigurableModifierConstructorDescriptionAddAction(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
Fields in VASSAL.counters declared as ConfigurableMethods in VASSAL.counters with parameters of type ConfigurableModifier and TypeMethodDescriptionvoidPieceDefiner.initCustomControls(JDialog d, Configurable target) Constructors in VASSAL.counters with parameters of type ConfigurableModifierConstructorDescriptionMassPieceDefiner(Configurable top, ConfigureTree tree) MassPieceLoader(ConfigureTree tree, Configurable target) -
Uses of Configurable in VASSAL.i18n
Classes in VASSAL.i18n that implement ConfigurableModifier and TypeClassDescriptionclassContainer for definitions of Translations.classSingleton class for managing the translation of a module into other languagesclassclassclassUtility class to allow translation of VASSAL using the Component Translation mechanism.Fields in VASSAL.i18n declared as ConfigurableModifier and TypeFieldDescriptionprotected ConfigurableComponentI18nData.myComponentprotected ConfigurableTranslateWindow.MyPropertiesWindow.myTargetprotected ConfigurableTranslateAction.targetFields in VASSAL.i18n with type parameters of type ConfigurableModifier and TypeFieldDescriptionprotected static final Map<Configurable,TranslateWindow> TranslateAction.openWindowsMethods in VASSAL.i18n with parameters of type ConfigurableModifier and TypeMethodDescriptionprotected voidComponentI18nData.init(Configurable c, String pfx, String[] names, Class<?>[] types, String[] descriptions) protected voidComponentI18nData.init(Configurable c, String pfx, String[] names, String[] descriptions, boolean[] translatable) protected voidTranslateWindow.refreshTranslationList(Configurable target) Called from MyPropertiesWindow when the user saves the new translationConstructors in VASSAL.i18n with parameters of type ConfigurableModifierConstructorDescriptionComponentI18nData(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
Classes in VASSAL.launch that implement ConfigurableModifier and TypeClassDescriptionclassDeprecated, 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 ConfigurableModifier and TypeClassDescriptionclassBase class for a Module Preference.classA Checkbox Module Preference.classA Decimal Number Module Preference.classA Drop-down list preference.classA whole number Module Preference.classA String Module Preference.classA multi-line textbox Module Preference. -
Uses of Configurable in VASSAL.script
Classes in VASSAL.script that implement ConfigurableModifier and TypeClassDescriptionclassclassclassclassclassContainer for Scripts. -
Uses of Configurable in VASSAL.tools
Methods in VASSAL.tools that return ConfigurableModifier and TypeMethodDescriptionReturn a list ofConfigurablecomponents specified by the given identifier.Methods in VASSAL.tools with parameters of type ConfigurableModifier and TypeMethodDescriptionComponentPathBuilder.getId(Configurable[] targetPath) Return a string identifying the specifiedConfigurablecomponents as a path through the configuration parent-child hierarchy.Method parameters in VASSAL.tools with type arguments of type ConfigurableModifier and TypeMethodDescriptionprotected voidSavedGameUpdater.findPieceSlots(List<Configurable> l, Properties p) -
Uses of Configurable in VASSAL.tools.icon
Classes in VASSAL.tools.icon that implement ConfigurableModifier and TypeClassDescriptionclassAn IconFamily is a named set of Icons in the four standard Tango sizes.