Package jakarta.faces.view.facelets

Class TagHandler

java.lang.Object
jakarta.faces.view.facelets.TagHandler
All Implemented Interfaces:
FaceletHandler
Direct Known Subclasses:
MetaTagHandler
public abstract class TagHandler extends Object implements FaceletHandler

Foundation class for FaceletHandlers associated with a markup element in a Facelet document. This class introduces the concept of XML attributes to Facelets. See the constructor documentation for more details.

Since:
2.0

  • Field Details

    • tagId

      protected final String tagId

      See TagConfig.getTagId().

    • tag

      protected final Tag tag

      A reference to the Tag instance corresponding to this TagHandler instance.

    • nextHandler

      protected final FaceletHandler nextHandler

      A reference to the FaceletHandler that represents the first nested child of this TagHandler instance.

  • Constructor Details

    • TagHandler

      public TagHandler(TagConfig config)

      Every TagHandler instance is associated with a Tag. Each Tag instance has a TagAttributes property, which is simply a collection of TagAttribute instances. Extract and save as protected instance variables the TagConfig.getTagId(), TagConfig.getTag() and TagConfig.getNextHandler() returns from the argument TagConfig. This constructor is only called when the Facelets View is compiled.

      Parameters:
      config - The structure that contains useful to the operation of this instance.

  • Method Details

    • getAttribute

      protected final TagAttribute getAttribute(String localName)
      Utility method for fetching the appropriate TagAttribute
      Parameters:
      localName - name of attribute
      Returns:
      TagAttribute if found, otherwise null

    • getRequiredAttribute

      protected final TagAttribute getRequiredAttribute(String localName) throws TagException
      Utility method for fetching a required TagAttribute
      Parameters:
      localName - name of the attribute
      Returns:
      TagAttribute if found, otherwise error
      Throws:
      TagException - if the attribute was not found

    • toString

      public String toString()
      Overrides:
      toString in class Object