OmniPartialViewContext

java.lang.Object
- javax.faces.context.PartialViewContext
- - javax.faces.context.PartialViewContextWrapper
  - - org.omnifaces.context.OmniPartialViewContext

All Implemented Interfaces:

FacesWrapper<PartialViewContext>
```
public class OmniPartialViewContext
extends PartialViewContextWrapper
```
This OmniFaces partial view context extends and improves the standard partial view context as follows:
- Support for executing callback scripts by PartialResponseWriter.startEval().
- Support for adding arguments to an ajax response.
- Any XML tags which Mojarra and MyFaces has left open after an exception in rendering of an already committed ajax response, will now be properly closed. This prevents errors about malformed XML.
- Fixes the no-feedback problem when ViewExpiredException occurs during an ajax request on a restricted page. The end-user will now properly be redirected to the login page.
You can use the Ajax utility class to easily add callback scripts and arguments.
This partial view context is already registered by OmniFaces' own faces-config.xml and thus gets auto-initialized when the OmniFaces JAR is bundled in a web application, so end-users do not need to register this partial view context explicitly themselves.
Since:

1.2

Author:

Bauke Scholtz

Field Summary
- Fields inherited from class javax.faces.context.PartialViewContext
  ALL_PARTIAL_PHASE_CLIENT_IDS, PARTIAL_EXECUTE_PARAM_NAME, PARTIAL_RENDER_PARAM_NAME

Constructor Summary

Constructors
Constructor and Description

OmniPartialViewContext(PartialViewContext wrapped)
Construct a new OmniFaces partial view context around the given wrapped partial view context.

Constructors
Constructor and Description
`OmniPartialViewContext(PartialViewContext wrapped)` Construct a new OmniFaces partial view context around the given wrapped partial view context.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addArgument(String name, Object value)` Add an argument to the partial response.
`void`	`addCallbackScript(String callbackScript)` Add a callback script to the partial response.
`void`	`closePartialResponse()` Close the partial response.
`static OmniPartialViewContext`	`getCurrentInstance()` Returns the current instance of the OmniFaces partial view context.
`static OmniPartialViewContext`	`getCurrentInstance(FacesContext context)` Returns the current instance of the OmniFaces partial view context from the given faces context.
`PartialResponseWriter`	`getPartialResponseWriter()`
`PartialViewContext`	`getWrapped()`
`void`	`resetPartialResponse()` Reset the partial response.
`void`	`setPartialRequest(boolean isPartialRequest)`

Methods inherited from class javax.faces.context.PartialViewContextWrapper
getExecuteIds, getRenderIds, isAjaxRequest, isExecuteAll, isPartialRequest, isRenderAll, processPartial, release, setRenderAll

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

- Constructor Detail
  - OmniPartialViewContext
```
public OmniPartialViewContext(PartialViewContext wrapped)
```
    Construct a new OmniFaces partial view context around the given wrapped partial view context.
    
    Parameters:
    wrapped - The wrapped partial view context.
- Method Detail
  - getPartialResponseWriter
```
public PartialResponseWriter getPartialResponseWriter()
```
    Overrides:
    
    getPartialResponseWriter in class PartialViewContextWrapper
  - setPartialRequest
```
public void setPartialRequest(boolean isPartialRequest)
```
    Specified by:
    
    setPartialRequest in class PartialViewContext
  - getWrapped
```
public PartialViewContext getWrapped()
```
    Specified by:
    
    getWrapped in interface FacesWrapper<PartialViewContext>
    
    Overrides:
    
    getWrapped in class PartialViewContextWrapper
  - addArgument
```
public void addArgument(String name,
               Object value)
```
    Add an argument to the partial response. This is as JSON object available by OmniFaces.Ajax.data. For supported argument value types, read Json.encode(Object). If a given argument type is not supported, then an IllegalArgumentException will be thrown during end of render response.
    
    Parameters:
    name - The argument name.
    value - The argument value.
  - addCallbackScript
```
public void addCallbackScript(String callbackScript)
```
    Add a callback script to the partial response. This script will be executed once the partial response is successfully retrieved at the client side.
    
    Parameters:
    callbackScript - The callback script to be added to the partial response.
  - resetPartialResponse
```
public void resetPartialResponse()
```
    Reset the partial response. This clears any JavaScript arguments and callbacks set any data written to the PartialResponseWriter.
    
    See Also:
    FullAjaxExceptionHandler
  - closePartialResponse
```
public void closePartialResponse()
```
    Close the partial response. If the writer is still in update phase, then end the update and the document. This fixes the Mojarra problem of incomplete ajax responses caused by exceptions during ajax render response.
    
    See Also:
    FullAjaxExceptionHandler
  - getCurrentInstance
```
public static OmniPartialViewContext getCurrentInstance()
```
    Returns the current instance of the OmniFaces partial view context.
    
    Returns:
    The current instance of the OmniFaces partial view context.
    
    Throws:
    
    IllegalStateException - When there is no current instance of the OmniFaces partial view context. That can happen when the OmniPartialViewContextFactory is not properly registered, or when there's another PartialViewContext implementation which doesn't properly delegate through the wrapped instance.
  - getCurrentInstance
```
public static OmniPartialViewContext getCurrentInstance(FacesContext context)
```
    Returns the current instance of the OmniFaces partial view context from the given faces context.
    
    Parameters:
    context - The faces context to obtain the current instance of the OmniFaces partial view context from.
    
    Returns:
    The current instance of the OmniFaces partial view context from the given faces context.
    
    Throws:
    
    IllegalStateException - When there is no current instance of the OmniFaces partial view context. That can happen when the OmniPartialViewContextFactory is not properly registered, or when there's another PartialViewContext implementation which doesn't properly delegate through the wrapped instance.

Class OmniPartialViewContext

Field Summary

Fields inherited from class javax.faces.context.PartialViewContext

Constructor Summary

Method Summary

Methods inherited from class javax.faces.context.PartialViewContextWrapper

Methods inherited from class java.lang.Object

Constructor Detail

OmniPartialViewContext

Method Detail

getPartialResponseWriter

setPartialRequest

getWrapped

addArgument

addCallbackScript

resetPartialResponse

closePartialResponse

getCurrentInstance

getCurrentInstance