Package VASSAL.configure
Provides classes for building "Edit Property" dialogs, and for editing
GameModule
's and ModuleExtension
's.
- See Also:
Configurable
,Configurer
-
Interface Summary Interface Description ConfigurerFactory General purpose type for defining property-sheet editors.ConfigureTree.Mutable Configurers that add or remove their own children directly should implement the Mutable interface so that ConfigureTree can refresh the changed node.SoundConfigurer.AudioClipFactory ValidationReportDialog.CallBack ValidityChecker Performs validation checks onBuildable
objectsVisibilityCondition -
Class Summary Class Description AudioClipConfigurer Class for selecting an AudioClip while editing a module and adding it to moduleAutoConfigurer A Configurer for configuring Configurable components (Is that as redundant as it sounds?) Automatically builds a property editor with controls for setting all of the attributes of the target Configurable componentBeanShellExpressionConfigurer A Configurer for Java ExpressionsBeanShellFunctionMenu BooleanConfigurer Configurer for Boolean valuesChooseComponentDialog Dialog that prompts the user to select a component from theConfigureTree
ChooseComponentPathDialog Widget for selecting the full path of a Component in the Buildable hierarchyColorConfigurer Configurer forColor
values.CompoundValidityChecker Combines multiple instances of ValidityCheckerConfigurer A property editor class.ConfigurerWindow A Window for displaying aConfigurer
.ConfigureTree This is the Configuration Tree that appears in the Configuration window when editing a VASSAL module.ConfigureTree.AdditionalComponent DirectoryConfigurer A Configurer for picking file directoriesDoubleConfigurer A Configurer for Double valuesEditContainedPiecesAction Action to edit allGamePiece
's within a given componentEditPropertiesAction Action to edit the Properties of a componentExtensionTree The configuration tree for editing a module extensionFileConfigurer A Configurer for java.io.File valuesFontConfigurer A Configurer forFont
valuesFormattedExpressionConfigurer A standard Formatted String configurer that has an additional Calculator icon that: a) Indicates to the user that $name$ variables can be used in this field b) Clicking on it opens up an Expression Builder that allows entry of in-line Calculated Properties (Not implemented yet)FormattedExpressionConfigurer.ExpressionButton A small 'Calculator' button added after the text to indicate this Configurer accepts Expressions.FormattedStringArrayConfigurer FormattedStringConfigurer GamePieceFormattedStringConfigurer Convenience class that provides prompts for the properties found in a BasicPieceHotKeyConfigurer A Configurer forKeyStroke
valuesIconConfigurer ImageConfigurer A Configurer forImage
values.IntConfigurer A Configurer for Integer valuesKeyModifiersConfigurer Configurer for specifing key masks (CTRL, SHIFT, CTRL-ALT, etc.)KeyStrokeArrayConfigurer Configures an array of keystrokesListConfigurer Configures a variable-length list of objectsLongConfigurer A Configurer for Long valuesMandatoryComponent Requires that at least one child of a given type exist within a target componentModuleUpdaterDialog NamedHotKeyConfigurer A Configurer forNamedKeyStroke
valuesNamedKeyStrokeArrayConfigurer Configures an array ofNamedKeyStrokes
PasswordConfigurer PieceAccessConfigurer PlayerIdFormattedStringConfigurer Utility subclass ofFormattedStringConfigurer
which includes variable keys for player name, side, and idPropertiesWindow Window for editing properties of aConfigurable
objectPropertyExpression PropertyExpressionConfigurer A Configurer for Java ExpressionsPropertyExpressionConfigurer.PropertyExpressionButton PropertyNameExpressionConfigurer A Configurer for Java ExpressionsPropertyNameExpressionConfigurer.PropertyNameExpressionButton SaveAction General-purpose "Save" actionSaveAsAction General-purpose "Save As" actionSavedGameUpdaterDialog ShowHelpAction Action that displays aHelpWindow
SimpleConfigurer AConfigurer
for configuringConfigurable
components (Is that as redundant as it sounds?) The invoking class must provide an array of Configurers, one for each attribute of the target Configurable object.SingleChildInstance Ensures that at most a single instance of a given type belongs to a given parentSoundConfigurer Configurer for specifying a Clip.StringArrayConfigurer A Configurer that returns an array of StringsStringConfigurer A Configurer for String valuesStringEnum Wrapper class for an enumerated type.StringEnumConfigurer A Configurer that returns a String from among a list of possible valuesTableConfigurer TableConfigurer.Column TextConfigurer A Configurer that allows multi-line string input via a JTextAreaValidationReport Summarizes error/warning messages about invalid module configurationValidationReportDialog Dialog for reporting the results of validating a GameModule -
Enum Summary Enum Description BeanShellExpressionConfigurer.Option enum describing any special processing that needs to be done for particular expression types NONE = No special handling PME = Property Match Expression handling.