PartialViewContextWrapper (Jakarta EE Platform API)

java.lang.Object
- jakarta.faces.context.PartialViewContext
- - jakarta.faces.context.PartialViewContextWrapper

All Implemented Interfaces:

FacesWrapper<PartialViewContext>
```
public abstract class PartialViewContextWrapper
extends PartialViewContext
implements FacesWrapper<PartialViewContext>
```
Provides a simple implementation of PartialViewContext that can be subclassed by developers wishing to provide specialized behavior to an existing PartialViewContext instance. The default implementation of all methods is to call through to the wrapped ExternalContext instance.

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

Since:

2.0

Field Summary
- Fields inherited from class jakarta.faces.context.PartialViewContext
  ALL_PARTIAL_PHASE_CLIENT_IDS, PARTIAL_EVENT_PARAM_NAME, PARTIAL_EXECUTE_PARAM_NAME, PARTIAL_RENDER_PARAM_NAME, RESET_VALUES_PARAM_NAME

Constructor Summary

Constructors
Constructor and Description
`PartialViewContextWrapper()` Deprecated. Use the other constructor taking the implementation being wrapped.
`PartialViewContextWrapper(PartialViewContext wrapped)` If this partial view context has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`getEvalScripts()` The default behavior of this method is to call `PartialViewContext.getRenderIds()` on the wrapped `PartialViewContext` object.
`Collection<String>`	`getExecuteIds()` The default behavior of this method is to call `PartialViewContext.getExecuteIds()` on the wrapped `PartialViewContext` object.
`PartialResponseWriter`	`getPartialResponseWriter()` The default behavior of this method is to call `PartialViewContext.getPartialResponseWriter()` on the wrapped `PartialViewContext` object.
`Collection<String>`	`getRenderIds()` The default behavior of this method is to call `PartialViewContext.getRenderIds()` on the wrapped `PartialViewContext` object.
`PartialViewContext`	`getWrapped()` A class that implements this interface uses this method to return an instance of the class being wrapped.
`boolean`	`isAjaxRequest()` The default behavior of this method is to call `PartialViewContext.isAjaxRequest()` on the wrapped `PartialViewContext` object.
`boolean`	`isExecuteAll()` The default behavior of this method is to call `PartialViewContext.isExecuteAll()` on the wrapped `PartialViewContext` object.
`boolean`	`isPartialRequest()` The default behavior of this method is to call `PartialViewContext.isPartialRequest()` on the wrapped `PartialViewContext` object.
`boolean`	`isRenderAll()` The default behavior of this method is to call `PartialViewContext.isRenderAll()` on the wrapped `PartialViewContext` object.
`boolean`	`isResetValues()` The default behavior of this method is to call `PartialViewContext.isResetValues()` on the wrapped `PartialViewContext` object.
`void`	`processPartial(PhaseId phaseId)` The default behavior of this method is to call `PartialViewContext.processPartial(PhaseId)` on the wrapped `PartialViewContext` object.
`void`	`release()` The default behavior of this method is to call `PartialViewContext.release()` on the wrapped `PartialViewContext` object.
`void`	`setPartialRequest(boolean isPartialRequest)` The default behavior of this method is to call `PartialViewContext.setPartialRequest(boolean)` on the wrapped `PartialViewContext` object.
`void`	`setRenderAll(boolean renderAll)` The default behavior of this method is to call `PartialViewContext.setRenderAll(boolean)` on the wrapped `PartialViewContext` object.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PartialViewContextWrapper
```
@Deprecated
public PartialViewContextWrapper()
```
    Deprecated. Use the other constructor taking the implementation being wrapped.
  - PartialViewContextWrapper
```
public PartialViewContextWrapper(PartialViewContext wrapped)
```
    If this partial view context 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.
    
    Since:
    
    2.3
- Method Detail
  - getWrapped
```
public PartialViewContext getWrapped()
```
    Description copied from interface: FacesWrapper
    
    A class that implements this interface uses this method to return an instance of the class being wrapped.
    
    Specified by:
    
    getWrapped in interface FacesWrapper<PartialViewContext>
    
    Returns:
    
    the wrapped instance.
  - getExecuteIds
```
public Collection<String> getExecuteIds()
```
    The default behavior of this method is to call PartialViewContext.getExecuteIds() on the wrapped PartialViewContext object.
    
    Specified by:
    
    getExecuteIds in class PartialViewContext
    
    Returns:
    
    the ids for the execute portion of the lifecycle
    
    See Also:
    
    PartialViewContext.getExecuteIds()
  - getRenderIds
```
public Collection<String> getRenderIds()
```
    The default behavior of this method is to call PartialViewContext.getRenderIds() on the wrapped PartialViewContext object.
    
    Specified by:
    
    getRenderIds in class PartialViewContext
    
    Returns:
    
    the ids for the render portion of the lifecycle
    
    See Also:
    
    PartialViewContext.getRenderIds()
  - getEvalScripts
