v2023.12
ServoyCloud Support Samples Open Source Community

Tab Panel

Overview

The TabPanel component is a tabbed container that can hold one or more forms. But only one of them is visible at a time. The active/visible form can be changed using the tab buttons or from code. At runtime, tabs can be added from code, and can be removed either from code or from the UI. Tabs can optionally show related data.

It can be used in both responsive and anchored layouts.

Get Started

Creating a Tab Panel

Here are the steps for creating a Tab Panel:

  1. Open the Form Editor of the form where you need to place an Accordion Panel

  2. Find TabPanel in Form Containers section in the components' pallet

  3. Drag and drop the TabPanel component in the desired place of the form

  4. Set the tabs; this can be done via wizard or in the properties panel

  5. Edit other TabPanel properties if needed

It is recommended to set a specific name in the Tab Panel properties in order to make it easier to use it later in scripting. Example: "tabpanel_orders".

It is recommended to set a specific name in the Tab Panel tab properties in order to make it easier to use them later in scripting. Example: "tab_customers".

Setting the tabs property via the wizard

After dragging the container in the form, the Property configurator for tabs wizard appears. In order to set the tabs using the wizard, you need to do the following steps:

  1. Find in the left side of the wizard the contained form you need: it can have a related or unrelated datasource

  2. Click on the form name

  3. The selected form will appear on the right side of the wizard, showing some of the tab properties:

    1. CONTAINEDFORM : the form shown in the tab

    2. RELATIONNAME : the name of the relation between datasources of main and contained forms; this field will be empty if the relation doesn't exist

    3. TEXT: the tab's title text (i18n and custom HTML supported)

    4. delete icon : you can remove a tab by clicking the icon

  4. Click OK button after all tabs have been added

Setting the tabs property in the properties panel

