diff options
Diffstat (limited to 'plugins/doc/org.eclipse.papyrus.layers.documentation/guides')
31 files changed, 0 insertions, 291 deletions
diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layers-toc.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layers-toc.xml deleted file mode 100644 index b54cf6ff390..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layers-toc.xml +++ /dev/null @@ -1,7 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc label="Papyrus Layers" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocDev"> - <topic href="guides/developpers/layersDevs.html" label="Layers Developers Documentation"> - <link toc="guides/developpers/layersDevs-toc.xml"/> - <anchor id="layers.guides.devs"/> - </topic> -</toc> diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs-toc.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs-toc.xml deleted file mode 100644 index 0d173331c62..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs-toc.xml +++ /dev/null @@ -1,6 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="guides/developpers/layersDevs.html" label="layersDevs"> - <topic href="guides/developpers/layersDevs.html" label="Layers Developpers"></topic> - <topic href="guides/developpers/layersDevs.html#General_Architecture" label="General Architecture"></topic> - <topic href="guides/developpers/layersDevs.html#Plugins" label="Plugins"></topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs.html b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs.html deleted file mode 100644 index 98dd7080b47..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs.html +++ /dev/null @@ -1 +0,0 @@ -<?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><h2 id="Layers_Developpers">Layers Developpers</h2><p>This is the documentation for layers developpers</p><h2 id="General_Architecture">General Architecture</h2><h2 id="Plugins">Plugins</h2></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs.mediawiki b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs.mediawiki deleted file mode 100644 index d9a33a73e11..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/developpers/layersDevs.mediawiki +++ /dev/null @@ -1,8 +0,0 @@ -== Layers Developpers ==
-This is the documentation for layers developpers
-
-
-== General Architecture ==
-
-== Plugins ==
-
diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/index-toc.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/index-toc.xml deleted file mode 100644 index da056b58757..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/index-toc.xml +++ /dev/null @@ -1,9 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc label="Layers" link_to="../org.eclipse.papyrus.infra.doc/toc.xml#PapyrusDocUser"> - <topic label="Layers" > - <link toc="guides/tutorials/layers-toc.xml"/> - <anchor id="tutorials"/> - <link toc="guides/users/index-toc.xml"/> - <anchor id="documentation"/> - </topic> -</toc> diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial-toc.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial-toc.xml deleted file mode 100644 index 42a0f7e2d56..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial-toc.xml +++ /dev/null @@ -1,12 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="guides/tutorials/derivedLayerTutorial.html" label="derivedLayerTutorial"> - <topic href="guides/tutorials/derivedLayerTutorial.html" label="Using Derived Layer (OCL Expression)"> - <topic href="guides/tutorials/derivedLayerTutorial.html#Creating_a_derived_Layer" label="Creating a derived Layer"></topic> - <topic href="guides/tutorials/derivedLayerTutorial.html#Writing_an_expression" label="Writing an expression"></topic> - <topic href="guides/tutorials/derivedLayerTutorial.html#Expressions_Examples" label="Expressions Examples"> - <topic href="guides/tutorials/derivedLayerTutorial.html#All_views_starting_with_a_particular_string" label="All views starting with a particular string"></topic> - <topic href="guides/tutorials/derivedLayerTutorial.html#All_classes_that_are_abstract" label="All classes that are abstract"></topic> - <topic href="guides/tutorials/derivedLayerTutorial.html#All_classes_containing_an_operation_named_.27abc.27" label="All classes containing an operation named 'abc'"></topic> - </topic> - </topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial.html b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial.html deleted file mode 100644 index c335b620d42..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial.html +++ /dev/null @@ -1,5 +0,0 @@ -<?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="Using_Derived_Layer_.28OCL_Expression.29">Using Derived Layer (OCL Expression)</h1><p>This tutorial show how to use a Derived Layer.</p><p>A derived layer is a leaf Layer where the views are automatically attached to -the layer, according to an expression. Actually, the expression is expressed in OCL.</p><h2 id="Creating_a_derived_Layer">Creating a derived Layer</h2><p>Derived Layer are actually called 'RegExp Layer'.</p><p>To create a derived layer:</p><ul><li>Click on the Layer stack</li><li>Click Layer->Create Layers ...->Create RegExp Layer</li></ul><p><img border="0" src="derivedLayerTutorial/createRegExpLayer.png"/></p><p>The new Layer appears under the Layer Stack. You can add Properties to the layer.</p><h2 id="Writing_an_expression">Writing an expression</h2><p>A derived layer is a Layer where views are automatically attached to -the layer. The expression is used for this purpose.</p><p>Actually, the expression can only be written in OCL.</p><p>The expression is a boolean expression returning true or false. The expression is applied on each <b><i>view</i></b> (ie Shapes and Links) in the diagram. If the expression return true, the corresponding element is attached to the layer. If the expression return false, the element is not attached to the layer.</p><p>The OCL expression has a predefined variable called 'self'. It is the 'view' that must be checked. -This variable is of type <b><i>notation::View</i></b> . It can be subclassed in <b><i>notation::Shape</i></b> and <b><i>notation::Link</i></b> .</p><p>A view in a uml diagram is always associated to a UML element. This element can be accessed with the expression <b><i>self.element</i></b> .</p><p>The expression is written in the Layer property->Expr -<img border="0" src="derivedLayerTutorial/writeExpression.png"/></p><h2 id="Expressions_Examples">Expressions Examples</h2><h3 id="All_Shapes">All Shapes</h3><ul><li>self.oclIsKindOf(Shape)</li></ul><h3 id="All_Classes.2FInterface.2F_...">All Classes/Interface/ ...</h3><ul><li>self.element.oclIsKindOf(uml::NamedElement)</li><li>self.element.oclIsKindOf(uml::Class)</li><li>self.element.oclIsKindOf(uml::Package)</li></ul><h3 id="All_Classes.2FNamedElement.2F..._starting_with_a_particular_string">All Classes/NamedElement/... starting with a particular string</h3><ul><li>self.element.oclAsType(uml::NamedElement).name.startsWith('D') = true</li><li>self.element.oclAsType(uml::Class).name.startsWith('Cl') = true</li><li>self.element.oclAsType(uml::Interface).name.startsWith('I') = true</li></ul><h3 id="and_.2F_or">and / or</h3><ul><li>self.oclIsKindOf(Shape) <b>and</b> self.oclAsType(Shape).visible = true </li></ul><ul><li>self.element.oclIsKindOf(uml::Class) <b>or</b> self.element.oclIsKindOf(uml::Package) </li></ul><h3 id="All_classes_that_are_abstract">All classes that are abstract</h3><ul><li>self.element.oclAsType(uml::Class).isAbstract</li></ul><h3 id="All_classes_containing_an_operation_named_.27op1.27">All classes containing an operation named 'op1'</h3><ul><li>self.element.oclAsType(uml::Class).ownedOperation->exists( op | op.name = 'op1')</li></ul><p>Also:</p><ul><li>self.element.oclAsType(uml::Class).ownedAttribute->exists( attr | attr.name = 'name')</li></ul></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial.mediawiki b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial.mediawiki deleted file mode 100644 index 583466e2f44..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial.mediawiki +++ /dev/null @@ -1,70 +0,0 @@ -= Using Derived Layer (OCL Expression) = - -This tutorial show how to use a Derived Layer. - -A derived layer is a leaf Layer where the views are automatically attached to -the layer, according to an expression. Actually, the expression is expressed in OCL. - -== Tutorial Video == - -A tutorial is available here: -[http://youtu.be/x6lnWwD47ZI] - -== Creating a derived Layer == -Derived Layer are actually called 'RegExp Layer'. - -To create a derived layer: - -* Click on the Layer stack -* Click Layer->Create Layers ...->Create RegExp Layer - - -[[Image:derivedLayerTutorial/createRegExpLayer.png]] - -The new Layer appears under the Layer Stack. You can add Properties to the layer. - -== Writing an expression == -A derived layer is a Layer where views are automatically attached to -the layer. The expression is used for this purpose. - -Actually, the expression can only be written in OCL. - -The expression is a boolean expression returning true or false. The expression is applied on each '''''view''''' (ie Shapes and Links) in the diagram. If the expression return true, the corresponding element is attached to the layer. If the expression return false, the element is not attached to the layer. - -The OCL expression has a predefined variable called 'self'. It is the 'view' that must be checked. -This variable is of type '''''notation::View''''' . It can be subclassed in '''''notation::Shape''''' and '''''notation::Link''''' . - -A view in a uml diagram is always associated to a UML element. This element can be accessed with the expression '''''self.element''''' . - -The expression is written in the Layer property->Expr -[[Image:derivedLayerTutorial/writeExpression.png]] - - -== Expressions Examples == - -=== All Shapes === -* self.oclIsKindOf(Shape) - -=== All Classes/Interface/ ... === -* self.element.oclIsKindOf(uml::NamedElement) -* self.element.oclIsKindOf(uml::Class) -* self.element.oclIsKindOf(uml::Package) - -=== All Classes/NamedElement/... starting with a particular string === -* self.element.oclAsType(uml::NamedElement).name.startsWith('D') = true -* self.element.oclAsType(uml::Class).name.startsWith('Cl') = true -* self.element.oclAsType(uml::Interface).name.startsWith('I') = true - -=== and / or === -* self.oclIsKindOf(Shape) '''and''' self.oclAsType(Shape).visible = true - -* self.element.oclIsKindOf(uml::Class) '''or''' self.element.oclIsKindOf(uml::Package) -=== All classes that are abstract === -* self.element.oclAsType(uml::Class).isAbstract - -=== All classes containing an operation named 'op1' === -* self.element.oclAsType(uml::Class).ownedOperation->exists( op | op.name = 'op1') - -Also: -* self.element.oclAsType(uml::Class).ownedAttribute->exists( attr | attr.name = 'name') - diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial/createRegExpLayer.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial/createRegExpLayer.png Binary files differdeleted file mode 100644 index e277553b384..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial/createRegExpLayer.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial/writeExpression.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial/writeExpression.png Binary files differdeleted file mode 100644 index 81061e0e1a5..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/derivedLayerTutorial/writeExpression.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/layers-toc.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/layers-toc.xml deleted file mode 100644 index 7baf497198d..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/layers-toc.xml +++ /dev/null @@ -1,8 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc label="Layers Tutorials" > - <topic label="Layers Tutorials"> - <link toc="guides/tutorials/simpleTutorial-toc.xml"/> - <link toc="guides/tutorials/derivedLayerTutorial-toc.xml"/> - <anchor id="layers.guides.tutorials"/> - </topic> -</toc> diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial-toc.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial-toc.xml deleted file mode 100644 index cc37f9ba974..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial-toc.xml +++ /dev/null @@ -1,18 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc topic="guides/tutorials/simpleTutorial.html" label="simpleTutorial"> - <topic href="guides/tutorials/simpleTutorial.html" label="A simple Example and Tutorial"> - <topic href="guides/tutorials/simpleTutorial.html#Create_a_new_Class_Diagram" label="Create a new Class Diagram"></topic> - <topic href="guides/tutorials/simpleTutorial.html#Open_the_LayersExplorer" label="Open the LayersExplorer"></topic> - <topic href="guides/tutorials/simpleTutorial.html#Attach_a_LayersStack_to_your_diagram" label="Attach a LayersStack to your diagram"></topic> - <topic href="guides/tutorials/simpleTutorial.html#Create_a_new_Layer_in_the_LayersStack" label="Create a new Layer in the LayersStack"></topic> - <topic href="guides/tutorials/simpleTutorial.html#Attach_Classes_to_the_Layer" label="Attach Classes to the Layer"></topic> - <topic href="guides/tutorials/simpleTutorial.html#Attach_some_properties_to_the_layer" label="Attach some properties to the layer"></topic> - <topic href="guides/tutorials/simpleTutorial.html#Add_more_layers" label="Add more layers"></topic> - <topic href="guides/tutorials/simpleTutorial.html#Change_the_value_of_an_attached_property" label="Change the value of an attached property"></topic> - <topic href="guides/tutorials/simpleTutorial.html#Add_the_3rd_layer" label="Add the 3rd layer"></topic> - <topic href="guides/tutorials/simpleTutorial.html#Disabling_a_Layer" label="Disabling a Layer"></topic> - </topic> - <topic href="guides/tutorials/simpleTutorial.html#Layer_Operators" label="Layer Operators"> - <topic href="guides/tutorials/simpleTutorial.html#Top_Layer_Operator" label="Top Layer Operator"></topic> - </topic> -</toc>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial.html b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial.html deleted file mode 100644 index 16a657ecba0..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial.html +++ /dev/null @@ -1,4 +0,0 @@ -<?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="A_simple_Example_and_Tutorial">A simple Example and Tutorial</h1><p>In this example, we create a class diagram with 3 classes (class1, class2, class3), and a LayersStack with 3 layers (layer2, layer1, bottom). The bottom layer control the 3 classes and all the available properties. The layer1 control Class1 and Class2. The layer2 control Class2 and Class3.</p><p>This example is also a tutorial, if you follow it step by step.</p><h2 id="Create_a_new_Class_Diagram">Create a new Class Diagram</h2><p>Start by creating a Papyrus Class Diagram with 3 classes:</p><ul><li>Create a new ClassDiagram in a Papyrus model</li><li>Create three classes: Class1, Class2, Class3</li><li>Open the Papyrus ModelExplorer and the Property View.</li></ul><p>You should have a diagram and model explorer like in the following figure:</p><p><img border="0" src="simpleTutorialImages/diagramWith3Classes.png"/></p><h2 id="Open_the_LayersExplorer">Open the LayersExplorer</h2><p>To open the LayersExplorer:</p><ul><li>In the diagram, Right Click->Layers->Open LayersExplorer</li></ul><p><img border="0" src="simpleTutorialImages/opnLayersExplorer.png"/></p><ul><li>The explorer should open (not necessarly at the same position as in the following snapshoot):</li></ul><p><img border="0" src="simpleTutorialImages/OpenedLayersExplorer.png"/></p><h2 id="Attach_a_LayersStack_to_your_diagram">Attach a LayersStack to your diagram</h2><p>To attach a LayersStack to your diagram:</p><ul><li>Click in the diagram, then Right Click->Layers->Attach Layer Stack</li></ul><p><img border="0" src="simpleTutorialImages/attachLayersStack.png"/></p><ul><li>The LayersExplorer should show the layers attached to the LayersStack. By default, there is a 'Layer Operator' of type 'Top Layer'. The 'Top Layer Operator' contains layers that are ordered from top to bottom. When computing the value for a particular (view, property type) couple, it search the first layer that define a value for the couple, and return this value.</li></ul><p><img border="0" src="simpleTutorialImages/attachedLayersStack.png"/></p><h2 id="Create_a_new_Layer_in_the_LayersStack">Create a new Layer in the LayersStack</h2><p>We need now to create a layer in the stack.</p><p>To create a new Layer in the LayersStack:</p><ul><li>In the LayerExplorer, select the Top Layer Operator</li><li>right click->Layers->Create Layers ...->Create Layer</li></ul><p><img border="0" src="simpleTutorialImages/createLayer.png"/></p><ul><li>A new layer is created:<ul><li>Open the tree node to see the layer (1)</li><li>Select the layers tab in the Property view (2)</li><li>Change the name of the layer to 'bottomLayer' (3)</li></ul></li></ul><p><img border="0" src="simpleTutorialImages/createdLayer.png"/></p><h2 id="Attach_Classes_to_the_Layer">Attach Classes to the Layer</h2><p>Attaching some classes (also called views) to a layer means that this layer will partially control the value of some properties for this attached classes. -Here, we attach the 3 classes. -To Attach the classes to the Layer:</p><ul><li>Select the layer 'bottomLayer', right click->Layers->Attach Views</li></ul><p><img border="0" src="simpleTutorialImages/attachViewsToLayer.png"/> </p><ul><li>A window open, select the 3 classes (1) and click 'ok (2)'.:</li></ul><p><img border="0" src="simpleTutorialImages/attachViewWindowSelectClasses.png"/></p><h2 id="Attach_some_properties_to_the_layer">Attach some properties to the layer</h2><p>A layer is used to control some properties of the attached views. It is necessary to attach the properties -controled by the layer. Once attached, it is possible to modify the values of this properties.</p><p>To attach some properties to the layer:</p><ul><li>In the LayersExplorer, select the defaul layer, right click->Layers->Attach Properties</li></ul><p><img border="0" src="simpleTutorialImages/openAttachPropertiesWindow.png"/></p><ul><li>The Attach Properties window open. Select properties as in the screenshot, and then 'ok'.</li></ul><p><img border="0" src="simpleTutorialImages/attachPropertiesWindow.png"/></p><ul><li>The properties and the views are now attached to the layers. Properties for these views are computed according to the layer, and as a resul the fill color change. This is because the default value for 'fill color' of the layer property is different from the Papyrus value.<ul><li>You can open the property node in the LayersExplorer, select a property, and change its value in the Property view.</li></ul></li></ul><p><img border="0" src="simpleTutorialImages/defaulLayerProperties.png"/></p><h2 id="Add_more_layers">Add more layers</h2><p>Now, add a new Layer in the Top Layer Operator:</p><ul><li>Select the Top Layer Operator, </li><li>right click->Layers->Create Layers ...->Create Layer</li><li>The new layer shoul appear as the first layer of the top layer operator.</li><li>Attach the class1 and class2</li><li>Attach the fill property</li></ul><h2 id="Change_the_value_of_an_attached_property">Change the value of an attached property</h2><p>You can change the value of the fill property color for the layer.</p><ul><li>Open the node 'Color' of the 'Fill Property' </li><li>click on the color picker in the Property view. </li><li>Choose a new color (blue).</li><li>The color should be applied on the 2 classes attached to the layer (Class1 and Class2). </li><li>Class3 still have the color of the 'bottom' layer.</li></ul><p><img border="0" src="simpleTutorialImages/changeFillColorValue.png"/></p><ul><li>Note that Class1 and Class2 color change to 'blue' because when computing the color for Class1, the first layer that attach both Class1and Property Fill is the Layer1. In this layer, the value for the Property Fill is 'blue', so it is for Class1. The same happen for class2.</li></ul><h2 id="Add_the_3rd_layer">Add the 3rd layer</h2><ul><li>Add a 3rd layer<ul><li>Attach the 2 classes Class2 and Class3 to this layer.</li><li>Attach the property 'Fill Color'</li><li>Change the value of 'Fill Color' to orange<ul><li>Class2 and Class3 should change to orange.</li></ul></li></ul></li></ul><p><img border="0" src="simpleTutorialImages/layer2.png"/></p><h2 id="Disabling_a_Layer">Disabling a Layer</h2><p>It is possible to disable a layer without deleting it. A disabled layer do not participate in layer stack.</p><p>To disable a layer, select it in the LayersExplorer.</p><ul><li>Then in the PropertyView, open the Layers tab</li><li>select or unselect the layer with 'Is Layer Enable".<ul><li>Note that in our example, disabling the Layer2 will change the color of the Class2 and Class3. Class2 take the color specified by layer1, and Class3 the color specified by bottomLayer.</li></ul></li></ul><p><img border="0" src="simpleTutorialImages/disableLayer.png"/></p><h1 id="Layer_Operators">Layer Operators</h1><p>Layer Operators are a kind of layer that can contain other Layers.</p><p>A layer operator is called like this because it is used to apply an 'operator' on its nested layers. The operator compute the property values for attached layers.</p><p>It is not possible to attach directly views or properties to a layer operator. But a layer operator still have a set of attached views and a set of attached properties. The values of these properties are the results of applying the operator on the properties of the nested layers. The set of the attached views is generally the union of the views attached to the nested layers.</p><p>There is different kind of 'layer operators', each one proposing a different way of computing the property values.</p><h2 id="Top_Layer_Operator">Top Layer Operator</h2><p>The 'Top Layer Operator' contains layers that are ordered from top to bottom. It is called 'Top Layer Operator' because it return the top most value for a particular (view, property type) couple. </p><p>When computing the property value for a specified (view, property type), the Top Layer Operator return the first value found for this couple. It start from the top layer, and stop as soon as a layer as a value set for the specified (view, property type).</p></body></html>
\ No newline at end of file diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial.mediawiki b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial.mediawiki deleted file mode 100644 index c4289c45315..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorial.mediawiki +++ /dev/null @@ -1,136 +0,0 @@ - - -= A simple Example and Tutorial = -In this example, we create a class diagram with 3 classes (class1, class2, class3), and a LayersStack with 3 layers (layer2, layer1, bottom). The bottom layer control the 3 classes and all the available properties. The layer1 control Class1 and Class2. The layer2 control Class2 and Class3. - -This example is also a tutorial, if you follow it step by step. - -== Create a new Class Diagram == -Start by creating a Papyrus Class Diagram with 3 classes: -* Create a new ClassDiagram in a Papyrus model -* Create three classes: Class1, Class2, Class3 -* Open the Papyrus ModelExplorer and the Property View. -You should have a diagram and model explorer like in the following figure: - -[[Image:simpleTutorialImages/diagramWith3Classes.png]] - -== Open the LayersExplorer == -To open the LayersExplorer: -* In the diagram, Right Click->Layers->Open LayersExplorer -[[Image:simpleTutorialImages/opnLayersExplorer.png]] - -* The explorer should open (not necessarly at the same position as in the following snapshoot): -[[Image:simpleTutorialImages/OpenedLayersExplorer.png]] - - -== Attach a LayersStack to your diagram == -To attach a LayersStack to your diagram: - -* Click in the diagram, then Right Click->Layers->Attach Layer Stack -[[Image:simpleTutorialImages/attachLayersStack.png]] - -* The LayersExplorer should show the layers attached to the LayersStack. By default, there is a 'Layer Operator' of type 'Top Layer'. The 'Top Layer Operator' contains layers that are ordered from top to bottom. When computing the value for a particular (view, property type) couple, it search the first layer that define a value for the couple, and return this value. - -[[Image:simpleTutorialImages/attachedLayersStack.png]] - -== Create a new Layer in the LayersStack == -We need now to create a layer in the stack. - -To create a new Layer in the LayersStack: - -* In the LayerExplorer, select the Top Layer Operator -* right click->Layers->Create Layers ...->Create Layer -[[Image:simpleTutorialImages/createLayer.png]] - -* A new layer is created: -** Open the tree node to see the layer (1) -** Select the layers tab in the Property view (2) -** Change the name of the layer to 'bottomLayer' (3) -[[Image:simpleTutorialImages/createdLayer.png]] - - -== Attach Classes to the Layer == - -Attaching some classes (also called views) to a layer means that this layer will partially control the value of some properties for this attached classes. -Here, we attach the 3 classes. -To Attach the classes to the Layer: -* Select the layer 'bottomLayer', right click->Layers->Attach Views -[[Image:simpleTutorialImages/attachViewsToLayer.png]] - -* A window open, select the 3 classes (1) and click 'ok (2)'.: -[[Image:simpleTutorialImages/attachViewWindowSelectClasses.png]] - -== Attach some properties to the layer == - -A layer is used to control some properties of the attached views. It is necessary to attach the properties -controled by the layer. Once attached, it is possible to modify the values of this properties. - -To attach some properties to the layer: -* In the LayersExplorer, select the defaul layer, right click->Layers->Attach Properties -[[Image:simpleTutorialImages/openAttachPropertiesWindow.png]] - -* The Attach Properties window open. Select properties as in the screenshot, and then 'ok'. -[[Image:simpleTutorialImages/attachPropertiesWindow.png]] - -* The properties and the views are now attached to the layers. Properties for these views are computed according to the layer, and as a resul the fill color change. This is because the default value for 'fill color' of the layer property is different from the Papyrus value. -** You can open the property node in the LayersExplorer, select a property, and change its value in the Property view. -[[Image:simpleTutorialImages/defaulLayerProperties.png]] - - - -== Add more layers == -Now, add a new Layer in the Top Layer Operator: -* Select the Top Layer Operator, -* right click->Layers->Create Layers ...->Create Layer -* The new layer shoul appear as the first layer of the top layer operator. -* Attach the class1 and class2 -* Attach the fill property - -== Change the value of an attached property == -You can change the value of the fill property color for the layer. - -* Open the node 'Color' of the 'Fill Property' -* click on the color picker in the Property view. -* Choose a new color (blue). -* The color should be applied on the 2 classes attached to the layer (Class1 and Class2). -* Class3 still have the color of the 'bottom' layer. -[[Image:simpleTutorialImages/changeFillColorValue.png]] - - -* Note that Class1 and Class2 color change to 'blue' because when computing the color for Class1, the first layer that attach both Class1and Property Fill is the Layer1. In this layer, the value for the Property Fill is 'blue', so it is for Class1. The same happen for class2. - -== Add the 3rd layer == -* Add a 3rd layer -** Attach the 2 classes Class2 and Class3 to this layer. -** Attach the property 'Fill Color' -** Change the value of 'Fill Color' to orange -*** Class2 and Class3 should change to orange. -[[Image:simpleTutorialImages/layer2.png]] - - -== Disabling a Layer == -It is possible to disable a layer without deleting it. A disabled layer do not participate in layer stack. - -To disable a layer, select it in the LayersExplorer. -* Then in the PropertyView, open the Layers tab -* select or unselect the layer with 'Is Layer Enable". -** Note that in our example, disabling the Layer2 will change the color of the Class2 and Class3. Class2 take the color specified by layer1, and Class3 the color specified by bottomLayer. -[[Image:simpleTutorialImages/disableLayer.png]] - - -= Layer Operators = -Layer Operators are a kind of layer that can contain other Layers. - -A layer operator is called like this because it is used to apply an 'operator' on its nested layers. The operator compute the property values for attached layers. - - -It is not possible to attach directly views or properties to a layer operator. But a layer operator still have a set of attached views and a set of attached properties. The values of these properties are the results of applying the operator on the properties of the nested layers. The set of the attached views is generally the union of the views attached to the nested layers. - -There is different kind of 'layer operators', each one proposing a different way of computing the property values. - - -== Top Layer Operator == -The 'Top Layer Operator' contains layers that are ordered from top to bottom. It is called 'Top Layer Operator' because it return the top most value for a particular (view, property type) couple. - -When computing the property value for a specified (view, property type), the Top Layer Operator return the first value found for this couple. It start from the top layer, and stop as soon as a layer as a value set for the specified (view, property type). - diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/OpenedLayersExplorer.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/OpenedLayersExplorer.png Binary files differdeleted file mode 100644 index 3243d6a59a0..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/OpenedLayersExplorer.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachLayersStack.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachLayersStack.png Binary files differdeleted file mode 100644 index fb89859462d..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachLayersStack.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachPropertiesWindow.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachPropertiesWindow.png Binary files differdeleted file mode 100644 index 43352b552f8..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachPropertiesWindow.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewWindow.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewWindow.png Binary files differdeleted file mode 100644 index 9aad29fef4c..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewWindow.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewWindowSelectClasses.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewWindowSelectClasses.png Binary files differdeleted file mode 100644 index 3275da01c65..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewWindowSelectClasses.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewsToLayer.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewsToLayer.png Binary files differdeleted file mode 100644 index 669be6f747e..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachViewsToLayer.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachedLayersStack.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachedLayersStack.png Binary files differdeleted file mode 100644 index 8d536ad621e..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/attachedLayersStack.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/changeFillColorValue.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/changeFillColorValue.png Binary files differdeleted file mode 100644 index db065e6effe..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/changeFillColorValue.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/createLayer.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/createLayer.png Binary files differdeleted file mode 100644 index 190ec7c5fba..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/createLayer.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/createdLayer.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/createdLayer.png Binary files differdeleted file mode 100644 index 27564e6d832..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/createdLayer.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/defaulLayerProperties.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/defaulLayerProperties.png Binary files differdeleted file mode 100644 index e2da266906d..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/defaulLayerProperties.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/diagramWith3Classes.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/diagramWith3Classes.png Binary files differdeleted file mode 100644 index 45529bd2afa..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/diagramWith3Classes.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/disableLayer.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/disableLayer.png Binary files differdeleted file mode 100644 index f4cb2f36020..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/disableLayer.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/layer2.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/layer2.png Binary files differdeleted file mode 100644 index 9181d275fcb..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/layer2.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/openAttachPropertiesWindow.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/openAttachPropertiesWindow.png Binary files differdeleted file mode 100644 index 79c2737f73e..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/openAttachPropertiesWindow.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/opnLayersExplorer.png b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/opnLayersExplorer.png Binary files differdeleted file mode 100644 index 4a4a2c92104..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/tutorials/simpleTutorialImages/opnLayersExplorer.png +++ /dev/null diff --git a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/users/index-toc.xml b/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/users/index-toc.xml deleted file mode 100644 index 6dc87b4974a..00000000000 --- a/plugins/doc/org.eclipse.papyrus.layers.documentation/guides/users/index-toc.xml +++ /dev/null @@ -1,7 +0,0 @@ -<?xml version='1.0' encoding='utf-8' ?> -<toc label="Layers Documentation" > - <topic label="Layers Documentation"> - <link toc="guides/tutorials/derivedLayerTutorial-toc.xml"/> - <anchor id="layers.guides.documentations"/> - </topic> -</toc> |
