Client Event Handler builder inputs

Table 1. General inputs

Input Name	Description
Name	Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Page Location	Page or pages on which this builder call acts.
Event Name	Select the event name for which you want to add an action. Only events that have been enabled for client-side delivery in the event declaration builder are listed.
Action Type	Defines the behavior of the of the action. Choose an action type based on the action that processes the event and whether to process any form inputs as part of that action. Submit form and invoke action Choose this option if the specified action is a method in the model or linked Java™ object and that method processes the inputs to the form. Submit form to URL Choose this option if the specified action is a URL outside of the factory runtime that processes the inputs to a form. The specified URL receives the form input values as name and value pairs appended to the URL. Link to an action Choose this option if the specified action is a method in the model or linked Java object (including service calls). This option acts as a simple link, transferring control directly to the specified URL. If the action associated with the event submits a form, the control portion of the page location must be inside the form. Link to a URL Choose this option to navigate to a URL outside of WebSphere Portlet Factory control. If the action associated with the event submits a form, the control portion of the page location must be inside the form. Run a script Choose this option to run some client-side JavaScript™ when the event is fired. If the action associated with the event submits a form, the control portion of the page location must be inside the form.
Action	Specify the model action to execute, or link to, as a result of the event you specified for the Event Name input.
Form Name	If the builder is in one form or frame and the form to be submitted is in another, enter the name of the form whose inputs you want to submit.

Table 2. Arguments inputs

Input Name	Description
Input Mappings	You can pass arguments to the specified action by adding argument names and the value to be passed to it. Use the reference chooser to specify input values or values returned by methods or service calls as the value to be passed to an argument for the specified action.

Table 3. Post-Action Behavior inputs

Input Name	Description
Post-Action Behavior	Select what happens after the action launched by the event completes. Default Typically, this displays the output generated by the action. One exception is when the action is run from inside a container that specifies that the outermost page gets rendered after the action runs. In the exception case, this value does not display the output, but refreshes the outermost page. Refresh specified page location after running action The outermost page is not refreshed. Instead, new HTML for the specified region is recalculated after the action runs, and this HTML is sent to the client where it replaces the existing HTML. If the Replace "id" Matches is checked, the HTML produced by the action is examined for elements that have ID attribute values. If ID attribute values are found, the corresponding elements in the page have their HTML replaced. Note: If Ajax is disabled, the default post-action behavior is used without loss of functionality. Ajax enablement is controlled by profiling rather than changing inputs in a large number of builders. Replace specified location with action results This is good for ToolTips, incremental validation, and other simple information calculated on the server. Note: If Ajax is disabled, the default post-action behavior is used without loss of functionality. Ajax enablement is controlled by profiling rather than changing inputs in a large number of builders. Evaluate action results as JavaScript Run the main action and evaluate what it returns as JavaScript. Always reload top-most page after running action This is very similar to default, but overrides behavior that prevents the top-most page from refreshing. This option would be necessary if portal event and render phases need to be carried out to enable portlet-to-portlet communication to function properly. Show action results "stand-alone": display no containing pages This option is similar to Default, but it ensures that even if the model is running in a portal or model container, the action only returns the results of the specified action, not the containing portal or other surrounding pages. This option is ideal for lower-level Ajax or related functionality such as pop-ups, computed images, or Excel export.
Execute Embedded Scripts	This input is available if the Post-Action Behavior input is set to Refresh specified page after running action. Set this input to execute any JavaScript present in the page that is being refreshed. Any script specified either by <script src="name" /> or as text inside a <script> section is executed.

Table 4. Advanced inputs

Input Name	Description
Target	The window or frame which displays the results of the action. If you do not set this value, the current window or frame is the target. Valid entries are the following: _self Display results in the frame containing the form. If target is not specified, _self is the default. _blank Display results in a new browser window. _parent Display results in the frameset above the frame containing the form. _top Display results the topmost frameset. name You can also specify the name of a frame in the current frameset. Note: All targets are relative to the form being processed, not to the builder itself.
Rendering mode	If the specified action returns a specific page, set Rendering Mode to Normal. If you do not know the specific page that gets returned, set Rendering Mode to Return Outermost page after running action. For example, use this setting when creating a builder.
Break Containment	Enable to replace the contents of the target window with the contents of the URL returned by the action.
Overwrite Rule	If the elements on which this Client Event Handler builder operates already have the specified attribute set, select one of the following: Don't overwrite HTML value Does not set or change attribute value. Append new value Appends the specified value to existing attribute value. Typically used for building JavaScript expressions. For example, border="oldJavaScriptExpression";"newJavaScriptExpression". Prepend new value Prepends the specified value to existing attribute value. Typically used for building JavaScript expressions. For example, onClick="newJavaScriptExpression";"oldJavaScriptExpression". Overwrite HTML value Replaces existing attribute value with the specified attribute value.
Custom Script Pattern	Enter javascript to override default client code action. {0} is replaced with the URL, {1} with the target window name, if any.