com.sitemesh.taglib
Class AbstractTag

java.lang.Object
  |
  +--com.sitemesh.taglib.AbstractTag
Direct Known Subclasses:
BodyTag, HeadTag, PanelTag, PropertyTag, TitleTag, UsePageTag

public abstract class AbstractTag
extends java.lang.Object
implements javax.servlet.jsp.tagext.Tag, RequestConstants

Convenience implementation of Tag containing generice methods required by all (or most) taglibs.

Version:
$Revision: 1.5 $
Author:
Joe Walnes

Field Summary
protected  javax.servlet.jsp.PageContext pageContext
           
protected  javax.servlet.jsp.tagext.Tag parent
           
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Fields inherited from interface com.sitemesh.RequestConstants
DECORATOR, FILTER_APPLIED, PAGE
 
Constructor Summary
AbstractTag()
           
 
Method Summary
abstract  int doEndTag()
          To be implemented by all empty tags.
 int doStartTag()
          Returns SKIP_BODY.
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  void trace(java.lang.Exception e)
          Log exception generated by taglib.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

pageContext

protected javax.servlet.jsp.PageContext pageContext

parent

protected javax.servlet.jsp.tagext.Tag parent
Constructor Detail

AbstractTag

public AbstractTag()
Method Detail

doEndTag

public abstract int doEndTag()
                      throws javax.servlet.jsp.JspException
To be implemented by all empty tags.
Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag

doStartTag

public int doStartTag()
Returns SKIP_BODY.
Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag

release

public void release()
Specified by:
release in interface javax.servlet.jsp.tagext.Tag

getParent

public javax.servlet.jsp.tagext.Tag getParent()
Specified by:
getParent in interface javax.servlet.jsp.tagext.Tag

setParent

public void setParent(javax.servlet.jsp.tagext.Tag parent)
Specified by:
setParent in interface javax.servlet.jsp.tagext.Tag

setPageContext

public void setPageContext(javax.servlet.jsp.PageContext pageContext)
Specified by:
setPageContext in interface javax.servlet.jsp.tagext.Tag

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 void trace(java.lang.Exception e)
Log exception generated by taglib.