| Live Search |
|---|
| spaceKey | @self |
|---|
| additional | none |
|---|
| placeholder | Search all help pages |
|---|
| type | page |
|---|
|
| Panel |
|---|
| borderColor | #00374F |
|---|
| titleColor | white |
|---|
| titleBGColor | #00374F |
|---|
| borderStyle | solid |
|---|
| title | Sections on this page |
|---|
|
| Table of Contents |
|---|
| maxLevel | 3 |
|---|
| indent | 12px |
|---|
| style | none |
|---|
|
|
This page is for application designers. It explains how to set up actions in response to an event, such as a user mouse-click.
Overview
Often in an application, you want to trigger an action based on the user:
- either mouse-clicking on the dashboard
- or pressing the enter key.
These user interactions are called events. In PhixFlow you can configure event handlers that respond to events by running a stream-action or actionflow.
- OnClick: the user mouse clicks in an area.
- OnEnter: the user presses the Enter key in a data field.
- OnBlur: the user mouse-clicks out of a data field.
The event is triggered whether or not the field has changed. - OnChange: the user mouse-clicks out of a data field in which they have changed data.
Notice that this event is not triggered by the user typing into a field.
You can set event handlers on the following components:
| Event | Supported components |
|---|
| OnClick | Area |
| OnChange | Area Data fields: - Boolean
- Date
- Datetime
- Number
- String
|
| OnBlur OnEnter | Data fields: - Boolean
- Date
- Datetime
- Number
- String
|
| Tip |
|---|
You do not have to configure OnClick events for button components, because button actions are always triggered when the user mouse-clicks on them. |
Adding an Event Handler
From the screen, click on a component to open its properties.In the Event Handler section, click | Insert excerpt |
|---|
_Add | _Add | | nopanel | true |
|---|
to create a new event handler.PhixFlow opens a new properties tab for the event handler.Select the Event Type, Action Method and specific stream-action or actionflow you require; see the properties below.Event Handler Properties
| Insert excerpt |
|---|
| _Banners |
|---|
| _Banners |
|---|
| name | actionflow |
|---|
| nopanel | true |
|---|
|
Event Handler Properties
For full details on event handlers, see Connecting Actionflows to Events.
Basic Settings
| Field | Description |
|---|
| Event Type | Select the type of event that will trigger an action: - OnClick
- OnEnter
- OnBlur
- OnChange
|
The list shows only the events available for this type of component. |
| Action Method | Available when Event Type is selected. Select the type of action: |
- Table-Action
- No action
- Actionflow
- Other
|
| Action | Available when Action Method is |
- table-action from the drop-down list
- Or, to find
|
- table-actions belonging to a specific
|
- table:
- Click
| Insert excerpt |
|---|
| _table_list |
|---|
| _table_list |
|---|
| nopanel | true |
|---|
|
to show
|
- tables in the repository
- Expand
|
- table-action from the list into this box.
|
| Actionflow | Available when Action Method is Actionflow. To select an actionflow, do one of the following: - Select an actionflow from the drop-down list.
- Click
| Insert excerpt |
|---|
| _actionflow |
|---|
| _actionflow |
|---|
| nopanel | true |
|---|
|
to show
|
- Actionflows in the repository
- Click to create a new actionflow; see
|
|
| Other | Available when Action Method is Other. Select from the drop down: - None
- Clear All Fields: clears content from all form fields on the parent form
- Close Screen: closes the parent screen
- Maximise/Minimise Screen: toggles the screen between minimised and its default size
- Screenshot: copies an image of the selected component to the clipboard. The required component must be dragged and dropped into the Screenshot Component box from the
| Insert excerpt |
|---|
| _layers |
|---|
| _layers |
|---|
| nopanel | true |
|---|
|
or | Insert excerpt |
|---|
| _repository |
|---|
| _repository |
|---|
| nopanel | true |
|---|
|
.
|