org.dd4t.mvc.tags

Class SmartIncludeTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.dd4t.mvc.tags.SmartIncludeTag

All Implemented Interfaces:

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

public class SmartIncludeTag
extends javax.servlet.jsp.tagext.TagSupport

SmartInclude Tag. JSP Tag which takes a 'page' parameter to include in the current JSP page.

If the page is not found in the given path and the page attribute on the tag does not start with a slash, the tag logic will search the parent paths one by one until a match is found. Existence will first be checked whether this is the case, in order to prevent heavy loading.

Since include pages are published through Tridion, the DD4T PageFactory is used. This also means that full DD4T rendering is initiated.

Important note: if the to be included page uses the same view as the 'parent' page, Spring MVC will throw an error, because of the danger of having circular view inclusions, and thus infinite loops. Therefore, a different view must always be used.

Usage

Author:

R. Kempees

See Also:

Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method and Description
int	doEndTag()
int	doStartTag()
String	getPage() Gets the set page URL
void	setPage(String page) Set page url to include.

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

doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, 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

SmartIncludeTag

public SmartIncludeTag()

Method Detail

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

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

Returns:

int

Throws:

javax.servlet.jsp.JspException

See Also:

super.doEndTag()

getPage

public String getPage()

Gets the set page URL

Returns:

String the URL

setPage

public void setPage(String page)

Set page url to include. Must be a published DD4T Tridion URL

Parameters:

page - the page URL to include