taginfo.html

jsp doc sun java

<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../javax/servlet/jsp/tagext/TagInfo.html#getTagName()">getTagName</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The name of the Tag.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../javax/servlet/jsp/tagext/TagVariableInfo.html" title="class in javax.servlet.jsp.tagext">TagVariableInfo</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../javax/servlet/jsp/tagext/TagInfo.html#getTagVariableInfos()">getTagVariableInfos</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get TagVariableInfo objects associated with this TagInfo.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../javax/servlet/jsp/tagext/VariableInfo.html" title="class in javax.servlet.jsp.tagext">VariableInfo</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../javax/servlet/jsp/tagext/TagInfo.html#getVariableInfo(javax.servlet.jsp.tagext.TagData)">getVariableInfo</A></B>(<A HREF="../../../../javax/servlet/jsp/tagext/TagData.html" title="class in javax.servlet.jsp.tagext">TagData</A>&nbsp;data)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Information on the scripting objects created by this tag at runtime.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../javax/servlet/jsp/tagext/TagInfo.html#hasDynamicAttributes()">hasDynamicAttributes</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get dynamicAttributes associated with this TagInfo.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../javax/servlet/jsp/tagext/TagInfo.html#isValid(javax.servlet.jsp.tagext.TagData)">isValid</A></B>(<A HREF="../../../../javax/servlet/jsp/tagext/TagData.html" title="class in javax.servlet.jsp.tagext">TagData</A>&nbsp;data)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Translation-time validation of the attributes.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../javax/servlet/jsp/tagext/TagInfo.html#setTagExtraInfo(javax.servlet.jsp.tagext.TagExtraInfo)">setTagExtraInfo</A></B>(<A HREF="../../../../javax/servlet/jsp/tagext/TagExtraInfo.html" title="class in javax.servlet.jsp.tagext">TagExtraInfo</A>&nbsp;tei)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the instance for extra tag information.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../javax/servlet/jsp/tagext/TagInfo.html#setTagLibrary(javax.servlet.jsp.tagext.TagLibraryInfo)">setTagLibrary</A></B>(<A HREF="../../../../javax/servlet/jsp/tagext/TagLibraryInfo.html" title="class in javax.servlet.jsp.tagext">TagLibraryInfo</A>&nbsp;tl)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the TagLibraryInfo property.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../../javax/servlet/jsp/tagext/ValidationMessage.html" title="class in javax.servlet.jsp.tagext">ValidationMessage</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../javax/servlet/jsp/tagext/TagInfo.html#validate(javax.servlet.jsp.tagext.TagData)">validate</A></B>(<A HREF="../../../../javax/servlet/jsp/tagext/TagData.html" title="class in javax.servlet.jsp.tagext">TagData</A>&nbsp;data)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Translation-time validation of the attributes.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TD><B>Methods inherited from class java.lang.Object</B></TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

<!-- ============ FIELD DETAIL =========== -->

<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Field Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="BODY_CONTENT_JSP"><!-- --></A><H3>
BODY_CONTENT_JSP</H3>
<PRE>
public static final java.lang.String <B>BODY_CONTENT_JSP</B></PRE>
<DL>
<DD>Static constant for getBodyContent() when it is JSP.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#javax.servlet.jsp.tagext.TagInfo.BODY_CONTENT_JSP">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="BODY_CONTENT_TAG_DEPENDENT"><!-- --></A><H3>
BODY_CONTENT_TAG_DEPENDENT</H3>
<PRE>
public static final java.lang.String <B>BODY_CONTENT_TAG_DEPENDENT</B></PRE>
<DL>
<DD>Static constant for getBodyContent() when it is Tag dependent.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#javax.servlet.jsp.tagext.TagInfo.BODY_CONTENT_TAG_DEPENDENT">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="BODY_CONTENT_EMPTY"><!-- --></A><H3>
BODY_CONTENT_EMPTY</H3>
<PRE>
public static final java.lang.String <B>BODY_CONTENT_EMPTY</B></PRE>
<DL>
<DD>Static constant for getBodyContent() when it is empty.
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#javax.servlet.jsp.tagext.TagInfo.BODY_CONTENT_EMPTY">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="BODY_CONTENT_SCRIPTLESS"><!-- --></A><H3>
BODY_CONTENT_SCRIPTLESS</H3>
<PRE>
public static final java.lang.String <B>BODY_CONTENT_SCRIPTLESS</B></PRE>
<DL>
<DD>Static constant for getBodyContent() when it is scriptless.
<P>
<DL>
<DT><B>Since:</B></DT>
  <DD>2.0</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#javax.servlet.jsp.tagext.TagInfo.BODY_CONTENT_SCRIPTLESS">Constant Field Values</A></DL>
