Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
Diffstat (limited to 'plugins/doc')
-rw-r--r--plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/tableDevDoc.mediawiki14
-rwxr-xr-xplugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/CreateTableConfigurationFromTable_WarningWizard.pngbin25931 -> 14965 bytes
-rwxr-xr-xplugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_ConcernsSelection.pngbin0 -> 30892 bytes
-rwxr-xr-xplugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_DefineOwnerAndRoot.pngbin0 -> 10540 bytes
-rwxr-xr-xplugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_MenuToRegisterTableConfiguration.pngbin0 -> 39285 bytes
-rwxr-xr-xplugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_SelectTableConfiguration.pngbin0 -> 26863 bytes
-rwxr-xr-xplugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_ViewpointSelection.pngbin0 -> 12924 bytes
-rwxr-xr-xplugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/ToolsmithsInstallation.pngbin0 -> 26363 bytes
-rwxr-xr-xplugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/nattableToolsmiths.mediawiki29
9 files changed, 40 insertions, 3 deletions
diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/tableDevDoc.mediawiki b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/tableDevDoc.mediawiki
index 1f1a2c060a1..3e477a8165c 100644
--- a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/tableDevDoc.mediawiki
+++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/tableDevDoc.mediawiki
@@ -2084,8 +2084,8 @@ It will allow you to get the contents of the cell and to save it after editing v
It will allow you to edit the cell value.
#Create a new class implementing <code>org.eclipse.papyrus.infra.nattable.celleditor.config.ICellAxisConfiguration</code> or one of these subclasses and complete it.
#Register the class in the plugin.xml file, using the extension point <code>org.eclipse.papyrus.infra.nattable.celleditor.configuration</code> and the object <code>cellAxisConfiguration</code>. (FYI, <code>configuration</code> is deprecated since Eclipse Neon/Papyrus 1.2.0)
-##'''class''': the java class for the cell editor configuration
-##'''order''': an integer
+##'''class''': the java class for the cell editor configuration,
+##'''order''': an integer.
==Create a new Label Provider Configuration==
It will allow you to display the contents of the cells returned by the CellManager. This steps is not mandatory, because it depends on the object displayed in our cells. Maybe your case is always managed by Papyrus, maybe not.
@@ -2094,6 +2094,15 @@ It will allow you to display the contents of the cells returned by the CellManag
#Register your class in the plugin.xml file, using the extension point <code>org.eclipse.papyrus.infra.services.labelprovider.labelProvider</code>
##'''priority''': an integer
##'''provider''': the java class
+#create a '''labelprovidercontext''' as child of the declared label provider. You must use one of these ones, depending on the table's region for which you want a custom label:
+##'''org.eclipse.papyrus.infra.nattable.full.labelprovider''': the labelprovider declared in this context dispatches to others labelproviders depending on the element's region for which we want a label,
+##'''org.eclipse.papyrus.infra.nattable.header.labelprovider''': the labelprovider declared in this context dispatches to others labelproviders declared on header, depending on the kind of the element (and sometimes of its place in the header (index layer, label layer, column/row, ...),
+##'''org.eclipse.papyrus.infra.nattable.header.feature.labelprovider''': this context is used to get the label for a feature displayed in the header of the table,
+##'''org.eclipse.papyrus.infra.nattable.header.operation.labelprovider''': this context is used to get the label for a feature displayed in the header of the table,
+##'''org.eclipse.papyrus.infra.nattable.header.treefilling.feature.labelprovider''': this context is used to get the label for a feature referenced by a TreeFillingConfiguration,
+##'''org.eclipse.papyrus.infra.nattable.header.treefilling.operation.labelprovider''': this context is used to get the label for an operation referenced by a TreeFillingConfiguration,
+##'''org.eclipse.papyrus.infra.nattable.body.labelprovider''': this context is used to get the label of the elements in the body of the table. Most of the time, you will contribute to this one.
+
==Create a new Filter Configuration==
This step is not mandatory, by default, the string filter will be used.
@@ -2102,6 +2111,7 @@ This step is not mandatory, by default, the string filter will be used.
##'''class''': the java class
##'''order''': an integer
+
=How to create your own post action for paste=
//TODO
=How to declare several axis configuration in the same table=
diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/CreateTableConfigurationFromTable_WarningWizard.png b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/CreateTableConfigurationFromTable_WarningWizard.png
index 0f510b92aaa..27be5d6efc5 100755
--- a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/CreateTableConfigurationFromTable_WarningWizard.png
+++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/CreateTableConfigurationFromTable_WarningWizard.png
Binary files differ
diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_ConcernsSelection.png b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_ConcernsSelection.png
new file mode 100755
index 00000000000..32eeac6549c
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_ConcernsSelection.png
Binary files differ
diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_DefineOwnerAndRoot.png b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_DefineOwnerAndRoot.png
new file mode 100755
index 00000000000..8ea8b203edd
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_DefineOwnerAndRoot.png
Binary files differ
diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_MenuToRegisterTableConfiguration.png b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_MenuToRegisterTableConfiguration.png
new file mode 100755
index 00000000000..96cf103c9bb
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_MenuToRegisterTableConfiguration.png
Binary files differ
diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_SelectTableConfiguration.png b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_SelectTableConfiguration.png
new file mode 100755
index 00000000000..75580a3da22
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_SelectTableConfiguration.png
Binary files differ
diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_ViewpointSelection.png b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_ViewpointSelection.png
new file mode 100755
index 00000000000..ff1067efadc
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/RegistrationInArchitectureFile_ViewpointSelection.png
Binary files differ
diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/ToolsmithsInstallation.png b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/ToolsmithsInstallation.png
new file mode 100755
index 00000000000..6bf45297fc6
--- /dev/null
+++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/images/ToolsmithsInstallation.png
Binary files differ
diff --git a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/nattableToolsmiths.mediawiki b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/nattableToolsmiths.mediawiki
index db13a12275e..a886a9a28c4 100755
--- a/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/nattableToolsmiths.mediawiki
+++ b/plugins/doc/org.eclipse.papyrus.infra.nattable.doc/src/site/mediawiki/toolsmiths/nattableToolsmiths.mediawiki
@@ -1,5 +1,10 @@
+=Prerequisites=
+To benefit from these features, you must install the '''Papyrus Toolsmiths''' called '''Papyrus Toolsmiths tools''' as shown on this snapshot
+
+[[File:images/ToolsmithsInstallation.png|frame|none]]
+
+
=How To Create a TableConfiguration From a Table?=
-#Install the plugin '''com.cea.papyrus.infra.nattable.export''' in your Eclipse, then restart.
#Create a new Papyrus Project
#Create a new Table
##To create a configuration for a flat or a tree table, we recommend to create a '''Generic Tree Table'''.
@@ -38,3 +43,25 @@ and fill us a bug if required.
***'''org.eclipse.papyrus.uml.nattable.matrix''' (required for Matrix),
***'''org.eclipse.papyrus.uml.nattable.properties''' (required for Matrix Properties View).
*the files and folders to include to the binary build have been added to the '''build.properties''' file.
+
+=How to contribute easily a table configuration into an existing Architecture Framework file?=
+*Import your plugin owning the Architecture Framework file to contribute in your current workspace (we use it at the end),
+*Launch a new Eclipse Runtime (required to avoid '''../../''' in the file),
+*Import in this runtime (without making a copy) your plugin owning your '''nattableconfiguration''' file,
+*Import in this runtime (without making a copy) your plugin owning the '''architecture''' file to edit,
+*Open the '''architecture''' file,
+*Select a '''Description Language''' element, then '''Right Click > New Child > Register Exiting Table Configuration''',
+[[File:images/RegistrationInArchitectureFile_MenuToRegisterTableConfiguration.png|frame|none]]
+*Select the '''nattableconfiguration''' file to register using the open Dialog
+[[File:images/RegistrationInArchitectureFile_SelectTableConfiguration.png|frame|none]]
+*If several viewpoints are declared for your '''Description Language''', a second dialog is open. You must select the viewpoint(s) to contribute,
+[[File:images/RegistrationInArchitectureFile_ViewpointSelection.png|frame|none]]
+*If several Concerns are declared for your '''Architecture Domain''', a third dialog is open. You must select the concern(s) to contribute,
+[[File:images/RegistrationInArchitectureFile_ConcernsSelection.png|frame|none]]
+*You must add rules to the created table configuration (define the type of allowed '''owner''' and '''root''' for the table creation),
+[[File:images/RegistrationInArchitectureFile_DefineOwnerAndRoot.png|frame|none]]
+*Save the architecture file,
+*Close your Eclipse Runtime,
+*Update the Architecture Framework project in the first Eclipse instance,
+*Relaunch the Eclipse Runtime,
+*Enjoy! Your new table is now registered in your viewpoint. \ No newline at end of file

Back to the top