Module jakarta.faces

Package jakarta.faces.lifecycle

Class ClientWindowFactory

java.lang.Object

jakarta.faces.lifecycle.ClientWindowFactory

All Implemented Interfaces:

FacesWrapper<ClientWindowFactory>

Direct Known Subclasses:

ClientWindowFactoryImpl

public abstract class ClientWindowFactory
extends Object
implements FacesWrapper<ClientWindowFactory>

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

Constructor Summary

Constructors

Constructor	Description
ClientWindowFactory()	Deprecated. Use the other constructor taking the implementation being wrapped.
ClientWindowFactory(ClientWindowFactory 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 Type	Method	Description
abstract ClientWindow	getClientWindow(FacesContext context)	The implementation is responsible for creating the ClientWindow instance for this request.
ClientWindowFactory	getWrapped()	If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.

Methods inherited from class java.lang.Object

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

Constructor Details

ClientWindowFactory

@Deprecated
public ClientWindowFactory()

Deprecated.

Use the other constructor taking the implementation being wrapped.

ClientWindowFactory

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 - The implementation being wrapped.

Method Details

getWrapped

public ClientWindowFactory getWrapped()

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

Specified by:

getWrapped in interface FacesWrapper<ClientWindowFactory>

Returns:

the wrapped instance.

getClientWindow

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 - the FacesContext for this request.

Returns:

the ClientWindow for this request, or null

Since:

2.2