Package com.opensymphony.module.sitemesh
Interface Page
- All Known Subinterfaces:
HTMLPage
- All Known Implementing Classes:
AbstractHTMLPage
,AbstractPage
,Content2HTMLPage
,FastPage
,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
Modifier and TypeMethodDescriptionvoid
addProperty
(String name, String value) Manually add a property to page.getBody()
Convenience method to return the contents of the<body>
tag.boolean
getBooleanProperty
(String name) Get a property embedded into thePage
as aboolean
.int
Length of thePage
, in the format before it was parsed.int
getIntProperty
(String name) Get a property embedded into thePage
as anint
.long
getLongProperty
(String name) Get a property embedded into thePage
as along
.getPage()
Convenience method to return the contents of thePage
in its original format.Get aMap
representing all the properties in thePage
.getProperty
(String name) Get a property embedded into thePage
as aString
.String[]
Get all available property keys for thePage
.javax.servlet.http.HttpServletRequest
Deprecated.Since Servlet 2.4 API, this is unnecessary - just use the stand HttpServletRequest instance.getTitle()
Get the Title of the documentboolean
isPropertySet
(String name) Determine whether a property embedded into thePage
has been set.void
setRequest
(javax.servlet.http.HttpServletRequest request) Create snapshot of Request.void
Write the contents of the<body>
tag.void
Write the entire contents of thePage
, in the format before it was parsed, to theWriter
.
-
Method Details
-
writePage
Write the entire contents of thePage
, in the format before it was parsed, to theWriter
.- Parameters:
out
- Writer to write to.- Throws:
IOException
- Rethrown if cannot write to writer.
-
getPage
String getPage()Convenience method to return the contents of thePage
in its original format.- Since:
- 2.1.1
- See Also:
-
writeBody
Write the contents of the<body>
tag.- Throws:
IOException
-
getBody
String getBody()Convenience method to return the contents of the<body>
tag.- Since:
- 2.1.1
- See Also:
-
getTitle
String getTitle()Get the Title of the document -
getContentLength
int getContentLength()Length of thePage
, in the format before it was parsed.- Returns:
- Length of page data (in number of bytes).
-
getProperty
Get a property embedded into thePage
as aString
.- Parameters:
name
- Name of property- Returns:
- Property value
-
getIntProperty
Get a property embedded into thePage
as anint
. Returns 0 if property not specified or not valid number.- Parameters:
name
- Name of property- Returns:
- Property value
-
getLongProperty
Get a property embedded into thePage
as along
. Returns 0L if property not specified or not valid number.- Parameters:
name
- Name of property- Returns:
- Property value
-
getBooleanProperty
Get a property embedded into thePage
as aboolean
. Returns true if value starts with '1', 't' or 'y' (case-insensitive) - otherwise returns false.- Parameters:
name
- Name of property- Returns:
- Property value
-
isPropertySet
Determine whether a property embedded into thePage
has been set.- Parameters:
name
- Name of property- Returns:
- Whether it has been set
-
getPropertyKeys
String[] getPropertyKeys()Get all available property keys for thePage
.- Returns:
- Property keys
-
getProperties
Map getProperties()Get aMap
representing all the properties in thePage
.- 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 bygetRequest()
-
addProperty
Manually add a property to page.
-