Package VASSAL.build.module

Class PieceWindow

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.Widget

VASSAL.build.module.PieceWindow

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ComponentDescription, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget, 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 final String	BUTTON_TEXT
static final String	DEFAULT_DOCKED_WIDTH
protected int	defaultDockedWidth
static final String	DEPRECATED_NAME
protected boolean	hidden
static final String	HIDDEN
static final String	HOTKEY
static final String	ICON
protected String	id
protected static final UniqueIdManager	idMgr
protected LaunchButton	launch
protected ComponentSplitter.SplitPane	mainWindowDock	Deprecated, for removal: This API element is subject to removal in a future version.
static final String	NAME
protected JComponent	root
protected double	scale
static final String	SCALE
protected SplitPane	splitPane
protected String	tooltip
static final String	TOOLTIP

Fields inherited from class VASSAL.build.Widget

buildElement, description, DESCRIPTION, 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	addLocalImageNames(Collection<String> s)	Classes extending AbstractImageFinder should override this method in order to add the names of any image files they use to the collection.
void	addTo(Buildable parent)	Expects to be added to a GameModule.
void	build(Element e)	For memory efficiency reasons, a Widget is initialized lazily.
void	dockMe()	Docks us into the main window -- needs to be called AFTER Chatter has docked.
Class<?>[]	getAllowableConfigureComponents()	A PieceWindow may contain a TabWidget, a PanelWidget, a BoxWidget, a ListWidget -- but not a lone piece slot
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
Class<?>[]	getAttributeTypes()	Return the Class for the attributes of this object.
String	getAttributeValueString(String name)	Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
Class<?>[]	getChildAllowableConfigureComponents()	Children of PieceWindow may contain a TabWidget, a PanelWidget, a BoxWidget, a ListWidget, or a PieceSlot
Component	getComponent()
static String	getConfigureTypeName()
HelpFile	getHelpFile()
String	getId()	Each instanceof PieceWindow has a unique String identifier
List<String>	getMenuTextList()	SearchTarget
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
double	getScale()
boolean	hasScale()
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 a buildFile (XML) 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, getDescription, getParent, hasScalablePieces, rebuild

Methods inherited from class VASSAL.build.AbstractConfigurable

addPropertyChangeListener, getAttributeVisibility, getConfigureName, getConfigurer, getExpressionList, getFormattedStringList, getI18nData, getI18nPrefix, getLocalizedConfigureName, getPropertyList, getTypeName, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Methods inherited from class VASSAL.build.AbstractBuildable

addImageNamesRecursively, buildString, getAllDescendantComponentsOf, getAncestor, getBuildables, getBuildComponents, getComponents, getComponentsOf, getNonFolderAncestor, getPropertyNames, setAncestor, validate

Methods inherited from class VASSAL.search.AbstractImageFinder

getAllImageNames, getLocalImageNames

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.script.expression.Auditable

getComponentName, getComponentTypeName

Methods inherited from interface VASSAL.build.Buildable

isMandatory, isMovable, isUnique

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

SCALE

public static final String SCALE

See Also:

• Constant Field Values

DEFAULT_DOCKED_WIDTH

public static final String DEFAULT_DOCKED_WIDTH

See Also:

• Constant Field Values

idMgr

protected static final UniqueIdManager idMgr

root

protected JComponent root

tooltip

protected String tooltip

scale

protected double scale

defaultDockedWidth

protected int defaultDockedWidth

mainWindowDock

@Deprecated(since="2020-11-15",
            forRemoval=true)
protected ComponentSplitter.SplitPane mainWindowDock

Deprecated, for removal: This API element is subject to removal in a future version.

splitPane

protected SplitPane splitPane

Constructor Details

PieceWindow

public PieceWindow()

Method Details

hasScale

public boolean hasScale()

Overrides:

hasScale in class Widget

getScale

public double getScale()

Overrides:

getScale in class Widget

launchButtonPressed

public void launchButtonPressed()

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Overrides:

getHelpFile in class Widget

Returns:

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

getChildAllowableConfigureComponents

public Class<?>[] getChildAllowableConfigureComponents()

