VASSAL.build.module.map
Class TextSaver

java.lang.Object
  |
  +--VASSAL.build.module.map.TextSaver

All Implemented Interfaces:

java.awt.event.ActionListener, Buildable, Configurable, java.util.EventListener

public class TextSaver

extends java.lang.Object

implements java.awt.event.ActionListener, Configurable

Field Summary

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

TextSaver()

Method Summary

void	actionPerformed(java.awt.event.ActionEvent e)
void	add(Buildable b) Adds a child component.
void	addPropertyChangeListener(java.beans.PropertyChangeListener l) Add a PropertyChangeListener.
void	addTo(Buildable b) Adds this component to its parent.
void	build(org.w3c.dom.Element e) Build the object
java.lang.Class[]	getAllowableConfigureComponents() Return a list of valid sub-component Classes.
Configurer[]	getAttributeConfigurers()
org.w3c.dom.Element	getBuildElement(org.w3c.dom.Document doc)
Configurable[]	getConfigureComponents()
java.lang.String	getConfigureName() The name of this Configurable Object
Configurer	getConfigurer() Return a Configurer object which can be used to set the attributes of this object
static java.lang.String	getConfigureTypeName()
HelpFile	getHelpFile()
void	remove(Buildable b) Remove a child component
void	removeFrom(Buildable b) Remove this component from its parent
protected void	writeMapAsText()

Methods inherited from class java.lang.Object

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

Constructor Detail

TextSaver

public TextSaver()

Method Detail

addTo

public void addTo(Buildable b)

Description copied from interface: Buildable

Adds this component to its parent. In order to make Buildable objects extensible, the child is reponsible 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

removeFrom

public void removeFrom(Buildable b)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

add

public void add(Buildable b)

Description copied from interface: Buildable

Adds a child component. Both this method and Buildable.addTo(VASSAL.build.Buildable) are invoked when adding a child to a parent

Specified by:

add in interface Buildable

remove

public void remove(Buildable b)

Description copied from interface: Configurable

Remove a child component

Specified by:

remove in interface Configurable

build

public void build(org.w3c.dom.Element e)

Description copied from interface: Buildable

Build the object

Specified by:

build in interface Buildable

Parameters:

e - the XML element containing the object data

actionPerformed

public void actionPerformed(java.awt.event.ActionEvent e)

Specified by:

actionPerformed in interface java.awt.event.ActionListener

writeMapAsText

protected void writeMapAsText()

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFilte describing how to use and configure this component

getBuildElement

public org.w3c.dom.Element getBuildElement(org.w3c.dom.Document doc)

Specified by:

getBuildElement in interface Buildable

Returns:

an XML element from which this component can be built

getConfigurer

public Configurer getConfigurer()

Description copied from interface: Configurable

Return a Configurer object which can be used to set the attributes of this object

Specified by:

getConfigurer in interface Configurable

getConfigureName

public java.lang.String getConfigureName()

The name of this Configurable Object

Specified by:

getConfigureName in interface Configurable

getConfigureTypeName

public static java.lang.String getConfigureTypeName()

getAttributeConfigurers

public Configurer[] getAttributeConfigurers()

Returns:

an array of Configurer objects representing the attributes of this Configurable object

getConfigureComponents

public Configurable[] getConfigureComponents()

Specified by:

getConfigureComponents in interface Configurable

Returns:

an array of Configurer objects representing the Buildable children of this Configurable object

getAllowableConfigureComponents

public java.lang.Class[] getAllowableConfigureComponents()

Description copied from interface: Configurable

Return 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 Configuration Window.

Specified by:

getAllowableConfigureComponents in interface Configurable

Returns:

an array of Configurer objects representing all possible classes of Buildable children of this Configurable object

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.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