Package VASSAL.i18n

Interface Translatable

All Superinterfaces:

Buildable

All Known Subinterfaces:

AutoConfigurable, Configurable

All Known Implementing Classes:

AboutScreen, AbstractConfigurable, AbstractScript, AbstractToolbarItem, ActionScript, BasicModule, BasicPreference, Board, BoardPicker, BooleanPreference, BoxWidget, BrowserHelpFile, BrowserHelpFile.ConfigSupport, BrowserPDFFile, BshPlugin, CardSlot, ChangePropertyButton, Chart, ChartWindow, ChessClock, ChessClockControl, ColorManager, ColorSwatch, CounterDetailViewer, CounterTurnLevel, DeckGlobalKeyCommand, DiceButton, DieManager, DoActionButton, Documentation, DoublePreference, DrawPile, EnumPreference, Flare, FontManager, FontStyle, GameModule, GamePieceImage, GamePieceImageDefinitions, GamePieceLayout, GamePieceLayoutsContainer, GeneralScript, GlobalKeyCommand, GlobalMap, GlobalMap.CounterViewer, GlobalOptions, GlobalProperties, GlobalProperty, GlobalTranslatableMessage, GlobalTranslatableMessages, 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 Translatable
extends Buildable

Defines VASSAL's standard interface for getting and setting XML (buildFile) attributes, as well as attendant i18n translatable field infrastructure. Components which have any translatable fields, or have any Translatable children, must implement Translatable.

Method Summary

Modifier and Type	Method	Description
String	getAttributeValueString(String key)
ComponentI18nData	getI18nData()
void	setAttribute(String key, Object value)	Sets a buildFile (XML) attribute value for this component.

Methods inherited from interface VASSAL.build.Buildable

add, addTo, build, getBuildElement

Method Details

getI18nData

ComponentI18nData getI18nData()

getAttributeValueString

String getAttributeValueString(String key)

Parameters:

key - the name of the attribute. If the implementing class extends AbstractConfigurable, 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 setAttribute(java.lang.String, java.lang.Object).

setAttribute

void setAttribute(String key,
 Object value)

Sets a buildFile (XML) attribute value for this component.

Parameters:

key - the name of the attribute. If the implementing class extends AbstractConfigurable, will be one of those listed in AbstractBuildable.getAttributeNames().

value - If the value parameter is a String, it will be the value returned by 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()