All Classes and Interfaces
Class
Description
Abstract DecoratorMapper implementation for easy creation of new DecoratorMappers.
Abstract implementation of
HTMLPage.Abstract implementation of
Page .Convenience implementation of Tag containing generice methods required by all (or most) taglibs.
The AgentDecoratorMapper can determine the user-agent (i.e.
This tag inserts an external resource as a panel into the current Page.
Base Factory implementation.
Convenient base class for all Java web-app based decorators that make use of the Servlet API.
The Class BasicRule.
The Class BlockExtractingRule.
Write original Page body to out.
The Class BodyTagRule.
When SiteMesh is activated for a request, the contents of the response are stored in this buffer, where they can
later be accessed as a parsed Page object.
A leaner, meaner version of StringBuilder.
This class implements a character buffer that can be used as a character-input stream.
Unsynced version of the JDK's CharArrayWriter.
This class is extremely useful for loading resources and classes in a fault tolerant manner that works across
different applications servers.
Common interface to ServletConfig and FilterConfig (since javax.servlet.Config was removed from 2.3 spec).
Default implementation of DecoratorMapper.
The ConfigLoader reads a configuration XML file that contains Decorator definitions (name, url, init-params) and
path-mappings (pattern, name).
Utility for determining the Servlet Container the application is running in.
Provides details of which tweaks should be used in SiteMesh - necessary because containers behave subtly different.
The Interface Content.
The Class ContentBlockExtractingRule.
The Class ContentBufferingResponse.
The Interface ContentProcessor.
The CookieDecoratorMapper will map a suitable decorator based on a cookie value.
A CustomTag provides a mechanism to manipulate the contents of a Tag.
The Class DebugResponseWrapper.
Representation of a Decorator.
The Interface Decorator.
Adapts a SiteMesh 2
DecoratorMapper to a SiteMesh 2 DecoratorSelector.Selects an appropriate Decorator for the Content.
Default implementation of Decorator.
DefaultFactory, reads configuration from the
sitemesh.configfile init param, or
/WEB-INF/sitemesh.xml if not specified, or uses the default configuration if sitemesh.xml
does not exist.The default implementation of sitemesh buffer.
The Class Builder.
Decorator that dispatches to another path in the Servlet Container (such as a JSP or path mapped to a Servlet).
The Class DivExtractingPageParser.
Write a HTMLPage div to out.
The EnvEntryDecoratorMapper allows the reference to a web-app environment entry for the decorator name, and falls
back to ConfigDecoratorMapper's behavior if no matching environment entry is found.
Decorator that dispatches to another path in A DIFFERENT WEB-APP in the same Servlet Container (such as a JSP or path
mapped to a Servlet).
The Class ExtractPropertyTag.
Factory responsible for creating appropriate instances of implementations.
This RuntimeException is thrown by the Factory if it cannot initialize or perform an appropriate function.
A speedy implementation of ByteArrayOutputStream.
HTMLPage implementation produced by FastPageParser.
Deprecated.
Use HTMLPageParser instead - it performs better and is more extensible.
The FileDecoratorMapper will treat the name of the decorator as a file-name to use (in the context of the web-app).
The FrameSetDecoratorMapper will use the specified decorator when the Page is an instance of
HTMLPage and isFrameSet() returns true.The Class FramesetRule.
Servlet that allows Freemarker templates to be used as decorators.
The Class HeadExtractingRule.
Write original HTMLPage head to out.
The Class HtmlAttributesRule.
Extension of
Page providing access to HTML data.
Builds an HTMLPage object from an HTML document.
The Class HTMLProcessor.
The Interface HTMLProcessorContext.
Extracts the type and encoding from an HTTP Content-Type header.
The InlineDecoratorMapper is used to determine the correct Decorator when using inline decorators.
The LanguageDecoratorMapper can determine the preferred language set in the browser requesting a page, and map to a
suitable Decorator (using the "Accept-Language" HTTP header).
The Class MetaTagRule.
Extracts the extra properties saved in HTML from MS Office applications (Word and Excel), such as Author, Company,
Version, etc.
The Class MultipassFilter.
The Class MultipassReplacementPageParser.
If no decorator is to be applied to a page, this will ensure the original content gets written out.
The NullDecoratorMapper represents the top-level DecoratorMapper that is finally delegated to if no other
DecoratorMapper has intervened.
The OSDecoratorMapper will map a suitable decorator based on the operating system of the remote client.
A converter from one character type to another
The Page object wraps the contents of the original (undecorated) page.
Allows a TagRule to add information to a Page object.
The PageDecoratorMapper allows the actual Page to determine the Decorator to be used.
Deprecated.
Use
SiteMeshFilter instead.The PageParser is responsible for parsing the page data into an appropriate
Page object.Adapts a SiteMesh 2
PageParser to a SiteMesh 3 ContentProcessor.The Interface PageParserSelector.
Will wrap a request for the
RequestDispatcherWrapper.Implementation of HttpServletResponseWrapper that captures page data instead of sending to the writer.
The ParameterDecoratorMapper will map a suitable decorator based on request parameters.
The Class ParameterExtractingRule.
Add a parameter to the inline Decorator, as if specified in the Page.
Looks for patterns of tokens in the Lexer and translates these to calls to pass to the TokenHandler.
Page parser that doesn't parse the full page, but rather just parses the head section of the page.
The Class ContentTagSimpleMap.
The Class HashSimpleMap.
The Class MetaTagSimpleMap.
The Interface SimpleMap.
The Class PartialPageParserHtmlPage.
The Class PartialPageParserPage.
The PathMapper is used to map file patterns to keys, and find an approriate key for a given file path.
The PrintableDecoratorMapper is a sample DecoratorMapper that will check to see whether 'printable=true' is supplied
as a request parameter and if so, use the specified decorator instead.
Because Tapestry templating works differently than JSP taglibs, the writeEntireProperty feature is not implemented
here.
Write property of Page to out.
TextFilter that substitutes content using a JDK 1.4 regular expression.
A set of static constants of Strings to be used as ServletRequest attribute keys to represent various objects passed
between pages.
Special request dispatcher that will include when an inline decorator includes a resource that uses an internal
forward.
The RobotDecoratorMapper will use the specified decorator when the requester is identified as a robot (also known as
spider, crawler, ferret) of a search engine.
Provides a PrintWriter that routes through to another PrintWriter, however the destination can be changed at any
point.
Factory to lazily instantiate the destination.
Provides a ServletOutputStream that routes through to another ServletOutputStream, however the destination can be
changed at any point.
Factory to lazily instantiate the destination.
Will look at a session attribute to find the name of an appropriate decorator to use.
Base class for Tapestry decorator components.
A potentially chained sitemesh buffer.
A fragment of a sitemesh buffer.
A builder for fragments.
A char array writer that caches other sitemesh buffers written to it, so that it doesn't have to continually copy
them from buffer to buffer.
The Interface SiteMeshContext.
Core Filter for integrating SiteMesh into a Java web application.
A sitemesh print writer.
The Class SiteMeshWebAppContext.
A sitemesh buffer writer.
The Class State.
The listener interface for receiving stateChange events.
The Class StateTransitionRule.
SitemeshBuffer that is a string.
Deprecated.
Renamed to PartialPageParser
Tag returned by HTMLTagTokenizer.
Very simple rule for replacing all occurences of one tag with another.
The Interface TagRule.
Splits a chunk of HTML into 'text' and 'tag' tokens, for easy processing.
Text returned by HTMLTagTokenizer.
Converts text stored in byte[] to char[] using specified encoding.
TextFilters can be added to the HTMLProcessor (or specific States) and allow a simple means of filtering text
content.
The Class Title.
The Class TitleExtractingRule.
Write the Page
<title> value to out.Handler passed to
TagTokenizer that will receive callbacks as 'tags' and 'text' are encountered.HTMLPage implementation that builds itself based on the incoming 'tag' and 'text' tokens fed to it from the
HTMLTagTokenizer.
TagExtraInfo implementation to expose HTMLPage object as variable.
Expose the Page as a bean to the page which can then be accessed from scriptlets.
TagExtraInfo implementation to expose Page object as variable.
This utility class gives easy access to the SiteMesh page, with convenience methods for title and property.
Servlet that allows Velocity templates to be used as decorators.