Apache Struts API Documentation: Class StrutsTag

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.bean Class StrutsTag

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

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

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

Define a scripting variable that exposes the requested Struts internal configuraton object.

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

Field Summary
`protected java.lang.String`	`formBean` The name of the `ActionFormBean` object to be exposed.
`protected java.lang.String`	`forward` The name of the `ActionForward` object to be exposed.
`protected java.lang.String`	`id` The name of the scripting variable that will be exposed as a page scope attribute.
`protected java.lang.String`	`mapping` The name of the `ActionMapping` object to be exposed.
`protected static MessageResources`	`messages` The message resources for this package.

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

pageContext, parent, values

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary
`StrutsTag()`

Method Summary
`int`	`doStartTag()` Retrieve the required configuration object and expose it as a scripting variable.
`java.lang.String`	`getFormBean()`
`java.lang.String`	`getForward()`
`java.lang.String`	`getId()`
`java.lang.String`	`getMapping()`
`void`	`release()` Release all allocated resources.
`void`	`setFormBean(java.lang.String formBean)`
`void`	`setForward(java.lang.String forward)`
`void`	`setId(java.lang.String id)`
`void`	`setMapping(java.lang.String mapping)`

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

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

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.

formBean

protected java.lang.String formBean

The name of the ActionFormBean object to be exposed.

forward

protected java.lang.String forward

The name of the ActionForward object to be exposed.

mapping

protected java.lang.String mapping

The name of the ActionMapping object to be exposed.

Constructor Detail

StrutsTag

public StrutsTag()

Method Detail

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

getFormBean

public java.lang.String getFormBean()

setFormBean

public void setFormBean(java.lang.String formBean)

getForward

public java.lang.String getForward()

setForward

public void setForward(java.lang.String forward)

getMapping

public java.lang.String getMapping()

setMapping

public void setMapping(java.lang.String mapping)

doStartTag

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

Retrieve the required configuration object and expose it as a scripting variable.

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

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

release

public void release()

Release all allocated resources.

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