action.html

门户开发

<DT><B>Returns:</B><DD>an <code>Object</code> representing the id of the portlet which registered this action.
 May be used in comparisons.</DL>
</DD>
</DL>
<HR>

<A NAME="isImplementedBy(org.apache.jetspeed.portlet.PortletSettings)"><!-- --></A><H3>
isImplementedBy</H3>
<PRE>
public boolean <B>isImplementedBy</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletSettings.html" title="interface in org.apache.jetspeed.portlet">PortletSettings</A>&nbsp;caller)</PRE>
<DL>
<DD>Returns true if the action was registered by the calling portlet.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>caller</CODE> - the <code>PortletSettings</code> object identifying the calling portlet
<DT><B>Returns:</B><DD>true iff this action was registered by by the portlet 
 identified by the <code>PortletSettings</code> object passed in.</DL>
</DD>
</DL>
<HR>

<A NAME="isActiveOnStartup()"><!-- --></A><H3>
isActiveOnStartup</H3>
<PRE>
public boolean <B>isActiveOnStartup</B>()</PRE>
<DL>
<DD>Returns true if this action is active on portlet startup.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>true iff this action is active on portlet startup.
 If false, the portlet must make a call to <code>activateActions</code>
 in the <code>PropertyBrokerService</code> interface.<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerService.html" title="interface in com.ibm.wps.pb.service"><CODE>PropertyBrokerService</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getActiveOnStartup()"><!-- --></A><H3>
getActiveOnStartup</H3>
<PRE>
public boolean <B>getActiveOnStartup</B>()</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>This method is deprecated. Use <code>isActiveOnStartup</code> instead.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><CODE>isActiveOnStartup()</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="setName(java.lang.String)"><!-- --></A><H3>
setName</H3>
<PRE>
public void <B>setName</B>(java.lang.String&nbsp;name)</PRE>
<DL>
<DD>Sets the name of the action.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Action.html#getName()"><CODE>getName()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setConstantParameters(java.util.Map)"><!-- --></A><H3>
setConstantParameters</H3>
<PRE>
public void <B>setConstantParameters</B>(java.util.Map&nbsp;params)</PRE>
<DL>
<DD>Sets constant parameters associated with the Action, by way of name, value entries
 in a <code>Map</code>. The values are restricted to <code>String</code>. If this method is called multiple times,
 the values in the <code>Map</code> passed to the last call override previous values.
 If null or an empty <code>Map</code> is passed, any
 constant parameters set earlier are cleared.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>params</CODE> - a <code>Map</code> of constant <code>String</code> values.
<DT><B>Throws:</B>
<DD><CODE>java.lang.ClassCastException</CODE> - if the name or value is not <code>String</code>.
<DD><CODE>java.lang.IllegalArgumentException</CODE> - if the parameters do not satisfy 
 required constraints.<DT><B>Since:</B></DT>
  <DD>5.1</DD>
