ZK Configuration Reference/zk.xml/The preference Element

Syntax:

<preference>
    <name>any name</name>
    <value>any value</value>
</preference>

[Optional]

Specify a preference with the preference element depicted above. The name and value are application specific and you can specify whatever value you like. Mupltie To avoid name conflict, it is suggested to prefix the name with your domain name, such as com.friend.some.another.

The preferences are application-level. They are shared by a single ZK application (WebApp).

They can then be retrieved back by calling the getPreference method of the Configuration class. Notice that each Web application has one configuration, which can be found by the use of getConfiguration method of the WebApp interface.

 String value = webApp.getConfiguration().getPreference("org.zkoss.name", null);
 if (value != null) {
     ...
 }

For a complete list of supported preferences, please refer to the Preferences section.

Version History

Version	Date	Content