Update documentation for v6.2.1
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
diff --git a/doc/Release_Notes.html b/doc/Release_Notes.html
index 943a4d2..b227842 100644
--- a/doc/Release_Notes.html
+++ b/doc/Release_Notes.html
@@ -13,6 +13,14 @@
<a href="#ReleaseNotesforSirius">Release Notes for Sirius</a>
<ol style="list-style: disc;">
<li>
+ <a href="#sirius6.2.1">Changes in Sirius 6.2.1</a>
+ <ol style="list-style: disc;">
+ <li>
+ <a href="#DeveloperVisibleChanges">Developer-Visible Changes</a>
+ </li>
+ </ol>
+ </li>
+ <li>
<a href="#sirius6.2.0">Changes in Sirius 6.2.0</a>
<ol style="list-style: disc;">
<li>
@@ -22,7 +30,7 @@
<a href="#SpecifierVisibleChanges">Specifier-Visible Changes</a>
</li>
<li>
- <a href="#DeveloperVisibleChanges">Developer-Visible Changes</a>
+ <a href="#DeveloperVisibleChanges2">Developer-Visible Changes</a>
</li>
</ol>
</li>
@@ -33,7 +41,7 @@
<a href="#UserVisibleChanges2">User-Visible Changes</a>
</li>
<li>
- <a href="#DeveloperVisibleChanges2">Developer-Visible Changes</a>
+ <a href="#DeveloperVisibleChanges3">Developer-Visible Changes</a>
</li>
</ol>
</li>
@@ -55,7 +63,7 @@
<a href="#SpecifierVisibleChanges2">Specifier-Visible Changes</a>
</li>
<li>
- <a href="#DeveloperVisibleChanges3">Developer-Visible Changes</a>
+ <a href="#DeveloperVisibleChanges4">Developer-Visible Changes</a>
</li>
</ol>
</li>
@@ -69,7 +77,7 @@
<a href="#SpecifierVisibleChanges3">Specifier-Visible Changes</a>
</li>
<li>
- <a href="#DeveloperVisibleChanges4">Developer-Visible Changes</a>
+ <a href="#DeveloperVisibleChanges5">Developer-Visible Changes</a>
</li>
</ol>
</li>
@@ -80,7 +88,7 @@
<a href="#UserVisibleChanges5">User-Visible Changes</a>
</li>
<li>
- <a href="#DeveloperVisibleChanges5">Developer-Visible Changes</a>
+ <a href="#DeveloperVisibleChanges6">Developer-Visible Changes</a>
</li>
</ol>
</li>
@@ -94,7 +102,7 @@
<a href="#SpecifierVisibleChanges4">Specifier-Visible Changes</a>
</li>
<li>
- <a href="#DeveloperVisibleChanges6">Developer-Visible Changes</a>
+ <a href="#DeveloperVisibleChanges7">Developer-Visible Changes</a>
</li>
</ol>
</li>
@@ -104,6 +112,61 @@
<p>This document contains the release notes for recent major releases of Sirius. See also
<a href="Release_Notes_Previous.html">the release notes from previous versions</a> for details about older releases.
</p>
+ <h2 id="sirius6.2.1">Changes in Sirius 6.2.1</h2>
+ <h3 id="DeveloperVisibleChanges">Developer-Visible Changes</h3>
+ <h4 id="Changesinorg.eclipse.sirius">Changes in
+ <code>org.eclipse.sirius</code>
+ </h4>
+ <ul>
+ <li><span class="label label-success">Added</span> Added a constructor
+ <code>org.eclipse.sirius.business.api.query.DRepresentationQuery.DRepresentationQuery(DRepresentation, Session)</code> to compute queries directly from the given session instead of computing it.
+ </li>
+ <li><span class="label label-success">Added</span> In
+ <code>viewpoint.ecore</code>, the
+ <code>UIState</code> class has a new
+ <code>subDiagramDecorationDescriptors</code> attribute. It is used as a cache to speed up sub diagram decorations computing.
+ </li>
+ <li><span class="label label-success">Added</span> It is now possible to consider that some specific graphical changes need a refresh of the representation. Before Sirius 6.1.3, only semantic changes triggers a refresh. Now you can use
+ <code>RefreshHelper.registerImpactingNotification(Predicate<Notification>)</code> to consider a specific graphical changes. An example is the possibility to launch a refresh when the region container is collapsed or expanded. See
+ <a href="developer/trigger-refresh-graphical-changes.html">Trigger a Sirius refresh on specific graphical changes</a> in the developer documentation for more details.
+ </li>
+ <li><span class="label label-success">Added</span> The method
+ <code>org.eclipse.sirius.tools.api.ui.RefreshHelper.isAutoRefresh()</code> has been added to know if Sirius is in automatic refresh mode or in manual mode.
+ </li>
+ <li><span class="label label-success">Added</span> The methods
+ <code>org.eclipse.sirius.tools.api.ui.RefreshHelper.registerImpactingNotification(Predicate<Notification>)</code> and
+ <code>org.eclipse.sirius.tools.api.ui.RefreshHelper.unregisterImpactingNotification(Predicate<Notification>)</code> have been added to allow to consider some graphical modifications as requiring a refresh. By default, only semantic changes are considered as requiring a refresh.
+ </li>
+ <li><span class="label label-danger">Removed</span> The
+ <code>org.eclipse.sirius.business.api.helper.task.NotificationTask</code> class has been removed. It was not used anywhere.
+ </li>
+ </ul>
+ <h4 id="Changesinorg.eclipse.sirius.tests.swtbot.support">Changes in
+ <code>org.eclipse.sirius.tests.swtbot.support</code>
+ </h4>
+ <ul>
+ <li><span class="label label-success">Added</span> The methods
+ <code>org.eclipse.sirius.tests.swtbot.support.api.widget.SWTBotSiriusFigureCanvas.mouseMoveLeftClick(int, int, boolean, int[])</code>,
+ <code>org.eclipse.sirius.tests.swtbot.support.api.editor.SWTBotSiriusGefViewer.click(int, int, boolean, int[])</code>,
+ <code>org.eclipse.sirius.tests.swtbot.support.api.editor.SWTBotSiriusDiagramEditor.clickWithKeys(String, int...)</code>, have been added to make a mouse click with key modifiers for a multi selection for example.
+ </li>
+ </ul>
+ <ul>
+ <li><span class="label label-success">Added</span> The method
+ <code>org.eclipse.sirius.tests.swtbot.support.api.editor.SWTBotSiriusHelper.selectPropertyTabItem(String, SWTBot)</code> has been added. It allows to look for property tab from a given bot. The bot corresponding to the property view should be given otherwise the search could fail starting from Eclipse 2019-06.
+ </li>
+ </ul>
+ <ul>
+ <li><span class="label label-success">Added</span>The method
+ <code>org.eclipse.sirius.tests.swtbot.support.api.editor.SWTBotSiriusHelper.getShellBot(String)</code> has been added and allows to retrieve a bot related to a shell with the given label.
+ </li>
+ </ul>
+ <ul>
+ <li><span class="label label-success">Added</span>The method
+ <code>org.eclipse.sirius.tests.swtbot.support.api.editor.SWTBotSiriusHelper.menu(SWTBot, String)</code> has been added and allows to retrieve a menu even when the active shell is null. Should be used over
+ <code>SWTBot.menu(String)</code> method.
+ </li>
+ </ul>
<h2 id="sirius6.2.0">Changes in Sirius 6.2.0</h2>
<h3 id="UserVisibleChanges">User-Visible Changes</h3>
<ul>
@@ -117,7 +180,7 @@
<a href="specifier/diagrams/Diagrams.html#group">corresponding documentation</a> .
</li>
</ul>
- <h3 id="DeveloperVisibleChanges">Developer-Visible Changes</h3>
+ <h3 id="DeveloperVisibleChanges2">Developer-Visible Changes</h3>
<h4 id="Changesinorg.eclipse.sirius.common">Changes in
<code>org.eclipse.sirius.common</code>
</h4>
@@ -213,14 +276,6 @@
<code>java.util.Optional<T></code> instead.
</li>
</ul>
- <h4 id="Changesinorg.eclipse.sirius">Changes in
- <code>org.eclipse.sirius</code>
- </h4>
- <ul>
- <li><span class="label label-danger">Removed</span> The
- <code>org.eclipse.sirius.business.api.helper.task.NotificationTask</code> class has been removed. It was not used anywhere.
- </li>
- </ul>
<h4 id="Changesinorg.eclipse.sirius.diagram.layoutdata">Changes in
<code>org.eclipse.sirius.diagram.layoutdata</code>
</h4>
@@ -243,7 +298,7 @@
<code>on()</code> was also added to provide a more fluent API, e.g.
<code>DragAndDropTargetQuery.on(container).getLogicalChildren()</code>.
</li>
- <li><span class="label label-info">Added</span> The extension point org.eclipse.sirius.diagram.customBundledImageShape has been created in order to provide custom shape to the bundled image style. This extension point offers more flexibility on the specification of the svg tags and attributes holding the color, border color and border size information than the extension point org.eclipse.sirius.diagram.bundledImageShape.</li>
+ <li><span class="label label-success">Added</span> The extension point org.eclipse.sirius.diagram.customBundledImageShape has been created in order to provide custom shape to the bundled image style. This extension point offers more flexibility on the specification of the svg tags and attributes holding the color, border color and border size information than the extension point org.eclipse.sirius.diagram.bundledImageShape.</li>
<li><span class="label label-info">Modified</span> The extension point org.eclipse.sirius.diagram.bundledImageShape has been marked as deprecated. Shapes provided by this extension point still work.</li>
<li><span class="label label-info">Modified</span> The method
<code>org.eclipse.sirius.diagram.tools.api.command.IDiagramCommandFactory.buildInsertVerticalBlankSpaceCommand(DDiagram, int, int)</code> has been renamed to
@@ -407,6 +462,10 @@
<code>org.eclipse.sirius.diagram.ui</code>
</h4>
<ul>
+ <li><span class="label label-success">Added</span> The method
+ <code>org.eclipse.sirius.diagram.ui.business.api.query.EditPartQuery.getDDiagram()</code> has been added to retrieve the
+ <code>DDiagram</code> associated to the edit part or to one of its ancestor.
+ </li>
<li><span class="label label-danger">Removed</span> The message
<code>org.eclipse.sirius.diagram.ui.provider.Messages.SynchronizeGMFModelCommand_label</code> has been removed. It has been replaced in
<code>org.eclipse.sirius.diagram.Messages</code>.
@@ -415,6 +474,12 @@
<code>layoutDataManager</code>, deprecated since Sirius 4.1.0, has been removed. The corresponding plug-in
<code>org.eclipse.sirius.diagram.layoutdata</code> has also been removed.
</li>
+ <li><span class="label label-success">Added</span> The method
+ <code>org.eclipse.sirius.diagram.ui.business.api.query.ConnectionEditPartQuery.getCenteredAnchorsAbsoluteLocation(Rectangle)</code> has been added in order to compute the location of the anchor of a connection centered on its target or source.
+ </li>
+ <li><span class="label label-success">Added</span> The method
+ <code>org.eclipse.sirius.diagram.ui.business.api.query.ConnectionQuery.getAbsolutePointList(RelativeBendpoints, PrecisionPoint, PrecisionPoint)</code> has been added to compute the absolute coordinates of the bendpoints of a connection.
+ </li>
</ul>
<h4 id="Changesinorg.eclipse.sirius.ui.editor">Changes in
<code>org.eclipse.sirius.ui.editor</code>
@@ -467,7 +532,7 @@
<code>java.util.Optional<T></code> instead.
</li>
</ul>
- <h4 id="Changesinorg.eclipse.sirius.tests.swtbot.support">Changes in
+ <h4 id="Changesinorg.eclipse.sirius.tests.swtbot.support2">Changes in
<code>org.eclipse.sirius.tests.swtbot.support</code>
</h4>
<ul>
@@ -492,7 +557,7 @@
<em>Delete</em>. It was previously the case only for representations which semantic target does not exist anymore.
</li>
</ul>
- <h3 id="DeveloperVisibleChanges2">Developer-Visible Changes</h3>
+ <h3 id="DeveloperVisibleChanges3">Developer-Visible Changes</h3>
<ul>
<li><span class="label label-success">Added</span> If the
<code>org.eclipse.sirius.diagam.ui.hidePrintingOfPermissionAuthorityDecoration</code> system property is set to true and if there is no other printable decoration provided at the same location (South-West), the permission authority decorations displayed on diagrams are not printed nor exported in images (export as image actions).
@@ -646,7 +711,7 @@
<a href="specifier/tables/Tables.html#edition_tables">the documentation</a> for details.
</li>
</ul>
- <h3 id="DeveloperVisibleChanges3">Developer-Visible Changes</h3>
+ <h3 id="DeveloperVisibleChanges4">Developer-Visible Changes</h3>
<p><span class="label label-info">IMPORTANT</span> Note that all plug-ins in the
<em>Sirius Server</em> feature (
<code>org.eclipse.sirius.server.*</code> and
@@ -879,7 +944,7 @@
<code>org.eclipse.emf.ecore.util.EcoreUtil.generateUUID()</code>.
</li>
</ul>
- <h4 id="Changesinorg.eclipse.sirius.tests.swtbot.support2">Changes in
+ <h4 id="Changesinorg.eclipse.sirius.tests.swtbot.support3">Changes in
<code>org.eclipse.sirius.tests.swtbot.support</code>
</h4>
<ul>
@@ -955,7 +1020,7 @@
<a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=531487">bugzilla 531487</a> for more details.
</li>
</ul>
- <h3 id="DeveloperVisibleChanges4">Developer-Visible Changes</h3>
+ <h3 id="DeveloperVisibleChanges5">Developer-Visible Changes</h3>
<ul>
<li><span class="label label-info">Modified</span> The SWTBot test framework version has been upgraded toward SWTBot 2.6. The main impacts are described below:
<ul>
@@ -1143,7 +1208,7 @@
<code>org.eclipse.sirius.tests.swtbot.Activator.PLUGIN_ID</code>). It avoids to build a wrong target platform containing each Sirius plug-ins twice.
</li>
</ul>
- <h4 id="Changesinorg.eclipse.sirius.tests.swtbot.support3">Changes in
+ <h4 id="Changesinorg.eclipse.sirius.tests.swtbot.support4">Changes in
<code>org.eclipse.sirius.tests.swtbot.support</code>
</h4>
<ul>
@@ -1184,7 +1249,7 @@
<a href="user/diagrams/Diagrams.html#standardToolId">Standard Tools</a> chapter for more details on this tool.
</li>
</ul>
- <h3 id="DeveloperVisibleChanges5">Developer-Visible Changes</h3>
+ <h3 id="DeveloperVisibleChanges6">Developer-Visible Changes</h3>
<h4 id="Changesinorg.eclipse.sirius4">Changes in
<code>org.eclipse.sirius</code>
</h4>
@@ -1324,7 +1389,7 @@
<em>Reference Name</em> field (if a valid feature has been specified).
</li>
</ul>
- <h3 id="DeveloperVisibleChanges6">Developer-Visible Changes</h3>
+ <h3 id="DeveloperVisibleChanges7">Developer-Visible Changes</h3>
<h4 id="Migrations3">Migrations</h4>
<ul>
<li><span class="label label-success">Added</span> A migration has been added to fix diagram with edge labels corrupted (see
diff --git a/doc/developer/Sirius Developer Manual.html b/doc/developer/Sirius Developer Manual.html
index 86692ef..2ffe064 100644
--- a/doc/developer/Sirius Developer Manual.html
+++ b/doc/developer/Sirius Developer Manual.html
@@ -109,6 +109,16 @@
<strong>Provide custom aird editor pages</strong>
</a>
</li>
+ <li>
+ <a href="extensions-provide_resource_strategy.html">
+ <strong>Provide a resource strategy</strong>
+ </a>
+ </li>
+ <li>
+ <a href="trigger-refresh-graphical-changes.html">
+ <strong>Trigger refresh on specific graphical changes</strong>
+ </a>
+ </li>
</ul>
</li>
</ul>
diff --git a/doc/developer/trigger-refresh-graphical-changes.html b/doc/developer/trigger-refresh-graphical-changes.html
new file mode 100644
index 0000000..1f4624a
--- /dev/null
+++ b/doc/developer/trigger-refresh-graphical-changes.html
@@ -0,0 +1,52 @@
+<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+ <title>trigger-refresh-graphical-changes</title>
+ <link type="text/css" rel="stylesheet" href="../resources/bootstrap.css"/>
+ <link type="text/css" rel="stylesheet" href="../resources/custom.css"/>
+ </head>
+ <body>
+ <h1 id="TriggeraSiriusrefreshonspecificgraphicalchanges">Trigger a Sirius refresh on specific graphical changes</h1>
+ <h2 id="Description">Description</h2>
+ <p>In automatic refresh mode, representations are refreshed as soon as at least one semantic change is done. Graphical changes are not considered as they are not impacting the mapping precondition. In some cases, the mapping can depend on the graphical state. A typical example is the “collapse” state of a
+ <a href="../specifier/diagrams/Diamgram.html#graphical_elements">region</a> to change the mapping according to it. Since Sirius 6.1.3, it is possible to register a new graphical change to trigger a Sirius refresh.
+ </p>
+ <h2 id="RegisteranewgraphicalchangetotriggeraSiriusrefresh">Register a new graphical change to trigger a Sirius refresh</h2>
+ <p>The
+ <code>org.eclipse.sirius.tools.api.ui.RefreshHelper.registerImpactingNotification(Predicate<Notification>)</code> allows to consider some graphical modifications as requiring a refresh. This method is called through the pre-commit listener
+ <code>org.eclipse.sirius.tools.api.ui.RefreshEditorsPrecommitListener</code>. So it is called only if you are in automatic refresh mode or if the “forceRefresh” mode has been activated (
+ <code>org.eclipse.sirius.tools.api.ui.RefreshEditorsPrecommitListener.setForceRefresh(boolean)</code>) with the corresponding representation to refresh (
+ <code>org.eclipse.sirius.tools.api.ui.RefreshEditorsPrecommitListener.addRepresentationToForceRefresh(DRepresentation)</code>).
+ <br/>For the specific case of collapse/expand, current representation is automatically added as a force refresh representation. So the collapse/expand of a region automatically launch a refresh, even in manual refresh mode.
+ </p>
+ <h3 id="Example">Example</h3>
+ <pre>// Register a predicate to consider Collapse/Expand changes as impacting in diagram of kind "MyDiagramDescriptionName".
+RefreshHelper.registerImpactingNotification(new Predicate<Notification>() {
+ @Override
+ public boolean test(Notification notification) {
+ if (notification != null) {
+ if (NotationPackage.eINSTANCE.getDrawerStyle_Collapsed().equals(notification.getFeature())) {
+ if (notification.getNotifier() instanceof EObject) {
+ Option<DDiagram> optionalDDiagram = new EObjectQuery((EObject) notification.getNotifier()).getParentDiagram();
+ if (optionalDDiagram.some()) {
+ return "MyDiagramDescriptionName".equals(optionalDDiagram.get().getDescription().getName);
+ }
+ }
+ }
+ }
+ return false;
+ }
+});
+</pre>
+ <h2 id="Unregisterapreviouslyregistergraphicalchanges">Unregister a previously register graphical changes</h2>
+ <p>You can use
+ <code>org.eclipse.sirius.tools.api.ui.RefreshHelper.unregisterImpactingNotification(Predicate<Notification>)</code> to unregister a previously registered predicate.
+ </p>
+ <h2 id="Recommendation">Recommendation</h2>
+ <p>The
+ <code>RefreshEditorsPrecommitListener</code> is called after each changes. So each predicate added through
+ <code>registerImpactingNotification()</code> will be called on each notification (until one is considered as impacting). These predicates must be efficient.
+ </p>
+ </body>
+</html>
\ No newline at end of file
