A B C D F G H I N P R S T U W

A

AbstractHTMLPage - class com.sitemesh.parser.AbstractHTMLPage.
Abstract implementation of HTMLPage.
AbstractHTMLPage() - Constructor for class com.sitemesh.parser.AbstractHTMLPage
 
AbstractPage - class com.sitemesh.parser.AbstractPage.
Abstract implementation of Page .
AbstractPage() - Constructor for class com.sitemesh.parser.AbstractPage
 
AbstractPageParser - class com.sitemesh.parser.AbstractPageParser.
Abstract implementation of PageParser.
AbstractPageParser() - Constructor for class com.sitemesh.parser.AbstractPageParser
 
AbstractTag - class com.sitemesh.taglib.AbstractTag.
Convenience implementation of Tag containing generice methods required by all (or most) taglibs.
AbstractTag() - Constructor for class com.sitemesh.taglib.AbstractTag
 
addProperty(String, String) - Method in class com.sitemesh.parser.AbstractPage
Add a property to the properties list.

B

BodyTag - class com.sitemesh.taglib.decorator.BodyTag.
Write original HTMLPage body to out.
BodyTag() - Constructor for class com.sitemesh.taglib.decorator.BodyTag
 

C

close() - Method in class com.sitemesh.filter.PageOutputStream
 
closeStream() - Method in class com.sitemesh.filter.PageResponse
Flush and close output stream of wrapped response.
com.sitemesh - package com.sitemesh
 
com.sitemesh.filter - package com.sitemesh.filter
 
com.sitemesh.mapper - package com.sitemesh.mapper
 
com.sitemesh.parser - package com.sitemesh.parser
 
com.sitemesh.taglib - package com.sitemesh.taglib
 
com.sitemesh.taglib.decorator - package com.sitemesh.taglib.decorator
 
com.sitemesh.taglib.page - package com.sitemesh.taglib.page
 
config - Variable in class com.sitemesh.Factory
ServletConfig or FilterConfig.

D

Decorator - interface com.sitemesh.Decorator.
Representation of a Decorator.
DECORATOR - Static variable in interface com.sitemesh.RequestConstants
The name (String) of the Decorator to suggest using.
decoratorMapper - Variable in class com.sitemesh.Factory
Instance of DecoratorMapper.
DecoratorMapper - interface com.sitemesh.DecoratorMapper.
The DecoratorMapper is resposible for determining which Decorator should be used for a Page .
DefaultDecorator - class com.sitemesh.mapper.DefaultDecorator.
Default implementation of Decorator.
DefaultDecorator(String, String, Map) - Constructor for class com.sitemesh.mapper.DefaultDecorator
Constructor to set all properties.
DefaultDecoratorMapper - class com.sitemesh.mapper.DefaultDecoratorMapper.
Default implementation of DecoratorMapper.
DefaultDecoratorMapper() - Constructor for class com.sitemesh.mapper.DefaultDecoratorMapper
 
doEndTag() - Method in class com.sitemesh.taglib.AbstractTag
To be implemented by all empty tags.
doEndTag() - Method in class com.sitemesh.taglib.decorator.UsePageTag
 
doEndTag() - Method in class com.sitemesh.taglib.decorator.BodyTag
 
doEndTag() - Method in class com.sitemesh.taglib.decorator.HeadTag
 
doEndTag() - Method in class com.sitemesh.taglib.decorator.PropertyTag
 
doEndTag() - Method in class com.sitemesh.taglib.decorator.TitleTag
 
doEndTag() - Method in class com.sitemesh.taglib.page.PanelTag
Standard taglib method: apply decorator to page.
doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class com.sitemesh.filter.PageFilter
Main method of Filter.
DOMPage - class com.sitemesh.parser.DOMPage.
Implementation of HTMLPage that populates itself from a parsed DOM document.
DOMPage(byte[], HTMLDocument) - Constructor for class com.sitemesh.parser.DOMPage
Create instance and set all initial properties and data.
DOMPageParser - class com.sitemesh.parser.DOMPageParser.
Implementation of PageParser that builds up a HTMLPage using DOM.
DOMPageParser() - Constructor for class com.sitemesh.parser.DOMPageParser
 
doStartTag() - Method in class com.sitemesh.taglib.AbstractTag
Returns SKIP_BODY.

F

Factory - class com.sitemesh.Factory.
Factory responsible for creating appropriate instances of implementations.
Factory(Config) - Constructor for class com.sitemesh.Factory
Constructor for default implementation of Factory.
FILTER_APPLIED - Static variable in interface com.sitemesh.RequestConstants
Marker that stores a Boolean to state whether the decorator filter has been applied yet in this request.
flush() - Method in class com.sitemesh.filter.PageOutputStream
 

