Index

A B C D E F G H I J L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractDecoratorMapper - Class in com.opensymphony.module.sitemesh.mapper

Abstract DecoratorMapper implementation for easy creation of new DecoratorMappers.

AbstractDecoratorMapper() - Constructor for class com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper

AbstractHTMLPage - Class in com.opensymphony.module.sitemesh.parser

Abstract implementation of HTMLPage.

AbstractHTMLPage(SitemeshBuffer) - Constructor for class com.opensymphony.module.sitemesh.parser.AbstractHTMLPage

Instantiates a new abstract HTML page.

AbstractPage - Class in com.opensymphony.module.sitemesh.parser

Abstract implementation of Page .

AbstractPage(SitemeshBuffer) - Constructor for class com.opensymphony.module.sitemesh.parser.AbstractPage

Instantiates a new abstract page.

AbstractTag - Class in com.opensymphony.module.sitemesh.taglib

Convenience implementation of Tag containing generice methods required by all (or most) taglibs.

AbstractTag() - Constructor for class com.opensymphony.module.sitemesh.taglib.AbstractTag

activateDestination() - Method in interface com.opensymphony.module.sitemesh.filter.RoutablePrintWriter.DestinationFactory

Activate destination.

activateSiteMesh(String, String) - Method in class com.opensymphony.module.sitemesh.filter.PageResponseWrapper

Activate site mesh.

addAttribute(String, String) - Method in class com.opensymphony.module.sitemesh.html.CustomTag

Add a new attribute.

addCookie(Cookie) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

addDateHeader(String, long) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

addExcludeUrl(String) - Method in class com.opensymphony.module.sitemesh.factory.BaseFactory

Adds the exclude url.

addHeader(String, String) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

addHeader(String, String) - Method in class com.opensymphony.module.sitemesh.filter.PageResponseWrapper

Prevent content-length being set if page is parseable.

addIntHeader(String, int) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

addListener(StateChangeListener) - Method in class com.opensymphony.module.sitemesh.html.State

Adds the listener.

addProperty(String, String) - Method in interface com.opensymphony.module.sitemesh.html.rules.PageBuilder

Adds the property.

addProperty(String, String) - Method in interface com.opensymphony.module.sitemesh.Page

Manually add a property to page.

addProperty(String, String) - Method in class com.opensymphony.module.sitemesh.parser.AbstractPage

Add a property to the properties list.

addProperty(String, String) - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

addProperty(String, String) - Method in class com.opensymphony.sitemesh.compatability.HTMLPage2Content

addProperty(String, String) - Method in interface com.opensymphony.sitemesh.Content

Manually add a property to page.

addRule(TagRule) - Method in class com.opensymphony.module.sitemesh.html.HTMLProcessor

Equivalent of htmlProcessor.defaultState().addRule()

addRule(TagRule) - Method in class com.opensymphony.module.sitemesh.html.State

Adds the rule.

addTextFilter(TextFilter) - Method in class com.opensymphony.module.sitemesh.html.HTMLProcessor

Adds the text filter.

addTextFilter(TextFilter) - Method in class com.opensymphony.module.sitemesh.html.State

Adds the text filter.

addUserDefinedRules(State, PageBuilder) - Method in class com.opensymphony.module.sitemesh.multipass.DivExtractingPageParser

addUserDefinedRules(State, PageBuilder) - Method in class com.opensymphony.module.sitemesh.parser.HTMLPageParser

Adds the user defined rules.

AgentDecoratorMapper - Class in com.opensymphony.module.sitemesh.mapper

