📄 strutsviewcommand.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>StrutsViewCommand (IBM WebSphere Portal Version 6.0.0.0 API Docs)</TITLE><META NAME="keywords" CONTENT="com.ibm.portal.struts.command.StrutsViewCommand class"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ parent.document.title="StrutsViewCommand (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"> <A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewActionCommand.html" title="class in com.ibm.portal.struts.command"><B>PREV CLASS</B></A> <A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewErrorCommand.html" title="class in com.ibm.portal.struts.command"><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="StrutsViewCommand.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 | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD><TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">DETAIL: <A HREF="#field_detail">FIELD</A> | <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.portal.struts.command</FONT><BR>Class StrutsViewCommand</H2><PRE>java.lang.Object <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>com.ibm.portal.struts.command.StrutsViewCommand</B></PRE><DL><DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../com/ibm/portal/struts/command/IViewCommand.html" title="interface in com.ibm.portal.struts.command">IViewCommand</A>, java.io.Serializable</DD></DL><DL><DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../com/ibm/portal/struts/command/StrutsFilteredViewCommand.html" title="class in com.ibm.portal.struts.command">StrutsFilteredViewCommand</A>, <A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewActionCommand.html" title="class in com.ibm.portal.struts.command">StrutsViewActionCommand</A>, <A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewErrorCommand.html" title="class in com.ibm.portal.struts.command">StrutsViewErrorCommand</A>, <A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewJspCommand.html" title="class in com.ibm.portal.struts.command">StrutsViewJspCommand</A>, <A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewXmlCommand.html" title="class in com.ibm.portal.struts.command">StrutsViewXmlCommand</A></DD></DL><HR><DL><DT>public abstract class <B>StrutsViewCommand</B><DT>extends java.lang.Object<DT>implements <A HREF="../../../../../com/ibm/portal/struts/command/IViewCommand.html" title="interface in com.ibm.portal.struts.command">IViewCommand</A>, java.io.Serializable</DL><P>Command pattern class used to provide a mechanism to encapsulate the information needed to redisplay a view. The StrutsViewCommand is the base class for all commands in the Struts Portlet Framework. The base class provides the methods to save all the attributes that need to be saved with the command, and provides the methods to repopulate the request attributes.<P><P><DL><DT><B>Since:</B></DT> <DD>5.1</DD><DT><B>See Also:</B><DD><A HREF="../../../../../serialized-form.html#com.ibm.portal.struts.command.StrutsViewCommand">Serialized Form</A></DL><HR><P><!-- ======== NESTED CLASS SUMMARY ======== --><!-- =========== FIELD SUMMARY =========== --><A NAME="field_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>Field Summary</B></FONT></TH></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected static java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#CONTENT_TYPE">CONTENT_TYPE</A></B></CODE><BR> Request attribute name for the content type.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected static org.apache.struts.util.MessageResources</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#messages">messages</A></B></CODE><BR> The message resources for the Struts Portlet Framework.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected static java.lang.String</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#PREFIX">PREFIX</A></B></CODE><BR> Request attribute name for the prefix.</TD></TR></TABLE> <!-- ======== 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/portal/struts/command/StrutsViewCommand.html#StrutsViewCommand()">StrutsViewCommand</A></B>()</CODE><BR> Default constructor.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD><CODE><B><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#StrutsViewCommand(javax.portlet.PortletRequest)">StrutsViewCommand</A></B>(javax.portlet.PortletRequest request)</CODE><BR> Constructs the StrutsViewCommand object.</TD></TR></TABLE> <!-- ========== 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>protected static void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#addAttribute(java.lang.Object, java.util.List)">addAttribute</A></B>(java.lang.Object attribute, java.util.List list)</CODE><BR> Adds the attribute to the list.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#addAttributeNameToSave(java.lang.String)">addAttributeNameToSave</A></B>(java.lang.String attributeName)</CODE><BR> Adds the name of an attribute from the object request that needs to be saved if present for the execution of the IViewCommand in Portal's render phase.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#addAttributeTypeToSave(java.lang.Class)">addAttributeTypeToSave</A></B>(java.lang.Class attributeType)</CODE><BR> Adds the class type of an attribute from the object request that needs to be saved if present for the execution of the IViewCommand in Portal's render phase.</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/portal/struts/command/StrutsViewCommand.html#execute(javax.portlet.RenderRequest, javax.portlet.RenderResponse, com.ibm.portal.struts.command.ViewCommandExecutionContext)">execute</A></B>(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response, <A HREF="../../../../../com/ibm/portal/struts/command/ViewCommandExecutionContext.html" title="class in com.ibm.portal.struts.command">ViewCommandExecutionContext</A> executionContext)</CODE><BR> Executes the given command given the request and response objects.</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/portal/struts/command/StrutsViewCommand.html#getContentType(javax.portlet.PortletRequest)">getContentType</A></B>(javax.portlet.PortletRequest request)</CODE><BR> Returns the content type associated with this command.</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/portal/struts/command/StrutsViewCommand.html#getPrefix(javax.portlet.PortletRequest)">getPrefix</A></B>(javax.portlet.PortletRequest request)</CODE><BR> Returns the prefix associated with this command.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> boolean</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#getRemoveOnModeChange()">getRemoveOnModeChange</A></B>()</CODE><BR> Returns the state of removeOnModeChange.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> java.util.Map</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#getSavedAttributes()">getSavedAttributes</A></B>()</CODE><BR> Returns the saved attributes map.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static <A HREF="../../../../../com/ibm/portal/struts/command/IViewCommand.html" title="interface in com.ibm.portal.struts.command">IViewCommand</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#getSavedCommand(javax.portlet.PortletRequest, javax.portlet.PortletResponse, com.ibm.portal.struts.command.ViewCommandExecutionContext)">getSavedCommand</A></B>(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, <A HREF="../../../../../com/ibm/portal/struts/command/ViewCommandExecutionContext.html" title="class in com.ibm.portal.struts.command">ViewCommandExecutionContext</A> context)</CODE><BR> Gets the saved command from the Command Manager Factory.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected static void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#removeAttribute(java.lang.Object, java.util.List)">removeAttribute</A></B>(java.lang.Object attribute, java.util.List list)</CODE><BR> Removes the attribute from the list.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#removeAttributeNameToSave(java.lang.String)">removeAttributeNameToSave</A></B>(java.lang.String attributeName)</CODE><BR> Removes the name of an attribute from the list of attribute names to save.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>static void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#removeAttributeTypeToSave(java.lang.Class)">removeAttributeTypeToSave</A></B>(java.lang.Class attributeType)</CODE><BR> Removes the class type of the request attribute from the list of attributes to save.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#repopulateRequest(javax.portlet.RenderRequest)">repopulateRequest</A></B>(javax.portlet.RenderRequest request)</CODE><BR> Repopulates the given request from saved values.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#saveAsAttribute(java.lang.String, java.lang.Object)">saveAsAttribute</A></B>(java.lang.String name, java.lang.Object value)</CODE><BR> Saves the given named object for later restoral as an attribute for when the command is executed.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#saveAttribute(javax.portlet.PortletRequest, java.lang.String)">saveAttribute</A></B>(javax.portlet.PortletRequest request, java.lang.String name)</CODE><BR> Saves the given request attribute for later restoral when the command is 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/portal/struts/command/StrutsViewCommand.html#saveAttributes(javax.portlet.PortletRequest, com.ibm.portal.struts.command.ViewCommandExecutionContext)">saveAttributes</A></B>(javax.portlet.PortletRequest request, <A HREF="../../../../../com/ibm/portal/struts/command/ViewCommandExecutionContext.html" title="class in com.ibm.portal.struts.command">ViewCommandExecutionContext</A> context)</CODE><BR> Saves attributes from the request by name for later restoral when the command is executed.</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE>protected void</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../com/ibm/portal/struts/command/StrutsViewCommand.html#saveAttributes(javax.portlet.PortletRequest, com.ibm.portal.struts.command.ViewCommandExecutionContext, java.util.List, java.util.List)">saveAttributes</A></B>(javax.portlet.PortletRequest request, <A HREF="../../../../../com/ibm/portal/struts/command/ViewCommandExecutionContext.html" title="class in com.ibm.portal.struts.command">ViewCommandExecutionContext</A> context, java.util.List namesToSave, java.util.List typesToSave)</CODE>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -