Zimlet JavaScript API Reference - ZmLocale

Class ZmLocale


This class represents a locale.

Defined in: ZmLocale.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
ZmLocale(id, name, image, localName)
Default constructor.
Method Summary
Method Attributes Method Name and Description
<static>  
ZmLocale.create(id, name, localName)
Creates the locale.
 
Gets the image.
 
Gets the name in both the locale itself, and in the local (user) locale.
<static>  
ZmLocale.hasChoices()
Checks if there are more than one selectable locale.
Class Detail
ZmLocale(id, name, image, localName)
Default constructor.
Parameters:
{String} id
the id
{String} name
the name
{String} image
the image
{String} localName
the name in user's locale
See:
ZmLocale.create
Method Detail
<static> ZmLocale.create(id, name, localName)
Creates the locale.
Parameters:
{String} id
the locale id (for example, en_US)
{String} name
the locale name
{String} localName
the name in user's locale

{String} getImage()
Gets the image.
Returns:
{String} the image

{String} getNativeAndLocalName()
Gets the name in both the locale itself, and in the local (user) locale.
Returns:
{String} the name

<static> {Boolean} ZmLocale.hasChoices()
Checks if there are more than one selectable locale.
Returns:
{Boolean} true if there are more than one selectable locale

Documentation generated by JsDoc Toolkit 2.3.0 on Tue Jun 28 2016 21:01:37 GMT-0400 (EDT)