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/07/15 18:57:31 UTC
svn commit: r422268 [1/5] - in /tapestry/tapestry4/trunk: src/documentation/
src/images/ src/site/ src/site/xdoc/components/ support/
tapestry-framework/src/documentation/content/xdocs/
tapestry-framework/src/documentation/content/xdocs/tapestry/Compon...
Author: jkuhnert
Date: Sat Jul 15 09:57:28 2006
New Revision: 422268
URL: http://svn.apache.org/viewvc?rev=422268&view=rev
Log:
Updating documentation
Added:
tapestry/tapestry4/trunk/src/site/xdoc/components/
tapestry/tapestry4/trunk/src/site/xdoc/components/Any.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Block.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Body.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Button.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Checkbox.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/DatePicker.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Delegator.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Describe.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/DirectLink.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Else.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/ExceptionDisplay.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/ExternalLink.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/FieldLabel.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/For.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Form.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Frame.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/GenericLink.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Hidden.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/If.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Image.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/ImageSubmit.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Insert.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/InsertText.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/InvokeListener.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/LinkSubmit.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Option.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/PageLink.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/PropertySelection.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Radio.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/RadioGroup.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/RenderBlock.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/RenderBody.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Rollover.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Script.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Select.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/ServiceLink.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Shell.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Submit.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/TextArea.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/TextField.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/Upload.xml (with props)
tapestry/tapestry4/trunk/src/site/xdoc/components/index.xml (with props)
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/links.ent
Removed:
tapestry/tapestry4/trunk/src/documentation/
tapestry/tapestry4/trunk/src/images/
Modified:
tapestry/tapestry4/trunk/src/site/site.xml
tapestry/tapestry4/trunk/support/build.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/ActionLink.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Any.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Block.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Body.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Button.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Checkbox.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Conditional.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/DatePicker.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Delegator.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Describe.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/DirectLink.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Else.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/ExceptionDisplay.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/ExternalLink.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/FieldLabel.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/For.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Foreach.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Form.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Frame.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/GenericLink.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Hidden.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/If.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Image.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/ImageSubmit.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Insert.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/InsertText.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/InvokeListener.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/LinkSubmit.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/ListEdit.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Option.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/PageLink.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/PropertySelection.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Radio.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/RadioGroup.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/RenderBlock.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/RenderBody.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Rollover.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Script.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Select.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/ServiceLink.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Shell.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Submit.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/TextArea.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/TextField.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/Upload.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/ValidField.xml
tapestry/tapestry4/trunk/tapestry-framework/src/documentation/content/xdocs/tapestry/ComponentReference/index.xml
Modified: tapestry/tapestry4/trunk/src/site/site.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/site.xml?rev=422268&r1=422267&r2=422268&view=diff
==============================================================================
--- tapestry/tapestry4/trunk/src/site/site.xml (original)
+++ tapestry/tapestry4/trunk/src/site/site.xml Sat Jul 15 09:57:28 2006
@@ -75,6 +75,54 @@
</menu>
+ <menu name="Components" inherit="top">
+
+ <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="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="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>
+
+ </menu>
+
<menu ref="modules" />
${reports}
Added: tapestry/tapestry4/trunk/src/site/xdoc/components/Any.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/Any.xml?rev=422268&view=auto
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/Any.xml (added)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/Any.xml Sat Jul 15 09:57:28 2006
@@ -0,0 +1,147 @@
+<?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>Any</title>
+ </properties>
+ <body>
+
+ <section name="Any">
+
+ <p>
+ A "Swiss Army Knife" component that can emulate any tag whatsoever. The Any
+ component renders the tag for its element in the template, plus any informal
+ parameters, and its body. This is typically used to make certain attributes of a tag
+ dynamic without having to write an entire component for that single purpose.
+ </p>
+
+ <p>
+ <strong>
+ See also:
+ <a
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/components/Any.html">
+ org.apache.tapestry.components.Any
+ </a>
+ ,
+ <a href="If.html">If</a>
+ ,
+ <a href="For.html">For</a>
+ </strong>
+ </p>
+
+ <subsection name="Parameters">
+
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Direction</th>
+ <th>Required</th>
+ <th>Default</th>
+ <th>Description</th>
+ </tr>
+
+ <tr>
+ <td>element</td>
+ <td>string</td>
+ <td>in</td>
+ <td>no</td>
+ <td>
+ <em>From the HTML template</em>
+ </td>
+ <td>The element to render.</td>
+ </tr>
+
+ </table>
+
+ <p>
+ Body:
+ <strong>allowed</strong>
+ </p>
+
+ <p>
+ Informal parameters:
+ <strong>allowed</strong>
+ </p>
+
+ <p>
+ Reserved parameters:
+ <em>none</em>
+ </p>
+
+ <p>
+ Certain other components, including
+ <a href="If.html">If</a>
+ and
+ <a href="For.html">For</a>
+ , can behave much like an Any component, in addition to their normal behavior,
+ by specifying a value for their element parameter.
+ </p>
+
+ </subsection>
+
+ <subsection name="Example">
+
+
+ <p>
+ In this example, the Any component is emulating an <img> element, and is
+ dynamically calculating the URL, width, height, and title from data (presumably
+ obtained from a database).
+ </p>
+
+ <source xml:space="preserve">
+
+<h2>Thumbails:</h2>
+
+<span jwcid="loop">
+ <p>
+ <img jwcid="@Any" src="ognl:image.thumbURL" width="ognl:image.thumbWidth" height="ognl:image.thumbHeight"
+ alt="ognl:image.title"/>
+ <br/>
+ <span jwcid="@Insert" value="ognl:image.title"/>
+ </p>
+</span>
+</source>
+
+ <p>This template is complemented by some details in the specification:</p>
+
+ <source xml:space="preserve">
+ . . .
+
+ <property name="image"/>
+
+ <component id="loop" type="Foreach">
+ <binding name="source" value="thumbnails"/>
+ <binding name="value" value="image"/>
+ </component>
+
+ . . .
+</source>
+
+ <p>
+ The
+ <a href="site:RenderBlock">RenderBlock</a>
+ component contains an extensive example that includes the use of the Any
+ component.
+ </p>
+
+ </subsection>
+
+ </section>
+ </body>
+</document>
Propchange: tapestry/tapestry4/trunk/src/site/xdoc/components/Any.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: tapestry/tapestry4/trunk/src/site/xdoc/components/Block.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/Block.xml?rev=422268&view=auto
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/Block.xml (added)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/Block.xml Sat Jul 15 09:57:28 2006
@@ -0,0 +1,103 @@
+<?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>Block</title>
+ </properties>
+ <body>
+
+ <section name="Block">
+ <p>
+ Contains markup and other components, and defers rendering of its body until invoked
+ by a
+ <a href="RenderBlock.html">RenderBlock</a>
+ .
+ </p>
+
+ <p>
+ <strong>
+ See also:
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/components/Block.html">
+ org.apache.tapestry.components.Block
+ </a>
+ ,
+ <a href="RenderBlock.html">RenderBlock</a>
+ </strong>
+ </p>
+
+ <section name="Parameters">
+
+
+ <p>
+ <em>No parameters</em>
+ </p>
+
+ <p>
+ Body:
+ <strong>allowed</strong>
+ </p>
+
+ <p>
+ Informal parameters:
+ <strong>forbidden</strong>
+ </p>
+
+ <p>
+ Reserved parameters:
+ <em>none</em>
+ </p>
+
+
+ <p>
+ When a
+ <a href="Block.html">Block</a>
+ component renders normally, it does absolutely nothing. It doesn't render any
+ tag, or render its body. However, a
+ <a href="RenderBlock.html">RenderBlock</a>
+ component can be passed a Block instance, which will trigger the Block to render
+ its body.
+ </p>
+
+ <p>
+ The parameters of the
+ <a href="RenderBlock.html">RenderBlock</a>
+ , including informal parameters, are indirectly available to the Block
+ component. The OGNL expression components.
+ <em>block</em>
+ .getParameter("
+ <em>name</em>
+ ") returns the value of a parameter bound to the
+ <a href="RenderBlock.html">RenderBlock</a>
+ which invoked the rendering of the Block's body.
+ </p>
+
+ </section>
+
+ <section name="Example">
+
+
+ <p>
+ The
+ <a href="RenderBlock.html">RenderBlock</a>
+ component has an extensive example.
+ </p>
+
+ </section>
+
+ </section>
+ </body>
+</document>
Propchange: tapestry/tapestry4/trunk/src/site/xdoc/components/Block.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: tapestry/tapestry4/trunk/src/site/xdoc/components/Body.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/Body.xml?rev=422268&view=auto
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/Body.xml (added)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/Body.xml Sat Jul 15 09:57:28 2006
@@ -0,0 +1,91 @@
+<?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>Body</title>
+ </properties>
+ <body>
+
+ <section name="Body">
+ <p>
+ Generates the <body> element for the page, and is involved in generating and
+ organizing the JavaScript on the page. You should always use the Body component for
+ your <body> tag, since you can never know which components within the page
+ will require the services it provides.
+ </p>
+
+ <p>
+ <strong>
+ See also:
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/html/Body.html">
+ org.apache.tapestry.html.Body
+ </a>
+ ,
+ <a href="Rollover.html">Rollover</a>
+ ,
+ <a href="Script.html">Script</a>
+ </strong>
+ </p>
+
+ <section name="Parameters">
+
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Direction</th>
+ <th>Required</th>
+ <th>Default</th>
+ <th>Description</th>
+ </tr>
+
+ <tr>
+ <td>element</td>
+ <td>string</td>
+ <td>in</td>
+ <td>no</td>
+ <td>body</td>
+ <td>
+ The element to use; this can be overriden, for example, when the Body
+ component is used to generate a <frameset>.
+ </td>
+ </tr>
+
+ </table>
+
+ <p>
+ Body:
+ <strong>allowed</strong>
+ </p>
+
+ <p>
+ Informal parameters:
+ <strong>allowed</strong>
+ </p>
+
+ <p>
+ Reserved parameters:
+ <em>none</em>
+ </p>
+
+ </section>
+
+ </section>
+
+ </body>
+</document>
Propchange: tapestry/tapestry4/trunk/src/site/xdoc/components/Body.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: tapestry/tapestry4/trunk/src/site/xdoc/components/Button.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/Button.xml?rev=422268&view=auto
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/Button.xml (added)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/Button.xml Sat Jul 15 09:57:28 2006
@@ -0,0 +1,94 @@
+<?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>Button</title>
+ </properties>
+ <body>
+
+ <section name="Button">
+ <p>
+ Provides a HTML form button element <input type="button"> 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="Submit.html">Submit</a>
+ </strong>
+ </p>
+
+ <section name="Parameters">
+
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Direction</th>
+ <th>Required</th>
+ <th>Default</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>lable</td>
+ <td>String</td>
+ <td>in</td>
+ <td>no</td>
+ <td></td>
+ <td>
+ The label put on the button (this becomes the HTML value attribute).
+ </td>
+ </tr>
+ <tr>
+ <td>disabled</td>
+ <td>boolean</td>
+ <td>in</td>
+ <td>no</td>
+ <td>false</td>
+ <td>
+ If set to true, the button will be disabled (will not respond to the
+ mouse); the browser should provide a "greyed out" appearance.
+ </td>
+ </tr>
+
+ </table>
+
+ <p>
+ Body:
+ <strong>removed</strong>
+ </p>
+
+ <p>
+ Informal parameters:
+ <strong>allowed</strong>
+ </p>
+
+ <p>
+ Reserved parameters:
+ <em>name, type</em>
+ </p>
+
+ </section>
+
+ </section>
+
+ </body>
+</document>
Propchange: tapestry/tapestry4/trunk/src/site/xdoc/components/Button.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: tapestry/tapestry4/trunk/src/site/xdoc/components/Checkbox.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/Checkbox.xml?rev=422268&view=auto
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/Checkbox.xml (added)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/Checkbox.xml Sat Jul 15 09:57:28 2006
@@ -0,0 +1,116 @@
+<?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>Checkbox</title>
+ </properties>
+ <body>
+
+ <section name="Checkbox">
+ <p>Renders an HTML checkbox, based on a boolean value.</p>
+
+ <p>
+ <strong>
+ See also:
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/form/Checkbox.html">
+ org.apache.tapestry.form.Checkbox
+ </a>
+ ,
+ <a href="Form.html">Form</a>
+ </strong>
+ </p>
+
+ <section name="Parameters">
+
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Direction</th>
+ <th>Required</th>
+ <th>Default</th>
+ <th>Description</th>
+ </tr>
+
+ <tr>
+ <td>value</td>
+ <td>boolean</td>
+ <td>in/out</td>
+ <td>yes</td>
+ <td></td>
+ <td>
+ Value editted by the component; read on render, updated on form submit.
+ This sets the check attribute of the rendered element. Deprecated alias:
+ selected.
+ </td>
+ </tr>
+
+ <tr>
+ <td>displayName</td>
+ <td>string</td>
+ <td>in</td>
+ <td>no</td>
+ <td></td>
+ <td>
+ The user-presentable name for the component, which will be used by a
+ <a href="FieldLabel.html">FieldLabel</a>
+ connected to the component.
+ </td>
+ </tr>
+
+ <tr>
+ <td>disabled</td>
+ <td>boolean</td>
+ <td>in</td>
+ <td>no</td>
+ <td>false</td>
+ <td>
+ If true, then the checkbox will render as disabled and any input from
+ 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>
+ </tr>
+
+ </table>
+
+ <p>
+ Body:
+ <strong>removed</strong>
+ </p>
+
+ <p>
+ Informal parameters:
+ <strong>allowed</strong>
+ </p>
+
+ <p>Reserved parameters: type, checked, name</p>
+
+ </section>
+
+ </section>
+
+ </body>
+</document>
Propchange: tapestry/tapestry4/trunk/src/site/xdoc/components/Checkbox.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: tapestry/tapestry4/trunk/src/site/xdoc/components/DatePicker.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/DatePicker.xml?rev=422268&view=auto
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/DatePicker.xml (added)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/DatePicker.xml Sat Jul 15 09:57:28 2006
@@ -0,0 +1,235 @@
+<?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>DatePicker</title>
+ </properties>
+ <body>
+
+ <section name="DatePicker">
+
+ <p>
+ Provides a form Date field component for selecting dates. DatePicker presents a drop
+ down monthly calendar for users to select dates from.
+ </p>
+ <p>
+ JavaScript must be enabled in the client browser to use the drop down calendar. If
+ JavaScript is not enabled users can still enter a date value in the HTML text field.
+ </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
+ obscuring part of the calendar. In these situation organize the form's UI layout so
+ this does not occur.
+ </p>
+ <p>
+ <strong>
+ See also:
+ <a href="Button.html">Button</a>
+ ,
+ <a href="Form.html">Form</a>
+ </strong>
+ </p>
+
+ <section name="Parameters">
+
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Direction</th>
+ <th>Required</th>
+ <th>Default</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>value</td>
+ <td>java.util.Date</td>
+ <td>in</td>
+ <td>yes</td>
+ <td></td>
+ <td>
+ The data value. Take care to ensure date time values are 'normalized'
+ before performing any millisec based comparison or equality operations.
+ </td>
+ </tr>
+
+ <tr>
+ <td>disabled</td>
+ <td>boolean</td>
+ <td>in</td>
+ <td>no</td>
+ <td>false</td>
+ <td>
+ Controls whether the date field and calendar button is active or not.
+ </td>
+ </tr>
+
+ <tr>
+ <td>displayName</td>
+ <td>String</td>
+ <td>in</td>
+ <td>no</td>
+ <td></td>
+ <td>
+ The user-presentable name for the component, which will be used by a
+ <a href="FieldLabel.html">FieldLabel</a>
+ connected to the component.
+ </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>
+ , or
+ <a
+ 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>
+ </tr>
+
+ <tr>
+ <td>translator</td>
+ <td>
+ <a
+ href="../../tapestry/apidocs/org/apache/tapestry/form/translator/Translator.html">
+ 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>
+ </tr>
+
+ <tr>
+ <td>icon</td>
+ <td>
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/IAsset.html">
+ IAsset
+ </a>
+ </td>
+ <td>in</td>
+ <td>no</td>
+ <td></td>
+ <td>
+ The icon used to toggle the calendar on and off. The calendar will
+ automatically line itself up beneath the text input field.
+ </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>
+ </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>
+ </tr>
+
+ </table>
+
+ <p>
+ Body:
+ <strong>removed</strong>
+ </p>
+
+ <p>
+ Informal parameters:
+ <strong>allowed</strong>
+ (These parameters will be applied to the text field)
+ </p>
+
+ <p>
+ Reserved parameters:
+ <em>none</em>
+ </p>
+
+ </section>
+
+ <section name="Examples">
+
+ <p>
+ This example provides a simple form where the user can select a start date and
+ an end date.
+ </p>
+ <p>HTML template</p>
+ <source xml:space="preserve">
+<form jwcid="Form" listener="listener:formSubmit">
+<table valign="middle">
+ <tr>
+ <td>Start Date:</td> <td><span jwcid="@DatePicker" value="ognl:startDate"/></td>
+ </tr>
+ <tr>
+ <td>End Date:</td> <td><span jwcid="@DatePicker" value="ognl:endDate"/></td>
+ </tr>
+ <tr>
+ <td colspan="2">&nbsp;</td>
+ </tr>
+ <tr>
+ <td colspan="2" align="right"><input type="submit" value="Submit"/></td>
+ </tr>
+</table>
+</form>
+</source>
+ <p>Page specification</p>
+ <source xml:space="preserve">
+...
+<property name="startDate" type="java.util.Date"/>
+<property name="endDate" type="java.util.Date"/>
+...
+</source>
+ <p>Java source</p>
+ <source xml:space="preserve">
+public abstract class Dates extends BasePage {
+ public abstract Date getStartDate();
+
+ public abstract Date getEndDate();
+
+ public void formSubmit(IRequestCycle cycle) {
+ // Process the submitted dates.
+ }
+}
+</source>
+ </section>
+
+ </section>
+
+ </body>
+</document>
Propchange: tapestry/tapestry4/trunk/src/site/xdoc/components/DatePicker.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: tapestry/tapestry4/trunk/src/site/xdoc/components/Delegator.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/Delegator.xml?rev=422268&view=auto
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/Delegator.xml (added)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/Delegator.xml Sat Jul 15 09:57:28 2006
@@ -0,0 +1,83 @@
+<?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>Delegator</title>
+ </properties>
+ <body>
+
+ <section name="Delegator">
+
+ <p>
+ A component which delegates its behavior (that is, the HTML rendered) to some other
+ object.
+ <br />
+ This is occasionally useful when the HTML to render is best generated from pure Java
+ code (or has been provided from some source outside of Tapestry).
+ </p>
+
+ <section name="Parameters">
+
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Direction</th>
+ <th>Required</th>
+ <th>Default</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>delegate</td>
+ <td>
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/IRender.html">
+ IRender
+ </a>
+ </td>
+
+ <td>in</td>
+ <td>no</td>
+ <td />
+ <td>
+ If specified, the object which will provide the rendering for the
+ component.
+ </td>
+ </tr>
+ </table>
+
+ <p>
+ Body:
+ <strong>removed</strong>
+ </p>
+
+ <p>
+ Informal parameters:
+ <strong>forbidden</strong>
+ </p>
+
+ <p>
+ Reserved parameters:
+ <em>none</em>
+ </p>
+
+ </section>
+
+ </section>
+
+ </body>
+</document>
Propchange: tapestry/tapestry4/trunk/src/site/xdoc/components/Delegator.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: tapestry/tapestry4/trunk/src/site/xdoc/components/Describe.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/Describe.xml?rev=422268&view=auto
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/Describe.xml (added)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/Describe.xml Sat Jul 15 09:57:28 2006
@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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.
+ 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>Describe</title>
+ </properties>
+ <body>
+
+ <section name="Describe">
+
+ <p>
+ Used to produce an HTML description of an object; typically a table is rendered, and
+ the object's properties are displayed in successive rows of the table. In some
+ cases, a property may be described recursively. Simple objects may be described as
+ strings. The behavior behind this is extensible, defined in terms of contributions
+ to the
+ <a href="../../tapestry-framework/hivedocs/config/tapestry.describe.DescribableStrategies">
+ tapestry.describe.DescribableStrategies
+ </a>
+ configuration point.
+ </p>
+
+ <p>
+ This component is used internally by Tapestry as part of the default Exception page.
+ </p>
+
+ <p>
+ <strong>
+ See also:
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/html/Describe.html">
+ org.apache.tapestry.html.Describe
+ </a>
+ ,
+ <a href="../../tapestry-framework/hivedocs/service/tapestry.describe.HTMLDescriber">
+ tapestry.describe.HTMLDescriber
+ </a>
+ </strong>
+ </p>
+
+ <section name="Parameters">
+
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Direction</th>
+ <th>Required</th>
+ <th>Default</th>
+ <th>Description</th>
+ </tr>
+
+ <tr>
+ <td>object</td>
+ <td>any</td>
+ <td>in</td>
+ <td>yes</td>
+ <td />
+ <td>The object to be described.</td>
+ </tr>
+
+ </table>
+
+ <p>
+ Body:
+ <strong>removed</strong>
+ </p>
+
+ <p>
+ Informal parameters:
+ <strong>forbidden</strong>
+ </p>
+
+ <p>
+ Reserved parameters:
+ <em>none</em>
+ </p>
+
+ </section>
+
+ </section>
+
+ </body>
+</document>
Propchange: tapestry/tapestry4/trunk/src/site/xdoc/components/Describe.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: tapestry/tapestry4/trunk/src/site/xdoc/components/DirectLink.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/DirectLink.xml?rev=422268&view=auto
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/DirectLink.xml (added)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/DirectLink.xml Sat Jul 15 09:57:28 2006
@@ -0,0 +1,369 @@
+<?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>DirectLink</title>
+ </properties>
+ <body>
+
+ <section name="DirectLink">
+
+ <p>
+ Creates an <a> hyperlink that notifies the component when the link is
+ triggered. The link includes some context-specific data that is made available to
+ the component's listener.
+ </p>
+ <p>
+ See the Developers Guide DirectLink listeners for a more complete
+ description.
+ </p>
+
+ <p>
+ <strong>
+ See also:
+ <a href="ExternalLink.html">ExternalLink</a>
+ ,
+ <a href="GenericLink.html">GenericLink</a>
+ ,
+ <a href="PageLink.html">PageLink</a>
+ ,
+ <a href="ServiceLink.html">ServiceLink</a>
+ </strong>
+
+ </p>
+
+ <section name="Parameters">
+
+
+ <table>
+
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Direction</th>
+
+ <th>Required</th>
+ <th>Default</th>
+
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>listener</td>
+ <td>
+ <a
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/IActionListener.html">
+ IActionListener
+ </a>
+ </td>
+
+ <td>in</td>
+ <td>yes</td>
+
+ <td />
+ <td>
+ Specifies an object that is notified when the link is clicked, which is
+ typically a listener method of its container (for example, listeners.
+ <em>method</em>
+ ).
+ </td>
+ </tr>
+ <tr>
+ <td>parameters</td>
+ <td>
+ Object or
+ <br />
+
+ Object[] or
+ <br />
+ List
+ </td>
+
+ <td>in</td>
+ <td>no</td>
+ <td />
+ <td>
+ <p>
+ An array of objects to be encoded into the URL. These parameters
+ will be decoded when the link is triggered.
+ </p>
+
+ <p>
+ In a web application built onto of Enterprise JavaBeans, the context
+ is often the primary key of some Entity bean; typically such keys
+ are Strings or Integers.
+ </p>
+ <p>
+ A listener method can retrieve the parameters three ways:
+ <br />
+ parameters are declared in the method itself, e.g. - listenerMethod(
+ <em>parameters</em>
+ )
+ <br />
+ parameters are declared along with the IRequestCycle, e.g. -
+ listenerMethod(IRequestCycle cycle,
+ <em>parameters</em>
+ )
+
+ <br />
+ or through the request cycle, e.g. - listenerMethod(IReuqestCycle
+ cycle), using IRequestCycle.getServiceParameters()
+ </p>
+ <p>
+ Prior to release 2.2, the parameters were always type String. They
+ may now be of any type; type will be maintained when the parameters
+ are later retrieved by a listener. See
+ <a
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/util/io/DataSqueezer.html">
+ DataSqueezer
+ </a>
+ for more details.
+ </p>
+ </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>stateful</td>
+ <td>boolean</td>
+ <td>in</td>
+
+ <td>no</td>
+ <td>true</td>
+ <td>
+ If true (the default), then the component requires an active (i.e.,
+ non-new) HttpSession when triggered. Failing that, it throws a
+ <a
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/StaleLinkException.html">
+ StaleLinkException
+ </a>
+ . If false, then no check is necessary. The latter works well with links
+ that encode all necessary state inside the URL itself.
+ </td>
+ </tr>
+ <tr>
+
+ <td>anchor</td>
+
+ <td>String</td>
+ <td>in</td>
+ <td>no</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>scheme</td>
+ <td>String</td>
+ <td>in</td>
+ <td>no</td>
+ <td />
+ <td>
+ The required scheme ("http" or "https", 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 to switch to "https" for secure portions of an application (such as
+ a login page), before switching back to standard "http" for the majority
+ of an application.
+ </td>
+ </tr>
+
+ <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"
+ 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
+ application.
+ </td>
+ </tr>
+
+ <tr>
+ <td>renderer</td>
+ <td>
+ <a
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/link/ILinkRenderer.html">
+ ILinkRenderer
+ </a>
+ </td>
+ <td>in</td>
+ <td>no</td>
+
+ <td />
+
+ <td>The object which will actually render the link.</td>
+ </tr>
+ </table>
+
+ <p>
+ Body:
+ <strong>rendered</strong>
+
+ </p>
+
+ <p>
+
+ Informal parameters:
+ <strong>allowed</strong>
+ </p>
+
+ <p>
+ Reserved parameters:
+ <em>href</em>
+ </p>
+
+ </section>
+ <section name="Examples">
+
+ <p>
+ In this example the DirectLink component enables users to select a Customer from
+ the Customer List table.
+ </p>
+
+ <img src="../../images/tapestry/ComponentReference/DirectLink.png"
+ alt="DirectLink Screen Shot" />
+
+
+ <p>HTML template</p>
+ <source xml:space="preserve">
+ <table cellspacing="6">
+ <tr>
+ <td>ID</td>
+ <td>&nbsp;</td>
+ <td>Name</td>
+ <td>&nbsp;</td>
+ <td>Level</td>
+ <th>&nbsp;</th>
+ </tr>
+ <tr>
+ <td colspan="6"><hr></td>
+ </tr>
+ <tr jwcid="@Foreach" source="ognl:customerList" value="ognl:customer" element="tr">
+ <td><span jwcid="@Insert" value="ognl:customer.id"/></td>
+ <td>&nbsp;</td>
+ <td><span jwcid="@DirectLink" listener="listener:customerSelectAction" parameters="ognl:customer.id"> <span jwcid="@Insert" value="ognl:customer.fullName"/> </span></td>
+ <td>&nbsp;</td>
+ <td><span jwcid="@Insert" value="ognl:customer.memberLevel"/></td>
+ <td>
+ <a jwcid="@DirectLink" listener="listener.customerDeleteAction" parameters="ognl:customer.id" onclick="return window.confirm('Are you sure you want remove this customer?');">
+ <img jwcid="@Image" image="ognl:assets.deleteImage" alt="Delete"/>
+ </a>
+ </td>
+ </tr>
+</table>
+</source>
+
+ <p>Page specification</p>
+ <source xml:space="preserve">
+<property name="customerList" type="java.util.List" persistent="yes"/>
+<property name="customer" type="Customer"/>
+</source>
+
+
+ <p>Java sources</p>
+ <source xml:space="preserve">
+public abstract class SalesPage extends BasePage {
+ public abstract List getCustomerList();
+ public abstract List setCustomerList(List value);
+
+ public abstract Customer getCustomer();
+
+ public void customerSelectAction(Integer id) {
+ Visit visit = (Visit) getVisit();
+ Customer customer = visit.findCustomerByPrimaryKey(id);
+ // Perform some action with the selected customer.
+ ..
+ }
+
+ public void customerDeleteAction(Integer id) {
+ Visit visit = (Visit) getVisit();
+ Customer customer = visit.findCustomerByPrimaryKey(id);
+ visit.deleteCustomer(customer);
+ }
+}
+</source>
+ <source xml:space="preserve">
+public class Visit() implements Serializable {
+
+ public List getCustomerList() {
+ List customerList = new ArrayList();
+ // Perform a database query retrieving the list of customers.
+ ..
+ return customerList;
+ }
+
+ public Customer findCustomerByPrimaryKey(Integer id) {
+ Customer customer = null;
+ // Retrieve the customer from the database with given the customer ID.
+ ..
+ return customer;
+ }
+
+ public void deleteCustomer(Customer customer) {
+ // Delete customer from the database.
+ ..
+ }
+}
+</source>
+
+ <source xml:space="preserve">
+public class Customer implements Serializable {
+ private Integer id;
+ private String fullName;
+ private String memberLevel;
+
+ public Customer(Integer id, String fullName, String memberLevel) {
+ this.id = id;
+ this.fullName = fullName;
+ this.memberLevel = memberLevel;
+ }
+
+ public Integer getId() { return id; }
+
+ public String getFullName() { return fullName; }
+
+ public String getMemberLevel() { return memberLevel; }
+}
+</source>
+ </section>
+
+ </section>
+
+ </body>
+</document>
Propchange: tapestry/tapestry4/trunk/src/site/xdoc/components/DirectLink.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: tapestry/tapestry4/trunk/src/site/xdoc/components/Else.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/Else.xml?rev=422268&view=auto
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/Else.xml (added)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/Else.xml Sat Jul 15 09:57:28 2006
@@ -0,0 +1,115 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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.
+ 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>Else</title>
+ </properties>
+ <body>
+
+ <section name="Else">
+
+ <p>
+ Conditionally emulates an element and its attributes and/or includes a block of
+ content if the condition of the previous If component evaluates to false.
+ </p>
+
+ <p>
+ <strong>
+ See also:
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/components/ElseBean.html">
+ org.apache.tapestry.components.ElseBean
+ </a>
+ ,
+ <a href="If.html">If</a>
+ </strong>
+ </p>
+
+ <section name="Parameters">
+
+
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Direction</th>
+ <th>Required</th>
+ <th>Default</th>
+
+ <th>Description</th>
+ </tr>
+
+ <tr>
+ <td>element</td>
+ <td>String</td>
+ <td>in</td>
+ <td>no</td>
+ <td></td>
+
+ <td>
+ The element to emulate. If specified, then the component acts like an
+ <a href="Any.html">Any</a>
+ , emitting an open and close tag. Informal parameters are applied to the
+ tag. If no element is specified, informal parameters are ignored.
+ </td>
+ </tr>
+ </table>
+
+ <p>
+ Body:
+ <strong>allowed</strong>
+ </p>
+
+ <p>
+ Informal parameters:
+ <strong>allowed</strong>
+
+ </p>
+
+ <p>
+ Reserved parameters:
+ <em>none</em>
+ </p>
+
+ </section>
+
+ <section name="Examples">
+
+
+ <p>
+
+ In the example, we say hello to our user if he/she has login, or we ask him/her
+ login. (Just the same example for If component.)
+ </p>
+ <p>Home.html</p>
+
+ <source xml:space="preserve">
+...
+<p>
+Hello, <span jwcid="@If" condition="ognl:user.login"><span jwcid="@Insert" value="ognl:user.name"/></span>
+<span jwcid="@Else"> please <span jwcid="@PageLink" page="Login">login</span></span>
+</p>
+...
+
+</source>
+
+ </section>
+
+ </section>
+
+ </body>
+</document>
Propchange: tapestry/tapestry4/trunk/src/site/xdoc/components/Else.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: tapestry/tapestry4/trunk/src/site/xdoc/components/ExceptionDisplay.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/ExceptionDisplay.xml?rev=422268&view=auto
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/ExceptionDisplay.xml (added)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/ExceptionDisplay.xml Sat Jul 15 09:57:28 2006
@@ -0,0 +1,87 @@
+<?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>ExceptionDisplay</title>
+ </properties>
+ <body>
+
+ <section name="ExceptionDisplay">
+
+
+ <p>
+ A component used on the standard exception page to render a detailed list of
+ exceptions.
+ </p>
+
+ <p>
+ <strong>
+ See also:
+ <a href="InspectorButton.html">InspectorButton</a>
+ </strong>
+ </p>
+
+ <section name="Parameters">
+
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Direction</th>
+ <th>Required</th>
+ <th>Default</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>exceptions</td>
+ <td>
+ <a
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/util/exception/ExceptionDescription.html">
+ ExceptionDescription
+ </a>
+ []
+ </td>
+ <td>in</td>
+ <td>yes</td>
+ <td />
+ <td>Provides the exception descriptions to render.</td>
+ </tr>
+
+ </table>
+
+ <p>
+ Body:
+ <strong>removed</strong>
+ </p>
+
+ <p>
+ Informal parameters:
+ <strong>forbidden</strong>
+ </p>
+
+ <p>
+ Reserved parameters:
+ <em>none</em>
+ </p>
+
+ </section>
+
+ </section>
+
+ </body>
+</document>
Propchange: tapestry/tapestry4/trunk/src/site/xdoc/components/ExceptionDisplay.xml
------------------------------------------------------------------------------
svn:eol-style = native
Added: tapestry/tapestry4/trunk/src/site/xdoc/components/ExternalLink.xml
URL: http://svn.apache.org/viewvc/tapestry/tapestry4/trunk/src/site/xdoc/components/ExternalLink.xml?rev=422268&view=auto
==============================================================================
--- tapestry/tapestry4/trunk/src/site/xdoc/components/ExternalLink.xml (added)
+++ tapestry/tapestry4/trunk/src/site/xdoc/components/ExternalLink.xml Sat Jul 15 09:57:28 2006
@@ -0,0 +1,223 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+ 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.
+ 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>ExternalLink</title>
+ </properties>
+ <body>
+
+ <section name="ExternalLink">
+
+ <p>
+ Creates a <a> hyperlink to an
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/IExternalPage.html">
+ IExternalPage
+ </a>
+ which may be bookmarked using the hyperlink's URL.
+ </p>
+
+ <p>
+ <strong>
+ See also:
+ <a href="../../tapestry-framework/apidocs/org/apache/tapestry/link/ExternalLink.html">
+ org.apache.tapestry.link.ExternalLink
+ </a>
+ ,
+ <a href="DirectLink.html">DirectLink</a>
+ ,
+ <a href="GenericLink.html">GenericLink</a>
+ ,
+ <a href="PageLink.html">PageLink</a>
+ ,
+ <a href="ServiceLink.html">ServiceLink</a>
+ </strong>
+ </p>
+
+ <section name="Parameters">
+
+
+ <table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Direction</th>
+ <th>Required</th>
+ <th>Default</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>page</td>
+ <td>String</td>
+ <td>in</td>
+ <td>yes</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>
+ 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>
+ 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>scheme</td>
+ <td>String</td>
+ <td>in</td>
+ <td>no</td>
+ <td />
+ <td>
+ The required scheme ("http" or "https", 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 to switch to "https" for secure portions of an application (such as
+ a login page), before switching back to standard "http" for the majority
+ of an application.
+ </td>
+ </tr>
+
+ <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"
+ 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
+ application.
+ </td>
+ </tr>
+
+ <tr>
+ <td>target</td>
+ <td>String</td>
+ <td>in</td>
+ <td>no</td>
+ <td />
+ <td>The target window to use in the link.</td>
+ </tr>
+ <tr>
+ <td>renderer</td>
+ <td>
+ <a
+ href="../../tapestry-framework/apidocs/org/apache/tapestry/link/ILinkRenderer.html">
+ ILinkRenderer
+ </a>
+ </td>
+ <td>in</td>
+ <td>no</td>
+ <td />
+ <td>The object which will actually render the link.</td>
+ </tr>
+ </table>
+
+ <p>
+ Body:
+ <strong>allowed</strong>
+ </p>
+
+ <p>
+ Informal parameters:
+ <strong>allowed</strong>
+ </p>
+
+ <p>Reserved parameters: href</p>
+
+ </section>
+
+ <section name="Examples">
+
+ <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 xml:space="preserve">
+<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 xml:space="preserve">
+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>
+
+ </section>
+
+ </body>
+</document>
Propchange: tapestry/tapestry4/trunk/src/site/xdoc/components/ExternalLink.xml
------------------------------------------------------------------------------
svn:eol-style = native