Package org.apache.ofbiz.birt.webapp.view

Class BirtViewHandler

  • All Implemented Interfaces:
    ViewHandler
    public class BirtViewHandler
extends java.lang.Object
implements ViewHandler

    • Constructor Summary

      Constructors 
      Constructor Description
      BirtViewHandler()  

    • Method Summary

      All Methods Instance Methods Concrete 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​(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, HttpServletRequest request, 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.

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • module

        public static final java.lang.String module

    • Constructor Detail

      • BirtViewHandler

        public BirtViewHandler()

    • Method Detail

      • init

        public void init​(ServletContext context)
          throws ViewHandlerException
        Description copied from interface: ViewHandler
        Initializes the handler. Since handlers use the singleton pattern this method should only be called the first time the handler is used.
        Specified by:
        init in interface ViewHandler
        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

      • getName

        public java.lang.String getName()
        Description copied from interface: ViewHandler
        Gets the name of the view handler as declared in the controller configuration file.
        Specified by:
        getName in interface ViewHandler
        Returns:
        name String The name of the view handler as declared in the controller configuration file.

      • setName

        public void setName​(java.lang.String name)
        Description copied from interface: ViewHandler
        Sets the name of the view handler as declared in the controller configuration file.
        Specified by:
        setName in interface ViewHandler
        Parameters:
        name - String The name of the view handler as declared in the controller configuration file.

      • render

        public void render​(java.lang.String name,
                   java.lang.String page,
                   java.lang.String info,
                   java.lang.String contentType,
                   java.lang.String encoding,
                   HttpServletRequest request,
                   HttpServletResponse response)
            throws ViewHandlerException
        Description copied from interface: ViewHandler
        Render the page.
        Specified by:
        render in interface ViewHandler
        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