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
BaseTag (Apache Struts API Documentation)
9
<META NAME="keywords" CONTENT="org.apache.struts.taglib.html.BaseTag,BaseTag class">
10
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
15
parent.document.title="BaseTag (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/BaseTag.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/html/BaseInputTag.html"><B>PREV CLASS</B></A>
47
<A HREF="../../../../../org/apache/struts/taglib/html/ButtonTag.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="BaseTag.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.html</FONT>
83
+--javax.servlet.jsp.tagext.TagSupport
85
+--<B>org.apache.struts.taglib.html.BaseTag</B>
88
<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, javax.servlet.jsp.tagext.Tag</DD>
92
<DT>public class <B>BaseTag</B><DT>extends javax.servlet.jsp.tagext.TagSupport</DL>
95
Renders an HTML <base> element with an href
96
attribute pointing to the absolute location of the enclosing JSP page. This
97
tag is only valid when nested inside a head tag body. The presence
98
of this tag allows the browser to resolve relative URL's to images,
99
CSS stylesheets and other resources in a manner independent of the URL
100
used to call the ActionServlet.
105
<DT><B>Version:</B></DT>
106
<DD>$Revision: 1.1 $ $Date: 2003/08/26 12:57:37 $</DD>
107
<DT><B>Author:</B></DT>
108
<DD>Luis Arias <luis@elysia.com>, David Graham</DD>
109
<DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html" TARGET="org.apache.struts.taglib.html.BaseTag">Serialized Form</A></DL>
113
<!-- ======== NESTED CLASS SUMMARY ======== -->
116
<!-- =========== FIELD SUMMARY =========== -->
118
<A NAME="field_summary"><!-- --></A>
119
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
120
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
121
<TD COLSPAN=2><FONT SIZE="+2">
122
<B>Field Summary</B></FONT></TD>
124
<TR BGCOLOR="white" CLASS="TableRowColor">
125
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
126
<CODE>protected static <A HREF="../../../../../org/apache/struts/util/MessageResources.html">MessageResources</A></CODE></FONT></TD>
127
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/BaseTag.html#messages">messages</A></B></CODE>
130
The message resources for this package.</TD>
132
<TR BGCOLOR="white" CLASS="TableRowColor">
133
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
134
<CODE>protected java.lang.String</CODE></FONT></TD>
135
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/BaseTag.html#server">server</A></B></CODE>
138
The server name to use instead of request.getServerName().</TD>
140
<TR BGCOLOR="white" CLASS="TableRowColor">
141
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
142
<CODE>protected java.lang.String</CODE></FONT></TD>
143
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/BaseTag.html#target">target</A></B></CODE>
146
The target window for this base reference.</TD>
149
<A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.TagSupport"><!-- --></A>
150
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
151
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
152
<TD><B>Fields inherited from class javax.servlet.jsp.tagext.TagSupport</B></TD>
154
<TR BGCOLOR="white" CLASS="TableRowColor">
155
<TD><CODE>id, pageContext</CODE></TD>
158
<A NAME="fields_inherited_from_class_javax.servlet.jsp.tagext.Tag"><!-- --></A>
159
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
160
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
161
<TD><B>Fields inherited from interface javax.servlet.jsp.tagext.Tag</B></TD>
163
<TR BGCOLOR="white" CLASS="TableRowColor">
164
<TD><CODE>EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE</CODE></TD>
168
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
170
<A NAME="constructor_summary"><!-- --></A>
171
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
172
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
173
<TD COLSPAN=2><FONT SIZE="+2">
174
<B>Constructor Summary</B></FONT></TD>
176
<TR BGCOLOR="white" CLASS="TableRowColor">
177
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/BaseTag.html#BaseTag()">BaseTag</A></B>()</CODE>
180
</TD>
184
<!-- ========== METHOD SUMMARY =========== -->
186
<A NAME="method_summary"><!-- --></A>
187
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
188
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
189
<TD COLSPAN=2><FONT SIZE="+2">
190
<B>Method Summary</B></FONT></TD>
192
<TR BGCOLOR="white" CLASS="TableRowColor">
193
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194
<CODE> int</CODE></FONT></TD>
195
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/BaseTag.html#doStartTag()">doStartTag</A></B>()</CODE>
198
Process the start of this tag.</TD>
200
<TR BGCOLOR="white" CLASS="TableRowColor">
201
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202
<CODE> java.lang.String</CODE></FONT></TD>
203
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/BaseTag.html#getServer()">getServer</A></B>()</CODE>
206
Returns the server.</TD>
208
<TR BGCOLOR="white" CLASS="TableRowColor">
209
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
210
<CODE> java.lang.String</CODE></FONT></TD>
211
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/BaseTag.html#getTarget()">getTarget</A></B>()</CODE>
214
</TD>
216
<TR BGCOLOR="white" CLASS="TableRowColor">
217
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
218
<CODE>protected java.lang.String</CODE></FONT></TD>
219
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/BaseTag.html#renderBaseElement(java.lang.String, java.lang.String, int, java.lang.String)">renderBaseElement</A></B>(java.lang.String scheme,
220
java.lang.String serverName,
222
java.lang.String uri)</CODE>
225
Render a fully formed HTML <base> element and return it as a String.</TD>
227
<TR BGCOLOR="white" CLASS="TableRowColor">
228
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
229
<CODE> void</CODE></FONT></TD>
230
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/BaseTag.html#setServer(java.lang.String)">setServer</A></B>(java.lang.String server)</CODE>
233
Sets the server.</TD>
235
<TR BGCOLOR="white" CLASS="TableRowColor">
236
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
237
<CODE> void</CODE></FONT></TD>
238
<TD><CODE><B><A HREF="../../../../../org/apache/struts/taglib/html/BaseTag.html#setTarget(java.lang.String)">setTarget</A></B>(java.lang.String target)</CODE>
241
</TD>
244
<A NAME="methods_inherited_from_class_javax.servlet.jsp.tagext.TagSupport"><!-- --></A>
245
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
246
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
247
<TD><B>Methods inherited from class javax.servlet.jsp.tagext.TagSupport</B></TD>
249
<TR BGCOLOR="white" CLASS="TableRowColor">
250
<TD><CODE>doEndTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue</CODE></TD>
253
<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
254
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
255
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
256
<TD><B>Methods inherited from class java.lang.Object</B></TD>
258
<TR BGCOLOR="white" CLASS="TableRowColor">
259
<TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD>
265
<!-- ============ FIELD DETAIL =========== -->
267
<A NAME="field_detail"><!-- --></A>
268
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
269
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
270
<TD COLSPAN=1><FONT SIZE="+2">
271
<B>Field Detail</B></FONT></TD>
275
<A NAME="messages"><!-- --></A><H3>
278
protected static <A HREF="../../../../../org/apache/struts/util/MessageResources.html">MessageResources</A> <B>messages</B></PRE>
280
<DD>The message resources for this package.
287
<A NAME="server"><!-- --></A><H3>
290
protected java.lang.String <B>server</B></PRE>
292
<DD>The server name to use instead of request.getServerName().
299
<A NAME="target"><!-- --></A><H3>
302
protected java.lang.String <B>target</B></PRE>
304
<DD>The target window for this base reference.
310
<!-- ========= CONSTRUCTOR DETAIL ======== -->
312
<A NAME="constructor_detail"><!-- --></A>
313
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
314
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
315
<TD COLSPAN=1><FONT SIZE="+2">
316
<B>Constructor Detail</B></FONT></TD>
320
<A NAME="BaseTag()"><!-- --></A><H3>
323
public <B>BaseTag</B>()</PRE>
327
<!-- ============ METHOD DETAIL ========== -->
329
<A NAME="method_detail"><!-- --></A>
330
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
331
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
332
<TD COLSPAN=1><FONT SIZE="+2">
333
<B>Method Detail</B></FONT></TD>
337
<A NAME="getTarget()"><!-- --></A><H3>
340
public java.lang.String <B>getTarget</B>()</PRE>
348
<A NAME="setTarget(java.lang.String)"><!-- --></A><H3>
351
public void <B>setTarget</B>(java.lang.String target)</PRE>
359
<A NAME="doStartTag()"><!-- --></A><H3>
362
public int <B>doStartTag</B>()
363
throws javax.servlet.jsp.JspException</PRE>
365
<DD>Process the start of this tag.
368
<DT><B>Specified by:</B><DD><CODE>doStartTag</CODE> in interface <CODE>javax.servlet.jsp.tagext.Tag</CODE><DT><B>Overrides:</B><DD><CODE>doStartTag</CODE> in class <CODE>javax.servlet.jsp.tagext.TagSupport</CODE></DL>
373
<DD><CODE>javax.servlet.jsp.JspException</CODE> - if a JSP exception has occurred</DL>
378
<A NAME="renderBaseElement(java.lang.String, java.lang.String, int, java.lang.String)"><!-- --></A><H3>
379
renderBaseElement</H3>
381
protected java.lang.String <B>renderBaseElement</B>(java.lang.String scheme,
382
java.lang.String serverName,
384
java.lang.String uri)</PRE>
386
<DD>Render a fully formed HTML <base> element and return it as a String.
389
<DT><B>Parameters:</B><DD><CODE>scheme</CODE> - The scheme used in the url (ie. http or https).<DD><CODE>serverName</CODE> - <DD><CODE>port</CODE> - <DD><CODE>uri</CODE> - The portion of the url from the protocol name up to the query
391
<DT><B>Returns:</B><DD>String An HTML <base> element.<DT><B>Since:</B></DT>
398
<A NAME="getServer()"><!-- --></A><H3>
401
public java.lang.String <B>getServer</B>()</PRE>
403
<DD>Returns the server.
407
<DT><B>Returns:</B><DD>String</DL>
412
<A NAME="setServer(java.lang.String)"><!-- --></A><H3>
415
public void <B>setServer</B>(java.lang.String server)</PRE>
420
<DT><B>Parameters:</B><DD><CODE>server</CODE> - The server to set</DL>
423
<!-- ========= END OF CLASS DATA ========= -->
426
<!-- ========== START OF NAVBAR ========== -->
427
<A NAME="navbar_bottom"><!-- --></A>
428
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
430
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
431
<A NAME="navbar_bottom_firstrow"><!-- --></A>
432
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
433
<TR ALIGN="center" VALIGN="top">
434
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
435
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
436
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
437
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/BaseTag.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
438
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
439
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
440
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
441
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
445
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
451
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
452
<A HREF="../../../../../org/apache/struts/taglib/html/BaseInputTag.html"><B>PREV CLASS</B></A>
453
<A HREF="../../../../../org/apache/struts/taglib/html/ButtonTag.html"><B>NEXT CLASS</B></A></FONT></TD>
454
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
455
<A HREF="../../../../../index.html" TARGET="_top"><B>FRAMES</B></A>
456
<A HREF="BaseTag.html" TARGET="_top"><B>NO FRAMES</B></A>
461
document.writeln('<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
466
<A HREF="../../../../../allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
471
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
472
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
473
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
474
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
477
<!-- =========== END OF NAVBAR =========== -->
480
Copyright � 2000-2003 - Apache Software Foundation