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, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.Tag
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, RSSCoffeeCupLinkTag, RSSImageLinkTag, RSSLinkTag, SearchResultsSizeTag, SearchResultsTag, TemplateDirTag, UserCheckTag, UserNameTag, UserProfileTag, VariableTag, WikiLinkTag

public abstract class WikiTagBase
extends javax.servlet.jsp.tagext.TagSupport

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
Author:
Janne Jalkanen
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
 int doEndTag()
           
 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 setPageContext(javax.servlet.jsp.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, setId, 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(javax.servlet.jsp.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 javax.servlet.jsp.tagext.Tag
Overrides:
setPageContext in class javax.servlet.jsp.tagext.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 javax.servlet.jsp.JspException
Specified by:
doStartTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doStartTag in class javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.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 javax.servlet.jsp.JspException
Specified by:
doEndTag in interface javax.servlet.jsp.tagext.Tag
Overrides:
doEndTag in class javax.servlet.jsp.tagext.TagSupport
Throws:
javax.servlet.jsp.JspException