Page History

{div:style=}

Wiki Markup

Div

style	display: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.\\ \\ Enter additional information related to this 'class' inside the \{div} macro with 'id=description'{div} {div:id=description}{div}\\ {table:id=|class=servoy sSummary}{colgroup}{column:width=80px|padding=0px}{column}{column}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=2}Method Summary{th}{tr}{tbody}{tr}{td}[String]\[]{td}{td}[#getAvailableTimeZoneIDs]\() Get the list of available time zones.{td}{tr}{tbody}{tbody}{tr}{td}[String]\[]{td}{td}[#getCountries]\() Gets the list of countries available for localization{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getCurrentCountry]\() Gets the current country; based on the current locale settings in the Servoy Client Locale preferences.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getCurrentLanguage]\() Gets the current language; based on the current locale settings in the Servoy Client Locale preferences.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getCurrentTimeZone]\() Gets the current time zone of the client; based on the current locale settings in the Servoy Client Locale preferences.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getDefaultDateFormat]\() Gets the current default date format; based on the current locale settings in the Servoy Client Locale preferences.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getDefaultNumberFormat]\() Gets the current default number format; based on the current locale settings in the Servoy Client Locale preferences.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getI18NMessage]\(i18nKey) Gets the real message (for the clients locale) for a specified message key.{td}{tr}{tbody}{tbody}{tr}{td}[String]{td}{td}[#getI18NMessage]\(i18nKey, dynamicValues) Gets the real message (for the clients locale) for a specified message key.{td}{tr}{tbody}{tbody}{tr}{td}[JSDataSet]{td}{td}[#getLanguages]\() Returns a dataset with rows that contains a language key (en) and the displayname (English) column.{td}{tr}{tbody}{tbody}{tr}{td}[JSDataSet]{td}{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.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getTimeZoneOffset]\(timeZoneId) Returns the offset (in milliseconds) of this time zone from UTC for the current date or at the specified date.{td}{tr}{tbody}{tbody}{tr}{td}[Number]{td}{td}[#getTimeZoneOffset]\(timeZoneId, date) Returns the offset (in milliseconds) of this time zone from UTC for the current date or at the specified date.{td}{tr}{tbody}{tbody}{tr}{td}[String]\[]{td}{td}[#getTimeZones]\() Returns an array of known timezones.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setI18NMessage]\(i18nKey, value) Sets the value of i18n key for client scope,if value null the setting is removed.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setLocale]\(language, country) Set/Overwrite the locale for this client.{td}{tr}{tbody}{tbody}{tr}{td}void{td}{td}[#setTimeZone]\() Sets the current time zone of the client.{td}{tr}{tbody}{table}\\ {table:id=function|class=servoy sDetail}{colgroup}{column:width=100%|padding=0px}{column}{colgroup}{tr:style=height: 30px;}{th:colspan=1}Method Details{th}{tr}{tbody:id=getAvailableTimeZoneIDs}{tr:id=name}{td}h6.getAvailableTimeZoneIDs{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]\[]{span}{span:style=font-weight: bold;}getAvailableTimeZoneIDs{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Get the list of available time zones.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]\[]{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

GENERATOR.

Div

id	description

HTML Table

id
class	servoy sSummary

Colgroup Tag

Col

width	80px

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

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

id	function
class	servoy sDetail

Colgroup Tag

Col

colspan	2
width	100%

Col

Table Head (thead)

Table Row (tr)

style	height: 30px;

Table Head (th)

colspan	2

Method Details

Table Body (tbody)

id	getAvailableTimeZoneIDs

Table Row (tr)

id	name

Table Cell (td)
getAvailableTimeZoneIDs

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String[]

Span

style	font-weight: bold;

getAvailableTimeZoneIDs

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Get the list of available time zones.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String[]

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//Get the list of available time zones


var timezones = i18n.getAvailableTimeZoneIDs();

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCountries}{tr:id=name}{td}h6.getCountries{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]\[]{span}{span:style=font-weight: bold;}getCountries{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Gets the list of countries available for localization{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]\[] -- a String array containing the available countries.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} i18n.getCountries() {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCurrentCountry}{tr:id=name}{td}h6.getCurrentCountry{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getCurrentCountry{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- a String representing the current country.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getCountries

Table Row (tr)

id	name

Table Cell (td)
getCountries

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String[]

Span

style	font-weight: bold;

getCountries

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Gets the list of countries available for localization

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

i18n.getCountries()

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getCurrentCountry

Table Row (tr)

id	name

Table Cell (td)
getCurrentCountry

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getCurrentCountry

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - a String representing the current country.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var currCountry = i18n.getCurrentCountry();

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCurrentLanguage}{tr:id=name}{td}h6.getCurrentLanguage{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getCurrentLanguage{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- a String representing the current language.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getCurrentLanguage

Table Row (tr)

id	name

Table Cell (td)
getCurrentLanguage

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getCurrentLanguage

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - a String representing the current language.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var currLang = i18n.getCurrentLanguage();

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getCurrentTimeZone}{tr:id=name}{td}h6.getCurrentTimeZone{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getCurrentTimeZone{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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).{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- a String representing the current time zone.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getCurrentTimeZone

Table Row (tr)

id	name

Table Cell (td)
getCurrentTimeZone

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getCurrentTimeZone

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - a String representing the current time zone.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var currTimeZone = i18n.getCurrentTimeZone

(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDefaultDateFormat}{tr:id=name}{td}h6.getDefaultDateFormat{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getDefaultDateFormat{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Gets the current default date format; based on the current locale settings in the Servoy Client Locale preferences.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- a String representing the default date format.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getDefaultDateFormat

Table Row (tr)

id	name

Table Cell (td)
getDefaultDateFormat

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getDefaultDateFormat

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - a String representing the default date format.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var defaultDateFormat = i18n.getDefaultDateFormat

(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getDefaultNumberFormat}{tr:id=name}{td}h6.getDefaultNumberFormat{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getDefaultNumberFormat{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Gets the current default number format; based on the current locale settings in the Servoy Client Locale preferences.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- a String representing the default number format.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript} var defaultNumberFormat = i18n.getDefaultNumberFormat(); {code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getI18NMessage-String}{tr:id=name}{td}h6.getI18NMessage{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]{span}{span:style=font-weight: bold;}getI18NMessage{span}{span}\(i18nKey){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Gets the real message (for the clients locale) for a specified message key.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} i18nKey -- The message key {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- a String that is the message for the message key.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getDefaultNumberFormat

Table Row (tr)

id	name

Table Cell (td)
getDefaultNumberFormat

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getDefaultNumberFormat

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String - a String representing the default number format.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var defaultNumberFormat = i18n.getDefaultNumberFormat();

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getI18NMessage-String

Table Row (tr)

id	name

Table Cell (td)
getI18NMessage

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String

Span

style	font-weight: bold;

getI18NMessage

Span
(i18nKey)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

{String} i18nKey - The message key

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// 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'))

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getI18NMessage-String_ObjectArray

}{

Table Row (tr)

:

id

=

	name

}{td}h6.getI18NMessage{td}{tr}{tr:id=sig}{td}{span:style=

Table Cell (td)
getI18NMessage

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right:

5px;

}[

String

]{span}{span:style=

Span

style	font-weight:

bold;

}

getI18NMessage

{span}{span}\

Span
(i18nKey,

dynamicValues)

{span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} i18nKey -- The message key \{[Object]\[]} dynamicValues -- Arguments array when using parameter substitution. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String] -- a String that is the message for the message key.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// 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'))

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getLanguages}{tr:id=name}{td}h6.getLanguages{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSDataSet]{span}{span:style=font-weight: bold;}getLanguages{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns a dataset with rows that contains a language key (en) and the displayname (English) column. See

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getLanguages

Table Row (tr)

id	name

Table Cell (td)
getLanguages

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSDataSet

Span

style	font-weight: bold;

getLanguages

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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.

{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSDataSet] -- a JSDataSet with all the languages.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSDataSet - a JSDataSet with all the languages.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var set = i18n.getLanguages();
for(var i=1;i<=set.getMaxRowIndex();i++)
{
	application.output(set.getValue(i, 1) + " " + set.getValue(i, 2));
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getSystemMessages}{tr:id=name}{td}h6.getSystemMessages{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[JSDataSet]{span}{span:style=font-weight: bold;}getSystemMessages{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[JSDataSet] -- a JSDataSet with all the system messages.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getSystemMessages

Table Row (tr)

id	name

Table Cell (td)
getSystemMessages

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

JSDataSet

Span

style	font-weight: bold;

getSystemMessages

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

JSDataSet - a JSDataSet with all the system messages.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

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));
}

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTimeZoneOffset-String}{tr:id=name}{td}h6.getTimeZoneOffset{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[Number]{span}{span:style=font-weight: bold;}getTimeZoneOffset{span}{span}\(timeZoneId){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the offset (in milliseconds) of this time zone from UTC for the current date or at the specified date.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} timeZoneId -- The time zone to get the offset for. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- an int representing the time zone's offset from UTC.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTimeZoneOffset-String

Table Row (tr)

id	name

Table Cell (td)
getTimeZoneOffset

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

Number

Span

style	font-weight: bold;

getTimeZoneOffset

Span
(timeZoneId)

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var timeZoneOffset = i18n.getTimeZoneOffset('America/Los_Angeles');

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTimeZoneOffset-String_Date

}{

Table Row (tr)

:

id

=

	name

}{td}h6.getTimeZoneOffset{td}{tr}{tr:id=sig}{td}{span:style=

Table Cell (td)
getTimeZoneOffset

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right:

5px;

}[

Number

]{span}{span:style=

Span

style	font-weight:

bold;

}

getTimeZoneOffset

{span}{span}\

Span
(timeZoneId,

date)

{span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns the offset (in milliseconds) of this time zone from UTC for the current date or at the specified date.{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[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. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[Number] -- an int representing the time zone's offset from UTC.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

id	ret

Table Cell (td)

Returns

Div

class	sIndent

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

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var timeZoneOffset = i18n.getTimeZoneOffset('America/Los_Angeles');

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=getTimeZones}{tr:id=name}{td}h6.getTimeZones{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}[String]\[]{span}{span:style=font-weight: bold;}getTimeZones{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}Returns an array of known timezones.{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}[String]\[] -- an Array with all the timezones.{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	getTimeZones

Table Row (tr)

id	name

Table Cell (td)
getTimeZones

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

String[]

Span

style	font-weight: bold;

getTimeZones

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

Returns an array of known timezones.

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

String[] - an Array with all the timezones.

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

var timeZones = i18n.getTimeZones();

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setI18NMessage-String_String

}{

Table Row (tr)

:

id

=

	name

}{td}h6.setI18NMessage{td}{tr}{tr:id=sig}{td}{span:style=

Table Cell (td)
setI18NMessage

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right:

5px;

}

void

{span}{span:style=

Span

style	font-weight:

bold;

}

setI18NMessage

{span}{span}\

Span
(i18nKey,

value)

{span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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){div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} i18nKey -- The message key \{[String]} value -- They value for the message key. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//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')

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setLocale-String_String

}{

Table Row (tr)

:

id

=

	name

}{td}h6.setLocale{td}{tr}{tr:id=sig}{td}{span:style=

Table Cell (td)
setLocale

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right:

5px;

}

void

{span}{span:style=

Span

style	font-weight:

bold;

}

setLocale

{span}{span}\

Span
(language,

country)

{span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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{div}{td}{tr}{tr:id=prs}{td}*Parameters*\\{div:class=sIndent}\{[String]} language -- The lowercase 2 letter code \{[String]} country -- The upper case 2 letter code. {div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

i18n

Table Row (tr)

id	prs

Table Cell (td)

Parameters

Div

class	sIndent

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

Table Row (tr)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

//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');

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{tbody:id=setTimeZone}{tr:id=name}{td}h6.setTimeZone{td}{tr}{tr:id=sig}{td}{span:style=margin-right: 5px;}void{span}{span:style=font-weight: bold;}setTimeZone{span}{span}\(){span}{td}{tr}{tr:id=des}{td}{div:class=sIndent}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".{div}{td}{tr}{tr:id=ret}{td}*Returns*\\{div:class=sIndent}void{div}{td}{tr}{tr:id=sam}{td}*Sample*\\{div:class=sIndent}{code:language=javascript}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Table Body (tbody)

id	setTimeZone

Table Row (tr)

id	name

Table Cell (td)
setTimeZone

Table Row (tr)

id	sig

Table Cell (td)

Span

style	margin-right: 5px;

void

Span

style	font-weight: bold;

setTimeZone

Span
()

Table Row (tr)

id	des

Table Cell (td)

Div

class	sIndent

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)

id	ret

Table Cell (td)

Returns

Div

class	sIndent

void

Table Row (tr)

id	sam

Table Cell (td)

Sample

Div

class	sIndent

Code Block

language	javascript

// This will set the default time zone to Central European Time
i18n.setTimeZone("Europe/Amsterdam");

{code}{div}{td}{tr}{tr:class=lastDetailRow}{td}{td}{tr}{tbody}{table}

Table Row (tr)

class	lastDetailRow

Table Cell (td)

Child pages

Versions Compared

Old Version 20

New Version Current

Key

getAvailableTimeZoneIDs

getCountries

getCurrentCountry

getCurrentLanguage

getCurrentTimeZone

getDefaultDateFormat

getDefaultNumberFormat

getI18NMessage

getI18NMessage

getLanguages

getSystemMessages

getTimeZoneOffset

getTimeZoneOffset

getTimeZones

setI18NMessage

setLocale

setTimeZone