Versions Compared

Version Old Version 6 New Version Current
Changes made by

Fiona Sargeant

Zoe Baldwin

Saved on

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.

todo-Fiona - Indraft: Layout component also needs updating as there is a new properties section

Often in an application, you want to trigger an action based on an event that occurs on the dashboard:

  • OnClick: the user mouse clicks in an area or on a button
  • OnEnter: the user presses the Enter key in a data field
  • OnBlur: the user moves their mouse pointer out of a data field.
    The event is triggered whether or not the field has changed.
  • OnChange: the user moves their mouse pointer 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 configure an event handler on a specific layout component, and link it to a stream-action or actionflow. When the user triggers the event, PhixFlow runs the stream-action or actionflow.

You can set event handlers on the following components:

EventSupported componentsOnClickAreas
ButtonsOnChange

Areas
Buttons
Data fields:

  • Boolean
  • Date
  • Datetime
  • Number
  • String
OnBlur OnEnter

Data fields:

  • Boolean
  • Date
  • Datetime
  • Number
  • String
Panel
borderColor#7da054
titleColorwhite
titleBGColor#7da054
borderStylesolid
titleSections on this page

Table of Contents
maxLevel3
indent12px
stylenone

  • From the screen, open the component.
    • In the Event Handler section, click  Insert excerpt_Add_Addnopaneltrue to create a new event handler.
  • In the new event handler tab, select the Action Method.
  • Open the repository to find the action you require.
  • Drag the action from the repository to the Action field, 

    • Add to component

    Action method

  • Stream Action
  • No action
    • Workflow Action

    Insert excerpt
    _Banners
    _Banners
    nameactionflow
    nopaneltrue

    Event Handler Properties

    For full details on event handlers, see Connecting Actionflows to Events.

    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:

    • Table-Action
    • No action
    • Actionflow
    • Other
    Action

    Available when Action Method is Table-Action.

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