Package VASSAL.build.module
Class PieceWindow
java.lang.Object
VASSAL.build.AbstractBuildable
VASSAL.build.AbstractConfigurable
VASSAL.build.Widget
VASSAL.build.module.PieceWindow
- All Implemented Interfaces:
AutoConfigurable
,Buildable
,Configurable
,PropertyNameSource
,ValidityChecker
,Translatable
,UniqueIdManager.Identifyable
public class PieceWindow extends Widget implements UniqueIdManager.Identifyable
-
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 double
scale
static String
SCALE
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 componentvoid
addTo(Buildable parent)
Expects to be added to aGameModule
.void
build(Element e)
For memory efficiency reasons, a Widget is initialized lazily.Class<?>[]
getAllowableConfigureComponents()
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 buildFile (XML) attributes of this component.String
getAttributeValueString(String name)
Called by theBuildable.getBuildElement(org.w3c.dom.Document)
method to write the attributes into an XML elementComponent
getComponent()
static String
getConfigureTypeName()
HelpFile
getHelpFile()
String
getId()
Each instanceof PieceWindow has a unique String identifierdouble
getScale()
boolean
hasScale()
void
launchButtonPressed()
void
remove(Buildable b)
Remove a Buildable object from this objectvoid
removeFrom(Buildable parent)
Remove this component from its parentvoid
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 identifierboolean
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
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
Methods inherited from interface VASSAL.tools.UniqueIdManager.Identifyable
getConfigureName
-
Field Details
-
id
-
launch
-
DEPRECATED_NAME
- See Also:
- Constant Field Values
-
NAME
- See Also:
- Constant Field Values
-
BUTTON_TEXT
- See Also:
- Constant Field Values
-
TOOLTIP
- See Also:
- Constant Field Values
-
ICON
- See Also:
- Constant Field Values
-
HOTKEY
- See Also:
- Constant Field Values
-
HIDDEN
- See Also:
- Constant Field Values
-
SCALE
- See Also:
- Constant Field Values
-
idMgr
-
root
-
mainWindowDock
-
tooltip
-
scale
protected double scale
-
-
Constructor Details
-
PieceWindow
public PieceWindow()
-
-
Method Details
-
hasScale
public boolean hasScale() -
getScale
public double getScale() -
launchButtonPressed
public void launchButtonPressed() -
getHelpFile
- Specified by:
getHelpFile
in interfaceConfigurable
- Overrides:
getHelpFile
in classWidget
- Returns:
- a HelpFilte describing how to use and configure this component
-
build
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 invokingWidget.rebuild()
. Subclasses should invokeWidget.rebuild()
before invokingWidget.getComponent()
-
shouldDockIntoMainWindow
public boolean shouldDockIntoMainWindow() -
getComponent
- Specified by:
getComponent
in classWidget
- 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
-
getAllowableConfigureComponents
- Specified by:
getAllowableConfigureComponents
in interfaceConfigurable
- Overrides:
getAllowableConfigureComponents
in classWidget
-
add
Description copied from class:AbstractConfigurable
Set the owning translatable of this component- Specified by:
add
in interfaceBuildable
- Overrides:
add
in classAbstractConfigurable
-
remove
Description copied from class:AbstractConfigurable
Remove a Buildable object from this object- Specified by:
remove
in interfaceConfigurable
- Overrides:
remove
in classAbstractConfigurable
-
getId
Each instanceof PieceWindow has a unique String identifier- Specified by:
getId
in interfaceUniqueIdManager.Identifyable
- Returns:
- the identifier for this PieceWindow
-
setId
Each instanceof PieceWindow has a unique String identifier- Specified by:
setId
in interfaceUniqueIdManager.Identifyable
-
addTo
Expects to be added to aGameModule
. When added, sets the containing window to visible -
removeFrom
Description copied from interface:Configurable
Remove this component from its parent- Specified by:
removeFrom
in interfaceConfigurable
- Overrides:
removeFrom
in classWidget
-
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 interfaceAutoConfigurable
- Specified by:
getAttributeDescriptions
in classAbstractConfigurable
- 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
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 ofAutoConfigurer
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 inAbstractBuildable.getAttributeNames()
- Specified by:
getAttributeTypes
in interfaceAutoConfigurable
- Specified by:
getAttributeTypes
in classAbstractConfigurable
-
getAttributeNames
Description copied from class:AbstractBuildable
Lists all the buildFile (XML) attribute names for this component. If this component is ALSO anAbstractConfigurable
, then this list of attributes determines the appropriate attribute order forAbstractConfigurable.getAttributeDescriptions()
andAbstractConfigurable.getAttributeTypes()
.- Specified by:
getAttributeNames
in interfaceAutoConfigurable
- Specified by:
getAttributeNames
in classAbstractBuildable
- Returns:
- a list of all buildFile (XML) attribute names for this component
-
setAttribute
Description copied from class:AbstractBuildable
Sets a buildFile (XML) attribute value for this component. Thekey
parameter will be one of those listed inAbstractBuildable.getAttributeNames()
. If thevalue
parameter is a String, it will be the value returned byAbstractBuildable.getAttributeValueString(java.lang.String)
for the samekey
. If the implementing class extendsAbstractConfigurable
, thenvalue
will be an instance of the corresponding Class listed inAbstractConfigurable.getAttributeTypes()
- Specified by:
setAttribute
in interfaceAutoConfigurable
- Specified by:
setAttribute
in interfaceTranslatable
- Specified by:
setAttribute
in classAbstractBuildable
- Parameters:
name
- the name of the attribute. Will be one of those listed inAbstractBuildable.getAttributeNames()
value
- If thevalue
parameter is a String, it will be the value returned byAbstractBuildable.getAttributeValueString(java.lang.String)
for the samekey
. If the implementing class extendsAbstractConfigurable
, thenvalue
can also be an instance of the corresponding Class listed inAbstractConfigurable.getAttributeTypes()
-
getAttributeValueString
Description copied from interface:AutoConfigurable
Called by theBuildable.getBuildElement(org.w3c.dom.Document)
method to write the attributes into an XML element- Specified by:
getAttributeValueString
in interfaceAutoConfigurable
- Specified by:
getAttributeValueString
in interfaceTranslatable
- Specified by:
getAttributeValueString
in classAbstractBuildable
- Parameters:
name
- the name of the attribute. Will be one of those listed inAbstractBuildable.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)
.
-