Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Papyrus/Neon Work Description/NewFeature/Papyrus Viewpoint Switch
Papyrus Viewpoint Switch
Overview
Provide appropriate UI that will let user switch seamlessly between viewpoints.
Requirement
| Index | Description |
|---|---|
| REQ_001 | The user must be able to switch between viewpoint while editing models with limited UI actions. |
| REQ_002 | The user must be warned when opening a model in a different viewpoint than the one it has been edited in and asked to switch to appropriate viewpoint if needed |
| REQ_003 | The situation where the required viewpoint to edit a model is not available in the setup must be handled |
| REQ_004 | The situation where multiple models are edited side by side but edited through different viewpoints must be handled |
| REQ_005 | It should be possible to ensure that a model will be created or opened with the required viewpoint (more particularly in RCP) |
| REQ_006 | In a viewpoint definition, it should be possible to import and reuse diagrams from existing viewpoints |
Proposal
1. Change the Papyrus viewpoint configuration preferences to allow selecting multiple viewpoint configurations. The Default configuration and the (viewpoint extension point) deployed configurations will be automatically added and initially selected (for discoverability). Such configurations cannot be removed but can be unselected (except for Default). In addition, local configurations can be added, edited, removed and (un)selected.
2. Local configurations can be added using different access schemes (file system, workspace, platform).
3. A 'Viewpoints Selection...' action will be contributed in multiple places in the workspace [REQ_001].
a. As a menubar action under the Papyrus menu
b. As a context menu action on the Papyrus model root.
c. As a toolbar action
4. The 'Viewpoints Selection...' action will show a dialog to switch the viewpoint of the model. The dialog shows a list of available stakeholders (in a drop-down menu) and their viewpoints (in a list box) that are available from the selected viewpoint configurations in the preferences (a button to navigate to the preferences will be provided). It will also show the currently selected viewpoint. A user can select a new viewpoint from the list by choosing the 'Select' button. When this happens, the new viewpoint becomes active and its relevant changes take place in the model's editor and the relevant views in the workspace.
5. The Papyrus DI (.di) model will have a new optional reference to a viewpoint configuration. This optional reference can be initialized from an added page in the New Papyrus model wizard. It can also be changed by the 'Viewpoints Selection..." action in point 3 above. If the reference is unset, the model's viewpoint is assumed to be Default. [REQ_003]
6. When a Papyrus model editor is opened (REQ_002) or receives focus (REQ_004), its model's viewpoint becomes active resulting in relevant changes to the editor and to the relevant views in the workbench. If the model's viewpoint is not resolvable, a warning will be displayed with an option to invoke the 'Viewpoints Selection...' dialog. [REQ_003]
