@openui5/sap.m
Version:
OpenUI5 UI Library sap.m
170 lines (140 loc) • 4.46 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.m.StandardTile.
sap.ui.define([
'./Tile',
'./library',
'sap/ui/core/IconPool',
'sap/ui/core/library',
'sap/ui/Device',
'./StandardTileRenderer',
'sap/m/ImageHelper'
],
function(Tile, library, IconPool, coreLibrary, Device, StandardTileRenderer, ImageHelper) {
"use strict";
// shortcut for sap.m.StandardTileType
var StandardTileType = library.StandardTileType;
// shortcut for sap.ui.core.ValueState
var ValueState = coreLibrary.ValueState;
/**
* Constructor for a new StandardTile.
*
* @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
* The StandardTile control is displayed in the tile container.
* @extends sap.m.Tile
*
* @author SAP SE
* @version 1.146.0
*
* @constructor
* @public
* @since 1.12
* @deprecated as of version 1.50, replaced by {@link sap.m.GenericTile}
* @alias sap.m.StandardTile
*/
var StandardTile = Tile.extend("sap.m.StandardTile", /** @lends sap.m.StandardTile.prototype */ {
metadata : {
library : "sap.m",
deprecated: true,
properties : {
/**
* Defines the title of the StandardTile.
*/
title : {type : "string", group : "Misc", defaultValue : null},
/**
* Defines the description of the StandardTile.
*/
info : {type : "string", group : "Misc", defaultValue : null},
/**
* Defines the icon of the StandardTile.
*/
icon : {type : "sap.ui.core.URI", group : "Misc", defaultValue : null},
/**
* Defines the active icon of the StandardTile.
*/
activeIcon : {type : "sap.ui.core.URI", group : "Misc", defaultValue : null},
/**
* Defines the number field of the StandardTile.
*/
number : {type : "string", group : "Misc", defaultValue : null},
/**
* Defines the number units qualifier of the StandardTile.
*/
numberUnit : {type : "string", group : "Misc", defaultValue : null},
/**
* Defines the color of the info text. Possible values are Error, Warning, Success and so on.
*/
infoState : {type : "sap.ui.core.ValueState", group : "Misc", defaultValue : ValueState.None},
/**
* Defines the type of the StandardTile.
*/
type : {type : "sap.m.StandardTileType", group : "Misc", defaultValue : StandardTileType.None},
/**
* By default, this is set to true but then one or more requests are sent trying to get the density perfect version of image if this version of image doesn't exist on the server.
*
* If bandwidth is key for the application, set this value to false.
*/
iconDensityAware : {type : "boolean", group : "Appearance", defaultValue : true}
},
associations : {
/**
* Association to controls / IDs, which describe this control (see WAI-ARIA attribute aria-describedby).
*/
ariaDescribedBy : {type : "sap.ui.core.Control", multiple : true, singularName : "ariaDescribedBy"}
}
},
renderer: StandardTileRenderer
});
/**
* Called when the control is destroyed.
*
* @private
*/
StandardTile.prototype.exit = function() {
if (this._oImageControl) {
this._oImageControl.destroy();
this._oImageControl = null;
}
};
StandardTile.prototype.ontap = function() {
Tile.prototype.ontap.apply(this, arguments);
};
/**
* Gets the icon of the <code>StandardTile</code> control.
* @returns {sap.ui.core.URI} The icon of the control
* @public
*/
StandardTile.prototype.getIcon = function() {
if (!this.getProperty("icon") && this.getType() === "Create") {
return IconPool.getIconURI("add");
} else {
return this.getProperty("icon");
}
};
/**
* Lazy loads StandardTile icon image.
* @returns {Object} The icon image
* @private
*/
StandardTile.prototype._getImage = function() {
var sImgId = this.getId() + "-img";
var sSize = Device.system.phone ? "1.3rem" : "2rem";
var mProperties = {
src : this.getIcon(),
height : sSize,
width : sSize,
size: sSize,
densityAware : this.getIconDensityAware(),
useIconTooltip : false
};
this._oImageControl = ImageHelper.getImageControl(sImgId, this._oImageControl, this, mProperties);
return this._oImageControl;
};
return StandardTile;
});