Apache Struts API Documentation: Class IncludeTag

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.apache.struts.taglib.bean
Class IncludeTag

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

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

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

Define the contents of a specified intra-application request as a page scope attribute of type `java.lang.String`. If the current request is part of a session, the session identifier will be included in the generated request, so it will be part of the same session.

FIXME: In a servlet 2.3 environment, we can use a wrapped response passed to RequestDispatcher.include().

Version:
  $Revision: 1.1 $ $Date: 2001-09-17 21:13:30 +0100 (Mon, 17 Sep 2001) $
Author:
  Craig R. McClanahan
See Also:
  Serialized Form

Field Summary
`protected java.lang.String` | `anchor` The anchor to be added to the end of the generated hyperlink.
`protected static int` | `BUFFER_SIZE` Buffer size to use when reading the input stream.
`protected java.lang.String` | `forward` The name of the global `ActionForward` that contains a path to our requested resource.
`protected java.lang.String` | `href` The absolute URL to the resource to be included.
`protected java.lang.String` | `id` The name of the scripting variable that will be exposed as a page scope attribute.
`protected static MessageResources` | `messages` The message resources for this package.
`protected java.lang.String` | `page` The context-relative URI of the page or servlet to be included.
`protected boolean` | `transaction` Include transaction token (if any) in the hyperlink?

Fields inherited from class javax.servlet.jsp.tagext.TagSupport
`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` | `doStartTag()` Define the contents returned for the specified resource as a page scope attribute.
`java.lang.String` | `getAnchor()`
`java.lang.String` | `getForward()`
`java.lang.String` | `getHref()`
`java.lang.String` | `getId()`
`java.lang.String` | `getPage()`
`boolean` | `getTransaction()`
`void` | `release()` Release all allocated resources.
`void` | `setAnchor(java.lang.String anchor)`
`void` | `setForward(java.lang.String forward)`
`void` | `setHref(java.lang.String href)`
`void` | `setId(java.lang.String id)`
`void` | `setName(java.lang.String name)` Deprecated. use setPage(String) instead
`void` | `setPage(java.lang.String page)`
`void` | `setTransaction(boolean transaction)`

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
`doAfterBody, doEndTag, findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue`

Methods inherited from class java.lang.Object
`, clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait`

Field Detail

### BUFFER_SIZE

    protected static final int BUFFER_SIZE

  Buffer size to use when reading the input stream.

### anchor

    protected java.lang.String anchor

  The anchor to be added to the end of the generated hyperlink.

### forward

    protected java.lang.String forward

  The name of the global `ActionForward` that contains a path to our requested resource.

### href

    protected java.lang.String href

  The absolute URL to the resource to be included.

### id

    protected java.lang.String id

  The name of the scripting variable that will be exposed as a page scope attribute.

### messages

    protected static MessageResources messages

  The message resources for this package.

### page

    protected java.lang.String page

  The context-relative URI of the page or servlet to be included.

### transaction

    protected boolean transaction

  Include transaction token (if any) in the hyperlink?

Constructor Detail

### IncludeTag

    public IncludeTag()

Method Detail

### getAnchor

    public java.lang.String getAnchor()

### setAnchor

    public void setAnchor(java.lang.String anchor)

### getForward

    public java.lang.String getForward()

### setForward

    public void setForward(java.lang.String forward)

### getHref

    public java.lang.String getHref()

### setHref

    public void setHref(java.lang.String href)

### getId

    public java.lang.String getId()

  Overrides:
    `getId` in class `javax.servlet.jsp.tagext.TagSupport`

### setId

    public void setId(java.lang.String id)

  Overrides:
    `setId` in class `javax.servlet.jsp.tagext.TagSupport`

### setName

    public void setName(java.lang.String name)

  Deprecated. use setPage(String) instead

  Deprecated method to set the "name" attribute, which has been replaced by the "page" attribute.

### getPage

    public java.lang.String getPage()

### setPage

    public void setPage(java.lang.String page)

### getTransaction

    public boolean getTransaction()

### setTransaction

    public void setTransaction(boolean transaction)

### doStartTag

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

  Define the contents returned for the specified resource as a page scope attribute.
  Overrides:
    `doStartTag` in class `javax.servlet.jsp.tagext.TagSupport`
  Throws:
    `javax.servlet.jsp.JspException` - if a JSP error occurs

### release

    public void release()

  Release all allocated resources.
  Overrides:
    `release` in class `javax.servlet.jsp.tagext.TagSupport`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2000-2001 - Apache Software Foundation