VASSAL.build.module.documentation
Class AboutScreen

java.lang.Object
  |
  +--VASSAL.build.AbstractBuildable
        |
        +--VASSAL.build.AbstractConfigurable
              |
              +--VASSAL.build.module.documentation.AboutScreen

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable

public class AboutScreen

extends AbstractConfigurable

Places an entry in the Help menu. Selecting the entry displays a window with a stored image on it. Good for a splash screen or an "about" screen.

Inner classes inherited from class VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

static java.lang.String	FILE
static java.lang.String	TITLE

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

AboutScreen()

AboutScreen(java.awt.Image i)

Method Summary

void	addTo(Buildable b) Expects to be added to a Documentation.
java.lang.Class[]	getAllowableConfigureComponents() Return a list of valid sub-component Classes.
java.lang.String[]	getAttributeDescriptions() Return an array of Strings describing the attributes of this object.
java.lang.String[]	getAttributeNames() The attributes of an AboutScreen are: TITLE the text of the menu entry in the Help menu FILE the name of an image file in the DataArchive.
java.lang.Class[]	getAttributeTypes() Return the Class for the attributes of this object.
java.lang.String	getAttributeValueString(java.lang.String key) Called by the AbstractBuildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
static java.lang.String	getConfigureTypeName()
HelpFile	getHelpFile()
protected void	initComponents()
void	launch()
static void	main(java.lang.String[] args)
void	removeFrom(Buildable b) Remove this component from its parent
void	setAttribute(java.lang.String key, java.lang.Object val) Called by the AbstractBuildable.build(org.w3c.dom.Element) method, where value is the String value read by the XML attribute.

Methods inherited from class VASSAL.build.AbstractConfigurable

addPropertyChangeListener, getAttributeVisibility, getConfigureComponents, getConfigureName, getConfigurer, remove, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

add, build, getBuildComponents, getBuildElement, getComponents

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

add, build, getBuildElement

Field Detail

TITLE

public static final java.lang.String TITLE

FILE

public static final java.lang.String FILE

Constructor Detail

AboutScreen

public AboutScreen()

AboutScreen

public AboutScreen(java.awt.Image i)

Method Detail

launch

public void launch()

initComponents

protected void initComponents()

getConfigureTypeName

public static java.lang.String getConfigureTypeName()

getAttributeNames

public java.lang.String[] getAttributeNames()

The attributes of an AboutScreen are: TITLE the text of the menu entry in the Help menu FILE the name of an image file in the DataArchive. The image is displayed when the menu item is selected

Overrides:

getAttributeNames in class AbstractBuildable

Following copied from interface: VASSAL.build.AutoConfigurable

Returns:

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

getAttributeDescriptions

public java.lang.String[] getAttributeDescriptions()

Description copied from class: AbstractConfigurable

Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()

Overrides:

getAttributeDescriptions in class AbstractConfigurable

getAttributeTypes

public java.lang.Class[] getAttributeTypes()

Description copied from class: AbstractConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, Color, and KeyStroke The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()

Overrides:

getAttributeTypes in class AbstractConfigurable

getAttributeValueString

public java.lang.String getAttributeValueString(java.lang.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

Overrides:

getAttributeValueString in class AbstractBuildable

Following copied from class: VASSAL.build.AbstractBuildable

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.Object val)

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.

Overrides:

setAttribute in class AbstractBuildable

Following copied from class: VASSAL.build.AbstractBuildable

Parameters:

key - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()

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.

removeFrom

public void removeFrom(Buildable b)

Description copied from interface: Configurable

Remove this component from its parent

addTo

public void addTo(Buildable b)

Expects to be added to a Documentation. Adds an entry to the Help menu

getHelpFile

public HelpFile getHelpFile()

Following copied from interface: VASSAL.build.Configurable

Returns:

a HelpFilte describing how to use and configure this component

main

public static void main(java.lang.String[] args)