org.apache.struts.taglib
Class IncludeTag

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--org.apache.struts.taglib.IncludeTag

All Implemented Interfaces:

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

public final class IncludeTag

extends javax.servlet.jsp.tagext.TagSupport

Perform an include of a page that is looked up in the global ActionForwards collection associated with our application.

Version:

$Revision: 1.3 $ $Date: 2000/08/01 20:03:34 $

Author:

Craig R. McClanahan

See Also:

Serialized Form

Field Summary

protected static MessageResources	messages The message resources for this package.
private java.lang.String	name The logical name of the global ActionForward we will look up

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

id, pageContext, parent, values

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

int	doEndTag() Look up the ActionForward associated with the specified name, and perform an include of the corresponding actual path.
int	doStartTag() Defer generation until the end of this tag is encountered.
java.lang.String	getName() Return the logical name.
void	release() Release any acquired resources.
void	setName(java.lang.String name) Set the logicl name.

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

doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait

Field Detail

messages

protected static MessageResources messages

The message resources for this package.

name

private java.lang.String name

The logical name of the global ActionForward we will look up

Constructor Detail

IncludeTag

public IncludeTag()

Method Detail

getName

public java.lang.String getName()

Return the logical name.

setName

public void setName(java.lang.String name)

Set the logicl name.

Parameters:

name - The new logical name

doStartTag

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

Defer generation until the end of this tag is encountered.

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException - if a JSP exception has occurred

doEndTag

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

Look up the ActionForward associated with the specified name, and perform an include of the corresponding actual path.

Overrides:

doEndTag in class javax.servlet.jsp.tagext.TagSupport

Throws:

javax.servlet.jsp.JspException - if a JSP exception has occurred

release

public void release()

Release any acquired resources.

Overrides:

release in class javax.servlet.jsp.tagext.TagSupport