Package jakarta.faces.webapp

Class FacetTag

java.lang.Object
jakarta.servlet.jsp.tagext.TagSupport
jakarta.faces.webapp.FacetTag
All Implemented Interfaces:
jakarta.servlet.jsp.tagext.IterationTag, jakarta.servlet.jsp.tagext.JspTag, jakarta.servlet.jsp.tagext.Tag, Serializable
public class FacetTag
extends jakarta.servlet.jsp.tagext.TagSupport

FacetTag is the Jakarta Server Pages mechanism for denoting a UIComponent is to be added as a facet to the component associated with its parent.

A FacetTag must have one and only one child. This child must be a UIComponentTag instance representing a single UIComponent instance.

See Also:
Serialized Form

  • 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
    FacetTag()  

  • Method Summary

    Modifier and Type Method Description
    int doStartTag()
    Return EVAL_BODY_INCLUDE to cause nested body content to be evaluated.
    String getName()
    Return the name to be assigned to this facet.
    void release()
    Release any resources allocated by this tag instance.
    void setName​(String name)
    Set the name to be assigned to this facet.

    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 java.lang.Object

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

  • Constructor Details

  • Method Details

    • getName

      public String getName()

      Return the name to be assigned to this facet.

      Returns:
      the name

    • setName

      public void setName​(String name)

      Set the name to be assigned to this facet.

      Parameters:
      name - The new facet name

    • release

      public void release()

      Release any resources allocated by this tag instance.

      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

      Return EVAL_BODY_INCLUDE to cause nested body content to be evaluated.

      Specified by:
      doStartTag in interface jakarta.servlet.jsp.tagext.Tag
      Overrides:
      doStartTag in class jakarta.servlet.jsp.tagext.TagSupport
      Throws:
      jakarta.servlet.jsp.JspException