Top Description Fields Constructors Methods
javax.faces.context

public abstract Class PartialViewContextWrapper

extends PartialViewContext
implements FacesWrapper<PartialViewContext>
Class Inheritance
All Implemented Interfaces
javax.faces.FacesWrapper
Imports
java.util.Collection, .List, javax.faces.FacesWrapper, javax.faces.event.PhaseId

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

Modifier and TypeField and Description
private PartialViewContext
wrapped

Inherited from javax.faces.context.PartialViewContext:
ALL_PARTIAL_PHASE_CLIENT_IDSPARTIAL_EVENT_PARAM_NAMEPARTIAL_EXECUTE_PARAM_NAMEPARTIAL_RENDER_PARAM_NAMERESET_VALUES_PARAM_NAME

Constructor Summary

AccessConstructor and Description
public
PartialViewContextWrapper()

Deprecated Use the other constructor taking the implementation being wrapped.
public
PartialViewContextWrapper(PartialViewContext
The implementation being wrapped.
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

Modifier and TypeMethod and Description
public List<String>
getEvalScripts()

Implements abstract javax.faces.context.PartialViewContext.getEvalScripts.

The default behavior of this method is to call PartialViewContext#getRenderIds() on the wrapped PartialViewContext object.

public Collection<String>
getExecuteIds()

Implements abstract javax.faces.context.PartialViewContext.getExecuteIds.

The default behavior of this method is to call PartialViewContext#getExecuteIds() on the wrapped PartialViewContext object.

public PartialResponseWriter
getPartialResponseWriter()

Implements abstract javax.faces.context.PartialViewContext.getPartialResponseWriter.

The default behavior of this method is to call PartialViewContext#getPartialResponseWriter() on the wrapped PartialViewContext object.

public Collection<String>
getRenderIds()

Implements abstract javax.faces.context.PartialViewContext.getRenderIds.

The default behavior of this method is to call PartialViewContext#getRenderIds() on the wrapped PartialViewContext object.

public PartialViewContext
getWrapped()

Implements javax.faces.FacesWrapper.getWrapped.

A class that implements this interface uses this method to return an instance of the class being wrapped.

public boolean
isAjaxRequest()

Implements abstract javax.faces.context.PartialViewContext.isAjaxRequest.

The default behavior of this method is to call PartialViewContext#isAjaxRequest() on the wrapped PartialViewContext object.

public boolean
isExecuteAll()

Implements abstract javax.faces.context.PartialViewContext.isExecuteAll.

The default behavior of this method is to call PartialViewContext#isExecuteAll() on the wrapped PartialViewContext object.

public boolean
isPartialRequest()

Implements abstract javax.faces.context.PartialViewContext.isPartialRequest.

The default behavior of this method is to call PartialViewContext#isPartialRequest() on the wrapped PartialViewContext object.

public boolean
isRenderAll()

Implements abstract javax.faces.context.PartialViewContext.isRenderAll.

The default behavior of this method is to call PartialViewContext#isRenderAll() on the wrapped PartialViewContext object.

public boolean
isResetValues()

Overrides javax.faces.context.PartialViewContext.isResetValues.

The default behavior of this method is to call PartialViewContext#isResetValues() on the wrapped PartialViewContext object.

public void
processPartial(PhaseId
the javax.faces.event.PhaseId that indicates the lifecycle phase the components will be processed in.
phaseId)

Implements abstract javax.faces.context.PartialViewContext.processPartial.

The default behavior of this method is to call PartialViewContext#processPartial(PhaseId) on the wrapped PartialViewContext object.

public void
release()

Implements abstract javax.faces.context.PartialViewContext.release.

The default behavior of this method is to call PartialViewContext#release() on the wrapped PartialViewContext object.

public void
setPartialRequest(boolean
the value true indicates this is a partial request.
isPartialRequest)

Implements abstract javax.faces.context.PartialViewContext.setPartialRequest.

The default behavior of this method is to call PartialViewContext#setPartialRequest(boolean) on the wrapped PartialViewContext object.

public void
setRenderAll(boolean
the value true indicates the entire view must be rendered.
renderAll)

Implements abstract javax.faces.context.PartialViewContext.setRenderAll.

The default behavior of this method is to call PartialViewContext#setRenderAll(boolean) on the wrapped PartialViewContext object.

Field Detail

wrappedback to summary
private PartialViewContext wrapped

Constructor Detail

PartialViewContextWrapperback to summary
public PartialViewContextWrapper()

Deprecated

Use the other constructor taking the implementation being wrapped.

Annotations
@Deprecated
PartialViewContextWrapperback to summary
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:PartialViewContext

The implementation being wrapped.

Since
2.3

Method Detail

getEvalScriptsback to summary
public List<String> getEvalScripts()

Implements abstract javax.faces.context.PartialViewContext.getEvalScripts.

The default behavior of this method is to call PartialViewContext#getRenderIds() on the wrapped PartialViewContext object.

Returns:List<String>

Doc from javax.faces.context.PartialViewContext.getEvalScripts.

A mutable List of scripts to be evaluated in client side on complete of ajax request.

Annotations
@Override
See Also
PartialViewContext#getEvalScripts()
getExecuteIdsback to summary
public Collection<String> getExecuteIds()

Implements abstract javax.faces.context.PartialViewContext.getExecuteIds.

The default behavior of this method is to call PartialViewContext#getExecuteIds() on the wrapped PartialViewContext object.

Returns:Collection<String>

Doc from javax.faces.context.PartialViewContext.getExecuteIds.

the ids for the execute portion of the lifecycle

Annotations
@Override
See Also
PartialViewContext#getExecuteIds()
getPartialResponseWriterback to summary
public PartialResponseWriter getPartialResponseWriter()

Implements abstract javax.faces.context.PartialViewContext.getPartialResponseWriter.

The default behavior of this method is to call PartialViewContext#getPartialResponseWriter() on the wrapped PartialViewContext object.

Returns:PartialResponseWriter

Doc from javax.faces.context.PartialViewContext.getPartialResponseWriter.

the ResponseWriter for output

Annotations
@Override
See Also
PartialViewContext#getPartialResponseWriter()
getRenderIdsback to summary
public Collection<String> getRenderIds()

Implements abstract javax.faces.context.PartialViewContext.getRenderIds.

The default behavior of this method is to call PartialViewContext#getRenderIds() on the wrapped PartialViewContext object.

Returns:Collection<String>

Doc from javax.faces.context.PartialViewContext.getRenderIds.

the ids for the render portion of the lifecycle

Annotations
@Override
See Also
PartialViewContext#getRenderIds()
getWrappedback to summary
public PartialViewContext getWrapped()

Implements javax.faces.FacesWrapper.getWrapped.

Doc from javax.faces.FacesWrapper.getWrapped.

A class that implements this interface uses this method to return an instance of the class being wrapped.

Returns:PartialViewContext

the wrapped instance.

Annotations
@Override
isAjaxRequestback to summary
public boolean isAjaxRequest()

Implements abstract javax.faces.context.PartialViewContext.isAjaxRequest.

The default behavior of this method is to call PartialViewContext#isAjaxRequest() on the wrapped PartialViewContext object.

Returns:boolean

Doc from javax.faces.context.PartialViewContext.isAjaxRequest.

whether or not this is an ajax request

Annotations
@Override
See Also
javax.faces.context.PartialViewContext#isAjaxRequest()
isExecuteAllback to summary
public boolean isExecuteAll()

Implements abstract javax.faces.context.PartialViewContext.isExecuteAll.

The default behavior of this method is to call PartialViewContext#isExecuteAll() on the wrapped PartialViewContext object.

Returns:boolean

Doc from javax.faces.context.PartialViewContext.isExecuteAll.

whether or not this is an execute all request

Annotations
@Override
See Also
PartialViewContext#isExecuteAll()
isPartialRequestback to summary
public boolean isPartialRequest()

Implements abstract javax.faces.context.PartialViewContext.isPartialRequest.

The default behavior of this method is to call PartialViewContext#isPartialRequest() on the wrapped PartialViewContext object.

Returns:boolean

Doc from javax.faces.context.PartialViewContext.isPartialRequest.

whether or not this request is partial

Annotations
@Override
See Also
PartialViewContext#isPartialRequest()
isRenderAllback to summary
public boolean isRenderAll()

Implements abstract javax.faces.context.PartialViewContext.isRenderAll.

The default behavior of this method is to call PartialViewContext#isRenderAll() on the wrapped PartialViewContext object.

Returns:boolean

Doc from javax.faces.context.PartialViewContext.isRenderAll.

whether or not this is a render all request

Annotations
@Override
See Also
PartialViewContext#isRenderAll()
isResetValuesback to summary
public boolean isResetValues()

Overrides javax.faces.context.PartialViewContext.isResetValues.

The default behavior of this method is to call PartialViewContext#isResetValues() on the wrapped PartialViewContext object.

Returns:boolean

Doc from javax.faces.context.PartialViewContext.isResetValues.

whether or not this is a reset values request

Annotations
@Override
See Also
PartialViewContext#isResetValues()
processPartialback to summary
public void processPartial(PhaseId phaseId)

Implements abstract javax.faces.context.PartialViewContext.processPartial.

The default behavior of this method is to call PartialViewContext#processPartial(PhaseId) on the wrapped PartialViewContext object.

Parameters
phaseId:PhaseId

Doc from javax.faces.context.PartialViewContext.processPartial.

the javax.faces.event.PhaseId that indicates the lifecycle phase the components will be processed in.

Annotations
@Override
See Also
PartialViewContext#processPartial(PhaseId)
releaseback to summary
public void release()

Implements abstract javax.faces.context.PartialViewContext.release.

The default behavior of this method is to call PartialViewContext#release() on the wrapped PartialViewContext object.

Annotations
@Override
See Also
PartialViewContext#release()
setPartialRequestback to summary
public void setPartialRequest(boolean isPartialRequest)

Implements abstract javax.faces.context.PartialViewContext.setPartialRequest.

The default behavior of this method is to call PartialViewContext#setPartialRequest(boolean) on the wrapped PartialViewContext object.

Parameters
isPartialRequest:boolean

Doc from javax.faces.context.PartialViewContext.setPartialRequest.

the value true indicates this is a partial request.

Annotations
@Override
See Also
PartialViewContext#setPartialRequest(boolean)
setRenderAllback to summary
public void setRenderAll(boolean renderAll)

Implements abstract javax.faces.context.PartialViewContext.setRenderAll.

The default behavior of this method is to call PartialViewContext#setRenderAll(boolean) on the wrapped PartialViewContext object.

Parameters
renderAll:boolean

Doc from javax.faces.context.PartialViewContext.setRenderAll.

the value true indicates the entire view must be rendered.

Annotations
@Override
See Also
PartialViewContext#setRenderAll(boolean)