propertybrokerservice.html

门户开发

changedProperties</H3>
<PRE>
public void <B>changedProperties</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                              <A HREF="../../../../../org/apache/jetspeed/portlet/PortletConfig.html" title="interface in org.apache.jetspeed.portlet">PortletConfig</A>&nbsp;config,
                              <A HREF="../../../../../com/ibm/wps/pb/property/PropertyValue.html" title="interface in com.ibm.wps.pb.property">PropertyValue</A>[]&nbsp;properties)
                       throws <A HREF="../../../../../com/ibm/wps/pb/service/IllegalStateException.html" title="class in com.ibm.wps.pb.service">IllegalStateException</A>,
                              <A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></PRE>
<DL>
<DD>Publishes changes in properties. 
 May be called during the portlet's event phase only.
 This includes the <code>beginEventPhase</code> method 
 of the <code>EventPhaseListener</code> interface,
 the <code>actionPerformed</code> method of the <code>ActionListener</code> interface, 
 and the <code>setProperties</code>
 method of the <code>PropertyListener</code> interface.
 All properties must have been registered earlier, implicitly or explicitly.
 A simpler alternative to explicitly invoking this method is 
 often applicable: declare output parameters for registered
 actions (either programmatically or via a WSDL declaration), in which case the action
 may bind the values of the output parameters on invocation, and the runtime will 
 transfer the values as if the <code>changedProperties</code> method 
 had been explicitly invoked.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <code>PortletRequest</code> object for the current request<DD><CODE>config</CODE> - the <code>PortletConfig</code> object for the calling portlet<DD><CODE>properties</CODE> - an array of <code>PropertyValue</code> objects containing the changed
 properties.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/wps/pb/service/IllegalStateException.html" title="class in com.ibm.wps.pb.service">IllegalStateException</A></CODE> - if invoked outside the event phase
<DD><CODE><A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></CODE> - is thrown if any problem is encountered<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/PropertyValue.html" title="interface in com.ibm.wps.pb.property"><CODE>PropertyValue</CODE></A>, 
<A HREF="../../../../../com/ibm/wps/pb/portlet/PropertyListener.html#setProperties(org.apache.jetspeed.portlet.PortletRequest, com.ibm.wps.pb.property.PropertyValue[])"><CODE>PropertyListener.setProperties(org.apache.jetspeed.portlet.PortletRequest, com.ibm.wps.pb.property.PropertyValue[])</CODE></A>, 
<A HREF="../../../../../org/apache/jetspeed/portlet/event/ActionListener.html#actionPerformed(org.apache.jetspeed.portlet.event.ActionEvent)"><CODE>ActionListener.actionPerformed(org.apache.jetspeed.portlet.event.ActionEvent)</CODE></A>, 
<A HREF="../../../../../com/ibm/wps/portlet/event/EventPhaseListener.html#beginEventPhase(org.apache.jetspeed.portlet.PortletRequest)"><CODE>EventPhaseListener.beginEventPhase(org.apache.jetspeed.portlet.PortletRequest)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="generateActionTriggerControl(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse, com.ibm.wps.pb.property.PropertyValue, boolean)"><!-- --></A><H3>
generateActionTriggerControl</H3>
<PRE>
public java.lang.String <B>generateActionTriggerControl</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                                                     <A HREF="../../../../../org/apache/jetspeed/portlet/PortletResponse.html" title="interface in org.apache.jetspeed.portlet">PortletResponse</A>&nbsp;response,
                                                     <A HREF="../../../../../com/ibm/wps/pb/property/PropertyValue.html" title="interface in com.ibm.wps.pb.property">PropertyValue</A>&nbsp;property,
                                                     boolean&nbsp;broadcast)
                                              throws <A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></PRE>
<DL>
<DD>Returns markup for displaying a Click-to-Action menu for triggering actions which
 can process the property passed to this method.
 This method provides the function exposed through the <code>encodeProperty</code>
 Click-to-Action JSP tag. It may be used to generate Click-to-Action menus when it is
 not possible to use JSPs.
 <br/>
 Generates markup to be written to the response stream which provides the 
 end-user with a means for  visually selecting portlet actions which can process 
 the specified property and sending the property value to these actions 
 The locale for the request is used for any locale-specific markup.
 If the property has not been wired to targets, a match is performed on the type
 of the property and the markup generated shows an icon which 
 displays a pop-up menu of matching actions when clicked. If the property has
 been wired to targets, the markup generated shows an icon which causes the wired
 actions to be fired when clicked. The icons generated for the wired and non-wired
 cases differ slightly to offer a visual cue to the user as to which case is in effect.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <code>PortletRequest</code> object for the current request<DD><CODE>response</CODE> - the <code>PortletResponse</code> object for the current request<DD><CODE>property</CODE> - a <code>PropertyValue</code> object holding the property and its value<DD><CODE>broadcast</CODE> - a boolean, if true an additional meta-action to trigger all matching
 portlet actions is generated.
<DT><B>Returns:</B><DD>a <code>String</code> containing the markup
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></CODE> - thrown if any problem is 
 encountered creating the menu markup</DL>
</DD>
</DL>
<HR>

<A NAME="generateActionTriggerControl(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse, com.ibm.wps.pb.property.PropertyValue[], java.lang.String, java.lang.String)"><!-- --></A><H3>
generateActionTriggerControl</H3>
<PRE>
public java.lang.String <B>generateActionTriggerControl</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                                                     <A HREF="../../../../../org/apache/jetspeed/portlet/PortletResponse.html" title="interface in org.apache.jetspeed.portlet">PortletResponse</A>&nbsp;response,
                                                     <A HREF="../../../../../com/ibm/wps/pb/property/PropertyValue.html" title="interface in com.ibm.wps.pb.property">PropertyValue</A>[]&nbsp;properties,
                                                     java.lang.String&nbsp;caption,
                                                     java.lang.String&nbsp;description)
                                              throws <A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></PRE>
