Java Doc for ApplyDecoratorTag.java in  » Web-Framework » SiteMesh » com » opensymphony » module » sitemesh » taglib » page » 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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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.taglib.page 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


javax.servlet.jsp.tagext.BodyTagSupport
   com.opensymphony.module.sitemesh.taglib.page.ApplyDecoratorTag

ApplyDecoratorTag
public class ApplyDecoratorTag extends BodyTagSupport implements RequestConstants(Code)
This tag inserts an external resource as a panel into the current Page.

The page attribute should point to the panel resource which should expose an entire page (e.g. another JSP file producing HTML). This attribute can be relative to the page it is being called from or an absolute path from the context-root.

OR

If the page attribute is not specified, the body content is parsed into the com.opensymphony.module.sitemesh.Page object and has the com.opensymphony.module.sitemesh.Decorator applied.

The (optional) decorator attribute is the name of the com.opensymphony.module.sitemesh.Decorator to apply to the included page. Note that the implementation of com.opensymphony.module.sitemesh.DecoratorMapper can overide this.


author:
   Joe Walnes
version:
   $Revision: 1.9 $

Inner Class :class ApplyDecoratorException extends Exception



Method Summary
 voidaddParam(String name, String value)
     Add a parameter to the page.
public  intdoAfterBody()
     Ensure that external page contents are included in bodycontent.
public  intdoEndTag()
     Standard taglib method: apply decorator to page.
public  intdoStartTag()
    
public  voidsetContentType(String contentType)
    
public  voidsetDecorator(String decorator)
    
public  voidsetEncoding(String encoding)
    
public  voidsetId(String id)
     Tag attribute: If set, this value will override the 'id' property of the page.
public  voidsetName(String decorator)
     Tag attribute: Name of Decorator to apply to Page. This is passed to DecoratorMapper to retrieve appropriate Decorator.
public  voidsetPage(String page)
     Tag attribute: URI of page to include.
public  voidsetTitle(String title)
     Tag attribute: If set, this value will override the 'title' property of the page.



Method Detail
addParam
void addParam(String name, String value)(Code)
Add a parameter to the page. This has a package level access modifier so ParamTag can also call it.



doAfterBody
public int doAfterBody() throws JspException(Code)
Ensure that external page contents are included in bodycontent.



doEndTag
public int doEndTag() throws JspException(Code)
Standard taglib method: apply decorator to page.



doStartTag
public int doStartTag()(Code)



setContentType
public void setContentType(String contentType)(Code)



setDecorator
public void setDecorator(String decorator)(Code)



setEncoding
public void setEncoding(String encoding)(Code)



setId
public void setId(String id)(Code)
Tag attribute: If set, this value will override the 'id' property of the page. This is a convenience utility and is identical to specifing a 'page:param name=id' tag.



setName
public void setName(String decorator)(Code)
Tag attribute: Name of Decorator to apply to Page. This is passed to DecoratorMapper to retrieve appropriate Decorator. DecoratorMapper may override if needed.
See Also:   com.opensymphony.module.sitemesh.DecoratorMapper



setPage
public void setPage(String page)(Code)
Tag attribute: URI of page to include. Can be relative to page being called from, or absolute path from context-root of web-app.



setTitle
public void setTitle(String title)(Code)
Tag attribute: If set, this value will override the 'title' property of the page. This is a convenience utility and is identical to specifing a 'page:param name=title' tag.



Fields inherited from javax.servlet.jsp.tagext.BodyTagSupport
protected BodyContent bodyContent(Code)(Java Doc)

Methods inherited from javax.servlet.jsp.tagext.BodyTagSupport
public int doAfterBody() throws JspException(Code)(Java Doc)
public int doEndTag() throws JspException(Code)(Java Doc)
public void doInitBody() throws JspException(Code)(Java Doc)
public int doStartTag() throws JspException(Code)(Java Doc)
public BodyContent getBodyContent()(Code)(Java Doc)
public JspWriter getPreviousOut()(Code)(Java Doc)
public void release()(Code)(Java Doc)
public void setBodyContent(BodyContent b)(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.