This chapter is about adding functionality and features to a screen.

For example, open a document on button click, calculate values after user input or log user changes, like when and who edited the record the last time. Of course, there are many more actions which we will look at in detail below.

VisionX allows this very easily via events and actions.

The chapter is divided into the following sections:

• Basics
• Events
• Actions
• Formulas
• Parameter
• List of events
• List of actions
• List of conditions
• List of formulas

Let's start with the basics.

Events define when something happens and actions what happens.

In the previously mentioned examples events are click on a button ('create action'), user input ('row value changed') or data change ('after updating row').

The equivalent actions are open a document ('show file'), calculate values ('calculate value') and update modified values ('set value').

Let's have a closer lock on events. In order to add an action you must first think of the event which will trigger the action.

Screens, Tabsets, Editing Panels, Tables, Input Fields, Buttons and Hyperlinks have a lot of different events. A List of all these events and their description is provided below (see List of events).

If you open the customizer with a right click on an element, a list of all possible events is displayed.

After selecting the desired event, the action wizard will be opened.

For example, if you want to show an uploaded image on button click you have to open the customizer with a right click on the button (1).

At the bottom of the customizer a list of all possible events is displayed (2).

If you click on one of the events, the edit action wizard is opened.

In the edit action wizard, you have 3 different tabs.

In the first tab 'Description' (1) you can describe the functionality of the element.

This description will be added in the documentation (Help or Specification) which can be generated in VisionX.

The description will also be used as documentation directly in the generated source code.

The second tab 'Action' (2) offers the possibility to create or edit the actions.

When you are an advanced user, it is possible to edit the source code directly. This can be done in the tab 'Source Code' (3). The changes must be validated too.

For each action an example of the generated java code is provided, which can also be inserted or edited directly in the source code tab.

In this tab you can configure the actions.

The action and the needed parameters are called 'Command' (1).

For example 'show file' with the parameters 'Filename' and 'Content' is a command.

A command is one of 3 possible statements (2).

The statements are 'Command', 'Condition' and 'Repeat'.

Statements can be selected and combined as often as desired.

The configured statements can be checked using 'Validate'. (3) The wizard remains open and changes can still be made.

With 'Finish' (4) the generated code is also checked, applied and the wizard is closed.

'Cancel' (4) discards all changes and closes the wizard.

It is possible to add more than one statements to an event.

To add another statement it must be dragged from the statement block and dropped into the existing list of statements in the appropriate order.

Therefore, you can select and drag the statement out from the right box (1) into the list of actions.

The black line indicates where the statement will be placed (2).

It is also possible to change the order of the statements.

To do this, move the mouse pointer to the left over the statement and start the move mode as already described for adding a new statement.

A statement can be deleted using the red cross to the right of the statement.

It's also possible to delete all statements of an event. Therefore you must click the red cross next to the event.

By default, an empty command is added in the wizard and you can select the appropriate action.

Let's look at our example 'show file'.

The action 'show file' for example, opens the selected file stored in a data table.

This action needs two parameters which you need to select from the corresponding table. The first one is the filename and the second the file itself.

Now let's look at conditions. With conditions it's possible to perform an action only if a certain condition is met.

Therefore, you must drag a condition out of the right statement box (1).

Now you can define the condition when the action has to be performed.

For example, if a file was uploaded (2) no action is performed, if a file was uploaded the file is displayed (3).

It's also possible to perform an action for each row in a table.

Therefore, you must drag a repeat statement out of the statement box on the right side (1).

Now you can decide for which table the action should be performed (2).

In this example an email is sent to each contact stored in the table (3).

After an event has been configured, it still needs to be validated.

The configured statements can be validated using 'Validate'. (1) The wizard remains open and changes can still be made.

With 'Finish' (2) the generated code is also validated, but applied and the wizard is closed.

'Cancel' (2) discards all changes and closes the wizard.

There are two possible ways to search for actions.

The first option is to open the drop down box in the action wizard and enter a search term.

For example, if you search for 'value' only actions with the term 'value' are displayed.

The second possibility is to open the search wizard (1) with the button '…' (2) next to the dropdwonbox.

You can either search for a term (1) or filter all actions by category (2). It's also possible to combine both.

If an action is selected all required parameters and a short description are displayed below.

In the customizer you can see if actions are configured and it's possible to delete or edit them.

Events with attached actions are now renamed to 'edit …' (1) on click the action wizard is opened and shows the actions.

With the red cross next to the event you can delete all defined statements (2).

Events with no action are still named 'create….' (3).

A number of actions can include the use of formulas.

These actions can be recognized by the fact that the parameter input field is marked with “Formula”, which are:

• Calculate value
• Set label with calculated currency
• Set label with calculated date
• Set label with calculated date short
• Set label with calculated date time
• Set label with calculated date time short
• Set label with calculated time
• Set label with calculated value
• Set Parameter with calculated value

There are lots of arithmetic operations, group functions, date calculation and text operations available.

A forumla is directly written in the formula field of an action.

For a list of possible formulas see List of formulas

Parameters can be used to temporarily store values and reuse them within the screen or pass parameters to a screen.

When the screen is closed, the parameter and the corresponding value are no longer available.

There are the following actions to set or calculate parameters:

• Set Parameter
• Set Parameter with calculated value
• Set Parameter with concatenated text

This event is triggered if the screen is initialized. As long as the screen is not closed and reopened this event will not be executed again.

In this event everything should be implemented that influences the screen directly. For example, hide elements due to roles, control access to tables (edit, update, delete), set filters…

