Class StringScenarioProperty

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.properties.GlobalProperty

VASSAL.build.module.properties.AbstractScenarioProperty

VASSAL.build.module.properties.StringScenarioProperty

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, GameComponent, MutableProperty, PropertyNameSource, PropertySource, CommandEncoder, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget, ToolBarComponent

public class StringScenarioProperty
extends AbstractScenarioProperty

Nested Class Summary

Nested classes/interfaces inherited from class GlobalProperty

GlobalProperty.SetGlobalProperty

Modifier and Type	Class	Description
static class	GlobalProperty.SetGlobalProperty	Command to pass a new Global property value to other players or into the logfile.

Nested classes/interfaces inherited from interface AutoConfigurable

AutoConfigurable.Util

Modifier and Type	Interface	Description
static class	AutoConfigurable.Util

Nested classes/interfaces inherited from interface MutableProperty

MutableProperty.Impl, MutableProperty.Util

Modifier and Type	Interface	Description
static class	MutableProperty.Impl	Simple implementation of MutableProperty Support dynamic changing of the property name, provided that the MutableProperty.Impl.addTo(MutablePropertiesContainer) method is used to register this property with a properties container.
static class	MutableProperty.Util

Field Summary

Fields inherited from class AbstractScenarioProperty

hotkey, HOTKEY, SWITCH, switchPosition, tab

Modifier and Type	Field	Description
protected NamedKeyStroke	hotkey
static final String	HOTKEY
static final String	SWITCH
protected boolean	switchPosition
protected ScenarioPropertiesOptionTab	tab	The Tab to which this Scenario Property belongs

Fields inherited from class GlobalProperty

COMMAND_PREFIX, description, DESCRIPTION, format, INITIAL_VALUE, initialValue, MAX_VALUE, maxValue, MIN_VALUE, minValue, NAME, numeric, NUMERIC, numericVisibility, parentContainer, property, propertySource, tempToolbar, wrap, WRAP

Modifier and Type	Field	Description
protected static final String	COMMAND_PREFIX
protected String	description
static final String	DESCRIPTION
protected FormattedString	format
static final String	INITIAL_VALUE
protected String	initialValue
static final String	MAX_VALUE
protected String	maxValue
static final String	MIN_VALUE
protected String	minValue
static final String	NAME
protected boolean	numeric
static final String	NUMERIC
protected VisibilityCondition	numericVisibility
protected MutablePropertiesContainer	parentContainer
protected MutableProperty.Impl	property
protected PropertySource	propertySource
protected TemporaryToolBar	tempToolbar
protected boolean	wrap
static final String	WRAP

Fields inherited from class AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Modifier and Type	Field	Description
protected PropertyChangeSupport	changeSupport
protected Configurer	config
protected String	localizedName
protected ComponentI18nData	myI18nData
protected String	name

Fields inherited from class AbstractBuildable

buildComponents, validator

Modifier and Type	Field	Description
protected List<Buildable>	buildComponents
protected ValidityChecker	validator

Fields inherited from interface Configurable

NAME_PROPERTY

Modifier and Type	Field	Description
static final String	NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
StringScenarioProperty()

Method Summary

Modifier and Type	Method	Description
static String	getConfigureTypeName()
Class<?>	getInitialValueClass()
Configurer	getOptionConfigurer()
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.

Methods inherited from class AbstractScenarioProperty

addTo, getAllowableConfigureComponents, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getAttributeValueString, getExpressionList, getHelpFile, getHotkey, isSwitchPosition, processOptionChange, setHotkey

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Adds this component to its parent.
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
Class<?>[]	getAttributeTypes()	Return the Class for the attributes of this object.
String	getAttributeValueString(String key)	Called by the Buildable.getBuildElement(Document) method to write the attributes into an XML element
List<String>	getExpressionList()	SearchTarget
HelpFile	getHelpFile()
NamedKeyStroke	getHotkey()
boolean	isSwitchPosition()
void	processOptionChange(Object newValue)
void	setHotkey(NamedKeyStroke hotkey)

Methods inherited from class GlobalProperty

addMutablePropertyChangeListener, decode, encode, getAttributeVisibility, getContainerId, getDescription, getLocalizedProperty, getMaxValue, getMenuTextList, getMinValue, getParent, getProperty, getPropertyId, getPropertyList, getPropertyValue, getRestoreCommand, getToolBar, isNumeric, isWrap, removeFrom, removeMutablePropertyChangeListener, setPropertyName, setPropertyValue, setup

