Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

Live Search
spaceKey@self
additionalnone
placeholderSearch all help pages
typepage

Panel
borderColor#00374F
titleColorwhite
titleBGColor#00374F
borderStylesolid
titleSections on this page

Table of Contents
maxLevel3
indent12px
stylenone

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:

EventSupported components
OnClickArea
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

  1. From the screen, click on a component to open its properties.
  2. In the Event Handler section, click 
    Insert excerpt
    _Add
    _Add
    nopaneltrue
     to create a new event handler.
  3. PhixFlow opens a new properties tab for the event handler.
  4. Select the Event Type, Action Method and specific stream-action or actionflow you require; see the properties below.

Event Handler Properties

Basic Settings

FieldDescription
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:

  • Stream Action
  • No action
  • Actionflow
Action

Available when Action Method is Stream Action.

  • Either, select a stream-action from the drop-down list
  • Or, to find stream-actions belonging to a specific stream:
    1. Click 
      Insert excerpt
      _table_list
      _table_list
      nopaneltrue
       to show streams in the repository
    2. Expand the stream
    3. Drag a stream-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
    nopaneltrue
     to show actionflows in the repository
  • Click 
    Insert excerpt
    _add
    _add
    nopaneltrue
     to create a new actionflow; see Actionflows