Class Index | File Index

Classes


Class orion.settings.SettingsRegistry

Maintains a registry of settings.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.ui/web/orion/settings/settingsRegistry.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
orion.settings.SettingsRegistry(serviceRegistry, metaTypeRegistry)
A SettingsRegistry provides access to information about settings registered with the service registry.
Method Summary
Method Attributes Method Name and Description
 
Returns all setting categories.
 
getCategoryLabel(category)
Returns the localized label for a category.
 
getSettings(category)
Returns settings.
 
Loads the localizations for settings in the registry.
Class Detail
orion.settings.SettingsRegistry(serviceRegistry, metaTypeRegistry)
A SettingsRegistry provides access to information about settings registered with the service registry.
Parameters:
{orion.serviceregistry.ServiceRegistry} serviceRegistry
The service registry to monitor.
{orion.metatype.MetaTypeRegistry} metaTypeRegistry
The metatype registry to look up Object Class Definitions in.
Method Detail
{String[]} getCategories()
Returns all setting categories.
Returns:
{String[]} The categories.

{String} getCategoryLabel(category)
Returns the localized label for a category.
Parameters:
category
Returns:
{String} The category label, or null if no localized label is available.

{orion.settings.Setting[]} getSettings(category)
Returns settings.
Parameters:
{String} category Optional
If passed, returns only the settings in the given category. Otherwise, returns all settings.
Returns:
{orion.settings.Setting[]}

{orion.Promise} loadI18n()
Loads the localizations for settings in the registry. After this method resolves, the Settings and AttributeDefinitions will return localized values from their name and label getters.
Returns:
{orion.Promise} A promise that resolves when localizations have been loaded.

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Apr 01 2014 22:58:24 GMT-0400 (EDT)