VASSAL.build.module.PieceWindow

All Implemented Interfaces:: AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable, UniqueIdManager.Identifyable

public class PieceWindow
extends Widget
implements UniqueIdManager.Identifyable

A window from which players can create new GamePieces by clicking and dragging from the PieceWindow. The actual GamePieces are contained in PieceSlot components. PieceWindow extends Widget, so it may be composed of various tabs, lists, etc.

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class PieceWindow.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 boolean`	`hidden`
`static String`	`HIDDEN`
`static String`	`HOTKEY`
`static String`	`ICON`
`protected String`	`id`
`protected static UniqueIdManager`	`idMgr`
`protected LaunchButton`	`launch`
`protected ComponentSplitter.SplitPane`	`mainWindowDock`
`static String`	`NAME`
`protected JComponent`	`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

PieceWindow()

Method Summary

Modifier and Type	Method	Description
`void`	`add(Buildable b)`	Set the owning translatable of this component
`void`	`addTo(Buildable parent)`	Expects to be added to a `GameModule`.
`void`	`build(Element e)`	For memory efficiency reasons, a Widget is initialized lazily.
`Class<?>[]`	`getAllowableConfigureComponents()`	A PieceWindow may contain a `TabWidget`, a `PanelWidget`, a `BoxWidget`, a `ListWidget`, or a `PieceSlot`
`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 name)`	Return a String representation of the attribute with the given name.
`Component`	`getComponent()`
`static String`	`getConfigureTypeName()`
`HelpFile`	`getHelpFile()`
`String`	`getId()`	Each instanceof PieceWindow has a unique String identifier
`void`	`launchButtonPressed()`
`void`	`remove(Buildable b)`	Remove a Buildable object from this object
`void`	`removeFrom(Buildable parent)`	Remove this component from its parent
`void`	`setAttribute(String name, Object value)`	Sets an attribute value for this component.
`void`	`setId(String s)`	Each instanceof PieceWindow has a unique String identifier
`boolean`	`shouldDockIntoMainWindow()`

Methods inherited from class VASSAL.build.Widget

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

Methods inherited from interface VASSAL.tools.UniqueIdManager.Identifyable

getConfigureName

Field Details
- id
  
  protected String id
- launch
  
  protected LaunchButton launch
- hidden
  
  protected boolean hidden
- 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
- HIDDEN
  
  public static final String HIDDEN
  
  See Also:
  
  Constant Field Values
- idMgr
  
  protected static UniqueIdManager idMgr
- root
  
  protected JComponent root
- mainWindowDock
  
  protected ComponentSplitter.SplitPane mainWindowDock
- tooltip
  
  protected String tooltip
Constructor Details
- PieceWindow
  
  public PieceWindow()
Method Details
- launchButtonPressed
  
  public void launchButtonPressed()
- 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
- shouldDockIntoMainWindow
  
  public boolean shouldDockIntoMainWindow()
- 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()
- getAllowableConfigureComponents
  
  public Class<?>[] getAllowableConfigureComponents()
  
  A PieceWindow may contain a TabWidget, a PanelWidget, a BoxWidget, a ListWidget, or a PieceSlot
  
  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
- getId
  
  public String getId()
  
  Each instanceof PieceWindow has a unique String identifier
  
  Specified by:
  
  getId in interface UniqueIdManager.Identifyable
  
  Returns:
  
  the identifier for this PieceWindow
- setId
  
  public void setId(String s)
  
  Each instanceof PieceWindow has a unique String identifier
  
  Specified by:
  
  setId in interface UniqueIdManager.Identifyable
- addTo
  
  public void addTo(Buildable parent)
  
  Expects to be added to a GameModule. When added, sets the containing window to visible
  
  Specified by:
  
  addTo in interface Buildable
  
  Overrides:
  
  addTo in class Widget
- removeFrom
  
  public void removeFrom(Buildable parent)
  
  Description copied from interface: Configurable
  
  Remove this component from its parent
  
  Specified by:
  
  removeFrom in interface Configurable
  
  Overrides:
  
  removeFrom in class Widget
- 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 name, 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:
  
  name - the name of the attribute. Will be one of those listed in AbstractBuildable.getAttributeNames()
- 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()

Class PieceWindow

Nested Class Summary

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

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