Class orion.settings.Setting

Represents the definition of a setting.
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.Setting() Represents the definition of a setting.

Method Summary
Method Attributes	Method Name and Description
	getAttributeDefinitions()
	getCategory() Returns the category.
	getCategoryKey() Returns the category key.
	getCategoryLabel() Returns the category label.
	getName() Returns the name.
	getNameKey() Returns the name key.
	getNls() Returns the NLS path.
	getObjectClassDefinitionId()
	getPid()
	getTags()
	isDefaults(properties) Returns whether a given properties map equals the default value of this setting.

Class Detail

orion.settings.Setting()

Represents the definition of a setting.

Method Detail

{orion.metatype.AttributeDefinition[]} getAttributeDefinitions()

Returns:: {orion.metatype.AttributeDefinition[]}

{String} getCategory()

Returns the category.

Returns:: {String} The category. May be null.

{String} getCategoryKey()

Returns the category key.

Returns:: {String} The category key. May be null.

{String} getCategoryLabel()

Returns the category label.

Returns:: {String} The category label. May be null.

{String} getName()

Returns the name.

Returns:: {String} The name. May be null.

{String} getNameKey()

Returns the name key.

Returns:: {String} The name key. May be null.

See:: #getNls

{String} getNls()

Returns the NLS path.

Returns:: {String} The NLS path. May be null.

See:: #getNameKey

{String} getObjectClassDefinitionId()

Returns:: {String}

{String} getPid()

Returns:: {String}

{String[]} getTags()

Returns:: {String[]}

{Boolean} isDefaults(properties)

Returns whether a given properties map equals the default value of this setting. This tests if the following two conditions hold:

The ID of every AttributeDefinition in this setting appears as a key in the map, and
The key's corresponding value equals the AttributeDefinition's default value.

Parameters:
{Object} properties: A map of AttributeDefinition IDs to values.

Returns:: {Boolean} true if the given properties map equals the defaults.

Classes

Class orion.settings.Setting