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

Class DefaultClientWindowConfig

java.lang.Object

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

All Implemented Interfaces:

Serializable, ClientWindowConfig

@SessionScoped
public class DefaultClientWindowConfig
extends Object
implements ClientWindowConfig

Default implementation of ClientWindowConfig. By default it will use the internal windowhandler.html

You can @Specializes this class to tweak the configuration or provide a completely new implementation as @Alternative.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.deltaspike.jsf.spi.scope.window.ClientWindowConfig

ClientWindowConfig.ClientWindowRenderMode

Constructor Summary

Constructors

Constructor and Description
DefaultClientWindowConfig()

Method Summary

Modifier and Type	Method and Description
String	getClientWindowHtml()
ClientWindowConfig.ClientWindowRenderMode	getClientWindowRenderMode(javax.faces.context.FacesContext facesContext) By default we use ClientWindowRenderMode#LAZY unless we detect a bot.
String	getClientWindowResourceLocation() Overwrite this to define your own ClientWindow handler html location.
int	getMaxWindowContextCount() Restricts the number of active windows.
String	getUserAgent(javax.faces.context.FacesContext facesContext) This information will get stored as it cannot change during the session anyway.
protected void	init()
boolean	isClientWindowStoreWindowTreeEnabledOnButtonClick()
boolean	isClientWindowStoreWindowTreeEnabledOnLinkClick()
boolean	isClientWindowTokenizedRedirectEnabled()
boolean	isJavaScriptEnabled()
void	setJavaScriptEnabled(boolean javaScriptEnabled)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultClientWindowConfig

public DefaultClientWindowConfig()

Method Detail

init

@PostConstruct
protected void init()

isJavaScriptEnabled

public boolean isJavaScriptEnabled()

Specified by:

isJavaScriptEnabled in interface ClientWindowConfig

Returns:

whether JavaScript is enabled

setJavaScriptEnabled

public void setJavaScriptEnabled(boolean javaScriptEnabled)

Specified by:

setJavaScriptEnabled in interface ClientWindowConfig

Parameters:

javaScriptEnabled - whether JavaScript is enabled

getClientWindowRenderMode

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

By default we use ClientWindowRenderMode#LAZY unless we detect a bot. Use JsfModuleConfig.getDefaultWindowMode() to change this default behavior. Alternative: Override this method to exclude other requests from getting accessed.

Specified by:

getClientWindowRenderMode in interface ClientWindowConfig

Returns:

the selected ClientWindowRenderMode

getClientWindowHtml

public String getClientWindowHtml()

Specified by:

getClientWindowHtml in interface ClientWindowConfig

Returns:

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

getUserAgent

public String getUserAgent(javax.faces.context.FacesContext facesContext)

This information will get stored as it cannot change during the session anyway.

Returns:

the UserAgent of the request.

getClientWindowResourceLocation

public String getClientWindowResourceLocation()

Overwrite this to define your own ClientWindow handler html location. This will get picked up as resource from the classpath.

getMaxWindowContextCount

public int getMaxWindowContextCount()

Description copied from interface: ClientWindowConfig

Restricts the number of active windows.

Specified by:

getMaxWindowContextCount in interface ClientWindowConfig

Returns:

limit for active windows

isClientWindowStoreWindowTreeEnabledOnLinkClick

public boolean isClientWindowStoreWindowTreeEnabledOnLinkClick()

Specified by:

isClientWindowStoreWindowTreeEnabledOnLinkClick in interface ClientWindowConfig

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

public boolean isClientWindowStoreWindowTreeEnabledOnButtonClick()

Specified by:

isClientWindowStoreWindowTreeEnabledOnButtonClick in interface ClientWindowConfig

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

public boolean isClientWindowTokenizedRedirectEnabled()

Specified by:

isClientWindowTokenizedRedirectEnabled in interface ClientWindowConfig