webwork.view.taglib

Class URLTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

webwork.view.taglib.WebWorkBodyTagSupport

webwork.view.taglib.URLTag

All Implemented Interfaces:

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

public class URLTag
extends WebWorkBodyTagSupport
implements ParamTag.Parametric

This tag is used to create a URL. You can use the "param" tag inside the body to provide additional request parameters.

Version:

$Revision: 1.27 $

Author:

Rickard Öberg (rickard@dreambean.com)

See Also:

ParamTag, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL
static String	GET
static String	NONE The includeParams attribute may have the value 'none', 'get' or 'all'.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(String name, Object value)
int	doEndTag()
int	doStartTag()
protected String	htmlEscape(String value) Template method to allow overriding the HTML escaping of our output
void	setIncludeContext(boolean includeContext)
void	setPage(String aName) Deprecated. use value instead
void	setValue(String aName)
protected String	urlEncode(String value) Template method to allow overriding of the URL encoding used.

Methods inherited from class webwork.view.taglib.WebWorkBodyTagSupport

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

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

doAfterBody, 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

NONE

public static final String NONE

The includeParams attribute may have the value 'none', 'get' or 'all'. It is used when the url tag is used without a value or page attribute. Its value is looked up on the ValueStack If no includeParams is specified then 'get' is used. none - include no parameters in the URL get - include only GET parameters in the URL (default) all - include both GET and POST parameters in the URL

See Also:

Constant Field Values

GET

public static final String GET

See Also:

Constant Field Values

ALL

public static final String ALL

See Also:

Constant Field Values

Constructor Detail

URLTag

public URLTag()

Method Detail

setPage

@Deprecated
public void setPage(String aName)

Deprecated. use value instead

setValue

public void setValue(String aName)

setIncludeContext

public void setIncludeContext(boolean includeContext)

addParameter

public void addParameter(String name,
                Object value)

Specified by:

addParameter in interface ParamTag.Parametric

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

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

htmlEscape

protected String htmlEscape(String value)

Template method to allow overriding the HTML escaping of our output

Parameters:

value - the string to HTML escape

Returns:

a HTML escaped value

urlEncode

protected String urlEncode(String value)

Template method to allow overriding of the URL encoding used.

Parameters:

value - the string to be URL encoded

Returns:

a URL encoded string please