Package org.apache.ofbiz.webapp.view

Interface ViewHandler

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getName()
      Gets the name of the view handler as declared in the controller configuration file.
      void init​(javax.servlet.ServletContext context)
      Initializes the handler.
      void render​(java.lang.String name, java.lang.String page, java.lang.String info, java.lang.String contentType, java.lang.String encoding, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
      Render the page.
      void setName​(java.lang.String name)
      Sets the name of the view handler as declared in the controller configuration file.

    • Method Detail

      • setName

        void setName​(java.lang.String name)
        Sets the name of the view handler as declared in the controller configuration file.
        Parameters:
        name - String The name of the view handler as declared in the controller configuration file.

      • getName

        java.lang.String getName()
        Gets the name of the view handler as declared in the controller configuration file.
        Returns:
        name String The name of the view handler as declared in the controller configuration file.

      • init

        void init​(javax.servlet.ServletContext context)
   throws ViewHandlerException
        Initializes the handler. Since handlers use the singleton pattern this method should only be called the first time the handler is used.
        Parameters:
        context - ServletContext This may be needed by the handler in order to lookup properties or XML definition files for rendering pages or handler options.
        Throws:
        ViewHandlerException

      • render

        void render​(java.lang.String name,
            java.lang.String page,
            java.lang.String info,
            java.lang.String contentType,
            java.lang.String encoding,
            javax.servlet.http.HttpServletRequest request,
            javax.servlet.http.HttpServletResponse response)
     throws ViewHandlerException
        Render the page.
        Parameters:
        name - The name of the view.
        page - The source of the view; could be a page, url, etc depending on the type of handler.
        info - An info string attached to this view
        request - The HttpServletRequest object used when requesting this page.
        response - The HttpServletResponse object to be used to present the page.
        Throws:
        ViewHandlerException