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 SummaryConstructors Constructor Description AbstractTagLibrary(String namespace)AbstractTagLibrary(String namespace, String jcpNamespace)AbstractTagLibrary(String namespace, String jcpNamespace, String sunNamespace)
 - 
Method SummaryAll Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voidaddBehavior(String name, String behaviorId)protected voidaddBehavior(String name, String behaviorId, Class<? extends TagHandler> handlerType)protected voidaddComponent(String name, String componentType, String rendererType)Add a ComponentHandler with the specified componentType and rendererType, aliased by the tag name.protected voidaddComponent(String name, String componentType, String rendererType, Class<? extends TagHandler> handlerType)Add a ComponentHandler with the specified componentType and rendererType, aliased by the tag name.protected voidaddComponentFromResourceId(String name, String resourceId)protected voidaddConverter(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)protected voidaddConverter(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)protected voidaddFunction(String name, Method method)Add a Method to be used as a Function at Compilation.protected voidaddTagHandler(String name, Class<? extends TagHandler> handlerType)Use the specified HandlerType in compiling Facelets.protected voidaddUserTag(String name, URL source)Add a UserTagHandler specified a the URL source.protected voidaddValidator(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)protected voidaddValidator(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)booleancontainsFunction(String ns, String name)If this library contains the specified function namebooleancontainsNamespace(String ns)If this library contains the passed namespacebooleancontainsTagHandler(String ns, String localName)If this library contains a TagHandler for the namespace and local nameMethodcreateFunction(String ns, String name)Return a Method instance for the passed namespace and nameTagHandlercreateTagHandler(String ns, String localName, TagConfig tag)Create a new instance of a TagHandler, using the passed TagConfigStringgetNamespace()
 
- 
- 
- 
Method Detail- 
containsNamespacepublic boolean containsNamespace(String ns) Description copied from interface:TagLibraryIf this library contains the passed namespace- Specified by:
- containsNamespacein interface- TagLibrary
- Parameters:
- ns- namespace
- Returns:
- true if the namespace is used in this library
 
 - 
containsTagHandlerpublic boolean containsTagHandler(String ns, String localName) Description copied from interface:TagLibraryIf this library contains a TagHandler for the namespace and local name- Specified by:
- containsTagHandlerin interface- TagLibrary
- Parameters:
- ns- namespace
- localName- local name
- Returns:
- true if handled by this library
 
 - 
createTagHandlerpublic TagHandler createTagHandler(String ns, String localName, TagConfig tag) throws FacesException Description copied from interface:TagLibraryCreate a new instance of a TagHandler, using the passed TagConfig- Specified by:
- createTagHandlerin interface- TagLibrary
- Parameters:
- ns- namespace
- localName- local name
- tag- configuration information
- Returns:
- a new TagHandler instance
- Throws:
- FacesException
 
 - 
containsFunctionpublic boolean containsFunction(String ns, String name) Description copied from interface:TagLibraryIf this library contains the specified function name- Specified by:
- containsFunctionin interface- TagLibrary
- Parameters:
- ns- namespace
- name- function name
- Returns:
- true if handled
 
 - 
createFunctionpublic Method createFunction(String ns, String name) Description copied from interface:TagLibraryReturn a Method instance for the passed namespace and name- Specified by:
- createFunctionin interface- TagLibrary
- Parameters:
- ns- namespace
- name- function name
- Returns:
 
 - 
getNamespacepublic String getNamespace() 
 - 
addComponentprotected 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
 
 - 
addComponentprotected 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
 
 - 
addComponentFromResourceIdprotected final void addComponentFromResourceId(String name, String resourceId) 
 - 
addConverterprotected 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
 
 - 
addConverterprotected 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
 
 - 
addValidatorprotected 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
 
 - 
addValidatorprotected 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
 
 - 
addTagHandlerprotected 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
 
 - 
addUserTagprotected 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
 
 - 
addFunctionprotected 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
 
 - 
addBehaviorprotected final void addBehavior(String name, String behaviorId) - Parameters:
- name-
- behaviorId-
- Since:
- 2.0
 
 - 
addBehaviorprotected final void addBehavior(String name, String behaviorId, Class<? extends TagHandler> handlerType) - Parameters:
- name-
- behaviorId-
- handlerType-
- Since:
- 2.0
 
 
- 
 
-