Event Declaration builder input - Portlet Factory v6.1.2

Portlet Factory, Version 6.1.2

Event Declaration builder input

This topic describes the Event Declaration builder inputs.

Input Name Description
Name Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Event Name Enter a name for this event. This name appears in the builder call list and in the list of events to handle in the Event Handler's builder call editor.
(optional) Arguments To define arguments that will be passed to the action specified by an Event Handler, name those arguments and specify their data type here.
Client-Side Event Delivery

Use Client-Side Delivery Check this option to designate this event for client-side delivery. You must also create a handler for the event using the client event handler builder. If this option is not checked (default), the event is delivered on the server and the full page is refreshed.
Fire Event On Server Check this option to invoke the event on the server, without a full page refresh, before firing the event on the client. If this option is checked, create a handler on the server side using the event handler builder.
Event Prefix Enter a prefix to be prepended to the event name to ensure that the name is unique on the client side. This is necessary to prevent name collisions when multiple models are on the same page. All uses of a particular client-delivered event need to agree about that prefix for the event to be shared among them. The best practice pattern, whether for server or client side events, is to put the event declaration builders into a model and import that model into all models that use those events.
Example: com.example.modelName

Parent topic: Event Declaration builder

Library | Support |

Input Name	Description
Name	Name for this builder call. The WebSphere Portlet Factory Designer displays this name in the builder call list.
Event Name	Enter a name for this event. This name appears in the builder call list and in the list of events to handle in the Event Handler's builder call editor.
(optional) Arguments	To define arguments that will be passed to the action specified by an Event Handler, name those arguments and specify their data type here.
Client-Side Event Delivery
Use Client-Side Delivery	Check this option to designate this event for client-side delivery. You must also create a handler for the event using the client event handler builder. If this option is not checked (default), the event is delivered on the server and the full page is refreshed.
Fire Event On Server	Check this option to invoke the event on the server, without a full page refresh, before firing the event on the client. If this option is checked, create a handler on the server side using the event handler builder.
Event Prefix	Enter a prefix to be prepended to the event name to ensure that the name is unique on the client side. This is necessary to prevent name collisions when multiple models are on the same page. All uses of a particular client-delivered event need to agree about that prefix for the event to be shared among them. The best practice pattern, whether for server or client side events, is to put the event declaration builders into a model and import that model into all models that use those events. Example: com.example.modelName