Script"

From Documentation
 
(5 intermediate revisions by the same user not shown)
Line 10: Line 10:
 
The script component is used to specify the script codes running at the browser. Notice that, unlike zscript, the script codes are running at the browser. They are usually written in JavaScript which is supported by the most of browsers. The simplest format is as follows.
 
The script component is used to specify the script codes running at the browser. Notice that, unlike zscript, the script codes are running at the browser. They are usually written in JavaScript which is supported by the most of browsers. The simplest format is as follows.
  
== Example ==
+
= Example =
  
 
[[Image:ZKComRef_Script_Example.png ]]  
 
[[Image:ZKComRef_Script_Example.png ]]  
Line 38: Line 38:
 
The defer attribute can be used with a JavaScript file as shown below. Then, the JavaScript file will be loaded after all widgets are created and bound to the DOM tree.
 
The defer attribute can be used with a JavaScript file as shown below. Then, the JavaScript file will be loaded after all widgets are created and bound to the DOM tree.
  
<syntax lang="xml">
+
<syntaxhighlight lang="xml">
 
<script src="/js/foo.js" defer="true"/>
 
<script src="/js/foo.js" defer="true"/>
</syntax>
+
</syntaxhighlight>
  
This is required if the script to load intends to manipulate a ZK widget's DOM elements
+
This is required if the script to load intends to manipulate a ZK widget's DOM elements. <code>defer="true"</code> can ensure that all widgets' DOM elements are already generated.
  
 
=Alternatives=
 
=Alternatives=
  
Instead of using the script component, you could use [[ZUML_Reference/ZUML/Processing_Instructions/script|the script directive]] instead. It does not support <code>defer</code>, but it is more efficient since no component is created.
+
== Load Javascript in head tag - script directive==
 +
Instead of using this component, you can use [[ZUML_Reference/ZUML/Processing_Instructions/script|the script directive]] instead. It does not support <code>defer</code>, but it consumes no memory since no component is created. And it generated <code>&lt;script></code> in HTML <code>&lt;head></code>, so the specified script will be loaded earlier than body DOM is created.
  
 
<source lang="xml">
 
<source lang="xml">
Line 52: Line 53:
 
<?script content="jq.IE6_ALPHAFIX='.png';"?>
 
<?script content="jq.IE6_ALPHAFIX='.png';"?>
 
</source>
 
</source>
 +
* Line 1: loads the debug utility
 +
* Line 2: generates a JavaScript code snippet directly.
  
where the first statement loads the debug utility and the second generates a JavaScript code snippet directly.
 
  
Another alternative is HTML SCRIPT.  For example, we could define global variables and functions as follows
+
==HTML script tag ==
 +
Another alternative is the HTML SCRIPT tag.  For example, we can define global variables and functions as follows:
  
 
<source lang="xml">
 
<source lang="xml">
Line 69: Line 72:
 
=Supported Events=
 
=Supported Events=
  
{| class='wikitable' | width="100%"
 
! <center>Name</center>
 
! <center>Event Type</center>
 
|-
 
| None
 
| None
 
|}
 
 
*Inherited Supported Events: [[ZK_Component_Reference/Base_Components/AbstractComponent#Supported_Events | AbstractComponent]]
 
*Inherited Supported Events: [[ZK_Component_Reference/Base_Components/AbstractComponent#Supported_Events | AbstractComponent]]
  
Line 93: Line 89:
 
|}
 
|}
  
=Version History=
+
 
{{LastUpdated}}
 
{| class='wikitable' | width="100%"
 
! Version !! Date !! Content
 
|-
 
| &nbsp;
 
| &nbsp;
 
| &nbsp;
 
|}
 
  
 
{{ZKComponentReferencePageFooter}}
 
{{ZKComponentReferencePageFooter}}

Latest revision as of 10:17, 25 April 2024

Script

Employment/Purpose

The script component is used to specify the script codes running at the browser. Notice that, unlike zscript, the script codes are running at the browser. They are usually written in JavaScript which is supported by the most of browsers. The simplest format is as follows.

Example

ZKComRef Script Example.png

<window id="win">
	<button label="change color" onClick='Clients.evalJavaScript("myfunc()")' />
</window>
<script type="text/javascript">
	function myfunc() {
	    jq("$win").css("backgroundColor", "blue");
	}
 </script>

Defer the Evaluation

By default, the specified JavaScript code will be evaluated as soon as the page is loaded. By specifying defer="true", the JavaScript code won't be evaluated until all ZK widgets are created and bound to the DOM tree.

<textbox id="inp"/>
<script defer="true">
   this.$f("inp").setValue("initialized");
</script>

The defer attribute can be used with a JavaScript file as shown below. Then, the JavaScript file will be loaded after all widgets are created and bound to the DOM tree.

<script src="/js/foo.js" defer="true"/>

This is required if the script to load intends to manipulate a ZK widget's DOM elements. defer="true" can ensure that all widgets' DOM elements are already generated.

Alternatives

Load Javascript in head tag - script directive

Instead of using this component, you can use the script directive instead. It does not support defer, but it consumes no memory since no component is created. And it generated <script> in HTML <head>, so the specified script will be loaded earlier than body DOM is created.

<?script src="~./js/zk.debug.wpd"?>
<?script content="jq.IE6_ALPHAFIX='.png';"?>
  • Line 1: loads the debug utility
  • Line 2: generates a JavaScript code snippet directly.


HTML script tag

Another alternative is the HTML SCRIPT tag. For example, we can define global variables and functions as follows:

<n:script xmlns:n="native"><!-- use the native namespace -->
	var a_global_variable;
	function a_global_function () {
		alert("native script");
	}
	alert("you can not access this as widget but evaluated immediately");
</n:script>

Supported Events

Supported Children

*NONE

Use Cases

Version Description Example Location
5.0 Overview and Tutorial Client Side Programming

ZK Client-side Reference: General Control




Last Update : 2024/04/25

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