Package javax.faces.lifecycle

Class ClientWindowWrapper

    • Constructor Summary

      Constructors 
      Constructor Description
      ClientWindowWrapper​()
      Deprecated. 
      Use the other constructor taking the implementation being wrapped.
      ClientWindowWrapper​(ClientWindow wrapped)
      If this client window has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void decode​(FacesContext context)
      The implementation is responsible for examining the incoming request and extracting the value that must be returned from the ClientWindow.getId() method.
      void disableClientWindowRenderMode​(FacesContext context)
      Components that permit per-use disabling of the appending of the ClientWindow in generated URLs must call this method first before rendering those URLs.
      void enableClientWindowRenderMode​(FacesContext context)
      Components that permit per-use disabling of the appending of the ClientWindow in generated URLs must call this method first after rendering those URLs.
      java.lang.String getId​()
      Return a String value that uniquely identifies this ClientWindow within the scope of the current session.
      java.util.Map<java.lang.String,java.lang.String> getQueryURLParameters​(FacesContext context)
      This method will be called whenever a URL is generated by the runtime where client window related parameters need to be inserted into the URL.
      ClientWindow getWrapped​()
      A class that implements this interface uses this method to return an instance of the class being wrapped.
      boolean isClientWindowRenderModeEnabled​(FacesContext context)
      Methods that append the ClientWindow to generated URLs must call this method to see if they are permitted to do so.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ClientWindowWrapper

        @Deprecated
public ClientWindowWrapper​()
        Deprecated. Use the other constructor taking the implementation being wrapped.

      • ClientWindowWrapper

        public ClientWindowWrapper​(ClientWindow wrapped)

        If this client window 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 - The implementation being wrapped.
        Since:
        2.3

    • Method Detail

      • getWrapped

        public ClientWindow getWrapped​()
        Description copied from interface: FacesWrapper

        A class that implements this interface uses this method to return an instance of the class being wrapped.

        Specified by:
        getWrapped in interface FacesWrapper<ClientWindow>
        Returns:
        the wrapped instance.

      • getQueryURLParameters

        public java.util.Map<java.lang.String,java.lang.String> getQueryURLParameters​(FacesContext context)
        Description copied from class: ClientWindow

        This method will be called whenever a URL is generated by the runtime where client window related parameters need to be inserted into the URL. This guarantees custom ClientWindow implementations that they will have the opportunity to insert any additional client window specific information in any case where a URL is generated, such as the rendering of hyperlinks. The returned map must be immutable. The default implementation of this method returns the empty map.

        Specified by:
        getQueryURLParameters in class ClientWindow
        Parameters:
        context - the FacesContext for this request.
        Returns:
        null or a map of parameters to insert into the URL query string.

      • enableClientWindowRenderMode

        public void enableClientWindowRenderMode​(FacesContext context)
        Description copied from class: ClientWindow

        Components that permit per-use disabling of the appending of the ClientWindow in generated URLs must call this method first after rendering those URLs. If ClientWindow.CLIENT_WINDOW_MODE_PARAM_NAME is "url" without the quotes, all generated URLs that cause a GET request must append the ClientWindow by default. This is specified as a static method because callsites need to access it without having access to an actual ClientWindow instance.

        Overrides:
        enableClientWindowRenderMode in class ClientWindow
        Parameters:
        context - the FacesContext for this request.

      • isClientWindowRenderModeEnabled

        public boolean isClientWindowRenderModeEnabled​(FacesContext context)
        Description copied from class: ClientWindow

        Methods that append the ClientWindow to generated URLs must call this method to see if they are permitted to do so. If ClientWindow.CLIENT_WINDOW_MODE_PARAM_NAME is "url" without the quotes, all generated URLs that cause a GET request must append the ClientWindow by default. This is specified as a static method because callsites need to access it without having access to an actual ClientWindow instance.

        Overrides:
        isClientWindowRenderModeEnabled in class ClientWindow
        Parameters:
        context - the FacesContext for this request.
        Returns:
        the result as specified above