complexType "componentReferencePropertyType"

Namespace: | http://www.nokia.com/sdt/emf/component
Content: | empty, 12 attributes
Defined: | globally within component.xsd, see XML source
Used: | at 1 location

XML Representation Summary
<...
| category | = | xsd:string
| constraint | = | xsd:string
| creationKeys | = | xsd:string
| descriptionKey | = | xsd:string
| displayName | = | xsd:string
| editorClass | = | xsd:string
| helpKey | = | xsd:string
| name | = | xsd:string
| promoteReferenceProperties | = | xsd:boolean
| readOnly | = | xsd:boolean : "false"
| resettable | = | xsd:boolean : "true"
| scope | = | ("model" | "children" | "siblings")
/>

Known Usage Locations

- As direct type of elements (1):
  componentReferenceProperty

Annotation
A concrete property type that maintains a reference to a component
instance in the same model. The reference is kept by name, and is maintained across renames of the target
instance. It is cleared automatically if the target instance is removed.
Type Definition Detail

Type Derivation Summary abstractPropertyType componentReferencePropertyType (extension)

XML Source

<xsd:complexType name="componentReferencePropertyType"> <xsd:annotation> <xsd:documentation> A concrete property type that maintains a reference to a component instance in the same model. The reference is kept by name, and is maintained across renames of the target instance. It is cleared automatically if the target instance is removed. </xsd:documentation> </xsd:annotation> <xsd:complexContent> <xsd:extension base="abstractPropertyType"> <xsd:attribute name="scope" type="referenceScopeType" use="required"> <xsd:annotation> <xsd:documentation> Enumeration defining the scope for permissable values. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="constraint" type="xsd:string"> <xsd:annotation> <xsd:documentation> If specified, this must be the fully qualified name of a component type. Values are then constrained to be instances of this type, and the property sheet user interface displays a list of eligible instances. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="creationKeys" type="xsd:string"> <xsd:annotation> <xsd:documentation> An optional comma-delimited string containing a list of keys. When present these keys are used to add "create new xxx" items to the dropdown menu for the property, in addition to the "None" and existing instances populated into the menu. A component using this feature must also provide an ISetValueCommandExtender implementation to handle the creation of these items. Each key is used for two purposes: - As a resource key for the dropdown menu item. The resource string should be the full command, e.g. "Create new Foo". - When selected, the key is provided as a parameter to a com.nokia.sdt.component.NewComponentReferenceParameter instance. This instance is then available from the SetValueCommand passed to ISetValueCommandExtender.getExtendedCommand. The implementation should retrieve the key, and return a Command object that will create the appropriate new instance and set the target value to the new instance. </xsd:documentation> </xsd:annotation> </xsd:attribute> <xsd:attribute name="promoteReferenceProperties" type="xsd:boolean"> <xsd:annotation> <xsd:documentation> If specified, the properties of the instance referenced by this property are promoted into this property source, excluding the 'name' property and other properties that already exist in this component. This property and the referenced component instance's properties will be at the same level. </xsd:documentation> </xsd:annotation> </xsd:attribute> </xsd:extension> </xsd:complexContent> </xsd:complexType>

Attribute Detail
category

  The category grouping to be used in the property sheet.
  If this value matches the key of a known group then the localized name is looked up within the Symbian component provider. Otherwise it is treated like a
  potentially localized string, i.e. if it is %-prefixed a string is looked up in the properties file.
  The special value of "hidden" will cause the property to be filtered from the property sheet.

  Type: | xsd:string
  Use: | optional
  Defined: | locally, within abstractPropertyType complexType

constraint

  If specified, this must be the fully qualified name of a component type. Values
  are then constrained to be instances of this type, and the property sheet user interface displays a list of eligible
  instances.

  Type: | xsd:string
  Use: | optional
  Defined: | locally, within this complexType

  XML Source

  <xsd:attribute name="constraint" type="xsd:string"> <xsd:annotation> <xsd:documentation> If specified, this must be the fully qualified name of a component type. Values are then constrained to be instances of this type, and the property sheet user interface displays a list of eligible instances. </xsd:documentation> </xsd:annotation> </xsd:attribute>

