org.zkoss.zul.api
Interface Script

All Known Implementing Classes:

Script

public interface Script

A component to represent script codes running at the client. It is the same as HTML SCRIPT tag.

Note: it is the scripting codes running at the client, not at the server. Don't confuse it with the zscript element.

There are three formats when used in a ZUML page:

Method 1: Specify the URL of the JS file

 <code><script type="text/javascript" src="my.js"/>
 </code>
 

Method 2: Specify the JavaScript codes directly

 <code><script type="text/javascript">
 some_js_at_browser();
 </script>
 </code>
 

Method 3: Specify the JavaScript codes by use of the content property ( setContent(java.lang.String)).

 <code><script type="text/javascript">
 <attribute name="content">
  some_js_at_browser();
 </attribute>
 </script>
 </code>
 

Since:

3.5.2

Author:

tomyeh

Method Summary

java.lang.String	getCharset() Returns the character enconding of the source.
java.lang.String	getContent() Returns the content of the script element.
java.lang.String	getSrc() Returns the URI of the source that contains the script codes.
java.lang.String	getType() Returns the type of this client script.
boolean	isDefer() Returns whether to defer the execution of the script codes.
void	setCharset(java.lang.String charset) Sets the character encoding of the source.
void	setContent(java.lang.String content) Sets the content of the script element.
void	setDefer(boolean defer) Sets whether to defer the execution of the script codes.
void	setSrc(java.lang.String src) Sets the URI of the source that contains the script codes.
void	setType(java.lang.String type) Sets the type of this client script.

Method Detail

getType

java.lang.String getType()

Returns the type of this client script.

Default: text/javascript.

setType

void setType(java.lang.String type)

Sets the type of this client script. For JavaScript, it is text/javascript

Note: this property is NOT optional. You must specify one.

getCharset

java.lang.String getCharset()

Returns the character enconding of the source. It is used with getSrc().

Default: null.

setCharset

void setCharset(java.lang.String charset)

Sets the character encoding of the source. It is used with setSrc(java.lang.String).

getSrc

java.lang.String getSrc()

Returns the URI of the source that contains the script codes.

Default: null.

setSrc

void setSrc(java.lang.String src)

Sets the URI of the source that contains the script codes.

You either add the script codes directly with the Label children, or set the URI to load the script codes with setSrc(java.lang.String). But, not both.

Parameters:

src - the URI of the source that contains the script codes

isDefer

boolean isDefer()

Returns whether to defer the execution of the script codes.

Default: false.

setDefer

void setDefer(boolean defer)

Sets whether to defer the execution of the script codes.

getContent

java.lang.String getContent()

Returns the content of the script element. By content we mean the JavaScript codes that will be enclosed by the HTML SCRIPT element.

Default: null.

setContent

void setContent(java.lang.String content)

Sets the content of the script element. By content we mean the JavaScript codes that will be enclosed by the HTML SCRIPT element.