The AgentDecoratorMapper can determine the user-agent (i.e.

AgentDecoratorMapper() - Constructor for class com.opensymphony.module.sitemesh.mapper.AgentDecoratorMapper

append(char) - Method in class com.opensymphony.module.sitemesh.html.util.CharArray

Appends a single character to the end of the character array.

append(char[]) - Method in class com.opensymphony.module.sitemesh.html.util.CharArray

Appends the supplied characters to the end of the array.

append(char[], int, int) - Method in class com.opensymphony.module.sitemesh.html.util.CharArray

Append.

append(CharArray) - Method in class com.opensymphony.module.sitemesh.html.util.CharArray

Appends an existing CharArray on to this one.

append(String) - Method in class com.opensymphony.module.sitemesh.html.util.CharArray

Appends the supplied string to the end of this character array.

ApplyDecoratorTag - Class in com.opensymphony.module.sitemesh.taglib.page

This tag inserts an external resource as a panel into the current Page.

ApplyDecoratorTag() - Constructor for class com.opensymphony.module.sitemesh.taglib.page.ApplyDecoratorTag

attributeCount - Variable in class com.opensymphony.module.sitemesh.html.tokenizer.Parser.ReusableToken

The attribute count.

attributes - Variable in class com.opensymphony.module.sitemesh.html.tokenizer.Parser.ReusableToken

The attributes.

B

BaseFactory - Class in com.opensymphony.module.sitemesh.factory

Base Factory implementation.

BaseFactory(Config) - Constructor for class com.opensymphony.module.sitemesh.factory.BaseFactory

Constructor for default implementation of Factory.

BaseWebAppDecorator - Class in com.opensymphony.sitemesh.webapp.decorator

Convenient base class for all Java web-app based decorators that make use of the Servlet API.

BaseWebAppDecorator() - Constructor for class com.opensymphony.sitemesh.webapp.decorator.BaseWebAppDecorator

BasicRule - Class in com.opensymphony.module.sitemesh.html

The Class BasicRule.

BasicRule() - Constructor for class com.opensymphony.module.sitemesh.html.BasicRule

Instantiates a new basic rule.

BasicRule(String) - Constructor for class com.opensymphony.module.sitemesh.html.BasicRule

Instantiates a new basic rule.

BasicRule(String[]) - Constructor for class com.opensymphony.module.sitemesh.html.BasicRule

Instantiates a new basic rule.

BlockExtractingRule - Class in com.opensymphony.module.sitemesh.html

The Class BlockExtractingRule.

BlockExtractingRule(boolean) - Constructor for class com.opensymphony.module.sitemesh.html.BlockExtractingRule

Instantiates a new block extracting rule.

BlockExtractingRule(boolean, String) - Constructor for class com.opensymphony.module.sitemesh.html.BlockExtractingRule

Instantiates a new block extracting rule.

BodyTag - Class in com.opensymphony.module.sitemesh.taglib.decorator

Write original Page body to out.

BodyTag() - Constructor for class com.opensymphony.module.sitemesh.taglib.decorator.BodyTag

BodyTagRule - Class in com.opensymphony.module.sitemesh.html.rules

The Class BodyTagRule.

BodyTagRule(PageBuilder, SitemeshBufferFragment.Builder) - Constructor for class com.opensymphony.module.sitemesh.html.rules.BodyTagRule

Instantiates a new body tag rule.

buf - Variable in class com.opensymphony.module.sitemesh.util.CharArrayReader

The character buffer.

buf - Variable in class com.opensymphony.module.sitemesh.util.CharArrayWriter

The buffer where data is stored.

Buffer - Class in com.opensymphony.module.sitemesh.filter

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.

Buffer(PageParser, String) - Constructor for class com.opensymphony.module.sitemesh.filter.Buffer

Instantiates a new buffer.

build() - Method in class com.opensymphony.module.sitemesh.DefaultSitemeshBuffer.Builder

Builds the.

build() - Method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment.Builder

Build the fragment.

build(SitemeshBuffer, SiteMeshContext) - Method in class com.opensymphony.sitemesh.compatability.PageParser2ContentProcessor

Builds the.

build(SitemeshBuffer, SiteMeshContext) - Method in interface com.opensymphony.sitemesh.ContentProcessor

Builds the.

builder() - Static method in class com.opensymphony.module.sitemesh.DefaultSitemeshBuffer

Builder.

builder() - Static method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment

Builder.

builder(SitemeshBuffer) - Static method in class com.opensymphony.module.sitemesh.DefaultSitemeshBuffer

Builder.

builder(SitemeshBufferFragment) - Static method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment

Builder.

C

changeState(State) - Method in interface com.opensymphony.module.sitemesh.html.HTMLProcessorContext

Change state.

CharArray - Class in com.opensymphony.module.sitemesh.html.util

A leaner, meaner version of StringBuilder.

CharArray(int) - Constructor for class com.opensymphony.module.sitemesh.html.util.CharArray

Constructs a CharArray that is initialized to the specified size.

CharArrayReader - Class in com.opensymphony.module.sitemesh.util

This class implements a character buffer that can be used as a character-input stream.

CharArrayReader(char[]) - Constructor for class com.opensymphony.module.sitemesh.util.CharArrayReader

Create an CharArrayReader from the specified array of chars.

CharArrayReader(char[], int, int) - Constructor for class com.opensymphony.module.sitemesh.util.CharArrayReader

Create an CharArrayReader from the specified array of chars.

CharArrayWriter - Class in com.opensymphony.module.sitemesh.util

Unsynced version of the JDK's CharArrayWriter.

CharArrayWriter() - Constructor for class com.opensymphony.module.sitemesh.util.CharArrayWriter

Creates a new CharArrayWriter.

CharArrayWriter(int) - Constructor for class com.opensymphony.module.sitemesh.util.CharArrayWriter

Creates a new CharArrayWriter with the specified initial size.

charAt(int) - Method in class com.opensymphony.module.sitemesh.html.util.CharArray

Returns the character that is at the specified position in the array.

checkError() - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

ClassLoaderUtil - Class in com.opensymphony.module.sitemesh.util

This class is extremely useful for loading resources and classes in a fault tolerant manner that works across different applications servers.

ClassLoaderUtil() - Constructor for class com.opensymphony.module.sitemesh.util.ClassLoaderUtil

clear() - Method in class com.opensymphony.module.sitemesh.html.util.CharArray

Clear the contents.

clearDecoratorMappers() - Method in class com.opensymphony.module.sitemesh.factory.BaseFactory

Clear all current DecoratorMappers.

clearExcludeUrls() - Method in class com.opensymphony.module.sitemesh.factory.BaseFactory

Clears all exclude URLs.

clearParserMappings() - Method in class com.opensymphony.module.sitemesh.factory.BaseFactory

Clear all PageParser mappings.

close() - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

close() - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

close() - Method in class com.opensymphony.module.sitemesh.util.CharArrayReader

Close the stream.

close() - Method in class com.opensymphony.module.sitemesh.util.CharArrayWriter

Close the stream.

close() - Method in class com.opensymphony.module.sitemesh.util.FastByteArrayOutputStream

CLOSE - Static variable in interface com.opensymphony.module.sitemesh.html.Tag

The close.

CLOSE_MAGIC_COMMENT - Static variable in interface com.opensymphony.module.sitemesh.html.Tag

The close magic comment.

column() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

com.opensymphony.module.sitemesh - package com.opensymphony.module.sitemesh

Sitemesh Package.

com.opensymphony.module.sitemesh.chaining - package com.opensymphony.module.sitemesh.chaining

Factory Package.

com.opensymphony.module.sitemesh.factory - package com.opensymphony.module.sitemesh.factory

Factory Package.

com.opensymphony.module.sitemesh.filter - package com.opensymphony.module.sitemesh.filter

Filter Package.

com.opensymphony.module.sitemesh.freemarker - package com.opensymphony.module.sitemesh.freemarker

Freemarker Package.

com.opensymphony.module.sitemesh.html - package com.opensymphony.module.sitemesh.html

HTML Package.

com.opensymphony.module.sitemesh.html.rules - package com.opensymphony.module.sitemesh.html.rules

HTML Rules Package.

com.opensymphony.module.sitemesh.html.tokenizer - package com.opensymphony.module.sitemesh.html.tokenizer

HTML Tokenizer Package.

com.opensymphony.module.sitemesh.html.util - package com.opensymphony.module.sitemesh.html.util

HTML Util Package.

com.opensymphony.module.sitemesh.mapper - package com.opensymphony.module.sitemesh.mapper

Mapper Package.

com.opensymphony.module.sitemesh.multipass - package com.opensymphony.module.sitemesh.multipass

Mutlipass Package.

com.opensymphony.module.sitemesh.parser - package com.opensymphony.module.sitemesh.parser

Parser Package.

com.opensymphony.module.sitemesh.taglib - package com.opensymphony.module.sitemesh.taglib

Taglib Package.

com.opensymphony.module.sitemesh.taglib.decorator - package com.opensymphony.module.sitemesh.taglib.decorator

Taglib Decorator Package.

com.opensymphony.module.sitemesh.taglib.page - package com.opensymphony.module.sitemesh.taglib.page

Taglib Page Package.

com.opensymphony.module.sitemesh.tapestry - package com.opensymphony.module.sitemesh.tapestry

Tapestry Package.

com.opensymphony.module.sitemesh.util - package com.opensymphony.module.sitemesh.util

Util Package.

com.opensymphony.module.sitemesh.velocity - package com.opensymphony.module.sitemesh.velocity

Velocity Package.

com.opensymphony.sitemesh - package com.opensymphony.sitemesh

The sitemesh package.

com.opensymphony.sitemesh.compatability - package com.opensymphony.sitemesh.compatability

Compatability classes to enable easy migration of SiteMesh 1 and 2 applications to SiteMesh 3.

com.opensymphony.sitemesh.webapp - package com.opensymphony.sitemesh.webapp

Provides integration of SiteMesh with Java web-applications.

com.opensymphony.sitemesh.webapp.decorator - package com.opensymphony.sitemesh.webapp.decorator

The Decorator Package.

compareLower(String, int) - Method in class com.opensymphony.module.sitemesh.html.util.CharArray

Compares the supplied uppercase string with the contents of the character array, starting at the offset specified.

compareLowerSubstr(String) - Method in class com.opensymphony.module.sitemesh.html.util.CharArray

This compares a substring of this character array (as specified by the CharArray.setSubstr(int, int) method call) with the supplied string.

config - Variable in class com.opensymphony.module.sitemesh.factory.BaseFactory

The config is of type ServletConfig or FilterConfig.

config - Variable in class com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper

The config.

Config - Class in com.opensymphony.module.sitemesh

Common interface to ServletConfig and FilterConfig (since javax.servlet.Config was removed from 2.3 spec).

Config(FilterConfig) - Constructor for class com.opensymphony.module.sitemesh.Config

Instantiates a new config.

Config(ServletConfig) - Constructor for class com.opensymphony.module.sitemesh.Config

Instantiates a new config.

configCheckMillis - Static variable in class com.opensymphony.module.sitemesh.factory.DefaultFactory

The config check millis.

ConfigDecoratorMapper - Class in com.opensymphony.module.sitemesh.mapper

Default implementation of DecoratorMapper.

ConfigDecoratorMapper() - Constructor for class com.opensymphony.module.sitemesh.mapper.ConfigDecoratorMapper

ConfigLoader - Class in com.opensymphony.module.sitemesh.mapper

The ConfigLoader reads a configuration XML file that contains Decorator definitions (name, url, init-params) and path-mappings (pattern, name).

ConfigLoader(File) - Constructor for class com.opensymphony.module.sitemesh.mapper.ConfigLoader

Create new ConfigLoader using supplied File.

ConfigLoader(String, Config) - Constructor for class com.opensymphony.module.sitemesh.mapper.ConfigLoader

Create new ConfigLoader using supplied filename and config.

Container - Class in com.opensymphony.module.sitemesh.util

Utility for determining the Servlet Container the application is running in.

Container() - Constructor for class com.opensymphony.module.sitemesh.util.Container

ContainerTweaks - Class in com.opensymphony.sitemesh.webapp

Provides details of which tweaks should be used in SiteMesh - necessary because containers behave subtly different.

ContainerTweaks() - Constructor for class com.opensymphony.sitemesh.webapp.ContainerTweaks

containsHeader(String) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

Content - Interface in com.opensymphony.sitemesh

The Interface Content.

CONTENT_KEY - Static variable in class com.opensymphony.sitemesh.webapp.decorator.DispatchedDecorator

The Constant CONTENT_KEY.

Content2HTMLPage - Class in com.opensymphony.sitemesh.compatability

Adapts a SiteMesh 3 Content to a SiteMesh 2 HTMLPage.

Content2HTMLPage(Content, HttpServletRequest) - Constructor for class com.opensymphony.sitemesh.compatability.Content2HTMLPage

Instantiates a new content 2 HTML page.

ContentBlockExtractingRule - Class in com.opensymphony.module.sitemesh.html.rules

The Class ContentBlockExtractingRule.

ContentBlockExtractingRule(PageBuilder) - Constructor for class com.opensymphony.module.sitemesh.html.rules.ContentBlockExtractingRule

Instantiates a new content block extracting rule.

ContentBufferingResponse - Class in com.opensymphony.sitemesh.webapp

The Class ContentBufferingResponse.

ContentBufferingResponse(HttpServletResponse, ContentProcessor, SiteMeshWebAppContext) - Constructor for class com.opensymphony.sitemesh.webapp.ContentBufferingResponse

Instantiates a new content buffering response.

ContentProcessor - Interface in com.opensymphony.sitemesh

The Interface ContentProcessor.

ContentTagSimpleMap() - Constructor for class com.opensymphony.module.sitemesh.parser.PartialPageParser.ContentTagSimpleMap

context - Variable in class com.opensymphony.module.sitemesh.html.BasicRule

The context.

CONTEXT_KEY - Static variable in class com.opensymphony.sitemesh.webapp.decorator.DispatchedDecorator

The Constant CONTEXT_KEY.

convert(String) - Static method in class com.opensymphony.module.sitemesh.util.OutputConverter

Convert.

CookieDecoratorMapper - Class in com.opensymphony.module.sitemesh.mapper

The CookieDecoratorMapper will map a suitable decorator based on a cookie value.

CookieDecoratorMapper() - Constructor for class com.opensymphony.module.sitemesh.mapper.CookieDecoratorMapper

count - Variable in class com.opensymphony.module.sitemesh.util.CharArrayReader

The index of the end of this buffer.

count - Variable in class com.opensymphony.module.sitemesh.util.CharArrayWriter

The number of chars in the buffer.

create() - Method in interface com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream.DestinationFactory

Creates the.

createBuffer(SitemeshBuffer) - Method in class com.opensymphony.module.sitemesh.html.BlockExtractingRule

Creates the buffer.

createBuffer(SitemeshBuffer) - Method in class com.opensymphony.module.sitemesh.html.rules.HeadExtractingRule

createBufferFragment(String) - Static method in class com.opensymphony.module.sitemesh.html.util.StringSitemeshBuffer

Creates the buffer fragment.

currentBuffer() - Method in class com.opensymphony.module.sitemesh.html.BasicRule

Current buffer.

currentBuffer() - Method in interface com.opensymphony.module.sitemesh.html.HTMLProcessorContext

Current buffer.

currentState() - Method in interface com.opensymphony.module.sitemesh.html.HTMLProcessorContext

Current state.

CustomTag - Class in com.opensymphony.module.sitemesh.html

A CustomTag provides a mechanism to manipulate the contents of a Tag.

CustomTag(Tag) - Constructor for class com.opensymphony.module.sitemesh.html.CustomTag

Create a CustomTag based on an existing Tag - this takes a copy of the Tag.

CustomTag(String, int) - Constructor for class com.opensymphony.module.sitemesh.html.CustomTag

Type of tag:
<blah> - Tag.OPEN
</blah> - Tag.CLOSE
<blah/> - Tag.EMPTY

D

DebugResponseWrapper - Class in com.opensymphony.module.sitemesh.filter

The Class DebugResponseWrapper.

DebugResponseWrapper(HttpServletResponse) - Constructor for class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

Instantiates a new debug response wrapper.

Decorator - Interface in com.opensymphony.module.sitemesh

Representation of a Decorator.

Decorator - Interface in com.opensymphony.sitemesh

The Interface Decorator.

DECORATOR - Static variable in interface com.opensymphony.module.sitemesh.RequestConstants

The name (String) of the Decorator to suggest using.

decoratorMapper - Variable in class com.opensymphony.module.sitemesh.factory.BaseFactory

Instance of DecoratorMapper.

DecoratorMapper - Interface in com.opensymphony.module.sitemesh

The DecoratorMapper is responsible for determining which Decorator should be used for a Page.

DecoratorMapper2DecoratorSelector - Class in com.opensymphony.sitemesh.compatability

Adapts a SiteMesh 2 DecoratorMapper to a SiteMesh 2 DecoratorSelector.

DecoratorMapper2DecoratorSelector(DecoratorMapper) - Constructor for class com.opensymphony.sitemesh.compatability.DecoratorMapper2DecoratorSelector

Instantiates a new decorator mapper 2 decorator selector.

DecoratorSelector - Interface in com.opensymphony.sitemesh

Selects an appropriate Decorator for the Content.

DefaultDecorator - Class in com.opensymphony.module.sitemesh.mapper

Default implementation of Decorator.

DefaultDecorator(String, String, String, String, Map<Object, Object>) - Constructor for class com.opensymphony.module.sitemesh.mapper.DefaultDecorator

Constructor to set all properties.

DefaultDecorator(String, String, String, Map<Object, Object>) - Constructor for class com.opensymphony.module.sitemesh.mapper.DefaultDecorator

Constructor to set all properties.

DefaultDecorator(String, String, Map<Object, Object>) - Constructor for class com.opensymphony.module.sitemesh.mapper.DefaultDecorator

Constructor to set name, page and parameters.

DefaultFactory - Class in com.opensymphony.module.sitemesh.factory

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.

DefaultFactory(Config) - Constructor for class com.opensymphony.module.sitemesh.factory.DefaultFactory

Instantiates a new default factory.

DefaultSitemeshBuffer - Class in com.opensymphony.module.sitemesh

The default implementation of sitemesh buffer.

DefaultSitemeshBuffer(char[]) - Constructor for class com.opensymphony.module.sitemesh.DefaultSitemeshBuffer

Instantiates a new default sitemesh buffer.

DefaultSitemeshBuffer(char[], int) - Constructor for class com.opensymphony.module.sitemesh.DefaultSitemeshBuffer

Instantiates a new default sitemesh buffer.

DefaultSitemeshBuffer(char[], int, TreeMap<Integer, SitemeshBufferFragment>) - Constructor for class com.opensymphony.module.sitemesh.DefaultSitemeshBuffer

Instantiates a new default sitemesh buffer.

DefaultSitemeshBuffer.Builder - Class in com.opensymphony.module.sitemesh

The Class Builder.

defaultState() - Method in class com.opensymphony.module.sitemesh.html.HTMLProcessor

Default state.

delete(int, int) - Method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment.Builder

Delete length characters from pos in this buffer fragment.

destroy() - Method in class com.opensymphony.sitemesh.webapp.SiteMeshFilter

DispatchedDecorator - Class in com.opensymphony.sitemesh.webapp.decorator

Decorator that dispatches to another path in the Servlet Container (such as a JSP or path mapped to a Servlet).

DispatchedDecorator(String) - Constructor for class com.opensymphony.sitemesh.webapp.decorator.DispatchedDecorator

Instantiates a new dispatched decorator.

DivExtractingPageParser - Class in com.opensymphony.module.sitemesh.multipass

The Class DivExtractingPageParser.

DivExtractingPageParser() - Constructor for class com.opensymphony.module.sitemesh.multipass.DivExtractingPageParser

divId - Variable in class com.opensymphony.module.sitemesh.taglib.decorator.DivTag

The div id.

DivTag - Class in com.opensymphony.module.sitemesh.taglib.decorator

Write a HTMLPage div to out.

DivTag() - Constructor for class com.opensymphony.module.sitemesh.taglib.decorator.DivTag

doAfterBody() - Method in class com.opensymphony.module.sitemesh.taglib.page.ApplyDecoratorTag

Ensure that external page contents are included in bodycontent.

doAfterBody() - Method in class com.opensymphony.module.sitemesh.taglib.page.ParamTag

doEndTag() - Method in class com.opensymphony.module.sitemesh.multipass.ExtractPropertyTag

doEndTag() - Method in class com.opensymphony.module.sitemesh.taglib.AbstractTag

To be implemented by all empty tags.

doEndTag() - Method in class com.opensymphony.module.sitemesh.taglib.decorator.BodyTag

doEndTag() - Method in class com.opensymphony.module.sitemesh.taglib.decorator.DivTag

doEndTag() - Method in class com.opensymphony.module.sitemesh.taglib.decorator.HeadTag

doEndTag() - Method in class com.opensymphony.module.sitemesh.taglib.decorator.PropertyTag

doEndTag() - Method in class com.opensymphony.module.sitemesh.taglib.decorator.TitleTag

doEndTag() - Method in class com.opensymphony.module.sitemesh.taglib.decorator.UsePageTag

doEndTag() - Method in class com.opensymphony.module.sitemesh.taglib.page.ApplyDecoratorTag

Standard taglib method: apply decorator to page.

doFilter(ServletRequest, ServletResponse, FilterChain) - Method in class com.opensymphony.sitemesh.webapp.SiteMeshFilter

Main method of the Filter.

doStartTag() - Method in class com.opensymphony.module.sitemesh.taglib.AbstractTag

Returns SKIP_BODY.

doStartTag() - Method in class com.opensymphony.module.sitemesh.taglib.page.ApplyDecoratorTag

E

ELEMENT - Static variable in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

EMPTY - Static variable in interface com.opensymphony.module.sitemesh.html.Tag

The empty.

encode(byte[], String) - Method in class com.opensymphony.module.sitemesh.filter.TextEncoder

Encode.

encodeRedirectUrl(String) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

encodeRedirectURL(String) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

end(int) - Method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment.Builder

End the fragment.

end(Tag) - Method in class com.opensymphony.module.sitemesh.html.BlockExtractingRule

End.

end(Tag) - Method in class com.opensymphony.module.sitemesh.html.rules.ContentBlockExtractingRule

end(Tag) - Method in class com.opensymphony.module.sitemesh.html.rules.MSOfficeDocumentPropertiesRule

end(Tag) - Method in class com.opensymphony.module.sitemesh.html.rules.TitleExtractingRule

endDelete(int) - Method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment.Builder

End the current deletion.

endOfState() - Method in class com.opensymphony.module.sitemesh.html.State

End of state.

EnvEntryDecoratorMapper - Class in com.opensymphony.module.sitemesh.mapper

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.

EnvEntryDecoratorMapper() - Constructor for class com.opensymphony.module.sitemesh.mapper.EnvEntryDecoratorMapper

equals(Object) - Method in class com.opensymphony.module.sitemesh.html.CustomTag

EQUALS - Static variable in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

The Constant EQUALS.

Example - Search tag in class com.opensymphony.module.sitemesh.html.rules.RegexReplacementTextFilter

Section

Example - Search tag in class com.opensymphony.module.sitemesh.mapper.PathMapper

Section

Example - Search tag in interface com.opensymphony.module.sitemesh.HTMLPage

Section

exception - Variable in exception class com.opensymphony.module.sitemesh.factory.FactoryException

The exception.

excludeUrls - Variable in class com.opensymphony.module.sitemesh.factory.BaseFactory

A map of paths that are excluded from decoration.

ExternalDispatchedDecorator - Class in com.opensymphony.sitemesh.webapp.decorator

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).

ExternalDispatchedDecorator(String, String) - Constructor for class com.opensymphony.sitemesh.webapp.decorator.ExternalDispatchedDecorator

Instantiates a new external dispatched decorator.

ExtractPropertyTag - Class in com.opensymphony.module.sitemesh.multipass

The Class ExtractPropertyTag.

