Uses of Interface
org.zkoss.zk.ui.Desktop

Packages that use Desktop

Package	Description
org.zkoss.zk.au
org.zkoss.zk.au.http
org.zkoss.zk.au.out
org.zkoss.zk.device
org.zkoss.zk.ui
org.zkoss.zk.ui.http
org.zkoss.zk.ui.impl
org.zkoss.zk.ui.sys
org.zkoss.zk.ui.util

Uses of Desktop in org.zkoss.zk.au

Methods in org.zkoss.zk.au that return Desktop

Modifier and Type	Method	Description
Desktop	AuRequest.getDesktop()	Returns the desktop; never null.

Methods in org.zkoss.zk.au with parameters of type Desktop

Modifier and Type	Method	Description
static <T extends Component> Set<T>	AuRequests.convertToItems(Desktop desktop, List<String> uuids)	Converts the data of the specified request to a set of Component.
List<AuRequest>	AuDecoder.decode(Object request, Desktop desktop)	Returns a list of AuRequest by decoding the request.

Constructors in org.zkoss.zk.au with parameters of type Desktop

Modifier	Constructor	Description
	AuRequest(Desktop desktop, String uuid, String cmd, Map<String,Object> data)	Constructor for a request sent from a component.
	AuRequest(Desktop desktop, String cmd, Map<String,Object> data)	Constructor for a general request sent from client.

Uses of Desktop in org.zkoss.zk.au.http

Methods in org.zkoss.zk.au.http that return Desktop

Modifier and Type	Method	Description
protected Desktop	DHtmlUpdateServlet.getDesktop(Session sess, String dtid)	Returns the desktop of the specified ID, or null if not found.
protected Desktop	DHtmlUpdateServlet.recoverDesktop(Session sess, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, WebAppCtrl wappc, String dtid)	Recovers the desktop if possible.

Uses of Desktop in org.zkoss.zk.au.out

Constructors in org.zkoss.zk.au.out with parameters of type Desktop

Modifier	Constructor	Description
	AuClientInfo(Desktop desktop)	Constructs a client-info response with the specified desktop.
	AuEcho(Desktop desktop)	Constructs an echo response with the specified desktop.
	AuEchoGlobal(String evtnm, String data, Desktop dt)

Constructor parameters in org.zkoss.zk.au.out with type arguments of type Desktop

Modifier	Constructor	Description
	AuEchoGlobal(String evtnm, String data, Collection<Desktop> dts)

Uses of Desktop in org.zkoss.zk.device

Methods in org.zkoss.zk.device with parameters of type Desktop

Modifier and Type	Method	Description
void	Device.sessionDidActivate(Desktop desktop)	Notification that the desktop, which owns this device, has just been activated (a.k.a., deserialized) by the Web container.
void	GenericDevice.sessionDidActivate(Desktop desktop)
void	Device.sessionWillPassivate(Desktop desktop)	Notification that the desktop, which owns this device, is about to be passivated (a.k.a., serialized) by the Web container.
void	GenericDevice.sessionWillPassivate(Desktop desktop)

Uses of Desktop in org.zkoss.zk.ui

Methods in org.zkoss.zk.ui that return Desktop

Modifier and Type	Method	Description
Desktop	AbstractComponent.getDesktop()
Desktop	Component.getDesktop()	Returns the desktop of this component, or null if this component doesn't belong to any desktop.
Desktop	Execution.getDesktop()	Returns the desktop associated with this execution.
Desktop	Page.getDesktop()	Returns the desktop that this page belongs to.

Methods in org.zkoss.zk.ui with parameters of type Desktop

Modifier and Type	Method	Description
static final void	Executions.activate(Desktop desktop)	Activates a thread to allow it access the given desktop synchronously.
static final boolean	Executions.activate(Desktop desktop, long timeout)	Activates a thread to allow it access the given desktop synchronously, or until a certain amount of time has elapsed.
static final void	Executions.deactivate(Desktop desktop)	Deactivates a thread that has invoked Executions.activate(org.zkoss.zk.ui.Desktop) successfully.
static final void	Executions.notify(Desktop desktop, Object mutex)	Wakes up a single event processing thread for the specified desktop that is waiting on the specified object.
static final void	Executions.notifyAll(Desktop desktop, Object mutex)	Wakes up all event processing threads for the specified desktop that are waiting on the specified object.
static <T extends Event> void	Executions.schedule(Desktop desktop, EventListener<T> task, T event)	Schedules a task to run under the server push of the given desktop asynchronously.