Modifier and Type	Method	Description
void	addMutablePropertyChangeListener(PropertyChangeListener l)
Command	decode(String command)	Translate a String into a Command
String	encode(Command c)	Translate a Command into a String
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
protected String	getContainerId()
String	getDescription()
Object	getLocalizedProperty(Object key)	Returns a localized translation of the specified property value, if available.
int	getMaxValue()
List<String>	getMenuTextList()	SearchTarget
int	getMinValue()
MutablePropertiesContainer	getParent()
Object	getProperty(Object key)	When using this interface a piece's own properties are preferred to those of "Global Properties", and those in turn are searched Zone-first then Map, then Module.
protected String	getPropertyId()	A String that identifies this property in an encoded Command
List<String>	getPropertyList()	SearchTarget
String	getPropertyValue()
Command	getRestoreCommand()	When saving a game, each GameComponent should return a Command that, when executed, restores the GameComponent to its state when the game was saved If this component has no persistent state, return null
JToolBar	getToolBar()
boolean	isNumeric()
boolean	isWrap()
void	removeFrom(Buildable parent)	Remove this component from its parent
void	removeMutablePropertyChangeListener(PropertyChangeListener l)
void	setPropertyName(String name)
Command	setPropertyValue(String newValue)
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended

Methods inherited from class AbstractConfigurable

add, addPropertyChangeListener, getConfigureComponents, getConfigureName, getConfigurer, getFormattedStringList, getI18nData, getI18nPrefix, getLocalizedConfigureName, getNamedKeyStrokeList, getTypeName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Modifier and Type	Method	Description
void	add(Buildable b)	Set the owning translatable of this component
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
Configurable[]	getConfigureComponents()
String	getConfigureName()	ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
List<String>	getFormattedStringList()	SearchTarget
ComponentI18nData	getI18nData()
protected String	getI18nPrefix()
String	getLocalizedConfigureName()
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
String	getTypeName()	Returns the name of the configurable type for display purposes.
void	remove(Buildable b)	Remove a Buildable object from this object
void	removePropertyChangeListener(PropertyChangeListener l)
protected void	setAllAttributesUntranslatable()	Sets all attributes untranslatable.
protected void	setAttributeTranslatable(String attr, boolean b)	Over-ride the default attribute translatability.
void	setConfigureName(String s)	Sets the name and fires a PropertyChangeEvent

Methods inherited from class AbstractBuildable

addImageNamesRecursively, build, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getNonFolderAncestor, getPropertyNames, setAncestor, validate

Modifier and Type	Method	Description
void	addImageNamesRecursively(Collection<String> s)	Adds all images used by this component AND any subcomponents to the collection
void	build(Element e)	Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(String, Object) with the String value of the attribute
String	buildString()
<T> List<T>	getAllDescendantComponentsOf(Class<T> target)	Recursively descend the build tree and return a List of all components that are instances of the given class
Buildable	getAncestor()
List<Buildable>	getBuildables()
Enumeration<Buildable>	getBuildComponents()	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getBuildables() instead.
Element	getBuildElement(Document doc)
<T> Enumeration<T>	getComponents(Class<T> target)	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getComponentsOf(Class) instead.
<T> List<T>	getComponentsOf(Class<T> target)
Buildable	getNonFolderAncestor()
List<String>	getPropertyNames()	Override this method to provide a list of properties to be exposed for use by expressions in the module.
void	setAncestor(Buildable ancestor)
void	validate(Buildable target, ValidationReport report)

Methods inherited from class AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	Classes extending AbstractImageFinder should override this method in order to add the names of any image files they use to the collection.
SortedSet<String>	getAllImageNames()
SortedSet<String>	getLocalImageNames()

Methods inherited from class Object

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

Methods inherited from interface Auditable

getComponentName, getComponentTypeName

Modifier and Type	Method	Description
default String	getComponentName()	Return the name of the trait or Component an Auditable is
default String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is

Methods inherited from interface Buildable

isMandatory, isMovable, isUnique

Modifier and Type	Method	Description
default boolean	isMandatory()	Is this component a reqired component within its parent?
default boolean	isMovable()	Is this component allowed to be moved around the Configure Tree?
default boolean	isUnique()	Does this component need to be unique within it's parent?

Methods inherited from interface ToolBarComponent

updateToolbarButtons

Modifier and Type	Method	Description
default void	updateToolbarButtons()	Update the text labels in the toolbar's component buttons (for mutable button label support)

Constructor Details

StringScenarioProperty

public StringScenarioProperty()

Method Details

getConfigureTypeName

public static String getConfigureTypeName()

setAttribute

public void setAttribute(String key,
 Object value)

Description copied from class: AbstractBuildable

Sets a buildFile (XML) attribute value for this component. The key parameter will be one of those listed in AbstractBuildable.getAttributeNames(). If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(String) for the same key. If the implementing class extends AbstractConfigurable, then value will be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

Specified by:

setAttribute in interface AutoConfigurable

Specified by:

setAttribute in interface Translatable

Overrides:

setAttribute in class AbstractScenarioProperty

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

value - If the value parameter is a String, it will be the value returned by AbstractBuildable.getAttributeValueString(String) for the same key. If the implementing class extends AbstractConfigurable, then value can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

getInitialValueClass

public Class<?> getInitialValueClass()

Specified by:

getInitialValueClass in class AbstractScenarioProperty

getOptionConfigurer

public Configurer getOptionConfigurer()

Specified by:

getOptionConfigurer in class AbstractScenarioProperty