```
public List<String> getEvalScripts()
```
    The default behavior of this method is to call PartialViewContext.getRenderIds() on the wrapped PartialViewContext object.
    
    Specified by:
    
    getEvalScripts in class PartialViewContext
    
    Returns:
    
    A mutable List of scripts to be evaluated in client side on complete of ajax request.
    
    See Also:
    
    PartialViewContext.getEvalScripts()
  - getPartialResponseWriter
```
public PartialResponseWriter getPartialResponseWriter()
```
    The default behavior of this method is to call PartialViewContext.getPartialResponseWriter() on the wrapped PartialViewContext object.
    
    Specified by:
    
    getPartialResponseWriter in class PartialViewContext
    
    Returns:
    
    the ResponseWriter for output
    
    See Also:
    
    PartialViewContext.getPartialResponseWriter()
  - setPartialRequest
```
public void setPartialRequest(boolean isPartialRequest)
```
    The default behavior of this method is to call PartialViewContext.setPartialRequest(boolean) on the wrapped PartialViewContext object.
    
    Specified by:
    
    setPartialRequest in class PartialViewContext
    
    Parameters:
    
    isPartialRequest - the value true indicates this is a partial request.
    
    See Also:
    
    PartialViewContext.setPartialRequest(boolean)
  - isAjaxRequest
```
public boolean isAjaxRequest()
```
    The default behavior of this method is to call PartialViewContext.isAjaxRequest() on the wrapped PartialViewContext object.
    
    Specified by:
    
    isAjaxRequest in class PartialViewContext
    
    Returns:
    
    whether or not this is an ajax request
    
    See Also:
    
    PartialViewContext.isAjaxRequest()
  - isPartialRequest
```
public boolean isPartialRequest()
```
    The default behavior of this method is to call PartialViewContext.isPartialRequest() on the wrapped PartialViewContext object.
    
    Specified by:
    
    isPartialRequest in class PartialViewContext
    
    Returns:
    
    whether or not this request is partial
    
    See Also:
    
    PartialViewContext.isPartialRequest()
  - isExecuteAll
```
public boolean isExecuteAll()
```
    The default behavior of this method is to call PartialViewContext.isExecuteAll() on the wrapped PartialViewContext object.
    
    Specified by:
    
    isExecuteAll in class PartialViewContext
    
    Returns:
    
    whether or not this is an execute all request
    
    See Also:
    
    PartialViewContext.isExecuteAll()
  - isRenderAll
```
public boolean isRenderAll()
```
    The default behavior of this method is to call PartialViewContext.isRenderAll() on the wrapped PartialViewContext object.
    
    Specified by:
    
    isRenderAll in class PartialViewContext
    
    Returns:
    
    whether or not this is a render all request
    
    See Also:
    
    PartialViewContext.isRenderAll()
  - isResetValues
```
public boolean isResetValues()
```
    The default behavior of this method is to call PartialViewContext.isResetValues() on the wrapped PartialViewContext object.
    
    Overrides:
    
    isResetValues in class PartialViewContext
    
    Returns:
    
    whether or not this is a reset values request
    
    See Also:
    
    PartialViewContext.isResetValues()
  - setRenderAll
```
public void setRenderAll(boolean renderAll)
```
    The default behavior of this method is to call PartialViewContext.setRenderAll(boolean) on the wrapped PartialViewContext object.
    
    Specified by:
    
    setRenderAll in class PartialViewContext
    
    Parameters:
    
    renderAll - the value true indicates the entire view must be rendered.
    
    See Also:
    
    PartialViewContext.setRenderAll(boolean)
  - release
```
public void release()
```
    The default behavior of this method is to call PartialViewContext.release() on the wrapped PartialViewContext object.
    
    Specified by:
    
    release in class PartialViewContext
    
    See Also:
    
    PartialViewContext.release()
  - processPartial
```
public void processPartial(PhaseId phaseId)
```
    The default behavior of this method is to call PartialViewContext.processPartial(PhaseId) on the wrapped PartialViewContext object.
    
    Specified by:
    
    processPartial in class PartialViewContext
    
    Parameters:
    
    phaseId - the PhaseId that indicates the lifecycle phase the components will be processed in.
    
    See Also:
    
    PartialViewContext.processPartial(PhaseId)

Class PartialViewContextWrapper

Field Summary

Fields inherited from class jakarta.faces.context.PartialViewContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PartialViewContextWrapper

PartialViewContextWrapper

Method Detail

getWrapped

getExecuteIds

getRenderIds

getEvalScripts

getPartialResponseWriter

setPartialRequest

isAjaxRequest

isPartialRequest

isExecuteAll

isRenderAll

isResetValues

setRenderAll

release

processPartial