Uses of Desktop in org.zkoss.zk.ui.http

Methods in org.zkoss.zk.ui.http that return Desktop

Modifier and Type	Method	Description
static Desktop	DesktopRecycles.beforeService(DesktopRecycle dtrc, jakarta.servlet.ServletContext ctx, Session sess, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, String path)	Called before serving a HTTP request.
Desktop	WebManager.getDesktop(Session sess, jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, String path, boolean autocreate)	Returns the desktop of the specified request, or null if not found and autocreate is false, or it has been redirect or forward to other page.
static Desktop	ZKWebSocket.getDesktop(jakarta.websocket.Session wsession)	Returns the desktop from the given websocket session.

Methods in org.zkoss.zk.ui.http with parameters of type Desktop

Modifier and Type	Method	Description
static void	DesktopRecycles.afterService(DesktopRecycle dtrc, Desktop desktop)	Called after serving a HTTP request.
static void	WebManager.setDesktop(jakarta.servlet.http.HttpServletRequest request, Desktop desktop)	Sets the desktop to the specified request.

Constructors in org.zkoss.zk.ui.http with parameters of type Desktop

Modifier	Constructor	Description
	ExecutionImpl(jakarta.servlet.ServletContext ctx, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Desktop desktop, Page creating)	Constructs an execution for the given HTTP request.

Uses of Desktop in org.zkoss.zk.ui.impl

Classes in org.zkoss.zk.ui.impl that implement Desktop

Modifier and Type	Class	Description
class	DesktopImpl	The implementation of Desktop.

Methods in org.zkoss.zk.ui.impl that return Desktop

Modifier and Type	Method	Description
Desktop	AbstractExecution.getDesktop()
final Desktop	EventProcessor.getDesktop()	Returns the desktop.
final Desktop	PageImpl.getDesktop()
final Desktop	RequestInfoImpl.getDesktop()
Desktop	SimpleDesktopCache.getDesktop(String desktopId)
Desktop	SimpleDesktopCache.getDesktopIfAny(String desktopId)
Desktop	AbstractUiFactory.newDesktop(RequestInfo ri, String updateURI, String path)
Desktop	AbstractUiFactory.newDesktop(RequestInfo ri, String updateURI, String resourceURI, String path)

Methods in org.zkoss.zk.ui.impl that return types with arguments of type Desktop

Modifier and Type	Method	Description
List<Desktop>	SimpleDesktopCache.getAllDesktops()

Methods in org.zkoss.zk.ui.impl with parameters of type Desktop

Modifier and Type	Method	Description
void	SimpleDesktopCache.addDesktop(Desktop desktop)
boolean	UiEngineImpl.ceaseSuspendedThread(Desktop desktop, EventProcessingThread evtthd, String cause)
void	UiEngineImpl.desktopDestroyed(Desktop desktop)
Collection<EventProcessingThread>	UiEngineImpl.getSuspendedThreads(Desktop desktop)
static boolean	Utils.markClientInfoPerDesktop(Desktop desktop, String key)	Marks the per-desktop information of the given key will be generated, and returns true if the information is not generated yet (i.e., this method is NOT called with the given key).
ServerPush	AbstractUiFactory.newServerPush(Desktop desktop, Class klass)	Instantiates a server push of the given class.
String	StaticIdGenerator.nextComponentUuid(Desktop desktop, Component comp, ComponentInfo compInfo)
String	LegacyDesktopIdGenerator.nextDesktopId(Desktop desktop)
String	StaticIdGenerator.nextDesktopId(Desktop desktop)
void	UiEngineImpl.notify(Desktop desktop, Object mutex)
void	UiEngineImpl.notifyAll(Desktop desktop, Object mutex)
boolean	EventProcessingThreadImpl.processEvent(Desktop desktop, Component comp, Event event)	Ask this event thread to process the specified event.
void	SimpleDesktopCache.removeDesktop(Desktop desktop)
void	PageImpl.sessionDidActivate(Desktop desktop)
void	PageImpl.sessionWillPassivate(Desktop desktop)
void	AbstractExecution.setDesktop(Desktop desktop)
void	PollingServerPush.start(Desktop desktop)

