Child pages
  • i18n

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3
Div
styledisplay:none

DO NOT EDIT THE CONTENT OF THIS PAGE DIRECTLY (EXCEPT INSIDE THE DIV BELOW WITH ID=DESCRIPTION), UNLESS YOU KNOW WHAT YOU'RE DOING.
THE STRUCTURE OF THE CONTENT IS VITAL IN BEING ABLE TO AUTO UPDATE THE CONTENT THROUGH THE DOC GENERATOR.

Div
iddescription



HTML Table
id
classservoy sSummary
Colgroup Tag
Col
width80px
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Summary
Table Row (tr)
Table Cell (td)
String[]
Table Cell (td)
getAvailableTimeZoneIDs()
Get the list of available time zones.
Table Row (tr)
Table Cell (td)
String[]
Table Cell (td)
getCountries()
Gets the list of countries available for localization
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getCurrentCountry()
Gets the current country; based on the current locale settings in the Servoy Client Locale preferences.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getCurrentLanguage()
Gets the current language; based on the current locale settings in the Servoy Client Locale preferences.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getCurrentTimeZone()
Gets the current time zone of the client; based on the current locale settings in the Servoy Client Locale preferences.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getDefaultDateFormat()
Gets the current default date format; based on the current locale settings in the Servoy Client Locale preferences.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getDefaultNumberFormat()
Gets the current default number format; based on the current locale settings in the Servoy Client Locale preferences.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getI18NMessage(i18nKey)
Gets the real message (for the clients locale) for a specified message key.
Table Row (tr)
Table Cell (td)
String
Table Cell (td)
getI18NMessage(i18nKey, dynamicValues)
Gets the real message (for the clients locale) for a specified message key.
Table Row (tr)
Table Cell (td)
JSDataSet
Table Cell (td)
getLanguages()
Returns a dataset with rows that contains a language key (en) and the displayname (English) column.
Table Row (tr)
Table Cell (td)
JSDataSet
Table Cell (td)
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.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getTimeZoneOffset(timeZoneId)
Returns the offset (in milliseconds) of this time zone from UTC for the current date or at the specified date.
Table Row (tr)
Table Cell (td)
Number
Table Cell (td)
getTimeZoneOffset(timeZoneId, date)
Returns the offset (in milliseconds) of this time zone from UTC for the current date or at the specified date.
Table Row (tr)
Table Cell (td)
String[]
Table Cell (td)
getTimeZones()
Returns an array of known timezones.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setI18NMessage(i18nKey, value)
Sets the value of i18n key for client scope,if value null the setting is removed.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setLocale(language, country)
Set/Overwrite the locale for this client.
Table Row (tr)
Table Cell (td)
void
Table Cell (td)
setTimeZone()
Sets the current time zone of the client.



HTML Table
idfunction
classservoy sDetail
Colgroup Tag
Col
colspan2
width100%
Col
Table Head (thead)
Table Row (tr)
styleheight: 30px;
Table Head (th)
colspan2
Method Details
Table Body (tbody)
idgetAvailableTimeZoneIDs
Table Row (tr)
idname
Table Cell (td)

getAvailableTimeZoneIDs

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String[]
Span
stylefont-weight: bold;
getAvailableTimeZoneIDs
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Get the list of available time zones.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String[]
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//Get the list of available time zones
var timezones = i18n.getAvailableTimeZoneIDs();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetCountries
Table Row (tr)
idname
Table Cell (td)

getCountries

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String[]
Span
stylefont-weight: bold;
getCountries
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets the list of countries available for localization
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String[] - a String array containing the available countries.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
i18n.getCountries()
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetCurrentCountry
Table Row (tr)
idname
Table Cell (td)

getCurrentCountry

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getCurrentCountry
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - a String representing the current country.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var currCountry = i18n.getCurrentCountry();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetCurrentLanguage
Table Row (tr)
idname
Table Cell (td)

getCurrentLanguage

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getCurrentLanguage
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - a String representing the current language.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var currLang = i18n.getCurrentLanguage();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetCurrentTimeZone
Table Row (tr)
idname
Table Cell (td)

getCurrentTimeZone

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getCurrentTimeZone
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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).
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - a String representing the current time zone.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var currTimeZone = i18n.getCurrentTimeZone();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetDefaultDateFormat
Table Row (tr)
idname
Table Cell (td)

getDefaultDateFormat

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getDefaultDateFormat
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets the current default date format; based on the current locale settings in the Servoy Client Locale preferences.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - a String representing the default date format.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var defaultDateFormat = i18n.getDefaultDateFormat();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetDefaultNumberFormat
Table Row (tr)
idname
Table Cell (td)

