/*!
* UI development toolkit for HTML5 (OpenUI5)
* (c) Copyright 2009-2018 SAP SE or an SAP affiliate company.
* Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
*/
// Provides control sap.m.ColumnListItem.
sap.ui.define([
"sap/ui/core/Element",
"sap/ui/core/library",
"./library",
"./ListItemBase",
"./ColumnListItemRenderer",
"sap/ui/thirdparty/jquery",
// jQuery custom selectors ":sapFocusable", ":sapTabbable"
"sap/ui/dom/jquery/Selectors"
],
function(Element, coreLibrary, library, ListItemBase, ColumnListItemRenderer, jQuery) {
"use strict";
// shortcut for sap.m.ListType
var ListItemType = library.ListType;
// shortcut for sap.ui.core.VerticalAlign
var VerticalAlign = coreLibrary.VerticalAlign;
/**
* Constructor for a new ColumnListItem.
*
* @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
* sap.m.ColumnListItem
can be used with the cells
aggregation to create rows for the sap.m.Table
control.
* The columns
aggregation of the sap.m.Table
should match with the cells aggregation.
*
* Note: This control should only be used within the sap.m.Table
control.
* The inherited counter
property of sap.m.ListItemBase
is not supported.
*
* @extends sap.m.ListItemBase
*
* @author SAP SE
* @version 1.60.23
*
* @constructor
* @public
* @since 1.12
* @alias sap.m.ColumnListItem
* @ui5-metamodel This control/element also will be described in the UI5 (legacy) designtime metamodel
*/
var ColumnListItem = ListItemBase.extend("sap.m.ColumnListItem", /** @lends sap.m.ColumnListItem.prototype */ { metadata : {
library : "sap.m",
properties : {
/**
* Sets the vertical alignment of all the cells within the table row (including selection and navigation).
* Note: vAlign
property of sap.m.Column
overrides the property for cell vertical alignment if both are set.
* @since 1.20
*/
vAlign : {type : "sap.ui.core.VerticalAlign", group : "Appearance", defaultValue : VerticalAlign.Inherit}
},
defaultAggregation : "cells",
aggregations : {
/**
* Every control
inside the cells
aggregation defines one cell of the row.
* Note: The order of the cells
aggregation must match the order of the columns
aggregation of sap.m.Table
.
*/
cells : {type : "sap.ui.core.Control", multiple : true, singularName : "cell", bindable : "bindable"}
}
}});
/**
* TablePopin element that handles own events.
*/
var TablePopin = Element.extend("sap.m.TablePopin", {
ontap: function(oEvent) {
// prevent the tap event if selection is done within the popin control and mark the event
if (oEvent.isMarked() || ListItemBase.detectTextSelection(this.getDomRef())) {
return oEvent.stopImmediatePropagation(true);
}
// focus to the main row if there is nothing to focus in the popin
if (oEvent.srcControl === this || !jQuery(oEvent.target).is(":sapFocusable")) {
this.getParent().focus();
}
}
});
// defines tag name
ColumnListItem.prototype.TagName = "tr";
ColumnListItem.prototype.init = function() {
ListItemBase.prototype.init.call(this);
this._bNeedsTypeColumn = false;
this._aClonedHeaders = [];
};
ColumnListItem.prototype.onAfterRendering = function() {
ListItemBase.prototype.onAfterRendering.call(this);
this._checkTypeColumn();
};
ColumnListItem.prototype.exit = function() {
ListItemBase.prototype.exit.call(this);
this._checkTypeColumn(false);
this._destroyClonedHeaders();
if (this._oPopin) {
this._oPopin.destroy(true);
this._oPopin = null;
}
};
// remove pop-in from DOM when setVisible false is called
ColumnListItem.prototype.setVisible = function(bVisible) {
ListItemBase.prototype.setVisible.call(this, bVisible);
if (!bVisible && this.hasPopin()) {
this.removePopin();
}
return this;
};
// returns responsible table control for the item
ColumnListItem.prototype.getTable = function() {
var oParent = this.getParent();
if (oParent && oParent.isA("sap.m.Table")) {
return oParent;
}
};
/**
* Returns the pop-in element.
*
* @protected
* @since 1.30.9
*/
ColumnListItem.prototype.getPopin = function() {
if (!this._oPopin) {
this._oPopin = new TablePopin({
id: this.getId() + "-sub"
}).addEventDelegate({
// handle the events of pop-in
ontouchstart: this.ontouchstart,
ontouchmove: this.ontouchmove,
ontap: this.ontap,
ontouchend: this.ontouchend,
ontouchcancel: this.ontouchcancel,
onsaptabnext: this.onsaptabnext,
onsaptabprevious: this.onsaptabprevious,
onsapup: this.onsapup,
onsapdown: this.onsapdown,
oncontextmenu: this.oncontextmenu
}, this).setParent(this, null, true);
}
return this._oPopin;
};
/**
* Returns pop-in DOMRef as a jQuery Object
*
* @protected
* @since 1.26
*/
ColumnListItem.prototype.$Popin = function() {
return this.$("sub");
};
/**
* Determines whether control has pop-in or not.
* @protected
*/
ColumnListItem.prototype.hasPopin = function() {
return this._oPopin;
};
/**
* Pemove pop-in from DOM
* @protected
*/
ColumnListItem.prototype.removePopin = function() {
this._oPopin && this.$Popin().remove();
};
/**
* Returns the tabbable DOM elements as a jQuery collection
* When popin is available this separated dom should also be included
*
* @returns {jQuery} jQuery object
* @protected
* @since 1.26
*/
ColumnListItem.prototype.getTabbables = function() {
return this.$().add(this.$Popin()).find(":sapTabbable");
};
ColumnListItem.prototype.getAccessibilityType = function(oBundle) {
return oBundle.getText("ACC_CTR_TYPE_ROW");
};
ColumnListItem.prototype.getContentAnnouncement = function(oBundle) {
var oTable = this.getTable();
if (!oTable) {
return;
}
var sAnnouncement = "",
aCells = this.getCells(),
aColumns = oTable.getColumns(true);
aColumns.forEach(function(oColumn) {
var oCell = aCells[oColumn.getInitialOrder()];
if (!oCell || !oColumn.getVisible() || (oColumn.isHidden() && !oColumn.isPopin())) {
return;
}
var oHeader = oColumn.getHeader();
if (oHeader && oHeader.getVisible()) {
sAnnouncement += ListItemBase.getAccessibilityText(oHeader) + " ";
}
sAnnouncement += ListItemBase.getAccessibilityText(oCell, true) + " ";
});
return sAnnouncement;
};
// update the aria-selected for the cells
ColumnListItem.prototype.updateSelectedDOM = function(bSelected, $This) {
ListItemBase.prototype.updateSelectedDOM.apply(this, arguments);
// update popin as well
if (this.hasPopin()) {
this.$Popin().attr("aria-selected", bSelected);
}
};
ColumnListItem.prototype.onfocusin = function(oEvent) {
if (oEvent.isMarked() || oEvent.srcControl !== this) {
return;
}
this.$().children(".sapMListTblCellDup").find(":sapTabbable").attr("tabindex", -1);
ListItemBase.prototype.onfocusin.apply(this, arguments);
};
// informs the table when item's type column requirement is changed
ColumnListItem.prototype._checkTypeColumn = function(bNeedsTypeColumn) {
if (bNeedsTypeColumn == undefined) {
bNeedsTypeColumn = this._needsTypeColumn();
}
if (this._bNeedsTypeColumn != bNeedsTypeColumn) {
this._bNeedsTypeColumn = bNeedsTypeColumn;
this.informList("TypeColumnChange", bNeedsTypeColumn);
}
};
// determines whether type column for this item is necessary or not
ColumnListItem.prototype._needsTypeColumn = function() {
var sType = this.getType();
return this.getVisible() && (
sType == ListItemType.Detail ||
sType == ListItemType.Navigation ||
sType == ListItemType.DetailAndActive
);
};
// Adds cloned header to the local collection
ColumnListItem.prototype._addClonedHeader = function(oHeader) {
return this._aClonedHeaders.push(oHeader);
};
// Destroys cloned headers that are generated for popin
ColumnListItem.prototype._destroyClonedHeaders = function() {
if (this._aClonedHeaders.length) {
this._aClonedHeaders.forEach(function(oClone) {
oClone.destroy("KeepDom");
});
this._aClonedHeaders = [];
}
};
// active feedback for pop-in
ColumnListItem.prototype._activeHandlingInheritor = function() {
this._toggleActiveClass(true);
};
// inactive feedback for pop-in
ColumnListItem.prototype._inactiveHandlingInheritor = function() {
this._toggleActiveClass(false);
};
// toggles the active class of the pop-in.
ColumnListItem.prototype._toggleActiveClass = function(bSwitch) {
if (this.hasPopin()) {
this.$Popin().toggleClass("sapMLIBActive", bSwitch);
}
};
return ColumnListItem;
});