Dashboard control array: Application automation features (AAF)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Help / Developing an application or website / Controls, windows and pages / Controls: Available types / Dashboard control

Overview
AAFs in the Windows applications
Overview
Features of the context menu
Edit mode in the Dashboard control
AAF in the WEBDEV websites
AAFs in the Mobile applications
Switching to Edit mode
Edit mode toolbar
Exit the Edit mode
Moving a widget
Resizing a widget
Adding a widget

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Dashboard control array: Application automation features (AAF)

Overview

The Dashboard control proposes several Automatic Application Features (AAF) allowing the user to benefit from all control capabilities. These features are available for Windows applications, the WEBDEV websites and the Mobile applications.

AAFs in the Windows applications

Overview

By default, the Dashboard control proposes to the user to:

Switch to edit mode: edit mode allows users to configure their array.
Save the content of Dashboard control in image format.

When users switch to "Edit" mode, they can configure the different elements in the dashboard:

It is possible to:

hide an element,
add an invisible element,
restore the initial configuration.

The edit mode can also be used to modify the position and size of elements.

Features of the context menu

Save as (image): Saves the contents of the Dashboard control as an image (for printing, for example).
Edit mode: This feature enables the user to enter edit mode and configure his or her array.

Edit mode in the Dashboard control

The following options are available in the context menu of the Edit mode:

Add: This option opens a sub-menu displaying a list of invisible Widgets that can be added.
Hide: This option hides the current Widget..
Restore initial configuration: This option returns the array to the state it was in before the changes were made in edit mode.. All the modifications performed (size, position, hiding, addition) are canceled.

The Edit mode can be configured programmatically:

DashMode can be used to:
- know whether the Edit mode is enabled,
- enable or disable the Edit mode,
- configure the available actions in Edit mode. You can for example allow the widgets to be moved and resized only.
Using AAFDisable with the aafDashEditMode constant disables the context menu used to switch to edit mode.

AAF in the WEBDEV websites

By default, the Dashboard control proposes to the user a context menu used to:

Switch to edit mode: This function switches to edit mode, allowing the user to configure his or her array..
Restore initial configuration: This option restores the array to the state it was in before the changes were made in edit mode.. All the modifications performed (size, position, hiding, addition) are canceled.
To display or not the different Widgets: Simply check or uncheck the name of the Widget to be displayed..

When users switch to "Edit" mode, they can change the size and position of the elements in the dashboard. The Edit mode can be configured programmatically:

DashMode can be used to:
- know whether the Edit mode is enabled,
- enable or disable the Edit mode,
- configure the available actions in Edit mode. You can for example allow the widgets to be moved and resized only.

AAFs in the Mobile applications

Switching to Edit mode

To enter in edit mode in a Dashboard control, a long press must be performed on the control background or on a widget. A micro vibration is triggered (haptic feedback).

If a Widget is long-pressed, the Widget is selected: sizing handles are displayed on all four edges of the Widget.

Warning: If the long press is performed on a field inside a Widget and this field intercepts the long press (code in long press processing, display of a context menu, etc.), the Dashboard control does not switch to edit mode.

In Edit mode:

Selecting a widget is performed via a simple click on the widget.
The controls displayed in the widgets no longer receive the click events and they can not gain focus anymore.
If at least one widget is displayed on the last dashboard row, an additional row is added in edit mode (with activation of the vertical scrollbar if necessary). This row is used to add new widgets or to move existing widgets.
A specific toolbar is displayed. For more details, see Edit mode toolbar.
It is possible to:

Note: The DashMode function allows you to:

switch to "Edit" mode programmatically. To prevent the user from switching to edit mode (long click without effect), use AAFDisable with the aafDashEditMode constant.
disable some features in the Dashboard control (as well as in the bar of the Edit mode).

Edit mode toolbar

When the Dashboard control switches to edit mode, a toolbar is displayed in the lower section of control. This toolbar is displayed in semi-transparency above the dashboard widgets.

This toolbar includes three buttons:

"Reset" Button: restores the dashboard's initial configuration
Button "OK": allows exit from edit mode.
Trash button: hides the selected Widget with a single click. You also have the ability to perform a Drag and Drop of a widget on the button in order to hide this widget (a micro vibration is performed when hovering the bin with the widget to hide).

Note: Text color and strikethrough are configurable in the Dashboard control style. The color of the icon for the bin button corresponds to the text color.

Note: If the DashMode function prohibits the deletion of Widgets, the trash button is not displayed in the toolbar.

Exit the Edit mode

You can use multiple methods to exit the Edit mode in the Dashboard control:

Click the background of Dashboard control.
Click the OK button displayed in the toolbar of the Edit mode.
Press the "back" key of the phone.

Moving a widget

To move a widget:

If the Widget is not selected: long press on the Widget. A ghost view of the widget to move is automatically created.
If the Widget is selected: simply press the pointer over the selected Widget. A ghost view of the widget to move is automatically created.

During the move, the sizing handles of selected widget are not drawn.

When the widget is moved onto a cell containing another widget, the second widget is moved onto the first free location and it goes back to its initial location as soon as the moved widget does not hover it anymore. The move of hovered widgets is performed with an animation.

Resizing a widget

To resize a widget, you must:

keep the pointer down on one of the widget borders (the one that displays the sizing handles).
and move the pointer in the requested direction.

A widget cannot be resized horizontally and vertically at the same time.

During the resize operation, only the handle found on the border on which the pointer was pressed down is displayed.

The widgets that occupy the cells on which the widget is enlarged are automatically moved with an animation onto the first free location. They go back to their initial location if the widget is reduced.

Adding a widget

In Edit mode, a "+" sign is displayed in the middle of empty cells (with the same color as the border of the widgets in Edit mode).

A click on an empty cell opens a context menu with the list of widgets to add.

If all the dashboard widgets are displayed, the "+" sign is not displayed and a click on an empty cell allows you to exit Edit mode.

Note: When moving and resizing a Widget, the "+" sign is not drawn in empty cells.