webwork.view.taglib

Class IncludeTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

javax.servlet.jsp.tagext.BodyTagSupport

webwork.view.taglib.WebWorkBodyTagSupport

webwork.view.taglib.IncludeTag

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 IncludeTag
extends WebWorkBodyTagSupport
implements ParamTag.Parametric

Include a servlets output (For example, result of servlet, or a JSP page).

Version:

$Revision: 1.24 $

Author:

Rickard Öberg (rickard@dreambean.com), Scott Farquhar

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	pageAttr
protected Map	params
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
IncludeTag()

Method Summary

Methods

Modifier and Type	Method and Description
void	addParameter(String name, Object value) Add a parameter to the URL of the included page/servlet.
int	doEndTag()
int	doStartTag()
static String	getContextRelativePath(javax.servlet.ServletRequest request, String relativePath)
static void	include(String aResult, javax.servlet.jsp.PageContext aContext)
void	setPage(String aPage) Deprecated. use value attribute instead
void	setValue(String aName) Name of property whose value is the name of the page/servlet to include.

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

pageAttr

protected String pageAttr

valueAttr

protected String valueAttr

params

protected Map params

Constructor Detail

IncludeTag

public IncludeTag()

Method Detail

include

public static void include(String aResult,
           javax.servlet.jsp.PageContext aContext)
                    throws javax.servlet.ServletException,
                           IOException

Throws:

javax.servlet.ServletException

IOException

getContextRelativePath

public static String getContextRelativePath(javax.servlet.ServletRequest request,
                            String relativePath)

setPage

public void setPage(String aPage)

Deprecated. use value attribute instead

Name of page/servlet to include.

Parameters:

aPage -

setValue

public void setValue(String aName)

Name of property whose value is the name of the page/servlet to include.

Parameters:

aName -

addParameter

public void addParameter(String name,
                Object value)

Add a parameter to the URL of the included page/servlet.

Specified by:

addParameter in interface ParamTag.Parametric

Parameters:

name -

value -

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