This event is triggered each time the screen gets active.

For example, if you open the screen or activate the screen through an action from another screen or through a menu.

For example, if ID parameters are passed to the screen, they will be used in this action.

This event is triggered short before the screen is closed.

With this event it is possible to prevent the closing throug an exception.

If a tab of a tabset is activated this event is triggered.

Every time a value of the selected table is changed, this event is triggered. The event is triggered when the input field is deselected.

Hint: With this action you can create a log that saves any user changes. For more information see

It is good practice to add changed_on, created_on table columns for all relevant tables.

Is triggered before a row in a table is selected.

Is triggered after a row in a table was selected.

Is triggered before the data row is inserted in the memory.

Is triggered after the data row is inserted in the memory.

Is triggered before the data row is inserted in the database.

Is triggered after the data row is inserted in the database.

Is triggered before the data row is updated in the memory.

Is triggered after the data row is updated in the memory.

Is triggered before the data row is updated in the database.

Is triggered after the data row is inserted in the database.

Is triggered before the data row is deleted from the memory.

Is triggered after the data row is deleted from the memory.

Is triggered before the data row is deleted from the database.

Is triggered after the data row is deleted from the database.

If the action Restore selected record is executed, this event is triggered before restoring the row.

The data is taken from the memory and no database query is performed.

If the action Restore selected record is executed, this event is triggered before restoring the row.

The data is taken from the memory and no database query is performed.

If any reload action is executed, this event is triggered before reloading the selected row.

The data is fetched from the database.

If any reload action is executed, this event is triggered after reloading the selected row.

The data is fetched from the database.

This event is triggered every time the button / hyperlink is clicked.

This event is triggered every time the validator is used.

The current user is logged out.

((ProjX)getApplication()).doLogout(null);

Discards all unsaved changes and reloads all screens.

((ProjX)getApplication()).doReload();

Shows a message in an error dialogue.

showError(this,Text.val(new Var(rdbContacts,"LASTNAME")) + " is missing!");

Shows a message in an information dialogue.

showInformation(this,Text.val(new Var(rdbContacts,"LASTNAME")) + " is missing!");

Cancels current execution without showing a message.

throw new SilentAbortException();

Shows an 'are you sure…' question before deleting a record within the selected table.

ProjXUtil.addAskDeleteDialog(rdbContacts);

Assigns the column name where data should be stored.

editContactsStreet.setColumnName("STREET");

Assigns the table which should be used for displaying data. If a table has been dragged into a screen, it can be replaced by another table.

tableContacts.setDataBook(rdbProfessions);

Assigns the table which should be used for displaying data of an editor .

Hint: For example, a search field can be assigned to another table that will be searched.

filterCustomers.setDataRow(rdbContacts);