ExtractPropertyTag() - Constructor for class com.opensymphony.module.sitemesh.multipass.ExtractPropertyTag

F

Factory - Class in com.opensymphony.module.sitemesh

Factory responsible for creating appropriate instances of implementations.

Factory() - Constructor for class com.opensymphony.module.sitemesh.Factory

FactoryException - Exception Class in com.opensymphony.module.sitemesh.factory

This RuntimeException is thrown by the Factory if it cannot initialize or perform an appropriate function.

FactoryException() - Constructor for exception class com.opensymphony.module.sitemesh.factory.FactoryException

Instantiates a new factory exception.

FactoryException(Exception) - Constructor for exception class com.opensymphony.module.sitemesh.factory.FactoryException

Instantiates a new factory exception.

FactoryException(String) - Constructor for exception class com.opensymphony.module.sitemesh.factory.FactoryException

Instantiates a new factory exception.

FactoryException(String, Throwable) - Constructor for exception class com.opensymphony.module.sitemesh.factory.FactoryException

Instantiates a new factory exception.

FastByteArrayOutputStream - Class in com.opensymphony.module.sitemesh.util

A speedy implementation of ByteArrayOutputStream.

FastByteArrayOutputStream() - Constructor for class com.opensymphony.module.sitemesh.util.FastByteArrayOutputStream

Instantiates a new fast byte array output stream.

FastByteArrayOutputStream(int) - Constructor for class com.opensymphony.module.sitemesh.util.FastByteArrayOutputStream

Instantiates a new fast byte array output stream.

FastPage - Class in com.opensymphony.module.sitemesh.parser

HTMLPage implementation produced by FastPageParser.

FastPage(SitemeshBuffer, Map<String, String>, Map<String, String>, Map<String, String>, Map<String, String>, String, String, String, boolean) - Constructor for class com.opensymphony.module.sitemesh.parser.FastPage

Instantiates a new fast page.

FastPageParser - Class in com.opensymphony.module.sitemesh.parser

Deprecated.

Use HTMLPageParser instead - it performs better and is more extensible.

FastPageParser() - Constructor for class com.opensymphony.module.sitemesh.parser.FastPageParser

Deprecated.

FileDecoratorMapper - Class in com.opensymphony.module.sitemesh.mapper

The FileDecoratorMapper will treat the name of the decorator as a file-name to use (in the context of the web-app).

FileDecoratorMapper() - Constructor for class com.opensymphony.module.sitemesh.mapper.FileDecoratorMapper

filter(String) - Method in class com.opensymphony.module.sitemesh.html.rules.RegexReplacementTextFilter

filter(String) - Method in interface com.opensymphony.module.sitemesh.html.TextFilter

Filter.

flush() - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

flush() - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

flush() - Method in class com.opensymphony.module.sitemesh.util.CharArrayWriter

Flush the stream.

flush() - Method in class com.opensymphony.module.sitemesh.util.FastByteArrayOutputStream

flushBuffer() - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

flushBuffer() - Method in class com.opensymphony.module.sitemesh.filter.PageResponseWrapper

Prevent buffer from being flushed if this is a page being parsed.

forward(ServletRequest, ServletResponse) - Method in class com.opensymphony.module.sitemesh.filter.RequestDispatcherWrapper

FrameSetDecoratorMapper - Class in com.opensymphony.module.sitemesh.mapper

The FrameSetDecoratorMapper will use the specified decorator when the Page is an instance of HTMLPage and isFrameSet() returns true.

FrameSetDecoratorMapper() - Constructor for class com.opensymphony.module.sitemesh.mapper.FrameSetDecoratorMapper

FramesetRule - Class in com.opensymphony.module.sitemesh.html.rules

The Class FramesetRule.

FramesetRule(PageBuilder) - Constructor for class com.opensymphony.module.sitemesh.html.rules.FramesetRule

Instantiates a new frameset rule.

FreemarkerDecoratorServlet - Class in com.opensymphony.module.sitemesh.freemarker

Servlet that allows Freemarker templates to be used as decorators.

FreemarkerDecoratorServlet() - Constructor for class com.opensymphony.module.sitemesh.freemarker.FreemarkerDecoratorServlet

G

get() - Static method in class com.opensymphony.module.sitemesh.util.Container

Get the current container.

get(String) - Method in class com.opensymphony.module.sitemesh.mapper.PathMapper

Retrieve appropriate key by matching patterns with supplied path.

getAttributeCount() - Method in class com.opensymphony.module.sitemesh.html.CustomTag

getAttributeCount() - Method in interface com.opensymphony.module.sitemesh.html.Tag

Number of attributes in tag.

getAttributeCount() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser.ReusableToken

getAttributeIndex(String, boolean) - Method in class com.opensymphony.module.sitemesh.html.CustomTag

getAttributeIndex(String, boolean) - Method in interface com.opensymphony.module.sitemesh.html.Tag

Determine which attribute has the specified name.

getAttributeIndex(String, boolean) - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser.ReusableToken

getAttributeName(int) - Method in class com.opensymphony.module.sitemesh.html.CustomTag

getAttributeName(int) - Method in interface com.opensymphony.module.sitemesh.html.Tag

Get name of attribute.

getAttributeName(int) - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser.ReusableToken

getAttributeValue(int) - Method in class com.opensymphony.module.sitemesh.html.CustomTag

getAttributeValue(int) - Method in interface com.opensymphony.module.sitemesh.html.Tag

Get value of an attribute.

getAttributeValue(int) - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser.ReusableToken

getAttributeValue(String, boolean) - Method in class com.opensymphony.module.sitemesh.html.CustomTag

getAttributeValue(String, boolean) - Method in interface com.opensymphony.module.sitemesh.html.Tag

Get value of an attribute.

getAttributeValue(String, boolean) - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser.ReusableToken

getBody() - Method in interface com.opensymphony.module.sitemesh.Page

Convenience method to return the contents of the <body> tag.

getBody() - Method in class com.opensymphony.module.sitemesh.parser.AbstractPage

getBody() - Method in class com.opensymphony.module.sitemesh.parser.FastPage

getBody() - Method in class com.opensymphony.module.sitemesh.parser.TokenizedHTMLPage

getBody() - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

getBooleanProperty(String) - Method in interface com.opensymphony.module.sitemesh.Page

Get a property embedded into the Page as a boolean.

getBooleanProperty(String) - Method in class com.opensymphony.module.sitemesh.parser.AbstractPage

getBooleanProperty(String) - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

getBufferLength() - Method in class com.opensymphony.module.sitemesh.DefaultSitemeshBuffer

getBufferLength() - Method in class com.opensymphony.module.sitemesh.html.util.StringSitemeshBuffer

getBufferLength() - Method in interface com.opensymphony.module.sitemesh.SitemeshBuffer

Get the length of the buffered content.

getBufferSize() - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

getCharacterEncoding() - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

getCharArray() - Method in class com.opensymphony.module.sitemesh.DefaultSitemeshBuffer

getCharArray() - Method in class com.opensymphony.module.sitemesh.html.util.StringSitemeshBuffer

getCharArray() - Method in interface com.opensymphony.module.sitemesh.SitemeshBuffer

Get the char array for this buffer.

getConfigFile() - Method in class com.opensymphony.module.sitemesh.Config

Gets the config file.

getContent() - Method in class com.opensymphony.module.sitemesh.parser.PartialPageParser.MetaTagSimpleMap

Gets the content.

getContent() - Method in class com.opensymphony.sitemesh.webapp.ContentBufferingResponse

Gets the content.

getContents() - Method in class com.opensymphony.module.sitemesh.filter.Buffer

Gets the contents.

getContents() - Method in class com.opensymphony.module.sitemesh.filter.PageResponseWrapper

Gets the contents.

getContents() - Method in class com.opensymphony.module.sitemesh.html.CustomTag

getContents() - Method in interface com.opensymphony.module.sitemesh.html.Tag

Get the complete tag in its original form, preserving original formatting.

getContents() - Method in interface com.opensymphony.module.sitemesh.html.Text

Get the complete contents of the text block, preserving original formatting.

getContents() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser.ReusableToken

getContentType() - Method in interface com.opensymphony.sitemesh.SiteMeshContext

Gets the content type.

getContentType() - Method in class com.opensymphony.sitemesh.webapp.SiteMeshWebAppContext

getCurrentBufferContent() - Method in class com.opensymphony.module.sitemesh.html.BasicRule

Gets the current buffer content.

getDecorator(HttpServletRequest, Page) - Method in interface com.opensymphony.module.sitemesh.DecoratorMapper

Return appropriate Decorator for a certain Page.

getDecorator(HttpServletRequest, Page) - Method in class com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper

getDecorator(HttpServletRequest, Page) - Method in class com.opensymphony.module.sitemesh.mapper.AgentDecoratorMapper

getDecorator(HttpServletRequest, Page) - Method in class com.opensymphony.module.sitemesh.mapper.ConfigDecoratorMapper

Retrieve Decorator based on 'pattern' tag.

getDecorator(HttpServletRequest, Page) - Method in class com.opensymphony.module.sitemesh.mapper.CookieDecoratorMapper

getDecorator(HttpServletRequest, Page) - Method in class com.opensymphony.module.sitemesh.mapper.FrameSetDecoratorMapper

getDecorator(HttpServletRequest, Page) - Method in class com.opensymphony.module.sitemesh.mapper.InlineDecoratorMapper

getDecorator(HttpServletRequest, Page) - Method in class com.opensymphony.module.sitemesh.mapper.LanguageDecoratorMapper

getDecorator(HttpServletRequest, Page) - Method in class com.opensymphony.module.sitemesh.mapper.NullDecoratorMapper

Returns null.

getDecorator(HttpServletRequest, Page) - Method in class com.opensymphony.module.sitemesh.mapper.OSDecoratorMapper

Attempts to find the correct decorator for Page page based on the UA-OS HTTP header in the request.

getDecorator(HttpServletRequest, Page) - Method in class com.opensymphony.module.sitemesh.mapper.PageDecoratorMapper

getDecorator(HttpServletRequest, Page) - Method in class com.opensymphony.module.sitemesh.mapper.ParameterDecoratorMapper

getDecorator(HttpServletRequest, Page) - Method in class com.opensymphony.module.sitemesh.mapper.PrintableDecoratorMapper

getDecorator(HttpServletRequest, Page) - Method in class com.opensymphony.module.sitemesh.mapper.RobotDecoratorMapper

getDecorator(HttpServletRequest, Page) - Method in class com.opensymphony.module.sitemesh.mapper.SessionDecoratorMapper

getDecoratorByName(String) - Method in class com.opensymphony.module.sitemesh.mapper.ConfigLoader

Retrieve Decorator based on name specified in configuration file.

getDecoratorMapper() - Method in class com.opensymphony.module.sitemesh.factory.BaseFactory

Return instance of DecoratorMapper.

getDecoratorMapper() - Method in class com.opensymphony.module.sitemesh.Factory

Return instance of DecoratorMapper.

getDecoratorMapper(Class<?>) - Method in class com.opensymphony.module.sitemesh.factory.BaseFactory

Gets the decorator mapper.

getDefault() - Method in class com.opensymphony.module.sitemesh.tapestry.Property

Gets the default.

getDefault() - Method in class com.opensymphony.module.sitemesh.tapestry.Title

Gets the default.

getEncoding() - Method in class com.opensymphony.module.sitemesh.filter.HttpContentType

Gets the encoding.

getHead() - Method in interface com.opensymphony.module.sitemesh.HTMLPage

Convenience method to return the contents of the <head> tag as a String.

getHead() - Method in class com.opensymphony.module.sitemesh.parser.FastPage

getHead() - Method in class com.opensymphony.module.sitemesh.parser.PartialPageParserHtmlPage

getHead() - Method in class com.opensymphony.module.sitemesh.parser.TokenizedHTMLPage

getHead() - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

getHeader(String) - Method in class com.opensymphony.module.sitemesh.filter.PageRequestWrapper

getHeadRenderer(IRequestCycle) - Static method in class com.opensymphony.module.sitemesh.tapestry.Util

Gets the head renderer.

getId() - Method in class com.opensymphony.module.sitemesh.taglib.decorator.DivTag

getInitParameter(String) - Method in interface com.opensymphony.module.sitemesh.Decorator

Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.

getInitParameter(String) - Method in class com.opensymphony.module.sitemesh.mapper.DefaultDecorator

Returns a String containing the value of the named initialization parameter, or null if the parameter does not exist.

getInitParameterNames() - Method in interface com.opensymphony.module.sitemesh.Decorator

Returns the names of the Decorator's initialization parameters as an Iterator of String objects, or an empty Iterator if the Decorator has no initialization parameters.

getInitParameterNames() - Method in class com.opensymphony.module.sitemesh.mapper.DefaultDecorator

Returns the names of the Decorator's initialization parameters as an Iterator of String objects, or an empty Iterator if the Decorator has no initialization parameters.

getInstance(Config) - Static method in class com.opensymphony.module.sitemesh.Factory

Entry-point for obtaining singleton instance of Factory.

getIntProperty(String) - Method in interface com.opensymphony.module.sitemesh.Page

Get a property embedded into the Page as an int.

getIntProperty(String) - Method in class com.opensymphony.module.sitemesh.parser.AbstractPage

getIntProperty(String) - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

getLength() - Method in class com.opensymphony.module.sitemesh.html.CustomTag

getLength() - Method in interface com.opensymphony.module.sitemesh.html.Tag

The length of the tag.

getLength() - Method in interface com.opensymphony.module.sitemesh.html.Text

The length of the text.

getLength() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser.ReusableToken

getLength() - Method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment

Gets the length.

getLocale() - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

getLongProperty(String) - Method in interface com.opensymphony.module.sitemesh.Page

Get a property embedded into the Page as a long.

