Class TranslatingStringEnumConfigurer

java.lang.Object

VASSAL.configure.Configurer

VASSAL.configure.TranslatingStringEnumConfigurer

public class TranslatingStringEnumConfigurer
extends Configurer

A Configurer that allows a user to select from an underlying list of values, based on a translatable list of descriptions of those values. Drop-in replacement for StringEnumConfigurer that allows a set of translation keys to be supplied to specify the drop-down values

Nested Class Summary

Nested classes/interfaces inherited from class Configurer

Configurer.ContextLevel

Modifier and Type	Class	Description
static enum	Configurer.ContextLevel	The ContextLevel of a Configurer defines the level that it is defined at.

Field Summary

Fields inherited from class Configurer

changeSupport, context, contextLevel, frozen, hint, key, LIST_ENTRY_HIGHLIGHT_COLOR, name, NAME_PROPERTY, noUpdate, value

Modifier and Type	Field	Description
protected PropertyChangeSupport	changeSupport
protected AbstractBuildable	context
protected Configurer.ContextLevel	contextLevel
protected boolean	frozen	When frozen is true, setting the value programmatically will not result in a PropertyChangeEvent being fired
protected String	hint	A Hint to be displayed in an empty field
protected String	key	A String the uniquely identifies this property
static final Color	LIST_ENTRY_HIGHLIGHT_COLOR	Default Highlight Color for Configurable Lists
protected String	name	A String that provides a short description of the property to the user
static final String	NAME_PROPERTY
protected boolean	noUpdate	When noUpdate is true, setting the value programmatically will not result in an update of the GUI Component
protected Object	value	The value

Constructor Summary

Constructors

Constructor	Description
TranslatingStringEnumConfigurer(String[] validValues, String[] i18nKeys)	Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.
TranslatingStringEnumConfigurer(String[] validValues, String[] i18nKeys, boolean isDisplayNames)
TranslatingStringEnumConfigurer(String[] validValues, String[] i18nKeys, char initialValue)	Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.
TranslatingStringEnumConfigurer(String[] validValues, String[] i18nKeys, String initialValue)	Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.
TranslatingStringEnumConfigurer(String key, String name, String[] validValues, String[] i18nKeys)	Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.
TranslatingStringEnumConfigurer(String key, String name, String[] validValues, String[] i18nKeys, boolean isDisplayNames)	Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.
TranslatingStringEnumConfigurer(String key, String name, String[] validValues, String[] i18nKeys, char initialValue)	Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.
TranslatingStringEnumConfigurer(String key, String name, String[] validValues, String[] i18nKeys, String initialValue)	Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.
TranslatingStringEnumConfigurer(String key, String name, String[] validValues, String[] i18nKeys, String initialValue, boolean isDisplayNames)	Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.
TranslatingStringEnumConfigurer(String key, String name, List<String> validValues, List<String> i18nKeys)	Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.
TranslatingStringEnumConfigurer(String key, String name, List<String> validValues, List<String> i18nKeys, boolean isDisplayNames)	Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.
TranslatingStringEnumConfigurer(String key, String name, List<String> validValues, List<String> i18nKeys, String initialValue)	Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.
TranslatingStringEnumConfigurer(String key, String name, List<String> validValues, List<String> i18nKeys, String initialValue, boolean isDisplayNames)	Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.
TranslatingStringEnumConfigurer(List<String> validValues, List<String> i18nKeys)	Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.
TranslatingStringEnumConfigurer(List<String> validValues, List<String> i18nKeys, String initialValue)	Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.

Method Summary

Modifier and Type	Method	Description
Component	getControls()	Get the Controls that make up this Configurer
int	getSelectedIndex()
String[]	getValidValues()	Return the array of valid underlying values.
int	getValueIndex(Object o)	Return the index of the supplied value in the list of allowed values.
String	getValueString()	Return the underlying value stored in the Configurer
boolean	isDisplayNames()
boolean	isValidValue(Object o)	Test if a supplied value is one of the underlying 'real' valued managed by the Configurer
void	setDisplayNames(boolean isDisplayNames)
void	setEditable(boolean editable)	Set whether or not the value showing in the Configurer can be changed by a user
void	setEnabled(boolean enabled)	Set the enabled status of the Configurer controls
void	setLabelVisible(boolean visible)	Show/Hide the internal label maintained by this Configurer.
void	setValidValues(String[] values, String[] keys)
void	setValue(Object o)	Set a value into the configurer If the value is one of the list of allowable values, then set the core value and update the drop-down list to show the corresponding translation.
void	setValue(String s)	Set the value stored in the Configurer.

Methods inherited from class Configurer

addFocusListener, addPropertyChangeListener, fireUpdate, getContext, getContextLevel, getHint, getKey, getName, getScreenSize, getValue, initCustomControls, isFrozen, isHighlighted, isPieceContext, removeFocusListener, removePropertyChangeListener, repack, repack, requestFocus, setContext, setContext, setContext, setContextLevel, setFrozen, setHighlighted, setHint, setHintKey, setLabelVisibile, setName

