Module jakarta.faces

Package com.sun.faces.lifecycle

Class ClientWindowImpl

java.lang.Object

jakarta.faces.lifecycle.ClientWindow

com.sun.faces.lifecycle.ClientWindowImpl

public class ClientWindowImpl
extends ClientWindow

Field Summary

Fields inherited from class jakarta.faces.lifecycle.ClientWindow

CLIENT_WINDOW_MODE_PARAM_NAME, NUMBER_OF_CLIENT_WINDOWS_PARAM_NAME

Constructor Summary

Constructors

Constructor	Description
ClientWindowImpl()

Method Summary

Modifier and Type	Method	Description
void	decode(FacesContext context)	The implementation is responsible for examining the incoming request and extracting the value that must be returned from the ClientWindow.getId() method.
String	getId()	Return a String value that uniquely identifies this ClientWindow within the scope of the current session.
Map<String,String>	getQueryURLParameters(FacesContext context)	This method will be called whenever a URL is generated by the runtime where client window related parameters need to be inserted into the URL.

Methods inherited from class jakarta.faces.lifecycle.ClientWindow

disableClientWindowRenderMode, enableClientWindowRenderMode, isClientWindowRenderModeEnabled

Methods inherited from class java.lang.Object

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

Constructor Details

ClientWindowImpl

public ClientWindowImpl()

Method Details

getQueryURLParameters

public Map<String,String> getQueryURLParameters(FacesContext context)

Description copied from class: ClientWindow

This method will be called whenever a URL is generated by the runtime where client window related parameters need to be inserted into the URL. This guarantees custom ClientWindow implementations that they will have the opportunity to insert any additional client window specific information in any case where a URL is generated, such as the rendering of hyperlinks. The returned map must be immutable. The default implementation of this method returns the empty map.

Specified by:

getQueryURLParameters in class ClientWindow

Parameters:

context - the FacesContext for this request.

Returns:

null or a map of parameters to insert into the URL query string.

decode

public void decode(FacesContext context)

Description copied from class: ClientWindow

The implementation is responsible for examining the incoming request and extracting the value that must be returned from the ClientWindow.getId() method. If ClientWindow.CLIENT_WINDOW_MODE_PARAM_NAME is "none" this method must not be invoked. If ClientWindow.CLIENT_WINDOW_MODE_PARAM_NAME is "url" the implementation must first look for a request parameter under the name given by the value of ResponseStateManager.CLIENT_WINDOW_PARAM. If no value is found, look for a request parameter under the name given by the value of ResponseStateManager.CLIENT_WINDOW_URL_PARAM. If no value is found, fabricate an id that uniquely identifies this ClientWindow within the scope of the current session. This value must be made available to return from the ClientWindow.getId() method. The value must be suitable for inclusion as a hidden field or query parameter. If a value is found, decrypt it using the key from the session and make it available for return from ClientWindow.getId().

Specified by:

decode in class ClientWindow

Parameters:

context - the FacesContext for this request.

getId

public String getId()

Description copied from class: ClientWindow

Return a String value that uniquely identifies this ClientWindow within the scope of the current session. See ClientWindow.decode(jakarta.faces.context.FacesContext) for the specification of how to derive this value.

Specified by:

getId in class ClientWindow

Returns:

the id of the ClientWindow