@openui5/sap.m
Version:
OpenUI5 UI Library sap.m
240 lines (207 loc) • 6.97 kB
JavaScript
/*!
* OpenUI5
* (c) Copyright 2026 SAP SE or an SAP affiliate company.
* Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
*/
// Provides control sap.ui.core.Item.
sap.ui.define(['sap/ui/core/Element',
'sap/ui/core/IconPool',
'./TabStripItem',
'sap/m/ImageHelper'],
function(Element, IconPool, TabStripItem, ImageHelper) {
"use strict";
/**
* Constructor for a new <code>TabContainerItem</code>.
*
* @param {string} [sId] ID for the new control, generated automatically if no ID is given
* @param {object} [mSettings] Initial settings for the new control
*
* @class
* An item to be used in a TabContainer.
* @extends sap.ui.core.Element
*
* @author SAP SE
* @version 1.146.0
*
* @constructor
* @public
* @since 1.34
* @alias sap.m.TabContainerItem
*/
var TabContainerItem = Element.extend("sap.m.TabContainerItem", /** @lends sap.m.TabContainerItem.prototype */ { metadata : {
properties : {
/**
* Determines the text to be displayed for the item.
*/
name : {type : "string", group : "Misc", defaultValue : ""},
/**
* Determines additional text to be displayed for the item.
* @since 1.63
*/
additionalText : {type : "string", group : "Misc", defaultValue : ""},
/**
* Defines the icon to be displayed as graphical element within the <code>TabContainerItem</code>.
* It can be an image or an icon from the icon font.
* @since 1.63
* */
icon : {type : "sap.ui.core.URI", group : "Appearance", defaultValue : null},
/**
* Determines the tooltip text of the <code>TabContainerItem</code>'s icon.
* @since 1.63
*/
iconTooltip : {type : "string", group : "Accessibility", defaultValue : null},
/**
* Determines the name of the item. Can be used as input for subsequent actions.
*/
key : {type : "string", group : "Data", defaultValue : null},
/**
* Shows if a control is edited (default is false). Items that are marked as modified have a * symbol to indicate that they haven't been saved.
*/
modified : {type : "boolean", group : "Misc", defaultValue : false}
},
aggregations : {
/**
* The content displayed for this item.
*/
content : {type : "sap.ui.core.Control", multiple : true, defaultValue : null},
/**
*
* Icon / Image for the <code>TabContainerItem</code> are managed in this aggregation.
*/
_image: {type: "sap.ui.core.Control", multiple: false, visibility: "hidden"}
},
associations : {
/**
* Internal association for managing the tab strip item element.
*/
_tabStripItem : {type : "sap.ui.core.Control", multiple : false, visibility : "hidden"}
},
events : {
/**
* Sends information that some of the properties have changed.
* @private
* @ui5-restricted sap.m.TabContainerItem
*/
itemPropertyChanged : {
parameters: {
/**
* The item changed.
*/
itemChanged : {type : "sap.m.TabContainerItem"},
/**
* The key of the property.
*/
propertyKey : {type : "string"},
/**
* The value of the property.
*/
propertyValue : {type : "any"}
}
}
},
dnd: { draggable: true, droppable: false }
}});
TabContainerItem.prototype.init = function() {
var oTabStripItem = new TabStripItem();
this.setAssociation("_tabStripItem", oTabStripItem, true);
};
TabContainerItem.prototype.exit = function() {
var oTabStripItem = this._getTabStripItem();
if (oTabStripItem) {
oTabStripItem.destroy();
}
};
/**
* Overwrites the method in order to suppress invalidation for some properties.
*
* @param {string} sName Property name to be set
* @param {boolean | string | object} vValue Property value to be set
* @param {boolean} bSuppressInvalidation Whether invalidation to be suppressed
* @return {this} This instance for chaining
* @public
*/
TabContainerItem.prototype.setProperty = function(sName, vValue, bSuppressInvalidation) {
this.fireItemPropertyChanged({
itemChanged : this,
propertyKey : sName,
propertyValue : vValue
});
return Element.prototype.setProperty.call(this, sName, vValue, bSuppressInvalidation);
};
/**
* Property setter for the icon
*
* @param {sap.ui.core.URI} sIcon new value of the Icon property
* @return {this} <code>this</code> to allow method chaining
* @public
*/
TabContainerItem.prototype.setIcon = function(sIcon, bSuppressRendering) {
var mProperties,
aCssClasses = ['sapMTabContIcon'],
oImage = this.getAggregation("_image"),
sImgId = this.getId() + "-img",
bDecorative = !!(this.getName() || this.getAdditionalText());
if (!sIcon) {
this.setProperty("icon", sIcon, bSuppressRendering);
if (oImage) {
this.destroyAggregation("_image");
}
return this;
}
if (this.getIcon() !== sIcon) {
this.setProperty("icon", sIcon, bSuppressRendering);
mProperties = {
src : sIcon,
id: sImgId,
decorative: bDecorative,
tooltip: this.getIconTooltip()
};
oImage = ImageHelper.getImageControl(sImgId, oImage, undefined, mProperties, aCssClasses);
this.setAggregation("_image", oImage, bSuppressRendering);
}
return this;
};
/**
* Property setter for the icon
*
* @param {string|sap.ui.core.TooltipBase} sTooltip new value of the tooltip aggregation
* @return {this} <code>this</code> to allow method chaining
* @public
*/
TabContainerItem.prototype.setTooltip = function(sTooltip) {
Element.prototype.setTooltip.apply(this, arguments);
const oTabStripItem = this._getTabStripItem();
if (oTabStripItem) {
oTabStripItem.setTooltip(sTooltip);
}
return this;
};
/**
* Function is called when image control needs to be loaded.
*
* @return {sap.ui.core.Control} The image
* @private
*/
TabContainerItem.prototype._getImage = function () {
return this.getAggregation("_image");
};
/**
* Gets a reference to the instance of the TabStripItem.
* @returns {sap.m.TabStripItem} The tab strip item instance.
*/
TabContainerItem.prototype._getTabStripItem = function () {
return Element.getElementById(this.getAssociation("_tabStripItem"));
};
// Override customData getters/setters to forward the customData added to TabContainerItem to the internal TabStripItem
["addCustomData", "getCustomData", "destroyCustomData", "indexOfCustomData",
"insertCustomData", "removeAllCustomData", "removeCustomData", "data"].forEach(function(sName){
TabContainerItem.prototype[sName] = function() {
var oTabStripItem = this._getTabStripItem();
if (oTabStripItem && oTabStripItem[sName]) {
var res = oTabStripItem[sName].apply(oTabStripItem, arguments);
return res === oTabStripItem ? this : res;
}
};
});
return TabContainerItem;
});