📄 portletwrapper.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"><!--NewPage--><HTML><HEAD><!-- Generated by javadoc (build 1.4.2) on Wed Jul 19 18:22:42 EDT 2006 --><TITLE>PortletWrapper (IBM WebSphere Portal Version 6.0.0.0 API Docs)</TITLE><META NAME="keywords" CONTENT="com.ibm.wps.pb.wrapper.PortletWrapper class"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ parent.document.title="PortletWrapper (IBM WebSphere Portal Version 6.0.0.0 API Docs)";}</SCRIPT></HEAD><BODY BGCOLOR="white" onload="windowTitle();"><!-- ========= START OF TOP NAVBAR ======= --><A NAME="navbar_top"><!-- --></A><A HREF="#skip-navbar_top" title="Skip navigation links"></A><TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""><TR><TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"><A NAME="navbar_top_firstrow"><!-- --></A><TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> <TR ALIGN="center" VALIGN="top"> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> </TR></TABLE></TD><TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM></EM></TD></TR><TR><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> PREV CLASS <A HREF="../../../../../com/ibm/wps/pb/wrapper/PortletWrapperBase.html" title="class in com.ibm.wps.pb.wrapper"><B>NEXT CLASS</B></A></FONT></TD><TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> <A HREF="PortletWrapper.html" target="_top"><B>NO FRAMES</B></A> <SCRIPT type="text/javascript"> <!-- if(window==top) { document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); } //--></SCRIPT><NOSCRIPT> <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A></NOSCRIPT></FONT></TD></TR><TR><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> SUMMARY: <A HREF="#nested_classes_inherited_from_class_org.apache.jetspeed.portlet.Portlet">NESTED</A> | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><A NAME="skip-navbar_top"></A><!-- ========= END OF TOP NAVBAR ========= --><HR><A NAME="main"></A><!-- ======== START OF CLASS DATA ======== --><H2><FONT SIZE="-1">com.ibm.wps.pb.wrapper</FONT><BR>Class PortletWrapper</H2><PRE>java.lang.Object <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by">javax.servlet.GenericServlet <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by">javax.servlet.http.HttpServlet <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../com/ibm/wps/pe/pc/legacy/cache/CacheablePortlet.html" title="class in com.ibm.wps.pe.pc.legacy.cache">com.ibm.wps.pe.pc.legacy.cache.CacheablePortlet</A> <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/jetspeed/portlet/Portlet.html" title="class in org.apache.jetspeed.portlet">org.apache.jetspeed.portlet.Portlet</A> <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../org/apache/jetspeed/portlet/PortletAdapter.html" title="class in org.apache.jetspeed.portlet">org.apache.jetspeed.portlet.PortletAdapter</A> <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><A HREF="../../../../../com/ibm/wps/pb/wrapper/PortletWrapperBase.html" title="class in com.ibm.wps.pb.wrapper">com.ibm.wps.pb.wrapper.PortletWrapperBase</A> <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.ibm.wps.pb.wrapper.PortletWrapper</B></PRE><DL><DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../org/apache/jetspeed/portlet/event/ActionListener.html" title="interface in org.apache.jetspeed.portlet.event">ActionListener</A>, com.ibm.websphere.servlet.cache.CacheableServlet, <A HREF="../../../../../com/ibm/wps/portlet/event/EventPhaseListener.html" title="interface in com.ibm.wps.portlet.event">EventPhaseListener</A>, org.apache.jetspeed.portlet.event.MessageListener, org.apache.jetspeed.portlet.event.PortletApplicationSettingsAttributesListener, org.apache.jetspeed.portlet.PortletPageListener, <A HREF="../../../../../org/apache/jetspeed/portlet/PortletSessionListener.html" title="interface in org.apache.jetspeed.portlet">PortletSessionListener</A>, <A HREF="../../../../../com/ibm/wps/pb/portlet/PropertyListener.html" title="interface in com.ibm.wps.pb.portlet">PropertyListener</A>, java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig, <A HREF="../../../../../org/apache/jetspeed/portlet/event/WindowListener.html" title="interface in org.apache.jetspeed.portlet.event">WindowListener</A></DD></DL><HR><DL><DT>public class <B>PortletWrapper</B><DT>extends <A HREF="../../../../../com/ibm/wps/pb/wrapper/PortletWrapperBase.html" title="class in com.ibm.wps.pb.wrapper">PortletWrapperBase</A></DL><P>The actual wrapper code for the application portlet is contained in the base class <code>PortletWrapperBase</code>. This class only implements the abstract method <code>instantiateApplicationPortlet</code> to instantiate and return the application portlet class. <br> Sometimes, the application programmer may need to extend this class and use the extended class in place of this class. An example of this is when the application portlet implements <code>PortletTitleListener</code>. The wrapper code provided as part of the runtime does not implement this interface, so the extended wrapper must implement the interface in this case. The application portlet must extend this class, implement <code>PortletTitleListener</code> and the <code>doTitle()</code> method in the extension, and use this as the wrapper class in web.xml. <br> An example code snippet is shown below: <br> <code> package com.myco.mywrapper;<br> import org.apache.jetspeed.portlet.*;<br> <br> public class MyPortletWrapper extends com.ibm.wps.pb.wrapper.PortletWrapper <br> implements PortletTitleListener<br> {<br> Portlet appPortlet_ = null;<br> <br> public void doTitle(PortletRequest request, PortletResponse response) <br> throws PortletException, IOException<br> {<br> Portlet appPortlet_ = getApplicationPortlet();<br> try<br> {<br> ((PortletTitleListener)appPortlet_).doTitle(request, response);<br> }<br> catch (ClassCastException e)// should not happen, as this class should <br> // be provided only if the app portlet <br> // implements PortletTitleListener<br> {<br> response.getWriter().print(request.getPortletSettings().getTitle(request.getLocale(), request.getClient()));<br> }<br> } <br> }<br> </code><br> To specify the new wrapper portlet in the web.xml, change the standard wrapper for cooperative portlets: <br> <code><servlet-class>com.ibm.wps.pb.wrapper.PortletWrapper</servlet-class></code> to the new wrapper class: <br> <code><servlet-class>com.myco.mywrapper.MyPortletWrapper</servlet-class></code> <br><P><P><DL><DT><B>Since:</B></DT> <DD>5.1.0.1</DD><DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/wrapper/PortletWrapperBase.html" title="class in com.ibm.wps.pb.wrapper"><CODE>PortletWrapperBase</CODE></A>, <CODE>PortletTitleListener</CODE>, <A HREF="../../../../../serialized-form.html#com.ibm.wps.pb.wrapper.PortletWrapper">Serialized Form</A></DL><HR><P><!-- ======== NESTED CLASS SUMMARY ======== --><A NAME="nested_class_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN=2><FONT SIZE="+2"><B>Nested Class Summary</B></FONT></TH></TR></TABLE> <A NAME="nested_classes_inherited_from_class_org.apache.jetspeed.portlet.Portlet"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"><TH ALIGN="left"><B>Nested classes inherited from class org.apache.jetspeed.portlet.<A HREF="../../../../../org/apache/jetspeed/portlet/Portlet.html" title="class in org.apache.jetspeed.portlet">Portlet</A></B></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><A HREF="../../../../../org/apache/jetspeed/portlet/Portlet.Mode.html" title="class in org.apache.jetspeed.portlet">Portlet.Mode</A>, <A HREF="../../../../../org/apache/jetspeed/portlet/Portlet.ModeModifier.html" title="class in org.apache.jetspeed.portlet">Portlet.ModeModifier</A></CODE></TD></TR></TABLE> <!-- =========== FIELD SUMMARY =========== --><!-- ======== CONSTRUCTOR SUMMARY ======== --><A NAME="constructor_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TH ALIGN="left" COLSPAN=2><FONT SIZE="+2"><B>Constructor Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../../com/ibm/wps/pb/wrapper/PortletWrapper.html#PortletWrapper()">PortletWrapper</A></B>()</CODE><BR> </TD>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -