Class orion.metatype.AttributeDefinition

Describes the data type of a property/attribute.
Defined in: </shared/eclipse/e4/orion/I201404012230/bundles/org.eclipse.orion.client.core/web/orion/metatype.js>.

Class Summary
Constructor Attributes	Constructor Name and Description
	orion.metatype.AttributeDefinition() An `AttributeDefinition` describes the data type of a property/attribute.

Method Summary
Method Attributes	Method Name and Description
	getDefaultValue() Returns the default value.
	getId() Returns the id.
	getName() Returns the name.
	getNameKey() Returns the name key.
	getOptionLabelKeys() Returns a list of label keys for option values.
	getOptionLabels() Returns a list of labels for option values.
	getOptionValues() Returns the option values that this attribute can take.
	getType() Returns the type.

Class Detail

orion.metatype.AttributeDefinition()

An AttributeDefinition describes the data type of a property/attribute.

It typically serves to describe the type of an individual property that may appear in a orion.cm.ConfigurationProperties dictionary.

Method Detail

{Object} getDefaultValue()

Returns the default value.

Returns:: {Object} The default value, or null if no default exists.

{String} getId()

Returns the id.

Returns:: {String} The id of this AttributeDefinition.

{String} getName()

Returns the name.

Returns:: {String} The name, or null.

{String} getNameKey()

Returns the name key.

Returns:: {String} The name key, or null.

{String[]|null} getOptionLabelKeys()

Returns a list of label keys for option values.

Returns:: {String[]|null} The option label keys. The ordering of the returned array matches the ordering of the values array returned by #getOptionValues.
If there are no label keys available, null is returned.

See:: orion.metatype.ObjectClassDefinition#getNameKey The parent ObjectClassDefinition's nameKey gives the message bundle to which the labelKeys apply.

{String[]|null} getOptionLabels()

Returns a list of labels for option values.

Returns:: {String[]|null} The option labels. The ordering of the returned array matches the ordering of the values array returned by #getOptionValues.
If there are no option labels available, null is returned.

{Object[]|null} getOptionValues()

Returns the option values that this attribute can take.

Returns:: {Object[]|null} The option values. If there are no option values available, null is returned.

{String} getType()

Returns the type.

Returns:

{String} The type. It is one of:

'boolean'
'number'
'string'

Classes

Class orion.metatype.AttributeDefinition