Versions Compared

Old Version 94

changes.mady.by.user Fiona Sargeant (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Anthony George

Saved on

Key

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

Overview

This

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 

Drag-and-Drop Techniques

Splitting a Screen.

Properties

Insert excerpt
_property_toolbar
_property_toolbar
nopaneltrue

 The toolbar includes the button to 

Insert excerpt
_

dashboard

property_

display

tabs
_

dashboard_display

property_tabs
namebasic-h
nopaneltrue

.

Insert excerpt
_parent
_parent
nopaneltrue

Basic Settings

FieldDescription
NameThe name of the
dashboard
screen.
Open Maximised

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to open

the dashboard

the screen maximised.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to open the

dashboard

screen as a

pop-up

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

dashboard

screen.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to keep the

dashboard

screen size fixed when running in in 

Insert excerpt
_app_mode
_app_mode
nopaneltrue
.

This option does not affect resizing the

dashboard

screen in 

Insert excerpt
_design_mode
_design_mode
nopaneltrue
.

Show Toolbar
Insert excerpt
_design_mode
_design_mode
nopaneltrue
 always has a toolbar with the
dashboard
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

dashboard

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

dashboard

screen. This has a maximise/restore button and a close button.

Image Modified

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to have no Windows-style bar at the top of the

dashboard

screen.

Always On Top

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to keep the

dashboard

screen on top of other

dashboards

screens. This is useful for a

pop-up

popup window that you want a user to complete before returning to another

dashboard

screen.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 to allow other

dashboards

screens to be displayed in front. 

Keep Data

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to

allow dashboard

allow screen data to be referenced even after the

dashboard

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

dashboard

screen data is not required once the

dashboard

screen is closed.

Preload
Dashboards

screens , especially complex

dashboards

screens, can take some time to open, which can feel slow to the application user. Use this option when you need a

dashboard

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

dashboards

screens that an application user will always want to open.

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to preload

the dashboard

the screen when PhixFlow first starts.  When the user then opens the

dashboard

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

dashboard

screen does not need to be preloaded.

Preloading relates to the

dashboard

screen itself. Any data backing the

dashboard

screen is only loaded when the

dashboard

screen opens, and this may also take time to load.

Cache Locally

If an application user is likely to require the same

dashboard

screen in different stages of a task. Use this option so that, when the user closes and reopens the

dashboard

screen, it loads immediately. 

Insert excerpt
_check_box_tick
_check_box_tick
nopaneltrue
 to cache the

dashboard

screen on the application user's client computer when the

dashboard

screen first opens.

Insert excerpt
_check_box_untick
_check_box_untick
nopaneltrue
 is the default. The

dashboard

screen does not need to be cached.

Caching relates to the

dashboard

screen itself. Any data backing the

dashboard

screen will be reload each time the

dashboard

screen is opened.

Position

By default, new

dashboards

screens are set to Floating. If you want a

dashboard

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

dashboard

screen. This is useful for a navigation area or toolbar that you want to be visible for all other

dashboards

screens. Floating

dashboards

screens do not overlap with pinned

dashboards

screens. When the user maximises a Floating

dashboard

 screen, it expands only to the remaining space. 

Width

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

For

dashboards

screens that are not set to Open maximised, specify a

dashboard

screen height in pixels, for example 150px for a small confirmation window. The default size of a

pop-up dashboard

popup screen is approximately 500px. 

Top

Available when Position is Floating.

For

dashboards

screens that are not set to Open maximised, set an offset value in pixels to position the

dashboard

screen where it is required. For example, to display a

dashboard

screen as a

pop-up

popup window towards the top left of the screen, set:

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

Screen Elements

Dashboard 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 Screen Element for

the elements for a specific screen, open the 

Insert excerpt
_property_settings
_property_settings
nopaneltrue
available from the screen toolbar

. For more information on Screen Element and how to use them see: 

; see Screen Element.  

Menu Items

This section has a toolbar with standard buttons and:

  •  Image Modified Show
stream
  • 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

click 
  1. Click 
    Insert excerpt
    _add
    _add
    nopaneltrue
  2. Select 
    • either Add a new sub-menu
    • or Add a new menu item; see 
Menu
  2. PhixFlow opens a new properties tab for a menu item or sub-menu; see 
Menu
  1. 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

dashboard

screen, such as buttons or data-components, can have

actions

actionflows or

stream

record-

item

actions.

 Stream

 Record-

item

actions can take data from attributes in different

streams

tables  or views. Where the attributes have different names, you must map the attribute, so that

the stream

the record-

item

action

recognises

 recognises the data. This grid contains a list of mappings for the components on this

dashboard

screen. 

To configure a mapping, in the

dashboard

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

dashboard

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 stream-item

and record-actions that are linked to the

dashboard

screen.

Tip

Actions

and stream-item

and record-actions were the way to

configure dashboard

configure screen functionality before PhixFlow version 9.0.0; see Using Table-Actions and Record-Action

Insert excerpt
_

access

description
_

access

description
nopaneltrue

Insert excerpt
_

description

access
_

description

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

streams

tables for your application.

Insert excerpt
_screen_toolbar
_screen_toolbar
nopaneltrue
Open the repository showing the list of available
dashboards
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
dashboards
screens.
Insert excerpt
_property_settings
_property_settings
nopaneltrue
Open the properties tab for the
dashboard
screen.

Insert excerpt

_layout

_unlock

_layout

_unlock
nopaneltrue

or 

Insert excerpt
_

layout_

lock
_

layout_

lock
nopaneltrue

Unlock a

dashboard

screen to edit its layout.

Lock a

dashboard

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

Insert excerpt
_refresh
_refresh
nopaneltrue

Update the

dashboard

screen to reflect changes made elsewhere in PhixFlow, such as the

dashboard

screen properties, layer orders or shared styles.

Screen

Pop-up

Popup Menu

Right-click on a screen to display its

pop-up

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
_layout
_unlock
_layout
_unlock
nopaneltrue
Unlock a
dashboard
screen to edit its layout.
Insert excerpt
_layout
_lock
_layout
_lock
nopaneltrue
Lock a 
dashboard
screen to prevent accidental edits and to display the data content.
Insert excerpt
_context_parameters
_context_parameters
nopaneltrue
For
dashboards
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
dashboards
screens created in PhixFlow versions 8.3 and earlier, open the properties for the
dashboard
screen element.
Insert excerpt
_area_above
_area_above
nopaneltrue

Use these options to divide a

dashboard

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

.To remove a pane, use the pop-up menu options 

.

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_
delete
left
_
delete
area_left
nopaneltrue
 Pane.
Insert excerpt
_area_lock_
right
width
_area_
right
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_
below
height
_area_
below
lock_height
nopaneltrue
Insert excerpt
_
area_left
delete
_
area_left
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
_

area_lock_width

remove
_

area_lock_width

remove
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

 Element

Remove the selected item from the screen, whilst leaving it in the repository.
Insert excerpt
_
area
element_
lock_height
delete
_
area
element_
lock_height
delete
nopaneltrue
Delete a screen element.
Insert excerpt
_form_
delete
new
_
delete
form_new
nopaneltrue

When a specific component is selected, delete the component.

Other delete options that may be available relate to specific types of component in the selected pane
Create a new form in the current area.
Insert excerpt
_
delete
pin_
item
unpin
_
delete
pin_
item
unpin
nopaneltrue
 Delete options depend on the selected item. Examples are:

Pin a component to fix its position; see Pinning and Unpinning.

Insert excerpt
_

delete_item

palette
_

delete_item

palette
nopanel

true selected objects

true

Open the palette to drag in components.
Insert excerpt
_
delete_item
autosize
_
delete_item
autosize
nopaneltrue
 pane

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
_
delete_item
align
_
delete_item
align
nopaneltrue
 form 

Options to arrange the selected components:

Insert excerpt
_

element

align_

delete

left
_

element

align_

delete

left
nopaneltrue

Delete a dashboard element

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

Insert excerpt
_

form

align_

new

right
_

form

align_

newnopaneltrueCreate a new form in the current area

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

Insert excerpt
_

pin

align_

unpin

top
_

pin

align_

unpin

top
nopaneltrue

Pin a component to fix its position; see Pinning and Unpinning

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

Insert excerpt
_align_

palette

bottom
_align_

palette

bottom
nopaneltrue

Open the palette to drag in components

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

Insert excerpt
_align_

autosize

horizontal
_align_

autosize

horizontal
nopaneltrue

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

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

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

Insert excerpt
_

arrange

align_

components

vertical
_

arrange

align_

components

vertical
nopaneltrue

Options to arrange

: Equally distribute the selected components

within a pane:

vertically in the available space.

Insert excerpt
_

align

repository_

left

find
_

align

repository_

left

find
nopanel

true

true

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
_
align
screen_
right
properties
_
align
screen_
right
properties
nopaneltrue
Open the properties tab for the screen.
Insert excerpt
_
align
record_
top
show
_
align
record_
top
show
nopaneltrue

Display information about the table and its records.

Insert excerpt
_
align_bottom
mapping
_
align_bottom
mapping
nopanel
true
true
Opens a new mapping element properties tab where you can map attributes with different names to components.
Insert excerpt
_
distribute_horizontal
children
_
distribute_horizontal
children
nopaneltrue
Insert excerpt_distribute_vertical_distribute_verticalnopaneltrue
For the selected parent container, select all the child components.

Insert excerpt
_

repository

table_

find

properties
_

repository

table_

find

properties
nopaneltrue

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


or Show the Table Configuration

Open the properties for the table.

Insert excerpt
_

screen

attributes_

properties

show
_

screen

attributes_

properties

show
nopaneltrue

Open the properties tab for the dashboard.

...

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
    _
record
  • attributes_show
    _
record
  • attributes_show
    nopaneltrue
Display information about the stream and its stream-items.
  •      for table     <name>
  • Insert excerpt
    _attributes_
mapping
  • show
    _attributes_
mapping
  • show
    nopaneltrue
Opens a new mapping element properties tab where you can map attributes with different names to components. Insert excerpt_children_childrennopaneltrueFor the selected parent container, select all the child components
  •  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_

table

box_

properties

tick
_check_

table

box_

properties

tick
nopaneltrue

or Show the Stream ConfigurationOpen the properties for the stream

 to open the screen when the application starts.

Insert excerpt
_

attributes

check_box_

show

untick
_check_

attributes

box_

show

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:

Insert excerpt_attributes_show_attributes_shownopaneltrue for stream <name> Insert excerpt_attributes_show_attributes_shownopaneltrue for view <name> HTML Comment

Unreachable Actions

A workflow can have placeholder actionflows linked to a dashboard. 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_ticknopaneltrue to open the screen when the application starts

 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
_

check

terms_

box_untick

changing
_

check

terms_

box_untick

changing
nopaneltrue

 is the default. The screen is opened by a user action within the application.