1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
5
<!-- Generated by javadoc on Fri Aug 22 03:44:05 EDT 2003 -->
7
PresentTag (Apache Struts API Documentation)
9
<META NAME="keywords" CONTENT="org.apache.struts.taglib.logic.PresentTag,PresentTag class">
10
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
15
parent.document.title="PresentTag (Apache Struts API Documentation)";
18
<BODY BGCOLOR="white" onload="asd();">
20
<!-- ========== START OF NAVBAR ========== -->
21
<A NAME="navbar_top"><!-- --></A>
22
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
24
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
25
<A NAME="navbar_top_firstrow"><!-- --></A>
26
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
27
<TR ALIGN="center" VALIGN="top">
28
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
29
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
30
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
31
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PresentTag.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
32
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
33
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
34
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
35
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
39
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
45
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
46
<A HREF="../../../../../org/apache/struts/taglib/logic/NotPresentTag.html"><B>PREV CLASS</B></A>
47
<A HREF="../../../../../org/apache/struts/taglib/logic/RedirectTag.html"><B>NEXT CLASS</B></A></FONT></TD>
48
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
49
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
50
<A HREF="PresentTag.html" TARGET="_top"><B>NO FRAMES</B></A>
55
document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
60
<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
65
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
66
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
67
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
68
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
71
<!-- =========== END OF NAVBAR =========== -->
74
<!-- ======== START OF CLASS DATA ======== -->
77
org.apache.struts.taglib.logic</FONT>
83
+--javax.servlet.jsp.tagext.TagSupport
85
+--<A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html">org.apache.struts.taglib.logic.ConditionalTagBase</A>
87
+--<B>org.apache.struts.taglib.logic.PresentTag</B>
90
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, javax.servlet.jsp.tagext.Tag</DD>
93
<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../org/apache/struts/taglib/nested/logic/NestedPresentTag.html">NestedPresentTag</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/NotPresentTag.html">NotPresentTag</A></DD>
97
<DT>public class <B>PresentTag</B><DT>extends <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html">ConditionalTagBase</A></DL>
100
Evalute the nested body content of this tag if the specified value
101
is present for this request.
106
<DT><B>Version:</B></DT>
107
<DD>$Revision: 1.1 $ $Date: 2003/08/26 12:57:40 $</DD>
108
<DT><B>Author:</B></DT>
109
<DD>Craig R. McClanahan</DD>
110
<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html" TARGET="org.apache.struts.taglib.logic.PresentTag">Serialized Form</A></DL>
114
<!-- ======== NESTED CLASS SUMMARY ======== -->
117
<!-- =========== FIELD SUMMARY =========== -->
119
<A NAME="field_summary"><!-- --></A>
120
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
121
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
122
<TD COLSPAN=2><FONT SIZE="+2">
123
<B>Field Summary</B></FONT></TD>
125
<TR BGCOLOR="white" CLASS="TableRowColor">
126
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
127
<CODE>static java.lang.String</CODE></FONT></TD>
128
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/PresentTag.html#ROLE_DELIMITER">ROLE_DELIMITER</A></B></CODE>
131
</TD>
134
<A NAME="fields_inherited_from_class_org.apache.struts.taglib.logic.ConditionalTagBase"><!-- --></A>
135
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
136
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
137
<TD><B>Fields inherited from class org.apache.struts.taglib.logic.<A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html">ConditionalTagBase</A></B></TD>
139
<TR BGCOLOR="white" CLASS="TableRowColor">
140
<TD><CODE><A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#cookie">cookie</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#header">header</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#messages">messages</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#name">name</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#parameter">parameter</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#property">property</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#role">role</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#scope">scope</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#user">user</A></CODE></TD>
143
<A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.TagSupport"><!-- --></A>
144
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
145
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
146
<TD><B>Fields inherited from class javax.servlet.jsp.tagext.TagSupport</B></TD>
148
<TR BGCOLOR="white" CLASS="TableRowColor">
149
<TD><CODE>id, pageContext</CODE></TD>
152
<A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.Tag"><!-- --></A>
153
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
154
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
155
<TD><B>Fields inherited from interface javax.servlet.jsp.tagext.Tag</B></TD>
157
<TR BGCOLOR="white" CLASS="TableRowColor">
158
<TD><CODE>EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE</CODE></TD>
162
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
164
<A NAME="constructor_summary"><!-- --></A>
165
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
166
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
167
<TD COLSPAN=2><FONT SIZE="+2">
168
<B>Constructor Summary</B></FONT></TD>
170
<TR BGCOLOR="white" CLASS="TableRowColor">
171
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/PresentTag.html#PresentTag()">PresentTag</A></B>()</CODE>
174
</TD>
178
<!-- ========== METHOD SUMMARY =========== -->
180
<A NAME="method_summary"><!-- --></A>
181
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
182
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
183
<TD COLSPAN=2><FONT SIZE="+2">
184
<B>Method Summary</B></FONT></TD>
186
<TR BGCOLOR="white" CLASS="TableRowColor">
187
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
188
<CODE>protected boolean</CODE></FONT></TD>
189
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/PresentTag.html#condition()">condition</A></B>()</CODE>
192
Evaluate the condition that is being tested by this particular tag,
193
and return <code>true</code> if the nested body content of this tag
194
should be evaluated, or <code>false</code> if it should be skipped.</TD>
196
<TR BGCOLOR="white" CLASS="TableRowColor">
197
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
198
<CODE>protected boolean</CODE></FONT></TD>
199
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/logic/PresentTag.html#condition(boolean)">condition</A></B>(boolean desired)</CODE>
202
Evaluate the condition that is being tested by this particular tag,
203
and return <code>true</code> if the nested body content of this tag
204
should be evaluated, or <code>false</code> if it should be skipped.</TD>
207
<A NAME="methods_inherited_from_class_org.apache.struts.taglib.logic.ConditionalTagBase"><!-- --></A>
208
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
209
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
210
<TD><B>Methods inherited from class org.apache.struts.taglib.logic.<A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html">ConditionalTagBase</A></B></TD>
212
<TR BGCOLOR="white" CLASS="TableRowColor">
213
<TD><CODE><A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#doEndTag()">doEndTag</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#doStartTag()">doStartTag</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#getCookie()">getCookie</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#getHeader()">getHeader</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#getName()">getName</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#getParameter()">getParameter</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#getProperty()">getProperty</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#getRole()">getRole</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#getScope()">getScope</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#getUser()">getUser</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#release()">release</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#setCookie(java.lang.String)">setCookie</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#setHeader(java.lang.String)">setHeader</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#setName(java.lang.String)">setName</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#setParameter(java.lang.String)">setParameter</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#setProperty(java.lang.String)">setProperty</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#setRole(java.lang.String)">setRole</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#setScope(java.lang.String)">setScope</A>, <A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#setUser(java.lang.String)">setUser</A></CODE></TD>
216
<A NAME="methods_inherited_from_class_javax.servlet.jsp.tagext.TagSupport"><!-- --></A>
217
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
218
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
219
<TD><B>Methods inherited from class javax.servlet.jsp.tagext.TagSupport</B></TD>
221
<TR BGCOLOR="white" CLASS="TableRowColor">
222
<TD><CODE>findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue</CODE></TD>
225
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
226
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
227
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
228
<TD><B>Methods inherited from class java.lang.Object</B></TD>
230
<TR BGCOLOR="white" CLASS="TableRowColor">
231
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
237
<!-- ============ FIELD DETAIL =========== -->
239
<A NAME="field_detail"><!-- --></A>
240
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
241
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
242
<TD COLSPAN=1><FONT SIZE="+2">
243
<B>Field Detail</B></FONT></TD>
247
<A NAME="ROLE_DELIMITER"><!-- --></A><H3>
250
public static final java.lang.String <B>ROLE_DELIMITER</B></PRE>
253
<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#org.apache.struts.taglib.logic.PresentTag.ROLE_DELIMITER">Constant Field Values</A></DL>
256
<!-- ========= CONSTRUCTOR DETAIL ======== -->
258
<A NAME="constructor_detail"><!-- --></A>
259
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
260
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
261
<TD COLSPAN=1><FONT SIZE="+2">
262
<B>Constructor Detail</B></FONT></TD>
266
<A NAME="PresentTag()"><!-- --></A><H3>
269
public <B>PresentTag</B>()</PRE>
273
<!-- ============ METHOD DETAIL ========== -->
275
<A NAME="method_detail"><!-- --></A>
276
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
277
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
278
<TD COLSPAN=1><FONT SIZE="+2">
279
<B>Method Detail</B></FONT></TD>
283
<A NAME="condition()"><!-- --></A><H3>
286
protected boolean <B>condition</B>()
287
throws javax.servlet.jsp.JspException</PRE>
289
<DD>Evaluate the condition that is being tested by this particular tag,
290
and return <code>true</code> if the nested body content of this tag
291
should be evaluated, or <code>false</code> if it should be skipped.
292
This method must be implemented by concrete subclasses.
295
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html#condition()">condition</A></CODE> in class <CODE><A HREF="../../../../../org/apache/struts/taglib/logic/ConditionalTagBase.html">ConditionalTagBase</A></CODE></DL>
300
<DD><CODE>javax.servlet.jsp.JspException</CODE> - if a JSP exception occurs</DL>
305
<A NAME="condition(boolean)"><!-- --></A><H3>
308
protected boolean <B>condition</B>(boolean desired)
309
throws javax.servlet.jsp.JspException</PRE>
311
<DD>Evaluate the condition that is being tested by this particular tag,
312
and return <code>true</code> if the nested body content of this tag
313
should be evaluated, or <code>false</code> if it should be skipped.
314
This method must be implemented by concrete subclasses.
317
<DT><B>Parameters:</B><DD><CODE>desired</CODE> - Desired outcome for a true result
319
<DD><CODE>javax.servlet.jsp.JspException</CODE> - if a JSP exception occurs</DL>
322
<!-- ========= END OF CLASS DATA ========= -->
325
<!-- ========== START OF NAVBAR ========== -->
326
<A NAME="navbar_bottom"><!-- --></A>
327
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
329
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
330
<A NAME="navbar_bottom_firstrow"><!-- --></A>
331
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
332
<TR ALIGN="center" VALIGN="top">
333
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
334
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
335
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
336
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PresentTag.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
337
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
338
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
339
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
340
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
344
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
350
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
351
<A HREF="../../../../../org/apache/struts/taglib/logic/NotPresentTag.html"><B>PREV CLASS</B></A>
352
<A HREF="../../../../../org/apache/struts/taglib/logic/RedirectTag.html"><B>NEXT CLASS</B></A></FONT></TD>
353
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
354
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
355
<A HREF="PresentTag.html" TARGET="_top"><B>NO FRAMES</B></A>
360
document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
365
<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
370
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
371
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
372
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
373
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
376
<!-- =========== END OF NAVBAR =========== -->
379
Copyright � 2000-2003 - Apache Software Foundation