You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@myfaces.apache.org by mb...@apache.org on 2005/08/01 17:41:55 UTC
svn commit: r226822 - in /myfaces/forrest/trunk/content/xdocs: site.xml
tomahawk/column.xml
Author: mbr
Date: Mon Aug 1 08:41:52 2005
New Revision: 226822
URL: http://svn.apache.org/viewcvs?rev=226822&view=rev
Log:
documentation for x:column component added
Added:
myfaces/forrest/trunk/content/xdocs/tomahawk/column.xml
Modified:
myfaces/forrest/trunk/content/xdocs/site.xml
Modified: myfaces/forrest/trunk/content/xdocs/site.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/site.xml?rev=226822&r1=226821&r2=226822&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/site.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/site.xml Mon Aug 1 08:41:52 2005
@@ -125,6 +125,7 @@
<panelNavigation label="Panel Navigation" href="panelNavigation.html"/>
<uiSaveState label="UI Save State" href="uiSaveState.html"/>
<columns label="Columns" href="columns.html"/>
+ <columns label="Column" href="column.html"/>
</components>
<validators href="tomahawk/" label="Validators" tab="tomahawk">
Added: myfaces/forrest/trunk/content/xdocs/tomahawk/column.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/tomahawk/column.xml?rev=226822&view=auto
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/tomahawk/column.xml (added)
+++ myfaces/forrest/trunk/content/xdocs/tomahawk/column.xml Mon Aug 1 08:41:52 2005
@@ -0,0 +1,135 @@
+<?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>Column</title>
+ <subtitle><x:column/></subtitle>
+ </header>
+ <body>
+ <!-- Description -->
+ <section>
+ <title>Description</title>
+ <p>A tag that extend h:column to provide HTML passthrough attributes.</p>
+ <p>
+ x:column can be used instead of h:column in a x:datatable. It provides
+ HTML passthrough attributes for header (<th>),
+ footer (<td>) and row cells (<td>).
+ </p>
+ </section>
+ <!-- screen shot -->
+ <section>
+ <title>Screen Shot</title>
+ <p>Not Available</p> <!-- replace with either a figure or Not Available -->
+ <!--
+ <figure src="jscookmenu.png" alt="jscookmenu"/>
+ -->
+ </section>
+ <!-- API -->
+ <section>
+ <title>API</title>
+ <table>
+ <tr>
+ <td>component-family</td>
+ <td>javax.faces.Column</td>
+ </tr>
+ <tr>
+ <td>renderer-type</td>
+ <td>-</td>
+ </tr>
+ <tr>
+ <td>component-class</td>
+ <td>org.apache.myfaces.custom.column.HtmlColumn</td>
+ </tr>
+ <tr>
+ <td>renderer-class</td>
+ <td>-</td>
+ </tr>
+ <tr>
+ <td>tag-class</td>
+ <td>org.apache.myfaces.custom.column.HtmlColumnTag</td>
+ </tr>
+ </table>
+ </section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:datatable var="row" ...>
+ <x:column styleClass="#{row.styleClass}">
+ ...
+ </x:column>
+</x:datatable>
+ </source>
+ </section>
+ <!-- Syntax -->
+ <section>
+ <title>Syntax</title>
+ <note label="<x:column/>">
+ <code>dir - row cell, ltr | rtl.</code><br/>
+ <code>lang - row cell, language see RFC 1766</code><br/>
+ <code>title - row cell, title (tooltip)</code><br/>
+ <code>style - row cell, inline css-style</code><br/>
+ <code>styleClass - row cell, css style class</code><br/>
+ <code>onclick - row cell, onclick event</code><br/>
+ <code>ondblclick - row cell, ondblclick event</code><br/>
+ <code>onmousedown - row cell, onmousedown event</code><br/>
+ <code>onmouseup - row cell, onmouseup event</code><br/>
+ <code>onmouseover - row cell, onmouseover event</code><br/>
+ <code>onmousemove - row cell, onmousemove event</code><br/>
+ <code>onmouseout - row cell, onmouseout event</code><br/>
+ <code>onkeypress - row cell, onkeypress event</code><br/>
+ <code>onkeydown - row cell, onkeydown event</code><br/>
+ <code>onkeyup - row cell, onkeyup event</code><br/>
+ <br/>
+ <code>headerdir - header cell, ltr | rtl.</code><br/>
+ <code>headerlang - header cell, language see RFC 1766</code><br/>
+ <code>headertitle - header cell, title (tooltip)</code><br/>
+ <code>headerstyle - header cell, inline css-style</code><br/>
+ <code>headerstyleClass - header cell, css style class</code><br/>
+ <code>headeronclick - header cell, onclick event</code><br/>
+ <code>headerondblclick - header cell, ondblclick event</code><br/>
+ <code>headeronmousedown - header cell, onmousedown event</code><br/>
+ <code>headeronmouseup - header cell, onmouseup event</code><br/>
+ <code>headeronmouseover - header cell, onmouseover event</code><br/>
+ <code>headeronmousemove - header cell, onmousemove event</code><br/>
+ <code>headeronmouseout - header cell, onmouseout event</code><br/>
+ <code>headeronkeypress - header cell, onkeypress event</code><br/>
+ <code>headeronkeydown - header cell, onkeydown event</code><br/>
+ <code>headeronkeyup - header cell, onkeyup event</code><br/>
+ <br/>
+ <code>footerdir - footer cell, ltr | rtl.</code><br/>
+ <code>footerlang - footer cell, language see RFC 1766</code><br/>
+ <code>footertitle - footer cell, title (tooltip)</code><br/>
+ <code>footerstyle - footer cell, inline css-style</code><br/>
+ <code>footerstyleClass - footer cell, css style class</code><br/>
+ <code>footeronclick - footer cell, onclick event</code><br/>
+ <code>footerondblclick - footer cell, ondblclick event</code><br/>
+ <code>footeronmousedown - footer cell, onmousedown event</code><br/>
+ <code>footeronmouseup - footer cell, onmouseup event</code><br/>
+ <code>footeronmouseover - footer cell, onmouseover event</code><br/>
+ <code>footeronmousemove - footer cell, onmousemove event</code><br/>
+ <code>footeronmouseout - footer cell, onmouseout event</code><br/>
+ <code>footeronkeypress - footer cell, onkeypress event</code><br/>
+ <code>footeronkeydown - footer cell, onkeydown event</code><br/>
+ <code>footeronkeyup - footer cell, onkeyup event</code>
+ </note>
+ </section>
+ <!-- Instructions -->
+ <section>
+ <title>Instructions</title>
+ <p>TODO: create 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>