EE4J Web API 10.0.0 · jakarta.faces.context.PartialViewContextWrapper

Modifier and Type	Field and Description
private PartialViewContext	wrapped

Access	Constructor 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 Type	Method and Description
public List<String>	getEvalScripts() Implements abstract jakarta.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 jakarta.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 jakarta.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 jakarta.faces.context.PartialViewContext.getRenderIds. The default behavior of this method is to call `PartialViewContext#getRenderIds()` on the wrapped `PartialViewContext` object.
public PartialViewContext	getWrapped() Implements jakarta.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 jakarta.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 jakarta.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 jakarta.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 jakarta.faces.context.PartialViewContext.isRenderAll. The default behavior of this method is to call `PartialViewContext#isRenderAll()` on the wrapped `PartialViewContext` object.
public boolean	isResetValues() Overrides jakarta.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 `jakarta.faces.event.PhaseId` that indicates the lifecycle phase the components will be processed in. phaseId) Implements abstract jakarta.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 jakarta.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 jakarta.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 jakarta.faces.context.PartialViewContext.setRenderAll. The default behavior of this method is to call `PartialViewContext#setRenderAll(boolean)` on the wrapped `PartialViewContext` object.

wrapped	back to summary
private PartialViewContext wrapped

PartialViewContextWrapper	back to summary
public PartialViewContextWrapper() Deprecated Use the other constructor taking the implementation being wrapped. Annotations @Deprecated

PartialViewContextWrapper	back 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

getEvalScripts back to summary

getEvalScripts	back to summary
public List<String> getEvalScripts() Implements abstract jakarta.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 jakarta.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()`

public List<String> getEvalScripts()

Implements abstract jakarta.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 jakarta.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()

getExecuteIds back to summary

getExecuteIds	back to summary
public Collection<String> getExecuteIds() Implements abstract jakarta.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 jakarta.faces.context.PartialViewContext.getExecuteIds. the ids for the execute portion of the lifecycle Annotations @Override See Also `PartialViewContext#getExecuteIds()`

public Collection<String> getExecuteIds()

Implements abstract jakarta.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 jakarta.faces.context.PartialViewContext.getExecuteIds.

the ids for the execute portion of the lifecycle

Annotations

@Override

See Also

PartialViewContext#getExecuteIds()

getPartialResponseWriter back to summary

getPartialResponseWriter	back to summary
public PartialResponseWriter getPartialResponseWriter() Implements abstract jakarta.faces.context.PartialViewContext.getPartialResponseWriter. The default behavior of this method is to call `PartialViewContext#getPartialResponseWriter()` on the wrapped `PartialViewContext` object. Returns:PartialResponseWriter Doc from jakarta.faces.context.PartialViewContext.getPartialResponseWriter. the `ResponseWriter` for output Annotations @Override See Also `PartialViewContext#getPartialResponseWriter()`

public PartialResponseWriter getPartialResponseWriter()

Implements abstract jakarta.faces.context.PartialViewContext.getPartialResponseWriter.

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

Returns:PartialResponseWriter

Doc from jakarta.faces.context.PartialViewContext.getPartialResponseWriter.

the ResponseWriter for output

Annotations

@Override

getRenderIds back to summary

getRenderIds	back to summary
public Collection<String> getRenderIds() Implements abstract jakarta.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 jakarta.faces.context.PartialViewContext.getRenderIds. the ids for the render portion of the lifecycle Annotations @Override See Also `PartialViewContext#getRenderIds()`

public Collection<String> getRenderIds()

Implements abstract jakarta.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 jakarta.faces.context.PartialViewContext.getRenderIds.

the ids for the render portion of the lifecycle

Annotations

@Override

See Also

PartialViewContext#getRenderIds()

getWrapped	back to summary
public PartialViewContext getWrapped() Implements jakarta.faces.FacesWrapper.getWrapped. Doc from jakarta.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

getWrapped

back to summary

public PartialViewContext getWrapped()

Implements jakarta.faces.FacesWrapper.getWrapped.

Doc from jakarta.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

isAjaxRequest back to summary

isAjaxRequest	back to summary
public boolean isAjaxRequest() Implements abstract jakarta.faces.context.PartialViewContext.isAjaxRequest. The default behavior of this method is to call `PartialViewContext#isAjaxRequest()` on the wrapped `PartialViewContext` object. Returns:boolean Doc from jakarta.faces.context.PartialViewContext.isAjaxRequest. whether or not this is an ajax request Annotations @Override See Also `jakarta.faces.context.PartialViewContext#isAjaxRequest()`

public boolean isAjaxRequest()

Implements abstract jakarta.faces.context.PartialViewContext.isAjaxRequest.

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

Returns:boolean

Doc from jakarta.faces.context.PartialViewContext.isAjaxRequest.

whether or not this is an ajax request

Annotations

@Override

isExecuteAll back to summary

