Class Index | File Index

Classes


Class orion.settings.Setting

Represents the definition of a setting.
Defined in: </jobs/genie.orion/orion-client-stable/workspace/bundles/org.eclipse.orion.client.ui/web/orion/settings/settingsRegistry.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
Represents the definition of a setting.
Method Summary
Method Attributes Method Name and Description
 
 
Returns the category.
 
Returns the category label.
 
Returns the name.
 
 
 
 
isDefaults(properties, defaultProperties)
Returns whether a given properties map is equivalent to 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} 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} getObjectClassDefinitionId()
Returns:
{String}

{String} getPid()
Returns:
{String}

{String[]} getTags()
Returns:
{String[]}

{Boolean} isDefaults(properties, defaultProperties)
Returns whether a given properties map is equivalent to the default value of this setting. Default values are drawn either from defaultProperties if provided, otherwise from the AttributeDefinition.
Parameters:
{Object} properties
A map of AttributeDefinition IDs to values.
{Object} defaultProperties Optional
If provided, gives a map of effective default values to compare properties against. If not provided, the default values defined in the AttributeDefinitions are used.
Returns:
{Boolean} true if the given properties map equals the defaults.

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Apr 04 2017 10:51:57 GMT-0400 (EDT)