org.springframework.extensions.surf.taglib

Class ObjectAnchorTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.springframework.web.servlet.tags.RequestContextAwareTag

org.springframework.extensions.surf.taglib.RenderServiceTag

org.springframework.extensions.surf.taglib.AbstractObjectTag

org.springframework.extensions.surf.taglib.ObjectAnchorTag

All Implemented Interfaces:

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

public class ObjectAnchorTag
extends AbstractObjectTag

Renders an HTML anchor tag to a page or page type using the attributes provided. Correct usage of this tag should include a body that will be rendered as the link - if no body is provided then nothing acionable will be rendered on the screen.

Author:

muzquiano, David Draper

See Also:

Serialized Form

Field Summary

Fields inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag

REQUEST_CONTEXT_PAGE_ATTRIBUTE

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
ObjectAnchorTag()

Method Summary

Methods

Modifier and Type	Method and Description
int	doEndTag() Closes the HTML anchor tag opened in doStartTag
String	getTarget()
protected int	invokeRenderService(RenderService renderService, RequestContext requestContext, ModelObject object) Generates the URL to the requested resource (either a page or page type with optional object and format request parameters) and then opens an HTML anchor tag using the generated URL as the HREF argument and setting a target if provided.
void	release() The life-cycle of a custom JSP tag is that the class is is instantiated when it is first required and then re-used for all subsequent invocations.
void	setTarget(String target)

Methods inherited from class org.springframework.extensions.surf.taglib.AbstractObjectTag

getFormat, getObject, getPage, getPageType, setFormat, setObject, setPage, setPageType

Methods inherited from class org.springframework.extensions.surf.taglib.RenderServiceTag

doStartTagInternal

Methods inherited from class org.springframework.web.servlet.tags.RequestContextAwareTag

doCatch, doFinally, doStartTag, getRequestContext

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

doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectAnchorTag

public ObjectAnchorTag()

Method Detail

setTarget

public void setTarget(String target)

getTarget

public String getTarget()

release

public void release()

The life-cycle of a custom JSP tag is that the class is is instantiated when it is first required and then re-used for all subsequent invocations. When a JSP has non-mandatory properties it means that the setters for those properties will not be called if the properties are not provided and the old values will still be available which can corrupt the behaviour of the code. In order to prevent this from happening we should override the release method to ensure that all instance variables are reset to their initial state.

Specified by:

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

Overrides:

release in class AbstractObjectTag

invokeRenderService

protected int invokeRenderService(RenderService renderService,
                      RequestContext requestContext,
                      ModelObject object)
                           throws Exception

Generates the URL to the requested resource (either a page or page type with optional object and format request parameters) and then opens an HTML anchor tag using the generated URL as the HREF argument and setting a target if provided. The body is then evaluated (which should render something to display as a link) and the doEndTag method will close the HTML anchor tag.

Specified by:

invokeRenderService in class RenderServiceTag

Parameters:

renderService - RenderService

requestContext - RequestContext

object - ModelObject

Returns:

The appropriate return code to pass on (e.g. SKIP_BODY, EVAL_BODY_INCLUDE, etc).

Throws:

javax.servlet.jsp.JspException - wrapping any IOException that may occur writing the output.

Exception

doEndTag

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

Closes the HTML anchor tag opened in doStartTag

Specified by:

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

Overrides:

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

Throws:

javax.servlet.jsp.JspException