Apache Struts API Documentation: Class PageTag

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 PageTag

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

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

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

Define a scripting variable that exposes the requested page context item as a scripting variable and a page scope bean.

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`	`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`	`property` The name of the page context property to be retrieved.

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
`PageTag()`

Method Summary
`int`	`doStartTag()` Retrieve the required configuration object and expose it as a scripting variable.
`java.lang.String`	`getId()`
`java.lang.String`	`getProperty()`
`void`	`release()` Release all allocated resources.
`void`	`setId(java.lang.String id)`
`void`	`setProperty(java.lang.String property)`

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.

property

protected java.lang.String property

The name of the page context property to be retrieved.

Constructor Detail

PageTag

public PageTag()

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

getProperty

public java.lang.String getProperty()

setProperty

public void setProperty(java.lang.String property)

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