</DL>

<!-- ========= CONSTRUCTOR DETAIL ======== -->

<A NAME="constructor_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Constructor Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="TagInfo(java.lang.String, java.lang.String, java.lang.String, java.lang.String, javax.servlet.jsp.tagext.TagLibraryInfo, javax.servlet.jsp.tagext.TagExtraInfo, javax.servlet.jsp.tagext.TagAttributeInfo[])"><!-- --></A><H3>
TagInfo</H3>
<PRE>
public <B>TagInfo</B>(java.lang.String&nbsp;tagName,
               java.lang.String&nbsp;tagClassName,
               java.lang.String&nbsp;bodycontent,
               java.lang.String&nbsp;infoString,
               <A HREF="../../../../javax/servlet/jsp/tagext/TagLibraryInfo.html" title="class in javax.servlet.jsp.tagext">TagLibraryInfo</A>&nbsp;taglib,
               <A HREF="../../../../javax/servlet/jsp/tagext/TagExtraInfo.html" title="class in javax.servlet.jsp.tagext">TagExtraInfo</A>&nbsp;tagExtraInfo,
               <A HREF="../../../../javax/servlet/jsp/tagext/TagAttributeInfo.html" title="class in javax.servlet.jsp.tagext">TagAttributeInfo</A>[]&nbsp;attributeInfo)</PRE>
<DL>
<DD>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.
<P>
<DT><B>Parameters:</B><DD><CODE>tagName</CODE> - The name of this tag<DD><CODE>tagClassName</CODE> - The name of the tag handler class<DD><CODE>bodycontent</CODE> - Information on the body content of these tags<DD><CODE>infoString</CODE> - The (optional) string information for this tag<DD><CODE>taglib</CODE> - The instance of the tag library that contains us.<DD><CODE>tagExtraInfo</CODE> - The instance providing extra Tag info.  May be null<DD><CODE>attributeInfo</CODE> - An array of AttributeInfo data from descriptor.
 May be null;</DL>
<HR>

<A NAME="TagInfo(java.lang.String, java.lang.String, java.lang.String, java.lang.String, javax.servlet.jsp.tagext.TagLibraryInfo, javax.servlet.jsp.tagext.TagExtraInfo, javax.servlet.jsp.tagext.TagAttributeInfo[], java.lang.String, java.lang.String, java.lang.String, javax.servlet.jsp.tagext.TagVariableInfo[])"><!-- --></A><H3>
TagInfo</H3>
<PRE>
public <B>TagInfo</B>(java.lang.String&nbsp;tagName,
               java.lang.String&nbsp;tagClassName,
               java.lang.String&nbsp;bodycontent,
               java.lang.String&nbsp;infoString,
               <A HREF="../../../../javax/servlet/jsp/tagext/TagLibraryInfo.html" title="class in javax.servlet.jsp.tagext">TagLibraryInfo</A>&nbsp;taglib,
               <A HREF="../../../../javax/servlet/jsp/tagext/TagExtraInfo.html" title="class in javax.servlet.jsp.tagext">TagExtraInfo</A>&nbsp;tagExtraInfo,
               <A HREF="../../../../javax/servlet/jsp/tagext/TagAttributeInfo.html" title="class in javax.servlet.jsp.tagext">TagAttributeInfo</A>[]&nbsp;attributeInfo,
               java.lang.String&nbsp;displayName,
               java.lang.String&nbsp;smallIcon,
               java.lang.String&nbsp;largeIcon,
               <A HREF="../../../../javax/servlet/jsp/tagext/TagVariableInfo.html" title="class in javax.servlet.jsp.tagext">TagVariableInfo</A>[]&nbsp;tvi)</PRE>
<DL>
<DD>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.
<P>
<DT><B>Parameters:</B><DD><CODE>tagName</CODE> - The name of this tag<DD><CODE>tagClassName</CODE> - The name of the tag handler class<DD><CODE>bodycontent</CODE> - Information on the body content of these tags<DD><CODE>infoString</CODE> - The (optional) string information for this tag<DD><CODE>taglib</CODE> - The instance of the tag library that contains us.<DD><CODE>tagExtraInfo</CODE> - The instance providing extra Tag info.  May be null<DD><CODE>attributeInfo</CODE> - An array of AttributeInfo data from descriptor.
 May be null;<DD><CODE>displayName</CODE> - A short name to be displayed by tools<DD><CODE>smallIcon</CODE> - Path to a small icon to be displayed by tools<DD><CODE>largeIcon</CODE> - Path to a large icon to be displayed by tools<DD><CODE>tvi</CODE> - An array of a TagVariableInfo (or null)</DL>
<HR>