Modifier and Type	Method	Description
void	addFocusListener(FocusListener listener)	Add a FocusListener to the Swing Components that make up this Configurer.
void	addPropertyChangeListener(PropertyChangeListener l)	Add a listener to be notified when the Object state changes
void	fireUpdate()	Fire a PropertyChangeEvent as if the value had been set from null
AbstractBuildable	getContext()	Get the Context for this Configurer
Configurer.ContextLevel	getContextLevel()
String	getHint()	Return the current hint String
String	getKey()	Unique identifier
String	getName()	Plain English description of the Object
protected Dimension	getScreenSize()	Return the current screen size for use by List type configurers to allow them to take up maximum screen real estate if needed.
Object	getValue()	The Object value May be null if the Object has not been initialized
void	initCustomControls(JDialog d, Configurable target)	Initialize any custom controls / keystrokes
boolean	isFrozen()
boolean	isHighlighted()	Return the current highlighted status
boolean	isPieceContext()
void	removeFocusListener(FocusListener listener)	Remove a FocusListener from the Swing Components that make up this Configurer.
void	removePropertyChangeListener(PropertyChangeListener l)
protected void	repack()	Repack the current configurer
protected void	repack(Component controls)	Repack a dialog or window
void	requestFocus()	Move the cursor to the first input field of this Configurer
void	setContext(AbstractBuildable context)	Set the Context for this Configurer to the first ancestor that is of type GameModule or Map NOTE: The ContextLevel may already have been preset by the ConfigureFactory when the Configurer was created.
void	setContext(Buildable context)
void	setContext(Configurable context)
void	setContextLevel(Configurer.ContextLevel contextLevel)
void	setFrozen(boolean val)	If true, then don't fire PropertyChangeEvents when the value is reset
void	setHighlighted(boolean highlighted)	Set the highlighted status of this configurer.
void	setHint(String hint)	Set the Hint String
void	setHintKey(String hintKey)	Set the Hint String via a I18n key
void	setLabelVisibile(boolean visible)	Deprecated, for removal: This API element is subject to removal in a future version. Use Configurer.setLabelVisible(boolean) instead.
void	setName(String s)

Methods inherited from class Object

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

Constructor Details

TranslatingStringEnumConfigurer

public TranslatingStringEnumConfigurer(String key,
 String name,
 String[] validValues,
 String[] i18nKeys)

Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.

Parameters:

key - Configurer Key

name - Configurer Name

validValues - Array of values to maintain

i18nKeys - Array of Translation Keys used to describe the list of values

TranslatingStringEnumConfigurer

public TranslatingStringEnumConfigurer(String[] validValues,
 String[] i18nKeys)

Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.

Parameters:

validValues - Array of values to maintain

i18nKeys - Array of Translation Keys used to describe the list of values

TranslatingStringEnumConfigurer

public TranslatingStringEnumConfigurer(String[] validValues,
 String[] i18nKeys,
 boolean isDisplayNames)

TranslatingStringEnumConfigurer

public TranslatingStringEnumConfigurer(String key,
 String name,
 String[] validValues,
 String[] i18nKeys,
 boolean isDisplayNames)

Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.

Parameters:

key - Configurer Key

name - Configurer Name

validValues - Array of values to maintain

i18nKeys - Array of Translation Keys used to describe the list of values

isDisplayNames - True if we have already been given full translated strings; false if they are "keys" for Resources.getString()

TranslatingStringEnumConfigurer

public TranslatingStringEnumConfigurer(String key,
 String name,
 List<String> validValues,
 List<String> i18nKeys)

Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.

Parameters:

key - Configurer Key

name - Configurer Name

validValues - List of values to maintain

i18nKeys - List of Translation Keys used to describe the list of values

TranslatingStringEnumConfigurer

public TranslatingStringEnumConfigurer(List<String> validValues,
 List<String> i18nKeys)

Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.

Parameters:

validValues - List of values to maintain

i18nKeys - List of Translation Keys used to describe the list of values

TranslatingStringEnumConfigurer

public TranslatingStringEnumConfigurer(String key,
 String name,
 List<String> validValues,
 List<String> i18nKeys,
 boolean isDisplayNames)

Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.

Parameters:

key - Configurer Key

name - Configurer Name

validValues - List of values to maintain

i18nKeys - List of Translation Keys used to describe the list of values

isDisplayNames - True if we have already been given full translated strings; false if they are "keys" for Resources.getString()

TranslatingStringEnumConfigurer

public TranslatingStringEnumConfigurer(String key,
 String name,
 String[] validValues,
 String[] i18nKeys,
 String initialValue)

Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.

Parameters:

key - Configurer Key

name - Configurer Name

validValues - Array of values to maintain

i18nKeys - Array of Translation Keys used to describe the list of values

initialValue - Initial Value to set in the Configurer.

TranslatingStringEnumConfigurer

public TranslatingStringEnumConfigurer(String key,
 String name,
 String[] validValues,
 String[] i18nKeys,
 char initialValue)

Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.

Parameters:

key - Configurer Key

name - Configurer Name

validValues - List of values to maintain

i18nKeys - List of Translation Keys used to describe the list of values

initialValue - Initial Value to set in the Configurer.

TranslatingStringEnumConfigurer

