Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Reverted from v. 106

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Overview

Create application screens by starting with a dashboard; see Creating or Opening a Screen.

...

  • either using the toolbar 
  • or right-click anywhere in the screen to display the pop-up menu.

This page has the reference documentation for dashboard properties. For information on how to divide a screen into different panes, and how to add things to a screen, see Drag-and-Drop Techniques.

See Also

Properties

...

Basic Settings

...

Insert excerpt
_Banners
_Banners
namescreen
nopaneltrue

This page is for application designers who want to create screens for application users.

Overview

This page explains the screen properties. For information on how to divide a screen into different panes, and how to add components to it, see Splitting a Screen.

Insert excerpt
_property_toolbar
_property_toolbar
nopaneltrue

Insert excerpt
_property_tabs
_property_tabs
namebasic-h
nopaneltrue

Insert excerpt
_parent
_parent
nopaneltrue

Basic Settings

FieldDescription
NameThe name of the screen.
Open Maximised

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to open the screen maximised.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to open the screen as a popup window.

Allow User to Resize

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to enable the application user, when running in 
Insert excerpt
_app_mode
_app_mode
nopaneltrue
, to resize the screen.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to keep the screen size fixed when running in in 
Insert excerpt
_app_mode
_app_mode
nopaneltrue
.

This option does not affect resizing the screen in 

Insert excerpt
_design_mode
_design_mode
nopaneltrue
.

Show Toolbar
Insert excerpt
_design_mode
_design_mode
nopaneltrue
 always has a toolbar with the screen name on the left and toolbar icons on the right. 

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to also display the toolbar in 
Insert excerpt
_app_mode
_app_mode
nopaneltrue
. The screen name is displayed. Toolbar icons are not displayed.

Insert excerpt
_check_box_

...

untick
_check_box_

...

untick
nopaneltrue

...

 is the default as the toolbar is usually not required in 

Insert excerpt
_

...

app_

...

mode
_

...

app_

...

mode
nopaneltrue

...

.

Show Window Button Bar

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to

...

display a Windows-style bar at the top of the screen. This has a maximise/restore button and a close button.

Image Added

Insert excerpt
_check_

...

box_

...

untick
_check_

...

box_

...

untick
nopaneltrue

...

 to have no Windows-style bar at the top of the screen.

Always On Top

Insert excerpt
_check_box_

...

tick
_check_box_

...

tick
nopaneltrue
 to keep the screen

...

on top of other screens. This is useful for a popup window that you want a user to complete before returning to another screen.

Insert excerpt
_check_

...

box_

...

untick
_check_

...

box_

...

untick
nopaneltrue
 to allow other screens to be displayed in front.

...

 

Keep Data

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to

...

allow screen data to be referenced even after the screen is closed. This is useful if an application user needs access to global data available in the system.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue

...

 is the default. The screen data is not required once the screen is closed.

Preload

screens , especially complex screens, can take some time to open, which can feel slow to the application user. Use this option when you need a screen to open quickly. Preloading screens adds to the time it takes PhixFlow to initially start up.  For this reason we recommend you only preload screens that an application user will always want to open.

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to

...

preload the screen when PhixFlow first starts.  When the user then opens the screen , it displays immediately. The data itself may still take time to load.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 is the default. The

...

screen does not need to be preloaded.

Preloading relates to the screen itself. Any data backing the screen is only loaded when the screen opens, and this may also take time to load.

Cache Locally

If an application user is likely to require the same screen in different stages of a task. Use this option so that, when the user closes and reopens the screen, it loads immediately. 

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to

...

cache the screen

...

Preloading relates to the screen itself. Any data backing the screen is only loaded when the screen opens, and this may also take time to load.

...

If an application user is likely to require the same screen in different stages of a task. Use this option so that, when the user closes and reopens the screen, it loads immediately. 

...

Caching relates to the screen itself. Any data backing the screen will be reload each time the screen is opened.

...

Todo - not yet implemented

You may have a screen that acts as your application's welcome window. Use this option to open a screen whenever the application starts.

...

By default, screens are opened floating centrally. If you want a screen to open with a fixed position, select one of the drop-down options:

  • Pinned to top
  • Pinned to bottom
  • Pinned to left: top left
  • Pinned to right: top right
  • Floating (default)

