com.atlassian.jira.web.tags.helppath

Class HelpTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

webwork.view.taglib.WebWorkTagSupport

com.atlassian.jira.web.tags.helppath.HelpTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

Direct Known Subclasses:

HelpTitleTag, HelpUrlTag

public abstract class HelpTag
extends webwork.view.taglib.WebWorkTagSupport

Template class for HelpUtil.HelpPath-related tags.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected HelpUtil	helpUtil The HelpUtil to look up paths from.

Fields inherited from class webwork.view.taglib.WebWorkTagSupport

stack

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

Constructors

Constructor and Description
HelpTag()
HelpTag(HelpUtil helpUtil)

Method Summary

Modifier and Type	Method and Description
int	doEndTag()
void	setKey(String key)
protected abstract void	writeContent(javax.servlet.jsp.JspWriter out, HelpUtil.HelpPath path) Writes the tag's value the given JspWriter.

Methods inherited from class webwork.view.taglib.WebWorkTagSupport

findString, findValue, getStack, release, setPageContext, setParent, toString

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, doStartTag, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

helpUtil

protected final HelpUtil helpUtil

The HelpUtil to look up paths from.

Constructor Detail

HelpTag

public HelpTag()

HelpTag

public HelpTag(HelpUtil helpUtil)

Method Detail

setKey

public final void setKey(String key)

doEndTag

public final int doEndTag()
                   throws javax.servlet.jsp.JspException

Specified by:

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

Overrides:

doEndTag in class webwork.view.taglib.WebWorkTagSupport

Throws:

javax.servlet.jsp.JspException

writeContent

protected abstract void writeContent(javax.servlet.jsp.JspWriter out,
                                     HelpUtil.HelpPath path)
                              throws IOException

Writes the tag's value the given JspWriter. Implementations should perform their own HTML escaping if necessary.

Parameters:

out - a JspWriter

path - a HelpPath

Throws:

IOException