Package VASSAL.tools

Contains various utility classes.

Interface Summary

Interface	Description
AudioClip
Prioritizable
RecursionLimiter.Loopable
Sort.Comparator	Deprecated. Use Comparator instead.
ToolBarComponent	Indicates a component with a toolbar
UniqueIdManager.Identifyable	An object with an identifier that can be manipulated by a UniqueIdManager

Class Summary

Class	Description
ActionManager
AdjustableSpeedScrollPane	AdjustableSpeedScrollPane extends ScrollPane by making the scroll speed user-configurable.
ApplicationIcons
ArchiveWriter	An ArchiveWriter is a writeable DataArchive.
ArgsParser
ArrayIterator<T>	Deprecated.
ArrayUtils	Deprecated. Use ArrayUtils.
AudioSystemClip
BackgroundTask	Deprecated. Use SwingWorker now that we ship the JAR for it.
BrowserSupport	Utility class for displaying an external browser window.
BugDialog
BugUtils
ButtonFactory	Produce standard Vassal buttons.
ColorButton	A JButton which displays a color swatch.
ComponentPathBuilder	Provides an XPath-like syntax for identifying configuration components
ComponentSplitter	Provides support for hidden panels.
ComponentSplitter.SplitPane	Contains methods to automatically show/hide one of its components (the "hideable" component) while the other (the "base" component) remains always visible.
CRCUtils	Some general purpose CRC utilities.
DataArchive	Wrapper around a Zip archive with methods to cache images
DialogUtils
EnumeratedIterator<T>	Deprecated. use Iterator, Iterable, Collection or Stream API instead.
ErrorDialog
FormattedString	FormattedString.java A String that can include options of the form $optionName$.
FutureUtils	Deprecated. Moved to VASSAL.tools.concurrent package.
HashCode	Deprecated. Use HashCodeBuilder instead.
HeapFinderDummy
HotkeySpecifier	Text component for specifying a hot key
HTTPPostBuilder	Builds HTTP POST requests conveniently.
IconButton
ImprovedAveragingScaleFilter	Extension of java.awt.image.AreaAveragingScaleFilter.
IteratorUtils
JarArchive
KeyStrokeListener	Utility class for associating an Action with a keystroke from multiple different component sources
KeyStrokeSource	Utility class for registering a component as a source of hotkey events
LaunchButton	A JButton for placing into a VASSAL component's toolbar.
LoopControl	Code for controlling looping common to both TriggerAction and DoActionButton
Mp3AudioClip
NamedKeyManager
NamedKeyStroke	A NamedKeyStroke is a KeyStroke with a name given by the module developer.
NamedKeyStrokeListener	Extension of KeyStrokeListener to support NamedKeyStroke's and store the supplied NamedKeyStroke.
PlayerIdFormattedString	Deprecated. use FormattedString constructor with defaultProperties
ProblemDialog
PropertiesEncoder	Encodes a set of properties into a String, without using an '\n' character.
ReadErrorDialog	Utility class for reporting an IOException reading from the local system or a resource bundled with the VASSAL engine
RecursionLimiter	Utility class to detect and report Infinite Loops within Vassal components
ReflectionUtils
ResourceErrorDialog	Utility class for reporting failure to load a resource from a module file
SavedGameUpdater
ScrollPane	ScrollPane extends JScrollPane to have complete mouse-wheel functionality.
SequenceEncoder	Encodes a sequence of Strings into a single String with a given delimiter.
SequenceEncoder.Decoder
Sort	Deprecated. Use java.util.Collections.sort instead.
Sort.Alpha	Deprecated. Use the natural ordering on Strings instead.
SplashScreen	Displays an image centered on the screen
TemporaryToolBar	Stores components in a dummy toolbar, then transfers them to another toolbar component when it becomes available.
ThrowableUtils
UniqueIdManager	A class for assigning unique identifiers to objects.
URLUtils
UsernameAndPasswordDialog	A dialog for setting a username and password.
WarningDialog
WrapLayout	FlowLayout subclass that fully supports wrapping of components.
WriteErrorDialog
ZipUpdater	Deprecated, for removal: This API element is subject to removal in a future version. removed without replacement

Exception Summary

Exception	Description
ComponentPathBuilder.PathFormatException
RecursionLimitException