G

getBooleanProperty(String) - Method in interface com.sitemesh.Page
Get a property embedded into the Page as a boolean.
getBooleanProperty(String) - Method in class com.sitemesh.parser.AbstractPage
 
getBytes() - Method in class com.sitemesh.filter.PageOutputStream
Return all data that has been written to this OutputStream.
getContentLength() - Method in interface com.sitemesh.Page
Length of the Page, in the format before it was parsed.
getContentLength() - Method in class com.sitemesh.parser.AbstractPage
 
getDecorator(HttpServletRequest, Page) - Method in interface com.sitemesh.DecoratorMapper
Return appropriate Decorator for a certain Page.
getDecorator(HttpServletRequest, Page) - Method in class com.sitemesh.mapper.DefaultDecoratorMapper
 
getDecoratorMapper() - Method in class com.sitemesh.Factory
Return instance of DecoratorMapper.
getDecoratorName() - Method in interface com.sitemesh.HTMLPage
Get the name of the template suitable for the HTMLPage.
getDecoratorName() - Method in class com.sitemesh.parser.AbstractHTMLPage
Return decorator name of from "decorator" property.
getFilterConfig() - Method in class com.sitemesh.filter.PageFilter
Standard Filter method.
getInitParam(String) - Method in interface com.sitemesh.Decorator
Return init parameter of Decorator.
getInitParam(String) - Method in class com.sitemesh.mapper.DefaultDecorator
Return init parameter of Decorator.
getInstance(Config) - Static method in class com.sitemesh.Factory
Entry-point for obtaining singleton instance of Factory.
getIntProperty(String) - Method in interface com.sitemesh.Page
Get a property embedded into the Page as an int.
getIntProperty(String) - Method in class com.sitemesh.parser.AbstractPage
 
getLongProperty(String) - Method in interface com.sitemesh.Page
Get a property embedded into the Page as a long.
getLongProperty(String) - Method in class com.sitemesh.parser.AbstractPage
 
getName() - Method in interface com.sitemesh.Decorator
Name of Decorator.
getName() - Method in class com.sitemesh.mapper.DefaultDecorator
Name of Decorator.
getOutputStream() - Method in class com.sitemesh.filter.PageResponse
Return instance of PageOutputStream allowing all data written to stream to be stored in temporary buffer.
getPage() - Method in interface com.sitemesh.Decorator
URI of Servlet/JSP to dispatch request to (relative to web-app context).
getPage() - Method in class com.sitemesh.filter.PageResponse
Send data written to PageOutputStream to PageParser and return Page instance.
getPage() - Method in class com.sitemesh.mapper.DefaultDecorator
URI of Servlet/JSP to dispatch request to (relative to web-app context).
getPage() - Method in class com.sitemesh.taglib.AbstractTag
Return the Page object from the PAGE scope.
getPageParser(String) - Method in class com.sitemesh.Factory
Create a PageParser suitable for the given content-type.
getParent() - Method in class com.sitemesh.taglib.AbstractTag
 
getProperties(String) - Method in interface com.sitemesh.Page
Get properties embedded into the Page as a String[].
getProperties(String) - Method in class com.sitemesh.parser.AbstractPage
 
getProperty(String) - Method in interface com.sitemesh.Page
Get a property embedded into the Page as a String.
getProperty(String) - Method in class com.sitemesh.parser.AbstractPage
 
getPropertyKeys() - Method in interface com.sitemesh.Page
Get all available property keys for the Page.
getPropertyKeys() - Method in class com.sitemesh.parser.AbstractPage
 
getPropertySize(String) - Method in interface com.sitemesh.Page
Determine the number of properties embedded into the Page with a given name.
getPropertySize(String) - Method in class com.sitemesh.parser.AbstractPage
 
getRequest() - Method in interface com.sitemesh.Page
Return the request of the original page.
getRequest() - Method in class com.sitemesh.parser.AbstractPage
 
getTitle() - Method in interface com.sitemesh.HTMLPage
Get the Title of the document
getTitle() - Method in class com.sitemesh.parser.AbstractHTMLPage
Return title of from "title" property.
getType() - Method in class com.sitemesh.taglib.decorator.UsePageTEI
 
getType() - Method in class com.sitemesh.taglib.decorator.UseHTMLPageTEI
 
getVariableInfo(TagData) - Method in class com.sitemesh.taglib.decorator.UsePageTEI
 

H

HeadTag - class com.sitemesh.taglib.decorator.HeadTag.
Write original HTMLPage head to out.
HeadTag() - Constructor for class com.sitemesh.taglib.decorator.HeadTag
 
