com.opensymphony.webwork.sitemesh
Class TemplatePageFilter

java.lang.Object
  com.opensymphony.module.sitemesh.filter.PageFilter
      com.opensymphony.webwork.sitemesh.TemplatePageFilter

All Implemented Interfaces:

com.opensymphony.module.sitemesh.RequestConstants, Filter

Direct Known Subclasses:

FreeMarkerPageFilter, VelocityPageFilter

public abstract class TemplatePageFilter
extends com.opensymphony.module.sitemesh.filter.PageFilter

An abstract template page filter that sets up the proper contexts for template processing.

Author:

patrick

Field Summary

Fields inherited from interface com.opensymphony.module.sitemesh.RequestConstants

DECORATOR, FILTER_APPLIED, PAGE, ROBOT, USING_STREAM

Constructor Summary

TemplatePageFilter()

Method Summary

protected void	applyDecorator(com.opensymphony.module.sitemesh.Page page, com.opensymphony.module.sitemesh.Decorator decorator, HttpServletRequest req, HttpServletResponse res) Applies the decorator, creating the relevent contexts and delegating to the extended applyDecorator().
protected abstract void	applyDecorator(com.opensymphony.module.sitemesh.Page page, com.opensymphony.module.sitemesh.Decorator decorator, HttpServletRequest req, HttpServletResponse res, ServletContext servletContext, com.opensymphony.xwork.ActionContext ctx) Applies the decorator, using the relevent contexts
protected String	getEncoding() Gets the L18N encoding of the system.
void	init(FilterConfig filterConfig)

Methods inherited from class com.opensymphony.module.sitemesh.filter.PageFilter

destroy, doFilter, getFilterConfig, parsePage, setFilterConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplatePageFilter

public TemplatePageFilter()

Method Detail

init

public void init(FilterConfig filterConfig)

Specified by:

init in interface Filter

Overrides:

init in class com.opensymphony.module.sitemesh.filter.PageFilter

applyDecorator

protected abstract void applyDecorator(com.opensymphony.module.sitemesh.Page page,
                                       com.opensymphony.module.sitemesh.Decorator decorator,
                                       HttpServletRequest req,
                                       HttpServletResponse res,
                                       ServletContext servletContext,
                                       com.opensymphony.xwork.ActionContext ctx)
                                throws ServletException,
                                       IOException

Applies the decorator, using the relevent contexts

Parameters:

page - The page

decorator - The decorator

req - The servlet request

res - The servlet response

servletContext - The servlet context

ctx - The action context for this request, populated with the server state

Throws:

ServletException

IOException

applyDecorator

protected void applyDecorator(com.opensymphony.module.sitemesh.Page page,
                              com.opensymphony.module.sitemesh.Decorator decorator,
                              HttpServletRequest req,
                              HttpServletResponse res)
                       throws ServletException,
                              IOException

Applies the decorator, creating the relevent contexts and delegating to the extended applyDecorator().

Overrides:

applyDecorator in class com.opensymphony.module.sitemesh.filter.PageFilter

Parameters:

page - The page

decorator - The decorator

req - The servlet request

res - The servlet response

Throws:

ServletException

IOException

getEncoding

protected String getEncoding()

Gets the L18N encoding of the system. The default is UTF-8.