public TranslatingStringEnumConfigurer(String[] validValues,
 String[] i18nKeys,
 String initialValue)

Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.

Parameters:

validValues - Array of values to maintain

i18nKeys - Array of Translation Keys used to describe the list of values

initialValue - Initial Value to set in the Configurer.

TranslatingStringEnumConfigurer

public TranslatingStringEnumConfigurer(String[] validValues,
 String[] i18nKeys,
 char initialValue)

Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.

Parameters:

validValues - List of values to maintain

i18nKeys - List of Translation Keys used to describe the list of values

initialValue - Initial Value to set in the Configurer.

TranslatingStringEnumConfigurer

public TranslatingStringEnumConfigurer(String key,
 String name,
 String[] validValues,
 String[] i18nKeys,
 String initialValue,
 boolean isDisplayNames)

Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.

Parameters:

key - Configurer Key

name - Configurer Name

validValues - Array of values to maintain

i18nKeys - Array of Translation Keys used to describe the list of values

initialValue - Initial Value to set in the Configurer.

isDisplayNames - True if we have already been given full translated strings; false if they are "keys" for Resources.getString()

TranslatingStringEnumConfigurer

public TranslatingStringEnumConfigurer(String key,
 String name,
 List<String> validValues,
 List<String> i18nKeys,
 String initialValue)

Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.

Parameters:

key - Configurer Key

name - Configurer Name

validValues - List of values to maintain

i18nKeys - List of Translation Keys used to describe the list of values

initialValue - Initial Value to set in the Configurer.

TranslatingStringEnumConfigurer

public TranslatingStringEnumConfigurer(List<String> validValues,
 List<String> i18nKeys,
 String initialValue)

Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.

Parameters:

validValues - List of values to maintain

i18nKeys - List of Translation Keys used to describe the list of values

initialValue - Initial Value to set in the Configurer.

TranslatingStringEnumConfigurer

public TranslatingStringEnumConfigurer(String key,
 String name,
 List<String> validValues,
 List<String> i18nKeys,
 String initialValue,
 boolean isDisplayNames)

Create a drop-list of localised display values that allows you to select a value from an underlying list of 'internal' untranslated values.

Parameters:

key - Configurer Key

name - Configurer Name

validValues - List of values to maintain

i18nKeys - List of Translation Keys used to describe the list of values

initialValue - Initial Value to set in the Configurer.

isDisplayNames - True if we have already been given full translated strings; false if they are "keys" for Resources.getString()

Method Details

isDisplayNames

public boolean isDisplayNames()

Returns:

true if our "keys" are actually already translated strings; false if they are really keys

setDisplayNames

public void setDisplayNames(boolean isDisplayNames)

Parameters:

isDisplayNames - true if our "keys" are actually already translated strings; false if they are really keys

getControls

public Component getControls()

Get the Controls that make up this Configurer

Specified by:

getControls in class Configurer

Returns:

A swing Component that holds all of the Configurer controls

getSelectedIndex

public int getSelectedIndex()

setEnabled

public void setEnabled(boolean enabled)

Set the enabled status of the Configurer controls

Overrides:

setEnabled in class Configurer

Parameters:

enabled - set the Enabled status of the Configurer

setEditable

public void setEditable(boolean editable)

Set whether or not the value showing in the Configurer can be changed by a user

Parameters:

editable - Set the Editable status of the Configurer

isValidValue

public boolean isValidValue(Object o)

Test if a supplied value is one of the underlying 'real' valued managed by the Configurer

Parameters:

o - Value to test

Returns:

true if the supplied Object is one of the allowed values

getValueIndex

public int getValueIndex(Object o)

Return the index of the supplied value in the list of allowed values. Return 0 if the supplied value is not found so that the Configurer will display the first valid value by default

Parameters:

o - Value to look for

Returns:

The index of the value, or 0 (i.e. first) if not found

getValidValues

public String[] getValidValues()

Return the array of valid underlying values.

Returns:

Array of underlying values.

setValidValues

public void setValidValues(String[] values,
 String[] keys)

setValue

public void setValue(Object o)

Set a value into the configurer If the value is one of the list of allowable values, then set the core value and update the drop-down list to show the corresponding translation.

Overrides:

setValue in class Configurer

Parameters:

o - Value to set

getValueString

public String getValueString()

Return the underlying value stored in the Configurer

Specified by:

getValueString in class Configurer

Returns:

stored value

setValue

public void setValue(String s)

Set the value stored in the Configurer. Note that the value must be one of the valid allowed values.

Specified by:

setValue in class Configurer

Parameters:

s - Value to store as Configurer value

setLabelVisible

public void setLabelVisible(boolean visible)

Description copied from class: Configurer

Show/Hide the internal label maintained by this Configurer. It is up to individual Configurers to track and hide the label (if they can). This method is currently only utilized by the Preference configs PrefsEditor.addOption(String, Configurer) to extract an existing label in a configurer, display correctly aligned and suppress the original label. This keeps compatibility with custom module code setting up preferences. This method only needs to be implemented in Configurers that are added as preferences.

Overrides:

setLabelVisible in class Configurer

Parameters:

visible - Hide label if true