Class MenuTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
org.deltava.taglib.BrowserInfoTag
org.deltava.taglib.layout.MenuElementTag
org.deltava.taglib.layout.MenuTag
All Implemented Interfaces:
jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, Serializable
public class MenuTag extends MenuElementTag
A JSP tag to display a navigation menu.
Since:
2.6
Version:
7.0
Author:
Luke
See Also:

  • Field Summary

    Fields inherited from class MenuElementTag

    _renderTable

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

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    doEndTag()
    Writes the menu item's closing tag(s) to the JSP output stream, if tags were opened in the doStartTag() method.
    int
    doStartTag()
    Writes the menu item's opening tag(s) to the JSP output stream.
    (package private) String
    getMaxMenuWidth()
    Returns the CSS attribute for the maximum width of each submenu.
    void
    release()
    Releases the tag's state variables.
    void
    setAttr(String attrName)
    Sets the page attribute that stores whether a side menu is being rendered.
    void
    setMaxWidth(String mw)
    Sets the CSS attribute for the maximum width of each submenu.

    Methods inherited from class BrowserInfoTag

    getBrowserContext, passedCAPTCHA

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

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

    • MenuTag

      public MenuTag()

  • Method Details

    • setAttr

      public void setAttr(String attrName)
      Sets the page attribute that stores whether a side menu is being rendered.
      Parameters:
      attrName - the attribute name

    • setMaxWidth

      public void setMaxWidth(String mw)
      Sets the CSS attribute for the maximum width of each submenu.
      Parameters:
      mw - the attribute

    • getMaxMenuWidth

      String getMaxMenuWidth()
      Returns the CSS attribute for the maximum width of each submenu.
      Returns:
      the attribute, or null if none
      See Also:

    • release

      public void release()
      Releases the tag's state variables.
      Specified by:
      release in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      release in class jakarta.servlet.jsp.tagext.TagSupport

    • doStartTag

      public int doStartTag() throws jakarta.servlet.jsp.JspException
      Writes the menu item's opening tag(s) to the JSP output stream. This will render a TABLE element if the parent region uses tables, otherwise no output will be generated.
      Specified by:
      doStartTag in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      doStartTag in class MenuElementTag
      Returns:
      EVAL_BODY_INCLUDE always
      Throws:
      jakarta.servlet.jsp.JspException - if an error occurs

    • doEndTag

      public int doEndTag() throws jakarta.servlet.jsp.JspException
      Writes the menu item's closing tag(s) to the JSP output stream, if tags were opened in the doStartTag() method.
      Specified by:
      doEndTag in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      doEndTag in class jakarta.servlet.jsp.tagext.TagSupport
      Returns:
      EVAL_PAGE always
      Throws:
      jakarta.servlet.jsp.JspException - if an error occured