Package javax.servlet.jsp.tagext
Class TagInfo
- java.lang.Object
-
- javax.servlet.jsp.tagext.TagInfo
-
public class TagInfo extends java.lang.Object
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 Modifier and Type Field Description static java.lang.String
BODY_CONTENT_EMPTY
static constant for getBodyContent() when it is emptystatic java.lang.String
BODY_CONTENT_JSP
static constant for getBodyContent() when it is JSPstatic java.lang.String
BODY_CONTENT_TAG_DEPENDENT
static constant for getBodyContent() when it is Tag dependent
-
Constructor Summary
Constructors Constructor Description TagInfo(java.lang.String tagName, java.lang.String tagClassName, java.lang.String bodycontent, java.lang.String infoString, TagLibraryInfo taglib, TagExtraInfo tagExtraInfo, TagAttributeInfo[] attributeInfo)
Constructor for TagInfo from data in the JSP 1.1 format for TLD.TagInfo(java.lang.String tagName, java.lang.String tagClassName, java.lang.String bodycontent, java.lang.String infoString, TagLibraryInfo taglib, TagExtraInfo tagExtraInfo, TagAttributeInfo[] attributeInfo, java.lang.String displayName, java.lang.String smallIcon, java.lang.String largeIcon, TagVariableInfo[] tvi)
Constructor for TagInfo from data in the JSP 1.2 format for TLD.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TagAttributeInfo[]
getAttributes()
Attribute information (in the TLD) on this tag.java.lang.String
getBodyContent()
The bodycontent information for this tag.java.lang.String
getDisplayName()
Get the displayNamejava.lang.String
getInfoString()
The information string for the tag.java.lang.String
getLargeIcon()
Get the path to the large iconjava.lang.String
getSmallIcon()
Get the path to the small iconjava.lang.String
getTagClassName()
Name of the class that provides the handler for this tag.TagExtraInfo
getTagExtraInfo()
The instance (if any) for extra tag informationTagLibraryInfo
getTagLibrary()
The instance of TabLibraryInfo we belong to.java.lang.String
getTagName()
The name of the Tag.TagVariableInfo[]
getTagVariableInfos()
Get TagVariableInfo objects associated with this TagInfoVariableInfo[]
getVariableInfo(TagData data)
Information on the scripting objects created by this tag at runtime.boolean
isValid(TagData data)
Translation-time validation of the attributes.void
setTagExtraInfo(TagExtraInfo tei)
Set the instance for extra tag informationvoid
setTagLibrary(TagLibraryInfo tl)
Set the TagLibraryInfo property.java.lang.String
toString()
Stringify for debug purposes...
-
-
-
Field Detail
-
BODY_CONTENT_JSP
public static final java.lang.String BODY_CONTENT_JSP
static constant for getBodyContent() when it is JSP- See Also:
- Constant Field Values
-
BODY_CONTENT_TAG_DEPENDENT
public static final java.lang.String BODY_CONTENT_TAG_DEPENDENT
static constant for getBodyContent() when it is Tag dependent- See Also:
- Constant Field Values
-
BODY_CONTENT_EMPTY
public static final java.lang.String BODY_CONTENT_EMPTY
static constant for getBodyContent() when it is empty- See Also:
- Constant Field Values
-
-
Constructor Detail
-
TagInfo
public TagInfo(java.lang.String tagName, java.lang.String tagClassName, java.lang.String bodycontent, java.lang.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(java.lang.String tagName, java.lang.String tagClassName, java.lang.String bodycontent, java.lang.String infoString, TagLibraryInfo taglib, TagExtraInfo tagExtraInfo, TagAttributeInfo[] attributeInfo, java.lang.String displayName, java.lang.String smallIcon, java.lang.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 Detail
-
getTagName
public java.lang.String getTagName()
The name of the Tag.- Returns:
- The (short) name of the tag.
-
getAttributes
public TagAttributeInfo[] 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
public VariableInfo[] getVariableInfo(TagData data)
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
public boolean isValid(TagData data)
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
public void setTagExtraInfo(TagExtraInfo tei)
Set the instance for extra tag information- Parameters:
tei
- the TagExtraInfo instance
-
getTagExtraInfo
public TagExtraInfo getTagExtraInfo()
The instance (if any) for extra tag information- Returns:
- The TagExtraInfo instance, if any.
-
getTagClassName
public java.lang.String getTagClassName()
Name of the class that provides the handler for this tag.- Returns:
- The name of the tag handler class.
-
getBodyContent
public java.lang.String getBodyContent()
The bodycontent information for this tag.- Returns:
- the body content string.
-
getInfoString
public java.lang.String getInfoString()
The information string for the tag.- Returns:
- the info string
-
setTagLibrary
public void setTagLibrary(TagLibraryInfo tl)
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
public TagLibraryInfo getTagLibrary()
The instance of TabLibraryInfo we belong to.- Returns:
- the tab library instance we belong to.
-
getDisplayName
public java.lang.String getDisplayName()
Get the displayName- Returns:
- A short name to be displayed by tools
-
getSmallIcon
public java.lang.String getSmallIcon()
Get the path to the small icon- Returns:
- Path to a small icon to be displayed by tools
-
getLargeIcon
public java.lang.String getLargeIcon()
Get the path to the large icon- Returns:
- Path to a large icon to be displayed by tools
-
getTagVariableInfos
public TagVariableInfo[] getTagVariableInfos()
Get TagVariableInfo objects associated with this TagInfo- Returns:
- A TagVariableInfo object associated with this
-
toString
public java.lang.String toString()
Stringify for debug purposes...- Overrides:
toString
in classjava.lang.Object
-
-