Package VASSAL.i18n
Interface Translatable
- All Superinterfaces:
Buildable
- All Known Subinterfaces:
AutoConfigurable
,Configurable
- All Known Implementing Classes:
AboutScreen
,AbstractConfigurable
,AbstractDeckKeyCommand
,AbstractFolder
,AbstractScenarioProperty
,AbstractScript
,AbstractToolbarItem
,ActionScript
,BasicModule
,BasicPreference
,Board
,BoardPicker
,BooleanPreference
,BooleanScenarioProperty
,BoxWidget
,BrowserHelpFile
,BrowserHelpFile.ConfigSupport
,BrowserPDFFile
,BshPlugin
,CardSlot
,ChangePropertyButton
,Chart
,ChartWindow
,ChessClock
,ChessClockControl
,ColorManager
,ColorSwatch
,CounterDetailViewer
,CounterTurnLevel
,DeckGlobalKeyCommand
,DeckSendKeyCommand
,DeckSortKeyCommand
,DeckSubFolder
,DiceButton
,DieManager
,DoActionButton
,Documentation
,DoublePreference
,DrawPile
,EnumPreference
,Flare
,FontManager
,FontStyle
,GameModule
,GamePieceImage
,GamePieceImageDefinitions
,GamePieceLayout
,GamePieceLayoutsContainer
,GeneralScript
,GlobalKeyCommand
,GlobalMap
,GlobalMap.CounterViewer
,GlobalOptions
,GlobalProperties
,GlobalProperty
,GlobalPropertyFolder
,GlobalTranslatableMessage
,GlobalTranslatableMessages
,HandMetrics
,HelpFile
,HexGrid
,HexGridNumbering
,HidePiecesButton
,HighlightLastMoved
,HtmlChart
,IconFamily
,ImageItem
,ImageItemInstance
,ImageSaver
,IntegerPreference
,InternetDiceButton
,Inventory
,Item
,ItemInstance
,Language
,LayerControl
,LayeredPieceCollection
,ListScenarioProperty
,ListTurnLevel
,ListWidget
,Localization
,LOS_Thread
,Map
,MapShader
,MapSubFolder
,MapWidget
,MassKeyCommand
,ModuleSubFolder
,MoveCameraButton
,MultiActionButton
,NotesWindow
,NumberScenarioProperty
,PanelWidget
,PieceRecenterer
,PieceSlot
,PieceWindow
,PlayerHand
,PlayerRoster
,Plugin
,PredefinedSetup
,PrivateMap
,PrototypeDefinition
,PrototypeFolder
,PrototypesContainer
,RandomTextButton
,Region
,RegionGrid
,RegularGridNumbering
,ScenarioPropertiesOptionTab
,ScriptContainer
,SelectionHighlighter
,SelectionHighlighters
,SetupStack
,ShapeItem
,ShapeItemInstance
,SpecialDiceButton
,SpecialDie
,SpecialDieFace
,SquareGrid
,SquareGridNumbering
,StackMetrics
,StartupGlobalKeyCommand
,StringPreference
,StringScenarioProperty
,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
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 TypeMethodDescriptionvoid
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, isMandatory, isMovable, isUnique
-
Method Details
-
getI18nData
ComponentI18nData getI18nData() -
getAttributeValueString
- Parameters:
key
- the name of the attribute. If the implementing class extendsAbstractConfigurable
, 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
setAttribute(java.lang.String, java.lang.Object)
.
-
setAttribute
Sets a buildFile (XML) attribute value for this component.- Parameters:
key
- the name of the attribute. If the implementing class extendsAbstractConfigurable
, will be one of those listed inAbstractBuildable.getAttributeNames()
.value
- If thevalue
parameter is a String, it will be the value returned bygetAttributeValueString(java.lang.String)
for the samekey
. If the implementing class extendsAbstractConfigurable
, thenvalue
can also be an instance of the corresponding Class listed inAbstractConfigurable.getAttributeTypes()
-