todo - check DEV-9189 as there are problems using these options

...

Width

...

Specify a screen height in pixels, for example 150px for a small confirmation window. The default size of a pop-up screen is approximately 500px. 

...

Available when Position is Floating.

Set an offset value in pixels to position the screen where it is required. For example, to display a screen as a pop-up window towards the top left of the screen set:

  • Top: 60px
  • Left: 60px

...

Dashboard Elements

...

PhixFlow creates dashboard elements when you use the pop-up menu Add Area... options to divide up the screen. In PhixFlow version 8.3 and earlier, dashboard elements enabled different parts of the screen to be bound to different sources of data, either a stream (table) or view.

Where dashboard elements are bound to data, you can link them, so that the data in one dashboard element drives the data in another; see Linked and Driving Views.

Menu Items

This section has a toolbar with standard buttons and:

...

  • either Add a new sub-menu
  • or Add a new menu item; see Menu

...

To remove a menu, use the toolbar button Image Removed Delete Everywhere.

Mappings

This section has a toolbar with standard buttons. The grid contains a list of mappings between attributes that are the same but have different names in different streams (tables) or views. PhixFlow will evaluate all the mapped datasets when it runs an action on the dashboard. Todo - check this is the correct mapping.

Unreachable Actions

Todo - New feature related to actionflows?

Actions

This section has a toolbar with standard buttons. The grid displays a list of actions and/or (todo - check) stream item actions (record-actions) that are linked to the screen.

...

Menus and Toolbars

Screen Toolbar

There is a toolbar above the screen canvas. This provides the following options:

...

Open the repository showing the list of available tables for your application.

...

Unlock a screen to edit its layout.

...

on the application user's client computer when the screen first opens.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 is the default. The screen does not need to be cached.

Caching relates to the screen itself. Any data backing the screen will be reload each time the screen is opened.

Position

By default, new screens are set to Floating. If you want a screen to open with a fixed position, select one of the Pinned drop-down options:

  • Pinned to top
  • Pinned to bottom
  • Pinned to left
  • Pinned to right
  • Floating

Use the Pinned options to create a permanently visible screen. This is useful for a navigation area or toolbar that you want to be visible for all other screens. Floating screens do not overlap with pinned screens. When the user maximises a Floating screen, it expands only to the remaining space. 

Width

For screens that are not set to Open maximised, specify a screen width in pixels, for example 500px for a small confirmation window. The default size for a popup screen approximately 800px.
Height

For screens that are not set to Open maximised, specify a screen height in pixels, for example 150px for a small confirmation window. The default size of a popup screen is approximately 500px. 

Top

Available when Position is Floating.

For screens that are not set to Open maximised, set an offset value in pixels to position the screen where it is required. For example, to display a screen as a popup window towards the top left of the screen, set:

  • Top: 60px
  • Left: 60px
Left
Right
Bottom

Screen Elements

Screen elements are specific sections on a screen that posses their own properties, specifically each element can be backed by a different table.

To view a list of the elements for a specific screen, open the 

Insert excerpt
_property_settings
_property_settings
nopaneltrue
available from the screen toolbar; see Screen Element.  

Menu Items

This section has a toolbar with standard buttons and:

  •  Image Added Show Table-actions
  • Insert excerpt
    _filter
    _filter
    nopaneltrue

The grid contains a list of menu items. To add a menu item to the list, click 

Insert excerpt
_add
_add
nopaneltrue

  1. Click 
    Insert excerpt
    _add
    _add
    nopaneltrue
  2. Select 
  3. PhixFlow opens a new properties tab for a menu item or sub-menu; see Startup Actions for details.

To remove a menu, use the toolbar button 

Insert excerpt
_delete
_delete
nopaneltrue
.

Mappings

This section has a toolbar with standard buttons

Components on the screen, such as buttons or data-components, can have actionflows or record-actions. Record-actions can take data from attributes in different tables  or views. Where the attributes have different names, you must map the attribute, so that the record-action recognises the data. This grid contains a list of mappings for the components on this screen. 

To configure a mapping, in the screen, right-click a component and select 

Insert excerpt
_mapping
_mapping
nopaneltrue
.

Unreachable Actions

