📄 action.html
字号:
<BR> Sets the key for the description.</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/pb/property/Action.html#setInvocableOnMultipleMatch(boolean)">setInvocableOnMultipleMatch</A></B>(boolean invokeOnMultipleMatch)</CODE><BR> 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.</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/pb/property/Action.html#setInvokeOnMultipleMatch(boolean)">setInvokeOnMultipleMatch</A></B>(boolean invokeOnMultipleMatch)</CODE><BR> <B>Deprecated.</B> <I></I> </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/pb/property/Action.html#setLocalizationInfo(java.lang.String, org.apache.jetspeed.portlet.PortletContext, java.util.Locale[])">setLocalizationInfo</A></B>(java.lang.String nlsFileName, <A HREF="../../../../../org/apache/jetspeed/portlet/PortletContext.html" title="interface in org.apache.jetspeed.portlet">PortletContext</A> context, java.util.Locale[] locales)</CODE><BR> This data is used to retrieve internationalized versions of the title and description.</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/pb/property/Action.html#setName(java.lang.String)">setName</A></B>(java.lang.String name)</CODE><BR> Sets the name of the action.</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/pb/property/Action.html#setParameters(com.ibm.wps.pb.property.Parameter[])">setParameters</A></B>(<A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html" title="interface in com.ibm.wps.pb.property">Parameter</A>[] params)</CODE><BR> Sets the action parameters.</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/pb/property/Action.html#setTitle(java.lang.String)">setTitle</A></B>(java.lang.String titleKey)</CODE><BR> <B>Deprecated.</B> <I></I> </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/pb/property/Action.html#setTitleKey(java.lang.String)">setTitleKey</A></B>(java.lang.String titleKey)</CODE><BR> Sets the key for the title.</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/pb/property/Action.html#setType(int)">setType</A></B>(int type)</CODE><BR> Sets the type of this action.</TD></TR></TABLE> <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="DEFAULT_PORTLET_ACTION"><!-- --></A><H3>DEFAULT_PORTLET_ACTION</H3><PRE>public static final int <B>DEFAULT_PORTLET_ACTION</B></PRE><DL><DD>Specifies delivery using <code>DefaultPortletAction</code>. The use of this value is deprecated and is retained for backwards compatibility<P><DL><DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.ibm.wps.pb.property.Action.DEFAULT_PORTLET_ACTION">Constant Field Values</A></DL></DL><HR><A NAME="SIMPLE_PORTLET_ACTION"><!-- --></A><H3>SIMPLE_PORTLET_ACTION</H3><PRE>public static final int <B>SIMPLE_PORTLET_ACTION</B></PRE><DL><DD>Specifies delivery using a simple action string<P><DL><DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.ibm.wps.pb.property.Action.SIMPLE_PORTLET_ACTION">Constant Field Values</A></DL></DL><HR><A NAME="STRUTS_ACTION"><!-- --></A><H3>STRUTS_ACTION</H3><PRE>public static final int <B>STRUTS_ACTION</B></PRE><DL><DD>Specifies delivery using Struts<P><DL><DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.ibm.wps.pb.property.Action.STRUTS_ACTION">Constant Field Values</A></DL></DL><!-- ========= 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="getName()"><!-- --></A><H3>getName</H3><PRE>public java.lang.String <B>getName</B>()</PRE><DL><DD>Returns the name of the action. Must be unique for a given portlet.<P><DD><DL><DT><B>Returns:</B><DD>a <code>String</code> containing the action name</DL></DD></DL><HR><A NAME="getConstantParameters()"><!-- --></A><H3>getConstantParameters</H3><PRE>public java.util.Map <B>getConstantParameters</B>()</PRE><DL><DD>Returns a <code>Map</code> containing name, value entries. These entries will be passed to the action when it is invoked through the property broker. How the entries are passed to the action is dependent on the action type. For actions implemented by portlets, the values are passed as request parameters. The values for the entries are restricted to <code>String</code>.<P><DD><DL><DT><B>Returns:</B><DD>an unmodifiable <code>Map</code> of constant objects associated with this action. If no constant parameters were set, an empty <code>Map</code> is returned.<DT><B>Since:</B></DT> <DD>5.1</DD></DL></DD></DL><HR><A NAME="getParameters()"><!-- --></A><H3>getParameters</H3><PRE>public <A HREF="../../../../../com/ibm/wps/pb/property/Parameter.html" title="interface in com.ibm.wps.pb.property">Parameter</A>[] <B>getParameters</B>()</PRE><DL><DD>Returns the parameters associated with the action.<P><DD><DL><DT><B>Returns:</B><DD>an array of <code>Parameter</code> objects containing the parameter information for this action<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></DL></DD></DL><HR><A NAME="getTitle()"><!-- --></A><H3>getTitle</H3><PRE>public java.lang.String <B>getTitle</B>()</PRE><DL><DD><B>Deprecated.</B> <I></I> <P><DD>This method is deprecated. Use the locale-specific version.<P><DD><DL><DT><B>Returns:</B><DD>a <code>String</code> containing the title<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Action.html#getTitle(java.util.Locale)"><CODE>getTitle(Locale)</CODE></A></DL></DD></DL><HR><A NAME="getDescription()"><!-- --></A><H3>getDescription</H3><PRE>public java.lang.String <B>getDescription</B>()</PRE><DL><DD><B>Deprecated.</B> <I></I> <P><DD>This method is deprecated. Use the locale-specific version.<P><DD><DL><DT><B>Returns:</B><DD>a <code>String</code> containing the description<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/Action.html#getTitle(java.util.Locale)"><CODE>getTitle(Locale)</CODE></A></DL></DD></DL><HR><A NAME="getTitle(java.util.Locale)"><!-- --></A><H3>getTitle</H3><PRE>public java.lang.String <B>getTitle</B>(java.util.Locale locale)</PRE><DL><DD>Returns a short string about the action suitable for displaying in a menu. This will return the title for the specified locale. Displayed in Click-to-Action menus, tools, or as help text as an aid to the user.<P><DD><DL><DT><B>Parameters:</B><DD><CODE>locale</CODE> - the client locale<DT><B>Returns:</B><DD>the internationalized version of the title string</DL></DD></DL><HR><A NAME="getDescription(java.util.Locale)"><!-- --></A><H3>getDescription</H3><PRE>public java.lang.String <B>getDescription</B>(java.util.Locale locale)</PRE><DL><DD>Returns a string containing a description of the action which can be used as a visual aid. Displayed in tools or as help text as an aid to the user. This will return the description for the specified locale.<P><DD><DL><DT><B>Parameters:</B><DD><CODE>locale</CODE> - the client locale<DT><B>Returns:</B><DD>the internationalized version of the description string</DL></DD></DL><HR><A NAME="isInvocableOnMultipleMatch()"><!-- --></A><H3>isInvocableOnMultipleMatch</H3><PRE>public boolean <B>isInvocableOnMultipleMatch</B>()</PRE><DL><DD>Returns a boolean indicating whether the action should be processed if it is simultaneously triggered with other actions on the same portlet (due to multiple wires being activated, or multiple actions being triggered through a Click-to-Action menu, for example). If return value is true, then this action will be invoked even if other actions on the portlet are simultaneously triggered. This is a safety mechanism used to prevent multiple actions from being invoked on the portlet even if simultaneously triggered, unless explictly overridden through this setting. The default value is false.<P><DD><DL><DT><B>Returns:</B><DD>a boolean value</DL></DD></DL><HR><A NAME="getInvokeOnMultipleMatch()"><!-- --></A><H3>getInvokeOnMultipleMatch</H3><PRE>public boolean <B>getInvokeOnMultipleMatch</B>()</PRE><DL><DD><B>Deprecated.</B> <I></I> <P><DD>This method is deprecated. Use <code>isInvocableOnMultipleMatch</code> instead.<P><DD><DL><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="getType()"><!-- --></A><H3>getType</H3><PRE>public int <B>getType</B>()</PRE><DL><DD>Returns the type of the action.<P><DD><DL><DT><B>Returns:</B><DD>the type of the action, ie <code>DEFAULT_PORTLET_ACTION</code> et. al. See the constants in this interface for allowed values.</DL></DD></DL><HR><A NAME="getOwnerId()"><!-- --></A><H3>getOwnerId</H3><PRE>public java.lang.Object <B>getOwnerId</B>()</PRE><DL><DD>Returns an id representing the portlet which registered this action.<P><DD><DL>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -