Examples of org.omnifaces.context.OmniPartialViewContext

org.omnifaces.context.OmniPartialViewContext

This OmniFaces partial view context extends and improves the standard partial view context as follows:

Support for executing callback scripts by {@link 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 a {@link ViewExpiredException} occurs during an ajax request on a page whichis restricted by web.xml <security-constraint>. The enduser will now properly be redirected to the login page instead of retrieving an ajax response with only a changed view state (and effectively thus no visual feedback at all).

You can use the {@link 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. @author Bauke Scholtz @since 1.2 @see OmniPartialViewContextFactory

   * Execute the given scripts on complete of the current ajax response.
   * @param scripts The scripts to be executed.
   * @see OmniPartialViewContext#addCallbackScript(String)
   */
  public static void oncomplete(String... scripts) {
    OmniPartialViewContext context = OmniPartialViewContext.getCurrentInstance();


    for (String script : scripts) {
      context.addCallbackScript(script);
    }
  }

  public static void data(Object... namesValues) {
    if (namesValues.length % 2 != 0) {
      throw new IllegalArgumentException(String.format(ERROR_ARGUMENTS_LENGTH, namesValues.length));
    }


    OmniPartialViewContext context = OmniPartialViewContext.getCurrentInstance();


    for (int i = 0; i < namesValues.length; i+= 2) {
      if (!(namesValues[i] instanceof String)) {
        String type = (namesValues[i]) != null ? namesValues[i].getClass().getName() : "null";
        throw new IllegalArgumentException(String.format(ERROR_ARGUMENT_TYPE, type, namesValues[i]));
      }


      context.addArgument((String) namesValues[i], namesValues[i + 1]);
    }
  }

   * <code>OmniFaces.Ajax.data</code>.
   * @param data The mapping of data arguments.
   * @see OmniPartialViewContext#addArgument(String, Object)
   */
  public static void data(Map<String, Object> data) {
    OmniPartialViewContext context = OmniPartialViewContext.getCurrentInstance();


    for (Entry<String, Object> entry : data.entrySet()) {
      context.addArgument(entry.getKey(), entry.getValue());
    }
  }

Examples of org.omnifaces.context.OmniPartialViewContext

Related Classes of org.omnifaces.context.OmniPartialViewContext