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

Class BirtViewHandler

java.lang.Object

org.apache.ofbiz.birt.webapp.view.BirtViewHandler

All Implemented Interfaces:

ViewHandler

public class BirtViewHandler
extends Object
implements ViewHandler

Field Summary

Fields

Modifier and Type	Field	Description
static String	module
static String	resource_error
protected ServletContext	servletContext

Constructor Summary

Constructors

Constructor	Description
BirtViewHandler()

Method Summary

Modifier and Type	Method	Description
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(String name, String page, String info, String contentType, String encoding, HttpServletRequest request, HttpServletResponse response)	Render the page.
void	setName(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 String module

resource_error

public static final String resource_error

See Also:

Constant Field Values

servletContext

protected ServletContext servletContext

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 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(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(String name,
                   String page,
                   String info,
                   String contentType,
                   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