genericportlet.html.svn-base

portal越来越流行了

 defined in the deployment descriptor.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>protected &nbsp;java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../javax/portlet/GenericPortlet.html#getTitle(javax.portlet.RenderRequest)">getTitle</A></B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A>&nbsp;request)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Used by the render method to get the title.</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/portlet/GenericPortlet.html#init()">init</A></B>()</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A convenience method which can be overridden so that there's no need
 to call <code>super.init(config)</code>.</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/portlet/GenericPortlet.html#init(javax.portlet.PortletConfig)">init</A></B>(<A HREF="../../javax/portlet/PortletConfig.html">PortletConfig</A>&nbsp;config)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called by the portlet container to indicate to a portlet that the 
 portlet is being placed into service.</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/portlet/GenericPortlet.html#processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)">processAction</A></B>(<A HREF="../../javax/portlet/ActionRequest.html">ActionRequest</A>&nbsp;request,
              <A HREF="../../javax/portlet/ActionResponse.html">ActionResponse</A>&nbsp;response)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Called by the portlet container to allow the portlet to process
 an action request.</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/portlet/GenericPortlet.html#render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)">render</A></B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A>&nbsp;request,
       <A HREF="../../javax/portlet/RenderResponse.html">RenderResponse</A>&nbsp;response)</CODE>

<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The default implementation of this method sets the title 
 using the <code>getTitle</code> method and invokes the
 <code>doDispatch</code> method.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
<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 =========== -->


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

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

<A NAME="GenericPortlet()"><!-- --></A><H3>
GenericPortlet</H3>
<PRE>
public <B>GenericPortlet</B>()</PRE>
<DL>
<DD>Does nothing.</DL>

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

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

<A NAME="init(javax.portlet.PortletConfig)"><!-- --></A><H3>
init</H3>
<PRE>
public void <B>init</B>(<A HREF="../../javax/portlet/PortletConfig.html">PortletConfig</A>&nbsp;config)
          throws <A HREF="../../javax/portlet/PortletException.html">PortletException</A></PRE>
<DL>
<DD>Called by the portlet container to indicate to a portlet that the 
 portlet is being placed into service.
 <p>
 The default implementation just stores the <code>PortletConfig</code>
 object.
 <p>The portlet container calls the <code>init</code>
 method exactly once after instantiating the portlet.
 The <code>init</code> method must complete successfully
 before the portlet can receive any requests.

 <p>The portlet container cannot place the portlet into service
 if the <code>init</code> method does one of the following:
 <ol>
 <li>it throws a <code>PortletException</code>
 <li>it does not return within a time period defined by the Web server
 </ol><DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../javax/portlet/Portlet.html#init(javax.portlet.PortletConfig)">init</A></CODE> in interface <CODE><A HREF="../../javax/portlet/Portlet.html">Portlet</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>config</CODE> - a <code>PortletConfig</code> object 
					containing the portlet
 					configuration and initialization parameters<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/portlet/PortletException.html">PortletException</A></CODE> - if an exception has occurred that
					interferes with the portlet normal
					operation.<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html">UnavailableException</A></CODE> - if the portlet cannot perform the initialization at this time.</DL>
</DD>
</DL>
<HR>

<A NAME="init()"><!-- --></A><H3>
init</H3>
<PRE>
public void <B>init</B>()
          throws <A HREF="../../javax/portlet/PortletException.html">PortletException</A></PRE>
<DL>
<DD>A convenience method which can be overridden so that there's no need
 to call <code>super.init(config)</code>.

 <p>Instead of overriding <A HREF="../../javax/portlet/GenericPortlet.html#init(javax.portlet.PortletConfig)"><CODE>init(PortletConfig)</CODE></A>, simply override
 this method and it will be called by
 <code>GenericPortlet.init(PortletConfig config)</code>.
 The <code>PortletConfig</code> object can still be retrieved via <A HREF="../../javax/portlet/GenericPortlet.html#getPortletConfig()"><CODE>getPortletConfig()</CODE></A>.<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/portlet/PortletException.html">PortletException</A></CODE> - if an exception has occurred that
					interferes with the portlet normal
					operation.<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html">UnavailableException</A></CODE> - if the portlet is unavailable to perform init</DL>
</DD>
</DL>
<HR>

