diff options
| author | Pierre-Charles David | 2016-04-12 15:09:38 +0000 |
|---|---|---|
| committer | Pierre-Charles David | 2016-04-13 09:46:52 +0000 |
| commit | 7b763b843f91c6c591ae91653eb429d5917665f2 (patch) | |
| tree | 4b4a3ff3facc4b99eb18bd4c5e845ddf4b83872d | |
| parent | 5f957f75c7fb8c8a632b0a90047096eee4975dc2 (diff) | |
| download | org.eclipse.sirius-7b763b843f91c6c591ae91653eb429d5917665f2.tar.gz org.eclipse.sirius-7b763b843f91c6c591ae91653eb429d5917665f2.tar.xz org.eclipse.sirius-7b763b843f91c6c591ae91653eb429d5917665f2.zip | |
[442268] Update release notes
Bug: 442268
Change-Id: I2136f9c6a3821cba96c3e3a6aa2e1c2f27073c83
Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
3 files changed, 79 insertions, 23 deletions
diff --git a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html index 69ba6943ba..186e25cd20 100644 --- a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html +++ b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html @@ -270,6 +270,9 @@ <code>org.eclipse.sirius.diagram.ui</code> </h4> <ul> + <li><span class="label label-success">Added</span> A new system property named + <code>org.eclipse.sirius.diagram.ui.svg.maxCacheSizeMB</code> has been added. It can be used to tweak the maximum size (in megabytes) of pre-rendered SVG images to keep in cache. The default is 50, corresponding to 50MB of bitmaps of 4 8-bit channels. Increasing the limit can improve performance when using diagrams with a lot of SVG images, at the cost of increased memory usage. + </li> <li><span class="label label-success">Added</span> <code>org.eclipse.sirius.diagram.ui.tools.api.editor.tabbar.ITabbarContributor</code> interface has been added to provide a customized tab-bar for a specific selection. </li> @@ -291,11 +294,56 @@ <li><span class="label label-success">Added</span> <code>org.eclipse.sirius.diagram.ui.tools.api.figure.DBorderedNodeFigure.getAuthorizedSides()</code> has been added to retrieve the figure authorized side (by default all sides). </li> + <li><span class="label label-success">Added</span> The following protected methods have been added to + <code>org.eclipse.sirius.diagram.ui.tools.api.figure.SVGFigure</code> : + <code>String getKey(Graphics)</code>, + <code>Image getImage(Rectangle, Graphics)</code>, + <code>static boolean doRemoveFromCache(String)</code>. + </li> <li><span class="label label-info">Modified</span> <code>org.eclipse.sirius.diagram.ui.tools.api.figure.BundleImageFigure</code> now overrides the method <code>setBorder(Border border)</code>. It also provides the accessors for the new field <code>mainBorderSize</code>. </li> + <li><span class="label label-info">Modified</span> + <code>org.eclipse.sirius.diagram.ui.tools.api.figure.BundledImageFigure</code> now inherits directly from + <code>SVGFigure</code> instead of + <code>AbstractCachedSVGFigure</code>. + </li> + <li><span class="label label-info">Modified</span> + <code>org.eclipse.sirius.diagram.ui.tools.api.figure.SVGWorkspaceImageFigure</code> now inherits directly from + <code>SVGFigure</code> instead of + <code>AbstractCachedSVGFigure</code>. + </li> + <li><span class="label label-info">Modified</span> + <code>org.eclipse.sirius.diagram.ui.tools.api.figure.SVGFigure</code> now implements interfaces + <code>StyledFigure</code>, + <code>ITransparentFigure</code> and + <code>ImageFigureWithAlpha</code>. + </li> + <li><span class="label label-danger">Removed</span> The following mehtods have been removed from + <code>org.eclipse.sirius.diagram.ui.tools.api.figure.SVGFigure</code>: + <code>NodeList getNodes(String)</code>, + <code>Color getColor(Element, String)</code>, + <code>void updateRenderingHints(Graphics)</code>, + <code>staticImage toSWT(Device, BufferedImage)</code>, + <code>boolean checkContentAvailable()</code>, + <code>Rectangle2D getAreaOfInterest()</code>, + <code>void setAreaOfInterest(Rectangle2D)</code>, + <code>boolean isSpecifyCanvasWidth()</code>, + <code>void setSpecifyCanvasWidth(boolean)</code>, + <code>boolean isSpecifyCanvasHeight()</code>, + <code>void setSpecifyCanvasHeight(boolean)</code>, + <code>boolean getSpecifyCanvasWidth()</code>, + <code>boolean getSpecifyCanvasHeight()</code>. + </li> + <li><span class="label label-danger">Removed</span> The class + <code>org.eclipse.sirius.diagram.ui.tools.api.figure.AbstractCachedSVGFigure</code> has been removed. Its functionality was merged directly into + <code>SVGFigure</code>. + </li> + <li><span class="label label-danger">Removed</span> The static + <code>org.eclipse.sirius.diagram.ui.tools.api.figure.SVGWorkspaceImageFigure.createImageFigure(ContainerStyle)</code> method has been removed; it was broken and not called anywhere. + </li> </ul> <h4 id="Changesinorg.eclipse.sirius.ext.emf.ui">Changes in <code>org.eclipse.sirius.ext.emf.ui</code> diff --git a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile index b72204bc48..905d6ea1f4 100644 --- a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile +++ b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile @@ -75,13 +75,21 @@ h4. Changes in @org.eclipse.sirius.ui@ h4. Changes in @org.eclipse.sirius.diagram.ui@ +* <span class="label label-success">Added</span> A new system property named @org.eclipse.sirius.diagram.ui.svg.maxCacheSizeMB@ has been added. It can be used to tweak the maximum size (in megabytes) of pre-rendered SVG images to keep in cache. The default is 50, corresponding to 50MB of bitmaps of 4 8-bit channels. Increasing the limit can improve performance when using diagrams with a lot of SVG images, at the cost of increased memory usage. * <span class="label label-success">Added</span> @org.eclipse.sirius.diagram.ui.tools.api.editor.tabbar.ITabbarContributor@ interface has been added to provide a customized tab-bar for a specific selection. * <span class="label label-success">Added</span> @org.eclipse.sirius.diagram.ui.tools.api.editor.tabbar.AbstractTabbarContributor@ is an abstract implementation of @ITabbarContributor@ that allows reusing one or several of the default Sirius contribution items. * <span class="label label-success">Added</span> @org.eclipse.sirius.diagram.editor.properties.sections.style.bundledimagedescription.BundledImageDescriptionShapePropertySectionSpec@ has been added to have a custom display in the VSM for provided basic shape. * <span class="label label-success">Added</span> @org.eclipse.sirius.diagram.ui.edit.api.part.AbstractDiagramBorderNodeEditPart.createNodeFigure()@ has been created to factorize the @DNode2EditPart@ and @DNode4EditPart@ constructors. * <span class="label label-success">Added</span> @org.eclipse.sirius.diagram.ui.tools.api.figure.DBorderedNodeFigure.setForbiddenSides(int...)@ has been added to set the figure forbidden sides on its parent. * <span class="label label-success">Added</span> @org.eclipse.sirius.diagram.ui.tools.api.figure.DBorderedNodeFigure.getAuthorizedSides()@ has been added to retrieve the figure authorized side (by default all sides). +* <span class="label label-success">Added</span> The following protected methods have been added to @org.eclipse.sirius.diagram.ui.tools.api.figure.SVGFigure@ : @String getKey(Graphics)@, @Image getImage(Rectangle, Graphics)@, @static boolean doRemoveFromCache(String)@. * <span class="label label-info">Modified</span> @org.eclipse.sirius.diagram.ui.tools.api.figure.BundleImageFigure@ now overrides the method @setBorder(Border border)@. It also provides the accessors for the new field @mainBorderSize@. +* <span class="label label-info">Modified</span> @org.eclipse.sirius.diagram.ui.tools.api.figure.BundledImageFigure@ now inherits directly from @SVGFigure@ instead of @AbstractCachedSVGFigure@. +* <span class="label label-info">Modified</span> @org.eclipse.sirius.diagram.ui.tools.api.figure.SVGWorkspaceImageFigure@ now inherits directly from @SVGFigure@ instead of @AbstractCachedSVGFigure@. +* <span class="label label-info">Modified</span> @org.eclipse.sirius.diagram.ui.tools.api.figure.SVGFigure@ now implements interfaces @StyledFigure@, @ITransparentFigure@ and @ImageFigureWithAlpha@. +* <span class="label label-danger">Removed</span> The following mehtods have been removed from @org.eclipse.sirius.diagram.ui.tools.api.figure.SVGFigure@: @NodeList getNodes(String)@, @Color getColor(Element, String)@, @void updateRenderingHints(Graphics)@, @staticImage toSWT(Device, BufferedImage)@, @boolean checkContentAvailable()@, @Rectangle2D getAreaOfInterest()@, @void setAreaOfInterest(Rectangle2D)@, @boolean isSpecifyCanvasWidth()@, @void setSpecifyCanvasWidth(boolean)@, @boolean isSpecifyCanvasHeight()@, @void setSpecifyCanvasHeight(boolean)@, @boolean getSpecifyCanvasWidth()@, @boolean getSpecifyCanvasHeight()@. +* <span class="label label-danger">Removed</span> The class @org.eclipse.sirius.diagram.ui.tools.api.figure.AbstractCachedSVGFigure@ has been removed. Its functionality was merged directly into @SVGFigure@. +* <span class="label label-danger">Removed</span> The static @org.eclipse.sirius.diagram.ui.tools.api.figure.SVGWorkspaceImageFigure.createImageFigure(ContainerStyle)@ method has been removed; it was broken and not called anywhere. h4. Changes in @org.eclipse.sirius.ext.emf.ui@ diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.html b/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.html index 68faf2c346..3996eba953 100644 --- a/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.html +++ b/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.html @@ -119,7 +119,7 @@ <p>Diagrams support several kinds of graphical constructs: simple nodes, containers (which can contain other nodes or containers), lists, bordered nodes (nodes which appear on the side of other elements, typically to represent ports), and edges between all of these. Each kind of element supports a rich set of possible styles (shape and color).</p> <p>As the specifier of Sirius diagrams, you have total control on how the elements in your semantic models are <em>represented</em> using the constructs provided by Sirius, and how they - <em>behave</em>. In particular, this means the structure of the graphical elements shown on a diagram (which element contains which, how they are connected) does not have to match the “physical” structure of the semantic model being represented. The two are completely de-correlated, and you can choose to represent your semantic models in ways which make sense from various point of views. + <em>behave</em>. In particular, this means the structure of the graphical elements shown on a diagram (which element contains which, how they are connected) does not have to match the «physical» structure of the semantic model being represented. The two are completely de-correlated, and you can choose to represent your semantic models in ways which make sense from various point of views. </p> <h2 id="diagram_description">Diagram Description</h2> <p>Diagrams are configured by creating a @@ -545,7 +545,7 @@ </tr> </table> <p>Most of the properties used to configure the various styles are self-explanatory. See the - <a href="#styling">styles</a> section below for a general discussion. You can also refer to the tool-tips available directly in the editor on the “question mark” icon of each property. + <a href="#styling">styles</a> section below for a general discussion. You can also refer to the tool-tips available directly in the editor on the «question mark» icon of each property. </p> <p> <strong>Gauge Style.</strong> The gauge style is more complex than the others and deserves a specific description. It is used to represent nodes as a (set of) gauges, which can be used for example as progress indicators. @@ -599,7 +599,7 @@ <a href="../general/Model_Operations.html">model operations</a>. </p> <p>By default, your node creation tools will be available on all the graphical elements which can contain an instance of the - <em>Node Mappings</em> you specified in the tool, and users will see a “forbidden” sign if they try to apply the tool on an incompatible type of element. You can specify a + <em>Node Mappings</em> you specified in the tool, and users will see a «forbidden» sign if they try to apply the tool on an incompatible type of element. You can specify a <em>Precondition</em> to forbid the application of the tool on some of the elements where it would normally be allowed. The precondition is evaluated in the context of the <em>view element</em> on which the user has put the mouse. If it returns a false value, the tool’s application will be forbidden. Symmetrically, you can specify <em>Extra Mappings</em> ( @@ -636,7 +636,7 @@ <br/></div> </p> <p id="list_containers"> - <strong>List Containers</strong> You can enable a special “list mode” for containers by setting the + <strong>List Containers</strong> You can enable a special «list mode» for containers by setting the <em>Children Presentation</em> attribute to <em>List</em> in the mapping configuration. List containers are represented in a special way, in which only the labels of their direct sub-elements (nodes only) are taken into account and presented in a vertical list. When represented as a list, only some of the style attributes (label text, tool-tip, colors) of the container are taken into account. For the list items themselves, only the label text is used. </p> @@ -644,7 +644,7 @@ <img border="0" src="images/styles/List_container_with_items.png"/> </p> <p id="compartments"> - <strong>Compartments</strong> You can enable a special “compartment mode” for containers by setting the + <strong>Compartments</strong> You can enable a special «compartment mode» for containers by setting the <em>Children Presentation</em> attribute to <em>Horizontal Stack</em> or <em>Vertical Stack</em> in the mapping configuration. Region containers presents their children containers and lists as compartments, vertically or horizontally organized. They are sorted following the mapping order and the semantic candidates expression evaluation result of each mapping. The border style attributes of the Region’s styles are used to specify the compartments separators. The other style properties of Region container or Region mapping are used as usual. @@ -705,7 +705,7 @@ <em>auto-sized</em>. </p> <p>Most of the properties used to configure the various styles are self-explanatory. See the - <a href="#styling">styles</a> section below for a general discussion. You can also refer to the tool-tips available directly in the editor on the “question mark” icon of each property. + <a href="#styling">styles</a> section below for a general discussion. You can also refer to the tool-tips available directly in the editor on the «question mark» icon of each property. </p> <h4 id="container_tools">Container Tools</h4> <p>See the @@ -718,7 +718,7 @@ <a href="../general/Model_Operations.html">model operations</a>. </p> <p>By default, your container creation tools will be available on all the graphical elements which can contain an instance of the - <em>Container Mappings</em> you specified in the tool, and users will see a “forbidden” sign if they try to apply the tool on an incompatible type of element. You can specify a + <em>Container Mappings</em> you specified in the tool, and users will see a «forbidden» sign if they try to apply the tool on an incompatible type of element. You can specify a <em>Precondition</em> to forbid the application of the tool on some of the elements where it would normally be allowed. The precondition is evaluated in the context of the <em>view element</em> on which the user has put the mouse. If it returns a false value, the tool’s application will be forbidden. Symmetrically, you can specify <em>Extra Mappings</em> ( @@ -944,12 +944,12 @@ <em>Direct Edit</em> tool is associated to the edge mapping. </p> <p> - <strong>Edge Folding.</strong> It can often be useful, from one end of the edge, to be able to hide the elements at the other end. Think for example when and edge is used to represent some kind of containment relationship between elements and you want to hide the “contents” of an element to concentrate on the rest of the diagram. You can allow end-users to do this be setting a + <strong>Edge Folding.</strong> It can often be useful, from one end of the edge, to be able to hide the elements at the other end. Think for example when and edge is used to represent some kind of containment relationship between elements and you want to hide the «contents» of an element to concentrate on the rest of the diagram. You can allow end-users to do this be setting a <em>Folding Style</em> on an edge mapping (in the <em>Advanced</em> category). When the <em>Folding Style</em> is set to <em>Source</em> or - <em>Target</em>, the element (node or container) at the source or target of the edge will have a small “ - ” sign in its top-left corner. If the user clicks on it, the edges instance of this mapping for which the element is a source (resp. target) will fold: the edges and the elements they are connected to at the other side will disappear from view. The behavior is recursive: if the elements hidden were connected to other elements using this kind edges, those too will be hidden. When an element has been folded, the “ - ” sign becomes a “ + ” sign which can be used to unfold the edges. This is useful when representing trees of elements: if you enable folding, users will be able with a single click to hide or reveal complete sub-hierarchies of elements. + <em>Target</em>, the element (node or container) at the source or target of the edge will have a small « - » sign in its top-left corner. If the user clicks on it, the edges instance of this mapping for which the element is a source (resp. target) will fold: the edges and the elements they are connected to at the other side will disappear from view. The behavior is recursive: if the elements hidden were connected to other elements using this kind edges, those too will be hidden. When an element has been folded, the « - » sign becomes a « + » sign which can be used to unfold the edges. This is useful when representing trees of elements: if you enable folding, users will be able with a single click to hide or reveal complete sub-hierarchies of elements. </p> <p> <strong>Edge Centering.</strong> The edge source and edge target are not systematically oriented toward the center of the node, depending on where the edge has been created or moved by the end user. You can specify that an edge end (the source, target or both) will always be centered. The @@ -1029,7 +1029,7 @@ <p>On the opposite, you can specify <em>Extra Source Mappings</em> and <em>Extra Target Mappings</em> ( - <em>Advanced</em> category) which the user will be able to select as “virtual” source and targets, even though the real edge created by the tool will not be between these elements. + <em>Advanced</em> category) which the user will be able to select as «virtual» source and targets, even though the real edge created by the tool will not be between these elements. </p> <p> <strong>Reconnect Edge.</strong> The @@ -1074,31 +1074,31 @@ </p> <ul> <li>The - <code>sourceView</code> is the graphical node ‘A’. + <code>sourceView</code> is the graphical node ‹A›. </li> <li>The - <code>targetView</code> is the graphical node ‘B’. + <code>targetView</code> is the graphical node ‹B›. </li> <li>The - <code>otherEnd</code> is the graphical node ‘C’, that has not changed during the reconnection. + <code>otherEnd</code> is the graphical node ‹C›, that has not changed during the reconnection. </li> <li> - <code>edgeView.sourceNode</code> is the graphical node ‘C’. + <code>edgeView.sourceNode</code> is the graphical node ‹C›. </li> <li> - <code>edgeView.targetNode</code> is the graphical node ‘B’. + <code>edgeView.targetNode</code> is the graphical node ‹B›. </li> </ul> - <p>For the semantic, we will consider that we represent “Box” and the link means “is contained in”:</p> + <p>For the semantic, we will consider that we represent «Box» and the link means «is contained in»:</p> <ul> <li>the - <code>source</code> is the box ‘A’. + <code>source</code> is the box ‹A›. </li> <li>the - <code>target</code> is the box ‘B’. + <code>target</code> is the box ‹B›. </li> <li> - <code>element</code> is the link “is contained” between ‘C’ and ‘A’. + <code>element</code> is the link «is contained» between ‹C› and ‹A›. </li> </ul> <h3 id="decorations">Decorations</h3> @@ -1129,7 +1129,7 @@ <ul> <li>NOTE : There is an exception to the rule of Conditional Styles:</li> </ul> - <p>if a user customized a Node with a WorkspaceImage style (through the “Set style to workspace image” action), then if a new style is computed through the VSM (e.g. through a Conditional Style appliance), this new style will not override the WorkspaceImage style to preserve this last customization (See + <p>if a user customized a Node with a WorkspaceImage style (through the «Set style to workspace image» action), then if a new style is computed through the VSM (e.g. through a Conditional Style appliance), this new style will not override the WorkspaceImage style to preserve this last customization (See <a href="../../user/diagrams/Diagrams.html#styleCustomizations"> <em>Style Customizations</em> </a> ). @@ -1231,7 +1231,7 @@ <p>The <em>Group Extension</em> elements (defined inside a tool section) allow you to add tools in a existing <em>Group</em> defined elsewhere. It can be used for example to merge tools defined in an additional layer into a group of tools defined in the default layer. You must select the existing - <em>Group</em> to extend, and any tool declared in a group extension will be added in the targeted group by the ‘group’ attribute. + <em>Group</em> to extend, and any tool declared in a group extension will be added in the targeted group by the ‹group› attribute. </p> <p> <i>WARNING</i> : It was possible to define a ToolSection directly under a DiagramDescription, outside a layer. Defining tool section outside a layer is discouraged, that’s why this action has been deleted. The tool sections created before are still present but you should move it into the default layer since it is likely to be deleted in the future. @@ -1608,7 +1608,7 @@ <em>Diagram Extension</em>. You should use regular expressions only to define a <em>Diagram Extension</em> that contains only <a href="#customization">style customization</a>. - <br/>These fields are considered as regular expressions if they contain at least one of these characters : “*”, “[”, “]”, “(”, “)” or “?”. + <br/>These fields are considered as regular expressions if they contain at least one of these characters : «*», «[», «]», «(», «)» or «?». </p> <h3 id="mapping_imports">Mapping Imports</h3> <p>A mapping import is used to @@ -1621,7 +1621,7 @@ <em>M2</em> which imports <em>M1</em>, then <em>M2</em> may override/overload some of the features of - <em>M1</em> like a more specific “Semantic Candidate Expression” or a conditional style taking into account other specific aspects. When only + <em>M1</em> like a more specific «Semantic Candidate Expression» or a conditional style taking into account other specific aspects. When only <em>L1</em> is activated the normal definition of <em>M1</em> is applied. If <em>L2</em> is also activated, |