portletresponse.html

门户开发

<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="../../../../org/apache/jetspeed/portlet/PortletResponse.html#setDateHeader(java.lang.String, long)">setDateHeader</A></B>(java.lang.String&nbsp;name,
              long&nbsp;date)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets a response header with the given name and
 date-value.</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="../../../../org/apache/jetspeed/portlet/PortletResponse.html#setHeader(java.lang.String, java.lang.String)">setHeader</A></B>(java.lang.String&nbsp;name,
          java.lang.String&nbsp;value)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets a response header with the given name and value.</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="../../../../org/apache/jetspeed/portlet/PortletResponse.html#setIntHeader(java.lang.String, int)">setIntHeader</A></B>(java.lang.String&nbsp;name,
             int&nbsp;value)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets a response header with the given name and
 integer value.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_javax.servlet.http.HttpServletResponse"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface javax.servlet.http.HttpServletResponse</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>encodeRedirectUrl, encodeRedirectURL, encodeUrl, sendError, sendError, sendRedirect, setStatus, setStatus</CODE></TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_javax.servlet.ServletResponse"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface javax.servlet.ServletResponse</B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE>flushBuffer, getBufferSize, getLocale, getOutputStream, isCommitted, reset, resetBuffer, setBufferSize, setContentLength, setContentType, setLocale</CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>

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


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


<!-- ============ 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="getWriter()"><!-- --></A><H3>
getWriter</H3>
<PRE>
public java.io.PrintWriter <B>getWriter</B>()
                              throws java.io.IOException</PRE>
<DL>
<DD>Returns the writer object that can be used to contribute
 markup to the portlet response.

 <P>
 It is important to note that the markup generated by the
 portlet is either a full document or just a fragment of the
 markup. A corresponding setting in the deployment descriptor
 has to be made.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getWriter</CODE> in interface <CODE>javax.servlet.ServletResponse</CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the print writer
<DT><B>Throws:</B>
<DD><CODE>java.io.IOException</CODE> - if the I/O operation fails</DL>
</DD>
</DL>
<HR>

<A NAME="getContentType()"><!-- --></A><H3>
getContentType</H3>
<PRE>
public java.lang.String <B>getContentType</B>()</PRE>
<DL>
<DD>Returns the content type that can be used to contribute
 markup to the portlet response.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the content type</DL>
</DD>
</DL>
<HR>