<A NAME="TagInfo(java.lang.String, java.lang.String, java.lang.String, java.lang.String, javax.servlet.jsp.tagext.TagLibraryInfo, javax.servlet.jsp.tagext.TagExtraInfo, javax.servlet.jsp.tagext.TagAttributeInfo[], java.lang.String, java.lang.String, java.lang.String, javax.servlet.jsp.tagext.TagVariableInfo[], boolean)"><!-- --></A><H3>
TagInfo</H3>
<PRE>
public <B>TagInfo</B>(java.lang.String&nbsp;tagName,
               java.lang.String&nbsp;tagClassName,
               java.lang.String&nbsp;bodycontent,
               java.lang.String&nbsp;infoString,
               <A HREF="../../../../javax/servlet/jsp/tagext/TagLibraryInfo.html" title="class in javax.servlet.jsp.tagext">TagLibraryInfo</A>&nbsp;taglib,
               <A HREF="../../../../javax/servlet/jsp/tagext/TagExtraInfo.html" title="class in javax.servlet.jsp.tagext">TagExtraInfo</A>&nbsp;tagExtraInfo,
               <A HREF="../../../../javax/servlet/jsp/tagext/TagAttributeInfo.html" title="class in javax.servlet.jsp.tagext">TagAttributeInfo</A>[]&nbsp;attributeInfo,
               java.lang.String&nbsp;displayName,
               java.lang.String&nbsp;smallIcon,
               java.lang.String&nbsp;largeIcon,
               <A HREF="../../../../javax/servlet/jsp/tagext/TagVariableInfo.html" title="class in javax.servlet.jsp.tagext">TagVariableInfo</A>[]&nbsp;tvi,
               boolean&nbsp;dynamicAttributes)</PRE>
<DL>
<DD>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.
<P>
<DT><B>Parameters:</B><DD><CODE>tagName</CODE> - The name of this tag<DD><CODE>tagClassName</CODE> - The name of the tag handler class<DD><CODE>bodycontent</CODE> - Information on the body content of these tags<DD><CODE>infoString</CODE> - The (optional) string information for this tag<DD><CODE>taglib</CODE> - The instance of the tag library that contains us.<DD><CODE>tagExtraInfo</CODE> - The instance providing extra Tag info.  May be null<DD><CODE>attributeInfo</CODE> - An array of AttributeInfo data from descriptor.
 May be null;<DD><CODE>displayName</CODE> - A short name to be displayed by tools<DD><CODE>smallIcon</CODE> - Path to a small icon to be displayed by tools<DD><CODE>largeIcon</CODE> - Path to a large icon to be displayed by tools<DD><CODE>tvi</CODE> - An array of a TagVariableInfo (or null)<DD><CODE>dynamicAttributes</CODE> - True if supports dynamic attributes<DT><B>Since:</B></DT>
  <DD>2.0</DD>
</DL>

<!-- ============ METHOD DETAIL ========== -->

<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TD COLSPAN=1><FONT SIZE="+2">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="getTagName()"><!-- --></A><H3>
getTagName</H3>
<PRE>
public java.lang.String <B>getTagName</B>()</PRE>
<DL>
<DD>The name of the Tag.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The (short) name of the tag.</DL>
</DD>
</DL>
<HR>

<A NAME="getAttributes()"><!-- --></A><H3>
getAttributes</H3>
<PRE>
public <A HREF="../../../../javax/servlet/jsp/tagext/TagAttributeInfo.html" title="class in javax.servlet.jsp.tagext">TagAttributeInfo</A>[] <B>getAttributes</B>()</PRE>
<DL>
<DD>Attribute information (in the TLD) on this tag.
 The return is an array describing the attributes of this tag, as
 indicated in the TLD.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>The array of TagAttributeInfo for this tag, or a
         zero-length array if the tag has no attributes.</DL>
</DD>
</DL>
<HR>

<A NAME="getVariableInfo(javax.servlet.jsp.tagext.TagData)"><!-- --></A><H3>
getVariableInfo</H3>
<PRE>
public <A HREF="../../../../javax/servlet/jsp/tagext/VariableInfo.html" title="class in javax.servlet.jsp.tagext">VariableInfo</A>[] <B>getVariableInfo</B>(<A HREF="../../../../javax/servlet/jsp/tagext/TagData.html" title="class in javax.servlet.jsp.tagext">TagData</A>&nbsp;data)</PRE>
<DL>
<DD>Information on the scripting objects created by this tag at runtime.
 This is a convenience method on the associated TagExtraInfo class.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>data</CODE> - TagData describing this action.
<DT><B>Returns:</B><DD>if a TagExtraInfo object is associated with this TagInfo, the
     result of getTagExtraInfo().getVariableInfo( data ), otherwise
     null.</DL>