Home
JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
Runtime (JavaScript)
The Runtime library contains classes that provide useful methods for globalization.
Locale (Runtime - JavaScript)
A Locale object represents a specific geographical, political, or cultural region. An operation that requires a Locale to perform its task is called locale-sensitive and uses the Locale to tailor information for the user. For example, displaying a number is a locale-sensitive operation because the number should be formatted according to the conventions of the user's native country, region, or culture.
equals (JavaScript)
Returns true if this Locale is equal to another object. A Locale is deemed equal to another Locale with identical language, country, and variant, and unequal to all other objects.

JavaScript and XPages reference
This reference describes the JavaScript™ language elements, Application Programming Interfaces (APIs), and other artifacts that you need to create scripts, plus the XPages simple actions.
- JavaScript™ language elements (JavaScript™)
  The JavaScript™ language elements are based on the ECMAScript Language Specification Standard ECMA-262 (see http://www.ecma-international.org/publications/standards/Ecma-262.htm). The JavaScript described here applies to the server-side interpreter. Client-side scripts are interpreted by the browser.
- Simple actions (JavaScript)
  A simple action performs a pre-programmed activity that can be modified by arguments.
- Global objects and functions (JavaScript™)
  Global objects provide entry points to server-side scripts. Entering the name of a global object instantiates it.
- DOM (JavaScript)
  Represents a document in XML Document Object Model format.
- Domino®
  This library provides access to the HCL Domino® back-end.
- Runtime (JavaScript)
  The Runtime library contains classes that provide useful methods for globalization.
  - I18n (JavaScript)
    This class provides methods for internationalization.
  - Locale (Runtime - JavaScript)
    A Locale object represents a specific geographical, political, or cultural region. An operation that requires a Locale to perform its task is called locale-sensitive and uses the Locale to tailor information for the user. For example, displaying a number is a locale-sensitive operation because the number should be formatted according to the conventions of the user's native country, region, or culture.
    - clone (Runtime - JavaScript)
      Overrides Cloneable.
    - equals (JavaScript)
      Returns true if this Locale is equal to another object. A Locale is deemed equal to another Locale with identical language, country, and variant, and unequal to all other objects.
    - getAvailableLocales (JavaScript)
      Returns a list of all installed locales.
    - getCountry (JavaScript)
      Returns the country/region code for this locale, which will either be the empty string or an upercase ISO 3166 2-letter code.
    - getDecimalSeparator (JavaScript)
      Returns the decimal separator in this locale.
    - getDefault (Locale - JavaScript)
      Gets the current value of the default locale for this instance of the Java™ Virtual Machine.
    - getDisplayCountry (JavaScript)
      Returns a name for the locale's country that is appropriate for display to the user.
    - getDisplayLanguage (JavaScript)
      Returns a name for the locale's language that is appropriate for display to the user.
    - getDisplayName (Locale - JavaScript)
      Returns a name for the locale that is appropriate for display to the user. This will be the values returned by getDisplayLanguage(), getDisplayCountry(), and getDisplayVariant() assembled into a single string.
    - getDisplayVariant (JavaScript)
      Returns a name for the locale's variant code that is appropriate for display to the user. If possible, the name can be localized for Locale. If the locale doesn't specify a variant code, this function returns the empty string.
    - getGroupingSeparator (JavaScript)
      Returns the grouping separator (to separate every 3 digits in integer part of a number) in this locale.
    - getISO3Country (JavaScript)
      Returns a three-letter abbreviation for this locale's country. If the locale doesn't specify a country, this will be the empty string. Otherwise, this will be an uppercase ISO 3166 3-letter country code.
    - getISO3Language (JavaScript)
      Returns a three-letter abbreviation for this locale's language. If the locale doesn't specify a language, this will be the empty string. Otherwise, this will be a lowercase ISO 639-2/T language code.
    - getISOCountries (JavaScript)
      Returns a list of all 2-letter country codes defined in ISO 3166. Can be used to create Locales
    - getISOLanguages (JavaScript)
      Returns a list of all 2-letter language codes defined in ISO 639. Can be used to create Locales.
    - getLanguage (JavaScript)
      Returns a list of all 2-letter country codes defined in ISO 3166. Can be used to create Locales
    - getVariant (JavaScript)
      Returns the variant code for this locale.
    - hashCode (JavaScript)
      Override hashCode. Since Locales are often used in hashtables, caches the value for speed.
    - setDefault (Locale - JavaScript)
      Sets the default locale for this instance of the Java™ Virtual Machine. This does not affect the host locale.
    - toString (Locale - JavaScript)
      Gets the programmatic name of the entire locale, with the language, country and variant separated by underbars. The Language is always lower case, and country is always upper case. If the language is missing, the string will begin with an underscore character. If both the language and country fields are missing, this function will return the empty string, even if the variant field is filled in (you cannot have a locale with just a variant-- the variant must accompany a valid language or country code). Examples: "en", "de_DE", "_GB", "en_US_WIN", "de__POSIX", "fr_MAC"
  - TimeZone (JavaScript)
    This class represents a time zone offset and figures out daylight saving time.
- Standard (JavaScript)
  The Standard library contains classes for manipulating data of different types and performing common operations.
- XSP (JavaScript™)
  The XSP library contains classes that access the browser context.

equals (JavaScript)

Returns true if this Locale is equal to another object. A Locale is deemed equal to another Locale with identical language, country, and variant, and unequal to all other objects.

Defined in

Locale (Runtime - JavaScript)

Syntax

equals(Object:java.lang.Object)
: boolean

Overrides

java.lang.Object (in class
java.lang.Object)


Return value	Description
`true`	"true" is returned if this Locale is equal to the specified object.