This section has a toolbar with standard buttons. The grid displays a list of actionflows that are linked to components on the screen, but do not exist yet.

Tip

Actionflows are a new way to configure actions, introduced in PhixFlow version 9.0.0; see Understanding Actionflows.

Actions

This section has a toolbar with standard buttons. The grid displays a list of actions and record-actions that are linked to the screen.

Tip

Actions and record-actions were the way to configure screen functionality before PhixFlow version 9.0.0; see Using Table-Actions and Record-Action

Insert excerpt
_description
_description
nopaneltrue

Insert excerpt
_access
_access
nopaneltrue


Insert excerpt
_audit
_audit
nopaneltrue

Menus and Toolbars

Screen Toolbar

There is a toolbar above the screen canvas. This provides the following options:

List options

Insert excerpt
_tables
_tables
nopaneltrue

Open the repository showing the list of available tables for your application.

Insert excerpt
_screen_toolbar
_screen_toolbar
nopaneltrue
Open the repository showing the list of available screens for your application.
Insert excerpt
_actionflow
_actionflow
nopaneltrue
Open the repository showing the list of available actionflows for your application.
Insert excerpt
_palette
_palette
nopaneltrue
Open the list of palettes.
Insert excerpt
_styles
_styles
nopaneltrue
Open the repository showing the list of available styles for your application.
Canvas options
Insert excerpt
_help
_help
nopaneltrue
Open the help topic with details about working with screens.
Insert excerpt
_property_settings
_property_settings
nopaneltrue
Open the properties tab for the screen.

Insert excerpt
_unlock
_unlock
nopaneltrue

or 

Insert excerpt
_lock
_lock
nopaneltrue

Unlock a screen to edit its layout.

Lock a screen to prevent accidental edits and to display the data content.

Insert excerpt
_refresh
_refresh
nopaneltrue

Update the screen to reflect changes made elsewhere in PhixFlow, such as the screen properties, layer orders or shared styles.

Screen Popup Menu

Right-click on a screen to display its popup menu. The options available depend on where you click. If there are many options, some are moved onto the sub-menu

Insert excerpt
_screen
_screen
nopaneltrue
 Options.

Menu optionDescription
Insert excerpt
_unlock
_unlock
nopaneltrue
Unlock a screen to edit its layout.
Insert excerpt
_lock
_lock
nopaneltrue
Lock a  screen to prevent accidental edits and to display the data content.
Insert excerpt
_context_

...

parameters

...

Update the screen to reflect changes made elsewhere in PhixFlow, such as the screen properties, layer orders or shared styles.

Screen Context Menu

...

_context_parameters
nopaneltrue
For screens created in PhixFlow versions 8.3 and earlier, open a window listing the context parameters in alphabetical order.
Insert excerpt
_element_show
_element_show
nopaneltrue
For screens created in PhixFlow versions 8.3 and earlier, open the properties for the screen element.
Insert excerpt
_

...

area_

...

above
_

...

area_

...

above
nopaneltrue

...

Use these options to divide a screen

...

into multiple, resizable panes. Select the option to add a pane relative to the currently selected pane.

To remove a pane, use the popup menu options 

Insert excerpt
_

...

delete
_

...

delete
nopaneltrue

...

 Pane.

Insert excerpt
_

...

area_

...

right
_

...

area_

...

right
nopaneltrue
Insert excerpt
_

...

area_

...

below
_

...

area_

...

below
nopaneltrue

...

Insert excerpt
_area_

...

left
_area_

...

left
nopanel

...

Use these options to divide a screen into multiple, resizable panes. Select the option to add a pane relative to the currently selected pane.

...

true
Insert excerpt
_area_

...

lock_width
_area_lock_width
nopaneltrue

...

Fix the height or width of the selected pane. You will no longer be able to resize a pane by dragging its dividing line.
Insert excerpt
_area_lock_

...

height
_area_lock_

...

height
nopaneltrue
Insert excerpt
_

...

delete
_

...

delete
nopaneltrue

When a specific component is selected, delete the component.

Delete options depend on the selected item, for example:

  • Delete Selected Objects
  • Delete Pane
  • Delete Form 

Insert excerpt
_

...

remove
_

...

remove
nopaneltrue
 Element

