Versions Compared

Old Version 23

changes.mady.by.user Fiona Sargeant

Saved on

compared with

New Version 24

changes.mady.by.user Fiona Sargeant

Saved on

Key

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

This page is is for application designers who need to create forms. It explains techniques for associating text with a data field, to label a field.

Overview

There are several ways that you can use stream data to set labels label fields on a dashboard. The text in a label can showscreen. You can use:

  • a static text component to display text
    • either that you enterhave entered
    • or populated with the name of a selected attribute.
  • a dynamic text that updates depending on the selected recordcomponent linked to the attribute in a grid.
    As an application users selects records in the grid, the dynamic text field updates.
  • placeholder text.

When you are designing a form, first add a form component. The form component is the container for all the data fields and labels; see Understanding Components and Layouts. You bind the form component to a stream or view; Showing Data on a Screen. This tells PhixFlow what attributes are available to display in data fields or labels. 


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

Table of Contents
maxLevel3
indent12px
stylenone


Opening the List of Attributes

Once a stream or view is bound to a form component, PhixFlow knows what attributes are available. To open the list of available attributes for a form component:

  • either right-click on the form in the dashboard and select 

    Insert excerpt
    _attributes_show
    _attributes_show
    nopaneltrue

  • or open the properties tab for a stream or view and expand the Attributes section.

Creating a Form

There are two ways to design a form for a screen.

  • From a list of attributes, drag an attribute onto a form component. PhixFlow adds a default labelled field that matches the data type of the attribute; see Showing Data on a Screen.
  • Drag field components individually from the palette, as follows:

  1. In the dashboard toolbar, click the

    Insert excerpt
    _palette
    _palette
    nopaneltrue
     icon.

Add or Change

  2. Expand a palette that has field or labelled field components, such as:

    • Basic Components
    • Labelled Fields
    • Theme 1 - App Builder Base Components
    • Theme 2 - App Builder Base Components

  3. Drag components onto a form container.

    Note

    Field or labelled fields must match the data type of the attribute that it will display.


  4. Enter a name so that PhixFlow can save the component to the repository.

Adding a Static Text Label

Use this option where you want to specify the text exactly.

Enter Your Own Text

Static text components display the text entered in their Display Text property. 

  1. From the palette, drag a static text field component onto the dashboard
next to
  1. .
  2. If this is a label for a data field
.Optionally
  1. , optionally group the data field and the static text field together; see Grouping Components.
  2. In the
static text component
  1. properties, in Basic Settings → Display Text, enter the fixed text you want to appear and save your changes.

To change a fixed text label:

  1. Click on the label to select it.
    If the label is a composite component, click on the data field, then click again to select its label. 
    Image Modified

  2. PhixFlow displays the static text properties. Edit Basic Settings →  Display Text and save your changes.

Click 


Image Added

Insert excerpt_finish_finishnopaneltrue.Use the Attribute as a Label


Image Added

Basic Components: individual data field and text components

Image Added

Labelled fields: a composite component comprising a data field and a static text field

Use the Attribute Name

When designing a dashboard, you may want a field to have a label that indicates the data being displayed. Where the attribute name is a good reflection of it's data, you can use this to add a

lable

label. For example, an attribute called Name has company name data:

Image Modified

To create a label from an attribute:

  1. Open the list of available attributes.

  2. Drag an attribute onto a form container on the dashboard.

  3. PhixFlow adds a labelled field to the form.

A labelled field is a composite component that includes:

  • a static text field, with properties → Basic Settings:
    • Name is Label
    • Display Text is the name of the attribute.
  • a data field that displays data from the attribute.

For information about composite components, see Grouping Components.

The default component to use when you drag attributes onto a dashboard are set in the Application properties or in System Configuration.

Display

Adding a Dynamic Text

as a

Label

For

PhixFlow matches a dynamic text

fields, PhixFlow matches the field

component to an attribute by matching their names. This is shown in the following illustration.

Panel
borderColor#00374F
titleColorwhite
titleBGColor#00374F
borderStylesolid
titleIllustration

A dashboard has a form container that includes a dynamic text field component

.

that looks like this:

Image Modified
Dynamic text field showing the business name

The dynamic text field displays the attribute Name from the selected record in a grid.

  

  In the dashboard below, the first record, for the business Avaveo, is selected.
Image Modified

   

     

  Image Removed

Dashboard with grid (top) and form (below)
                                               
 
   Stream that is bound to the grid and the form

Both the data grid and the form are bound to a stream called Business, which includes the attribute called Name.     

Image Added

Stream that is bound to the grid and the form

In the dynamic text field properties, the Name property is set to Name. PhixFlow recognises that Name is an attribute. This creates a link between the dynamic text field and the attribute.

Image Modified  

Image Removed

Editing a Form Field Label

To change the default name of a form field:

  1. Click on the form field, then click again to select the label. 

    1. Image Removed

  2. In the properties window on the right, update the Display Text to the desired value.

  3. Save your changes.

Image Removed

Manually Creating Form Fields

In the Screen's toolbar click the Insert excerpt_palette_palettenopaneltrue button.

  • Open the your desired palette e.g. Theme 2.1

  • Open the Labelled Fields section e.g.

    1. Image Removed

  • Drag a labelled field onto your screen. Note, select a field that matches the type of data the attribute will display.

  • Provide a name when prompted.

    • Optional Steps

    If you need your field to be backed by data it will need to be associated to an attribute on a stream. 

    1. Click on the broken link Icon.

    2. Image Removed

    3. Follow the wizard prompts.

    ddd


    Image Added


    Setting Place Holder Text

    Place holder text can be used to display a message to communicate information to the user. The value can be set manually or set to match the form field label.

    1. Select the Form Field on the dashboard.
    3. In the properties window on the right:
      1. Type a value in the Place Holder Text field to manually set a value.
      2. Tick Use Field Name as Place Holder to use the name of the field as the place holder text.


    Advanced Editing

    In addition to a label, you may want additional text below the field. For example you might want to add

    • static text, to explain what the user can do.
    • dynamic text that depends on selected data.
    1. In a basic components palette, such as Basic Components, drag a Static Text or Dynamic Text layout onto a form area.

    2. Right-click the new field and select Find. In the layouts list, find the container for the fields and double-click it to open its properties.

    3. In the Advanced section, the View Type is Field container. Expand the drop-down list and select the empty row. Save the container component. This "opens" the container so you can add more components to it.

    4. In the layouts list, shift-click and drag the new component into the container. PhixFlow moves your component to be a child of the container component.

    5. Important: Open the field container properties again and reset Advanced →View Type  to Field container. All child components are now contained within the parent, which is also a composite component.


    HTML Comment
    hiddentrue

    Not yet implemented

    To bind the field to an attribute:

    1. Click on the broken link icon.
      Image Added

    2. Follow the wizard prompts.


    Additional Reading

    Showing Data on a Screen