VASSAL.build
Interface Configurable

All Superinterfaces:

Buildable

All Known Subinterfaces:

AutoConfigurable

All Known Implementing Classes:

AbstractConfigurable, BoardPicker, GlobalMap, LOS_Thread, Map, PlayerRoster, TextSaver

public interface Configurable

extends Buildable

An object that implements the Configurable interface can, in addition to being built from a configuration XML file, be manipulated by the user directly in the VASSAL module editor via the Configuration window.

Field Summary

static java.lang.String

NAME_PROPERTY

Method Summary

void	addPropertyChangeListener(java.beans.PropertyChangeListener l) Add a PropertyChangeListener.
java.lang.Class[]	getAllowableConfigureComponents() Return a list of valid sub-component Classes.
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
HelpFile	getHelpFile()
void	remove(Buildable child) Remove a child component
void	removeFrom(Buildable parent) Remove this component from its parent

Methods inherited from interface VASSAL.build.Buildable

add, addTo, build, getBuildElement

Field Detail

NAME_PROPERTY

public static final java.lang.String NAME_PROPERTY

See Also:

Constant Field Values

Method Detail

removeFrom

public void removeFrom(Buildable parent)

Remove this component from its parent

remove

public void remove(Buildable child)

Remove a child component

getConfigureName

public java.lang.String getConfigureName()

The name of this Configurable Object

getHelpFile

public HelpFile getHelpFile()

Returns:

a HelpFilte describing how to use and configure this component

getConfigureComponents

public Configurable[] getConfigureComponents()

Returns:

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

getConfigurer

public Configurer getConfigurer()

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

getAllowableConfigureComponents

public java.lang.Class[] getAllowableConfigureComponents()

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.

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener l)

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