Top Description Fields Constructors Methods
jakarta.faces.lifecycle

public abstract Class ClientWindowFactory

extends Object
implements FacesWrapper<ClientWindowFactory>
Class Inheritance
All Implemented Interfaces
jakarta.faces.FacesWrapper
Known Direct Subclasses
com.sun.faces.lifecycle.ClientWindowFactoryImpl
Imports
jakarta.faces.FacesWrapper, jakarta.faces.context.FacesContext

Create ClientWindow instances based on the incoming request.

Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped to access the instance being wrapped.

Since
2.2

Field Summary

Modifier and TypeField and Description
private ClientWindowFactory
wrapped

Constructor Summary

AccessConstructor and Description
public
ClientWindowFactory()
Deprecated Use the other constructor taking the implementation being wrapped.

public
ClientWindowFactory(ClientWindowFactory
The implementation being wrapped.
wrapped)

If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.

Method Summary

Modifier and TypeMethod and Description
public abstract ClientWindow

Returns:

the ClientWindow for this request, or null
getClientWindow(FacesContext
the FacesContext for this request.
context)

The implementation is responsible for creating the ClientWindow instance for this request.

public ClientWindowFactory
getWrapped()

Implements jakarta.faces.FacesWrapper.getWrapped.

If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

wrappedback to summary
private ClientWindowFactory wrapped

Constructor Detail

ClientWindowFactoryback to summary
public ClientWindowFactory()

Deprecated

Use the other constructor taking the implementation being wrapped.

Annotations
@Deprecated
ClientWindowFactoryback to summary
public ClientWindowFactory(ClientWindowFactory wrapped)

If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The getWrapped() will then return the implementation being wrapped.

Parameters
wrapped:ClientWindowFactory

The implementation being wrapped.

Method Detail

getClientWindowback to summary
public abstract ClientWindow getClientWindow(FacesContext context)

The implementation is responsible for creating the ClientWindow instance for this request. If ClientWindow#CLIENT_WINDOW_MODE_PARAM_NAME is "none" or unspecified, this method must return null. If ClientWindow#CLIENT_WINDOW_MODE_PARAM_NAME is "url" the implementation must return a ClientWindow instance that implements the url-mode semantics described in ClientWindow.

Parameters
context:FacesContext

the FacesContext for this request.

Returns:ClientWindow

the ClientWindow for this request, or null

Since
2.2
getWrappedback to summary
public ClientWindowFactory getWrapped()

Implements jakarta.faces.FacesWrapper.getWrapped.

If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.

Returns:ClientWindowFactory

Doc from jakarta.faces.FacesWrapper.getWrapped.

the wrapped instance.

Annotations
@Override