org.hippoecm.hst.tag

Class HstHtmlTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.hippoecm.hst.tag.HstHtmlTag

All Implemented Interfaces:

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	HstHtmlTag.RewriteMode
static class	HstHtmlTag.TEI TagExtraInfo class for HstURLTag.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	canonicalLinks boolean indicating whether possible available internal links will be created as canonicalLinks links.
protected ContentRewriter<String>	contentRewriter
protected String	formattedText
protected boolean	fullyQualifiedLinks Whether links should be rewritten to fully qualified links (URLs) including scheme, host, port etc.
protected HippoHtml	hippoHtml
protected ImageVariant	imageVariant Holds the ImageVariant when there is configured an ImageVariant and is null when no image variant has been specified
protected String	scope
protected String	text
protected String	var

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

Method Summary

Modifier and Type	Method and Description
protected void	cleanup()
int	doEndTag()
int	doStartTag()
ContentRewriter<String>	getContentRewriter()
HippoHtml	getHippohtml()
ContentRewriter<String>	getOrCreateContentRewriter()
String	getScope()
String	getVar() Returns the var property.
void	release()
void	setCanonicalLinks(boolean canonicalLinks)
void	setContentRewriter(ContentRewriter<String> contentRewriter)
void	setFormattedText(String formattedText)
void	setFullyQualifiedLinks(boolean fullyQualifiedLinks)
void	setHippohtml(HippoHtml hippoHtml)
void	setImageVariant(ImageVariant imageVariant)
void	setScope(String scope)
void	setText(String text)
void	setVar(String var) Sets the var property.

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

hippoHtml

protected HippoHtml hippoHtml

var

protected String var

scope

protected String scope

contentRewriter

protected ContentRewriter<String> contentRewriter

formattedText

protected String formattedText

text

protected String text

canonicalLinks

protected boolean canonicalLinks

boolean indicating whether possible available internal links will be created as canonicalLinks links. The canonicalLinks link is always the same, regardless the current context, in other words, regardless the current URL.

fullyQualifiedLinks

protected boolean fullyQualifiedLinks

Whether links should be rewritten to fully qualified links (URLs) including scheme, host, port etc. Default false

imageVariant

protected ImageVariant imageVariant

Holds the ImageVariant when there is configured an ImageVariant and is null when no image variant has been specified

Constructor Detail

HstHtmlTag

public HstHtmlTag()

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

Throws:

javax.servlet.jsp.JspException

release

public void release()

Specified by:

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

Overrides:

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

cleanup

protected void cleanup()

getVar

public String getVar()

Returns the var property.

Returns:

String

getScope

public String getScope()

getHippohtml

public HippoHtml getHippohtml()

getContentRewriter

public ContentRewriter<String> getContentRewriter()

getOrCreateContentRewriter

public ContentRewriter<String> getOrCreateContentRewriter()

setFullyQualifiedLinks

public void setFullyQualifiedLinks(boolean fullyQualifiedLinks)

Parameters:

fullyQualifiedLinks - flag to define whether internal links are rewritten into fully qualified links (URLs) (including scheme and domain)

setCanonicalLinks

public void setCanonicalLinks(boolean canonicalLinks)

setVar

public void setVar(String var)

Sets the var property.

Parameters:

var - The var to set

setScope

public void setScope(String scope)

setHippohtml

public void setHippohtml(HippoHtml hippoHtml)

setContentRewriter

public void setContentRewriter(ContentRewriter<String> contentRewriter)

setImageVariant

public void setImageVariant(ImageVariant imageVariant)

setFormattedText

public void setFormattedText(String formattedText)

setText

public void setText(String text)