Class ModuleExtension

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.module.ModuleExtension

All Implemented Interfaces:

Buildable, GpIdSupport, GameComponent, PluginsLoader.PluginElement, PropertyNameSource, ValidityChecker, Auditable, ImageSearchTarget

Direct Known Subclasses:

ModulePlugin

public class ModuleExtension
extends AbstractBuildable
implements GameComponent, PluginsLoader.PluginElement, GpIdSupport

An optional extension to a GameModule Like a GameModule, it is built from scratch from a 'buildFile' in a DataArchive The components described in the buildFile are appended to components in the base DataArchive

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModuleExtension.RegCmd	A command that verifies that a certain extension has been loaded

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_MODULE_NAME
static final String	BASE_MODULE_VERSION
protected String	description
static final String	DESCRIPTION
static final String	EXTENSION_ID
protected String	extensionId
protected JTextField	idDisplay
static final String	NEXT_PIECESLOT_ID
protected int	nextGpId
protected boolean	universal
static final String	UNIVERSAL
static final String	VASSAL_VERSION_CREATED
static final String	VERSION

Fields inherited from class AbstractBuildable

buildComponents, validator

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

Constructor Summary

Constructors

Constructor	Description
ModuleExtension(DataArchive archive)

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable parent)	Adds this component to its parent.
void	build()
protected void	checkGpIds(Buildable b, GpIdChecker checker)
boolean	confirmExit()
String	generateGpId()	Generate a new Unique GamePiece Id
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
String	getAttributeValueString(String key)
DataArchive	getDataArchive()
String	getDescription()
Action	getEditAction(JDialog d)
String	getExtensionId()
HelpFile	getHelpFile()
String	getName()
int	getNextGpId()	Accessors to check and update the next GpId if necessary.
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
boolean	getUniversal()
String	getVersion()
void	remove(ExtensionElement el)
void	removeFrom(Buildable parent)
void	save()
void	saveAs()
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
void	setNextGpId(int id)
void	setup(boolean gameStarting)	Notify the GameComponent that a game has started/ended
protected void	updateGpIds()	Allocate new gpid's to all PieceSlots defined in a Buildable and all of it's children
protected void	updateGpIds(Buildable b)
protected void	write(boolean saveAs)

Methods inherited from class AbstractBuildable

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

Modifier and Type	Method	Description
void	add(Buildable b)	Add a Buildable object to this object
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?

Field Details

BASE_MODULE_NAME

public static final String BASE_MODULE_NAME

See Also:

• Constant Field Values

BASE_MODULE_VERSION

public static final String BASE_MODULE_VERSION

See Also:

• Constant Field Values

VERSION

public static final String VERSION

See Also:

• Constant Field Values

VASSAL_VERSION_CREATED

public static final String VASSAL_VERSION_CREATED

See Also:

• Constant Field Values

UNIVERSAL

public static final String UNIVERSAL

See Also:

• Constant Field Values

NEXT_PIECESLOT_ID

public static final String NEXT_PIECESLOT_ID

See Also:

• Constant Field Values

EXTENSION_ID

public static final String EXTENSION_ID

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

universal

protected boolean universal

nextGpId

protected int nextGpId

extensionId

protected String extensionId

idDisplay

protected JTextField idDisplay

description

protected String description

Constructor Details

ModuleExtension

public ModuleExtension(DataArchive archive)

Method Details

getVersion

public String getVersion()

getDataArchive

public DataArchive getDataArchive()

getDescription

public String getDescription()

getUniversal

public boolean getUniversal()

build

public void build()

checkGpIds

protected void checkGpIds(Buildable b,
 GpIdChecker checker)

updateGpIds

protected void updateGpIds()

Allocate new gpid's to all PieceSlots defined in a Buildable and all of it's children

updateGpIds

protected void updateGpIds(Buildable b)

getNextGpId

public int getNextGpId()

Description copied from interface: GpIdSupport

Accessors to check and update the next GpId if necessary.

Specified by:

getNextGpId in interface GpIdSupport

setNextGpId

public void setNextGpId(int id)

Specified by:

setNextGpId in interface GpIdSupport

getRestoreCommand

public Command getRestoreCommand()

Description copied from interface: GameComponent

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

Specified by:

getRestoreCommand in interface GameComponent

setup

public void setup(boolean gameStarting)

Description copied from interface: GameComponent

Notify the GameComponent that a game has started/ended

Specified by:

setup in interface GameComponent

Parameters:

gameStarting - if true, a game is starting. If false, then a game is ending

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 class AbstractBuildable

Returns:

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

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

getHelpFile

public HelpFile getHelpFile()

removeFrom

public void removeFrom(Buildable parent)

confirmExit

public boolean confirmExit()

getAttributeValueString

public String getAttributeValueString(String key)

Specified by:

getAttributeValueString in class AbstractBuildable

Parameters:

key - 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(String, Object). It is also frequently used for checking the current value of an attribute.

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 class AbstractBuildable

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

getExtensionId

public String getExtensionId()

generateGpId

public String generateGpId()

Generate a new Unique GamePiece Id

Specified by:

generateGpId in interface GpIdSupport

Returns:

PieceSlot Id

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.

getName

public String getName()

write

protected void write(boolean saveAs)
              throws IOException

Throws:

IOException

save

public void save()
          throws IOException

Throws:

IOException

saveAs

public void saveAs()
            throws IOException

Throws:

IOException

remove

public void remove(ExtensionElement el)

getEditAction

public Action getEditAction(JDialog d)