org.apache.taglibs.string
Class OverlayTag

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--javax.servlet.jsp.tagext.BodyTagSupport
              |
              +--org.apache.taglibs.string.StringTagSupport
                    |
                    +--org.apache.taglibs.string.OverlayTag

All Implemented Interfaces:

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

public class OverlayTag

extends StringTagSupport

Overlay a String on top of another String. The length of the String to overlay does not have to be the same as the size of substring it replaces.

with

String to overlay onto the body. Required.

start

Start index. Required.

end

Index to end before. Required.

Author:

bayard@generationjava.com

See Also:

Serialized Form

Fields inherited from class javax.servlet.jsp.tagext.BodyTagSupport

bodyContent

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

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

EVAL_BODY_BUFFERED, EVAL_BODY_TAG

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

OverlayTag()

Method Summary

java.lang.String	changeString(java.lang.String text) Perform a transformation on the passed in String.
java.lang.String	getEnd() Get the end property
java.lang.String	getStart() Get the start property
java.lang.String	getWith() Get the with property
void	initAttributes() Initialise any properties to default values.
void	setEnd(java.lang.String end) Set the end property
void	setStart(java.lang.String start) Set the start property
void	setWith(java.lang.String with) Set the with property

Methods inherited from class org.apache.taglibs.string.StringTagSupport

doEndTag, evaluateString, getVar, setVar

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

doAfterBody, doInitBody, doStartTag, getBodyContent, getPreviousOut, release, setBodyContent

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

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

Methods inherited from interface javax.servlet.jsp.tagext.Tag

getParent, setPageContext, setParent

Constructor Detail

OverlayTag

public OverlayTag()

Method Detail

getWith

public java.lang.String getWith()

Get the with property

Returns:

String property

setWith

public void setWith(java.lang.String with)

Set the with property

Parameters:

with - String property

getStart

public java.lang.String getStart()

Get the start property

Returns:

String property

setStart

public void setStart(java.lang.String start)

Set the start property

Parameters:

start - String property

getEnd

public java.lang.String getEnd()

Get the end property

Returns:

String property

setEnd

public void setEnd(java.lang.String end)

Set the end property

Parameters:

end - String property

changeString

public java.lang.String changeString(java.lang.String text)
                              throws javax.servlet.jsp.JspException

Description copied from class: StringTagSupport

Perform a transformation on the passed in String.

Overrides:

changeString in class StringTagSupport

Following copied from class: org.apache.taglibs.string.StringTagSupport

Parameters:

str - String to be manipulated

Returns:

String result of operation upon passed in String

initAttributes

public void initAttributes()

Description copied from class: StringTagSupport

Initialise any properties to default values. This method is called upon construction, and after changeString(String) is called. This is a default empty implementation.

Overrides:

initAttributes in class StringTagSupport