getDefaultNumberFormat

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getDefaultNumberFormat
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets the current default number format; based on the current locale settings in the Servoy Client Locale preferences.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - a String representing the default number format.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var defaultNumberFormat = i18n.getDefaultNumberFormat();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetI18NMessage-String
Table Row (tr)
idname
Table Cell (td)

getI18NMessage

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getI18NMessage
Span
(i18nKey)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Gets the real message (for the clients locale) for a specified message key.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} i18nKey - The message key
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - a String that is the message for the message key.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// 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'))
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetI18NMessage-String_ObjectArray
Table Row (tr)
idname
Table Cell (td)

getI18NMessage

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String
Span
stylefont-weight: bold;
getI18NMessage
Span
(i18nKey, dynamicValues)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} i18nKey - The message key
{Object[]} dynamicValues - Arguments array when using parameter substitution.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String - a String that is the message for the message key.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// 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'))
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetLanguages
Table Row (tr)
idname
Table Cell (td)

getLanguages

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSDataSet
Span
stylefont-weight: bold;
getLanguages
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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.

Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSDataSet - a JSDataSet with all the languages.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var set = i18n.getLanguages();
for(var i=1;i<=set.getMaxRowIndex();i++)
{
	application.output(set.getValue(i, 1) + " " + set.getValue(i, 2));
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetSystemMessages
Table Row (tr)
idname
Table Cell (td)

getSystemMessages

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
JSDataSet
Span
stylefont-weight: bold;
getSystemMessages
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
JSDataSet - a JSDataSet with all the system messages.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
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));
}
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetTimeZoneOffset-String
Table Row (tr)
idname
Table Cell (td)

getTimeZoneOffset

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getTimeZoneOffset
Span
(timeZoneId)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the offset (in milliseconds) of this time zone from UTC for the current date or at the specified date.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} timeZoneId - The time zone to get the offset for.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - an int representing the time zone's offset from UTC.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var timeZoneOffset = i18n.getTimeZoneOffset('America/Los_Angeles');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetTimeZoneOffset-String_Date
Table Row (tr)
idname
Table Cell (td)

getTimeZoneOffset

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
Number
Span
stylefont-weight: bold;
getTimeZoneOffset
Span
(timeZoneId, date)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns the offset (in milliseconds) of this time zone from UTC for the current date or at the specified date.
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} timeZoneId - The time zone to get the offset for.
{Date} 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.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
Number - an int representing the time zone's offset from UTC.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var timeZoneOffset = i18n.getTimeZoneOffset('America/Los_Angeles');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idgetTimeZones
Table Row (tr)
idname
Table Cell (td)

getTimeZones

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
String[]
Span
stylefont-weight: bold;
getTimeZones
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Returns an array of known timezones.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
String[] - an Array with all the timezones.
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
var timeZones = i18n.getTimeZones();
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetI18NMessage-String_String
Table Row (tr)
idname
Table Cell (td)

setI18NMessage

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setI18NMessage
Span
(i18nKey, value)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
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)
Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} i18nKey - The message key
{String} value - They value for the message key.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//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
//this method saves message for current locale, so if locale is changed with setLocale, all messages set from scripting will be lost

i18n.setI18NMessage('mykey.username.text','my_name')
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetLocale-String_String
Table Row (tr)
idname
Table Cell (td)

setLocale

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setLocale
Span
(language, country)
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent

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-639.
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

Table Row (tr)
idprs
Table Cell (td)

Parameters

Div
classsIndent
{String} language - The lowercase 2 letter code
{String} country - The upper case 2 letter code.
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
//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');
Table Row (tr)
classlastDetailRow
Table Cell (td)
 
Table Body (tbody)
idsetTimeZone
Table Row (tr)
idname
Table Cell (td)

setTimeZone

Table Row (tr)
idsig
Table Cell (td)
Span
stylemargin-right: 5px;
void
Span
stylefont-weight: bold;
setTimeZone
Span
()
Table Row (tr)
iddes
Table Cell (td)
Div
classsIndent
Sets the current time zone of the client.
The parameter should be a string having the format which can be retrieved via i18n.getAvailableTimeZones or
can be seen in the SmartClient Edit -> Preferences -> Locale at the "Default Timezone" combobox.
For instance the time zone for Netherlands is set using the ID "Europe/Amsterdam".
Table Row (tr)
idret
Table Cell (td)

Returns

Div
classsIndent
void
Table Row (tr)
idsam
Table Cell (td)

Sample

Div
classsIndent
Code Block
languagejavascript
// This will set the default time zone to Central European Time
i18n.setTimeZone("Europe/Amsterdam");
Table Row (tr)
classlastDetailRow
Table Cell (td)