diff options
| author | vlorenzo | 2013-05-22 11:58:15 +0000 |
|---|---|---|
| committer | vlorenzo | 2013-05-22 11:58:15 +0000 |
| commit | 3b9005cf2bc1bdcf8e53a293bd1a09b2fa8ccb77 (patch) | |
| tree | b49b7fe1b73da5d0b024d6eec8a1e90ce3ea5105 /sandbox | |
| parent | cdfe6aceece06c6a1238c74f0c430c32b2b057ff (diff) | |
| download | org.eclipse.papyrus-3b9005cf2bc1bdcf8e53a293bd1a09b2fa8ccb77.tar.gz org.eclipse.papyrus-3b9005cf2bc1bdcf8e53a293bd1a09b2fa8ccb77.tar.xz org.eclipse.papyrus-3b9005cf2bc1bdcf8e53a293bd1a09b2fa8ccb77.zip | |
Share the Papyrus Table documentation plugin (work in progress)
Diffstat (limited to 'sandbox')
6 files changed, 163 insertions, 0 deletions
diff --git a/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/.project b/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/.project new file mode 100644 index 00000000000..d38510b07bd --- /dev/null +++ b/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/.project @@ -0,0 +1,22 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>org.eclipse.papyrus.infra.nattable.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/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/META-INF/MANIFEST.MF b/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/META-INF/MANIFEST.MF new file mode 100644 index 00000000000..fc4c0fb3ca7 --- /dev/null +++ b/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/META-INF/MANIFEST.MF @@ -0,0 +1,6 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: Papyrus Table Documentation (Incubation) +Bundle-SymbolicName: org.eclipse.papyrus.infra.nattable.doc +Bundle-Version: 0.10.0.qualifier +Bundle-Vendor: Eclipse Modeling Project diff --git a/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/about.html b/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/about.html new file mode 100644 index 00000000000..598b3684879 --- /dev/null +++ b/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/about.html @@ -0,0 +1,28 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"/> +<title>About</title> +</head> +<body lang="EN-US"> +<h2>About This Content</h2> + +<p>May 12, 2008</p> +<h3>License</h3> + +<p>The Eclipse Foundation makes available all content in this plug-in ("Content"). Unless otherwise +indicated below, the Content is provided to you under the terms and conditions of the +Eclipse Public License Version 1.0 ("EPL"). A copy of the EPL is available +at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>. +For purposes of the EPL, "Program" will mean the Content.</p> + +<p>If you did not receive this Content directly from the Eclipse Foundation, the Content is +being redistributed by another party ("Redistributor") and different terms and conditions may +apply to your use of any object code in the Content. Check the Redistributor's license that was +provided with the Content. If no such license exists, contact the Redistributor. Unless otherwise +indicated below, the terms and conditions of the EPL still apply to any source code in the Content +and such source code may be obtained at <a href="http://www.eclipse.org/">http://www.eclipse.org</a>.</p> + +</body> +</html>
\ No newline at end of file diff --git a/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/build.properties b/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/build.properties new file mode 100644 index 00000000000..31fc0a4172a --- /dev/null +++ b/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/build.properties @@ -0,0 +1,5 @@ +bin.includes = META-INF/,\
+ about.html,\
+ tablemetamodeldocumentation.mediawiki,\
+ plugin.pdoc
+src.includes = about.html
diff --git a/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/plugin.pdoc b/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/plugin.pdoc new file mode 100644 index 00000000000..0c39ddfbfbd --- /dev/null +++ b/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/plugin.pdoc @@ -0,0 +1,4 @@ +<?xml version="1.0" encoding="UTF-8"?>
+<doc:Documentation xmi:version="2.0" xmlns:xmi="http://www.omg.org/XMI" xmlns:doc="http://www.eclipse.org/papyrus/documentation/plugin/documentation" description="This plugin provides the documentation for the Papyrus Table (the new version of the Papyrus Table).">
+ <referent firstName="Vincent" lastName="LORENZO" eMail="vincent.lorenzo@cea.fr" currentCompany="CEA LIST"/>
+</doc:Documentation>
diff --git a/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/tablemetamodeldocumentation.mediawiki b/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/tablemetamodeldocumentation.mediawiki new file mode 100644 index 00000000000..1c42a44865f --- /dev/null +++ b/sandbox/TableV3/org.eclipse.papyrus.infra.nattable.doc/tablemetamodeldocumentation.mediawiki @@ -0,0 +1,98 @@ +=Metamodel Description=
+==CellEditorDeclaration==
+This enumeration allows to describe the way to declare the cell editor in the table :
+<li>by column </li>
+<li>by row </li>
+<li>by cell </li>
+
+==AxisIndexStyle==
+This enumeration allows to describe how to display the index of the axis :
+<li>Alphabetic : A, B, C ... Y, Z, AA, AB, ... </li>
+<li>Numeric : 1, 2, 3 </li>
+
+==TableNamedElement==
+abstract object used when an element need to have a name and a description
+
+==TableConfiguration==
+this object is used to configure the table
+
+===Fields===
+ <li>type : the type of the table</li>
+ <li>iconPath : the icon associated to the table</li>
+ <li>cellEditorDeclaration : describe how the cell editor will be declared in the table : They can be declared by row, by column or by cells</li>
+ <li>rowAxisProviders : the possible axis providers used for rows for this configuration</li>
+ <li>columnAxisProviders : the possible axis providers used for the columns for this configuration</li>
+ <li>defaultRowAxisProvider : the axis provider used for row just after the table creation </li>
+ <li>defaultColumnAxisProvider : the axis provider used for column just after the table creation </li>
+
+
+ ????rowAxisProviderConfiguration -> a la bonne place ? -> peut-être sur un (local)AbstractAxisProvider?
+ ????columnAxisProviderConfiguration -> à la bonne place? -> peut-être sur un (local)AbstractAxisProvider?
+
+ ===Constraints===
+ the field defaultRowAxisProvider must references an axis owned by rowAxisProviders
+ the field defaultColumnAxisProvider must references an axis owned by columnAxisProviders
+
+
+==Table==
+This object represents the model of the table used in Papyrus
+===Fields===
+<li>invertAxis : indicates if the rows and the columns are inverted</li>
+<li>tableConfiguration : the configuration used for the table</li>
+<li>currentColumnAxisProvider : the current axis provider used for columns</li>
+<li>currentRowAxisProvider : the current axis provider used for rows</li>
+<li>rowAxisProvidersHistory : an history of the axis provider used for rows</li>
+<li>columnAxisProvidersHistory : an history of the axis provider used for columns</li>
+
+===Constraints===
+<li>the field currentRowAxisProvider must references an axis owned by rowAxisProviderHistory</li>
+<li>The field currentColumnAxisProvider must references one of axis provider referenced by columnAxisProviderHistory </li>
+<li>the field rowAxisProviderHistory will contains only 1 axisProvider just after the table creation even if the config provides several row axis providers in rowAxisProviders</li>
+<li>the field columnAxisProviderHistory will contains only 1 axisProvider just after the table creation even if the config provides several column axis providers in columnAxisProviders</li>
+<li> the axis providers owned by columnAxisProviderHistory and rowAxisProviderHistory contains only the axis provider already used by the user. </li>
+
+
+??? localTableConfiguration : must be here?
+
+??? add header in the name of the label configuration????
+==AbstractLabelConfiguration==
+This object allows to store the configuration for the label provider.
+===Fields===
+<li>labelProviderContext : the context to use to find the label provider to use</li>
+
+
+==ObjectLabelProviderConfiguration==
+This label provider can be used for all element displayed in a table
+===Fields===
+<li>displayIcon : indicates if we want display the icon of the object in the header</li>
+<li>displayLabel : indicates if we want display the label of the object in the header</li>
+
+==FeatureLabelProviderConfiguration==
+The label provider used for object representing properties/features of others objects
+===Fields===
+<li>displayIsDerived: indicates if we want display the "/" for the derived feature</li>
+<li>displayType: indicates if we want display the type of the feature</li>
+<li>displayMultiplicity: : indicates if we want display the multiplicity of the feature</li>
+<li>displayName:indicates if the want display the name of the feature</li>
+
+
+==AbstractAxisProvider==
+This class stores in an ordered list the IAxis displayed in rows or in columns
+
+
+=Table Refresh=
+ There are 2 kinds of refresh in the tables :
+#a refresh of the appearance of the table <br> This refresh is done after each command executed in the command stack.
+#a refresh of the rows and columns of the table <br> This refresh needs to recalculate the rows and the columns to display before to refresh the table. This refresh is called thanks to listen which listen specific modifications on the model :
+##add/remove/move/... IAxis inside the model of the table, if the table is not synchronized
+##add/remove/move/... elements in the display feature if the table is synchronized
+
+=Refresh Rows/Columns to display=
+A table is managed by 2 CompositeAxisManager one for Rows and one for Columns. These managers refers one or several Axis Manager, identified in the model by an id (AxisManager#managerId). The CompositeAxisManager is used to update the list of the element to display as rows/columns. Here, we need to distinguish 2 kinds of AxisManager
+#the axis manager which provides a contents stored in the model of the table <br> the user can reorder and 'mix'/reoder the elements provided by this kind of AxisManager. <br> The CompositeAxisManager reads the table model to update the list of the elements to display.
+#the axis manager which provides a contents derived of the (UML) model. These one are dynamic, because they doesn't contribute to the table model. <br>the elements can't be mixed with the elements managed by the non-dynamic AxisManager, but they can be reorder 'inside' the Axismanager <br> in case of dynamic and non-dynamic AxisManager used on the same axis, the dynamic will always be displayed at the end of the axis.
+
+The distinction between them is done by a boolean 'isDynamic' stored in the AxisManager class
+
+
+
|