Package VASSAL.build.module.properties

Class ZoneProperty

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.properties.GlobalProperty

VASSAL.build.module.properties.ZoneProperty

All Implemented Interfaces:

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

public class ZoneProperty
extends GlobalProperty

Author:

Brent Easton A class implementing a cut-down Global property at the Zone level. Zone Properties do not have Toolbar butttons, but are controlled by SetGlobalProperty traits in counters.

Nested Class Summary

Nested classes/interfaces inherited from class VASSAL.build.module.properties.GlobalProperty

GlobalProperty.SetGlobalProperty

Nested classes/interfaces inherited from interface VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Nested classes/interfaces inherited from interface VASSAL.build.module.properties.MutableProperty

MutableProperty.Impl, MutableProperty.Util

Field Summary

Fields

Modifier and Type	Field	Description
protected Zone	parentZone

Fields inherited from class VASSAL.build.module.properties.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 VASSAL.build.AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
ZoneProperty()
ZoneProperty(GlobalProperty p)

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Adds this component to its parent.
Class<?>[]	getAllowableConfigureComponents()
static String	getConfigureTypeName()
protected String	getPropertyId()	A String that identifies this property in an encoded Command

Methods inherited from class VASSAL.build.module.properties.GlobalProperty

addMutablePropertyChangeListener, decode, encode, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getAttributeValueString, getAttributeVisibility, getContainerId, getDescription, getExpressionList, getHelpFile, getLocalizedProperty, getMaxValue, getMenuTextList, getMinValue, getParent, getProperty, getPropertyList, getPropertyValue, getRestoreCommand, getToolBar, isNumeric, isWrap, removeFrom, removeMutablePropertyChangeListener, setAttribute, setPropertyName, setPropertyValue, setup

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, build, getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getPropertyNames, validate

Methods inherited from class VASSAL.search.AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.build.Buildable

build, getBuildElement

Field Details

parentZone

protected Zone parentZone

Constructor Details

ZoneProperty

public ZoneProperty()

ZoneProperty

public ZoneProperty(GlobalProperty p)

Method Details

getConfigureTypeName

public static String getConfigureTypeName()

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Specified by:

getAllowableConfigureComponents in interface Configurable

Overrides:

getAllowableConfigureComponents in class GlobalProperty

Returns:

a list of valid sub-component Classes. If a Class appears in this list, then instances of that class may be added to this component from the Editor's ConfigureTree window by right-clicking on the component and selecting the appropriate "Add" option.

getPropertyId

protected String getPropertyId()

Description copied from class: GlobalProperty

A String that identifies this property in an encoded Command

Overrides:

getPropertyId in class GlobalProperty

Returns:

propertyId

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 GlobalProperty

Parameters:

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