Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep
Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> com >> [ sitemesh overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of com.sitemesh.HTMLPage JAVADOC | Sourc code of com.sitemesh.HTMLPage SOURCE | Download com.sitemesh.HTMLPage DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.sitemesh
Interface HTMLPage  view HTMLPage download HTMLPage.java

All Superinterfaces:
Page
public interface HTMLPage
extends Page

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.

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

Version:
$Revision: 1.7 $

Method Summary
 java.lang.String getDecoratorName()
          Get the name of the template suitable for the HTMLPage.
 java.lang.String getTitle()
          Get the Title of the document
 void writeBody(java.io.OutputStream out)
          Write the contents of the <body> tag.
 void writeBody(java.io.Writer out)
          Write the contents of the <body> tag.
 void writeHead(java.io.OutputStream out)
          Write the contents of the <head> tag.
 void writeHead(java.io.Writer out)
          Write the contents of the <head> tag.
 
Methods inherited from interface com.sitemesh.Page
getBooleanProperty, getContentLength, getIntProperty, getLongProperty, getProperties, getProperty, getPropertyKeys, getPropertySize, getRequest, isPropertySet, setRequest, shouldCache, writePage, writePage
 

Method Detail

writeHead

public void writeHead(java.io.OutputStream out)
               throws java.io.IOException
Write the contents of the <head> tag.

writeHead

public void writeHead(java.io.Writer out)
               throws java.io.IOException
Write the contents of the <head> tag.

writeBody

public void writeBody(java.io.OutputStream out)
               throws java.io.IOException
Write the contents of the <body> tag.

writeBody

public void writeBody(java.io.Writer out)
               throws java.io.IOException
Write the contents of the <body> tag.

getTitle

public java.lang.String getTitle()
Get the Title of the document

getDecoratorName

public java.lang.String getDecoratorName()
Get the name of the template suitable for the HTMLPage.

Overview  Package   Class  Use  Deprecated  Index 
Home >> All >> com >> [ sitemesh overview ]  PREV CLASS  NEXT CLASS
SUMMARY: JavaDoc of com.sitemesh.HTMLPage JAVADOC | Sourc code of com.sitemesh.HTMLPage SOURCE | Download com.sitemesh.HTMLPage DOWNLOAD | NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD