jhelp.util.resources

Class ResourceText

java.lang.Object

jhelp.util.resources.ResourceText

public final class ResourceText
extends java.lang.Object

Represents a resources of texts.
Texts are describes in XML.
Must have an XML per language, and a generic XML (by default). Each XML are : The markup "Text" defines an association to a "key" with some text. The parameter "key" specify the text key. The text between opening and closing markup "Text" is the corresponding text in the specific language.

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Hashtable<java.lang.String,java.lang.String>	keysText Hash map of key, text
private java.util.Locale	locale Actual locale
private Resources	resources Resources reference
private java.util.ArrayList<ResourceTextListener>	resourceTextListeners List of listener to alert in language change
private static java.lang.String	XML XML extension
private java.lang.String	xmlReferencePathHeader Path of default XML, without .xml

Constructor Summary

Constructors

Constructor and Description
ResourceText(Resources resources, java.lang.String xmlReferencePathHeader) Create a new instance of ResourceText

Method Summary

Methods

Modifier and Type	Method and Description
private void	fillKeysText(java.lang.String path) Fill the hash map of key, text with the content of given resource
java.util.Locale	getLocale() Actual locale
java.lang.String	getText(java.lang.String key) Obtain a text
java.lang.String	getXmlReferencePathHeader() Path of default XML, without .xml
void	register(ResourceTextListener resourceTextListener) Register a listener to be alert when language change
void	setLocale(java.util.Locale locale) Change the language
void	unregister(ResourceTextListener resourceTextListener) Unregister a listener to be no more alert when language change

Methods inherited from class java.lang.Object

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

Field Detail

XML

private static final java.lang.String XML

XML extension

See Also:

Constant Field Values

keysText

private final java.util.Hashtable<java.lang.String,java.lang.String> keysText

Hash map of key, text

locale

private java.util.Locale locale

Actual locale

resources

private final Resources resources

Resources reference

resourceTextListeners

private final java.util.ArrayList<ResourceTextListener> resourceTextListeners

List of listener to alert in language change

xmlReferencePathHeader

private final java.lang.String xmlReferencePathHeader

Path of default XML, without .xml

Constructor Detail

ResourceText

ResourceText(Resources resources,
            java.lang.String xmlReferencePathHeader)

Create a new instance of ResourceText

Parameters:

resources - Resources reference

xmlReferencePathHeader - Path of default XML, without .xml

Method Detail

fillKeysText

private void fillKeysText(java.lang.String path)

Fill the hash map of key, text with the content of given resource

Parameters:

path - Resource to parse

getLocale

public java.util.Locale getLocale()

Actual locale

Returns:

Actual locale

getText

public java.lang.String getText(java.lang.String key)

Obtain a text

Parameters:

key - Text key

Returns:

Text itself

getXmlReferencePathHeader

public java.lang.String getXmlReferencePathHeader()

Path of default XML, without .xml

Returns:

Path of default XML, without .xml

register

public void register(ResourceTextListener resourceTextListener)

Register a listener to be alert when language change

Parameters:

resourceTextListener - Listener to register

setLocale

public void setLocale(java.util.Locale locale)

Change the language

Parameters:

locale - New language

unregister

public void unregister(ResourceTextListener resourceTextListener)

Unregister a listener to be no more alert when language change

Parameters:

resourceTextListener - Listener to unregister