// For Library Version: 1.149.0 declare namespace sap { namespace zen { /** * Design Studio Commons Library. Intended only to be used within S/4 HANA Fiori applications. */ namespace commons { namespace layout { /** * Describes the settings that can be provided to the AbsoluteLayout constructor. * * @deprecated As of version 1.38. the concept has been discarded. */ interface $AbsoluteLayoutSettings extends sap.ui.core.$ControlSettings { /** * The overall width of the control. When not set, 100% is automatically set. */ width?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The overall height of the control. When not set, 100% is automatically set. */ height?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode. */ verticalScrolling?: | sap.ui.core.Scrolling | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode. */ horizontalScrolling?: | sap.ui.core.Scrolling | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Positioned child controls within the layout */ positions?: | sap.zen.commons.layout.PositionContainer[] | sap.zen.commons.layout.PositionContainer | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the MatrixLayout constructor. * * @deprecated As of version 1.38. Instead, use the `sap.ui.layout.Grid` control. */ interface $MatrixLayoutSettings extends sap.ui.core.$ControlSettings { /** * CSS width of the matrix layout. If the LayoutFixed = true a adequate width should be provided. */ width?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * CSS height of the matrix layout. */ height?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets the table layout. If fixed the width parameter of a column has priority, if not the width of the * content of the colums has priority. The default is "fixed". If the fixed layout is used a adequate width * of the MatrixLayout should be provided. Otherwise the column width displayed could be different than * the given ones because of browser dependend optimazations. */ layoutFixed?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Number of columns. If not specified, the number of columns will be determined from the given cells. */ columns?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Widths of the columns. Use an array to define the widths of the columns. If a column shall have an automatical * sizing enter "auto" for this column width. */ widths?: | sap.ui.core.CSSSize[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The matrix layout's individual rows. */ rows?: | sap.zen.commons.layout.MatrixLayoutRow[] | sap.zen.commons.layout.MatrixLayoutRow | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the MatrixLayoutCell constructor. * * @deprecated As of version 1.38. Instead, use the `sap.ui.layout.Grid` control. */ interface $MatrixLayoutCellSettings extends sap.ui.core.$ElementSettings {} /** * Describes the settings that can be provided to the MatrixLayoutRow constructor. * * @deprecated As of version 1.38. replaced by {@link sap.ui.layout.Grid}. */ interface $MatrixLayoutRowSettings extends sap.ui.core.$ElementSettings { /** * Height of the row. */ height?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The matrix layout row's individual cells. */ cells?: | sap.zen.commons.layout.MatrixLayoutCell[] | sap.zen.commons.layout.MatrixLayoutCell | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the PositionContainer constructor. * * @deprecated As of version 1.89. the concept has been discarded. */ interface $PositionContainerSettings extends sap.ui.core.$ElementSettings { /** * Defines the distance to the top of the layout (as specified in HTML) */ top?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the distance to the bottom of the layout (as specified in HTML) */ bottom?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the distance to the left of the layout (as specified in HTML) */ left?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the distance to the right of the layout (as specified in HTML) */ right?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates whether this container shall be centered horizontally within the AbsoluteLayout area. The values * of the attributes left and right are ignored when this feature is activated. */ centerHorizontally?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates whether this container should be centered vertically within the AbsoluteLayout area. The values * of the attributes top and bottom are ignored when this feature is activated. */ centerVertically?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Child control of the position container */ control?: sap.ui.core.Control; } /** * The Absolute Layout positions its child controls absolutely * * @deprecated As of version 1.38. the concept has been discarded. */ class AbsoluteLayout extends sap.ui.core.Control { /** * Constructor for a new layout/AbsoluteLayout. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. */ constructor( /** * initial settings for the new control */ mSettings?: sap.zen.commons.layout.$AbsoluteLayoutSettings ); /** * Constructor for a new layout/AbsoluteLayout. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: sap.zen.commons.layout.$AbsoluteLayoutSettings ); /** * Creates a new subclass of class sap.zen.commons.layout.AbsoluteLayout with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.zen.commons.layout.AbsoluteLayout >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.zen.commons.layout.AbsoluteLayout. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds the given control and a corresponding position container into the aggregation named 'positions'. * Returns 'this' to allow method chaining. */ addContent( /** * The content to add; if empty, nothing is inserted. */ oContent: sap.ui.core.Control, /** * JSON-like object which defines the position of the child control in the layout. The object is expected * to have one or more from the attribute set top, bottom, left, right; each with a value of type sap.ui.core.CSSSize. * If no object is given, the default is left=0px,right=0px */ oPos: object ): sap.zen.commons.layout.AbsoluteLayout; /** * Adds some position to the aggregation {@link #getPositions positions}. * * * @returns Reference to `this` in order to allow method chaining */ addPosition( /** * The position to add; if empty, nothing is inserted */ oPosition: sap.zen.commons.layout.PositionContainer ): this; /** * Destroys all aggregated position containers and their child controls. Returns 'this' to allow method * chaining. */ destroyContent(): sap.zen.commons.layout.AbsoluteLayout; /** * Destroys all the positions in the aggregation {@link #getPositions positions}. * * * @returns Reference to `this` in order to allow method chaining */ destroyPositions(): this; /** * Returns an array of the controls contained in the aggregated position containers (might be empty). */ getContent(): sap.ui.core.Control[]; /** * Gets current value of property {@link #getHeight height}. * * The overall height of the control. When not set, 100% is automatically set. * * Default value is `"100%"`. * * * @returns Value of property `height` */ getHeight(): sap.ui.core.CSSSize; /** * Gets current value of property {@link #getHorizontalScrolling horizontalScrolling}. * * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode. * * Default value is `Hidden`. * * * @returns Value of property `horizontalScrolling` */ getHorizontalScrolling(): sap.ui.core.Scrolling; /** * Gets content of aggregation {@link #getPositions positions}. * * Positioned child controls within the layout */ getPositions(): sap.zen.commons.layout.PositionContainer[]; /** * Gets current value of property {@link #getVerticalScrolling verticalScrolling}. * * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode. * * Default value is `Hidden`. * * * @returns Value of property `verticalScrolling` */ getVerticalScrolling(): sap.ui.core.Scrolling; /** * Gets current value of property {@link #getWidth width}. * * The overall width of the control. When not set, 100% is automatically set. * * Default value is `"100%"`. * * * @returns Value of property `width` */ getWidth(): sap.ui.core.CSSSize; /** * Checks for the provided sap.ui.core.Control in the aggregated position containers, and returns the index * of the container in the positions aggregation if found, or '-1' otherwise. */ indexOfContent( /** * The content of which the index is looked for */ oContent: sap.ui.core.Control ): int; /** * Checks for the provided `sap.zen.commons.layout.PositionContainer` in the aggregation {@link #getPositions positions}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfPosition( /** * The position whose index is looked for */ oPosition: sap.zen.commons.layout.PositionContainer ): int; /** * Inserts the given control and a corresponding position container into the aggregation named 'positions'. * Returns 'this' to allow method chaining. */ insertContent( /** * The content to insert; if empty, nothing is inserted */ oContent: sap.ui.core.Control, /** * The '0'-based index where the content shall be inserted at. For a negative value of iIndex, the content * is inserted at position '0'; for a value greater than the current size of the aggregation, the content * is inserted at the last position. */ iIndex: int, /** * JSON-like object which defines the position of the child control within the layout. The object is expected * to have one or more from the attribute set top, bottom, left, right; each with a value of type sap.ui.core.CSSSize. * If no object is given, the default is left=0px,right=0px. */ oPos: object ): sap.zen.commons.layout.AbsoluteLayout; /** * Inserts a position into the aggregation {@link #getPositions positions}. * * * @returns Reference to `this` in order to allow method chaining */ insertPosition( /** * The position to insert; if empty, nothing is inserted */ oPosition: sap.zen.commons.layout.PositionContainer, /** * The `0`-based index the position should be inserted at; for a negative value of `iIndex`, the position * is inserted at position 0; for a value greater than the current size of the aggregation, the position * is inserted at the last position */ iIndex: int ): this; /** * Removes all aggregated position containers. Returns an array of the controls contained in the removed * position containers (might be empty). */ removeAllContent(): sap.ui.core.Control[]; /** * Removes all the controls from the aggregation {@link #getPositions positions}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllPositions(): sap.zen.commons.layout.PositionContainer[]; /** * Removes the given control and its corresponding position container from the aggregation named 'positions'. */ removeContent( /** * The content control to remove, its ID, or the index of the corresponding position container in the 'positions' * aggregation. */ oContent: object ): sap.ui.core.Control; /** * Removes a position from the aggregation {@link #getPositions positions}. * * * @returns The removed position or `null` */ removePosition( /** * The position to remove or its index or id */ vPosition: int | string | sap.zen.commons.layout.PositionContainer ): sap.zen.commons.layout.PositionContainer | null; /** * Sets a new value for property {@link #getHeight height}. * * The overall height of the control. When not set, 100% is automatically set. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"100%"`. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ sHeight?: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getHorizontalScrolling horizontalScrolling}. * * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Hidden`. * * * @returns Reference to `this` in order to allow method chaining */ setHorizontalScrolling( /** * New value for property `horizontalScrolling` */ sHorizontalScrolling?: sap.ui.core.Scrolling ): this; /** * Allows to set or change the position information of the given child control */ setPositionOfChild( /** * The child control for which to change the position information; if empty or not aggregated, nothing is * changed */ oControl: sap.ui.core.Control, /** * JSON-like object which defines the position of the child control. The object is expected to have one * or more from the attribute set top, bottom, left, right; each with a value of type sap.ui.core.CSSSize. * If no object is given, the default is used which is left=0px,right=0px. */ oPos: object ): boolean; /** * Sets a new value for property {@link #getVerticalScrolling verticalScrolling}. * * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Hidden`. * * * @returns Reference to `this` in order to allow method chaining */ setVerticalScrolling( /** * New value for property `verticalScrolling` */ sVerticalScrolling?: sap.ui.core.Scrolling ): this; /** * Sets a new value for property {@link #getWidth width}. * * The overall width of the control. When not set, 100% is automatically set. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"100%"`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: sap.ui.core.CSSSize ): this; } /** * @deprecated As of version 1.38. Instead, use the `sap.ui.layout.Grid` control. */ class MatrixLayout extends sap.ui.core.Control { /** * Constructor for a new layout/MatrixLayout. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. */ constructor( /** * initial settings for the new control */ mSettings?: sap.zen.commons.layout.$MatrixLayoutSettings ); /** * Constructor for a new layout/MatrixLayout. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: sap.zen.commons.layout.$MatrixLayoutSettings ); /** * Creates a new subclass of class sap.zen.commons.layout.MatrixLayout with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.zen.commons.layout.MatrixLayout. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some row to the aggregation {@link #getRows rows}. * * * @returns Reference to `this` in order to allow method chaining */ addRow( /** * The row to add; if empty, nothing is inserted */ oRow: sap.zen.commons.layout.MatrixLayoutRow ): this; /** * Creates a new matrix layout row and appends it to this matrix layout. * * Each argument must be either a matrix layout cell, which is added to the row "as is", or an arbitrary * content control, which is wrapped with a new (default) matrix layout cell first and then added to the * row. * * * @returns `this` to allow method chaining */ createRow( /** * to add */ rowContent: | sap.ui.core.Control | sap.zen.commons.layout.MatrixLayoutCell | string ): sap.zen.commons.layout.MatrixLayout; /** * Destroys all the rows in the aggregation {@link #getRows rows}. * * * @returns Reference to `this` in order to allow method chaining */ destroyRows(): this; /** * Gets current value of property {@link #getColumns columns}. * * Number of columns. If not specified, the number of columns will be determined from the given cells. * * * @returns Value of property `columns` */ getColumns(): int; /** * Gets current value of property {@link #getHeight height}. * * CSS height of the matrix layout. * * * @returns Value of property `height` */ getHeight(): sap.ui.core.CSSSize; /** * Gets current value of property {@link #getLayoutFixed layoutFixed}. * * Sets the table layout. If fixed the width parameter of a column has priority, if not the width of the * content of the colums has priority. The default is "fixed". If the fixed layout is used a adequate width * of the MatrixLayout should be provided. Otherwise the column width displayed could be different than * the given ones because of browser dependend optimazations. * * Default value is `true`. * * * @returns Value of property `layoutFixed` */ getLayoutFixed(): boolean; /** * Gets content of aggregation {@link #getRows rows}. * * The matrix layout's individual rows. */ getRows(): sap.zen.commons.layout.MatrixLayoutRow[]; /** * Gets current value of property {@link #getWidth width}. * * CSS width of the matrix layout. If the LayoutFixed = true a adequate width should be provided. * * * @returns Value of property `width` */ getWidth(): sap.ui.core.CSSSize; /** * Gets current value of property {@link #getWidths widths}. * * Widths of the columns. Use an array to define the widths of the columns. If a column shall have an automatical * sizing enter "auto" for this column width. * * * @returns Value of property `widths` */ getWidths(): sap.ui.core.CSSSize[]; /** * Checks for the provided `sap.zen.commons.layout.MatrixLayoutRow` in the aggregation {@link #getRows rows}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfRow( /** * The row whose index is looked for */ oRow: sap.zen.commons.layout.MatrixLayoutRow ): int; /** * Inserts a row into the aggregation {@link #getRows rows}. * * * @returns Reference to `this` in order to allow method chaining */ insertRow( /** * The row to insert; if empty, nothing is inserted */ oRow: sap.zen.commons.layout.MatrixLayoutRow, /** * The `0`-based index the row should be inserted at; for a negative value of `iIndex`, the row is inserted * at position 0; for a value greater than the current size of the aggregation, the row is inserted at the * last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getRows rows}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllRows(): sap.zen.commons.layout.MatrixLayoutRow[]; /** * Removes a row from the aggregation {@link #getRows rows}. * * * @returns The removed row or `null` */ removeRow( /** * The row to remove or its index or id */ vRow: int | string | sap.zen.commons.layout.MatrixLayoutRow ): sap.zen.commons.layout.MatrixLayoutRow | null; /** * Sets a new value for property {@link #getColumns columns}. * * Number of columns. If not specified, the number of columns will be determined from the given cells. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setColumns( /** * New value for property `columns` */ iColumns?: int ): this; /** * Sets a new value for property {@link #getHeight height}. * * CSS height of the matrix layout. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ sHeight?: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getLayoutFixed layoutFixed}. * * Sets the table layout. If fixed the width parameter of a column has priority, if not the width of the * content of the colums has priority. The default is "fixed". If the fixed layout is used a adequate width * of the MatrixLayout should be provided. Otherwise the column width displayed could be different than * the given ones because of browser dependend optimazations. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setLayoutFixed( /** * New value for property `layoutFixed` */ bLayoutFixed?: boolean ): this; /** * Sets a new value for property {@link #getWidth width}. * * CSS width of the matrix layout. If the LayoutFixed = true a adequate width should be provided. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getWidths widths}. * * Widths of the columns. Use an array to define the widths of the columns. If a column shall have an automatical * sizing enter "auto" for this column width. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setWidths( /** * New value for property `widths` */ sWidths?: sap.ui.core.CSSSize[] ): this; } /** * Non-control element used as part of a matrix layout's inner structure. * * @deprecated As of version 1.38. Instead, use the `sap.ui.layout.Grid` control. */ class MatrixLayoutCell extends sap.ui.core.Element { /** * Constructor for a new layout/MatrixLayoutCell. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. */ constructor( /** * initial settings for the new control */ mSettings?: sap.zen.commons.layout.$MatrixLayoutCellSettings ); /** * Constructor for a new layout/MatrixLayoutCell. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: sap.zen.commons.layout.$MatrixLayoutCellSettings ); /** * Creates a new subclass of class sap.zen.commons.MatrixLayoutCell with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.zen.commons.layout.MatrixLayoutCell >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.zen.commons.MatrixLayoutCell. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some content to the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ addContent( /** * The content to add; if empty, nothing is inserted */ oContent: sap.ui.core.Control ): this; /** * The string given as "sStyleClass" will be added to the "class" attribute of this element's root HTML * element. * * This method is intended to be used to mark controls as being of a special type for which special styling * can be provided using CSS selectors that reference this style class name. * * * ```javascript * * Example: * myButton.addStyleClass("myRedTextButton"); // add a CSS class to one button instance * * ...and in CSS: * .myRedTextButton { * color: red; * } * ``` * * * This will add the CSS class "myRedTextButton" to the Button HTML and the CSS code above will then make * the text in this particular button red. * * Only characters allowed inside HTML attributes are allowed. Quotes are not allowed and this method will * ignore any strings containing quotes. Strings containing spaces are interpreted as ONE custom style class * (even though CSS selectors interpret them as different classes) and can only removed later by calling * removeStyleClass() with exactly the same (space-containing) string as parameter. Multiple calls with * the same sStyleClass will have no different effect than calling once. If sStyleClass is null, the call * is ignored. * * Returns `this` to allow method chaining */ addStyleClass( /** * the CSS class name to be added */ sStyleClass: string ): sap.zen.commons.layout.MatrixLayoutCell; /** * Destroys all the content in the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Gets current value of property {@link #getBackgroundDesign backgroundDesign}. * * Determines the matrix layout cell's background design. * * Default value is `'Transparent'`. * * * @returns Value of property `backgroundDesign` */ getBackgroundDesign(): /* was: sap.zen.commons.BackgroundDesign */ any; /** * Gets current value of property {@link #getColSpan colSpan}. * * Determines how many columns of the underlying grid structure are occupied by this matrix layout cell. * * Default value is `1`. * * * @returns Value of property `colSpan` */ getColSpan(): int; /** * Gets content of aggregation {@link #getContent content}. * * The matrix layout cell's content (arbitrary controls). * * If the matrix row has a defined height and the matrix has layoutFixed = true, the controls inside of * a cell should all use the same unit for its height property. */ getContent(): sap.ui.core.Control[]; /** * Gets current value of property {@link #getHAlign hAlign}. * * Determines the horizontal alignment of the matrix layout cell's content with the cell's borders. * * Default value is `'Begin'`. * * * @returns Value of property `hAlign` */ getHAlign(): sap.zen.commons.HAlign; /** * Gets current value of property {@link #getPadding padding}. * * Determines the padding of the matrix layout cell's content within the cell's borders. The default value * is appropriate for all cells in a form-like layout. Consider to remove the padding on the outer layout * in case of nesting. * * Default value is `'End'`. * * * @returns Value of property `padding` */ getPadding(): sap.zen.commons.Padding; /** * Gets current value of property {@link #getRowSpan rowSpan}. * * Determines how many rows of the underlying grid structure are occupied by this matrix layout cell. In * case a row-height is used, all rows affected by the RowSpan must have the same unit. * * Default value is `1`. * * * @returns Value of property `rowSpan` */ getRowSpan(): int; /** * Gets current value of property {@link #getSeparation separation}. * * Determines how a matrix layout cell is separated from its predecessor, via a vertical gutter of variable * width, with or without a vertical line. * * Default value is `'None'`. * * * @returns Value of property `separation` */ getSeparation(): sap.zen.commons.Separation; /** * Gets current value of property {@link #getVAlign vAlign}. * * Determines the vertical alignment of the matrix layout cell's content with the cell's borders. * * Default value is `'Middle'`. * * * @returns Value of property `vAlign` */ getVAlign(): sap.zen.commons.VAlign; /** * Returns true if the given style class string is valid and if this Element has this style class set via * a previous call to addStyleClass(). */ hasStyleClass( /** * the style to check for */ sStyleClass: string ): boolean; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContent( /** * The content whose index is looked for */ oContent: sap.ui.core.Control ): int; /** * Inserts a content into the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ insertContent( /** * The content to insert; if empty, nothing is inserted */ oContent: sap.ui.core.Control, /** * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content * is inserted at position 0; for a value greater than the current size of the aggregation, the content * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getContent content}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllContent(): sap.ui.core.Control[]; /** * Removes a content from the aggregation {@link #getContent content}. * * * @returns The removed content or `null` */ removeContent( /** * The content to remove or its index or id */ vContent: int | string | sap.ui.core.Control ): sap.ui.core.Control | null; /** * Removes the given string from the list of custom style classes that have been set previously. Regular * style classes like "sapUiBtn" cannot be removed. * * Returns `this` to allow method chaining */ removeStyleClass( /** * the style to be removed */ sStyleClass: string ): sap.zen.commons.layout.MatrixLayoutCell; /** * Sets a new value for property {@link #getBackgroundDesign backgroundDesign}. * * Determines the matrix layout cell's background design. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'Transparent'`. * * * @returns Reference to `this` in order to allow method chaining */ setBackgroundDesign( /** * New value for property `backgroundDesign` */ sBackgroundDesign?: /* was: sap.zen.commons.BackgroundDesign */ any ): this; /** * Sets a new value for property {@link #getColSpan colSpan}. * * Determines how many columns of the underlying grid structure are occupied by this matrix layout cell. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `1`. * * * @returns Reference to `this` in order to allow method chaining */ setColSpan( /** * New value for property `colSpan` */ iColSpan?: int ): this; /** * Sets a new value for property {@link #getHAlign hAlign}. * * Determines the horizontal alignment of the matrix layout cell's content with the cell's borders. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'Begin'`. * * * @returns Reference to `this` in order to allow method chaining */ setHAlign( /** * New value for property `hAlign` */ sHAlign?: sap.zen.commons.HAlign ): this; /** * Sets a new value for property {@link #getPadding padding}. * * Determines the padding of the matrix layout cell's content within the cell's borders. The default value * is appropriate for all cells in a form-like layout. Consider to remove the padding on the outer layout * in case of nesting. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'End'`. * * * @returns Reference to `this` in order to allow method chaining */ setPadding( /** * New value for property `padding` */ sPadding?: sap.zen.commons.Padding ): this; /** * Sets a new value for property {@link #getRowSpan rowSpan}. * * Determines how many rows of the underlying grid structure are occupied by this matrix layout cell. In * case a row-height is used, all rows affected by the RowSpan must have the same unit. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `1`. * * * @returns Reference to `this` in order to allow method chaining */ setRowSpan( /** * New value for property `rowSpan` */ iRowSpan?: int ): this; /** * Sets a new value for property {@link #getSeparation separation}. * * Determines how a matrix layout cell is separated from its predecessor, via a vertical gutter of variable * width, with or without a vertical line. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'None'`. * * * @returns Reference to `this` in order to allow method chaining */ setSeparation( /** * New value for property `separation` */ sSeparation?: sap.zen.commons.Separation ): this; /** * Sets a new value for property {@link #getVAlign vAlign}. * * Determines the vertical alignment of the matrix layout cell's content with the cell's borders. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'Middle'`. * * * @returns Reference to `this` in order to allow method chaining */ setVAlign( /** * New value for property `vAlign` */ sVAlign?: sap.zen.commons.VAlign ): this; } /** * Non-control element used as part of a matrix layout's inner structure. * * @deprecated As of version 1.38. replaced by {@link sap.ui.layout.Grid}. */ class MatrixLayoutRow extends sap.ui.core.Element { /** * Constructor for a new layout/MatrixLayoutRow. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. */ constructor( /** * initial settings for the new control */ mSettings?: sap.zen.commons.layout.$MatrixLayoutRowSettings ); /** * Constructor for a new layout/MatrixLayoutRow. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: sap.zen.commons.layout.$MatrixLayoutRowSettings ); /** * Creates a new subclass of class sap.zen.commons.layout.MatrixLayoutRow with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.zen.commons.layout.MatrixLayoutRow >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.zen.commons.layout.MatrixLayoutRow. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some cell to the aggregation {@link #getCells cells}. * * * @returns Reference to `this` in order to allow method chaining */ addCell( /** * The cell to add; if empty, nothing is inserted */ oCell: sap.zen.commons.layout.MatrixLayoutCell ): this; /** * The string given as "sStyleClass" will be added to the "class" attribute of this element's root HTML * element. * * This method is intended to be used to mark controls as being of a special type for which special styling * can be provided using CSS selectors that reference this style class name. * * * ```javascript * * Example: * myButton.addStyleClass("myRedTextButton"); // add a CSS class to one button instance * * ...and in CSS: * .myRedTextButton { * color: red; * } * ``` * * * This will add the CSS class "myRedTextButton" to the Button HTML and the CSS code above will then make * the text in this particular button red. * * Only characters allowed inside HTML attributes are allowed. Quotes are not allowed and this method will * ignore any strings containing quotes. Strings containing spaces are interpreted as ONE custom style class * (even though CSS selectors interpret them as different classes) and can only removed later by calling * removeStyleClass() with exactly the same (space-containing) string as parameter. Multiple calls with * the same sStyleClass will have no different effect than calling once. If sStyleClass is null, the call * is ignored. * * Returns `this` to allow method chaining */ addStyleClass( /** * the CSS class name to be added */ sStyleClass: string ): sap.zen.commons.layout.MatrixLayoutRow; /** * Destroys all the cells in the aggregation {@link #getCells cells}. * * * @returns Reference to `this` in order to allow method chaining */ destroyCells(): this; /** * Gets content of aggregation {@link #getCells cells}. * * The matrix layout row's individual cells. */ getCells(): sap.zen.commons.layout.MatrixLayoutCell[]; /** * Gets current value of property {@link #getHeight height}. * * Height of the row. * * * @returns Value of property `height` */ getHeight(): sap.ui.core.CSSSize; /** * Returns true if the given style class string is valid and if this Element has this style class set via * a previous call to addStyleClass(). */ hasStyleClass( /** * the style to check for */ sStyleClass: string ): boolean; /** * Checks for the provided `sap.zen.commons.layout.MatrixLayoutCell` in the aggregation {@link #getCells cells}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfCell( /** * The cell whose index is looked for */ oCell: sap.zen.commons.layout.MatrixLayoutCell ): int; /** * Inserts a cell into the aggregation {@link #getCells cells}. * * * @returns Reference to `this` in order to allow method chaining */ insertCell( /** * The cell to insert; if empty, nothing is inserted */ oCell: sap.zen.commons.layout.MatrixLayoutCell, /** * The `0`-based index the cell should be inserted at; for a negative value of `iIndex`, the cell is inserted * at position 0; for a value greater than the current size of the aggregation, the cell is inserted at * the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getCells cells}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllCells(): sap.zen.commons.layout.MatrixLayoutCell[]; /** * Removes a cell from the aggregation {@link #getCells cells}. * * * @returns The removed cell or `null` */ removeCell( /** * The cell to remove or its index or id */ vCell: int | string | sap.zen.commons.layout.MatrixLayoutCell ): sap.zen.commons.layout.MatrixLayoutCell | null; /** * Removes the given string from the list of custom style classes that have been set previously. Regular * style classes like "sapUiBtn" cannot be removed. * * Returns `this` to allow method chaining */ removeStyleClass( /** * the style to be removed */ sStyleClass: string ): sap.zen.commons.layout.MatrixLayoutRow; /** * Sets a new value for property {@link #getHeight height}. * * Height of the row. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ sHeight?: sap.ui.core.CSSSize ): this; } /** * Is used to specify the position of a control in the AbsoluteLayout * * @deprecated As of version 1.89. the concept has been discarded. */ class PositionContainer extends sap.ui.core.Element { /** * Constructor for a new layout/PositionContainer. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. */ constructor( /** * initial settings for the new control */ mSettings?: sap.zen.commons.layout.$PositionContainerSettings ); /** * Constructor for a new layout/PositionContainer. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: sap.zen.commons.layout.$PositionContainerSettings ); /** * Creates a new subclass of class sap.zen.commons.layout.PositionContainer with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.zen.commons.layout.PositionContainer >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.zen.commons.layout.PositionContainer. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Destroys the control in the aggregation {@link #getControl control}. * * * @returns Reference to `this` in order to allow method chaining */ destroyControl(): this; /** * Gets current value of property {@link #getBottom bottom}. * * Defines the distance to the bottom of the layout (as specified in HTML) * * * @returns Value of property `bottom` */ getBottom(): sap.ui.core.CSSSize; /** * Gets current value of property {@link #getCenterHorizontally centerHorizontally}. * * Indicates whether this container shall be centered horizontally within the AbsoluteLayout area. The values * of the attributes left and right are ignored when this feature is activated. * * Default value is `false`. * * * @returns Value of property `centerHorizontally` */ getCenterHorizontally(): boolean; /** * Gets current value of property {@link #getCenterVertically centerVertically}. * * Indicates whether this container should be centered vertically within the AbsoluteLayout area. The values * of the attributes top and bottom are ignored when this feature is activated. * * Default value is `false`. * * * @returns Value of property `centerVertically` */ getCenterVertically(): boolean; /** * Gets content of aggregation {@link #getControl control}. * * Child control of the position container */ getControl(): sap.ui.core.Control; /** * Gets current value of property {@link #getLeft left}. * * Defines the distance to the left of the layout (as specified in HTML) * * * @returns Value of property `left` */ getLeft(): sap.ui.core.CSSSize; /** * Gets current value of property {@link #getRight right}. * * Defines the distance to the right of the layout (as specified in HTML) * * * @returns Value of property `right` */ getRight(): sap.ui.core.CSSSize; /** * Gets current value of property {@link #getTop top}. * * Defines the distance to the top of the layout (as specified in HTML) * * * @returns Value of property `top` */ getTop(): sap.ui.core.CSSSize; /** * Sets a new value for property {@link #getBottom bottom}. * * Defines the distance to the bottom of the layout (as specified in HTML) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setBottom( /** * New value for property `bottom` */ sBottom?: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getCenterHorizontally centerHorizontally}. * * Indicates whether this container shall be centered horizontally within the AbsoluteLayout area. The values * of the attributes left and right are ignored when this feature is activated. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setCenterHorizontally( /** * New value for property `centerHorizontally` */ bCenterHorizontally?: boolean ): this; /** * Sets a new value for property {@link #getCenterVertically centerVertically}. * * Indicates whether this container should be centered vertically within the AbsoluteLayout area. The values * of the attributes top and bottom are ignored when this feature is activated. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setCenterVertically( /** * New value for property `centerVertically` */ bCenterVertically?: boolean ): this; /** * Sets the aggregated {@link #getControl control}. * * * @returns Reference to `this` in order to allow method chaining */ setControl( /** * The control to set */ oControl: sap.ui.core.Control ): this; /** * Sets a new value for property {@link #getLeft left}. * * Defines the distance to the left of the layout (as specified in HTML) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setLeft( /** * New value for property `left` */ sLeft?: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getRight right}. * * Defines the distance to the right of the layout (as specified in HTML) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setRight( /** * New value for property `right` */ sRight?: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getTop top}. * * Defines the distance to the top of the layout (as specified in HTML) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setTop( /** * New value for property `top` */ sTop?: sap.ui.core.CSSSize ): this; /** * Updates the position properties of the container according to the given position in JSON style. */ updatePosition( /** * JSON-like object which defines the position of the child control in the absolute layout. The object is * expected to have one or more out of the attributes top, bottom, left, right (each with a value of type * sap.ui.core.CSSSize). If no object is given, nothing is updated. */ oPos: object ): void; } } /** * Horizontal alignment, e.g. of a layout cell's content within the cell's borders. Note that some values * depend on the current locale's writing direction while others do not. * * @deprecated As of version 1.89.0. Please use the WD Grid control instead. */ enum HAlign { /** * Aligned towards the beginning of a line, in the current locale's writing direction. */ Begin = "Begin", /** * Horizontally centered. */ Center = "Center", /** * Aligned towards the end of a line, in the current locale's writing direction. */ End = "End", /** * Left aligned, regardless of the current locale's writing direction. */ Left = "Left", /** * Right aligned, regardless of the current locale's writing direction. */ Right = "Right", } /** * Padding, e.g. of a layout cell's content within the cell's borders. Note that all options except "None" * include a padding of 2px at the top and bottom, and differ only in the presence of a 4px padding towards * the beginning or end of a line, in the current locale's writing direction. * * @deprecated As of version 1.89.0. Please use the WD Grid control instead. * @experimental */ enum Padding { /** * Top and bottom padding of 2px. Padding of 4px towards the beginning of a line, in the current locale's * writing direction, but none towards its end. */ Begin = "Begin", /** * Top and bottom padding of 2px. Padding of 4px towards both the beginning and end of a line. */ Both = "Both", /** * Top and bottom padding of 2px. Padding of 4px towards the end of a line, in the current locale's writing * direction, but none towards its beginning. */ End = "End", /** * Top and bottom padding of 2px. No padding towards neither the beginning nor end of a line. */ Neither = "Neither", /** * No padding at all. */ None = "None", } /** * Separation, e.g. of a layout cell from its neighbor, via a vertical gutter of defined width, with or * without a vertical line in its middle. * * @deprecated As of version 1.89.0. Please use the WD Grid control instead. */ enum Separation { /** * A large (63px) vertical gutter without a vertical line. */ Large = "Large", /** * A large (63px) vertical gutter with a vertical line in its middle. */ LargeWithLine = "LargeWithLine", /** * A medium (31px) vertical gutter without a vertical line. */ Medium = "Medium", /** * A medium (31px) vertical gutter with a vertical line in its middle. */ MediumWithLine = "MediumWithLine", /** * No gutter at all (0px), and without a vertical line, of course. */ None = "None", /** * A small (17px) vertical gutter without a vertical line. */ Small = "Small", /** * A small (17px) vertical gutter with a vertical line in its middle. */ SmallWithLine = "SmallWithLine", } /** * Vertical alignment, e.g. of a layout cell's content within the cell's borders. * * @deprecated As of version 1.89.0. Please use the WD Grid control instead. */ enum VAlign { /** * Aligned at the bottom. */ Bottom = "Bottom", /** * Vertically centered. */ Middle = "Middle", /** * Aligned at the top. */ Top = "Top", } } } interface IUI5DefineDependencyNames { "sap/zen/commons/HAlign": undefined; "sap/zen/commons/layout/AbsoluteLayout": undefined; "sap/zen/commons/layout/MatrixLayout": undefined; "sap/zen/commons/layout/MatrixLayoutCell": undefined; "sap/zen/commons/layout/MatrixLayoutRow": undefined; "sap/zen/commons/layout/PositionContainer": undefined; "sap/zen/commons/library": undefined; "sap/zen/commons/Padding": undefined; "sap/zen/commons/Separation": undefined; "sap/zen/commons/VAlign": undefined; } }