com.ihr.xbrl.dts

Interface LangsProvider

All Known Implementing Classes:

HTMLReportHandler, LangsProviderBasic, XBRLReportHandler

public interface LangsProvider

Provides an ordered list of language tokens according to the user's preferences.

Author:

Ignacio

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<java.lang.String>	getLangs() The ordered list of preferred languages.
void	setLangs(java.util.Collection<java.lang.String> newCol) Sets the set of languages (replaces current set of labels) .
void	showNewLangsAddedMessage() an application that implements LangsProvider is informed about new languages added to the languages lists by the labels provider.

Method Detail

getLangs

java.util.Iterator<java.lang.String> getLangs()

The ordered list of preferred languages. The first element in the Iterator is the top most preferred user language. The next one is the second best etc...

Note, this method does not considers the languages in resources of the loaded DTS. For that list there is a method in the DTSContainer

Returns:

Collection<String>

setLangs

void setLangs(java.util.Collection<java.lang.String> newCol)

Sets the set of languages (replaces current set of labels) .

Parameters:

newCol - the new langs

showNewLangsAddedMessage

void showNewLangsAddedMessage()

an application that implements LangsProvider is informed about new languages added to the languages lists by the labels provider.

The LabelsProvider requires a LangsProvider during the creation. that LangsProvider is informed about new languages when the labels database is build.

Applications should show a message to the user or call the LabelsProviderUI.showNewLangsAddedMessage() method that shows an standard message.

.NET api can use a different UI for the same purpose