Use Native Namespace instead of XHTML Namespace

From Documentation

DocumentationZK Developer's ReferencePerformance TipsUse Native Namespace instead of XHTML Namespace
Use Native Namespace instead of XHTML Namespace

ZK creates a component (one of the derives of AbstractTag) for each XML element specified with the XHTML component set. In other words, ZK will maintain their states on the server. However, if you won't change their states dynamically (i.e., after instantiated), you could use the native namespace instead.

For example, the following code snippet creates five components (one Table, Tr, Textbox and two Td).

1 <h:table xmlns:h="xhtml">
2     <h:tr>
3         <h:td>Name</h:td>
4         <h:td>
5         <textbox/>
6         </h:td>
7     </h:tr>
8 </h:table>

On the other hand, the following code snippet won't create components for any elements specified with the native space (with prefix n:)[1].

1 <n:table xmlns:n="native">
2     <n:tr>
3         <n:td>Name</n:td>
4         <n:td>
5         <textbox/>
6         </n:td>
7     </n:tr>
8 </n:table>

Notice that table, tr and td are generated directly to the client, so they have no counterpart at the server. You cannot change their states dynamically. For example, the following code snippet is incorrect.

1 <n:ul id="x" xmlns:n="native"/>
2 <button label="add" onClick="new Li().setParent(x)"/>

If you have to change them dynamically, you still have to use the XHTML component set, or you could use Html alternatively, if the HTML tags won't contain any ZUL component.

Notice that you could create the native components in Java too. For more information, please refer to the native namespace section.

    HtmlNativeComponent n =
        new HtmlNativeComponent("table", "<tr><td>When:</td><td>", "</td></tr>");
    n.setDynamicProperty("border", "1");
    n.setDynamicProperty("width", "100%");
    n.appendChild(new Datebox());

  1. In fact, it will still create some components for the rerender purpose, such as Component.invalidate(). However, since they shall not be accessed, you could imagine them as not created at all.

The Stub-izing of Native Components

By default, a native component will be stub-ized, i.e., they will be replaced with a stateless component called StubComponent, such that the memory footprint will be minimized[1]

Though rarely, you could disable the stubing by setting a component attribute called org.zkoss.zk.ui.stub.native (i.e., Attributes.STUB_NATIVE). A typical case is that suppose you have a component that has a native descendant, and you'd like to detach it and re-attach later. Then, you have to set this attribute to false, since the server does not maintain the states of stub-ized components (thus, it cannot be restored when attached back).

    <custom-attributes org.zkoss.zk.ui.stub.native="false"/>
    <n:table xmlns:n="native"> <!-- won't be stub-ized -->

Once set, descendant components unless it was set explicitly.

  1. Non-native components could be stub-ized too by use of Component.setStubonly(String). For more information, please refer here.

Version History

Version Date Content
5.0.6 January, 2011 The attribute called org.zkoss.zk.ui.stub.native was introduced to disable the stub-ization.

Last Update : 2024/02/01

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