Java Doc for Page.java in » Web-Framework » SiteMesh » com » opensymphony » module » sitemesh » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Web Framework » SiteMesh » com.opensymphony.module.sitemesh

Source Cross Reference Class Diagram Java Document (Java Doc)

com.opensymphony.module.sitemesh .Page

All known Subclasses:   com.opensymphony.module.sitemesh.parser .AbstractPage,
Page
public interface Page (Code)
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 com.opensymphony.module.sitemesh.PageParser implementations.

Typically a Page is no use to a com.opensymphony.module.sitemesh.Decorator as it needs specific details relevant to the content-type of that page (e.g. HTML pages). The appropriate com.opensymphony.module.sitemesh.PageParser is responsible for returning extended implementations of pages such as com.opensymphony.module.sitemesh.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.

author:
   Joe Walnes
version:
   $Revision: 1.4 $

Method Summary
void addProperty(String name, String value)
     Manually add a property to page.
String getBody()
     Convenience method to return the contents of the <body> tag.
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.
String getPage()
     Convenience method to return the contents of the Page in its original format.
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()

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
addProperty
void addProperty(String name, String value)(Code)
Manually add a property to page.

getBody
String getBody()(Code)
Convenience method to return the contents of the <body> tag.
since:
   2.1.1
See Also:   Page.writeBody(java.io.Writer)

getBooleanProperty
boolean getBooleanProperty(String name)(Code)
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 Property value

getContentLength
int getContentLength()(Code)
Length of the Page, in the format before it was parsed. Length of page data (in number of bytes).

getIntProperty
int getIntProperty(String name)(Code)
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 Property value

getLongProperty
long getLongProperty(String name)(Code)
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 Property value

getPage
String getPage()(Code)
Convenience method to return the contents of the Page in its original format.
since:
   2.1.1
See Also:   Page.writePage(java.io.Writer)

getProperties
Map getProperties()(Code)
Get a Map representing all the properties in the Page. Properties map

getProperty
String getProperty(String name)(Code)
Get a property embedded into the Page as a String.
Parameters:
  name - Name of property Property value

getPropertyKeys
String[] getPropertyKeys()(Code)
Get all available property keys for the Page. Property keys

getRequest
HttpServletRequest getRequest()(Code)
Return the request of the original page.

getTitle
String getTitle()(Code)
Get the Title of the document

isPropertySet
boolean isPropertySet(String name)(Code)
Determine whether a property embedded into the Page has been set.
Parameters:
  name - Name of property Whether it has been set

setRequest
void setRequest(HttpServletRequest request)(Code)
Create snapshot of Request. Subsequent modifications to the request by the servlet container will not be returned by Page.getRequest()

writeBody
void writeBody(Writer out) throws IOException(Code)
Write the contents of the <body> tag.

writePage
void writePage(Writer out) throws IOException(Code)
Write the entire contents of the Page, in the format before it was parsed, to the Writer.
Parameters:
  out - Writer to write to.
exception:
  java.io.IOException - Rethrown if cannot write to writer.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.