- java.lang.Object
-
- javax.faces.context.PartialViewContext
-
- javax.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 existingPartialViewContext
instance. The default implementation of all methods is to call through to the wrappedExternalContext
instance.Usage: extend this class and override
getWrapped()
to return the instance being wrapping.- Since:
- 2.0
-
-
Field Summary
-
Fields inherited from class javax.faces.context.PartialViewContext
ALL_PARTIAL_PHASE_CLIENT_IDS, PARTIAL_EXECUTE_PARAM_NAME, PARTIAL_RENDER_PARAM_NAME, RESET_VALUES_PARAM_NAME
-
-
Constructor Summary
Constructors Constructor and Description PartialViewContextWrapper()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method and Description Collection<String>
getExecuteIds()
The default behavior of this method is to callPartialViewContext.getExecuteIds()
on the wrappedPartialViewContext
object.PartialResponseWriter
getPartialResponseWriter()
The default behavior of this method is to callPartialViewContext.getPartialResponseWriter()
on the wrappedPartialViewContext
object.Collection<String>
getRenderIds()
The default behavior of this method is to callPartialViewContext.getRenderIds()
on the wrappedPartialViewContext
object.abstract 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 callPartialViewContext.isAjaxRequest()
on the wrappedPartialViewContext
object.boolean
isExecuteAll()
The default behavior of this method is to callPartialViewContext.isExecuteAll()
on the wrappedPartialViewContext
object.boolean
isPartialRequest()
The default behavior of this method is to callPartialViewContext.isPartialRequest()
on the wrappedPartialViewContext
object.boolean
isRenderAll()
The default behavior of this method is to callPartialViewContext.isRenderAll()
on the wrappedPartialViewContext
object.boolean
isResetValues()
The default behavior of this method is to callPartialViewContext.isResetValues()
on the wrappedPartialViewContext
object.void
processPartial(PhaseId phaseId)
The default behavior of this method is to callPartialViewContext.processPartial(PhaseId)
on the wrappedPartialViewContext
object.void
release()
The default behavior of this method is to callPartialViewContext.release()
on the wrappedPartialViewContext
object.void
setPartialRequest(boolean isPartialRequest)
The default behavior of this method is to call
PartialViewContext.setPartialRequest(boolean)
on the wrappedPartialViewContext
object.void
setRenderAll(boolean renderAll)
The default behavior of this method is to callPartialViewContext.setRenderAll(boolean)
on the wrappedPartialViewContext
object.
-
-
-
Method Detail
-
getWrapped
public abstract 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 interfaceFacesWrapper<PartialViewContext>
- Returns:
- the wrapped
PartialViewContext
instance - See Also:
FacesWrapper.getWrapped()
-
getExecuteIds
public Collection<String> getExecuteIds()
The default behavior of this method is to call
PartialViewContext.getExecuteIds()
on the wrappedPartialViewContext
object.- Specified by:
getExecuteIds
in classPartialViewContext
- See Also:
PartialViewContext.getExecuteIds()
-
getRenderIds
public Collection<String> getRenderIds()
The default behavior of this method is to call
PartialViewContext.getRenderIds()
on the wrappedPartialViewContext
object.- Specified by:
getRenderIds
in classPartialViewContext
- See Also:
PartialViewContext.getRenderIds()
-
getPartialResponseWriter
public PartialResponseWriter getPartialResponseWriter()
The default behavior of this method is to call
PartialViewContext.getPartialResponseWriter()
on the wrappedPartialViewContext
object.- Specified by:
getPartialResponseWriter
in classPartialViewContext
- See Also:
PartialViewContext.getPartialResponseWriter()
-
setPartialRequest
public void setPartialRequest(boolean isPartialRequest)
The default behavior of this method is to call
PartialViewContext.setPartialRequest(boolean)
on the wrappedPartialViewContext
object.- Specified by:
setPartialRequest
in classPartialViewContext
- Parameters:
isPartialRequest
- the valuetrue
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 wrappedPartialViewContext
object.- Specified by:
isAjaxRequest
in classPartialViewContext
- See Also:
PartialViewContext.isAjaxRequest()
-
isPartialRequest
public boolean isPartialRequest()
The default behavior of this method is to call
PartialViewContext.isPartialRequest()
on the wrappedPartialViewContext
object.- Specified by:
isPartialRequest
in classPartialViewContext
- See Also:
PartialViewContext.isPartialRequest()
-
isExecuteAll
public boolean isExecuteAll()
The default behavior of this method is to call
PartialViewContext.isExecuteAll()
on the wrappedPartialViewContext
object.- Specified by:
isExecuteAll
in classPartialViewContext
- See Also:
PartialViewContext.isExecuteAll()
-
isRenderAll
public boolean isRenderAll()
The default behavior of this method is to call
PartialViewContext.isRenderAll()
on the wrappedPartialViewContext
object.- Specified by:
isRenderAll
in classPartialViewContext
- See Also:
PartialViewContext.isRenderAll()
-
isResetValues
public boolean isResetValues()
The default behavior of this method is to call
PartialViewContext.isResetValues()
on the wrappedPartialViewContext
object.- Overrides:
isResetValues
in classPartialViewContext
- See Also:
PartialViewContext.isResetValues()
-
setRenderAll
public void setRenderAll(boolean renderAll)
The default behavior of this method is to call
PartialViewContext.setRenderAll(boolean)
on the wrappedPartialViewContext
object.- Specified by:
setRenderAll
in classPartialViewContext
- Parameters:
renderAll
- the valuetrue
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 wrappedPartialViewContext
object.- Specified by:
release
in classPartialViewContext
- See Also:
PartialViewContext.release()
-
processPartial
public void processPartial(PhaseId phaseId)
The default behavior of this method is to call
PartialViewContext.processPartial(PhaseId)
on the wrappedPartialViewContext
object.- Specified by:
processPartial
in classPartialViewContext
- Parameters:
phaseId
- thePhaseId
that indicates the lifecycle phase the components will be processed in.- See Also:
PartialViewContext.processPartial(PhaseId)
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/faces/context/PartialViewContextWrapper.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.