org.hippoecm.hst.tag

Class SiteMapItemTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.hippoecm.hst.tag.SiteMapItemTag

All Implemented Interfaces:

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

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

A tag handler for the siteItemTag tag. Defines a sitemap item that can be added to a HstLinkTag. If a sitemap item is added to a HstLinkTag, it means that for linkrewriting, this sitemap item + descendants have precedence for rewriting the link. Depending on whether fallback is true or false, a fallback to original linkrewriting is done when the preferred sitemap item cannot create a link.
The following attributes are allowed: To define the preferred sitemap item, one of the following attributes needs to be defined

1. preferItem : the preferred sitemap item (HstSiteMapItem)
2. preferItemId : the id of the preferred sitemap item (java.lang.String)
3. preferPath : the pathInfo (url) of the preferred sitemap item (java.lang.String)
4. preferItemByPath : the preferred sitemap item by path for freemarker (java.lang.String)

When fallback must be false, you can use attribute:

• fallback : true|false (java.lang.String)

Default fallback = true

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	fallback
protected String	preferItemId
protected String	preferPath
protected HstSiteMapItem	siteMapItem
protected boolean	skipTag

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

Method Summary

Modifier and Type	Method and Description
protected void	cleanup()
int	doStartTag()
HstSiteMapItem	getPreferItem() Returns the name.
void	setFallback(boolean fallback) Sets the fallback
void	setPreferItem(HstSiteMapItem siteMapItem) Sets the siteMapItem.
void	setPreferItemId(String preferItemId)
void	setPreferPath(String preferPath)

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

doAfterBody, doEndTag, 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

Field Detail

siteMapItem

protected HstSiteMapItem siteMapItem

fallback

protected boolean fallback

preferItemId

protected String preferItemId

preferPath

protected String preferPath

skipTag

protected boolean skipTag

Constructor Detail

SiteMapItemTag

public SiteMapItemTag()

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

cleanup

protected void cleanup()

getPreferItem

public HstSiteMapItem getPreferItem()

Returns the name.

Returns:

String

setPreferItem

public void setPreferItem(HstSiteMapItem siteMapItem)

Sets the siteMapItem.

Parameters:

siteMapItem - to set

setPreferItemId

public void setPreferItemId(String preferItemId)

setPreferPath

public void setPreferPath(String preferPath)

setFallback

public void setFallback(boolean fallback)

Sets the fallback

Parameters:

fallback - to set