Portlet Factory, Version 6.1.2
Widget Event builder inputs
This topic describes the inputs for the Widget Event builder.
Properties
Table 1. Widget Event builder Properties inputs Input Name Description Event Name Enter the name of the widget event. Description Enter a short description of the widget event. Payload Enter the type of payload. The payload is the data associated with the event, usually in the form of one or more parameters that are specific to the event type. Select one of the following:
- No payload
- One simple parameter as payload
- Structured payload with multiple elements. If you select this, the table in the Payload Structure input appears.
Payload Type/ID This input is available if a payload option is selected in the Payload input. Select the payload type or identifier. The default value is text.
- address
- A designation of a destination
- atom
- Atom format XML
- boolean
- A true or false value
- countrycode
- A country code
- currency
- A number that is a monetary value
- date
- A representation of year, month, and day in standard international format, for example, YYYY-MM-DD, YYYYMMDD, YYYYMM, or YYYY
- An e-mail address
- html
- An HTML markup fragment
- image
- A DOM node or a DOM node id to an image
- json
- JavaScript Object Notation (JSON) format
- languagecode
- A code to represent a human language
- number
- A number
- person
- A person (such as a name)
- phone
- A telephone number
- postalcode
- A postal code
- rss
- Really Simple Syndication (RSS) format XML
- table
- Comma Separated Value (CSV) format
- text
- Any plain text (not matching anything more specific in this list)
- time
- A time of day in standard international format, for example, hh:mm:ss.mmmm, hh:mm:ss, hh:mm or hh
- timestamp
- A timestamp combining a date and a time
- url
- A (any) Web resource
- url.html
- An HTML Web resource
- url.table
- A CSV format web resource
- url.xml
- An XML web resource
- url.atom
- An Atom Syndication Format (Atom) Web resource
- url.rss
- An RSS Web resource
- url.json
- A JSON Web resource
- url.image
- An image Web resource
- xml
- XML
Payload Structure This input is available if Structured payload with multiple elements is selected for the Payload input. In the table, enter the names of the elements and the payload type for each element. Event usage Select one of the following to determine whether events are to be handled, fired, or both fired and handled.
Event Handling
In the Event usage input, if you specify that the event can be handled, you can specify the actions to take in response to the event.
Table 2. Widget Event builder Event Handling inputs Input Name Description Action Type Select one of the following:
- Execute one or more actions on the server
- Specify the server actions in the Actions input.
- Run Javascript on the client
- Specify in the Script input the script to be executed locally.
Actions This input is available if the Action Type input selected is Execute one or more actions on the server. Specify the ActionList. Script This input is available if the Action Type input selected is Run Javascript on the client. Enter the script itself. Parent topic: Widget Event builder
Library | Support |