Release Notes for Sirius

1. Release Notes for Sirius
   1. Changes in Sirius 7.2.1
      1. User-Visible Changes
      2. Specifier-Visible Changes
      3. Developer-Visible Changes
   2. Changes in Sirius 7.2.0
      1. User-Visible Changes
      2. Specifier-Visible Changes
      3. Developer-Visible Changes
   3. Changes in Sirius 7.1.0
      1. User-Visible Changes
      2. Specifier-Visible Changes
      3. Developer-Visible Changes
   4. Changes in Sirius 7.0.4
      1. User-Visible Changes
   5. Changes in Sirius 7.0.3
      1. Developer-Visible Changes
   6. Changes in Sirius 7.0.2
      1. Specifier-Visible Changes
      2. Developer-Visible Changes
   7. Changes in Sirius 7.0.1
      1. Developer-Visible Changes
   8. Changes in Sirius 7.0.0
      1. User-Visible Changes
      2. Developer-Visible Changes
   9. Changes in Sirius 6.6.0
      1. User-Visible Changes
      2. Developer-Visible Changes
   10. Changes in Sirius 6.5.1
       1. Developer-Visible Changes
   11. Changes in Sirius 6.5.0
       1. User-Visible Changes
       2. Specifier-Visible Changes
       3. Developer-Visible Changes

This document contains the release notes for recent major releases of Sirius. See also the release notes from previous versions for details about older releases.

Changes in Sirius 7.2.1

User-Visible Changes

• Modified Sequence diagrams are now correctly identified in the Sirius Session Details report (accessible with the “Properties” dialog on an aird file).
• Modified When a semantic modification is made on a diagram (e.g. Drag and Drop of an element), the notes and texts attached to the element remain attached, and the notes and texts contained in the element are preserved as much as possible.
• Modified When an element is deleted after drag and drop, its attached notes and texts are also removed if preference “Remove/hide note when the annotated element is removed/hidden” is enabled.

Specifier-Visible Changes

• Modified Three system properties have been added to allow the enablement of layout customizations for Regions (containers whose parent has a Children Presentation attribute set to Horizontal Stack or Vertical Stack):
  • -Dorg.eclipse.sirius.diagram.ui.internal.region.autosize.figure.optimized=true
    • When this system property is set to true, the auto-size layout of Regions is based on model constraints. It reduces the layout changes for such Regions after reopening of a diagram.
  • -Dorg.eclipse.sirius.diagram.ui.internal.region.autosize.action.optimized=true
    • When this system property is set to true, individual auto-size actions and status are enabled for Regions. Otherwise the auto-size actions and status are delegated and managed by the RegionContainer.
  • -Dorg.eclipse.sirius.diagram.ui.internal.region.content.canonical.layout.standard=true
    • When this system property is set to true, the centered layout will not be applied on the Regions content at RegionContainer creation time.

Developer-Visible Changes

Changes in org.eclipse.sirius.diagram.ui

Added org.eclipse.sirius.diagram.ui.business.api.query.NodeQuery.getFreeFormContainerCompartment() is added to get the compartment of the GMF node container with «free form» layout.
Added org.eclipse.sirius.diagram.ui.business.api.query.ViewQuery.isFreeFormContainer() and org.eclipse.sirius.diagram.ui.business.api.query.ViewQuery.isRegionContainer() are added to test if a GMF node is associated to DNodeContainer Sirius diagram element with respectively free form layout and stack layout (horizontal or vartical).
Added org.eclipse.sirius.diagram.ui.business.api.query.ViewQuery.isFreeFormCompartment() is added to test if a GMF node is compartment of node corresponding to a Sirius container free form.
Added org.eclipse.sirius.diagram.ui.business.api.query.ViewQuery.isNode() is added to test if a GMF node is associated to DNode Sirius diagram element.
Added org.eclipse.sirius.diagram.ui.business.api.query.ViewQuery.isNodeLabel() is added to test if a GMF node is associated to label of DNode Sirius diagram element.

Changes in Sirius 7.2.0

User-Visible Changes

• Modified Java 17 (or later) is now required to run Sirius.

Specifier-Visible Changes

• Added New decorators are now available for the beginning and edge of edges: CirclePlus, DiamondWithDot, FillDiamondWithDot, InputArrowWithDiamondAndDot, InputArrowWithDot, InputArrowWithFillDiamondAndDot.

Developer-Visible Changes

• Modified Java 17 is required as BREE and source level.

Changes in Sirius 7.1.0

User-Visible Changes

