Apache Struts API Documentation: Class SizeTag

From 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 SizeTag

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

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

Direct Known Subclasses:: NestedSizeTag

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

Define a scripting variable that will contain the number of elements found in a specified array, Collection, or Map.

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

Field Summary
`protected java.lang.Object`	`collection` The actual collection to be counted.
`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`	`name` The name of the bean owning the property to be counted.
`protected java.lang.String`	`property` The name of the property to be retrieved.
`protected java.lang.String`	`scope` The scope within which to search for the specified bean.

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

Method Summary
`int`	`doStartTag()` Retrieve the required property and expose it as a scripting variable.
`java.lang.Object`	`getCollection()`
`java.lang.String`	`getId()`
`java.lang.String`	`getName()`
`java.lang.String`	`getProperty()`
`java.lang.String`	`getScope()`
`void`	`release()` Release all allocated resources.
`void`	`setCollection(java.lang.Object collection)`
`void`	`setId(java.lang.String id)`
`void`	`setName(java.lang.String name)`
`void`	`setProperty(java.lang.String property)`
`void`	`setScope(java.lang.String scope)`

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

collection

protected java.lang.Object collection

The actual collection to be counted.

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.

name

protected java.lang.String name

The name of the bean owning the property to be counted.

property

protected java.lang.String property

The name of the property to be retrieved.

scope

protected java.lang.String scope

The scope within which to search for the specified bean.

Constructor Detail

SizeTag

public SizeTag()

Method Detail

getCollection

public java.lang.Object getCollection()

setCollection

public void setCollection(java.lang.Object collection)

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

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getProperty

public java.lang.String getProperty()

setProperty

public void setProperty(java.lang.String property)

getScope

public java.lang.String getScope()

setScope

public void setScope(java.lang.String scope)

doStartTag

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

Retrieve the required property 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