org.apache.wiki.tags
Class LinkTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      org.apache.wiki.tags.WikiTagBase
          org.apache.wiki.tags.WikiLinkTag
              org.apache.wiki.tags.LinkTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag, javax.servlet.jsp.tagext.TryCatchFinally, ParamHandler

public class LinkTag
extends WikiLinkTag
implements ParamHandler, javax.servlet.jsp.tagext.BodyTag

Provides a generic link tag for all kinds of linking purposes.

If parameter jsp is defined, constructs a URL pointing to the specified JSP page, under the baseURL known by the WikiEngine. Any ParamTag name-value pairs contained in the body are added to this URL to provide support for arbitrary JSP calls.

Since:

2.3.50

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.wiki.tags.WikiLinkTag

ANCHOR, m_format, m_pageName, m_template, URL

Fields inherited from class org.apache.wiki.tags.WikiTagBase

ATTR_CONTEXT, m_wikiContext

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

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

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

LinkTag()

Method Summary

int	doEndTag()
void	doInitBody()
int	doWikiStartTag() This method is allowed to do pretty much whatever he wants.
String	getVersion()
void	initTag() This method is called when the tag is encountered within a new request, but before the setXXX() methods are called.
void	setAbsolute(String arg)
void	setAccessKey(String key)
void	setBodyContent(javax.servlet.jsp.tagext.BodyContent bc)
void	setClass(String arg)
void	setCompareToVersion(String ver)
void	setContainedParameter(String name, String value) Support for ParamTag supplied parameters in body.
void	setContext(String context)
void	setJsp(String jsp)
void	setRef(String ref)
void	setRel(String rel)
void	setStyle(String style)
void	setTarget(String target)
void	setTemplatefile(String key)
void	setTitle(String title)
void	setVersion(String arg)

Methods inherited from class org.apache.wiki.tags.WikiLinkTag

getPage, getTemplate, setFormat, setPage, setTemplate

Methods inherited from class org.apache.wiki.tags.WikiTagBase

doCatch, doFinally, doStartTag, setId, setPageContext

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

Methods inherited from interface javax.servlet.jsp.tagext.IterationTag

doAfterBody

Methods inherited from interface javax.servlet.jsp.tagext.Tag

doStartTag, getParent, release, setPageContext, setParent

Constructor Detail

LinkTag

public LinkTag()

Method Detail

initTag

public void initTag()

Description copied from class: WikiTagBase

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.

Overrides:

initTag in class WikiLinkTag

setTemplatefile

public void setTemplatefile(String key)

setAccessKey

public void setAccessKey(String key)

setAbsolute

public void setAbsolute(String arg)

getVersion

public String getVersion()

setVersion

public void setVersion(String arg)

setClass

public void setClass(String arg)

setStyle

public void setStyle(String style)

setTitle

public void setTitle(String title)

setTarget

public void setTarget(String target)

setCompareToVersion

public void setCompareToVersion(String ver)

setRel

public void setRel(String rel)

setRef

public void setRef(String ref)

setJsp

public void setJsp(String jsp)

setContext

public void setContext(String context)

setContainedParameter

public void setContainedParameter(String name,
                                  String value)

Support for ParamTag supplied parameters in body.

Specified by:

setContainedParameter in interface ParamHandler

doWikiStartTag

public int doWikiStartTag()
                   throws Exception

Description copied from class: WikiTagBase

This method is allowed to do pretty much whatever he wants. We then catch all mistakes.

Specified by:

doWikiStartTag in class WikiTagBase

Throws:

Exception

doEndTag

public int doEndTag()

Specified by:

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

Overrides:

doEndTag in class WikiLinkTag

setBodyContent

public void setBodyContent(javax.servlet.jsp.tagext.BodyContent bc)

Specified by:

setBodyContent in interface javax.servlet.jsp.tagext.BodyTag

doInitBody

public void doInitBody()
                throws javax.servlet.jsp.JspException

Specified by:

doInitBody in interface javax.servlet.jsp.tagext.BodyTag

Throws:

javax.servlet.jsp.JspException