VASSAL.build.module
Class ChartWindow

java.lang.Object
  |
  +--VASSAL.build.AbstractBuildable
        |
        +--VASSAL.build.AbstractConfigurable
              |
              +--VASSAL.build.Widget
                    |
                    +--VASSAL.build.module.ChartWindow

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable

public class ChartWindow

extends Widget

A top-level Widget for displaying Charts

Inner classes inherited from class VASSAL.build.Widget

Widget.MyCellRenderer

Inner classes inherited from class VASSAL.build.AutoConfigurable

AutoConfigurable.Util

Field Summary

static java.lang.String	HOTKEY
static java.lang.String	NAME

Fields inherited from class VASSAL.build.Widget

buildElement, parent

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

ChartWindow()

Method Summary

void	add(Buildable b) Adds a child component.
void	addTo(Buildable b) Expects to be added to a GameModule.
java.lang.Class[]	getAllowableConfigureComponents() The allowable Configurable components of a Widget are the same as its parent
java.lang.String[]	getAttributeDescriptions() Return an array of Strings describing the attributes of this object.
java.lang.String[]	getAttributeNames() The attributes of a ChartWindow are: NAME Appears as the name of the button in the toolbar and the window itself HOTKEY for the hotkey equivalent for the button
java.lang.Class[]	getAttributeTypes() Return the Class for the attributes of this object.
java.lang.String	getAttributeValueString(java.lang.String name) Called by the Widget.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
java.awt.Component	getComponent()
static java.lang.String	getConfigureTypeName()
HelpFile	getHelpFile()
void	remove(Buildable b) Remove a Buildable object from this object
void	removeFrom(Buildable b) Remove this component from its parent
void	setAttribute(java.lang.String key, java.lang.Object val) Called by the Widget.build(org.w3c.dom.Element) method, where value is the String value read by the XML attribute.

Methods inherited from class VASSAL.build.Widget

build, getBuildElement, getConfigureComponents, getParent, rebuild

Methods inherited from class VASSAL.build.AbstractConfigurable

addPropertyChangeListener, getAttributeVisibility, getConfigureName, getConfigurer, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

getBuildComponents, getComponents

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

HOTKEY

public static final java.lang.String HOTKEY

Constructor Detail

ChartWindow

public ChartWindow()

Method Detail

addTo

public void addTo(Buildable b)

Expects to be added to a GameModule. Adds a JButton to the control window's toolbar. Pushing the button displays the window

Overrides:

addTo in class Widget

removeFrom

public void removeFrom(Buildable b)

Description copied from interface: Configurable

Remove this component from its parent

Overrides:

removeFrom in class Widget

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

getAttributeNames

public java.lang.String[] getAttributeNames()

The attributes of a ChartWindow are: NAME Appears as the name of the button in the toolbar and the window itself HOTKEY for the hotkey equivalent for the button

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

getAttributeValueString

public java.lang.String getAttributeValueString(java.lang.String name)

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

getAllowableConfigureComponents

public java.lang.Class[] getAllowableConfigureComponents()

Description copied from class: Widget

The allowable Configurable components of a Widget are the same as its parent

Overrides:

getAllowableConfigureComponents in class Widget

add

public void add(Buildable b)

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

Overrides:

add in class AbstractBuildable

remove

public void remove(Buildable b)

Description copied from class: AbstractConfigurable

Remove a Buildable object from this object

Overrides:

remove in class AbstractConfigurable

getComponent

public java.awt.Component getComponent()

Overrides:

getComponent in class Widget

Following copied from class: VASSAL.build.Widget

Returns:

the Component for this widget. For efficiency, the Component may be initialized lazily instead of being created in the Buildable.build(org.w3c.dom.Element) method

getConfigureTypeName

public static java.lang.String getConfigureTypeName()

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

getHelpFile

public HelpFile getHelpFile()

Overrides:

getHelpFile in class Widget

Following copied from interface: VASSAL.build.Configurable

Returns:

a HelpFilte describing how to use and configure this component