You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by ca...@apache.org on 2006/10/14 13:24:02 UTC
svn commit: r463916 - in /myfaces/tomahawk/trunk/sandbox/core/src/site:
site.xml xdoc/excelexport.xml
Author: cagatay
Date: Sat Oct 14 04:24:01 2006
New Revision: 463916
URL: http://svn.apache.org/viewvc?view=rev&rev=463916
Log:
Add doc for excelexport component
Added:
myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/excelexport.xml
Modified:
myfaces/tomahawk/trunk/sandbox/core/src/site/site.xml
Modified: myfaces/tomahawk/trunk/sandbox/core/src/site/site.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/site/site.xml?view=diff&rev=463916&r1=463915&r2=463916
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/site/site.xml (original)
+++ myfaces/tomahawk/trunk/sandbox/core/src/site/site.xml Sat Oct 14 04:24:01 2006
@@ -32,7 +32,7 @@
<item name="Sandbox" href="index.html"/>
</menu>
- <menu name="Components">
+ <menu name="Components">
<item name="Input Suggest Ajax Menu" href="inputSuggestAjax.html"/>
<item name="Auto Update DataTable" href="autoUpdateDataTable.html"/>
<item name="Input Suggest" href="inputSuggest.html"/>
@@ -43,6 +43,7 @@
<item name="Dynamic Image" href="graphicImageDynamic.html"/>
<item name="FishEye Navigation Menu" href="fisheye.html"/>
<item name="SelectItems" href="selectItems.html"/>
+ <item name="ExcelExport" href="excelexport.html"/>
</menu>
<menu name="Validators">
Added: myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/excelexport.xml
URL: http://svn.apache.org/viewvc/myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/excelexport.xml?view=auto&rev=463916
==============================================================================
--- myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/excelexport.xml (added)
+++ myfaces/tomahawk/trunk/sandbox/core/src/site/xdoc/excelexport.xml Sat Oct 14 04:24:01 2006
@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation Maven//EN" "http://maven.apache.org/dtd/maven-xdoc.dtd">
+
+ <!--
+This is a standard template meant to be used for the documentation of all custom
+components.
+--><document>
+
+ <body>
+ <!-- Description -->
+ <section name="Description">
+
+ <p>
+ ExcelExport allows exporting HtmlDataTable contents as an excel file.
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section name="Screen Shot">
+
+ <p>Not Available</p> <!-- replace with either a figure or Not Available -->
+ <!--
+ <figure src="jscookmenu.png" alt="jscookmenu"/>
+ -->
+ </section>
+ <!-- API -->
+ <section name="API">
+
+ <table>
+ <tr>
+ <td colspan="1" rowspan="1">component-family</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.Export</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-type</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.ExcelExportRenderer</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">component-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.excelexport.ExcelExport</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">renderer-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.excelexport.ExcelExportRenderer</td>
+ </tr>
+ <tr>
+ <td colspan="1" rowspan="1">tag-class</td>
+ <td colspan="1" rowspan="1">org.apache.myfaces.excelexport.ExcelExportTag</td>
+ </tr>
+ </table>
+ </section>
+
+ <!-- Usage -->
+ <section name="Usage">
+
+ <source xml:space="preserve">
+<s:excelExport for="tbl_cars">
+ <h:commandButton action="" value="Export"/>
+</s:excelExport></source>
+ </section>
+
+ <!-- Syntax -->
+ <section name="Syntax">
+
+ <blockquote><h3><s:excelExport></h3>
+ <code>for="Id of the datatable"</code><br/>
+ </blockquote>
+ </section>
+
+ <!-- Additional Information -->
+ <section name="Additional Information">
+
+ <p>For now this component only works with server side state saving.</p>
+ </section>
+
+ </body>
+
+
+</document>