Class Widget

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.Widget

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ComponentDescription, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget

Direct Known Subclasses:

BoxWidget, Chart, ChartWindow, HtmlChart, ListWidget, MapWidget, PanelWidget, PieceSlot, PieceWindow, TabWidget

public abstract class Widget
extends AbstractConfigurable
implements ComponentDescription

A general-purpose configurable GUI container Widgets are Configurable objects that represent AWT components. Adding a Widget to another Widget during a Buildable.build(Element) operation will add the corresponding AWT component of the child to the component of the parent

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Widget.MyCellRenderer

Nested classes/interfaces inherited from interface AutoConfigurable

AutoConfigurable.Util

Modifier and Type	Interface	Description
static class	AutoConfigurable.Util

Field Summary

Fields

Modifier and Type	Field	Description
protected Element	buildElement
protected String	description
static final String	DESCRIPTION
static final String	HEIGHT
static final String	NAME
protected Widget	parent
static final String	WIDTH

Fields inherited from class AbstractConfigurable

changeSupport, config, localizedName, myI18nData, name

Modifier and Type	Field	Description
protected PropertyChangeSupport	changeSupport
protected Configurer	config
protected String	localizedName
protected ComponentI18nData	myI18nData
protected String	name

Fields inherited from class AbstractBuildable

buildComponents, validator

Modifier and Type	Field	Description
protected List<Buildable>	buildComponents
protected ValidityChecker	validator

Fields inherited from interface Configurable

NAME_PROPERTY

Modifier and Type	Field	Description
static final String	NAME_PROPERTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Widget()

Method Summary

Modifier and Type	Method	Description
void	addTo(Buildable b)	Adds this component to its parent.
void	build(Element el)	For memory efficiency reasons, a Widget is initialized lazily.
Class<?>[]	getAllowableConfigureComponents()	The allowable Configurable components of a Widget determined by its parent's Child-Allowable method.
Element	getBuildElement(Document doc)
Class<?>[]	getChildAllowableConfigureComponents()	Allowable components for a CHILD of this class - default is to ask our parent for this list.
abstract Component	getComponent()
Configurable[]	getConfigureComponents()
String	getDescription()
HelpFile	getHelpFile()
Widget	getParent()
double	getScale()
boolean	hasScalablePieces()
boolean	hasScale()
protected void	rebuild()	Perform the build of this Buildable component using the element stored from when the the build(Element) method was invoked
void	removeFrom(Buildable b)	Remove this component from its parent

Methods inherited from class AbstractConfigurable

add, addPropertyChangeListener, getAttributeDescriptions, getAttributeTypes, getAttributeVisibility, getConfigureName, getConfigurer, getExpressionList, getFormattedStringList, getI18nData, getI18nPrefix, getLocalizedConfigureName, getMenuTextList, getNamedKeyStrokeList, getPropertyList, getTypeName, remove, removePropertyChangeListener, setAllAttributesUntranslatable, setAttributeTranslatable, setConfigureName

Modifier and Type	Method	Description
void	add(Buildable b)	Set the owning translatable of this component
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
abstract String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
abstract Class<?>[]	getAttributeTypes()	Return the Class for the attributes of this object.
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
String	getConfigureName()	ConfigureName is used, in particular, by the Editor to track the names of components, and is preferred by UniqueIdManager.
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
List<String>	getExpressionList()	SearchTarget
List<String>	getFormattedStringList()	SearchTarget
ComponentI18nData	getI18nData()
protected String	getI18nPrefix()
String	getLocalizedConfigureName()
List<String>	getMenuTextList()	SearchTarget
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
List<String>	getPropertyList()	SearchTarget
String	getTypeName()	Returns the name of the configurable type for display purposes.
void	remove(Buildable b)	Remove a Buildable object from this object
void	removePropertyChangeListener(PropertyChangeListener l)
protected void	setAllAttributesUntranslatable()	Sets all attributes untranslatable.
protected void	setAttributeTranslatable(String attr, boolean b)	Over-ride the default attribute translatability.
void	setConfigureName(String s)	Sets the name and fires a PropertyChangeEvent

Methods inherited from class AbstractBuildable

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

