org.apache.struts.taglib
Class OptionsTag

org.apache.struts.taglib.OptionsTag

public final class OptionsTag

Tag for creating multiple <select> options from a collection. The associated values displayed to the user may optionally be specified by a second collection, or will be the same as the values themselves. Each collection may be an array of objects, a Collection, an Iterator, or a Map. NOTE - This tag requires a Java2 (JDK 1.2 or later) platform.

Author:
Florent Carpentier, Craig McClanahan

Field Summary
private  java.lang.String labelName
          The name of the bean containing the labels collection.
private  java.lang.String labelProperty
          The bean property containing the labels collection.
protected static MessageResources messages
          The message resources for this package.
private  java.lang.String name
          The name of the bean containing the values collection.
private  java.lang.String property
          The name of the property to use to build the values collection.
 
Constructor Summary
OptionsTag()
           
 
Method Summary
 int doEndTag()
          Process the end of this tag.
 int doStartTag()
          Process the start of this tag.
private  java.util.Iterator getIterator(java.lang.String name, java.lang.String property)
          Return an iterator for the option labels or values, based on our configured properties.
 java.lang.String getLabelName()
           
 java.lang.String getLabelProperty()
           
 java.lang.String getName()
           
 java.lang.String getProperty()
           
 void release()
          Release any acquired resources.
 void setLabelName(java.lang.String labelName)
           
 void setLabelProperty(java.lang.String labelProperty)
           
 void setName(java.lang.String name)
           
 void setProperty(java.lang.String property)
           
 

Field Detail

messages

protected static MessageResources messages
The message resources for this package.

labelName

private java.lang.String labelName
The name of the bean containing the labels collection.

labelProperty

private java.lang.String labelProperty
The bean property containing the labels collection.

name

private java.lang.String name
The name of the bean containing the values collection.

property

private java.lang.String property
The name of the property to use to build the values collection.
Constructor Detail

OptionsTag

public OptionsTag()
Method Detail

getLabelName

public java.lang.String getLabelName()

setLabelName

public void setLabelName(java.lang.String labelName)

getLabelProperty

public java.lang.String getLabelProperty()

setLabelProperty

public void setLabelProperty(java.lang.String labelProperty)

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)

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException
Process the start of this tag.
Throws:
JspException - if a JSP exception has occurred

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException
Process the end of this tag.
Throws:
JspException - if a JSP exception has occurred

release

public void release()
Release any acquired resources.

getIterator

private java.util.Iterator getIterator(java.lang.String name,
                                       java.lang.String property)
                                throws javax.servlet.jsp.JspException
Return an iterator for the option labels or values, based on our configured properties.
Parameters:
name - Name of the bean attribute (if any)
property - Name of the bean property (if any)
Throws:
JspException - if an error occurs


Copyright © 2000-2002 - Apache Software Foundation