Constructors in org.zkoss.zk.ui.impl with parameters of type Desktop

Modifier	Constructor	Description
protected	AbstractExecution(Desktop desktop, Page creating)	Constructs an execution.
	EventProcessor(Desktop desktop, Component comp, Event event)
	ExecutionCarryOver(Desktop desktop)
	RequestInfoImpl(Desktop desktop, Object request, org.zkoss.util.resource.Locator locator)	Constructor.
	RequestInfoImpl(WebApp wapp, Session sess, Desktop desktop, Object request, org.zkoss.util.resource.Locator locator)	Constructor

Uses of Desktop in org.zkoss.zk.ui.sys

Methods in org.zkoss.zk.ui.sys that return Desktop

Modifier and Type	Method	Description
Desktop	DesktopCache.getDesktop(String desktopId)	Returns the desktop for the specified desktop ID.
Desktop	RequestInfo.getDesktop()	Returns the desktop, or null if not created yet.
Desktop	DesktopCache.getDesktopIfAny(String desktopId)	Returns the desktop for the specified desktop ID, or null if not found.
Desktop	UiFactory.newDesktop(RequestInfo ri, String updateURI, String path)	Creates an instance of Desktop.
default Desktop	UiFactory.newDesktop(RequestInfo ri, String updateURI, String resourceURI, String path)	Creates an instance of Desktop.

Methods in org.zkoss.zk.ui.sys that return types with arguments of type Desktop

Modifier and Type	Method	Description
List<Desktop>	DesktopCache.getAllDesktops()	Returns all the desktops in this cache.

Methods in org.zkoss.zk.ui.sys with parameters of type Desktop

Modifier and Type	Method	Description
void	DesktopCache.addDesktop(Desktop desktop)	Adds a desktop to this session.
boolean	UiEngine.ceaseSuspendedThread(Desktop desktop, EventProcessingThread evtthd, String cause)	Ceases the specified event thread.
void	UiEngine.desktopDestroyed(Desktop desktop)	Called when a desktop is being removed.
Collection<EventProcessingThread>	UiEngine.getSuspendedThreads(Desktop desktop)	Returns a collection of suspended event processing threads belonging to the specified desktop, or empty if no suspended thread at all.
ServerPush	UiFactory.newServerPush(Desktop desktop, Class klass)	Creates and initializes the server push of the given class and desktop.
default String	IdGenerator.nextComponentUuid(Desktop desktop, Component comp, ComponentInfo compInfo)	Returns the next component UUID for the specified component, or null to generate the default UUID.
default String	IdGenerator.nextDesktopId(Desktop desktop)	Returns the next desktop ID for the specified desktop, or null to generate the default ID.
void	UiEngine.notify(Desktop desktop, Object obj)	Wakes up a single event processing thread for the specified desktop that is waiting on the specified object.
void	UiEngine.notifyAll(Desktop desktop, Object obj)	Wakes up all event processing threads for the specified desktop that are waiting on the specified object.
static final String	HtmlPageRenders.outSpecialJS(Desktop desktop)	Generates the special JavaScript code, such as the application's name.
void	FailoverManager.recover(Session sess, Execution exec, Desktop desktop)	Recovers the specified desktop.
void	DesktopCache.removeDesktop(Desktop desktop)	Removes a desktop from this session.
void	PageCtrl.sessionDidActivate(Desktop desktop)	Notification that the session, which owns this page, has just been activated (a.k.a., deserialized).
void	PageCtrl.sessionWillPassivate(Desktop desktop)	Notification that the session, which owns this page, is about to be passivated (a.k.a., serialized).
void	ExecutionCtrl.setDesktop(Desktop desktop)	Sets the desktop associated with this execution.
void	ServerPush.start(Desktop desktop)	Starts and initializes the server-push controller.

