Uses of Class
VASSAL.tools.FormattedString

Packages that use FormattedString

Package	Description
VASSAL.build.module	Contains classes that may be added to a GameModule.
VASSAL.build.module.dice
VASSAL.build.module.map	Contains classes that may be added to a Map.
VASSAL.build.module.map.boardPicker.board.mapgrid	Contains classes that may be added to a MapGrid.
VASSAL.build.module.map.deck
VASSAL.build.module.properties
VASSAL.build.module.turn
VASSAL.configure	Provides classes for building "Edit Property" dialogs, and for editing GameModule's and ModuleExtension's.
VASSAL.counters	Provides classes that define game pieces.
VASSAL.script.expression
VASSAL.tools	Contains various utility classes.

Uses of FormattedString in VASSAL.build.module

Fields in VASSAL.build.module declared as FormattedString

Modifier and Type	Field	Description
protected FormattedString	Inventory.Counter.format
protected FormattedString	SpecialDiceButton.format
protected FormattedString	DoActionButton.loopCount
protected final FormattedString	DiceButton.reportFormat
protected FormattedString	DoActionButton.reportFormat
protected FormattedString	Inventory.Counter.sortingFormat

Methods in VASSAL.build.module with parameters of type FormattedString

Modifier and Type	Method	Description
void	DieManager.roll(int nDice, int nSides, int plus, boolean reportTotal, String description, FormattedString format)

Uses of FormattedString in VASSAL.build.module.dice

Methods in VASSAL.build.module.dice with parameters of type FormattedString

Modifier and Type	Method	Description
void	DieServer.doInternetRoll(RollSet mroll, FormattedString format)
protected String	DieServer.formatResult(String description, String result, FormattedString format)	Use the configured FormattedString to format the result of a roll
void	DieServer.reportResult(RollSet mroll, FormattedString format)
void	BonesDiceServer.roll(RollSet mr, FormattedString format)
abstract void	DieServer.roll(RollSet mr, FormattedString format)
void	ShadowDiceDieServer.roll(RollSet mr, FormattedString format)

Uses of FormattedString in VASSAL.build.module.map

Fields in VASSAL.build.module.map declared as FormattedString

Modifier and Type	Field	Description
protected FormattedString	MoveCameraButton.board
protected FormattedString	CounterDetailViewer.counterReportFormat
protected FormattedString	CounterDetailViewer.emptyHexReportFormat
protected FormattedString	MovementReporter.format
protected FormattedString	MoveCameraButton.gridLocation
protected FormattedString	MoveCameraButton.region
protected FormattedString	LOS_Thread.reportFormat
protected FormattedString	MassKeyCommand.reportFormat
protected FormattedString	CounterDetailViewer.showTerrainText
protected FormattedString	CounterDetailViewer.summaryReportFormat
protected FormattedString	MoveCameraButton.x
protected FormattedString	MoveCameraButton.xOffset
protected FormattedString	MoveCameraButton.y
protected FormattedString	MoveCameraButton.yOffset
protected FormattedString	MoveCameraButton.zone
protected FormattedString	MoveCameraButton.zoom

Uses of FormattedString in VASSAL.build.module.map.boardPicker.board.mapgrid

Fields in VASSAL.build.module.map.boardPicker.board.mapgrid declared as FormattedString

Modifier and Type	Field	Description
protected FormattedString	RegularGridNumbering.format
protected FormattedString	Zone.format

Uses of FormattedString in VASSAL.build.module.map.deck

Fields in VASSAL.build.module.map.deck declared as FormattedString

Modifier and Type	Field	Description
protected FormattedString	AbstractDeckKeyCommand.reportFormat

Methods in VASSAL.build.module.map.deck that return FormattedString

Modifier and Type	Method	Description
FormattedString	DeckSendKeyCommand.getDeckExpression()
FormattedString	DeckSendKeyCommand.getLimitExpression()
FormattedString	DeckSendKeyCommand.getMatchExpression()
FormattedString	AbstractDeckKeyCommand.getReportFormat()
FormattedString	DeckSendKeyCommand.getStopExpresson()

Uses of FormattedString in VASSAL.build.module.properties

Fields in VASSAL.build.module.properties declared as FormattedString

