Class BrowserHelpFile.ConfigSupport

java.lang.Object

VASSAL.build.module.documentation.BrowserHelpFile.ConfigSupport

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, Translatable

Enclosing class:

BrowserHelpFile

protected class BrowserHelpFile.ConfigSupport
extends Object
implements AutoConfigurable

The attributes we want to expose in the editor are not the same as the ones we want to save to the buildFile, so we use this object to specify the properties in the editor. Also packs up the contents directory and saves it to the ArchiveWriter

Author:

rkinney

Nested Class Summary

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
protected File	dir
static final String	DIR

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ConfigSupport()

Method Summary

Modifier and Type	Method	Description
void	add(Buildable child)	Adds a child component.
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
void	addTo(Buildable parent)	Adds this component to its parent.
void	build(Element e)	Build the object from the XML representation of the Buildable
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()
Class<?>[]	getAttributeTypes()	Return the Class for the attributes of this object.
String	getAttributeValueString(String key)	Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
VisibilityCondition	getAttributeVisibility(String name)	Because attributes are not always applicable in all cases, this method returns an interface to determine when the controls for specifying the named attribute should be visible.
Element	getBuildElement(Document doc)
Configurable[]	getConfigureComponents()
String	getConfigureName()	The name of this Configurable Object
Configurer	getConfigurer()
HelpFile	getHelpFile()
ComponentI18nData	getI18nData()
void	packContents()
protected void	packFile(File packed, String prefix, ZipOutputStream out)
void	remove(Buildable child)	Remove a child component
void	removeFrom(Buildable parent)	Remove this component from its parent
void	setAttribute(String key, Object value)	Called by the Buildable.build(org.w3c.dom.Element) method, where value is the String value read by the XML attribute.

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.build.Buildable

isMandatory, isMovable, isUnique

Field Details

DIR

public static final String DIR

See Also:

• Constant Field Values

dir

protected File dir

Constructor Details

ConfigSupport

protected ConfigSupport()

Method Details

getAttributeDescriptions

public String[] getAttributeDescriptions()

Description copied from interface: AutoConfigurable

Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object.

Specified by:

getAttributeDescriptions in interface AutoConfigurable

getAttributeNames

public String[] getAttributeNames()

Specified by:

getAttributeNames in interface AutoConfigurable

Returns:

an array of Strings giving all attributes of this Buildable component that will be written to/read from an XML element

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from interface: AutoConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, File, Color, and KeyStroke

Specified by:

getAttributeTypes in interface AutoConfigurable

getAttributeValueString

public String getAttributeValueString(String key)

Description copied from interface: AutoConfigurable

Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element

Specified by:

getAttributeValueString in interface AutoConfigurable

Specified by:

getAttributeValueString in interface Translatable

Parameters:

key - the name of the attribute. If the implementing class extends AbstractConfigurable, will be one of those listed in AbstractBuildable.getAttributeNames().

Returns:

a String representation of the attribute with the given name. When initializing a module, this String value will be passed to Translatable.setAttribute(java.lang.String, java.lang.Object).

getAttributeVisibility

public VisibilityCondition getAttributeVisibility(String name)

Description copied from interface: AutoConfigurable

Because attributes are not always applicable in all cases, this method returns an interface to determine when the controls for specifying the named attribute should be visible.

Specified by:

getAttributeVisibility in interface AutoConfigurable

Parameters:

name -

Returns:

null if the attribute controls should always be visible;

setAttribute

public void setAttribute(String key,
 Object value)

Description copied from interface: AutoConfigurable

Called by the Buildable.build(org.w3c.dom.Element) method, where value is the String value read by the XML attribute. Can also be called with Object value to set the attribute.

Specified by:

setAttribute in interface AutoConfigurable

Specified by:

setAttribute in interface Translatable

Parameters:

key - the name of the attribute. If the implementing class extends AbstractConfigurable, will be one of those listed in AbstractBuildable.getAttributeNames().

value - If the value parameter is a String, it will be the value returned by Translatable.getAttributeValueString(java.lang.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()

packContents

public void packContents()

packFile

protected void packFile(File packed,
 String prefix,
 ZipOutputStream out)
                 throws IOException

Throws:

IOException

addPropertyChangeListener

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

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

Specified by:

getAllowableConfigureComponents in interface Configurable

Returns:

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 Editor's ConfigureTree window by right-clicking on the component and selecting the appropriate "Add" option.

getConfigureComponents

public Configurable[] getConfigureComponents()

Specified by:

getConfigureComponents in interface Configurable

Returns:

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

getConfigureName

public String getConfigureName()

Description copied from interface: Configurable

The name of this Configurable Object

Specified by:

getConfigureName in interface Configurable

getConfigurer

public Configurer getConfigurer()

Specified by:

getConfigurer in interface Configurable

Returns:

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

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component

remove

public void remove(Buildable child)

Description copied from interface: Configurable

Remove a child component

Specified by:

remove in interface Configurable

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

add

public void add(Buildable child)

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

Parameters:

child - Child to attach to this buildable as a subcomponent

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.

build

public void build(Element e)

Description copied from interface: Buildable

Build the object from the XML representation of the Buildable

Specified by:

build in interface Buildable

Parameters:

e - the XML element containing the object data

getBuildElement

public Element getBuildElement(Document doc)

Specified by:

getBuildElement in interface Buildable

Parameters:

doc - XML file

Returns:

an XML element from which this component can be built

getI18nData

public ComponentI18nData getI18nData()

Specified by:

getI18nData in interface Translatable