• Added In a tree editor, if the Shift key is pressed during using the left arrow key, a collapse all is done instead of a simple collapse. This is the same for expand with Shift + right arrow key. You can refer to navigation documentation for more details.
• Added A new mode has been added to paste the layout of elements between two diagrams. This mode is useful in case of diagrams having the same elements represented several times in a diagram or to copy the layout from a diagram having a hierarchy different than the target diagram. This mode is called “Optimized locations by group” (the existing mode is called “Similar locations in absolute coordinates”). With this new mode, the paste action groups elements having the same container in the target diagram. Then it applies the copied layout of these elements relative to each other, while maintaining the same location for the group in the target diagram. Examples are available in the corresponding documentation.
• Added The Distribute and Align actions are now also available on the label of edges. Previously, this kind of actions was available only on nodes. You can refer to Distribute elements documentation or Align elements documentation for more details.
• Modified In a tree editor, if the expand is done with the right arrow key, the behavior is now OK. Before this version, if the expand is done for the first time with the right arrow key, only a blank child is displayed. You can refer to bugzilla 549352 for more details.
• Modified In a tree or a table representation, the direct edit is no longer accessible with any alphanumeric character key pressed, but only with double-clicking or pressing F2 or Return (as the documentation always said). It is possible to restore the previous behavior by setting the system property org.eclipse.sirius.ui.restoreBehaviorEnablingDirectEditOnAlphanumericKey to true
• Modified The Sirius Session Details report (accessible with the “Properties” dialog on an aird file) is updated to always show the dependencies even for a not opened Session. The general dependencies are computed from serialized data. The image project dependencies are computed from the opened session or from the serialized data if the Session is not opened. A button is available to update image project dependencies.
• Modified The Copy action is now visible in the tabbar, of a diagram editor, when no diagram element is selected, before it was visible only when at least one diagram element is selected. And the drop-down menu for Paste actions is now visible in the tabbar, of a diagram editor, when at least one diagram element is selected, before it was visible only when no diagram element is selected.

Specifier-Visible Changes

• Added The system property org.eclipse.sirius.ui.enableCreatedElementsConstraintInSelectElementsListener has been added to allow to ignore the “created elements” constraint when the SelectDRepresentationElementsListener is called to select elements after a tool execution. In other words, this allows to select an element that is not created during the tool execution. The default value of the system property is true. It must be set to false to ignore the constraint.
• Modified A fix has been done to ensure that all the necessary interpreter variables are set when computing the conditional style expression whatever the context of call. Variables for Node and NodeContainer styles: (diagram, view, containerView, container) and for Edge style: (same than for Node, sourceView, targetView). Warning The impact is that, potentially, if you used the variables diagram or containerView in the precondition of your conditional styles, the precondition that returned false before the fix, could now returned true. So you may encounter different node or edge rendering.
• Added The enhancement of the properties views with the org.eclipse.sirius.properties.core.api.SiriusInputDescriptor and org.eclipse.sirius.properties.core.internal.SiriusToolServices classes allows to use the list of selected elements in order to exploit additional informations. It is now possible to retrieve the list of selected elements via an aql expression like aql:input.getSelectedOriginalSelections(), the list of semantic elements with aql:input.getSelectedSemanticElements() and the list of contexts with aql:input.getContextSelections().

Developer-Visible Changes

• Added The interface org.eclipse.sirius.ecore.extender.business.api.permission.IPermissionAuthority now has a isFrozen(EObject) method. This is a status handled by the collaborative plugins, but this new API makes this status available for queries from Sirius core plugins.

Changes in org.eclipse.sirius

• Added The method org.eclipse.sirius.business.api.helper.task.DeleteEObjectTask.getEObjectToDelete() has been added to get the EObject that will be deleted by this task.
• Added org.eclipse.sirius.business.api.refresh.RepresentationTimeStampInformationSupplierRegistry and org.eclipse.sirius.business.api.refresh.RepresentationTimeStampInformationSupplier have been added. The first is the registry to register instance of the second that allows to tell when the DRepresentationDescriptor.changeId is updated or not.
• AddedThe class org.eclipse.sirius.business.api.query.SiriusProjectDependencyQuery is added to get project

dependencies from a given project.

• AddedThe method org.eclipse.sirius.business.api.session.Session.getSharedMainDAnalysis() is added to get the DAnalysis that holds data and can be shared in some context such as CDO.

Changes in org.eclipse.sirius.diagram.ui

• Added Two new preferences have been added in org.eclipse.sirius.diagram.ui.tools.api.preferences.SiriusDiagramUiPreferencesKeys:
  • PREF_PROMPT_PASTE_MODE: A boolean preference to say if the paste mode must be requested at each “Paste format” or “Paste layout” action.
  • PREF_PASTE_MODE_ABSOLUTE: : A boolean preference for the paste mode, true for “Absolute” mode, false for “Bounding box” mode. This preference is changed as soon as the user changes the selection in the dialog asking the mode. Thereby, at the next dialog, the last choice is pre-selected.
    • If the PREF_PROMPT_PASTE_MODE is true, this preference is used to pre-select the choice in the dialog.
    • If the PREF_PROMPT_PASTE_MODE is false, this preference is used as the Paste mode to apply.

The Sirius default values for these preferences can be overridden for a specific product. For example:

    // Preference customization for plugin "org.eclipse.sirius.diagram.ui"
    IEclipsePreferences diagramPreferences = DefaultScope.INSTANCE.getNode(org.eclipse.sirius.diagram.ui.provider.DiagramUIPlugin.ID);
    // By default override the PREF_PROMPT_PASTE_MODE default value
    diagramPreferences.putBoolean(SiriusDiagramUiPreferencesKeys.PREF_PROMPT_PASTE_MODE, false);

• Added Two new methods have been added in org.eclipse.sirius.diagram.ui.tools.api.format.SiriusFormatDataManager to allow to paste the layout on a subpart of the children of a container and not on all children of this container: applyLayout(IGraphicalEditPart, List<IGraphicalEditPart>, boolean) and applyFormat(IGraphicalEditPart, List<IGraphicalEditPart>, boolean). A default implementation is available in org.eclipse.sirius.diagram.ui.tools.api.format.AbstractSiriusFormatDataManager.

Changes in org.eclipse.sirius.tests.swtbot.support

