Package org.apache.wiki.tags

Class WikiTagBase

java.lang.Object

jakarta.servlet.jsp.tagext.TagSupport

org.apache.wiki.tags.WikiTagBase

All Implemented Interfaces:

jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, jakarta.servlet.jsp.tagext.TryCatchFinally, Serializable

Direct Known Subclasses:

AuthorTag, BaseURLTag, BreadcrumbsTag, CalendarTag, CheckLockTag, CheckRequestContextTag, CheckVersionTag, ContentEncodingTag, ContentTag, CsrfProtectionTag, FeedDiscoveryTag, HasAttachmentsTag, IfNoSearchResultsTag, IncludeResourcesTag, IncludeTag, InsertDiffTag, InsertPageTag, MaxUploadTag, MessagesTag, NextVersionTag, NoSuchPageTag, PageDateTag, PageNameTag, PageSizeTag, PageTypeTag, PageVersionTag, ParentPageNameTag, PermissionTag, PreviousVersionTag, RequestResourceTag, RSSImageLinkTag, SearchResultsSizeTag, SearchResultsTag, SetPaginationTag, SpamFilterInputsTag, TabTag, TemplateDirTag, UserCheckTag, UserNameTag, UserProfileTag, VariableTag, WikiLinkTag

public abstract class WikiTagBase
extends jakarta.servlet.jsp.tagext.TagSupport
implements jakarta.servlet.jsp.tagext.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

Fields

Modifier and Type	Field	Description
protected org.apache.wiki.api.core.Context	m_wikiContext

Fields inherited from class jakarta.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface jakarta.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface jakarta.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor	Description
WikiTagBase()

Method Summary

Modifier and Type	Method	Description
void	doCatch(Throwable th)
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(jakarta.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 jakarta.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 Details

m_wikiContext

protected org.apache.wiki.api.core.Context m_wikiContext

Constructor Details

WikiTagBase

public WikiTagBase()

Method Details

setPageContext

public void setPageContext(jakarta.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 jakarta.servlet.jsp.tagext.Tag

Overrides:

setPageContext in class jakarta.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 jakarta.servlet.jsp.JspException

Specified by:

doStartTag in interface jakarta.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class jakarta.servlet.jsp.tagext.TagSupport

Throws:

jakarta.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 jakarta.servlet.jsp.JspException

Specified by:

doEndTag in interface jakarta.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class jakarta.servlet.jsp.tagext.TagSupport

Throws:

jakarta.servlet.jsp.JspException

doCatch

public void doCatch(Throwable th)
             throws Throwable

Specified by:

doCatch in interface jakarta.servlet.jsp.tagext.TryCatchFinally

Throws:

Throwable

doFinally

public void doFinally()

Specified by:

doFinally in interface jakarta.servlet.jsp.tagext.TryCatchFinally

setId

public void setId(String id)

Overrides:

setId in class jakarta.servlet.jsp.tagext.TagSupport