Bug 531729: [Diagram] Explicit the preference used to draw common bendpoints on connectors

Change-Id: I2fec207b58a7098419b0ad86d7b6044f73d65aee
Signed-off-by: Vincent Lorenzo <vincent.lorenzo@cea.fr>

7 files changed, 73 insertions, 0 deletions

diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/plugin.xml b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/plugin.xml
index 2c89b466847..fc6e0dfff5d 100644
--- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/plugin.xml
+++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/plugin.xml
@@ -26,6 +26,22 @@
       <toc
             file="target/generated-eclipse-help/connectionDecorationCustomization-toc.xml"
             primary="false">
+      </toc>
+      <toc
+            file="target/generated-eclipse-help/diagramPreferences-devDoc-main-toc.xml"
+            primary="false">
+      </toc>
+      <toc
+            file="target/generated-eclipse-help/diagramPreferences-devDoc-toc.xml"
+            primary="false">
+      </toc>
+      <toc
+            file="target/generated-eclipse-help/diagramPreferences-userDoc-main-toc.xml"
+            primary="false">
+      </toc>
+      <toc
+            file="target/generated-eclipse-help/diagramPreferences-userDoc-toc.xml"
+            primary="false">
       </toc>      
    </extension>
 </plugin>
diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/diagramPreferences-devDoc-main-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/diagramPreferences-devDoc-main-toc.xml
new file mode 100755
index 00000000000..def616b42d8
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/diagramPreferences-devDoc-main-toc.xml
@@ -0,0 +1,6 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc label="Diagrams" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocDev">
+    <topic label="Diagram's Preferences">
+    <link toc="target/generated-eclipse-help/diagramPreferences-devDoc-toc.xml"/>
+  	</topic>
+</toc>
diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/diagramPreferences-devDoc.mediawiki b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/diagramPreferences-devDoc.mediawiki
new file mode 100755
index 00000000000..b98234309a2
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/diagramPreferences-devDoc.mediawiki
@@ -0,0 +1,22 @@
+=Diagram Preferences=
+Many preferences are available for the diagrams. This page will be completed as arises.
+*The list of the diagram preferences key is provided by the class <code>org.eclipse.papyrus.infra.gmfdiag.common.preferences.PreferencesConstantsHelper</code>.
+**This class provides methods to calculate the <code>String</code> key for a given preference, represented by an <code>int</code> according to the context:
+***all diagrams
+***a specific diagram
+***a specific UML element 
+
+The preference values are generally stored in the PreferenceStore provided by <code>org.eclipse.papyrus.infra.gmfdiag.common.Activator</code>.
+
+The default value of preferences are generally done by classes extending <code>org.eclipse.core.runtime.preferences.AbstractPreferenceInitializer</code> or by a static method in a PreferencePage, like it is done with <code>org.eclipse.core.runtime.preferences.AbstractPreferenceInitializer</code>
+
+ 
+==Connection Preference==
+===Connection Bendpoints===
+*'''Draw Common Bendpoints''': 
+**the <code>int</code> value is provided by <code>org.eclipse.papyrus.infra.gmfdiag.common.preferences.PreferencesConstantsHelper.DRAW_CONNECTION_POINT</code>
+**the suffix's key is provided by <code>org.eclipse.papyrus.infra.gmfdiag.common.preferences.PreferencesConstantsHelper.DRAW_CONNECTION_POINT_CONSTANT</code>
+**the default value for this preference is <code>false</code>.
+**the class <code>org.eclipse.papyrus.infra.gmfdiag.common.figure.edge.PapyrusEdgeFigure</code> is in charge to draw the bendpoints through the method  <code>drawCommonbendpoints(Graphics)</code>, when the preference is set to <code>true</code>, but we need to override the method <code>org.eclipse.papyrus.infra.gmfdiag.common.figure.edge.PapyrusEdgeFigure.getDrawBendpointPreferenceValue()</code> to get this behavior.
+**The subclass <code>org.eclipse.papyrus.uml.diagram.common.figure.edge.CommonEdgeFigure</code> override the previous method to be able to draw the bendpoints according to the preference value.
+**The algorithm used to find the bendpoints to draw is tested by a JUnit test provided by the class <code>org.eclipse.papyrus.uml.diagram.common.tests.tests.CommonBendpointsTest</code>.
diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/diagramPreferences-userDoc-main-toc.xml b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/diagramPreferences-userDoc-main-toc.xml
new file mode 100755
index 00000000000..99a02c96617
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/diagramPreferences-userDoc-main-toc.xml
@@ -0,0 +1,7 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc label="Papyrus Modeling Tools" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusTipsAndTricks">
+	<topic label="Diagram Preferences">
+    
+    <link toc="target/generated-eclipse-help/diagramPreferences-userDoc-toc.xml"/>
+</topic>
+</toc>
diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/diagramPreferences-userDoc.mediawiki b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/diagramPreferences-userDoc.mediawiki
new file mode 100755
index 00000000000..a1dab4ec435
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/diagramPreferences-userDoc.mediawiki
@@ -0,0 +1,22 @@
+=Diagram Preferences=
+Many preferences are available for the diagrams. This page will be completed as arises.
+The Papyrus diagrams preferences are available doing '''Window > Preferences > Papyrus > Diagrams'''.
+Under the '''Diagram''' page, you will found each Papyrus Diagram with each preferences.
+
+The page for the diagram preferences:
+[[File:images/diagramPreferences/diagramPreferences.png]]
+
+
+==Connection Group==
+===Connection Bendpoints===
+This group provides the preferences concerning the connections' bendpoints.
+*'''Draw Common Bendpoints'''
+**This preference is only available on the page '''Window > Preferences > Papyrus > Diagrams''' because it is applied to all existing diagrams.
+**This preference allows to draw plain circle at the beginning and ending of a connection segment shared between several link representing the same type of UML Element and connected to the same source or target.
+**This preference is not available through the CSS.
+**This preference is set to <code>false</code> by default.
+**Known trouble:
+***print a diagram as image is not able to render the drawn bendpoints
+**Example of represented common bendpoints:
+[[File:images/diagramPreferences/drawCommonBendpoints.png]]
+
diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/images/diagramPreferences/diagramPreferences.png b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/images/diagramPreferences/diagramPreferences.png
new file mode 100755
index 00000000000..3090c47633c
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/images/diagramPreferences/diagramPreferences.png
diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/images/diagramPreferences/drawCommonBendpoints.png b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/images/diagramPreferences/drawCommonBendpoints.png
new file mode 100755
index 00000000000..8e48667c5bf
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/images/diagramPreferences/drawCommonBendpoints.png