Package VASSAL.script

Class GeneralScript

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.script.AbstractScript

VASSAL.script.GeneralScript

All Implemented Interfaces:

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

public class GeneralScript
extends AbstractScript
implements UniqueIdManager.Identifyable, ValidityChecker

Nested Class Summary

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

AutoConfigurable.Util

Field Summary

Fields inherited from class VASSAL.script.AbstractScript

DESC, NAME, SCRIPT

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

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Adds this component to its parent.
protected String	buildHeaderLine()
CompileResult	compile()
String	evaluate(PropertySource target)
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
static String	getConfigureTypeName()
String	getFullScript()
HelpFile	getHelpFile()
String	getId()
void	removeFrom(Buildable parent)	Remove this component from its parent
void	setId(String id)
void	validate(Buildable target, ValidationReport report)

Methods inherited from class VASSAL.script.AbstractScript

getAllowableConfigureComponents, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getAttributeValueString, getDescription, getI18nData, getScript, setAttribute, setDescription, setScript

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, getExpressionList, getFormattedStringList, getI18nPrefix, getLocalizedConfigureName, getMenuTextList, getNamedKeyStrokeList, getPropertyList, getTypeName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, build, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getBuildElement, 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

build, getBuildElement, isMandatory, isMovable, isUnique

Methods inherited from interface VASSAL.tools.UniqueIdManager.Identifyable

getConfigureName

Constructor Details

GeneralScript

public GeneralScript()

Method Details

getConfigureTypeName

public static String getConfigureTypeName()

evaluate

public String evaluate(PropertySource target)

getId

public String getId()

Specified by:

getId in interface UniqueIdManager.Identifyable

setId

public void setId(String id)

Specified by:

setId in interface UniqueIdManager.Identifyable

buildHeaderLine

protected String buildHeaderLine()

getFullScript

public String getFullScript()

compile

public CompileResult compile()

Specified by:

compile in class AbstractScript

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

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

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.

validate

public void validate(Buildable target,
 ValidationReport report)

Specified by:

validate in interface ValidityChecker

Overrides:

validate in class AbstractBuildable