Class BooleanScenarioProperty

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.BooleanScenarioProperty

All Implemented Interfaces:

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

public class BooleanScenarioProperty
extends AbstractScenarioProperty

Nested Class Summary

Nested classes/interfaces inherited from class GlobalProperty

GlobalProperty.SetGlobalProperty

Nested classes/interfaces inherited from interface AutoConfigurable

AutoConfigurable.Util

Nested classes/interfaces inherited from interface MutableProperty

MutableProperty.Impl, MutableProperty.Util

Field Summary

Fields inherited from class AbstractScenarioProperty

hotkey, HOTKEY, SWITCH, switchPosition, tab

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

Fields inherited from class AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Fields inherited from class AbstractBuildable

buildComponents, validator

Fields inherited from interface Configurable

NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
BooleanScenarioProperty()

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Adds this component to its parent.
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

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

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

Methods inherited from class AbstractConfigurable

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

Methods inherited from class AbstractBuildable

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

Methods inherited from class AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Methods inherited from class Object

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

Methods inherited from interface Auditable

getComponentName, getComponentTypeName

Methods inherited from interface Buildable

build, getBuildElement, isMandatory, isMovable, isUnique

Methods inherited from interface ToolBarComponent

updateToolbarButtons

Constructor Details

BooleanScenarioProperty

public BooleanScenarioProperty()

Method Details

getConfigureTypeName

public static String getConfigureTypeName()

addTo

public void addTo(Buildable parent)

Description copied from interface: Buildable

Adds this component to its parent. In order to make Buildable objects extensible, the child is responsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.

Specified by:

addTo in interface Buildable

Overrides:

addTo in class AbstractScenarioProperty

Parameters:

parent - parent Buildable to add this component to as a subcomponent.

getInitialValueClass

public Class<?> getInitialValueClass()

Specified by:

getInitialValueClass in class AbstractScenarioProperty

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()

getOptionConfigurer

public Configurer getOptionConfigurer()

Specified by:

getOptionConfigurer in class AbstractScenarioProperty