The automatic-timeout Element"

From Documentation
m
m
Line 26: Line 26:
 
</source>
 
</source>
  
<blockquote>
+
For more information, please refer to [[ZK Developer's Reference/UI Patterns/Session Timeout Management]].
 +
 
 
=== Page-level Automatic Timeout ===
 
=== Page-level Automatic Timeout ===
  
Line 38: Line 39:
 
...
 
...
 
</source>
 
</source>
</blockquote>
 
  
 
=Version History=
 
=Version History=

Revision as of 14:48, 4 December 2010


The automatic-timeout Element


Syntax:

<automatic-timeout>true|false</automatic-timeout>
[Optional]
[Since 3.6.3]
[Default: false]

It specifies whether to automatically redirect to the timeout URI.

If false, it means a page will be redirected to the timeout URI, when the use takes some action after timeout.

In other words, nothing happens (no redirect) if the user does nothing on the page.

If it is set to true, it is redirected as soon as timeout, no matter the user takes any action.

Notice that this setting is applied only to the specified device (<device-type>), so remember to specify the correct device. For example,

<session-config>
	<device-type>ajax</device-type>
	<automatic-timeout/> <!-- the same as <automatic-timeout>true</automatic-timeout> -->
	<timeout-uri>/timeout.zul</timeout-uri>
</session-config>

For more information, please refer to ZK Developer's Reference/UI Patterns/Session Timeout Management.

Page-level Automatic Timeout

If you want to specify whether to automatically timeout for particular pages, you can use the page directive.

Moreover, it is better to turn off the automatic timeout for the timeout page you want to redirect to (if the page is a ZUML page). For example,

<!-- my timeout page -->
<?page automaticTimeout="false"?>
...

Version History

Last Update : 2010/12/04


Version Date Content
     



Last Update : 2010/12/04

Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.