Uses of Desktop in org.zkoss.zk.ui.util

Fields in org.zkoss.zk.ui.util declared as Desktop

Modifier and Type	Field	Description
protected Desktop	GenericAutowireComposer.desktop	Implicit Object; the desktop.

Methods in org.zkoss.zk.ui.util that return Desktop

Modifier and Type	Method	Description
Desktop	DesktopRecycle.beforeService(Execution exec, String uri)	Called when an user requests the content of a page.

Methods in org.zkoss.zk.ui.util with parameters of type Desktop

Modifier and Type	Method	Description
void	Configuration.afterPageAttached(Page page, Desktop desktop)	Invokes UiLifeCycle.afterPageAttached(org.zkoss.zk.ui.Page, org.zkoss.zk.ui.Desktop) when a compnent's parent is changed.
void	UiLifeCycle.afterPageAttached(Page page, Desktop desktop)	Called after a page is attached to a desktop.
void	Configuration.afterPageDetached(Page page, Desktop prevdesktop)	Invokes UiLifeCycle.afterPageDetached(org.zkoss.zk.ui.Page, org.zkoss.zk.ui.Desktop) when a compnent's parent is changed.
void	UiLifeCycle.afterPageDetached(Page page, Desktop prevdesktop)	Called after a page is detached to a desktop.
void	DesktopRecycle.afterRemove(Session sess, Desktop desktop)	Called after a desktop is removed.
void	DesktopRecycle.afterService(Desktop desktop)	Called after the request is served.
void	Monitor.afterUpdate(Desktop desktop)	Called when an asynchronous updated has been processed.
void	Statistic.afterUpdate(Desktop desktop)
boolean	DesktopRecycle.beforeRemove(Execution exec, Desktop desktop, int cause)	Called when the client asks the server to remove a desktop because of the user's navigating to other URL or refreshing the page.
void	Monitor.beforeUpdate(Desktop desktop, List<AuRequest> requests)	Called when an asynchronous updated is called (and not yet processed).
void	Statistic.beforeUpdate(Desktop desktop, List<AuRequest> requests)
void	DesktopCleanup.cleanup(Desktop desktop)	called when a desktop is about to be destroyed.
void	Monitor.desktopCreated(Desktop desktop)	Called when a desktop is created.
void	Statistic.desktopCreated(Desktop desktop)
void	ExecutionMonitor.desktopDestroy(Desktop desktop)	Called when a desktop is destroyed.
void	Monitor.desktopDestroyed(Desktop desktop)	Called when a desktop is being destroyed.
void	Statistic.desktopDestroyed(Desktop desktop)
void	DesktopActivationListener.didActivate(Desktop desktop)	Called when a session has just been activated (and its value has been deserialized).
void	DesktopSerializationListener.didDeserialize(Desktop desktop)	Called when a desktop has de-serialized this object back.
void	ExecutionMonitor.executionAbort(Execution exec, Desktop desktop, Throwable t)	Called when the activation of the given execution is aborted.
void	ExecutionMonitor.executionActivate(Execution exec, Desktop desktop)	Called when an execution is activated.
void	ExecutionMonitor.executionDeactivate(Execution exec, Desktop desktop)	Called when an activated execution completes and is deactivated.
void	ExecutionMonitor.executionWait(Execution exec, Desktop desktop)	Called when an execution fails to activate and then being waiting for activation.
void	DesktopInit.init(Desktop desktop, Object request)	Called when a desktop is created and initialized.
void	Configuration.invokeDesktopCleanups(Desktop desktop)	Invokes DesktopCleanup.cleanup(org.zkoss.zk.ui.Desktop) for each relevant listener registered by Configuration.addListener(java.lang.Class<?>).
void	Configuration.invokeDesktopInits(Desktop desktop, Object request)	Invokes DesktopInit.init(org.zkoss.zk.ui.Desktop, java.lang.Object) for each relevant listener registered by Configuration.addListener(java.lang.Class<?>).
void	DesktopActivationListener.willPassivate(Desktop desktop)	Called when a session is about to be passivated (and then serialize its value).
void	DesktopSerializationListener.willSerialize(Desktop desktop)	Called when a desktop is going to serialize this object.