Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLaurent Redor2016-05-12 10:27:24 +0000
committerLaurent Redor2016-05-13 09:31:06 +0000
commit407a3a24d89c963d1bc01ae0dce3ae732eed4eb8 (patch)
treee8880750bd1b929e2219eeabe1d8feacb8781c70
parent425fea1044e14703b493be3601af0338d298415d (diff)
downloadorg.eclipse.sirius-407a3a24d89c963d1bc01ae0dce3ae732eed4eb8.tar.gz
org.eclipse.sirius-407a3a24d89c963d1bc01ae0dce3ae732eed4eb8.tar.xz
org.eclipse.sirius-407a3a24d89c963d1bc01ae0dce3ae732eed4eb8.zip
[470297] Update documentation and release notes
Update documentation and release notes about impacts of these changes. Bug: 470297 Change-Id: I4db155eff6046351f2bc84cfb7a2841eee82b746 Signed-off-by: Laurent Redor <laurent.redor@obeo.fr>
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/Release_Notes.html8
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile1
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.html39
-rw-r--r--plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.textile16
4 files changed, 64 insertions, 0 deletions
diff --git a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html
index bccb24c0a2..d9683a44f4 100644
--- a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html
+++ b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.html
@@ -116,6 +116,14 @@
</li>
<li><span class="label label-success">Added</span> It is possible to create Typed Variable under Variable Filter.</li>
<li><span class="label label-info">Added</span> The specifier can now restrict the border node authorized sides. This new option is available in the advanced tab of the border node style. See the specifier documentation for more details.</li>
+ <li><span class="label label-info">Modified</span>
+ <strong>Warning</strong>: Before this version, a style customization of an
+ <code>EEnum</code> attribute, like
+ <code>labelFormat</code>, worked with a value expression using a Java service returning a
+ <code>EEnumLiteral</code>. It is now forbidden. You must return an
+ <code>Enumerator</code>. The documentation about
+ <a href="specifier/diagrams/Diagrams.html#enum_customization">Styles Customization</a> now details this case.
+ </li>
<li><span class="label label-info">Modified</span> The
<code>BorderSizeComputationExpression</code> migration has been corrected to recursively handle the sub container mappings. VSM created or migrated with Sirius 3.1.0, 3.1.1 or 3.1.2 might require a manual modification for the style descriptions of sub container mappings with border size computation equals to 0 as we cannot determine if they were added (or updated) after or before the migration: starting with Sirius 3.1.0, no border will be displayed for a 0 pixel value whereas with older version container always had at least a 1 pixel border.
</li>
diff --git a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile
index fffba72969..a42852d198 100644
--- a/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile
+++ b/plugins/org.eclipse.sirius.doc/doc/Release_Notes.textile
@@ -23,6 +23,7 @@ h3. Specifier-Visible Changes
* <span class="label label-success">Added</span> All static strings defined in the VSMs which are visible to the end-user of the modeler, like viewpoint and tools names, can now be internationalized. Simply replace the name with a translation key reference of the form @%myUniqueKey@ in the VSM, and define the value in the _Viewpoint Specification Project_'s @plugin.properties@ (for the default value), or @plugin_XX.properties@ for locale @XX@. The underlying mechanism is the same as for Eclipse/OSGi plug-ins, so translations can even be contributed by physically separate plug-in fragments. See "the corresponding section":specifier/general/Specifying_Viewpoints.html#translatable_messages in the documentation for more details.
* <span class="label label-success">Added</span> It is possible to create Typed Variable under Variable Filter.
* <span class="label label-info">Added</span> The specifier can now restrict the border node authorized sides. This new option is available in the advanced tab of the border node style. See the specifier documentation for more details.
+* <span class="label label-info">Modified</span> *Warning*: Before this version, a style customization of an @EEnum@ attribute, like @labelFormat@, worked with a value expression using a Java service returning a @EEnumLiteral@. It is now forbidden. You must return an @Enumerator@. The documentation about "Styles Customization":specifier/diagrams/Diagrams.html#enum_customization now details this case.
* <span class="label label-info">Modified</span> The @BorderSizeComputationExpression@ migration has been corrected to recursively handle the sub container mappings. VSM created or migrated with Sirius 3.1.0, 3.1.1 or 3.1.2 might require a manual modification for the style descriptions of sub container mappings with border size computation equals to 0 as we cannot determine if they were added (or updated) after or before the migration: starting with Sirius 3.1.0, no border will be displayed for a 0 pixel value whereas with older version container always had at least a 1 pixel border.
* <span class="label label-info">Modified</span> The variable under VariableFilter, previously named "Variable", is renamed to "Select Model Element Variable". It is functionally equivalent.
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 805aca07c0..a419688198 100644
--- a/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.html
+++ b/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.html
@@ -110,6 +110,11 @@
</li>
<li>
<a href="#customization">Diagram Styles Customization</a>
+ <ol style="list-style: disc;">
+ <li>
+ <a href="#enum_customization">Style Customization of an Enumerator property </a>
+ </li>
+ </ol>
</li>
</ol>
</li>
@@ -1731,5 +1736,39 @@
<em>Applied On</em> property). They will behave as if they had been defined locally inside a
<em>Style Customization</em> with no precondition.
</p>
+ <h3 id="enum_customization">Style Customization of an Enumerator property </h3>
+ <p>To customize a property of type Enumerator, the value expression must return an instance of Enumerator. Here is some examples of value expression:</p>
+ <ul>
+ <li>Examples for sourceArrow property (of kind
+ <code>EdgeArrows</code>):
+ <ul>
+ <li>
+ <code>aql:diagram::EdgeArrows::FillDiamond</code>
+ </li>
+ <li>
+ <code>aql:'FillDiamond'</code> or
+ <code>FillDiamond</code> also works but it is not recommended to use the literal value of an instance of Enumerator.
+ </li>
+ </ul>
+ </li>
+ <li>Examples for labelFormat property (of kind
+ <code>EList&lt;FontFormat&gt;</code>):
+ <ul>
+ <li>
+ <code>aql:viewpoint::FontFormat::bold</code> to set a label in bold
+ </li>
+ <li>
+ <code>aql:OrderedSet{viewpoint::FontFormat::bold, viewpoint::FontFormat::italic}</code> to set a label in bold and italic
+ </li>
+ <li>
+ <code>service:fontFormatBold()</code> with a service like
+ </li>
+ </ul>
+ </li>
+ </ul>
+ <pre>public FontFormat fontFormatBold(EObject any) {
+ return FontFormat.BOLD_LITERAL;
+ }
+</pre>
</body>
</html> \ No newline at end of file
diff --git a/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.textile b/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.textile
index 5b6549cf11..a8c7e86063 100644
--- a/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.textile
+++ b/plugins/org.eclipse.sirius.doc/doc/specifier/diagrams/Diagrams.textile
@@ -698,3 +698,19 @@ To use this feature, you must first create a _Style Customizations_ element insi
A _Style Customization_ can define a predicate expression to control whether or not it should apply. If defined, the expression is evaluated in the context of a semantic element to determine whether or not the customizations should be applied. If no expression is defined, the customizations will apply. If a _Style Customization_ applies to a given element, the _base style_ that the element would normally have will be modified by applying all the _Property Customization_ (by expression and by reference) defined in the _Style Customization_ , if they are compatible with that base style.
A _Style Customizations_ group can also contain _Style Customization Reuse_ elements. These can be used to reuse customizations defined elsewhere in a different context (specified using the _Reuse_ property), and apply them to other elements (specified using the _Applied On_ property). They will behave as if they had been defined locally inside a _Style Customization_ with no precondition.
+
+h3(#enum_customization). Style Customization of an Enumerator property
+
+To customize a property of type Enumerator, the value expression must return an instance of Enumerator. Here is some examples of value expression:
+
+* Examples for sourceArrow property (of kind @EdgeArrows@):
+** @aql:diagram::EdgeArrows::FillDiamond@
+** @aql:'FillDiamond'@ or @FillDiamond@ also works but it is not recommended to use the literal value of an instance of Enumerator.
+* Examples for labelFormat property (of kind @EList<FontFormat>@):
+** @aql:viewpoint::FontFormat::bold@ to set a label in bold
+** @aql:OrderedSet{viewpoint::FontFormat::bold, viewpoint::FontFormat::italic}@ to set a label in bold and italic
+** @service:fontFormatBold()@ with a service like
+
+pre. public FontFormat fontFormatBold(EObject any) {
+ return FontFormat.BOLD_LITERAL;
+ }

Back to the top