portletapiutils.html

门户开发

<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
</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 =========== -->

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

<A NAME="s_namescopeForm"><!-- --></A><H3>
s_namescopeForm</H3>
<PRE>
protected static boolean <B>s_namescopeForm</B></PRE>
<DL>
<DD>Indicator of whether or not to namescope the form name.
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="s_namescopeInputName"><!-- --></A><H3>
s_namescopeInputName</H3>
<PRE>
protected static boolean <B>s_namescopeInputName</B></PRE>
<DL>
<DD>Indicator of whether or not to namescope the name attribute of the input element.
<P>
<DL>
</DL>
</DL>
<HR>

<A NAME="STANDARD_URL"><!-- --></A><H3>
STANDARD_URL</H3>
<PRE>
public static final int <B>STANDARD_URL</B></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>Supported Portal URL type - standard
<P>
<DL>
<DT><B>See Also:</B><DD><code>PortletURIAttributes</code>, 
<A HREF="../../../../../constant-values.html#com.ibm.portal.struts.common.PortletApiUtils.STANDARD_URL">Constant Field Values</A></DL>
</DL>
<HR>

<A NAME="RETURN_URL"><!-- --></A><H3>
RETURN_URL</H3>
<PRE>
public static final int <B>RETURN_URL</B></PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>Supported Portal URL type - return
<P>
<DL>
<DT><B>See Also:</B><DD><code>PortletURIAttributes</code>, 
<A HREF="../../../../../constant-values.html#com.ibm.portal.struts.common.PortletApiUtils.RETURN_URL">Constant Field Values</A></DL>
</DL>

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

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

<A NAME="PortletApiUtils()"><!-- --></A><H3>
PortletApiUtils</H3>
<PRE>
public <B>PortletApiUtils</B>()</PRE>
<DL>
<DD>Constructor for PortletApiUtils. Typically not needed, the 
 static methods can be used to obtain the implementation object.
<P>
</DL>

<!-- ============ 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="getUtilsInstance()"><!-- --></A><H3>
getUtilsInstance</H3>
<PRE>
public static <A HREF="../../../../../com/ibm/portal/struts/common/PortletApiUtils.html" title="class in com.ibm.portal.struts.common">PortletApiUtils</A> <B>getUtilsInstance</B>()</PRE>
<DL>
<DD>Gets the singleton instance of the PortletApiUtils implementation.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the implementation object of the PortletApiUtils or <code>null</code> if none has been set</DL>
</DD>
</DL>
<HR>

<A NAME="setUtilsInstance(com.ibm.portal.struts.common.PortletApiUtils)"><!-- --></A><H3>
setUtilsInstance</H3>
<PRE>
public static void <B>setUtilsInstance</B>(<A HREF="../../../../../com/ibm/portal/struts/common/PortletApiUtils.html" title="class in com.ibm.portal.struts.common">PortletApiUtils</A>&nbsp;implementation)</PRE>
<DL>
<DD>Sets the singleton instance of the PortletApiUtils implementation.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>implementation</CODE> - the implementation object of the PortletApiUtils</DL>
</DD>
</DL>
<HR>

<A NAME="getDefaultPortletActionName()"><!-- --></A><H3>
getDefaultPortletActionName</H3>
<PRE>
public java.lang.String <B>getDefaultPortletActionName</B>()</PRE>
<DL>
<DD>Returns the name of the portlet action for a Struts PortletURI.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>name of the portlet action</DL>
</DD>
</DL>
<HR>

<A NAME="setDefaultPortletActionName(java.lang.String)"><!-- --></A><H3>
setDefaultPortletActionName</H3>
<PRE>
public void <B>setDefaultPortletActionName</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Sets the name of the portlet action for a Struts PortletURI.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the portlet action name</DL>
</DD>
</DL>
<HR>

