diff options
18 files changed, 59 insertions, 8 deletions
diff --git a/doc/org.eclipse.eef.documentation.ext.widgets.reference/pages/widget/reference.html b/doc/org.eclipse.eef.documentation.ext.widgets.reference/pages/widget/reference.html index f72daf16b..77711de3f 100644 --- a/doc/org.eclipse.eef.documentation.ext.widgets.reference/pages/widget/reference.html +++ b/doc/org.eclipse.eef.documentation.ext.widgets.reference/pages/widget/reference.html @@ -17,6 +17,7 @@ </li> <li>style: The style of the reference widget.</li> <li>conditionalStyles: All the conditional styles of the reference widget.</li> + <li>onClickExpression: If an onClickExpression is specified, the mono-valued version of the widget will now have a hyperlink instead of a label and the multi-valued version of the widget will react to clicks in the user interface. This expression is executed when the user will click on the widget in a similar fashion as the hyperlink and list widgets.</li> </ul> <h3 id="editanedreference">Edit an EReference named children</h3> <p>In order to edit an EReference named diff --git a/doc/org.eclipse.eef.documentation.ext.widgets.reference/pages/widget/reference.textile b/doc/org.eclipse.eef.documentation.ext.widgets.reference/pages/widget/reference.textile index f9b6085a1..1ea27a6cd 100644 --- a/doc/org.eclipse.eef.documentation.ext.widgets.reference/pages/widget/reference.textile +++ b/doc/org.eclipse.eef.documentation.ext.widgets.reference/pages/widget/reference.textile @@ -8,6 +8,7 @@ The reference widget is used to edit mono-valued and multi-valued references. On * referenceOwnerExpression: This expression is used to compute the EObject used to compute the value of the reference. By default, the EObject contained in the variable @self@ will be used. This expression must return an @org.eclipse.emf.ecore.EObject@. * style: The style of the reference widget. * conditionalStyles: All the conditional styles of the reference widget. +* onClickExpression: If an onClickExpression is specified, the mono-valued version of the widget will now have a hyperlink instead of a label and the multi-valued version of the widget will react to clicks in the user interface. This expression is executed when the user will click on the widget in a similar fashion as the hyperlink and list widgets. h3(#editanedreference). Edit an EReference named children diff --git a/doc/org.eclipse.eef.documentation/pages/language/dynamicmappings.html b/doc/org.eclipse.eef.documentation/pages/language/dynamicmappings.html index 8e52ec517..81cff8c25 100644 --- a/doc/org.eclipse.eef.documentation/pages/language/dynamicmappings.html +++ b/doc/org.eclipse.eef.documentation/pages/language/dynamicmappings.html @@ -20,6 +20,9 @@ <code>eStructuralFeature</code>. </li> <li>ifs: This property will contain all the use cases that can be handled by our dynamic mapping.</li> + <li>forceRefresh: This property is used to indicate that the dynamic mapping is based on an iterableExpression which may return a different result overtime for the same object contrary to the example before + <code>aql:self.eClass().eAllStructuralFeatures</code>. By setting forceRefresh to true, we will force the refresh of the user interface when evaluating this dynamic mapping. + </li> </ul> <p>An «if» contains the following two properties:</p> <ul> diff --git a/doc/org.eclipse.eef.documentation/pages/language/dynamicmappings.textile b/doc/org.eclipse.eef.documentation/pages/language/dynamicmappings.textile index 7b97eaf38..c21c6f916 100644 --- a/doc/org.eclipse.eef.documentation/pages/language/dynamicmappings.textile +++ b/doc/org.eclipse.eef.documentation/pages/language/dynamicmappings.textile @@ -9,6 +9,7 @@ h3(#properties). Properties * iterableExpression: This expression will use concepts of the meta-model in order to compute the number of element to take into account. This expression must return a collection of elements on which we will iterate to create the widgets. For example, to fulfill our requirement of one text widget for each property with the type EString, you could type the following iterableExpression @aql:self.eClass().eAllStructuralFeatures@. * iterator: The iterator will be used to define a name to manipulate the result of the iterable expression. To fulfill our requirement, we could use the name @eStructuralFeature@. * ifs: This property will contain all the use cases that can be handled by our dynamic mapping. +* forceRefresh: This property is used to indicate that the dynamic mapping is based on an iterableExpression which may return a different result overtime for the same object contrary to the example before @aql:self.eClass().eAllStructuralFeatures@. By setting forceRefresh to true, we will force the refresh of the user interface when evaluating this dynamic mapping. An "if" contains the following two properties: diff --git a/doc/org.eclipse.eef.documentation/pages/language/group.html b/doc/org.eclipse.eef.documentation/pages/language/group.html index 6ee93574f..89a7299ef 100644 --- a/doc/org.eclipse.eef.documentation/pages/language/group.html +++ b/doc/org.eclipse.eef.documentation/pages/language/group.html @@ -31,6 +31,7 @@ </li> <li>style: The style of the group is used to modify the appearance of the group in the user interface.</li> <li>conditionalStyles: The conditional styles is the list of all the alternate appearance that can be used when a specific condition is fulfilled.</li> + <li>actions: The list of the Toolbar Actions used to create buttons in the toolbar of the page. Those actions can contain a tooltipExpression wich should return a string used as the tooltip, an actionExpression executed when the user will click on the button and an imageExpression used to configure the appearance of the button. The imageExpression must return a string with the following structure PROJECT_NAME/IMAGE_PATH, for example: org.eclipse.sample/icons/Icon.gif</li> </ul> <h3 id="variables">Variables</h3> <p>The semantic candidate expression will have access to two different variables, diff --git a/doc/org.eclipse.eef.documentation/pages/language/group.textile b/doc/org.eclipse.eef.documentation/pages/language/group.textile index c960f5795..1f984c3df 100644 --- a/doc/org.eclipse.eef.documentation/pages/language/group.textile +++ b/doc/org.eclipse.eef.documentation/pages/language/group.textile @@ -16,6 +16,7 @@ h3(#properties). Properties * propertyValidationRules: The validation rules of the "widgets":widgets.html of the group. For more details regarding the validation in EEF, have a look at the documentation of the "validation":validation.html. * style: The style of the group is used to modify the appearance of the group in the user interface. * conditionalStyles: The conditional styles is the list of all the alternate appearance that can be used when a specific condition is fulfilled. +* actions: The list of the Toolbar Actions used to create buttons in the toolbar of the page. Those actions can contain a tooltipExpression wich should return a string used as the tooltip, an actionExpression executed when the user will click on the button and an imageExpression used to configure the appearance of the button. The imageExpression must return a string with the following structure PROJECT_NAME/IMAGE_PATH, for example: org.eclipse.sample/icons/Icon.gif h3(#variables). Variables diff --git a/doc/org.eclipse.eef.documentation/pages/language/page.html b/doc/org.eclipse.eef.documentation/pages/language/page.html index ed5fac710..44934fb47 100644 --- a/doc/org.eclipse.eef.documentation/pages/language/page.html +++ b/doc/org.eclipse.eef.documentation/pages/language/page.html @@ -22,6 +22,7 @@ <li>semanticValidationRules: The validation rules of the page. For more details regarding the validation in EEF, have a look at the documentation of the <a href="validation.html">validation</a>. </li> + <li>actions: The list of the Toolbar Actions used to create buttons in the toolbar of the page. Those actions can contain a tooltipExpression wich should return a string used as the tooltip, an actionExpression executed when the user will click on the button and an imageExpression used to configure the appearance of the button. The imageExpression must return a string with the following structure PROJECT_NAME/IMAGE_PATH, for example: org.eclipse.sample/icons/Icon.gif</li> </ul> <h4 id="variables">Variables</h4> <p>The semantic candidate expression will have access to two variables diff --git a/doc/org.eclipse.eef.documentation/pages/language/page.textile b/doc/org.eclipse.eef.documentation/pages/language/page.textile index a426f2c1d..6d4c8b0ec 100644 --- a/doc/org.eclipse.eef.documentation/pages/language/page.textile +++ b/doc/org.eclipse.eef.documentation/pages/language/page.textile @@ -13,6 +13,7 @@ h3(#properties). Properties * preconditionExpression: The precondition expression is used in order to determine if the page should be displayed or not. This expression must return a boolean. * groups: The list of the "groups":page.html that should be used in this page. * semanticValidationRules: The validation rules of the page. For more details regarding the validation in EEF, have a look at the documentation of the "validation":validation.html. +* actions: The list of the Toolbar Actions used to create buttons in the toolbar of the page. Those actions can contain a tooltipExpression wich should return a string used as the tooltip, an actionExpression executed when the user will click on the button and an imageExpression used to configure the appearance of the button. The imageExpression must return a string with the following structure PROJECT_NAME/IMAGE_PATH, for example: org.eclipse.sample/icons/Icon.gif h4(#variables). Variables diff --git a/doc/org.eclipse.eef.documentation/pages/language/widgets/button.html b/doc/org.eclipse.eef.documentation/pages/language/widgets/button.html index 18afe02a1..2c2c98bd5 100644 --- a/doc/org.eclipse.eef.documentation/pages/language/widgets/button.html +++ b/doc/org.eclipse.eef.documentation/pages/language/widgets/button.html @@ -12,6 +12,7 @@ <ul> <li>buttonLabelExpression: This expression is used to compute the label of the button. This expression must return a string.</li> <li>pushExpression: This expression will be executed once the end user will click on the button. This expression does not have to return anything.</li> + <li>imageExpression: This expression is used to compute the image to display in the button. This expression must return a string with the following structure PROJECT_NAME/IMAGE_PATH.</li> <li>style: The style of the button widget.</li> <li>conditionalStyle: All the conditional styles of the button widget.</li> </ul> @@ -24,6 +25,9 @@ <li>pushExpression: <code>aql:self.doSomething()</code> </li> + <li>imageExpression: + <code>org.eclipse.example/icons/Icon.gif</code> + </li> </ul> </body> </html>
\ No newline at end of file diff --git a/doc/org.eclipse.eef.documentation/pages/language/widgets/button.textile b/doc/org.eclipse.eef.documentation/pages/language/widgets/button.textile index 71a0b8273..a4f84cccb 100644 --- a/doc/org.eclipse.eef.documentation/pages/language/widgets/button.textile +++ b/doc/org.eclipse.eef.documentation/pages/language/widgets/button.textile @@ -6,6 +6,7 @@ The button widget can be used to execute an action in your user interface. On to * buttonLabelExpression: This expression is used to compute the label of the button. This expression must return a string. * pushExpression: This expression will be executed once the end user will click on the button. This expression does not have to return anything. +* imageExpression: This expression is used to compute the image to display in the button. This expression must return a string with the following structure PROJECT_NAME/IMAGE_PATH. * style: The style of the button widget. * conditionalStyle: All the conditional styles of the button widget. @@ -14,4 +15,5 @@ h3(#displayanaction). Display an action In order to create an action using a button widget, you can use the following properties: * buttonLabelExpression: @aql:'Click'@ -* pushExpression: @aql:self.doSomething()@
\ No newline at end of file +* pushExpression: @aql:self.doSomething()@ +* imageExpression: @org.eclipse.example/icons/Icon.gif@
\ No newline at end of file diff --git a/doc/org.eclipse.eef.documentation/pages/language/widgets/hyperlink.html b/doc/org.eclipse.eef.documentation/pages/language/widgets/hyperlink.html index 8455fd3c8..2eb5f1d33 100644 --- a/doc/org.eclipse.eef.documentation/pages/language/widgets/hyperlink.html +++ b/doc/org.eclipse.eef.documentation/pages/language/widgets/hyperlink.html @@ -24,6 +24,7 @@ <ul> <li>labelExpression: This expression is used to compute the label of the button. It should return a string.</li> <li>actionExpression: This expression is used to define the behavior of the button. It will be executed when the end user will click on the button. It should not return anything.</li> + <li>imageExpression: This expression is used to compute the image to display in the button. This expression must return a string with the following structure PROJECT_NAME/IMAGE_PATH.</li> </ul> <h3 id="displayanaction">Display an action</h3> <p>In order to create a hyperlink widget, you can use the following properties:</p> diff --git a/doc/org.eclipse.eef.documentation/pages/language/widgets/hyperlink.textile b/doc/org.eclipse.eef.documentation/pages/language/widgets/hyperlink.textile index 974ef3fef..b76291db6 100644 --- a/doc/org.eclipse.eef.documentation/pages/language/widgets/hyperlink.textile +++ b/doc/org.eclipse.eef.documentation/pages/language/widgets/hyperlink.textile @@ -15,6 +15,7 @@ A widget action contains only the following properties: * labelExpression: This expression is used to compute the label of the button. It should return a string. * actionExpression: This expression is used to define the behavior of the button. It will be executed when the end user will click on the button. It should not return anything. +* imageExpression: This expression is used to compute the image to display in the button. This expression must return a string with the following structure PROJECT_NAME/IMAGE_PATH. h3(#displayanaction). Display an action diff --git a/doc/org.eclipse.eef.documentation/pages/language/widgets/label.html b/doc/org.eclipse.eef.documentation/pages/language/widgets/label.html index e809ca735..709edc1be 100644 --- a/doc/org.eclipse.eef.documentation/pages/language/widgets/label.html +++ b/doc/org.eclipse.eef.documentation/pages/language/widgets/label.html @@ -22,6 +22,7 @@ <ul> <li>labelExpression: This expression is used to compute the label of the button. It should return a string.</li> <li>actionExpression: This expression is used to define the behavior of the button. It will be executed when the end user will click on the button. It should not return anything.</li> + <li>imageExpression: This expression is used to compute the image to display in the button. This expression must return a string with the following structure PROJECT_NAME/IMAGE_PATH.</li> </ul> <h3 id="displayreadonlyestringeattribute">Display a read-only EString EAttribute</h3> <p>In order to display in the user interface a label with the value of a read-only EAttribute with the eType EString, you can create a label widget with the following properties:</p> diff --git a/doc/org.eclipse.eef.documentation/pages/language/widgets/label.textile b/doc/org.eclipse.eef.documentation/pages/language/widgets/label.textile index 011daf3e6..b29b39daf 100644 --- a/doc/org.eclipse.eef.documentation/pages/language/widgets/label.textile +++ b/doc/org.eclipse.eef.documentation/pages/language/widgets/label.textile @@ -14,6 +14,7 @@ A widget action contains only the following properties: * labelExpression: This expression is used to compute the label of the button. It should return a string. * actionExpression: This expression is used to define the behavior of the button. It will be executed when the end user will click on the button. It should not return anything. +* imageExpression: This expression is used to compute the image to display in the button. This expression must return a string with the following structure PROJECT_NAME/IMAGE_PATH. h3(#displayreadonlyestringeattribute). Display a read-only EString EAttribute diff --git a/doc/org.eclipse.eef.documentation/pages/language/widgets/list.html b/doc/org.eclipse.eef.documentation/pages/language/widgets/list.html index 4580f4f40..ed34df991 100644 --- a/doc/org.eclipse.eef.documentation/pages/language/widgets/list.html +++ b/doc/org.eclipse.eef.documentation/pages/language/widgets/list.html @@ -20,7 +20,7 @@ <code>DOUBLE_CLICK</code>. This expression does not have to return anything. </li> <li>actions: The actions are a list of buttons which will be available next to the widget to allow the user to trigger some actions for the list. An action has a labelExpression which must return a string used as the label of the button created for the action. An action also has an action expression used to execute some behavior when the end user will click on the button. The action expression does not have to return anything. The action expression will have access to the selected elements in a variable named - <code>selection</code>. + <code>selection</code>. An action can also have an imageExpression, used to compute the image of the button created for the action. This expression must return a string with the following structure PROJECT_NAME/IMAGE_PATH. </li> <li>style: The style of the list widget.</li> <li>conditionalStyles: All the conditional styles of the list widget.</li> diff --git a/doc/org.eclipse.eef.documentation/pages/language/widgets/list.textile b/doc/org.eclipse.eef.documentation/pages/language/widgets/list.textile index c0867d6ac..17c3e5ee1 100644 --- a/doc/org.eclipse.eef.documentation/pages/language/widgets/list.textile +++ b/doc/org.eclipse.eef.documentation/pages/language/widgets/list.textile @@ -7,7 +7,7 @@ The list in EEF lets you display and edit a list of elements easily. On top of t * valueExpression: This expression will be used to compute all the valued will be displayed in the table. This expression must return an object. * displayExpression: This expression is used to compute each label of the table. This expression can use the result of the valueExpression thanks to the variable @value@. This expression must return a string. * onClickExpression: This expression will be executed when the user will click on the value. The user will be able to double click on a value. To determine whether the click on a single click or a double click, the kind of the click realized is available as a String in the variable @onClickEventKind@ which can have the value @SINGLE_CLICK@ or @DOUBLE_CLICK@. This expression does not have to return anything. -* actions: The actions are a list of buttons which will be available next to the widget to allow the user to trigger some actions for the list. An action has a labelExpression which must return a string used as the label of the button created for the action. An action also has an action expression used to execute some behavior when the end user will click on the button. The action expression does not have to return anything. The action expression will have access to the selected elements in a variable named @selection@. +* actions: The actions are a list of buttons which will be available next to the widget to allow the user to trigger some actions for the list. An action has a labelExpression which must return a string used as the label of the button created for the action. An action also has an action expression used to execute some behavior when the end user will click on the button. The action expression does not have to return anything. The action expression will have access to the selected elements in a variable named @selection@. An action can also have an imageExpression, used to compute the image of the button created for the action. This expression must return a string with the following structure PROJECT_NAME/IMAGE_PATH. * style: The style of the list widget. * conditionalStyles: All the conditional styles of the list widget. diff --git a/doc/org.eclipse.eef.documentation/pages/releasenotes.html b/doc/org.eclipse.eef.documentation/pages/releasenotes.html index ae5aefd38..8b357d768 100644 --- a/doc/org.eclipse.eef.documentation/pages/releasenotes.html +++ b/doc/org.eclipse.eef.documentation/pages/releasenotes.html @@ -43,11 +43,34 @@ </ol> <p>This document contains the release notes for recent major releases of EEF.</p> <h3 id="eef2.0.0">Changes in EEF 2.0.0</h3> + <h4 id="SpecifierVisibleChanges">Specifier-Visible Changes</h4> + <ul> + <li><span class="label label-success">Added</span> You can now create + <em>Toolbar Actions</em> on pages and groups in order to define small buttons in their toolbars. + </li> + <li><span class="label label-success">Added</span> + <em>Buttons</em> and + <em>Widget Actions</em> can now use an image along with a label thanks to the new + <em>Image expression</em>. + </li> + <li><span class="label label-success">Added</span> It is now possible to execute some behavior when the end users will click on the + <em>Reference Widget</em> thanks to the addition of an + <em>OnClick expression</em>. + </li> + <li><span class="label label-success">Added</span> You can indicate that a + <em>Dynamic Mapping For</em> should force the refresh of the user interface with the + <em>Force Refresh</em> property. + </li> + </ul> <h4 id="DeveloperVisibleChanges">Developer-Visible Changes</h4> <ul> <li><span class="label label-info">Modified</span> The class <code>org.eclipse.eef.core.api.controllers.AbstractEEFController</code> and all its subclasses now require an EditingContextAdapter. </li> + <li><span class="label label-info">Modified</span> The interface + <code>IConsumer</code> has now been replaced by + <code>java.util.Consumer</code>. + </li> </ul> <h3 id="eef1.9.0">Changes in EEF 1.9.0</h3> <h4 id="UserVisibleChanges">User-Visible Changes</h4> @@ -55,7 +78,7 @@ <li><span class="label label-success">Added</span> Add support for permissions with locks</li> </ul> <h3 id="eef1.8.0">Changes in EEF 1.8.0</h3> - <h4 id="SpecifierVisibleChanges">Specifier-Visible Changes</h4> + <h4 id="SpecifierVisibleChanges2">Specifier-Visible Changes</h4> <ul> <li><span class="label label-info">Modified</span> The selection variable of the hyperlink widget now refers properly to the value of the hyperlink.</li> </ul> @@ -64,13 +87,13 @@ <li><span class="label label-info">Modified</span> The interfaces of the controllers for the default widget will now return an IStatus in order to support potential issues after the execution of the callback.</li> </ul> <h3 id="eef1.7.2">Changes in EEF 1.7.2</h3> - <h4 id="SpecifierVisibleChanges2">Specifier-Visible Changes</h4> + <h4 id="SpecifierVisibleChanges3">Specifier-Visible Changes</h4> <ul> <li><span class="label label-info">Modified</span> The dynamic mappings will take into account all the «if» blocks with a valid predicate expression and not only the first one.</li> <li><span class="label label-info">Modified</span> Fixed an issue with the enablement of the widget actions of the reference widget.</li> </ul> <h3 id="eef1.7.1">Changes in EEF 1.7.1</h3> - <h4 id="SpecifierVisibleChanges3">Specifier-Visible Changes </h4> + <h4 id="SpecifierVisibleChanges4">Specifier-Visible Changes </h4> <ul> <li><span class="label label-info">Modified</span> Fixed an issue where the variable <code>input</code> was not available for some expressions in the select and radio widget. @@ -91,7 +114,7 @@ <code>enter</code>. </li> </ul> - <h4 id="SpecifierVisibleChanges4">Specifier-Visible Changes</h4> + <h4 id="SpecifierVisibleChanges5">Specifier-Visible Changes</h4> <ul> <li><span class="label label-success">Added</span> A brand new widget outside of the default library is now available to edit references using an easier approach. Only the name of the reference to edit is necessary and the rest will be computed by the EEF runtime.</li> <li><span class="label label-success">Added</span> Widget actions are now available on labels and hyperlinks.</li> @@ -130,7 +153,7 @@ <ul> <li><span class="label label-success">Added</span> The user interface has been recreated from scratch with a new runtime. As a result multiple changes can be visible in the user interface.</li> </ul> - <h4 id="SpecifierVisibleChanges5">Specifier-Visible Changes</h4> + <h4 id="SpecifierVisibleChanges6">Specifier-Visible Changes</h4> <ul> <li><span class="label label-success">Added</span> A brand new <a href="language/overview.html">language</a> is available to create your user interface. Have a look at the documentation for additional details. diff --git a/doc/org.eclipse.eef.documentation/pages/releasenotes.textile b/doc/org.eclipse.eef.documentation/pages/releasenotes.textile index 230db6f3f..8f81f83b2 100644 --- a/doc/org.eclipse.eef.documentation/pages/releasenotes.textile +++ b/doc/org.eclipse.eef.documentation/pages/releasenotes.textile @@ -6,9 +6,17 @@ This document contains the release notes for recent major releases of EEF. h3(#eef2.0.0). Changes in EEF 2.0.0 +h4. Specifier-Visible Changes + +* <span class="label label-success">Added</span> You can now create _Toolbar Actions_ on pages and groups in order to define small buttons in their toolbars. +* <span class="label label-success">Added</span> _Buttons_ and _Widget Actions_ can now use an image along with a label thanks to the new _Image expression_. +* <span class="label label-success">Added</span> It is now possible to execute some behavior when the end users will click on the _Reference Widget_ thanks to the addition of an _OnClick expression_. +* <span class="label label-success">Added</span> You can indicate that a _Dynamic Mapping For_ should force the refresh of the user interface with the _Force Refresh_ property. + h4. Developer-Visible Changes * <span class="label label-info">Modified</span> The class @org.eclipse.eef.core.api.controllers.AbstractEEFController@ and all its subclasses now require an EditingContextAdapter. +* <span class="label label-info">Modified</span> The interface @IConsumer@ has now been replaced by @java.util.Consumer@. h3(#eef1.9.0). Changes in EEF 1.9.0 |