public class ClientWindowImpl extends ClientWindow
CLIENT_WINDOW_MODE_PARAM_NAME
Constructor and Description |
---|
ClientWindowImpl() |
Modifier and Type | Method and Description |
---|---|
void |
decode(FacesContext context)
The implementation is responsible
for examining the incoming request and extracting the value that
must be returned from the |
String |
getId()
Return a String value that uniquely
identifies this |
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. |
disableClientWindowRenderMode, enableClientWindowRenderMode, isClientWindowRenderModeEnabled
public Map<String,String> getQueryURLParameters(FacesContext context)
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.
getQueryURLParameters
in class ClientWindow
context
- the FacesContext
for this request.null
or a map of parameters to insert into the URL query string.public void decode(FacesContext context)
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()
.
decode
in class ClientWindow
context
- the FacesContext
for this request.public String getId()
ClientWindow
Return a String value that uniquely
identifies this ClientWindow
within the scope of the current session. See ClientWindow.decode(javax.faces.context.FacesContext)
for the
specification of how to derive this value.
getId
in class ClientWindow
ClientWindow
Copyright © 1997–2019 Eclipse Foundation. All rights reserved.