VASSAL.build.widget.MapWidget

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

public class MapWidget
extends Widget

Nested Class Summary

Nested Classes

Modifier and Type Class Description

protected static class MapWidget.TabSwitcher

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
`protected WidgetMap`	`map`
`protected JComponent`	`mapHolder`
`protected JPanel`	`panel`
`protected Buildable`	`parent`
`protected JTabbedPane`	`tab`

Fields inherited from class VASSAL.build.Widget

buildElement, HEIGHT, NAME, 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

MapWidget()

Method Summary

Modifier and Type	Method	Description
`void`	`add(Buildable b)`	Set the owning translatable of this component
`void`	`addTo(Buildable b)`	Adds this component to its parent.
`void`	`build(Element e)`	For memory efficiency reasons, a Widget is initialized lazily.
`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()`
`Class<?>[]`	`getAttributeTypes()`	Return the Class for the attributes of this object.
`String`	`getAttributeValueString(String key)`	Return a String representation of the attribute with the given name.
`Component`	`getComponent()`
`static String`	`getConfigureTypeName()`
`HelpFile`	`getHelpFile()`
`WidgetMap`	`getMap()`
`void`	`remove(Buildable b)`	Remove a Buildable object from this object
`void`	`setAttribute(String key, Object value)`	Sets an attribute value for this component.

Methods inherited from class VASSAL.build.Widget

getBuildElement, getConfigureComponents, getParent, rebuild, removeFrom

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
- panel
  
  protected JPanel panel
- mapHolder
  
  protected JComponent mapHolder
- map
  
  protected WidgetMap map
- parent
  
  protected Buildable parent
- tab
  
  protected JTabbedPane tab
Constructor Details
- MapWidget
  
  public MapWidget()
Method Details
- getConfigureTypeName
  
  public static String getConfigureTypeName()
- 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
- build
  
  public void build(Element e)
  
  Description copied from class: Widget
  
  For memory efficiency reasons, a Widget is initialized lazily. This method only stores the element from which the build the Widget. The Widget is built from the stored element by invoking Widget.rebuild(). Subclasses should invoke Widget.rebuild() before invoking Widget.getComponent()
  
  Specified by:
  
  build in interface Buildable
  
  Overrides:
  
  build in class Widget
  
  Parameters:
  
  e - the XML element containing the object data
- 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
- 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 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.
  
  Specified by:
  
  addTo in interface Buildable
  
  Overrides:
  
  addTo 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
- 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
- getAttributeNames
  
  public String[] getAttributeNames()
  
  Specified by:
  
  getAttributeNames in interface AutoConfigurable
  
  Specified by:
  
  getAttributeNames in class AbstractBuildable
  
  Returns:
  
  a list of all attribute names for this component
- setAttribute
  
  public void setAttribute(String key, Object value)
  
  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()
- getAttributeValueString
  
  public String getAttributeValueString(String key)
  
  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:
  
  key - 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
- getMap
  
  public WidgetMap getMap()

Class MapWidget

Nested Class Summary

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

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