Package jakarta.faces.lifecycle
Class ClientWindow
- java.lang.Object
-
- jakarta.faces.lifecycle.ClientWindow
-
- Direct Known Subclasses:
ClientWindowWrapper
public abstract class ClientWindow extends Object
- Since:
- 2.2
-
-
Field Summary
Fields Modifier and Type Field Description static String
CLIENT_WINDOW_MODE_PARAM_NAME
Defines the ClientWindow mode to use.static String
NUMBER_OF_CLIENT_WINDOWS_PARAM_NAME
Indicate the max number of ClientWindows, which is used byClientWindowScoped
.
-
Constructor Summary
Constructors Constructor Description ClientWindow()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract void
decode(FacesContext context)
void
disableClientWindowRenderMode(FacesContext context)
void
enableClientWindowRenderMode(FacesContext context)
abstract String
getId()
abstract Map<String,String>
getQueryURLParameters(FacesContext context)
boolean
isClientWindowRenderModeEnabled(FacesContext context)
-
-
-
Field Detail
-
CLIENT_WINDOW_MODE_PARAM_NAME
@JSFWebConfigParam(since="2.2.0", expectedValues="none, url, url-redirect, client", defaultValue="none") public static final String CLIENT_WINDOW_MODE_PARAM_NAME
Defines the ClientWindow mode to use. url = like the defined in the specs url-redirect = same like 'url' but with a initial redirect, so that the first request already contains a valid windowId in the URL. Similar to DeltaSpile LAZY mode. client = like the DeltaSpike CLIENTWINDOW mode.- See Also:
- Constant Field Values
-
NUMBER_OF_CLIENT_WINDOWS_PARAM_NAME
@JSFWebConfigParam(since="4.0", group="state", tags="performance", defaultValue="10") public static final String NUMBER_OF_CLIENT_WINDOWS_PARAM_NAME
Indicate the max number of ClientWindows, which is used byClientWindowScoped
. It is only active when jakarta.faces.CLIENT_WINDOW_MODE is enabled.- Since:
- 4.0
- See Also:
- Constant Field Values
-
-
Method Detail
-
decode
public abstract void decode(FacesContext context)
-
getId
public abstract String getId()
-
getQueryURLParameters
public abstract Map<String,String> getQueryURLParameters(FacesContext context)
-
isClientWindowRenderModeEnabled
public boolean isClientWindowRenderModeEnabled(FacesContext context)
-
disableClientWindowRenderMode
public void disableClientWindowRenderMode(FacesContext context)
-
enableClientWindowRenderMode
public void enableClientWindowRenderMode(FacesContext context)
-
-