Three Steps to Generate XML Output with a ZUML Page"
From Documentation
m (correct highlight (via JWB)) |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
{{ZKDevelopersGuidePageHeader}} | {{ZKDevelopersGuidePageHeader}} | ||
| Line 7: | Line 6: | ||
=== Use the XML Component Set, http://www.zkoss.org/2007/xml === | === Use the XML Component Set, http://www.zkoss.org/2007/xml === | ||
| − | The XML component set (aka., the XML language, in ZK terminology) is used to generate XML output. Unlike the XUL or XHTML component sets, all unknown<ref name="ftn62">By the unknown tag we mean a tag that is not associated with a namespace, or the namespace is unknown.</ref> tags in a ZUML page are assumed to belong the Native namespace (< | + | The XML component set (aka., the XML language, in ZK terminology) is used to generate XML output. Unlike the XUL or XHTML component sets, all unknown<ref name="ftn62">By the unknown tag we mean a tag that is not associated with a namespace, or the namespace is unknown.</ref> tags in a ZUML page are assumed to belong the Native namespace (<code>http://www.zkoss.org/2005/native</code>) rather than throwing an exception. ZK generates them directly to the output without instantiating a ZK component for each of them. |
The following is an example that generates the SVG output. It looks very similar to the XML output you want to generate, except you can use zscript, EL expressions, macro components and other ZK features. | The following is an example that generates the SVG output. It looks very similar to the XML output you want to generate, except you can use zscript, EL expressions, macro components and other ZK features. | ||
| Line 44: | Line 43: | ||
where | where | ||
| − | * The content type is specified with the < | + | * The content type is specified with the <code>page</code> directive. For SVG, it is <code>image/svg+xml</code>. The <code>xml</code> processing instruction (<code><?xml?></code>) and <code>DOCTYPE</code> of the output are also specified in the <code>page</code> directive. Refer to the [http://books.zkoss.org/wiki/ZK_ZUML_Reference '''Developer's Reference'''] for more about the <code>page</code> directive. |
| − | * All tags in this example, such as < | + | * All tags in this example, such as <code>svg</code> and <code>circle</code>, are associated with a namespace (<code>http://www.w3.org/2000/svg</code>) that is unknown to ZK Loader. Thus, they are assumed to belong the Native namespace. They are output directly rather than instantiating a ZK component for each of them. Refer to the [http://books.zkoss.org/wiki/Developer%27s_Reference/ZUML_Component_Sets_and_XML_Namespaces#Standard_Namespaces ''' Native Namespace'''] section int the '''ZUML with the XUL Component Set''' chapter for more about the Native namespace. |
| − | * To use < | + | * To use <code>zscript</code>, <code>forEach</code> and other ZK specific features, you have to specify the ZK namespace ([http://www.zkoss.org/2005/zk http://www.zkoss.org/2005/zk]). |
=== Maps the File Extension to ZK Loader === | === Maps the File Extension to ZK Loader === | ||
| − | To let ZK Loader process the file, you have to associate it with the ZK Loader in < | + | To let ZK Loader process the file, you have to associate it with the ZK Loader in <code>WEB-INF/web.xml</code>. In this example, we map all files with the <code>.svg</code> extension to ZK Loader<ref name="ftn63">We assume ZK Loader (<code>zkLoader</code>) is mapped to <code>org.zkoss.zk.ui.http.DHtmlLayoutServlet</code>.</ref>: |
<source lang="xml" > | <source lang="xml" > | ||
| Line 59: | Line 58: | ||
=== Maps the File Extension to the XML Component Set === | === Maps the File Extension to the XML Component Set === | ||
| − | Unless the file extension is < | + | Unless the file extension is <code>.xml</code>, you have to associate it with the XML component set (aka., the XML language) explicitly in <code>WEB-INF/zk.xml</code>. In this example, we map <code>.svg</code> to the XML component set: |
<source lang="xml" > | <source lang="xml" > | ||
| Line 68: | Line 67: | ||
</source> | </source> | ||
| − | where < | + | where <code>xml</code> is the language name of the XML component set ([http://www.zkoss.org/2007/xml http://www.zkoss.org/2007/xml]). Thus, when ZK Loader parses a file with the <code>.svg</code> extension, it knows the default language is the XML component set. |
| + | |||
| + | <blockquote> | ||
| + | ---- | ||
| + | <references/> | ||
| + | </blockquote> | ||
{{ ZKDevelopersGuidePageFooter}} | {{ ZKDevelopersGuidePageFooter}} | ||
Latest revision as of 10:41, 19 January 2022
This documentation is for an older version of ZK. For the latest one, please click here.
- Uses the XML component set (http://www.zkoss.org/2007/xml).
- Maps the file extension to ZK Loader
- Maps the file extension to the XML component set
Use the XML Component Set, http://www.zkoss.org/2007/xml
The XML component set (aka., the XML language, in ZK terminology) is used to generate XML output. Unlike the XUL or XHTML component sets, all unknown[1] tags in a ZUML page are assumed to belong the Native namespace (http://www.zkoss.org/2005/native) rather than throwing an exception. ZK generates them directly to the output without instantiating a ZK component for each of them.
The following is an example that generates the SVG output. It looks very similar to the XML output you want to generate, except you can use zscript, EL expressions, macro components and other ZK features.
<?page contentType="image/svg+xml;charset=UTF-8"?>
<svg width="100%" height="100%" version="1.1" xmlns="[http://www.w3.org/2000/svg http://www.w3.org/2000/svg]"
xmlns:z="[http://www.zkoss.org/2005/zk http://www.zkoss.org/2005/zk]">
<z:zscript><![CDATA[
String[] bgnds = {"purple", "blue", "yellow"};
int[] rads = {30, 25, 20};
]]></z:zscript>
<circle style="fill:${each}" z:forEach="${bgnds}"
cx="${50+rads[forEachStatus.index]}"
cy="${20+rads[forEachStatus.index]}"
r="${rads[forEachStatus.index]}"/>
</svg>
The generated output will be
<svg xmlns="http://www.w3.org/2000/svg" width="100%" height="100%"
version="1.1">
<circle style="fill:purple" cx="80" cy="50" r="30">
</circle>
<circle style="fill:blue" cx="75" cy="45" r="25">
</circle>
<circle style="fill:yellow" cx="70" cy="40" r="20">
</circle>
</svg>
where
- The content type is specified with the
pagedirective. For SVG, it isimage/svg+xml. Thexmlprocessing instruction (<?xml?>) andDOCTYPEof the output are also specified in thepagedirective. Refer to the Developer's Reference for more about thepagedirective. - All tags in this example, such as
svgandcircle, are associated with a namespace (http://www.w3.org/2000/svg) that is unknown to ZK Loader. Thus, they are assumed to belong the Native namespace. They are output directly rather than instantiating a ZK component for each of them. Refer to the Native Namespace section int the ZUML with the XUL Component Set chapter for more about the Native namespace. - To use
zscript,forEachand other ZK specific features, you have to specify the ZK namespace (http://www.zkoss.org/2005/zk).
Maps the File Extension to ZK Loader
To let ZK Loader process the file, you have to associate it with the ZK Loader in WEB-INF/web.xml. In this example, we map all files with the .svg extension to ZK Loader[2]:
<servlet-mapping>
<servlet-name>zkLoader</servlet-name>
<url-pattern>*.svg</url-pattern>
</servlet-mapping>
Maps the File Extension to the XML Component Set
Unless the file extension is .xml, you have to associate it with the XML component set (aka., the XML language) explicitly in WEB-INF/zk.xml. In this example, we map .svg to the XML component set:
<language-mapping>
<language-name>xml</language-name>
<extension>svg</extension>
</language-mapping>
where xml is the language name of the XML component set (http://www.zkoss.org/2007/xml). Thus, when ZK Loader parses a file with the .svg extension, it knows the default language is the XML component set.