org.apache.deltaspike.core.spi.scope.window

Interface WindowContext

public interface WindowContext

We support the general notion of multiple 'windows' That might be different parallel edit pages in a desktop application (think about different open documents in an editor) or multiple browser tabs in a web application.

For web applications each browser tab or window will be represented by an own WindowContext slice. All those WindowContext slices will be held in the users servlet session as @SessionScoped bean.

Every WindowContext is uniquely identified via a 'windowId' inside the current Session. Each Thread is associated with at most one single windowId at a time. The WindowContext is the interface which allows resolving the current windowId associated with this very Thread.

Method Summary

Methods

Modifier and Type	Method and Description
void	activateWindow(String windowId) Set the current windowId as the currently active for the very Thread.
boolean	closeWindow(String windowId) close the WindowContext with the given windowId.
String	getCurrentWindowId()

Method Detail

getCurrentWindowId

String getCurrentWindowId()

Returns:

the windowId associated with the very Thread or null.

activateWindow

void activateWindow(String windowId)

Set the current windowId as the currently active for the very Thread. If no WindowContext exists with the very windowId we will create a new one.

Parameters:

windowId -

closeWindow

boolean closeWindow(String windowId)

close the WindowContext with the given windowId.

Returns:

true if any did exist, false otherwise