<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Action.html#getConstantParameters()"><CODE>getConstantParameters()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setParameters(com.ibm.wps.pb.property.Parameter[])"><!-- --></A><H3>
setParameters</H3>
<PRE>
public void <B>setParameters</B>(<A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html" title="interface in com.ibm.wps.pb.property">Parameter</A>[]&nbsp;params)
                   throws <A HREF="../../../../../com/ibm/wps/pb/service/InvalidPropertyException.html" title="class in com.ibm.wps.pb.service">InvalidPropertyException</A></PRE>
<DL>
<DD>Sets the action parameters.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>params</CODE> - an array of <code>Parameter</code> objects.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/wps/pb/service/InvalidPropertyException.html" title="class in com.ibm.wps.pb.service">InvalidPropertyException</A></CODE> - is thrown if the parameters do not satisfy 
 required constraints.<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html" title="interface in com.ibm.wps.pb.property"><CODE>Parameter</CODE></A>, 
<A HREF="../../../../../com/ibm/wps/pb/service/InvalidPropertyException.html" title="class in com.ibm.wps.pb.service"><CODE>InvalidPropertyException</CODE></A>, 
<A HREF="../../../../../com/ibm/wps/pb/property/Action.html#getParameters()"><CODE>getParameters()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setTitle(java.lang.String)"><!-- --></A><H3>
setTitle</H3>
<PRE>
public void <B>setTitle</B>(java.lang.String&nbsp;titleKey)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>This method is deprecated. Use <code>setTitleKey</code> instead.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>titleKey</CODE> - the key for the title<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Action.html#setTitleKey(java.lang.String)"><CODE>setTitleKey(String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setTitleKey(java.lang.String)"><!-- --></A><H3>
setTitleKey</H3>
<PRE>
public void <B>setTitleKey</B>(java.lang.String&nbsp;titleKey)</PRE>
<DL>
<DD>Sets the key for the title. The key is used in conjunction with the localization
 info set in the <code>setLocalizationInfo</code> method to retrieve the translated title for 
 supported locales.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>titleKey</CODE> - the key for the title</DL>
</DD>
</DL>
<HR>

<A NAME="setDescription(java.lang.String)"><!-- --></A><H3>
setDescription</H3>
<PRE>
public void <B>setDescription</B>(java.lang.String&nbsp;descriptionKey)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>This method is deprecated. Use <code>setDescriptionKey</code> instead.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>descriptionKey</CODE> - the key for the description<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Action.html#setDescriptionKey(java.lang.String)"><CODE>setDescriptionKey(String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setDescriptionKey(java.lang.String)"><!-- --></A><H3>
setDescriptionKey</H3>
<PRE>
public void <B>setDescriptionKey</B>(java.lang.String&nbsp;descriptionKey)</PRE>
<DL>
<DD>Sets the key for the description. The key is used in conjunction with the localization
 info set in the <code>setLocalizationInfo</code> method to retrieve the translated description for 
 supported locales.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>descriptionKey</CODE> - the key for the description</DL>
</DD>
</DL>
<HR>

<A NAME="setLocalizationInfo(java.lang.String, org.apache.jetspeed.portlet.PortletContext, java.util.Locale[])"><!-- --></A><H3>
setLocalizationInfo</H3>
<PRE>
public void <B>setLocalizationInfo</B>(java.lang.String&nbsp;nlsFileName,
                                <A HREF="../../../../../org/apache/jetspeed/portlet/PortletContext.html" title="interface in org.apache.jetspeed.portlet">PortletContext</A>&nbsp;context,
                                java.util.Locale[]&nbsp;locales)</PRE>
<DL>
<DD>This data is used to retrieve internationalized
 versions of the title and description.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>nlsFileName</CODE> - the base name of the nls resource file(s) containing translated strings<DD><CODE>context</CODE> - the <code>PortletContext</code> for the calling portlet<DD><CODE>locales</CODE> - the locales supported by this portlet</DL>
</DD>
</DL>
<HR>

<A NAME="setInvocableOnMultipleMatch(boolean)"><!-- --></A><H3>
setInvocableOnMultipleMatch</H3>
<PRE>
public void <B>setInvocableOnMultipleMatch</B>(boolean&nbsp;invokeOnMultipleMatch)</PRE>
<DL>
<DD>Sets the parameter used to specify whether the action can be invoked in the event
 multiple matching actions are available for invocation on the portlet.
 See the <code>isInvocableOnMultipleMatch</code> method description for a description of
 the semantics of this parameter.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>invokeOnMultipleMatch</CODE> - true or false<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Action.html#isInvocableOnMultipleMatch()"><CODE>isInvocableOnMultipleMatch()</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="setInvokeOnMultipleMatch(boolean)"><!-- --></A><H3>
setInvokeOnMultipleMatch</H3>
<PRE>
public void <B>setInvokeOnMultipleMatch</B>(boolean&nbsp;invokeOnMultipleMatch)</PRE>
<DL>
<DD><B>Deprecated.</B>&nbsp;<I></I>&nbsp;
<P>
<DD>This method is deprecated. Use <code>setInvocableOnMultipleMatch</code> instead.
<P>
<DD><DL>
<DT><B>See Also:</B><DD><CODE>setInvocableOnMultipleMatch(boolean)</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="setType(int)"><!-- --></A><H3>
setType</H3>
<PRE>
public void <B>setType</B>(int&nbsp;type)
             throws <A HREF="../../../../../com/ibm/wps/pb/service/InvalidPropertyException.html" title="class in com.ibm.wps.pb.service">InvalidPropertyException</A></PRE>
<DL>
<DD>Sets the type of this action.
 Must be one of the type values defined in this class.
 <code>DEFAULT_PORTLET_ACTION</code> is the default if not set.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>type</CODE> - the type of the action
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/wps/pb/service/InvalidPropertyException.html" title="class in com.ibm.wps.pb.service">InvalidPropertyException</A></CODE> - is thrown if the type does not satisfy the
 required constraint.</DL>
</DD>
</DL>
<HR>

<A NAME="setActiveOnStartup(boolean)"><!-- --></A><H3>
setActiveOnStartup</H3>
<PRE>
public void <B>setActiveOnStartup</B>(boolean&nbsp;activeOnStartup)</PRE>
<DL>
<DD>Sets the activeOnStartup parameter for this action.
 See the <code>getActiveOnStartup</code> method description for a description of
 this parameter.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>activeOnStartup</CODE> - true or false<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Action.html#isActiveOnStartup()"><CODE>isActiveOnStartup()</CODE></A></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;PREV CLASS&nbsp;
&nbsp;<A HREF="../../../../../com/ibm/wps/pb/property/ActionTriggerMarkup.html" title="interface in com.ibm.wps.pb.property"><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="Action.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>
  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>

</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>

</BODY>
</HTML>