Class LegendTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
org.deltava.taglib.mapbox.LegendTag
All Implemented Interfaces:
jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, Serializable
public class LegendTag extends jakarta.servlet.jsp.tagext.TagSupport
A JSP Tag to display a legend entry for a MapBox marker.
Since:
1.0
Version:
12.3
Author:
Luke
See Also:

  • Field Summary

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

    id, pageContext

    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
    LegendTag()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    doEndTag()
    Renders the marker image and legend text to the JSP output stream.
    void
    release()
     
    void
    setClassName(String cName)
    Sets the CSS class name for the marker legend.
    void
    setColor(String color)
    Sets the marker color.
    void
    setLegend(String legend)
    Sets the marker legend.

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

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

    Methods inherited from class Object

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

  • Constructor Details

    • LegendTag

      public LegendTag()

  • Method Details

    • setColor

      public void setColor(String color)
      Sets the marker color.
      Parameters:
      color - the marker color

    • setLegend

      public void setLegend(String legend)
      Sets the marker legend.
      Parameters:
      legend - the legend text

    • setClassName

      public void setClassName(String cName)
      Sets the CSS class name for the marker legend.
      Parameters:
      cName - the CSS class name

    • release

      public void release()
      Specified by:
      release in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      release in class jakarta.servlet.jsp.tagext.TagSupport

    • doEndTag

      public int doEndTag() throws jakarta.servlet.jsp.JspException
      Renders the marker image and legend text to the JSP output stream.
      Specified by:
      doEndTag in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      doEndTag in class jakarta.servlet.jsp.tagext.TagSupport
      Returns:
      TagSupport.EVAL_PAGE
      Throws:
      jakarta.servlet.jsp.JspException - if an error occurs