Package com.sun.faces.facelets.tag

Class AbstractTagLibrary

java.lang.Object
com.sun.faces.facelets.tag.AbstractTagLibrary
All Implemented Interfaces:
TagLibrary
Direct Known Subclasses:
AbstractHtmlLibrary, CompositeLibrary, CoreLibrary, JstlCoreLibrary, PassThroughAttributeLibrary, PassThroughElementLibrary, TagLibraryImpl, UILibrary
public abstract class AbstractTagLibrary extends Object implements TagLibrary
Base class for defining TagLibraries in Java
Author:
Jacob Hookom

  • Constructor Details

    • AbstractTagLibrary

      public AbstractTagLibrary(String namespace)

  • Method Details

    • addComponent

      protected final void addComponent(String name, String componentType, String rendererType)
      Add a ComponentHandlerImpl with the specified componentType and rendererType, aliased by the tag name.
      Parameters:
      name - name to use, "foo" would be <my:foo />
      componentType - componentType to use
      rendererType - rendererType to use
      See Also:

    • addComponent

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

    • addConverter

      protected final void addConverter(String name, String converterId)
      Add a ConverterHandler for the specified converterId
      Parameters:
      name - name to use, "foo" would be <my:foo />
      converterId - id to pass to Application instance
      See Also:

    • addConverter

      protected final void addConverter(String name, String converterId, Class type)
      Add a ConverterHandler for the specified converterId of a TagHandler type
      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
      See Also:

    • addValidator

      protected final void addValidator(String name, String validatorId)
      Add a ValidatorHandler for the specified validatorId
      Parameters:
      name - name to use, "foo" would be <my:foo />
      validatorId - id to pass to Application instance
      See Also:

    • addValidator

      protected final void addValidator(String name, String validatorId, Class type)
      Add a ValidatorHandler for the specified validatorId
      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
      See Also:

    • addBehavior

      protected final void addBehavior(String name, String behaviorId)

      Parameters:
      name -
      behaviorId -

    • addBehavior

      protected final void addBehavior(String name, String behaviorId, Class type)

    • addTagHandler

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

    • addUserTag

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

    • addCompositeComponentTag

      protected final void addCompositeComponentTag(String name, String resourceId)
      Add a CompositeComponentTagHandler for the specified resource.
      Parameters:
      name - name to use, "foo" would be <my:foo />
      resourceId - source where the Facelet (Tag) source is
      See Also:
      • UserTagHandler

    • addFunction

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

    • containsNamespace

      public boolean containsNamespace(String ns, Tag t)
      Description copied from interface: TagLibrary
      true if the namespace is used in this library
      Specified by:
      containsNamespace in interface TagLibrary
      Parameters:
      ns - namespace
      t - the tag instance currently active at the time this method is called. May be null
      Returns:
      whether 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 true if handled by this library
      Specified by:
      containsTagHandler in interface TagLibrary
      Parameters:
      ns - namespace
      localName - local name
      Returns:
      whether 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 - when a Faces exception occurs

    • 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:
      a Method instance for the passed namespace and name

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getNamespace

      public String getNamespace()