portletapiutils.html

门户开发

encodeURL</H3>
<PRE>
public abstract java.lang.String <B>encodeURL</B>(java.lang.String&nbsp;path,
                                           javax.servlet.http.HttpServletRequest&nbsp;request)</PRE>
<DL>
<DD>Returns the fully qualified URL from the path.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - the path<DD><CODE>request</CODE> - the request object.
<DT><B>Returns:</B><DD>String the encoded URL</DL>
</DD>
</DL>
<HR>

<A NAME="encodeURL(java.lang.String, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3>
encodeURL</H3>
<PRE>
public abstract java.lang.String <B>encodeURL</B>(java.lang.String&nbsp;path,
                                           javax.servlet.http.HttpServletResponse&nbsp;response)</PRE>
<DL>
<DD>Returns the fully qualified URL from the path.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - the path<DD><CODE>response</CODE> - the response object.
<DT><B>Returns:</B><DD>String the encoded URL</DL>
</DD>
</DL>
<HR>

<A NAME="encodeNamespace(java.lang.String, javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
encodeNamespace</H3>
<PRE>
public abstract java.lang.String <B>encodeNamespace</B>(java.lang.String&nbsp;name,
                                                 javax.servlet.http.HttpServletRequest&nbsp;request)</PRE>
<DL>
<DD>Returns the namescoped name. This method can return a blank string if 
 namescope cannot be determined, typically because the method is called in
 the render phase of portal.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name to namescope<DD><CODE>request</CODE> - the request object.
<DT><B>Returns:</B><DD>String the namescoped name, can be a blank string</DL>
</DD>
</DL>
<HR>

<A NAME="addModulePrefix(java.lang.String, javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
addModulePrefix</H3>
<PRE>
public abstract java.lang.String <B>addModulePrefix</B>(java.lang.String&nbsp;path,
                                                 javax.servlet.http.HttpServletRequest&nbsp;request)</PRE>
<DL>
<DD>Adds the module prefix to the path. The module config will be determined
 from the request object and the module prefix will be prepended to the
 path.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - the path<DD><CODE>request</CODE> - the request object.
<DT><B>Returns:</B><DD>String the module prefixed path</DL>
</DD>
</DL>
<HR>

<A NAME="getEncodedBeanName(java.lang.String, javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
getEncodedBeanName</H3>
<PRE>
public abstract java.lang.String <B>getEncodedBeanName</B>(java.lang.String&nbsp;beanName,
                                                    javax.servlet.http.HttpServletRequest&nbsp;request)</PRE>
<DL>
<DD>Returns the encoded bean name with the first character upper-cased 
 if isFormNamescoped returns true.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>beanName</CODE> - the bean name<DD><CODE>request</CODE> - the request object.
<DT><B>Returns:</B><DD>String encoded bean name</DL>
</DD>
</DL>
<HR>

<A NAME="setNamescopeForm(boolean)"><!-- --></A><H3>
setNamescopeForm</H3>
<PRE>
public static void <B>setNamescopeForm</B>(boolean&nbsp;value)</PRE>
<DL>
<DD>Turns namescoping of forms on or off, default is on.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>value</CODE> - false to turn off namescoping</DL>
</DD>
</DL>
<HR>

<A NAME="isFormNamescoped()"><!-- --></A><H3>
isFormNamescoped</H3>
<PRE>
public static boolean <B>isFormNamescoped</B>()</PRE>
<DL>
<DD>Returns whether or not namescoping of forms is enabled.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>boolean false if namescoping is turned off</DL>
</DD>
</DL>
<HR>

<A NAME="createCommand(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String)"><!-- --></A><H3>
createCommand</H3>
<PRE>
public abstract void <B>createCommand</B>(java.lang.String&nbsp;path,
                                   javax.servlet.http.HttpServletRequest&nbsp;request,
                                   javax.servlet.http.HttpServletResponse&nbsp;response,
                                   java.lang.String&nbsp;commandPrefix)
                            throws javax.servlet.ServletException</PRE>
<DL>
<DD>Creates the IViewCommand object for the path for the specified mode 
 prefix. The command prefix is used to store the command and commands are saved
 by the portlet mode.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - the URI for the command<DD><CODE>request</CODE> - the request object.<DD><CODE>response</CODE> - the response object.<DD><CODE>commandPrefix</CODE> - the prefix that the command is stored under
<DT><B>Throws:</B>
<DD><CODE>javax.servlet.ServletException</CODE> - if create fails</DL>
</DD>
</DL>
<HR>

