UsePageTag (OpenSymphony SiteMesh 2.1 API)

java.lang.Object
- jakarta.servlet.jsp.tagext.TagSupport
- - jakarta.servlet.jsp.tagext.BodyTagSupport
  - - com.opensymphony.module.sitemesh.taglib.AbstractTag
    - - com.opensymphony.module.sitemesh.taglib.decorator.UsePageTag

All Implemented Interfaces:

RequestConstants, jakarta.servlet.jsp.tagext.BodyTag, jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, java.io.Serializable
```
public class UsePageTag
extends AbstractTag
```
Expose the Page as a bean to the page which can then be accessed from scriptlets.
Depending on the TEI used, the object will be Page or HTMLPage.

Version:

$Revision: 1.1 $

Author:

Joe Walnes

See Also:

UsePageTEI, UseHTMLPageTEI, Serialized Form

Field Summary

Fields
Modifier and Type Field Description

private java.lang.String id
- Fields inherited from class com.opensymphony.module.sitemesh.taglib.AbstractTag
  pageContext, parent
- Fields inherited from class jakarta.servlet.jsp.tagext.BodyTagSupport
  bodyContent
- Fields inherited from interface jakarta.servlet.jsp.tagext.BodyTag
  EVAL_BODY_BUFFERED
- Fields inherited from interface jakarta.servlet.jsp.tagext.IterationTag
  EVAL_BODY_AGAIN
- Fields inherited from interface com.opensymphony.module.sitemesh.RequestConstants
  DECORATOR, FILTER_APPLIED, PAGE, ROBOT, USING_STREAM
- Fields inherited from interface jakarta.servlet.jsp.tagext.Tag
  EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors
Constructor Description

UsePageTag()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`doEndTag()`	To be implemented by all empty tags.
`void`	`setId(java.lang.String id)`	Set name of variable the Page will be set as.

Methods inherited from class com.opensymphony.module.sitemesh.taglib.AbstractTag
doStartTag, getOut, getPage, getParent, release, setPageContext, setParent, trace

Methods inherited from class jakarta.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent

Methods inherited from class jakarta.servlet.jsp.tagext.TagSupport
findAncestorWithClass, getId, getValue, getValues, removeValue, setValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - id
```
private java.lang.String id
```
- Constructor Detail
  - UsePageTag
```
public UsePageTag()
```
- Method Detail
  - setId
```
public void setId(java.lang.String id)
```
    Set name of variable the Page will be set as.
    
    Overrides:
    
    setId in class jakarta.servlet.jsp.tagext.TagSupport
  - doEndTag
```
public final int doEndTag()
                   throws jakarta.servlet.jsp.JspException
```
    Description copied from class: AbstractTag
    
    To be implemented by all empty tags.
    
    Specified by:
    
    doEndTag in interface jakarta.servlet.jsp.tagext.Tag
    
    Specified by:
    
    doEndTag in class AbstractTag
    
    Throws:
    
    jakarta.servlet.jsp.JspException