• Added Two new methods have been added in org.eclipse.sirius.tests.swtbot.support.api.editor.SWTBotSiriusDiagramEditor: getAbsoluteLocation(String, Class<? extends EditPart>, boolean) and getAbsoluteLocation(GraphicalEditPart, boolean). Only a boolean parameter has been added to two existing methods (same name without last boolean parameter). This boolean allows to consider, or note, the label of an edge in the bounds computation.

Changes in org.eclipse.sirius.properties.core

• Added The org.eclipse.sirius.properties.core.api.SiriusInputDescriptor class has been modified to handle the selection of many elements by creating a list of SiriusContext. This enhancement allows to access the list of selected semantic elements with org.eclipse.sirius.properties.core.api.SiriusInputDescriptor.getSemanticElements() and the list of original selected objects with org.eclipse.sirius.properties.core.api.SiriusInputDescriptor.getOriginalSelections().

Migrations

• ModifiedThe migration participant introduced by Bug 576423 - Incorrect representation size when using 'Size Computation Expression' was wrongly resizing the GMF bounds of collapsed nodes. org.eclipse.sirius.diagram.ui.business.internal.migration.WorkspaceImageGMFBoundsMigrationParticipant migration participant has been modified to fix the previous version 15.0.0.202201261500 . The corresponding version, stored in attribute version of viewpoint:DAnalysis of the aird file, is 15.0.0.202209061200.
• Modified The migration participant org.eclipse.sirius.diagram.ui.business.internal.migration.SetChangeIdMigrationParticipant that set a changeId value for each DRepresentationDescriptor that did not have one has been changed. The migration participant now sets a time stamp that represents the absolute time. The corresponding version, stored in the attribute version of viewpoint:DAnalysis of the aird file, is 15.1.0.202211301600.

Changes in Sirius 7.0.4

User-Visible Changes

Minor release to avoid errors thrown during indirect deletion of edges whose label is selected (deletion done from outside the diagram editor or from a custom command).

Changes in Sirius 7.0.3

Developer-Visible Changes

• Removed To ensure compatibility with Eclipse 2022-09, dependency to com.ibm.icu has been removed.

Changes in Sirius 7.0.2

Specifier-Visible Changes

• Added The variables edgeView and otherEnd are now also available during precondition evaluation of a reconnect tool. Before, these variables were available only during the reconnection tool execution.

Developer-Visible Changes

Changes in org.eclipse.sirius

• Added The method org.eclipse.sirius.business.api.helper.task.TaskHelper.checkPrecondition(EObject, AbstractToolDescription, Map<String, EObject>, boolean, boolean) has been added to factorize code for the evaluation of a tool precondition.

Changes in org.eclipse.sirius.common

• Added The method org.eclipse.sirius.common.tools.api.interpreter.VariableType.fromVariableTypes(VariableType...) has been added to create a new VariableType from a list of other VariableTypes, ie a concatenation without duplicate.

Changes in org.eclipse.sirius.diagram

• Added The name for variables edgeView and otherEnd is now available in org.eclipse.sirius.diagram.tools.api.interpreter.IInterpreterSiriusDiagramVariables. Before, it was duplicated constants in several classes.

Changes in Sirius 7.0.1

Developer-Visible Changes

• Modified The behavior concerning SVG images export has been improved. You can refer to bugzilla 578509 for more details. This behavior is activated by default but you may disable it by setting the system property org.eclipse.sirius.diagram.ui.enableEmbeddedSVGInSVGExport to false.

Changes in Sirius 7.0.0

User-Visible Changes

• Added Some enhancement have been done about the images management.
  • The selection of images from the workspace to change the style of an element in a diagram has been improved. The UI can now provide a preview of the images on the workspace by displaying them in a gallery based on the selected project or directory.
  • A new constraint used for the “Diagram validation” has been added to check that images used by the models are reachable. A quick fix, available on the marker, allows to select a new image in the workspace.
• Modified The Sirius constraints, used for the model validation, have been re-categorized (visible in Preferences) to better understand where they are defined and on which model they apply.

• Modified It is now possible to move a regions container by moving one of its region with the “Ctrl” shortcut key pressed. In the same way, it is now possible to select a regions container by clicking on one of its region with the “Ctrl” shortcut key pressed.
• Removed It is no longer possible to change the workspace image of a diagram element with an image from an internal plugin via the “Set style to workspace image” action. This functionality affects a very small part of the use cases. The new UI of the “Set style to workspace image” action does not support this advanced functionality. However, it is still possible to go through Properties > Style > Workspace Image, then paste the path of the internal plugin image.

Developer-Visible Changes

• Added Sirius core and dialects metamodels have been extracted in new .model plugins with minimum dependencies. Each new plugin is re-exported by the plugin which was the previous container of its metamodel. The base packages of the generated code has not been modified. Each API modification is listed in the corresponding plugin section. Additional dialect providers and extension providers might have to modify the path or references to Sirius .ecore and .genmodel files to reflect this change. The new plugins are:
  • org.eclipse.sirius.model, re-exported by org.eclipse.sirius
  • org.eclipse.sirius.diagram.model, re-exported by org.eclipse.sirius.diagram
  • org.eclipse.sirius.diagram.sequence.model, re-exported by org.eclipse.sirius.diagram.sequence
  • org.eclipse.sirius.table.model, re-exported by org.eclipse.sirius.table
  • org.eclipse.sirius.tree.model, re-exported by org.eclipse.sirius.tree
