java.lang.Object

com.opensymphony.module.sitemesh.parser.AbstractPage

com.opensymphony.module.sitemesh.parser.PartialPageParserHtmlPage

All Implemented Interfaces:: HTMLPage, Page

public class PartialPageParserHtmlPage extends AbstractPage implements HTMLPage

Constructor Summary

Constructors

Constructor

Description

PartialPageParserHtmlPage(SitemeshBuffer sitemeshBuffer)

PartialPageParserHtmlPage(SitemeshBuffer sitemeshBuffer, SitemeshBufferFragment body, Map<String,String> bodyProperties)

PartialPageParserHtmlPage(SitemeshBuffer sitemeshBuffer, SitemeshBufferFragment body, Map<String,String> bodyProperties, SitemeshBufferFragment head, String title, Map<String,String> metaAttributes, Map<String,String> pageProperties)
Method Summary

Modifier and Type

Method

Description

String

getBody()

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

String

getHead()

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

boolean

isFrameSet()

Check to see if this page contains an HTML frameset.

void

setFrameSet(boolean frameset)

Marks this page as a frameset.

void

writeBody(Writer out)

Write data of html <body> tag.

void

writeHead(Writer out)

Write the contents of the <head> tag.

void

writePage(Writer out)

Write the entire contents of the Page, in the format before it was parsed, to the Writer.

Methods inherited from class com.opensymphony.module.sitemesh.parser.AbstractPage
addProperty, getBooleanProperty, getIntProperty, getLongProperty, getPage, getProperties, getProperty, getPropertyKeys, getRequest, getTitle, isPropertySet, noNull, setRequest

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.opensymphony.module.sitemesh.Page
addProperty, getBooleanProperty, getIntProperty, getLongProperty, getPage, getProperties, getProperty, getPropertyKeys, getRequest, getTitle, isPropertySet, setRequest

Constructor Details
- PartialPageParserHtmlPage
  
  public PartialPageParserHtmlPage(SitemeshBuffer sitemeshBuffer)
- PartialPageParserHtmlPage
  
  public PartialPageParserHtmlPage(SitemeshBuffer sitemeshBuffer, SitemeshBufferFragment body, Map<String,String> bodyProperties)
- PartialPageParserHtmlPage
  
  public PartialPageParserHtmlPage(SitemeshBuffer sitemeshBuffer, SitemeshBufferFragment body, Map<String,String> bodyProperties, SitemeshBufferFragment head, String title, Map<String,String> metaAttributes, Map<String,String> pageProperties)
  
  Parameters:
  
  sitemeshBuffer - The buffer for the page
  
  body - The body fragment
  
  bodyProperties - The properties of the body
  
  head - The head section
  
  title - The title
  
  metaAttributes - The meta attributes found in the head section
  
  pageProperties - The page properties extracted from the head section
Method Details
- writeHead
  
  public void writeHead(Writer out) throws IOException
  
  Description copied from interface: HTMLPage
  
  Write the contents of the <head> tag.
  
  Specified by:
  
  writeHead in interface HTMLPage
  
  Throws:
  
  IOException
- getHead
  
  public String getHead()
  
  Description copied from interface: HTMLPage
  
  Convenience method to return the contents of the <head> tag as a String.
  Specified by:
  
  getHead in interface HTMLPage
  
  See Also:
  
  HTMLPage.writeHead(java.io.Writer)
- writeBody
  
  public void writeBody(Writer out) throws IOException
  
  Description copied from class: AbstractPage
  
  Write data of html <body> tag.
  Must be implemented. Data written should not actually contain the body tags, but all the data in between.
  
  Specified by:
  
  writeBody in interface Page
  
  Specified by:
  
  writeBody in class AbstractPage
  
  Throws:
  
  IOException
- getBody
  
  public String getBody()
  
  Description copied from interface: Page
  
  Convenience method to return the contents of the <body> tag.
  Specified by:
  
  getBody in interface Page
  
  Overrides:
  
  getBody in class AbstractPage
  
  See Also:
  
  Page.writeBody(java.io.Writer)
- writePage
  
  public void writePage(Writer out) throws IOException
  
  Description copied from interface: Page
  
  Write the entire contents of the Page, in the format before it was parsed, to the Writer.
  
  Specified by:
  
  writePage in interface Page
  
  Overrides:
  
  writePage in class AbstractPage
  
  Parameters:
  
  out - Writer to write to.
  
  Throws:
  
  IOException - Rethrown if cannot write to writer.
- isFrameSet
  
  public boolean isFrameSet()
  
  Description copied from interface: HTMLPage
  
  Check to see if this page contains an HTML frameset.
  
  Specified by:
  
  isFrameSet in interface HTMLPage
- setFrameSet
  
  public void setFrameSet(boolean frameset)
  
  Description copied from interface: HTMLPage
  
  Marks this page as a frameset.
  Specified by:
  
  setFrameSet in interface HTMLPage
  
  See Also:
  
  HTMLPage.isFrameSet()

Class PartialPageParserHtmlPage

Constructor Summary

Method Summary

Methods inherited from class com.opensymphony.module.sitemesh.parser.AbstractPage

Methods inherited from class java.lang.Object

Methods inherited from interface com.opensymphony.module.sitemesh.Page

Constructor Details

PartialPageParserHtmlPage

PartialPageParserHtmlPage

PartialPageParserHtmlPage

Method Details

writeHead

getHead

writeBody

getBody

writePage

isFrameSet

setFrameSet