getLongProperty(String) - Method in class com.opensymphony.module.sitemesh.parser.AbstractPage

getLongProperty(String) - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

getLowerSubstr() - Method in class com.opensymphony.module.sitemesh.html.util.CharArray

Returns the substring that was specified by the CharArray.setSubstr(int, int) call.

getMap() - Method in class com.opensymphony.module.sitemesh.parser.PartialPageParser.HashSimpleMap

Gets the map.

getMappedName(String) - Method in class com.opensymphony.module.sitemesh.mapper.ConfigLoader

Get name of Decorator mapped to given path.

getName() - Method in interface com.opensymphony.module.sitemesh.Decorator

Name of the Decorator.

getName() - Method in class com.opensymphony.module.sitemesh.html.CustomTag

getName() - Method in interface com.opensymphony.module.sitemesh.html.Tag

Name of tag (ie.

getName() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser.ReusableToken

getName() - Method in class com.opensymphony.module.sitemesh.mapper.DefaultDecorator

Name of Decorator.

getName() - Method in class com.opensymphony.module.sitemesh.parser.PartialPageParser.MetaTagSimpleMap

Gets the name.

getNamedDecorator(HttpServletRequest, String) - Method in interface com.opensymphony.module.sitemesh.DecoratorMapper

Return a Decorator with given name.

getNamedDecorator(HttpServletRequest, String) - Method in class com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper

getNamedDecorator(HttpServletRequest, String) - Method in class com.opensymphony.module.sitemesh.mapper.ConfigDecoratorMapper

Retrieve Decorator named in 'name' attribute.

getNamedDecorator(HttpServletRequest, String) - Method in class com.opensymphony.module.sitemesh.mapper.EnvEntryDecoratorMapper

Retrieves the Decorator specified by the decorator name.

getNamedDecorator(HttpServletRequest, String) - Method in class com.opensymphony.module.sitemesh.mapper.FileDecoratorMapper

getNamedDecorator(HttpServletRequest, String) - Method in class com.opensymphony.module.sitemesh.mapper.NullDecoratorMapper

Returns null.

getOut() - Method in class com.opensymphony.module.sitemesh.taglib.AbstractTag

Get the outputWriter.

getOutputStream() - Method in class com.opensymphony.module.sitemesh.filter.Buffer

Gets the output stream.

getOutputStream() - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

getOutputStream() - Method in class com.opensymphony.module.sitemesh.filter.PageResponseWrapper

getPage() - Method in interface com.opensymphony.module.sitemesh.Decorator

URI of the Servlet/JSP to dispatch the request to (relative to the web-app context).

getPage() - Method in class com.opensymphony.module.sitemesh.filter.PageResponseWrapper

Gets the page.

getPage() - Method in class com.opensymphony.module.sitemesh.mapper.DefaultDecorator

URI of the Servlet/JSP to dispatch the request to (relative to the web-app context).

getPage() - Method in interface com.opensymphony.module.sitemesh.Page

Convenience method to return the contents of the Page in its original format.

getPage() - Method in class com.opensymphony.module.sitemesh.parser.AbstractPage

getPage() - Method in class com.opensymphony.module.sitemesh.taglib.AbstractTag

Return the Page object from the PAGE scope.

getPage() - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

getPage(IRequestCycle) - Static method in class com.opensymphony.module.sitemesh.tapestry.Util

Gets the page.

getPageParser(String) - Method in class com.opensymphony.module.sitemesh.factory.BaseFactory

Create a PageParser suitable for the given content-type.

getPageParser(String) - Method in interface com.opensymphony.module.sitemesh.PageParserSelector

Create a PageParser suitable for the given content-type.

getParent() - Method in class com.opensymphony.module.sitemesh.taglib.AbstractTag

getPosition() - Method in class com.opensymphony.module.sitemesh.html.CustomTag

getPosition() - Method in interface com.opensymphony.module.sitemesh.html.Tag

The position of the tag.

getPosition() - Method in interface com.opensymphony.module.sitemesh.html.Text

The position of the text.

getPosition() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser.ReusableToken

getProperties() - Method in interface com.opensymphony.module.sitemesh.Page

Get a Map representing all the properties in the Page.

getProperties() - Method in class com.opensymphony.module.sitemesh.parser.AbstractPage

getProperties() - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

getProperty() - Method in class com.opensymphony.module.sitemesh.taglib.decorator.PropertyTag

Gets the property.

getProperty() - Method in class com.opensymphony.module.sitemesh.tapestry.Property

Gets the property.

getProperty(String) - Method in interface com.opensymphony.module.sitemesh.Page

Get a property embedded into the Page as a String.

getProperty(String) - Method in class com.opensymphony.module.sitemesh.parser.AbstractPage

getProperty(String) - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

getProperty(String) - Method in class com.opensymphony.sitemesh.compatability.HTMLPage2Content

getProperty(String) - Method in interface com.opensymphony.sitemesh.Content

Get a property embedded into the Page as a String.

getProperty(String, IRequestCycle) - Static method in class com.opensymphony.module.sitemesh.tapestry.Util

Gets the property.

getPropertyKeys() - Method in interface com.opensymphony.module.sitemesh.Page

Get all available property keys for the Page.

getPropertyKeys() - Method in class com.opensymphony.module.sitemesh.parser.AbstractPage

getPropertyKeys() - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

getPropertyKeys() - Method in class com.opensymphony.sitemesh.compatability.HTMLPage2Content

getPropertyKeys() - Method in interface com.opensymphony.sitemesh.Content

Get all available property keys for the Page.

getRequest() - Method in interface com.opensymphony.module.sitemesh.Page

Deprecated.

Since Servlet 2.4 API, this is unnecessary - just use the stand HttpServletRequest instance.

getRequest() - Method in class com.opensymphony.module.sitemesh.parser.AbstractPage

getRequest() - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

getRequest() - Method in class com.opensymphony.sitemesh.webapp.SiteMeshWebAppContext

Gets the request.

getRequestDispatcher(String) - Method in class com.opensymphony.module.sitemesh.filter.PageRequestWrapper

getResource(String, Class<?>) - Static method in class com.opensymphony.module.sitemesh.util.ClassLoaderUtil

Load a given resource.

getResourceAsStream(String, Class<?>) - Static method in class com.opensymphony.module.sitemesh.util.ClassLoaderUtil

This is a convenience method to load a resource as a stream.

getResponse() - Method in class com.opensymphony.sitemesh.webapp.SiteMeshWebAppContext

Gets the response.

getRole() - Method in interface com.opensymphony.module.sitemesh.Decorator

Role the user has to be in to get this decorator applied.

getRole() - Method in class com.opensymphony.module.sitemesh.mapper.DefaultDecorator

Role the user has to be in to get this decorator applied.

getRootCause() - Method in exception class com.opensymphony.module.sitemesh.factory.FactoryException

Get the original cause of the Exception.

getRule(String) - Method in class com.opensymphony.module.sitemesh.html.State

Gets the rule.

getServletContext() - Method in class com.opensymphony.module.sitemesh.Config

Gets the servlet context.

getServletContext() - Method in class com.opensymphony.sitemesh.webapp.SiteMeshWebAppContext

Gets the servlet context.

getSitemeshBuffer() - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

getSitemeshBuffer() - Method in class com.opensymphony.module.sitemesh.filter.SitemeshPrintWriter

getSitemeshBuffer() - Method in interface com.opensymphony.module.sitemesh.html.HTMLProcessorContext

Gets the sitemesh buffer.

getSitemeshBuffer() - Method in class com.opensymphony.module.sitemesh.SitemeshBufferWriter

getSitemeshBuffer() - Method in interface com.opensymphony.module.sitemesh.SitemeshWriter

Get the underlying buffer for the writer.

getSiteMeshPage() - Method in class com.opensymphony.module.sitemesh.tapestry.SiteMeshBase

Gets the site mesh page.

getStart() - Method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment

Gets the start.

getStringContent() - Method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment

Gets the string content.

getStringResource(String) - Static method in class com.opensymphony.module.sitemesh.mapper.EnvEntryDecoratorMapper

This pulls a value out of the web-app environment.

getTag() - Method in class com.opensymphony.module.sitemesh.parser.PartialPageParser.ContentTagSimpleMap

Gets the tag.

getTitle() - Method in interface com.opensymphony.module.sitemesh.Page

Get the Title of the document.

getTitle() - Method in class com.opensymphony.module.sitemesh.parser.AbstractPage

Return title of from "title" property.

getTitle() - Method in class com.opensymphony.module.sitemesh.tapestry.Title

Gets the title.

getTitle() - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

getTitle() - Method in class com.opensymphony.sitemesh.compatability.HTMLPage2Content

getTitle() - Method in interface com.opensymphony.sitemesh.Content

Get the Title of the document.

getTitle(IRequestCycle) - Static method in class com.opensymphony.module.sitemesh.tapestry.Util

Gets the title.

getTotalLength() - Method in class com.opensymphony.module.sitemesh.DefaultSitemeshBuffer

getTotalLength() - Method in class com.opensymphony.module.sitemesh.html.util.StringSitemeshBuffer

getTotalLength() - Method in interface com.opensymphony.module.sitemesh.SitemeshBuffer

Get the total length of the buffered content, including the length of any chained buffers.

getTotalLength() - Method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment

Get the total length of the fragment, taking deletions and chained buffers of the buffer.

getTotalLength(int, int) - Method in class com.opensymphony.module.sitemesh.DefaultSitemeshBuffer

getTotalLength(int, int) - Method in class com.opensymphony.module.sitemesh.html.util.StringSitemeshBuffer

getTotalLength(int, int) - Method in interface com.opensymphony.module.sitemesh.SitemeshBuffer

Get the total length of the buffered content, including chained buffers from start to length.

getType() - Method in class com.opensymphony.module.sitemesh.filter.HttpContentType

Gets the type.

getType() - Method in class com.opensymphony.module.sitemesh.html.CustomTag

Type of tag:
<blah> - Tag.OPEN
</blah> - Tag.CLOSE
<blah/> - Tag.EMPTY

getType() - Method in interface com.opensymphony.module.sitemesh.html.Tag

Type of tag:
<blah> - Tag.OPEN
</blah> - Tag.CLOSE
<blah/> - Tag.EMPTY

getType() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser.ReusableToken

getType() - Method in class com.opensymphony.module.sitemesh.taglib.decorator.UseHTMLPageTEI

getType() - Method in class com.opensymphony.module.sitemesh.taglib.decorator.UsePageTEI

Gets the type.

getURIPath() - Method in interface com.opensymphony.module.sitemesh.Decorator

URI path of the Decorator.

getURIPath() - Method in class com.opensymphony.module.sitemesh.mapper.DefaultDecorator

URI path of the Decorator.

getValue() - Method in class com.opensymphony.module.sitemesh.tapestry.Property

Gets the value.

getVariableInfo(TagData) - Method in class com.opensymphony.module.sitemesh.taglib.decorator.UsePageTEI

getWriter() - Method in class com.opensymphony.module.sitemesh.filter.Buffer

Gets the writer.

getWriter() - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

getWriter() - Method in class com.opensymphony.module.sitemesh.filter.PageResponseWrapper

getWriter(Writer) - Static method in class com.opensymphony.module.sitemesh.util.OutputConverter

Gets the writer.

GT - Static variable in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

The Constant GT.

H

handleRequest(HttpServletRequest, HttpServletResponse, Context) - Method in class com.opensymphony.module.sitemesh.velocity.VelocityDecoratorServlet

handles(SiteMeshContext) - Method in class com.opensymphony.sitemesh.compatability.PageParser2ContentProcessor

Handles.

handles(SiteMeshContext) - Method in interface com.opensymphony.sitemesh.ContentProcessor

Handles.

handles(String) - Method in class com.opensymphony.sitemesh.compatability.PageParser2ContentProcessor

handles(String) - Method in interface com.opensymphony.sitemesh.ContentProcessor

Handles.

handleText(Text, HTMLProcessorContext) - Method in class com.opensymphony.module.sitemesh.html.State

Handle text.

hasAttribute(String, boolean) - Method in class com.opensymphony.module.sitemesh.html.CustomTag

hasAttribute(String, boolean) - Method in interface com.opensymphony.module.sitemesh.html.Tag

Determine if an attribute is present.

hasAttribute(String, boolean) - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser.ReusableToken

hasFragments() - Method in class com.opensymphony.module.sitemesh.DefaultSitemeshBuffer

hasFragments() - Method in class com.opensymphony.module.sitemesh.html.util.StringSitemeshBuffer

hasFragments() - Method in interface com.opensymphony.module.sitemesh.SitemeshBuffer

Whether the buffer has fragments or not.

hashCode() - Method in class com.opensymphony.module.sitemesh.html.CustomTag

HashSimpleMap() - Constructor for class com.opensymphony.module.sitemesh.parser.PartialPageParser.HashSimpleMap

HeadExtractingRule - Class in com.opensymphony.module.sitemesh.html.rules

The Class HeadExtractingRule.

HeadExtractingRule(SitemeshBufferFragment.Builder) - Constructor for class com.opensymphony.module.sitemesh.html.rules.HeadExtractingRule

Instantiates a new head extracting rule.

HeadTag - Class in com.opensymphony.module.sitemesh.taglib.decorator

Write original HTMLPage head to out.

HeadTag() - Constructor for class com.opensymphony.module.sitemesh.taglib.decorator.HeadTag

HPAS - Static variable in class com.opensymphony.module.sitemesh.util.Container

The Constant HPAS.

HtmlAttributesRule - Class in com.opensymphony.module.sitemesh.html.rules

The Class HtmlAttributesRule.

HtmlAttributesRule(PageBuilder) - Constructor for class com.opensymphony.module.sitemesh.html.rules.HtmlAttributesRule

Instantiates a new html attributes rule.

HTMLPage - Interface in com.opensymphony.module.sitemesh

Extension of Page providing access to HTML data.

HTMLPage2Content - Class in com.opensymphony.sitemesh.compatability

Adapts a SiteMesh 2 HTMLPage to a SiteMesh 3 Content.

HTMLPage2Content(HTMLPage) - Constructor for class com.opensymphony.sitemesh.compatability.HTMLPage2Content

Instantiates a new HTML page 2 content.

HTMLPageParser - Class in com.opensymphony.module.sitemesh.parser

Builds an HTMLPage object from an HTML document.

HTMLPageParser() - Constructor for class com.opensymphony.module.sitemesh.parser.HTMLPageParser

HTMLProcessor - Class in com.opensymphony.module.sitemesh.html

The Class HTMLProcessor.

HTMLProcessor(SitemeshBuffer, SitemeshBufferFragment.Builder) - Constructor for class com.opensymphony.module.sitemesh.html.HTMLProcessor

Instantiates a new HTML processor.

HTMLProcessorContext - Interface in com.opensymphony.module.sitemesh.html

The Interface HTMLProcessorContext.

HttpContentType - Class in com.opensymphony.module.sitemesh.filter

Extracts the type and encoding from an HTTP Content-Type header.

HttpContentType(String) - Constructor for class com.opensymphony.module.sitemesh.filter.HttpContentType

Instantiates a new http content type.

I

include(ServletRequest, ServletResponse) - Method in class com.opensymphony.module.sitemesh.filter.RequestDispatcherWrapper

init(Config, Properties, DecoratorMapper) - Method in interface com.opensymphony.module.sitemesh.DecoratorMapper

Initialize the mapper.

init(Config, Properties, DecoratorMapper) - Method in class com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper

init(Config, Properties, DecoratorMapper) - Method in class com.opensymphony.module.sitemesh.mapper.AgentDecoratorMapper

init(Config, Properties, DecoratorMapper) - Method in class com.opensymphony.module.sitemesh.mapper.ConfigDecoratorMapper

Create new ConfigLoader using '/WEB-INF/decorators.xml' file.

init(Config, Properties, DecoratorMapper) - Method in class com.opensymphony.module.sitemesh.mapper.CookieDecoratorMapper

init(Config, Properties, DecoratorMapper) - Method in class com.opensymphony.module.sitemesh.mapper.FrameSetDecoratorMapper

init(Config, Properties, DecoratorMapper) - Method in class com.opensymphony.module.sitemesh.mapper.LanguageDecoratorMapper

init(Config, Properties, DecoratorMapper) - Method in class com.opensymphony.module.sitemesh.mapper.NullDecoratorMapper

Does nothing.

init(Config, Properties, DecoratorMapper) - Method in class com.opensymphony.module.sitemesh.mapper.OSDecoratorMapper

Init initializes the OSDecoratorMapper object by setting the parent DecoratorMapper, and loading the initialization properties.

init(Config, Properties, DecoratorMapper) - Method in class com.opensymphony.module.sitemesh.mapper.PageDecoratorMapper

init(Config, Properties, DecoratorMapper) - Method in class com.opensymphony.module.sitemesh.mapper.ParameterDecoratorMapper

init(Config, Properties, DecoratorMapper) - Method in class com.opensymphony.module.sitemesh.mapper.PrintableDecoratorMapper

init(Config, Properties, DecoratorMapper) - Method in class com.opensymphony.module.sitemesh.mapper.RobotDecoratorMapper

init(Config, Properties, DecoratorMapper) - Method in class com.opensymphony.module.sitemesh.mapper.SessionDecoratorMapper

init(FilterConfig) - Method in class com.opensymphony.sitemesh.webapp.SiteMeshFilter

initContentProcessor(SiteMeshWebAppContext) - Method in class com.opensymphony.sitemesh.webapp.SiteMeshFilter

Inits the content processor.

initDecoratorSelector(SiteMeshWebAppContext) - Method in class com.opensymphony.sitemesh.webapp.SiteMeshFilter

Inits the decorator selector.

InlineDecoratorMapper - Class in com.opensymphony.module.sitemesh.mapper

The InlineDecoratorMapper is used to determine the correct Decorator when using inline decorators.

InlineDecoratorMapper() - Constructor for class com.opensymphony.module.sitemesh.mapper.InlineDecoratorMapper

insert(int, SitemeshBufferFragment) - Method in class com.opensymphony.module.sitemesh.DefaultSitemeshBuffer.Builder

Insert.

insert(int, SitemeshBufferFragment) - Method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment.Builder

Insert the given fragment to the given position.

insert(int, String) - Method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment.Builder

Insert the given string fragment to the given position.

isCommitted() - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

isFrameSet() - Method in interface com.opensymphony.module.sitemesh.HTMLPage

Check to see if this page contains an HTML frameset.

isFrameSet() - Method in class com.opensymphony.module.sitemesh.parser.AbstractHTMLPage

isFrameSet() - Method in class com.opensymphony.module.sitemesh.parser.PartialPageParserHtmlPage

isFrameSet() - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

isPathExcluded(String) - Method in class com.opensymphony.module.sitemesh.factory.BaseFactory

Returns true if the supplied path matches one of the exclude URLs specified in sitemesh.xml, otherwise returns false.

isPathExcluded(String) - Method in class com.opensymphony.module.sitemesh.Factory

Determine whether the given path should be excluded from decoration or not.

isPropertySet(String) - Method in interface com.opensymphony.module.sitemesh.Page

Determine whether a property embedded into the Page has been set.

isPropertySet(String) - Method in class com.opensymphony.module.sitemesh.parser.AbstractPage

isPropertySet(String) - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

isReady() - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

isUsingStream() - Method in class com.opensymphony.module.sitemesh.filter.Buffer

Checks if is using stream.

isUsingStream() - Method in class com.opensymphony.module.sitemesh.filter.PageResponseWrapper

Checks if is using stream.

isUsingStream() - Method in class com.opensymphony.sitemesh.webapp.ContentBufferingResponse

Checks if is using stream.

isUsingStream() - Method in class com.opensymphony.sitemesh.webapp.SiteMeshWebAppContext

Checks if is using stream.

J

JRUN - Static variable in class com.opensymphony.module.sitemesh.util.Container

The Constant JRUN.

L

LanguageDecoratorMapper - Class in com.opensymphony.module.sitemesh.mapper

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).

