Package VASSAL.build

Interface Configurable

All Superinterfaces:

Buildable, Translatable

All Known Subinterfaces:

AutoConfigurable

All Known Implementing Classes:

AboutScreen, AbstractConfigurable, AbstractScript, ActionScript, BasicModule, BasicPreference, Board, BoardPicker, BooleanPreference, BoxWidget, BrowserHelpFile, BrowserHelpFile.ConfigSupport, BshPlugin, CardSlot, ChangePropertyButton, Chart, ChartWindow, ColorManager, ColorSwatch, CounterDetailViewer, CounterTurnLevel, DeckGlobalKeyCommand, DiceButton, DieManager, DoActionButton, Documentation, DoublePreference, DrawPile, EnumPreference, FontManager, FontStyle, GameModule, GamePieceImage, GamePieceImageDefinitions, GamePieceLayout, GamePieceLayoutsContainer, GeneralScript, GlobalKeyCommand, GlobalMap, GlobalMap.CounterViewer, GlobalOptions, GlobalProperties, GlobalProperty, HandMetrics, HelpFile, HexGrid, HexGridNumbering, HidePiecesButton, HighlightLastMoved, HtmlChart, IconFamily, ImageItem, ImageItemInstance, ImageSaver, IntegerPreference, InternetDiceButton, Inventory, Item, ItemInstance, Language, LayerControl, LayeredPieceCollection, ListTurnLevel, ListWidget, Localization, LOS_Thread, Map, MapShader, MapWidget, MassKeyCommand, MultiActionButton, NotesWindow, PanelWidget, PieceRecenterer, PieceSlot, PieceWindow, PlayerHand, PlayerRoster, Plugin, PredefinedSetup, PrivateMap, PrototypeDefinition, PrototypesContainer, RandomTextButton, Region, RegionGrid, RegularGridNumbering, ScriptContainer, SelectionHighlighter, SelectionHighlighters, SetupStack, ShapeItem, ShapeItemInstance, SpecialDiceButton, SpecialDie, SpecialDieFace, SquareGrid, SquareGridNumbering, StackMetrics, StartupGlobalKeyCommand, StringPreference, SymbolItem, SymbolItemInstance, TabWidget, TextBoxItem, TextBoxItemInstance, TextItem, TextItemInstance, TextPreference, TextSaver, ToolbarMenu, TranslatableMarker, Translation, TurnComponent, TurnGlobalHotkey, TurnLevel, TurnTracker, Tutorial, VassalTranslation, Widget, WidgetMap, Zone, ZonedGrid, ZonedGridHighlighter, ZoneHighlight, ZoneProperty, Zoomer

public interface Configurable
extends Translatable

An object that implements the Configurable interface can, in addition to being built from a configuration XML file, be manipulated by the user directly in the VASSAL module editor via the Configuration window.

Field Summary

Fields

Modifier and Type	Field	Description
static String	NAME_PROPERTY

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangeListener(PropertyChangeListener l)	Add a PropertyChangeListener.
Class[]	getAllowableConfigureComponents()	Return a list of valid sub-component Classes.
Configurable[]	getConfigureComponents()
String	getConfigureName()	The name of this Configurable Object
Configurer	getConfigurer()	Return a Configurer object which can be used to set the attributes of this object
HelpFile	getHelpFile()
void	remove(Buildable child)	Remove a child component
void	removeFrom(Buildable parent)	Remove this component from its parent

Methods inherited from interface VASSAL.build.Buildable

add, addTo, build, getBuildElement

Methods inherited from interface VASSAL.i18n.Translatable

getAttributeValueString, getI18nData, setAttribute

Field Details

NAME_PROPERTY

static final String NAME_PROPERTY

See Also:

Constant Field Values

Method Details

removeFrom

void removeFrom(Buildable parent)

Remove this component from its parent

remove

void remove(Buildable child)

Remove a child component

getConfigureName

String getConfigureName()

The name of this Configurable Object

getHelpFile

HelpFile getHelpFile()

Returns:

a HelpFilte describing how to use and configure this component

getConfigureComponents

Configurable[] getConfigureComponents()

Returns:

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

getConfigurer

Configurer getConfigurer()

Return a Configurer object which can be used to set the attributes of this object

getAllowableConfigureComponents

Class[] getAllowableConfigureComponents()

Return 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 Configuration Window.

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener l)

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