ForwardTag (Struts 1.3.10 API)

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | 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:
  Serializable, IterationTag, Tag

Direct Known Subclasses:
  ELForwardTag

    public class ForwardTag

extends TagSupport

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

Version:
  $Rev: 471754 $ $Date: 2004-10-16 12:38:42 -0400 (Sat, 16 Oct 2004) $
See Also:
  Serialized Form

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

Fields inherited from class javax.servlet.jsp.tagext.TagSupport
`id, pageContext`

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
`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(String path)` Forward to the given path converting exceptions to JspException.
`protected void` | `doRedirect(String path)` Redirect to the given path converting exceptions to JspException.
`int` | `doStartTag()` Defer processing until the end of this tag is encountered.
`String` | `getName()`
`void` | `release()` Release all allocated resources.
`void` | `setName(String 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, toString, wait, wait, wait`

Field Detail

### messages

    protected static MessageResources messages

  The message resources for this package.

### name

    protected String name

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

Constructor Detail

### ForwardTag

    public ForwardTag()

Method Detail

### getName

    public String getName()

### setName

    public void setName(String name)

### doStartTag

    public int doStartTag()
                   throws JspException

  Defer processing until the end of this tag is encountered.

  Specified by:
    `doStartTag` in interface `Tag`
  Overrides:
    `doStartTag` in class `TagSupport`
  Throws:
    `JspException` - if a JSP exception has occurred

### doEndTag

    public int doEndTag()
                 throws JspException

  Look up the ActionForward associated with the specified name, and perform a forward or redirect to that path as indicated.

  Specified by:
    `doEndTag` in interface `Tag`
  Overrides:
    `doEndTag` in class `TagSupport`
  Throws:
    `JspException` - if a JSP exception has occurred

### doForward

    protected void doForward(String path)
                      throws JspException

  Forward to the given path converting exceptions to JspException.

  Parameters:
    `path` - The path to forward to.
  Throws:
    `JspException`
  Since:
    Struts 1.2

### doRedirect

    protected void doRedirect(String path)
                       throws JspException

  Redirect to the given path converting exceptions to JspException.

  Parameters:
    `path` - The path to redirect to.
  Throws:
    `JspException`
  Since:
    Struts 1.2

### release

    public void release()

  Release all allocated resources.

  Specified by:
    `release` in interface `Tag`
  Overrides:
    `release` in class `TagSupport`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2008 Apache Software Foundation. All Rights Reserved.