• Modified The behavior of arrange at opening has been changed/fixed (only one arrange instead of two for examples). You can refer to bugzilla 577676 for more details. Maybe your modeler rely on this “buggy behavior” or maybe some impacts have not yet been detected. If you notice a problem, you can retrieve the previous behavior by setting the system property org.eclipse.sirius.diagram.ui.disableArrangeAtOpeningChanges to true. You can also create a specific bugzilla to explain the problem. This system property is temporary and will be removed in one or two versions.
• Modified The behavior concerning layout of regions container has been improved. You can refer to bugzilla 576305 for more details. Maybe your modeler rely on this “buggy behavior” or maybe some impacts have not yet been detected. As a reminder, assembling multiple region containers is not supported. These changes are improving the situation but maybe not in your modeler. If you notice a problem, you can retrieve the previous behavior by setting the system property org.eclipse.sirius.diagram.ui.disableHStackContainerNewBehavior to true. You can also create a specific bugzilla to explain the problem. This system property is temporary and will be removed in one or two versions.
• Modified The org.eclipse.sirius.ext.base.Option<T> helper type has been deprecated for removal. It will be progressively replaced by the standard java.util.Optional type in our APIs.
• Removed The “Workflow” feature has been removed . Workflow was experimental and to our knowledge not used in practice. This corresponds to the org.eclipse.sirius.workflow.* and org.eclipse.sirius.editor.workflow plug-ins.
• Removed The server parts which supported the Workflow feature has been removed too. It was our first experiment in moving Sirius to the web, but this is now replaced by the newly published Sirius Web. This corresponds to all the org.eclipse.sirius.server.* plug-ins.
• Added The method org.eclipse.sirius.business.api.query.DRepresentationDescriptorQuery.isRepresentationReachable(boolean) was added to allow it to load the representation in order to verify that the representation element is reachable, not just its resource. To benefit from this new method, org.eclipse.sirius.business.api.query.DRepresentationDescriptorQuery.isRepresentationValid(boolean) and org.eclipse.sirius.business.api.query.DRepresentationDescriptorQuery.DRepresentationDescriptorValidityAdapter.triggerRepresentationValidation(boolean) were also created. These new methods (with a parameter value true) can be used in tests, but should not be used by the “Model explorer” view otherwise there would be no more lazy loading of representations.

Changes in org.eclipse.sirius

• Added The classes org.eclipse.sirius.business.api.image.ImageManager and org.eclipse.sirius.business.api.image.Base64ImageHelper have been added to support image management such as image creation from base64 string or image path serialization.
• Added The class org.eclipse.sirius.business.api.query.SiriusReferenceFinderCache has been added. This cache allows to avoid redundant computing to find impacted DRepresentationDescriptors returned by org.eclipse.sirius.business.api.query.SiriusReferenceFinder.getImpactedRepresentationDescriptors.
• Added org.eclipse.sirius.business.api.query.SiriusReferenceFinder.CACHE is a convenience to use org.eclipse.sirius.business.api.query.SiriusReferenceFinderCache.
• Modified org.eclipse.sirius.viewpoint.SiriusPlugin has been renamed to org.eclipse.sirius.tools.api.SiriusPlugin
• Modified org.eclipse.sirius.viewpoint.Messages has been renamed to org.eclipse.sirius.tools.api.Messages
• Modified org.eclipse.sirius.business.api.helper.ViewpointUtil has been deprecated, org.eclipse.sirius.model.business.api.helper.ViewpointUtil from plugin org.eclipse.sirius.model should be used instead.
• Modified org.eclipse.sirius.business.api.resource.ResourceDescriptor has been moved to org.eclipse.sirius.model plugin alongside with code generated from Sirius metamodel as it is one of its data type.
• Modified The package org.eclipse.sirius.business.api.resource has been renamed to org.eclipse.sirius.business.api.resource.support. Impacted classes are org.eclipse.sirius.business.api.resource.support.LoadEMFResource and org.eclipse.sirius.business.api.resource.support.WorkspaceDragAndDropSupport.
• Modified org.eclipse.sirius.tools.api.ui.color.EnvironmentSystemColorFactory has been moved to org.eclipse.sirius.model plugin.
• Modified Methods org.eclipse.sirius.business.api.session.danalysis.DAnalysisSelector.selectSmartlyAnalysisForAddedResource(Resource, Collection<DAnalysis>) and org.eclipse.sirius.business.api.session.danalysis.DAnalysisSessionHelper.selectAnalysis(Resource, Collection<DAnalysis>, DAnalysisSelector) have been deprecated for removal in a future version.

Changes in org.eclipse.sirius.common

• Added The method org.eclipse.sirius.common.tools.api.resource.FileProvider.exists(IPath) and org.eclipse.sirius.common.tools.api.resource.IFileGetter.exists(IPath) have been added to know if a path leads to an existing file.

Changes in org.eclipse.sirius.diagram

