VASSAL.build.module.ChartWindow

All Implemented Interfaces:: AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable

public class ChartWindow
extends Widget

A top-level Widget for displaying Charts

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class ChartWindow.IconConfig

Nested classes/interfaces inherited from class VASSAL.build.Widget
Widget.MyCellRenderer

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

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`BUTTON_TEXT`
`static String`	`DEPRECATED_NAME`
`protected JDialog`	`frame`
`static String`	`HOTKEY`
`static String`	`ICON`
`protected String`	`id`
`protected LaunchButton`	`launch`
`static String`	`NAME`
`protected Container`	`root`
`protected String`	`tooltip`
`static String`	`TOOLTIP`

Fields inherited from class VASSAL.build.Widget

buildElement, HEIGHT, parent, WIDTH

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

ChartWindow()

Method Summary

Modifier and Type	Method	Description
`void`	`add(Buildable b)`	Set the owning translatable of this component
`void`	`addTo(Buildable b)`	Expects to be added to a GameModule.
`Class<?>[]`	`getAllowableConfigureComponents()`	The allowable Configurable components of a Widget are the same as its parent
`String[]`	`getAttributeDescriptions()`	Return an array of Strings describing the attributes of this object.
`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
`Class<?>[]`	`getAttributeTypes()`	Return the Class for the attributes of this object.
`String`	`getAttributeValueString(String name)`	Return a String representation of the attribute with the given name.
`Component`	`getComponent()`
`static 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(String key, Object val)`	Sets an attribute value for this component.

Methods inherited from class VASSAL.build.Widget

build, getBuildElement, getConfigureComponents, getParent, rebuild

Methods inherited from class VASSAL.build.AbstractConfigurable

addPropertyChangeListener, getAttributeVisibility, getConfigureName, getConfigurer, getI18nData, getI18nPrefix, getLocalizedConfigureName, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

getAllDescendantComponentsOf, getBuildables, getBuildComponents, getComponentsOf, getPropertyNames, validate

Methods inherited from class java.lang.Object

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

Field Details
- DEPRECATED_NAME
  
  public static final String DEPRECATED_NAME
  
  See Also:
  
  Constant Field Values
- NAME
  
  public static final String NAME
  
  See Also:
  
  Constant Field Values
- BUTTON_TEXT
  
  public static final String BUTTON_TEXT
  
  See Also:
  
  Constant Field Values
- TOOLTIP
  
  public static final String TOOLTIP
  
  See Also:
  
  Constant Field Values
- ICON
  
  public static final String ICON
  
  See Also:
  
  Constant Field Values
- HOTKEY
  
  public static final String HOTKEY
  
  See Also:
  
  Constant Field Values
- launch
  
  protected LaunchButton launch
- frame
  
  protected JDialog frame
- root
  
  protected Container root
- tooltip
  
  protected String tooltip
- id
  
  protected String id
Constructor Details
- ChartWindow
  
  public ChartWindow()
Method Details
- 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
  
  Specified by:
  
  addTo in interface Buildable
  
  Overrides:
  
  addTo in class Widget
- removeFrom
  
  public void removeFrom(Buildable b)
  
  Description copied from interface: Configurable
  
  Remove this component from its parent
  
  Specified by:
  
  removeFrom in interface Configurable
  
  Overrides:
  
  removeFrom in class Widget
- setAttribute
  
  public void setAttribute(String key, Object val)
  
  Description copied from class: AbstractBuildable
  
  Sets an 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()
- getAttributeNames
  
  public 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
  
  Specified by:
  
  getAttributeNames in interface AutoConfigurable
  
  Specified by:
  
  getAttributeNames in class AbstractBuildable
  
  Returns:
  
  a list of all attribute names for this component
- getAttributeValueString
  
  public String getAttributeValueString(String name)
  
  Description copied from class: AbstractBuildable
  
  Return a String representation of the attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).
  
  Specified by:
  
  getAttributeValueString in interface AutoConfigurable
  
  Specified by:
  
  getAttributeValueString in interface Translatable
  
  Specified by:
  
  getAttributeValueString in class AbstractBuildable
  
  Parameters:
  
  name - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()
- getAllowableConfigureComponents
  
  public Class<?>[] getAllowableConfigureComponents()
  
  Description copied from class: Widget
  
  The allowable Configurable components of a Widget are the same as its parent
  
  Specified by:
  
  getAllowableConfigureComponents in interface Configurable
  
  Overrides:
  
  getAllowableConfigureComponents in class Widget
- add
  
  public void add(Buildable b)
  
  Description copied from class: AbstractConfigurable
  
  Set the owning translatable of this component
  
  Specified by:
  
  add in interface Buildable
  
  Overrides:
  
  add in class AbstractConfigurable
- remove
  
  public void remove(Buildable b)
  
  Description copied from class: AbstractConfigurable
  
  Remove a Buildable object from this object
  
  Specified by:
  
  remove in interface Configurable
  
  Overrides:
  
  remove in class AbstractConfigurable
- getComponent
  
  public Component getComponent()
  
  Specified by:
  
  getComponent in class 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 String getConfigureTypeName()
- getAttributeDescriptions
  
  public 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()
  
  Specified by:
  
  getAttributeDescriptions in interface AutoConfigurable
  
  Specified by:
  
  getAttributeDescriptions in class AbstractConfigurable
- getAttributeTypes
  
  public 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()
  
  Specified by:
  
  getAttributeTypes in interface AutoConfigurable
  
  Specified by:
  
  getAttributeTypes in class AbstractConfigurable
- getHelpFile
  
  public HelpFile getHelpFile()
  
  Specified by:
  
  getHelpFile in interface Configurable
  
  Overrides:
  
  getHelpFile in class Widget
  
  Returns:
  
  a HelpFilte describing how to use and configure this component

Class ChartWindow

Nested Class Summary

Nested classes/interfaces inherited from class VASSAL.build.Widget

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