Package VASSAL.i18n

Class Resources

java.lang.Object

VASSAL.i18n.Resources

public class Resources
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Resources.VassalPropertyClassLoader	Custom Class Loader for loading VASSAL property files.

Field Summary

Fields

Modifier and Type	Field	Description
static String	ADD
protected static String	BASE_BUNDLE
static String	BUTTON_ICON
static String	BUTTON_TEXT
static String	CANCEL
static String	CLOSE
static String	COLOR_LABEL
static String	COMMAND_NAME_LABEL
static String	DATE_DISPLAY
protected static String	DATE_FORMAT
static String	DESCRIPTION
static String	EDIT
protected static String	EDITOR_BUNDLE
static String	EDITOR_PREFIX
protected BundleHelper	editorBundle
protected static String	EN_BUNDLE
static String	FILE
static String	HELP
static String	HORIZONTAL_OFFSET_LABEL
static String	HOTKEY_LABEL
static String	INSERT
static String	KEYBOARD_COMMAND_LABEL
static String	LOAD
protected Locale	locale
static String	LOCALE_PREF_KEY	Preferences key for the user's Locale
static String	MENU
static String	MENU_COMMAND_LABEL
protected static String	MODULE_BUNDLE
static String	NAME_FORMAT_LABEL
static String	NAME_LABEL
static String	NEW
static String	NEXT
static String	NO
static String	OK
static String	QUIT
static String	REFRESH
static String	REMOVE
static String	REPORT_FORMAT_LABEL
static String	SAVE
static String	SELECT
protected List<Locale>	supportedLocales
static String	TOOLS
static String	TOOLTIP_TEXT
static String	VALUE_LABEL
static String	VASSAL
protected static String	VASSAL_BUNDLE
protected BundleHelper	vassalBundle
static String	VERTICAL_OFFSET_LABEL
static String	YES

Method Summary

Modifier and Type	Method	Description
static void	addSupportedLocale(Locale l)
static String	formatDate(Date date)	Return a standard formatted localised date
protected BundleHelper	getBundleForKey(String id)
protected BundleHelper	getEditorBundle()
Collection<String>	getEditorKeys()
static String	getEditorString(String id)	Deprecated, for removal: This API element is subject to removal in a future version. Use getString(String, Object...) Instead
static Locale	getLocale()
static String	getString(String id)	getString Return a translated string for the specified key, using the current language bundles
static String	getString(String id, Object... params)	getString Return a translated string for the specified key, using the current language bundles
static String	getString(ResourceBundle bundle, String id)	Deprecated, for removal: This API element is subject to removal in a future version. Use getString(String, Object...) Instead
static Collection<Locale>	getSupportedLocales()
protected BundleHelper	getVassalBundle()
static Collection<String>	getVassalKeys()
static String	getVassalString(String id)	Deprecated, for removal: This API element is subject to removal in a future version. Use getString(String, Object...) Instead
static void	setLocale(Locale l)

Methods inherited from class java.lang.Object

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

Field Details

VASSAL

public static final String VASSAL

See Also:

Constant Field Values

VASSAL_BUNDLE

protected static final String VASSAL_BUNDLE

See Also:

Constant Field Values

EDITOR_BUNDLE

protected static final String EDITOR_BUNDLE

See Also:

Constant Field Values

BASE_BUNDLE

protected static final String BASE_BUNDLE

See Also:

Constant Field Values

EN_BUNDLE

protected static final String EN_BUNDLE

See Also:

Constant Field Values

vassalBundle

protected BundleHelper vassalBundle

editorBundle

protected BundleHelper editorBundle

LOCALE_PREF_KEY

public static final String LOCALE_PREF_KEY

Preferences key for the user's Locale

See Also:

Constant Field Values

supportedLocales

protected final List<Locale> supportedLocales

locale

protected Locale locale

DATE_FORMAT

protected static final String DATE_FORMAT

See Also:

Constant Field Values

MODULE_BUNDLE

protected static final String MODULE_BUNDLE

See Also:

Constant Field Values

ADD

public static final String ADD

See Also:

Constant Field Values

REMOVE

public static final String REMOVE

See Also:

Constant Field Values

INSERT

public static final String INSERT

See Also:

Constant Field Values

YES

public static final String YES

See Also:

Constant Field Values

NO

public static final String NO

See Also:

Constant Field Values

CANCEL

public static final String CANCEL

See Also:

Constant Field Values

SAVE

public static final String SAVE

See Also:

Constant Field Values

OK

public static final String OK

