Child pages
  • i18n
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 17 Next »

Unknown macro: {div}

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.

Enter additional information related to this 'class' inside the {div} macro with 'id=description'

Unknown macro: {div}


Unknown macro: {table}

{column:width=80px|padding=0px}{column}{column}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Summary

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String[]

Unknown macro: {td}

getAvailableTimeZoneIDs()
Get the list of available time zones.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String[]

Unknown macro: {td}

getCountries()
Gets the list of countries available for localization

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

getCurrentCountry()
Gets the current country; based on the current locale settings in the Servoy Client Locale preferences.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

getCurrentLanguage()
Gets the current language; based on the current locale settings in the Servoy Client Locale preferences.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

getCurrentTimeZone()
Gets the current time zone of the client; based on the current locale settings in the Servoy Client Locale preferences.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

getDefaultDateFormat()
Gets the current default date format; based on the current locale settings in the Servoy Client Locale preferences.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

getDefaultNumberFormat()
Gets the current default number format; based on the current locale settings in the Servoy Client Locale preferences.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

getI18NMessage(i18nKey)
Gets the real message (for the clients locale) for a specified message key.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String

Unknown macro: {td}

getI18NMessage(i18nKey, dynamicValues)
Gets the real message (for the clients locale) for a specified message key.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSDataSet

Unknown macro: {td}

getLanguages()
Returns a dataset with rows that contains a language key (en) and the displayname (English) column.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

JSDataSet

Unknown macro: {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.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

getTimeZoneOffset(timeZoneId)
Returns the offset (in milliseconds) of this time zone from UTC for the current date or at the specified date.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

Number

Unknown macro: {td}

getTimeZoneOffset(timeZoneId, date)
Returns the offset (in milliseconds) of this time zone from UTC for the current date or at the specified date.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

String[]

Unknown macro: {td}

getTimeZones()
Returns an array of known timezones.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

setI18NMessage(i18nKey, value)
Sets the value of i18n key for client scope,if value null the setting is removed.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

setLocale(language, country)
Set/Overwrite the locale for this client.

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}

void

Unknown macro: {td}

setTimeZone()
Sets the current time zone of the client.


Unknown macro: {table}

{column:width=100%|padding=0px}{column}

Unknown macro: {tr}
Unknown macro: {th}

Method Details

Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getAvailableTimeZoneIDs
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String[]

Unknown macro: {span}

getAvailableTimeZoneIDs

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String[]

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//Get the list of available time zones 
var timezones = i18n.getAvailableTimeZoneIDs();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getCountries
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String[]

Unknown macro: {span}

getCountries

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String[] – a String array containing the available countries.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
i18n.getCountries()
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getCurrentCountry
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

getCurrentCountry

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – a String representing the current country.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var currCountry = i18n.getCurrentCountry();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getCurrentLanguage
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

getCurrentLanguage

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – a String representing the current language.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var currLang = i18n.getCurrentLanguage();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getCurrentTimeZone
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

getCurrentTimeZone

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – a String representing the current time zone.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var currTimeZone = i18n.getCurrentTimeZone();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getDefaultDateFormat
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

getDefaultDateFormat

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – a String representing the default date format.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var defaultDateFormat = i18n.getDefaultDateFormat();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getDefaultNumberFormat
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

getDefaultNumberFormat

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – a String representing the default number format.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var defaultNumberFormat = i18n.getDefaultNumberFormat();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getI18NMessage
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

getI18NMessage

Unknown macro: {span}

(i18nKey)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} i18nKey – The message key

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – a String that is the message for the message key.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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'))
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getI18NMessage
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String

Unknown macro: {span}

getI18NMessage

Unknown macro: {span}

(i18nKey, dynamicValues)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} i18nKey – The message key
{Object[]} dynamicValues – Arguments array when using parameter substitution.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String – a String that is the message for the message key.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// 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'))
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getLanguages
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSDataSet

Unknown macro: {span}

getLanguages

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSDataSet – a JSDataSet with all the languages.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var set = i18n.getLanguages();
for(var i=1;i<=set.getMaxRowIndex();i++)
{
	application.output(set.getValue(i, 1) + " " + set.getValue(i, 2));
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getSystemMessages
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

JSDataSet

Unknown macro: {span}

getSystemMessages

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

JSDataSet – a JSDataSet with all the system messages.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
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));
}
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getTimeZoneOffset
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

getTimeZoneOffset

Unknown macro: {span}

(timeZoneId)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} timeZoneId – The time zone to get the offset for.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – an int representing the time zone's offset from UTC.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var timeZoneOffset = i18n.getTimeZoneOffset('America/Los_Angeles');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getTimeZoneOffset
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

Number

Unknown macro: {span}

getTimeZoneOffset

Unknown macro: {span}

(timeZoneId, date)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

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

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

Number – an int representing the time zone's offset from UTC.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var timeZoneOffset = i18n.getTimeZoneOffset('America/Los_Angeles');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
getTimeZones
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

String[]

Unknown macro: {span}

getTimeZones

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

String[] – an Array with all the timezones.

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
var timeZones = i18n.getTimeZones();
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
setI18NMessage
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

setI18NMessage

Unknown macro: {span}

(i18nKey, value)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} i18nKey – The message key
{String} value – They value for the message key.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//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')
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
setLocale
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

setLocale

Unknown macro: {span}

(language, country)

Unknown macro: {tr}
Unknown macro: {td}

Parameters

Unknown macro: {div}

{String} language – The lowercase 2 letter code
{String} country – The upper case 2 letter code.

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
//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');
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {tbody}
Unknown macro: {tr}
Unknown macro: {td}
setTimeZone
Unknown macro: {tr}
Unknown macro: {td}
Unknown macro: {span}

void

Unknown macro: {span}

setTimeZone

Unknown macro: {span}

()

Unknown macro: {tr}
Unknown macro: {td}

Returns

Unknown macro: {div}

void

Unknown macro: {tr}
Unknown macro: {td}

Sample

Unknown macro: {div}
// This will set the default time zone to Central European Time
i18n.setTimeZone("Europe/Amsterdam");
Unknown macro: {tr}
Unknown macro: {td}
  • No labels