Class AbstractTagLibrary

java.lang.Object
org.apache.myfaces.view.facelets.tag.AbstractTagLibrary
All Implemented Interfaces:
TagLibrary
Direct Known Subclasses:
AbstractHtmlLibrary, CompositeLibrary, CoreLibrary, JsfLibrary, JstlCoreLibrary, LegacyJstlCoreLibrary, LegacyUILibrary, PassThroughLibrary, UILibrary

public abstract class AbstractTagLibrary extends Object implements TagLibrary
Base class for defining TagLibraries in Java
Version:
$Id$
Author:
Jacob Hookom
  • Constructor Details

    • AbstractTagLibrary

      public AbstractTagLibrary(String namespace)
    • AbstractTagLibrary

      public AbstractTagLibrary(String namespace, String jcpNamespace)
    • AbstractTagLibrary

      public AbstractTagLibrary(String namespace, String jcpNamespace, String sunNamespace)
  • Method Details

    • containsNamespace

      public boolean containsNamespace(String ns)
      Description copied from interface: TagLibrary
      If this library contains the passed namespace
      Specified by:
      containsNamespace in interface TagLibrary
      Parameters:
      ns - namespace
      Returns:
      true if the namespace is used in this library
    • containsTagHandler

      public boolean containsTagHandler(String ns, String localName)
      Description copied from interface: TagLibrary
      If this library contains a TagHandler for the namespace and local name
      Specified by:
      containsTagHandler in interface TagLibrary
      Parameters:
      ns - namespace
      localName - local name
      Returns:
      true if handled by this library
    • createTagHandler

      public TagHandler createTagHandler(String ns, String localName, TagConfig tag) throws FacesException
      Description copied from interface: TagLibrary
      Create a new instance of a TagHandler, using the passed TagConfig
      Specified by:
      createTagHandler in interface TagLibrary
      Parameters:
      ns - namespace
      localName - local name
      tag - configuration information
      Returns:
      a new TagHandler instance
      Throws:
      FacesException
    • containsFunction

      public boolean containsFunction(String ns, String name)
      Description copied from interface: TagLibrary
      If this library contains the specified function name
      Specified by:
      containsFunction in interface TagLibrary
      Parameters:
      ns - namespace
      name - function name
      Returns:
      true if handled
    • createFunction

      public Method createFunction(String ns, String name)
      Description copied from interface: TagLibrary
      Return a Method instance for the passed namespace and name
      Specified by:
      createFunction in interface TagLibrary
      Parameters:
      ns - namespace
      name - function name
      Returns:
    • getNamespace

      public String getNamespace()
    • addComponent

      protected final void addComponent(String name, String componentType, String rendererType)
      Add a ComponentHandler with the specified componentType and rendererType, aliased by the tag name. See ComponentHandler See jakarta.faces.application.Application#createComponent(java.lang.String)
      Parameters:
      name - name to use, "foo" would be <my:foo />
      componentType - componentType to use
      rendererType - rendererType to use
    • addComponent

      protected final void addComponent(String name, String componentType, String rendererType, Class<? extends TagHandler> handlerType)
      Add a ComponentHandler with the specified componentType and rendererType, aliased by the tag name. The Facelet will be compiled with the specified HandlerType (which must extend AbstractComponentHandler). See AbstractComponentHandler
      Parameters:
      name - name to use, "foo" would be <my:foo />
      componentType - componentType to use
      rendererType - rendererType to use
      handlerType - a Class that extends AbstractComponentHandler
    • addComponentFromResourceId

      protected final void addComponentFromResourceId(String name, String resourceId)
    • addConverter

      protected final void addConverter(String name, String converterId)
      Add a ConvertHandler for the specified converterId See jakarta.faces.view.facelets.ConverterHandler See jakarta.faces.application.Application#createConverter(java.lang.String)
      Parameters:
      name - name to use, "foo" would be <my:foo />
      converterId - id to pass to Application instance
    • addConverter

      protected final void addConverter(String name, String converterId, Class<? extends TagHandler> type)
      Add a ConvertHandler for the specified converterId of a TagHandler type See jakarta.faces.view.facelets.ConverterHandler See jakarta.faces.view.facelets.ConverterConfig See jakarta.faces.application.Application#createConverter(java.lang.String)
      Parameters:
      name - name to use, "foo" would be <my:foo />
      converterId - id to pass to Application instance
      type - TagHandler type that takes in a ConverterConfig
    • addValidator

      protected final void addValidator(String name, String validatorId)
      Add a ValidateHandler for the specified validatorId See jakarta.faces.view.facelets.ValidatorHandler See jakarta.faces.application.Application#createValidator(java.lang.String)
      Parameters:
      name - name to use, "foo" would be <my:foo />
      validatorId - id to pass to Application instance
    • addValidator

      protected final void addValidator(String name, String validatorId, Class<? extends TagHandler> type)
      Add a ValidateHandler for the specified validatorId See jakarta.faces.view.facelets.ValidatorHandler See jakarta.faces.view.facelets.ValidatorConfig See jakarta.faces.application.Application#createValidator(java.lang.String)
      Parameters:
      name - name to use, "foo" would be <my:foo />
      validatorId - id to pass to Application instance
      type - TagHandler type that takes in a ValidatorConfig
    • addTagHandler

      protected final void addTagHandler(String name, Class<? extends TagHandler> handlerType)
      Use the specified HandlerType in compiling Facelets. HandlerType must extend TagHandler. See TagHandler
      Parameters:
      name - name to use, "foo" would be <my:foo />
      handlerType - must extend TagHandler
    • addUserTag

      protected final void addUserTag(String name, URL source)
      Add a UserTagHandler specified a the URL source. See UserTagHandler
      Parameters:
      name - name to use, "foo" would be <my:foo />
      source - source where the Facelet (Tag) source is
    • addFunction

      protected final void addFunction(String name, Method method)
      Add a Method to be used as a Function at Compilation. See jakarta.el.FunctionMapper
      Parameters:
      name - (suffix) of function name
      method - method instance
    • addBehavior

      protected final void addBehavior(String name, String behaviorId)
      Parameters:
      name -
      behaviorId -
      Since:
      2.0
    • addBehavior

      protected final void addBehavior(String name, String behaviorId, Class<? extends TagHandler> handlerType)
      Parameters:
      name -
      behaviorId -
      handlerType -
      Since:
      2.0