Class AbstractTag
- java.lang.Object
-
- javax.servlet.jsp.tagext.TagSupport
-
- javax.servlet.jsp.tagext.BodyTagSupport
-
- com.opensymphony.module.sitemesh.taglib.AbstractTag
-
- All Implemented Interfaces:
RequestConstants
,Serializable
,javax.servlet.jsp.tagext.BodyTag
,javax.servlet.jsp.tagext.IterationTag
,javax.servlet.jsp.tagext.JspTag
,javax.servlet.jsp.tagext.Tag
- Direct Known Subclasses:
BodyTag
,HeadTag
,PropertyTag
,TitleTag
,UsePageTag
public abstract class AbstractTag extends javax.servlet.jsp.tagext.BodyTagSupport implements RequestConstants
Convenience implementation of Tag containing generice methods required by all (or most) taglibs.- Version:
- $Revision: 1.4 $
- Author:
- Joe Walnes
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected javax.servlet.jsp.PageContext
pageContext
protected javax.servlet.jsp.tagext.Tag
parent
-
Fields inherited from interface com.opensymphony.module.sitemesh.RequestConstants
DECORATOR, PAGE, ROBOT
-
-
Constructor Summary
Constructors Constructor Description AbstractTag()
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description abstract int
doEndTag()
To be implemented by all empty tags.int
doStartTag()
Returns SKIP_BODY.protected Writer
getOut()
Get the outputWriter.protected Page
getPage()
Return the Page object from the PAGE scope.javax.servlet.jsp.tagext.Tag
getParent()
void
release()
void
setPageContext(javax.servlet.jsp.PageContext pageContext)
void
setParent(javax.servlet.jsp.tagext.Tag parent)
protected static void
trace(Exception e)
Log exception generated by taglib.-
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, getBodyContent, getPreviousOut, setBodyContent
-
-
-
-
Method Detail
-
doEndTag
public abstract int doEndTag() throws javax.servlet.jsp.JspException
To be implemented by all empty tags.- Specified by:
doEndTag
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
doEndTag
in classjavax.servlet.jsp.tagext.BodyTagSupport
- Throws:
javax.servlet.jsp.JspException
-
doStartTag
public int doStartTag()
Returns SKIP_BODY.- Specified by:
doStartTag
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
doStartTag
in classjavax.servlet.jsp.tagext.BodyTagSupport
-
release
public void release()
- Specified by:
release
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
release
in classjavax.servlet.jsp.tagext.BodyTagSupport
-
getParent
public javax.servlet.jsp.tagext.Tag getParent()
- Specified by:
getParent
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
getParent
in classjavax.servlet.jsp.tagext.TagSupport
-
setParent
public void setParent(javax.servlet.jsp.tagext.Tag parent)
- Specified by:
setParent
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
setParent
in classjavax.servlet.jsp.tagext.TagSupport
-
setPageContext
public void setPageContext(javax.servlet.jsp.PageContext pageContext)
- Specified by:
setPageContext
in interfacejavax.servlet.jsp.tagext.Tag
- Overrides:
setPageContext
in classjavax.servlet.jsp.tagext.TagSupport
-
getPage
protected Page getPage()
Return the Page object from the PAGE scope. If this is found in REQUEST scope instead, it will be moved into PAGE scope - to handle multi-level includes.
-
trace
protected static void trace(Exception e)
Log exception generated by taglib.
-
getOut
protected Writer getOut()
Get the outputWriter. This method should be used in preference topageContext.getOut()
, as some charset conversions may need to happen in some servers.- Returns:
- the writer for use in the tag
-
-