creationKeys

  An optional comma-delimited string containing a list of keys. When
  present these keys are used to add "create new xxx" items to the dropdown menu for the property, in addition to
  the "None" and existing instances populated into the menu. A component using this feature must also provide
  an ISetValueCommandExtender implementation to handle the creation of these items.
  Each key is used for two purposes:
  - As a resource key for the dropdown menu item. The resource string should be the full command, e.g. "Create new Foo".
  - When selected, the key is provided as a parameter to a com.nokia.sdt.component.NewComponentReferenceParameter instance.
  This instance is then available from the SetValueCommand passed to ISetValueCommandExtender.getExtendedCommand.
  The implementation should retrieve the key, and return a Command object that will create the appropriate new instance
  and set the target value to the new instance.

  Type: | xsd:string
  Use: | optional
  Defined: | locally, within this complexType

  XML Source

  <xsd:attribute name="creationKeys" type="xsd:string"> <xsd:annotation> <xsd:documentation> An optional comma-delimited string containing a list of keys. When present these keys are used to add "create new xxx" items to the dropdown menu for the property, in addition to the "None" and existing instances populated into the menu. A component using this feature must also provide an ISetValueCommandExtender implementation to handle the creation of these items. Each key is used for two purposes: - As a resource key for the dropdown menu item. The resource string should be the full command, e.g. "Create new Foo". - When selected, the key is provided as a parameter to a com.nokia.sdt.component.NewComponentReferenceParameter instance. This instance is then available from the SetValueCommand passed to ISetValueCommandExtender.getExtendedCommand. The implementation should retrieve the key, and return a Command object that will create the appropriate new instance and set the target value to the new instance. </xsd:documentation> </xsd:annotation> </xsd:attribute>

descriptionKey

  A property key to descriptive text for the property to be displayed in the status bar
  when the property is selected in the property sheet.

  Type: | xsd:string
  Use: | optional
  Defined: | locally, within abstractPropertyType complexType

displayName

  The property name to be display in the user interface. Can contain spaces and other characters.
  This value should be localized.

  Type: | xsd:string
  Use: | optional
  Defined: | locally, within abstractPropertyType complexType

editorClass

  The fully qualified name of a class implementing com.nokia.sdt.component.property.IPropertyEditorFactory.
  This allows Java code to provide a label provider, cell editor, and validator for the property.

  Type: | xsd:string
  Use: | optional
  Defined: | locally, within abstractPropertyType complexType

helpKey

  A key to more detailed help for the property.

  Type: | xsd:string
  Use: | optional
  Defined: | locally, within abstractPropertyType complexType

name

  The internal name for the property. It must be unique within the component and its base
  components. Since it may be used as an identifier in scripts it should be a legal JavaScript identifier.

  Type: | xsd:string
  Use: | required
  Defined: | locally, within abstractPropertyType complexType

promoteReferenceProperties

  If specified, the properties of the instance referenced by this property are promoted
  into this property source, excluding the 'name' property and other properties that already exist in this component.
  This property and the referenced component instance's properties will be at the same level.

  Type: | xsd:boolean
  Use: | optional
  Defined: | locally, within this complexType

  XML Source

  <xsd:attribute name="promoteReferenceProperties" type="xsd:boolean"> <xsd:annotation> <xsd:documentation> If specified, the properties of the instance referenced by this property are promoted into this property source, excluding the 'name' property and other properties that already exist in this component. This property and the referenced component instance's properties will be at the same level. </xsd:documentation> </xsd:annotation> </xsd:attribute>

readOnly

  If true the property will be read-only in the property sheet.

  Type: | xsd:boolean
  Use: | optional
  Default: | "false"
  Defined: | locally, within abstractPropertyType complexType

resettable

  If false the reset button will be disabled, inhibiting the user from reverting to the default value

  Type: | xsd:boolean
  Use: | optional
  Default: | "true"
  Defined: | locally, within abstractPropertyType complexType

scope

  Enumeration defining the scope for permissable values.

  Type: | referenceScopeType
  Use: | required
  Defined: | locally, within this complexType

  XML Source

  <xsd:attribute name="scope" type="referenceScopeType" use="required"> <xsd:annotation> <xsd:documentation> Enumeration defining the scope for permissable values. </xsd:documentation> </xsd:annotation> </xsd:attribute>