Class PlayerIdFormattedString

java.lang.Object

VASSAL.tools.FormattedString

VASSAL.tools.PlayerIdFormattedString

All Implemented Interfaces:

Auditable, RecursionLimiter.Loopable

@Deprecated
public class PlayerIdFormattedString
extends FormattedString

Deprecated.

use FormattedString constructor with defaultProperties

Utility subclass of FormattedString which automatically includes variables for Player name, side, and id

Field Summary

Fields inherited from class FormattedString

props

Modifier and Type	Field	Description
protected Map<String,String>	props

Constructor Summary

Constructors

Constructor	Description
PlayerIdFormattedString()	Deprecated.
PlayerIdFormattedString(String s)	Deprecated.

Method Summary

Methods inherited from class FormattedString

clearProperties, debugInfo, debugInfo, equals, getComponentName, getComponentTypeName, getDefaultProperties, getFormat, getLocalizedText, getLocalizedText, getLocalizedText, getLocalizedText, getLocalizedText, getLocalizedText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getText, getTextAsInt, getTextAsInt, getTextAsInt, hashCode, isDynamic, setDefaultProperties, setFormat, setProperty

Modifier and Type	Method	Description
void	clearProperties()
String	debugInfo(String value, String description)
static String	debugInfo(FormattedString fs, String value, String description)	Format a standard debug message for use in Decorator bad data reports.
boolean	equals(Object obj)
String	getComponentName()	Return the name of the trait or Component an Auditable is
String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is
PropertySource	getDefaultProperties()
String	getFormat()
String	getLocalizedText()	Deprecated. Use FormattedString.getLocalizedText(Auditable, String)
String	getLocalizedText(PropertySource ps)	Deprecated. Use FormattedString.getLocalizedText(PropertySource, Auditable, String)
String	getLocalizedText(PropertySource ps, Auditable owner, String fieldKey)	Evaulate a formatted String and return localized text Use the supplied property source to find property values Create an AuditTrail object if expression auditing enabled
String	getLocalizedText(PropertySource ps, Auditable owner, String fieldKey, boolean quietly)
String	getLocalizedText(PropertySource ps, Auditable owner, AuditTrail audit)	Evaulate a formatted String and return localized text Use the supplied property source to find property values
String	getLocalizedText(Auditable owner, String fieldKey)	Evaulate a formatted String and return localized text Use the default property source to find property values Create an AuditTrail object if expression auditing enabled
String	getText()	Deprecated. Use FormattedString.getText(Auditable, String)
String	getText(PropertySource ps)	Deprecated. Use FormattedString.getText(PropertySource, Auditable, String)
String	getText(PropertySource ps, boolean localized)	Deprecated. Use FormattedString.getText(PropertySource, String, Auditable, String)
String	getText(PropertySource ps, boolean localized, Auditable owner, AuditTrail audit)	Evaluate the supplied Formmatted String, using the supplied property source to replace any property references.
String	getText(PropertySource ps, boolean localized, Auditable owner, AuditTrail audit, boolean quietly)	Core implementation of getText.
String	getText(PropertySource ps, String def)	Deprecated. Use FormattedString.getText(PropertySource, String, Auditable, String)
String	getText(PropertySource ps, String def, Auditable owner, String fieldKey)	Evaulate a formatted String and return unlocalized text Use the supplied property source to find property values If any property value is found to be null, use the supplied default value instead Create an AuditTrail object if expression auditing enabled
String	getText(PropertySource ps, String def, Auditable owner, AuditTrail audit)	Evaulate a formatted String and return unlocalized text Use the supplied property source to find property values If any property value is found to be null, use the supplied default value instead
String	getText(PropertySource ps, Auditable owner, String fieldKey)	Evaulate a formatted String and return unlocalized text Use the supplied property source to find property values Create an AuditTrail object if expression auditing enabled
String	getText(PropertySource ps, Auditable owner, String fieldKey, boolean quietly)	Evaluate a formatted String and return unlocalized text Use the supplied property source to find property values Create an AuditTrail object if expression auditing enabled
String	getText(PropertySource ps, Auditable owner, AuditTrail audit)	Evaulate a formatted String and return unlocalized text Use the supplied property source to find property values
String	getText(Auditable owner, String fieldKey)	Evaulate a formatted String and return unlocalized text Use the default property source to find property values Create an AuditTrail object if expression auditing enabled
int	getTextAsInt(PropertySource ps, String description, AbstractConfigurable source)
int	getTextAsInt(PropertySource ps, String description, EditablePiece source)	Expand a FormattedString using the supplied propertySource and parse it as an integer.
int	getTextAsInt(PropertySource ps, String description, EditablePiece source, Auditable owner, AuditTrail audit)
int	hashCode()
static boolean	isDynamic(String text)	Return true if the supplied string contains $$ variables or is a Beanshell expression
void	setDefaultProperties(PropertySource defaultProperties)
void	setFormat(String fs)
void	setProperty(String name, String value)

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PlayerIdFormattedString

public PlayerIdFormattedString()

Deprecated.

PlayerIdFormattedString

public PlayerIdFormattedString(String s)

Deprecated.