Package VASSAL.build.module.properties

Interface TranslatableStringContainer

All Known Implementing Classes:

BasicModule, GameModule, GlobalTranslatableMessages, TranslatableStringContainer.Impl

public interface TranslatableStringContainer

A component that can contain mutable (updatable) properties

Author:

rkinney

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TranslatableStringContainer.Impl	Simple implementation of TranslatableStringContainer

Method Summary

Modifier and Type	Method	Description
void	addTranslatableString(String key, TranslatableString p)	Add a property under the given key
TranslatableString	getTranslatableString(String propertyName)	Find an object with the given name
String	getTranslatableStringContainerId()	Return a unique Id for the container
TranslatableString	removeTranslatableString(String key)	Remove the property with the given key

Method Details

addTranslatableString

void addTranslatableString(String key,
TranslatableString p)

Add a property under the given key

Parameters:

key - key

p - property

removeTranslatableString

TranslatableString removeTranslatableString(String key)

Remove the property with the given key

Parameters:

key - key

getTranslatableString

TranslatableString getTranslatableString(String propertyName)

Find an object with the given name

getTranslatableStringContainerId

String getTranslatableStringContainerId()

Return a unique Id for the container