Class BrowserHelpFile

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.module.documentation.BrowserHelpFile

All Implemented Interfaces:

Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable, Auditable, ImageSearchTarget

public class BrowserHelpFile
extends AbstractBuildable
implements Configurable

Unpacks a zipped directory stored in the module and displays it in an external browser window.

Author:

rkinney

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	BrowserHelpFile.ConfigSupport	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.
static class	BrowserHelpFile.ContentsConfig
protected static class	BrowserHelpFile.MyConfigurer	Handles the packaging of the target directory into the module file after the user saves the properties in the editor
static class	BrowserHelpFile.StartPageConfig

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTENTS
protected File	externalTempFile
protected Action	launch
protected MenuItemProxy	launchItem
protected ComponentI18nData	myI18nData
protected String	name
protected PropertyChangeSupport	propSupport
static final String	STARTING_PAGE
protected String	startingPage
static final String	TITLE
protected URL	url

Fields inherited from class AbstractBuildable

buildComponents, validator

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

Fields inherited from interface Configurable

NAME_PROPERTY

Modifier and Type	Field	Description
static final String	NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
BrowserHelpFile()

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
void	addTo(Buildable parent)	Adds this component to its parent.
protected String	evaluateStartingPage()
protected void	extractContents()	Extract the HTML from the module, or create an External URL from the Starting page if there is none
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
String	getAttributeValueString(String key)
Configurable[]	getConfigureComponents()
String	getConfigureName()	The name of this Configurable Object
Configurer	getConfigurer()
static String	getConfigureTypeName()
protected String	getContentsResource()
HelpFile	getHelpFile()
ComponentI18nData	getI18nData()
void	launch()
protected void	recursiveDelete(File output)	Deprecated, for removal: This API element is subject to removal in a future version. Use FileUtils.deleteDirectory(File) instead.
protected URL	regenerateUrl()
void	remove(Buildable child)	Remove a child component
void	removeFrom(Buildable parent)	Remove this component from its parent
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.

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

TITLE

public static final String TITLE

See Also:

• Constant Field Values

CONTENTS

public static final String CONTENTS

See Also:

• Constant Field Values

STARTING_PAGE

public static final String STARTING_PAGE

See Also:

• Constant Field Values

name

protected String name

startingPage

protected String startingPage

launch

protected Action launch

url

protected URL url

externalTempFile

protected File externalTempFile

propSupport

protected PropertyChangeSupport propSupport

myI18nData

protected ComponentI18nData myI18nData

launchItem

protected MenuItemProxy launchItem

Constructor Details

BrowserHelpFile

public BrowserHelpFile()

Method Details

launch

public void launch()

getContentsResource

protected String getContentsResource()

Returns:

The entry in the module Zip file containing the HTML directory

extractContents

protected void extractContents()

Extract the HTML from the module, or create an External URL from the Starting page if there is none

regenerateUrl

protected URL regenerateUrl()

evaluateStartingPage

protected String evaluateStartingPage()

recursiveDelete

@Deprecated(since="2020-10-04",
            forRemoval=true)
protected void recursiveDelete(File output)

Deprecated, for removal: This API element is subject to removal in a future version.

Use FileUtils.deleteDirectory(File) instead.

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

getAttributeValueString

public String getAttributeValueString(String key)

Specified by:

getAttributeValueString in interface Translatable

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 interface Translatable

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

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.

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

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

getConfigureTypeName

public static String getConfigureTypeName()

getI18nData

public ComponentI18nData getI18nData()

Specified by:

getI18nData in interface Translatable