Package VASSAL.build.module

Class PrototypeDefinition

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.PrototypeDefinition

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ComponentDescription, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget, UniqueIdManager.Identifyable

public class PrototypeDefinition
extends AbstractConfigurable
implements UniqueIdManager.Identifyable, ValidityChecker, ComponentDescription

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PrototypeDefinition.Config

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

AutoConfigurable.Util

Field Summary

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, localizedName, myI18nData

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
PrototypeDefinition()

Method Summary

Modifier and Type	Method	Description
void	add(Buildable child)	Set the owning translatable of this component
void	addImageNamesRecursively(Collection<String> s)	Adds all images used by this component AND any subcomponents to the collection
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
void	addTo(Buildable parent)	Adds this component to its parent.
void	build(Element e)	Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(java.lang.String, java.lang.Object) with the String value of the attribute
void	clearCache()
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 attr)	Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
Element	getBuildElement(Document doc)
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
static String	getConfigureTypeName()
String	getDescription()
HelpFile	getHelpFile()
ComponentI18nData	getI18nData()
String	getId()
GamePiece	getPiece()
protected GamePiece	getPiece(String def)
GamePiece	getPiece(PropertySource props)	For the case when the piece definition is a Message Format, expand the definition using the given properties
void	remove(Buildable child)	Remove a Buildable object from this object
void	removeFrom(Buildable parent)	Remove this component from its parent
void	setAttribute(String attr, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setConfigureName(String s)	Sets the name and fires a PropertyChangeEvent
void	setDescription(String description)
void	setId(String id)
void	setPiece(GamePiece p)
void	validate(Buildable target, ValidationReport report)

Methods inherited from class VASSAL.build.AbstractConfigurable

getAttributeVisibility, getExpressionList, getFormattedStringList, getI18nPrefix, getLocalizedConfigureName, getMenuTextList, getNamedKeyStrokeList, getPropertyList, getTypeName, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable

Methods inherited from class VASSAL.build.AbstractBuildable

buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getComponents, getComponentsOf, getNonFolderAncestor, getPropertyNames, setAncestor

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.script.expression.Auditable

getComponentName, getComponentTypeName

Methods inherited from interface VASSAL.build.Buildable

isMandatory, isMovable, isUnique

Constructor Details

PrototypeDefinition

public PrototypeDefinition()

Method Details

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Description copied from interface: Configurable

Add a PropertyChangeListener. A PropertyChangeEvent should be fired with property name Configurable.NAME_PROPERTY when the value returned from Configurable.getConfigureName() has changed

Specified by:

addPropertyChangeListener in interface Configurable

Overrides:

addPropertyChangeListener in class AbstractConfigurable

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Specified by:

getAllowableConfigureComponents in interface Configurable

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.

getConfigureComponents

public Configurable[] getConfigureComponents()

Specified by:

getConfigureComponents in interface Configurable

Overrides:

getConfigureComponents in class AbstractConfigurable

Returns:

A list of all child components (i.e. subcomponents) of this component that are configurable.

getConfigureName

public String getConfigureName()

Description copied from class: AbstractConfigurable

ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.

Specified by:

getConfigureName in interface Configurable

Specified by:

getConfigureName in interface UniqueIdManager.Identifyable

Overrides:

getConfigureName in class AbstractConfigurable

Returns:

The language-independent name of this component used for programmatic identification (including within Modules by e.g. Traits and module components)

setConfigureName

public void setConfigureName(String s)

Description copied from class: AbstractConfigurable

Sets the name and fires a PropertyChangeEvent

Overrides:

setConfigureName in class AbstractConfigurable

getConfigurer

public Configurer getConfigurer()

Description copied from class: AbstractConfigurable

The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer

Specified by:

getConfigurer in interface Configurable

Overrides:

getConfigurer in class AbstractConfigurable

Returns:

Configurer for this component

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

remove

public void remove(Buildable child)

Description copied from class: AbstractConfigurable

Remove a Buildable object from this object

Specified by:

remove in interface Configurable

Overrides:

remove in class AbstractConfigurable

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

add

public void add(Buildable child)

Description copied from class: AbstractConfigurable

Set the owning translatable of this component

Specified by:

add in interface Buildable

Overrides:

add in class AbstractConfigurable

Parameters:

child - Child to attach to this buildable as a subcomponent

getId

public String getId()

Specified by:

getId in interface UniqueIdManager.Identifyable

setId

public void setId(String id)

Specified by:

setId in interface UniqueIdManager.Identifyable

validate

public void validate(Buildable target,
 ValidationReport report)

Specified by:

validate in interface ValidityChecker

Overrides:

validate in class AbstractBuildable

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

Parameters:

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

addImageNamesRecursively

public void addImageNamesRecursively(Collection<String> s)

Description copied from class: AbstractBuildable

Adds all images used by this component AND any subcomponents to the collection

Specified by:

addImageNamesRecursively in interface ImageSearchTarget

Overrides:

addImageNamesRecursively in class AbstractBuildable

Parameters:

s - Collection to add image names to

getPiece

public GamePiece getPiece()

getPiece

public GamePiece getPiece(PropertySource props)

For the case when the piece definition is a Message Format, expand the definition using the given properties

Parameters:

props - PropertySource providing property values

Returns:

Created Piece

getPiece

protected GamePiece getPiece(String def)

clearCache

public void clearCache()

setPiece

public void setPiece(GamePiece p)

getDescription

public String getDescription()

Specified by:

getDescription in interface ComponentDescription

Returns:

Description to be displayed next to component type/name in the main Editor window. Or null or "" to not display anything.

setDescription

public void setDescription(String description)

build

public void build(Element e)

Description copied from class: AbstractBuildable

Build this component by getting all XML attributes of the XML element and calling AbstractBuildable.setAttribute(java.lang.String, java.lang.Object) with the String value of the attribute

Specified by:

build in interface Buildable

Overrides:

build in class AbstractBuildable

Parameters:

e - the XML element containing the object data

getBuildElement

public Element getBuildElement(Document doc)

Specified by:

getBuildElement in interface Buildable

Overrides:

getBuildElement in class AbstractBuildable

Parameters:

doc - XML file

Returns:

an XML element from which this component can be built

getConfigureTypeName

public static String getConfigureTypeName()

setAttribute

public void setAttribute(String attr,
 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(java.lang.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

Specified by:

setAttribute in class AbstractBuildable

Parameters:

attr - 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(java.lang.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()

getAttributeDescriptions

public String[] getAttributeDescriptions()

Description copied from interface: AutoConfigurable

Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object.

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Specified by:

getAttributeDescriptions in class AbstractConfigurable

Returns:

an array of Strings describing the buildFile (XML) attributes of this component. These strings are used as prompts in the Properties window for this object, when the component is configured in the Editor. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from interface: AutoConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, File, Color, and KeyStroke

Specified by:

getAttributeTypes in interface AutoConfigurable

Specified by:

getAttributeTypes in class AbstractConfigurable

Returns:

the Class for the buildFile (XML) attributes of this component. Valid classes include: String, Integer, Double, Boolean, Image, Color, and KeyStroke, along with any class for which a Configurer exists in VASSAL.configure. The class determines, among other things, which type of AutoConfigurer will be used to configure the attribute when the object is configured in the Editor. The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractBuildable

Lists all the buildFile (XML) attribute names for this component. If this component is ALSO an AbstractConfigurable, then this list of attributes determines the appropriate attribute order for AbstractConfigurable.getAttributeDescriptions() and AbstractConfigurable.getAttributeTypes().

Specified by:

getAttributeNames in interface AutoConfigurable

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

a list of all buildFile (XML) attribute names for this component

getAttributeValueString

public String getAttributeValueString(String attr)

Description copied from interface: AutoConfigurable

Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element

Specified by:

getAttributeValueString in interface AutoConfigurable

Specified by:

getAttributeValueString in interface Translatable

Specified by:

getAttributeValueString in class AbstractBuildable

Parameters:

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

Returns:

a String representation of the XML buildFile attribute with the given name. When initializing a module, this String value will loaded from the XML and passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.

getI18nData

public ComponentI18nData getI18nData()

Specified by:

getI18nData in interface Translatable

Overrides:

getI18nData in class AbstractConfigurable

Returns:

the i18n data for this component