Package VASSAL.build

Class AbstractConfigurable

java.lang.Object

VASSAL.build.AbstractBuildable

VASSAL.build.AbstractConfigurable

All Implemented Interfaces:

AutoConfigurable, Buildable, Configurable, PropertyNameSource, ValidityChecker, Translatable

Direct Known Subclasses:

AboutScreen, AbstractScript, BasicPreference, Board, ChangePropertyButton, ColorManager, ColorSwatch, CounterDetailViewer, DiceButton, DieManager, DoActionButton, Documentation, FontManager, FontStyle, GameModule, GamePieceImage, GamePieceImageDefinitions, GamePieceLayout, GamePieceLayoutsContainer, GlobalOptions, GlobalProperties, GlobalProperty, HelpFile, HexGrid, HighlightLastMoved, IconFamily, ImageSaver, Inventory, Item, ItemInstance, Language, LayerControl, LayeredPieceCollection, LOS_Thread, Map, MapShader, MassKeyCommand, NotesWindow, PieceRecenterer, PlayerRoster, Plugin, PredefinedSetup, PrototypeDefinition, PrototypesContainer, Region, RegionGrid, RegularGridNumbering, ScriptContainer, SelectionHighlighter, SelectionHighlighters, SetupStack, SpecialDiceButton, SpecialDie, SpecialDieFace, SquareGrid, StackMetrics, TextSaver, ToolbarMenu, TranslatableMarker, Translation, TurnComponent, TurnGlobalHotkey, Tutorial, Widget, Zone, ZonedGrid, ZonedGridHighlighter, ZoneHighlight, Zoomer

public abstract class AbstractConfigurable
extends AbstractBuildable
implements AutoConfigurable

An abstract implementation of the Configurable interface. Takes care of most of the Configurable functionality

Nested Class Summary

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

AutoConfigurable.Util

Field Summary

Fields

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

Fields inherited from class VASSAL.build.AbstractBuildable

buildComponents, validator

Fields inherited from interface VASSAL.build.Configurable

NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
AbstractConfigurable()

Method Summary

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
Configurable[]	getConfigureComponents()
String	getConfigureName()	The name of this Configurable Object
Configurer	getConfigurer()	The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer
ComponentI18nData	getI18nData()	Return the i18n data for this component
protected String	getI18nPrefix()	Generate a standard prefix for i18n keys for attributes of this component - Classname.attributeName
String	getLocalizedConfigureName()
void	remove(Buildable b)	Remove a Buildable object from this object
void	removePropertyChangeListener(PropertyChangeListener l)
protected void	setAllAttributesUntranslatable()
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 VASSAL.build.AbstractBuildable

build, getAllDescendantComponents, getAllDescendantComponentsOf, getAttributeNames, getAttributeValueString, getBuildables, getBuildComponents, getBuildElement, getComponents, getComponentsOf, getPropertyNames, setAttribute, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.build.AutoConfigurable

getAttributeNames, getAttributeValueString, setAttribute

Methods inherited from interface VASSAL.build.Buildable

addTo, build, getBuildElement

Methods inherited from interface VASSAL.build.Configurable

getAllowableConfigureComponents, getHelpFile, removeFrom

Field Details

changeSupport

protected PropertyChangeSupport changeSupport

name

protected String name

localizedName

protected String localizedName

config

protected Configurer config

myI18nData

protected ComponentI18nData myI18nData

Constructor Details

AbstractConfigurable

public AbstractConfigurable()

Method Details

remove

public void remove(Buildable b)

Remove a Buildable object from this object

Specified by:

remove in interface Configurable

getConfigureName

public String getConfigureName()

Description copied from interface: Configurable

The name of this Configurable Object

Specified by:

getConfigureName in interface Configurable

getLocalizedConfigureName

public String getLocalizedConfigureName()

setConfigureName

public void setConfigureName(String s)

Sets the name and fires a PropertyChangeEvent

getAttributeDescriptions

public abstract String[] getAttributeDescriptions()

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

getAttributeTypes

public abstract Class<?>[] getAttributeTypes()

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

getAttributeVisibility

public VisibilityCondition getAttributeVisibility(String name)

By default, all attributes are visible

Specified by:

getAttributeVisibility in interface AutoConfigurable

Parameters:

name -

Returns:

getI18nData

public ComponentI18nData getI18nData()

Return the i18n data for this component

Specified by:

getI18nData in interface Translatable

getI18nPrefix

protected String getI18nPrefix()

Generate a standard prefix for i18n keys for attributes of this component - Classname.attributeName

setAttributeTranslatable

protected void setAttributeTranslatable(String attr, boolean b)

Over-ride the default attribute translatability. This is called by inidivdual components to force specific attributes to be translatable or not translatable

setAllAttributesUntranslatable

protected void setAllAttributesUntranslatable()

add

public void add(Buildable b)

Set the owning translatable of this component

Specified by:

add in interface Buildable

Overrides:

add in class AbstractBuildable

addPropertyChangeListener

public void addPropertyChangeListener(PropertyChangeListener l)

Description copied from interface: Configurable

Add a PropertyChangeListener. A PropertyChangeEvent should be fired with property name Configurable.NAME_PROPERTY when the value returned from Configurable.getConfigureName() has changed

Specified by:

addPropertyChangeListener in interface Configurable

removePropertyChangeListener

public void removePropertyChangeListener(PropertyChangeListener l)

getConfigureComponents

public Configurable[] getConfigureComponents()

Specified by:

getConfigureComponents in interface Configurable

Returns:

an array of Configurer objects representing the Configurable children of this Configurable object

getConfigurer

public Configurer getConfigurer()

The default Configurer of an AbstractConfigurable class is an instance of AutoConfigurer

Specified by:

getConfigurer in interface Configurable