<A NAME="createCommand(java.lang.String, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><!-- --></A><H3>
createCommand</H3>
<PRE>
public abstract void <B>createCommand</B>(java.lang.String&nbsp;path,
                                   javax.servlet.http.HttpServletRequest&nbsp;request,
                                   javax.servlet.http.HttpServletResponse&nbsp;response)
                            throws javax.servlet.ServletException</PRE>
<DL>
<DD>Creates the IViewCommand object for the path for the specified mode 
 prefix. The command prefix is used to store the command and commands are saved
 by the portlet mode.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - the URI for the command<DD><CODE>request</CODE> - the request object.<DD><CODE>response</CODE> - the response object.
<DT><B>Throws:</B>
<DD><CODE>javax.servlet.ServletException</CODE> - if create fails</DL>
</DD>
</DL>
<HR>

<A NAME="createCommand(java.lang.String, javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
createCommand</H3>
<PRE>
public abstract void <B>createCommand</B>(java.lang.String&nbsp;path,
                                   javax.servlet.http.HttpServletRequest&nbsp;request)
                            throws javax.servlet.ServletException</PRE>
<DL>
<DD>Creates the IViewCommand object for the path for the specified mode 
 prefix. The command prefix is used to store the command and commands are saved
 by the portlet mode. The commands prefix will be determined from the request object.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - the URI for the command<DD><CODE>request</CODE> - the request object.
<DT><B>Throws:</B>
<DD><CODE>javax.servlet.ServletException</CODE> - if create fails</DL>
</DD>
</DL>
<HR>

<A NAME="createCommand(java.lang.String, javax.servlet.http.HttpServletRequest, java.lang.String)"><!-- --></A><H3>
createCommand</H3>
<PRE>
public abstract void <B>createCommand</B>(java.lang.String&nbsp;path,
                                   javax.servlet.http.HttpServletRequest&nbsp;request,
                                   java.lang.String&nbsp;commandPrefix)
                            throws javax.servlet.ServletException</PRE>
<DL>
<DD>Creates the IViewCommand object for the path for the specified mode 
 prefix. The command prefix is used to store the command and commands are saved
 by the portlet mode.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - the URI for the command<DD><CODE>request</CODE> - the request object.<DD><CODE>commandPrefix</CODE> - the prefix that the command is stored under
<DT><B>Throws:</B>
<DD><CODE>javax.servlet.ServletException</CODE> - if create fails</DL>
</DD>
</DL>
<HR>

<A NAME="includeTile(java.lang.String, javax.servlet.jsp.PageContext)"><!-- --></A><H3>
includeTile</H3>
<PRE>
public abstract void <B>includeTile</B>(java.lang.String&nbsp;path,
                                 javax.servlet.jsp.PageContext&nbsp;pageContext)
                          throws javax.servlet.ServletException</PRE>
<DL>
<DD>Includes the path as a tile. The path can be an action
 or a includable path, and the markup will be written to the pageContext
 print writer.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - the URI for the command<DD><CODE>pageContext</CODE> - the page context
<DT><B>Throws:</B>
<DD><CODE>javax.servlet.ServletException</CODE> - if include fails</DL>
</DD>
</DL>
<HR>

<A NAME="encodeAction(java.lang.String, javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
encodeAction</H3>
<PRE>
public abstract java.lang.String <B>encodeAction</B>(java.lang.String&nbsp;actionURL,
                                              javax.servlet.http.HttpServletRequest&nbsp;request)</PRE>
<DL>
<DD>Encodes the Struts action URL so that it can be added as a paramter
 to the portlet URL.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>actionURL</CODE> - the Struts action URL<DD><CODE>request</CODE> - the servlet request object
<DT><B>Returns:</B><DD>the encoded Struts action</DL>
</DD>
</DL>
<HR>

<A NAME="getActionMappingURL(java.lang.String, javax.servlet.jsp.PageContext)"><!-- --></A><H3>
getActionMappingURL</H3>
<PRE>
public abstract java.lang.String <B>getActionMappingURL</B>(java.lang.String&nbsp;action,
                                                     javax.servlet.jsp.PageContext&nbsp;pageContext)</PRE>
<DL>
<DD>Return the form action converted into a server-relative URL.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>action</CODE> - the Struts action<DD><CODE>pageContext</CODE> - the page context
<DT><B>Returns:</B><DD>the server-relative URL</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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<A HREF="#main"><FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../../com/ibm/portal/struts/common/ModuleContext.html" title="class in com.ibm.portal.struts.common"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../../com/ibm/portal/struts/common/PortletURIAttributes.html" title="class in com.ibm.portal.struts.common"><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>  &nbsp;
&nbsp;<A HREF="PortletApiUtils.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<SCRIPT type="text/javascript">
  <!--
  if(window==top) {
    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
  }
  //-->
</SCRIPT>
<NOSCRIPT>
  <