org.hippoecm.hst.tag

Class HstLinkTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.hippoecm.hst.tag.ParamContainerTag

org.hippoecm.hst.tag.HstLinkTag

All Implemented Interfaces:

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

public class HstLinkTag
extends ParamContainerTag

Abstract supporting class for Hst Link tags

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HstLinkTag.TEI TagExtraInfo class for HstURLTag.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	canonical boolean indicating whether the link that will be created is the canonical link.
protected Boolean	escapeXml
protected boolean	fallback whether to fallback to normal linkrewriting when the preferSiteMapItem was not able to linkrewrite the item.
protected boolean	fullyQualified
protected IdentifiableContentBean	identifiableContentBean
protected HstLink	link
protected boolean	linkForAttributeSet Whether either the link, path, identifiableContentBean or siteMapItemRefId did have its setter called.
protected String	mountAlias The alias of the mount the link is meant for
protected String	mountType The type of the mount the link is meant for
protected boolean	navigationStateful boolean indicating whether the link that will be created is wrt the current URL and virtual location of the jcr Node backing the HippoBean or wrt the canonical location.
protected String	nodeId
protected String	path
protected HstSiteMapItem	preferSiteMapItem if defined, first a link for this preferSiteMapItem is tried to be created.
protected String	scope
protected String	siteMapItemRefId
protected boolean	skipTag
protected String	subPath
static String	UNALLOWED_ATTR_COMBINATION_MSG
protected String	var

Fields inherited from class org.hippoecm.hst.tag.ParamContainerTag

parametersMap, removedParametersList

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

Method Summary

Modifier and Type	Method and Description
protected void	cleanup()
int	doEndTag()
int	doStartTag()
Boolean	getEscapeXml() Returns escapeXml property.
IdentifiableContentBean	getHippobean()
HstLink	getLink()
String	getMount()
String	getMountType()
String	getNodeId()
String	getPath()
String	getScope()
String	getSubPath()
String	getVar() Returns the var property.
boolean	isFullyQualified()
void	release()
void	setCanonical(boolean canonical)
void	setEscapeXml(Boolean escapeXml) Sets the escapeXml property.
void	setFallback(boolean fallback)
void	setFullyQualified(boolean fullyQualified)
void	setHippobean(IdentifiableContentBean identifiableContentBean)
void	setLink(HstLink hstLink)
void	setMount(String mount)
void	setMountType(String mountType)
void	setNavigationStateful(boolean navigationStateful)
void	setNodeId(String nodeId)
void	setPath(String path)
void	setPreferredSiteMapItem(HstSiteMapItem preferSiteMapItem)
void	setScope(String scope)
void	setSiteMapItemRefId(String siteMapItemRefId)
void	setSubPath(String subPath)
void	setVar(String var) Sets the var property.

Methods inherited from class org.hippoecm.hst.tag.ParamContainerTag

addParameter

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

Field Detail

UNALLOWED_ATTR_COMBINATION_MSG

public static final String UNALLOWED_ATTR_COMBINATION_MSG

See Also:

Constant Field Values

link

protected HstLink link

identifiableContentBean

protected IdentifiableContentBean identifiableContentBean

nodeId

protected String nodeId

path

protected String path

siteMapItemRefId

protected String siteMapItemRefId

subPath

protected String subPath

var

protected String var

scope

protected String scope

fullyQualified

protected boolean fullyQualified

canonical

protected boolean canonical

boolean indicating whether the link that will be created is the canonical link. The canonical link is always the same, regardless the current context, in other words, regardless the current URL.

navigationStateful

protected boolean navigationStateful

boolean indicating whether the link that will be created is wrt the current URL and virtual location of the jcr Node backing the HippoBean or wrt the canonical location. Note that this is different then the variable canonical : canonical true or false refers to whether the link should be created wrt the current url or not.

mountAlias

protected String mountAlias

The alias of the mount the link is meant for

mountType

protected String mountType

The type of the mount the link is meant for

skipTag

protected boolean skipTag

preferSiteMapItem

protected HstSiteMapItem preferSiteMapItem

if defined, first a link for this preferSiteMapItem is tried to be created.

fallback

protected boolean fallback

whether to fallback to normal linkrewriting when the preferSiteMapItem was not able to linkrewrite the item. Default true

linkForAttributeSet

protected boolean linkForAttributeSet

Whether either the link, path, identifiableContentBean or siteMapItemRefId did have its setter called. Also, only one of the setters is allowed. If none called, we return a hst link for the current URL

escapeXml

protected Boolean escapeXml

Constructor Detail

HstLinkTag

public HstLinkTag()

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 ParamContainerTag

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

Throws:

javax.servlet.jsp.JspException

cleanup

protected void cleanup()

Overrides:

cleanup in class ParamContainerTag

release

public void release()

Specified by:

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

Overrides:

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

getVar

public String getVar()

Returns the var property.

Returns:

String

getScope

public String getScope()

getLink

public HstLink getLink()

getHippobean

public IdentifiableContentBean getHippobean()

getNodeId

public String getNodeId()

getPath

public String getPath()

getSubPath

public String getSubPath()

getEscapeXml

public Boolean getEscapeXml()

Returns escapeXml property.

Returns:

Boolean

setLink

public void setLink(HstLink hstLink)

setFullyQualified

public void setFullyQualified(boolean fullyQualified)

isFullyQualified

public boolean isFullyQualified()

setPath

public void setPath(String path)

setSiteMapItemRefId

public void setSiteMapItemRefId(String siteMapItemRefId)

setSubPath

public void setSubPath(String subPath)

setCanonical

public void setCanonical(boolean canonical)

setNavigationStateful

public void setNavigationStateful(boolean navigationStateful)

setHippobean

public void setHippobean(IdentifiableContentBean identifiableContentBean)

setNodeId

public void setNodeId(String nodeId)

setMount

public void setMount(String mount)

getMount

public String getMount()

getMountType

public String getMountType()

setMountType

public void setMountType(String mountType)

setVar

public void setVar(String var)

Sets the var property.

Parameters:

var - The var to set

setScope

public void setScope(String scope)

setEscapeXml

public void setEscapeXml(Boolean escapeXml)

Sets the escapeXml property.

Parameters:

escapeXml -

setPreferredSiteMapItem

public void setPreferredSiteMapItem(HstSiteMapItem preferSiteMapItem)

setFallback

public void setFallback(boolean fallback)