@sapui5/sap.fe.templates 1.100.0 → 1.102.0

package/src/sap/fe/templates/ListReport/ListReportController.controller.ts

@@ -0,0 +1,1088 @@
+import ResourceBundle from "sap/base/i18n/ResourceBundle";
+import Log from "sap/base/Log";
+import ObjectPath from "sap/base/util/ObjectPath";
+import DynamicPage from "sap/f/DynamicPage";
+import CommonUtils from "sap/fe/core/CommonUtils";
+import EditFlow from "sap/fe/core/controllerextensions/EditFlow";
+import IntentBasedNavigation from "sap/fe/core/controllerextensions/IntentBasedNavigation";
+import InternalIntentBasedNavigation from "sap/fe/core/controllerextensions/InternalIntentBasedNavigation";
+import InternalRouting from "sap/fe/core/controllerextensions/InternalRouting";
+import KPIManagement from "sap/fe/core/controllerextensions/KPIManagement";
+import MassEdit from "sap/fe/core/controllerextensions/MassEdit";
+import Placeholder from "sap/fe/core/controllerextensions/Placeholder";
+import Share from "sap/fe/core/controllerextensions/Share";
+import SideEffects from "sap/fe/core/controllerextensions/SideEffects";
+import ViewState from "sap/fe/core/controllerextensions/ViewState";
+import FilterBar from "sap/fe/core/controls/FilterBar";
+import {
+	defineUI5Class,
+	extensible,
+	finalExtension,
+	privateExtension,
+	publicExtension,
+	usingExtension
+} from "sap/fe/core/helpers/ClassSupport";
+import EditState from "sap/fe/core/helpers/EditState";
+import { InternalModelContext } from "sap/fe/core/helpers/ModelHelper";
+import CoreLibrary from "sap/fe/core/library";
+import PageController from "sap/fe/core/PageController";
+import ChartRuntime from "sap/fe/macros/chart/ChartRuntime";
+import ChartUtils from "sap/fe/macros/chart/ChartUtils";
+import CommonHelper from "sap/fe/macros/CommonHelper";
+import DelegateUtil from "sap/fe/macros/DelegateUtil";
+import FilterUtils from "sap/fe/macros/filter/FilterUtils";
+import TableUtils from "sap/fe/macros/table/Utils";
+import ExtensionAPI from "sap/fe/templates/ListReport/ExtensionAPI";
+import EditFlowOverrides from "sap/fe/templates/RootContainer/overrides/EditFlow";
+import TableScroller from "sap/fe/templates/TableScroller";
+import IconTabBar from "sap/m/IconTabBar";
+import SegmentedButton from "sap/m/SegmentedButton";
+import Control from "sap/ui/core/Control";
+import Core from "sap/ui/core/Core";
+import OverrideExecution from "sap/ui/core/mvc/OverrideExecution";
+import { system } from "sap/ui/Device";
+import ControlPersonalizationWriteAPI from "sap/ui/fl/write/api/ControlPersonalizationWriteAPI";
+import StateUtil from "sap/ui/mdc/p13n/StateUtil";
+import Table from "sap/ui/mdc/Table";
+import JSONModel from "sap/ui/model/json/JSONModel";
+import ResourceModel from "sap/ui/model/resource/ResourceModel";
+import hasher from "sap/ui/thirdparty/hasher";
+import IntentBasedNavigationOverride from "./overrides/IntentBasedNavigation";
+import ShareOverrides from "./overrides/Share";
+import ViewStateOverrides from "./overrides/ViewState";
+
+const TemplateContentView = CoreLibrary.TemplateContentView,
+	InitialLoadMode = CoreLibrary.InitialLoadMode;
+
+@defineUI5Class("sap.fe.templates.ListReport.ListReportController")
+class ListReportController extends PageController {
+	@usingExtension(
+		InternalRouting.override({
+			onAfterBinding: function (this: InternalRouting) {
+				(this.getView().getController() as ListReportController)._onAfterBinding();
+			}
+		})
+	)
+	_routing!: InternalRouting;
+	@usingExtension(
+		InternalIntentBasedNavigation.override({
+			getEntitySet: function (this: InternalIntentBasedNavigation) {
+				return (this.base as ListReportController).getCurrentEntitySet();
+			}
+		})
+	)
+	_intentBasedNavigation!: InternalIntentBasedNavigation;
+	@usingExtension(SideEffects)
+	sideEffects!: SideEffects;
+
+	@usingExtension(IntentBasedNavigation.override(IntentBasedNavigationOverride))
+	intentBasedNavigation!: IntentBasedNavigation;
+
+	@usingExtension(Share.override(ShareOverrides))
+	share!: Share;
+
+	@usingExtension(EditFlow.override(EditFlowOverrides))
+	editFlow!: EditFlow;
+
+	@usingExtension(ViewState.override(ViewStateOverrides))
+	viewState!: ViewState;
+
+	@usingExtension(KPIManagement)
+	kpiManagement!: KPIManagement;
+	@usingExtension(Placeholder)
+	placeholder!: Placeholder;
+	@usingExtension(MassEdit)
+	massEdit!: MassEdit;
+	private extensionAPI?: ExtensionAPI;
+	private _oListReportControl?: Control;
+	private filterBarConditions?: any;
+	private _bMultiMode?: boolean;
+	private sUpdateTimer?: any;
+	private oResourceBundle?: ResourceBundle;
+	private _sEntitySet?: string;
+	private hasPendingChartChanges?: boolean;
+	private hasPendingTableChanges?: boolean;
+
+	@publicExtension()
+	@finalExtension()
+	getExtensionAPI(): ExtensionAPI {
+		if (!this.extensionAPI) {
+			this.extensionAPI = new ExtensionAPI(this);
+		}
+		return this.extensionAPI;
+	}
+
+	onInit() {
+		PageController.prototype.onInit.apply(this);
+		const aControls = this._getControls();
+		const oInternalModelContext = this.getView().getBindingContext("internal") as InternalModelContext;
+		if (this._isMultiMode()) {
+			const oMultiModeTab = this._getMultiModeControl();
+			oInternalModelContext.setProperty("tabs", {
+				selected: oMultiModeTab.getSelectedKey() || (oMultiModeTab.getItems()[0] as any).getKey()
+			});
+			aControls.forEach((oControl: any) => {
+				const oUpdateCounts = () => {
+					this._updateCounts();
+				};
+				CommonUtils.addEventToBindingInfo(oControl, "dataRequested", oUpdateCounts);
+			});
+		}
+		//TODO: This is only a temporary approach and will be removed once app state behaviour is finalized.
+
+		oInternalModelContext.setProperty("hasPendingFilters", true);
+		oInternalModelContext.setProperty("appliedFilters", "");
+		oInternalModelContext.setProperty("hideDraftInfo", false);
+		oInternalModelContext.setProperty("uom", {});
+		oInternalModelContext.setProperty("scalefactor", {});
+		oInternalModelContext.setProperty("scalefactorNumber", {});
+		oInternalModelContext.setProperty("currency", {});
+
+		if (this._hasMultiVisualizations()) {
+			let alpContentView = this._getDefaultPath();
+			if (!system.desktop && alpContentView === TemplateContentView.Hybrid) {
+				alpContentView = TemplateContentView.Chart;
+			}
+			oInternalModelContext.setProperty("alpContentView", alpContentView);
+		}
+
+		// Store conditions from filter bar
+		// this is later used before navigation to get conditions applied on the filter bar
+		this.filterBarConditions = {};
+
+		// As AppStateHandler.applyAppState triggers a navigation we want to make sure it will
+		// happen after the routeMatch event has been processed (otherwise the router gets broken)
+		this.getAppComponent().getRouterProxy().waitForRouteMatchBeforeNavigation();
+
+		this._isMultiMode() && this._updateMultiControlHiddenStatus();
+
+		// Configure the initial load settings
+		this._setInitLoad();
+	}
+
+	onExit() {
+		delete this.filterBarConditions;
+		delete this._oListReportControl;
+		this.extensionAPI && this.extensionAPI.destroy();
+		delete this.extensionAPI;
+	}
+
+	_onAfterBinding() {
+		const aTables = this._getControls("table");
+		if (EditState.isEditStateDirty()) {
+			const oTableBinding = this._getTableBinding();
+			if (oTableBinding) {
+				if (CommonUtils.getAppComponent(this.getView())._isFclEnabled()) {
+					// there is an issue if we use a timeout with a kept alive context used on another page
+					oTableBinding.refresh();
+				} else {
+					if (!this.sUpdateTimer) {
+						this.sUpdateTimer = setTimeout(() => {
+							oTableBinding.refresh();
+							if (this._isMultiMode()) {
+								this._setCountsOutDated();
+								this._updateCounts();
+							}
+							delete this.sUpdateTimer;
+						}, 0);
+					}
+
+					// Update action enablement and visibility upon table data update.
+					const fnUpdateTableActions = () => {
+						this._updateTableActions(aTables);
+						oTableBinding.detachDataReceived(fnUpdateTableActions);
+					};
+					oTableBinding.attachDataReceived(fnUpdateTableActions);
+				}
+			}
+			EditState.setEditStateProcessed();
+		}
+
+		if (!this.sUpdateTimer) {
+			this._updateTableActions(aTables);
+		}
+
+		this.pageReady.waitFor(this.getAppComponent().getAppStateHandler().applyAppState());
+	}
+
+	onBeforeRendering() {
+		PageController.prototype.onBeforeRendering.apply(this);
+	}
+
+	onAfterRendering() {
+		((this.getView().getModel("sap.fe.i18n") as ResourceModel).getResourceBundle() as Promise<ResourceBundle>)
+			.then((response: any) => {
+				this.oResourceBundle = response;
+				const aControls = this._getControls();
+				const sEntitySet = (this.getView().getViewData() as any).entitySet;
+				const sText = CommonUtils.getTranslatedText(
+					"T_TABLE_AND_CHART_NO_DATA_TEXT",
+					this.oResourceBundle as ResourceBundle,
+					undefined,
+					sEntitySet
+				);
+				aControls.forEach(function (oControl: any) {
+					oControl.setNoDataText(sText);
+				});
+			})
+			.catch(function (oError: any) {
+				Log.error("Error while retrieving the resource bundle", oError);
+			});
+	}
+
+	@privateExtension()
+	@extensible(OverrideExecution.After)
+	onPageReady(mParameters: any) {
+		// Enabling mandatory filter fields message dialog and focusing on them
+		if (mParameters.forceFocus) {
+			const oFilterBar = this._getFilterBarControl();
+
+			if (oFilterBar && !oFilterBar.getShowMessages()) {
+				oFilterBar.setShowMessages(true);
+				(oFilterBar as any).setFocusOnFirstErroneousField();
+			}
+		}
+
+		// Remove the handler on back navigation that displays Draft confirmation
+		this.getAppComponent().getShellServices().setBackNavigation(undefined);
+	}
+
+	/**
+	 * Method called when the content of a list report view needs to be refreshed.
+	 * This happens either when there is a change on the FilterBar and the search is triggered,
+	 * or when a tab with custom content is selected.
+	 * This method can be overwritten by the controller extension in case of customization.
+	 *
+	 * @param {map} mParameters Map containing the filter conditions of the FilterBar, the currentTabID
+	 * and the view refresh cause (tabChanged or search).
+	 * The map looks like this:
+	 * <code><pre>
+	 * 	{
+	 * 		filterConditions: {
+	 * 			Country: [
+	 * 				{
+	 * 					operator: "EQ"
+	 *					validated: "NotValidated"
+	 *					values: ["Germany", ...]
+	 * 				},
+	 * 				...
+	 * 			]
+	 * 			...
+	 * 		},
+	 *		currentTabId: "fe::CustomTab::tab1",
+	 *		refreshCause: "tabChanged" | "search"
+	 *	}
+	 * </pre></code>
+	 *
+	 * @public
+	 */
+	@publicExtension()
+	@extensible(OverrideExecution.After)
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	onViewNeedsRefresh(mParameters: any) {
+		/* To be overriden */
+	}
+
+	/**
+	 * Method called when a filter or search value has been changed in the FilterBar,
+	 * but has not been validated yet by the end user (with the 'Go' or 'Search' button).
+	 * Typically, the content of the current tab is greyed out until the filters are validated.
+	 * This method can be overwritten by the controller extension in case of customization.
+	 *
+	 * @public
+	 */
+	@publicExtension()
+	@extensible(OverrideExecution.After)
+	onPendingFilters() {
+		/* To be overriden */
+	}
+
+	getCurrentEntitySet() {
+		if (!this._sEntitySet) {
+			const oDisplayedControl = (this._isMultiMode() && this._getCurrentControl()) || this._getTable();
+			this._sEntitySet = oDisplayedControl?.data("targetCollectionPath").slice(1);
+		}
+		return this._sEntitySet;
+	}
+
+	/**
+	 * This method initiates the update of the enabled state of the DataFieldForAction and the visible state of the DataFieldForIBN buttons.
+	 * @param aTables Array of tables in the list report
+	 * @private
+	 */
+	_updateTableActions(aTables: any) {
+		let aIBNActions: any[] = [];
+		aTables.forEach(function (oTable: any) {
+			aIBNActions = CommonUtils.getIBNActions(oTable, aIBNActions);
+			// Update 'enabled' property of DataFieldForAction buttons on table toolbar
+			// The same is also performed on Table selectionChange event
+			const oInternalModelContext = oTable.getBindingContext("internal"),
+				oActionOperationAvailableMap = JSON.parse(
+					CommonHelper.parseCustomData(DelegateUtil.getCustomData(oTable, "operationAvailableMap")) as any
+				),
+				aSelectedContexts = oTable.getSelectedContexts();
+
+			CommonUtils.setActionEnablement(oInternalModelContext, oActionOperationAvailableMap, aSelectedContexts);
+		});
+		CommonUtils.updateDataFieldForIBNButtonsVisibility(aIBNActions, this.getView());
+	}
+
+	/**
+	 * This method scrolls to a specific row on all the available tables.
+	 *
+	 * @function
+	 * @name sap.fe.templates.ListReport.ListReportController.controller#_scrollTablesToRow
+	 * @param {string} sRowPath The path of the table row context to be scrolled to
+	 */
+	_scrollTablesToRow(sRowPath: string) {
+		this._getControls("table").forEach(function (oTable: any) {
+			TableScroller.scrollTableToRow(oTable, sRowPath);
+		});
+	}
+
+	_getPageTitleInformation() {
+		const oTitleInfo = { title: "", subtitle: "", intent: "", icon: "" };
+		oTitleInfo.title = this.getView().getContent()[0].data().ListReportTitle;
+		oTitleInfo.subtitle = this.getView().getContent()[0].data().ListReportSubtitle;
+		return oTitleInfo;
+	}
+
+	_getPageOrFilterBarVariantManagement() {
+		return (
+			this.getView().byId("fe::PageVariantManagement") || this.getView().byId(this._getFilterBarControlId() + "::VariantManagement")
+		);
+	}
+
+	_getFilterBarControl() {
+		return this.getView().byId(this._getFilterBarControlId()) as FilterBar;
+	}
+
+	_getAdaptationFilterBarControl() {
+		// If the adaptation filter bar is part of the DOM tree, the "Adapt Filter" dialog is open,
+		// and we return the adaptation filter bar as an active control (visible for the user)
+		const adaptationFilterBar = (this._getFilterBarControl() as any).getInbuiltFilter();
+		return adaptationFilterBar?.getParent() ? adaptationFilterBar : undefined;
+	}
+
+	_getSegmentedButton(sControl: any) {
+		return this.getView().byId(this._getSegmentedButtonId(sControl));
+	}
+
+	_getSegmentedButtonId(sControl: any) {
+		if (sControl === "Chart") {
+			return this._getChart().data("segmentedButtonId");
+		} else {
+			return this._getTable()?.data("segmentedButtonId");
+		}
+	}
+
+	_getFilterBarControlId() {
+		return this.getView().getContent()[0].data("filterBarId");
+	}
+
+	_getChartControlId() {
+		return this.getView().getContent()[0].data("singleChartId");
+	}
+
+	getChartControl() {
+		return this.getView().byId(this._getChartControlId());
+	}
+
+	_getVisualFilterBarControl() {
+		return this.getView().byId(this._getVisualFilterBarControlId());
+	}
+
+	_getVisualFilterBarControlId() {
+		return this.getView().getContent()[0].data("visualFilterBarId");
+	}
+
+	_getMultiModeControl() {
+		return this.getView().byId("fe::TabMultipleMode") as IconTabBar;
+	}
+
+	_getTableControlId() {
+		return this.getView().getContent()[0].data("singleTableId");
+	}
+
+	_getCurrentControl(): Control {
+		if (!this._oListReportControl) {
+			const oMultiModeTab = this._getMultiModeControl();
+			this._oListReportControl = this.getView().byId(
+				oMultiModeTab.getSelectedKey() || (oMultiModeTab.getItems()[0] as any).getKey()
+			) as Control;
+		}
+		return this._oListReportControl as Control;
+	}
+
+	_getTable(): Table | undefined {
+		if (this._isMultiMode()) {
+			const oControl = this._getCurrentControl();
+			return oControl && oControl.isA("sap.ui.mdc.Table") ? (oControl as Table) : undefined;
+		}
+		return this.getView().byId(this._getTableControlId()) as Table;
+	}
+
+	_getChart() {
+		return this.getView().byId(this._getChartControlId());
+	}
+
+	_getTableBinding(sTableId?: any) {
+		const oTableControl = sTableId ? this.getView().byId(sTableId) : this._getTable();
+		const oBinding = oTableControl && (oTableControl as any)._getRowBinding();
+
+		return oBinding;
+	}
+
+	_getControls(sKey?: any) {
+		if (this._isMultiMode()) {
+			const aControls: any[] = [];
+			const oTabMultiMode = this._getMultiModeControl();
+			oTabMultiMode.getItems().forEach((oItem: any) => {
+				const oControl = this.getView().byId(oItem.getKey());
+				if (sKey) {
+					if (oItem.getKey().indexOf("fe::" + sKey) > -1) {
+						oControl && aControls.push(oControl);
+					}
+				} else {
+					oControl && aControls.push(oControl);
+				}
+			});
+			return aControls;
+		} else if (sKey === "Chart") {
+			const oChart = this._getChart();
+			return oChart ? [oChart] : [];
+		} else {
+			const oTable = this._getTable();
+			return oTable ? [oTable] : [];
+		}
+	}
+
+	_getDefaultPath() {
+		const defaultPath = this.getView().getContent()[0].data("defaultPath");
+		switch (defaultPath) {
+			case "primary":
+				return TemplateContentView.Chart;
+			case "secondary":
+				return TemplateContentView.Table;
+			case "both":
+			default:
+				return TemplateContentView.Hybrid;
+		}
+	}
+
+	/**
+	 * Method to know if ListReport is configured with Multiple Table mode.
+	 *
+	 * @function
+	 * @name _isMultiMode
+	 * @returns {boolean} Is Multiple Table mode set?
+	 */
+	_isMultiMode() {
+		if (!this._oListReportControl) {
+			this._bMultiMode = !!this._getMultiModeControl();
+		}
+		return this._bMultiMode;
+	}
+
+	/**
+	 * Method to know if ListReport is configured to load data at start up.
+	 *
+	 * @function
+	 * @name _isInitLoadDisabled
+	 * @returns {boolean} Is InitLoad enabled?
+	 */
+	_isInitLoadEnabled() {
+		const initLoadMode = (this.getView().getViewData() as any).initialLoad;
+		return initLoadMode === InitialLoadMode.Enabled;
+	}
+
+	/**
+	 * Method to know if ListReport is configured with Multiple EntitySets.
+	 *
+	 * @function
+	 * @name _isMultiEntitySets
+	 * @returns {boolean} Is Multiple EntitySets configuration?
+	 */
+	_isMultiEntitySets() {
+		return this.getView().getContent()[0].data("isMultiEntitySets") === "true";
+	}
+
+	_hasMultiVisualizations() {
+		return this.getView().getContent()[0].data("hasMultiVisualizations") === "true";
+	}
+
+	/**
+	 * Method to suspend search on the filter bar. The initial loading of data is disabled based on the manifest configuration InitLoad - Disabled/Auto.
+	 * It is enabled later when the view state is set, when it is possible to realize if there are default filters.
+	 */
+	_disableInitLoad() {
+		const filterBar = this._getFilterBarControl();
+		// check for filter bar hidden
+		if (filterBar) {
+			filterBar.setSuspendSelection(true);
+		}
+	}
+
+	/**
+	 * Method called by flex to determine if the applyAutomatically setting on the variant is valid.
+	 * Called only for Standard Variant and only when there is display text set for applyAutomatically (FE only sets it for Auto).
+	 *
+	 * @returns Boolean true if data should be loaded automatically, false otherwise
+	 */
+	_applyAutomaticallyOnStandardVariant() {
+		// We always return false and take care of it when view state is set
+		return false;
+	}
+
+	/**
+	 * Configure the settings for initial load based on
+	 * - manifest setting initLoad - Enabled/Disabled/Auto
+	 * - user's setting of applyAutomatically on variant
+	 * - if there are default filters
+	 * We disable the filter bar search at the beginning and enable it when view state is set.
+	 */
+	_setInitLoad() {
+		// if initLoad is Disabled or Auto, switch off filter bar search temporarily at start
+		if (!this._isInitLoadEnabled()) {
+			this._disableInitLoad();
+		}
+		// set hook for flex for when standard variant is set (at start or by user at runtime)
+		// required to override the user setting 'apply automatically' behaviour if there are no filters
+		const variantManagement: any = this._getPageOrFilterBarVariantManagement();
+		if (variantManagement) {
+			variantManagement.registerApplyAutomaticallyOnStandardVariant(this._applyAutomaticallyOnStandardVariant.bind(this));
+		}
+	}
+
+	_setShareModel() {
+		// TODO: deactivated for now - currently there is no _templPriv anymore, to be discussed
+		// this method is currently not called anymore from the init method
+
+		const fnGetUser = ObjectPath.get("sap.ushell.Container.getUser");
+		//var oManifest = this.getOwnerComponent().getAppComponent().getMetadata().getManifestEntry("sap.ui");
+		//var sBookmarkIcon = (oManifest && oManifest.icons && oManifest.icons.icon) || "";
+
+		//shareModel: Holds all the sharing relevant information and info used in XML view
+		const oShareInfo = {
+			bookmarkTitle: document.title, //To name the bookmark according to the app title.
+			bookmarkCustomUrl: function () {
+				const sHash = hasher.getHash();
+				return sHash ? "#" + sHash : window.location.href;
+			},
+			/*
+							To be activated once the FLP shows the count - see comment above
+							bookmarkServiceUrl: function() {
+								//var oTable = oTable.getInnerTable(); oTable is already the sap.fe table (but not the inner one)
+								// we should use table.getListBindingInfo instead of the binding
+								var oBinding = oTable.getBinding("rows") || oTable.getBinding("items");
+								return oBinding ? fnGetDownloadUrl(oBinding) : "";
+							},*/
+			isShareInJamActive: !!fnGetUser && fnGetUser().isJamActive()
+		};
+
+		const oTemplatePrivateModel = this.getOwnerComponent().getModel("_templPriv") as JSONModel;
+		oTemplatePrivateModel.setProperty("/listReport/share", oShareInfo);
+	}
+
+	/**
+	 * Hidden tables must be marked as hidden to avoid sending
+	 * requests when FilterBar is changed or LR is initialized
+	 * Best workflow would be to suspend table binding but
+	 * if the user switch quickly between tabs the batch response of previous
+	 * is received when previous tab is already disabled (binding is suspended) and
+	 * generates error.
+	 * A temporary solution (if we find better workflow) is to set a customData and don't trigger
+	 * rebindTable if this customData is set to true.
+	 */
+	_updateMultiControlHiddenStatus() {
+		const oDisplayedControl = this._getCurrentControl();
+		if (this._isMultiMode() && oDisplayedControl) {
+			const sDisplayControlId = oDisplayedControl.getId();
+			const aControls = this._getControls();
+			aControls.forEach(function (oControl: any) {
+				const sControlId = oControl.getId();
+				oControl.data("controlHidden", sControlId !== sDisplayControlId);
+			});
+		}
+	}
+
+	/**
+	 * Method to update the local UI model of the page with the fields that are not applicable to the filter bar (this is specific to the multiple table scenario).
+	 *
+	 * @param {sap.ui.model.context} oInternalModelContext The internal model context
+	 * @param {sap.ui.mdc.FilterBar} oFilterBar MDC filter bar
+	 */
+	_updateMultiTabNotApplicableFields(oInternalModelContext: any, oFilterBar: any) {
+		const mCache: any = {};
+		const ignoredFields: any = {},
+			ignoredFieldsTitle: any = {},
+			aTables = this._getControls("table"),
+			aCharts = this._getControls("Chart");
+		aTables.forEach((oTable: any) => {
+			const sTableEntityPath = oTable.data("targetCollectionPath"),
+				sTableEntitySet = sTableEntityPath.slice(1),
+				sTabId = oTable.getParent().getParent().getKey(),
+				sTabTitle = oTable.getParent().getParent().getText(),
+				sCacheKey = sTableEntitySet + (oTable.data("enableAnalytics") === "true" ? "Analytical" : "Regular");
+			if (!mCache[sCacheKey]) {
+				mCache[sCacheKey] = FilterUtils.getNotApplicableFilters(oFilterBar, oTable);
+			}
+			ignoredFields[sTabId] = mCache[sCacheKey];
+			ignoredFieldsTitle[sTabId] = this.formatters.setTabMessageStrip.call(this, mCache[sCacheKey], sTabTitle, "false", {});
+		});
+		aCharts.forEach((oChart: any) => {
+			const sChartEntityPath = oChart.data("targetCollectionPath"),
+				sChartEntitySet = sChartEntityPath.slice(1),
+				sTabId = oChart.getParent().getParent().getKey(),
+				sTabTitle = oChart.getParent().getParent().getText(),
+				sCacheKey = sChartEntitySet + "Chart";
+			if (!mCache[sCacheKey]) {
+				mCache[sCacheKey] = FilterUtils.getNotApplicableFilters(oFilterBar, oChart);
+			}
+			ignoredFields[sTabId] = mCache[sCacheKey];
+			ignoredFieldsTitle[sTabId] = this.formatters.setTabMessageStrip.call(this, mCache[sCacheKey], sTabTitle, "false", {});
+		});
+		oInternalModelContext.setProperty("tabs/ignoredFields", ignoredFields);
+		oInternalModelContext.setProperty("tabs/ignoredFieldsTitle", ignoredFieldsTitle);
+	}
+
+	/**
+	 * Method to update the local UI model of the page with the fields that are not applicable to the filter bar (this is specific to the ALP scenario).
+	 *
+	 * @param {sap.ui.model.context} oInternalModelContext The internal model context
+	 * @param {sap.ui.mdc.FilterBar} oFilterBar MDC filter bar
+	 */
+	_updateALPNotApplicableFields(oInternalModelContext: any, oFilterBar: any) {
+		const mCache: any = {};
+		const ignoredFields: any = {},
+			aTables = this._getControls("table"),
+			aCharts = this._getControls("Chart");
+
+		if (!aTables.length || !aCharts.length) {
+			// If there's not a table and a chart, we're not in the ALP case
+			return;
+		}
+
+		// For the moment, there's nothing for tables...
+		aCharts.forEach(function (oChart: any) {
+			const sChartEntityPath = oChart.data("targetCollectionPath"),
+				sChartEntitySet = sChartEntityPath.slice(1),
+				sCacheKey = sChartEntitySet + "Chart";
+			if (!mCache[sCacheKey]) {
+				mCache[sCacheKey] = FilterUtils.getNotApplicableFilters(oFilterBar, oChart);
+			}
+			ignoredFields[sCacheKey] = mCache[sCacheKey];
+		});
+		oInternalModelContext.setProperty("controls/ignoredFields", ignoredFields);
+	}
+
+	_updateMultiModeSelectedControl() {
+		this._sEntitySet = undefined;
+		this._oListReportControl = undefined;
+		this._getCurrentControl();
+	}
+
+	_updateCounts() {
+		this._updateMultiModeCounts();
+	}
+
+	/**
+	 * Method to determine if a tab from the list report is a custom tab.
+	 *
+	 * @function
+	 * @name _isCustomTab
+	 * @returns {boolean} Determines if the tab is a custom tab.
+	 */
+	_isCustomTab() {
+		const oMultiModeControl = this._getMultiModeControl();
+		return oMultiModeControl && oMultiModeControl.getSelectedKey().indexOf("::CustomTab::") > -1;
+	}
+
+	_setCountsOutDated() {
+		const oMultiModeControl = this._getMultiModeControl();
+		if (oMultiModeControl && oMultiModeControl.data("showCounts") === "true") {
+			const aItems = oMultiModeControl.getItems();
+			aItems.forEach(function (oItem: any) {
+				if (oItem.getKey().indexOf("fe::Chart") === -1) {
+					oItem.data("outdatedCounts", true);
+				}
+			});
+		}
+	}
+
+	_updateMultiModeCounts() {
+		let aBindingPromises = [];
+		const oMultiModeControl = this._getMultiModeControl();
+		if (oMultiModeControl && oMultiModeControl.data("showCounts") === "true" && !this._isCustomTab()) {
+			const oDisplayedControl = this._getCurrentControl();
+			const sDisplayedControlId = oDisplayedControl.getId();
+			const aCompliantTabs: any[] = [];
+			const aItems = oMultiModeControl.getItems();
+			aItems.forEach((oItem: any) => {
+				const oControl = this.getView().byId(oItem.getKey());
+				if (
+					oControl &&
+					!oControl.isA("sap.ui.mdc.Chart") &&
+					(oItem.data("outdatedCounts") || oControl.getId() === sDisplayedControlId)
+				) {
+					aCompliantTabs.push({
+						control: oControl,
+						item: oItem
+					});
+				}
+			});
+
+			aBindingPromises = aCompliantTabs.map((mTab: any) => {
+				mTab.item.setCount("...");
+				const oControl = mTab.control;
+				const oFilterInfos = TableUtils.getFiltersInfoForSV(oControl, mTab.item.data("selectionVariant")) as any;
+				return TableUtils.getListBindingForCount(oControl, this.getView().getBindingContext(), {
+					batchGroupId: oControl.getId() === sDisplayedControlId ? oControl.data("batchGroupId") : "$auto",
+					additionalFilters: oFilterInfos.filters
+				});
+			});
+
+			Promise.all(aBindingPromises)
+				.then(function (aCounts: any[]) {
+					for (const k in aCounts) {
+						const oItem = aCompliantTabs[k].item;
+						oItem.setCount(TableUtils.getCountFormatted(aCounts[k]));
+						oItem.data("outdatedCounts", false);
+					}
+				})
+				.catch(function (oError: any) {
+					Log.error("Error while retrieving the values for the icon tab bar", oError);
+				});
+		}
+	}
+
+	_isFilterBarHidden() {
+		return (this.getView().getViewData() as any).hideFilterBar;
+	}
+
+	_shouldAutoTriggerSearch(oVM: any) {
+		if (
+			(this.getView().getViewData() as any).initialLoad === InitialLoadMode.Auto &&
+			(!oVM || oVM.getStandardVariantKey() === oVM.getCurrentVariantKey())
+		) {
+			const oFilterBar = this._getFilterBarControl();
+			if (oFilterBar) {
+				const oConditions = oFilterBar.getConditions();
+				for (const sKey in oConditions) {
+					// ignore filters starting with $ (e.g. $search, $editState)
+					if (!sKey.startsWith("$") && Array.isArray(oConditions[sKey]) && oConditions[sKey].length) {
+						// load data as per user's setting of applyAutomatically on the variant
+						const standardVariant: any = oVM.getVariants().find((variant: any) => {
+							return variant.key === oVM.getCurrentVariantKey();
+						});
+						return standardVariant && standardVariant.executeOnSelect;
+					}
+				}
+			}
+		}
+		return false;
+	}
+
+	_updateTable(oTable: any) {
+		if (!oTable.isTableBound() || this.hasPendingChartChanges) {
+			oTable.rebind();
+			this.hasPendingChartChanges = false;
+		}
+	}
+
+	_updateChart(oChart: any) {
+		const oInnerChart = oChart.getControlDelegate()._getChart(oChart);
+		if (!(oInnerChart && oInnerChart.isBound("data")) || this.hasPendingTableChanges) {
+			oChart.getControlDelegate().rebind(oChart, oInnerChart.getBindingInfo("data"));
+			this.hasPendingTableChanges = false;
+		}
+	}
+
+	handlers = {
+		onTabMultiModeChange(this: ListReportController, oEvent: any) {
+			this._updateMultiModeSelectedControl();
+			this._updateMultiControlHiddenStatus();
+
+			const oFilterBar = this._getFilterBarControl();
+			const oInternalModelContext = this.getView().getBindingContext("internal") as InternalModelContext;
+			const oDisplayedControl = this._getCurrentControl() as any;
+			const oMultiModeControl = this._getMultiModeControl();
+			const sSelectedKey = oMultiModeControl.getSelectedKey();
+			const sPreviousSelectedKey = oEvent && oEvent.mParameters ? oEvent.mParameters.previousKey : undefined;
+
+			oInternalModelContext.setProperty("tabs/selected", sSelectedKey);
+			if (oInternalModelContext.getProperty("hasPendingFilters") !== true) {
+				// No pending filters into FilterBar
+				if (oFilterBar && this._isCustomTab()) {
+					const oFilterConditions = oFilterBar.getFilterConditions();
+					this.onViewNeedsRefresh({
+						filterConditions: oFilterConditions,
+						currentTabId: sSelectedKey,
+						refreshCause: "tabChanged"
+					});
+				} else if (
+					!oDisplayedControl.isA("sap.ui.mdc.Chart") &&
+					(!oDisplayedControl.getRowBinding() || // first time the tab/table is displayed
+						oDisplayedControl.data("outdatedRows") === true)
+				) {
+					// Search has been triggered on a different tab {}
+					oDisplayedControl.rebind();
+					oDisplayedControl.data("outdatedRows", false);
+				} else if (
+					oDisplayedControl.isA("sap.ui.mdc.Chart") &&
+					(!oDisplayedControl.getControlDelegate()._getChart(oDisplayedControl).getBinding("data") || // first time the tab/chart is displayed
+						oDisplayedControl.data("outdatedRows") === true)
+				) {
+					const oInnerChart = oDisplayedControl.getControlDelegate()._getChart(oDisplayedControl);
+					oDisplayedControl.getControlDelegate().rebind(oDisplayedControl, oInnerChart.getBindingInfo("data"));
+					oDisplayedControl.data("outdatedRows", false);
+				}
+			}
+
+			if (oEvent && oEvent.mParameters && sPreviousSelectedKey !== oEvent.mParameters.selectedKey) {
+				ControlPersonalizationWriteAPI.add({
+					changes: [
+						{
+							changeSpecificData: {
+								changeType: "selectIconTabBarFilter",
+								content: {
+									selectedKey: sSelectedKey,
+									previousSelectedKey: sPreviousSelectedKey
+								}
+							},
+							selectorElement: oMultiModeControl
+						}
+					]
+				});
+			}
+			this.getExtensionAPI().updateAppState();
+		},
+		onFiltersChanged(this: ListReportController, oEvent: any) {
+			const oFilterBar = this._getFilterBarControl();
+			if (oFilterBar) {
+				const oInternalModelContext = this.getView().getBindingContext("internal") as InternalModelContext;
+				// Pending filters into FilterBar to be used for custom views
+				this.onPendingFilters();
+				oInternalModelContext.setProperty("appliedFilters", oFilterBar.getAssignedFiltersText().filtersText);
+				if (oEvent.getParameter("conditionsBased")) {
+					oInternalModelContext.setProperty("hasPendingFilters", true);
+				}
+			}
+		},
+		onVariantSelected(this: ListReportController, oEvent: any) {
+			const oVM = oEvent.getSource();
+			// setTimeout cause the variant needs to be applied before judging the auto search or updating the app state
+			setTimeout(() => {
+				if (this._isMultiMode()) {
+					(this.handlers as any).onTabMultiModeChange.apply(this, [oEvent]);
+				}
+				if (this._shouldAutoTriggerSearch(oVM)) {
+					// the app state will be updated via onSearch handler
+					return this._getFilterBarControl().triggerSearch();
+				} else {
+					this.getExtensionAPI().updateAppState();
+				}
+			}, 0);
+		},
+		onVariantSaved(this: ListReportController) {
+			//TODO: Should remove this setTimeOut once Variant Management provides an api to fetch the current variant key on save!!!
+			setTimeout(() => {
+				this.getExtensionAPI().updateAppState();
+			}, 1000);
+		},
+		onSearch(this: ListReportController) {
+			const oFilterBar = this._getFilterBarControl();
+			const oInternalModelContext = this.getView().getBindingContext("internal") as InternalModelContext;
+			const oMdcChart = this.getChartControl();
+			const bHideDraft = FilterUtils.getEditStateIsHideDraft(oFilterBar.getConditions());
+			oInternalModelContext.setProperty("hasPendingFilters", false);
+			oInternalModelContext.setProperty("hideDraftInfo", bHideDraft);
+			if (this._isMultiMode()) {
+				const aControls = this._getControls(),
+					oMultiModeControl = this._getMultiModeControl();
+				this._setCountsOutDated();
+				if (!this._isCustomTab()) {
+					const sDisplayedControlId = this._getCurrentControl().getId();
+					this._updateMultiTabNotApplicableFields(oInternalModelContext, oFilterBar);
+					// This should be done outside the search event handler of the filter bar.
+					// The same logic is required when filter bar is hidden and multiple tables exist on the LR.
+					// This is currently done in ListReport/overrides/ViewState.js#onAfterStateApplied()
+					aControls.forEach(function (oControl: any) {
+						oControl.data("outdatedRows", oControl.getId() !== sDisplayedControlId);
+					});
+				} else {
+					const oFilterConditions = oFilterBar.getFilterConditions();
+					this.onViewNeedsRefresh({
+						filterConditions: oFilterConditions,
+						currentTabId: oMultiModeControl.getSelectedKey(),
+						refreshCause: "search"
+					});
+				}
+			} else {
+				this._updateALPNotApplicableFields(oInternalModelContext, oFilterBar);
+			}
+			if (oMdcChart) {
+				// disable bound actions TODO: this clears everything for the chart?
+				(oMdcChart.getBindingContext("internal") as InternalModelContext).setProperty("", {});
+
+				const oPageInternalModelContext = oMdcChart.getBindingContext("pageInternal") as InternalModelContext;
+				const sTemplateContentView = oPageInternalModelContext.getProperty(oPageInternalModelContext.getPath() + "/alpContentView");
+				if (sTemplateContentView === TemplateContentView.Chart) {
+					this.hasPendingChartChanges = true;
+				}
+				if (sTemplateContentView === TemplateContentView.Table) {
+					this.hasPendingTableChanges = true;
+				}
+			}
+			// store filter bar conditions to use later while navigation
+			StateUtil.retrieveExternalState(oFilterBar)
+				.then((oExternalState: any) => {
+					this.filterBarConditions = oExternalState.filter;
+				})
+				.catch(function (oError: any) {
+					Log.error("Error while retrieving the external state", oError);
+				});
+			if ((this.getView().getViewData() as any).liveMode === false) {
+				this.getExtensionAPI().updateAppState();
+			}
+
+			if (system.phone) {
+				const oDynamicPage = this.getView().byId("fe::ListReport") as DynamicPage;
+				oDynamicPage.setHeaderExpanded(false);
+			}
+		},
+		/**
+		 * Triggers an outbound navigation when a user chooses the chevron.
+		 *
+		 * @param {object} oController
+		 * @param {string} sOutboundTarget Name of the outbound target (needs to be defined in the manifest)
+		 * @param {sap.ui.model.odata.v4.Context} oContext The context that contains the data for the target app
+		 * @param {string} sCreatePath Create path when the chevron is created.
+		 * @returns {Promise} Promise which is resolved once the navigation is triggered
+		 * @ui5-restricted
+		 * @final
+		 */
+		onChevronPressNavigateOutBound(oController: ListReportController, sOutboundTarget: string, oContext: any, sCreatePath: string) {
+			return oController._intentBasedNavigation.onChevronPressNavigateOutBound(oController, sOutboundTarget, oContext, sCreatePath);
+		},
+		onChartSelectionChanged(this: ListReportController, oEvent: any) {
+			const oMdcChart = oEvent.getSource().getContent(),
+				oTable = this._getTable(),
+				aData = oEvent.getParameter("data"),
+				oInternalModelContext = this.getView().getBindingContext("internal") as InternalModelContext;
+			if (aData) {
+				// update action buttons enablement / disablement
+				ChartRuntime.fnUpdateChart(oEvent);
+				// update selections on selection or deselection
+				ChartUtils.setChartFilters(oMdcChart);
+			}
+			const sTemplateContentView = oInternalModelContext.getProperty(oInternalModelContext.getPath() + "/alpContentView");
+			if (sTemplateContentView === TemplateContentView.Chart) {
+				this.hasPendingChartChanges = true;
+			} else {
+				oTable && (oTable as any).rebind();
+				this.hasPendingChartChanges = false;
+			}
+		},
+		onSegmentedButtonPressed(this: ListReportController, oEvent: any) {
+			const sSelectedKey = oEvent.mParameters.key ? oEvent.mParameters.key : null;
+			const oInternalModelContext = this.getView().getBindingContext("internal") as InternalModelContext;
+			oInternalModelContext.setProperty("alpContentView", sSelectedKey);
+			const oChart = this._getChart();
+			const oTable = this._getTable();
+			const oSegmentedButtonDelegate = {
+				onAfterRendering() {
+					const aItems = oSegmentedButton.getItems();
+					aItems.forEach(function (oItem: any) {
+						if (oItem.getKey() === sSelectedKey) {
+							oItem.focus();
+						}
+					});
+					oSegmentedButton.removeEventDelegate(oSegmentedButtonDelegate);
+				}
+			};
+			const oSegmentedButton = (
+				sSelectedKey === TemplateContentView.Table ? this._getSegmentedButton("Table") : this._getSegmentedButton("Chart")
+			) as SegmentedButton;
+			if (oSegmentedButton !== oEvent.getSource()) {
+				oSegmentedButton.addEventDelegate(oSegmentedButtonDelegate);
+			}
+			switch (sSelectedKey) {
+				case TemplateContentView.Table:
+					this._updateTable(oTable);
+					break;
+				case TemplateContentView.Chart:
+					this._updateChart(oChart);
+					break;
+				case TemplateContentView.Hybrid:
+					this._updateTable(oTable);
+					this._updateChart(oChart);
+					break;
+				default:
+					break;
+			}
+			this.getExtensionAPI().updateAppState();
+		},
+		onFiltersSegmentedButtonPressed(this: ListReportController, oEvent: any) {
+			if (oEvent.getParameter("key") === "Compact") {
+				this._getFilterBarControl().setVisible(true);
+				(this.getView().byId(this.getView().getContent()[0].data("visualFilterBarId")) as Control).setVisible(false);
+			} else {
+				this._getFilterBarControl().setVisible(false);
+				(this.getView().byId(this.getView().getContent()[0].data("visualFilterBarId")) as Control).setVisible(true);
+			}
+		},
+		onStateChange(this: ListReportController) {
+			this.getExtensionAPI().updateAppState();
+		}
+	};
+	formatters = {
+		/**
+		 * Method to set the message text for the multiple entity sets when fields in the FilterBar need to be ignored.
+		 *
+		 * @param this
+		 * @param {Array} aIgnoredFields Array of ignored fields in the FilterBar for the current tab (multiple entity sets)
+		 * @param {string} sTabTitle Tab title
+		 * @param {boolean} bIsChart Flag that indicates whether the control is a chart or not
+		 * @param {object} oApplySupported ApplySupported for the control
+		 * @returns {string} Message text
+		 */
+		setTabMessageStrip(this: ListReportController, aIgnoredFields: any[], sTabTitle: string, bIsChart?: any, oApplySupported?: any) {
+			let sText = "";
+			bIsChart = bIsChart === "true" || bIsChart === true;
+			const oFilterBar = this._getFilterBarControl();
+			if (oFilterBar && Array.isArray(aIgnoredFields) && aIgnoredFields.length > 0 && (sTabTitle || bIsChart)) {
+				const sFilterBarEntityPath = oFilterBar.data("entityType"),
+					oMetaModel = this.getView().getModel().getMetaModel(),
+					oResourceBundle = Core.getLibraryResourceBundle("sap.fe.templates") as ResourceBundle,
+					aIgnoredLabels = aIgnoredFields.map(function (sProperty) {
+						const oMacroResourceBundle = Core.getLibraryResourceBundle("sap.fe.macros") as ResourceBundle;
+						if (sProperty === "$search") {
+							return oMacroResourceBundle ? oMacroResourceBundle.getText("M_FILTERBAR_SEARCH") : "";
+						}
+						if (sProperty === "$editState") {
+							return oMacroResourceBundle ? oMacroResourceBundle.getText("M_COMMON_FILTERBAR_EDITING_STATUS") : "";
+						}
+						const sLabel = oMetaModel.getObject(sFilterBarEntityPath + sProperty + "@com.sap.vocabularies.Common.v1.Label");
+						return DelegateUtil.getLocalizedText(sLabel, oFilterBar);
+					});
+				const bIsSearchIgnored = !oApplySupported.enableSearch;
+				if (oResourceBundle) {
+					sText = CommonUtils.getMessageStripText(
+						this.getView(),
+						aIgnoredLabels,
+						oFilterBar,
+						bIsChart,
+						bIsSearchIgnored,
+						sTabTitle,
+						oResourceBundle,
+						DelegateUtil.getLocalizedText
+					);
+				}
+			}
+			return sText;
+		}
+	};
+}
+
+export default ListReportController;