org.apache.deltaspike.jsf.spi.scope.window

Interface ClientWindow

public interface ClientWindow

API to interact with the window/browser tab handling. This originally got implemented in Apache MyFaces CODI which was the basis for the respective feature in JSF-2.2. We now orientate us a bit on the JSF-2.2 API for making it easier to provide this feature for JSF-2.0, JSF-2.1 and also JSF-2.2 JSF implementations.

Please not that in JSF-2.2 a javax.faces.lifecycle.ClientWindow instance gets created for each and every request, but in DeltaSpike our ClientWindow instances are most likely @ApplicationScoped.

Method Summary

Modifier and Type	Method and Description
void	disableClientWindowRenderMode(javax.faces.context.FacesContext facesContext) Can be called to disable the window-id for an URL.
void	enableClientWindowRenderMode(javax.faces.context.FacesContext facesContext) Can be used to reset window-id rendering for a specific component.
Map<String,String>	getQueryURLParameters(javax.faces.context.FacesContext facesContext)
String	getWindowId(javax.faces.context.FacesContext facesContext) Extract the windowId for the current request.
boolean	isClientWindowRenderModeEnabled(javax.faces.context.FacesContext facesContext)

Method Detail

getWindowId

String getWindowId(javax.faces.context.FacesContext facesContext)

Extract the windowId for the current request. This method is intended to get executed at the start of the JSF lifecycle. We also need to take care about JSF-2.2 ClientWindow in the future. Depending on the ClientWindowConfig.ClientWindowRenderMode and after consulting ClientWindowConfig we will first send an intermediate page if the request is an initial GET request.

Parameters:

facesContext - for the request

Returns:

the extracted WindowId of the Request, or null if there is no window assigned.

disableClientWindowRenderMode

void disableClientWindowRenderMode(javax.faces.context.FacesContext facesContext)

Can be called to disable the window-id for an URL. Don't forget to call enableClientWindowRenderMode(javax.faces.context.FacesContext) after rendering the markup for the current component, if isClientWindowRenderModeEnabled(javax.faces.context.FacesContext) returned true before calling this method.

enableClientWindowRenderMode

void enableClientWindowRenderMode(javax.faces.context.FacesContext facesContext)

Can be used to reset window-id rendering for a specific component.

isClientWindowRenderModeEnabled

boolean isClientWindowRenderModeEnabled(javax.faces.context.FacesContext facesContext)

Returns:

true if the window-id should be appended during the rendering-process, false otherwise

getQueryURLParameters

Map<String,String> getQueryURLParameters(javax.faces.context.FacesContext facesContext)

Returns:

meta-data for the current window which should get added to URLs, null otherwise