Author: bwallace
Date: Wed Apr 26 21:22:07 2006
New Revision: 397386
URL: http://svn.apache.org/viewcvs?rev=397386&view=rev
Log:
[TAPESTRY-922] Added documentation for Timeout component
Added:
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/Timeout.xml
Modified:
tapestry/tapestry4/branches/4.0/contrib/src/java/org/apache/tapestry/contrib/ajax/Timeout.jwc
tapestry/tapestry4/branches/4.0/src/documentation/content/xdocs/links.ent
tapestry/tapestry4/branches/4.0/src/documentation/content/xdocs/site.xml
Added:
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/Timeout.xml
URL:
http://svn.apache.org/viewcvs/tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/Timeout.xml?rev=397386&view=auto
==============================================================================
---
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/Timeout.xml
(added)
+++
tapestry/tapestry4/branches/4.0/contrib/src/documentation/content/xdocs/tapestry-contrib/ComponentReference/Timeout.xml
Wed Apr 26 21:22:07 2006
@@ -0,0 +1,161 @@
+<?xml version="1.0"?>
+<!--
+ 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.
+-->
+
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN"
"./dtd/document-v12.dtd"
+[
+ <!ENTITY projectroot '../../'>
+ <!ENTITY % links.ent SYSTEM "../../links.ent">
+ %links.ent;
+]>
+<document>
+ <header>
+ <title>Timeout</title>
+ </header>
+
+ <body>
+
+<p>
+ Displays a message to the user when a certain amount of time remains
+ to the expiration of the session.
+</p>
+
+<section>
+ <title>Parameters</title>
+
+<table>
+ <tr>
+ <th>Name</th>
+ <th>Type</th>
+ <th>Direction</th>
+ <th>Required</th>
+ <th>Default</th>
+ <th>Description</th>
+ </tr>
+
+ <tr>
+ <td>warningTime</td>
+ <td>int</td>
+ <td>in</td>
+ <td>no</td>
+ <td>300</td>
+ <td>
+ The number of seconds before session expiration when a warning message
will appear.
+ </td>
+ </tr>
+
+ <tr>
+ <td>autoProlongTime</td>
+ <td>int</td>
+ <td>in</td>
+ <td>no</td>
+ <td>900</td>
+ <td>
+ The number of seconds before session expiration when the session
+ will be automatically prolonged upon user activity.
+ </td>
+ </tr>
+
+ <tr>
+ <td>warningMessage</td>
+ <td>String</td>
+ <td>in</td>
+ <td>no</td>
+ <td>The connection was inactive for more than {0} minutes. Your
session will expire at {1}.\\n Please click OK to continue your work or CANCEL
to close the session.</td>
+ <td>
+ The warning message that will appear when the session is about to
exipre.
+ Here {0} is replaced by the number of minutes that remain until
expiration and
+ {1} is replaced with the time when the expiration will occur.
+ </td>
+ </tr>
+
+ <tr>
+ <td>expirationMessage</td>
+ <td>String</td>
+ <td>in</td>
+ <td>no</td>
+ <td>Your session has expired. Please log in again.</td>
+ <td>
+ The message that will appear when the session exipres and
+ the user needs to log in again.
+ </td>
+ </tr>
+
+ <tr>
+ <td>disableWarning</td>
+ <td>boolean</td>
+ <td>in</td>
+ <td>no</td>
+ <td>false</td>
+ <td>
+ Do not display a warning message after 'warningTime' seconds.
+ </td>
+ </tr>
+
+ <tr>
+ <td>disableAutoProlong</td>
+ <td>boolean</td>
+ <td>in</td>
+ <td>no</td>
+ <td>false</td>
+ <td>
+ Disable the automatic prolonging of a session after 'autoProlongTime'
seconds
+ upon user activity.
+ </td>
+ </tr>
+
+ <tr>
+ <td>expirationFunction</td>
+ <td>String</td>
+ <td>in</td>
+ <td>no</td>
+ <td>null</td>
+ <td>
+ The JavaScript function that will be invoked when the session expires.
+ </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>
+ <title>Examples</title>
+ <source><![CDATA[
+<html>
+ <head>
+ <title>Timeout Example</title>
+ </head>
+ <body>
+ <span jwcid="@contrib:Timeout" warningTime="100"/>
+ </body>
+</html>
+ ]]></source>
+</section>
+</body>
+</document>
\ No newline at end of file
Modified:
tapestry/tapestry4/branches/4.0/contrib/src/java/org/apache/tapestry/contrib/ajax/Timeout.jwc
URL:
http://svn.apache.org/viewcvs/tapestry/tapestry4/branches/4.0/contrib/src/java/org/apache/tapestry/contrib/ajax/Timeout.jwc?rev=397386&r1=397385&r2=397386&view=diff
==============================================================================
---
tapestry/tapestry4/branches/4.0/contrib/src/java/org/apache/tapestry/contrib/ajax/Timeout.jwc
(original)
+++
tapestry/tapestry4/branches/4.0/contrib/src/java/org/apache/tapestry/contrib/ajax/Timeout.jwc
Wed Apr 26 21:22:07 2006
@@ -40,7 +40,7 @@
</description>
</parameter>
- <parameter name="warningMessage" default-value="message: warning">
+ <parameter name="warningMessage" default-value="message:warning">
<description>
The warning message that will appear when the session is about to
exipre.
Here {0} is replaced by the number of minutes that remain until
expiration and
Modified:
tapestry/tapestry4/branches/4.0/src/documentation/content/xdocs/links.ent
URL:
http://svn.apache.org/viewcvs/tapestry/tapestry4/branches/4.0/src/documentation/content/xdocs/links.ent?rev=397386&r1=397385&r2=397386&view=diff
==============================================================================
--- tapestry/tapestry4/branches/4.0/src/documentation/content/xdocs/links.ent
(original)
+++ tapestry/tapestry4/branches/4.0/src/documentation/content/xdocs/links.ent
Wed Apr 26 21:22:07 2006
@@ -201,7 +201,7 @@
<!ENTITY TableRows '<link
href="site:TableRows">TableRows</link>'>
<!ENTITY TableValues '<link
href="site:TableValues">TableValues</link>'>
<!ENTITY TableView '<link
href="site:TableView">TableView</link>'>
-
+<!ENTITY Timeout '<link
href="site:Timeout">Timeout</link>'>
<!ENTITY Tree '<link href="site:Tree">Tree</link>'>
<!ENTITY TreeDataView '<link
href="site:TreeDataView">TreeDataView</link>'>
<!ENTITY TreeNodeView '<link
href="site:TreeNodeView">TreeNodeView</link>'>
Modified:
tapestry/tapestry4/branches/4.0/src/documentation/content/xdocs/site.xml
URL:
http://svn.apache.org/viewcvs/tapestry/tapestry4/branches/4.0/src/documentation/content/xdocs/site.xml?rev=397386&r1=397385&r2=397386&view=diff
==============================================================================
--- tapestry/tapestry4/branches/4.0/src/documentation/content/xdocs/site.xml
(original)
+++ tapestry/tapestry4/branches/4.0/src/documentation/content/xdocs/site.xml
Wed Apr 26 21:22:07 2006
@@ -160,6 +160,7 @@
<TablePages label="TablePages" href="TablePages.html"/>
<TableValues label="TableValues" href="TableValues.html"/>
<TableView label="TableView" href="TableView.html"/>
+ <Timeout label="Timeout" href="Timeout.html"/>
<Tree label="Tree" href="Tree.html"/>
<TreeDataView label="TreeDataView" href="TreeDataView.html"/>
<TreeNodeView label="TreeNodeView" href="TreeNodeView.html"/>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
