{column:padding=0px|width=80px}{column}{column}{column}
Method Summery
getCurrentCountry()
Gets the current country; based on the current locale settings in the Servoy Client Locale preferences.
getCurrentLanguage()
Gets the current language; based on the current locale settings in the Servoy Client Locale preferences.
getCurrentTimeZone()
Gets the current time zone of the client; based on the current locale settings in the Servoy Client Locale preferences.
getDefaultDateFormat()
Gets the current default date format; based on the current locale settings in the Servoy Client Locale preferences.
getDefaultNumberFormat()
Gets the current default number format; based on the current locale settings in the Servoy Client Locale preferences.
getI18NMessage(i18nKey, [dynamicValues])
Gets the real message (for the clients locale) for a specified message key.
getLanguages()
Returns a dataset with rows that contains a language key (en) and the displayname (English) column.
getSystemMessages()
Returns a dataset with rows that contains 3 columns: 'key' (i18n key), 'reference' (reference text for that key) and 'locale ([CURRENT_LOCALE])' (where [CURRENT_LOCALE] is the current language) - with the system messages of servoy.
getTimeZoneOffset(timezone, [date])
Returns the offset (in milliseconds) of this time zone from UTC for the current date or at the specified date.
String[]
getTimeZones()
Returns an array of known timezones.
void
setI18NMessage(i18nKey, value)
Sets the value of i18n key for client scope,if value null the setting is removed.
void
setI18NMessagesFilter(columnName, value)
Call this if you want to add a filter for a column (created by you) in the i18n table.
void
setLocale(language, country)
Set/Overwrite the locale for this client.
{column:padding=0px|width=100%}{column}
Method Details
getCurrentCountry
()
Gets the current country; based on the current locale settings in the Servoy Client Locale preferences.
NOTE: For more information on i18n, see the chapter on Internationalization (i18n) in the Servoy Developer User's Guide, beginning with the Introduction to i18n
Returns
String – a String representing the current country.
Sample
var currCountry = i18n.getCurrentCountry();
getCurrentLanguage
()
Gets the current language; based on the current locale settings in the Servoy Client Locale preferences.
NOTE: For more information on i18n, see the chapter on Internationalization (i18n) in the Servoy Developer User's Guide, beginning with the Introduction to i18n
Returns
String – a String representing the current language.
Sample
var currLang = i18n.getCurrentLanguage();
getCurrentTimeZone
()
Gets the current time zone of the client; based on the current locale settings in the Servoy Client Locale preferences. For Servoy Web Clients the time zone is given by the browser (if it is possible to obtain it).
Returns
String – a String representing the current time zone.
Sample
var currTimeZone = i18n.getCurrentTimeZone();
getDefaultDateFormat
()
Gets the current default date format; based on the current locale settings in the Servoy Client Locale preferences.
Returns
String – a String representing the default date format.
Sample
var defaultDateFormat = i18n.getDefaultDateFormat();
getDefaultNumberFormat
()
Gets the current default number format; based on the current locale settings in the Servoy Client Locale preferences.
Returns
String – a String representing the default number format.
Sample
var defaultNumberFormat = i18n.getDefaultNumberFormat();
getI18NMessage
(i18nKey, [dynamicValues])
Gets the real message (for the clients locale) for a specified message key.
You can use parameter substitution by using {n}, where n is a index number of the value thats in the arguments array.
Returns
String – a String that is the message for the message key.
Sample
// returns 'Welcome my_name in my solution' // if the key 'mykey.username.text' is 'Welcome {0} in my solution' i18n.getI18NMessage('mykey.username.text',new Array('my_name'))
getLanguages
()
Returns a dataset with rows that contains a language key (en) and the displayname (English) column.
See http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt for a list that could be returned.
Returns
JSDataSet – a JSDataSet with all the languages.
Sample
var set = i18n.getLanguages(); for(var i=1;i<=set.getMaxRowIndex();i++) { application.output(set.getValue(i, 1) + " " + set.getValue(i, 2)); }
getSystemMessages
()
Returns a dataset with rows that contains 3 columns: 'key' (i18n key), 'reference' (reference text for that key) and 'locale ([CURRENT_LOCALE])' (where [CURRENT_LOCALE] is the current language) - with the system messages of servoy.
This means all servoy messages, with all available translations.
Returns
JSDataSet – a JSDataSet with all the system messages.
Sample
var set = i18n.getSystemMessages(); for(var i=1;i<=set.getMaxRowIndex();i++) { application.output(set.getValue(i, 1) + " " + set.getValue(i, 2)+ " " + set.getValue(i, 3)); }
getTimeZoneOffset
(timezone, [date])
Returns the offset (in milliseconds) of this time zone from UTC for the current date or at the specified date.
Parameters
timezone – The time zone to get the offset for.
[date] – The date in the time zone (default current date). Needed in case daylight saving time/GMT offset changes are used in the time zone.
Returns
Number – an int representing the time zone's offset from UTC.
Sample
var timeZoneOffset = i18n.getTimeZoneOffset('America/Los_Angeles');
String[]
getTimeZones
()
Returns an array of known timezones.
Returns
String[] – an Array with all the timezones.
Sample
var timeZones = i18n.getTimeZones();
void
setI18NMessage
(i18nKey, value)
Sets the value of i18n key for client scope,if value null the setting is removed.
All forms not yet loaded will change (execute this in solution startup or first form)
Returns
void
Sample
//sets the value of i18n key for client scope; if value null the setting is removed //Warning: already created form elements with i18n text lookup will not change, //so call this method in the solution startup method or in methods from first form i18n.setI18NMessage('mykey.username.text','my_name')
void
setI18NMessagesFilter
(columnName, value)
Call this if you want to add a filter for a column (created by you) in the i18n table.
So that you can have multiple default values and multiple values per locale for one key.
Returns
void
Sample
// Puts i18n in filter mode - this allows you to have multiple default/per locale // values for one key and to use one of them based on the filter parameters. // Let's say you added a new column "message_variant" to your i18n table. // Now you can have keys that will translate to a language differently depending on the used variant // For example you have 2 rows in you table for key X, language EN, different values and different "message_variant" (let's say 1 and 2) // If you want the solution to use the first variant, you will have to call: i18n.setI18NMessagesFilter('message_variant', '1') // ATTENTION: if you use setI18NMessagesFilter(...) it is not recommended to use the i18n Dialog (especially before the filter is applied through JS).
void
setLocale
(language, country)
Set/Overwrite the locale for this client.
All forms not yet loaded will change (execute this in solution startup or first form).
The language must be a lowercase 2 letter code defined by ISO-649.
see http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt
The country must be an upper case 2 letter code defined by IS-3166
see http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html
NOTE: For more information on i18n, see the chapter on Internationalization (i18n) in the Servoy Developer User's Guide, beginning with the Introduction to i18n
Returns
void
Sample
//Warning: already created form elements with i18n text lookup will not change, //so call this method in the solution startup method or in methods from first form i18n.setLocale('en','US');