@openui5/sap.m
Version:
OpenUI5 UI Library sap.m
966 lines (862 loc) • 35.3 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.SelectionDetails.
sap.ui.define([
'./library',
'sap/ui/core/Control',
'sap/m/Button',
'sap/ui/base/Interface',
'sap/ui/Device',
"sap/ui/core/ControlBehavior",
"sap/ui/core/Lib",
'sap/ui/core/library',
'./SelectionDetailsRenderer',
'sap/base/util/uid',
"sap/ui/core/Configuration"
],
function(
library,
Control,
Button,
Interface,
Device,
ControlBehavior,
Library,
CoreLibrary,
SelectionDetailsRenderer,
uid,
Configuration
) {
"use strict";
/**
* Constructor for a new SelectionDetails.
*
* @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 protected control provides a popover that displays the details of the items selected in the chart. This control should only be used in the toolbars of sap.suite.ui.commons.ChartContainer and sap.ui.comp.smartchart.SmartChart controls. Initially, the control is rendered as a button that opens the popup after clicking on it.
* <b><i>Note:</i></b>It is protected and should only be used within the framework itself.
*
* @author SAP SE
* @version 1.146.0
*
* @extends sap.ui.core.Control
* @constructor
* @protected
* @since 1.48.0
* @alias sap.m.SelectionDetails
*/
var SelectionDetails = Control.extend("sap.m.SelectionDetails", /** @lends sap.m.SelectionDetails.prototype */ {
metadata: {
library: "sap.m",
defaultAggregation: "items",
aggregations: {
/**
* Contains {@link sap.m.SelectionDetailsItem items} that are displayed on the first page.
*/
"items": {type: "sap.m.SelectionDetailsItem", multiple: true, bindable: "bindable"},
/**
* Contains custom actions shown in the responsive toolbar below items on the first page.
*/
"actions": {type: "sap.ui.core.Item", multiple: true},
/**
* Contains actions that are rendered as a dedicated {@link sap.m.StandardListItem item}.
* In case an action group is pressed, a navigation should be triggered via <code>navTo</code> method.
* A maximum of 5 actionGroups is displayed inside the popover, though more can be added to the aggregation.
*/
"actionGroups": {type: "sap.ui.core.Item", multiple: true},
/**
* Hidden aggregation that contains the popover.
*/
"_popover": {type: "sap.m.ResponsivePopover", multiple: false, visibility: "hidden"},
/**
* Hidden aggregation that contains the button.
*/
"_button": {type: "sap.m.Button", multiple: false, visibility: "hidden"}
},
events: {
/**
* Event is triggered before the popover is open.
*/
beforeOpen: {},
/**
* Event is triggered before the popover is closed.
*/
beforeClose: {},
/**
* Event is triggered after a list item of {@link sap.m.SelectionDetailsItem} is pressed.
*/
navigate: {
parameters: {
/**
* The item on which the action has been pressed.
* Can be null in case a navigation was done without item context, e.g. action press.
*/
item: {type: "sap.m.SelectionDetailsItem"},
/**
* Direction of the triggered navigation, possible values are "to" and "back".
*/
direction: {type: "string"},
/**
* The content of the currently viewed page that was previously added via {@link sap.m.SelectionDetailsFacade#navTo}.
* This contains the content of the page before the navigation was triggered.
* Can be null in case of first event triggering.
*/
content: {type: "sap.ui.core.Control"}
}
},
/**
* Event is triggered when a custom action is pressed.
*/
actionPress: {
parameters: {
/**
* The action that has to be processed once the action has been pressed
*/
action: {type: "sap.ui.core.Item"},
/**
* If the action is pressed on one of the {@link sap.m.SelectionDetailsItem items}, the parameter contains a reference to the pressed {@link sap.m.SelectionDetailsItem item}. If a custom action or action group of the SelectionDetails popover is pressed, this parameter refers to all {@link sap.m.SelectionDetailsItem items}
*/
items: {type: "sap.m.SelectionDetailsItem"},
/**
* The action level of action buttons. The available levels are Item, List and Group
*/
level: {type: "sap.m.SelectionDetailsActionLevel"}
}
}
}
},
renderer: SelectionDetailsRenderer
});
/**
* The maximum number of actionGroups that are shown in the actionGroup list.
* @type {int}
* @private
*/
SelectionDetails._MAX_ACTIONGROUPS = 5; // This number is also implemented as a rule within the sap.ui.support namespace.
SelectionDetails._POPOVER_MAX_HEIGHT = 500;
/* =========================================================== */
/* Lifecycle methods */
/* =========================================================== */
SelectionDetails.prototype.init = function() {
// Indicates whether the labels are wrapped
this._bWrapLabels = false;
this._oRb = Library.getResourceBundleFor("sap.m");
this.setAggregation("_button", new Button({
id: this.getId() + "-button",
type: library.ButtonType.Transparent,
press: [this._onToolbarButtonPress, this]
}), true);
this._oItemFactory = null;
};
SelectionDetails.prototype.onBeforeRendering = function() {
this._updateButton();
};
SelectionDetails.prototype.onAfterRendering = function() {
document.getElementById(this.getAggregation("_button").getId()).setAttribute("aria-haspopup", "dialog");
};
SelectionDetails.prototype.exit = function() {
this.detachSelectionHandler();
this._oItemFactory = null;
this._oChangeHandler = null;
};
/* =========================================================== */
/* API methods */
/* =========================================================== */
/**
* Returns true if the SelectionDetails is open, otherwise false.
* @returns {boolean} True if the SelectionDetails is open, otherwise false.
* @public
* @function
* @name sap.m.SelectionDetailsFacade#isOpen
*/
SelectionDetails.prototype.isOpen = function() {
var oPopover = this.getAggregation("_popover");
return oPopover ? oPopover.isOpen() : false;
};
/**
* Returns true if the SelectionDetails is enabled, otherwise false.
* @returns {boolean} True if the SelectionDetails contains items, otherwise false.
* @public
* @function
* @name sap.m.SelectionDetailsFacade#isEnabled
*/
SelectionDetails.prototype.isEnabled = function() {
return this.getItems().length > 0;
};
/**
* Closes SelectionDetails if open.
* @returns {this} To ensure method chaining, return the SelectionDetails.
* @public
* @function
* @name sap.m.SelectionDetailsFacade#close
*/
SelectionDetails.prototype.close = function() {
var oPopover = this.getAggregation("_popover");
if (oPopover) {
oPopover.close();
}
return this;
};
/**
* Wraps the given content in {@link sap.m.Page page}, adds it to existing {@link sap.m.NavContainer NavContainer} and navigates to this newly created page.
* Has no effect if the SelectionDetails is closed.
* Lazily processes dependencies for the navigation event.
*
* @param {string} title The title property of the {@link sap.m.Page page} control to which the navigation should occur.
* @param {sap.ui.core.Control} content The content of the control to which the navigation should occur.
* @returns {this} To ensure method chaining, return the SelectionDetails.
* @public
* @function
* @name sap.m.SelectionDetailsFacade#navTo
*/
SelectionDetails.prototype.navTo = function(title, content) {
if (this.isOpen()) {
sap.ui.require([
"sap/m/Page", "sap/m/Toolbar", "sap/m/ToolbarSpacer", "sap/m/Title"
], this._handleNavLazy.bind(this, title, content));
}
return this;
};
/**
* Returns <code>true</code> if the labels of the {@link sap.m.SelectionDetailsItemLine} elements are wrapped, <code>false</code> otherwise.
* @returns {boolean} True if the labels of the {@link sap.m.SelectionDetailsItemLine} elements are wrapped, false otherwise.
* @public
* @function
* @name sap.m.SelectionDetailsFacade#getWrapLabels
*/
SelectionDetails.prototype.getWrapLabels = function () {
return this._bWrapLabels;
};
/**
* Enables line wrapping for the labels of the of the {@link sap.m.SelectionDetailsItemLine} elements.
* @param {boolean} bWrap True to apply wrapping to the labels of the {@link sap.m.SelectionDetailsItemLine} elements.
* @returns {this} To ensure method chaining, returns SelectionDetails.
* @public
* @function
* @name sap.m.SelectionDetailsFacade#setWrapLabels
*/
SelectionDetails.prototype.setWrapLabels = function (bWrap) {
var oPopover = this.getAggregation("_popover");
this._bWrapLabels = bWrap;
if (oPopover && oPopover.isOpen()) {
oPopover.invalidate();
}
return this;
};
/* =========================================================== */
/* Protected API methods */
/* =========================================================== */
/**
* Sets the popover to modal or non-modal based on the given parameter. This only takes effect on desktop or tablet.
* Please see the documentation {@link sap.m.ResponsivePopover#modal}.
* @param {boolean} modal New value for property modal of the internally used popover.
* @returns {this} To ensure method chaining, return the SelectionDetails.
* @protected
*/
SelectionDetails.prototype.setPopoverModal = function(modal) {
this._getPopover().setModal(modal);
return this;
};
/**
* Handles the wrapping of the content and the toolbar creation for the new page.
*
* @param {string} pageTitle The title property of the {@link sap.m.Page page} control to which the navigation should occur.
* @param {sap.ui.core.Control} content The content of the control to which the navigation should occur.
* @param {function} Page The constructor for sap.m.Page.
* @param {function} Toolbar The constructor for sap.m.Toolbar.
* @param {function} ToolbarSpacer The constructor for sap.m.ToolbarSpacer.
* @param {function} Title The constructor for sap.m.Title.
* @param {function} Button The constructor for sap.m.Button.
* @private
*/
SelectionDetails.prototype._handleNavLazy = function(pageTitle, content, Page, Toolbar, ToolbarSpacer, Title) {
var sPageId = this.getId() + "-page-for-" + content.getId() + "-uid-" + uid();
this._setPopoverHeight(SelectionDetails._POPOVER_MAX_HEIGHT);
var oPage = new Page(sPageId, {
customHeader: this._getPageToolbar(Toolbar, ToolbarSpacer, Title, true, pageTitle),
content: [ content ]
});
// The logic in the overwritten addPage method of navContainer has to be executed.
this._oNavContainer.addPage(oPage);
this._oNavContainer.to(sPageId);
};
/**
* Updates the popover's customHeader aggregation and builds a new toolbar.
* A back button and the title are added to the newly created toolbar.
* Only on mobile devices a close button is added as well.
* @param {function} Toolbar The constructor for sap.m.Toolbar.
* @param {function} ToolbarSpacer The constructor for sap.m.ToolbarSpacer.
* @param {function} Title The constructor for sap.m.Title.
* @param {boolean} [showBackButton] If set to true, a back button with enabled navigation is added to the toolbar.
* @param {string} [pageTitle] The title property of the {@link sap.m.Page page} control to which the navigation is going to occur.
* @returns {sap.m.Toolbar} The new toolbar with an optional back button, an optional title and a close button that is only shown if used on a mobile device.
* @private
*/
SelectionDetails.prototype._getPageToolbar = function(Toolbar, ToolbarSpacer, Title, showBackButton, pageTitle) {
var oToolbar = new Toolbar({
design: library.ToolbarDesign.Transparent
}).addStyleClass("sapMSDPageHeader");
if (showBackButton) {
var oBackButton = new Button({
icon: "sap-icon://nav-back",
press: this._onBackButtonPress.bind(this),
tooltip: this._oRb.getText("SELECTIONDETAILS_BACK_BUTTON")
});
oToolbar.addAggregation("content", oBackButton, true);
}
var oToolbarSpacer = new ToolbarSpacer();
var oTitle = new Title({
text: pageTitle,
titleStyle: CoreLibrary.TitleLevel.H5
});
oToolbar.addAggregation("content", oToolbarSpacer, true);
oToolbar.addAggregation("content", oTitle, true);
oToolbar.addAggregation("content", oToolbarSpacer.clone(), true);
if (Device.system.phone) {
oToolbar.addAggregation("content", this._getCloseButton(), true);
}
return oToolbar;
};
/**
* Animate the height css property of the internal popover to the given height with a fixed duration and standard easing.
* This does not change the contentHeight property of the popover.
* @param {int} height The popover height in pixels.
* @private
*/
SelectionDetails.prototype._setPopoverHeight = function(height) {
if (!Device.system.phone) {
var oPopover = this._getPopover(),
$PopoverContent = oPopover.$("cont"),
iMaxHeight = this._getMaxPopoverHeight();
height = Math.min(SelectionDetails._POPOVER_MAX_HEIGHT, height);
oPopover._oControl._deregisterContentResizeHandler();
var bAnimationMode = ControlBehavior.getAnimationMode() !== Configuration.AnimationMode.none;
$PopoverContent.animate({
"height": Math.min(height, iMaxHeight)
}, bAnimationMode ? 100 : 0, function() {
oPopover.setProperty("contentHeight", height + "px", true);
oPopover._oControl._registerContentResizeHandler();
});
}
};
/**
* Calculates the maximum height of the popover used for height animations.
* @returns {int} The maximum height of the popover in pixels
* @private
*/
SelectionDetails.prototype._getMaxPopoverHeight = function() {
var oResponsivePopover = this._getPopover(),
$ResponsivePopover = oResponsivePopover.$(),
iOffsetTop,
iViewportHeight,
oPopover;
if (!$ResponsivePopover.length) {
return 0;
}
iOffsetTop = $ResponsivePopover.offset().top;
iViewportHeight = Device.resize.height;
oPopover = oResponsivePopover._oControl;
oPopover._adaptPositionParams();
return iViewportHeight - iOffsetTop - oPopover._marginBottom;
};
/**
* Handles the backward navigation and popover animation.
* @private
*/
SelectionDetails.prototype._onBackButtonPress = function() {
var oContent = this._oNavContainer.getCurrentPage().getContent()[0];
this._oNavContainer.attachEventOnce("afterNavigate", function () {
this.fireNavigate({
item: this._oItemForNavigation,
direction: "back",
content: oContent
});
}, this);
this._oNavContainer.back();
// Once NavContainer's history returned to the initial page, the popover's size has to be reset
if (this._oNavContainer.getCurrentPage() === this._oInitialPage) {
this._setPopoverHeight(this._getInitialPageHeight());
}
};
/**
* Builds a new button that serves as a close button that can be put in page toolbars.
* @returns {sap.m.Button} The newly created close button with an icon and a press handler attached
* @private
*/
SelectionDetails.prototype._getCloseButton = function() {
return new Button({
icon: "sap-icon://decline",
press: this.close.bind(this)
});
};
SelectionDetails.prototype._aFacadeMethods = [
"addCustomData", "getCustomData", "indexOfCustomData", "insertCustomData",
"removeCustomData", "removeAllCustomData", "destroyCustomData",
"data",
"addEventDelegate", "removeEventDelegate",
"close", "isOpen", "isEnabled",
"attachBeforeOpen", "detachBeforeOpen",
"attachBeforeClose", "detachBeforeClose",
"attachNavigate", "detachNavigate",
"attachActionPress", "detachActionPress",
"addAction", "removeAction", "removeAllActions",
"addActionGroup", "removeActionGroup", "removeAllActionGroups",
"navTo",
"getWrapLabels", "setWrapLabels"
];
/**
* Returns the public facade of the SelectionDetails control for non inner framework usages.
* @returns {sap.ui.base.Interface} The reduced facade for outer framework usages.
* @protected
*/
SelectionDetails.prototype.getFacade = function() {
var oFacade = new Interface(this, SelectionDetails.prototype._aFacadeMethods, true);
oFacade.getItems = this._getItemFacades.bind(this);
this.getFacade = function() {
return oFacade;
};
return oFacade;
};
/**
* Builds a mapping of items to their respective facades via calling getFacade() on each item.
* @returns {sap.ui.base.Interface[]} An array containing the interfaces to the items with all their relevant public methods
* @private
*/
SelectionDetails.prototype._getItemFacades = function() {
var aItems = this.getItems();
var aItemFacades = [];
for (var i = 0; i < aItems.length; i++) {
aItemFacades.push(aItems[i].getFacade());
}
return aItemFacades;
};
/* =========================================================== */
/* Private methods */
/* =========================================================== */
/**
* Updates the button text and sets the button to enabled or disabled depending on the amount of items or selections made.
* @private
*/
SelectionDetails.prototype._updateButton = function() {
var sText, iCount, oButton = this.getAggregation("_button"), bEnabled;
if (this._oSelectionData && this._oSelectionData.length >= 0) {
iCount = this._oSelectionData.length;
} else {
iCount = this.getItems().length;
}
if (iCount > 0) {
sText = this._oRb.getText("SELECTIONDETAILS_BUTTON_TEXT_WITH_NUMBER", [ iCount ]);
bEnabled = true;
} else {
sText = this._oRb.getText("SELECTIONDETAILS_BUTTON_TEXT");
bEnabled = false;
}
oButton.setText(sText);
oButton.setEnabled(bEnabled);
oButton.setTooltip(sText);
};
/**
* Calls the handler for the button click. Loads the necessary dependencies only when they are needed.
* @private
*/
SelectionDetails.prototype._onToolbarButtonPress = function() {
sap.ui.require([
'sap/m/NavContainer', 'sap/m/ResponsivePopover', 'sap/m/Page', "sap/m/Toolbar", 'sap/m/OverflowToolbar', 'sap/m/ToolbarSpacer',
'sap/m/Button', 'sap/m/List', 'sap/m/StandardListItem', 'sap/ui/layout/FixFlex', 'sap/m/ScrollContainer', "sap/m/Title"
], this._handlePressLazy.bind(this));
};
/**
* Opens SelectionDetails as ResponsivePopover. Creates the structure of the popup and fills the first page.
* @param {function} NavContainer The constructor of sap.m.NavContainer
* @param {function} ResponsivePopover The constructor of sap.m.ResponsivePopover
* @param {function} Page The constructor of sap.m.Page
* @param {function} Toolbar The constructor of sap.m.Toolbar
* @param {function} OverflowToolbar The constructor of sap.m.OverflowToolbar
* @param {function} ToolbarSpacer The constructor of sap.m.ToolbarSpacer
* @param {function} Button The constructor of sap.m.OverflowToolbarButton
* @param {function} List The constructor of sap.m.List
* @param {function} StandardListItem The constructor of sap.m.StandardListItem
* @param {function} FixFlex The constructor of sap.ui.layout.FixFlex
* @param {function} ScrollContainer The constructor of sap.m.ScrollContainer
* @param {function} Title The constructor of sap.m.Title
* @private
*/
SelectionDetails.prototype._handlePressLazy = function(NavContainer, ResponsivePopover, Page, Toolbar, OverflowToolbar, ToolbarSpacer, Button, List, StandardListItem, FixFlex, ScrollContainer, Title) {
var oPopover = this._getPopover(NavContainer, ResponsivePopover, Toolbar, ToolbarSpacer, Page, List, FixFlex, ScrollContainer, Title);
if (this._oItemFactory) {
this._callFactory();
}
this.fireBeforeOpen();
this._addMainListItems();
this._addActionGroupListItems(StandardListItem);
this._addListActions(OverflowToolbar, ToolbarSpacer, Button);
this._oNavContainer.setProperty("defaultTransitionName", "show", true);
this._oNavContainer.to(this._oInitialPage);
this._oNavContainer.setProperty("defaultTransitionName", "slide", true);
oPopover.openBy(this.getAggregation("_button"));
oPopover.invalidate(); //trigger a rendering of the updated lists and toolbars
};
/**
* Calls the registered factory function for each entry in this._oSelectionData.
* Before the factory is called, the 'beforeUpdate' event is triggered.
* After the factory is called for all entries in this._oSelectionData, the 'afterUpdate' event is triggered.
* @private
*/
SelectionDetails.prototype._callFactory = function() {
var fnFactory = this._oItemFactory.factory,
oData = this._oItemFactory.data,
aSelection = this._oSelectionData,
oResult;
this.fireEvent("beforeUpdate", {
items: this.getItems()
});
this.destroyAggregation("items", true);
for (var i = 0; i < aSelection.length; i++) {
oResult = fnFactory(aSelection[i].displayData, aSelection[i].data, aSelection[i].context, oData, aSelection[i].shapeString);
if (oResult) {
oResult._sMarkerShapeString = aSelection[i].shapeString;
this.addAggregation("items", oResult, true);
}
}
this.fireEvent("afterUpdate", {
items: this.getItems()
});
};
/**
* Creates and returns the internal initial Page. If the Page does not yet exist, it is created.
* @param {function} Page The constructor of sap.m.Page
* @param {function} Toolbar The constructor of sap.m.Toolbar
* @param {function} ToolbarSpacer The constructor of sap.m.ToolbarSpacer
* @param {function} Title The constructor of sap.m.Title
* @returns {sap.m.Page} The newly created or existing Page
* @private
*/
SelectionDetails.prototype._getInitialPage = function(Page, Toolbar, ToolbarSpacer, Title) {
if (!this._oInitialPage) {
this._oInitialPage = new Page(this.getId() + "-page", {
showHeader: false,
enableScrolling: false
});
if (Device.system.phone) {
this._oInitialPage.setProperty("showHeader", true, true);
this._oInitialPage.setAggregation("customHeader", this._getPageToolbar(Toolbar, ToolbarSpacer, Title), true);
}
}
return this._oInitialPage;
};
/**
* Creates and returns the internal NavContainer.
* @param {function} NavContainer The constructor of sap.m.NavContainer
* @returns {sap.m.NavContainer} The newly created NavContainer
* @private
*/
SelectionDetails.prototype._getNavContainer = function(NavContainer) {
if (!this._oNavContainer) {
this._oNavContainer = new NavContainer(this.getId() + "-nav-container");
}
return this._oNavContainer;
};
/**
* Returns the internal popover. In case it is not created yet, it is created with the minimal layout structure.
* @param {function} NavContainer The constructor of sap.m.NavContainer
* @param {function} ResponsivePopover The constructor of sap.m.ResponsivePopover
* @param {function} Toolbar The constructor of sap.m.Toolbar
* @param {function} ToolbarSpacer The constructor of sap.m.ToolbarSpacer
* @param {function} Page The constructor of sap.m.Page
* @param {function} List The constructor of sap.m.List
* @param {function} FixFlex The constructor of sap.ui.layout.FixFlex
* @param {function} ScrollContainer The constructor of sap.m.ScrollContainer
* @param {function} Title The constructor of sap.m.Title
* @returns {sap.m.ResponsivePopover} The newly created or existing popover.
* @private
*/
SelectionDetails.prototype._getPopover = function(NavContainer, ResponsivePopover, Toolbar, ToolbarSpacer, Page, List, FixFlex, ScrollContainer, Title) {
var oPopover = this.getAggregation("_popover"),
oNavContainer,
oPage,
oMainContainer,
oActionGroupList,
oMainList;
if (!oPopover) {
oPopover = new ResponsivePopover({
id: this.getId() + "-popover",
placement: library.PlacementType.Bottom,
showHeader: false,
contentWidth: "25rem",
contentHeight: "500px",
beforeClose: this.fireBeforeClose.bind(this)
}).addStyleClass("sapMSD");
oPopover.setProperty = this._setPopoverProperty;
//build popover contents
oPage = this._getInitialPage(Page, Toolbar, ToolbarSpacer, Title);
oActionGroupList = this._getActionGroupList(List);
oNavContainer = this._getNavContainer(NavContainer);
oMainList = this._getMainList(List);
oMainContainer = this._createMainContainer(FixFlex);
oMainContainer.setAggregation("flexContent", oMainList, true);
oMainContainer.addAggregation("fixContent", oActionGroupList, true);
oPage.addAggregation("content", oMainContainer, true);
// NavContainer adds necessary styles in its overwritten addPage function.
// It does not result in rerendering since it checks for an existing DOM reference before doing so.
// This reference does not yet exist while adding our very first page.
oNavContainer.addPage(oPage);
oPopover.addAggregation("content", oNavContainer, true);
oPopover.addEventDelegate({
onBeforeRendering: function () {
this.getWrapLabels() ? oPopover.addStyleClass("sapMSDWrapLabels") : oPopover.removeStyleClass("sapMSDWrapLabels");
}.bind(this)
});
this.setAggregation("_popover", oPopover, true);
}
return oPopover;
};
/**
* Overwrite a property's value on the control and its inner control if it has the same name.
* @param {string} propertyName The name of the property.
* @param {int} value Value to set for the given property name
* @returns {sap.m.ResponsivePopover} this to allow method chaining
* @private
*/
SelectionDetails.prototype._setPopoverProperty = function(propertyName, value) {
var oProperty = this._oControl.getMetadata().getProperty(propertyName);
if (oProperty && propertyName === "modal" && this._oControl.setModal) {
this._oControl.setModal(value);
} else {
this._oControl.setProperty.apply(this._oControl, arguments);
}
return Control.prototype.setProperty.apply(this, arguments);
};
/**
* Calculates the sum of all heights of the given instances.
* @returns {int} The height of all given instances in pixels
* @private
*/
SelectionDetails.prototype._getInitialPageHeight = function() {
var oFooter = this._oInitialPage && this._oInitialPage.getFooter(),
iListHeight = this._oMainList.$().outerHeight(),
iActionGroupsHeight = this._oActionGroupList.$().outerHeight(),
iToolbarHeight = oFooter && oFooter.$().outerHeight() || 0;
return iListHeight + iActionGroupsHeight + iToolbarHeight;
};
/**
* Add the List that contains SelectionDetailsListItems based on the items aggregation.
* @param {function} FixFlex The constructor of sap.m.VBox
* @returns {sap.m.VBox} The newly created or existing main container VBox
* @private
*/
SelectionDetails.prototype._createMainContainer = function(FixFlex) {
return new FixFlex(this.getId() + "-mainContainer", {
fixFirst: false,
minFlexSize: -1 // use -1 to enable scrolling. If minFlexSize is not set, scrolling is disabled
});
};
/**
* Creates a new list and returns the reference for the SelectionDetailsListItems.
* @param {function} List Constructor function for sap.m.List
* @returns {sap.m.List} The newly created or existing main list for SelectionDetailsItems
* @private
*/
SelectionDetails.prototype._getMainList = function(List) {
if (!this._oMainList) {
this._oMainList = new List(this.getId() + "-list");
}
return this._oMainList;
};
/**
* Add the SelectionDetailsItems' list items to the main list.
* @private
*/
SelectionDetails.prototype._addMainListItems = function() {
var i, aItems, oListItem;
this._oMainList.removeAllAggregation("items", true);
aItems = this.getItems();
for (i = 0; i < aItems.length; i++) {
if (!aItems[i].hasListeners("_navigate")) {
aItems[i].attachEvent("_navigate", this._onNavigate, this);
}
if (!aItems[i].hasListeners("_actionPress")) {
aItems[i].attachEvent("_actionPress", this._onActionPress, this);
}
oListItem = aItems[i]._getListItem();
this._oMainList.addAggregation("items", oListItem, true);
}
};
/**
* Creates the List for actionGroups if necessary.
* @param {function} List The constructor of sap.m.List
* @returns {sap.m.List} The newly created or existing list for actionGroups
* @private
*/
SelectionDetails.prototype._getActionGroupList = function(List) {
if (!this._oActionGroupList) {
this._oActionGroupList = new List(this.getId() + "-actionGroupList", {
showNoData: false
});
}
return this._oActionGroupList;
};
/**
* Adds StandardListItems to list which will be used for actionGroups on list level.
* This method adds up to _MAX_ACTIONGROUPS StandardListItems to the internal list.
* @param {function} StandardListItem The constructor of sap.m.StandardListItem
* @private
*/
SelectionDetails.prototype._addActionGroupListItems = function(StandardListItem) {
this._oActionGroupList.destroyAggregation("items", true);
var aActionGroupItems = this.getActionGroups(),
oStandardListItem,
i,
iDisplayedGroupActions = Math.min(SelectionDetails._MAX_ACTIONGROUPS, aActionGroupItems.length);
for (i = 0; i < iDisplayedGroupActions; i++) {
oStandardListItem = new StandardListItem(this.getId() + "-actionGroup-" + i, {
title: aActionGroupItems[i].getText(),
type: library.ListType.Navigation,
press: [{
action: aActionGroupItems[i],
level: library.SelectionDetailsActionLevel.Group
}, this._onActionPress, this]
});
if (i === 0) {
oStandardListItem.addStyleClass("sapMSDFirstActionGroup");
}
this._oActionGroupList.addAggregation("items", oStandardListItem, true);
}
};
/**
* Creates the new overflow toolbar that contains the buttons for actions on list level.
* @param {function} OverflowToolbar The constructor of sap.m.OverflowToolbar
* @param {function} ToolbarSpacer The constructor of sap.m.ToolbarSpacer
* @param {function} Button The constructor of sap.m.OverflowToolbarButton
* @private
*/
SelectionDetails.prototype._addListActions = function(OverflowToolbar, ToolbarSpacer, Button) {
var oButton, i, aActions, oAction, oToolbar;
this._oInitialPage.destroyAggregation("footer", true);
if (!this.getActions().length) {
return;
}
oToolbar = new OverflowToolbar(this.getId() + "-action-toolbar").addStyleClass("sapContrast sapContrastPlus");
this._oInitialPage.setAggregation("footer", oToolbar, true);
oToolbar.addAggregation("content", new ToolbarSpacer(), true);
aActions = this.getActions();
for (i = 0; i < aActions.length; i++) {
oAction = aActions[i];
oButton = new Button(this.getId() + "-action-" + i, {
text: oAction.getText(),
enabled: oAction.getEnabled(),
press: [{
action: oAction,
level: library.SelectionDetailsActionLevel.List
}, this._onActionPress, this]
});
oToolbar.addAggregation("content", oButton, true);
}
};
/**
* Handles the press on the action or actionGroups by triggering the action press event on the instance of SelectionDetails.
* @param {sap.ui.base.Event} oEvent Event object of press action
* @param {sap.ui.core.Item} oData The item that was used in the creation of the action button and action list item
* @private
*/
SelectionDetails.prototype._onActionPress = function(oEvent, oData) {
this.fireActionPress({
action: oData && oData.action || oEvent.getParameter("action"),
items: oEvent.getParameter("items") || this.getItems(),
level: oData && oData.level || oEvent.getParameter("level")
});
};
/**
* Handles the navigate on the SelectionDetailsItem by triggering the navigate event on the instance of SelectionDetails.
* @param {sap.ui.base.Event} oEvent Event object of the navigation event that has been triggered by the SelectionDetailsItem
* @private
*/
SelectionDetails.prototype._onNavigate = function(oEvent) {
this._oItemForNavigation = oEvent.getSource();
this.fireNavigate({
item: oEvent.getSource(),
direction: "to"
});
};
/**
* Handles the selection change event. The event parameters need to follow this structure:
* data: [
* {
* data: [ {} ],
* displayData: [ {} ]
* }
* ]
* @param {sap.ui.base.Event} oEvent Event object of selection change listener object
* @private
*/
SelectionDetails.prototype._handleSelectionChange = function(oEvent) {
var oEventParams = oEvent.getParameter("data");
if (Array.isArray(oEventParams)) {
this._oSelectionData = oEventParams;
this._updateButton();
}
};
/* =========================================================== */
/* Public and Protected methods */
/* =========================================================== */
/**
* Method to register the factory function that creates the SelectionDetailsItems.
* The factory function is called for every selected entry separately with three parameters.
* First parameter is the display data array for each item out of the selection.
* Second parameter is the data array for each item out of the selection.
* Third parameter is the binding context for each item in the selection. This is undefined if no binding is used.
* Fourth parameter is <code>oData</code>. Can be undefined.
* @protected
* @param {any} data Data to be passed to the factory function
* @param {function} factory The item factory function that returns SelectionDetailsItems
* @returns {this} this to allow method chaining
*/
SelectionDetails.prototype.registerSelectionDetailsItemFactory = function(data, factory) {
if (typeof (data) === "function") {
factory = data;
data = undefined;
}
if (typeof factory === "function") {
this._oItemFactory = {
factory: factory,
data: data
};
}
return this;
};
/**
* Attaches an event handler to the given listener to react to user selection interaction.
* @protected
* @param {string} eventId The identifier of the event to listen for
* @param {object} listener The object which triggers the event to register on
* @returns {this} this to allow method chaining
*/
SelectionDetails.prototype.attachSelectionHandler = function(eventId, listener) {
// only create change handler once + check for argument validity
if (!this._oChangeHandler && typeof eventId === "string" && listener && typeof listener.attachEvent === "function") {
this._oChangeHandler = {
eventId: eventId,
listener: listener
};
listener.attachEvent(eventId, this._handleSelectionChange, this);
}
return this;
};
/**
* Detaches the event which was attached by <code>attachSelectionHandler</code>.
* @protected
* @returns {this} this to allow method chaining
*/
SelectionDetails.prototype.detachSelectionHandler = function() {
if (this._oChangeHandler) {
this._oChangeHandler.listener.detachEvent(this._oChangeHandler.eventId, this._handleSelectionChange, this);
this._oChangeHandler = null;
}
return this;
};
return SelectionDetails;
});