- Legend to Symbols
-
Namespace
The namespace is really just an object where further objects and their methods and properties are attached bundling up all the functionality using a unique name.
Interface
The Interface is a contract by which the implementing class adheres. It describes a desired behavior and enforces adherence for any class that implements the interface.
Class
Classes define types of objects that will be used by the application.
Method
A function associated with a class or object.
Field
A variable associated with a class or object.
Inherited Method
A function inherited from the parent class. The present documentation scheme differentiates between a direct or indirect inheritance relationship.
Inherited Field
A variable inherited from the parent class. The present documentation scheme differentiates between a direct or indirect inheritance relationship.
Event
Events are actions that occur because of user interaction. They are normally used in combination with functions, and the function will not be executed before the event occurs.
Class ovi.mapsapi.language.Info
Class Summary
The static Info class that provides utilities
regarding languages.
It has an observable "language" property, which will be updated when
language changes due to loading a new language package.
The language info object is initialized with the default locale en-GB
and will also come with the related translation table.
The Info class can provide language meta data given an LCID composed of
either
- the ISO639-1 language code and the ISO3166-1 alpha-2 country code, e.g. "en-US", "de-DE", etc.
- the ISO639-1 language code only
- key
- the key by which this language is known to the system
- iso639_1
- the ISO-639-1 language code
- marc
- the 3-letter MARC language codes mapped to this language
- [locale]
- if a locale (and therefore translation table) is associated with this language the locale property will be available holding the LCID
Extends
ovi.mapsapi.util.OObject.
Method Summary
addObserver
(key, callback, [context])
: ovi.mapsapi.util.OObject
Register an observer for a property.
get
(key)
: Variant
Returns the value of the property with the given name.
getDefinition
(code, [definitions])
: Object
Retrieves the language meta data for a given LCID.
remove
(key)
: ovi.mapsapi.util.OObject
Removes the property with the given name.
removeObserver
(key, callback, context)
: ovi.mapsapi.util.OObject
Remove an observer from a key.
set
(nameOrObject, [value, [force]])
: ovi.mapsapi.util.OObject
Set the value(s) of a property or properties of given name(s) to given value(s).
Direct Inheritance
Constructor Detail
Method Detail
getDefinition
(code, [definitions])
: Object
Retrieves the language meta data for a given LCID. The lookup will be
done in two steps:
First the full LCID (ISO-639-1 AND ISO-3166-1 alpha-2) will be matched.
If the full LCID cannot be found the more general form (ISO-639-1 only)
will be matched.
Parameters:
| {String} | code |
- an LCID composed of either
|
| {Object} | [definitions]: | a specific map of language meta data to search |
Returns:
| {Object} |
a language meta data object containing the following properties:
|