LanguageDecoratorMapper() - Constructor for class com.opensymphony.module.sitemesh.mapper.LanguageDecoratorMapper

length() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

length() - Method in class com.opensymphony.module.sitemesh.html.util.CharArray

Returns the current length of the character array.

line() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

loadClass(String, Class<?>) - Static method in class com.opensymphony.module.sitemesh.util.ClassLoaderUtil

Load a class with a given name.

locateWebApp(ServletContext) - Method in class com.opensymphony.sitemesh.webapp.decorator.DispatchedDecorator

Locate web app.

locateWebApp(ServletContext) - Method in class com.opensymphony.sitemesh.webapp.decorator.ExternalDispatchedDecorator

LT - Static variable in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

The Constant LT.

LT_CLOSE_MAGIC_COMMENT - Static variable in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

The Constant LT_CLOSE_MAGIC_COMMENT.

LT_OPEN_MAGIC_COMMENT - Static variable in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

The Constant LT_OPEN_MAGIC_COMMENT.

M

mapParser(String, String) - Method in class com.opensymphony.module.sitemesh.factory.BaseFactory

Map new PageParser to given content-type.

mark(int) - Method in class com.opensymphony.module.sitemesh.util.CharArrayReader

Mark the present position in the stream.

markedPos - Variable in class com.opensymphony.module.sitemesh.util.CharArrayReader

The position of mark in buffer.

markStart(int) - Method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment.Builder

Mark the start of the fragment.

markStartDelete(int) - Method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment.Builder

Mark the start of a deletion.

markSupported() - Method in class com.opensymphony.module.sitemesh.util.CharArrayReader

Tell whether this stream supports the mark() operation, which it does.

MetaTagRule - Class in com.opensymphony.module.sitemesh.html.rules

The Class MetaTagRule.

MetaTagRule(PageBuilder) - Constructor for class com.opensymphony.module.sitemesh.html.rules.MetaTagRule

Instantiates a new meta tag rule.

MetaTagSimpleMap() - Constructor for class com.opensymphony.module.sitemesh.parser.PartialPageParser.MetaTagSimpleMap

MSOfficeDocumentPropertiesRule - Class in com.opensymphony.module.sitemesh.html.rules

Extracts the extra properties saved in HTML from MS Office applications (Word and Excel), such as Author, Company, Version, etc.

MSOfficeDocumentPropertiesRule(PageBuilder) - Constructor for class com.opensymphony.module.sitemesh.html.rules.MSOfficeDocumentPropertiesRule

Instantiates a new MS office document properties rule.

MultipassFilter - Class in com.opensymphony.module.sitemesh.multipass

The Class MultipassFilter.

MultipassFilter() - Constructor for class com.opensymphony.module.sitemesh.multipass.MultipassFilter

MultipassReplacementPageParser - Class in com.opensymphony.module.sitemesh.multipass

The Class MultipassReplacementPageParser.

MultipassReplacementPageParser(Page, HttpServletResponse) - Constructor for class com.opensymphony.module.sitemesh.multipass.MultipassReplacementPageParser

Instantiates a new multipass replacement page parser.

N

name - Variable in class com.opensymphony.module.sitemesh.mapper.DefaultDecorator

The name.

NoDecorator - Class in com.opensymphony.sitemesh.webapp.decorator

If no decorator is to be applied to a page, this will ensure the original content gets written out.

NoDecorator() - Constructor for class com.opensymphony.sitemesh.webapp.decorator.NoDecorator

noNull(String) - Static method in class com.opensymphony.module.sitemesh.parser.AbstractPage

Return String as is, or "" if null.

NullDecoratorMapper - Class in com.opensymphony.module.sitemesh.mapper

The NullDecoratorMapper represents the top-level DecoratorMapper that is finally delegated to if no other DecoratorMapper has intervened.

NullDecoratorMapper() - Constructor for class com.opensymphony.module.sitemesh.mapper.NullDecoratorMapper

O

OldDecorator2NewDecorator - Class in com.opensymphony.sitemesh.compatability

Adapts a SiteMesh 2 Decorator to a SiteMesh 3 Decorator.

OldDecorator2NewDecorator(Decorator) - Constructor for class com.opensymphony.sitemesh.compatability.OldDecorator2NewDecorator

Instantiates a new old decorator 2 new decorator.

OPEN - Static variable in interface com.opensymphony.module.sitemesh.html.Tag

The open.

OPEN_MAGIC_COMMENT - Static variable in interface com.opensymphony.module.sitemesh.html.Tag

The open magic comment.

ORION - Static variable in class com.opensymphony.module.sitemesh.util.Container

The Constant ORION.

OSDecoratorMapper - Class in com.opensymphony.module.sitemesh.mapper

The OSDecoratorMapper will map a suitable decorator based on the operating system of the remote client.

OSDecoratorMapper() - Constructor for class com.opensymphony.module.sitemesh.mapper.OSDecoratorMapper

OutputConverter - Class in com.opensymphony.module.sitemesh.util

A converter from one character type to another

OutputConverter() - Constructor for class com.opensymphony.module.sitemesh.util.OutputConverter

P

page - Variable in class com.opensymphony.module.sitemesh.mapper.DefaultDecorator

The page.

Page - Interface in com.opensymphony.module.sitemesh

The Page object wraps the contents of the original (undecorated) page.

PAGE - Static variable in interface com.opensymphony.module.sitemesh.RequestConstants

Stores Page instance for parsed page to be passed across to Decorator.

PageBuilder - Interface in com.opensymphony.module.sitemesh.html.rules

Allows a TagRule to add information to a Page object.

pageContext - Variable in class com.opensymphony.module.sitemesh.taglib.AbstractTag

The page context.

PageDecoratorMapper - Class in com.opensymphony.module.sitemesh.mapper

The PageDecoratorMapper allows the actual Page to determine the Decorator to be used.

PageDecoratorMapper() - Constructor for class com.opensymphony.module.sitemesh.mapper.PageDecoratorMapper

PageFilter - Class in com.opensymphony.module.sitemesh.filter

Deprecated.

Use SiteMeshFilter instead.

PageFilter() - Constructor for class com.opensymphony.module.sitemesh.filter.PageFilter

Deprecated.

PageParser - Interface in com.opensymphony.module.sitemesh

The PageParser is responsible for parsing the page data into an appropriate Page object.

PageParser2ContentProcessor - Class in com.opensymphony.sitemesh.compatability

Adapts a SiteMesh 2 PageParser to a SiteMesh 3 ContentProcessor.

PageParser2ContentProcessor(Factory) - Constructor for class com.opensymphony.sitemesh.compatability.PageParser2ContentProcessor

Instantiates a new page parser 2 content processor.

pageParsers - Variable in class com.opensymphony.module.sitemesh.factory.BaseFactory

Map that associates content-types with PageParser instances.

PageParserSelector - Interface in com.opensymphony.module.sitemesh

The Interface PageParserSelector.

Page Properties - Search tag in interface com.opensymphony.module.sitemesh.HTMLPage

Section

PageRequestWrapper - Class in com.opensymphony.module.sitemesh.filter

Will wrap a request for the RequestDispatcherWrapper.

PageRequestWrapper(HttpServletRequest) - Constructor for class com.opensymphony.module.sitemesh.filter.PageRequestWrapper

Instantiates a new page request wrapper.

PageResponseWrapper - Class in com.opensymphony.module.sitemesh.filter

Implementation of HttpServletResponseWrapper that captures page data instead of sending to the writer.

PageResponseWrapper(HttpServletResponse, PageParserSelector) - Constructor for class com.opensymphony.module.sitemesh.filter.PageResponseWrapper

Instantiates a new page response wrapper.

