Package VASSAL.configure

Class TranslatableStringEnum

java.lang.Object

VASSAL.configure.StringEnum

VASSAL.configure.TranslatableStringEnum

Direct Known Subclasses:

ChessClock.PlayerSidesConfig, ChessClockControl.TimeStyleConfig, CounterDetailViewer.DisplayConfig, CounterDetailViewer.TerrainConfig, DrawPile.AssignedDeckPrompt, DrawPile.Prompt, DrawPile.Prompt2, Flare.FlareKeyConfig, GamePieceLayout.BorderConfig, Item.LocationConfig, LayerControl.CommandConfig, LOS_Thread.GlobalOptions, LOS_Thread.PersistenceOptions, LOS_Thread.RoundingOptions, MapShader.BoardPrompt, MapShader.PatternPrompt, MapShader.TypePrompt, MassKeyCommand.Prompt, MoveCameraButton.DestConfig, RegularGridNumbering.F, RegularGridNumbering.T, SetupStack.OwningBoardPrompt, ShapeItem.ShapeConfig, StartupGlobalKeyCommand.Prompt, StartupGlobalKeyCommand.SendConfig, SymbolItem.SetConfig, TextItem.TextSource, TurnTracker.LengthStyleConfig, ZoneHighlight.Coverage, ZoneHighlight.Style

public abstract class TranslatableStringEnum
extends StringEnum

Wrapper class for an enumerated type. If an AutoConfigurable object lists an attribute of type TranslatableStringEnum.class, the AutoConfigurer class will build a TranslatingStringEnumConfigurer as that attribute's editor. The AutoConfigurable object should return a sub-class of StringEnum with a no-arg constructor

Constructor Summary

Constructors

Constructor	Description
TranslatableStringEnum()

Method Summary

Modifier and Type	Method	Description
abstract String[]	getI18nKeys(AutoConfigurable target)
boolean	isDisplayNames()

Methods inherited from class VASSAL.configure.StringEnum

getValidValues

Methods inherited from class java.lang.Object

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

Constructor Details

TranslatableStringEnum

public TranslatableStringEnum()

Method Details

getI18nKeys

public abstract String[] getI18nKeys(AutoConfigurable target)

isDisplayNames

public boolean isDisplayNames()

Returns:

true if names have already been translated; false means keys will be passed to Resources.getString()