ZK AU Engine"

From Documentation
m (correct highlight (via JWB))
Line 7: Line 7:
 
ZK AU Engine, aka., ZK Update Engine, is a servlet that handles AJAX requests asynchronously and automatically.
 
ZK AU Engine, aka., ZK Update Engine, is a servlet that handles AJAX requests asynchronously and automatically.
  
Notice that the URL pattern mapped to this engine must be consistent with the <tt>update-uri</tt> parameter of [[ZK_Configuration_Reference/web.xml/ZK_Loader|ZK Loader]].
+
Notice that the URL pattern mapped to this engine must be consistent with the <code>update-uri</code> parameter of [[ZK_Configuration_Reference/web.xml/ZK_Loader|ZK Loader]].
  
 
Here is [[ZK_Configuration_Reference/web.xml/Sample_of_web.xml|a complete sample]].
 
Here is [[ZK_Configuration_Reference/web.xml/Sample_of_web.xml|a complete sample]].
Line 19: Line 19:
 
|-
 
|-
 
|  compress
 
|  compress
|  [Optional][Default:<tt>true</tt>][since 3.6.3]
+
|  [Optional][Default:<code>true</code>][since 3.6.3]
  
  
It specifies whether to compress the output of this Servlet, if the browser supports the compression (<tt>Accept-Encoding</tt>). Notice that it affects not only the AU response, but also JavaScript and CSS files loaded from this Servlet.
+
It specifies whether to compress the output of this Servlet, if the browser supports the compression (<code>Accept-Encoding</code>). Notice that it affects not only the AU response, but also JavaScript and CSS files loaded from this Servlet.
  
 
<source lang="xml" >
 
<source lang="xml" >
Line 41: Line 41:
 
| [Optional] [since 5.0]
 
| [Optional] [since 5.0]
  
It specifies an AU extension The first processor must be specified with the name called <tt>extension0</tt>, second <tt>extension1</tt> and so on.
+
It specifies an AU extension The first processor must be specified with the name called <code>extension0</code>, second <code>extension1</code> and so on.
  
 
The syntax of the value is
 
The syntax of the value is
Line 79: Line 79:
 
</source>
 
</source>
  
Notice that the URL pattern mapped to this engine must be consistent with the <tt>update-uri</tt> parameter of [[ZK_Configuration_Reference/web.xml/ZK_Loader|ZK Loader]].
+
Notice that the URL pattern mapped to this engine must be consistent with the <code>update-uri</code> parameter of [[ZK_Configuration_Reference/web.xml/ZK_Loader|ZK Loader]].
  
 
Here is [[ZK_Configuration_Reference/web.xml/Sample_of_web.xml|a complete sample]].
 
Here is [[ZK_Configuration_Reference/web.xml/Sample_of_web.xml|a complete sample]].

Revision as of 10:18, 19 January 2022


DHtmlUpdateServlet

[Required] Class: DHtmlUpdateServlet


ZK AU Engine, aka., ZK Update Engine, is a servlet that handles AJAX requests asynchronously and automatically.

Notice that the URL pattern mapped to this engine must be consistent with the update-uri parameter of ZK Loader.

Here is a complete sample.

The Initial Parameters

init-param
Descriptions
compress [Optional][Default:true][since 3.6.3]


It specifies whether to compress the output of this Servlet, if the browser supports the compression (Accept-Encoding). Notice that it affects not only the AU response, but also JavaScript and CSS files loaded from this Servlet.

<init-param>
	<param-name>compress</param-name>
	<param-value>false</param-value>
</init-param>
extension0

extension1

extension2

...

[Optional] [since 5.0]

It specifies an AU extension The first processor must be specified with the name called extension0, second extension1 and so on.

The syntax of the value is

/prefix=class

For example,

<init-param>
	<param-name>extension0</param-name>
	<param-value>/upload=com.super.MyUploader</param-value>
</init-param>
<init-param>
	<param-name>extension1</param-name>
	<param-value>/extra=com.super.MyExtra</param-value>
</init-param>


The class must implement the AuExtension interface.

Map URL to ZK AU Engine

Mapping URL to ZK AU Engine is straightforward:

	<servlet>
		<servlet-name>auEngine</servlet-name>
		<servlet-class>org.zkoss.zk.au.http.DHtmlUpdateServlet</servlet-class>
	</servlet>
	<servlet-mapping>
		<servlet-name>auEngine</servlet-name>
		<url-pattern>/zkau/*</url-pattern>
	</servlet-mapping>

Notice that the URL pattern mapped to this engine must be consistent with the update-uri parameter of ZK Loader.

Here is a complete sample.

Version History

Version Date Content
5.0.0 07/14/10 processor0, processor1, processor2 parameters have been depreciated.



Last Update : 2022/01/19

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