ParameterDecoratorMapper - Class in com.opensymphony.module.sitemesh.mapper

The ParameterDecoratorMapper will map a suitable decorator based on request parameters.

ParameterDecoratorMapper() - Constructor for class com.opensymphony.module.sitemesh.mapper.ParameterDecoratorMapper

ParameterExtractingRule - Class in com.opensymphony.module.sitemesh.html.rules

The Class ParameterExtractingRule.

ParameterExtractingRule(PageBuilder) - Constructor for class com.opensymphony.module.sitemesh.html.rules.ParameterExtractingRule

Instantiates a new parameter extracting rule.

parameters - Variable in class com.opensymphony.module.sitemesh.mapper.DefaultDecorator

The parameters.

ParamTag - Class in com.opensymphony.module.sitemesh.taglib.page

Add a parameter to the inline Decorator, as if specified in the Page.

ParamTag() - Constructor for class com.opensymphony.module.sitemesh.taglib.page.ParamTag

parent - Variable in class com.opensymphony.module.sitemesh.mapper.AbstractDecoratorMapper

Parent DecoratorMapper.

parent - Variable in class com.opensymphony.module.sitemesh.taglib.AbstractTag

The parent.

parse() - Method in class com.opensymphony.module.sitemesh.filter.Buffer

Parses the.

parse(char[]) - Method in class com.opensymphony.module.sitemesh.multipass.MultipassReplacementPageParser

parse(char[]) - Method in interface com.opensymphony.module.sitemesh.PageParser

Deprecated.

Use PageParser.parse(SitemeshBuffer), to allow performance improvement such as single buffer parsing and buffer chaining.

parse(char[]) - Method in class com.opensymphony.module.sitemesh.parser.FastPageParser

Deprecated.

parse(char[]) - Method in class com.opensymphony.module.sitemesh.parser.HTMLPageParser

parse(char[]) - Method in class com.opensymphony.module.sitemesh.parser.PartialPageParser

parse(SitemeshBuffer) - Method in class com.opensymphony.module.sitemesh.multipass.MultipassReplacementPageParser

parse(SitemeshBuffer) - Method in interface com.opensymphony.module.sitemesh.PageParser

Parse the given buffer into a page object.

parse(SitemeshBuffer) - Method in class com.opensymphony.module.sitemesh.parser.FastPageParser

Deprecated.

parse(SitemeshBuffer) - Method in class com.opensymphony.module.sitemesh.parser.HTMLPageParser

parse(SitemeshBuffer) - Method in class com.opensymphony.module.sitemesh.parser.PartialPageParser

parsedAttribute(String, String, boolean) - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

Parsed attribute.

parsedTag(int, String, int, int) - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

Parsed tag.

parsedText(int, int) - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

Parsed text.

Parser - Class in com.opensymphony.module.sitemesh.html.tokenizer

Looks for patterns of tokens in the Lexer and translates these to calls to pass to the TokenHandler.

Parser(char[], int, TokenHandler) - Constructor for class com.opensymphony.module.sitemesh.html.tokenizer.Parser

Instantiates a new parser.

Parser.ReusableToken - Class in com.opensymphony.module.sitemesh.html.tokenizer

The Class ReusableToken.

PartialPageParser - Class in com.opensymphony.module.sitemesh.parser

Page parser that doesn't parse the full page, but rather just parses the head section of the page.

PartialPageParser() - Constructor for class com.opensymphony.module.sitemesh.parser.PartialPageParser

PartialPageParser.ContentTagSimpleMap - Class in com.opensymphony.module.sitemesh.parser

The Class ContentTagSimpleMap.

PartialPageParser.HashSimpleMap - Class in com.opensymphony.module.sitemesh.parser

The Class HashSimpleMap.

PartialPageParser.MetaTagSimpleMap - Class in com.opensymphony.module.sitemesh.parser

The Class MetaTagSimpleMap.

PartialPageParser.SimpleMap - Interface in com.opensymphony.module.sitemesh.parser

The Interface SimpleMap.

PartialPageParserHtmlPage - Class in com.opensymphony.module.sitemesh.parser

The Class PartialPageParserHtmlPage.

PartialPageParserHtmlPage(SitemeshBuffer, SitemeshBufferFragment, Map<String, String>) - Constructor for class com.opensymphony.module.sitemesh.parser.PartialPageParserHtmlPage

Instantiates a new partial page parser html page.

PartialPageParserHtmlPage(SitemeshBuffer, SitemeshBufferFragment, Map<String, String>, SitemeshBufferFragment, String, Map<String, String>, Map<String, String>) - Constructor for class com.opensymphony.module.sitemesh.parser.PartialPageParserHtmlPage

Instantiates a new partial page parser html page.

PartialPageParserPage - Class in com.opensymphony.module.sitemesh.parser

The Class PartialPageParserPage.

PartialPageParserPage(SitemeshBuffer, SitemeshBufferFragment) - Constructor for class com.opensymphony.module.sitemesh.parser.PartialPageParserPage

Instantiates a new partial page parser page.

PathMapper - Class in com.opensymphony.module.sitemesh.mapper

The PathMapper is used to map file patterns to keys, and find an approriate key for a given file path.

PathMapper() - Constructor for class com.opensymphony.module.sitemesh.mapper.PathMapper

popBuffer() - Method in interface com.opensymphony.module.sitemesh.html.HTMLProcessorContext

Pop buffer.

pos - Variable in class com.opensymphony.module.sitemesh.util.CharArrayReader

The current buffer position.

position() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

preTemplateProcess(HttpServletRequest, HttpServletResponse, Template, TemplateModel) - Method in class com.opensymphony.module.sitemesh.freemarker.FreemarkerDecoratorServlet

print(boolean) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

print(boolean) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

print(char) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

print(char) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

print(char[]) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

print(double) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

print(double) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

print(float) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

print(float) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

print(int) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

print(int) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

print(long) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

print(long) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

print(Object) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

print(String) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

print(String) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

PrintableDecoratorMapper - Class in com.opensymphony.module.sitemesh.mapper

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.

PrintableDecoratorMapper() - Constructor for class com.opensymphony.module.sitemesh.mapper.PrintableDecoratorMapper

println() - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

println() - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

println(boolean) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

println(boolean) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

println(char) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

println(char) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

println(char[]) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

println(double) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

println(double) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

println(float) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

println(float) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

println(int) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

println(int) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

println(long) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

println(long) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

println(Object) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

println(String) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

println(String) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

printStackTrace() - Method in exception class com.opensymphony.module.sitemesh.factory.FactoryException

printStackTrace(PrintStream) - Method in exception class com.opensymphony.module.sitemesh.factory.FactoryException

printStackTrace(PrintWriter) - Method in exception class com.opensymphony.module.sitemesh.factory.FactoryException

process() - Method in class com.opensymphony.module.sitemesh.html.HTMLProcessor

Process.

process(Tag) - Method in class com.opensymphony.module.sitemesh.html.BlockExtractingRule

process(Tag) - Method in class com.opensymphony.module.sitemesh.html.rules.BodyTagRule

process(Tag) - Method in class com.opensymphony.module.sitemesh.html.rules.FramesetRule

process(Tag) - Method in class com.opensymphony.module.sitemesh.html.rules.HtmlAttributesRule

process(Tag) - Method in class com.opensymphony.module.sitemesh.html.rules.MetaTagRule

process(Tag) - Method in class com.opensymphony.module.sitemesh.html.rules.MSOfficeDocumentPropertiesRule

process(Tag) - Method in class com.opensymphony.module.sitemesh.html.rules.ParameterExtractingRule

process(Tag) - Method in class com.opensymphony.module.sitemesh.html.rules.TagReplaceRule

process(Tag) - Method in class com.opensymphony.module.sitemesh.html.StateTransitionRule

process(Tag) - Method in interface com.opensymphony.module.sitemesh.html.TagRule

Process.

properties - Variable in class com.opensymphony.module.sitemesh.mapper.OSDecoratorMapper

Properties holds the parameters that the object was initialized with.

Property - Class in com.opensymphony.module.sitemesh.tapestry

Because Tapestry templating works differently than JSP taglibs, the writeEntireProperty feature is not implemented here.

Property() - Constructor for class com.opensymphony.module.sitemesh.tapestry.Property

PropertyTag - Class in com.opensymphony.module.sitemesh.taglib.decorator

Write property of Page to out.

PropertyTag() - Constructor for class com.opensymphony.module.sitemesh.taglib.decorator.PropertyTag

pushBuffer(SitemeshBufferFragment.Builder) - Method in interface com.opensymphony.module.sitemesh.html.HTMLProcessorContext

Push buffer.

pushDecoratorMapper(String, Properties) - Method in class com.opensymphony.module.sitemesh.factory.BaseFactory

Push new DecoratorMapper onto end of chain.

put(String, String) - Method in class com.opensymphony.module.sitemesh.mapper.PathMapper

Add a key and appropriate matching pattern.

put(String, String) - Method in class com.opensymphony.module.sitemesh.parser.PartialPageParser.ContentTagSimpleMap

put(String, String) - Method in class com.opensymphony.module.sitemesh.parser.PartialPageParser.HashSimpleMap

put(String, String) - Method in class com.opensymphony.module.sitemesh.parser.PartialPageParser.MetaTagSimpleMap

put(String, String) - Method in interface com.opensymphony.module.sitemesh.parser.PartialPageParser.SimpleMap

Put.

Q

QUOTE - Static variable in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

The Constant QUOTE.

QUOTED - Static variable in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

The Constant QUOTED.

R

read() - Method in class com.opensymphony.module.sitemesh.util.CharArrayReader

Read a single character.

read(char[], int, int) - Method in class com.opensymphony.module.sitemesh.util.CharArrayReader

Read characters into a portion of an array.

ready() - Method in class com.opensymphony.module.sitemesh.util.CharArrayReader

Tell whether this stream is ready to be read.

refresh() - Method in class com.opensymphony.module.sitemesh.factory.DefaultFactory

Check if configuration file has been modified, and if so reload it.

refresh() - Method in class com.opensymphony.module.sitemesh.Factory

Refresh.

RegexReplacementTextFilter - Class in com.opensymphony.module.sitemesh.html.rules

TextFilter that substitutes content using a JDK 1.4 regular expression.

RegexReplacementTextFilter(String, String) - Constructor for class com.opensymphony.module.sitemesh.html.rules.RegexReplacementTextFilter

Instantiates a new regex replacement text filter.

RegexReplacementTextFilter(Pattern, String) - Constructor for class com.opensymphony.module.sitemesh.html.rules.RegexReplacementTextFilter

Instantiates a new regex replacement text filter.

release() - Method in class com.opensymphony.module.sitemesh.taglib.AbstractTag

removeAttribute(int) - Method in class com.opensymphony.module.sitemesh.html.CustomTag

Remove an attribute.

removeAttribute(String, boolean) - Method in class com.opensymphony.module.sitemesh.html.CustomTag

Change the value of an attribute, or add an attribute if it does not already exist.

render(Content, SiteMeshContext) - Method in interface com.opensymphony.sitemesh.Decorator

Render.

render(Content, SiteMeshContext) - Method in class com.opensymphony.sitemesh.webapp.decorator.BaseWebAppDecorator

Render.

render(Content, HttpServletRequest, HttpServletResponse, ServletContext, SiteMeshWebAppContext) - Method in class com.opensymphony.sitemesh.compatability.OldDecorator2NewDecorator

render(Content, HttpServletRequest, HttpServletResponse, ServletContext, SiteMeshWebAppContext) - Method in class com.opensymphony.sitemesh.webapp.decorator.BaseWebAppDecorator

More convenient version of BaseWebAppDecorator.render(com.opensymphony.sitemesh.Content, com.opensymphony.sitemesh.SiteMeshContext) suited for Servlet API calls.

render(Content, HttpServletRequest, HttpServletResponse, ServletContext, SiteMeshWebAppContext) - Method in class com.opensymphony.sitemesh.webapp.decorator.DispatchedDecorator

Render.

render(Content, HttpServletRequest, HttpServletResponse, ServletContext, SiteMeshWebAppContext) - Method in class com.opensymphony.sitemesh.webapp.decorator.NoDecorator

Render.

reportError(String, int, int) - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

RequestConstants - Interface in com.opensymphony.module.sitemesh

A set of static constants of Strings to be used as ServletRequest attribute keys to represent various objects passed between pages.

RequestDispatcherWrapper - Class in com.opensymphony.module.sitemesh.filter

Special request dispatcher that will include when an inline decorator includes a resource that uses an internal forward.

RequestDispatcherWrapper(RequestDispatcher) - Constructor for class com.opensymphony.module.sitemesh.filter.RequestDispatcherWrapper

Instantiates a new request dispatcher wrapper.

reset() - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

reset() - Method in class com.opensymphony.module.sitemesh.util.CharArrayReader

Reset the stream to the most recent mark, or to the beginning if it has never been marked.

reset() - Method in class com.opensymphony.module.sitemesh.util.CharArrayWriter

Resets the buffer so that you can use it again without throwing away the already allocated buffer.

reset() - Method in class com.opensymphony.module.sitemesh.util.FastByteArrayOutputStream

resetLexerState() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

RESIN - Static variable in class com.opensymphony.module.sitemesh.util.Container

The Constant RESIN.

ReusableToken() - Constructor for class com.opensymphony.module.sitemesh.html.tokenizer.Parser.ReusableToken

ROBOT - Static variable in interface com.opensymphony.module.sitemesh.RequestConstants

Marker that stores a Boolean (under the session) to state whether the current session is the session of a web search engine spider.

RobotDecoratorMapper - Class in com.opensymphony.module.sitemesh.mapper

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.

RobotDecoratorMapper() - Constructor for class com.opensymphony.module.sitemesh.mapper.RobotDecoratorMapper

role - Variable in class com.opensymphony.module.sitemesh.mapper.DefaultDecorator

