You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tapestry.apache.org by jk...@apache.org on 2006/10/13 02:28:44 UTC
svn commit: r463527 [1/3] - in /tapestry/tapestry4/trunk/src/site: ./
xdoc/components/ xdoc/components/form/ xdoc/components/general/
xdoc/components/link/
Author: jkuhnert
Date: Thu Oct 12 17:28:41 2006
New Revision: 463527
URL: http://svn.apache.org/viewvc?view=rev&rev=463527
Log:
Refactored layout/documentation for components.
Added:
tapestry/tapestry4/trunk/src/site/xdoc/components/form/
tapestry/tapestry4/trunk/src/site/xdoc/components/form/Button.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Button.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/form/Checkbox.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Checkbox.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/form/DatePicker.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/DatePicker.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/form/FieldLabel.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/FieldLabel.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/form/Form.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Form.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/form/Hidden.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Hidden.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/form/ImageSubmit.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/ImageSubmit.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/form/LinkSubmit.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/form/Option.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Option.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/form/PropertySelection.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/PropertySelection.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/form/Radio.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Radio.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/form/RadioGroup.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/RadioGroup.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/form/Select.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Select.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/form/Submit.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Submit.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/form/TextArea.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/TextArea.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/form/TextField.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/TextField.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/form/Upload.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Upload.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/form/index.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/general/
tapestry/tapestry4/trunk/src/site/xdoc/components/general/Any.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Any.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/Block.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Block.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/Body.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Body.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/Delegator.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Delegator.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/Describe.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Describe.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/Else.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Else.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/ExceptionDisplay.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/ExceptionDisplay.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/For.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/For.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/Frame.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Frame.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/If.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/If.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/Image.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Image.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/Insert.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Insert.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/InsertText.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/InsertText.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/InvokeListener.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/InvokeListener.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/Relation.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Relation.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/RenderBlock.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/RenderBlock.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/RenderBody.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/RenderBody.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/Script.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Script.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/Shell.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Shell.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/general/Style.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Style.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/link/
tapestry/tapestry4/trunk/src/site/xdoc/components/link/DirectLink.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/DirectLink.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/link/ExternalLink.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/ExternalLink.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/link/GenericLink.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/GenericLink.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/link/PageLink.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/PageLink.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/link/Rollover.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Rollover.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/link/ServiceLink.xml
- copied, changed from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/ServiceLink.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/link/index.xml (with props)
Removed:
tapestry/tapestry4/trunk/src/site/xdoc/components/Any.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Block.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Body.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Button.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Checkbox.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/DatePicker.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Delegator.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Describe.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/DirectLink.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Else.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/ExceptionDisplay.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/ExternalLink.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/FieldLabel.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/For.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Form.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Frame.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/GenericLink.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Hidden.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/If.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Image.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/ImageSubmit.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Insert.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/InsertText.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/InvokeListener.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/LinkSubmit.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Option.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/PageLink.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/PropertySelection.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Radio.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/RadioGroup.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Relation.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/RenderBlock.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/RenderBody.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Rollover.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Script.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Select.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/ServiceLink.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Shell.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Style.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Submit.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/TextArea.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/TextField.xml
tapestry/tapestry4/trunk/src/site/xdoc/components/Upload.xml
Modified:
tapestry/tapestry4/trunk/src/site/site.xml
Modified: tapestry/tapestry4/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/site.xml?view=diff&rev=463527&r1=463526&r2=463527
==============================================================================
--- tapestry/tapestry4/trunk/src/site/site.xml (original)
+++ tapestry/tapestry4/trunk/src/site/site.xml Thu Oct 12 17:28:41 2006
@@ -96,50 +96,56 @@
<menu name="Components" >
- <item name="Core" href="/components/index.html" collapse="true">
- <item name="Any" href="/components/Any.html" />
- <item name="Block" href="/components/Block.html" />
- <item name="Body" href="/components/Body.html" />
- <item name="Button" href="/components/Button.html" />
- <item name="Checkbox" href="/components/Checkbox.html" />
- <item name="DatePicker" href="/components/DatePicker.html" />
- <item name="Delegator" href="/components/Delegator.html" />
- <item name="Describe" href="/components/Describe.html" />
- <item name="DirectLink" href="/components/DirectLink.html" />
- <item name="Else" href="/components/Else.html" />
- <item name="ExceptionDisplay" href="/components/ExceptionDisplay.html" />
- <item name="ExternalLink" href="/components/ExternalLink.html" />
- <item name="FieldLabel" href="/components/FieldLabel.html" />
- <item name="For" href="/components/For.html" />
- <item name="Form" href="/components/Form.html" />
- <item name="Frame" href="/components/Frame.html" />
- <item name="GenericLink" href="/components/GenericLink.html" />
- <item name="Hidden" href="/components/Hidden.html" />
- <item name="If" href="/components/If.html" />
- <item name="Image" href="/components/Image.html" />
- <item name="ImageSubmit" href="/components/ImageSubmit.html" />
- <item name="Insert" href="/components/Insert.html" />
- <item name="InsertText" href="/components/InsertText.html" />
- <item name="InvokeListener" href="/components/InvokeListener.html" />
- <item name="LinkSubmit" href="/components/LinkSubmit.html" />
- <item name="Option" href="/components/Option.html" />
- <item name="PageLink" href="/components/PageLink.html" />
- <item name="PropertySelection" href="/components/PropertySelection.html" />
- <item name="Radio" href="/components/Radio.html" />
- <item name="RadioGroup" href="/components/RadioGroup.html" />
- <item name="Relation" href="/components/Relation.html" />
- <item name="RenderBlock" href="/components/RenderBlock.html" />
- <item name="RenderBody" href="/components/RenderBody.html" />
- <item name="Rollover" href="/components/Rollover.html" />
- <item name="Script" href="/components/Script.html" />
- <item name="Select" href="/components/Select.html" />
- <item name="ServiceLink" href="/components/ServiceLink.html" />
- <item name="Shell" href="/components/Shell.html" />
- <item name="Style" href="/components/Style.html" />
- <item name="Submit" href="/components/Submit.html" />
- <item name="TextArea" href="/components/TextArea.html" />
- <item name="TextField" href="/components/TextField.html" />
- <item name="Upload" href="/components/Upload.html" />
+ <item name="General" href="/components/index.html" collapse="true">
+ <item name="Any" href="/components/general/Any.html" />
+ <item name="Block" href="/components/general/Block.html" />
+ <item name="Body" href="/components/general/Body.html" />
+ <item name="Delegator" href="/components/general/Delegator.html" />
+ <item name="Describe" href="/components/general/Describe.html" />
+ <item name="Else" href="/components/general/Else.html" />
+ <item name="ExceptionDisplay" href="/components/general/ExceptionDisplay.html" />
+ <item name="For" href="/components/general/For.html" />
+ <item name="Frame" href="/components/general/Frame.html" />
+ <item name="If" href="/components/general/If.html" />
+ <item name="Image" href="/components/general/Image.html" />
+ <item name="Insert" href="/components/general/Insert.html" />
+ <item name="InsertText" href="/components/general/InsertText.html" />
+ <item name="InvokeListener" href="/components/general/InvokeListener.html" />
+ <item name="Relation" href="/components/general/Relation.html" />
+ <item name="RenderBlock" href="/components/general/RenderBlock.html" />
+ <item name="RenderBody" href="/components/general/RenderBody.html" />
+ <item name="Script" href="/components/general/Script.html" />
+ <item name="Shell" href="/components/general/Shell.html" />
+ <item name="Style" href="/components/general/Style.html" />
+ </item>
+
+ <item name="Form" href="/components/form/index.html" collapse="true">
+ <item name="Button" href="/components/form/Button.html" />
+ <item name="Checkbox" href="/components/form/Checkbox.html" />
+ <item name="DatePicker" href="/components/form/DatePicker.html" />
+ <item name="FieldLabel" href="/components/form/FieldLabel.html" />
+ <item name="Form" href="/components/form/Form.html" />
+ <item name="Hidden" href="/components/form/Hidden.html" />
+ <item name="ImageSubmit" href="/components/form/ImageSubmit.html" />
+ <item name="LinkSubmit" href="/components/form/LinkSubmit.html" />
+ <item name="Option" href="/components/form/Option.html" />
+ <item name="PropertySelection" href="/components/form/PropertySelection.html" />
+ <item name="Radio" href="/components/form/Radio.html" />
+ <item name="RadioGroup" href="/components/form/RadioGroup.html" />
+ <item name="Select" href="/components/form/Select.html" />
+ <item name="Submit" href="/components/form/Submit.html" />
+ <item name="TextArea" href="/components/form/TextArea.html" />
+ <item name="TextField" href="/components/form/TextField.html" />
+ <item name="Upload" href="/components/form/Upload.html" />
+ </item>
+
+ <item name="Link" href="/components/link/index.html" collapse="true">
+ <item name="DirectLink" href="/components/link/DirectLink.html" />
+ <item name="ExternalLink" href="/components/link/ExternalLink.html" />
+ <item name="GenericLink" href="/components/link/GenericLink.html" />
+ <item name="PageLink" href="/components/link/PageLink.html" />
+ <item name="Rollover" href="/components/link/Rollover.html" />
+ <item name="ServiceLink" href="/components/link/ServiceLink.html" />
</item>
</menu>
Copied: tapestry/tapestry4/trunk/src/site/xdoc/components/form/Button.xml (from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Button.xml)
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/form/Button.xml?view=diff&rev=463527&p1=tapestry/tapestry4/trunk/src/site/xdoc/components/Button.xml&r1=454604&p2=tapestry/tapestry4/trunk/src/site/xdoc/components/form/Button.xml&r2=463527
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/Button.xml (original)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/form/Button.xml Thu Oct 12 17:28:41 2006
@@ -22,15 +22,15 @@
<section name="Button">
<p>
- Provides a HTML form button element <input type="button"> for attaching
+ Provides a HTML form button element <code><input type="button"></code> for attaching
JavaScript onclick event handlers.
</p>
<p>
<strong>
See also:
- <a href="Form.html">Form</a>
- <a href="Script.html">Script</a>
+ <a href="Form.html">Form</a>,
+ <a href="../general/Script.html">Script</a>,
<a href="Submit.html">Submit</a>
</strong>
</p>
@@ -42,7 +42,6 @@
<tr>
<th>Name</th>
<th>Type</th>
- <th>Direction</th>
<th>Required</th>
<th>Default</th>
<th>Description</th>
@@ -50,7 +49,6 @@
<tr>
<td>lable</td>
<td>String</td>
- <td>in</td>
<td>no</td>
<td></td>
<td>
@@ -60,7 +58,6 @@
<tr>
<td>disabled</td>
<td>boolean</td>
- <td>in</td>
<td>no</td>
<td>false</td>
<td>
Copied: tapestry/tapestry4/trunk/src/site/xdoc/components/form/Checkbox.xml (from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Checkbox.xml)
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/form/Checkbox.xml?view=diff&rev=463527&p1=tapestry/tapestry4/trunk/src/site/xdoc/components/Checkbox.xml&r1=454604&p2=tapestry/tapestry4/trunk/src/site/xdoc/components/form/Checkbox.xml&r2=463527
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/Checkbox.xml (original)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/form/Checkbox.xml Thu Oct 12 17:28:41 2006
@@ -26,7 +26,7 @@
<p>
<strong>
See also:
- <a href="../tapestry-framework/apidocs/org/apache/tapestry/form/Checkbox.html">
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/form/Checkbox.html">
org.apache.tapestry.form.Checkbox
</a>
,
@@ -41,7 +41,6 @@
<tr>
<th>Name</th>
<th>Type</th>
- <th>Direction</th>
<th>Required</th>
<th>Default</th>
<th>Description</th>
@@ -50,7 +49,6 @@
<tr>
<td>value</td>
<td>boolean</td>
- <td>in/out</td>
<td>yes</td>
<td></td>
<td>
@@ -63,7 +61,6 @@
<tr>
<td>displayName</td>
<td>string</td>
- <td>in</td>
<td>no</td>
<td></td>
<td>
@@ -76,7 +73,6 @@
<tr>
<td>disabled</td>
<td>boolean</td>
- <td>in</td>
<td>no</td>
<td>false</td>
<td>
@@ -84,16 +80,50 @@
the checkbox will be ignored.
</td>
</tr>
-
+
<tr>
<td>id</td>
<td>string</td>
- <td>in</td>
<td>no</td>
<td></td>
- <td>Sets the id attribute for the rendered <input> element.</td>
+ <td>Sets the id attribute for the rendered <code><input></code> element.</td>
+ </tr>
+
+ <tr>
+ <td>validators</td>
+ <td>
+ Array or collection of
+ <a
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/form/validator/Validator.html">
+ Validator
+ </a>
+ </td>
+ <td>no</td>
+ <td></td>
+ <td>
+ The validators to apply to the component. Something along the lines of:
+ <code>validators:required</code> .<br/><br/>
+
+ <strong>See also:</strong> <a href="../../UsersGuide/validation.html">Validation</a>
+ </td>
</tr>
+ <tr>
+ <td>translator</td>
+ <td>
+ <a
+ href="../../tapestry/apidocs/org/apache/tapestry/form/translator/Translator.html">
+ Translator
+ </a>
+ </td>
+ <td>no</td>
+ <td></td>
+ <td>
+ The translator to use when displaying and parsing the date.
+ <br/><br/>
+ <strong>See also:</strong> <a href="../../UsersGuide/validation.html">Validation</a>
+ </td>
+ </tr>
</table>
<p>
Copied: tapestry/tapestry4/trunk/src/site/xdoc/components/form/DatePicker.xml (from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/DatePicker.xml)
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/form/DatePicker.xml?view=diff&rev=463527&p1=tapestry/tapestry4/trunk/src/site/xdoc/components/DatePicker.xml&r1=454604&p2=tapestry/tapestry4/trunk/src/site/xdoc/components/form/DatePicker.xml&r2=463527
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/DatePicker.xml (original)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/form/DatePicker.xml Thu Oct 12 17:28:41 2006
@@ -32,9 +32,10 @@
</p>
<p>
Note a rendering feature of Netscape and Internet Explorer gives the HTML
- <select> element the highest Z-level index. The HTML <select> cannot be
- covered by other elements. If a <select> is located inside the DatePicker's
- popup calendar region, the <select> will render through the popup calendar
+ <code><select></code> element the highest Z-level index. The HTML
+ <code><select></code> cannot be
+ covered by other elements. If a <code><select></code> is located inside the DatePicker's
+ popup calendar region, the <code><select></code> will render through the popup calendar
obscuring part of the calendar. In these situation organize the form's UI layout so
this does not occur.
</p>
@@ -54,7 +55,6 @@
<tr>
<th>Name</th>
<th>Type</th>
- <th>Direction</th>
<th>Required</th>
<th>Default</th>
<th>Description</th>
@@ -62,7 +62,6 @@
<tr>
<td>value</td>
<td>java.util.Date</td>
- <td>in</td>
<td>yes</td>
<td></td>
<td>
@@ -74,7 +73,6 @@
<tr>
<td>disabled</td>
<td>boolean</td>
- <td>in</td>
<td>no</td>
<td>false</td>
<td>
@@ -85,7 +83,6 @@
<tr>
<td>displayName</td>
<td>String</td>
- <td>in</td>
<td>no</td>
<td></td>
<td>
@@ -100,19 +97,18 @@
<td>
Array or collection of
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/form/validator/Validator.html">
- Validator
- </a>
- , or
- <a
- href="../tapestry-framework/apidocs/org/apache/tapestry/form/validator/Validator.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/form/validator/Validator.html">
Validator
</a>
</td>
- <td>in</td>
<td>no</td>
<td></td>
- <td>The validators to apply to the component.</td>
+ <td>
+ The validators to apply to the component. Something along the lines of:
+ <code>validators:required</code> .<br/><br/>
+
+ <strong>See also:</strong> <a href="../../UsersGuide/validation.html">Validation</a>
+ </td>
</tr>
<tr>
@@ -123,20 +119,22 @@
Translator
</a>
</td>
- <td>in</td>
<td>no</td>
<td>translator:date,pattern=dd MMM yyyy</td>
- <td>The translator to use when displaying and parsing the date.</td>
+ <td>
+ The translator to use when displaying and parsing the date.
+ <br/><br/>
+ <strong>See also:</strong> <a href="../../UsersGuide/validation.html">Validation</a>
+ </td>
</tr>
<tr>
<td>icon</td>
<td>
- <a href="../tapestry-framework/apidocs/org/apache/tapestry/IAsset.html">
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/IAsset.html">
IAsset
</a>
</td>
- <td>in</td>
<td>no</td>
<td></td>
<td>
@@ -148,16 +146,14 @@
<tr>
<td>id</td>
<td>String</td>
- <td>in</td>
<td>no</td>
<td></td>
- <td>Sets the id attribute for the rendered <input> element.</td>
+ <td>Sets the id attribute for the rendered <code><input></code> element.</td>
</tr>
<tr>
<td>includeWeek</td>
<td>boolean</td>
- <td>in</td>
<td>no</td>
<td></td>
<td>If true, displays in the calendar the week number for each week.</td>
Copied: tapestry/tapestry4/trunk/src/site/xdoc/components/form/FieldLabel.xml (from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/FieldLabel.xml)
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/form/FieldLabel.xml?view=diff&rev=463527&p1=tapestry/tapestry4/trunk/src/site/xdoc/components/FieldLabel.xml&r1=454604&p2=tapestry/tapestry4/trunk/src/site/xdoc/components/form/FieldLabel.xml&r2=463527
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/FieldLabel.xml (original)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/form/FieldLabel.xml Thu Oct 12 17:28:41 2006
@@ -45,14 +45,11 @@
<p>
<strong>
See also:
- <a href="../tapestry-framework/apidocs/org/apache/tapestry/valid/FieldLabel.html">
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/valid/FieldLabel.html">
org.apache.tapestry.valid.FieldLabel
</a>
,
- <a
- href="../tapestry-framework/apidocs/org/apache/tapestry/valid/IValidationDelegate.html">
- IValidationDelegate
- </a>
+ <a href="../../UsersGuide/validation.html">Validation</a>
</strong>
</p>
@@ -63,7 +60,6 @@
<tr>
<th>Name</th>
<th>Type</th>
- <th>Direction</th>
<th>Required</th>
<th>Default</th>
<th>Description</th>
@@ -73,11 +69,10 @@
<td>field</td>
<td>
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/form/IFormComponent.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/form/IFormComponent.html">
IFormComponent
</a>
</td>
- <td>in</td>
<td>yes</td>
<td></td>
<td>
@@ -91,7 +86,6 @@
<tr>
<td>displayName</td>
<td>String</td>
- <td>in</td>
<td>no</td>
<td></td>
<td>
@@ -106,7 +100,6 @@
<tr>
<td>raw</td>
<td>boolean</td>
- <td>in</td>
<td>no</td>
<td>false</td>
<td>
@@ -118,7 +111,6 @@
<tr>
<td>prerender</td>
<td>boolean</td>
- <td>in</td>
<td>no</td>
<td>true</td>
<td>
Copied: tapestry/tapestry4/trunk/src/site/xdoc/components/form/Form.xml (from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Form.xml)
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/form/Form.xml?view=diff&rev=463527&p1=tapestry/tapestry4/trunk/src/site/xdoc/components/Form.xml&r1=454604&p2=tapestry/tapestry4/trunk/src/site/xdoc/components/form/Form.xml&r2=463527
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/Form.xml (original)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/form/Form.xml Thu Oct 12 17:28:41 2006
@@ -38,14 +38,11 @@
<p>
<strong>
See also:
- <a href="../tapestry-framework/apidocs/org/apache/tapestry/form/Form.html">
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/form/Form.html">
org.apache.tapestry.form.Form
</a>
,
- <a
- href="../tapestry-framework/apidocs/org/apache/tapestry/valid/IValidationDelegate.html">
- IValidationDelegate
- </a>
+ <a href="../../UsersGuide/validation.html">Validation</a>
</strong>
</p>
<section name="Parameters">
@@ -54,7 +51,6 @@
<tr>
<th>Name</th>
<th>Type</th>
- <th>Direction</th>
<th>Required</th>
<th>Default</th>
<th>Description</th>
@@ -62,7 +58,6 @@
<tr>
<td>method</td>
<td>string</td>
- <td>in</td>
<td>no</td>
<td>post</td>
<td>Method used by the form when it is submitted.</td>
@@ -71,13 +66,12 @@
<td>success</td>
<td>
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/IActionListener.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/IActionListener.html">
IActionListener
</a>
</td>
- <td>in</td>
<td>no</td>
- <td />
+ <td></td>
<td>
Listener invoked when the form is submitted normally (not a cancel or a
refresh) and the validation delegate indicates no errors. If the
@@ -89,53 +83,57 @@
<td>cancel</td>
<td>
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/IActionListener.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/IActionListener.html">
IActionListener
</a>
</td>
- <td>in</td>
<td>no</td>
- <td />
+ <td></td>
<td>
Listener used when a form is cancelled, overriding the default listener.
Forms are cancelled by invoking the client-side JavaScript function
- document.
- <em>form-name</em>
- .events.cancel(). A cancelled form
- <em>does not</em>
- rewind. If no cancel listener is provided, then the normal listener will
- be used.
+ document.<br/><br/>
+
+ <code>tapestry.form.cancel(formId || form element, submitName)</code>
+
+ <br/>
+ A cancelled form <em>does not</em> rewind. If no cancel listener is
+ provided, then the normal listener will be used.
+
+ <br/><br/>
+ <strong>See also:</strong> <a href="../../javascript/form.html">Form JavaScript API</a>
</td>
</tr>
<tr>
<td>refresh</td>
<td>
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/IActionListener.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/IActionListener.html">
IActionListener
</a>
</td>
- <td>in</td>
<td>no</td>
- <td />
+ <td></td>
<td>
Listener used when a form is refreshed, overriding the default listener.
A refreshed form bypasses input field validation on the client side,
though validation still occurs on the server side. If no refresh
listener is provided, then the normal listener will be used.
+
+ <br/><br/>
+ <strong>See also:</strong> <a href="../../javascript/form.html">Form JavaScript API</a>
</td>
</tr>
<tr>
<td>listener</td>
<td>
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/IActionListener.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/IActionListener.html">
IActionListener
</a>
</td>
- <td>in</td>
<td>no</td>
- <td />
+ <td></td>
<td>
Default listener to be invoked when the form is submitted. Invoked only
if another listener (success, cancel or refresh) is not invoked.
@@ -144,7 +142,6 @@
<tr>
<td>stateful</td>
<td>boolean</td>
- <td>in</td>
<td>no</td>
<td>true</td>
<td>
@@ -156,11 +153,10 @@
<td>delegate</td>
<td>
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/valid/IValidationDelegate.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/valid/IValidationDelegate.html">
IValidationDelegate
</a>
</td>
- <td>in</td>
<td>no</td>
<td>default instance</td>
<td>
@@ -172,7 +168,6 @@
<tr>
<td>clientValidationEnabled</td>
<td>boolean</td>
- <td>in</td>
<td>no</td>
<td>false</td>
<td>
@@ -180,12 +175,13 @@
support it (such as
<a href="TextField.html">TextField</a>
).
+ <br/><br/>
+ <strong>See also:</strong> <a href="../../UsersGuide/clientside-validation.html">Client Side Validation</a>
</td>
</tr>
<tr>
<td>focus</td>
<td>boolean</td>
- <td>in</td>
<td>no</td>
<td>true</td>
<td>
@@ -199,7 +195,6 @@
<tr>
<td>scheme</td>
<td>String</td>
- <td>in</td>
<td>no</td>
<td />
<td>
@@ -214,23 +209,21 @@
<tr>
<td>port</td>
<td>Integer</td>
- <td>in</td>
<td>no</td>
<td />
<td>
The required port (80, 443, 8080. 8443, typically) for the URL. This
will force the creation of an absolute URL when the current request's
scheme does not match the value for this parameter. This is most often
- used in conjunction with scheme to switch to "https:443"/"https:8443"
+ used in conjunction with scheme to switch to <code>"https:443"/"https:8443"</code>
for secure portions of an application (such as a login page), before
- switching back to standard "http:80"/"http:80" for the majority of an
+ switching back to standard <code>"http:80"/"http:80"</code> for the majority of an
application.
</td>
</tr>
<tr>
<td>updateComponents</td>
<td>String[],Collection</td>
- <td>in</td>
<td>no</td>
<td></td>
<td>
@@ -238,32 +231,39 @@
rendered back to the client. These are expected to be unique component ids.
<p>
- See: <a href="../tapestry-framework/apidocs/org/apache/tapestry/services/ResponseBuilder.html">ResponseBuilder</a>
+ See: <a href="../../tapestry-framework/apidocs/org/apache/tapestry/services/ResponseBuilder.html">ResponseBuilder</a>
</p>
+
+ <br/>
+ <strong>See also:</strong> <a href="../../ajax/index.html">Ajax Features</a>
</td>
</tr>
<tr>
<td>json</td>
<td>boolean</td>
- <td>in</td>
<td>no</td>
<td>false</td>
<td>
Causes the request to be asynchronous and the response to be captured/rendered via
- the <a href="../tapestry-framework/apidocs/org/apache/tapestry/services/impl/JSONResponseBuilder.html">JSONResponseBuilder</a>
+ the <a href="../../tapestry-framework/apidocs/org/apache/tapestry/services/impl/JSONResponseBuilder.html">JSONResponseBuilder</a>
renderer.
+
+ <br/><br/>
+ <strong>See also:</strong> <a href="../../ajax/index.html">Ajax Features</a>
</td>
</tr>
<tr>
<td>async</td>
<td>boolean</td>
- <td>in</td>
<td>no</td>
<td>false</td>
<td>
Causes the request to be asynchronous and the response to be captured/rendered via
- the <a href="../tapestry-framework/apidocs/org/apache/tapestry/services/impl/DojoAjaxResponseBuilder.html">DojoAjaxResponseBuilder</a>
+ the <a href="../../tapestry-framework/apidocs/org/apache/tapestry/services/impl/DojoAjaxResponseBuilder.html">DojoAjaxResponseBuilder</a>
renderer.
+
+ <br/><br/>
+ <strong>See also:</strong> <a href="../../ajax/index.html">Ajax Features</a>
</td>
</tr>
</table>
Copied: tapestry/tapestry4/trunk/src/site/xdoc/components/form/Hidden.xml (from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Hidden.xml)
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/form/Hidden.xml?view=diff&rev=463527&p1=tapestry/tapestry4/trunk/src/site/xdoc/components/Hidden.xml&r1=454604&p2=tapestry/tapestry4/trunk/src/site/xdoc/components/form/Hidden.xml&r2=463527
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/Hidden.xml (original)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/form/Hidden.xml Thu Oct 12 17:28:41 2006
@@ -23,7 +23,7 @@
<section name="Hidden">
<p>
- Adds a hidden HTML <input type="hidden"> field to a
+ Adds a hidden HTML <code><input type="hidden"></code> field to a
<a href="Form.html">Form</a>
. This is often used to synchronize data when the form is submitted with values
known when the page was rendered.
@@ -43,7 +43,6 @@
<tr>
<th>Name</th>
<th>Type</th>
- <th>Direction</th>
<th>Required</th>
<th>Default</th>
<th>Description</th>
@@ -51,16 +50,14 @@
<tr>
<td>value</td>
<td>Object</td>
-
- <td>in/out</td>
<td>yes</td>
- <td />
+ <td></td>
<td>
The value to be stored in the the hidden field. The parameter is read
when the HTML response is generated, and then written when the form is
submitted. A
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/util/io/DataSqueezer.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/util/io/DataSqueezer.html">
DataSqueezer
</a>
is used to convert the value between an arbitrary type and a String.
@@ -70,7 +67,6 @@
<tr>
<td>id</td>
<td>Object</td>
- <td>in</td>
<td>no</td>
<td>undefined in HTML presentation.</td>
<td>
@@ -83,14 +79,12 @@
<td>listener</td>
<td>
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/IActionListener.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/IActionListener.html">
IActionListener
</a>
</td>
-
- <td>in</td>
<td>no</td>
- <td />
+ <td></td>
<td>
<p>
A listener that is informed after the value parameter is updated.
@@ -108,16 +102,14 @@
</tr>
<tr>
<td>encode</td>
-
<td>boolean</td>
- <td>in</td>
<td>no</td>
<td>true</td>
<td>
<p>
If true (the default) a
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/util/io/DataSqueezer.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/util/io/DataSqueezer.html">
DataSqueezer
</a>
is used to transform the value Object into the HTML value string,
@@ -129,7 +121,7 @@
in JavaScript (which is not able to interpret even Strings encoded
by
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/util/io/DataSqueezer.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/util/io/DataSqueezer.html">
DataSqueezer
</a>
). If you find yourself getting strange errors during the form
Copied: tapestry/tapestry4/trunk/src/site/xdoc/components/form/ImageSubmit.xml (from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/ImageSubmit.xml)
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/form/ImageSubmit.xml?view=diff&rev=463527&p1=tapestry/tapestry4/trunk/src/site/xdoc/components/ImageSubmit.xml&r1=454604&p2=tapestry/tapestry4/trunk/src/site/xdoc/components/form/ImageSubmit.xml&r2=463527
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/ImageSubmit.xml (original)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/form/ImageSubmit.xml Thu Oct 12 17:28:41 2006
@@ -24,8 +24,8 @@
<p>
A component that generates a clickable image that will cause the enclosing form to
- submit. The <input type="image"> form element was originally designed for use
- as a way to select a pixel within an image that was presumable a map; it has been
+ submit. The <code><input type="image"></code> form element was originally designed
+ for use as a way to select a pixel within an image that was presumable a map; it has been
co-opted by web applications as a way to decorate a form submit button using a
custom image instead of ordinary clickable buttons. This component is simply an
enhanced version of the
@@ -36,7 +36,7 @@
<p>
<strong>
See also:
- <a href="../tapestry-framework/apidocs/org/apache/tapestry/form/ImageSubmit.html">
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/form/ImageSubmit.html">
org.apache.tapestry.form.ImageSubmit
</a>
,
@@ -55,7 +55,6 @@
<tr>
<th>Name</th>
<th>Type</th>
- <th>Direction</th>
<th>Required</th>
<th>Default</th>
<th>Description</th>
@@ -64,11 +63,10 @@
<tr>
<td>image</td>
<td>
- <a href="../tapestry-framework/apidocs/org/apache/tapestry/IAsset.html">
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/IAsset.html">
IAsset
</a>
</td>
- <td>in</td>
<td>yes</td>
<td></td>
<td>The normal image to display for the button.</td>
@@ -77,12 +75,11 @@
<tr>
<td>name</td>
<td>String</td>
- <td>in</td>
<td>no</td>
<td></td>
<td>
Overrides the default mechanism for selecting the form element id; this
- allows the name attribute of the rendered <input> tag to be
+ allows the name attribute of the rendered <code><input></code> tag to be
controlled, which is necessary is some browsers to control the tooltip
help message for the control.
</td>
@@ -91,7 +88,6 @@
<tr>
<td>disabled</td>
<td>boolean</td>
- <td>in</td>
<td>no</td>
<td>false</td>
<td>
@@ -103,11 +99,10 @@
<tr>
<td>disabledImage</td>
<td>
- <a href="../tapestry-framework/apidocs/org/apache/tapestry/IAsset.html">
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/IAsset.html">
IAsset
</a>
</td>
- <td>in</td>
<td>no</td>
<td></td>
<td>
@@ -120,7 +115,6 @@
<tr>
<td>point</td>
<td>java.awt.Point</td>
- <td>out</td>
<td>no</td>
<td></td>
<td>Set to the coordinates of the clicked point within the image.</td>
@@ -129,7 +123,6 @@
<tr>
<td>selected</td>
<td>Object</td>
- <td>out</td>
<td>no</td>
<td></td>
<td>
@@ -141,7 +134,6 @@
<tr>
<td>tag</td>
<td>Object</td>
- <td>in</td>
<td>no</td>
<td></td>
<td>
@@ -154,11 +146,10 @@
<td>listener</td>
<td>
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/IActionListener.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/IActionListener.html">
IActionListener
</a>
</td>
- <td>in</td>
<td>no</td>
<td></td>
<td>
@@ -166,7 +157,7 @@
method), notified when the Submit is triggered.
<p>
- When invoking listeners invoked within a <a href="For.html">For</a> loop this
+ When invoking listeners invoked within a <a href="../general/For.html">For</a> loop this
listener should be used.
</p>
@@ -183,11 +174,10 @@
<td>action</td>
<td>
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/IActionListener.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/IActionListener.html">
IActionListener
</a>
</td>
- <td>in</td>
<td>no</td>
<td></td>
<td>
@@ -204,7 +194,6 @@
<tr>
<td>parameters</td>
<td>Object</td>
- <td>in</td>
<td>no</td>
<td></td>
<td>
@@ -225,15 +214,15 @@
<tr>
<td>submitType</td>
<td>String - [submit,cancel,refresh]</td>
- <td></td>
<td>yes</td>
<td>submit</td>
<td>
Controls the type of submission that this component invokes. Using javascript
this parameter will cause the invocation of the component to be recognized as
a cancel/refresh/normal form submission depending on the value given. If you
- have a cancel="listener" or refresh="listener" parameter set on your
- <a href="Form.html">Form</a> they will be invoked accordingly.
+ have a <code>cancel="listener"</code> or <code>refresh="listener"</code>
+ parameter set on your <a href="Form.html">Form</a> they will be invoked
+ accordingly.
</td>
</tr>
<tr>
@@ -246,8 +235,11 @@
rendered back to the client. These are expected to be unique component ids.
<p>
- See: <a href="../tapestry-framework/apidocs/org/apache/tapestry/services/ResponseBuilder.html">ResponseBuilder</a>
+ See: <a href="../../tapestry-framework/apidocs/org/apache/tapestry/services/ResponseBuilder.html">ResponseBuilder</a>
</p>
+
+ <br/>
+ <strong>See also:</strong> <a href="../../ajax/index.html">Ajax Features</a>
</td>
</tr>
<tr>
@@ -257,8 +249,11 @@
<td>false</td>
<td>
Causes the request to be asynchronous and the response to be captured/rendered via
- the <a href="../tapestry-framework/apidocs/org/apache/tapestry/services/impl/JSONResponseBuilder.html">JSONResponseBuilder</a>
+ the <a href="../../tapestry-framework/apidocs/org/apache/tapestry/services/impl/JSONResponseBuilder.html">JSONResponseBuilder</a>
renderer.
+
+ <br/><br/>
+ <strong>See also:</strong> <a href="../../ajax/index.html">Ajax Features</a>
</td>
</tr>
<tr>
@@ -268,8 +263,11 @@
<td>false</td>
<td>
Causes the request to be asynchronous and the response to be captured/rendered via
- the <a href="../tapestry-framework/apidocs/org/apache/tapestry/services/impl/DojoAjaxResponseBuilder.html">DojoAjaxResponseBuilder</a>
+ the <a href="../../tapestry-framework/apidocs/org/apache/tapestry/services/impl/DojoAjaxResponseBuilder.html">DojoAjaxResponseBuilder</a>
renderer.
+
+ <br/><br/>
+ <strong>See also:</strong> <a href="../../ajax/index.html">Ajax Features</a>
</td>
</tr>
</table>
@@ -302,7 +300,6 @@
</p>
</span>
-
</section>
<section name="Examples">
@@ -331,9 +328,8 @@
</form></source>
<p>Page specification:</p>
-
<source xml:space="preserve">
-
+
. . .
<asset name="help" path="images/help.png"/>
Added: tapestry/tapestry4/trunk/src/site/xdoc/components/form/LinkSubmit.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/form/LinkSubmit.xml?view=auto&rev=463527
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/form/LinkSubmit.xml (added)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/form/LinkSubmit.xml Thu Oct 12 17:28:41 2006
@@ -0,0 +1,240 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ Copyright 2004, 2005 The Apache Software Foundation
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<document>
+ <properties>
+ <title>LinkSubmit</title>
+ </properties>
+ <body>
+
+ <section name="LinkSubmit">
+
+ <p>
+ Creates a hyperlink that submits its enclosing form using a JavaScript function.
+ <br />
+ Pages incorporating a LinkSubmit component must also include a
+ <a href="Body.html">Body</a>
+ component.
+ </p>
+
+ <p>
+ <strong>
+ See also:
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/form/LinkSubmit.html">
+ org.apache.tapestry.form.LinkSubmit
+ </a>
+ ,
+ <a href="Form.html">Form</a>
+ ,
+ <a href="ImageSubmit.html">ImageSubmit</a>
+ ,
+ <a href="Submit.html">Submit</a>
+ </strong>
+ </p>
+
+ <section name="Parameters">
+
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Required</th>
+ <th>Default</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>disabled</td>
+ <td>boolean</td>
+ <td>no</td>
+ <td>false</td>
+ <td>
+ Controls whether the link is produced. If disabled, the portion of the
+ template the link surrounds is still rendered, but not the link itself.
+ </td>
+ </tr>
+ <tr>
+ <td>selected</td>
+ <td>Object</td>
+ <td>no</td>
+ <td></td>
+ <td>
+ This parameter is bound to a property that is updated when the submit
+ button is clicked by the user. The property is updated to match the tag
+ parameter.
+ </td>
+ </tr>
+ <tr>
+ <td>tag</td>
+ <td>Object</td>
+ <td>no</td>
+ <td></td>
+ <td>
+ Tag used with the selected parameter to indicate which Submit button on
+ a form was clicked.
+ </td>
+ </tr>
+ <tr>
+ <td>listener</td>
+ <td>
+ <a
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/IActionListener.html">
+ IActionListener
+ </a>
+ </td>
+ <td>no</td>
+ <td></td>
+ <td>
+ An optional listener (typically specified as the name of a listener
+ method), notified when the Submit is triggered.
+
+ <p>
+ When invoking listeners invoked within a <a href="../general/For.html">For</a> loop this
+ listener should be used.
+ </p>
+
+ <p>
+ This parameter should <strong>not</strong> be used in the majority of cases as the
+ listener is notified before all form data has been captured on the server. Only use
+ this when you know you are going to redirect or do some other cancelling sort of action
+ that isn't likely to alter form state. Use <em>action</em> as your preferred listener
+ method parameter.
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td>action</td>
+ <td>
+ <a
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/IActionListener.html">
+ IActionListener
+ </a>
+ </td>
+ <td>no</td>
+ <td></td>
+ <td>
+ A listener that is notified if this component is triggered just before
+ the form's listener, after all components enclosed by the Form have had
+ a chance to update their properties.
+
+ <p>
+ If you are going to notify a listener, this is probably the parameter you want
+ to bind to.
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td>parameters</td>
+ <td>Object</td>
+ <td>no</td>
+ <td></td>
+ <td>
+ Parameter(s) gathered at the time the link is triggered, supplied as
+ listener parameters in the IRequestCycle available to the listener.
+ <p>
+ If the parameter is a Collection, it will be converted to an Object
+ array (to match the IRequestCycle getListenerParameters()
+ signature).
+ </p>
+ <p>
+ Allows deferred listeners (defer = true) access to any rewind state
+ not conveniently placed using tag/selected (e.g. when there are
+ multiple objects to select as might happen with a nested Foreach).
+ </p>
+ </td>
+ </tr>
+ <tr>
+ <td>submitType</td>
+ <td>String - [submit,cancel,refresh]</td>
+ <td>yes</td>
+ <td>submit</td>
+ <td>
+ Controls the type of submission that this component invokes. Using javascript
+ this parameter will cause the invocation of the component to be recognized as
+ a cancel/refresh/normal form submission depending on the value given. If you
+ have a <code>cancel="listener"</code> or <code>refresh="listener"</code>
+ parameter set on your <a href="Form.html">Form</a> they will be invoked
+ accordingly.
+ </td>
+ </tr>
+ <tr>
+ <td>updateComponents</td>
+ <td>String[],Collection</td>
+ <td>no</td>
+ <td></td>
+ <td>
+ In an asynchronous request, specifies which components should have their content
+ rendered back to the client. These are expected to be unique component ids.
+
+ <p>
+ See: <a href="../../tapestry-framework/apidocs/org/apache/tapestry/services/ResponseBuilder.html">ResponseBuilder</a>
+ </p>
+
+ <br/>
+ <strong>See also:</strong> <a href="../../ajax/index.html">Ajax Features</a>
+ </td>
+ </tr>
+ <tr>
+ <td>json</td>
+ <td>boolean</td>
+ <td>no</td>
+ <td>false</td>
+ <td>
+ Causes the request to be asynchronous and the response to be captured/rendered via
+ the <a href="../../tapestry-framework/apidocs/org/apache/tapestry/services/impl/JSONResponseBuilder.html">JSONResponseBuilder</a>
+ renderer.
+
+ <br/><br/>
+ <strong>See also:</strong> <a href="../../ajax/index.html">Ajax Features</a>
+ </td>
+ </tr>
+ <tr>
+ <td>async</td>
+ <td>boolean</td>
+ <td>no</td>
+ <td>false</td>
+ <td>
+ Causes the request to be asynchronous and the response to be captured/rendered via
+ the <a href="../../tapestry-framework/apidocs/org/apache/tapestry/services/impl/DojoAjaxResponseBuilder.html">DojoAjaxResponseBuilder</a>
+ renderer.
+
+ <br/><br/>
+ <strong>See also:</strong> <a href="../../ajax/index.html">Ajax Features</a>
+ </td>
+ </tr>
+ </table>
+
+ <p>
+ Body:
+ <strong>allowed</strong>
+ </p>
+
+ <p>
+ Informal parameters:
+ <strong>allowed</strong>
+ </p>
+
+ <p>
+ Reserved parameters:
+ <em>name, href</em>
+ </p>
+
+ </section>
+
+ </section>
+
+ </body>
+</document>
Propchange: tapestry/tapestry4/trunk/src/site/xdoc/components/form/LinkSubmit.xml
------------------------------------------------------------------------------
svn:eol-style = native
Copied: tapestry/tapestry4/trunk/src/site/xdoc/components/form/Option.xml (from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/Option.xml)
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/form/Option.xml?view=diff&rev=463527&p1=tapestry/tapestry4/trunk/src/site/xdoc/components/Option.xml&r1=454604&p2=tapestry/tapestry4/trunk/src/site/xdoc/components/form/Option.xml&r2=463527
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/Option.xml (original)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/form/Option.xml Thu Oct 12 17:28:41 2006
@@ -23,9 +23,9 @@
<section name="Option">
<p>
- A component that renders an HTML <option> form element. The Option component
- must be wrapped by a
- <a href="Select.html">Select</a>
+ A component that renders an HTML <code><option></code> form element.
+
+ The Option component must be wrapped by a <a href="Select.html">Select</a>
component. For a fully worked example showing the Option component, please refer to
the
<a href="Select.html">Select</a>
@@ -35,7 +35,7 @@
<p>
<strong>
See also:
- <a href="../tapestry-framework/apidocs/org/apache/tapestry/form/Option.html">
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/form/Option.html">
org.apache.tapestry.form.Option
</a>
,
@@ -54,7 +54,6 @@
<tr>
<th>Name</th>
<th>Type</th>
- <th>Direction</th>
<th>Required</th>
<th>Default</th>
<th>Description</th>
@@ -62,7 +61,6 @@
<tr>
<td>selected</td>
<td>boolean</td>
- <td>in-out</td>
<td>yes</td>
<td />
<td>Used to indicate whether the given option is selected.</td>
@@ -70,14 +68,13 @@
<tr>
<td>label</td>
<td>String</td>
- <td>in</td>
<td>no</td>
<td />
<td>
A string which represents the option that may be selected. This is
- optional; any text that follows the <option> tag is considered the
+ optional; any text that follows the <code><option></code> tag is considered the
label, but this saves the designer from have to include one more
- <a href="Insert.html">Insert</a>
+ <a href="../general/Insert.html">Insert</a>
component to display the option label.
</td>
</tr>
@@ -98,8 +95,6 @@
</section>
<section name="Examples">
-
-
<p>
Please see the documentation for the
<a href="Select.html">Select</a>
Copied: tapestry/tapestry4/trunk/src/site/xdoc/components/form/PropertySelection.xml (from r454604, tapestry/tapestry4/trunk/src/site/xdoc/components/PropertySelection.xml)
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/form/PropertySelection.xml?view=diff&rev=463527&p1=tapestry/tapestry4/trunk/src/site/xdoc/components/PropertySelection.xml&r1=454604&p2=tapestry/tapestry4/trunk/src/site/xdoc/components/form/PropertySelection.xml&r2=463527
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/PropertySelection.xml (original)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/form/PropertySelection.xml Thu Oct 12 17:28:41 2006
@@ -29,7 +29,7 @@
<p>
Uses a
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/form/IPropertySelectionModel.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/form/IPropertySelectionModel.html">
IPropertySelectionModel
</a>
to map between Java values that will be assigned, and textual labels that will
@@ -38,8 +38,12 @@
<p>
A useful property selection model is available (
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/form/StringPropertySelectionModel.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/form/StringPropertySelectionModel.html">
StringPropertySelectionModel
+ </a> , or
+ <a
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/form/BeanPropertySelectionModel.html">
+ BeanPropertySelectionModel
</a>
). You can also create your own model, as illustrated in the examples below.
</p>
@@ -50,8 +54,8 @@
</p>
<p>
- Informal parameters are applied to the <select> tag. To have greater control
- over the <option> tags, you must use the
+ Informal parameters are applied to the <code><select></code> tag. To have greater control
+ over the <code><option></code> tags, you must use the
<a href="Select.html">Select</a>
and
<a href="Option.html">Option</a>
@@ -62,7 +66,7 @@
<strong>
See also:
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/form/PropertySelection.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/form/PropertySelection.html">
org.apache.tapestry.form.PropertySelection
</a>
,
@@ -76,7 +80,7 @@
,
<a href="Form.html">Form</a>
,
- <a href="Script.html">Script</a>
+ <a href="../general/Script.html">Script</a>
</strong>
</p>
@@ -88,8 +92,6 @@
<tr>
<th>Name</th>
<th>Type</th>
- <th>Direction</th>
-
<th>Required</th>
<th>Default</th>
<th>Description</th>
@@ -97,10 +99,8 @@
<tr>
<td>value</td>
<td>Object</td>
-
- <td>in-out</td>
<td>yes</td>
- <td />
+ <td></td>
<td>
The property to set. During rendering, this property is read, and sets
the default value of the selection (if it is null, no element is
@@ -113,13 +113,12 @@
<td>model</td>
<td>
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/form/IPropertySelectionModel.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/form/IPropertySelectionModel.html">
IPropertySelectionModel
</a>
</td>
- <td>in</td>
<td>yes</td>
- <td />
+ <td></td>
<td>
The model provides a list of possible labels, and matches those labels
against possible values that can be assigned back to the property.
@@ -129,12 +128,10 @@
<tr>
<td>disabled</td>
<td>boolean</td>
- <td>in</td>
<td>no</td>
<td>false</td>
-
<td>
- Controls whether the <select> is active or not. A disabled
+ Controls whether the <code><select></code> is active or not. A disabled
PropertySelection does not update its value parameter. Corresponds to
the "disabled" HTML attribute.
</td>
@@ -142,8 +139,6 @@
<tr>
<td>submitOnChange (deprecated)</td>
<td>boolean</td>
-
- <td>in</td>
<td>no</td>
<td>false</td>
<td>
@@ -158,13 +153,12 @@
<tr>
<td>displayName</td>
<td>String</td>
- <td>in</td>
<td>no</td>
- <td />
+ <td></td>
<td>
The user-presentable name for the component, which will be used by a
- <a href="site:FieldLabel">FieldLabel</a>
+ <a href="FieldLabel">FieldLabel</a>
connected to the component.
</td>
</tr>
@@ -173,31 +167,44 @@
<td>
Array or collection of
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/form/validator/Validator.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/form/validator/Validator.html">
Validator
</a>
- , or
+ </td>
+ <td>no</td>
+ <td></td>
+ <td>
+ The validators to apply to the component. Something along the lines of:
+ <code>validators:required</code> .<br/><br/>
+
+ <strong>See also:</strong> <a href="../../UsersGuide/validation.html">Validation</a>
+ </td>
+ </tr>
+
+ <tr>
+ <td>translator</td>
+ <td>
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/form/validator/Validator.html">
- Validator
+ href="../../tapestry/apidocs/org/apache/tapestry/form/translator/Translator.html">
+ Translator
</a>
</td>
- <td>in</td>
-
<td>no</td>
- <td />
- <td>The validators to apply to the component.</td>
+ <td></td>
+ <td>
+ The translator to use when displaying and parsing the date.
+ <br/><br/>
+ <strong>See also:</strong> <a href="../../UsersGuide/validation.html">Validation</a>
+ </td>
</tr>
<tr>
<td>id</td>
-
<td>String</td>
- <td>in</td>
<td>no</td>
- <td />
+ <td></td>
<td>
The value of the id attribute in the generated
- <em><select></em>
+ <code><select></code>
tag.
</td>
@@ -222,16 +229,12 @@
</section>
<section name="Examples">
-
-
<subsection name="Example 1">
-
-
<p>
The PropertySelection component provides Gender selection drop down list
using a
<a
- href="../tapestry-framework/apidocs/org/apache/tapestry/form/StringPropertySelectionModel.html">
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/form/StringPropertySelectionModel.html">
StringPropertySelectionModel
</a>
</p>