You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by mm...@apache.org on 2005/08/24 14:44:57 UTC
svn commit: r239642 -
/myfaces/forrest/trunk/content/xdocs/sandbox/autoUpdateDataTable.xml
Author: mmarinschek
Date: Wed Aug 24 05:44:44 2005
New Revision: 239642
URL: http://svn.apache.org/viewcvs?rev=239642&view=rev
Log:
docu for autoupdatedatatable
Added:
myfaces/forrest/trunk/content/xdocs/sandbox/autoUpdateDataTable.xml
Added: myfaces/forrest/trunk/content/xdocs/sandbox/autoUpdateDataTable.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/sandbox/autoUpdateDataTable.xml?rev=239642&view=auto
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/sandbox/autoUpdateDataTable.xml (added)
+++ myfaces/forrest/trunk/content/xdocs/sandbox/autoUpdateDataTable.xml Wed Aug 24 05:44:44 2005
@@ -0,0 +1,117 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "document-v12.dtd">
+
+<!--
+This is a standard template meant to be used for the documentation of all custom
+components.
+-->
+<document>
+ <header>
+ <title>Ajax DataTable</title>
+ <subtitle><x:autoUpdateDataTable></subtitle>
+ </header>
+ <body>
+ <!-- Description -->
+ <section>
+ <title>Description</title>
+ <p>
+ A tag that defines an automatically update DataTable Ajax binding.<br/>
+ This allows you to do frequency controlled update via asynchronous
+ server requests - Ajax. <br/><br/>
+ <code>
+ Note, this control is experimental and it is currently
+ located in the MyFaces sandbox and can be subject to
+ alteration in the immediate future.
+ Therefore use it with care.
+ </code>
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section>
+ <title>Screen Shot</title>
+ <figure src="images/autoUpdateDataTable.jpg" alt="autoUpdateDataTable"/>
+ </section>
+ <!-- API -->
+ <section>
+ <title>API</title>
+ <table>
+ <tr>
+ <td>component-family</td>
+ <td>javax.faces.Data</td>
+ </tr>
+ <tr>
+ <td>renderer-type</td>
+ <td>org.apache.myfaces.AutoUpdateDataTable</td>
+ </tr>
+ <tr>
+ <td>component-class</td>
+ <td>org.apache.myfaces.custom.autoupdatedatatable.AutoUpdateDataTable</td>
+ </tr>
+ <tr>
+ <td>renderer-class</td>
+ <td>org.apache.myfaces.custom.autoupdatedatatable.AutoUpdateDataTableRenderer</td>
+ </tr>
+ <tr>
+ <td>tag-class</td>
+ <td>org.apache.myfaces.custom.autoupdatedatatable.AutoUpdateDataTableTag</td>
+ </tr>
+ </table>
+ </section>
+
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+ <x:autoUpdateDataTable [ all standard dataTable attributes allowed ]
+ [ preserveDataModel="{true|false}" ]
+ [ forceIdIndexFormula="value-binding" ]
+ [ sortColumn="value-binding" ]
+ [ sortAscending="value-binding" ]
+ [ preserveSort="{true|false}" ]
+ [ frequency="value-binding" ]>
+ standard dataTable body (<h:column> tags and optional "header" and "footer" facets)
+ </t:command_sortheader>
+ <x:autoUpdateDataTable>
+ </source>
+ </section>
+
+ <!-- Syntax -->
+ <section>
+ <title>Syntax</title>
+ <note label="<x:autoUpdateDataTable>">
+ <code>all standard dataTable attributes allowed</code><br/>
+ <code>preserveDataModel="{true|false}"</code><br/>
+ <code>forceIdIndexFormula="value-binding"</code><br/>
+ <code>sortColumn="value-binding"</code><br/>
+ <code>sortAscending="value-binding"</code><br/>
+ <code>preserveSort="{true|false}"</code><br/>
+ <code>frequency="value-binding"</code><br/>
+ </note>
+ </section>
+
+ <section>
+ <title>Instructions</title>
+ <p>
+ <code>
+ frequency - defines the time in seconds between the Ajax-Requests
+ </code>
+ </p>
+ <p>
+ Note - This component is different to others, it uses Ajax mechanisms
+ to fetch data from the server, thus the backend binding can
+ and will be used outside of the standard JSF lifecycle to deliver the data.
+ </p>
+ <br/><br/>
+ <p>Use the autoUpdateDataTable tag always within a form tag.</p>
+ <br/><br/>
+ <p>see examples/ajaxDataTableSingle.jsp for an example.</p>
+ </section>
+
+ </body>
+ <footer>
+ <legal>Java, J2EE, and JCP are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.<br />
+ © 2004 - 2005, Apache Software Foundation
+ </legal>
+ </footer>
+
+</document>