Package org.apache.sling.scripting.jsp.taglib

Class GetParentsTag

  • All Implemented Interfaces:
    java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
    public class GetParentsTag
extends javax.servlet.jsp.tagext.TagSupport
    Tag for retrieving all of the parent resources of a specified resource, returning them in hierarchy order.
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

        EVAL_BODY_AGAIN

      • Fields inherited from interface javax.servlet.jsp.tagext.Tag

        EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

    • Constructor Summary

      Constructors 
      Constructor Description
      GetParentsTag()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int doEndTag()  
      Resource getResource()
      Gets the resource.
      java.lang.String getStartDepth()
      Retrieves the start depth
      java.lang.String getVar()
      Gets the variable name to which to save the list of children.
      void setResource​(Resource resource)
      Sets the resource.
      void setStartDepth​(java.lang.String startDepth)
      The depth at which to start, for example given a path of: /content/page1/page2/page3 and a start depth of 3, the parents page2/page3 would be returned
      void setVar​(java.lang.String var)
      Sets the variable name to which to save the parent resource.

      • Methods inherited from class javax.servlet.jsp.tagext.TagSupport

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

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • GetParentsTag

        public GetParentsTag()

    • Method Detail

      • doEndTag

        public int doEndTag()
        Specified by:
        doEndTag in interface javax.servlet.jsp.tagext.Tag
        Overrides:
        doEndTag in class javax.servlet.jsp.tagext.TagSupport

      • getResource

        public Resource getResource()
        Gets the resource.
        Returns:
        the resource

      • getStartDepth

        public java.lang.String getStartDepth()
        Retrieves the start depth
        Returns:
        the start depth to retrieve

      • getVar

        public java.lang.String getVar()
        Gets the variable name to which to save the list of children.
        Returns:
        the variable name

      • setResource

        public void setResource​(Resource resource)
        Sets the resource.
        Parameters:
        resource - the new resource

      • setStartDepth

        public void setStartDepth​(java.lang.String startDepth)
        The depth at which to start, for example given a path of: /content/page1/page2/page3 and a start depth of 3, the parents page2/page3 would be returned
        Parameters:
        startDepth - the start depth from which to retrieve the parent resources

      • setVar

        public void setVar​(java.lang.String var)
        Sets the variable name to which to save the parent resource.
        Parameters:
        var - the variable name