The role.

RoutablePrintWriter - Class in com.opensymphony.module.sitemesh.filter

Provides a PrintWriter that routes through to another PrintWriter, however the destination can be changed at any point.

RoutablePrintWriter(RoutablePrintWriter.DestinationFactory) - Constructor for class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

Instantiates a new routable print writer.

RoutablePrintWriter.DestinationFactory - Interface in com.opensymphony.module.sitemesh.filter

Factory to lazily instantiate the destination.

RoutableServletOutputStream - Class in com.opensymphony.module.sitemesh.filter

Provides a ServletOutputStream that routes through to another ServletOutputStream, however the destination can be changed at any point.

RoutableServletOutputStream(RoutableServletOutputStream.DestinationFactory) - Constructor for class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

Instantiates a new routable servlet output stream.

RoutableServletOutputStream.DestinationFactory - Interface in com.opensymphony.module.sitemesh.filter

Factory to lazily instantiate the destination.

S

selectDecorator(Content, SiteMeshContext) - Method in class com.opensymphony.sitemesh.compatability.DecoratorMapper2DecoratorSelector

selectDecorator(Content, SiteMeshContext) - Method in interface com.opensymphony.sitemesh.DecoratorSelector

Select decorator.

sendError(int) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

sendError(int) - Method in class com.opensymphony.module.sitemesh.filter.PageResponseWrapper

sendError(int, String) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

sendError(int, String) - Method in class com.opensymphony.module.sitemesh.filter.PageResponseWrapper

sendRedirect(String) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

sendRedirect(String) - Method in class com.opensymphony.module.sitemesh.filter.PageResponseWrapper

SessionDecoratorMapper - Class in com.opensymphony.module.sitemesh.mapper

Will look at a session attribute to find the name of an appropriate decorator to use.

SessionDecoratorMapper() - Constructor for class com.opensymphony.module.sitemesh.mapper.SessionDecoratorMapper

setAttributeName(int, String) - Method in class com.opensymphony.module.sitemesh.html.CustomTag

Change the name of an existing attribute.

setAttributeValue(int, String) - Method in class com.opensymphony.module.sitemesh.html.CustomTag

Change the value of an existing attribute.

setAttributeValue(String, boolean, String) - Method in class com.opensymphony.module.sitemesh.html.CustomTag

Change the value of an attribute, or add an attribute if it does not already exist.

setBody(SitemeshBufferFragment) - Method in class com.opensymphony.module.sitemesh.parser.TokenizedHTMLPage

Sets the body.

setBuffer(char[]) - Method in class com.opensymphony.module.sitemesh.DefaultSitemeshBuffer.Builder

Sets the buffer.

setBuffer(SitemeshBuffer) - Method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment.Builder

Set the buffer.

setBufferSize(int) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

setContentLength(int) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

setContentLength(int) - Method in class com.opensymphony.module.sitemesh.filter.PageResponseWrapper

Prevent content-length being set if page is parseable.

setContentType(String) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

setContentType(String) - Method in class com.opensymphony.module.sitemesh.filter.PageResponseWrapper

Set the content-type of the request and store it so it can be passed to the PageParser.

setContentType(String) - Method in class com.opensymphony.module.sitemesh.taglib.page.ApplyDecoratorTag

Sets the content type.

setContentType(String) - Method in interface com.opensymphony.sitemesh.SiteMeshContext

Sets the content type.

setContentType(String) - Method in class com.opensymphony.sitemesh.webapp.SiteMeshWebAppContext

setContext(HTMLProcessorContext) - Method in class com.opensymphony.module.sitemesh.html.BasicRule

setContext(HTMLProcessorContext) - Method in interface com.opensymphony.module.sitemesh.html.TagRule

Sets the context.

setDateHeader(String, long) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

setDecorator(String) - Method in class com.opensymphony.module.sitemesh.taglib.page.ApplyDecoratorTag

Deprecated.

Use setName() instead.

setDefault(String) - Method in class com.opensymphony.module.sitemesh.taglib.decorator.PropertyTag

Value to write if no property matching key is found (optional).

setDefault(String) - Method in class com.opensymphony.module.sitemesh.taglib.decorator.TitleTag

Value to write if no title is found (optional).

setEncoding(String) - Method in class com.opensymphony.module.sitemesh.taglib.page.ApplyDecoratorTag

Sets the encoding.

setFrameSet(boolean) - Method in interface com.opensymphony.module.sitemesh.HTMLPage

Marks this page as a frameset.

setFrameSet(boolean) - Method in class com.opensymphony.module.sitemesh.parser.AbstractHTMLPage

setFrameSet(boolean) - Method in class com.opensymphony.module.sitemesh.parser.PartialPageParserHtmlPage

setFrameSet(boolean) - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

setHead(SitemeshBufferFragment) - Method in class com.opensymphony.module.sitemesh.parser.TokenizedHTMLPage

Sets the head.

setHeader(String, String) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

setHeader(String, String) - Method in class com.opensymphony.module.sitemesh.filter.PageResponseWrapper

Prevent content-length being set if page is parseable.

setId(String) - Method in class com.opensymphony.module.sitemesh.taglib.decorator.DivTag

setId(String) - Method in class com.opensymphony.module.sitemesh.taglib.decorator.UsePageTag

Set name of variable the Page will be set as.

setId(String) - Method in class com.opensymphony.module.sitemesh.taglib.page.ApplyDecoratorTag

Tag attribute: If set, this value will override the 'id' property of the page.

setIntHeader(String, int) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

setLength(int) - Method in class com.opensymphony.module.sitemesh.DefaultSitemeshBuffer.Builder

Sets the length.

setLength(int) - Method in class com.opensymphony.module.sitemesh.html.util.CharArray

Changes the size of the character array to the value specified.

setLength(int) - Method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment.Builder

Sets the length.

setLocale(Locale) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

setName(String) - Method in class com.opensymphony.module.sitemesh.html.CustomTag

Change the name of the attribute.

setName(String) - Method in class com.opensymphony.module.sitemesh.taglib.page.ApplyDecoratorTag

Tag attribute: Name of Decorator to apply to Page.

setName(String) - Method in class com.opensymphony.module.sitemesh.taglib.page.ParamTag

Sets the name.

setPage(String) - Method in class com.opensymphony.module.sitemesh.taglib.page.ApplyDecoratorTag

Tag attribute: URI of page to include.

setPageContext(PageContext) - Method in class com.opensymphony.module.sitemesh.taglib.AbstractTag

setParent(Tag) - Method in class com.opensymphony.module.sitemesh.taglib.AbstractTag

setProperty(String) - Method in class com.opensymphony.module.sitemesh.taglib.decorator.PropertyTag

Key of property to write.

setRequest(HttpServletRequest) - Method in interface com.opensymphony.module.sitemesh.Page

Create snapshot of Request.

setRequest(HttpServletRequest) - Method in class com.opensymphony.module.sitemesh.parser.AbstractPage

Create snapshot of Request.

setRequest(HttpServletRequest) - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

Create snapshot of Request.

setStart(int) - Method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment.Builder

Sets the start.

setStatus(int) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

setStatus(int) - Method in class com.opensymphony.module.sitemesh.filter.PageResponseWrapper

If 'not modified' (304) HTTP status is being sent - then abort parsing, as there shouldn't be any body

setStatus(int, String) - Method in class com.opensymphony.module.sitemesh.filter.DebugResponseWrapper

setSubstr(int, int) - Method in class com.opensymphony.module.sitemesh.html.util.CharArray

Allows an arbitrary substring of this character array to be specified.

setTitle(String) - Method in class com.opensymphony.module.sitemesh.taglib.page.ApplyDecoratorTag

Tag attribute: If set, this value will override the 'title' property of the page.

setType(int) - Method in class com.opensymphony.module.sitemesh.html.CustomTag

Change the type of the tag.

setUsingStream(boolean) - Method in class com.opensymphony.sitemesh.webapp.SiteMeshWebAppContext

Sets the using stream.

setWriteEntireProperty(String) - Method in class com.opensymphony.module.sitemesh.taglib.decorator.PropertyTag

When begins with y, t or 1, the full attribute (name + value) is written.

setWriteListener(WriteListener) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

shouldAutoCreateSession() - Method in class com.opensymphony.sitemesh.webapp.ContainerTweaks

Should auto create session.

shouldIgnoreIllegalStateExceptionOnErrorPage() - Method in class com.opensymphony.sitemesh.webapp.ContainerTweaks

Should ignore illegal state exception on error page.

shouldLogUnhandledExceptions() - Method in class com.opensymphony.sitemesh.webapp.ContainerTweaks

Should log unhandled exceptions.

shouldParsePage(String) - Method in class com.opensymphony.module.sitemesh.factory.BaseFactory

Determine whether a Page of given content-type should be parsed or not.

shouldParsePage(String) - Method in interface com.opensymphony.module.sitemesh.PageParserSelector

Determine whether a Page of given content-type should be parsed or not.

shouldProcess(String) - Method in class com.opensymphony.module.sitemesh.html.BasicRule

shouldProcess(String) - Method in class com.opensymphony.module.sitemesh.html.rules.MSOfficeDocumentPropertiesRule

shouldProcess(String) - Method in interface com.opensymphony.module.sitemesh.html.TagRule

Called by the HTMLProcessor to determine if a rule should be called for a given tag.

shouldProcessTag(String) - Method in class com.opensymphony.module.sitemesh.html.State

Should process tag.

shouldProcessTag(String) - Method in interface com.opensymphony.module.sitemesh.html.tokenizer.TokenHandler

Before attempting to parse a tag, the tokenizer will ask the handler whether the tag should be processed - avoiding additional tag parsing makes the tokenizer quicker.

SiteMeshBase - Class in com.opensymphony.module.sitemesh.tapestry

Base class for Tapestry decorator components.

SiteMeshBase() - Constructor for class com.opensymphony.module.sitemesh.tapestry.SiteMeshBase

SitemeshBuffer - Interface in com.opensymphony.module.sitemesh

A potentially chained sitemesh buffer.

SitemeshBufferFragment - Class in com.opensymphony.module.sitemesh

A fragment of a sitemesh buffer.

SitemeshBufferFragment(SitemeshBuffer, int, int) - Constructor for class com.opensymphony.module.sitemesh.SitemeshBufferFragment

Instantiates a new sitemesh buffer fragment.

SitemeshBufferFragment(SitemeshBuffer, int, int, TreeMap<Integer, Integer>) - Constructor for class com.opensymphony.module.sitemesh.SitemeshBufferFragment

Create a sitemesh buffer fragment.

SitemeshBufferFragment.Builder - Class in com.opensymphony.module.sitemesh

A builder for fragments.

SitemeshBufferWriter - Class in com.opensymphony.module.sitemesh

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.

SitemeshBufferWriter() - Constructor for class com.opensymphony.module.sitemesh.SitemeshBufferWriter

Instantiates a new sitemesh buffer writer.

SitemeshBufferWriter(int) - Constructor for class com.opensymphony.module.sitemesh.SitemeshBufferWriter

Instantiates a new sitemesh buffer writer.

SiteMeshContext - Interface in com.opensymphony.sitemesh

The Interface SiteMeshContext.

SiteMeshFilter - Class in com.opensymphony.sitemesh.webapp

Core Filter for integrating SiteMesh into a Java web application.

SiteMeshFilter() - Constructor for class com.opensymphony.sitemesh.webapp.SiteMeshFilter

SitemeshPrintWriter - Class in com.opensymphony.module.sitemesh.filter

A sitemesh print writer.

SitemeshPrintWriter(SitemeshBufferWriter) - Constructor for class com.opensymphony.module.sitemesh.filter.SitemeshPrintWriter

Instantiates a new sitemesh print writer.

SiteMeshWebAppContext - Class in com.opensymphony.sitemesh.webapp

The Class SiteMeshWebAppContext.

SiteMeshWebAppContext(HttpServletRequest, HttpServletResponse, ServletContext) - Constructor for class com.opensymphony.sitemesh.webapp.SiteMeshWebAppContext

Instantiates a new site mesh web app context.

SitemeshWriter - Interface in com.opensymphony.module.sitemesh

A sitemesh buffer writer.

size() - Method in class com.opensymphony.module.sitemesh.util.CharArrayWriter

Returns the current size of the buffer.

size() - Method in class com.opensymphony.module.sitemesh.util.FastByteArrayOutputStream

skip(long) - Method in class com.opensymphony.module.sitemesh.util.CharArrayReader

Skip characters.

SLASH - Static variable in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

The Constant SLASH.

start() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

Start.

start(Tag) - Method in class com.opensymphony.module.sitemesh.html.BlockExtractingRule

Start.

start(Tag) - Method in class com.opensymphony.module.sitemesh.html.rules.ContentBlockExtractingRule

start(Tag) - Method in class com.opensymphony.module.sitemesh.html.rules.MSOfficeDocumentPropertiesRule

start(TokenHandler) - Method in class com.opensymphony.module.sitemesh.html.tokenizer.TagTokenizer

Start.

State - Class in com.opensymphony.module.sitemesh.html

The Class State.

State() - Constructor for class com.opensymphony.module.sitemesh.html.State

StateChangeListener - Interface in com.opensymphony.module.sitemesh.html

The listener interface for receiving stateChange events.

stateFinished() - Method in interface com.opensymphony.module.sitemesh.html.StateChangeListener

State finished.

StateTransitionRule - Class in com.opensymphony.module.sitemesh.html

The Class StateTransitionRule.

StateTransitionRule(String, State) - Constructor for class com.opensymphony.module.sitemesh.html.StateTransitionRule

Instantiates a new state transition rule.

StateTransitionRule(String, State, boolean) - Constructor for class com.opensymphony.module.sitemesh.html.StateTransitionRule

Instantiates a new state transition rule.