HTMLPage - interface com.sitemesh.HTMLPage.
Extention of Page providing access to HTML data.

I

init(Config, Properties) - Method in interface com.sitemesh.DecoratorMapper
Initialize the mapper.
init(Config, Properties) - Method in class com.sitemesh.mapper.DefaultDecoratorMapper
 
isPropertySet(String) - Method in interface com.sitemesh.Page
Determine whether a property embedded into the Page has been set.
isPropertySet(String) - Method in class com.sitemesh.parser.AbstractPage
 

N

name - Variable in class com.sitemesh.mapper.DefaultDecorator
 
noNull(String) - Method in class com.sitemesh.parser.AbstractPage
Return String as is, or "" if null.

P

page - Variable in class com.sitemesh.mapper.DefaultDecorator
 
Page - interface com.sitemesh.Page.
The Page object wraps the contents of the original (undecorated) page.
PAGE - Static variable in interface com.sitemesh.RequestConstants
Stores Page instance for parsed page to be passed across to Decorator .
pageContext - Variable in class com.sitemesh.taglib.AbstractTag
 
pageData - Variable in class com.sitemesh.parser.AbstractPage
Date of page contents.
PageFilter - class com.sitemesh.filter.PageFilter.
Main SiteMesh filter for applying Decorators to entire Pages.
PageFilter() - Constructor for class com.sitemesh.filter.PageFilter
 
PageOutputStream - class com.sitemesh.filter.PageOutputStream.
Implementation of ServletOutputStream that stores all data written to it in a temporary buffer accessible from PageOutputStream.getBytes() .
PageOutputStream() - Constructor for class com.sitemesh.filter.PageOutputStream
 
PageParser - interface com.sitemesh.PageParser.
The PageParser is responsible for parsing the page data into an appropriate Page object.
PageResponse - class com.sitemesh.filter.PageResponse.
Implementation of HttpServletResponse that captures page data instead of sending to output stream.
PageResponse(HttpServletResponse, Config) - Constructor for class com.sitemesh.filter.PageResponse
Create PageResponse wrapped around existing HttpServletResponse.
PanelTag - class com.sitemesh.taglib.page.PanelTag.
This tag inserts an external resource as a panel into the current Page.
PanelTag() - Constructor for class com.sitemesh.taglib.page.PanelTag
 
parameters - Variable in class com.sitemesh.mapper.DefaultDecorator
 
parent - Variable in class com.sitemesh.taglib.AbstractTag
 
parse(byte[]) - Method in interface com.sitemesh.PageParser
 
parse(byte[]) - Method in class com.sitemesh.parser.AbstractPageParser
Method to be implemented by sub-classes.
parse(byte[]) - Method in class com.sitemesh.parser.DOMPageParser
Send data to DOM parser and build new DOMPage.
parse(char[]) - Method in interface com.sitemesh.PageParser
 
parse(char[]) - Method in class com.sitemesh.parser.AbstractPageParser
 
parse(InputSource) - Method in interface com.sitemesh.PageParser
 
parse(InputSource) - Method in class com.sitemesh.parser.AbstractPageParser
 
parse(InputStream) - Method in interface com.sitemesh.PageParser
 
parse(InputStream) - Method in class com.sitemesh.parser.AbstractPageParser
 
parse(Reader) - Method in interface com.sitemesh.PageParser
 
parse(Reader) - Method in class com.sitemesh.parser.AbstractPageParser
 
PropertyTag - class com.sitemesh.taglib.decorator.PropertyTag.
Write property of Page to out.
PropertyTag() - Constructor for class com.sitemesh.taglib.decorator.PropertyTag
 

R

refresh() - Method in class com.sitemesh.mapper.DefaultDecoratorMapper
Check if configuration file has been updated, and if so, reload.
release() - Method in class com.sitemesh.taglib.AbstractTag
 
release() - Method in class com.sitemesh.taglib.decorator.PropertyTag
 
release() - Method in class com.sitemesh.taglib.decorator.TitleTag
 
release() - Method in class com.sitemesh.taglib.page.PanelTag
Standard taglib method: resets attributes.
request - Variable in class com.sitemesh.parser.AbstractPage
RequestURI of original Page.
RequestConstants - interface com.sitemesh.RequestConstants.
This is a set of static constants of Strings to be used as ServletRequest attribute keys to represent various objects passed between pages.

S

