?? istrutsportletmessage.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:43 EDT 2006 --><TITLE>IStrutsPortletMessage (IBM WebSphere Portal Version 6.0.0.0 API Docs)</TITLE><META NAME="keywords" CONTENT="com.ibm.wps.portlets.struts.IStrutsPortletMessage interface"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ parent.document.title="IStrutsPortletMessage (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/portlets/struts/IViewCommand.html" title="interface in com.ibm.wps.portlets.struts"><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="IStrutsPortletMessage.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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | CONSTR | <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.portlets.struts</FONT><BR>Interface IStrutsPortletMessage</H2><DL><DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../com/ibm/wps/portlets/struts/WpsStrutsPortletMessage.html" title="class in com.ibm.wps.portlets.struts">WpsStrutsPortletMessage</A></DD></DL><HR><DL><DT>public interface <B>IStrutsPortletMessage</B></DL><P>The <code>IStrutsPortletMessage</code> class defines the interface for the PortletMessage that can be sent to the WpsStrutsPortlet. The attribute that is sent in the portlet message can be retrieved in the Struts action as a request attribute with the name WpsStrutsConstants.SPF_MESSAGE_ATTRIBUTE. The application should use the property broker instead of portlet messaging.<P><P><DL><DT><B>Since:</B></DT> <DD>4.2</DD></DL><HR><P><!-- ======== NESTED CLASS SUMMARY ======== --><!-- =========== FIELD SUMMARY =========== --><!-- ======== CONSTRUCTOR SUMMARY ======== --><!-- ========== METHOD SUMMARY =========== --><A NAME="method_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>Method Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.Object</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html#getAttribute()">getAttribute</A></B>()</CODE><BR> Returns the object set in the portlet message.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html#getConcretePortletName()">getConcretePortletName</A></B>()</CODE><BR> Returns the name of the concrete portlet.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html#getStrutsAction()">getStrutsAction</A></B>()</CODE><BR> Returns the Struts action.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html#getStrutsForward()">getStrutsForward</A></B>()</CODE><BR> Returns the Struts forward.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html#setAttribute(java.lang.Object)">setAttribute</A></B>(java.lang.Object attribute)</CODE><BR> The attribute that is passed to the message listener on the WpsStrutsPortlet.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html#setConcretePortletName(java.lang.String)">setConcretePortletName</A></B>(java.lang.String name)</CODE><BR> Sets the concrete portlet name for an additional level of filtering.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html#setStrutsAction(java.lang.String)">setStrutsAction</A></B>(java.lang.String action)</CODE><BR> Sets the name of the Struts action that will be executed.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/wps/portlets/struts/IStrutsPortletMessage.html#setStrutsForward(java.lang.String)">setStrutsForward</A></B>(java.lang.String forward)</CODE><BR> Sets the name of a Struts forward that will be executed.</TD></TR></TABLE> <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="setAttribute(java.lang.Object)"><!-- --></A><H3>setAttribute</H3><PRE>public void <B>setAttribute</B>(java.lang.Object attribute)</PRE><DL><DD>The attribute that is passed to the message listener on the WpsStrutsPortlet. The attribute can then be obtained in a Struts action by getting the WpsStrutsConstants.SPF_MESSAGE_ATTRIBUTE from the request object.<P><DD><DL><DT><B>Parameters:</B><DD><CODE>attribute</CODE> - the attribute to set</DL></DD></DL><HR><A NAME="getAttribute()"><!-- --></A><H3>getAttribute</H3><PRE>public java.lang.Object <B>getAttribute</B>()</PRE><DL><DD>Returns the object set in the portlet message.<P><DD><DL><DT><B>Returns:</B><DD>returns the stored attribute, can be <code>null</code> if not set</DL></DD></DL><HR><A NAME="setConcretePortletName(java.lang.String)"><!-- --></A><H3>setConcretePortletName</H3><PRE>public void <B>setConcretePortletName</B>(java.lang.String name)</PRE><DL><DD>Sets the concrete portlet name for an additional level of filtering. The PortletContext send is based on the name of the abstract portlet. If the concrete portlet name is specified then only that portlet will see the message.<P><DD><DL><DT><B>Parameters:</B><DD><CODE>name</CODE> - the name of the concrete portlet</DL></DD></DL><HR><A NAME="getConcretePortletName()"><!-- --></A><H3>getConcretePortletName</H3><PRE>public java.lang.String <B>getConcretePortletName</B>()</PRE><DL><DD>Returns the name of the concrete portlet.<P><DD><DL><DT><B>Returns:</B><DD>returns the concrete portlet name, can be <code>null</code> if not set</DL></DD></DL><HR><A NAME="setStrutsAction(java.lang.String)"><!-- --></A><H3>setStrutsAction</H3><PRE>public void <B>setStrutsAction</B>(java.lang.String action)</PRE><DL><DD>Sets the name of the Struts action that will be executed. The action is assumed to be contextRelative.<P><DD><DL><DT><B>Parameters:</B><DD><CODE>action</CODE> - the Struts action</DL></DD></DL><HR><A NAME="getStrutsAction()"><!-- --></A><H3>getStrutsAction</H3><PRE>public java.lang.String <B>getStrutsAction</B>()</PRE><DL><DD>Returns the Struts action.<P><DD><DL><DT><B>Returns:</B><DD>returns the Struts action, can be <code>null</code> if not set</DL></DD></DL><HR><A NAME="setStrutsForward(java.lang.String)"><!-- --></A><H3>setStrutsForward</H3><PRE>public void <B>setStrutsForward</B>(java.lang.String forward)</PRE><DL><DD>Sets the name of a Struts forward that will be executed. The forward is assumed to be contextRelative. If the Struts forward and the Struts action are both set then only the action is executed.<P><DD><DL><DT><B>Parameters:</B><DD><CODE>forward</CODE> - the Struts forward</DL></DD></DL><HR><A NAME="getStrutsForward()"><!-- --></A><H3>getStrutsForward</H3><PRE>public java.lang.String <B>getStrutsForward</B>()</PRE><DL><DD>Returns the Struts forward.<P><DD><DL><DT><B>Returns:</B><DD>returns the Struts forward, can be <code>null</null> if not set</DL></DD></DL><!-- ========= END OF CLASS DATA ========= --><HR><!-- ======= START OF BOTTOM NAVBAR ====== --><A NAME="navbar_bottom"><!-- --></A><A HREF="#skip-navbar_bottom" 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_bottom_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/portlets/struts/IViewCommand.html" title="interface in com.ibm.wps.portlets.struts"><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="IStrutsPortletMessage.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: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD></TR></TABLE><A NAME="skip-navbar_bottom"></A><!-- ======== END OF BOTTOM NAVBAR ======= --><HR></BODY></HTML>
?? 快捷鍵說明
復制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號
Ctrl + =
減小字號
Ctrl + -