• Modified org.eclipse.sirius.diagram.DiagramPlugin has been renamed to org.eclipse.sirius.diagram.tools.api.DiagramPlugin.
• Modified org.eclipse.sirius.diagram.Messages has been renamed to org.eclipse.sirius.diagram.tools.api.Messages.
• Added eventShouldTriggerArrange(OperationHistoryEvent) in org.eclipse.sirius.diagram.business.api.diagramtype.IDiagramDescriptionProvider This method is used to avoid an arrange to be launch for a specific event if it is not necessary for a specific diagram description.
• Added org.eclipse.sirius.diagram.business.api.helper.graphicalfilters.HideFilterHelper.hideLabel(DDiagramElement, Map<EObject, List<Integer>>) has been added in order to hide a list of labels of a diagram element. This is dedicated to DEdge that can have up to 3 labels. The list of Integer correspond to the VisualID of the corresponding edge label edit part.
• Added org.eclipse.sirius.diagram.business.api.helper.graphicalfilters.HideFilterHelper.revealLabel(DDiagramElement, Map<EObject, List<Integer>>) has been added in order to reveal a list of labels of a diagram element. This is dedicated to DEdge that can have up to 3 labels. The list of Integer correspond to the VisualID of the corresponding edge label edit part.
• Added org.eclipse.sirius.diagram.tools.api.command.IDiagramCommandFactory.buildHideLabelSelectionCommand(Set<EObject>, Map<EObject, List<Integer>>) has been added to forward the labels of an edge to hide to the command.
• Added org.eclipse.sirius.diagram.tools.api.command.IDiagramCommandFactory.buildRevealLabelSelectionCommand(DDiagramElement, Map<EObject, List<Integer>>) has been added to forward the labels of an edge to reveal to the command.
• Added org.eclipse.sirius.diagram.tools.api.command.view.HideDDiagramElementLabel.HideDDiagramElementLabel(TransactionalEditingDomain, Set<?>, Map<EObject, List<Integer>>) has a new constructor in order to give the list of labels of an edge to hide.
• Added org.eclipse.sirius.diagram.tools.api.command.view.RevealDDiagramElementsLabel.RevealDDiagramElementsLabel(TransactionalEditingDomain, Set<DDiagramElement>, Map<EObject, List<Integer>>) has a new constructor in order to give the list of labels of an edge to reveal.
• Added org.eclipse.sirius.diagram.business.api.query.DDiagramElementQuery.hasAnyHiddenLabel() has been added in order to check if at least one label of a DDiagramElement is hidden.
• Added org.eclipse.sirius.diagram.business.api.query.DDiagramElementQuery.areAllLabelsHidden() has been added in order to check if at all labels of a DDiagramElement are hidden.
• Added org.eclipse.sirius.diagram.business.api.query.DDiagramElementQuery.areAllLabelsHidden(List<Integer>) has been added in order to check if at all labels of the given collection concerning a DDiagramElement are hidden.
• Added org.eclipse.sirius.diagram.business.api.query.DDiagramElementQuery.isLabelHidden(int) has been added in order to check if one label in particular of a DDiagramElement is hidden.
• Added org.eclipse.sirius.diagram.business.api.query.DEdgeQuery.howManyLabels() has been added in order to return how many labels an edge has.
• Added org.eclipse.sirius.diagram.business.api.query.DEdgeQuery.areAllLabelsHidden() has been added in order to check if at all labels of a DEdge are hidden.

Changes in org.eclipse.sirius.diagram.model

• Removed The DiagramDescription::allTools operation has been removed from the Diagram metamodel. The corresponding method has been removed from generated code. Calls to org.eclipse.sirius.diagram.description.DiagramDescription.getAllTools() should be replaced by new org.eclipse.sirius.diagram.business.api.query.DiagramDescriptionQuery(diagramDescription).getAllTools().
• Removed The DiagramDescription::allEdgeMappings operation has been removed from the Diagram metamodel. The corresponding method has been removed from generated code. Calls to org.eclipse.sirius.diagram.description.DiagramDescription.getAllEdgeMappings() should be replaced by org.eclipse.sirius.diagram.business.internal.metamodel.helper.ContentHelper.getAllEdgeMappings(diagramDescription, false) alongside with the getAllNodeMappings and getAllContainerMappings methods.

Changes in org.eclipse.sirius.diagram.ui

• Added The class org.eclipse.sirius.diagram.ui.business.api.image.WorkspaceImageHelper has been added, it includes most of the methods that previously existed in org.eclipse.sirius.diagram.ui.business.api.image.ImageSelectorService. The affected methods are:
  • Added org.eclipse.sirius.diagram.ui.business.api.image.WorkspaceImageHelper.updateStyle(BasicLabelStyle, String), which was previously org.eclipse.sirius.diagram.ui.business.api.image.ImageSelectorService.updateStyle(BasicLabelStyle, String).
  • Added org.eclipse.sirius.diagram.ui.business.api.image.WorkspaceImageHelper.updateWorkspacePath(BasicLabelStyle, String), which was previously org.eclipse.sirius.diagram.ui.business.api.image.ImageSelectorService.updateWorkspacePath(BasicLabelStyle, String).
