org.zkoss.web.util.resource.dir"

From Documentation
Line 46: Line 46:
  
  
== Overriding with Classpath Web Resource Path ==
+
== Overriding JavaScript in a ZK JAR ==
ZK loads the JavaScript file under the classpath web resource path, '''<code>WEB-INF/classes/web/js</code>''', as the first priority. So that you can put javascript files there to override the JavaScript files in ZK jar under the corresponding path.  
+
ZK loads the JavaScript file under the [[ZK_Developer%27s_Reference/UI_Composing/ZUML/Include_a_Page#Classpath_Web_Resource_Path| class path web resource path]], '''<code>WEB-INF/classes/web/js</code>''', in a higher priority than JavaScript files in ZK jar (e.g. zul.jar). So that you put javascript files there to override the JavaScript files in ZK jar under the corresponding path.  
  
 
Assume you have a Maven project, you need to put JavaScript files under the path:
 
Assume you have a Maven project, you need to put JavaScript files under the path:

Revision as of 07:21, 2 March 2023


org.zkoss.web.util.resource.dir


IMPORTANT

Before enabling this feature upgrade to the latest available versions (older versions contain a critical security vulnerability).

The latest versions containing a fix are:

Property:

 org.zkoss.web.util.resource.dir
Applicable:
Dndsmalltalk-check-icon.png globally in zk.xml via <library-property>
Dndsmalltalk-cross-icon.png not as <custom-attribute>
Default: none

Since 5.0.0

It specifies a directory, where ZK will load the so-called Class-Web Resources (CWR), in addition to the class path. CWR includes JavaScript files, CSS files, and other resources that are specified in the form of ~./xxx.

By default, ZK only searches the class path for the required CWR. By specifying a directory here, ZK will search the directory first and then the class path. This implies that a developer can override the default behavior by providing a file with the same name.

Notice: never put security sensitive files in the directory specified here, since they can be accessed externally.

For example, assuming that we have a JavaScript package called foo.great and we want to put it to WEB-INF/cwr, we have to specify the following in WEB-INF/zk.xml:

	<library-property>
		<name>org.zkoss.web.util.resource.dir</name>
		<value>/WEB-INF/cwr</value>
	</library-property>

You can place zk.wpd and the required JavaScript files under the WEB-INF/cwr/js/foo/great directory.

Overriding JavaScript Files in a JAR

Though rarely needed, sometimes you might need to override a JavaScript file of a JAR file with this option. One example is that you don't have to re-package zul.jar when replacing zul/inp/Textbox.js that is part of zul.jar.

Rather, you could specify this library property as described above, and place the modified version of Textbox.js under the /WEB-INF/cwr/js/zul/inp directory. Then, ZK will load /WEB-INF/cwr/js/zul/inp/Textbox.js you placed rather than the default one in zul.jar.

debug-js enabled

Notice that if debug-js is turned on, ZK will actually look for Textbox.src.js rather than Textbox.js in the above example. Thus, it is suggested to put both files:

  • Textbox.src.js
  • Textbox.js

into the /WEB-INF/cwr/js/zul/inp directories. In addition, Textbox.src.js is suggested to be the readable one (for debugging purpose), while Textbox.js is the compressed one (for production purpose).


Overriding JavaScript in a ZK JAR

ZK loads the JavaScript file under the class path web resource path, WEB-INF/classes/web/js, in a higher priority than JavaScript files in ZK jar (e.g. zul.jar). So that you put javascript files there to override the JavaScript files in ZK jar under the corresponding path.

Assume you have a Maven project, you need to put JavaScript files under the path: src/main/resources/web/[JAVASCRIPT_PATH_IN_JAR]

So the js files will be packaged into WEB-INF/classes/web/.

The picture below demonstrates to override javascript files under zkcharts.jar/web/js/chart/ext:

OverrideByClasspathWebResourcePath.png

After doing this, then ZK will load highcharts.js under WEB-INF/classes/web/ instead of those js in jar.



Last Update : 2023/03/02

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