com.ecyrd.jspwiki.tags
Class WikiTagBase

java.lang.Object
  extended by javax.servlet.jsp.tagext.TagSupport
      extended by com.ecyrd.jspwiki.tags.WikiTagBase
All Implemented Interfaces:
Serializable, IterationTag, JspTag, Tag, TryCatchFinally
Direct Known Subclasses:
AuthorTag, BaseURLTag, BreadcrumbsTag, CalendarTag, CheckLockTag, CheckRequestContextTag, CheckVersionTag, ContentEncodingTag, ContentTag, FeedDiscoveryTag, HasAttachmentsTag, IfNoSearchResultsTag, IncludeResourcesTag, IncludeTag, InsertDiffTag, InsertPageTag, MessagesTag, NextVersionTag, NoSuchPageTag, PageDateTag, PageNameTag, PageSizeTag, PageTypeTag, PageVersionTag, ParentPageNameTag, PermissionTag, PreviousVersionTag, RequestResourceTag, RSSImageLinkTag, RSSLinkTag, SearchResultsSizeTag, SearchResultsTag, SetPaginationTag, TabTag, TemplateDirTag, UserCheckTag, UserNameTag, UserProfileTag, VariableTag, WikiLinkTag

public abstract class WikiTagBase
extends TagSupport
implements TryCatchFinally

Base class for JSPWiki tags. You do not necessarily have to derive from this class, since this does some initialization.

This tag is only useful if you're having an "empty" tag, with no body content.

Since:
2.0
See Also:
Serialized Form

Field Summary
static String ATTR_CONTEXT
           
protected  WikiContext m_wikiContext
           
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
EVAL_BODY_AGAIN
 
Fields inherited from interface javax.servlet.jsp.tagext.Tag
EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
 
Constructor Summary
WikiTagBase()
           
 
Method Summary
 void doCatch(Throwable arg0)
           
 int doEndTag()
           
 void doFinally()
           
 int doStartTag()
           
abstract  int doWikiStartTag()
          This method is allowed to do pretty much whatever he wants.
 void initTag()
          This method is called when the tag is encountered within a new request, but before the setXXX() methods are called.
 void setId(String id)
           
 void setPageContext(PageContext arg0)
          This method calls the parent setPageContext() but it also provides a way for a tag to initialize itself before any of the setXXX() methods are called.
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ATTR_CONTEXT

public static final String ATTR_CONTEXT
See Also:
Constant Field Values

m_wikiContext

protected WikiContext m_wikiContext
Constructor Detail

WikiTagBase

public WikiTagBase()
Method Detail

setPageContext

public void setPageContext(PageContext arg0)
This method calls the parent setPageContext() but it also provides a way for a tag to initialize itself before any of the setXXX() methods are called.

Specified by:
setPageContext in interface Tag
Overrides:
setPageContext in class TagSupport

initTag

public void initTag()
This method is called when the tag is encountered within a new request, but before the setXXX() methods are called. The default implementation does nothing.

Since:
2.3.92

doStartTag

public int doStartTag()
               throws JspException
Specified by:
doStartTag in interface Tag
Overrides:
doStartTag in class TagSupport
Throws:
JspException

doWikiStartTag

public abstract int doWikiStartTag()
                            throws Exception
This method is allowed to do pretty much whatever he wants. We then catch all mistakes.

Throws:
Exception

doEndTag

public int doEndTag()
             throws JspException
Specified by:
doEndTag in interface Tag
Overrides:
doEndTag in class TagSupport
Throws:
JspException

doCatch

public void doCatch(Throwable arg0)
             throws Throwable
Specified by:
doCatch in interface TryCatchFinally
Throws:
Throwable

doFinally

public void doFinally()
Specified by:
doFinally in interface TryCatchFinally

setId

public void setId(String id)
Overrides:
setId in class TagSupport