Class ScrollBarTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
org.deltava.taglib.view.ScrollBarTag
All Implemented Interfaces:
jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, Serializable
public class ScrollBarTag extends jakarta.servlet.jsp.tagext.TagSupport
A JSP tag to selectively display view table scroll tags.
Since:
1.0
Version:
7.0
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
    ScrollBarTag()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    doEndTag()
    Completes the tag by releasing the state variables.
    int
    doStartTag()
    Loads the view context from the page context, and determines whether to include the tag body.
    (package private) ViewContext<?>
    getContext()
    Returns the view context.
    (package private) boolean
    hasView()
    Returns whether a view context is present in the requeust.
    (package private) boolean
    isForced()
    Returns whether display of the scroll bar has been forced.
    (package private) boolean
    isViewEnd()
    Returns whether we are at the end of the view.
    (package private) boolean
    isViewStart()
    Returns whether we are at the start of the view.
    void
    release()
    Releases the tag's state variables.
    void
    setForce(boolean doForce)
    Sets whether the tag body should be always included.

    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

    • ScrollBarTag

      public ScrollBarTag()

  • Method Details

    • setForce

      public void setForce(boolean doForce)
      Sets whether the tag body should be always included.
      Parameters:
      doForce - TRUE if the body should be always rendered, otherwise FALSE

    • isViewStart

      boolean isViewStart()
      Returns whether we are at the start of the view.
      Returns:
      TRUE if at the start of a view, otherwise FALSE
      See Also:

    • isViewEnd

      boolean isViewEnd()
      Returns whether we are at the end of the view.
      Returns:
      TRUE if at the end of a view, otherwise FALSE
      See Also:

    • hasView

      boolean hasView()
      Returns whether a view context is present in the requeust.
      Returns:
      TRUE if a view context is present, otherwise FALSE

    • isForced

      boolean isForced()
      Returns whether display of the scroll bar has been forced.
      Returns:
      TRUE if the body should always be rendered

    • getContext

      ViewContext<?> getContext()
      Returns the view context.
      Returns:
      the view context

    • doStartTag

      public int doStartTag()
      Loads the view context from the page context, and determines whether to include the tag body. The tag body will only be included if the view context is present and we are not simaltaneously at the start and end of the view.
      Specified by:
      doStartTag in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      doStartTag in class jakarta.servlet.jsp.tagext.TagSupport
      Returns:
      TagSupport.EVAL_BODY_INCLUDE or TagSupport.SKIP_BODY

    • doEndTag

      public int doEndTag()
      Completes the tag by releasing the state variables.
      Specified by:
      doEndTag in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      doEndTag in class jakarta.servlet.jsp.tagext.TagSupport
      Returns:
      TagSupport.EVAL_PAGE always

    • 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