@openui5/sap.m
Version:
OpenUI5 UI Library sap.m
97 lines (83 loc) • 2.86 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.ToolbarLayoutData.
sap.ui.define(['./library', 'sap/ui/core/LayoutData'],
function(library, LayoutData) {
"use strict";
/**
* Constructor for a new <code>ToolbarLayoutData</code>.
*
* @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
* Defines layout data for the {@link sap.m.Toolbar} items.
*
* <b>Note:</b> The {@link sap.m.ToolbarSpacer} is a flex control that is intended to
* control its own behavior, thus <code>sap.m.ToolbarLayoutData</code> is not supported as value for the
* <code>layoutData</code> aggregation of {@link sap.m.ToolbarSpacer} and if set it's ignored.
*
* @extends sap.ui.core.LayoutData
* @version 1.117.4
*
* @constructor
* @public
* @since 1.20
* @alias sap.m.ToolbarLayoutData
*/
var ToolbarLayoutData = LayoutData.extend("sap.m.ToolbarLayoutData", /** @lends sap.m.ToolbarLayoutData.prototype */ { metadata : {
library : "sap.m",
properties : {
/**
* Determines whether the control, when in a toolbar, is shrinkable or not. For controls with fixed width (100px, 5rem, etc...) this property is ignored.
*
* <b>Notes:</b>
* <ul>
* <li>Nested layout controls should not be shrinkable.</li>
* <li>This property has no effect on <code>sap.m.Breadcrumbs</code> as it is shrinkable by default.</li>
* </ul>
*/
shrinkable : {type : "boolean", group : "Behavior", defaultValue : false},
/**
* Sets the minimum width of the toolbar item.
*/
minWidth : {type : "sap.ui.core.CSSSize", group : "Dimension", defaultValue : null},
/**
* Sets the maximum width of the toolbar item.
*/
maxWidth : {type : "sap.ui.core.CSSSize", group : "Dimension", defaultValue : null}
}
}});
/*
* Returns the parent's live style object from DOM.
* Here the parent is the control who is setting the layout data
*
* @returns {Object}
* @protected
*/
ToolbarLayoutData.prototype.getParentStyle = function() {
var oParent = this.getParent();
if (!oParent || !oParent.getDomRef) {
return {};
}
var oDomRef = oParent.getDomRef();
return oDomRef ? oDomRef.style : {};
};
/*
* If the control that is using ToolbarLayoutData has been already rendered,
* then this function can be used to apply layout data properties to the related control
*
* @returns {this}
* @protected
*/
ToolbarLayoutData.prototype.applyProperties = function() {
var oStyle = this.getParentStyle();
oStyle.minWidth = this.getMinWidth();
oStyle.maxWidth = this.getMaxWidth();
return this;
};
return ToolbarLayoutData;
});