Element Type
An element type describes a class of elements, including their properties and applicable actions.
Every element must belong to an element type at run time. You assign it via the Match Name. In addition, each element type has a match name attribute, under which a unique name for the type must be defined. A tool that creates a new element must return this name under a designated property.
You can configure element types hierarchically so that they can be displayed in a Tree view. This is done using the Get Children Action relationship.
Depending on function packages installed and used in an AWM model, it is possible to create a linked element type. See Linked Element Types for the Eclipse Function Package for more information.
| Attribute | Type | Description |
|---|---|---|
| ID * | ID * | The ID of the element type. |
| Icon [O] | Icon | The icon of the element type. |
| Matchname * | String | The name by which the element type can be determined. |
| ID_Definition * | ID Definition | The ID definition of the element type. This definition describes the properties of the element type that uniquely identify an element within an application. See ID definition for more information. |
| Relationship | Cardinality | Description |
|---|---|---|
| Get_Children_Action | 0..1 | Relationship to an action descriptor. The referenced action should return the children elements. If you expand an element in the Tree view, this action displays the next hierarchical level of elements. |
| Get_All_Properties_Action | 0..1 | Relationship to an action that returns all the property values of an element. See Get All Properties Action for more information. |
| Has_Action | 0..* | Relationship to an action descriptor. Element-Actions can be executed from the context menu of the corresponding element. |
| Has_Property | 1..* | Relationship to a property that stands for an attribute of the element. |
| Has_Filter | 0..* | Relationship to a filter type. A Filter dialog box can be executed from the context menu of the corresponding element. |
| Has_Text_Decoration | 0..* | Relationship which describes decorations in front or behind of the label of the element type. |
Examples
Element Type SCLM_ELE_Project
| Attribute | Value | Description |
|---|---|---|
| Essential: | ||
| ID | SCLM_ELE_Project | Unique identifier of the element type in this model. |
| ID Definition | Reference to the ID Definition SCLM_ID_Project | The ID definition consists of a set of properties by which a SCLM project can be uniquely identified during runtime. |
| Matchname | PROJ | The value tools have to return in the Element_Type property to identify a SCLM project instance. |
| Optional: | ||
| Icon | Refrence to the Icon SCLM_ICON_ELE_Project | Icon shown in the context menu in front of the element type label. |
Element Type SCLM_ELE_Editable
| Attribute | Value | Description |
|---|---|---|
| Essential: | ||
| ID | SCLM_ELE_Editable | Unique identifier of the element type in this model. |
| ID Definition | Reference to the ID Definition SCLM_ID_SclmElements | The ID definition consists of a set of properties by which a SCLM element can be uniquely identified during runtime. |
| Matchname | EDITABLE | The value tools have to return in the Element_Type property to identify an editable SCLM element instance. |
| Optional: | ||
| Icon | Refrence to the Icon SCLM_ICON_ELE_Editable | Icon shown in the context menu in front of the element type label. |
Within the SCLM application model the same ID definition (SCLM_ELE_Editable) is shared by several element types:
-
SCLM_ELE_Editable
-
SCLM_ELE_LockEntry
-
SCLM_ELE_NonEditable
The mapping to the appropriate element type depends on the match name value returned by a tool providing new elements within the special Element_Type property. This means a tool returning new AWM elements must always return values for all key properties of the element as defined in the ID definition and the match name value defined in the attribute Matchname within the special Element_Type property.
The Element_Type property must not necessarily be a property which is associated with the element type via an Element Type_Has_Property relationship. It is sufficient to define just one special Element_Type property in an AWM model which is used by every tool returning a match name.