From 288434710b55ee485e41011a79ff5ffb10159ac7 Mon Sep 17 00:00:00 2001 From: Mickael ADAM Date: Wed, 2 Aug 2017 13:55:52 +0200 Subject: 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 --- papyrusrequirements/PapyrusRequirements.di | 8 +- papyrusrequirements/PapyrusRequirements.notation | 28 +- papyrusrequirements/PapyrusRequirements.uml | 514 +++++++++++---------- .../plugin.xml | 8 + .../connectionDecorationCustomization.mediawiki | 40 ++ .../connectionDecorationCustomizationMain.xml | 4 + .../resource/css.mediawiki | 4 +- 7 files changed, 351 insertions(+), 255 deletions(-) create mode 100644 plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/connectionDecorationCustomization.mediawiki create mode 100644 plugins/doc/org.eclipse.papyrus.infra.gmfdiag.common.doc/resource/connectionDecorationCustomizationMain.xml diff --git a/papyrusrequirements/PapyrusRequirements.di b/papyrusrequirements/PapyrusRequirements.di index 8634d4c00e0..c80a2ed1fc8 100644 --- a/papyrusrequirements/PapyrusRequirements.di +++ b/papyrusrequirements/PapyrusRequirements.di @@ -1,2 +1,8 @@ - + + + + org.eclipse.papyrus.sysml.analysis + org.eclipse.papyrus.sysml.design + + diff --git a/papyrusrequirements/PapyrusRequirements.notation b/papyrusrequirements/PapyrusRequirements.notation index bd2a9e51865..26dc15c55bf 100644 --- a/papyrusrequirements/PapyrusRequirements.notation +++ b/papyrusrequirements/PapyrusRequirements.notation @@ -1,5 +1,5 @@ - + @@ -184,4 +184,30 @@ + + +
+ + + + + + + + + + + + + + + + + + + + + + + diff --git a/papyrusrequirements/PapyrusRequirements.uml b/papyrusrequirements/PapyrusRequirements.uml index 04688bbb6f8..575a2338cf0 100644 --- a/papyrusrequirements/PapyrusRequirements.uml +++ b/papyrusrequirements/PapyrusRequirements.uml @@ -1,251 +1,263 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 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 @@ + + + + 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:
+''org.eclipse.papyrus.infra.gmfdiag.common.connectionDecoration''

+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 @@ + + + + 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 || [none] || N/A || Connectors || If "targetDecoration" is set to None, hides the target decoration of the Connector (e.g. the arrow) +| targetDecoration || [none | default | open_arrow | ...] || 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 || [none] || N/A || Connectors || If "sourceDecoration" is set to None, hides the source decoration of the Connector (e.g. the arrow) +| sourceDecoration || [none | default | open_arrow | ...] || 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 || string[] || 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 |- -- cgit v1.2.3