<A NAME="processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)"><!-- --></A><H3>
processAction</H3>
<PRE>
public void <B>processAction</B>(<A HREF="../../javax/portlet/ActionRequest.html">ActionRequest</A>&nbsp;request,
                          <A HREF="../../javax/portlet/ActionResponse.html">ActionResponse</A>&nbsp;response)
                   throws <A HREF="../../javax/portlet/PortletException.html">PortletException</A>,
                          java.io.IOException</PRE>
<DL>
<DD>Called by the portlet container to allow the portlet to process
 an action request. This method is called if the client request was
 originated by a URL created (by the portlet) with the 
 <code>RenderResponse.createActionURL()</code> method.
 <p>
 The default implementation throws an exception.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../javax/portlet/Portlet.html#processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)">processAction</A></CODE> in interface <CODE><A HREF="../../javax/portlet/Portlet.html">Portlet</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the action request<DD><CODE>response</CODE> - the action response<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/portlet/PortletException.html">PortletException</A></CODE> - if the portlet cannot fulfilling the request<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html">UnavailableException</A></CODE> - if the portlet is unavailable to process the action at this time<DD><CODE><A HREF="../../javax/portlet/PortletSecurityException.html">PortletSecurityException</A></CODE> - if the portlet cannot fullfill this request because of security reasons<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
</DD>
</DL>
<HR>

<A NAME="render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
render</H3>
<PRE>
public void <B>render</B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A>&nbsp;request,
                   <A HREF="../../javax/portlet/RenderResponse.html">RenderResponse</A>&nbsp;response)
            throws <A HREF="../../javax/portlet/PortletException.html">PortletException</A>,
                   java.io.IOException</PRE>
<DL>
<DD>The default implementation of this method sets the title 
 using the <code>getTitle</code> method and invokes the
 <code>doDispatch</code> method.<DD><DL>
<DT><B>Specified by: </B><DD><CODE><A HREF="../../javax/portlet/Portlet.html#render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)">render</A></CODE> in interface <CODE><A HREF="../../javax/portlet/Portlet.html">Portlet</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the render request<DD><CODE>response</CODE> - the render response<DT><B>Throws:</B><DD><CODE><A HREF="../../javax/portlet/PortletException.html">PortletException</A></CODE> - if the portlet cannot fulfilling the request<DD><CODE><A HREF="../../javax/portlet/UnavailableException.html">UnavailableException</A></CODE> - if the portlet is unavailable to perform render at this time<DD><CODE><A HREF="../../javax/portlet/PortletSecurityException.html">PortletSecurityException</A></CODE> - if the portlet cannot fullfill this request because of security reasons<DD><CODE>java.io.IOException</CODE> - if the streaming causes an I/O problem</DL>
</DD>
</DL>
<HR>

<A NAME="getTitle(javax.portlet.RenderRequest)"><!-- --></A><H3>
getTitle</H3>
<PRE>
protected java.lang.String <B>getTitle</B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A>&nbsp;request)</PRE>
<DL>
<DD>Used by the render method to get the title.
 <p>
 The default implementation gets the title from the ResourceBundle
 of the PortletConfig of the portlet. The title is retrieved
 using the 'javax.portlet.title' resource name.
 <p>
 Portlets can overwrite this method to provide dynamic
 titles (e.g. based on locale, client, and session information).
 Examples are:
 <UL>
 <LI>language-dependant titles for multi-lingual portals
 <LI>shorter titles for WAP phones
 <LI>the number of messages in a mailbox portlet
 </UL><DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the portlet title for this window</DL>
</DD>
</DL>
<HR>

<A NAME="doDispatch(javax.portlet.RenderRequest, javax.portlet.RenderResponse)"><!-- --></A><H3>
doDispatch</H3>
<PRE>
protected void <B>doDispatch</B>(<A HREF="../../javax/portlet/RenderRequest.html">RenderRequest</A>&nbsp;request,
                          <A HREF="../../javax/portlet/RenderResponse.html">RenderResponse</A>&nbsp;response)
                   throws <A HREF="../../javax/portlet/PortletException.html">PortletException</A>,
                          java.io.IOException</PRE>
<DL>
<DD>The default implementation of this method routes the render request
 to a set of helper methods depending on the current portlet mode the
 portlet is currently in.
 These methods are:
 <ul>
 <li><code>doView</code> for handling <code>view</code> requests