Children of PieceWindow may contain a TabWidget, a PanelWidget, a BoxWidget, a ListWidget, or a PieceSlot

Overrides:

getChildAllowableConfigureComponents in class Widget

Returns:

configure components allowed for children of this class

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

A PieceWindow may contain a TabWidget, a PanelWidget, a BoxWidget, a ListWidget -- but not a lone piece slot

Specified by:

getAllowableConfigureComponents in interface Configurable

Overrides:

getAllowableConfigureComponents in class Widget

Returns:

a list of valid sub-component Classes. If a Class appears in this list, then instances of that class may be added to this component from the Editor's ConfigureTree window by right-clicking on the component and selecting the appropriate "Add" option.

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

Parameters:

b - Child to attach to this buildable as a subcomponent

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

dockMe

public void dockMe()

Docks us into the main window -- needs to be called AFTER Chatter has docked.

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

Parameters:

parent - parent Buildable to add this component to as a subcomponent.

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 interface: AutoConfigurable

Return an array of Strings describing the attributes of this object. These strings are used as prompts in the Properties window for this object.

Specified by:

getAttributeDescriptions in interface AutoConfigurable

Specified by:

getAttributeDescriptions in class AbstractConfigurable

Returns:

an array of Strings describing the buildFile (XML) attributes of this component. These strings are used as prompts in the Properties window for this object, when the component is configured in the Editor. The order of descriptions should be the same as the order of names in AbstractBuildable.getAttributeNames()

getAttributeTypes

public Class<?>[] getAttributeTypes()

Description copied from interface: AutoConfigurable

Return the Class for the attributes of this object. Valid classes are: String, Integer, Double, Boolean, Image, File, Color, and KeyStroke

Specified by:

getAttributeTypes in interface AutoConfigurable

Specified by:

getAttributeTypes in class AbstractConfigurable

Returns:

the Class for the buildFile (XML) attributes of this component. Valid classes include: String, Integer, Double, Boolean, Image, Color, and KeyStroke, along with any class for which a Configurer exists in VASSAL.configure. The class determines, among other things, which type of AutoConfigurer will be used to configure the attribute when the object is configured in the Editor. The order of classes should be the same as the order of names in AbstractBuildable.getAttributeNames()

getAttributeNames

public String[] getAttributeNames()

Description copied from class: AbstractBuildable

Lists all the buildFile (XML) attribute names for this component. If this component is ALSO an AbstractConfigurable, then this list of attributes determines the appropriate attribute order for AbstractConfigurable.getAttributeDescriptions() and AbstractConfigurable.getAttributeTypes().

Specified by:

getAttributeNames in interface AutoConfigurable

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

a list of all buildFile (XML) attribute names for this component

setAttribute

public void setAttribute(String name,
 Object value)

Description copied from class: AbstractBuildable

Sets a buildFile (XML) 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()

value - 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 can also be an instance of the corresponding Class listed in AbstractConfigurable.getAttributeTypes()

getAttributeValueString

public String getAttributeValueString(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

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

Returns:

a String representation of the XML buildFile attribute with the given name. When initializing a module, this String value will loaded from the XML and passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object). It is also frequently used for checking the current value of an attribute.

getMenuTextList

public List<String> getMenuTextList()

SearchTarget

Specified by:

getMenuTextList in interface SearchTarget

Overrides:

getMenuTextList in class AbstractConfigurable

Returns:

a list of any Menu/Button/Tooltip Text strings referenced in the Configurable, if any (for search)

getNamedKeyStrokeList

public List<NamedKeyStroke> getNamedKeyStrokeList()

SearchTarget

Specified by:

getNamedKeyStrokeList in interface SearchTarget

Overrides:

getNamedKeyStrokeList in class AbstractConfigurable

Returns:

a list of any Named KeyStrokes referenced in the Configurable, if any (for search)

addLocalImageNames

public void addLocalImageNames(Collection<String> s)

Description copied from class: AbstractImageFinder

Classes extending AbstractImageFinder should override this method in order to add the names of any image files they use to the collection.

Specified by:

addLocalImageNames in interface ImageSearchTarget

Overrides:

addLocalImageNames in class AbstractImageFinder

Parameters:

s - Collection to add image names to