Modifier and Type	Method	Description
void	addImageNamesRecursively(Collection<String> s)	Adds all images used by this component AND any subcomponents to the collection
String	buildString()
<T> List<T>	getAllDescendantComponentsOf(Class<T> target)	Recursively descend the build tree and return a List of all components that are instances of the given class
Buildable	getAncestor()
abstract String[]	getAttributeNames()	Lists all the buildFile (XML) attribute names for this component.
abstract String	getAttributeValueString(String key)
List<Buildable>	getBuildables()
Enumeration<Buildable>	getBuildComponents()	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getBuildables() instead.
<T> Enumeration<T>	getComponents(Class<T> target)	Deprecated, for removal: This API element is subject to removal in a future version. Use AbstractBuildable.getComponentsOf(Class) instead.
<T> List<T>	getComponentsOf(Class<T> target)
Buildable	getNonFolderAncestor()
List<String>	getPropertyNames()	Override this method to provide a list of properties to be exposed for use by expressions in the module.
void	setAncestor(Buildable ancestor)
abstract void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.
void	validate(Buildable target, ValidationReport report)

Methods inherited from class AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Modifier and Type	Method	Description
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.
SortedSet<String>	getAllImageNames()
SortedSet<String>	getLocalImageNames()

Methods inherited from class Object

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

Methods inherited from interface Auditable

getComponentName, getComponentTypeName

Modifier and Type	Method	Description
default String	getComponentName()	Return the name of the trait or Component an Auditable is
default String	getComponentTypeName()	Return a description of the Type of trait or Component an Auditable is

Methods inherited from interface AutoConfigurable

getAttributeNames, getAttributeValueString, setAttribute

Modifier and Type	Method	Description
String[]	getAttributeNames()
String	getAttributeValueString(String key)	Called by the Buildable.getBuildElement(Document) method to write the attributes into an XML element
void	setAttribute(String key, Object value)	Called by the Buildable.build(Element) method, where value is the String value read by the XML attribute.

Methods inherited from interface Buildable

isMandatory, isMovable, isUnique

Modifier and Type	Method	Description
default boolean	isMandatory()	Is this component a reqired component within its parent?
default boolean	isMovable()	Is this component allowed to be moved around the Configure Tree?
default boolean	isUnique()	Does this component need to be unique within it's parent?

Field Details

DESCRIPTION

public static final String DESCRIPTION

See Also:

• Constant Field Values

NAME

public static final String NAME

See Also:

• Constant Field Values

WIDTH

public static final String WIDTH

See Also:

• Constant Field Values

HEIGHT

public static final String HEIGHT

See Also:

• Constant Field Values

buildElement

protected Element buildElement

parent

protected Widget parent

description

protected String description

Constructor Details

Widget

protected Widget()

Method Details

hasScale

public boolean hasScale()

hasScalablePieces

public boolean hasScalablePieces()

Returns:

false if we're a child of a ChartWindow, meaning there won't be pieces to scale

getScale

public double getScale()

getDescription

public String getDescription()

Specified by:

getDescription in interface ComponentDescription

Returns:

Description to be displayed next to component type/name in the main Editor window. Or null or "" to not display anything.

build

public void build(Element el)

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 rebuild(). Subclasses should invoke rebuild() before invoking getComponent()

Specified by:

build in interface Buildable

Overrides:

build in class AbstractBuildable

Parameters:

el - the XML element containing the object data

rebuild

protected void rebuild()

Perform the build of this Buildable component using the element stored from when the the build(Element) method was invoked

getBuildElement

public Element getBuildElement(Document doc)

Specified by:

getBuildElement in interface Buildable

Overrides:

getBuildElement in class AbstractBuildable

Parameters:

doc - XML file

Returns:

an XML element from which this component can be built

getChildAllowableConfigureComponents

public Class<?>[] getChildAllowableConfigureComponents()

Allowable components for a CHILD of this class - default is to ask our parent for this list. Top-level parents must override this with the proper child list for their trees.

Returns:

configure components allowed for children of this class

getAllowableConfigureComponents

public Class<?>[] getAllowableConfigureComponents()

The allowable Configurable components of a Widget determined by its parent's Child-Allowable method.

Specified by:

getAllowableConfigureComponents in interface Configurable

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.

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 responsible 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

Parameters:

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

removeFrom

public void removeFrom(Buildable b)

Description copied from interface: Configurable

Remove this component from its parent

Specified by:

removeFrom in interface Configurable

getParent

public Widget getParent()

getConfigureComponents

public Configurable[] getConfigureComponents()

Specified by:

getConfigureComponents in interface Configurable

Overrides:

getConfigureComponents in class AbstractConfigurable

Returns:

A list of all child components (i.e. subcomponents) of this component that are configurable.

getComponent

public abstract Component getComponent()

Returns:

the Component for this widget. For efficiency, the Component may be initialized lazily instead of being created in the Buildable.build(Element) method

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface Configurable

Returns:

a HelpFile describing how to use and configure * this component