@openui5/sap.m
Version:
OpenUI5 UI Library sap.m
223 lines (195 loc) • 5.86 kB
JavaScript
/*!
* OpenUI5
* (c) Copyright 2026 SAP SE or an SAP affiliate company.
* Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
*/
sap.ui.define([
'./library',
'sap/ui/core/Control',
'sap/m/Text',
'sap/ui/Device',
'./FeedContentRenderer',
"sap/ui/events/KeyCodes"
],
function(library, Control, Text, Device, FeedContentRenderer, KeyCodes) {
"use strict";
// shortcut for sap.m.Size
var Size = library.Size;
/**
* Constructor for a new sap.m.FeedContent control.
*
* @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 Displays a tile containing the text of the feed, a subheader, and a numeric value.
* @extends sap.ui.core.Control
*
* @author SAP SE
* @version 1.146.0
* @since 1.34
*
* @public
* @alias sap.m.FeedContent
*/
var FeedContent = Control.extend("sap.m.FeedContent", /** @lends sap.m.FeedContent.prototype */ {
metadata : {
library : "sap.m",
properties : {
/**
* Updates the size of the chart. If not set then the default size is applied based on the device tile.
* @deprecated Since version 1.38.0. The FeedContent control has now a fixed size, depending on the used media (desktop, tablet or phone).
*/
"size" : {type : "sap.m.Size", group : "Misc", defaultValue : Size.Auto, deprecated: true},
/**
* The content text.
*/
"contentText" : {type : "string", group : "Misc", defaultValue : null},
/**
* The subheader.
*/
"subheader" : {type : "string", group : "Misc", defaultValue : null},
/**
* The actual value.
*/
"value" : {type : "string", group : "Misc", defaultValue : null},
/**
* The semantic color of the value.
*/
"valueColor" : {type : "sap.m.ValueColor", group : "Misc", defaultValue : null},
/**
* The number of characters to display for the value property.
*/
"truncateValueTo" : {type : "int", group : "Misc", defaultValue : 4}
},
defaultAggregation : "_contentTextAgr",
aggregations : {
/**
* The hidden aggregation for the content text.
*/
"_contentTextAgr" : {type : "sap.m.Text", multiple : false, visibility : "hidden"}
},
events : {
/**
* The event is triggered when the feed content is pressed.
*/
"press" : {}
}
},
renderer: FeedContentRenderer
});
/* --- Lifecycle Handling --- */
FeedContent.prototype.init = function() {
this._oContentText = new Text(this.getId() + "-content-text", {
maxLines : 2
});
this.setAggregation("_contentTextAgr", this._oContentText, true);
this.setTooltip("{AltText}");
};
FeedContent.prototype.onBeforeRendering = function() {
this.$().off("mouseenter");
this.$().off("mouseleave");
};
FeedContent.prototype.onAfterRendering = function() {
this.$().on("mouseenter", this._addTooltip.bind(this));
this.$().on("mouseleave", this._removeTooltip.bind(this));
};
FeedContent.prototype.exit = function() {
this._oContentText = null;
};
/**
* Sets the control's title attribute in order to show the tooltip.
* @private
*/
FeedContent.prototype._addTooltip = function() {
this.$().attr("title", this.getTooltip_AsString());
};
/**
* Removes the control's tooltip in order to prevent screen readers from reading it.
* @private
*/
FeedContent.prototype._removeTooltip = function() {
this.$().attr("title", null);
};
/* --- Getters and Setters --- */
/**
* Returns the Alttext
* @returns {string} The AltText text
*/
FeedContent.prototype.getAltText = function() {
var sAltText = "";
var bIsFirst = true;
if (this.getAggregation("_contentTextAgr").getText()) {
sAltText += this.getAggregation("_contentTextAgr").getText();
bIsFirst = false;
}
if (this.getSubheader()) {
if (bIsFirst) {
sAltText += "" + this.getSubheader();
} else {
sAltText += "\n" + this.getSubheader();
}
bIsFirst = false;
}
if (this.getValue()) {
if (bIsFirst) {
sAltText += "" + this.getValue();
} else {
sAltText += "\n" + this.getValue();
}
}
return sAltText;
};
FeedContent.prototype.getTooltip_AsString = function() { //eslint-disable-line
var oTooltip = this.getTooltip();
var sTooltip = this.getAltText();
if (typeof oTooltip === "string" || oTooltip instanceof String) {
sTooltip = oTooltip.split("{AltText}").join(sTooltip).split("((AltText))").join(sTooltip);
return sTooltip;
}
if (oTooltip) {
return oTooltip;
} else {
return "";
}
};
FeedContent.prototype.setContentText = function(text) {
this._oContentText.setText(text);
return this;
};
/* --- Event Handling --- */
/**
* Handler for tap event
* @param {sap.ui.base.Event} oEvent which was triggered
*/
FeedContent.prototype.ontap = function(oEvent) {
if (Device.browser.msie) {
this.$().trigger("focus");
}
this.firePress();
};
/**
* Handler for keydown event
* @param {jQuery.Event} oEvent which was triggered
*/
FeedContent.prototype.onkeydown = function(oEvent) {
if (oEvent.which === KeyCodes.ENTER || oEvent.which === KeyCodes.SPACE) {
this.firePress();
oEvent.preventDefault();
}
};
FeedContent.prototype.attachEvent = function(eventId, data, functionToCall, listener) {
Control.prototype.attachEvent.call(this, eventId, data, functionToCall, listener);
if (this.hasListeners("press")) {
this.$().attr("tabindex", 0).addClass("sapMPointer");
}
return this;
};
FeedContent.prototype.detachEvent = function(eventId, functionToCall, listener) {
Control.prototype.detachEvent.call(this, eventId, functionToCall, listener);
if (!this.hasListeners("press")) {
this.$().removeAttr("tabindex").removeClass("sapMPointer");
}
return this;
};
return FeedContent;
});