javax.faces.context: abstract public class: PartialViewContext

javax.faces.context
abstract public class: PartialViewContext [javadoc | source]

java.lang.Object
   javax.faces.context.PartialViewContext

Direct Known Subclasses:
PartialViewContextWrapper

PartialViewContext contains methods and properties that pertain to partial request processing and partial response rendering on a view.

The PartialViewContext instance is used to determine if the current request indicates the requirement to perform partial processing and/or partial rendering. Partial processing is the processing of selected components through the execute portion of the request processing lifecycle. Partial rendering is the rendering of specified components in the Render Response Phase of the request processing lifecycle.

Field Summary

Field Summary
public static final String	PARTIAL_RENDER_PARAM_NAME	The request parameter name whose request parameter value is a `Collection` of client identifiers identifying the components that must be processed during the Render Response phase of the request processing lifecycle. since: `2.0` -
public static final String	PARTIAL_EXECUTE_PARAM_NAME	The request parameter name whose request parameter value is a `Collection` of client identifiers identifying the components that must be processed during the Apply Request Values, Process Validations, and Update Model Values phases of the request processing lifecycle. since: `2.0` -
public static final String	ALL_PARTIAL_PHASE_CLIENT_IDS	The value that when used with #PARTIAL_EXECUTE_PARAM_NAME or #PARTIAL_RENDER_PARAM_NAME indicates these phases must be skipped. since: `2.0` -

public static final String

PARTIAL_RENDER_PARAM_NAME

The request parameter name whose request parameter value is a Collection of client identifiers identifying the components that must be processed during the Render Response phase of the request processing lifecycle.

since: 2.0 -

public static final String

PARTIAL_EXECUTE_PARAM_NAME

The request parameter name whose request parameter value is a Collection of client identifiers identifying the components that must be processed during the Apply Request Values, Process Validations, and Update Model Values phases of the request processing lifecycle.

since: 2.0 -

public static final String

ALL_PARTIAL_PHASE_CLIENT_IDS

The value that when used with #PARTIAL_EXECUTE_PARAM_NAME or #PARTIAL_RENDER_PARAM_NAME indicates these phases must be skipped.

since: 2.0 -

Method from javax.faces.context.PartialViewContext Summary:
getExecuteIds, getPartialResponseWriter, getRenderIds, isAjaxRequest, isExecuteAll, isPartialRequest, isRenderAll, processPartial, release, setPartialRequest, setRenderAll

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

Method from javax.faces.context.PartialViewContext Detail:
abstract public Collection<String> getExecuteIds() Return a `Collection` of client identifiers from the current request with the request parameter name #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.
abstract public PartialResponseWriter getPartialResponseWriter() 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.
abstract public Collection<String> getRenderIds() Return a `Collection` of client identifiers from the current request with the request parameter name #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.
abstract public boolean isAjaxRequest() Return `true` if the request header `Faces-Request` is present with the value `partial/ajax`. Otherwise, return `false`.
abstract public boolean isExecuteAll() Return `true` if #isAjaxRequest returns `true` and #PARTIAL_EXECUTE_PARAM_NAME is present in the current request with the value #ALL_PARTIAL_PHASE_CLIENT_IDS . Otherwise, return `false`.
abstract public boolean isPartialRequest() Return `true` #isAjaxRequest returns `true` or if the request header `Faces-Request` is present with the value `partial/process`. Otherwise, return `false`.
abstract public boolean isRenderAll() Return `true` if #isAjaxRequest returns `true` and #PARTIAL_RENDER_PARAM_NAME is present in the current request with the value #ALL_PARTIAL_PHASE_CLIENT_IDS . Otherwise, return `false`.
abstract public void processPartial(PhaseId phaseId) Perform lifecycle processing on components during the indicated `phaseId`. Only those components with identifiers existing in the `Collection` returned from #getExecuteIds and #getRenderIds will be processed.
abstract public void release() Release any resources associated with this `PartialViewContext` instance.
abstract public void setPartialRequest(boolean isPartialRequest) Dynamically indicate that this is a partial request.
abstract public void setRenderAll(boolean renderAll) Indicate the entire view must be rendered if `renderAll` is `true`.