Class Index | File Index

Classes


Class orion.metatype.AttributeDefinition

Describes the data type of a property/attribute.
Defined in: </jobs/genie.orion/orion-client-stable/workspace/bundles/org.eclipse.orion.client.core/web/orion/metatype.js>.

Class Summary
Constructor Attributes Constructor Name and Description
 
An AttributeDefinition describes the data type of a property/attribute.
Method Summary
Method Attributes Method Name and Description
 
Returns the default value.
 
Returns the id.
 
Returns the name.
 
Returns a list of labels for option values.
 
Returns the option values that this attribute can take.
 
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[]|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'

Documentation generated by JsDoc Toolkit 2.4.0 on Wed Jan 18 2017 12:15:12 GMT-0500 (EST)