The automatic-timeout Element"

From Documentation
Line 30: Line 30:
 
=== Page-level Automatic Timeout ===
 
=== Page-level Automatic Timeout ===
  
If you want to specify whether to automatically timeout for particular pages, you can use [[ZUML Reference/ZUML/Processing Instructions/page#automaticTimeout | the page directive]].
+
If you want to specify whether or not to automatically timeout for particular pages, you can use [[ZUML Reference/ZUML/Processing Instructions/page#automaticTimeout | 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,
 
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,

Revision as of 02:59, 8 August 2011


The automatic-timeout Element


Syntax:

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

It specifies whether or not 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 would happen (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 or not 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 : 2011/08/08


Version Date Content
     



Last Update : 2011/08/08

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