• Added org.eclipse.sirius.diagram.ui.business.api.image.ImageSelectionDialog has been added to replace the org.eclipse.sirius.common.ui.tools.api.resource.WorkspaceResourceDialogWithFilter dialog which was used to select a background image for a diagram element. org.eclipse.sirius.diagram.ui.business.api.image.ImageSelectionDialog now provides a new simpler and more complete UI.
• Added org.eclipse.sirius.diagram.ui.business.api.image.ITreeImagesContentProvider has been added to allow the implementation of an org.eclipse.jface.viewers.ITreeContentProvider that can be used by org.eclipse.sirius.diagram.ui.business.api.image.ImageSelectionDialog to retrieve image information.
• Added org.eclipse.sirius.diagram.ui.business.api.image.ImageFiltersUtils provides the filter used by the TreeViewer in the ImageSelectionDialog as well as various utility methods to identify the supported image formats.
• Added org.eclipse.sirius.diagram.ui.business.api.image.GallerySelectable provides an implementation of org.eclipse.sirius.diagram.ui.tools.internal.dialogs.widgets.gallery.Gallery which allows to select items in the gallery. This is mostly used in tests. GallerySelectable allows to use the org.eclipse.sirius.diagram.ui.tools.internal.dialogs.widgets.gallery.Gallery in ImageSelectionDialog implementations.
• Added 2 methods have been added in org.eclipse.sirius.diagram.ui.tools.api.editor.DDiagramEditor: enableFireNotification() to enable the fire notification, ie it causes the editor to fire selection changed notification to all listeners when SelectionManager#fireSelectionChanged() is called, and disableFireNotification() to disable it. It is used internally, among others, to disable the notification during a drag’n’drop of an element or during the reconnection of an edge.
• Modified org.eclipse.sirius.diagram.ui now depends on GMF Runtime 1.14.0, which itself uses Apache Batik 1.14.0 to support SVG (both rendering SVG images on diagrams and exporting diagrams to SVG files). As a result, exporting diagrams to PDF is not supported anymore (as GMF Runtime 1.14.0 itself has dropped support for this).
• Modified org.eclipse.sirius.diagram.ui.business.api.image.ImageSelector has been modified to support multiple image selection. The enum org.eclipse.sirius.diagram.ui.business.api.image.ImageSelector.SelectionMode can be used to define the selection mode supported: MONO_SELECTION for a single selection or MULTI_SELECTION for a multiple selection. The method org.eclipse.sirius.diagram.ui.business.api.image.ImageSelector.selectImages(EObject, SelectionMode) has been updated to handle this selection mode as a parameter and now returns the list of selected images as a List<String>.
• Modified The class org.eclipse.sirius.diagram.ui.business.api.image.WorkspaceImageSelector has been modified to implement the interface ImageSelector and the update of its ImageSelector.selectImages(EObject, SelectionMode) method.
• Modified org.eclipse.sirius.diagram.ui.business.api.image.ImageSelectorService has been split in a new lighter ImageSelectorService which aims to get an ImageSelector. The other methods have been moved to org.eclipse.sirius.diagram.ui.business.api.image.WorkspaceImageHelper.
• Added org.eclipse.sirius.diagram.ui.tools.internal.util.EditPartQuery.getVisualID() has been added in order to return the VisualID field value if there is one.
• Added org.eclipse.sirius.diagram.ui.tools.api.figure.FigureQuery.edgeLabelViewConstantToVisualID(int) has been added in order to convert LabelViewConstant values to the equivalent VisualID from the label edit parts.
• Added org.eclipse.sirius.diagram.ui.tools.api.figure.SiriusWrapLabelWithAttachment.getLocationField() was added in order to have a public access to the location value.
• Added org.eclipse.sirius.diagram.ui.business.api.provider.DEdgeBeginLabelItemProvider, org.eclipse.sirius.diagram.ui.business.api.provider.DEdgeEndLabelItemProvider and org.eclipse.sirius.diagram.ui.business.api.provider.DEdgeLabelItemProvider methods equals and hashCode have been overridden in order to differentiate them in an HashSet.

Changes in org.eclipse.sirius.common.ui

• Modified The class org.eclipse.sirius.common.ui.tools.api.resource.WorkspaceResourceDialogWithFilter is now deprecated. The use of org.eclipse.sirius.diagram.ui.business.api.image.ImageSelectionDialog is now favored to provide a dialog to select a background image of a diagram element.

Changes in org.eclipse.sirius.diagram.sequence

• Modified org.eclipse.sirius.diagram.sequence.util.Range has been moved to org.eclipse.sirius.diagram.sequence.business.api.util.Range
• Modified org.eclipse.sirius.diagram.sequence.util.Pair has been moved to org.eclipse.sirius.diagram.sequence.business.api.util.Pair
• Modified org.eclipse.sirius.diagram.sequence.Messages has been moved to org.eclipse.sirius.diagram.sequence.tool.internal.Messages.

Changes in org.eclipse.sirius.tests.swtbot.support

• Added The method org.eclipse.sirius.tests.swtbot.support.api.editor.SWTBotSiriusHelper.selectGalleryItem(SWTBot, String) has been added in order to select an item in the Gallery in the new org.eclipse.sirius.diagram.ui.business.api.image.ImageSelectionDialog.
• Added The condition org.eclipse.sirius.tests.swtbot.support.api.condition.CheckNbVisibleElementsInGallery has been added to avoid tests failing because of images that have not finished loading.
• Removed The method org.eclipse.sirius.tests.swtbot.support.api.AbstractSiriusSwtBotGefTestCase.getNbStatusInErrorLog() has been removed. It is not reliable (sometimes the number of elements returned is 0 instead of the real number). It should be replaced by doesAnErrorOccurs() and doesAWarningOccurs().

Changes in org.eclipse.sirius.tests.junit.support

• Added The method org.eclipse.sirius.tests.support.api.SiriusTestCase.copyAllFiles(String, String, String) and org.eclipse.sirius.tests.support.api.EclipseTestsSupportHelper.copyDirectory(String, String) have been added to ease to the copy of the test files from the test plugin to the junit workspace.

