|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
void |
addProperty(String name,
String value)
Manually add a property to page. |
boolean |
getBooleanProperty(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. |
int |
getIntProperty(String name)
Get a property embedded into the Page as an int . |
long |
getLongProperty(String name)
Get a property embedded into the Page as a long . |
Map |
getProperties()
Get a Map representing all the properties in the Page . |
String |
getProperty(String name)
Get a property embedded into the Page as a String . |
String[] |
getPropertyKeys()
Get all available property keys for the Page . |
HttpServletRequest |
getRequest()
Return the request of the original page. |
String |
getTitle()
Get the Title of the document |
boolean |
isPropertySet(String name)
Determine whether a property embedded into the Page has been set. |
void |
setRequest(HttpServletRequest request)
Create snapshot of Request. |
void |
writeBody(Writer out)
Write the contents of the <body> tag. |
void |
writePage(Writer out)
Write the entire contents of the Page , in the format before
it was parsed, to the Writer . |
Method Detail |
---|
void writePage(Writer out) throws IOException
Page
, in the format before
it was parsed, to the Writer
.
out
- Writer to write to.
IOException
- Rethrown if cannot write to writer.void writeBody(Writer out) throws IOException
<body>
tag.
IOException
String getTitle()
int getContentLength()
Page
, in the format before
it was parsed.
String getProperty(String name)
Page
as a String
.
name
- Name of property
int getIntProperty(String name)
Page
as an int
.
Returns 0 if property not specified or not valid number.
name
- Name of property
long getLongProperty(String name)
Page
as a long
.
Returns 0L if property not specified or not valid number.
name
- Name of property
boolean getBooleanProperty(String name)
Page
as a boolean
.
Returns true if value starts with '1', 't' or 'y' (case-insensitive) -
otherwise returns false.
name
- Name of property
boolean isPropertySet(String name)
Page
has been set.
name
- Name of property
String[] getPropertyKeys()
Page
.
Map getProperties()
Map
representing all the properties in the Page
.
HttpServletRequest getRequest()
void setRequest(HttpServletRequest request)
getRequest()
void addProperty(String name, String value)
|
www.opensymphony.com/sitemesh/ | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |