com.opensymphony.webwork.views.jsp
Class IncludeTag

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended byjavax.servlet.jsp.tagext.BodyTagSupport
          extended bycom.opensymphony.webwork.views.jsp.WebWorkBodyTagSupport
              extended bycom.opensymphony.webwork.views.jsp.IncludeTag
All Implemented Interfaces:
BodyTag, IterationTag, ParamTag.Parametric, Serializable, Tag

public class IncludeTag
extends WebWorkBodyTagSupport
implements ParamTag.Parametric

Include a servlet's output (result of servlet or a JSP page).

Version:
$Revision: 1.15 $
Author:
Rickard ???berg (rickard@dreambean.com), Scott Farquhar
See Also:
Serialized Form

Field Summary
protected  String pageAttr
           
protected  Map params
           
protected  String valueAttr
           
 
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
IncludeTag()
           
 
Method Summary
 void addParameter(String name, Object value)
          Add a parameter to the URL of the included page/servlet.
 int doEndTag()
           
 int doStartTag()
           
static String getContextRelativePath(ServletRequest request, String relativePath)
           
 Map getParameters()
           
static void include(String aResult, 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 com.opensymphony.webwork.views.jsp.WebWorkBodyTagSupport
findString, findValue, findValue, getStack, toString
 
Methods inherited from class javax.servlet.jsp.tagext.BodyTagSupport
doAfterBody, doInitBody, 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
 

Field Detail

params

protected Map params

pageAttr

protected String pageAttr

valueAttr

protected String valueAttr
Constructor Detail

IncludeTag

public IncludeTag()
Method Detail

getContextRelativePath

public static String getContextRelativePath(ServletRequest request,
                                            String relativePath)

include

public static void include(String aResult,
                           PageContext aContext)
                    throws ServletException,
                           IOException
Throws:
ServletException
IOException

setPage

public void setPage(String aPage)
Deprecated. use value attribute instead

Name of page/servlet to include.

Parameters:
aPage -

getParameters

public Map getParameters()
Specified by:
getParameters in interface ParamTag.Parametric

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 -

doEndTag

public int doEndTag()
             throws JspException
Specified by:
doEndTag in interface Tag
Throws:
JspException

doStartTag

public int doStartTag()
               throws JspException
Specified by:
doStartTag in interface Tag
Throws:
JspException

WebWork Project Page