Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Papyrus/Mars Work Description/Improvments/Stereotype support"
(→Enhancement of the support for the stereotypes in Papyrus) |
|||
| Line 3: | Line 3: | ||
This page presents the improvments that will be pushed in the Mars version of Papyrus regarding the stereotypes support in the tool. | This page presents the improvments that will be pushed in the Mars version of Papyrus regarding the stereotypes support in the tool. | ||
| − | + | === Introduction === | |
The starting point of this study is due to concomitant issues around the stereotype display: | The starting point of this study is due to concomitant issues around the stereotype display: | ||
| Line 10: | Line 10: | ||
*The third point is the user interface to display the Stereotype that doesn’t fulfil the user expectation in terms of intuitiveness. | *The third point is the user interface to display the Stereotype that doesn’t fulfil the user expectation in terms of intuitiveness. | ||
| − | + | === State of art === | |
| − | + | ||
The Stereotype feature contains two types of display, which are more or less independent. | The Stereotype feature contains two types of display, which are more or less independent. | ||
* The stereotype name label | * The stereotype name label | ||
| Line 26: | Line 26: | ||
Those different cases should be part of the solution. But as there are quite independent, they can be treated as such. | Those different cases should be part of the solution. But as there are quite independent, they can be treated as such. | ||
| − | + | === Conception === | |
In Papyrus, Stereotypes are stored into UML model. But the information related to manner to display stereotypes is stored through the EAnnotation. | In Papyrus, Stereotypes are stored into UML model. But the information related to manner to display stereotypes is stored through the EAnnotation. | ||
| Line 38: | Line 38: | ||
!colspan="1"| Description | !colspan="1"| Description | ||
|- | |- | ||
| − | |Stereotype_Presentation_Kind | + | |rowspan="5"|Stereotype_Presentation_Kind |
|TextIconStereotype | |TextIconStereotype | ||
| − | |The kind of presentation for stereotype | + | |rowspan="5"|The kind of presentation for stereotype |
| + | |- | ||
| + | |IconStereotype | ||
| + | |- | ||
| + | |ImageStereotype | ||
| + | |- | ||
| + | |HorizontalStereo | ||
| + | |- | ||
| + | |VerticalStereo | ||
|- | |- | ||
|StereotypeList | |StereotypeList | ||
| − | | | + | |Block, Allocated |
| − | | | + | |The list of stereotype to display |
|- | |- | ||
|StereotypeWithQualifiedNameList | |StereotypeWithQualifiedNameList | ||
| − | | | + | |SysML::Allocations::Allocated, SysML::Blocks::Block |
| − | | | + | |The list of stereotype to display with Qualified Name |
|- | |- | ||
|PropStereoDisplay | |PropStereoDisplay | ||
| − | | | + | |SysML::Blocks::Block.isEncapsulated |
| − | | | + | |List of properties to display |
|- | |- | ||
| − | |StereotypePropertyLocation | + | |rowspan="3"|StereotypePropertyLocation |
| − | | | + | |Compartment |
| − | | | + | |rowspan="3"|Location of Stereotype Properties |
|- | |- | ||
| − | | | + | |In Brace |
| − | | | + | |- |
| − | | | + | |Comment |
|- | |- | ||
|} | |} | ||
| + | === Property View === | ||
| + | |||
| + | The profile and stereotypes applied are available under the tab “Profile” of the property view of the diagram or of the object. | ||
| + | All the information about the display of those stereotypes is available under the “Appearance” tab. | ||
| + | |||
| + | |||
| + | ++ Images | ||
| + | |||
| + | # What information should be displayed (Text, icon, image, text and Icon) | ||
| + | # How the stereotypes should be aligned (Horizontal or vertical ) | ||
| + | # Location of the stereotype information to be displayed (in a specific compartment, as a comment, or between bracket ) | ||
| + | # The selection tree of the applied stereotypes with their properties | ||
| + | # Pair of buttons to display either short stereotype name, or the whole qualified name. | ||
| + | |||
| + | |||
| + | === Architecture === | ||
| + | Here is the general overview of the Stereotypes architecture with EAnnotation. | ||
| + | ++ Image | ||
| + | |||
| + | |||
| + | |||
Revision as of 12:33, 9 January 2015
Contents
Enhancement of the support for the stereotypes in Papyrus
This page presents the improvments that will be pushed in the Mars version of Papyrus regarding the stereotypes support in the tool.
Introduction
The starting point of this study is due to concomitant issues around the stereotype display:
- The first whished improvement is to display the stereotypes when dragged and dropped from the model explorer.
- The second whish would be to use the Named Styles instead of EAnnotation in order to be aligned with the Papyrus point of view and be based on GMF layer.
- The third point is the user interface to display the Stereotype that doesn’t fulfil the user expectation in terms of intuitiveness.
State of art
The Stereotype feature contains two types of display, which are more or less independent.
- The stereotype name label
- Can be displayed or hidden
- With a short name or a Qualified Name
- The stereotype properties
- Can be displayed or hidden
- Can be shown in a compartment, as a comment or in braces
On top of that, there are several actions taking part in the stereotype display:
- When displaying or hiding an item (stereotype Label or property label) from the appearance property view.
- When a new stereotype is applied or unapplied from the profile tab into the property view.
Those different cases should be part of the solution. But as there are quite independent, they can be treated as such.
Conception
In Papyrus, Stereotypes are stored into UML model. But the information related to manner to display stereotypes is stored through the EAnnotation. EAnnotation is an EMF concept that is attached to an object of type EModelElement. The EAnnotation details is a Map of type EMap<String,String>. In the case of “Stereotype”, the EAnnotation name is “Stereotype_Annotation”, the related map contains the following list of properties and values:
| KEY (String) | VALUE (String) | Description |
|---|---|---|
| Stereotype_Presentation_Kind | TextIconStereotype | The kind of presentation for stereotype |
| IconStereotype | ||
| ImageStereotype | ||
| HorizontalStereo | ||
| VerticalStereo | ||
| StereotypeList | Block, Allocated | The list of stereotype to display |
| StereotypeWithQualifiedNameList | SysML::Allocations::Allocated, SysML::Blocks::Block | The list of stereotype to display with Qualified Name |
| PropStereoDisplay | SysML::Blocks::Block.isEncapsulated | List of properties to display |
| StereotypePropertyLocation | Compartment | Location of Stereotype Properties |
| In Brace | ||
| Comment |
Property View
The profile and stereotypes applied are available under the tab “Profile” of the property view of the diagram or of the object. All the information about the display of those stereotypes is available under the “Appearance” tab.
++ Images
- What information should be displayed (Text, icon, image, text and Icon)
- How the stereotypes should be aligned (Horizontal or vertical )
- Location of the stereotype information to be displayed (in a specific compartment, as a comment, or between bracket )
- The selection tree of the applied stereotypes with their properties
- Pair of buttons to display either short stereotype name, or the whole qualified name.
Architecture
Here is the general overview of the Stereotypes architecture with EAnnotation. ++ Image
Bugzilla
The bugzilla items tracking progress of this improvments are: