Author: andyhot
Date: Wed Apr 12 08:21:50 2006
New Revision: 393485
URL: http://svn.apache.org/viewcvs?rev=393485&view=rev
Log:
Improved documentation of contrib:tree related components
Modified:
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/Tree.xml
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeDataView.xml
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeNodeView.xml
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeTableDataView.xml
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeTableNodeViewDelegator.xml
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeView.xml
tapestry/tapestry4/branches/4.0/src/documentation/content/xdocs/links.ent
Modified:
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/Tree.xml
URL:
http://svn.apache.org/viewcvs/tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/Tree.xml?rev=393485&r1=393484&r2=393485&view=diff
==============================================================================
---
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/Tree.xml
(original)
+++
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/Tree.xml
Wed Apr 12 08:21:50 2006
@@ -32,7 +32,17 @@
</p>
<p>
- <strong>See also:</strong>
+ The Tree component uses the lower level components
+ <link
href="&apicontrib;/contrib/tree/components/TreeView.html">TreeView</link>
+ (handles the tree model),
+ <link
href="&apicontrib;/contrib/tree/components/TreeDataView.html">TreeDataView</link>
+ (handles the tree data),
+ <link
href="&apicontrib;/contrib/tree/components/TreeNodeView.html">TreeNodeView</link>
+ (handles the presentation of the data).
+</p>
+
+<p>
+ <strong>See also: &TreeView;, &TreeDataView;, &TreeNodeView;</strong>
</p>
<section>
@@ -108,9 +118,14 @@
</td>
<td>custom</td>
<td>no</td>
- <td> </td>
+ <td>(<link
href="&apicontrib;/contrib/tree/simple/SimpleNodeRenderFactory.html">SimpleNodeRenderFactory</link>)</td>
<td>
Allows custom rendering of each node.
+ <p>This parameter defines a factory responsible for creating <link
href="&apiroot;/IRender.html">IRender</link> instances
+ which will be used to perform the actual render of each
node.</p>
+ <p>The default factory returns <link
href="&apiroot;/valid/RenderString.html">RenderString</link> instances
+ that output each node's <code>toString()</code>.
+ </p>
</td>
</tr>
@@ -119,7 +134,7 @@
<td>boolean</td>
<td>custom</td>
<td>no</td>
- <td>true</td>
+ <td>(true)</td>
<td>
If node images are shown.
</td>
@@ -130,7 +145,7 @@
<td>boolean</td>
<td>custom</td>
<td>no</td>
- <td>true</td>
+ <td>(true)</td>
<td>
If true, renders a link around nodes that contain children. This
allows
expanding and collapsing the node.
@@ -142,7 +157,7 @@
<td>boolean</td>
<td>custom</td>
<td>no</td>
- <td>true</td>
+ <td>(true)</td>
<td>
If root node should be visible.
</td>
Modified:
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeDataView.xml
URL:
http://svn.apache.org/viewcvs/tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeDataView.xml?rev=393485&r1=393484&r2=393485&view=diff
==============================================================================
---
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeDataView.xml
(original)
+++
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeDataView.xml
Wed Apr 12 08:21:50 2006
@@ -28,11 +28,14 @@
<body>
-<p> <strong>THIS PAGE UNDER CONSTRUCTION</strong>
+<p>
+ A low level Tree component that initiates the rendering of the tree
nodes.
+ It should be wrapped by
+ <link
href="&apicontrib;/contrib/tree/components/TreeView.html">TreeView</link>.
</p>
<p>
- <strong>See also:</strong>
+ <strong>See also: &Tree;, &TreeView;, &TreeNodeView;</strong>
</p>
<section>
@@ -57,7 +60,8 @@
<td>yes</td>
<td> </td>
<td>
- Desc...
+ The TreeView component that provides an
+ <link
href="&apicontrib;/contrib/tree/model/ITreeModel.html">ITreeModel</link>
</td>
</tr>
@@ -81,7 +85,7 @@
<td>no</td>
<td>true</td>
<td>
- Desc...
+ If root node should be visible.
</td>
</tr>
Modified:
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeNodeView.xml
URL:
http://svn.apache.org/viewcvs/tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeNodeView.xml?rev=393485&r1=393484&r2=393485&view=diff
==============================================================================
---
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeNodeView.xml
(original)
+++
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeNodeView.xml
Wed Apr 12 08:21:50 2006
@@ -28,11 +28,13 @@
<body>
-<p> <strong>THIS PAGE UNDER CONSTRUCTION</strong>
+<p>
+ A low level Tree component that renders a tree node.
+ This component should be wrapped by
+ <link
href="&apicontrib;/contrib/tree/components/TreeDataView.html">TreeDataView</link>.
</p>
-
<p>
- <strong>See also:</strong>
+ <strong>See also: &Tree;, &TreeView;, &TreeDataView;</strong>
</p>
<section>
@@ -55,7 +57,7 @@
<td>no</td>
<td>true</td>
<td>
- Desc...
+ If node images are shown.
</td>
</tr>
@@ -66,7 +68,8 @@
<td>no</td>
<td>true</td>
<td>
- Desc...
+ If true, renders a link around nodes that contain children. This
allows
+ expanding and collapsing the node.
</td>
</tr>
@@ -77,9 +80,13 @@
</td>
<td>in</td>
<td>no</td>
- <td> </td>
+ <td>(<link
href="&apicontrib;/contrib/tree/simple/SimpleNodeRenderFactory.html">SimpleNodeRenderFactory</link>)</td>
<td>
- Desc...
+ A factory responsible for creating <link
href="&apiroot;/IRender.html">IRender</link> instances.
+ They will be used to perform the actual render of the tree
nodes.
+ <p>The default factory returns <link
href="&apiroot;/valid/RenderString.html">RenderString</link> instances
+ that output the node's <code>toString()</code>.
+ </p>
</td>
</tr>
</table>
Modified:
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeTableDataView.xml
URL:
http://svn.apache.org/viewcvs/tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeTableDataView.xml?rev=393485&r1=393484&r2=393485&view=diff
==============================================================================
---
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeTableDataView.xml
(original)
+++
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeTableDataView.xml
Wed Apr 12 08:21:50 2006
@@ -47,15 +47,86 @@
<th>Default</th>
<th>Description</th>
</tr>
+
+ <!-- Are these params used somewhere?
+ <tr>
+ <td>treeView</td>
+ <td>boolean</td>
+ <td> </td>
+ <td>no</td>
+ <td> </td>
+ <td>
+ Desc...
+ </td>
+ </tr>
+
+ <tr>
+ <td>nodeViewComponentAddress</td>
+ <td>boolean</td>
+ <td> </td>
+ <td>no</td>
+ <td> </td>
+ <td>
+ Desc...
+ </td>
+ </tr>
+
+ <tr>
+ <td>nodeRenderFactory</td>
+ <td>boolean</td>
+ <td> </td>
+ <td>no</td>
+ <td> </td>
+ <td>
+ Desc...
+ </td>
+ </tr>
+ -->
+
+ <tr>
+ <td>entriesPerTablePage</td>
+ <td>int</td>
+ <td>in</td>
+ <td>no</td>
+ <td> </td>
+ <td>
+ The number of records displayed per page.
+ </td>
+ </tr>
+
+ <tr>
+ <td>showRootNode</td>
+ <td>boolean</td>
+ <td>in</td>
+ <td>no</td>
+ <td> </td>
+ <td>
+ If root node should be visible.
+ </td>
+ </tr>
+
+ <tr>
+ <td>tableColumns</td>
+ <td><link href="&apijava;/java/util/List.html">List</link> (of
+ <link
href="&apicontrib;/contrib/table/model/ITableColumn.html">ITableColumn</link>)
+ </td>
+ <td>in</td>
+ <td>no</td>
+ <td> </td>
+ <td>
+ A list of <link
href="&apicontrib;/contrib/table/model/ITableColumn.html"><code>ITableColumn</code></link>
+ objects, each defining a column in the table,
+ </td>
+ </tr>
</table>
<p>
- Body: <strong>removed / allowed</strong>
+ Body: <strong>allowed</strong>
</p>
<p>
- Informal parameters: <strong>allowed / forbidden</strong>
+ Informal parameters: <strong>allowed</strong>
</p>
<p>
Modified:
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeTableNodeViewDelegator.xml
URL:
http://svn.apache.org/viewcvs/tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeTableNodeViewDelegator.xml?rev=393485&r1=393484&r2=393485&view=diff
==============================================================================
---
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeTableNodeViewDelegator.xml
(original)
+++
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeTableNodeViewDelegator.xml
Wed Apr 12 08:21:50 2006
@@ -28,7 +28,7 @@
<body>
-<p> <strong>THIS PAGE UNDER CONSTRUCTION</strong>
+<p> <strong>Renders a &TreeNodeView;</strong>
</p>
<p>
@@ -51,11 +51,11 @@
</table>
<p>
- Body: <strong>removed / allowed</strong>
+ Body: <strong>allowed</strong>
</p>
<p>
- Informal parameters: <strong>allowed / forbidden</strong>
+ Informal parameters: <strong>allowed</strong>
</p>
<p>
Modified:
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeView.xml
URL:
http://svn.apache.org/viewcvs/tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeView.xml?rev=393485&r1=393484&r2=393485&view=diff
==============================================================================
---
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeView.xml
(original)
+++
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/TreeView.xml
Wed Apr 12 08:21:50 2006
@@ -28,11 +28,14 @@
<body>
-<p> <strong>THIS PAGE UNDER CONSTRUCTION</strong>
+<p>
+ A low level Tree component that wraps all other low level Tree
components.
+ This component carries the <link
href="&apicontrib;/contrib/tree/model/ITreeModel.html">ITreeModel</link>
+ that is used by the other Tree components.
</p>
<p>
- <strong>See also:</strong>
+ <strong>See also: &Tree;, &TreeDataView;, &TreeNodeView;</strong>
</p>
<section>
@@ -48,14 +51,67 @@
<th>Description</th>
</tr>
+<tr>
+ <td>sessionStateManager</td>
+ <td>
+ <link
href="&apicontrib;/contrib/tree/model/ITreeSessionStateManager.html">ITreeSessionStateManager</link>
+ </td>
+ <td>in</td>
+ <td>no</td>
+ <td> </td>
+ <td>
+ Manages the state of the tree (i.e. which nodes are open, closed or
selected).
+ </td>
+ </tr>
+
+ <tr>
+ <td>sessionStoreManager</td>
+ <td>
+ <link
href="&apicontrib;/contrib/tree/model/ISessionStoreManager.html">ISessionStoreManager</link>
+ </td>
+ <td>in</td>
+ <td>no</td>
+ <td> </td>
+ <td>
+ Allows storing the tree (or parts of it) to the session.
+ </td>
+ </tr>
+
+ <tr>
+ <td>treeModel</td>
+ <td>
+ <link
href="&apicontrib;/contrib/tree/model/ITreeModel.html">ITreeModel</link>
+ </td>
+ <td>in</td>
+ <td>yes</td>
+ <td> </td>
+ <td>
+ Defines a model that can provide the nodes of the tree.
+ </td>
+ </tr>
+
+ <tr>
+ <td>treeStateListener</td>
+ <td>
+ <link
href="&apicontrib;/contrib/tree/model/ITreeStateListener.html">ITreeStateListener</link>
+ </td>
+ <td>in</td>
+ <td>no</td>
+ <td> </td>
+ <td>
+ If specified, this object will receive events generated by the tree.
+ Such events are: SELECTED_NODE_CHANGED, NODE_EXPANDED and
NODE_COLLAPSED.
+ </td>
+ </tr>
+
</table>
<p>
- Body: <strong>removed / allowed</strong>
+ Body: <strong>allowed</strong>
</p>
<p>
- Informal parameters: <strong>allowed / forbidden</strong>
+ Informal parameters: <strong>allowed</strong>
</p>
<p>
Modified:
tapestry/tapestry4/branches/4.0/src/documentation/content/xdocs/links.ent
URL:
http://svn.apache.org/viewcvs/tapestry/tapestry4/branches/4.0/src/documentation/content/xdocs/links.ent?rev=393485&r1=393484&r2=393485&view=diff
==============================================================================
--- tapestry/tapestry4/branches/4.0/src/documentation/content/xdocs/links.ent
(original)
+++ tapestry/tapestry4/branches/4.0/src/documentation/content/xdocs/links.ent
Wed Apr 12 08:21:50 2006
@@ -198,6 +198,14 @@
<!ENTITY TableValues '<link
href="site:TableValues">TableValues</link>'>
<!ENTITY TableView '<link
href="site:TableView">TableView</link>'>
+<!ENTITY Tree '<link href="site:Tree">Tree</link>'>
+<!ENTITY TreeDataView '<link
href="site:TreeDataView">TreeDataView</link>'>
+<!ENTITY TreeNodeView '<link
href="site:TreeNodeView">TreeNodeView</link>'>
+<!ENTITY TreeTable '<link
href="site:TreeTable">TreeTable</link>'>
+<!ENTITY TreeTableDataView '<link
href="site:TreeTableDataView">TreeTableDataView</link>'>
+<!ENTITY TreeTableNodeViewDelegator '<link
href="site:TreeTableNodeViewDelegator">TreeTableNodeViewDelegator</link>'>
+<!ENTITY TreeView '<link
href="site:TreeView">TreeView</link>'>
+
<!-- External links -->
<!ENTITY Ant '<link
href="http://ant.apache.org/";>Ant</link>'>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
