Author: hlship
Date: Wed Aug 31 11:54:54 2005
New Revision: 265550
URL: http://svn.apache.org/viewcvs?rev=265550&view=rev
Log:
TAPESTRY-477, TAPESTRY-463: Document RadioGroup, ExternalLink components.
Removed:
jakarta/tapestry/trunk/doc/src/ComponentReference/ExternalLink.html
jakarta/tapestry/trunk/doc/src/ComponentReference/Radio.html
Modified:
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/ExternalLink.xml
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Radio.xml
jakarta/tapestry/trunk/status.xml
Modified:
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/ExternalLink.xml
URL:
http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/ExternalLink.xml?rev=265550&r1=265549&r2=265550&view=diff
==============================================================================
---
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/ExternalLink.xml
(original)
+++
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/ExternalLink.xml
Wed Aug 31 11:54:54 2005
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<!--
- Copyright 2004, 2005 The Apache Software Foundation
+ Copyright 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.
@@ -27,12 +27,11 @@
</header>
<body>
-
-<p> <strong>THIS PAGE UNDER CONSTRUCTION</strong>
-</p>
+
+ <p>Creates a <a> hyperlink to an <link
href="&apiroot;/IExternalPage.html">IExternalPage</link> which may be
bookmarked using the hyperlink's URL.</p>
<p>
- <strong>See also:</strong>
+ <strong>See also: <link
href="&apiroot;/link/ExternalLink.html">org.apache.tapestry.link.ExternalLink</link>,
&DirectLink;, &GenericLink;, &PageLink;, &ServiceLink;</strong>
</p>
<section>
@@ -42,30 +41,130 @@
<tr>
<th>Name</th>
<th>Type</th>
- <th>Direction</th>
+ <th>Direction</th>
<th>Required</th>
<th>Default</th>
<th>Description</th>
</tr>
-
- </table>
+ <tr>
+ <td>page</td>
+ <td>String</td>
+ <td>in</td>
+ <td>yes</td>
+ <td></td>
+ <td>
+ The name of a application page to link to.
+ </td>
+ </tr>
+ <tr>
+ <td>parameters</td>
+ <td>Object or Object[] or List</td>
+ <td>in</td>
+ <td>no</td>
+ <td></td>
+ <td>
+ An array of objects to be encoded into the URL. These parameters will
be passed to IExternalPage.activateExternalPage() method.
+ </td>
+ </tr>
+ <tr>
+ <td>disabled</td>
+ <td>boolean</td>
+ <td>in</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>anchor</td>
+ <td>String</td>
+ <td>in</td>
+ <td>no</td>
+ <td></td>
+ <td>
+ The name of an anchor or element to link to. The final URL will have
'#' and the anchor appended to it.
+ </td>
+ </tr>
+ <tr>
+ <td>target</td>
+ <td>String</td>
+ <td>in</td>
+ <td>no</td>
+ <td></td>
+ <td>
+ The target window to use in the link.
+ </td>
+ </tr>
+ <tr>
+ <td>renderer</td>
+ <td><link
href="&apiroot;/link/ILinkRenderer.html">ILinkRenderer</link></td>
+ <td>in</td>
+ <td>no</td>
+ <td></td>
+ <td>
+ The object which will actually render the link.
+ </td>
+ </tr>
+</table>
<p>
- Body: <strong>removed / allowed</strong>
+ Body: <strong>allowed</strong>
</p>
<p>
- Informal parameters: <strong>allowed / forbidden</strong>
+ Informal parameters: <strong>allowed</strong>
</p>
<p>
- Reserved parameters: <em>none</em>
+ Reserved parameters: href
</p>
</section>
<section>
<title>Examples</title>
+ <p>
+ This example illustrates a page displaying some content based on an id and
a language code.
+ It contains a link to view the same content in German.
+ </p>
+<source><![CDATA[
+<a href="#"
+ jwcid="@ExternalLink"
+ page="ViewArticle"
+ parameters="ognl:{articleId, 'de'}"
+ disabled="ognl:languageCode=='de'"
+>view this article in German</a>
+
+<div jwcid="@Insert" value="ognl:content">content of the article</div>
+]]></source>
+
+<source><![CDATA[
+package com.myexample;
+
+import org.apache.tapestry.IExternalPage;
+import org.apache.tapestry.IRequestCycle;
+import org.apache.tapestry.html.BasePage;
+
+public abstract class ViewArticle extends BasePage implements IExternalPage {
+
+ public abstract Integer getArticleId();
+ public abstract void setArticleId(Integer articleId);
+ public abstract String getLanguageCode();
+ public abstract void setLanguageCode(String language);
+
+ public void activateExternalPage(Object[] params, IRequestCycle cycle) {
+ setArticleId((Integer) params[0]);
+ setLanguageCode((String) params[1]);
+ }
+
+ public String getContent() {
+ // retrieve the content of the article for the selected language
+
+ }
+
+}
+]]></source>
</section>
</body>
Modified:
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Radio.xml
URL:
http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Radio.xml?rev=265550&r1=265549&r2=265550&view=diff
==============================================================================
---
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Radio.xml
(original)
+++
jakarta/tapestry/trunk/framework/src/documentation/content/xdocs/tapestry/ComponentReference/Radio.xml
Wed Aug 31 11:54:54 2005
@@ -1,6 +1,6 @@
<?xml version="1.0"?>
<!--
- Copyright 2004, 2005 The Apache Software Foundation
+ Copyright 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.
@@ -28,11 +28,14 @@
<body>
-<p> <strong>THIS PAGE UNDER CONSTRUCTION</strong>
-</p>
-
+ <p>Provides a HTML <input type="radio"> form element. The Radio
component
+ must be wrapped (possibly indirectly) inside a &RadioGroup; component.</p>
+
+ <p>Generally the &PropertySelection; component is used in preference to
+ the Radio and &RadioGroup;, except in special cases.</p>
<p>
- <strong>See also:</strong>
+ <strong>See also: <link
href="&apiroot;/components/Radio.html">org.apache.tapestry.components.Radio</link>,
&Form;, &Option;, &PropertySelection;, &RadioGroup;, &Select;</strong>
+
</p>
<section>
@@ -43,29 +46,57 @@
<th>Name</th>
<th>Type</th>
<th>Direction</th>
+
<th>Required</th>
<th>Default</th>
<th>Description</th>
</tr>
+ <tr>
+ <td>value</td>
+ <td>Object</td>
+
+ <td>in</td>
+ <td>no</td>
+ <td></td>
+ <td>
+ The value is used to determine if the radio button is initially
selected (when rendering) and is the value assigned to the selected parameter
when the form is submitted, if the HTML radio button is selected.
+ </td>
+ </tr>
+ <tr>
+
+ <td>disabled</td>
+ <td>boolean</td>
+ <td>in</td>
+ <td>no</td>
+ <td>false</td>
+ <td>
+
+ If true, then the Radio is disabled. It will write a "disabled"
attribute into its tag when rendering, and will not update its selected binding.
+ A Radio may also be disabled if its containing RadioGroup is disabled.
+ </td>
+ </tr>
</table>
<p>
- Body: <strong>removed / allowed</strong>
+ Body: <strong>removed</strong>
</p>
<p>
- Informal parameters: <strong>allowed / forbidden</strong>
+ Informal parameters: <strong>allowed</strong>
+
</p>
<p>
- Reserved parameters: <em>none</em>
+ Reserved parameters: checked, name, type
</p>
</section>
<section>
<title>Examples</title>
+
+ <p>See &RadioGroup; for a Radio component example.</p>
</section>
</body>
Modified: jakarta/tapestry/trunk/status.xml
URL:
http://svn.apache.org/viewcvs/jakarta/tapestry/trunk/status.xml?rev=265550&r1=265549&r2=265550&view=diff
==============================================================================
--- jakarta/tapestry/trunk/status.xml (original)
+++ jakarta/tapestry/trunk/status.xml Wed Aug 31 11:54:54 2005
@@ -55,7 +55,7 @@
<action type="fix" dev="HLS" fixes-bug="TAPESTRY-611">Pattern validator
invokes wrong client-side JavaScript function</action>
<action type="fix" dev="HLS" fixes-bug="TAPESTRY-610">$bean syntax for
validators: binding prefix is broken</action>
<action type="fix" dev="HLS"
fixes-bug="TAPESTRY-609">Tapestry.set_focus() seems to be passed the form
components elementId (i.e. name attribute) not clientId (i.e. id attribute),
which keeps focus from being set</action>
- <action type="fix" dev="HLS" fixes-bug="TAPESTRY-478"
due-to="Pierre-Yves Nicolas">Document RadioGroup component</action>
+ <action type="fix" dev="HLS" fixes-bug="TAPESTRY-478, TAPESTRY-477,
TAPESTRY-463" due-to="Pierre-Yves Nicolas">Document RadioGroup, Radio and
ExternalLink components</action>
<action type="fix" dev="HLS" fixes-bug="TAPESTRY-613">Javascript problem
with @LinkSubmit</action>
</release>
<release version="4.0-beta-5" date="Aug 26 2005">
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
