Jakarta EE 11.0.0 · com.sun.faces.lifecycle.ClientWindowImpl

Modifier and Type	Field and Description
pack-priv String	id

Access	Constructor and Description
public	ClientWindowImpl()

Method Summary

Modifier and Type	Method and Description
private String	calculateClientWindow(FacesContext context)
public void	decode(FacesContext the `FacesContext` for this request. context) Implements abstract jakarta.faces.lifecycle.ClientWindow.decode. The implementation is responsible for examining the incoming request and extracting the value that must be returned from the `getId` method.
public String	getId() Implements abstract jakarta.faces.lifecycle.ClientWindow.getId. Return a String value that uniquely identifies this `ClientWindow` within the scope of the current session.
public Map<String, String>	getQueryURLParameters(FacesContext the `FacesContext` for this request. context) Implements abstract jakarta.faces.lifecycle.ClientWindow.getQueryURLParameters. 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.

Inherited from jakarta.faces.lifecycle.ClientWindow:: disableClientWindowRenderMode enableClientWindowRenderMode isClientWindowRenderModeEnabled

id	back to summary
pack-priv String id

ClientWindowImpl	back to summary
public ClientWindowImpl()

Method Detail

calculateClientWindow	back to summary
private String calculateClientWindow(FacesContext context)

decode back to summary

decode	back to summary
public void decode(FacesContext context) Implements abstract jakarta.faces.lifecycle.ClientWindow.decode. Doc from jakarta.faces.lifecycle.ClientWindow.decode. The implementation is responsible for examining the incoming request and extracting the value that must be returned from the `getId` method. If `CLIENT_WINDOW_MODE_PARAM_NAME` is "none" this method must not be invoked. If `CLIENT_WINDOW_MODE_PARAM_NAME` is "url" the implementation must first look for a request parameter under the name given by the value of `jakarta.faces.render.ResponseStateManager#CLIENT_WINDOW_PARAM`. If no value is found, look for a request parameter under the name given by the value of `jakarta.faces.render.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 `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 `getId`. Parameters context:FacesContext the `FacesContext` for this request. Annotations @Override

public void decode(FacesContext context)

Implements abstract jakarta.faces.lifecycle.ClientWindow.decode.

Doc from jakarta.faces.lifecycle.ClientWindow.decode.

The implementation is responsible for examining the incoming request and extracting the value that must be returned from the getId method. If CLIENT_WINDOW_MODE_PARAM_NAME is "none" this method must not be invoked. If CLIENT_WINDOW_MODE_PARAM_NAME is "url" the implementation must first look for a request parameter under the name given by the value of jakarta.faces.render.ResponseStateManager#CLIENT_WINDOW_PARAM. If no value is found, look for a request parameter under the name given by the value of jakarta.faces.render.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 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 getId.

Parameters

context:FacesContext: the FacesContext for this request.

Annotations

@Override

getId back to summary

getId	back to summary
public String getId() Implements abstract jakarta.faces.lifecycle.ClientWindow.getId. Doc from jakarta.faces.lifecycle.ClientWindow.getId. Return a String value that uniquely identifies this `ClientWindow` within the scope of the current session. See `decode` for the specification of how to derive this value. Returns:String the id of the `ClientWindow` Annotations @Override

public String getId()

Implements abstract jakarta.faces.lifecycle.ClientWindow.getId.

Doc from jakarta.faces.lifecycle.ClientWindow.getId.

Return a String value that uniquely identifies this ClientWindow within the scope of the current session. See decode for the specification of how to derive this value.

Returns:String

the id of the ClientWindow

Annotations

@Override

getQueryURLParameters back to summary

getQueryURLParameters	back to summary
public Map<String, String> getQueryURLParameters(FacesContext context) Implements abstract jakarta.faces.lifecycle.ClientWindow.getQueryURLParameters. Doc from jakarta.faces.lifecycle.ClientWindow.getQueryURLParameters. 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. Parameters context:FacesContext the `FacesContext` for this request. Returns:Map<String, String> `null` or a map of parameters to insert into the URL query string. Annotations @Override

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

Implements abstract jakarta.faces.lifecycle.ClientWindow.getQueryURLParameters.

Doc from jakarta.faces.lifecycle.ClientWindow.getQueryURLParameters.

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.

Parameters

context:FacesContext: the FacesContext for this request.

Returns:Map<String, String>

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

Annotations

@Override

public Class ClientWindowImpl

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail