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

Interface ClientWindowConfig

All Superinterfaces:

Serializable

All Known Implementing Classes:

DefaultClientWindowConfig

public interface ClientWindowConfig
extends Serializable

Configuration for ClientWindow handler which is used to determine the correct windowId for ?WindowScoped beans.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ClientWindowConfig.ClientWindowRenderMode

Method Summary

Modifier and Type	Method and Description
String	getClientWindowHtml()
ClientWindowConfig.ClientWindowRenderMode	getClientWindowRenderMode(javax.faces.context.FacesContext facesContext) Determine whether this request should take care of clientWindow detection.
int	getMaxWindowContextCount() Restricts the number of active windows.
boolean	isClientWindowStoreWindowTreeEnabledOnButtonClick()
boolean	isClientWindowStoreWindowTreeEnabledOnLinkClick()
boolean	isClientWindowTokenizedRedirectEnabled()
boolean	isJavaScriptEnabled()
void	setJavaScriptEnabled(boolean javaScriptEnabled)

Method Detail

isJavaScriptEnabled

boolean isJavaScriptEnabled()

Returns:

whether JavaScript is enabled

setJavaScriptEnabled

void setJavaScriptEnabled(boolean javaScriptEnabled)

Parameters:

javaScriptEnabled - whether JavaScript is enabled

getClientWindowRenderMode

ClientWindowConfig.ClientWindowRenderMode getClientWindowRenderMode(javax.faces.context.FacesContext facesContext)

Determine whether this request should take care of clientWindow detection. This can e.g. get disabled for download pages or if a useragent doesn't support html5 or any other required technique. This only gets checked for GET requests!

Parameters:

facesContext -

Returns:

the selected ClientWindowRenderMode

getClientWindowHtml

String getClientWindowHtml()

Returns:

the prepared html which gets sent out to the client as intermediate client window.

isClientWindowStoreWindowTreeEnabledOnLinkClick

boolean isClientWindowStoreWindowTreeEnabledOnLinkClick()

Returns:

Whether the DOM tree should stored in the localStorage for the windowhandler.html when clicking on a link. Currently it's only used by ClientWindowConfig.ClientWindowRenderMode.CLIENTWINDOW.

See Also:

windowhandler.html

isClientWindowStoreWindowTreeEnabledOnButtonClick

boolean isClientWindowStoreWindowTreeEnabledOnButtonClick()

Returns:

Whether the DOM tree should stored in the localStorage for the windowhandler.html when clicking on a button. Currently it's only used by ClientWindowConfig.ClientWindowRenderMode.CLIENTWINDOW.

See Also:

windowhandler.html

isClientWindowTokenizedRedirectEnabled

boolean isClientWindowTokenizedRedirectEnabled()

getMaxWindowContextCount

int getMaxWindowContextCount()

Restricts the number of active windows.

Returns:

limit for active windows