setContentType(String) - Method in class com.sitemesh.filter.PageResponse
Set the content-type of the request and store it so it can be passed to the PageParser.
setDecorator(String) - Method in class com.sitemesh.taglib.page.PanelTag
Tag attribute: Name of Decorator to apply to Page.
setDefault(String) - Method in class com.sitemesh.taglib.decorator.PropertyTag
Value to write if no property matching key is found (optional).
setDefault(String) - Method in class com.sitemesh.taglib.decorator.TitleTag
Value to write if no title is found (optional).
setFilterConfig(FilterConfig) - Method in class com.sitemesh.filter.PageFilter
Set FilterConfig, and get instance of DecoratorMapper .
setId(String) - Method in class com.sitemesh.taglib.decorator.UsePageTag
Set name of variable the Page will be set as.
setPage(String) - Method in class com.sitemesh.taglib.page.PanelTag
Tag attribute: URI of page to include.
setPageContext(PageContext) - Method in class com.sitemesh.taglib.AbstractTag
 
setParent(Tag) - Method in class com.sitemesh.taglib.AbstractTag
 
setProperty(String) - Method in class com.sitemesh.taglib.decorator.PropertyTag
Key of property to write.
setRequest(HttpServletRequest) - Method in interface com.sitemesh.Page
Create snapshot of Request.
setRequest(HttpServletRequest) - Method in class com.sitemesh.parser.AbstractPage
Create snapshot of Request.
shouldCache() - Method in interface com.sitemesh.Page
Determine whether this Page can be cached or not.
shouldCache() - Method in class com.sitemesh.parser.AbstractPage
Returns false.

T

TitleTag - class com.sitemesh.taglib.decorator.TitleTag.
Write the HTMLPage <title> value to out.
TitleTag() - Constructor for class com.sitemesh.taglib.decorator.TitleTag
 
trace(Exception) - Method in class com.sitemesh.taglib.AbstractTag
Log exception generated by taglib.

U

UnParsedPage - class com.sitemesh.parser.UnParsedPage.
A page that is of unrecognised content-type, or cannot be parsed into a specific type of Page.
UnParsedPage(byte[]) - Constructor for class com.sitemesh.parser.UnParsedPage
Simple constructor.
UseHTMLPageTEI - class com.sitemesh.taglib.decorator.UseHTMLPageTEI.
TagExtraInfo implementation to expose HTMLPage object as variable.
UseHTMLPageTEI() - Constructor for class com.sitemesh.taglib.decorator.UseHTMLPageTEI
 
UsePageTag - class com.sitemesh.taglib.decorator.UsePageTag.
Expose the Page as a bean to the page which can then be accessed from scriptlets.
UsePageTag() - Constructor for class com.sitemesh.taglib.decorator.UsePageTag
 
UsePageTEI - class com.sitemesh.taglib.decorator.UsePageTEI.
TagExtraInfo implementation to expose Page object as variable.
UsePageTEI() - Constructor for class com.sitemesh.taglib.decorator.UsePageTEI
 

W

write(byte[], int, int) - Method in class com.sitemesh.filter.PageOutputStream
 
write(int) - Method in class com.sitemesh.filter.PageOutputStream
 
writeBody(OutputStream) - Method in interface com.sitemesh.HTMLPage
Write the contents of the <body> tag.
writeBody(OutputStream) - Method in class com.sitemesh.parser.AbstractHTMLPage
Calls AbstractHTMLPage.writeBody(java.io.Writer)
writeBody(Writer) - Method in interface com.sitemesh.HTMLPage
Write the contents of the <body> tag.
writeBody(Writer) - Method in class com.sitemesh.parser.AbstractHTMLPage
Write data of html <body> tag.
writeBody(Writer) - Method in class com.sitemesh.parser.DOMPage
Serialize BODY contents to stream.
writeHead(OutputStream) - Method in interface com.sitemesh.HTMLPage
Write the contents of the <head> tag.
writeHead(OutputStream) - Method in class com.sitemesh.parser.AbstractHTMLPage
Calls AbstractHTMLPage.writeHead(java.io.Writer)
writeHead(Writer) - Method in interface com.sitemesh.HTMLPage
Write the contents of the <head> tag.
writeHead(Writer) - Method in class com.sitemesh.parser.AbstractHTMLPage
Write data of html <head> tag.
writeHead(Writer) - Method in class com.sitemesh.parser.DOMPage
Serialize HEAD contents to stream.
writePage(OutputStream) - Method in interface com.sitemesh.Page
Write the entire contents of the Page, in the format before it was parsed, to the OutputStream.
writePage(OutputStream) - Method in class com.sitemesh.parser.AbstractPage
 
writePage(Writer) - Method in interface com.sitemesh.Page
Write the entire contents of the Page, in the format before it was parsed, to the Writer.
writePage(Writer) - Method in class com.sitemesh.parser.AbstractPage
 

A B C D F G H I N P R S T U W