PartialViewContextImpl (Mojarra 3.0.2.SP01 3.0.2.SP01 API)

java.lang.Object
- jakarta.faces.context.PartialViewContext
- - com.sun.faces.context.PartialViewContextImpl

public class PartialViewContextImpl
extends jakarta.faces.context.PartialViewContext

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

PartialViewContextImpl(jakarta.faces.context.FacesContext ctx)

Constructors
Constructor and Description
`PartialViewContextImpl(jakarta.faces.context.FacesContext ctx)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`getEvalScripts()` Returns a mutable `List` of scripts to be evaluated in client side on complete of ajax request.
`Collection<String>`	`getExecuteIds()` Return a `Collection` of client identifiers from the current request with the request parameter name `PartialViewContext.PARTIAL_EXECUTE_PARAM_NAME`.
`jakarta.faces.context.PartialResponseWriter`	`getPartialResponseWriter()` Return the `ResponseWriter` to which components should direct their output for partial view rendering.
`Collection<String>`	`getRenderIds()` Return a `Collection` of client identifiers from the current request with the request parameter name `PartialViewContext.PARTIAL_RENDER_PARAM_NAME`.
`boolean`	`isAjaxRequest()` Return `true` if the request header `Faces-Request` is present with the value `partial/ajax`.
`boolean`	`isExecuteAll()` Return `true` if `PartialViewContext.isAjaxRequest()` returns `true` and `PartialViewContext.PARTIAL_EXECUTE_PARAM_NAME` is present in the current request with the value `PartialViewContext.ALL_PARTIAL_PHASE_CLIENT_IDS`.
`boolean`	`isPartialRequest()` Return `true` `PartialViewContext.isAjaxRequest()` returns `true` or if the request header `Faces-Request` is present with the value `partial/process`.
`boolean`	`isRenderAll()` Return `true` if `PartialViewContext.isAjaxRequest()` returns `true` and `PartialViewContext.PARTIAL_RENDER_PARAM_NAME` is present in the current request with the value `PartialViewContext.ALL_PARTIAL_PHASE_CLIENT_IDS`.
`boolean`	`isResetValues()` Return `true` if the incoming request has a parameter named by the value of `PartialViewContext.RESET_VALUES_PARAM_NAME` and that value is `true`.
`void`	`processPartial(jakarta.faces.event.PhaseId phaseId)` Perform lifecycle processing on components during the indicated `phaseId`.
`void`	`release()` Release any resources associated with this `PartialViewContext` instance.
`void`	`setPartialRequest(boolean isPartialRequest)` Dynamically indicate that this is a partial request.
`void`	`setRenderAll(boolean renderAll)` Indicate the entire view must be rendered if `renderAll` is `true`.

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

- Constructor Detail
  - PartialViewContextImpl
```
public PartialViewContextImpl(jakarta.faces.context.FacesContext ctx)
```
- Method Detail
  - isAjaxRequest
```
public boolean isAjaxRequest()
```
    Description copied from class: jakarta.faces.context.PartialViewContext
    
    Return true if the request header Faces-Request is present with the value partial/ajax. Otherwise, return false.
    
    Specified by:
    
    isAjaxRequest in class jakarta.faces.context.PartialViewContext
    
    Returns:
    
    whether or not this is an ajax request
    
    See Also:
    
    PartialViewContext.isAjaxRequest()
  - isPartialRequest
```
public boolean isPartialRequest()
```
    Description copied from class: jakarta.faces.context.PartialViewContext
    
    Return true PartialViewContext.isAjaxRequest() returns true or if the request header Faces-Request is present with the value partial/process. Otherwise, return false.
    
    Specified by:
    
    isPartialRequest in class jakarta.faces.context.PartialViewContext
    
    Returns:
    
    whether or not this request is partial
    
    See Also:
    
    PartialViewContext.isPartialRequest()
  - isExecuteAll
```
public boolean isExecuteAll()
```
    Description copied from class: jakarta.faces.context.PartialViewContext
    
    Return true if PartialViewContext.isAjaxRequest() returns true and PartialViewContext.PARTIAL_EXECUTE_PARAM_NAME is present in the current request with the value PartialViewContext.ALL_PARTIAL_PHASE_CLIENT_IDS. Otherwise, return false.
    
    Specified by:
    
    isExecuteAll in class jakarta.faces.context.PartialViewContext
    
    Returns:
    
    whether or not this is an execute all request
    
    See Also:
    
    PartialViewContext.isExecuteAll()
  - isRenderAll
```
public boolean isRenderAll()
```
    Description copied from class: jakarta.faces.context.PartialViewContext
    
    Return true if PartialViewContext.isAjaxRequest() returns true and PartialViewContext.PARTIAL_RENDER_PARAM_NAME is present in the current request with the value PartialViewContext.ALL_PARTIAL_PHASE_CLIENT_IDS. Otherwise, return false.
    
    Specified by:
    
    isRenderAll in class jakarta.faces.context.PartialViewContext
    
    Returns:
    
    whether or not this is a render all request
    
    See Also:
    
    PartialViewContext.isRenderAll()
  - setRenderAll
```
public void setRenderAll(boolean renderAll)
```
    Description copied from class: jakarta.faces.context.PartialViewContext
    
    Indicate the entire view must be rendered if renderAll is true.
    
    Specified by:
    
    setRenderAll in class jakarta.faces.context.PartialViewContext
    
    Parameters:
    
    renderAll - the value true indicates the entire view must be rendered.
    
    See Also:
    
    PartialViewContext.setRenderAll(boolean)
  - isResetValues
```
public boolean isResetValues()
```
    Description copied from class: jakarta.faces.context.PartialViewContext
    
    Return true if the incoming request has a parameter named by the value of PartialViewContext.RESET_VALUES_PARAM_NAME and that value is true. To preserve backward compatibility with custom implementations that may have extended from an earlier version of this class, an implementation is provided that returns false. A compliant implementation must override this method to take the specified action.
    
    Overrides:
    
    isResetValues in class jakarta.faces.context.PartialViewContext
    
    Returns:
    
    whether or not this is a reset values request
  - setPartialRequest
```
public void setPartialRequest(boolean isPartialRequest)
```
    Description copied from class: jakarta.faces.context.PartialViewContext
    
    Dynamically indicate that this is a partial request.
    
    Specified by:
    
    setPartialRequest in class jakarta.faces.context.PartialViewContext
    
    Parameters:
    
    isPartialRequest - the value true indicates this is a partial request.
  - getExecuteIds
```
public Collection<String> getExecuteIds()
```
    Description copied from class: jakarta.faces.context.PartialViewContext
    
    Return a Collection of client identifiers from the current request with the request parameter name PartialViewContext.PARTIAL_EXECUTE_PARAM_NAME. If there is no such request parameter, return an empty Collection. These client identifiers are used to identify components that will be processed during the execute phase of the request processing lifecycle. The returned Collection is mutable.
    
    Specified by:
    
    getExecuteIds in class jakarta.faces.context.PartialViewContext
    
    Returns:
    
    the ids for the execute portion of the lifecycle
    
    See Also:
    
    PartialViewContext.getExecuteIds()
  - getRenderIds
```
public Collection<String> getRenderIds()
```
    Description copied from class: jakarta.faces.context.PartialViewContext
    
    Return a Collection of client identifiers from the current request with the request parameter name PartialViewContext.PARTIAL_RENDER_PARAM_NAME. If there is no such request parameter, return an empty Collection. These client identifiers are used to identify components that will be processed during the render phase of the request processing lifecycle. The returned Collection is mutable.
    
    Specified by:
    
    getRenderIds in class jakarta.faces.context.PartialViewContext
    
    Returns:
    
    the ids for the render portion of the lifecycle
    
    See Also:
    
    PartialViewContext.getRenderIds()
  - getEvalScripts
```
public List<String> getEvalScripts()
```
    Description copied from class: jakarta.faces.context.PartialViewContext
    
    Returns a mutable List of scripts to be evaluated in client side on complete of ajax request.
    
    Specified by:
    
    getEvalScripts in class jakarta.faces.context.PartialViewContext
    
    Returns:
    
    A mutable List of scripts to be evaluated in client side on complete of ajax request.
    
    See Also:
    
    PartialViewContext.getEvalScripts()
  - processPartial
```
public void processPartial(jakarta.faces.event.PhaseId phaseId)
```
    Description copied from class: jakarta.faces.context.PartialViewContext
    Perform lifecycle processing on components during the indicated phaseId. Only those components with identifiers existing in the Collection returned from PartialViewContext.getExecuteIds() and PartialViewContext.getRenderIds() will be processed.
    When the indicated phaseId equals PhaseId.RENDER_RESPONSE, then perform the following tasks in sequence:
    
    If PartialViewContext.isResetValues() returns true, then call UIViewRoot.resetValues(FacesContext, Collection), passing PartialViewContext.getRenderIds().
    
    If PartialViewContext.isRenderAll() returns false, then render any component resource of UIViewRoot whose ResourceHandler.getRendererTypeForResourceName(String) does not return null, and whose UIComponent.getChildCount() is zero, and whose ResourceHandler.isResourceRendered(FacesContext, String, String) returns false, in an update element with an identifier of jakarta.faces.Resource.
    
    Process the components.
    
    Obtain the state by calling StateManager.getViewState(jakarta.faces.context.FacesContext) and write it out as an update element with an identifier of <VIEW_ROOT_CONTAINER_CLIENT_ID><SEP>jakarta.faces.ViewState where <VIEW_ROOT_CONTAINER_CLIENT_ID> is the return from UIComponent.getContainerClientId(FacesContext) on the view from whence this state originated, and <SEP> is the currently configured UINamingContainer.getSeparatorChar(FacesContext).
    
    If PartialViewContext.isRenderAll() returns false, then write out each script of PartialViewContext.getEvalScripts() as an eval element.
    Specified by:
    
    processPartial in class jakarta.faces.context.PartialViewContext
    
    Parameters:
    
    phaseId - the PhaseId that indicates the lifecycle phase the components will be processed in.
    
    See Also:
    
    PartialViewContext.processPartial(jakarta.faces.event.PhaseId)
  - getPartialResponseWriter
```
public jakarta.faces.context.PartialResponseWriter getPartialResponseWriter()
```
    Description copied from class: jakarta.faces.context.PartialViewContext
    
    Return the ResponseWriter to which components should direct their output for partial view rendering. Within a given response, components can use either the ResponseStream or the ResponseWriter, but not both.
    
    Specified by:
    
    getPartialResponseWriter in class jakarta.faces.context.PartialViewContext
    
    Returns:
    
    the ResponseWriter for output
    
    See Also:
    
    PartialViewContext.getPartialResponseWriter()
  - release
```
public void release()
```
    Description copied from class: jakarta.faces.context.PartialViewContext
    
    Release any resources associated with this PartialViewContext instance.
    
    Specified by:
    
    release in class jakarta.faces.context.PartialViewContext
    
    See Also:
    
    PartialViewContext.release()

Class PartialViewContextImpl

Field Summary

Fields inherited from class jakarta.faces.context.PartialViewContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PartialViewContextImpl

Method Detail

isAjaxRequest

isPartialRequest

isExecuteAll

isRenderAll

setRenderAll

isResetValues

setPartialRequest

getExecuteIds

getRenderIds

getEvalScripts

processPartial

getPartialResponseWriter

release