After dragging the container in the form, the Property configurator for tabs wizard appears. Close the editor without setting anything here, find the Accordion Panel in the form editor, click it and proceed with the following steps:

  1. Add a tab. There are 2 ways of adding a tab:

    1. Select the tabs property and click the + button in order to add a tab. Next tabs can be added the same way or by clicking the + button (insert a new array item below) of another tab. You can change the tabs' order by dragging them into the desired placed inside the TabPanel (in the form editor).

    2. Drag and drop tab component (of an TabPanel in Form Containers section in the components' pallet) into the TabPanel container (in the form editor)

  2. Expand the tabs property to see the list of tabs. They are also shown in the TabPanel container (in the form editor)

  3. In order to edit each tab, expand it or click the tab name in the TabPanel container (in the form editor) and set the properties:

    1. containedForm: the form shown in the tab

    2. disabled: whether that tab is enabled or not

    3. hideCloseIcon: whether a close icon is shown or not (only applicable when showTabCloseIcon is set to true)

    4. iconStyleClass: style class for the tab's icon

    5. imageMedia: image to be drawn in tab header

    6. name: a name for this tab

    7. relationName: optional relation for the form to be shown

    8. text: the tab's title text (i18n and custom HTML supported)

    9. toolTipText: the text message when a user hovers their cursor (i18n and custom HTML supported)

Using a relation

The contained form of the tabs can show related data. In order to do this, you need to have the following:

  1. Set the datasource property on the main form

  2. Set the datasource property on the contained form

  3. Make sure that the relation from datasource table of the main form to datasource table of the contained form exists, otherwise it needs to be created

  4. Set the above relation in the relationName property of the corresponding tab

Once everything is set, the contained form will show related data according to the selected record in the main form. When the selected record changes in the main form, so will the related data from the contained form.

Customizing the Tabs

Setting the tab text

Tab's title text property can be set by entering a value in the property field or by entering the Text Property Editor. Usually this will be plain text or it can contain data from table columns, aggregations, calculations, relations or from and scopes variables, all of them can be combined, as well. i18n is also supported.

Examples:

Setting the tooltip text

Tab's tooltip text property can be set by entering a value in the property field or by entering the Text Property Editor. Most often, this will just be plain text that describes what will happen on-click. It can also contain data from table columns, aggregations, calculations, relations or from and scopes variables - all of them can be combined. i18n is also supported.

Closable Tabs

TabPanel component can also have closable tabs, when needed.

Enabling/Disabling Tab Close

In order to enable the option to have closable tabs, the user must check showTabCloseIcon property of the TabPanel component. This applies to all tabs, so in case when not all tabs should be closable, the user can check hideCloseIcon property of the tab; this will remove the close icon of the tab.

Setting the close Icon

The close icon can be set by editing the closeIconStyleClass property of the TabPanel.

Custom Tab Markup

Tab's title text property supports custom HMTL content.

Example:

In order for the custom HTML content to be correctly displayed we need to make sure that it will not be sanitized by using .putClientProperty(UICONSTANTS.TRUST_DATA_AS_HTML,true)

function onShow(firstShow, event) {
	// TODO Auto-generated method stub
    elements.tabpanel_orders.putClientProperty(UICONSTANTS.TRUST_DATA_AS_HTML,true);
}

Only enable this setting if the data shown can always be trusted and is never composed of data from an external system or user.

Scripting a Tabpanel

TabPanel properties can be also set in the Scripting Editor. You can find a list of AccordionPanel API methods here.

Changing Selected Tab

Here is an example of how to programmatically set the active tab in the Scripting Editor of the main form:

/**
 * TODO generated, please specify type and doc for the params
 * @param index {Number}
 *
 * @properties={typeid:24,uuid:"78CE78AF-AC5A-458B-A611-84DDC07878B3"}
 */
function setActiveTab(index){
	elements.tabpanel_orders.selectTabAt(index)
} // call this function after the TabPanel container is fully loaded on the page and set the desired index value

Adding a Tab

Here is an example of how to programmatically add a tab in the Scripting Editor of the main form:

function onShow(firstShow, event) {
	// TODO Auto-generated method stub
    elements.tabpanel_orders.addTab(forms.suppliers,'Suppliers'); // Adds a tab to this accordion with that form and text
}

Removing a Tab

Here is an example of how to programmatically remove a tab in the Scripting Editor of the main form:

function onShow(firstShow, event) {
	// TODO Auto-generated method stub
    var x = elements.tabpanel_orders.tabs.length;
    elements.tabpanel_orders.removeTabAt(x-1);  //Removes a tab of the given index. Returns true if this was sucessfull.  
}

Handling Tab Change Event

Here is an example of how to use the onChange event of an TabPanel in the Scripting Editor of the main form:

Saving the active tab index in the onChange event(fired after a different tab is selected) of the TabPanel container:

/**
 * Fired after a different tab is selected.
 *
 * @param {Number} previousIndex The previous tab index
 * @param {JSEvent} event
 *
 * @private
 *
 * @properties={typeid:24,uuid:"0A044286-CB21-4CCC-A8AA-284137F1D22E"}
 */
function onChange(previousIndex, event) {
	// TODO Auto-generated method stub
	application.setUserProperty(controller.getName()+"."+elements.tabpanel_orders+".activeTab",elements.tabpanel_orders.activeTabIndex.toString())
}

Checking if there is a saved previous active tab index and set it in the onShow main form event:

/**
 * @type {String}
 *
 * @properties={typeid:35,uuid:"2FD6AD36-9779-49D2-B4A7-985C7C73B66C",variableType:8}
 */
var activeTab;

/**
 * Callback method for when form is shown.
 *
 * @param {Boolean} firstShow form is shown first time after load
 * @param {JSEvent} event the event that triggered the action
 *
 * @private
 *
 * @properties={typeid:24,uuid:"37E091B7-6FD0-47E8-94E4-A22585A3C717"}
 */
function onShow(firstShow, event) {
    // TODO Auto-generated method stub
    activeTab = application.getUserProperty(ontroller.getName()+"."+elements.tabpanel_orders+".activeTab");
    if (activeTab)
    {
        elements.tabpanel_orders.selectTabAt(parseInt(activeTab));
    }   
}

Blocking a tab change

Here is an example of how to block a tab change using the onTabClicked event of an TabPanel in the Scripting Editor of the main form:

/**
 * Fired when the user clicks on a tab. When false is returned, the tab switch is prevented.
 *
 * @param {JSEvent} event The event that triggered the action
 * @param {Number} clickedTabIndex The index of the tab that was clicked
 * @param {String} dataTarget The value of the closest data-target attribute when found
 *
 * @return {Boolean}
 *
 * @private
 *
 * @properties={typeid:24,uuid:"0C9D0DEA-5D52-4E2E-B5D9-2E510FC2BE9F"}
 */
function onTabClicked(event, clickedTabIndex, dataTarget) {
	var editedRecords = databaseManager.getEditedRecords();
	if (editedRecords.length>0) {
		var button = plugins.dialogs.showInfoDialog('Pending changes', 'Some fields have changes. How would you like to proceed?', 'Stay on tab', 'Leave')
		if (button == 'Leave') {
			return true;
		}
	} else {
		return true;
	}
	return false;
}

Handling a Tab Close Event

Here is an example of how to use the onTabClose event of an TabPanel in the Scripting Editor of the main form:

/**
 * @type {Array<Object>}
 * @properties={typeid:35,uuid:"A5B0105B-1663-44DF-AC5B-3E8ABE63CA69",variableType:-4}
 */
var closedtabs = [];

/**
 * @properties={typeid:35,uuid:"7F15F51E-6AB9-41CC-9BC9-8A635CD2F298",variableType:-4}
 */
var closedtabsIndexes = []; 
/**
 * Fired when the user clicks on the tab close icon. When false is returned, the tab close is prevented.
 *
 * @param {JSEvent} event The event that triggered the action
 * @param {Number} clickedTabIndex The index of the tab that was clicked
 *
 * @return {Boolean}
 *
 * @private
 *
 * @properties={typeid:24,uuid:"2C20175F-CC95-4A35-8C78-0791981B4D9F"}
 */
function onTabClose(event, clickedTabIndex) {
	// TODO Auto-generated method stub
	closedtabsIndexes.push(clickedTabIndex)
	return true;
    // saves the indexes of closed tabs
}

Blocking a tab close

Here is an example of how to block a tab close using the onTabClose event of an TabPanel in the Scripting Editor of the main form:

/**
 * Fired when the user clicks on the tab close icon. When false is returned, the tab close is prevented.
 *
 * @param {JSEvent} event The event that triggered the action
 * @param {Number} clickedTabIndex The index of the tab that was clicked
 *
 * @return {Boolean}
 *
 * @private
 *
 * @properties={typeid:24,uuid:"2C20175F-CC95-4A35-8C78-0791981B4D9F"}
 */
function onTabClose(event, clickedTabIndex) {
	// TODO Auto-generated method stub
	if (databaseManager.getEditedRecords(foundset).length>0)
	{
		return false;
	}
	else {
		return true;
	}
    // prevents tab close when there is edited and unsaved data
}
PreviousForm ContainerNextSplit Pane

Last updated