Examples of org.richfaces.context.ExtendedPartialViewContext

org.richfaces.context.ExtendedPartialViewContext
The RichFaces custom version of PartialViewContext

Important differences of RichFaces implementation:
- Values are resolved in runtime by visiting the request activator component and evaluating attributes
- Usage of extended visit contexts in order to support meta-components processing
- Support for auto-updateable Ajax components
- Support for Ajax extensions like passing data to the client, onbeforedomupdate and oncomplete callbacks and {@link JavaScriptService}
Extended Partial View Processing Scheme

On following diagram, you can see which classes contributes to RichFaces specific partial view processing (find an explanation bellow):
```
 +-------------------------+  RF: ExtendedPartialViewContextFactory |PartialViewContextFactory| +------------+------------+   +------------------------+ |                |   PartialViewContext   | Mojarra: PartialViewContextImpl +--------------->|                        | RF: ExtendedPartialViewContext creates        |#processPartial(PhaseId)| +--+-------------+-------+ |             | RF: ExtendedVisitContextFactory  |             | +-------------------+            |             | |VisitContextFactory|            |             | +--------------+----+       uses |             |creates/uses |                 |             | creates |                 |             | v                 v             v +----------------------------+        +---------------------------+ |        VisitContext        |        |       VisitCallback       | |                            |        |                           | |     #invokeVisitContext    |        |          #visit           | |(UIComponent, VisitCallback)|        |(VisitContext, UIComponent)| +----------------------------+        +---------------------------+ Mojarra: PhaseAwareVisitCallback RF: ExtendedExecuteVisitContext       RF: MetaComponentProcessingVisitCallback RF: ExtendedRenderVisitContext        RF: MetaComponentEncodingVisitCallback +-----------------------------+ |          UIViewRoot         | |                             | |          #visitTree         | |(VisitContext, VisitCallback)| +-----------------------------+ 
```
{@link ExtendedPartialViewContext} does (except other things) tracking of the mode ({@link ExtendedVisitContextMode}). This mode determines whether we are not inside a partial processing phase (inside {@link #processPartial(PhaseId)}) or not (determined by mode equal to null).

The knowledge of current mode is leveraged by {@link ExtendedVisitContextFactory} that either use visit context created by parent factory (in a wrapper chain) in case the mode is equal to null or it creates {@link ExtendedExecuteVisitContext} (resp. {@link ExtendedRenderVisitContext}).

(Note: the null mode is necessary because the tree visiting can be leveraged outside of partial tree processing/rendering, e.g. in partial state saving)
These {@link VisitContext} wrappers makes sure that when {@link VisitContext#invokeVisitCallback(UIComponent,VisitCallback)} method is called, the actual {@link VisitCallback} created by JSF implementation is wrapped in wrappers that allows to execute (resp. render) meta-components {@link MetaComponentProcessingVisitCallback} (resp. {@link MetaComponentEncodingVisitCallback}).

While extended {@link VisitContext} implementations ({@link ExtendedRenderVisitContext} and {@link ExtendedExecuteVisitContext}) allows to visit subtrees that are not normally visited (meta-components and implicitly renderer areas, aka {@link AjaxOutput}s),

extended implementations of {@link VisitCallback} ({@link MetaComponentProcessingVisitCallback} and {@link MetaComponentEncodingVisitCallback}) do the extended processing and rendering logic for meta-components.

{@link UIViewRoot} is a place where the tree processing starts to dive into subtrees, it is called by JSF implementation of {@link PartialViewContext#processPartial(PhaseId)}.

Rendering AJAX Extensions

This context returns wrapped {@link PartialResponseWriter} in order to intercept its {@link PartialResponseWriter#endDocument()} method and write extensions before the document is actually ended. For more details see {@link ExtensionWritingPartialResponseWriter}. @author Lukas Fryc @author Nick Belaevski

            encodeSelectionStateInput(context, component);
            writer.endUpdate();


            JSFunction function = new JSFunction("RichFaces.component", component.getClientId(context));


            ExtendedPartialViewContext partialContext = ExtendedPartialViewContext.getInstance(context);
            partialContext.appendOncomplete(function.toScript() + ".__updateSelectionFromInput();");
        } else {
            throw new IllegalArgumentException(metaComponentId);
        }


        // TODO Auto-generated method stub

View Full Code Here

    public void encodeMetaComponent(FacesContext context, UIComponent component, String metaComponentId) throws IOException {


        if (AbstractProgressBar.STATE_META_COMPONENT_ID.equals(metaComponentId)) {
            ProgressBarState state = getCurrentState(context, component);


            ExtendedPartialViewContext partialContext = ExtendedPartialViewContext.getInstance(context);
            partialContext.getResponseComponentDataMap().put(component.getClientId(context),
                NumberUtils.getNumber(component.getAttributes().get("value")));


            PartialResponseWriter partialResponseWriter = context.getPartialViewContext().getPartialResponseWriter();
            partialResponseWriter.startUpdate(state.getStateClientId(context, component));

View Full Code Here

    // may not work
    @SuppressWarnings("unused")
    public static void addToRerender(String componentId) {
        try {
            FacesContext fc = FacesContext.getCurrentInstance();
            ExtendedPartialViewContext epvc = ExtendedPartialViewContext.getInstance(fc);
            UIComponent destComponent = fc.getViewRoot().findComponent(componentId);
        } catch (Exception e) {
            System.err.print(e.getMessage());
        }
    }

View Full Code Here

            encodeSelectionStateInput(context, component);
            writer.endUpdate();


            JSFunction function = new JSFunction("RichFaces.$", component.getClientId(context));


            ExtendedPartialViewContext partialContext = ExtendedPartialViewContext.getInstance(context);
            partialContext.appendOncomplete(function.toScript() + ".__updateSelectionFromInput();");
        } else {
            throw new IllegalArgumentException(metaComponentId);
        }


        // TODO Auto-generated method stub

View Full Code Here

    public void encodeMetaComponent(FacesContext context, UIComponent component, String metaComponentId) throws IOException {


        if (AbstractProgressBar.STATE_META_COMPONENT_ID.equals(metaComponentId)) {
            ProgressBarState state = getCurrentState(context, component);


            ExtendedPartialViewContext partialContext = ExtendedPartialViewContext.getInstance(context);
            partialContext.getResponseComponentDataMap().put(component.getClientId(context),
                NumberUtils.getNumber(component.getAttributes().get("value")));


            PartialResponseWriter partialResponseWriter = context.getPartialViewContext().getPartialResponseWriter();
            partialResponseWriter.startUpdate(state.getStateClientId(context, component));

View Full Code Here

        if (treeNode.getClientId(context).equals(context.getAttributes().get(TreeNodeRendererBase.AJAX_TOGGLED_NODE_ATTRIBUTE))) {
            TreeNodeState initialState = (TreeNodeState) context.getAttributes().get(
                TreeNodeRendererBase.AJAX_TOGGLED_NODE_STATE_ATTRIBUTE);


            if (initialState.isDifferentThan(nodeState)) {
                ExtendedPartialViewContext partialContext = ExtendedPartialViewContext.getInstance(context);
                partialContext.appendOncomplete(new JSFunction("RichFaces.ui.TreeNode.emitToggleEvent", treeNode
                    .getClientId(context)));
            }
        }
    }

View Full Code Here

TOP

Related Classes of org.richfaces.context.ExtendedPartialViewContext

org.richfaces.javascript.ScriptsHolder

org.richfaces.photoalbum.util.ApplicationUtils

org.richfaces.renderkit.AjaxDataSerializer

org.richfaces.renderkit.html.ProgressBarBaseRenderer

org.richfaces.renderkit.TreeEncoderBase

org.richfaces.renderkit.TreeRendererBase

javax.faces.context.PartialViewContext

javax.faces.event.PhaseId

javax.faces.component.visit.VisitContextFactory

javax.faces.component.visit.VisitContext

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.

Examples of org.richfaces.context.ExtendedPartialViewContext

Extended Partial View Processing Scheme

Rendering AJAX Extensions

Related Classes of org.richfaces.context.ExtendedPartialViewContext