Wiki source code of LanguageClientModule
Last modified by colinw on 2021/09/10 23:34
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | The LanguageClientModule provides the ability to retrieve a translation based on the user's currently selected language and localization. This is one of the first modules instantiated, and should be available for the entire lifetime of the client session for all other modules. | ||
| 2 | |||
| 3 | == Availability == | ||
| 4 | |||
| 5 | The LanguageClientModule is an init-level module, so it is created and available when the browser session is first instantiated, before the login screen is displayed. It is shut down immediately before the client session is destroyed. | ||
| 6 | |||
| 7 | == Methods == | ||
| 8 | |||
| 9 | {{code}} | ||
| 10 | public String get(final String key); | ||
| 11 | {{/code}} | ||
| 12 | |||
| 13 | The get method is the only method provided by this module. It allows you to retrieve a language translation for the provided translation key. Due to the frequency with which this method is called, the ClientRootUI provides a shortcut to this method: ClientRootUI.~_~_(final String key); | ||
| 14 | |||
| 15 | == Factory Name == | ||
| 16 | |||
| 17 | The factory name for dependencies of this module is: | ||
| 18 | |||
| 19 | {{code}} | ||
| 20 | com.xmlnamespace.panel.client.factory.client_module.language | ||
| 21 | {{/code}} | ||
| 22 | |||
| 23 | == Direct Descendents == | ||
| 24 | |||
| 25 | The following other modules are known to be direct descendents of the LanguageClientModule: | ||
| 26 | |||
| 27 | * LoginClientModule | ||
| 28 | |||
| 29 |