Apache Struts API Documentation: Class ForwardTag

Apache Struts API

previous page next page

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.struts.taglib.logic Class ForwardTag

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

All Implemented Interfaces:: java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class ForwardTag
extends javax.servlet.jsp.tagext.TagSupport

Perform a forward or redirect to a page that is looked up in the configuration information associated with our application.

Version:: $Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $
See Also:: Serialized Form

Field Summary
`protected static MessageResources`	`messages` The message resources for this package.
`protected java.lang.String`	`name` The logical name of the `ActionForward` entry to be looked up.

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

id, pageContext, parent, values

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary
`ForwardTag()`

Method Summary
`int`	`doEndTag()` Look up the ActionForward associated with the specified name, and perform a forward or redirect to that path as indicated.
`protected void`	`doForward(java.lang.String path)` Forward to the given path converting exceptions to JspException.
`protected void`	`doRedirect(java.lang.String path)` Redirect to the given path converting exceptions to JspException.
`int`	`doStartTag()` Defer processing until the end of this tag is encountered.
`java.lang.String`	`getName()`
`void`	`release()` Release all allocated resources.
`void`	`setName(java.lang.String name)`

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, registerNatives, toString, wait, wait, wait

Field Detail

messages

protected static MessageResources messages

The message resources for this package.

name

protected java.lang.String name

The logical name of the ActionForward entry to be looked up.

Constructor Detail

ForwardTag

public ForwardTag()

Method Detail

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

doStartTag

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

Defer processing 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 a forward or redirect to that path as indicated.

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

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

doForward

protected void doForward(java.lang.String path)
                  throws javax.servlet.jsp.JspException

Forward to the given path converting exceptions to JspException.

Parameters:: path - The path to forward to.
Throws:: javax.servlet.jsp.JspException -
Since:: Struts 1.2

doRedirect

protected void doRedirect(java.lang.String path)
                   throws javax.servlet.jsp.JspException

Redirect to the given path converting exceptions to JspException.

Parameters:: path - The path to redirect to.
Throws:: javax.servlet.jsp.JspException -
Since:: Struts 1.2

release

public void release()

Release all allocated resources.

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