: Class HtmlChart

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

VASSAL.build.widget
Class HtmlChart

java.lang.Object
  |
  +--VASSAL.build.AbstractBuildable
        |
        +--VASSAL.build.AbstractConfigurable
              |
              +--VASSAL.build.Widget
                    |
                    +--VASSAL.build.widget.HtmlChart

All Implemented Interfaces:: AutoConfigurable, Buildable, Configurable, java.util.EventListener, java.awt.event.MouseListener, ValidityChecker

public class HtmlChart
extends Widget
implements java.awt.event.MouseListener

An HtmlChart is used for displaying html information for the module. The charts are loaded as html files stored in the DataArchive. As a subclass of Widget, a Chart may be added to any Widget, but it may not contain children of its own

Inner Class Summary

class HtmlChart.HtmlChartHyperlinkListener


class HtmlChart.XTMLEditorKit
          Extended HTML Editor kit to extend the tag to display images from the module DataArchive where no pathname included in the image name.

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 FILE


static java.lang.String NAME


Fields inherited from class VASSAL.build.Widget

buildElement, HEIGHT, parent, WIDTH

Fields inherited from class VASSAL.build.AbstractConfigurable

changeSupport, config, name

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

HtmlChart()


Method Summary

void addTo(Buildable parent)
          Adds this component to its parent.

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 Chart are:

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


java.lang.String getFileName()


HelpFile getHelpFile()


void mouseClicked(java.awt.event.MouseEvent e)


void mouseEntered(java.awt.event.MouseEvent e)


void mouseExited(java.awt.event.MouseEvent e)


void mousePressed(java.awt.event.MouseEvent event)


void mouseReleased(java.awt.event.MouseEvent e)


void removeFrom(Buildable parent)
          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, remove, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

add, getBuildComponents, getComponents, validate

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

Field Detail

NAME

public static final java.lang.String NAME

FILE

public static final java.lang.String FILE

Constructor Detail

HtmlChart

public HtmlChart()

Method Detail

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

getFileName

public java.lang.String getFileName()

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 reponsible for adding itself to the parent. That way, Buildable subcomponents can be defined in an extension package without needing to modify the containing class.

Overrides:: addTo in class Widget

getConfigureTypeName

public static java.lang.String getConfigureTypeName()

removeFrom

public void removeFrom(Buildable parent)

Description copied from interface: Configurable

Remove this component from its parent

Overrides:: removeFrom in class Widget

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

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 class: Widget

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

Overrides:: getAllowableConfigureComponents in class Widget

getAttributeNames

public java.lang.String[] getAttributeNames()

The Attributes of a Chart are:

 
 NAME
 









           for the name of the chart










 
 FILE
 









           for the name of the HTML file in the DataArchive

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