<A NAME="getStrutsActionParameterName()"><!-- --></A><H3>
getStrutsActionParameterName</H3>
<PRE>
public java.lang.String <B>getStrutsActionParameterName</B>()</PRE>
<DL>
<DD>Returns the name of the parameter used to pass the Struts action.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>name the parameter name for the Struts action</DL>
</DD>
</DL>
<HR>

<A NAME="setStrutsActionParameterName(java.lang.String)"><!-- --></A><H3>
setStrutsActionParameterName</H3>
<PRE>
public void <B>setStrutsActionParameterName</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Sets the name used to store the Struts action as a parameter in the Portlet URL.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the parameter name used to store the Struts action</DL>
</DD>
</DL>
<HR>

<A NAME="getParameterName(java.lang.String)"><!-- --></A><H3>
getParameterName</H3>
<PRE>
public java.lang.String <B>getParameterName</B>(java.lang.String&nbsp;key)</PRE>
<DL>
<DD>Returns the parameter name stored under the specified key. This allows
 the parameter names to be independent of the generic key.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - the parameter names key
<DT><B>Returns:</B><DD>the parameter name, <code>null</code> if not set</DL>
</DD>
</DL>
<HR>

<A NAME="setParameterName(java.lang.String, java.lang.String)"><!-- --></A><H3>
setParameterName</H3>
<PRE>
public void <B>setParameterName</B>(java.lang.String&nbsp;key,
                             java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Sets the parameter name for the specified key.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>key</CODE> - the paramter key<DD><CODE>name</CODE> - the parameter name</DL>
</DD>
</DL>
<HR>

<A NAME="getPortletResponse(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
getPortletResponse</H3>
<PRE>
public abstract java.lang.Object <B>getPortletResponse</B>(javax.servlet.http.HttpServletRequest&nbsp;request)</PRE>
<DL>
<DD>Gets the PortletResponse as an object from the given request. This method
 may return null if called during the event phase of portal. The returned object
 should be casted to the appropriate PortletResponse class of the container.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the request object
<DT><B>Returns:</B><DD>Object the portlet response, can return <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="getPortletResponse(javax.servlet.http.HttpServletResponse, javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
getPortletResponse</H3>
<PRE>
public abstract java.lang.Object <B>getPortletResponse</B>(javax.servlet.http.HttpServletResponse&nbsp;response,
                                                    javax.servlet.http.HttpServletRequest&nbsp;request)</PRE>
<DL>
<DD>Gets the PortletResponse as an object from the given request. This method
 may return null if called during the event phase of portal. The returned object 
 should be casted to the appropriate PortletResponse class of the current
 Portal container.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>response</CODE> - the response object<DD><CODE>request</CODE> - the request object
<DT><B>Returns:</B><DD>Object the portlet response object, can return <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="getPortletRequest(javax.servlet.http.HttpServletRequest)"><!-- --></A><H3>
getPortletRequest</H3>
<PRE>
public abstract java.lang.Object <B>getPortletRequest</B>(javax.servlet.http.HttpServletRequest&nbsp;request)</PRE>
<DL>
<DD>Gets the PortletRequest as an object from the given request object. The returnd 
 object should be casted to the appriorate PortletRequest class of the current
 Portal container.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the request object
<DT><B>Returns:</B><DD>Object the portlet request, can return <code>null</code></DL>
</DD>
</DL>
<HR>

<A NAME="createPortletURI(java.lang.Object)"><!-- --></A><H3>
createPortletURI</H3>
<PRE>
public java.lang.Object <B>createPortletURI</B>(java.lang.Object&nbsp;response)</PRE>
<DL>
<DD>Creates a Portlet URI from the given response. This method can only be called
 in the render phase of portal. The Portlet URI should be casted to the
 appropriate PortletURI class of the current Portal container.
 The response object must be a valid PortletResponse object to create the URL.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>response</CODE> - the portlet response
<DT><B>Returns:</B><DD>Object the portlet URL, can be <code>null</code></DL>
</DD>
</DL>
<HR>