diff options
| author | pguilet | 2017-08-11 12:23:22 +0000 |
|---|---|---|
| committer | Pierre Guilet | 2017-08-23 07:29:52 +0000 |
| commit | b5adcd991ada8dd9924fe0de9c8fe35bf1cd1f82 (patch) | |
| tree | 2aaa3c91aa96da9d16867590db6b27960a394e86 | |
| parent | c09f3da6f8cabe6ec35cafa4d6c2ece5d8d66f5f (diff) | |
| download | org.eclipse.sirius-b5adcd991ada8dd9924fe0de9c8fe35bf1cd1f82.tar.gz org.eclipse.sirius-b5adcd991ada8dd9924fe0de9c8fe35bf1cd1f82.tar.xz org.eclipse.sirius-b5adcd991ada8dd9924fe0de9c8fe35bf1cd1f82.zip | |
[520521] Update documentation and release note and icons
Bug: 520521
Change-Id: I987ed1c820c37cf77edcbf94b506fb7eb736cd18
Signed-off-by: pguilet <pierre.guilet@obeo.fr>
16 files changed, 114 insertions, 35 deletions
diff --git a/plugins/org.eclipse.sirius.diagram.ui/icons/straightenWithBottomPinned.png b/plugins/org.eclipse.sirius.diagram.ui/icons/straightenWithBottomPinned.png Binary files differnew file mode 100644 index 0000000000..312ce11b78 --- /dev/null +++ b/plugins/org.eclipse.sirius.diagram.ui/icons/straightenWithBottomPinned.png diff --git a/plugins/org.eclipse.sirius.diagram.ui/icons/straightenWithLeftPinned.png b/plugins/org.eclipse.sirius.diagram.ui/icons/straightenWithLeftPinned.png Binary files differnew file mode 100644 index 0000000000..20f9c40994 --- /dev/null +++ b/plugins/org.eclipse.sirius.diagram.ui/icons/straightenWithLeftPinned.png diff --git a/plugins/org.eclipse.sirius.diagram.ui/icons/straightenWithRightPinned.png b/plugins/org.eclipse.sirius.diagram.ui/icons/straightenWithRightPinned.png Binary files differnew file mode 100644 index 0000000000..2b1f6b0ed4 --- /dev/null +++ b/plugins/org.eclipse.sirius.diagram.ui/icons/straightenWithRightPinned.png diff --git a/plugins/org.eclipse.sirius.diagram.ui/icons/straightenWithTopPinned.png b/plugins/org.eclipse.sirius.diagram.ui/icons/straightenWithTopPinned.png Binary files differnew file mode 100644 index 0000000000..eb9cd1759d --- /dev/null +++ b/plugins/org.eclipse.sirius.diagram.ui/icons/straightenWithTopPinned.png diff --git a/plugins/org.eclipse.sirius.diagram.ui/src-diag/org/eclipse/sirius/diagram/ui/tools/internal/actions/straighten/StraightenToAction.java b/plugins/org.eclipse.sirius.diagram.ui/src-diag/org/eclipse/sirius/diagram/ui/tools/internal/actions/straighten/StraightenToAction.java index e20a81a784..f816a1397f 100644 --- a/plugins/org.eclipse.sirius.diagram.ui/src-diag/org/eclipse/sirius/diagram/ui/tools/internal/actions/straighten/StraightenToAction.java +++ b/plugins/org.eclipse.sirius.diagram.ui/src-diag/org/eclipse/sirius/diagram/ui/tools/internal/actions/straighten/StraightenToAction.java @@ -258,7 +258,7 @@ public class StraightenToAction extends DiagramAction { public static StraightenToAction createStraightenLeftSidePinnedAction(IWorkbenchPage workbenchPage) { StraightenToAction action = new StraightenToAction(workbenchPage, StraightenToAction.LEFT_SIDE_PINNED); action.setId(ActionIds.STRAIGHTEN_LEFT_SIDE_PINNED); - ImageDescriptor bundledImageDescriptor = DiagramUIPlugin.Implementation.getBundledImageDescriptor(DiagramImagesPath.STRAIGHTEN_TO_TOP); + ImageDescriptor bundledImageDescriptor = DiagramUIPlugin.Implementation.getBundledImageDescriptor(DiagramImagesPath.STRAIGHTEN_WITH_LEFT_PINNED); action.setImageDescriptor(bundledImageDescriptor); action.setHoverImageDescriptor(bundledImageDescriptor); return action; @@ -275,7 +275,7 @@ public class StraightenToAction extends DiagramAction { public static StraightenToAction createStraightenRightSidePinnedAction(IWorkbenchPage workbenchPage) { StraightenToAction action = new StraightenToAction(workbenchPage, StraightenToAction.RIGHT_SIDE_PINNED); action.setId(ActionIds.STRAIGHTEN_RIGHT_SIDE_PINNED); - ImageDescriptor bundledImageDescriptor = DiagramUIPlugin.Implementation.getBundledImageDescriptor(DiagramImagesPath.STRAIGHTEN_TO_BOTTOM); + ImageDescriptor bundledImageDescriptor = DiagramUIPlugin.Implementation.getBundledImageDescriptor(DiagramImagesPath.STRAIGHTEN_WITH_RIGHT_PINNED); action.setImageDescriptor(bundledImageDescriptor); action.setHoverImageDescriptor(bundledImageDescriptor); return action; @@ -292,7 +292,7 @@ public class StraightenToAction extends DiagramAction { public static StraightenToAction createStraightenTopSidePinnedAction(IWorkbenchPage workbenchPage) { StraightenToAction action = new StraightenToAction(workbenchPage, StraightenToAction.TOP_SIDE_PINNED); action.setId(ActionIds.STRAIGHTEN_TOP_SIDE_PINNED); - ImageDescriptor bundledImageDescriptor = DiagramUIPlugin.Implementation.getBundledImageDescriptor(DiagramImagesPath.STRAIGHTEN_TO_LEFT); + ImageDescriptor bundledImageDescriptor = DiagramUIPlugin.Implementation.getBundledImageDescriptor(DiagramImagesPath.STRAIGHTEN_WITH_TOP_PINNED); action.setImageDescriptor(bundledImageDescriptor); action.setHoverImageDescriptor(bundledImageDescriptor); return action; @@ -309,7 +309,7 @@ public class StraightenToAction extends DiagramAction { public static StraightenToAction createStraightenBottomSidePinnedAction(IWorkbenchPage workbenchPage) { StraightenToAction action = new StraightenToAction(workbenchPage, StraightenToAction.BOTTOM_SIDE_PINNED); action.setId(ActionIds.STRAIGHTEN_BOTTOM_SIDE_PINNED); - ImageDescriptor bundledImageDescriptor = DiagramUIPlugin.Implementation.getBundledImageDescriptor(DiagramImagesPath.STRAIGHTEN_TO_RIGHT); + ImageDescriptor bundledImageDescriptor = DiagramUIPlugin.Implementation.getBundledImageDescriptor(DiagramImagesPath.STRAIGHTEN_WITH_BOTTOM_PINNED); action.setImageDescriptor(bundledImageDescriptor); action.setHoverImageDescriptor(bundledImageDescriptor); return action; diff --git a/plugins/org.eclipse.sirius.diagram.ui/src/org/eclipse/sirius/diagram/ui/tools/api/image/DiagramImagesPath.java b/plugins/org.eclipse.sirius.diagram.ui/src/org/eclipse/sirius/diagram/ui/tools/api/image/DiagramImagesPath.java index 64ef0ad9ef..326dd3c5a1 100644 --- a/plugins/org.eclipse.sirius.diagram.ui/src/org/eclipse/sirius/diagram/ui/tools/api/image/DiagramImagesPath.java +++ b/plugins/org.eclipse.sirius.diagram.ui/src/org/eclipse/sirius/diagram/ui/tools/api/image/DiagramImagesPath.java @@ -1,5 +1,5 @@ /******************************************************************************* - * Copyright (c) 2007, 2016 THALES GLOBAL SERVICES and others. + * Copyright (c) 2007, 2017 THALES GLOBAL SERVICES and others. * All rights reserved. This program and the accompanying materials * are made available under the terms of the Eclipse Public License v1.0 * which accompanies this distribution, and is available at @@ -200,4 +200,24 @@ public interface DiagramImagesPath { * Path of the action's image to straighten to top. */ String STRAIGHTEN_TO_TOP = "icons/straightenToTop.png"; //$NON-NLS-1$ + + /** + * Path of the action's image to straighten to bottom. + */ + String STRAIGHTEN_WITH_BOTTOM_PINNED = "icons/straightenWithBottomPinned.png"; //$NON-NLS-1$ + + /** + * Path of the action's image to straighten to left. + */ + String STRAIGHTEN_WITH_LEFT_PINNED = "icons/straightenWithLeftPinned.png"; //$NON-NLS-1$ + + /** + * Path of the action's image to straighten to right. + */ + String STRAIGHTEN_WITH_RIGHT_PINNED = "icons/straightenWithRightPinned.png"; //$NON-NLS-1$ + + /** + * Path of the action's image to straighten to top. + */ + String STRAIGHTEN_WITH_TOP_PINNED = "icons/straightenWithTopPinned.png"; //$NON-NLS-1$ } diff --git a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html index c0e4f99481..3109160c80 100644 --- a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html +++ b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html @@ -120,7 +120,10 @@ <a href="user/diagrams/Diagrams.html#RemoveBendpoints">remove all bend-points</a> on rectilinear edges. It was only possible on oblique edges before. This action is available on edge context menu “Remove Bend-points” or by using the shortcut “Ctrl” + “Shift” + “-”. If number of bend-points can not be reduced, remove action will be inefficient. </li> <li><span class="label label-success">Added</span> The status Synchronized/Unsynchronized of the diagram is now displayed in the status bar when the diagram editor has the focus.</li> - <li><span class="label label-info">Modified</span> In a diagram, when selecting an edge or a node that are not fully displayed in the editor, now, the reveal is not done anymore, that is, the displayed content of the editor is not moved anymore. If the user want to fully see the selected element, he may drag the editor content using center mouse button. </li> + <li><span class="label label-success">Added</span> The user now have a drop down menu in the tabbar with all available straighten to edge actions. </li> + <li><span class="label label-success">Added</span> Straighten to actions on edge are now available even if the selection contains incompatible elements (edge labels for example). Their execution affects only compatible edges.</li> + <li><span class="label label-success">Added</span> Four new straighten actions are available (with top pinned, with bottom pinned, with left pinned, with right pinned) and allow to straighten edges from the opposed straightening axis point of view.</li> + <li><span class="label label-info">Modified</span> In a diagram, when selecting an edge or a node that are not fully displayed in the editor, now, the reveal is not done anymore, that is, the displayed content of the editor is not moved anymore. If the user want to fully see the selected element, he may drag the editor content using center mouse button.</li> </ul> <h3 id="SpecifierVisibleChanges">Specifier-Visible Changes</h3> <ul> diff --git a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile index 60fa27cb72..37aefb75aa 100644 --- a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile +++ b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile @@ -10,7 +10,11 @@ h3. User-Visible Changes * <span class="label label-success">Added</span> The end user can now "remove all bend-points":user/diagrams/Diagrams.html#RemoveBendpoints on rectilinear edges. It was only possible on oblique edges before. This action is available on edge context menu "Remove Bend-points" or by using the shortcut "Ctrl" + "Shift" + "-". If number of bend-points can not be reduced, remove action will be inefficient. * <span class="label label-success">Added</span> The status Synchronized/Unsynchronized of the diagram is now displayed in the status bar when the diagram editor has the focus. -* <span class="label label-info">Modified</span> In a diagram, when selecting an edge or a node that are not fully displayed in the editor, now, the reveal is not done anymore, that is, the displayed content of the editor is not moved anymore. If the user want to fully see the selected element, he may drag the editor content using center mouse button. +* <span class="label label-success">Added</span> The user now have a drop down menu in the tabbar with all available straighten to edge actions. +* <span class="label label-success">Added</span> Straighten to actions on edge are now available even if the selection contains incompatible elements (edge labels for example). Their execution affects only compatible edges. +* <span class="label label-success">Added</span> Four new straighten actions are available (with top pinned, with bottom pinned, with left pinned, with right pinned) and allow to straighten edges from the opposed straightening axis point of view. +* <span class="label label-info">Modified</span> In a diagram, when selecting an edge or a node that are not fully displayed in the editor, now, the reveal is not done anymore, that is, the displayed content of the editor is not moved anymore. If the user want to fully see the selected element, he may drag the editor content using center mouse button. + h3. Specifier-Visible Changes diff --git a/plugins/org.eclipse.sirius.doc/doc/user/diagrams/Diagrams.html b/plugins/org.eclipse.sirius.doc/doc/user/diagrams/Diagrams.html index 74b50fdc7f..b7cc6271b6 100644 --- a/plugins/org.eclipse.sirius.doc/doc/user/diagrams/Diagrams.html +++ b/plugins/org.eclipse.sirius.doc/doc/user/diagrams/Diagrams.html @@ -321,31 +321,56 @@ <img border="0" src="images/rectilinearAfterRemoveBendpoints.png"/> </p> <p>This action is available within the edge context menu or by using the shortcut “Ctrl” + “Shift” + “-” and it is not available on edges with a “Tree” routing style.</p> - <h4 id="straighten_an_edge">Straighten an edge</h4> - <p>There are four actions to straighten an edge, i.e. to transform an edge to an horizontal, or vertical, straight edge (with only one starting point and one ending point). + <h4 id="straighten_an_edge">Straighten edges</h4> + <h5 id="Straightenasingleedge">Straighten a single edge</h5> + <p>There are eight actions to straighten an edge, i.e. to transform an edge to an horizontal, or vertical, straight edge (with only one starting point and one ending point). <br/>If the edge is connected to a border node, the border node is moved too. </p> - <p>These actions are available on edge contextual menu + <p>These actions can be triggered on edge contextual menu <em>Layout/Straighten</em>: + </p> + <p> <img border="0" src="images/straightenToMenu.png"/> </p> - <p>Example of initial state of horizontal cases: - <img border="0" src="images/straightenHorizontalInitialState.png"/> - <br/>Result after - <em>Straighten to top</em> action: - <img border="0" src="images/straightenToTop.png"/> - <br/>Result after - <em>Straighten to bottom</em> action: - <img border="0" src="images/straightenToBottom.png"/> - <br/>Example of initial state of vertical cases: + <p>and also in the tabbar if at least one edge is selected: </p> + <p> + <img border="0" src="images/straightenToTabbarButton.png"/> + </p> + <p>There are two distinct kinds of straightening actions. The following examples show how they can be used.</p> + <p>Example for horizontal cases of result with the same initial state (the moved nodes are in red): </p> + <ul> + <li>Result after + <em>Straighten to top</em> action: + <img border="0" src="images/straightenToTop.png"/> + </li> + <li>Result after + <em>Straighten with left side pinned</em> action: + <img border="0" src="images/straightenWithLeftPinned.png"/> + </li> + <li>Result after + <em>Straighten with right side pinned</em> action: + <img border="0" src="images/straightenWithRightPinned.png"/> + </li> + <li>Result after + <em>Straighten to bottom</em> action: + <img border="0" src="images/straightenToBottom.png"/> + </li> + </ul> + <p>Example of initial state of vertical cases: <img border="0" src="images/straightenVerticalInitialState.png"/> - <br/>Result after - <em>Straighten to left</em> action: - <img border="0" src="images/straightenToLeft.png"/> - <br/>Result after - <em>Straighten to right</em> action: - <img border="0" src="images/straightenToRight.png"/> </p> + <ul> + <li>Result after + <em>Straighten to left</em> or + <em>Straighten with bottom side pinned</em> action: + <img border="0" src="images/straightenToRight.png"/> + </li> + <li>Result after + <em>Straighten to right</em> or + <em>Straighten with top side pinned</em> action: + <img border="0" src="images/straightenToLeft.png"/> + </li> + </ul> <p>The action can be disabled (grayed menu) in some conditions:</p> <ul> <li>The action is not possible because it does not respect the source or target node boundaries.</li> @@ -357,7 +382,11 @@ <li>The source or the target of the edge is another edge.</li> <li>The source and the target is the same element.</li> </ul> - <p>The action is available (menu is displayed) if the selection contains only edges (note and text attachments are not considered as edges).</p> + <p>The action is available (menu is displayed) if the selection contains at least one edge (note, labels and text attachments are not considered as edges). The menu will show all actions available for all edges in the selection. So if a straighten to top is available on one edge and straighten to left on another, both action will be available. Their execution will only affects the edges compatible with it.</p> + <h5 id="Straightenmanyedges">Straighten many edges</h5> + <p>The straighten actions can be triggered on one edge but also in case of a multi-selection containing more than one edges.</p> + <p>In this case the straighten actions available will be the union of actions available for each edges of the selection. I.e if an edge can be only straighten to top and another edge in the selection can be only straighten to top, then available actions on the selection of both edges will be both the top and left actions.</p> + <p>When executing a straighten action, only edges from the selection that can be affected by this action will be impacted (if a constraint prevent an edge to be straighten to the direction of the executed action, then it is untouched). </p> <h4 id="move_edge_group">Move edge group</h4> <p>In specific cases, we can find edges connected to border nodes. For example in a diagram representing data flows, exchanges are connected to port in and port out. When the user wants to move an exchange on a layouted diagram, he has to move the source port, then the target port and possibly move some bendpoints of the edge. <br/>This feature aims to move the group {edge, labels, ports} in a single diff --git a/plugins/org.eclipse.sirius.doc/doc/user/diagrams/Diagrams.textile b/plugins/org.eclipse.sirius.doc/doc/user/diagrams/Diagrams.textile index 89fa6d73ac..5e3a5d9c45 100644 --- a/plugins/org.eclipse.sirius.doc/doc/user/diagrams/Diagrams.textile +++ b/plugins/org.eclipse.sirius.doc/doc/user/diagrams/Diagrams.textile @@ -153,19 +153,33 @@ The user executes the "Remove Bend-points" action: This action is available within the edge context menu or by using the shortcut "Ctrl" + "Shift" + "-" and it is not available on edges with a "Tree" routing style. -h4(#straighten_an_edge). Straighten an edge +h4(#straighten_an_edge). Straighten edges -There are four actions to straighten an edge, i.e. to transform an edge to an horizontal, or vertical, straight edge (with only one starting point and one ending point). +h5. Straighten a single edge + +There are eight actions to straighten an edge, i.e. to transform an edge to an horizontal, or vertical, straight edge (with only one starting point and one ending point). If the edge is connected to a border node, the border node is moved too. -These actions are available on edge contextual menu _Layout/Straighten_: !images/straightenToMenu.png! +These actions can be triggered on edge contextual menu _Layout/Straighten_: + +!images/straightenToMenu.png! + +and also in the tabbar if at least one edge is selected: + +!images/straightenToTabbarButton.png! + +There are two distinct kinds of straightening actions. The following examples show how they can be used. + +Example for horizontal cases of result with the same initial state (the moved nodes are in red): + +* Result after _Straighten to top_ action: !images/straightenToTop.png! +* Result after _Straighten with left side pinned_ action: !images/straightenWithLeftPinned.png! +* Result after _Straighten with right side pinned_ action: !images/straightenWithRightPinned.png! +* Result after _Straighten to bottom_ action: !images/straightenToBottom.png! -Example of initial state of horizontal cases: !images/straightenHorizontalInitialState.png! -Result after _Straighten to top_ action: !images/straightenToTop.png! -Result after _Straighten to bottom_ action: !images/straightenToBottom.png! Example of initial state of vertical cases: !images/straightenVerticalInitialState.png! -Result after _Straighten to left_ action: !images/straightenToLeft.png! -Result after _Straighten to right_ action: !images/straightenToRight.png! +* Result after _Straighten to left_ or _Straighten with bottom side pinned_ action: !images/straightenToRight.png! +* Result after _Straighten to right_ or _Straighten with top side pinned_ action: !images/straightenToLeft.png! The action can be disabled (grayed menu) in some conditions: * The action is not possible because it does not respect the source or target node boundaries. @@ -175,7 +189,16 @@ The action can be disabled (grayed menu) in some conditions: * The source or the target of the edge is another edge. * The source and the target is the same element. -The action is available (menu is displayed) if the selection contains only edges (note and text attachments are not considered as edges). +The action is available (menu is displayed) if the selection contains at least one edge (note, labels and text attachments are not considered as edges). The menu will show all actions available for all edges in the selection. So if a straighten to top is available on one edge and straighten to left on another, both action will be available. Their execution will only affects the edges compatible with it. + +h5. Straighten many edges + +The straighten actions can be triggered on one edge but also in case of a multi-selection containing more than one edges. + +In this case the straighten actions available will be the union of actions available for each edges of the selection. I.e if an edge can be only straighten to top and another edge in the selection can be only straighten to top, then available actions on the selection of both edges will be both the top and left actions. + +When executing a straighten action, only edges from the selection that can be affected by this action will be impacted (if a constraint prevent an edge to be straighten to the direction of the executed action, then it is untouched). + h4(#move_edge_group). Move edge group diff --git a/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenToBottom.png b/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenToBottom.png Binary files differindex f32665fdb4..9c71f089ca 100644 --- a/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenToBottom.png +++ b/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenToBottom.png diff --git a/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenToMenu.png b/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenToMenu.png Binary files differindex 3727be1573..d686ea1119 100644 --- a/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenToMenu.png +++ b/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenToMenu.png diff --git a/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenToTabbarButton.png b/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenToTabbarButton.png Binary files differnew file mode 100644 index 0000000000..2173ddb71f --- /dev/null +++ b/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenToTabbarButton.png diff --git a/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenToTop.png b/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenToTop.png Binary files differindex 01392e418e..ccc9eee442 100644 --- a/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenToTop.png +++ b/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenToTop.png diff --git a/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenWithLeftPinned.png b/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenWithLeftPinned.png Binary files differnew file mode 100644 index 0000000000..74bad50a2a --- /dev/null +++ b/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenWithLeftPinned.png diff --git a/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenWithRightPinned.png b/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenWithRightPinned.png Binary files differnew file mode 100644 index 0000000000..0f5c24adc7 --- /dev/null +++ b/plugins/org.eclipse.sirius.doc/doc/user/diagrams/images/straightenWithRightPinned.png |