<DL>
<DD>Returns markup to generate a Click-to-Action menu for triggering actions which can process any
 one of the set of properties passed to this method.
 This method provides the function exposed through the <code>encodeProperties</code>
 Click-to-Action JSP tag. It may be used to generate Click-to-Action menus when it is
 not possible to use JSPs.
 <br/>
 Takes an array of property values and generates markup to display a
 visual control in the form of a clickable icon 
 which allows the end-user to trigger all actions matching
 any property in the array at once. Useful for allowing user-driven
 resync on a set of related information - e.g. all the information
 in a table row. See the description of the alternate <code>generateActionTriggerControl</code>
 method for details on the markup generated.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <code>PortletRequest</code> object<DD><CODE>response</CODE> - the <code>PortletResponse</code> object<DD><CODE>properties</CODE> - an array of <code>PropertyValue</code> containing the
 descriptions and values of the properties to be passed to the actions<DD><CODE>caption</CODE> - the string which will be used to visually identify to the user
 the actions which will be taken.<DD><CODE>description</CODE> - a descriptive string expanding on the caption
<DT><B>Returns:</B><DD>the string containing the markup to for displaying the visual control
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></CODE> - thrown if any problem was 
 encountered creating the markup</DL>
</DD>
</DL>
<HR>

<A NAME="getActionTriggerMarkup(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse, com.ibm.wps.pb.property.PropertyValue, boolean)"><!-- --></A><H3>
getActionTriggerMarkup</H3>
<PRE>
public <A HREF="../../../../../com/ibm/wps/pb/property/ActionTriggerMarkup.html" title="interface in com.ibm.wps.pb.property">ActionTriggerMarkup</A> <B>getActionTriggerMarkup</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                                                  <A HREF="../../../../../org/apache/jetspeed/portlet/PortletResponse.html" title="interface in org.apache.jetspeed.portlet">PortletResponse</A>&nbsp;response,
                                                  <A HREF="../../../../../com/ibm/wps/pb/property/PropertyValue.html" title="interface in com.ibm.wps.pb.property">PropertyValue</A>&nbsp;property,
                                                  boolean&nbsp;broadcast)
                                           throws <A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></PRE>
<DL>
<DD>Returns an interface allowing access to markup for displaying a Click-to-Action menu for triggering actions which
 can process the property passed to this method.
 Performs the same matching logic as the <code>generateActionTriggerControl</code> method,
 but returns the markup in a form that may be embedded with custom
 elements, rather than the standard icon that is provided. Allows 
 the generated Click-to-Action menu to be associated with arbitrary clickable elements
 in the markup generated by the portlet.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>request</CODE> - the <code>PortletRequest</code> object for the current request<DD><CODE>response</CODE> - the <code>PortletResponse</code> object for the current request<DD><CODE>property</CODE> - a <code>PropertyValue</code> object holding the property and its value
 description and value<DD><CODE>broadcast</CODE> - a boolean, if true an additional meta-action to trigger all matching
 portlet actions is generated.
<DT><B>Returns:</B><DD>a String containing the markup
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></CODE> - is thrown if any problem is encountered<DT><B>See Also:</B><DD><A HREF="../../../../../com/ibm/wps/pb/property/ActionTriggerMarkup.html" title="interface in com.ibm.wps.pb.property"><CODE>ActionTriggerMarkup</CODE></A>, 
<A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerService.html#generateActionTriggerControl(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse, com.ibm.wps.pb.property.PropertyValue, boolean)"><CODE>generateActionTriggerControl(PortletRequest, PortletResponse,PropertyValue, boolean)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getActionTriggerMarkup(org.apache.jetspeed.portlet.PortletRequest, org.apache.jetspeed.portlet.PortletResponse, com.ibm.wps.pb.property.PropertyValue[], java.lang.String, java.lang.String)"><!-- --></A><H3>
getActionTriggerMarkup</H3>
<PRE>
public <A HREF="../../../../../com/ibm/wps/pb/property/ActionTriggerMarkup.html" title="interface in com.ibm.wps.pb.property">ActionTriggerMarkup</A> <B>getActionTriggerMarkup</B>(<A HREF="../../../../../org/apache/jetspeed/portlet/PortletRequest.html" title="interface in org.apache.jetspeed.portlet">PortletRequest</A>&nbsp;request,
                                                  <A HREF="../../../../../org/apache/jetspeed/portlet/PortletResponse.html" title="interface in org.apache.jetspeed.portlet">PortletResponse</A>&nbsp;response,
                                                  <A HREF="../../../../../com/ibm/wps/pb/property/PropertyValue.html" title="interface in com.ibm.wps.pb.property">PropertyValue</A>[]&nbsp;properties,
                                                  java.lang.String&nbsp;caption,
                                                  java.lang.String&nbsp;description)
                                           throws <A HREF="../../../../../com/ibm/wps/pb/service/PropertyBrokerServiceException.html" title="class in com.ibm.wps.pb.service">PropertyBrokerServiceException</A></PRE>
<DL>
<DD>Returns an interface allowing access to markup to generate a Click-to-Action menu for triggering actions which can process any
 one of the set of properties passed to this method.
 Performs the same matching logic as the <code>generateActionTriggerControl</code> method,
 but returns the markup in a form that may be embedded with custom
 elements, rather than the standard icon that is provided. Allows 
 the generated Click-to-Action menu to be associated with arbitrary clickable elements
 in the markup generated by the portlet.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>