Package javax.servlet.jsp.tagext
Class TagInfo
java.lang.Object
javax.servlet.jsp.tagext.TagInfo
Tag information for a tag in a Tag Library;
This class is instantiated from the Tag Library Descriptor file (TLD)
and is available only at translation time.
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionTagInfo
(String tagName, String tagClassName, String bodycontent, String infoString, TagLibraryInfo taglib, TagExtraInfo tagExtraInfo, TagAttributeInfo[] attributeInfo) Constructor for TagInfo from data in the JSP 1.1 format for TLD.TagInfo
(String tagName, String tagClassName, String bodycontent, String infoString, TagLibraryInfo taglib, TagExtraInfo tagExtraInfo, TagAttributeInfo[] attributeInfo, String displayName, String smallIcon, String largeIcon, TagVariableInfo[] tvi) Constructor for TagInfo from data in the JSP 1.2 format for TLD. -
Method Summary
Modifier and TypeMethodDescriptionAttribute information (in the TLD) on this tag.The bodycontent information for this tag.Get the displayNameThe information string for the tag.Get the path to the large iconGet the path to the small iconName of the class that provides the handler for this tag.The instance (if any) for extra tag informationThe instance of TabLibraryInfo we belong to.The name of the Tag.Get TagVariableInfo objects associated with this TagInfogetVariableInfo
(TagData data) Information on the scripting objects created by this tag at runtime.boolean
Translation-time validation of the attributes.void
Set the instance for extra tag informationvoid
Set the TagLibraryInfo property.toString()
Stringify for debug purposes...
-
Field Details
-
BODY_CONTENT_JSP
static constant for getBodyContent() when it is JSP- See Also:
-
BODY_CONTENT_TAG_DEPENDENT
static constant for getBodyContent() when it is Tag dependent- See Also:
-
BODY_CONTENT_EMPTY
static constant for getBodyContent() when it is empty- See Also:
-
-
Constructor Details
-
TagInfo
public TagInfo(String tagName, String tagClassName, String bodycontent, String infoString, TagLibraryInfo taglib, TagExtraInfo tagExtraInfo, TagAttributeInfo[] attributeInfo) Constructor for TagInfo from data in the JSP 1.1 format for TLD. This class is to be instantiated only from the TagLibrary code under request from some JSP code that is parsing a TLD (Tag Library Descriptor). Note that, since TagLibibraryInfo reflects both TLD information and taglib directive information, a TagInfo instance is dependent on a taglib directive. This is probably a design error, which may be fixed in the future.- Parameters:
tagName
- The name of this tagtagClassName
- The name of the tag handler classbodycontent
- Information on the body content of these tagsinfoString
- The (optional) string information for this tagtaglib
- The instance of the tag library that contains us.tagExtraInfo
- The instance providing extra Tag info. May be nullattributeInfo
- An array of AttributeInfo data from descriptor. May be null;
-
TagInfo
public TagInfo(String tagName, String tagClassName, String bodycontent, String infoString, TagLibraryInfo taglib, TagExtraInfo tagExtraInfo, TagAttributeInfo[] attributeInfo, String displayName, String smallIcon, String largeIcon, TagVariableInfo[] tvi) Constructor for TagInfo from data in the JSP 1.2 format for TLD. This class is to be instantiated only from the TagLibrary code under request from some JSP code that is parsing a TLD (Tag Library Descriptor). Note that, since TagLibibraryInfo reflects both TLD information and taglib directive information, a TagInfo instance is dependent on a taglib directive. This is probably a design error, which may be fixed in the future.- Parameters:
tagName
- The name of this tagtagClassName
- The name of the tag handler classbodycontent
- Information on the body content of these tagsinfoString
- The (optional) string information for this tagtaglib
- The instance of the tag library that contains us.tagExtraInfo
- The instance providing extra Tag info. May be nullattributeInfo
- An array of AttributeInfo data from descriptor. May be null;displayName
- A short name to be displayed by toolssmallIcon
- Path to a small icon to be displayed by toolslargeIcon
- Path to a large icon to be displayed by toolstagVariableInfo
- An array of a TagVariableInfo (or null)
-
-
Method Details
-
getTagName
The name of the Tag.- Returns:
- The (short) name of the tag.
-
getAttributes
Attribute information (in the TLD) on this tag. The return is an array describing the attributes of this tag, as indicated in the TLD. A null return means no attributes.- Returns:
- The array of TagAttributeInfo for this tag.
-
getVariableInfo
Information on the scripting objects created by this tag at runtime. This is a convenience method on the associated TagExtraInfo class.Default is null if the tag has no "id" attribute, otherwise, {"id", Object}
- Parameters:
data
- TagData describing this action.- Returns:
- Array of VariableInfo elements.
-
isValid
Translation-time validation of the attributes. This is a convenience method on the associated TagExtraInfo class.- Parameters:
data
- The translation-time TagData instance.- Returns:
- Whether the data is valid.
-
setTagExtraInfo
Set the instance for extra tag information- Parameters:
tei
- the TagExtraInfo instance
-
getTagExtraInfo
The instance (if any) for extra tag information- Returns:
- The TagExtraInfo instance, if any.
-
getTagClassName
Name of the class that provides the handler for this tag.- Returns:
- The name of the tag handler class.
-
getBodyContent
The bodycontent information for this tag.- Returns:
- the body content string.
-
getInfoString
The information string for the tag.- Returns:
- the info string
-
setTagLibrary
Set the TagLibraryInfo property. Note that a TagLibraryInfo element is dependent not just on the TLD information but also on the specific taglib instance used. This means that a fair amount of work needs to be done to construct and initialize TagLib objects. If used carefully, this setter can be used to avoid having to create new TagInfo elements for each taglib directive.- Parameters:
tl
- the TagLibraryInfo to assign
-
getTagLibrary
The instance of TabLibraryInfo we belong to.- Returns:
- the tab library instance we belong to.
-
getDisplayName
Get the displayName- Returns:
- A short name to be displayed by tools
-
getSmallIcon
Get the path to the small icon- Returns:
- Path to a small icon to be displayed by tools
-
getLargeIcon
Get the path to the large icon- Returns:
- Path to a large icon to be displayed by tools
-
getTagVariableInfos
Get TagVariableInfo objects associated with this TagInfo- Returns:
- A TagVariableInfo object associated with this
-
toString
Stringify for debug purposes...
-