Class Content2HTMLPage
java.lang.Object
com.opensymphony.sitemesh.compatability.Content2HTMLPage
- Since:
- SiteMesh 3
- Author:
- Joe Walnes
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionContent2HTMLPage
(Content content) Content2HTMLPage
(Content content, javax.servlet.http.HttpServletRequest request) -
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.getHead()
Convenience method to return the contents of the<head>
tag as a String.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
Return the request of the original page.getTitle()
Get the Title of the documentboolean
Check to see if this page contains an HTML frameset.boolean
isPropertySet
(String name) Determine whether a property embedded into thePage
has been set.private String
void
setFrameSet
(boolean frameset) Marks this page as a frameset.void
setRequest
(javax.servlet.http.HttpServletRequest request) Create snapshot of Request.void
Write the contents of the<body>
tag.void
Write the contents of the<head>
tag.void
Write the entire contents of thePage
, in the format before it was parsed, to theWriter
.
-
Field Details
-
-
request
private javax.servlet.http.HttpServletRequest request
-
-
Constructor Details
-
Content2HTMLPage
-
Content2HTMLPage
-
-
Method Details
-
writePage
Description copied from interface:Page
Write the entire contents of thePage
, in the format before it was parsed, to theWriter
.- Specified by:
writePage
in interfacePage
- Parameters:
out
- Writer to write to.- Throws:
IOException
- Rethrown if cannot write to writer.
-
getPage
Description copied from interface:Page
Convenience method to return the contents of thePage
in its original format. -
writeBody
Description copied from interface:Page
Write the contents of the<body>
tag.- Specified by:
writeBody
in interfacePage
- Throws:
IOException
-
getBody
Description copied from interface:Page
Convenience method to return the contents of the<body>
tag. -
writeHead
Description copied from interface:HTMLPage
Write the contents of the<head>
tag.- Specified by:
writeHead
in interfaceHTMLPage
- Throws:
IOException
-
getHead
Description copied from interface:HTMLPage
Convenience method to return the contents of the<head>
tag as a String. -
getTitle
Description copied from interface:Page
Get the Title of the document -
getContentLength
public int getContentLength()Description copied from interface:Page
Length of thePage
, in the format before it was parsed.- Specified by:
getContentLength
in interfacePage
- Returns:
- Length of page data (in number of bytes).
-
getProperty
Description copied from interface:Page
Get a property embedded into thePage
as aString
.- Specified by:
getProperty
in interfacePage
- Parameters:
name
- Name of property- Returns:
- Property value
-
getIntProperty
Description copied from interface:Page
Get a property embedded into thePage
as anint
. Returns 0 if property not specified or not valid number.- Specified by:
getIntProperty
in interfacePage
- Parameters:
name
- Name of property- Returns:
- Property value
-
getLongProperty
Description copied from interface:Page
Get a property embedded into thePage
as along
. Returns 0L if property not specified or not valid number.- Specified by:
getLongProperty
in interfacePage
- Parameters:
name
- Name of property- Returns:
- Property value
-
noNull
-
getBooleanProperty
Description copied from interface:Page
Get a property embedded into thePage
as aboolean
. Returns true if value starts with '1', 't' or 'y' (case-insensitive) - otherwise returns false.- Specified by:
getBooleanProperty
in interfacePage
- Parameters:
name
- Name of property- Returns:
- Property value
-
isPropertySet
Description copied from interface:Page
Determine whether a property embedded into thePage
has been set.- Specified by:
isPropertySet
in interfacePage
- Parameters:
name
- Name of property- Returns:
- Whether it has been set
-
getPropertyKeys
Description copied from interface:Page
Get all available property keys for thePage
.- Specified by:
getPropertyKeys
in interfacePage
- Returns:
- Property keys
-
getProperties
Description copied from interface:Page
Get aMap
representing all the properties in thePage
.- Specified by:
getProperties
in interfacePage
- 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 interfaceHTMLPage
-
setFrameSet
public void setFrameSet(boolean frameset) Description copied from interface:HTMLPage
Marks this page as a frameset.- Specified by:
setFrameSet
in interfaceHTMLPage
- See Also:
-
getRequest
public javax.servlet.http.HttpServletRequest getRequest()Description copied from interface:Page
Return the request of the original page.- Specified by:
getRequest
in interfacePage
- See Also:
-
setRequest
public void setRequest(javax.servlet.http.HttpServletRequest request) Create snapshot of Request.- Specified by:
setRequest
in interfacePage
- See Also:
-
addProperty
Description copied from interface:Page
Manually add a property to page.- Specified by:
addProperty
in interfacePage
-