Package net.ontopia.topicmaps.nav2.taglibs.logic

Class ForEachTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
jakarta.servlet.jsp.tagext.BodyTagSupport
net.ontopia.topicmaps.nav2.taglibs.logic.ForEachTag
All Implemented Interfaces:
jakarta.servlet.jsp.tagext.BodyTag, jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, Serializable
public class ForEachTag extends jakarta.servlet.jsp.tagext.BodyTagSupport
INTERNAL: Logic Tag for iterating over each object in a collection, creating new content for each iteration.
See Also:

  • Field Summary

    Fields inherited from class jakarta.servlet.jsp.tagext.BodyTagSupport

    bodyContent

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

    id, pageContext

    Fields inherited from interface jakarta.servlet.jsp.tagext.BodyTag

    EVAL_BODY_BUFFERED

    Fields inherited from interface jakarta.servlet.jsp.tagext.IterationTag

    EVAL_BODY_AGAIN

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

    EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

  • Constructor Summary

    Constructors
    Constructor
    Description
    ForEachTag()
    Default constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    doAfterBody()
    Actions after some body has been evaluated.
    int
    doEndTag()
    Process the end tag.
    int
    doStartTag()
    Process the start tag for this instance.
    void
    release()
    Resets the state of the Tag.
    void
    setComparator(String classname)
     
    void
    setFunctionOnTruncate(String functionName)
     
    void
    setMax(String maxString)
    Sets the maximum number of displayed items.
    void
    setName(String collectionName)
     
    void
    setOrder(String order)
     
    void
    setSeparator(String separator)
     
    void
    setSet(String itemName)
     
    void
    setStart(String startString)
    Sets the start number for the object in the collection at this index, counting from 0.

    Methods inherited from class jakarta.servlet.jsp.tagext.BodyTagSupport

    doInitBody, getBodyContent, getPreviousOut, setBodyContent

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

    findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface jakarta.servlet.jsp.tagext.Tag

    getParent, setPageContext, setParent

  • Constructor Details

    • ForEachTag

      public ForEachTag()
      Default constructor.

  • Method Details

    • doStartTag

      public int doStartTag() throws jakarta.servlet.jsp.JspTagException
      Process the start tag for this instance.
      Specified by:
      doStartTag in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      doStartTag in class jakarta.servlet.jsp.tagext.BodyTagSupport
      Throws:
      jakarta.servlet.jsp.JspTagException

    • doAfterBody

      public int doAfterBody() throws jakarta.servlet.jsp.JspTagException
      Actions after some body has been evaluated.
      Specified by:
      doAfterBody in interface jakarta.servlet.jsp.tagext.IterationTag
      Overrides:
      doAfterBody in class jakarta.servlet.jsp.tagext.BodyTagSupport
      Throws:
      jakarta.servlet.jsp.JspTagException

    • doEndTag

      public int doEndTag() throws jakarta.servlet.jsp.JspException
      Process the end tag.
      Specified by:
      doEndTag in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      doEndTag in class jakarta.servlet.jsp.tagext.BodyTagSupport
      Throws:
      jakarta.servlet.jsp.JspException

    • release

      public void release()
      Resets the state of the Tag.
      Specified by:
      release in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      release in class jakarta.servlet.jsp.tagext.BodyTagSupport

    • setName

      public void setName(String collectionName)

    • setSet

      public void setSet(String itemName)

    • setComparator

      public void setComparator(String classname)

    • setOrder

      public void setOrder(String order) throws NavigatorRuntimeException
      Throws:
      NavigatorRuntimeException

    • setMax

      public void setMax(String maxString)
      Sets the maximum number of displayed items.
      Parameters:
      maxString - try to convert to valid integer, otherwise fallback to default value. If Value is 0 or negative it is set to 1.

    • setStart

      public void setStart(String startString)
      Sets the start number for the object in the collection at this index, counting from 0. Defaults to 0. Useful for implementing paging of long lists.
      Parameters:
      startString - try to convert to valid integer, otherwise fallback to default value. If Value is 0 or negative it is set to 1.

    • setSeparator

      public void setSeparator(String separator)

    • setFunctionOnTruncate

      public void setFunctionOnTruncate(String functionName)