<A NAME="getCharacterEncoding()"><!-- --></A><H3>
getCharacterEncoding</H3>
<PRE>
public java.lang.String <B>getCharacterEncoding</B>()</PRE>
<DL>
<DD>Returns the name of the charset used for
 the MIME body sent in this response.

 <p>If no charset has been assigned, it is implicitly
 set to <code>ISO-8859-1</code> (<code>Latin-1</code>).

 <p>See RFC 2047 (http://ds.internic.net/rfc/rfc2045.txt)
 for more information about character encoding and MIME.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>getCharacterEncoding</CODE> in interface <CODE>javax.servlet.ServletResponse</CODE></DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a <code>String</code> specifying the
			name of the charset, for
			example, <code>ISO-8859-1</code></DL>
</DD>
</DL>
<HR>

<A NAME="getCharacterSet()"><!-- --></A><H3>
getCharacterSet</H3>
<PRE>
public java.lang.String <B>getCharacterSet</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>use <CODE>getCharacterEncoding</CODE> since version 1.1</I>
<P>
<DD>Returns the character set that can be used to contribute
 markup to the portlet response.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>the character set</DL>
</DD>
</DL>
<HR>

<A NAME="createURI()"><!-- --></A><H3>
createURI</H3>
<PRE>
public <A HREF="../../../../org/apache/jetspeed/portlet/PortletURI.html" title="interface in org.apache.jetspeed.portlet">PortletURI</A> <B>createURI</B>()</PRE>
<DL>
<DD>Creates a portlet URI pointing to the current portlet mode.
 The returned URI can be further extended by adding
 portlet-specific parameters and by attaching an action. Also,
 the portlet window will stay in the same state as before.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a portlet URI</DL>
</DD>
</DL>
<HR>

<A NAME="createURI(org.apache.jetspeed.portlet.PortletWindow.State)"><!-- --></A><H3>
createURI</H3>
<PRE>
public <A HREF="../../../../org/apache/jetspeed/portlet/PortletURI.html" title="interface in org.apache.jetspeed.portlet">PortletURI</A> <B>createURI</B>(<A HREF="../../../../org/apache/jetspeed/portlet/PortletWindow.State.html" title="class in org.apache.jetspeed.portlet">PortletWindow.State</A>&nbsp;state)</PRE>
<DL>
<DD>Creates a portlet URI pointing to the current portlet mode
 and given portlet window state. The returned URI can be
 further extended by adding portlet-specific parameters and
 by attaching an action.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>state</CODE> - the portlet window state
<DT><B>Returns:</B><DD>a portlet URI</DL>
</DD>
</DL>
<HR>

<A NAME="createReturnURI()"><!-- --></A><H3>
createReturnURI</H3>
<PRE>
public <A HREF="../../../../org/apache/jetspeed/portlet/PortletURI.html" title="interface in org.apache.jetspeed.portlet">PortletURI</A> <B>createReturnURI</B>()</PRE>
<DL>
<DD>Creates a portlet URI pointing at the referrer of the portlet. This is
 normally the previous screen / URL shown in the browser.
 The returned URI can be further extended by adding
 portlet-specific parameters and/or by attaching an action.
 This method is very useful to return from the EDIT mode,
 for example.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>a portlet URI</DL>
</DD>
</DL>
<HR>

<A NAME="encodeURI(java.lang.String)"><!-- --></A><H3>
encodeURI</H3>
<PRE>
public java.lang.String <B>encodeURI</B>(java.lang.String&nbsp;path)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I>use <A HREF="../../../../org/apache/jetspeed/portlet/PortletResponse.html#encodeURL(java.lang.String)"><CODE>encodeURL(java.lang.String)</CODE></A> since version 1.1</I>
<P>
<DD>Returns the encoded URI of the resource at the given path.
 Encoding may include prefixing, conversion to absolute URL, 
 WSRP rewriting etc.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - the path to the resource
<DT><B>Returns:</B><DD>the resource URI as string<DT><B>See Also:</B><DD><A HREF="../../../../org/apache/jetspeed/portlet/PortletResponse.html#encodeURL(java.lang.String)"><CODE>encodeURL(java.lang.String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="encodeURL(java.lang.String)"><!-- --></A><H3>
encodeURL</H3>
<PRE>
public java.lang.String <B>encodeURL</B>(java.lang.String&nbsp;path)</PRE>
<DL>
<DD>Returns the encoded URI of the resource at the given path.
 Encoding may include prefixing, conversion to absolute URL, 
 WSRP rewriting etc.
 <p>
 This method <em>must</em> be called on all resource URLs 
 (images etc.) before they are written to the output writer.
 It <em>must not</em> be called on portal or portlet URLs that 
 were generated using APIs like <A HREF="../../../../org/apache/jetspeed/portlet/PortletResponse.html#createURI()"><CODE>createURI()</CODE></A>  
 <P>
 The given path may be a relative path inside the portlet WAR
 file like images/myimage.gif, which must be relative to the root
 of the WAR archive. For historical compatibility reasons, 
 absolute paths that do not start with the portlet or portal context 
 root are also treated as relative paths inside the portlet WAR; e.g.
 /images/myimage.gif is equivalent to images/myimage.gif.
 <P>
 The output of this method may not necessarily be a valid URL, it may
 also be a token that is later replaced in the portlet output 
 processing. The only valid use of the this method is to write the
 result to the portlet output stream.
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE>encodeURL</CODE> in interface <CODE>javax.servlet.http.HttpServletResponse</CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - the path to the resource
<DT><B>Returns:</B><DD>the resource URL as string</DL>
</DD>
</DL>
<HR>

<A NAME="encodeNamespace(java.lang.String)"><!-- --></A><H3>
encodeNamespace</H3>
<PRE>
public java.lang.String <B>encodeNamespace</B>(java.lang.String&nbsp;aValue)</PRE>
<DL>