Package VASSAL.build.widget

Class PanelWidget

java.lang.Object

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

VASSAL.build.Widget

VASSAL.build.widget.PanelWidget

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable

public class PanelWidget
extends Widget

A Widget that corresponds to a JPanel with a GridLayout or BoxLayout layout. Adding a Widget to a PanelWidget adds the child Widget's component to the JPanel. The attributes of the PanelWidget determine the layout parameters

Nested Class Summary

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	COLS
static String	FIXED
protected double	scale
static String	SCALE
static String	VERTICAL

Fields inherited from class VASSAL.build.Widget

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

Method Summary

Modifier and Type	Method	Description
void	add(Buildable b)	Set the owning translatable of this component
String[]	getAttributeDescriptions()	Return an array of Strings describing the attributes of this object.
String[]	getAttributeNames()	The attributes of a PanelWidget are: NAME for the name of the Widget FIXED uses GridLayout if true.
Class<?>[]	getAttributeTypes()	Return the Class for the buildFile (XML) attributes of this component.
String	getAttributeValueString(String name)	Called by the Buildable.getBuildElement(org.w3c.dom.Document) method to write the attributes into an XML element
VisibilityCondition	getAttributeVisibility(String name)	By default, all attributes are visible
Component	getComponent()
static String	getConfigureTypeName()
double	getScale()
boolean	hasScale()
void	remove(Buildable b)	Remove a Buildable object from this object
void	setAttribute(String name, Object value)	Sets a buildFile (XML) attribute value for this component.

Methods inherited from class VASSAL.build.Widget

addTo, build, getAllowableConfigureComponents, getBuildElement, getConfigureComponents, getHelpFile, getParent, rebuild, removeFrom

Methods inherited from class VASSAL.build.AbstractConfigurable

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

Methods inherited from class VASSAL.build.AbstractBuildable

getAllDescendantComponents, getAllDescendantComponentsOf, getBuildables, getBuildComponents, getComponents, getComponentsOf, getPropertyNames, validate

Methods inherited from class java.lang.Object

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

Field Details

scale

protected double scale

SCALE

public static final String SCALE

See Also:

Constant Field Values

FIXED

public static final String FIXED

See Also:

Constant Field Values

COLS

public static final String COLS

See Also:

Constant Field Values

VERTICAL

public static final String VERTICAL

See Also:

Constant Field Values

Constructor Details

PanelWidget

public PanelWidget()

Method Details

hasScale

public boolean hasScale()

Overrides:

hasScale in class Widget

getScale

public double getScale()

Overrides:

getScale in class Widget

getConfigureTypeName

public static String getConfigureTypeName()

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

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

getAttributeNames

public String[] getAttributeNames()

The attributes of a PanelWidget are: NAME for the name of the Widget FIXED uses GridLayout if true. Otherwise uses BoxLayout COLS for the number of columns. Ignored unless FIXED is true VERTICAL Uses a vertical BoxLayout if true. otherwise uses a horizontal layout. Ignored unless FIXED is false

Specified by:

getAttributeNames in interface AutoConfigurable

Specified by:

getAttributeNames in class AbstractBuildable

Returns:

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

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 class: AbstractConfigurable

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

Specified by:

getAttributeTypes in interface AutoConfigurable

Specified by:

getAttributeTypes in class AbstractConfigurable

getAttributeVisibility

public VisibilityCondition getAttributeVisibility(String name)

Description copied from class: AbstractConfigurable

By default, all attributes are visible

Specified by:

getAttributeVisibility in interface AutoConfigurable

Overrides:

getAttributeVisibility in class AbstractConfigurable

Parameters:

name - Name (key) of one of this component's attributes

Returns:

a VisibilityCondition for this attribute, or null if attribute should always be visible.

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 attribute with the given name. When initializing a module, this String value will be passed to AbstractBuildable.setAttribute(java.lang.String, java.lang.Object).