Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMickael ADAM2017-08-02 11:55:52 +0000
committervincent lorenzo2017-09-01 09:01:23 +0000
commit288434710b55ee485e41011a79ff5ffb10159ac7 (patch)
tree94bf757b69b246a88fc67807a0e65665be360c71 /plugins
parent38075fa4f280949f45ea6e5e5c7b3e2d1d32b803 (diff)
downloadorg.eclipse.papyrus-288434710b55ee485e41011a79ff5ffb10159ac7.tar.gz
org.eclipse.papyrus-288434710b55ee485e41011a79ff5ffb10159ac7.tar.xz
org.eclipse.papyrus-288434710b55ee485e41011a79ff5ffb10159ac7.zip
Bug 520453 - [Documentation] Documentation on Graphical direction
customization on connectors shall exist https://bugs.eclipse.org/bugs/show_bug.cgi?id=520453 Change-Id: I1d5a8ca74b1976900a4c57420bb3c637e68c87a9 Signed-off-by: Mickael ADAM <mickael.adam@all4tec.net>
Diffstat (limited to 'plugins')
-rw-r--r--plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/plugin.xml8
-rw-r--r--plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/connectionDecorationCustomization.mediawiki40
-rw-r--r--plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/connectionDecorationCustomizationMain.xml4
-rw-r--r--plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css.mediawiki4
4 files changed, 54 insertions, 2 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 cc2180c8961..2c89b466847 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
@@ -18,6 +18,14 @@
<toc
file="target/generated-eclipse-help/textAlignment-toc.xml"
primary="false">
+ </toc>
+ <toc
+ file="target/generated-eclipse-help/connectionDecorationCustomizationMain.xml"
+ primary="false">
+ </toc>
+ <toc
+ file="target/generated-eclipse-help/connectionDecorationCustomization-toc.xml"
+ primary="false">
</toc>
</extension>
</plugin>
diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/connectionDecorationCustomization.mediawiki b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/connectionDecorationCustomization.mediawiki
new file mode 100644
index 00000000000..03e64cf77f7
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/connectionDecorationCustomization.mediawiki
@@ -0,0 +1,40 @@
+=Connection decoration customization=
+
+==Abstract==
+There is the possibility to display a direction (plain arrow for example) on connectors.
+This information is only graphical and not semantic. This capability can be driven by a dedicated CSS syntax or through properties view.
+
+==Requirement==
+#The graphical representation can be set on source.
+#The graphical representation can be set on target.
+#Available decoration must be extensible through extension point.
+#The source and target representation can be set with CSS.
+#The list of available decoration types is in CSS autocompletion.
+#The source and target representation can be set with properties view.
+#The width of the decoration line is the same as the width of edge line.
+
+==Usage==
+There are two possibities to set connection decoration on existing link, with properties view or with CSS.
+Available decorations are added through extension point, except for two which are:
+
+*''none'': No decoration will be displayed on the source or target connection.
+*''default'': The default decoration of the connection will be displayed.
+
+===With properties view===
+To use it activate the ''Advance Tabulation'': In Window > Preferences > Papyrus > Property views > ''Select Diagram Advanced Notation (plugin)'', Apply and close.
+Select the edge to customize, 'Advance Tabulation'' is now visible under ''Appearance''. You can set source and target decoration.
+
+===With CSS===
+Attributes ''sourceDecoration'' and ''targetDecoration'' permit to set source and target decoration on link. The list of available decoration values is accessible with the autocompletion (Ctrl+Space).
+
+==Extensibility==
+New decoration can be added through extension point:<br>
+''org.eclipse.papyrus.infra.gmfdiag.common.connectionDecoration''<br><br>
+Attributes:
+*''name'': The name of the decoration, used for the decoration values.
+*''class'': The class of the decoration to instanciate. Must implement ''org.eclipse.draw2d.RotatableDecoration''.
+
+Added decorations will be available in advance properties tab and in the CSS autocompletion.
+
+===Restriction===
+The full compliance is guaranteed for ''Stereotype Property Reference Link'' and for ''Connector Link''. \ No newline at end of file
diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/connectionDecorationCustomizationMain.xml b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/connectionDecorationCustomizationMain.xml
new file mode 100644
index 00000000000..e38cfed2e44
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/connectionDecorationCustomizationMain.xml
@@ -0,0 +1,4 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc label="Connection Decoration Customization" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocCustom" topic="target/generated-eclipse-help/connectionDecorationCustomization.html">
+ <link toc="target/generated-eclipse-help/connectionDecorationCustomization-toc.xml"/>
+</toc>
diff --git a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css.mediawiki b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css.mediawiki
index 320dd3dfa01..cdd9a2c81e4 100644
--- a/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css.mediawiki
+++ b/plugins/doc/org.eclipse.papyrus.infra.gmfdiag.css.doc/resource/css.mediawiki
@@ -348,9 +348,9 @@ The following properties can be used to bypass the standard UML notation. They c
|-
| lineDashGap || integer || N/A || Connectors || When the lineStyle is set to "Dash", specifies the gap between the dashes
|-
-| targetDecoration || <nowiki>[none]</nowiki> || N/A || Connectors || If "targetDecoration" is set to None, hides the target decoration of the Connector (e.g. the arrow)
+| targetDecoration || <nowiki>[none | default | open_arrow | ...]</nowiki> || N/A || Connectors || Permits to set target decoration. If "targetDecoration" is set to None, hides the target decoration of the Connector (e.g. the arrow)
|-
-| sourceDecoration || <nowiki>[none]</nowiki> || N/A || Connectors || If "sourceDecoration" is set to None, hides the source decoration of the Connector (e.g. the arrow)
+| sourceDecoration || <nowiki>[none | default | open_arrow | ...]</nowiki> || N/A || Connectors || Permits to set source decoration. If "sourceDecoration" is set to None, hides the source decoration of the Connector (e.g. the arrow)
|-
| maskLabel || <nowiki>string[]</nowiki> || N/A || Labels, floating labels || This property can be used to configure the display of complex labels (e.g. properties). See examples in the [#Mask_Label Mask Label] chapter below
|-

Back to the top