Package VASSAL.build.module.documentation

Class HelpFile

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.module.documentation.HelpFile

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable, ImageSearchTarget, SearchTarget

public class HelpFile
extends AbstractConfigurable

Places an entry in the Help menu. Selecting the entry displays a window with stored text on it.

Nested Class Summary

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

AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
static String	ARCHIVE_ENTRY
protected URL	contents
protected DialogHelpWindow	dialog
static String	FILE
protected String	fileName
protected String	fileType
protected HelpWindow	frame
protected Action	launch
protected MenuItemProxy	launchItem
static String	LOCAL_FILE
static String	RESOURCE
protected String	title
static String	TITLE
static String	TYPE

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
HelpFile()
HelpFile(String title, File contents)
HelpFile(String title, File contents, String ref)
HelpFile(String title, URL contents)

Method Summary

Modifier and Type	Method	Description
void	addLocalImageNames(Collection<String> s)	AbstractImageFinder - add any images referenced in our html file to our list of images
void	addTo(Buildable b)	Adds this component to its parent.
Class<?>[]	getAllowableConfigureComponents()
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()	The attributes of a HelpFile are: TITLE the text of the menu entry in the Help menu FILE the name of an text file in the DataArchive.
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
static String	getConfigureTypeName()
URL	getContents()
protected DialogHelpWindow	getDialogHelpWindow(Dialog d)
List<String>	getFormattedStringList()	SearchTarget
HelpFile	getHelpFile()
protected HelpWindow	getHelpWindow()
static HelpFile	getReferenceManualPage(String page)
static HelpFile	getReferenceManualPage(String page, String anchor)
void	removeFrom(Buildable b)	Remove this component from its parent
void	setAttribute(String key, Object val)	Sets a buildFile (XML) attribute value for this component.
void	showWindow()	Create and display a new HelpWindow with the contents of this HelpFile
void	showWindow(Dialog owner)	Create and display a new HelpWindow as a Dialog with the contents of this HelpFile
static URL	toURL(File f)	Deprecated, for removal: This API element is subject to removal in a future version. Use URLUtils.toURL(File) instead.

Methods inherited from class VASSAL.build.AbstractConfigurable

add, addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, getConfigurer, getExpressionList, getI18nData, getI18nPrefix, getLocalizedConfigureName, getMenuTextList, getNamedKeyStrokeList, getPropertyList, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

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

Methods inherited from class VASSAL.search.AbstractImageFinder

getAllImageNames, getLocalImageNames

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

build, getBuildElement

Field Details

TITLE

public static final String TITLE

See Also:

Constant Field Values

FILE

public static final String FILE

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

ARCHIVE_ENTRY

public static final String ARCHIVE_ENTRY

See Also:

Constant Field Values

RESOURCE

public static final String RESOURCE

See Also:

Constant Field Values

LOCAL_FILE

public static final String LOCAL_FILE

See Also:

Constant Field Values

frame

protected HelpWindow frame

dialog

protected DialogHelpWindow dialog

contents

protected URL contents

title

protected String title

fileName

protected String fileName

launch

protected Action launch

fileType

protected String fileType

launchItem

protected MenuItemProxy launchItem

Constructor Details

HelpFile

public HelpFile()

HelpFile

public HelpFile(String title,
 File contents,
 String ref)
         throws MalformedURLException

Throws:

MalformedURLException

HelpFile

public HelpFile(String title,
 File contents)
         throws MalformedURLException

Throws:

MalformedURLException

HelpFile

public HelpFile(String title,
 URL contents)

Method Details

getConfigureTypeName

public static String getConfigureTypeName()

showWindow

public void showWindow()

Create and display a new HelpWindow with the contents of this HelpFile

getHelpWindow

protected HelpWindow getHelpWindow()

showWindow

public void showWindow(Dialog owner)

Create and display a new HelpWindow as a Dialog with the contents of this HelpFile

getDialogHelpWindow

protected DialogHelpWindow getDialogHelpWindow(Dialog d)

getContents

public URL getContents()

toURL

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static URL toURL(File f)
                 throws MalformedURLException

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

Use URLUtils.toURL(File) instead.

Throws:

MalformedURLException

getHelpFile

public HelpFile getHelpFile()

Returns:

a HelpFile describing how to use and configure * this component

getAttributeNames

public String[] getAttributeNames()

The attributes of a HelpFile are: TITLE the text of the menu entry in the Help menu FILE the name of an text file in the DataArchive. The text is displayed in a window with the same title

Specified by:

getAttributeNames in interface AutoConfigurable

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

a list of all buildFile (XML) attribute names for this component

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

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(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.

setAttribute

public void setAttribute(String key,
 Object val)

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(java.lang.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 AutoConfigurable

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

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

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

Specified by:

getAttributeDescriptions in class AbstractConfigurable

Returns:

an array of Strings describing the buildFile (XML) attributes of this component. These strings are used as prompts in the Properties window for this object, when the component is configured in the Editor. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()

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

Specified by:

getAttributeTypes in class AbstractConfigurable

Returns:

the Class for the buildFile (XML) attributes of this component. Valid classes include: String, Integer, Double, Boolean, Image, Color, and KeyStroke, along with any class for which a Configurer exists in VASSAL.configure. The class determines, among other things, which type of AutoConfigurer will be used to configure the attribute when the object is configured in the Editor. The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

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.

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 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.

Parameters:

b - parent Buildable to add this component to as a subcomponent.

removeFrom

public void removeFrom(Buildable b)

Description copied from interface: Configurable

Remove this component from its parent

getReferenceManualPage

public static HelpFile getReferenceManualPage(String page)

getReferenceManualPage

public static HelpFile getReferenceManualPage(String page,
 String anchor)

getFormattedStringList

public List<String> getFormattedStringList()

SearchTarget

Specified by:

getFormattedStringList in interface SearchTarget

Overrides:

getFormattedStringList in class AbstractConfigurable

Returns:

a list of any Message Format strings referenced in the Configurable, if any (for search)

addLocalImageNames

public void addLocalImageNames(Collection<String> s)

AbstractImageFinder - add any images referenced in our html file to our list of images

Specified by:

addLocalImageNames in interface ImageSearchTarget

Overrides:

addLocalImageNames in class AbstractImageFinder

Parameters:

s - Collection to add image names to