1. General information
1.1. Description of the control
Tree is a tree structure.
- The nodes of the tree structure are composed according to the “pid” system column, which refers to the parent record of the same form (nested records). The root of the tree structure contains the records without a parent record.
- Dragging a node using the Drag&Drop method changes the parent record of the dragged record. The change is saved to the database immediately, is written to the change history, and does not run the save scripts of the edit form. Only a record that the user may edit can be moved.
- If the text of a node contains a vertical bar “|”, the parts of the text separated by the vertical bar are displayed as columns side by side. With the “Show details in tree” box checked, the text of the node is not split.
1.2. Create a new control
A new tree can be created from the view page using the toolbar with controls:
- First, clicking the mouse on the view page determines the position in which the new tree should be placed. This will highlight the selected position with a gray horizontal line. Then just click on the “Tree” item in the toolbar of the view page, fill in the attributes of the new control in the newly opened dialog, and then save. This will insert a new tree at a pre-selected location on the view page.
- If the desired position is not determined before inserting a new tree, the new tree will be inserted at the end of the view page.
1.3. Edit or delete a control
- For each existing control, a pencil icon appears to the left of the control page to change or delete the control's settings.
- Individual controls can be moved vertically on the view page using the Drag&Drop method. Moving consists of grabbing the control, preferably behind its name, and then dragging it to the desired location on the view page.
- Controls can be moved only with the “Drag&Drop” check box located above the toolbar with controls selected. For security reasons, this check box is cleared after each login to the application, so that a control is not moved by accident.
2. List of tabs in the control settings dialog
- General – Setting general properties
- Details – Settings for columns displayed in details
- Search – Search settings
- Rights – Rights settings
- Administration – Setting other properties
2.1. “General” tab
2.1.1. Name
- The name of the control displayed in the header of the tree structure.
2.1.2. Dictionary
- The dictionary lists the names of other controls, forms, view pages, categories, applications, and application groups used across the entire application.
- The dictionary search is used to design the correct control name and to maintain the consistency of the nomenclature throughout the application so that controls with the same meaning located in different places in the application are named in the same way.
2.1.3. Width
- The width of the control, expressed in pixels.
- If this input field is not filled in, the tree structure stretches to the full available width.
2.1.4. Data source
- The data source defines the source database records displayed in a tree structure.
- Data source settings are made in the graphical designer of database queries. A detailed description of the database query designer is provided in the separate “Database Query Designer” guide.
2.1.5. Layout
- The layout determines how the tree structure is displayed, either from left to right or from top to bottom.
- The drop-down list contains the following values:
- Horizontal – displaying the tree structure from left to right
- Vertical – top-down display of the tree structure
2.1.6. Type
- The tree type determines the display range of the tree structure.
- The whole tree contains all nodes, and the subsequent showing or hiding of individual subnodes is solved using javascript.
- Power save mode shows only active nodes, and the subsequent display or hiding of individual subnodes is solved by updating the web page.
- The option offers the following values:
- Full tree – internal and leaf nodes together
- Full tree – first internal, then the leaf nodes
- Economic tree – internal and leaf nodes together
- Economic tree – first internal, then the leaf nodes
- If the tree structure is sorted by a control with an integer data type, the order of the nodes follows only this sorting, and the choice between the “internal and leaf nodes together” and “first internal, then the leaf nodes” variants has no effect.
2.1.7. Options
- Show “New Record...” icon
- Checking this box determines whether an icon should be displayed in the header of the tree structure and for individual nodes, which redirects the user to a specific edit form in order to create a new record in the database.
- The icon is displayed only if the column whose values the tree structure displays in its nodes belongs to the source form of the database query, and not to a form attached by a join.
- Deny opening records
- Checking this box determines whether all users should be denied access to the edit form to open the displayed database record using the pencil icon that appears at the beginning of each node in the tree.
- Deny Drag&Drop
- Checking this box determines whether dragging and dropping of individual nodes in the tree structure should be disabled.
- With Drag&Drop allowed, the “Sort order...” icon is displayed in the header of the tree structure, which opens a dialog for changing the order of the nodes. The icon is displayed only if the source form of the database query has a text box with the “Show the “Sort order...” icon in the view table” option checked.
- If Drag&Drop is allowed and the tree structure is sorted by an integer column of the source form, the “Move up” and “Move down” icons are displayed in the navigation bar below the tree structure and, if the upper navigation bar is shown, in it as well. They move the selected node by one place among the nodes of the same level and renumber the values of the sort column of these nodes from 1. With the “Expand all” box checked, the navigation bars, and with them these icons, are not displayed.
- Expand all
- Checking this box determines whether the tree structure should be fully expanded, including all its nodes and subnodes, when it is displayed.
- An icon for expanding the entire tree structure is also available in the footer of each tree structure.
2.2. “Details” tab
2.2.1. Options
- Show details
- Checking this box determines whether the tree structure should display the details of each record. With the vertical layout, the details are displayed to the right of the tree structure; with the horizontal layout and on a mobile device, they are displayed below the tree structure.
- Show details in tree
- Checking this box determines whether the tree structure should display the details of individual records as part of individual nodes or subnodes.
- Show tooltip
- Checking this box determines whether the tree structure should display the details of individual records in the tooltip when the mouse hovers over individual records.
- The tooltip is not displayed on a mobile device.
2.2.2. Columns
- Definition of columns of details displayed in the details next to or below the tree structure, in the nodes of the tree structure, or when hovering the mouse over individual records of the tree structure.
2.3. “Search” tab
2.3.1. Options
- Activate search
- Checking this box determines whether a row with a search box and a “Search” button should be automatically displayed in the header of the tree structure.
- On a mobile device with a small screen, the row is not displayed automatically.
- Show search results only
- Checking this box determines whether the data in the tree structure should be displayed only after a searched expression is entered in the search box of the tree structure.
2.4. “Rights” tab
2.4.1. Rights
- Rights define a list of user groups and users who have permission to display the control on the view page.
- For a new control, the rights are prefilled from the control at the position selected before inserting it; if no position is selected, from the rights of the view page.
2.4.2. Replace rights to other controls
- The “Replace rights to other controls” feature is used to unify rights across the entire view page for controls that are related in terms of rights.
- Thanks to the “Show...” link, it is possible to display a list of all controls on the view page, including the setting of the rights of these controls. A check box is displayed for each control to select it. When the control is saved, the same rights are then set for the selected controls.
- An alternative for unifying rights within the entire view page is the overview of the rights settings of all controls, displayed by the “Show summary...” link on the “Rights” tab in the view page settings.
2.5. “Administration” tab
- The “Administration” tab is only displayed for existing controls.
2.5.1. Location
- Select the view page on which the control is located.
- The drop-down list contains the view pages located in the same application and in the same category as the view page on which the control stands. For a view page without a category, it offers only view pages without a category. For a new control, it contains only the current view page.
2.6. “Save”, “Save to all users”, “Delete”, and “Close” buttons
- “Save” button – Saves changes to the control settings together with the individual settings of the currently logged-in user.
- The columns on the “Details” tab from this dialog are applied to the individual settings of this tree for the current user.
- Individual tree settings can be opened using the gear icon in the icon bar in the header of the tree. The icon is displayed if any of the “Show details”, “Show details in tree” or – except on mobile devices – “Show tooltip” boxes is checked.
- Individual tree settings include the following options:
- Column settings in the “Details” tab of the individual tree settings
- All other users will retain their individual tree settings.
- For users with administrator privileges, the individual settings dialog also offers the “Save to more users” tab. The “Save to more users” button overwrites the details columns in the individual tree settings of the selected user groups and users according to the dialog.
- “Save to all users” button – Saves changes to the control settings and deletes the individual settings of this tree for all other users so that, upon the next display of the tree, the default settings defined in this dialog are applied. The individual settings of the current user are modified in the same way as by the “Save” button.
- “Delete” button – Permanently deletes the control.
- “Close” button – Closes the control settings dialog without saving changes.