Page (OpenSymphony SiteMesh 2.5 API)

All Known Subinterfaces:

HTMLPage

All Known Implementing Classes:

AbstractHTMLPage, AbstractPage, Content2HTMLPage, FastPage, PartialPageParserHtmlPage, PartialPageParserPage, TokenizedHTMLPage
```
public interface 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 and implementing an appropriate PageParser.

Version:

$Revision: 1.5 $

Author:

Joe Walnes

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`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`	`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()` Deprecated. Since Servlet 2.4 API, this is unnecessary - just use the stand HttpServletRequest instance.
`java.lang.String`	`getTitle()` Get the Title of the document
`boolean`	`isPropertySet(java.lang.String name)` Determine whether a property embedded into the `Page` has been set.
`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`	`writePage(java.io.Writer out)` Write the entire contents of the `Page`, in the format before it was parsed, to the `Writer`.

- Method Detail
  - writePage
```
void writePage(java.io.Writer out)
        throws java.io.IOException
```
    Write the entire contents of the Page, in the format before it was parsed, to the Writer.
    
    Parameters:
    
    out - Writer to write to.
    
    Throws:
    
    java.io.IOException - Rethrown if cannot write to writer.
  - getPage
```
java.lang.String getPage()
```
    Convenience method to return the contents of the Page in its original format.
    
    Since:
    
    2.1.1
    
    See Also:
    
    writePage(java.io.Writer)
  - writeBody
```
void writeBody(java.io.Writer out)
        throws java.io.IOException
```
    Write the contents of the <body> tag.
    
    Throws:
    
    java.io.IOException
  - getBody
```
java.lang.String getBody()
```
    Convenience method to return the contents of the <body> tag.
    
    Since:
    
    2.1.1
    
    See Also:
    
    writeBody(java.io.Writer)
  - getTitle
```
java.lang.String getTitle()
```
    Get the Title of the document
  - getProperty
```
java.lang.String getProperty(java.lang.String name)
```
    Get a property embedded into the Page as a String.
    
    Parameters:
    
    name - Name of property
    
    Returns:
    
    Property value
  - getIntProperty
```
int getIntProperty(java.lang.String name)
```
    Get a property embedded into the Page as an int. Returns 0 if property not specified or not valid number.
    
    Parameters:
    
    name - Name of property
    
    Returns:
    
    Property value
  - getLongProperty
```
long getLongProperty(java.lang.String name)
```
    Get a property embedded into the Page as a long. Returns 0L if property not specified or not valid number.
    
    Parameters:
    
    name - Name of property
    
    Returns:
    
    Property value
  - getBooleanProperty
```
boolean getBooleanProperty(java.lang.String name)
```
    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.
    
    Parameters:
    
    name - Name of property
    
    Returns:
    
    Property value
  - isPropertySet
```
boolean isPropertySet(java.lang.String name)
```
    Determine whether a property embedded into the Page has been set.
    
    Parameters:
    
    name - Name of property
    
    Returns:
    
    Whether it has been set
  - getPropertyKeys
```
java.lang.String[] getPropertyKeys()
```
    Get all available property keys for the Page.
    
    Returns:
    
    Property keys
  - getProperties
```
java.util.Map getProperties()
```
    Get a Map representing all the properties in the Page.
    
    Returns:
    
    Properties map
  - getRequest
```
javax.servlet.http.HttpServletRequest getRequest()
```
    Deprecated. Since Servlet 2.4 API, this is unnecessary - just use the stand HttpServletRequest instance.
    
    Return the request of the original page.
  - setRequest
```
void setRequest(javax.servlet.http.HttpServletRequest request)
```
    Create snapshot of Request. Subsequent modifications to the request by the servlet container will not be returned by getRequest()
  - addProperty
```
void addProperty(java.lang.String name,
                 java.lang.String value)
```
    Manually add a property to page.

Interface Page

Method Summary

Method Detail

writePage

getPage

writeBody

getBody

getTitle

getProperty

getIntProperty

getLongProperty

getBooleanProperty

isPropertySet

getPropertyKeys

getProperties

getRequest

setRequest

addProperty