| org.zkoss.zk.ui.util |
|
Utitilies to Handle User Interfaces
Utilities to handle user interfaces.
|
| Java Source File Name | Type | Comment |
| CharsetFinder.java | Interface | Represents a class that decides the character set based on the
content type and the real content. |
| Clients.java | Class | Utilities to send
AuResponse to the client.
Utilities here are mainly to control how the client (aka., the browser window)
behaves. |
| ComponentCloneListener.java | Interface | Used to notify an object stored in a component, when the
component is cloned.
When a component is cloned, it checks every
attribute (
Component.setAttribute )
and listener (
Component.addEventListener )
to see whether this interface is implemented.
If implemented,
ComponentCloneListener.clone will be called. |
| ComponentSerializationListener.java | Interface | Used to notify an object stored in a component, when the component
is going to be serialized or has been deserialized. |
| Composer.java | Interface | Represents a composer to initialize a component (or a component of tree)
when ZK loader is composing a component. |
| ComposerExt.java | Interface | An addition interface implemented with
Composer to provide
more control. |
| Condition.java | Interface | A condition to test with. |
| ConditionImpl.java | Class | An utility to simplify the implementation of
Condition . |
| Configuration.java | Class | The ZK configuration. |
| DeferredValue.java | Interface | Used with
org.zkoss.zk.ui.Component.smartUpdateDeferred(StringDeferredValue) to represent a value that shall be evaluated only in the rendering phase
(rather than in the event processing phase). |
| DesktopCleanup.java | Interface | Used to clean up a desktop. |
| DesktopInit.java | Interface | Used to initialize a desktop when it is created. |
| DesktopSerializationListener.java | Interface | Used to notify an object stored in a desktop, when the desktop
is going to be serialized or has been deserialized. |
| EventInterceptor.java | Interface | The event interceptor used to intercept the processing of events. |
| ExecutionCleanup.java | Interface | Used to clean up an execution. |
| ExecutionInit.java | Interface | Used to initialize an execution when it is created. |
| ForEach.java | Interface | Used to denote a collection of elements. |
| ForEachImpl.java | Class | An implementation of
ForEach .
Note: the use of
ForEachImpl is different from
ConditionImpl . |
| ForEachStatus.java | Interface | Represents the runtime information of each iteration caused by
ForEach . |
| GenericComposer.java | Class | An abstract composer that you can extend and write intuitive onXxx event handler methods;
this class will registers onXxx events to the supervised component automatically.
The following is an example. |
| Initiator.java | Interface | Implemented by an initiator that will be invoked if it is specified
in the init directive.
<?init class="MyInit"?>
Once specified, an instance is created and
Initiator.doInit is called
before the page is evaluated. |
| InitiatorExt.java | Interface | An extra interface that can be implemented with
Initiator to
have the better control. |
| Monitor.java | Interface | A listener to monitor the status of ZK engine. |
| PageSerializationListener.java | Interface | Used to notify an object stored in a page, when the page
is going to be serialized or has been deserialized. |
| PerformanceMeter.java | Interface | A listener to measure the performance of certain activities.
Note: ZK doesn't fork another low-priority thread to call the
methods defined in this listener. |
| RequestInterceptor.java | Interface | Used to intercept the requests for the ZK Loader and Update Engine.
Developers usually use it to prepare the locale and time zone.
RequestInterceptor.request is called at very early stage, even before
setting the locale for the request.
Thus, you can configure the locale as follows:
sess.setAttribute(
org.zkoss.web.Attributes.PREFERRED_LOCALE , myLocale);
By default, the locale is decided by the browser's preference.
However, you may want to store the previous locale in the cookie
if your application is HTTP. |
| SessionCleanup.java | Interface | Used to clean up a session. |
| SessionInit.java | Interface | Used to initialize a session when it is created. |
| SessionSerializationListener.java | Interface | Used to notify an object stored in a session, when the session
is going to be serialized or has been deserialized. |
| Statistic.java | Class | An implementation of
Monitor to accumulate statistic data
in memory. |
| ThemeProvider.java | Interface | Used to replace the theme defined in the language definitions
(lang.xml and lang-addon.xml) and the configuration
(the theme-uri elements in web.xml). |
| URIInterceptor.java | Interface | Used to intercept the loading of ZUML pages associated with the specfied URI.
Developers usually use it to do the security check.
How this interface is used.
- First, you specify a class that implements this interface
in WEB-INF/zk.xml as a listener.
Then, an instance of the specified class is created.
- Each time ZK wants to load a page definition based on an URI,
URIInterceptor.request is called against the instance created in
the previous step.
Note:
- Unlike
ExecutionInit and others listeners, the same instance of
URIInterceptor is used for the whole application.
Thus, you have to make sure it can be accessed concurrently.
-
URIInterceptor.request is called even if the page definition is cached.
URIInterceptor is called when retrieving a page definition
from an URI (
org.zkoss.zk.ui.metainfo.PageDefinitions.getPageDefinition ). |
| WebAppCleanup.java | Interface | Used to initialize a ZK application when it about to be destroyed. |
| WebAppInit.java | Interface | Used to initialize a ZK application when it is created. |