Remove the selected item from the screen, whilst leaving it in the repository.
Insert excerpt

...

_

...

element_

...

delete
_

...

element_

...

delete
nopaneltrue

...

Delete a screen element.
Insert excerpt
_

...

form_

...

new
_

...

form_

...

new
nopaneltrue
Create a new form in the current area.
Insert excerpt
_pin_unpin
_

...

pin_

...

unpin
nopaneltrue

...

Pin a

...

component

...

to fix its position; see Pinning and Unpinning.

Insert excerpt
_

...

palette
_

...

palette
nopaneltrue

...

Open the palette to drag in components.
Insert excerpt
_

...

autosize
_

...

autosize
nopaneltrue

...

Toggle whether or not the currently selected component is automatically auto sized when an application window is resized by the user.

Note

Using this option, or manually resizing a component may change the state of the Layout → Style Settings → Auto Size property.


Insert excerpt

...

_

...

align
_

...

align
nopaneltrue

...

Options to arrange the selected components:

Insert excerpt
_

...

align_

...

left
_

...

align_

...

left
nopaneltrue

...

: Align the left edges of all the selected components to the component that is furthest to the left.

Insert excerpt
_

...

align_

...

right
_

...

align_

...

right
nopanel

...

true
: Align the right edges of all the selected components to the component that is furthest to the right.

Insert excerpt
_

...

align_

...

top
_

...

align_

...

top
nopaneltrue

...

: Align the top edges of the selected components to the component that is positioned highest.

Insert excerpt
_

...

align_

...

bottom
_

...

align_

...

bottom
nopaneltrue

...

: Align the bottom edges of the selected components to the component that is positioned lowest.

Insert excerpt
_align_

...

horizontal
_align_

...

horizontal
nopaneltrue

...

: Equally distribute the selected components horizontally in the available space.

Insert excerpt
_

...

align_vertical

...

Toggle whether or not the currently selected component is automatically auto sized when an application window is resized by the user.

...

_align_vertical
nopaneltrue
: Equally distribute the selected components vertically in the available space.

Insert excerpt
_

...

repository_

...

find
_

...

repository_

...

find
nopaneltrue

...

Open the repository with to see the selected component in the list. This can be useful if you want to move a component.
Insert excerpt
_

...

screen_

...

properties
_

...

screen_

...

properties
nopaneltrue
Open the properties tab for the screen.
Insert excerpt
_

...

record_

...

show
_

...

record_

...

show
nopaneltrue

...

Display information about the table and its records.

Insert excerpt
_

...

mapping

...

_

...

mapping
nopaneltrue
Opens a new mapping element properties tab where you can map attributes with different names to components.
Insert excerpt
_

...

children
_

...

children
nopaneltrue
For the selected parent container, select all the child components.

Insert excerpt
_

...

table_

...

properties
_

...

table_

...

properties
nopaneltrue

or Show the Table Configuration

Open the properties for the table.

Insert excerpt
_

...

attributes_

...

show
_

...

attributes_

...

show
nopaneltrue

...

...

Show the list of attributes that are bound to the component. The attributes can be from a table or view. This is shown in the option:

  • Insert excerpt
    _

...

  • attributes_

...

  • show
    _

...

  • attributes_

...

  • show
    nopaneltrue

...

  •  for table <name>
  • Insert excerpt
    _

...

  • attributes_show
    _

...

  • attributes_show
    nopaneltrue

...

  •  for view <name>


HTML Comment

Unreachable Actions

A workflow can have placeholder actionflows linked to a screen. If the actionflow has not been wired then it is listed here.

Open on Startup

You may have a screen that acts as your application's welcome window. Use this option to open a screen whenever the application starts.

Insert excerpt
_check_box_

...

tick
_check_box_

...

tick
nopaneltrue

...

 to open the screen when the application starts.

Insert excerpt
_

...

check_box_

...

untick
_check_

...

box_

...

untick
nopaneltrue

...

Show the list of attributes that are bound to the component. The attributes can be from a stream or view. This is shown in the option:

...

 is the default. The screen is opened by a user interacting with the application. 


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


Learn More

For links to all pages in this topic, see Designing Screens.

Insert excerpt
_

...

terms_

...

changing
_

...

terms_

...

changing
nopaneltrue

...