isExecuteAll	back to summary
public boolean isExecuteAll() Implements abstract jakarta.faces.context.PartialViewContext.isExecuteAll. The default behavior of this method is to call `PartialViewContext#isExecuteAll()` on the wrapped `PartialViewContext` object. Returns:boolean Doc from jakarta.faces.context.PartialViewContext.isExecuteAll. whether or not this is an execute all request Annotations @Override See Also `PartialViewContext#isExecuteAll()`

public boolean isExecuteAll()

Implements abstract jakarta.faces.context.PartialViewContext.isExecuteAll.

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

Returns:boolean

Doc from jakarta.faces.context.PartialViewContext.isExecuteAll.

whether or not this is an execute all request

Annotations

@Override

See Also

PartialViewContext#isExecuteAll()

isPartialRequest back to summary

isPartialRequest	back to summary
public boolean isPartialRequest() Implements abstract jakarta.faces.context.PartialViewContext.isPartialRequest. The default behavior of this method is to call `PartialViewContext#isPartialRequest()` on the wrapped `PartialViewContext` object. Returns:boolean Doc from jakarta.faces.context.PartialViewContext.isPartialRequest. whether or not this request is partial Annotations @Override See Also `PartialViewContext#isPartialRequest()`

public boolean isPartialRequest()

Implements abstract jakarta.faces.context.PartialViewContext.isPartialRequest.

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

Returns:boolean

Doc from jakarta.faces.context.PartialViewContext.isPartialRequest.

whether or not this request is partial

Annotations

@Override

See Also

PartialViewContext#isPartialRequest()

isRenderAll back to summary

isRenderAll	back to summary
public boolean isRenderAll() Implements abstract jakarta.faces.context.PartialViewContext.isRenderAll. The default behavior of this method is to call `PartialViewContext#isRenderAll()` on the wrapped `PartialViewContext` object. Returns:boolean Doc from jakarta.faces.context.PartialViewContext.isRenderAll. whether or not this is a render all request Annotations @Override See Also `PartialViewContext#isRenderAll()`

public boolean isRenderAll()

Implements abstract jakarta.faces.context.PartialViewContext.isRenderAll.

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

Returns:boolean

Doc from jakarta.faces.context.PartialViewContext.isRenderAll.

whether or not this is a render all request

Annotations

@Override

See Also

PartialViewContext#isRenderAll()

isResetValues back to summary

isResetValues	back to summary
public boolean isResetValues() Overrides jakarta.faces.context.PartialViewContext.isResetValues. The default behavior of this method is to call `PartialViewContext#isResetValues()` on the wrapped `PartialViewContext` object. Returns:boolean Doc from jakarta.faces.context.PartialViewContext.isResetValues. whether or not this is a reset values request Annotations @Override See Also `PartialViewContext#isResetValues()`

public boolean isResetValues()

Overrides jakarta.faces.context.PartialViewContext.isResetValues.

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

Returns:boolean

Doc from jakarta.faces.context.PartialViewContext.isResetValues.

whether or not this is a reset values request

Annotations

@Override

See Also

PartialViewContext#isResetValues()

processPartial back to summary

processPartial	back to summary
public void processPartial(PhaseId phaseId) Implements abstract jakarta.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 jakarta.faces.context.PartialViewContext.processPartial. the `jakarta.faces.event.PhaseId` that indicates the lifecycle phase the components will be processed in. Annotations @Override See Also `PartialViewContext#processPartial(PhaseId)`

public void processPartial(PhaseId phaseId)

Implements abstract jakarta.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 jakarta.faces.context.PartialViewContext.processPartial.

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

Annotations

@Override

release back to summary

release	back to summary
public void release() Implements abstract jakarta.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()`

public void release()

Implements abstract jakarta.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()

setPartialRequest back to summary

setPartialRequest	back to summary
public void setPartialRequest(boolean isPartialRequest) Implements abstract jakarta.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 jakarta.faces.context.PartialViewContext.setPartialRequest. the value `true` indicates this is a partial request. Annotations @Override See Also `PartialViewContext#setPartialRequest(boolean)`

public void setPartialRequest(boolean isPartialRequest)

Implements abstract jakarta.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 jakarta.faces.context.PartialViewContext.setPartialRequest.

the value true indicates this is a partial request.

Annotations

@Override

setRenderAll back to summary

setRenderAll	back to summary
public void setRenderAll(boolean renderAll) Implements abstract jakarta.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 jakarta.faces.context.PartialViewContext.setRenderAll. the value `true` indicates the entire view must be rendered. Annotations @Override See Also `PartialViewContext#setRenderAll(boolean)`

public void setRenderAll(boolean renderAll)

Implements abstract jakarta.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 jakarta.faces.context.PartialViewContext.setRenderAll.

the value true indicates the entire view must be rendered.

Annotations

@Override

public abstract Class PartialViewContextWrapper

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail