org.hippoecm.hst.tag

Class BaseHstURLTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.hippoecm.hst.tag.ParamContainerTag

org.hippoecm.hst.tag.BaseHstURLTag

All Implemented Interfaces:

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

Direct Known Subclasses:

HstActionURLTag, HstComponentRenderingURLTag, HstRenderURLTag, HstResourceURLTag

public abstract class BaseHstURLTag
extends ParamContainerTag

Abstract supporting class for Hst URL tags (action, redner and resource)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	escapeXml
protected boolean	fullyQualified
protected String	resourceId
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
BaseHstURLTag()

Method Summary

Modifier and Type	Method and Description
protected void	cleanup()
int	doEndTag()
protected String	doEscapeXml(String str) Replaces in String str the characters &,>,<,",' with their corresponding character entity codes.
int	doStartTag()
Boolean	getEscapeXml() Returns escapeXml property.
String	getResourceId() Returns resource ID property
protected abstract HstURL	getUrl()
String	getVar() Returns the var property.
boolean	isFullyQualified() Returns true if the generated URL should be a fully qualified URL, starting with 'http://' or 'https://', etc.
void	release()
void	setEscapeXml(Boolean escapeXml) Sets the escapeXml property.
void	setFullyQualified(boolean fullyQualified) Sets the flag to generate URL as a fully qualified URL, starting with 'http://' or 'https://', etc.
void	setResourceId(String resourceId) Sets the resource ID property.
protected abstract void	setUrl(HstURL url)
protected void	setUrlParameters(HstURL url) Copies the parameters from map to the BaseURL.
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

var

protected String var

escapeXml

protected Boolean escapeXml

resourceId

protected String resourceId

fullyQualified

protected boolean fullyQualified

Constructor Detail

BaseHstURLTag

public BaseHstURLTag()

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

getEscapeXml

public Boolean getEscapeXml()

Returns escapeXml property.

Returns:

Boolean

getResourceId

public String getResourceId()

Returns resource ID property

Returns:

isFullyQualified

public boolean isFullyQualified()

Returns true if the generated URL should be a fully qualified URL, starting with 'http://' or 'https://', etc.

Returns:

setVar

public void setVar(String var)

Sets the var property.

Parameters:

var - The var to set

setEscapeXml

public void setEscapeXml(Boolean escapeXml)

Sets the escapeXml property.

Parameters:

escapeXml -

setResourceId

public void setResourceId(String resourceId)

Sets the resource ID property.

Parameters:

resourceId -

setFullyQualified

public void setFullyQualified(boolean fullyQualified)

Sets the flag to generate URL as a fully qualified URL, starting with 'http://' or 'https://', etc.

setUrlParameters

protected void setUrlParameters(HstURL url)

Copies the parameters from map to the BaseURL.

Parameters:

url - BaseURL

getUrl

protected abstract HstURL getUrl()

Returns:

the url

setUrl

protected abstract void setUrl(HstURL url)

Parameters:

url - the url to set

doEscapeXml

protected String doEscapeXml(String str)

Replaces in String str the characters &,>,<,",' with their corresponding character entity codes.

Parameters:

str - - the String where to replace

Returns:

String