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
ConfigurableList	An interface to be implemented by Configurers that manage variable sized lists.
ConfigurableListEntry	An interface to be implemented by Configurers that manage variable sized lists.
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 on Buildable objects
VisibilityCondition

Class Summary

Class	Description
AbstractConfigurableListEntry	Base class for a List Entry maintained by a ConfigurableList A ConfigurableListEntry must be configurered by a single Configurer.
AudioClipConfigurer	Class for selecting an AudioClip while editing a module and adding it to module
AutoConfigurer	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 component
BeanShellExpressionConfigurer	A Configurer for Java Expressions
BeanShellFunctionMenu
BooleanConfigurer	Configurer for Boolean values
ChooseComponentDialog	Dialog that prompts the user to select a component from the ConfigureTree
ChooseComponentPathDialog	Widget for selecting the full path of a Component in the Buildable hierarchy
ColorConfigurer	Configurer for Color values.
ComponentConfigPanel	A standardised Panel for use by Component configurers
ComponentLayout	A standardised MigLayout for use by Component configurers
CompoundValidityChecker	Combines multiple instances of ValidityChecker
ConfigurableListController	A small panel of buttons for controlling the entries in a Configurablelist See also ConfigurableList, ConfigurableListEntry, ConfigurableListController
Configurer	A property editor class.
ConfigurerLayout	A Standardised MigLayout for use by individual Configurers
ConfigurerPanel	A standardised Panel to hold an individual Configurer
ConfigurerWindow	A Window for displaying a Configurer.
ConfigureTree	The beating heart of the Editor, this class handles the Configuration Tree that appears in the Configuration window when editing a VASSAL module.
ConfigureTree.AdditionalComponent
DirectoryConfigurer	A Configurer for picking file directories
DoubleConfigurer	A Configurer for Double values
DynamicKeyCommandConfigurer
DynamicKeyCommandListConfigurer
EditContainedPiecesAction	Action to edit all GamePiece's within a given component
EditPropertiesAction	Action to edit the Properties of a component
ExtensionTree	The configuration tree for editing a module extension
FileConfigurer	A Configurer for java.io.File values
FlareFormattedStringConfigurer	Utility subclass of FormattedStringConfigurer which includes variable keys for player name, side, and id
FontConfigurer	A Configurer for Font values
FormattedExpressionConfigurer	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 BasicPiece
GlobalCommandTargetConfigurer
HintTextField	A class extending a JTextField that can display a 'ghost' text prompt in the field when it is empty.
HotKeyConfigurer	A Configurer for KeyStroke values
IconConfigurer
ImageConfigurer	A Configurer for Image values.
ImageSelector	Allows a user to select from the images currently available in a module, or to open a File Dialog to import a new image.
IntConfigurer	A Configurer for Integer values
KeyModifiersConfigurer	Configurer for specifying key masks (CTRL, SHIFT, CTRL-ALT, etc.)
KeyStrokeArrayConfigurer	Configures an array of keystrokes
ListConfigurer	Configures a variable-length list of objects
LongConfigurer	A Configurer for Long values
MandatoryComponent	Requires that at least one child of a given type exist within a target component
ModuleUpdaterDialog
NamedHotKeyConfigurer	A configurer for Configuring Key Strokes.
NamedKeyStrokeArrayConfigurer	Configures an array of {link NamedKeyStrokes}
NoInsetButton	A button with no insets to be as small as possible
PasswordConfigurer
PieceAccessConfigurer
PlayerIdFormattedStringConfigurer	Utility subclass of FormattedStringConfigurer which includes variable keys for player name, side, and id
PropertiesWindow	Window for editing properties of a Configurable object
PropertyExpression
PropertyExpressionConfigurer	A Configurer for Java Expressions
PropertyExpressionConfigurer.PropertyExpressionButton
PropertyNameExpressionConfigurer	A Configurer for Java Expressions
PropertyNameExpressionConfigurer.PropertyNameExpressionButton
RefreshPredefinedSetupsDialog
RemoveUnusedImagesDialog
SaveAction	General-purpose "Save" action
SaveAsAction	General-purpose "Save As" action
SavedGameUpdaterDialog
ShowHelpAction	Action that displays a HelpWindow
SimpleConfigurer	A Configurer for configuring Configurable 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 parent
SoundConfigurer	Configurer for specifying a Clip.
StringArrayConfigurer	A Configurer that returns an array of Strings
StringConfigurer	A Configurer for String values
StringEnum	Wrapper class for an enumerated type.
StringEnumConfigurer	A Configurer that returns a String from among a list of possible values
TableConfigurer
TableConfigurer.Column
TextConfigurer	A Configurer that allows multi-line string input via a JTextArea
TranslatableStringEnum	Wrapper class for an enumerated type.
TranslatingStringEnumConfigurer	A Configurer that allows a user to select from an underlying list of values, based on a translatable list of descriptions of those values.
ValidationReport	Summarizes error/warning messages about invalid module configuration
ValidationReportDialog	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.