@openui5/sap.m
Version:
OpenUI5 UI Library sap.m
117 lines (100 loc) • 3.72 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.
*/
// Provides control sap.m.OverflowToolbarLayoutData.
sap.ui.define(['sap/m/ToolbarLayoutData', 'sap/m/library', "sap/base/Log"],
function(ToolbarLayoutData, library, Log) {
"use strict";
// shortcut for sap.m.OverflowToolbarPriority
var OverflowToolbarPriority = library.OverflowToolbarPriority;
/**
* Constructor for a new <code>OverflowToolbarLayoutData</code>.
*
* @param {string} [sId] ID for the new element, generated automatically if no ID is given
* @param {object} [mSettings] Initial settings for the new control
*
* @class
* Holds layout data for the {@link sap.m.OverflowToolbar} items.
* @extends sap.m.ToolbarLayoutData
* @author SAP SE
* @version 1.117.4
*
* @constructor
* @public
* @since 1.28
* @alias sap.m.OverflowToolbarLayoutData
*/
var OverflowToolbarLayoutData = ToolbarLayoutData.extend("sap.m.OverflowToolbarLayoutData", /** @lends sap.m.OverflowToolbarLayoutData.prototype */ { metadata : {
properties : {
/**
* The OverflowToolbar item can or cannot move to the overflow area
*
* @deprecated Since version 1.32
*/
moveToOverflow : {type: "boolean", defaultValue: true, deprecated: true},
/**
* The OverflowToolbar item can or cannot stay in the overflow area
*
* @deprecated Since version 1.32
*/
stayInOverflow : {type: "boolean", defaultValue: false, deprecated: true},
/**
* Defines OverflowToolbar items priority. Available priorities are NeverOverflow, High, Low, Disappear and AlwaysOverflow.
*
* @public
* @since 1.32
*/
priority: {type: "sap.m.OverflowToolbarPriority", group: "Behavior", defaultValue: OverflowToolbarPriority.High},
/**
* Defines OverflowToolbar items group number.
* Default value is 0, which means that the control does not belong to any group.
* Elements that belong to a group overflow together. The overall priority of the group is defined by the element with highest priority.
* Elements that belong to a group are not allowed to have AlwaysOverflow or NeverOverflow priority.
* @public
* @since 1.32
*/
group: {type: "int", group: "Behavior", defaultValue: 0},
/**
* Defines whether the overflow area is automatically closed when interacting with a control in it
*
* @public
* @since 1.40
*/
closeOverflowOnInteraction: {type: "boolean", group: "Behavior", defaultValue: true}
}
}});
/**
* Called when the OverflowToolbarLayoutData is invalidated.
* @override
*/
OverflowToolbarLayoutData.prototype.invalidate = function () {
var sControlPriority = this.getPriority(),
bInvalidPriority = sControlPriority === OverflowToolbarPriority.AlwaysOverflow ||
sControlPriority === OverflowToolbarPriority.NeverOverflow;
// Validate layoutData priority and group properties
if (this.getGroup() && bInvalidPriority) {
Log.error("It is not allowed to set AlwaysOverflow or NeverOverflow to a group items.");
}
return ToolbarLayoutData.prototype.invalidate.call(this);
};
/**
* @override
*/
OverflowToolbarLayoutData.prototype.setPriority = function (sPriority) {
var vResult;
if (this.getPriority() === sPriority) {
return this;
}
if (this.isInvalidateSuppressed()) {
// Guarantee that OverflowLayoutData will always be invalidated and will fire event to its parent control
vResult = this.setProperty("priority", sPriority, true);
this.invalidate();
} else {
vResult = this.setProperty("priority", sPriority);
}
return vResult;
};
return OverflowToolbarLayoutData;
});