| Home >> All >> com >> [ sitemesh Javadoc ] |
| • | com.sitemesh.filter.* (3) | • | com.sitemesh.mapper.* (2) | • | com.sitemesh.parser.* (6) |
| • | com.sitemesh.taglib.* (9) | • | com.sitemesh.taglib.decorator.* (7) | • | com.sitemesh.taglib.page.* (1) |
• com.sitemesh: Javadoc index of package com.sitemesh.
Package Samples:
• com.sitemesh.filter
• com.sitemesh.mapper
• com.sitemesh.parser
• com.sitemesh.taglib
• com.sitemesh.taglib.decorator
• com.sitemesh.taglib.page
Classes:
• HTMLPage: Extention of Page providing access to HTML data. The page is parsed and the <title> , <head> (minus the <title> ) and <body> are split into chunks. These can then be used by a Decorator . Properties are also extracted from the HTML. Page Properties When the page is parsed, values from certain tags are added to the properties to allow easy access to them. The following tags have properties extracted from them. HTML Tag All attributes of the <html> tag shall be added as properties. Title Tag The contents of the <title> tag shall be added as the title property. ...
• Page: The Page object wraps the contents of the original (undecorated) page. The original data in its entirity can be written using the writePage() methods. It may also contain a set of properties - these vary among different PageParser implementations. Typically a Page is no use to a Decorator as it needs specific details relevant to the content-type of that page ( e.g. HTML pages). The appropriate PageParser is responsible for returning extended implementations of pages such as HTMLPage which are of more use to the Decorator. New media types ( e.g. WML) could be added to the system by extending Page ...
• AbstractPage: Abstract implementation of com.sitemesh.Page . Contains base methods for storing and accessing page properties. Also stores pageData 55 as byte[] and implements write???() methods. Concrete implementations need only set the pageData 55 and call addProperty(java.lang.String,java.lang.String) 55 to add all the required information.
• PageParser: The PageParser is responsible for parsing the page data into an appropriate Page object. The implementation of this can be switched to parse different kind of data ( e.g. HTML, WML, FOP, images) or for performance enhancements. An implementation is obtained through the Factory . Methods are provided to parse data from a variety of input sources.
• PageResponse: Implementation of HttpServletResponse that captures page data instead of sending to output stream. Should be used in filter-chains or when forwarding/including pages using a RequestDispatcher. In order to capture the response, getOutputStream() 55 returns an instance of PageOutputStream .
• PanelTag: This tag inserts an external resource as a panel into the current Page. The page attribute is required and points to the panel resource which should expose an entire page (e.g. another JSP file producing HTML). This attribute can be relative to the page it is being called from or an absolute path from the context-root. The (optional) decorator attribute is the name of the Decorator to apply to the included page. Note that the implementation of DecoratorMapper can overide this.
• DecoratorMapper: The DecoratorMapper is resposible for determining which Decorator should be used for a Page . Implementations of this are returned by Factory . All implementations of this should be thread safe.
• DOMPageParser: Implementation of com.sitemesh.PageParser that builds up a com.sitemesh.HTMLPage using DOM. This implementation uses OpenXML 1.2 as it is capable of parsing (and beform basic clean-up operations) on HTML.
• AbstractHTMLPage: Abstract implementation of com.sitemesh.HTMLPage . Adds to AbstractPage some HTML methods. To implement, follow guidelines of super-class, and implement the 2 abstract methods states below.
• Decorator: Representation of a Decorator. A Decorator is infact a Servlet/JSP, and this is a wrapper to reference it. An implementation is returned by the DecoratorMapper .
• PageOutputStream: Implementation of ServletOutputStream that stores all data written to it in a temporary buffer accessible from getBytes() 55 .
• AbstractPageParser: Abstract implementation of com.sitemesh.PageParser . All methods convert input into byte[] , meaning only that method need be implemented.
• UnParsedPage: A page that is of unrecognised content-type, or cannot be parsed into a specific type of Page. The original page is contained within, but no meta-data or parsed chunks.
• Factory: Factory responsible for creating appropriate instances of implementations. This is a singleton and is obtained through #getInstance(javax.servlet.Config) .
• UsePageTag: Expose the Page as a bean to the page which can then be accessed from scriptlets. Depending on the TEI used, the object will be Page or HTMLPage.
• RequestConstants: This is a set of static constants of Strings to be used as ServletRequest attribute keys to represent various objects passed between pages.
• DOMPage: Implementation of com.sitemesh.HTMLPage that populates itself from a parsed DOM document.
• DefaultDecoratorMapper: Default implementation of DecoratorMapper. Reads decorators and mappings from /WEB-INF/decorators.xml .
• AbstractTag: Convenience implementation of Tag containing generice methods required by all (or most) taglibs.
• DefaultDecorator: Default implementation of Decorator. All properties are set by the constructor.
• UseHTMLPageTEI: TagExtraInfo implementation to expose HTMLPage object as variable.
• UsePageTEI: TagExtraInfo implementation to expose Page object as variable.
• PageFilter: Main SiteMesh filter for applying Decorators to entire Pages.
• TitleTag: Write the HTMLPage <title> value to out.
• BodyTag: Write original HTMLPage body to out.
| Home | Contact Us | Privacy Policy | Terms of Service |