Class GoogleMapEntryTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
org.deltava.taglib.JSTag
org.deltava.taglib.googlemap.GoogleMapEntryTag
All Implemented Interfaces:
jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, Serializable
Direct Known Subclasses:
BoundsTag, LineTag, MarkerArrayTag, MarkerTag, PointArrayTag, PointTag
abstract class GoogleMapEntryTag extends JSTag
An abstract class to support Google Maps JSP tags.
Since:
1.0
Version:
6.0
Author:
Luke

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    (package private) static final String
    API_JS_NAME
    Internal name used to check for Google Maps API inclusion.

    Fields inherited from class JSTag

    _jsVarName

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

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    doStartTag()
    Executed before the Tag is rendered.
    protected static String
    generateIconMarker(GeoLocation loc, int paletteCode, int iconCode, String label)
    Generates a call to googleIconMarker() to generate a Google Maps icon marker.
    protected static String
    generateMarker(GeoLocation loc, String color, String label)
    Generates a call to googleMarker() to generate a Google Maps marker.
    protected int
    getAPIVersion()
    Returns the Google Maps API version used on this page.

    Methods inherited from class JSTag

    release, setConst, setVar, writeVariableName

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

    doAfterBody, doEndTag, 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

  • Field Details

    • API_JS_NAME

      static final String API_JS_NAME
      Internal name used to check for Google Maps API inclusion.
      See Also:

  • Constructor Details

    • GoogleMapEntryTag

      GoogleMapEntryTag()

  • Method Details

    • doStartTag

      public int doStartTag() throws jakarta.servlet.jsp.JspException
      Executed before the Tag is rendered. This will check for the presence of required JavaScript files in the request. Tags that do not require this check can override this method.
      Specified by:
      doStartTag in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      doStartTag in class jakarta.servlet.jsp.tagext.TagSupport
      Returns:
      TagSupport.SKIP_BODY always
      Throws:
      IllegalStateException - if the Google Maps API or googleMaps.js not included in request
      jakarta.servlet.jsp.JspException

    • getAPIVersion

      protected int getAPIVersion()
      Returns the Google Maps API version used on this page.
      Returns:
      the API major version

    • generateMarker

      protected static String generateMarker(GeoLocation loc, String color, String label)
      Generates a call to googleMarker() to generate a Google Maps marker.
      Parameters:
      loc - the location
      color - the icon color
      label - the label HTML text, or null if none
      Returns:
      a JavaScript function call definition

    • generateIconMarker

      protected static String generateIconMarker(GeoLocation loc, int paletteCode, int iconCode, String label)
      Generates a call to googleIconMarker() to generate a Google Maps icon marker.
      Parameters:
      loc - the location
      paletteCode - the Google Earth palette code
      iconCode - the Google Earth icon code
      label - the label HTML text, or null if none
      Returns:
      a JavaScript function call definition