Modifier and Type	Field	Description
protected FormattedString	ChangePropertyButton.format
protected FormattedString	GlobalProperty.format
protected FormattedString	GlobalTranslatableMessage.format
protected FormattedString	IncrementProperty.format
protected FormattedString	ChangePropertyButton.report
protected FormattedString	ScenarioPropertiesOptionTab.reportFormat

Methods in VASSAL.build.module.properties that return FormattedString

Modifier and Type	Method	Description
FormattedString	PropertySetter.getFormat()
FormattedString	ScenarioPropertiesOptionTab.getReportFormat()

Uses of FormattedString in VASSAL.build.module.turn

Fields in VASSAL.build.module.turn declared as FormattedString

Modifier and Type	Field	Description
protected FormattedString	TurnGlobalHotkey.format
protected FormattedString	TurnTracker.reportFormat
protected FormattedString	TurnLevel.turnFormat
protected FormattedString	TurnTracker.turnFormat

Uses of FormattedString in VASSAL.configure

Constructors in VASSAL.configure with parameters of type FormattedString

Modifier	Constructor	Description
	FormattedExpressionConfigurer(String key, String name, FormattedString s)

Uses of FormattedString in VASSAL.counters

Fields in VASSAL.counters declared as FormattedString

Modifier and Type	Field	Description
protected FormattedString	SendToLocation.boardName
protected FormattedString	ReturnToDeck.deckExpression
protected FormattedString	FreeRotator.directExpression
protected FormattedString	DynamicProperty.format
protected FormattedString	PlaySound.format
protected FormattedString	ReportState.format
protected FormattedString	SendToLocation.gridLocation
protected FormattedString	TriggerAction.indexStart
protected FormattedString	TriggerAction.indexStep
protected FormattedString	TriggerAction.loopCount
protected FormattedString	SendToLocation.mapId
protected FormattedString	MultiLocationCommand.menuText
protected FormattedString	SendToLocation.region
protected FormattedString	GlobalCommand.reportFormat
protected FormattedString	Embellishment.resetLevel
protected FormattedString	Embellishment0.resetLevel
protected FormattedString	Deck.selectDisplayProperty
protected FormattedString	SendToLocation.x
protected FormattedString	Translate.xDist
protected FormattedString	SendToLocation.xIndex
protected FormattedString	Translate.xIndex
protected FormattedString	SendToLocation.xOffset
protected FormattedString	Translate.xOffset
protected FormattedString	SendToLocation.y
protected FormattedString	Translate.yDist
protected FormattedString	SendToLocation.yIndex
protected FormattedString	Translate.yIndex
protected FormattedString	SendToLocation.yOffset
protected FormattedString	Translate.yOffset
protected FormattedString	SendToLocation.zone

Methods in VASSAL.counters with parameters of type FormattedString

Modifier and Type	Method	Description
static SendToLocation.Destination	SendToLocation.getSendLocation(PropertySource source, Auditable auditSource, String destination, FormattedString mapId, FormattedString boardName, FormattedString zone, FormattedString region, FormattedString gridLocation, FormattedString x, FormattedString y, PropertyExpression propertyFilter, Map sourceMap, Point startPosition)	Compute a destination from the parameters
protected Command	Deck.reportCommand(FormattedString reportFormat, String commandName)	Format command report as per module designers setup.
Command	Deck.sort(List<SortParameter> sortParameters, FormattedString reportFormat, String menuCommand)	Sort the Deck.

Uses of FormattedString in VASSAL.script.expression

Methods in VASSAL.script.expression with parameters of type FormattedString

Modifier and Type	Method	Description
static AuditTrail	AuditTrail.create(Auditable source, FormattedString originalExpression)
static AuditTrail	AuditTrail.create(Auditable source, FormattedString originalExpression, String comment)

Uses of FormattedString in VASSAL.tools

Subclasses of FormattedString in VASSAL.tools

Modifier and Type	Class	Description
class	PlayerIdFormattedString	Deprecated. use FormattedString constructor with defaultProperties

Fields in VASSAL.tools declared as FormattedString

Modifier and Type	Field	Description
protected FormattedString	LaunchButton.formatted

Methods in VASSAL.tools with parameters of type FormattedString

Modifier and Type	Method	Description
static String	FormattedString.debugInfo(FormattedString fs, String value, String description)	Format a standard debug message for use in Decorator bad data reports.