|
|||||||||
| Home >> All >> com >> opensymphony >> module >> [ sitemesh overview ] | PREV NEXT | ||||||||
A
- addProperty(String, String) - Method in interface com.opensymphony.module.sitemesh.Page
- Manually add a property to page.
C
- Config - class com.opensymphony.module.sitemesh.Config.
- Common interface to ServletConfig and FilterConfig (since javax.servlet.Config was removed from 2.3 spec).
- Config(ServletConfig) - Constructor for class com.opensymphony.module.sitemesh.Config
- Config(FilterConfig) - Constructor for class com.opensymphony.module.sitemesh.Config
- com.opensymphony.module.sitemesh - package com.opensymphony.module.sitemesh
D
- DECORATOR - Static variable in interface com.opensymphony.module.sitemesh.RequestConstants
- The name (String) of the Decorator to suggest using.
- Decorator - interface com.opensymphony.module.sitemesh.Decorator.
- Representation of a Decorator.
- DecoratorMapper - interface com.opensymphony.module.sitemesh.DecoratorMapper.
- The DecoratorMapper is responsible for determining which Decorator should be used for a Page.
F
- FILTER_APPLIED - Static variable in interface com.opensymphony.module.sitemesh.RequestConstants
- Marker that stores a Boolean to state whether the decorator filter has been applied yet to this request.
- Factory - class com.opensymphony.module.sitemesh.Factory.
- Factory responsible for creating appropriate instances of implementations.
- Factory() - Constructor for class com.opensymphony.module.sitemesh.Factory
- filterConfig - Variable in class com.opensymphony.module.sitemesh.Config
G
- getBody() - Method in interface com.opensymphony.module.sitemesh.Page
- Convenience method to return the contents of the
<body>tag. - getBooleanProperty(String) - Method in interface com.opensymphony.module.sitemesh.Page
- Get a property embedded into the
Pageas aboolean. - getContentLength() - Method in interface com.opensymphony.module.sitemesh.Page
- Length of the
Page, in the format before it was parsed. - getDecorator(HttpServletRequest, Page) - Method in interface com.opensymphony.module.sitemesh.DecoratorMapper
- Return appropriate Decorator for a certain Page.
- getDecoratorMapper() - Method in class com.opensymphony.module.sitemesh.Factory
- Return instance of DecoratorMapper.
- getEnvEntry(String, String) - Static method in class com.opensymphony.module.sitemesh.Factory
- Find String environment entry, or return default if not found.
- getHead() - Method in interface com.opensymphony.module.sitemesh.HTMLPage
- Convenience method to return the contents of the
<head>tag as a String. - 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.
- 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.
- 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
Pageas anint. - getLongProperty(String) - Method in interface com.opensymphony.module.sitemesh.Page
- Get a property embedded into the
Pageas along. - getName() - Method in interface com.opensymphony.module.sitemesh.Decorator
- Name of the Decorator.
- getNamedDecorator(HttpServletRequest, String) - Method in interface com.opensymphony.module.sitemesh.DecoratorMapper
- Return a Decorator with given name.
- 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 interface com.opensymphony.module.sitemesh.Page
- Convenience method to return the contents of the
Pagein its original format. - getPageParser(String) - Method in class com.opensymphony.module.sitemesh.Factory
- Create a PageParser suitable for the given content-type.
- getProperties() - Method in interface com.opensymphony.module.sitemesh.Page
- Get a
Maprepresenting all the properties in thePage. - getProperty(String) - Method in interface com.opensymphony.module.sitemesh.Page
- Get a property embedded into the
Pageas aString. - getPropertyKeys() - Method in interface com.opensymphony.module.sitemesh.Page
- Get all available property keys for the
Page. - getRequest() - Method in interface com.opensymphony.module.sitemesh.Page
- Return the request of the original page.
- getRole() - Method in interface com.opensymphony.module.sitemesh.Decorator
- Role the user has to be in to get this decorator applied.
- getServletContext() - Method in class com.opensymphony.module.sitemesh.Config
- getTitle() - Method in interface com.opensymphony.module.sitemesh.Page
- Get the Title of the document
- getURIPath() - Method in interface com.opensymphony.module.sitemesh.Decorator
- URI path of the Decorator.
H
- HTMLPage - interface com.opensymphony.module.sitemesh.HTMLPage.
- Extension of Page providing access to HTML data.
I
- init(Config, Properties, DecoratorMapper) - Method in interface com.opensymphony.module.sitemesh.DecoratorMapper
- Initialize the mapper.
- isFrameSet() - Method in interface com.opensymphony.module.sitemesh.HTMLPage
- Check to see if this page contains an HTML frameset.
- 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
Pagehas been set.
P
- PAGE - Static variable in interface com.opensymphony.module.sitemesh.RequestConstants
- Stores Page instance for parsed page to be passed across to Decorator.
- Page - interface com.opensymphony.module.sitemesh.Page.
- The Page object wraps the contents of the original (undecorated) page.
- PageParser - interface com.opensymphony.module.sitemesh.PageParser.
- The PageParser is responsible for parsing the page data into an appropriate Page object.
- parse(char[]) - Method in interface com.opensymphony.module.sitemesh.PageParser
- This builds a Page.
R
- 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.
- RequestConstants - interface com.opensymphony.module.sitemesh.RequestConstants.
- A set of static constants of Strings to be used as ServletRequest attribute keys to represent various objects passed between pages.
- report(String, Exception) - Static method in class com.opensymphony.module.sitemesh.Factory
- Report a problem.
S
- SITEMESH_FACTORY - Static variable in class com.opensymphony.module.sitemesh.Factory
- Web context lookup key
- servletConfig - Variable in class com.opensymphony.module.sitemesh.Config
- setFrameSet(boolean) - Method in interface com.opensymphony.module.sitemesh.HTMLPage
- Marks this page as a frameset.
- setRequest(HttpServletRequest) - Method in interface com.opensymphony.module.sitemesh.Page
- Create snapshot of Request.
- shouldParsePage(String) - Method in class com.opensymphony.module.sitemesh.Factory
- Determine whether a Page of given content-type should be parsed or not.
U
- USING_STREAM - Static variable in interface com.opensymphony.module.sitemesh.RequestConstants
- Whether the current request should use a binary stream (as opposed to writer).
W
- writeBody(Writer) - Method in interface com.opensymphony.module.sitemesh.Page
- Write the contents of the
<body>tag. - writeHead(Writer) - Method in interface com.opensymphony.module.sitemesh.HTMLPage
- Write the contents of the
<head>tag. - 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 theWriter.
A C D F G H I P R S U W
|
|||||||||
| Home >> All >> com >> opensymphony >> module >> [ sitemesh overview ] | PREV NEXT | ||||||||