org.zkoss.zk.ui.sys
Interface WebAppCtrl

All Known Implementing Classes:

AbstractWebApp, SimpleWebApp

public interface WebAppCtrl

Additional interface of WebApp for implementation.

Note: applications shall never access this interface.

Author:

tomyeh

Method Summary

void	destroy() Destroys this Web applicaiton.
DesktopCache	getDesktopCache(Session sess) Returns the desktop cache.
DesktopCacheProvider	getDesktopCacheProvider() Returns the desktop cache provider.
FailoverManager	getFailoverManager() Returns the failover manager, or null if not available.
IdGenerator	getIdGenerator() Returns the ID generator, or null if not available.
UiEngine	getUiEngine() Returns the UI engine for this Web application (never null).
UiFactory	getUiFactory() Returns the UI factory for this Web application (never null).
void	init(java.lang.Object context, Configuration config) Initializes this Web application.
void	sessionDidActivate(Session sess) Notification that the session has just been activated (aka., deserialized).
void	sessionWillPassivate(Session sess) Notification that the session is about to be passivated (aka., serialized).

Method Detail

init

void init(java.lang.Object context,
          Configuration config)

Initializes this Web application.

Parameters:

context - the servlet context, if servlets are used. Currently, ZK supports only servlets. In the future there might be more to support.

config - the configuration (never null)

destroy

void destroy()

Destroys this Web applicaiton.

Note; once destroyed, this instance cannot be used anymore.

getUiEngine

UiEngine getUiEngine()

Returns the UI engine for this Web application (never null).

getDesktopCache

DesktopCache getDesktopCache(Session sess)

Returns the desktop cache. A shortcut of getDesktopCacheProvider()'s DesktopCacheProvider.getDesktopCache(org.zkoss.zk.ui.Session).

getDesktopCacheProvider

DesktopCacheProvider getDesktopCacheProvider()

Returns the desktop cache provider.

getUiFactory

UiFactory getUiFactory()

Returns the UI factory for this Web application (never null).

getFailoverManager

FailoverManager getFailoverManager()

Returns the failover manager, or null if not available.

getIdGenerator

IdGenerator getIdGenerator()

Returns the ID generator, or null if not available.

Since:

2.4.1

sessionWillPassivate

void sessionWillPassivate(Session sess)

Notification that the session is about to be passivated (aka., serialized).

sessionDidActivate

void sessionDidActivate(Session sess)

Notification that the session has just been activated (aka., deserialized).