@openui5/sap.m
Version:
OpenUI5 UI Library sap.m
507 lines (442 loc) • 14 kB
JavaScript
/*!
* OpenUI5
* (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
* Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
*/
/**
* SemanticPage base classes
*
* @namespace
* @name sap.m.semantic
*/
// Provides class sap.m.semantic.SemanticConfiguration
sap.ui.define([
"sap/ui/base/Object",
"sap/m/library",
"sap/m/OverflowToolbarLayoutData",
"sap/ui/core/IconPool",
"sap/ui/core/InvisibleText"
], function(BaseObject, library, OverflowToolbarLayoutData, IconPool, InvisibleText) {
"use strict";
// shortcut for sap.m.ButtonType
var ButtonType = library.ButtonType;
// shortcut for sap.m.PlacementType
var PlacementType = library.PlacementType;
// shortcut for sap.m.semantic.SemanticRuleSetType
var SemanticRuleSetType = library.semantic.SemanticRuleSetType;
var OverflowToolbarPriority = library.OverflowToolbarPriority;
/**
* Constructor for an sap.m.semantic.SemanticConfiguration.
*
* @class Defines the visual properties and positioning for each supported semantic type
* @version 1.117.4
* @private
* @since 1.30.0
* @alias sap.m.semantic.SemanticConfiguration
*/
var SemanticConfiguration = BaseObject.extend("sap.m.semantic.SemanticConfiguration", {
getInterface: function() {
return this; // no facade
}
});
/*
static members
*/
SemanticConfiguration.prototype._PositionInPage = {
headerLeft: "headerLeft",
headerRight: "headerRight",
headerMiddle: "headerMiddle",
footerLeft: "footerLeft",
footerRight_IconOnly: "footerRight_IconOnly",
footerRight_TextOnly: "footerRight_TextOnly",
shareMenu: "shareMenu"
};
SemanticConfiguration._PageMode = {
display: "display",
edit: "edit",
multimode: "multimode"
};
SemanticConfiguration.isKnownSemanticType = function (sType) {
return SemanticConfiguration.getConfiguration(sType) != undefined;
};
SemanticConfiguration.getConfiguration = function (sType) {
return SemanticConfiguration._oTypeConfigs[sType];
};
SemanticConfiguration.getSettings = function (sType) {
return SemanticConfiguration._oTypeConfigs[sType].getSettings();
};
SemanticConfiguration.getPositionInPage = function (sType) {
return SemanticConfiguration._oTypeConfigs[sType].position;
};
SemanticConfiguration.getSequenceOrderIndex = function (sType) {
return SemanticConfiguration._oTypeConfigs[sType].order;
};
SemanticConfiguration.getAriaId = function (sType) {
return SemanticConfiguration._oTypeConfigs[sType].getSettings().ariaLabelledBy;
};
SemanticConfiguration.getShareMenuConfig = function (sRuleSetType) {
switch (sRuleSetType) {
case SemanticRuleSetType.Classic:
return {
baseButtonPlacement: PlacementType.Bottom,
actionSheetPlacement: PlacementType.Top
};
case SemanticRuleSetType.Optimized:
return {
baseButtonPlacement: PlacementType.Top,
actionSheetPlacement: PlacementType.Bottom
};
}
};
SemanticConfiguration._oTypeConfigs = (function () { //TODO: set from outside?
var oTypeConfigs = {},
oBundle = sap.ui.getCore().getLibraryResourceBundle("sap.m");
oTypeConfigs["sap.m.semantic.MultiSelectAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.headerRight,
getSettings: function() {
return {
icon: IconPool.getIconURI("multi-select"),
tooltip: oBundle.getText("SEMANTIC_CONTROL_MULTI_SELECT")
};
}
};
oTypeConfigs["sap.m.semantic.MainAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_TextOnly,
getSettings: function() {
return {
type: ButtonType.Emphasized,
layoutData: new OverflowToolbarLayoutData({
priority: OverflowToolbarPriority.NeverOverflow
})};
},
order: 0
};
oTypeConfigs["sap.m.semantic.EditAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_TextOnly,
triggers: SemanticConfiguration._PageMode.edit,
getSettings: function() {
return {
text: oBundle.getText("SEMANTIC_CONTROL_EDIT"),
type: ButtonType.Emphasized,
layoutData: new OverflowToolbarLayoutData({
priority: OverflowToolbarPriority.NeverOverflow
})
};
},
order: 1
};
oTypeConfigs["sap.m.semantic.SaveAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_TextOnly,
triggers: SemanticConfiguration._PageMode.display,
getSettings: function() {
return {
text: oBundle.getText("SEMANTIC_CONTROL_SAVE"),
type: ButtonType.Emphasized,
layoutData: new OverflowToolbarLayoutData({
priority: OverflowToolbarPriority.NeverOverflow
})
};
},
order: 3
};
oTypeConfigs["sap.m.semantic.DeleteAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_TextOnly,
triggers: SemanticConfiguration._PageMode.display,
getSettings: function() {
return {
text: oBundle.getText("SEMANTIC_CONTROL_DELETE"),
layoutData: new OverflowToolbarLayoutData({
priority: OverflowToolbarPriority.NeverOverflow
})
};
},
order: 4
};
oTypeConfigs["sap.m.semantic.PositiveAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_TextOnly,
getSettings: function() {
return {
type: ButtonType.Accept,
layoutData: new OverflowToolbarLayoutData({
priority: OverflowToolbarPriority.NeverOverflow
})};
},
order: 5
};
oTypeConfigs["sap.m.semantic.NegativeAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_TextOnly,
getSettings: function() {
return {
type: ButtonType.Reject,
layoutData: new OverflowToolbarLayoutData({
priority: OverflowToolbarPriority.NeverOverflow
})};
},
order: 6
};
oTypeConfigs["sap.m.semantic.CancelAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_TextOnly,
triggers: SemanticConfiguration._PageMode.display,
getSettings: function() {
return {
text: oBundle.getText("SEMANTIC_CONTROL_CANCEL")
};
},
order: 7
};
oTypeConfigs["sap.m.semantic.ForwardAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_TextOnly,
getSettings: function() {
return {
text: oBundle.getText("SEMANTIC_CONTROL_FORWARD")
};
},
order: 8
};
oTypeConfigs["sap.m.semantic.OpenInAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_TextOnly,
getSettings: function() {
return {
text: oBundle.getText("SEMANTIC_CONTROL_OPEN_IN")
};
},
order: 9
};
oTypeConfigs["sap.m.semantic.AddAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_IconOnly,
triggers: SemanticConfiguration._PageMode.edit,
getSettings: function() {
return {
icon: IconPool.getIconURI("add"),
text: oBundle.getText("SEMANTIC_CONTROL_ADD")
};
},
order: 0,
constraints: "IconOnly"
};
oTypeConfigs["sap.m.semantic.FavoriteAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_IconOnly,
getSettings: function() {
return {
icon: IconPool.getIconURI("favorite"),
text: oBundle.getText("SEMANTIC_CONTROL_FAVORITE")
};
},
order: 1,
constraints: "IconOnly"
};
oTypeConfigs["sap.m.semantic.FlagAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_IconOnly,
getSettings: function() {
return {
icon: IconPool.getIconURI("flag"),
text: oBundle.getText("SEMANTIC_CONTROL_FLAG")
};
},
order: 2,
constraints: "IconOnly"
};
oTypeConfigs["sap.m.semantic.ISort"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_IconOnly,
order: 3
};
oTypeConfigs["sap.m.semantic.IFilter"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_IconOnly,
order: 4
};
oTypeConfigs["sap.m.semantic.IGroup"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_IconOnly,
order: 5
};
oTypeConfigs["sap.m.semantic.SortAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_IconOnly,
getSettings: function() {
return {
icon: IconPool.getIconURI("sort"),
text: oBundle.getText("SEMANTIC_CONTROL_SORT")
};
},
constraints: "IconOnly"
};
oTypeConfigs["sap.m.semantic.SortSelect"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_IconOnly,
getSettings: function() {
return {
icon: IconPool.getIconURI("sort"),
type: "IconOnly",
autoAdjustWidth: true,
tooltip: oBundle.getText("SEMANTIC_CONTROL_SORT")
};
},
getEventDelegates: function(oContext) {
return {
onAfterRendering: function () {
this.$().attr({"aria-haspopup": "listbox"});
}.bind(oContext)
};
},
constraints: "IconOnly"
};
oTypeConfigs["sap.m.semantic.FilterAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_IconOnly,
getSettings: function() {
return {
icon: IconPool.getIconURI("filter"),
text: oBundle.getText("SEMANTIC_CONTROL_FILTER")
};
},
constraints: "IconOnly"
};
oTypeConfigs["sap.m.semantic.FilterSelect"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_IconOnly,
getSettings: function() {
return {
icon: IconPool.getIconURI("filter"),
type: "IconOnly",
autoAdjustWidth: true,
tooltip: oBundle.getText("SEMANTIC_CONTROL_FILTER")
};
},
getEventDelegates: function(oContext) {
return {
onAfterRendering: function () {
this.$().attr({"aria-haspopup": "listbox"});
}.bind(oContext)
};
},
constraints: "IconOnly"
};
oTypeConfigs["sap.m.semantic.GroupAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_IconOnly,
getSettings: function() {
return {
icon: IconPool.getIconURI("group-2"),
text: oBundle.getText("SEMANTIC_CONTROL_GROUP")
};
},
constraints: "IconOnly"
};
// sap.m.Select has no property for tooltip of the icon, so the default tooltip icon will be used
// this might lead to a different translation of the tooltip when the "Group-2" button is used inside sap.m.Select or used as a standard button
oTypeConfigs["sap.m.semantic.GroupSelect"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerRight_IconOnly,
getSettings: function() {
return {
icon: IconPool.getIconURI("group-2"),
type: "IconOnly",
autoAdjustWidth: true,
tooltip: oBundle.getText("SEMANTIC_CONTROL_GROUP")
};
},
getEventDelegates: function(oContext) {
return {
onAfterRendering: function () {
this.$().attr({"aria-haspopup": "listbox"});
}.bind(oContext)
};
},
constraints: "IconOnly"
};
oTypeConfigs["saveAsTileAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.shareMenu,
order: 0,
constraints: "IconOnly"
};
oTypeConfigs["pagingAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.headerRight
};
oTypeConfigs["sap.m.semantic.DiscussInJamAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.shareMenu,
getSettings: function() {
return {
icon: IconPool.getIconURI("discussion-2"),
text: oBundle.getText("SEMANTIC_CONTROL_DISCUSS_IN_WORK_ZONE")
};
},
order: 1,
constraints: "IconOnly"
};
oTypeConfigs["sap.m.semantic.ShareInJamAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.shareMenu,
getSettings: function() {
return {
icon: IconPool.getIconURI("share-2"),
text: oBundle.getText("SEMANTIC_CONTROL_SHARE_ON_WORK_ZONE")
};
},
order: 2,
constraints: "IconOnly"
};
oTypeConfigs["sap.m.semantic.SendMessageAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.shareMenu,
getSettings: function() {
return {
icon: IconPool.getIconURI("discussion"),
text: oBundle.getText("SEMANTIC_CONTROL_SEND_MESSAGE")
};
},
order: 3,
constraints: "IconOnly"
};
oTypeConfigs["sap.m.semantic.SendEmailAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.shareMenu,
getSettings: function() {
return {
icon: IconPool.getIconURI("email"),
text: oBundle.getText("SEMANTIC_CONTROL_SEND_EMAIL")
};
},
order: 4,
constraints: "IconOnly"
};
oTypeConfigs["sap.m.semantic.PrintAction"] = {
position: SemanticConfiguration.prototype._PositionInPage.shareMenu,
getSettings: function() {
return {
icon: IconPool.getIconURI("print"),
text: oBundle.getText("SEMANTIC_CONTROL_PRINT")
};
},
order: 5,
constraints: "IconOnly"
};
oTypeConfigs["sap.m.semantic.MessagesIndicator"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerLeft,
getSettings: function() {
var sTooltipId = InvisibleText.getStaticId("sap.m", "SEMANTIC_CONTROL_MESSAGES_INDICATOR");
return {
icon: IconPool.getIconURI("message-popup"),
text: {
path: "message>/",
formatter: function (aMessages) {
return aMessages.length || 0;
}
},
ariaDescribedBy: sTooltipId,
type: ButtonType.Emphasized,
visible: {
path: "message>/",
formatter: function (aMessages) {
return aMessages && aMessages.length > 0;
}
},
models: {message: sap.ui.getCore().getMessageManager().getMessageModel()},
layoutData: new OverflowToolbarLayoutData({
priority: OverflowToolbarPriority.NeverOverflow
})
};
}
};
oTypeConfigs["draftIndicator"] = {
position: SemanticConfiguration.prototype._PositionInPage.footerLeft,
getSettings: function() {
return {
layoutData: new OverflowToolbarLayoutData({shrinkable: false})
};
},
order: 1
};
return oTypeConfigs;
})();
return SemanticConfiguration;
});