Package VASSAL.launch

Class BasicModule

java.lang.Object

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.GameModule

VASSAL.launch.BasicModule

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, GpIdSupport, MutablePropertiesContainer, PropertyNameSource, PropertySource, CommandEncoder, ValidityChecker, Translatable, ToolBarComponent

public class BasicModule
extends GameModule

Nested Class Summary

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

AutoConfigurable.Util

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

MutablePropertiesContainer.Impl

Field Summary

Fields

Modifier and Type	Field	Description
protected GameRefresher	gameRefresher
protected ChatServerControls	serverControls

Fields inherited from class VASSAL.build.GameModule

archive, BUILDFILE, chat, commandEncoders, controlPanel, crc, DEFAULT_NAME, deferredChat, description, DESCRIPTION, fileChooser, fileDialog, frame, gameName, gpidSupport, idChangeSupport, keyStrokeListeners, keyStrokeSources, lastSavedConfiguration, localizedGameName, logger, loggingLock, loggingPaused, MODULE_NAME, MODULE_VERSION, moduleVersion, NEXT_PIECESLOT_ID, nextGpId, pausedCommands, PERSONAL_INFO, preferences, propsContainer, REAL_NAME, repaintOnPropertyChange, RNG, SECRET_NAME, server, tcache, theState, VASSAL_VERSION_CREATED, VASSAL_VERSION_RUNNING, vassalVersionCreated, wizardSupport

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
BasicModule(DataArchive archive)

Method Summary

Modifier and Type	Method	Description
protected void	addComponent(Class<? extends Buildable> componentClass)
protected void	build()	Initialize the module
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
protected void	buildDefaultComponents()
Command	decode(String command)	Uses the registered CommandEncoders to decode a String into a Command.
String	encode(Command c)	Uses the registered CommandEncoders to encode a Command into a String object
protected void	ensureComponent(Class<? extends Buildable> componentClass)
String	getI18nPrefix()
ChatServerControls	getServerControls()
protected void	initFrame()
protected void	initGameState()
protected void	initIdentityPreferences()
protected void	initImagePreferences()
protected void	initLogger()
protected void	initServer()
String	toString()

Methods inherited from class VASSAL.build.GameModule

addCommandEncoder, addIdChangeListener, addKeyStrokeListener, addKeyStrokeSource, addMutableProperty, addSideChangeListenerToPlayerRoster, addTo, appendToTitle, buildCrc, buildString, checkGpIds, clearPausedCommands, compareVersions, createPiece, createPiece, fireKeyStroke, fireKeyStroke, generateGpId, getAllowableConfigureComponents, getArchiveWriter, getAttributeDescriptions, getAttributeNames, getAttributeTypes, getAttributeValueString, getChatter, getConfigureTypeName, getControlPanel, getCrc, getDataArchive, getFileChooser, getFileDialog, getFrame, getGameModule, getGameName, getGameState, getGameVersion, getGlobalPrefs, getGpIdSupport, getHelpFile, getI18nData, getImageTileSource, getLocalizedGameName, getLocalizedProperty, getLogger, getMutablePropertiesContainerId, getMutableProperty, getNextGpId, getPlayerRoster, getPlayerWindow, getPrefs, getProperty, getRNG, getServer, getToolBar, getUserId, getWizardSupport, init, initFrameTitle, isLocalizationEnabled, pauseLogging, quit, refreshKeyStrokeListeners, removeCommandEncoder, removeFrom, removeIdChangeListener, removeMutableProperty, resumeLogging, save, save, saveAs, sendAndLog, setAttribute, setChatter, setGlobalPrefs, setGpIdSupport, setNextGpId, setPrefs, setUserId, shutDown, unload, updateLastSave, warn

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, getConfigurer, getLocalizedConfigureName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.build.Buildable

getBuildElement

Field Details

serverControls

protected ChatServerControls serverControls

gameRefresher

protected GameRefresher gameRefresher

Constructor Details

BasicModule

public BasicModule(DataArchive archive)

Method Details

build

protected void build()
              throws IOException

Description copied from class: GameModule

Initialize the module

Specified by:

build in class GameModule

Throws:

IOException

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

initIdentityPreferences

protected void initIdentityPreferences()

initImagePreferences

protected void initImagePreferences()

initServer

protected void initServer()

initLogger

protected void initLogger()

initGameState

protected void initGameState()

decode

public Command decode(String command)

Description copied from class: GameModule

Uses the registered CommandEncoders to decode a String into a Command.

Specified by:

decode in interface CommandEncoder

Overrides:

decode in class GameModule

encode

public String encode(Command c)

Description copied from class: GameModule

Uses the registered CommandEncoders to encode a Command into a String object

Specified by:

encode in interface CommandEncoder

Overrides:

encode in class GameModule

buildDefaultComponents

protected void buildDefaultComponents()

initFrame

protected void initFrame()

ensureComponent

protected void ensureComponent(Class<? extends Buildable> componentClass)

addComponent

protected void addComponent(Class<? extends Buildable> componentClass)

getServerControls

public ChatServerControls getServerControls()

getI18nPrefix

public String getI18nPrefix()

Overrides:

getI18nPrefix in class AbstractConfigurable

Returns:

Generate a standard prefix for i18n keys for attributes of this component - Classname.attributeName

toString

public String toString()

Overrides:

toString in class Object