atg.epub.pws.taglib
Class EscapeHTMLTextTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      atg.web.tagsupport.PageVariableTagSupport
          atg.epub.pws.taglib.EscapeHTMLTextTag

All Implemented Interfaces:

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

public class EscapeHTMLTextTag
extends atg.web.tagsupport.PageVariableTagSupport

Support for HTML escaping and truncating text

See Also:

Serialized Form

Nested Class Summary

static class

EscapeHTMLTextTag.TEI TagExtraInfo class to handle var/id processing.

Field Summary

static java.lang.String

CLASS_VERSION Class version string

Fields inherited from class atg.web.tagsupport.PageVariableTagSupport

sResourceBundle

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

EscapeHTMLTextTag()
Constructs an instanceof PagingEnvTag

Method Summary

int	doStartTag() Tag which truncates or escapes a string
java.lang.String	getAppendedText()
java.lang.String	getEscapedText()
int	getMaxLength()
java.lang.String	getText()
boolean	getTrimmed()
void	release() Releases the tag
void	setAppendedText(java.lang.String pAppendedText) Sets text to add to end of truncated string
void	setEscapedText(java.lang.String pEscapedText) Sets the escaped text
void	setMaxLength(int pMaxLength) Sets length for truncating string if necessary
void	setText(java.lang.String pText) Sets the text to escape or truncate
void	setTrimmed(boolean pTrimmed) Sets flag indicating whether or not string was truncated

Methods inherited from class atg.web.tagsupport.PageVariableTagSupport

getDynamoRequest, getId, getVar, isBlank, setId, setPageVariable, setScope, setVar

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

doAfterBody, doEndTag, findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

Constructor Detail

EscapeHTMLTextTag

public EscapeHTMLTextTag()

Constructs an instanceof PagingEnvTag

Method Detail

setText

public void setText(java.lang.String pText)

Sets the text to escape or truncate

Parameters:

pText - the text to escape or truncate

getText

public java.lang.String getText()

Returns:

the text to escape or truncate

setMaxLength

public void setMaxLength(int pMaxLength)

Sets length for truncating string if necessary

Parameters:

pMaxLength - length for truncating string

getMaxLength

public int getMaxLength()

Returns:

maximum length of string. if string length longer then truncate

setTrimmed

public void setTrimmed(boolean pTrimmed)

Sets flag indicating whether or not string was truncated

Parameters:

pTrimmed - flag indicating whether or not string was truncated

getTrimmed

public boolean getTrimmed()

Returns:

flag indicating whether or not string was truncated

setAppendedText

public void setAppendedText(java.lang.String pAppendedText)

Sets text to add to end of truncated string

Parameters:

pAppendedText - the text to append to end of truncated string

getAppendedText

public java.lang.String getAppendedText()

Returns:

the text to add to end of truncated string

setEscapedText

public void setEscapedText(java.lang.String pEscapedText)

Sets the escaped text

Parameters:

pEscapedText - the escaped text

getEscapedText

public java.lang.String getEscapedText()

Returns:

the escaped string

doStartTag

public int doStartTag()

Tag which truncates or escapes a string

Specified by:

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

Overrides:

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

release

public void release()

Releases the tag

Specified by:

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

Overrides:

release in class atg.web.tagsupport.PageVariableTagSupport