Calculates a value based on dynamic or fixed data and sets the result into a column (see List of Formulas. The value can be calculated with any values from other tables, with parameters or specific texts.

Calc.set(new Var(rdbProducts,"TOTAL"),Calc.val(new Var(rdbProducts,"PRICE")) * Calc.val(new Var(rdbProducts,"QUANTITY")));

Creates a unique identifier and sets the value into a selected column.

DataBookUtil.createUniqueIdentifier(new Var(rdbProducts,"PRODUCT_KEY"));

Deletes all records in the selected table.

rdbProducts.deleteAllRows();

Deletes the selected/current record in the selected table.

rdbProducts.deleteAllRows();

In the selected table no row is selected, when a row is selected, it is deselected.

rdbProducts.setSelectedRow(-1);

Disables automatic deletion of sub records in the selected table.

rdbProducts.setDeleteCascade(false);

Disables deletion of records in the selected table.

rdbProducts.setDeleteEnabled(false);

Disables editing of records in the selected table.

rdbProducts.setUpdateEnabled(false);

Disables creating of records in the selected table.

rdbProducts.setInsertEnabled(false);

Disables all manipulation (insert, edit, delete) of records in the selected table.

rdbProducts.setReadOnly(true);

Disables fetching data from server (no database query is performed).

rdbContacts.setFetchEnabled(false);

Disables record lock an reload of current record before start editing.

rdbProducts.setLockAndRefetchEnabled(false);

Disables search in memory, the data is fetched form the server (a database query is performed).

rdbProducts.setMemFilter(false);

Disables sort in memory, the data is fetched form the server (a database query is performed).

rdbProducts.setMemSort(false);

Disables sending changed records to the database.

rdbProducts.setWritebackEnabled(false);

Duplicates the selected record.

DataBookUtil.copySelectedRow(rdbProducts);

Hint: The old record remains selected.

Enables automatic deletion of sub records in the selected table.

rdbProducts.setDeleteCascade(true);

Enables deletion of records in the selected table.

rdbProducts.setDeleteEnabled(true);

Enables editing of records in the selected table.

rdbProducts.setUpdateEnabled(true);

Enables creating of records in the selected table.

rdbProducts.setInsertEnabled(true);

Enables all manipulation (insert, edit, delete) of records in the selected table.

rdbProducts.setReadOnly(false);

Enables fetching data from server (database query is performed).

rdbContacts.setFetchEnabled(true);

Enables record lock an reload of current record before start editing.

rdbProducts.setLockAndRefetchEnabled(true);

Enables search in memory, the data is not fetched form the server (no database query is performed).

rdbProducts.setMemFilter(true);

Enables sort in memory, the data is not fetched from the server (a database query is performed).

rdbProducts.setMemSort(false);

Enables sending changed records to the database.

rdbProducts.setWritebackEnabled(true);

Loads all available records of the selected table.

rdbContacts.fetchAll();

Hint: This command is used to ensure that all rows of a table/view are loaded and displayed (e.g., to search for specific entries)

Inserts a new record in the selected table after the currently selected record.

rdbContacts.insert(false);

Inserts a new record in the selected table before the currently selected record.

  rdbContacts.insert(true);

If the data element tree is added to the screen it is possible to create a sub record at the current position in the tree.

  tree1.doInsertSub();

Makes a value unique.

It is checked whether this value already exists in the table column. If yes, then the value is extended by a numbering. For example, if the value 'XXX' is entered but already exists, the value is changed to 'XXX - 2'.

DataBookUtil.makeValueUnique(new Var(rdbProducts,"PRODUCT_KEY"));

Discards all unsaved changes and reloads all records of the selected table.

rdbContacts.reload();

Hint: This action can be used to query changes from other users or made in other screens and update the opened screen.

This action can be used to restore the original selection in a table after a number of operations. The selected row must be stored before.

Hint: This action works only within the same action as 'Store selected record'.

For example: - store selected record - loop through all records of the table - restore selected record

DataBookUtil.restoreSelection(rdbContacts);

Saves all changes in the selected Table.

rdbContacts.saveAllRows();

Hint: This action can be used to save changes using a “Save” button.

The filter works like Search by value, but in case of a drop down in search mode “equals”, you don't search by the displayed value (e.g. “Mr.”) but by the id (e.g. 1).

This can improve the performance in some cases.

filterContacts.setValue("Mr.");

Sets the value of a search element.

It's possible to set a value or use column values, element values, parameters or combine all of them.

filterContacts.setDisplayValue(Text.val(new Var(rdbContacts,"FIRSTNAME")) + " " + Text.val(new Var(rdbContacts,"LASTNAME")));

Selects the first record of the selected table.

DataBookUtil.selectFirstRow(rdbCustomers);

Selects the last inserted record in the selected table.

DataBookUtil.selectLastInsertedRow(rdbCustomers);

Selects the last record of the selected table.

DataBookUtil.selectLastRow(rdbCustomers,false);

Selects the next record of the selected table. The cycle option enables you to jump from the last to the first record.

DataBookUtil.selectNextRow(rdbCustomers,true);

Selects the previous record of the selected table. The cycle option enables you to jump from the first to the last record.

DataBookUtil.selectPreviousRow(rdbCustomers,true,false);

Selects the first record that contains the specific value.

DataBookUtil.selectRowHavingValue(new Var(rdbCustomers,"COMPANY_NAME"),"XYZ");

Sorts the selected table ascending by the given column.

rdbContacts.setSort(new SortDefinition(true,"LASTNAME"));

If a new table row with filled default values is added.

rdbContacts.getRowDefinition().getColumnDefinition("SALU_SALUTATION").setDefaultValue("Mrs.");

The selected column of the table is set editable.

Hint: This action sets both the column in the table as well as the associated editor editable!

If the column should not be editable you have to use the action 'Set column readonly'.

DataBookUtil.setColumnEditable(new Var(rdbContacts,"FIRSTNAME"));

Changes the header label of a table column.

rdbContacts.getRowDefinition().getColumnDefinition("SALU_SALUTATION").setLabel("Salutation");

Sets a column of a table mandatory.

Hint: This action sets both the column in the table as well as the associated editor mandatory!

rdbContacts.getRowDefinition().getColumnDefinition("SALU_SALUTATION").setNullable(false);

Sets a column of a table not mandatory.

Hint: This action sets both the column in the table as well as the associated editor not mandatory!

rdbContacts.getRowDefinition().getColumnDefinition("LASTNAME").setNullable(true);

A selected column is excluded from the search.

rdbContacts.getRowDefinition().getColumnDefinition("LASTNAME").setFilterable(false);

It is no longer possible to sort the selected column in the header.

rdbContacts.getRowDefinition().getColumnDefinition("LASTNAME").setSortable(false);

Sets a selected column readonly.

Hint: This action sets both the column in the table as well as the associated editor readonly!

DataBookUtil.setColumnReadOnly(new Var(rdbContacts,"EMAIL"));

A selected column is included in the search.

rdbContacts.getRowDefinition().getColumnDefinition("LASTNAME").setFilterable(true);

The selected column can be sorted in the header.

rdbContacts.getRowDefinition().getColumnDefinition("LASTNAME").setSortable(true);

Changes the width of a selected table column.

Hint: This action works only in the onLoad event of the screen.

rdbContacts.getRowDefinition().getColumnDefinition("LASTNAME").setWidth(200);

The current time and date are written to the selected table column.

Hint: This action can be used to pre-fill all date columns with the current date. With this action it's also possible to create a log that shows when a record was added or changed. It is good practice to add changed_on, created_on table columns for all relevant tables!

Text.set(new Var(rdbContacts,"BIRTHDAY"),new Date());

Sets the current username into a selected column

Text.set(new Var(rdbContacts,"BIRTHDAY"),new Date());

Hint: When you start VisionX you are logged in as VisionX user. With this user no user is set. To change the user there is a button “Switch User” at the bottom right. Here you can choose if you want to use the VisionX user or one of the actual application users managed in the user management. It's also possible to Logout and Login (Button in the top navigation) as application user.

With this action it's also possible to create a log that shows who added or changed a record. It is good practice to add changed_by, created_by table columns for all relevant tables!

Sorts the selected table descending by the given column.

rdbContacts.setSort(new SortDefinition(false,"LASTNAME"));

Calculates a value based on dynamic or fixed data, rounds the result to 2 decimal places and set it as label.

The value can be calculated with any values from other tables, with parameters or specific texts (see List of Formulas).

Calc.setText(labelTotalPrice,Calc.val(new Var(rdbOrderdetails,"UNIT_PRICE")) * Calc.val(new Var(rdbOrderdetails,"QUANTITY")) * Calc.val(new Var(rdbOrderdetails,"DSICOUNT")),"#,##0.00");

Calculates a date value and set it as label.

The value can be calculated with any date values from other tables or with parameters (see Date group functions).

Example: January 1, 2001

  Calc.setDateText(labelLabel,Calc.addYears(Calc.val(new Var(rdbContacts,"BIRTHDAY")),1));

Calculates a date value, formats it as date short and set it as a label.

The value can be calculated with any date values from other tables or with parameters (see Date group functions).

Example: 1/1/2001

  Calc.setDateShortText(labelLabel1,Calc.addYears(Calc.val(new Var(rdbContacts,"BIRTHDAY")),1));

Calculates a date value, formats it as date and time and set it as a label.

The value can be calculated with any date values from other tables or with parameters (see Date group functions).

Example: Januara 1, 2000, 6:00 AM

  Calc.setDateTimeText(labelLabel,Calc.addHours(Calc.val(new Var(rdbContacts,"BIRTHDAY")),5));

Calculates a date value, formats it as date time short and set it as a label.

The value can be calculated with any date values from other tables or with parameters (see Date group functions).

Example: 1/1/2000, 6:00 AM

  Calc.setDateTimeShortText(labelLabel1,Calc.addYears(Calc.val(new Var(rdbContacts,"BIRTHDAY")),1));

Calculates a date value, formats it as date and time short and set it as a label.

The value can be calculated with any date values from other tables or with parameters (see Date group functions).

Example: 6:00 AM

  Calc.setTimeText(labelLabel,Calc.addHours(Calc.val(new Var(rdbContacts,"BIRTHDAY")),5));

Calculates a value based on dynamic or fixed data and sets the result as label text. The value can be calculated with any values from other tables, with parameters or specific texts (see List of Formulas).

Calc.setText(labelTotalPrice,Calc.val(new Var(rdbOrderdetails,"UNIT_PRICE")) * Calc.val(new Var(rdbOrderdetails,"QUANTITY")) * Calc.val(new Var(rdbOrderdetails,"DSICOUNT")),null);

Sets the number of records which will be loaded initially.

rdbContacts.setReadAhead(10);

Sets the current username as the value of a search element.

This action can be used to restrict access to information according to user roles. For example: * Administrator is able to see everything, no filter * Staff member can only see their own datasets, filtered by username

Hint: When you start VisionX you are logged in as VisionX user. With this user no filter is set. To change the user there is a button “Switch User” at the bottom right. Here you can choose if you want to use the VisionX user or one of the actual application users managed in the user management. It's also possible to Logout and Login (Button in the top navigation) as application user.

filterContacts.setValue(getConnection().getUserName());

Sets the current/selected column.

rdbContacts.setSelectedColumn("LASTNAME");

Sets the current/selected row number.

rdbContacts.setSelectedRow(2);

Hint: The row numbers start at 0 and not at 1. For example, the row numbered 2 is the 3rd row in the table.

Sets a value into a column. The value can be any text, value from another table or a parameter.

DataBookUtil.set(new Var(rdbContacts,"EMAIL"),rdbCustomers.getValue("EMAIL"));

Hint: This command can be used to copy values (text, date, numerical) from one table column to another. E.g.: [Contacts.Email] = [Customers.email]. As a result, the email of the customers table is copied to the email of the contacts table.

Sets a concatenated text into a column. The text can contain values from other tables, from parameters and any texts.

Text.set(new Var(rdbCustomers,"NAME"),Text.val(new Var(rdbContacts,"LASTNAME")) + ", " + Text.val(new Var(rdbContacts,"FIRSTNAME")));

Hint: This command can be used to populate text columns with fixed text or values from other columns. In the example below, the value from “Lastname”, the fixed text “, ” (comma + space) and the value from “Firstname” is written to the column “Name”: “Doe, John”.

Stores the currently selected row in the selected table, to enable selection of that row at a later time.

Hint: You can restore a stored selected record only within the same action.

For example: - store selected record - loop through all records of the table - restore selected record

DataBookUtil.storeSelection(rdbContacts);

Logs a debug message. The message can be a text, column value, a filter value, a parameter or a combination of all.

debug(rdbContacts.getValue("EMAIL"));

Logs an error message. The message can be a column value, a filter value or a parameter.

error(rdbContacts.getValue("EMAIL"));

Logs an info message. The message can be a column value, a filter value or a parameter.

info(rdbContacts.getValue("EMAIL"));

Prints a message to the console.

System.out.println((String)rdbCustomers.getValue("EMAIL"));

Downloads the selected file. The file can be saved to a local hard drive and then opened.

ProjXUtil.downloadFile(this,(String)rdbContacts.getValue("FILENAME"),rdbContacts.getValue("IMAGE"));

Downloads the selected, previously created, report. The report can be saved on a local hard drive and then opened.

getApplication().getLauncher().saveFileHandle(getListReportContacts());

Imports the selected report. All of the report's data is imported to the relevant rows and fields of the screen. If Merge is selected, only changed, deleted or new data is imported. Data that already exists is not added. If Insert is used, all data rows, including existing rows (tested for similarity) are transferred.

This functionality is only available for XLSX (Excel) and XML reports that were created with VisionX. Of course, the report templates can be edited. This is command is used to import offline forms into the application.

merge:
ProjXUtil.importFile(this,"/reports/screens/NeuWorkScreen$ContactsList.xlsx",true);
 
insert:
ProjXUtil.importFile(this,"/reports/screens/NeuWorkScreen$ContactsList.xlsx",false);

Removes a file or report from the selected record. The columns in which the filename and the content was stored must be specified.

ProjXUtil.deleteFile(new Var(rdbContacts,"FILENAME"),new Var(rdbContacts,"IMAGE"));

Saves the specified report in a table. The save location is defined via two parameters: The report's file name is saved in a text column of the table; the file itself is saved in the current record of a table column of the type Image or File.

ProjXUtil.storeFileHandle(new Var(rdbContacts,"REPORT_NAME"),new Var(rdbContacts,"REPORT_FILE"),getListReportContacts());

Shows the selected file. The file is either displayed in a browser or opened using the relevant program (e.g. Word, Excel), depending on how the PC is configured.

ProjXUtil.showFile(this,(String)rdbContacts.getValue("FILENAME"),rdbContacts.getValue("IMAGE"));

Shows the specified report. The report is either displayed in a browser or opened using the relevant program (e.g. Word, Excel), depending on how the PC is configured.

getApplication().getLauncher().showFileHandle(getListReportContacts());

Saves a file in the current record. The name of the uploaded file is saved in a text column; the file itself is saved in a column of type Image or File.

ProjXUtil.showFile(this,(String)rdbContacts.getValue("FILENAME"),rdbContacts.getValue("IMAGE"));

Disables header sorting by click in the header columns.

tableContacts.setSortOnHeaderEnabled(false);

Enables header sorting by click in the header columns.

tableContacts.setSortOnHeaderEnabled(false);

Hides the 'delete record' button in the table view.

tableContacts.setDeleteVisible(false);

Hides the 'duplicate record' button in the table view.

tableContacts.setDuplicateVisible(false);

Hides the 'edit record' button in the table view.

tableContacts.setEditVisible(false);

Hides the 'export' button in the table view.

tableContacts.setExportVisible(false);

Hides the 'insert new record' button in the table view.

tableContacts.setInsertVisible(false);

Hides the 'search record' button in the table view.

tableContacts.setSearchVisible(false);

It is possible to search directly in a table view. If such a search was performed, this action can be used to disable the search restriction. 'Enable Search button' restores the restriction by the search terms.

tableContacts.setSearchEnabled(false);

Hides the focus style of the selected cell in the table view. A selected cell has no additional frame. The cell looks unselected.

tableContacts.setShowFocusRect(false);

Hint: This action does not work in the web application

Hides the horizontal and vertical gridlines in the table view.

tableContacts.setShowGridLines(false);

Hides the horizontal lines in the table view.

tableContacts.setShowHorizontalLines(false);

Disables highlighting of the selected record in the table view.

tableContacts.setShowSelection(false);

Hides the navigation toolbar for the selected table view.

tableContacts.setToolBarVisible(false);

Hides the vertical lines in the table view.

tableContacts.setShowVerticalLines(false);

Sets the maximum row height of a table view.

tableContacts.setMaxRowHeight(30);

Hint: The height of the header line is not changed.

Sets the minimum row height of a table view.

tableContacts.setMinRowHeight(30);

Hint: The height of the header line is not changed.

Set the row height of a table view.

tableContacts.setRowHeight(50);

Hint: The height of the header line is not changed.

Defines in which column the sort order is stored as a numerical value. The sorting starts at 0 and the table view is sorted by this column. In the table view navigation, there are two new buttons 'move up' and 'move down' to move a record up or down in the sort order.

tableContacts.setSortOrderColumnName("SORTING");

Shows the 'delete recored' button in the table view.

tableContacts.setDeleteVisible(true);

Shows the 'duplicate record' button in the table view.

tableContacts.setDuplicateVisible(true);

Shows the 'edit record' button in the table view.

tableContacts.setEditVisible(true);

Shows the 'export' button in the table view.

tableContacts.setExportVisible(true);

Shows the 'insert new record' button in the table view.

tableContacts.setInsertVisible(false);

Hides the 'search record' button in the table view.

tableContacts.setSearchVisible(true);

It is possible to search directly in a table view. If such a search was performed and disabled, this action can be used to enable the search restriction again. The table view is now again filtered according to the previously entered search terms.

tableContacts.setSearchEnabled(true);

Shows the focus style of the selected cell in the table view. A selected cell has an additional frame.

tableContacts.setShowFocusRect(true);

Shows the horizontal and vertical gridlines in the table view.

tableContacts.setShowGridLines(true);

Shows the horizontal lines in the table view.

tableContacts.setShowHorizontalLines(true);

Disables highlighting of the selected record in the table view.

tableContacts.setShowSelection(false);

Shows the navigation toolbar for the selected table view.

tableContacts.setToolBarVisible(true);

Shows the vertical lines in the table view.

tableContacts.setShowVerticalLines(true);

Calls a server action or a stored procedure from the database. The parameters of this action are different, depending on which server action is selected. 'sendMail' for example has the following parameters: pFrom, pTo, pSubject, pText, pFileName, pContent

getConnection().callAction("doCommit");

Opens an Website in a web browser.

Hint: Depending on the browser settings you may have to allow the pop up the first time.

getApplication().getLauncher().showDocument("https://www.sibvisions.com/",null,"_blank");

Converts the given contact information into a QR code and saves it in the selected image column. Parameters can be left empty.

QRUtil.setContact(getConnection(),new Var(rdbContacts,"QR"),(String)getParameter("name"),"",(String)rdbContacts.getValue("ACTI_ACADEMIC_TITLE"),"",(String)rdbContacts.getValue("EMAIL"),(String)getParameter("address"),"",(String)rdbContacts.getValue("DESCRIPTION"));

Hint: If several columns should be merged into one text, this is possible via parameters. Before the action a parameter can be set and this can be used in the action. For more information see 'Set Parameter', 'Set Parameter with concatenated text', 'Set Parameter with calculated value'.

Converts the E-Mail address into a QR code and saves it in the selected image column.

QRUtil.setEMail(getConnection(),new Var(rdbContacts,"QR"),(String)rdbContacts.getValue("EMAIL"));

Converts the given location into a QR code and saves it in the selected column.

QRUtil.setGeoLocation(getConnection(),new Var(rdbContacts,"QR"),"48.24669129999999","16.3798883",null);

Converts the given phone number into a QR code and saves it in the selected image column.

QRUtil.setPhoneNumber(getConnection(),new Var(rdbContacts,"QR"),"+43 1 934 6009 0");

Converts the given text into a QR code and saves it in the selected image column.

QRUtil.setText(getConnection(),new Var(rdbContacts,"QR"),"VisionX");

Sends an email message using the application settings. One file can be attached. Before this action can be used, the mail server must be configured under Settings → E-Mail. The needed Parameters are: Server, Port, TLS Username, Password Default Sender Default Html

Hint: Filename and data can be left empty if no attachment is to be sent.

getConnection().callAction("sendMail","application.email@test.com",(String)rdbContacts.getValue("EMAIL"),"Subject","Dear " + Text.val(new Var(rdbContacts,"FIRSTNAME")) + " "+ Text.val(new Var(rdbContacts,"LASTNAME"))+ ",\nthis is the body of the e-mail.",(String)rdbContacts.getValue("REPORT_NAME"),rdbContacts.getValue("REPORT_FILE"));

This action can be used if you want to send from another server than defined in the application settings. It's possible to use TLS encryption. No HTML only plain text is possible. One file can be attached.

Hint: Filename and data can be left empty if no attachment is to be sent.

If you want to use more than one server you can store the connection details in a server table, filter the table before sending and then you can use the table information.

getConnection().callAction("sendMail","host","25","Username","Password",Boolean.TRUE,Boolean.FALSE,"application.email@test.com",(String)rdbContacts.getValue("EMAIL"),"Subject","Dear " + Text.val(new Var(rdbContacts,"FIRSTNAME")) + " "+ Text.val(new Var(rdbContacts,"LASTNAME"))+ ",\nthis is the body of the e-mail.",(String)rdbContacts.getValue("REPORT_NAME"),rdbContacts.getValue("REPORT_FILE"));

This action can be used if you want to send from another server than defined in the application settings. It's not possible to use TLS encryption. No HTML only plain text is possible. One file can be attached.

Hint: Filename and data can be left empty if no attachment is to be sent.

If you want to use more than one server you can store the connection details in a server table, filter the table before sending and then you can use the table information.

getConnection().callAction("sendMail","host","25","Username","Password","application.email@test.com",(String)rdbContacts.getValue("EMAIL"),"Subject","Dear " + Text.val(new Var(rdbContacts,"FIRSTNAME")) + " "+ Text.val(new Var(rdbContacts,"LASTNAME"))+ ",\nthis is the body of the e-mail.",(String)rdbContacts.getValue("REPORT_NAME"),rdbContacts.getValue("REPORT_FILE"));

This action can be used if you want to send HTML Mails from another server than defined in the application settings. It's possible to use TLS encryption. One file can be attached.

Hint: Filename and data can be left empty if no attachment is to be sent.

If you want to use more than one server you can store the connection details in a server table, filter the table before sending and then you can use the table information.

getConnection().callAction("sendMail","host","25","Username","Password",Boolean.TRUE,Boolean.TRUE,"application.email@test.com",(String)rdbContacts.getValue("EMAIL"),"Subject","Dear " + Text.val(new Var(rdbContacts,"FIRSTNAME")) + " "+ Text.val(new Var(rdbContacts,"LASTNAME"))+ ",\nthis is the body of the e-mail.",(String)rdbContacts.getValue("REPORT_NAME"),rdbContacts.getValue("REPORT_FILE"));

Activates autoresize for the selected table view. If no width was set for a column, it will automatically be set so that all displayed columns have space on the screen.

tableContacts.setAutoResize(true);

Activates responsive design for the selected element. Only works when the responsive mode is activated under Settings → Design.

advancedFormLayout1.setResponsive(true);

A CSS (Cascading Style Sheets) class can be assigned to an element. This class must be defined under Settings → Web Application Settings → Styles

/*
Put your custom application styles in this file.
*/
 
.colorGreen .v-panel-caption {
color: green;
}

This action works only in the web.

Style.addStyleNames(groupPanelContacts,"colorGreen");

Allows setting focus (selection of the element with tab) on an element.

Hint: Works only in web.

editContactsFirstname.setFocusable(true);

Deactivates autoresize for the selected table view.

tableContacts.setAutoResize(false);

Deactivates responsive design for the selected element.

advancedFormLayout1.setResponsive(false);

Disables the selected element. The element is grayed out and no changes can be made.

editContactsFirstname.setEnabled(false);

Disables the selected tab in a tabset. It is grayed out and cannot be clicked.

tabsetPanelMain.setEnabledAtIfExists(1,false);

Disables the translation of an element. This action works only in the onLoad Event of the Screen.

tabsetPanelMain.setEnabledAtIfExists(1,false);

Disables the translation for the selected element.

Disallow setting focus (selection of the element with tab) on an element.

Hint: Works only in web.

editContactsFirstname.setFocusable(false);

If an icon has horizontal and/or vertical alignment set to stretch, this action does not keep the original heights and width ratio.

icon1.setPreserveAspectRatio(false);

Enables the selected element. The element is grayed out and no changes can be made.

editContactsFirstname.setEnabled(true);

Enables the selected tab in a tabset. It is not grayed out and can opened.

tabsetPanelMain.setEnabledAtIfExists(1,true);

Enables the translation of an element. This action works only in the onLoad Event of the Screen.

tabsetPanelMain.setEnabledAtIfExists(1,false);

Hides the border of the selected button.

buttonButton14.setBorderPainted(false);

Hides the selected column of a Table.

DataBookUtil.hideColumn(new Var(rdbContacts,"FIRSTNAME"));

Hides the border of an input field used in the screen.

editContactsFirstname.setBorderVisible(false);

Hides the selected element used in the screen.

editContactsFirstname.setVisible(false);

Hides the navigation of an editing panel in display mode Tabset or Inline or the table

morphPanelMain.setTabHeaderVisible(false);

If an icon has horizontal and/or vertical alignment set to stretch, this action can keep the original height and width ratio.

icon1.setPreserveAspectRatio(true);

A CSS (Cascading Style Sheets) class can be removed from an element.

Only styles that were previously added with add style can be removed.

This action works only in the web.

Style.removeStyleNames(groupPanelOverview,"colorGreen");

Requests the focus (selection of the element with tab) on an element. This works also, if the focus of the element is disabled.

editContactsFirstname.requestFocus();

Normally, changed editor values are only saved in the model when the editor is exited.

For example, the filter does not search until the editor is exited with enter, tab or mouse click.

If Save editor immediately is set to an editor or filter, it is saved to the model with each keystroke. The filter searches immediately during the input.

filterContacts.setSavingImmediate(true);

Changed editor values are only saved in the model when the editor is exited.

For example, the filter does not search until the editor is exited with Enter, Tab or mouse click.

filterContacts.setSavingImmediate(false);

Activates the selected tab.

tabsetPanelMain.setSelectedIndexIfExists(1);

Changes the background color of the selected element.

groupPanelOverview.setBackground(new UIColor(0xff0000));

Changes the background image of the selected panel.

panelMain.setBackgroundImage(UIImage.getImage("/com/sibvisions/apps/vxdemo/images/Background.png"));

Changes the button margins of the selected button.

buttonShowReport.setMargins(new UIInsets(10,10,10,10));

Changes the display mode of an editing panel.

morphPanelMain.setDisplayMode(DisplayMode.Tabset);

Sets the divider position of a split panel.

morphPanelMain.setDividerPosition(350);

Enables editing of a table view or trees.

tableContacts.setEditable(true);

Disables editing of a table view or trees.

tableContacts.setEditable(false);

Changes the font of an element.

groupPanelOverview.setFont(new UIFont("Comic Sans MS",3,16));

Changes the gap between the image and the text within a button.

groupPanelOverview.setFont(new UIFont("Comic Sans MS",3,16));

Changes the alignment of an element text. Left, center and right are possible.

buttonButton15.setHorizontalAlignment(UIButton.ALIGN_RIGHT);

Changes the alignment of a button text in relation to the button image. Left, center and right are possible.

buttonButton10.setHorizontalTextPosition(UIButton.ALIGN_RIGHT);

Changes the image of a button.

buttonButton15.setImage(UIImage.getImage(UIImage.SAVE_SMALL));

Changes the text of a label. It's possible to concatenate different values like fixed text and column values.

labelLabel.setText("Hello, " + Text.val(new Var(rdbContacts,"FIRSTNAME")) + " "+ Text.val(new Var(rdbContacts,"LASTNAME")));

Hint: It's possible to use HTML tags within the label.

<html><div style="color:red;"><b><i>Hello,</i></b></div></html>

Changes the maximum height and width of an element.

buttonButton16.setMaximumSize(150,50);

Changes the minimum height and width of an element.

buttonButton16.setMinimumSize(150,50);

Changes the mouse over image of a button.

buttonButton16.setMouseOverImage(UIImage.getImage(UIImage.SAVE_LARGE));

Changes the navigation mode of an editing panel.

The navigation by single or double click works only if on the first tab is a table placed and on the second the input form. The display mode must be inline or popup and the navigation hidden.

morphPanelMain.setInlineAndPopupNavigationMode(NavigationMode.DoubleClick);

Sets a placeholder text on an element.

For example, a date format placeholder text can be displayed in a birthday input field. The text is light grey and only displayed, when the editor / element is empty.

editContactsBirthday.setPlaceholder("DD.MM.YYYY (01.01.1999)");

Changes the preferred height and width of an element.

buttonButton15.setPreferredSize(150,50);

Changes the on button click image of a button.

buttonButton16.setPressedImage(UIImage.getImage(UIImage.SAVE_LARGE));

Changes the image of the selected tab.

tabsetPanelMain.setIconAtIfExists(1,UIImage.getImage(UIImage.ABOUT_SMALL));

Changes the text of the selected tab.

tabsetPanelMain.setTextAtIfExists(1,Text.val(new Var(rdbCustomers,"COMPANY_NAME")));

Changes the text color of an element.

buttonButton15.setForeground(new UIColor(0xff0000));

Changes the tooltip text of an element. The tooltip is displayed when the mouse is positioned over the selected element.

buttonButton15.setToolTipText("This button saves all changes.");

Changes the vertical alignment of a selected element.

buttonButton15.setVerticalAlignment(UIButton.ALIGN_TOP);

Changes the vertical text position of a button in relation to the button image.

buttonButton15.setVerticalTextPosition(UIButton.ALIGN_TOP);

Shows the border of the selected button.

buttonButton14.setBorderPainted(false);

Shows the border of the selected button if the mouse cursor is not pointing over the button.

buttonButton15.setBorderOnMouseEntered(false);

Shows the border of the selected button if the mouse cursor points over the button.

buttonButton15.setBorderOnMouseEntered(true);

Shows the selected column of a Table. The column will be placed at the end of all displayed columns.

DataBookUtil.showColumn(new Var(rdbContacts,"FIRSTNAME"));

Shows the border of an input field used in the screen.

editContactsFirstname.setBorderVisible(false);

Shows the selected element used in the screen.

editContactsFirstname.setVisible(true);

Shows the navigation of an editing panel in display mode Tabset or Inline.

morphPanelMain.setTabHeaderVisible(true);

Starts editing in the selected row and column of a table view.

tableContacts.startEditing();

The selected toggle button (checkbox, radio- or toggle button) is pressed.

checkBoxCheckBox.setSelected(true);

The selected toggle button (checkbox, radio- or toggle button) is unpressed.

checkBoxCheckBox.setSelected(false);

Shows a validation error. The defined error message is shown in a Validation Result area.

Hint: Only triggered within a validator will display it in the Validation Result. If this action is placed on a button, it will be displayed in a message dialog.

throw new Exception("The email " + Text.val(new Var(rdbCustomers,"EMAIL")) + " is not valid.");

Centers the current screen (horizontally and vertically). It only works, if the screen is not maximized.

center();

Closes the selected screen.

((ProjX)getApplication()).close("com.sibvisions.apps.vxdemo.screens.ContactsWorkScreen");

Closes the current screen.

close();

Changes are saved automatically.

Hint: The current screen is attached to the application toolbar. Clicking “Save” or “Reload” on the toolbar is working within the current screen.

setManualSaveAndReload(false);

Discards all changes on a screen, without reloading the data.

Hint: This command is used to discard changes on a form using a “Cancel” button.

getDataSource().restoreAllDataBooks();

No changes are saved automatically. To save or undo changes, there are the following actions:

• Save all changes
• Save table
• Reload all
• Reload all screens
• Reload table
• Discard all changes

Hint: The current screen is detached from the application toolbar. Clicking “Save” or “Reload” on the toolbar is ignored within the current screen.

setManualSaveAndReload(true);

Opens the selected workscreen.

((ProjX)getApplication()).openWorkScreen("com.sibvisions.apps.vxdemo.screens.ContactsWorkScreen");

Discards all changes and reloads records of the current screen from the database.

getDataSource().reloadAllDataBooks();

Saves all changes of the current screen.

getDataSource().saveAllDataBooks();

Sets a parameter with a static value.

setParameter("VALUE","100");

Sets a parameter with a calculated value. For more information see Formulas

Calc.setParameter(this,"VALUE",Calc.val(new Var(rdbOrderdetails,"QUANTITY")) * Calc.val(new Var(rdbOrderdetails,"UNIT_PRICE")));

Text.setParameter(this,"VALUE",Text.val(new Var(rdbContacts,"FIRSTNAME")) + " " + Text.val(new Var(rdbContacts,"LASTNAME")));

If an action is to be executed only in certain cases, then conditions are required. Always 2 values are compared by means of a given condition. If this condition is fulfilled, one or more actions are executed, if this condition is not fulfilled, another action can be executed. Conditions are nestable.

Compares two values if they are equal.

if (Logical.equals(rdbContacts.getValue("TOWN"),"Vienna")) {
  showInformation(this,"Yes");
}
else {
  showInformation(this,"No");
}

Compares two values if they are not equal.

if (!Logical.equals(rdbContacts.getValue("TOWN"),"Vienna")) {
  showInformation(this,"Yes");
}
else {
  showInformation(this,"No");
}

It's possible to check all validators of a grouping element or a validator directly When all validators or the selected are correct, the actions in the “If” path are executed, otherwise the actions in the “Else” path are executed.

Hint: It is also possible to check nested elements here. For example, if a panel is selected, all validators on the panel and on all panels that have been placed on this panel are checked.

if (validationResult2.isValid()) {
  showInformation(this,"yes");
}
else {
  showInformation(this,"no");
}

If all validation elements on the same grouping element as the result element are correct, then the actions in the “If” path are executed, otherwise the actions in the “Else” path are executed.

Hint: This condition is often used to perform and show all field validations. If validation errors occur during the field validations, they are displayed collectively in the selected validation result.

if (validationResult2.isValid()) {
  showInformation(this,"yes");
}
else {
  showInformation(this,"no");
}

Checks if a table has at least one record.

Hint: If a filter is used in the screen, you may reset or if needed set the filter to check if there are any records.