myfaces-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From mmarinsc...@apache.org
Subject svn commit: r209944 - in /myfaces/forrest/trunk/content/xdocs: components/component-template.xml components/dataScroller.xml site.xml
Date Sat, 09 Jul 2005 13:47:50 GMT
Author: mmarinschek
Date: Sat Jul  9 06:47:47 2005
New Revision: 209944

URL: http://svn.apache.org/viewcvs?rev=209944&view=rev
Log: (empty)

Added:
    myfaces/forrest/trunk/content/xdocs/components/dataScroller.xml
Modified:
    myfaces/forrest/trunk/content/xdocs/components/component-template.xml
    myfaces/forrest/trunk/content/xdocs/site.xml

Modified: myfaces/forrest/trunk/content/xdocs/components/component-template.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/component-template.xml?rev=209944&r1=209943&r2=209944&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/component-template.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/components/component-template.xml Sat Jul  9 06:47:47
2005
@@ -59,12 +59,12 @@
         <!-- Usage -->
         <section>
             <title>Usage</title>
-            <p>[TODO]</p>
+            <source>[TODO]</source>
         </section>
         
         <!-- Additional Information -->
         <section>
-            <title>Additional Informaiton</title>
+            <title>Additional Information</title>
             <p>[TODO]</p>
         </section>        
 

Added: myfaces/forrest/trunk/content/xdocs/components/dataScroller.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/components/dataScroller.xml?rev=209944&view=auto
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/components/dataScroller.xml (added)
+++ myfaces/forrest/trunk/content/xdocs/components/dataScroller.xml Sat Jul  9 06:47:47 2005
@@ -0,0 +1,86 @@
+<?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>
+    <!-- component name -->
+    <header>
+        <title>DataScroller</title>
+        <subtitle>&lt;x:dataScroller&gt;</subtitle>
+    </header>
+    <body>
+        <section>
+            <title>Description</title>
+            <p>
+A component to run over the pages of an UIData (eg. <h:dataTable>). 
+            </p>
+            <p>
+Renders a DataScroller, which should work with any UIData. The facets are getting rendered
in the following order: first, fastrewind, previous, next, fastforward, last 
+            </p>
+        </section>
+        <!-- screen shot -->
+        <section>
+            <title>Screen Shot</title>
+            <figure src="images/datascroller.png" alt="DataScroller"/>
+        </section>
+        <!-- API -->
+        <section>
+            <title>API</title>
+            <table>
+                <tr>
+                    <td>component-family</td>
+                    <td>javax.faces.Panel</td>
+                </tr>
+                <tr>
+                    <td>renderer-type</td>
+                    <td>org.apache.myfaces.DataScroller</td>
+                </tr>
+                <tr>
+                    <td>component-class</td>
+                    <td>org.apache.myfaces.custom.datascroller.HtmlDataScroller</td>
+                </tr>
+                <tr>
+                    <td>renderer-class</td>
+                    <td>org.apache.myfaces.custom.datascroller.HtmlDataScrollerRenderer</td>
+                </tr>
+                <tr>
+                    <td>tag-class</td>
+                    <td>org.apache.myfaces.custom.datascroller.HtmlDataScrollerTag</td>
+                </tr>
+            </table>
+        </section>
+
+        <!-- Usage -->
+        <section>
+            <title>Usage</title>
+            <source>
+&lt;x:dataScroller[ user-role-support-attributes ]
+     [for="reference to UIData"]
+     [fastStep="values {ThemeIE, ThemeMiniBlack, ThemeOffice, ThemePanel}"]
+     [pageIndexVar="A parameter name, under which the actual page index is set in request
scope
+                              similar to the var parameter."]
+     [pageCountVar="A parameter name, under which the actual page count is set in request
scope
+                              similar to the var parameter."]&gt;
+    Nested Facets: first, previous, next, last, fastforward, fastrewind
+&lt;/x:dataScroller&gt;
+            <source>
+        </section>
+
+        <!-- Additional Information -->
+        <section>
+            <title>Additional Information</title>
+            <p>DataScroller must be nested inside of an UIData component, or attribute
"for" must be given so that corresponding uiData can be found.</p>
+            <p>The scope of pageIndexVar and pageCountVar is limited, and only direct
children of DataScroller may see them.</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 />
+	&copy; 2004 - 2005, Apache Software Foundation
+	</legal>
+    </footer>
+
+</document>

Modified: myfaces/forrest/trunk/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/site.xml?rev=209944&r1=209943&r2=209944&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/site.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/site.xml Sat Jul  9 06:47:47 2005
@@ -43,6 +43,7 @@
          <newspaperTable label="Newspaper Table" href="newspaperTable.html"/>
          <aliasBean label="Alias Bean" href="aliasBean.html"/>
          <Buffer label="Buffer" href="buffer.html"/>
+         <dataScroller label="dataScroller" href="dataScroller.html"/>
          <fileUpload label="File Upload" href="fileUpload.html"/>
          <tabbedPane label="TabbedPane" href="tabbedPane.html"/>
          <calendar label="Calendar" href="calendar.html"/>



Mime
View raw message