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/07/28 17:54:49 UTC
svn commit: r225804 - in /myfaces/forrest/trunk/content/xdocs: site.xml
tomahawk/form.xml
Author: mbr
Date: Thu Jul 28 08:54:45 2005
New Revision: 225804
URL: http://svn.apache.org/viewcvs?rev=225804&view=rev
Log:
adding doc for x:form component
Added:
myfaces/forrest/trunk/content/xdocs/tomahawk/form.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=225804&r1=225803&r2=225804&view=diff
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/site.xml (original)
+++ myfaces/forrest/trunk/content/xdocs/site.xml Thu Jul 28 08:54:45 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"/>
+ <form label="Form" href="form.html"/>
</components>
<validators href="tomahawk/" label="Validators" tab="tomahawk">
Added: myfaces/forrest/trunk/content/xdocs/tomahawk/form.xml
URL: http://svn.apache.org/viewcvs/myfaces/forrest/trunk/content/xdocs/tomahawk/form.xml?rev=225804&view=auto
==============================================================================
--- myfaces/forrest/trunk/content/xdocs/tomahawk/form.xml (added)
+++ myfaces/forrest/trunk/content/xdocs/tomahawk/form.xml Thu Jul 28 08:54:45 2005
@@ -0,0 +1,84 @@
+<?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>Form</title>
+ <subtitle><x:form/></subtitle>
+ </header>
+ <body>
+ <!-- Description -->
+ <section>
+ <title>Description</title>
+ <p>The tag allows control for the action attribute of the form.</p>
+ <p>
+ Every JSF request goes to the same url which renders the response.
+ The x:form component allows to use a different scheme, servername or
+ port when a form is submitted. This is normally needed to change
+ from http to https to submit security related data.
+ </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.Form</td>
+ </tr>
+ <tr>
+ <td>renderer-type</td>
+ <td>org.apache.myfaces.Form</td>
+ </tr>
+ <tr>
+ <td>component-class</td>
+ <td>org.apache.myfaces.component.html.ext.HtmlForm</td>
+ </tr>
+ <tr>
+ <td>renderer-class</td>
+ <td>org.apache.myfaces.renderkit.html.ext.HtmlFormRenderer</td>
+ </tr>
+ <tr>
+ <td>tag-class</td>
+ <td>org.apache.myfaces.taglib.html.ext.HtmlFormTag</td>
+ </tr>
+ </table>
+ </section>
+ <!-- Usage -->
+ <section>
+ <title>Usage</title>
+ <source>
+<x:form scheme="https" servername="www.domain.org" port="1234">
+</x:form>
+ </source>
+ </section>
+ <!-- Syntax -->
+ <section>
+ <title>Syntax</title>
+ <note label="<x:form/>">
+ <code>scheme - either "http" or "https" (optional)</code><br/>
+ <code>servername - the server name or an ip address (optional)</code><br/>
+ <code>port - a int value which defines the port (optional)</code>
+ </note>
+ </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>