Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc')
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/.project22
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/.settings/org.eclipse.core.resources.prefs3
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/META-INF/MANIFEST.MF5
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/build.properties3
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/plugin.xml8
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/EClassCustomCreation1.pngbin0 -> 33215 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/EClassCustomEdition.pngbin0 -> 57098 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/EditorWithEmptyFile.pngbin0 -> 18586 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/FacetCustomCreation1.pngbin0 -> 43995 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/FacetOperationCreation1.pngbin0 -> 62245 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/FacetOperationSpecifyQuery.pngbin0 -> 86902 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/FineTuneEClassCustomization.pngbin0 -> 38903 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/RightPaneldescription.pngbin0 -> 31283 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/WizardCreation1.pngbin0 -> 41678 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/WizardCreation2.pngbin0 -> 29755 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/WizardCreation3.pngbin0 -> 20914 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/addParameter.pngbin0 -> 59824 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/attributes.gifbin0 -> 124 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/bottomLeftOverlay.pngbin0 -> 181 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/bottomMiddleOverlay.pngbin0 -> 188 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/bottomRightOverlay.pngbin0 -> 185 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/customizationLabel.pngbin0 -> 215 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/editor-toc.xml14
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/editor.html1
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/editor.textile174
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/facetOperationWithPropertiesView.pngbin0 -> 40264 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontBold.pngbin0 -> 249 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontItalic.bmpbin0 -> 822 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontName.pngbin0 -> 256 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontSize.pngbin0 -> 275 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontStrukethrough.bmpbin0 -> 822 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontUnderline.bmpbin0 -> 822 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/imageCustomization.pngbin0 -> 215 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/middleLeftOverlay.pngbin0 -> 188 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/middleRightOverlay.pngbin0 -> 191 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/rgb.pngbin0 -> 307 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/topLeftOverlay.pngbin0 -> 170 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/topMiddleOverlay.pngbin0 -> 159 bytes
-rw-r--r--plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/topRightOverlay.pngbin0 -> 196 bytes
39 files changed, 230 insertions, 0 deletions
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/.project b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/.project
new file mode 100644
index 00000000000..8a3ea32073d
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/.project
@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>org.eclipse.emf.facet.custom.metamodel.editor.doc</name>
+ <comment></comment>
+ <projects>
+ </projects>
+ <buildSpec>
+ <buildCommand>
+ <name>org.eclipse.pde.ManifestBuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ <buildCommand>
+ <name>org.eclipse.pde.SchemaBuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ </buildSpec>
+ <natures>
+ <nature>org.eclipse.pde.PluginNature</nature>
+ </natures>
+</projectDescription>
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/.settings/org.eclipse.core.resources.prefs b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/.settings/org.eclipse.core.resources.prefs
new file mode 100644
index 00000000000..1c7907bc702
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/.settings/org.eclipse.core.resources.prefs
@@ -0,0 +1,3 @@
+eclipse.preferences.version=1
+encoding//resource/editor-toc.xml=utf-8
+encoding//resource/editor.html=utf-8
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/META-INF/MANIFEST.MF b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/META-INF/MANIFEST.MF
new file mode 100644
index 00000000000..f135ac5235b
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/META-INF/MANIFEST.MF
@@ -0,0 +1,5 @@
+Bundle-ManifestVersion: 2
+Bundle-Name: Doc
+Bundle-SymbolicName: org.eclipse.emf.facet.custom.metamodel.editor.doc;singleton:=true
+Bundle-Version: 1.0.0.qualifier
+Require-Bundle: org.eclipse.help
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/build.properties b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/build.properties
new file mode 100644
index 00000000000..47663ae2b76
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/build.properties
@@ -0,0 +1,3 @@
+bin.includes = META-INF/,\
+ resource/,\
+ plugin.xml
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/plugin.xml b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/plugin.xml
new file mode 100644
index 00000000000..bf9f4621285
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/plugin.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?eclipse version="3.4"?>
+<plugin>
+ <extension point="org.eclipse.help.toc">
+ <toc file="resource/editor-toc.xml" primary="true"/>
+ </extension>
+
+</plugin>
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/EClassCustomCreation1.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/EClassCustomCreation1.png
new file mode 100644
index 00000000000..b7ce2be5d6a
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/EClassCustomCreation1.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/EClassCustomEdition.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/EClassCustomEdition.png
new file mode 100644
index 00000000000..293be89ee3f
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/EClassCustomEdition.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/EditorWithEmptyFile.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/EditorWithEmptyFile.png
new file mode 100644
index 00000000000..09750a8c957
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/EditorWithEmptyFile.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/FacetCustomCreation1.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/FacetCustomCreation1.png
new file mode 100644
index 00000000000..8a787419b71
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/FacetCustomCreation1.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/FacetOperationCreation1.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/FacetOperationCreation1.png
new file mode 100644
index 00000000000..da82b169bb0
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/FacetOperationCreation1.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/FacetOperationSpecifyQuery.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/FacetOperationSpecifyQuery.png
new file mode 100644
index 00000000000..2a56ae18c97
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/FacetOperationSpecifyQuery.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/FineTuneEClassCustomization.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/FineTuneEClassCustomization.png
new file mode 100644
index 00000000000..0768ed91326
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/FineTuneEClassCustomization.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/RightPaneldescription.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/RightPaneldescription.png
new file mode 100644
index 00000000000..0eff804280d
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/RightPaneldescription.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/WizardCreation1.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/WizardCreation1.png
new file mode 100644
index 00000000000..11e4c4845e5
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/WizardCreation1.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/WizardCreation2.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/WizardCreation2.png
new file mode 100644
index 00000000000..3c1816c30fb
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/WizardCreation2.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/WizardCreation3.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/WizardCreation3.png
new file mode 100644
index 00000000000..dbcc95e1ecf
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/WizardCreation3.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/addParameter.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/addParameter.png
new file mode 100644
index 00000000000..41ebe356cb8
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/addParameter.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/attributes.gif b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/attributes.gif
new file mode 100644
index 00000000000..d4cb4254d92
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/attributes.gif
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/bottomLeftOverlay.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/bottomLeftOverlay.png
new file mode 100644
index 00000000000..a590639ef21
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/bottomLeftOverlay.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/bottomMiddleOverlay.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/bottomMiddleOverlay.png
new file mode 100644
index 00000000000..aa965d8f304
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/bottomMiddleOverlay.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/bottomRightOverlay.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/bottomRightOverlay.png
new file mode 100644
index 00000000000..c4aa66c4043
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/bottomRightOverlay.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/customizationLabel.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/customizationLabel.png
new file mode 100644
index 00000000000..e7a492fe7b2
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/customizationLabel.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/editor-toc.xml b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/editor-toc.xml
new file mode 100644
index 00000000000..8a6d371a5ee
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/editor-toc.xml
@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<toc topic="resource/editor.html" label="EMF Facet Customization Editor">
+ <topic href="resource/editor.html" label="Customization of model with EMF Facet"></topic>
+ <topic href="resource/editor.html#Creationof.customfile" label="Creation of .custom file"></topic>
+ <topic href="resource/editor.html#EClassCustomandFacetCustom" label="EClassCustom and FacetCustom">
+ <topic href="resource/editor.html#Creationandbasicedition" label="Creation and basic edition"></topic>
+ <topic href="resource/editor.html#Finetuneedition" label="Fine-tune edition"></topic>
+ </topic>
+ <topic href="resource/editor.html#DerivedTypedElement" label="DerivedTypedElement">
+ <topic href="resource/editor.html#Creationandbasicedition2" label="Creation and basic edition"></topic>
+ <topic href="resource/editor.html#Structuredviews" label="Structured views"></topic>
+ <topic href="resource/editor.html#Finetuneedition2" label="Fine-tune edition"></topic>
+ </topic>
+</toc> \ No newline at end of file
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/editor.html b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/editor.html
new file mode 100644
index 00000000000..197d79c3e30
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/editor.html
@@ -0,0 +1 @@
+<?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="CustomizationofmodelwithEMFFacet">Customization of model with EMF Facet</h1><ol class="toc" style="list-style: none;"><li><a href="#CustomizationofmodelwithEMFFacet">Customization of model with EMF Facet</a></li><li><a href="#Creationof.customfile">Creation of .custom file</a></li><li><a href="#EClassCustomandFacetCustom">EClassCustom and FacetCustom</a><ol style="list-style: none;"><li><a href="#Creationandbasicedition">Creation and basic edition</a></li><li><a href="#Finetuneedition">Fine-tune edition</a></li></ol></li><li><a href="#DerivedTypedElement">DerivedTypedElement</a><ol style="list-style: none;"><li><a href="#Creationandbasicedition2">Creation and basic edition</a></li><li><a href="#Structuredviews">Structured views</a></li><li><a href="#Finetuneedition2">Fine-tune edition</a></li></ol></li></ol><p>EMF Facet provides a customization component, that can be used to define the appearance of model elements when viewed in an editor or view that supports this customization mechanism.</p><h1 id="Creationof.customfile">Creation of .custom file</h1><p>A customization is defined in a model that conforms to the EMF Facet customization metamodel. This model is saved in a file with the &#171;.custom&#187; file extension. The file can be created via a wizard in Eclipse from “New -&gt; EMF Facet -&gt; Create a customization 0.2” option in menu and will prompt the user for the nsURI and prefix for the customization model. The following screen captures show step by step the creation process :</p><p><img border="0" src="WizardCreation1.png"/><br/>Figure 1 : custom file creation wizard</p><p><img border="0" src="WizardCreation2.png"/><br/>Figure 2 : file name selection</p><p><img border="0" src="WizardCreation2.png"/><br/>Figure 3 : nsURI and prefix specification for the model</p><p>Upon the creation of the customization model file, the editor will open and allow the user to populate the model:</p><p><img border="0" src="EditorWithEmptyFile.png"/><br/>Figure 4 : empty Customization created from the wizard</p><p>Customization is a specific FacetSet acting as the main container for the customization elements. These elements may be customization for<br/>EClass or Facet; each of them containing DerivedTypedElement such as FacetAttribute, FacetReference, and FacetOperation.</p><h1 id="EClassCustomandFacetCustom">EClassCustom and FacetCustom</h1><h2 id="Creationandbasicedition">Creation and basic edition</h2><p>Custom classes can be created when a Customization element is selected, the far right panel displays buttons to ease the creation of such<br/>elements:</p><p><img border="0" src="EClassCustomCreation1.png"/><br/>Figure 5 : creation of an EClassCustom</p><p>The dialog allows specifying generic features for Custom classes and the properties view is always there to fine-tune different features:</p><p><img border="0" src="EClassCustomEdition.png"/><br/>Figure 6 : Edition of an EClassCustom</p><p>In this example, the EClassCustom extends the metaclass from the org.eclipse.emf.facet.examples.library metamodel, the editor will<br/>automatically load every model in which a facet specifies this metamodel, hence the loading of .efacet and .custom files available in the<br/>platform. This allow an easy access of all declared facets bound to an element of the customized metamodel.</p><p>The process is identical for the creation of a FacetCustom:</p><p><img border="0" src="FacetCustomCreation1.png"/><br/>Figure 7 : creation of a FacetCustom</p><h2 id="Finetuneedition">Fine-tune edition</h2><p>If needed, properties view allows the user to have a more advanced control on custom elements:</p><p><img border="0" src="FineTuneEClassCustomization.png"/><br/>Figure 8 : fine-tune edition of an EClassCustom</p><p>Also, applied customization are strongly affected by the order the manager load them up, the editor provides a way to modify this order by<br/>selecting an element and press either the “Up” or “Down” bottom. This results in modifying the index of the selected element in its<br/>containment list.</p><h1 id="DerivedTypedElement">DerivedTypedElement</h1><h2 id="Creationandbasicedition2">Creation and basic edition</h2><p>Custom element, either ECLassCustom or FacetCustom, contains DerivedTypeElement. Those elements can be FacetAttribute, FacetReference or<br/>FacetOperation. The most used lement for Customization is the FacetOperation: each of these FacetOperations overrides the FacetOperation<br/>corresponding to the customizable feature you want to customize: label, font, color, etc…<br/>In order to create a FacetOperation, a FacetCustom or an EClassCustom must be selected:</p><p><img border="0" src="FacetOperationCreation1.png"/><br/>Figure 9 : creation of a FacetOperation</p><p>Finally, the user must provide an implementation for an overriding FacetOperation, by the means of a Query that will return the value of the<br/>customization when this Query is evaluated on a model element that conforms to the extendedFacet. If the query has not been written yet, the<br/>wizard provides an easy wizard to create the Query directly extending one of the Query class available, or the editor will scan the project<br/>and prompt the user to choose among a list of available query classes.</p><p><img border="0" src="FacetOperationSpecifyQuery.png"/><br/>Figure 10 : Creation of a Query for a FacetOperation</p><p>If a FacetOperation is selected, it is possible to add parameters. This parameter is useful for customizing the structural feature<br/>corresponding to a single customized model element:</p><p><img border="0" src="addParameter.png"/><br/>Figure 11 : adding a parameter to a FacetOperation</p><h2 id="Structuredviews">Structured views</h2><p>The left tree is the main navigator of the model in the editor, when a Custom element is selected or any DerivedTypeElement, the right panel<br/>shows the list of all child derivedTypeElements, or brother depending on the nature of the left panel selection. This panel offers a quick<br/>overview of the DerivedTypeElement:</p><p><img border="0" src="RightPaneldescription.png"/><br/>Figure 12 : detailed view of the right panel</p><p>An icon symbolizes the override customization facet, all icons are as follow:</p><ul><li><img border="0" src="attributes.gif"/> means the derivedTypeElement is not a FacetOperation</li><li><img border="0" src="customizationLabel.png"/> stands for “label”</li><li><img border="0" src="fontBold.png"/> stands for “isBold”</li><li><img border="0" src="fontItalic.bmp"/> stands for “isItalic”</li><li><img border="0" src="fontName.png"/> stands for “fontName”</li><li><img border="0" src="fontSize.png"/> stands for “fontSize”</li><li><img border="0" src="fontStrukethrough.bmp"/> stands for “isStrikethrough”</li><li><img border="0" src="fontUnderline.bmp"/> stands for “isUnderlined”</li><li><img border="0" src="imageCustomization.png"/> stands for “image”</li><li><img border="0" src="rgb.png"/> stands for “foreground” or “background”</li><li><img border="0" src="middleLeftOverlay.png"/> stands for “middleLeftOverlay”</li><li><img border="0" src="middleRightOverlay.png"/> stands for “middleRightOverlay”</li><li><img border="0" src="topLeftOverlay.png"/> stands for “topLeftOverlay”</li><li><img border="0" src="topMiddleOverlay.png"/> stands for “topMiddleOverlay”</li><li><img border="0" src="topRightOverlay.png"/> stands for “topRightOverlay”</li><li><img border="0" src="bottomRightOverlay.png"/> stands for “bottomRightOverlay”</li><li><img border="0" src="bottomMiddleOverlay.png"/> stands for “bottomMiddleOverlay”</li><li><img border="0" src="bottomLeftOverlay.png"/> stands for “bottomLeftOverlay”</li></ul><h2 id="Finetuneedition2">Fine-tune edition</h2><p>An advanced control of FacetOperation, and moreover DerivedTypeElement, is available via the properties view:</p><p><img border="0" src="facetOperationWithPropertiesView.png"/><br/>Figure 13 : fine-tune edition of a FacetOperation</p></body></html> \ No newline at end of file
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/editor.textile b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/editor.textile
new file mode 100644
index 00000000000..17a6cac2723
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/editor.textile
@@ -0,0 +1,174 @@
+h1. Customization of model with EMF Facet
+
+
+
+{toc}
+
+
+
+
+EMF Facet provides a customization component, that can be used to define the appearance of model elements when viewed in an editor or view that supports this customization mechanism.
+
+
+
+h1. Creation of .custom file
+
+
+
+A customization is defined in a model that conforms to the EMF Facet customization metamodel. This model is saved in a file with the ".custom" file extension. The file can be created via a wizard in Eclipse from New -> EMF Facet -> Create a customization 0.2 option in menu and will prompt the user for the nsURI and prefix for the customization model. The following screen captures show step by step the creation process :
+
+
+
+!WizardCreation1.png!
+Figure 1 : custom file creation wizard
+
+
+
+!WizardCreation2.png!
+Figure 2 : file name selection
+
+
+
+!WizardCreation2.png!
+Figure 3 : nsURI and prefix specification for the model
+
+
+
+Upon the creation of the customization model file, the editor will open and allow the user to populate the model:
+
+
+!EditorWithEmptyFile.png!
+Figure 4 : empty Customization created from the wizard
+
+
+
+Customization is a specific FacetSet acting as the main container for the customization elements. These elements may be customization for
+EClass or Facet; each of them containing DerivedTypedElement such as FacetAttribute, FacetReference, and FacetOperation.
+
+
+
+h1. EClassCustom and FacetCustom
+
+
+
+h2. Creation and basic edition
+
+
+
+Custom classes can be created when a Customization element is selected, the far right panel displays buttons to ease the creation of such
+elements:
+
+!EClassCustomCreation1.png!
+Figure 5 : creation of an EClassCustom
+
+
+The dialog allows specifying generic features for Custom classes and the properties view is always there to fine-tune different features:
+
+!EClassCustomEdition.png!
+Figure 6 : Edition of an EClassCustom
+
+
+In this example, the EClassCustom extends the metaclass from the org.eclipse.emf.facet.examples.library metamodel, the editor will
+automatically load every model in which a facet specifies this metamodel, hence the loading of .efacet and .custom files available in the
+platform. This allow an easy access of all declared facets bound to an element of the customized metamodel.
+
+The process is identical for the creation of a FacetCustom:
+
+!FacetCustomCreation1.png!
+Figure 7 : creation of a FacetCustom
+
+
+
+h2. Fine-tune edition
+
+If needed, properties view allows the user to have a more advanced control on custom elements:
+
+!FineTuneEClassCustomization.png!
+Figure 8 : fine-tune edition of an EClassCustom
+
+
+
+Also, applied customization are strongly affected by the order the manager load them up, the editor provides a way to modify this order by
+selecting an element and press either the Up or Down bottom. This results in modifying the index of the selected element in its
+containment list.
+
+
+
+h1. DerivedTypedElement
+
+
+
+h2. Creation and basic edition
+
+
+
+Custom element, either ECLassCustom or FacetCustom, contains DerivedTypeElement. Those elements can be FacetAttribute, FacetReference or
+FacetOperation. The most used lement for Customization is the FacetOperation: each of these FacetOperations overrides the FacetOperation
+corresponding to the customizable feature you want to customize: label, font, color, etc
+In order to create a FacetOperation, a FacetCustom or an EClassCustom must be selected:
+
+!FacetOperationCreation1.png!
+Figure 9 : creation of a FacetOperation
+
+
+
+Finally, the user must provide an implementation for an overriding FacetOperation, by the means of a Query that will return the value of the
+customization when this Query is evaluated on a model element that conforms to the extendedFacet. If the query has not been written yet, the
+wizard provides an easy wizard to create the Query directly extending one of the Query class available, or the editor will scan the project
+and prompt the user to choose among a list of available query classes.
+
+!FacetOperationSpecifyQuery.png!
+Figure 10 : Creation of a Query for a FacetOperation
+
+
+If a FacetOperation is selected, it is possible to add parameters. This parameter is useful for customizing the structural feature
+corresponding to a single customized model element:
+
+
+!addParameter.png!
+Figure 11 : adding a parameter to a FacetOperation
+
+
+
+h2. Structured views
+
+
+
+The left tree is the main navigator of the model in the editor, when a Custom element is selected or any DerivedTypeElement, the right panel
+shows the list of all child derivedTypeElements, or brother depending on the nature of the left panel selection. This panel offers a quick
+overview of the DerivedTypeElement:
+
+!RightPaneldescription.png!
+Figure 12 : detailed view of the right panel
+
+
+An icon symbolizes the override customization facet, all icons are as follow:
+* !attributes.gif! means the derivedTypeElement is not a FacetOperation
+* !customizationLabel.png! stands for label
+* !fontBold.png! stands for isBold
+* !fontItalic.bmp! stands for isItalic
+* !fontName.png! stands for fontName
+* !fontSize.png! stands for fontSize
+* !fontStrukethrough.bmp! stands for isStrikethrough
+* !fontUnderline.bmp! stands for isUnderlined
+* !imageCustomization.png! stands for image
+* !rgb.png! stands for foreground or background
+* !middleLeftOverlay.png! stands for middleLeftOverlay
+* !middleRightOverlay.png! stands for middleRightOverlay
+* !topLeftOverlay.png! stands for topLeftOverlay
+* !topMiddleOverlay.png! stands for topMiddleOverlay
+* !topRightOverlay.png! stands for topRightOverlay
+* !bottomRightOverlay.png! stands for bottomRightOverlay
+* !bottomMiddleOverlay.png! stands for bottomMiddleOverlay
+* !bottomLeftOverlay.png! stands for bottomLeftOverlay
+
+
+
+h2. Fine-tune edition
+
+
+
+An advanced control of FacetOperation, and moreover DerivedTypeElement, is available via the properties view:
+
+!facetOperationWithPropertiesView.png!
+Figure 13 : fine-tune edition of a FacetOperation
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/facetOperationWithPropertiesView.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/facetOperationWithPropertiesView.png
new file mode 100644
index 00000000000..f507fb7f97c
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/facetOperationWithPropertiesView.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontBold.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontBold.png
new file mode 100644
index 00000000000..45033eb9b8a
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontBold.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontItalic.bmp b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontItalic.bmp
new file mode 100644
index 00000000000..3e8d38653cc
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontItalic.bmp
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontName.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontName.png
new file mode 100644
index 00000000000..348dd6641fb
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontName.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontSize.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontSize.png
new file mode 100644
index 00000000000..ba5b44296cc
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontSize.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontStrukethrough.bmp b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontStrukethrough.bmp
new file mode 100644
index 00000000000..945988b541e
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontStrukethrough.bmp
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontUnderline.bmp b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontUnderline.bmp
new file mode 100644
index 00000000000..5368eb463db
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/fontUnderline.bmp
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/imageCustomization.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/imageCustomization.png
new file mode 100644
index 00000000000..c8fa43a07f5
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/imageCustomization.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/middleLeftOverlay.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/middleLeftOverlay.png
new file mode 100644
index 00000000000..46158d8fe8b
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/middleLeftOverlay.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/middleRightOverlay.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/middleRightOverlay.png
new file mode 100644
index 00000000000..f73c1ed8a0e
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/middleRightOverlay.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/rgb.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/rgb.png
new file mode 100644
index 00000000000..119f9d57ff0
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/rgb.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/topLeftOverlay.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/topLeftOverlay.png
new file mode 100644
index 00000000000..2b30f260028
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/topLeftOverlay.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/topMiddleOverlay.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/topMiddleOverlay.png
new file mode 100644
index 00000000000..0cb45759b3b
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/topMiddleOverlay.png
Binary files differ
diff --git a/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/topRightOverlay.png b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/topRightOverlay.png
new file mode 100644
index 00000000000..1ea16e56587
--- /dev/null
+++ b/plugins/facet/editor/org.eclipse.emf.facet.custom.metamodel.editor.doc/resource/topRightOverlay.png
Binary files differ

Back to the top