Migrations

• Added A migration participant has been added to repair size of GMF nodes with Workspace Image style description. A default size was set for this type of nodes, which resulted in graphical inconsistencies (see Bug 576423 - Incorrect representation size when using 'Size Computation Expression' . With the org.eclipse.sirius.diagram.ui.business.internal.migration.WorkspaceImageGMFBoundsMigrationParticipant migration participant, the size of these nodes was recomputed according to the Size Computation Expression defined in the VSM. The corresponding version, stored in attribute version of viewpoint:DAnalysis of the aird file, is 15.0.0.202201261500.

Changes in Sirius 6.6.0

User-Visible Changes

• Added 4 new actions have been added to control the “z-order” of edges. These actions are mainly useful in the context of jump links. Similar actions already existed for nodes but not for edges. A chapter dedicated to these new actions has been added in Sirius User Manual.
• Removed To be coherent, the actions available “Diagram/Order” menu of Eclipse menu bar have been removed. Indeed, these actions are always visible but only valid for nodes. Now, only the contextual menus are to be used (for nodes or for edges).

Developer-Visible Changes

Changes in org.eclipse.sirius.diagram

• Added New methods returning z-order commands have been added in org.eclipse.sirius.diagram.tools.api.command.IDiagramCommandFactory to support the new z-order actions on edges. The returned commands are currently only used by new actions for edges but they also manage nodes (same code than in existing GMF commands).
  • buildBringToFrontCommand(List<? extends View>): Build a command that is able to bring to the front many elements. These elements, nodes or edges, must be of the same type and have the same parent.
  • buildSendToBackCommand(List<? extends View>: Build a command that is able to send to the back many elements. These elements, nodes or edges, must be of the same type and have the same parent.
  • buildBringForwardCommand(List<? extends View>): Build a command that is able to bring forward many elements. These elements, nodes or edges, must be of the same type and have the same parent.
  • buildSendBackwardCommand(List<? extends View>): Build a command that is able to send backward many elements. These elements, nodes or edges, must be of the same type and have the same parent.
• Added The 4 commands corresponding to the above method has been added as API:
  • org.eclipse.sirius.diagram.tools.api.command.view.BringForwardElements
  • org.eclipse.sirius.diagram.tools.api.command.view.BringToFrontElements
  • org.eclipse.sirius.diagram.tools.api.command.view.SendBackwardElements
  • org.eclipse.sirius.diagram.tools.api.command.view.SendToBackElements

Changes in org.eclipse.sirius.diagram.ui

• * Modified The method org.eclipse.sirius.diagram.ui.edit.api.part.AbstractDDiagramEditPart.refreshChildren() has been overridden to redraw the edges figures according to the order of the GMF edges.

Migrations

• Added A migration participant has been added to set a changeId value for each DRepresentationDescriptor that did not have one. Some old models were missing the changeId attribute, which could lead to technical problems. The migration participant org.eclipse.sirius.diagram.ui.business.internal.migration.SetChangeIdMigrationParticipant sets a random changeId if it didn’t already exist. The corresponding version, stored in attribute version of viewpoint:DAnalysis of the aird file, is 14.6.0.202110251100.
• Added A migration participant has been added to sort GMF edges order. The goal is to have edges displayed as before “edges z-order” improvement. Indeed, the display now consider order of GMF edges instead of order of its sources/targets.The corresponding version, stored in attribute version of viewpoint:DAnalysis of the aird file, is 14.6.0.202109231100.

Changes in Sirius 6.5.1

Developer-Visible Changes

Migrations

• Modified The migration participant org.eclipse.sirius.diagram.ui.business.internal.migration.NoteShapeDefaultLabelAlignmentMigrationParticipant has been updated to repair Notes with a potential wrong vertical label alignment. This problem can occur since Sirius 6.3.2 used in a collaborative environment, Obeo Designer Team Edition or Team For Capella for example. The corresponding version, stored in the attribute version of viewpoint:DAnalysis of the aird file, is 14.5.1.202106111100 (migration added in Sirius 6.5.1).

Changes in Sirius 6.5.0

User-Visible Changes

• Added It is possible to override at the aird level both “Sirius/Do Refresh on representation opening” and “Sirius/Automatic refresh” preferences. To override the preferences, right-click on the aird file, select “Properties”, and in the dialog go to the “Sirius settings” section. The preferences are stored in the project scope and associated to the aird file. For more details, refer the documentation .
• Added A new tab has been added in the properties dialog box, when an aird is selected, to present technical information about the Sirius Session. For more details, refer the documentation .

Specifier-Visible Changes

• Added A new CellEditor tool is available for feature column mapping of edition table. It allows to define a specific org.eclipse.jface.viewers.CellEditor to edit a cell (see documentation for more details).
• Modified ELK integration now handles “egde on edge” case. As reminder, Sirius allows to have an edge as source or target of another edge. This kind of construction is not allowed by ELK. Sirius 6.5.0 introduces a specific transformation from Sirius graph to EKL graph (and reciprocally) in

order, despite this problem, to have a satisfactory layout result. This new behavior has been tested with ELK Layered algorithm with option Node Placement Strategy set to NETWORK_SIMPLEX. There is no guarantee with other kind of layouts. All cases are not supported. Further additional developments are needed to support more. There are probably still some constructions not correctly handled but it is a first step. As example, the edges with label(s) have not been tested. Here is a list of supported/tested cases:

• • An edge having another edge as source,
  • An edge having another edge as target,
  • An edge that is the source of several edges,
  • An edge that is the target of several edges.

Developer-Visible Changes

• Added It is now possible to keep semantic element traceability during the representation export. For now, this option is only supported for diagram SVG export. In this case, a new attribute diagram:targetSemanticId is added on SVG elements to reference the target semantic id on which the graphical element is based on. This option can be activated programmatically or by setting a preference. See the details below:
  • Added The constructor org.eclipse.sirius.diagram.ui.tools.api.part.DiagramEditPartService.DiagramEditPartService(boolean) has been added to make it possible to activate the semantic traceability during the SVG export. Note that this constructor will also be called by org.eclipse.sirius.ui.business.api.dialect.DialectUIServices.exportWithResult with the ExportFormat as parameter, which own the SemanticTraceabilityEnabled value.
  • Added In org.eclipse.sirius.ui.business.api.dialect.ExportFormat, setSemanticTraceabilityEnabled(boolean) and isSemanticTraceabilityEnabled() have been added to specify through the ExportFormat if the traceability should be enabled.
  • Added org.eclipse.sirius.ui.business.api.preferences.SiriusUIPreferencesKeys.PREF_EXPORT_SEMANTIC_TRACEABILITY has been added to make it possible to activate the traceability on representation export. This will activate the traceability for any export by using the user interface (through the export specific wizard) or by calling the ExportAction. Direct calls to the DialectUIServices.exportWithResult are not impacted.
• Modified Upgraded ELK version from 0.7.0 to 0.7.1, see the ELK documentation for the list of changes in that version (and previous).

Changes in org.eclipse.sirius

• Added The API org.eclipse.sirius.business.api.session.SiriusPreferences has been added to get preferences related to a Sirius Session that is to a main aird file. An instance of this API can be accessed with org.eclipse.sirius.business.api.session.Session.getSiriusPreferences(). Both org.eclipse.sirius.business.api.preferences.SiriusPreferencesKeys.PREF_AUTO_REFRESH and org.eclipse.sirius.ui.business.api.preferences.SiriusUIPreferencesKeys.PREF_REFRESH_ON_REPRESENTATION_OPENING should not be used any more by clients with Eclipse preference API but org.eclipse.sirius.business.api.session.SiriusPreferences.isAutoRefresh() and org.eclipse.sirius.business.api.session.SiriusPreferences.isRefreshAtRepresentationOpening() should be used instead.

The reason is that the implementation of SiriusPreferences wraps the logic of getting or storing the preferences on a ProjectScope.

• Removed org.eclipse.sirius.tools.api.ui.RefreshHelper.isAutoRefresh() has been removed. Clients should call Session.getPreferences.isAutoRefresh() or new DRepresentationQuery(DRpresentation).isAutoRefresh() instead.
• Removed org.eclipse.sirius.diagram.ui.tools.api.properties.PropertiesService, org.eclipse.sirius.tools.api.ui.property.IPropertiesProvider and org.eclipse.sirius.diagram.ui.tools.internal.properties.SiriusDiagramEditorPropertiesProvider have been removed. Clients should call Session.getPreferences.isAutoRefresh() or new DRepresentationQuery(DRpresentation).isAutoRefresh() instead.

Changes in org.eclipse.sirius.diagram.ui

• Added The method org.eclipse.sirius.diagram.ui.tools.api.format.AbstractSiriusFormatDataManager.logUnhandledDiagramElementKindMessage(Object) has been added to mutualize the code concerning the log of a warning for Object not managed by the SiriusLayoutDataManager. This method avoids to log a message for DNodeListElement, as it is expected that nothing is stored in LayoutDataManager for DNodeListElement as their location and size are constrained by their parents.

Changes in org.eclipse.sirius.ui

• Removed org.eclipse.sirius.ui.business.api.dialect.DialectUIManager.isRefreshActivatedOnRepresentationOpening() has been removed. Use org.eclipse.sirius.business.api.session.SiriusPreferences.isRefreshAtRepresentationOpening() instead.

Changes in org.eclipse.sirius.ecore.extender

• Added The method org.eclipse.sirius.ecore.extender.business.api.permission.IPermissionAuthority.getLockedObjects() has been added the get all the locked objects.

Changes in org.eclipse.sirius.ext.gmf.runtime

• Added The API org.eclipse.sirius.ext.gmf.runtime.gef.ui.figures.IFigureWithoutLabels has been created so that a Figure, that implements this API, can provide its bounds without considering its labels. The method org.eclipse.sirius.ext.gmf.runtime.editparts.GraphicalHelper.getAbsoluteBoundsWithoutLabelsIn100Percent(GraphicalEditPart) has been added to get the rectangle bounds without taking labels into account. This is used, in particular, to compute the bendpoints of an edge when the source or the target of the edge is an edge.

Migrations

• Added A migration participant has been added to repair rectilinear edges containing only one bendpoint. Bracket edges are not relevant. The corresponding version, stored in attribute version of viewpoint:DAnalysis of the aird file, is 14.5.0.202104070943.
• Added A migration participant has been added to unset originalStyle features. This feature is no longer used by Sirius and, if set, it may cause errors when loading the aird because of dangling reference. The corresponding version, stored in attribute version of viewpoint:DAnalysis of the aird file, is 14.5.0.202104161500.