See Also:

Constant Field Values

MENU

public static final String MENU

See Also:

Constant Field Values

LOAD

public static final String LOAD

See Also:

Constant Field Values

QUIT

public static final String QUIT

See Also:

Constant Field Values

EDIT

public static final String EDIT

See Also:

Constant Field Values

NEW

public static final String NEW

See Also:

Constant Field Values

FILE

public static final String FILE

See Also:

Constant Field Values

TOOLS

public static final String TOOLS

See Also:

Constant Field Values

HELP

public static final String HELP

See Also:

Constant Field Values

CLOSE

public static final String CLOSE

See Also:

Constant Field Values

DATE_DISPLAY

public static final String DATE_DISPLAY

See Also:

Constant Field Values

NEXT

public static final String NEXT

See Also:

Constant Field Values

REFRESH

public static final String REFRESH

See Also:

Constant Field Values

SELECT

public static final String SELECT

See Also:

Constant Field Values

EDITOR_PREFIX

public static final String EDITOR_PREFIX

See Also:

Constant Field Values

BUTTON_TEXT

public static final String BUTTON_TEXT

See Also:

Constant Field Values

TOOLTIP_TEXT

public static final String TOOLTIP_TEXT

See Also:

Constant Field Values

BUTTON_ICON

public static final String BUTTON_ICON

See Also:

Constant Field Values

HOTKEY_LABEL

public static final String HOTKEY_LABEL

See Also:

Constant Field Values

COLOR_LABEL

public static final String COLOR_LABEL

See Also:

Constant Field Values

NAME_LABEL

public static final String NAME_LABEL

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

REPORT_FORMAT_LABEL

public static final String REPORT_FORMAT_LABEL

See Also:

Constant Field Values

COMMAND_NAME_LABEL

public static final String COMMAND_NAME_LABEL

See Also:

Constant Field Values

KEYBOARD_COMMAND_LABEL

public static final String KEYBOARD_COMMAND_LABEL

See Also:

Constant Field Values

NAME_FORMAT_LABEL

public static final String NAME_FORMAT_LABEL

See Also:

Constant Field Values

MENU_COMMAND_LABEL

public static final String MENU_COMMAND_LABEL

See Also:

Constant Field Values

HORIZONTAL_OFFSET_LABEL

public static final String HORIZONTAL_OFFSET_LABEL

See Also:

Constant Field Values

VERTICAL_OFFSET_LABEL

public static final String VERTICAL_OFFSET_LABEL

See Also:

Constant Field Values

VALUE_LABEL

public static final String VALUE_LABEL

See Also:

Constant Field Values

Method Details

getSupportedLocales

public static Collection<Locale> getSupportedLocales()

addSupportedLocale

public static void addSupportedLocale(Locale l)

getVassalKeys

public static Collection<String> getVassalKeys()

getEditorKeys

public Collection<String> getEditorKeys()

getString

public static String getString(String id)

getString Return a translated string for the specified key, using the current language bundles

Parameters:

id - Key of string to translate

Returns:

Translated String

getString

public static String getString(String id,
Object... params)

getString Return a translated string for the specified key, using the current language bundles

Parameters:

id - Key of string to translate

params - Additional parameters that need to be inserted into the string

Returns:

Translated String

getBundleForKey

protected BundleHelper getBundleForKey(String id)

getEditorBundle

protected BundleHelper getEditorBundle()

getVassalBundle

protected BundleHelper getVassalBundle()

getVassalString

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static String getVassalString(String id)

Deprecated, for removal: This API element is subject to removal in a future version.

Use getString(String, Object...) Instead

Localize a VASSAL user interface string

Parameters:

id - String id

Returns:

Localized result

getEditorString

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static String getEditorString(String id)

Deprecated, for removal: This API element is subject to removal in a future version.

Use getString(String, Object...) Instead

Localize a VASSAL Module Editor String

Parameters:

id - String Id

Returns:

Localized Result

getString

@Deprecated(since="2020-08-06",
            forRemoval=true)
public static String getString(ResourceBundle bundle,
String id)

Deprecated, for removal: This API element is subject to removal in a future version.

Use getString(String, Object...) Instead

Localize a string using the supplied resource bundle

Parameters:

bundle - Resource bundle

id - String Id

Returns:

Localized result

setLocale

public static void setLocale(Locale l)

getLocale

public static Locale getLocale()

formatDate

public static String formatDate(Date date)

Return a standard formatted localised date

Parameters:

date - date to format

Returns:

formatted localized date