org.apache.struts2.sitemesh
Class TemplatePageFilter

java.lang.Object
  extended by com.opensymphony.sitemesh.webapp.SiteMeshFilter
      extended by com.opensymphony.module.sitemesh.filter.PageFilter
          extended by org.apache.struts2.sitemesh.TemplatePageFilter
All Implemented Interfaces:
javax.servlet.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.


Constructor Summary
TemplatePageFilter()
           
 
Method Summary
protected  void applyDecorator(com.opensymphony.module.sitemesh.Page page, com.opensymphony.module.sitemesh.Decorator decorator, javax.servlet.http.HttpServletRequest req, javax.servlet.http.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, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, javax.servlet.ServletContext servletContext, com.opensymphony.xwork2.ActionContext ctx)
          Applies the decorator, using the relevent contexts
protected  java.lang.String getEncoding()
          Gets the L18N encoding of the system.
 void init(javax.servlet.FilterConfig filterConfig)
           
static void setCustomEncoding(java.lang.String enc)
           
 
Methods inherited from class com.opensymphony.sitemesh.webapp.SiteMeshFilter
destroy, doFilter, initContentProcessor, initDecoratorSelector
 
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

setCustomEncoding

public static void setCustomEncoding(java.lang.String enc)

init

public void init(javax.servlet.FilterConfig filterConfig)
Specified by:
init in interface javax.servlet.Filter
Overrides:
init in class com.opensymphony.sitemesh.webapp.SiteMeshFilter

applyDecorator

protected abstract void applyDecorator(com.opensymphony.module.sitemesh.Page page,
                                       com.opensymphony.module.sitemesh.Decorator decorator,
                                       javax.servlet.http.HttpServletRequest req,
                                       javax.servlet.http.HttpServletResponse res,
                                       javax.servlet.ServletContext servletContext,
                                       com.opensymphony.xwork2.ActionContext ctx)
                                throws javax.servlet.ServletException,
                                       java.io.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:
javax.servlet.ServletException
java.io.IOException

applyDecorator

protected void applyDecorator(com.opensymphony.module.sitemesh.Page page,
                              com.opensymphony.module.sitemesh.Decorator decorator,
                              javax.servlet.http.HttpServletRequest req,
                              javax.servlet.http.HttpServletResponse res)
                       throws javax.servlet.ServletException,
                              java.io.IOException
Applies the decorator, creating the relevent contexts and delegating to the extended applyDecorator().

Parameters:
page - The page
decorator - The decorator
req - The servlet request
res - The servlet response
Throws:
javax.servlet.ServletException
java.io.IOException

getEncoding

protected java.lang.String getEncoding()
Gets the L18N encoding of the system. The default is UTF-8.



Copyright © 2000-2009 Apache Software Foundation. All Rights Reserved.