StringSitemeshBuffer - Class in com.opensymphony.module.sitemesh.html.util

SitemeshBuffer that is a string.

StringSitemeshBuffer(String) - Constructor for class com.opensymphony.module.sitemesh.html.util.StringSitemeshBuffer

Instantiates a new string sitemesh buffer.

substrHashCode() - Method in class com.opensymphony.module.sitemesh.html.util.CharArray

Returns the hashcode for a lowercase version of the array's substring (as set by the CharArray.setSubstr(int, int) method).

substring(int, int) - Method in class com.opensymphony.module.sitemesh.html.util.CharArray

Returns a substring from within this character array.

SuperFastSimplePageParser - Class in com.opensymphony.module.sitemesh.parser

Deprecated.

Renamed to PartialPageParser

SuperFastSimplePageParser() - Constructor for class com.opensymphony.module.sitemesh.parser.SuperFastSimplePageParser

Deprecated.

T

tag(Tag) - Method in interface com.opensymphony.module.sitemesh.html.tokenizer.TokenHandler

Called when tokenizer encounters an HTML tag (open, close or empty).

Tag - Interface in com.opensymphony.module.sitemesh.html

Tag returned by HTMLTagTokenizer.

TagReplaceRule - Class in com.opensymphony.module.sitemesh.html.rules

Very simple rule for replacing all occurences of one tag with another.

TagReplaceRule(String, String) - Constructor for class com.opensymphony.module.sitemesh.html.rules.TagReplaceRule

Instantiates a new tag replace rule.

TagRule - Interface in com.opensymphony.module.sitemesh.html

The Interface TagRule.

TagTokenizer - Class in com.opensymphony.module.sitemesh.html.tokenizer

Splits a chunk of HTML into 'text' and 'tag' tokens, for easy processing.

TagTokenizer(char[]) - Constructor for class com.opensymphony.module.sitemesh.html.tokenizer.TagTokenizer

Instantiates a new tag tokenizer.

TagTokenizer(char[], int) - Constructor for class com.opensymphony.module.sitemesh.html.tokenizer.TagTokenizer

Instantiates a new tag tokenizer.

TagTokenizer(String) - Constructor for class com.opensymphony.module.sitemesh.html.tokenizer.TagTokenizer

Instantiates a new tag tokenizer.

text(Text) - Method in interface com.opensymphony.module.sitemesh.html.tokenizer.TokenHandler

Called when tokenizer encounters anything other than a well-formed HTML tag.

Text - Interface in com.opensymphony.module.sitemesh.html

Text returned by HTMLTagTokenizer.

TEXT - Static variable in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

The Constant TEXT.

TextEncoder - Class in com.opensymphony.module.sitemesh.filter

Converts text stored in byte[] to char[] using specified encoding.

TextEncoder() - Constructor for class com.opensymphony.module.sitemesh.filter.TextEncoder

TextFilter - Interface in com.opensymphony.module.sitemesh.html

TextFilters can be added to the HTMLProcessor (or specific States) and allow a simple means of filtering text content.

Title - Class in com.opensymphony.module.sitemesh.tapestry

The Class Title.

Title() - Constructor for class com.opensymphony.module.sitemesh.tapestry.Title

TitleExtractingRule - Class in com.opensymphony.module.sitemesh.html.rules

The Class TitleExtractingRule.

TitleExtractingRule(PageBuilder) - Constructor for class com.opensymphony.module.sitemesh.html.rules.TitleExtractingRule

Instantiates a new title extracting rule.

TitleTag - Class in com.opensymphony.module.sitemesh.taglib.decorator

Write the Page <title> value to out.

TitleTag() - Constructor for class com.opensymphony.module.sitemesh.taglib.decorator.TitleTag

toByteArray() - Method in class com.opensymphony.module.sitemesh.util.FastByteArrayOutputStream

toCharArray() - Method in class com.opensymphony.module.sitemesh.util.CharArrayWriter

Returns a copy of the input data.

TokenHandler - Interface in com.opensymphony.module.sitemesh.html.tokenizer

Handler passed to TagTokenizer that will receive callbacks as 'tags' and 'text' are encountered.

TokenizedHTMLPage - Class in com.opensymphony.module.sitemesh.parser

HTMLPage implementation that builds itself based on the incoming 'tag' and 'text' tokens fed to it from the HTMLTagTokenizer.

TokenizedHTMLPage(SitemeshBuffer) - Constructor for class com.opensymphony.module.sitemesh.parser.TokenizedHTMLPage

Instantiates a new tokenized HTML page.

TOMCAT - Static variable in class com.opensymphony.module.sitemesh.util.Container

The Constant TOMCAT.

toString() - Method in class com.opensymphony.module.sitemesh.html.CustomTag

toString() - Method in class com.opensymphony.module.sitemesh.html.util.CharArray

Returns a String represenation of the character array.

toString() - Method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment

toString() - Method in class com.opensymphony.module.sitemesh.util.CharArrayWriter

Converts input data to a string.

toString() - Method in class com.opensymphony.module.sitemesh.util.FastByteArrayOutputStream

toString(String) - Method in class com.opensymphony.module.sitemesh.util.FastByteArrayOutputStream

trace(Exception) - Static method in class com.opensymphony.module.sitemesh.taglib.AbstractTag

Log exception generated by taglib.

U

UNKNOWN - Static variable in class com.opensymphony.module.sitemesh.util.Container

The Constant UNKNOWN.

updateDestination(RoutablePrintWriter.DestinationFactory) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

Update destination.

updateDestination(RoutableServletOutputStream.DestinationFactory) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

Update destination.

uriPath - Variable in class com.opensymphony.module.sitemesh.mapper.DefaultDecorator

The uri path.

Usage - Search tag in class com.opensymphony.module.sitemesh.html.tokenizer.TagTokenizer

Section

Usage: - Search tag in class com.opensymphony.module.sitemesh.util.Container

Section

UseHTMLPageTEI - Class in com.opensymphony.module.sitemesh.taglib.decorator

TagExtraInfo implementation to expose HTMLPage object as variable.

UseHTMLPageTEI() - Constructor for class com.opensymphony.module.sitemesh.taglib.decorator.UseHTMLPageTEI

UsePageTag - Class in com.opensymphony.module.sitemesh.taglib.decorator

Expose the Page as a bean to the page which can then be accessed from scriptlets.

UsePageTag() - Constructor for class com.opensymphony.module.sitemesh.taglib.decorator.UsePageTag

UsePageTEI - Class in com.opensymphony.module.sitemesh.taglib.decorator

TagExtraInfo implementation to expose Page object as variable.

UsePageTEI() - Constructor for class com.opensymphony.module.sitemesh.taglib.decorator.UsePageTEI

Util - Class in com.opensymphony.module.sitemesh.tapestry

This utility class gives easy access to the SiteMesh page, with convenience methods for title and property.

V

VelocityDecoratorServlet - Class in com.opensymphony.module.sitemesh.velocity

Servlet that allows Velocity templates to be used as decorators.

VelocityDecoratorServlet() - Constructor for class com.opensymphony.module.sitemesh.velocity.VelocityDecoratorServlet

W

warning(String, int, int) - Method in interface com.opensymphony.module.sitemesh.html.tokenizer.TokenHandler

Called when tokenizer encounters something it cannot correctly parse.

WEBLOGIC - Static variable in class com.opensymphony.module.sitemesh.util.Container

The Constant WEBLOGIC.

WEBSPHERE - Static variable in class com.opensymphony.module.sitemesh.util.Container

The Constant WEBSPHERE.

WHITESPACE - Static variable in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

The Constant WHITESPACE.

WORD - Static variable in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

The Constant WORD.

WORK_AROUND_RESIN_I18N_BUG - Static variable in class com.opensymphony.module.sitemesh.util.OutputConverter

Resin versions 2.1.12 and previously have encoding problems for internationalization.

write(byte[]) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

write(byte[], int, int) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

write(byte[], int, int) - Method in class com.opensymphony.module.sitemesh.util.FastByteArrayOutputStream

write(char[]) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

write(char[], int, int) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

write(char[], int, int) - Method in class com.opensymphony.module.sitemesh.util.CharArrayWriter

Writes characters to the buffer.

write(int) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

write(int) - Method in class com.opensymphony.module.sitemesh.filter.RoutableServletOutputStream

write(int) - Method in class com.opensymphony.module.sitemesh.util.CharArrayWriter

Writes a character to the buffer.

write(int) - Method in class com.opensymphony.module.sitemesh.util.FastByteArrayOutputStream

write(String) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

write(String, int, int) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

write(String, int, int) - Method in class com.opensymphony.module.sitemesh.util.CharArrayWriter

Write a portion of a string to the buffer.

writeBody(Writer) - Method in interface com.opensymphony.module.sitemesh.Page

Write the contents of the <body> tag.

writeBody(Writer) - Method in class com.opensymphony.module.sitemesh.parser.AbstractPage

Write data of html <body> tag.

writeBody(Writer) - Method in class com.opensymphony.module.sitemesh.parser.FastPage

writeBody(Writer) - Method in class com.opensymphony.module.sitemesh.parser.PartialPageParserPage

writeBody(Writer) - Method in class com.opensymphony.module.sitemesh.parser.TokenizedHTMLPage

writeBody(Writer) - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

writeBody(Writer) - Method in class com.opensymphony.sitemesh.compatability.HTMLPage2Content

writeBody(Writer) - Method in interface com.opensymphony.sitemesh.Content

Write the contents of the <body> tag.

writeDecorator(HttpServletResponse, Page, RequestDispatcher, HttpServletRequest) - Method in class com.opensymphony.module.sitemesh.multipass.MultipassFilter

Write decorator.

writeHead(Writer) - Method in interface com.opensymphony.module.sitemesh.HTMLPage

Write the contents of the <head> tag.

writeHead(Writer) - Method in class com.opensymphony.module.sitemesh.parser.AbstractHTMLPage

Write data of html <head> tag.

writeHead(Writer) - Method in class com.opensymphony.module.sitemesh.parser.FastPage

writeHead(Writer) - Method in class com.opensymphony.module.sitemesh.parser.PartialPageParserHtmlPage

writeHead(Writer) - Method in class com.opensymphony.module.sitemesh.parser.TokenizedHTMLPage

writeHead(Writer) - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

writeHead(Writer) - Method in class com.opensymphony.sitemesh.compatability.HTMLPage2Content

writeHead(Writer) - Method in interface com.opensymphony.sitemesh.Content

Write the contents of the <head> tag.

writeOriginal(Writer) - Method in class com.opensymphony.sitemesh.compatability.HTMLPage2Content

writeOriginal(Writer) - Method in interface com.opensymphony.sitemesh.Content

Write out the original unprocessed content.

writePage(Writer) - Method in interface com.opensymphony.module.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.opensymphony.module.sitemesh.parser.AbstractPage

writePage(Writer) - Method in class com.opensymphony.sitemesh.compatability.Content2HTMLPage

writeSitemeshBufferFragment(SitemeshBufferFragment) - Method in class com.opensymphony.module.sitemesh.filter.RoutablePrintWriter

writeSitemeshBufferFragment(SitemeshBufferFragment) - Method in class com.opensymphony.module.sitemesh.filter.SitemeshPrintWriter

writeSitemeshBufferFragment(SitemeshBufferFragment) - Method in class com.opensymphony.module.sitemesh.SitemeshBufferWriter

writeSitemeshBufferFragment(SitemeshBufferFragment) - Method in interface com.opensymphony.module.sitemesh.SitemeshWriter

Write a sitemesh buffer fragment to the writer.

writeTo(SitemeshBufferFragment.Builder, int) - Method in class com.opensymphony.module.sitemesh.html.CustomTag

writeTo(SitemeshBufferFragment.Builder, int) - Method in interface com.opensymphony.module.sitemesh.html.Tag

Write out the complete tag in its original form, preserving original formatting.

writeTo(SitemeshBufferFragment.Builder, int) - Method in interface com.opensymphony.module.sitemesh.html.Text

Write out the complete contents of the text block, preserving original formatting.

writeTo(SitemeshBufferFragment.Builder, int) - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser.ReusableToken

writeTo(OutputStream) - Method in class com.opensymphony.module.sitemesh.util.FastByteArrayOutputStream

writeTo(PrintWriter) - Method in class com.opensymphony.module.sitemesh.html.util.CharArray

Write to.

writeTo(Writer) - Method in class com.opensymphony.module.sitemesh.SitemeshBufferFragment

Write the fragment to the given writer.

writeTo(Writer) - Method in class com.opensymphony.module.sitemesh.util.CharArrayWriter

Writes the contents of the buffer to another character stream.

writeTo(Writer, int, int) - Method in class com.opensymphony.module.sitemesh.DefaultSitemeshBuffer

writeTo(Writer, int, int) - Method in class com.opensymphony.module.sitemesh.html.util.StringSitemeshBuffer

writeTo(Writer, int, int) - Method in interface com.opensymphony.module.sitemesh.SitemeshBuffer

Write this buffer, and any chained sub buffers in the given range, out to the given writer.

Y

yyatEOF() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

Returns whether the scanner has reached the end of the reader it reads from.

yybegin(int) - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

Enters a new lexical state.

yycharat(int) - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

Returns the character at the given position from the matched text.

yyclose() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

Closes the input reader.

YYEOF - Static variable in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

This character denotes the end of file.

YYINITIAL - Static variable in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

yylength() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

How many characters were matched.

yylex() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

Resumes scanning until the next regular expression is matched, the end of input is encountered or an I/O-Error occurs.

yypushback(int) - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

Pushes the specified amount of characters back into the input stream.

yyreset(Reader) - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

Resets the scanner to read from a new input stream.

yystate() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

Returns the current lexical state.

yytext() - Method in class com.opensymphony.module.sitemesh.html.tokenizer.Parser

Returns the text matched by the current regular expression.

A B C D E F G H I J L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form