Home » apache-tomcat-6.0.26-src » javax » servlet » jsp » tagext » [javadoc | source]
javax.servlet.jsp.tagext
public class: TagInfo [javadoc | source]
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
public static final  String BODY_CONTENT_JSP    Static constant for getBodyContent() when it is JSP. 
public static final  String BODY_CONTENT_TAG_DEPENDENT    Static constant for getBodyContent() when it is Tag dependent. 
public static final  String BODY_CONTENT_EMPTY    Static constant for getBodyContent() when it is empty. 
public static final  String BODY_CONTENT_SCRIPTLESS    Static constant for getBodyContent() when it is scriptless.
    since: 2.0 -
 
Constructor:
 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 tag
    tagClassName - The name of the tag handler class
    bodycontent - Information on the body content of these tags
    infoString - The (optional) string information for this tag
    taglib - The instance of the tag library that contains us.
    tagExtraInfo - The instance providing extra Tag info. May be null
    attributeInfo - An array of AttributeInfo data from descriptor. May be null;
 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 tag
    tagClassName - The name of the tag handler class
    bodycontent - Information on the body content of these tags
    infoString - The (optional) string information for this tag
    taglib - The instance of the tag library that contains us.
    tagExtraInfo - The instance providing extra Tag info. May be null
    attributeInfo - An array of AttributeInfo data from descriptor. May be null;
    displayName - A short name to be displayed by tools
    smallIcon - Path to a small icon to be displayed by tools
    largeIcon - Path to a large icon to be displayed by tools
    tvi - An array of a TagVariableInfo (or null)
 public TagInfo(String tagName,
    String tagClassName,
    String bodycontent,
    String infoString,
    TagLibraryInfo taglib,
    TagExtraInfo tagExtraInfo,
    TagAttributeInfo[] attributeInfo,
    String displayName,
    String smallIcon,
    String largeIcon,
    TagVariableInfo[] tvi,
    boolean dynamicAttributes) 
    Constructor for TagInfo from data in the JSP 2.0 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 tag
    tagClassName - The name of the tag handler class
    bodycontent - Information on the body content of these tags
    infoString - The (optional) string information for this tag
    taglib - The instance of the tag library that contains us.
    tagExtraInfo - The instance providing extra Tag info. May be null
    attributeInfo - An array of AttributeInfo data from descriptor. May be null;
    displayName - A short name to be displayed by tools
    smallIcon - Path to a small icon to be displayed by tools
    largeIcon - Path to a large icon to be displayed by tools
    tvi - An array of a TagVariableInfo (or null)
    dynamicAttributes - True if supports dynamic attributes
    since: 2.0 -
Method from javax.servlet.jsp.tagext.TagInfo Summary:
getAttributes,   getBodyContent,   getDisplayName,   getInfoString,   getLargeIcon,   getSmallIcon,   getTagClassName,   getTagExtraInfo,   getTagLibrary,   getTagName,   getTagVariableInfos,   getVariableInfo,   hasDynamicAttributes,   isValid,   setTagExtraInfo,   setTagLibrary,   validate
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from javax.servlet.jsp.tagext.TagInfo Detail:
 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.
 public String getBodyContent() 
    The bodycontent information for this tag. If the bodycontent is not defined for this tag, the default of JSP will be returned.
 public String getDisplayName() 
    Get the displayName.
 public String getInfoString() 
    The information string for the tag.
 public String getLargeIcon() 
    Get the path to the large icon.
 public String getSmallIcon() 
    Get the path to the small icon.
 public String getTagClassName() 
    Name of the class that provides the handler for this tag.
 public TagExtraInfo getTagExtraInfo() 
    The instance (if any) for extra tag information.
 public TagLibraryInfo getTagLibrary() 
    The instance of TabLibraryInfo we belong to.
 public String getTagName() 
    The name of the Tag.
 public TagVariableInfo[] getTagVariableInfos() 
    Get TagVariableInfo objects associated with this TagInfo.
 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.
 public boolean hasDynamicAttributes() 
    Get dynamicAttributes associated with this TagInfo.
 public boolean isValid(TagData data) 
    Translation-time validation of the attributes. This is a convenience method on the associated TagExtraInfo class.
 public  void setTagExtraInfo(TagExtraInfo tei) 
    Set the instance for extra tag information.
 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.
 public ValidationMessage[] validate(TagData data) 
    Translation-time validation of the attributes. This is a convenience method on the associated TagExtraInfo class.