Package org.primefaces.clientwindow

Class PrimeClientWindow

java.lang.Object
javax.faces.lifecycle.ClientWindow
org.primefaces.clientwindow.PrimeClientWindow
public class PrimeClientWindow extends javax.faces.lifecycle.ClientWindow

  • Field Summary

    Fields inherited from class javax.faces.lifecycle.ClientWindow

    CLIENT_WINDOW_MODE_PARAM_NAME

  • Constructor Summary

    Constructors
    Constructor
    Description
    PrimeClientWindow()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected String
    appendParameters(javax.faces.context.ExternalContext externalContext, String url, Map<String,List<String>> parameters)
     
    protected String
    constructInitialRedirectUrl(javax.faces.context.FacesContext context)
    Constructs the URL for the initialRedirect, which equals the current requested URL + the window id candidate.
    void
    decode(javax.faces.context.FacesContext context)
     
    protected String
    encodeURLParameterValue(String value, javax.faces.context.ExternalContext externalContext)
    Encodes the given value using URLEncoder.encode() with the charset returned from ExternalContext.getResponseCharacterEncoding().
    String
    getId()
     
    Map<String,String>
    getQueryURLParameters(javax.faces.context.FacesContext context)
     

    Methods inherited from class javax.faces.lifecycle.ClientWindow

    disableClientWindowRenderMode, enableClientWindowRenderMode, isClientWindowRenderModeEnabled

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • PrimeClientWindow

      public PrimeClientWindow()

  • Method Details

    • getQueryURLParameters

      public Map<String,String> getQueryURLParameters(javax.faces.context.FacesContext context)
      Specified by:
      getQueryURLParameters in class javax.faces.lifecycle.ClientWindow

    • getId

      public String getId()
      Specified by:
      getId in class javax.faces.lifecycle.ClientWindow

    • decode

      public void decode(javax.faces.context.FacesContext context)
      Specified by:
      decode in class javax.faces.lifecycle.ClientWindow

    • constructInitialRedirectUrl

      protected String constructInitialRedirectUrl(javax.faces.context.FacesContext context)
      Constructs the URL for the initialRedirect, which equals the current requested URL + the window id candidate. We cant use ViewHandler.getBookmarkableURL(javax.faces.context.FacesContext, java.lang.String, java.util.Map, boolean) as the ViewRoot isn't available yet in the FacesContext. Same applies for ExternalContext.encodeRedirectURL(java.lang.String, java.util.Map).
      Parameters:
      context - The FacesContext.
      Returns:
      The initial-redirect URL.

    • appendParameters

      protected String appendParameters(javax.faces.context.ExternalContext externalContext, String url, Map<String,List<String>> parameters)

    • encodeURLParameterValue

      protected String encodeURLParameterValue(String value, javax.faces.context.ExternalContext externalContext)
      Encodes the given value using URLEncoder.encode() with the charset returned from ExternalContext.getResponseCharacterEncoding(). This is exactly how the ExternalContext impl encodes URL parameter values.
      Parameters:
      value - value which should be encoded
      externalContext - current external-context
      Returns:
      encoded value