diff options
| author | Esteban Dugueperoux | 2016-03-25 08:36:08 +0000 |
|---|---|---|
| committer | Esteban DUGUEPEROUX | 2016-03-31 15:27:47 +0000 |
| commit | 1ef19426604aef40f86f7ca96a9f0c614ffcdbc3 (patch) | |
| tree | f37221bf92ea45af7c4c788d2c1308f3bdcae821 | |
| parent | fe7fc1653ae059b5a970ea501a8059b8b975125e (diff) | |
| download | org.eclipse.sirius-1ef19426604aef40f86f7ca96a9f0c614ffcdbc3.tar.gz org.eclipse.sirius-1ef19426604aef40f86f7ca96a9f0c614ffcdbc3.tar.xz org.eclipse.sirius-1ef19426604aef40f86f7ca96a9f0c614ffcdbc3.zip | |
[490384] Add spec about "Reset to default filters" new action
Bug: 490384
Change-Id: Iaa9a9a2fcbee4460c8d8be930684ea645edf1730
Signed-off-by: Esteban Dugueperoux <esteban.dugueperoux@obeo.fr>
2 files changed, 132 insertions, 0 deletions
diff --git a/plugins/org.eclipse.sirius.doc/specs/proposal/490384_resetToDefaultFilters/490384.html b/plugins/org.eclipse.sirius.doc/specs/proposal/490384_resetToDefaultFilters/490384.html new file mode 100644 index 0000000000..8d79599b6a --- /dev/null +++ b/plugins/org.eclipse.sirius.doc/specs/proposal/490384_resetToDefaultFilters/490384.html @@ -0,0 +1,74 @@ +<?xml version='1.0' encoding='utf-8' ?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/> + </head> + <body> + <h1 id="SiriusEvolutionSpecificationHaveaResettodefaultfiltersactionintabbar.">Sirius Evolution Specification: Have a «Reset to default filters» action in tabbar.</h1> + <h2 id="Preamble">Preamble</h2> + <p> + <em>Summary</em>: Have a «reset to default filters» action in tabbar. + </p> + <table> + <tr> + <th>Version</th> + <th>Status</th> + <th>Date</th> + <th>Authors</th> + <th>Changes</th> + </tr> + <tr> + <td>v0.1</td> + <td>DRAFT</td> + <td>2016-03-24</td> + <td>edugueperoux</td> + <td>Initial version.</td> + </tr> + </table> + <p> + <em>Relevant tickets:</em> + </p> + <ul> + <li> + <a href="https://bugs.eclipse.org/bugs/show_bug.cgi?id=490384">Bug #490384, Have a ‹Reset to default filters› action in tabbar</a> + </li> + </ul> + <h2 id="Introduction">Introduction</h2> + <p>There is a need to have a filters related action to set activated filters on a diagram to their initial state as at diagram creation. + <br/>This need is expressed only in case of Concern use. + <br/>To recall Concern is a odesign concept, specific to diagram description, which allows to group references to filters, validation rules and behavior tools. + <br/>A diagram description can contains several Concern, and defined a default one. + <br/>Having a default concern defined for a diagram description, means that at diagram creation the filters, validation rules and behavior tools will be activated for this diagram. + </p> + <h2 id="DetailedSpecification">Detailed Specification</h2> + <p>A new action will be available in filters drop down button, at the end of the list of filters, only visible when there is a default concern defined for the diagram description. + <br/>The action would be enabled only if activated filters set is different of the set of filters from default concern. + <br/>This new action will call + <code>SetDefaultConcernCommand</code> EMF command to reset diagram to the default concern as defined in its diagram description and consequently will reset activated filters, validation rules and behavior tools to the one defined in the diagram description default concern. + </p> + <h2 id="BackwardCompatibilityandMigrationPaths">Backward Compatibility and Migration Paths</h2> + <h3 id="MetamodelChanges">Metamodel Changes</h3> + <p>No metamodel changes.</p> + <h3 id="APIChanges">API Changes</h3> + <p>No API changes.</p> + <h3 id="UserInterfaceChanges">User Interface Changes</h3> + <p>A new tabbar action will be available in filters drop down menu.</p> + <p>No other user interface changes.</p> + <h3 id="DocumentationChanges">Documentation Changes</h3> + <ul> + <li>Concern feature is an old feature not documented. At long term this feature will be removed or replaced by a better one, then this new action «Reset to default filters» will not be documented. This change will appears only in release notes.</li> + </ul> + <h2 id="TestsandNonregressionstrategy">Tests and Non-regression strategy</h2> + <ul> + <li>JUnit Tests + <ul> + <li>test action availability of action when there is a default concern</li> + <li>the non availability when there is no default concern</li> + <li>test the result of the action on activated filters </li> + <li>test that the button is gray (disabled) when the state of filter is the same as the default concern.</li> + </ul> + </li> + </ul> + <h2 id="Implementationchoicesandtradeoffs">Implementation choices and tradeoffs</h2> + </body> +</html>
\ No newline at end of file diff --git a/plugins/org.eclipse.sirius.doc/specs/proposal/490384_resetToDefaultFilters/490384.textile b/plugins/org.eclipse.sirius.doc/specs/proposal/490384_resetToDefaultFilters/490384.textile new file mode 100644 index 0000000000..046dd90233 --- /dev/null +++ b/plugins/org.eclipse.sirius.doc/specs/proposal/490384_resetToDefaultFilters/490384.textile @@ -0,0 +1,58 @@ +h1. Sirius Evolution Specification: Have a "Reset to default filters" action in tabbar. + +h2. Preamble + +_Summary_: Have a "reset to default filters" action in tabbar. + +|_. Version |_. Status |_. Date |_. Authors |_. Changes | +| v0.1 | DRAFT | 2016-03-24 | edugueperoux | Initial version. | + +_Relevant tickets:_ +* "Bug #490384, Have a 'Reset to default filters' action in tabbar":https://bugs.eclipse.org/bugs/show_bug.cgi?id=490384 + +h2. Introduction + +There is a need to have a filters related action to set activated filters on a diagram to their initial state as at diagram creation. +This need is expressed only in case of Concern use. +To recall Concern is a odesign concept, specific to diagram description, which allows to group references to filters, validation rules and behavior tools. +A diagram description can contains several Concern, and defined a default one. +Having a default concern defined for a diagram description, means that at diagram creation the filters, validation rules and behavior tools will be activated for this diagram. + +h2. Detailed Specification + +A new action will be available in filters drop down button, at the end of the list of filters, only visible when there is a default concern defined for the diagram description. +The action would be enabled only if activated filters set is different of the set of filters from default concern. +This new action will call @SetDefaultConcernCommand@ EMF command to reset diagram to the default concern as defined in its diagram description and consequently will reset activated filters, validation rules and behavior tools to the one defined in the diagram description default concern. + +h2. Backward Compatibility and Migration Paths + +h3. Metamodel Changes + +No metamodel changes. + +h3. API Changes + +No API changes. + +h3. User Interface Changes + +A new tabbar action will be available in filters drop down menu. + +No other user interface changes. + +h3. Documentation Changes + +* Concern feature is an old feature not documented. At long term this feature will be removed or replaced by a better one, then this new action "Reset to default filters" will not be documented. This change will appears only in release notes. + +h2. Tests and Non-regression strategy + +* JUnit Tests +** test action availability of action when there is a default concern +** the non availability when there is no default concern +** test the result of the action on activated filters +** test that the button is gray (disabled) when the state of filter is the same as the default concern. + + +h2. Implementation choices and tradeoffs + + |