Home » sitemesh-2.4.1 » com.opensymphony.module » sitemesh » [javadoc | source]
com.opensymphony.module.sitemesh
public interface: HTMLPage [javadoc | source]

All Implemented Interfaces:
    Page

All Known Implementing Classes:
    AbstractHTMLPage, TokenizedHTMLPage, FastPage, Content2HTMLPage

Extension of com.opensymphony.module.sitemesh.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 com.opensymphony.module.sitemesh.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.

Example

  
    <html template="funky">
      <head>
        <title>My Funky Page</title>
        <meta name="description" content="Description of my page.">
        <meta name="author" content="Bob">
        ...
      </head>
      <body text="#ff00ff" bgcolor="green">
        ...
      </body>
    </html>
  
template=funky
title=My Funky Page
meta.description=Description of my page.
meta.author=Bob
body.text=#ff00ff
body.bgcolor=green
Method from com.opensymphony.module.sitemesh.HTMLPage Summary:
getHead,   isFrameSet,   setFrameSet,   writeHead
Method from com.opensymphony.module.sitemesh.HTMLPage Detail:
 public String getHead()
    Convenience method to return the contents of the <head> tag as a String.
 public boolean isFrameSet()
 public  void setFrameSet(boolean frameset)
    Marks this page as a frameset.
 public  void writeHead(Writer out) throws IOException
    Write the contents of the <head> tag.