webwork.view.taglib

Class BasicPropertyTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

webwork.view.taglib.WebWorkBodyTagSupport

webwork.view.taglib.BasicPropertyTag

All Implemented Interfaces:

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

Direct Known Subclasses:

PropertyTag, WriteTag

public class BasicPropertyTag
extends WebWorkBodyTagSupport

Access the value of a named property. By default (implicitly), this tag will escape its contents if it does *not* have a body. If it does have a body, the tag will not escape the contents. You can explicitly tell the tag to escape or not. Quoted text that is escaped will have its quotes stripped off.

Version:

$Revision: 1.10 $

Author:

Rickard Öberg (rickard@dreambean.com), Matt Baldree (matt@smallleap.com)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	escape
protected boolean	hadBody
protected static org.apache.commons.logging.Log	log
protected String	valueAttr

Fields inherited from class webwork.view.taglib.WebWorkBodyTagSupport

stack

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

Constructors

Constructor and Description
BasicPropertyTag()

Method Summary

Methods

Modifier and Type	Method and Description
int	doAfterBody()
int	doEndTag()
int	doStartTag()
protected String	escapeValue(String value) This is called to escape a value for output.
protected void	onOutput(javax.servlet.jsp.JspWriter out, String bodyOutput) This is called when the tag has something to output.
void	setEscape(boolean inEscape)
void	setValue(String inName)
protected boolean	shouldEscape() The BasicPropertyTag should escape IF the escape value has been set to true.

Methods inherited from class webwork.view.taglib.WebWorkBodyTagSupport

findString, findValue, getStack, release, setPageContext, setParent, toString

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

doInitBody, getBodyContent, getPreviousOut, setBodyContent

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

findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, 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

Field Detail

log

protected static org.apache.commons.logging.Log log

valueAttr

protected String valueAttr

escape

protected Boolean escape

hadBody

protected boolean hadBody

Constructor Detail

BasicPropertyTag

public BasicPropertyTag()

Method Detail

setValue

public void setValue(String inName)

setEscape

public void setEscape(boolean inEscape)

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.BodyTagSupport

Throws:

javax.servlet.jsp.JspException

doAfterBody

public int doAfterBody()
                throws javax.servlet.jsp.JspException

Specified by:

doAfterBody in interface javax.servlet.jsp.tagext.IterationTag

Overrides:

doAfterBody in class javax.servlet.jsp.tagext.BodyTagSupport

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 WebWorkBodyTagSupport

Throws:

javax.servlet.jsp.JspException

onOutput

protected void onOutput(javax.servlet.jsp.JspWriter out,
            String bodyOutput)
                 throws IOException

This is called when the tag has something to output. By default it does just that, it writes the output but it you may override this method and do something else if you like

Parameters:

out - the JspWriter to use

bodyOutput - the content to write

Throws:

IOException - because we are involved in that game

shouldEscape

protected boolean shouldEscape()

The BasicPropertyTag should escape IF the escape value has been set to true. At all other times it will false (ie not escape data).

CHANGE THIS METHOD ON PAIN OF DEATH -mike :)

See Also:

PropertyTag.shouldEscape()

escapeValue

protected String escapeValue(String value)

This is called to escape a value for output. By default it uses HTML escaping. A subclass can overrride this and use some other escaping mechanism

Parameters:

value - the value to be escaped

Returns:

the escaped value