IBM Branch Transformation Toolkit Javadoc

com.ibm.btt.struts.taglib.html
Class ListTag

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended bycom.ibm.btt.struts.taglib.html.StrutsTagSupport
          extended bycom.ibm.btt.struts.taglib.html.DSEListTagSupport
              extended bycom.ibm.btt.struts.taglib.html.ListTag
All Implemented Interfaces:
javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

public class ListTag
extends DSEListTagSupport

This class implements the ListTag that creates Lists.

The following tag attributes can be associated with the ListTag:

The ListTag can also contain tag attributs defined by its subclass, DSEListTagSupport.

See Also:
Serialized Form

Field Summary
protected  java.lang.String multipleSelection
          The default value for multipleSelection attribute
protected  java.lang.String size
          The default size
 
Fields inherited from class com.ibm.btt.struts.taglib.html.DSEListTagSupport
dataNameForList, item, OT_CLOSE, OT_OPEN, OT_SA, ST_CLOSE, ST_MA, ST_OPEN, value
 
Fields inherited from class com.ibm.btt.struts.taglib.html.StrutsTagSupport
APPLICATION_SCOPE, BR_RE, BT_CLOSE, BT_OPEN, buffer, BUTTON, CENTER, COMMENT_VAL_ERROR, COMPID, custom, dataName, DOC_CLOSE, DOC_FORM_EVENT, DOC_FORM_HALF1, DOC_FORM_HALF2, DOC_SUBMIT, DOT, ERRORCOLOR, FCLTA, FCTA, FFTA, fontColor, fontFace, fontSize, FSTA, FT_CLOSE, FT_OPEN, HARD, IBT_OPEN, ICKT_OPEN, IHT_OPEN, IIT_OPEN, IMAGE, IPT_OPEN, IRAT_OPEN, IRT_OPEN, IST_OPEN, IT_CA, IT_CHECKED, IT_DISA, IT_MA, IT_NA, IT_OA, IT_OPEN, IT_READ, IT_READONLY, IT_SA, IT_SRA, IT_VA, IT_WA, ITT_OPEN, LEFT, LO_RE, LOWT, msgPrefix, name, NBSP, NO, NULL, OFF, out, PAGE_SCOPE, QU_LO, QU_LO_RE, QU_SP, QUOT, REQUEST_SCOPE, RESET, RET, RIGHT, SESSION_SCOPE, SOFT, SP, styleName, SUBMIT, TAT_CA, TAT_CLOSE, TAT_OPNE, TAT_RA, TAT_WA, utb, valErrBundle, YES
 
Fields inherited from class javax.servlet.jsp.tagext.TagSupport
id, pageContext
 
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
ListTag()
          ListTag constructor.
 
Method Summary
 boolean contains(java.lang.Object values, java.lang.Object value)
          Returns a boolean indicating if the value value is contained in the values array.
 void doForMultipleSelection()
          Processes the selections when the multipleSelection attribute is YES.
 void doForSingleSelection()
          Processes the selections when the multipleSelection attribute is NO.
 int doStartTag()
          Process the start tag for this instance.
 void setMultipleSelection(java.lang.String newMultipleSelection)
          Sets the multipleSelection property with a new value.
 void setSize(java.lang.String newSize)
          Sets the size property with a new value.
 
Methods inherited from class com.ibm.btt.struts.taglib.html.DSEListTagSupport
setDataNameForList, setItem, setValue
 
Methods inherited from class com.ibm.btt.struts.taglib.html.StrutsTagSupport
bufferAppendFontEnd, bufferAppendFontStart, getJspContextServices, getName, getResourceBundle, setCustom, setDataName, setFontColor, setFontFace, setFontSize, setName, setPageContext, setResourceBundle, setResourceBundle, setStyle, setVEResourceBundle
 
Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setParent, setValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

size

protected java.lang.String size
The default size


multipleSelection

protected java.lang.String multipleSelection
The default value for multipleSelection attribute

Constructor Detail

ListTag

public ListTag()
ListTag constructor.

Method Detail

contains

public boolean contains(java.lang.Object values,
                        java.lang.Object value)
Returns a boolean indicating if the value value is contained in the values array.

Parameters:
values - The array of values
value - The value to check
Returns:
boolean - True if values contain value

doForMultipleSelection

public void doForMultipleSelection()
                            throws java.io.IOException,
                                   DSEObjectNotFoundException
Processes the selections when the multipleSelection attribute is YES.

Throws:
java.io.IOException
DSEObjectNotFound
DSEObjectNotFoundException

doForSingleSelection

public void doForSingleSelection()
                          throws java.io.IOException,
                                 DSEObjectNotFoundException
Processes the selections when the multipleSelection attribute is NO.

Throws:
java.io.IOException
DSEObjectNotFound
DSEObjectNotFoundException

doStartTag

public int doStartTag()
Process the start tag for this instance. This method is invoked by the JSP page implementation object. The doStartTag method assumes that the properties pageContext and parent have been set. It also assumes that any properties exposed as attributes have been set. When this method is invoked, the body has not yet been evaluated.

This method returns Tag.EVAL_BODY_INCLUDE or BodyTag.EVAL_BODY_BUFFERED to indicate that the body of the action should be evaluated or SKIP_BODY to indicate otherwise. When a Tag returns EVAL_BODY_INCLUDE, this method includes the result of evaluating the body (if any) in the current "out" JspWriter and then invokes doEndTag().

Refer to the class description for specific details about this method.

Returns:
int - The evaluation constant

setMultipleSelection

public void setMultipleSelection(java.lang.String newMultipleSelection)
Sets the multipleSelection property with a new value.

Parameters:
newMultipleSelection - The new value

setSize

public void setSize(java.lang.String newSize)
Sets the size property with a new value.

Parameters:
newSize - The new value

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005