Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.opensymphony.sitemesh.compatability
Class Content2HTMLPage

java.lang.Object
  extended by com.opensymphony.sitemesh.compatability.Content2HTMLPage
All Implemented Interfaces:
HTMLPage, Page
public class Content2HTMLPage
extends java.lang.Object
implements HTMLPage

Adapts a SiteMesh 3 Content to a SiteMesh 2 HTMLPage.

Since:
SiteMesh 3
Author:
Joe Walnes

Field Summary
private  Content content
           
private  javax.servlet.http.HttpServletRequest request
           
 
Constructor Summary
Content2HTMLPage(Content content)
           
Content2HTMLPage(Content content, javax.servlet.http.HttpServletRequest request)
           
 
Method Summary
 void addProperty(java.lang.String name, java.lang.String value)
          Manually add a property to page.
 java.lang.String getBody()
          Convenience method to return the contents of the <body> tag.
 boolean getBooleanProperty(java.lang.String name)
          Get a property embedded into the Page as a boolean.
 int getContentLength()
          Length of the Page, in the format before it was parsed.
 java.lang.String getHead()
          Convenience method to return the contents of the <head> tag as a String.
 int getIntProperty(java.lang.String name)
          Get a property embedded into the Page as an int.
 long getLongProperty(java.lang.String name)
          Get a property embedded into the Page as a long.
 java.lang.String getPage()
          Convenience method to return the contents of the Page in its original format.
 java.util.Map getProperties()
          Get a Map representing all the properties in the Page.
 java.lang.String getProperty(java.lang.String name)
          Get a property embedded into the Page as a String.
 java.lang.String[] getPropertyKeys()
          Get all available property keys for the Page.
 javax.servlet.http.HttpServletRequest getRequest()
          Return the request of the original page.
 java.lang.String getTitle()
          Get the Title of the document
 boolean isFrameSet()
          Check to see if this page contains an HTML frameset.
 boolean isPropertySet(java.lang.String name)
          Determine whether a property embedded into the Page has been set.
private  java.lang.String noNull(java.lang.String property)
           
 void setFrameSet(boolean frameset)
          Marks this page as a frameset.
 void setRequest(javax.servlet.http.HttpServletRequest request)
          Create snapshot of Request.
 void writeBody(java.io.Writer out)
          Write the contents of the <body> tag.
 void writeHead(java.io.Writer out)
          Write the contents of the <head> tag.
 void writePage(java.io.Writer out)
          Write the entire contents of the Page, in the format before it was parsed, to the Writer.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

content

private final Content content

request

private javax.servlet.http.HttpServletRequest request
Constructor Detail

Content2HTMLPage

public Content2HTMLPage(Content content)

Content2HTMLPage

public Content2HTMLPage(Content content,
                        javax.servlet.http.HttpServletRequest request)
Method Detail

writePage

public void writePage(java.io.Writer out)
               throws java.io.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
Parameters:
out - Writer to write to.
Throws:
java.io.IOException - Rethrown if cannot write to writer.

getPage

public java.lang.String getPage()
Description copied from interface: Page
Convenience method to return the contents of the Page in its original format.

Specified by:
getPage in interface Page
See Also:
Page.writePage(java.io.Writer)

writeBody

public void writeBody(java.io.Writer out)
               throws java.io.IOException
Description copied from interface: Page
Write the contents of the <body> tag.

Specified by:
writeBody in interface Page
Throws:
java.io.IOException

getBody

public java.lang.String getBody()
Description copied from interface: Page
Convenience method to return the contents of the <body> tag.

Specified by:
getBody in interface Page
See Also:
Page.writeBody(java.io.Writer)

writeHead

public void writeHead(java.io.Writer out)
               throws java.io.IOException
Description copied from interface: HTMLPage
Write the contents of the <head> tag.

Specified by:
writeHead in interface HTMLPage
Throws:
java.io.IOException

getHead

public java.lang.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)

getTitle

public java.lang.String getTitle()
Description copied from interface: Page
Get the Title of the document

Specified by:
getTitle in interface Page

getContentLength

public int getContentLength()
Description copied from interface: Page
Length of the Page, in the format before it was parsed.

Specified by:
getContentLength in interface Page
Returns:
Length of page data (in number of bytes).

getProperty

public java.lang.String getProperty(java.lang.String name)
Description copied from interface: Page
Get a property embedded into the Page as a String.

Specified by:
getProperty in interface Page
Parameters:
name - Name of property
Returns:
Property value

getIntProperty

public int getIntProperty(java.lang.String name)
Description copied from interface: Page
Get a property embedded into the Page as an int. Returns 0 if property not specified or not valid number.

Specified by:
getIntProperty in interface Page
Parameters:
name - Name of property
Returns:
Property value

getLongProperty

public long getLongProperty(java.lang.String name)
Description copied from interface: Page
Get a property embedded into the Page as a long. Returns 0L if property not specified or not valid number.

Specified by:
getLongProperty in interface Page
Parameters:
name - Name of property
Returns:
Property value

noNull

private java.lang.String noNull(java.lang.String property)

getBooleanProperty

public boolean getBooleanProperty(java.lang.String name)
Description copied from interface: Page
Get a property embedded into the Page as a boolean. Returns true if value starts with '1', 't' or 'y' (case-insensitive) - otherwise returns false.

Specified by:
getBooleanProperty in interface Page
Parameters:
name - Name of property
Returns:
Property value

isPropertySet

public boolean isPropertySet(java.lang.String name)
Description copied from interface: Page
Determine whether a property embedded into the Page has been set.

Specified by:
isPropertySet in interface Page
Parameters:
name - Name of property
Returns:
Whether it has been set

getPropertyKeys

public java.lang.String[] getPropertyKeys()
Description copied from interface: Page
Get all available property keys for the Page.

Specified by:
getPropertyKeys in interface Page
Returns:
Property keys

getProperties

public java.util.Map getProperties()
Description copied from interface: Page
Get a Map representing all the properties in the Page.

Specified by:
getProperties in interface Page
Returns:
Properties map

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()

getRequest

public javax.servlet.http.HttpServletRequest getRequest()
Description copied from interface: Page
Return the request of the original page.

Specified by:
getRequest in interface Page
See Also:
Page.getRequest()

setRequest

public void setRequest(javax.servlet.http.HttpServletRequest request)
Create snapshot of Request.

Specified by:
setRequest in interface Page
See Also:
Page.getRequest()

addProperty

public void addProperty(java.lang.String name,
                        java.lang.String value)
Description copied from interface: Page
Manually add a property to page.

Specified by:
addProperty in interface Page
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
www.opensymphony.com/sitemesh/
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD