diff --git a/types/openui5/openui5-tests.ts b/types/openui5/openui5-tests.ts index 1375d2905de330..e3e58e5913f9a5 100644 --- a/types/openui5/openui5-tests.ts +++ b/types/openui5/openui5-tests.ts @@ -282,3 +282,5 @@ new FeedInput().addAction(link); // 1.140.0 const p13nEngine = new Engine(); // version 1.141.0 added - tests are not required as the type definitions are generated and the generator is sufficiently tested + +// version 1.142.0 added - tests are not required as the type definitions are generated and the generator is sufficiently tested diff --git a/types/openui5/package.json b/types/openui5/package.json index 091fd6d34b8a29..f125dab93d6fd2 100644 --- a/types/openui5/package.json +++ b/types/openui5/package.json @@ -1,7 +1,7 @@ { "private": true, "name": "@types/openui5", - "version": "1.141.9999", + "version": "1.142.9999", "nonNpm": true, "nonNpmDescription": "openui5", "projects": [ diff --git a/types/openui5/sap.f.d.ts b/types/openui5/sap.f.d.ts index 472954a583e919..a90dd24b90e777 100644 --- a/types/openui5/sap.f.d.ts +++ b/types/openui5/sap.f.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/tnt/library" { export interface IToolHeader { diff --git a/types/openui5/sap.m.d.ts b/types/openui5/sap.m.d.ts index efb8db6b0fdb50..0b444ef929174f 100644 --- a/types/openui5/sap.m.d.ts +++ b/types/openui5/sap.m.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/f/library" { export interface IShellBar { @@ -2944,9 +2944,6 @@ declare module "sap/m/library" { * Sets grid layout for rendering the table popins. The grid width for each table popin is comparatively * larger than `GridSmall`, hence this allows less content to be rendered in a single popin row. * - * **Note:** This feature is currently not supported with Internet Explorer and Edge (version lower than - * 16) browsers. - * * @since 1.52 */ GridLarge = "GridLarge", @@ -2955,9 +2952,6 @@ declare module "sap/m/library" { * this allows more content to be rendered in a single popin row. This value defines small grid width for * the table popins. * - * **Note:** This feature is currently not supported with Internet Explorer and Edge (version lower than - * 16) browsers. - * * @since 1.52 */ GridSmall = "GridSmall", @@ -3145,6 +3139,25 @@ declare module "sap/m/library" { */ XXSmall = "XXSmall", } + /** + * Different SegmentedButton items sizing modes. + * + * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'SegmentedButtonContentMode'. + */ + export enum SegmentedButtonContentMode { + /** + * Each item fits its content and extra space is placed after the last item. + * + * @since 1.42 + */ + ContentFit = "ContentFit", + /** + * All items are sized equally to fill the available space. + * + * @since 1.42 + */ + EqualSized = "EqualSized", + } /** * A string type that represents column ratio. * @@ -7459,6 +7472,15 @@ declare module "sap/m/Avatar" { */ mParameters?: object ): this; + /** + * See: + * sap.ui.core.Control#getAccessibilityInfo + * + * @ui5-protected Do not call from applications (only from related classes in the framework) + * + * @returns Current accessibility state of the Avatar + */ + getAccessibilityInfo(): object; /** * Gets current value of property {@link #getActive active}. * @@ -24279,11 +24301,11 @@ declare module "sap/m/Dialog" { rightButton?: Button | string; /** - * In the Dialog focus is set first on the `beginButton` and then on `endButton`, when available. If another - * control needs to get the focus, set the `initialFocus` with the control which should be focused on. Setting - * `initialFocus` to input controls doesn't open the On-Screen keyboard on mobile device as, due to browser - * restriction, the On-Screen keyboard can't be opened with JavaScript code. The opening of On-Screen keyboard - * must be triggered by real user action. + * In the Dialog, focus is initially set on the first focusable element, or on the dialog itself if no such + * element is available. If another control needs to receive focus, set the `initialFocus` to the control + * that should be focused. Setting `initialFocus` on input controls does not open the on-screen keyboard + * on mobile devices. Due to browser restrictions, the on-screen keyboard can't be opened with JavaScript + * code; it must be triggered explicitly by the user. * * @since 1.15.0 */ @@ -53415,7 +53437,7 @@ declare module "sap/m/ListBase" { /** * The list item action that fired the event */ - itemAction?: ListItemAction; + action?: ListItemAction; /** * The list item in which the action was performed @@ -58148,7 +58170,7 @@ declare module "sap/m/MessageBox" { /** * callback function to be called when the user closes the dialog */ - onClose?: Function; + onClose?: (p1: (Action | keyof typeof Action) | string | null) => void; /** * Title to be displayed in the alert dialog */ @@ -58277,7 +58299,7 @@ declare module "sap/m/MessageBox" { /** * Callback to be called when the user closes the dialog */ - onClose?: Function; + onClose?: (p1: (Action | keyof typeof Action) | string | null) => void; /** * Title to display in the confirmation dialog */ @@ -58403,7 +58425,7 @@ declare module "sap/m/MessageBox" { /** * Callback when the user closes the dialog */ - onClose?: Function; + onClose?: (p1: (Action | keyof typeof Action) | string | null) => void; /** * Title of the error dialog */ @@ -58526,7 +58548,7 @@ declare module "sap/m/MessageBox" { /** * Callback when the user closes the dialog */ - onClose?: Function; + onClose?: (p1: (Action | keyof typeof Action) | string | null) => void; /** * Title of the information dialog */ @@ -58677,7 +58699,7 @@ declare module "sap/m/MessageBox" { /** * Function to be called when the user taps a button or closes the message box. */ - onClose?: Function; + onClose?: (p1: (Action | keyof typeof Action) | string | null) => void; /** * ID to be used for the dialog. Intended for test scenarios, not recommended for productive apps */ @@ -58781,7 +58803,7 @@ declare module "sap/m/MessageBox" { /** * Callback when the user closes the dialog */ - onClose?: Function; + onClose?: (p1: (Action | keyof typeof Action) | string | null) => void; /** * Title of the success dialog */ @@ -58904,7 +58926,7 @@ declare module "sap/m/MessageBox" { /** * Callback when the user closes the dialog */ - onClose?: Function; + onClose?: (p1: (Action | keyof typeof Action) | string | null) => void; /** * Title of the warning dialog */ @@ -88950,9 +88972,8 @@ declare module "sap/m/PDFViewer" { * Gets current value of property {@link #getSource source}. * * Specifies the path to the PDF file to display. Can be set to a relative or an absolute path. - * Optionally, this property can also be set to a data URI path or a blob URL in all major web browsers - * except Internet Explorer and Microsoft Edge, provided that this data URI or blob URL is allowed in advance. - * For more information about URL filtering, see {@link https://ui5.sap.com/#/topic/91f3768f6f4d1014b6dd926db0e91070 URLList Validator Filtering}. + * Optionally, this property can also be set to a data URI path or a blob URL, provided that this data + * URI or blob URL is allowed in advance. For more information about URL filtering, see {@link https://ui5.sap.com/#/topic/91f3768f6f4d1014b6dd926db0e91070 URLList Validator Filtering}. * * * @returns Value of property `source` @@ -89200,9 +89221,8 @@ declare module "sap/m/PDFViewer" { * Sets a new value for property {@link #getSource source}. * * Specifies the path to the PDF file to display. Can be set to a relative or an absolute path. - * Optionally, this property can also be set to a data URI path or a blob URL in all major web browsers - * except Internet Explorer and Microsoft Edge, provided that this data URI or blob URL is allowed in advance. - * For more information about URL filtering, see {@link https://ui5.sap.com/#/topic/91f3768f6f4d1014b6dd926db0e91070 URLList Validator Filtering}. + * Optionally, this property can also be set to a data URI path or a blob URL, provided that this data + * URI or blob URL is allowed in advance. For more information about URL filtering, see {@link https://ui5.sap.com/#/topic/91f3768f6f4d1014b6dd926db0e91070 URLList Validator Filtering}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * @@ -89269,9 +89289,8 @@ declare module "sap/m/PDFViewer" { /** * Specifies the path to the PDF file to display. Can be set to a relative or an absolute path. - * Optionally, this property can also be set to a data URI path or a blob URL in all major web browsers - * except Internet Explorer and Microsoft Edge, provided that this data URI or blob URL is allowed in advance. - * For more information about URL filtering, see {@link https://ui5.sap.com/#/topic/91f3768f6f4d1014b6dd926db0e91070 URLList Validator Filtering}. + * Optionally, this property can also be set to a data URI path or a blob URL, provided that this data + * URI or blob URL is allowed in advance. For more information about URL filtering, see {@link https://ui5.sap.com/#/topic/91f3768f6f4d1014b6dd926db0e91070 URLList Validator Filtering}. */ source?: URI | PropertyBindingInfo | `{${string}}`; @@ -90647,7 +90666,7 @@ declare module "sap/m/PlanningCalendar" { * of the content. * * **Note:** There is limited browser support, hence the API is in experimental state. Browsers that currently - * support this feature are Chrome (desktop and mobile), Safari (desktop and mobile) and Edge 41. + * support this feature are Chrome (desktop and mobile), Safari (desktop and mobile) and Edge. * * There are also some known issues with respect to the scrolling behavior and focus handling. A few are * given below: @@ -91457,7 +91476,7 @@ declare module "sap/m/PlanningCalendar" { * of the content. * * **Note:** There is limited browser support, hence the API is in experimental state. Browsers that currently - * support this feature are Chrome (desktop and mobile), Safari (desktop and mobile) and Edge 41. + * support this feature are Chrome (desktop and mobile), Safari (desktop and mobile) and Edge. * * There are also some known issues with respect to the scrolling behavior and focus handling. A few are * given below: @@ -91721,7 +91740,7 @@ declare module "sap/m/PlanningCalendar" { * of the content. * * **Note:** There is limited browser support, hence the API is in experimental state. Browsers that currently - * support this feature are Chrome (desktop and mobile), Safari (desktop and mobile) and Edge 41. + * support this feature are Chrome (desktop and mobile), Safari (desktop and mobile) and Edge. * * There are also some known issues with respect to the scrolling behavior and focus handling. A few are * given below: @@ -97606,6 +97625,57 @@ declare module "sap/m/plugins/UploadSetwithTable" { */ oListener?: object ): this; + /** + * Attaches event handler `fnFunction` to the {@link #event:itemRenameCanceled itemRenameCanceled} event + * of this `sap.m.plugins.UploadSetwithTable`. + * + * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, + * otherwise it will be bound to this `sap.m.plugins.UploadSetwithTable` itself. + * + * The event is triggered when the file renaming process is canceled. + * + * @since 1.142 + * + * @returns Reference to `this` in order to allow method chaining + */ + attachItemRenameCanceled( + /** + * An application-specific payload object that will be passed to the event handler along with the event + * object when firing the event + */ + oData: object, + /** + * The function to be called when the event occurs + */ + fnFunction: (p1: UploadSetwithTable$ItemRenameCanceledEvent) => void, + /** + * Context object to call the event handler with. Defaults to this `sap.m.plugins.UploadSetwithTable` itself + */ + oListener?: object + ): this; + /** + * Attaches event handler `fnFunction` to the {@link #event:itemRenameCanceled itemRenameCanceled} event + * of this `sap.m.plugins.UploadSetwithTable`. + * + * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, + * otherwise it will be bound to this `sap.m.plugins.UploadSetwithTable` itself. + * + * The event is triggered when the file renaming process is canceled. + * + * @since 1.142 + * + * @returns Reference to `this` in order to allow method chaining + */ + attachItemRenameCanceled( + /** + * The function to be called when the event occurs + */ + fnFunction: (p1: UploadSetwithTable$ItemRenameCanceledEvent) => void, + /** + * Context object to call the event handler with. Defaults to this `sap.m.plugins.UploadSetwithTable` itself + */ + oListener?: object + ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemRenamed itemRenamed} event of this `sap.m.plugins.UploadSetwithTable`. * @@ -97982,6 +98052,26 @@ declare module "sap/m/plugins/UploadSetwithTable" { */ oListener?: object ): this; + /** + * Detaches event handler `fnFunction` from the {@link #event:itemRenameCanceled itemRenameCanceled} event + * of this `sap.m.plugins.UploadSetwithTable`. + * + * The passed function and listener object must match the ones used for event registration. + * + * @since 1.142 + * + * @returns Reference to `this` in order to allow method chaining + */ + detachItemRenameCanceled( + /** + * The function to be called, when the event occurs + */ + fnFunction: (p1: UploadSetwithTable$ItemRenameCanceledEvent) => void, + /** + * Context object on which the given function had to be called + */ + oListener?: object + ): this; /** * Detaches event handler `fnFunction` from the {@link #event:itemRenamed itemRenamed} event of this `sap.m.plugins.UploadSetwithTable`. * @@ -98160,6 +98250,20 @@ declare module "sap/m/plugins/UploadSetwithTable" { */ mParameters?: UploadSetwithTable$FileTypeMismatchEventParameters ): this; + /** + * Fires event {@link #event:itemRenameCanceled itemRenameCanceled} to attached listeners. + * + * @since 1.142 + * @ui5-protected Do not call from applications (only from related classes in the framework) + * + * @returns Reference to `this` in order to allow method chaining + */ + fireItemRenameCanceled( + /** + * Parameters to pass along with the event + */ + mParameters?: UploadSetwithTable$ItemRenameCanceledEventParameters + ): this; /** * Fires event {@link #event:itemRenamed itemRenamed} to attached listeners. * @@ -99114,6 +99218,15 @@ declare module "sap/m/plugins/UploadSetwithTable" { */ itemRenamed?: (oEvent: UploadSetwithTable$ItemRenamedEvent) => void; + /** + * The event is triggered when the file renaming process is canceled. + * + * @since 1.142 + */ + itemRenameCanceled?: ( + oEvent: UploadSetwithTable$ItemRenameCanceledEvent + ) => void; + /** * This event is fired right before the upload process begins. */ @@ -99278,6 +99391,24 @@ declare module "sap/m/plugins/UploadSetwithTable" { UploadSetwithTable >; + /** + * Parameters of the UploadSetwithTable#itemRenameCanceled event. + */ + export interface UploadSetwithTable$ItemRenameCanceledEventParameters { + /** + * The renamed UI element is of UploadItem type. + */ + item?: UploadItem; + } + + /** + * Event object of the UploadSetwithTable#itemRenameCanceled event. + */ + export type UploadSetwithTable$ItemRenameCanceledEvent = Event< + UploadSetwithTable$ItemRenameCanceledEventParameters, + UploadSetwithTable + >; + /** * Parameters of the UploadSetwithTable#itemRenamed event. */ @@ -111262,6 +111393,7 @@ declare module "sap/m/SegmentedButton" { import { IOverflowToolbarContent, IToolbarInteractiveControl, + SegmentedButtonContentMode, } from "sap/m/library"; import Button from "sap/m/Button"; @@ -111678,6 +111810,20 @@ declare module "sap/m/SegmentedButton" { * @deprecated As of version 1.28.0. replaced by `items` aggregation */ getButtons(): Button[]; + /** + * Gets current value of property {@link #getContentMode contentMode}. + * + * Defines how the content of the SegmentedButton is sized. Possible values: + * - **ContentFit**: Each button is sized according to its content. + * - **EqualSized**: All buttons have equal width, regardless of their content. + * + * Default value is `EqualSized`. + * + * @since 1.42.0 + * + * @returns Value of property `contentMode` + */ + getContentMode(): SegmentedButtonContentMode; /** * Gets current value of property {@link #getEnabled enabled}. * @@ -111737,7 +111883,8 @@ declare module "sap/m/SegmentedButton" { * Gets current value of property {@link #getWidth width}. * * Defines the width of the SegmentedButton control. If not set, it uses the minimum required width to make - * all buttons inside of the same size (based on the biggest button). + * all buttons inside of the same size (based on the biggest button). **Note:** This property functions + * only when the {@link sap.m.SegmentedButton#getContentMode contentMode} is set to EqualSized. * * * @returns Value of property `width` @@ -111885,6 +112032,29 @@ declare module "sap/m/SegmentedButton" { */ oItem: SegmentedButtonItem ): void; + /** + * Sets a new value for property {@link #getContentMode contentMode}. + * + * Defines how the content of the SegmentedButton is sized. Possible values: + * - **ContentFit**: Each button is sized according to its content. + * - **EqualSized**: All buttons have equal width, regardless of their content. + * + * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * + * Default value is `EqualSized`. + * + * @since 1.42.0 + * + * @returns Reference to `this` in order to allow method chaining + */ + setContentMode( + /** + * New value for property `contentMode` + */ + sContentMode?: + | SegmentedButtonContentMode + | keyof typeof SegmentedButtonContentMode + ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * @@ -111950,7 +112120,8 @@ declare module "sap/m/SegmentedButton" { * Sets a new value for property {@link #getWidth width}. * * Defines the width of the SegmentedButton control. If not set, it uses the minimum required width to make - * all buttons inside of the same size (based on the biggest button). + * all buttons inside of the same size (based on the biggest button). **Note:** This property functions + * only when the {@link sap.m.SegmentedButton#getContentMode contentMode} is set to EqualSized. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * @@ -111986,7 +112157,8 @@ declare module "sap/m/SegmentedButton" { export interface $SegmentedButtonSettings extends $ControlSettings { /** * Defines the width of the SegmentedButton control. If not set, it uses the minimum required width to make - * all buttons inside of the same size (based on the biggest button). + * all buttons inside of the same size (based on the biggest button). **Note:** This property functions + * only when the {@link sap.m.SegmentedButton#getContentMode contentMode} is set to EqualSized. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; @@ -112004,6 +112176,18 @@ declare module "sap/m/SegmentedButton" { */ selectedKey?: string | PropertyBindingInfo; + /** + * Defines how the content of the SegmentedButton is sized. Possible values: + * - **ContentFit**: Each button is sized according to its content. + * - **EqualSized**: All buttons have equal width, regardless of their content. + * + * @since 1.42.0 + */ + contentMode?: + | (SegmentedButtonContentMode | keyof typeof SegmentedButtonContentMode) + | PropertyBindingInfo + | `{${string}}`; + /** * The buttons of the SegmentedButton control. The items set in this aggregation are used as an interface * for the buttons displayed by the control. Only the properties ID, icon, text, enabled and textDirections @@ -112310,7 +112494,8 @@ declare module "sap/m/SegmentedButtonItem" { /** * Gets current value of property {@link #getWidth width}. * - * Sets the width of the buttons. + * Sets the width of the buttons **Note:** This property functions only when the {@link sap.m.SegmentedButton#getContentMode contentMode } + * is set to EqualSized. * * * @returns Value of property `width` @@ -112360,7 +112545,8 @@ declare module "sap/m/SegmentedButtonItem" { /** * Sets a new value for property {@link #getWidth width}. * - * Sets the width of the buttons. + * Sets the width of the buttons **Note:** This property functions only when the {@link sap.m.SegmentedButton#getContentMode contentMode } + * is set to EqualSized. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * @@ -112390,7 +112576,8 @@ declare module "sap/m/SegmentedButtonItem" { visible?: boolean | PropertyBindingInfo | `{${string}}`; /** - * Sets the width of the buttons. + * Sets the width of the buttons **Note:** This property functions only when the {@link sap.m.SegmentedButton#getContentMode contentMode } + * is set to EqualSized. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; @@ -129026,11 +129213,6 @@ declare module "sap/m/SinglePlanningCalendar" { * Determines which part of the control will remain fixed at the top of the page during vertical scrolling * as long as the control is in the viewport. * - * **Note:** Limited browser support. Browsers which do not support this feature: - * - Microsoft Internet Explorer - * - Microsoft Edge lower than version 41 (EdgeHTML 16) - * - Mozilla Firefox lower than version 59 - * * Default value is `None`. * * @since 1.62 @@ -129668,11 +129850,6 @@ declare module "sap/m/SinglePlanningCalendar" { * Determines which part of the control will remain fixed at the top of the page during vertical scrolling * as long as the control is in the viewport. * - * **Note:** Limited browser support. Browsers which do not support this feature: - * - Microsoft Internet Explorer - * - Microsoft Edge lower than version 41 (EdgeHTML 16) - * - Mozilla Firefox lower than version 59 - * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `None`. @@ -129759,11 +129936,6 @@ declare module "sap/m/SinglePlanningCalendar" { * Determines which part of the control will remain fixed at the top of the page during vertical scrolling * as long as the control is in the viewport. * - * **Note:** Limited browser support. Browsers which do not support this feature: - * - Microsoft Internet Explorer - * - Microsoft Edge lower than version 41 (EdgeHTML 16) - * - Mozilla Firefox lower than version 59 - * * @since 1.62 */ stickyMode?: @@ -153731,7 +153903,12 @@ declare module "sap/m/Token" { declare module "sap/m/Tokenizer" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; - import { ID, CSSSize } from "sap/ui/core/library"; + import { + ISemanticFormContent, + IFormContent, + ID, + CSSSize, + } from "sap/ui/core/library"; import Token from "sap/m/Token"; @@ -153757,7 +153934,12 @@ declare module "sap/m/Tokenizer" { * * @since 1.22 */ - export default class Tokenizer extends Control { + export default class Tokenizer + extends Control + implements ISemanticFormContent, IFormContent + { + __implements__sap_ui_core_ISemanticFormContent: boolean; + __implements__sap_ui_core_IFormContent: boolean; /** * Constructor for a new Tokenizer. * @@ -154268,6 +154450,20 @@ declare module "sap/m/Tokenizer" { * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): ID[]; + /** + * Gets current value of property {@link #getDisplayOnly displayOnly}. + * + * Determines whether the `Tokenizer` is in display only state. + * + * When set to `true`, the `Tokenizer` is not editable. This setting is used for forms in review mode. + * + * Default value is `false`. + * + * @since 1.142.0 + * + * @returns Value of property `displayOnly` + */ + getDisplayOnly(): boolean; /** * Gets current value of property {@link #getEditable editable}. * @@ -154318,6 +154514,31 @@ declare module "sap/m/Tokenizer" { * @returns Value of property `maxWidth` */ getMaxWidth(): CSSSize; + /** + * Gets current value of property {@link #getMultiLine multiLine}. + * + * Defines whether tokens are displayed on multiple lines. + * + * Default value is `false`. + * + * @experimental As of version 1.142. + * + * @returns Value of property `multiLine` + */ + getMultiLine(): boolean; + /** + * Gets current value of property {@link #getName name}. + * + * The name property to be used in the HTML code for the tokenizer (e.g. for HTML forms that send data to + * the server via submit). + * + * Default value is `empty string`. + * + * @since 1.142.0 + * + * @returns Value of property `name` + */ + getName(): string; /** * Gets current value of property {@link #getRenderMode renderMode}. * @@ -154356,6 +154577,19 @@ declare module "sap/m/Tokenizer" { * @returns Array of selected tokens or empty array */ getSelectedTokens(): Token[]; + /** + * Gets current value of property {@link #getShowClearAll showClearAll}. + * + * Defines whether "Clear All" button is present. Ensure `multiLine` is enabled, otherwise `showClearAll` + * will have no effect. + * + * Default value is `false`. + * + * @experimental As of version 1.142. + * + * @returns Value of property `showClearAll` + */ + getShowClearAll(): boolean; /** * Gets content of aggregation {@link #getTokens tokens}. * @@ -154523,6 +154757,27 @@ declare module "sap/m/Tokenizer" { */ bSelect: boolean ): this; + /** + * Sets a new value for property {@link #getDisplayOnly displayOnly}. + * + * Determines whether the `Tokenizer` is in display only state. + * + * When set to `true`, the `Tokenizer` is not editable. This setting is used for forms in review mode. + * + * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * + * Default value is `false`. + * + * @since 1.142.0 + * + * @returns Reference to `this` in order to allow method chaining + */ + setDisplayOnly( + /** + * New value for property `displayOnly` + */ + bDisplayOnly?: boolean + ): this; /** * Sets a new value for property {@link #getEditable editable}. * @@ -154590,6 +154845,45 @@ declare module "sap/m/Tokenizer" { */ sMaxWidth?: CSSSize ): this; + /** + * Sets a new value for property {@link #getMultiLine multiLine}. + * + * Defines whether tokens are displayed on multiple lines. + * + * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * + * Default value is `false`. + * + * @experimental As of version 1.142. + * + * @returns Reference to `this` in order to allow method chaining + */ + setMultiLine( + /** + * New value for property `multiLine` + */ + bMultiLine?: boolean + ): this; + /** + * Sets a new value for property {@link #getName name}. + * + * The name property to be used in the HTML code for the tokenizer (e.g. for HTML forms that send data to + * the server via submit). + * + * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * + * Default value is `empty string`. + * + * @since 1.142.0 + * + * @returns Reference to `this` in order to allow method chaining + */ + setName( + /** + * New value for property `name` + */ + sName?: string + ): this; /** * Function sets the tokenizer's width in pixels. */ @@ -154634,6 +154928,26 @@ declare module "sap/m/Tokenizer" { */ bShouldRenderTabIndex: boolean ): void; + /** + * Sets a new value for property {@link #getShowClearAll showClearAll}. + * + * Defines whether "Clear All" button is present. Ensure `multiLine` is enabled, otherwise `showClearAll` + * will have no effect. + * + * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * + * Default value is `false`. + * + * @experimental As of version 1.142. + * + * @returns Reference to `this` in order to allow method chaining + */ + setShowClearAll( + /** + * New value for property `showClearAll` + */ + bShowClearAll?: boolean + ): this; /** * Sets a new value for property {@link #getWidth width}. * @@ -154686,6 +155000,38 @@ declare module "sap/m/Tokenizer" { */ renderMode?: string | PropertyBindingInfo; + /** + * The name property to be used in the HTML code for the tokenizer (e.g. for HTML forms that send data to + * the server via submit). + * + * @since 1.142.0 + */ + name?: string | PropertyBindingInfo; + + /** + * Determines whether the `Tokenizer` is in display only state. + * + * When set to `true`, the `Tokenizer` is not editable. This setting is used for forms in review mode. + * + * @since 1.142.0 + */ + displayOnly?: boolean | PropertyBindingInfo | `{${string}}`; + + /** + * Defines whether tokens are displayed on multiple lines. + * + * @experimental As of version 1.142. + */ + multiLine?: boolean | PropertyBindingInfo | `{${string}}`; + + /** + * Defines whether "Clear All" button is present. Ensure `multiLine` is enabled, otherwise `showClearAll` + * will have no effect. + * + * @experimental As of version 1.142. + */ + showClearAll?: boolean | PropertyBindingInfo | `{${string}}`; + /** * the currently displayed tokens */ diff --git a/types/openui5/sap.tnt.d.ts b/types/openui5/sap.tnt.d.ts index 1df03b47d531db..deec39d6554891 100644 --- a/types/openui5/sap.tnt.d.ts +++ b/types/openui5/sap.tnt.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/tnt/library" { /** diff --git a/types/openui5/sap.ui.codeeditor.d.ts b/types/openui5/sap.ui.codeeditor.d.ts index 876ef51538835a..881b3d80b0a86c 100644 --- a/types/openui5/sap.ui.codeeditor.d.ts +++ b/types/openui5/sap.ui.codeeditor.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/ui/codeeditor/library" {} diff --git a/types/openui5/sap.ui.commons.d.ts b/types/openui5/sap.ui.commons.d.ts index b426b771b48b05..178eb77126bcbf 100644 --- a/types/openui5/sap.ui.commons.d.ts +++ b/types/openui5/sap.ui.commons.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/ui/commons/library" { import { ColorPickerMode as ColorPickerMode1 } from "sap/ui/unified/library"; diff --git a/types/openui5/sap.ui.core.d.ts b/types/openui5/sap.ui.core.d.ts index bb1982a3945277..433d5a0d670b93 100644 --- a/types/openui5/sap.ui.core.d.ts +++ b/types/openui5/sap.ui.core.d.ts @@ -279,7 +279,7 @@ declare namespace sap { "sap/ui/thirdparty/qunit-2": undefined; } } -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/base/assert" { /** @@ -6702,6 +6702,7 @@ declare module "sap/ui/model/odata/v2/ODataModel" { * provided via `treeAnnotationProperties.hierarchyNodeDescendantCountFor` * - The `"hierarchy-preorder-rank-for"` annotation must be present in the service metadata or provided * via `treeAnnotationProperties.hierarchyPreorderRankFor` + * - The hierarchy maintenance is performed on the client side */ restoreTreeStateAfterChange?: boolean; /** @@ -8192,6 +8193,10 @@ declare module "sap/ui/model/odata/v2/ODataModel" { * If the `changeBatchGroup` for the changed entity type is set to {@link #setDeferredGroups deferred}, * changes could be submitted with {@link #submitChanges}. Otherwise the change will be submitted directly. * + * Consecutive calls of this method which update bindings ***synchronously*** may cause performance issues; + * see {@link https://ui5.sap.com/#/topic/6c47b2b39db9404582994070ec3d57a2#loioadd47c3966dd40489e952bb4f5f74a7c Accessing Data from an OData Model } + * for details. + * * * @returns `true` if the value was set correctly and `false` if errors occurred like the entry was not * found or another entry was already updated. @@ -8210,7 +8215,7 @@ declare module "sap/ui/model/odata/v2/ODataModel" { */ oContext?: Context, /** - * Whether to update other bindings dependent on this property asynchronously + * Whether to update bindings dependent on this property asynchronously */ bAsyncUpdate?: boolean ): boolean; @@ -10176,6 +10181,508 @@ declare module "sap/ui/test/opaQunit" { ): void; } +declare module "sap/ui/test/starter/config" { + import { URI } from "sap/ui/core/library"; + + /** + * Code coverage options. + * + * The qunit-coverage/qunit-coverage-istanbul module is always loaded after QUnit has been loaded to enable + * the coverage option. When the 'coverage' parameter is set in the URL (e.g. because the `coverage` checkbox + * has been clicked), then "blanket" (if Istanbul is not used instead) is loaded before qunit-coverage to + * avoid its synchronous loading. The `instrumenter` property identifies which tool for code coverage should + * be used. If "auto" is chosen, a check determines whether Istanbul and its middleware are available, and + * if so, they are loaded. Otherwise, "blanket" is used as a fallback. + * + * The following default coverage configuration is applied: + * + * + * ```javascript + * + * { + * only: null, + * never: null, + * branchTracking: false, + * instrumenter: "auto" + * } + * ``` + */ + export type CoverageConfiguration = { + /** + * List of modules or packages that should be instrumented. If not given, all modules are instrumented. + * Default is null + */ + only?: string[]; + /** + * List of modules or packages that never should be instrumented. Default is null + */ + never?: string[]; + + branchTracking?: boolean; + /** + * "auto" checks for istanbul middleware and loads istanbul instrumentation, otherwise blanket is used. + * The other options set explicitly the desired instrumenter. + */ + instrumenter?: "auto" | "blanket" | "istanbul"; + }; + + /** + * Describes what versions of QUnit are known to the test starter, which one to use for a test, and how + * to configure it. + * + * Besides the documented properties, QUnit configuration options can be set as well. Currently supported + * are `altertitle`, `collapse`, `filter`, `fixture`, `hidepassed`, `maxDepth`, `module`, `moduleId`, `notrycatch`, + * `noglobals`, `seed`, `reorder`, `requireExpects`, `testId`, `testTimeout`, `scrolltop`. + * + * ## Default Configuration + * + * The following default QUnit configuration is applied: + * + * + * ```javascript + * + * { + * versions: { + * 1: { + * module: "sap/ui/thirdparty/qunit", + * css: "sap/ui/thirdparty/qunit.css" + * }, + * 2: { + * module: "sap/ui/thirdparty/qunit-2", + * css: "sap/ui/thirdparty/qunit-2.css" + * }, + * edge: 2, + * "true": "edge" + * }, + * version: "edge" + * } + * ``` + */ + export type QUnitConfiguration = { + /** + * Defines a set of available QUnit versions that the test starter can use. + * + * Allows for easier switch between different QUnit versions for tests by simply changing the `version` + * property in the test configuration. The test starter then uses the versions map to find the correct files + * for the requested version. + * + * The keys of this map can be used as values of the `version` property. The value can either be a `QUnitVersionInfo` + * that names a JavaScript module and a CSS stylesheet resource for a QUnit version or it can be a reference + * to another key (e.g. "edge" as an alias for a concrete version). + * + * By default, the map contains entries for the keys 1, 2, "edge" (same as 2) and "true" (same as "edge"). + * All predefined entries can be overridden in a testsuite or test. + */ + versions?: Record; + /** + * Version of QUnit that should be loaded. + * + * If set to a null, QUnit won't be loaded. If set to "edge", the newest available version of QUnit is used. + * If set to a number, the corresponding major version of QUnit is used if supported. Currently supported + * versions are 1 and 2. An error will be thrown for unsupported versions. + * + * Default is "edge" + */ + version?: null | false | int | "edge" | string; + /** + * Any valid QUnit configuration property + */ + [key: string]: any; + }; + + /** + * Describes the JavaScript and CSS resources of a certain QUnit version. Allows the test starter to start + * a custom QUnit version not provided by the framework. + */ + export type QUnitVersionInfo = { + /** + * Module ID of the described QUnit version. Will be loaded with a sap.ui.require call when that QUnit version + * is selected. + */ + module: string; + /** + * UI5 resource name of a CSS stylesheet that is loaded for the described QUnit version. + */ + css: string; + }; + + /** + * Describes what versions of Sinon are known to the test starter, which one to use for a test, and how + * to configure it. + * + * For versions up to Sinon 4, further Sinon config options can be added and are copied into `sinon.config`. + * Newer Sinon versions don't support such a config anymore. In Sinon 4, supported options are `injectIntoThis`, + * `injectInto`, `properties`, `useFakeTimers`, `useFakeServer` + * + * The following default Sinon configuration is applied: + * + * + * ```javascript + * + * { + * versions: { + * 1: { + * module: "sap/ui/thirdparty/sinon", + * bridge: "sap/ui/thirdparty/sinon-qunit" + * }, + * 4: { + * module: "sap/ui/thirdparty/sinon-4", + * bridge: "sap/ui/qunit/sinon-qunit-bridge" + * }, + * edge: 4, + * "true": "edge" + * }, + * version: "edge", + * qunitBridge: true, + * useFakeTimers: false, + * useFakeServer: false + * } + * ``` + */ + export type SinonConfiguration = { + /** + * Defines a set of available Sinon versions that the test starter can use. + * + * Allows for an easier switch between different Sinon versions for tests by simply changing the `version` + * property in the test configuration. The test starter then uses the versions map to find the correct files + * for the requested version. + * + * The keys of this map can be used as values of the `version` property. The value can either be a `SinonVersionInfo` + * that names the JavaScript module for a Sinon version or it can be a reference to another key (e.g. "edge" + * as an alias for a concrete version). + * + * By default, the map contains entries for the keys 1, 4, "edge" (same as 4) and "true" (same as "edge"). + * All predefined entries can be overridden in a testsuite or test. + */ + versions?: Record; + /** + * Version of Sinon that should be loaded. Default: "edge" + * + * If set to null, Sinon won't be loaded. If set to "edge", the newest available version of Sinon is used. + * If set to a number, the corresponding version of Sinon is used if supported. By default, supported versions + * are 1 and 4. An error will be thrown for unsupported versions. + */ + version?: null | false | int | string; + /** + * Whether one of the sinon-qunit bridges is loaded. + * + * When set to true, the sap/ui/thirdparty/sinon-qunit bridge is loaded for Sinon 1 and the sap/ui/qunit/sinon-qunit-bridge + * is loaded for newer versions of Sinon. + * + * The bridge is only loaded after both QUnit and Sinon have been loaded. If either QUnit or Sinon are not + * loaded, no bridge is loaded. + * + * If Sinon is not loaded, but QUnit, the bridge will not be loaded, but a shim with dependencies will be + * configured. This allows tests to load Sinon / the bridge on their own without taking care of the bridge + * dependencies. + */ + qunitBridge?: boolean; + /** + * Any valid Sinon configuration property (up to Sinon version 4 at least) + */ + [key: string]: any; + }; + + /** + * Describes the JavaScript resource of a certain Sinon version. Allows the test starter to start a custom + * Sinon version not provided by the framework. + */ + export type SinonVersionInfo = { + /** + * Module ID of the described Sinon version. Will be loaded with a sap.ui.require call when that Sinon version + * is selected. + */ + module: string; + /** + * Module ID of a "bridge" that can integrate the Sinon version with QUnit, wrapping each test in a Sinon + * sandbox. The bridge module will only be required by the test starter when the `qunitBridge` config option + * of the test is set to true. + */ + bridge: string; + }; + + export type SuiteConfiguration = { + /** + * Name of the test suite. + * + * This name is used as the title of the index page / testsuite page. + */ + name?: string; + /** + * An Object with default settings for all tests. + * + * The defaults and the test configuration are merged recursively in such a way that the merge contains + * properties from both the defaults and the test config. If a property is defined by both config objects, + * the value from the test config is used. There's no special handling for other types of values, e.g an + * array value in the defaults is replaced by an array value in the test config. + * + * The test starter applies the following complete default configuration structure: + * + * + * ```javascript + * + * { + * name: null, + * beforeBootstrap: null, + * module: "./{name}.qunit", + * page: "resources/sap/ui/test/starter/Test.qunit.html?testsuite={suite}&test={name}", + * title: "QUnit tests '{name}' of suite '{suite}'", + * qunit: "edge", + * sinon: "edge", + * coverage: { + * only: null, + * never: null, + * branchTracking: false, + * instrumenter: "auto" + * }, + * ui5: { + * bindingSyntax: "complex", + * libs: [] + * }, + * bootCore: true, + * autostart: true + * } + * ``` + */ + defaults?: TestConfiguration; + /** + * A map with the individual test configurations, keyed by a unique test name. + * + * There's no technical limitation for the length or the characters of the test names. The name is used + * only in the overview page showing all tests of your suite. + * + * By default, the name is also used to derive an ID for the module that contains the test cases. We therefore + * recommend using names which are valid module IDs (no blanks, no special chars other than "/" or "."). + * If you have multiple tests that execute the same module but with different configurations (e.g. different + * QUnit versions or different URL parameters), you have to make up unique names and manually configure + * the module IDs for them. + * + * The test starter applies the following complete default configuration structure: + * + * + * ```javascript + * + * { + * name: null, + * beforeBootstrap: null, + * module: "./{name}.qunit", + * page: "resources/sap/ui/test/starter/Test.qunit.html?testsuite={suite}&test={name}", + * title: "QUnit tests '{name}' of suite '{suite}'", + * qunit: "edge", + * sinon: "edge", + * coverage: { + * only: null, + * never: null, + * branchTracking: false, + * instrumenter: "auto" + * }, + * ui5: { + * bindingSyntax: "complex", + * libs: [] + * }, + * bootCore: true, + * autostart: true + * } + * ``` + */ + tests?: Record; + }; + + /** + * Defines the configuration options for a single test in a testsuite. The same structure is also used for + * the defaults of a testsuite. + * + * Some of the properties in this structure support placeholders for the name of the test (written as `{name}`) + * and the module ID of the testsuite (written as {suite}>). These placeholders are substituted + * before the test configuration is evaluated. + * + * Properties that represent UI5 module IDs also support relative module IDs (starting with `./`). They + * are resolved relative to the package that contains the testsuite. This behaves the same as if the testsuite + * module would use these IDs in its `sap.ui.define` call. + * + * The test starter applies the following complete default configuration structure: + * + * + * ```javascript + * + * { + * name: null, // Derived from test key + * beforeBootstrap: null, + * module: "./{name}.qunit", + * page: "resources/sap/ui/test/starter/Test.qunit.html?testsuite={suite}&test={name}", + * title: "QUnit tests '{name}' of suite '{suite}'", + * qunit: "edge", + * sinon: "edge", + * coverage: { + * only: null, + * never: null, + * branchTracking: false, + * instrumenter: "auto" + * }, + * ui5: { + * bindingSyntax: "complex", + * libs: [] + * }, + * bootCore: true, + * autostart: true + * } + * ``` + */ + export type TestConfiguration = { + /** + * The name of a group to which the test belongs. + * + * This is an optional string by which all tests in a testsuite will be sorted and grouped when they are + * listed in a UI. The group name usually is shown as a prefix of the test name. + */ + group?: string; + /** + * Whether the test starter should skip a test file. Such tests will remain in the overview list but won't + * be executed in the test suite. + */ + skip?: boolean; + /** + * Name of the test. If omitted, it is derived from the corresponding key in the ´tests` object of the enclosing + * suite. + */ + name?: string; + /** + * A module to be executed before the UI5 framework is bootstrapped. + * + * This can be useful for setting up global configurations or mocks that need to exist before any UI5 code + * runs. + * + * The value can be a relative module ID (e.g., `./mySetup.js`) and may use the placeholders `{name}` for + * the test name and `{suite}` for the suite name. + */ + beforeBootstrap?: string; + /** + * ID(s) of the module(s) to load. + * + * Can either be a single string or an array of strings. Each given module ID can be a relative module ID + * (relative to the package that contains the testsuite) and may use the placeholders `{name}` and `{suite}`. + * + * By default, a single module with the same name as the test and in the same package as the testsuite is + * loaded. + */ + module?: string | string[]; + /** + * URL of the test page to start for this test. + * + * By default, all tests use the generic starter page, which reads the suite configuration, finds the tests, + * and starts the configured test components before it requires and executes the configured test module(s). + * + * The URL must either be relative to the application root or use the ui5:// protocol with a module name. + * The URL can use the following placeholders, enclosed in curly braces: {suite} - replaced by the name + * of the testsuite (configuration) {name} - replaced by the name of the current test + * + * By default, a generic test page uses the testsuite and test names as URL parameters `testsuite` and `test`, + * respectively. + */ + page?: URI; + /** + * A map-like object with URL parameters that are appended to the `page` URL. Making this a separate property + * allows to use the same page URL for all tests but with different URL parameters per test. + * + * Keys in the object are parameter names, and their values represent the parameter values. If the value + * for a parameter is an array, the parameter will be added multiple times, once for each value in the array. + * + * Non-string values are not recommended and are cast to string (using the standard JavaScript `toString` + * functionality). + */ + searchParams?: Record; + /** + * A map-like object with URL parameters that are appended to the `page` URL. {@deprecated As of version + * 1.141.0, use `searchParams` instead.} + */ + uriParams?: Record; + /** + * Title of the test. + * + * The title can use the following placeholders, enclosed in curly braces: {suite} - replaced by the name + * of the testsuite (configuration) {name} - replaced by the name of the current test + * + * By default, a title is chosen which contains the names of the testsuite and the test. The exact text + * is not specified and may change. + * + * Default is "QUnit tests '{name}' of suite '{suite}'" + */ + title?: string; + /** + * Whether QUnit should be started, what version of it should be used, and what configuration should be + * applied. Details are described in the {@link module:sap/ui/test/starter/config.QUnitConfiguration} type. + * + * The values `null`, `false`, `"edge"` as well as any numerical value are shortcut notations for `qunit: + * { version: }`. + * + * Default is to use the "edge" version without any additional configuration. + */ + qunit?: QUnitConfiguration | null | false | number | "edge"; + /** + * Whether Sinon should be started, what version of it should be used, and what configuration should be + * applied. Details are described in the {@link module:sap/ui/test/starter/config.SinonConfiguration} type. + * + * The values `null`, `false`, `"edge"` as well as any numerical value are shortcut notations for `sinon: + * { version: }`. + * + * Default is to use the "edge" version with a QUnit bridge, but without fake timers and fake servers. + */ + sinon?: SinonConfiguration; + /** + * Code coverage options. + * + * The qunit-coverage/qunit-coverage-istanbul module is always loaded after QUnit has been loaded to enable + * the coverage option. When the 'coverage' parameter is set in the URL (e.g. because the `coverage` checkbox + * has been clicked), then "blanket" (if Istanbul is not used instead) will be loaded before qunit-coverage + * to avoid its synchronous loading. + * + * The `instrumenter` property identifies which tool for code coverage should be used. If "auto" is chosen, + * a check determines whether Istanbul and its middleware are available, and if so, they will be loaded. + * Otherwise, "blanket" is used as a fallback. + * + * The default is to automatically determine the instrumenter to use ("auto") and not to use branch tracking. + */ + coverage?: CoverageConfiguration; + /** + * Configuration options for the ui5loader. + * + * The configured object value is given to the {@link sap.ui.loader.config} API and supports nearly all + * configuration options that are documented for that API. The only exception is the async flag, which is + * already set to true by the test starter. The ui5loader doesn't support switching back to sync mode (async:false). + */ + loader?: Record; + /** + * UI5 runtime configuration options. + * + * Any configured property is made available to the runtime as if it was given in the `window["sap-ui-config"]` + * config object. If a value is of a type not supported for window["sap-ui-config"], executing the UI5 core + * might fail. As the only current exception, the "libs" property can be an array of library names and not + * only a comma-separated string. + * + * To ease test development, the test starter applies the following defaults. Note that any default is only + * applied if the corresponding property has not been defined in the test-specific configuration. + * - `bindingSyntax: "complex"` + */ + ui5?: Record; + /** + * Whether the UI5 core (sap/ui/core/Core.js) should be required and booted. + * + * When this option is true, the core is not only loaded and started, but loading and execution of the test + * module(s) is also delayed until a listener registered with sap.ui.getCore().attachInit() has been executed. + * + * {@deprecated As of version 1.120, it should not be used in new tests} + */ + bootCore?: boolean; + /** + * Whether the test starter should call QUnit.start() after all prerequisites have been fulfilled (e.g. + * QUnit, Sinon, a bridge, have been loaded, coverage tooling has been loaded and configured, the Core has + * been booted, the test modules have been loaded and executed, any Promises returned by the test modules + * have been resolved). + */ + autostart?: boolean; + }; +} + declare module "sap/ui/test/utils/nextUIUpdate" { /** * Return a Promise that resolves when the next Rendering is ready. If no rendering is sheduled it resolves @@ -28312,8 +28819,7 @@ declare module "sap/ui/core/Element" { * * UI5 currently does not provide a recommended implementation of `TooltipBase` as the use of content-rich * tooltips is discouraged by the Fiori Design Guidelines. Existing subclasses of `TooltipBase` therefore - * have been deprecated. However, apps can still subclass from `TooltipBase` and create their own implementation - * when needed (potentially taking the deprecated implementations as a starting point). + * have been deprecated. * * See the section {@link https://experience.sap.com/fiori-design-web/using-tooltips/ Using Tooltips} in * the Fiori Design Guideline. @@ -33693,9 +34199,9 @@ declare module "sap/ui/core/Lib" { * * **Note:** Dependencies between libraries have to be modeled consistently in several places: * - Both eager and lazy dependencies have to be modelled in the `.library` file. - * - By default, UI5 Tooling generates a `manifest.json` file from the content of the `.library` file. - * However, if the `manifest.json` file for the library is not generated but maintained manually, it must - * be kept consistent with the `.library` file, especially regarding its listed library dependencies. + * - By default, UI5 CLI generates a `manifest.json` file from the content of the `.library` file. However, + * if the `manifest.json` file for the library is not generated but maintained manually, it must be kept + * consistent with the `.library` file, especially regarding its listed library dependencies. * - All eager library dependencies must be declared as AMD dependencies of the `library.js` module by * referring to the corresponding `"some/lib/namespace/library"` module of each library dependency. * @@ -42775,458 +43281,6 @@ declare module "sap/ui/core/routing/Target" { >; } -declare module "sap/ui/core/routing/HashChanger" { - import HashChangerBase from "sap/ui/core/routing/HashChangerBase"; - - import Metadata from "sap/ui/base/Metadata"; - - import { routing } from "sap/ui/core/library"; - - import Event from "sap/ui/base/Event"; - - /** - * Class for manipulating and receiving changes of the browser hash with `hasher` framework. - * - * **IMPORTANT:** To set or replace the current browser hash, use {@link #setHash} or {@link #replaceHash } - * and do NOT interact with the `hasher` framework directly in order to have the navigation direction calculated - * as accurate as possible. - * - * Fires a `hashChanged` event if the browser hash changes. - */ - export default class HashChanger extends HashChangerBase { - constructor(); - - /** - * Creates a new subclass of class sap.ui.core.routing.HashChanger 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.routing.HashChangerBase.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; - /** - * Gets a global singleton of the HashChanger. The singleton will get created when this function is invoked - * for the first time. - * - * - * @returns The global HashChanger - */ - static getInstance(): HashChanger; - /** - * Returns a metadata object for class sap.ui.core.routing.HashChanger. - * - * - * @returns Metadata object describing this class - */ - static getMetadata(): Metadata; - /** - * Sets the hashChanger to a new instance, destroys the old one and copies all its event listeners to the - * new one - * - * @ui5-protected Do not call from applications (only from related classes in the framework) - */ - static replaceHashChanger( - /** - * the new instance for the global singleton - */ - oHashChanger: HashChanger - ): void; - /** - * Cleans the event registration - * See: - * sap.ui.base.Object.prototype.destroy - * - * @ui5-protected Do not call from applications (only from related classes in the framework) - */ - destroy(): void; - /** - * Fires the `hashChanged` event, may be extended to modify the hash before firing the event - * - * @ui5-protected Do not call from applications (only from related classes in the framework) - */ - fireHashChanged( - /** - * the new hash of the browser - */ - sNewHash: string, - /** - * the previous hash - */ - sOldHash: string - ): void; - /** - * Gets the current hash - * - * - * @returns the current hash - */ - getHash(): string; - /** - * Defines the events and its parameters which should be used for tracking the hash changes - * - * @ui5-protected Do not call from applications (only from related classes in the framework) - * - * @returns The array containing the events info - */ - getRelevantEventsInfo(): HashChangerEventInfo[]; - /** - * Will start listening to hash changes. This will also fire a `hashChanged` event with the initial hash. - * - * - * @returns false if it was initialized before, true if it was initialized the first time - */ - init(): boolean; - /** - * Replaces the hash with a certain value. When using the replace function, no browser history entry is - * written. If you want to have an entry in the browser history, please use the {@link #setHash} function. - * - * The `sDirection` parameter can be used to provide direction information on the navigation which leads - * to this hash replacement. This is typically used when synchronizing the hashes between multiple frames - * to provide information to the frame where the hash is replaced with the navigation direction in the other - * frame where the navigation occurs. - */ - replaceHash( - /** - * New hash - */ - sHash: string, - /** - * The direction information for this hash replacement - */ - sDirection: - | routing.HistoryDirection - | keyof typeof routing.HistoryDirection - ): void; - /** - * Sets the hash to a certain value. When using this function, a browser history entry is written. If you - * do not want to have an entry in the browser history, please use the {@link #replaceHash} function. - */ - setHash( - /** - * New hash - */ - sHash: string - ): void; - } - /** - * The object containing the event info for the events that are forwarded to {@link sap.ui.core.routing.RouterHashChanger}. - * - * @since 1.82.0 - * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) - */ - export type HashChangerEventInfo = { - /** - * The name of the event that is fired by the HashChanger and should be forwarded to the RouterHashChanger - * - * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) - */ - name: string; - /** - * The optional defined parameter name mapping that is used for forwarding the event to the {@link sap.ui.core.routing.RouterHashChanger}. - * - * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) - */ - paramMapping?: HashChangerEventParameterMapping; - /** - * Indicates whether the event is ignored by every RouterHashChanger instance and is only relevant for the - * other routing classes, for example {@link sap.ui.core.routing.History}. - * - * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) - */ - updateHashOnly: boolean; - }; - - /** - * The object containing the parameter mapping for forwarding the event to the {@link sap.ui.core.routing.RouterHashChanger}. - * - * @since 1.82.0 - * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) - */ - export type HashChangerEventParameterMapping = { - /** - * The name of the parameter whose value is used as the `newHash` parameter in the event that is forwarded - * to the {@link sap.ui.core.routing.RouterHashChanger}. If this isn't set, the value is taken from the - * property `newHash`. - * - * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) - */ - newHash?: string; - /** - * The name of the parameter whose value is used as the `oldHash` parameter in the event that is forwarded - * to the {@link sap.ui.core.routing.RouterHashChanger}. If this isn't set, the value is taken from the - * property `oldHash`. - * - * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) - */ - oldHash?: string; - /** - * The name of the parameter whose value is used as the `fullHash` parameter in the event that is forwarded - * to the {@link sap.ui.core.routing.RouterHashChanger}. If this isn't set, the value is taken from the - * property `fullHash`. - * - * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) - */ - fullHash?: string; - }; - - /** - * Parameters of the HashChanger#hashSet event. - */ - export interface HashChanger$HashSetEventParameters { - /** - * The relevant hash segment - */ - hash?: string; - } - - /** - * Event object of the HashChanger#hashSet event. - */ - export type HashChanger$HashSetEvent = Event< - HashChanger$HashSetEventParameters, - HashChanger - >; -} - -declare module "sap/ui/core/routing/HashChangerBase" { - import EventProvider from "sap/ui/base/EventProvider"; - - import Metadata from "sap/ui/base/Metadata"; - - import { routing } from "sap/ui/core/library"; - - import Event from "sap/ui/base/Event"; - - /** - * Base Class for manipulating and receiving changes of hash segment. - * - * Fires a `hashChanged` event if the relevant hash changes. - * - * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) - */ - export default class HashChangerBase extends EventProvider { - /** - * @ui5-protected Do not call from applications (only from related classes in the framework) - */ - protected constructor(); - - /** - * Creates a new subclass of class sap.ui.core.routing.HashChangerBase 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.base.EventProvider.extend}. - * - * @ui5-protected Do not call from applications (only from related classes in the framework) - * - * @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.ui.core.routing.HashChangerBase. - * - * @ui5-protected Do not call from applications (only from related classes in the framework) - * - * @returns Metadata object describing this class - */ - static getMetadata(): Metadata; - /** - * Replaces the hash with a certain value. When using the replace function, no browser history entry is - * written. If you want to have an entry in the browser history, please use the {@link #setHash} function. - * - * The `sDirection` parameter can be used to provide direction information on the navigation which leads - * to this hash replacement. This is typically used when synchronizing the hashes between multiple frames - * to provide information to the frame where the hash is replaced with the navigation direction in the other - * frame where the navigation occurs. - * - * @ui5-protected Do not call from applications (only from related classes in the framework) - */ - replaceHash( - /** - * New hash - */ - sHash: string, - /** - * The direction information for this hash replacement - */ - sDirection: - | routing.HistoryDirection - | keyof typeof routing.HistoryDirection - ): void; - /** - * Sets the hash to a certain value. When using this function, a browser history entry is written. If you - * do not want to have an entry in the browser history, please use the {@link #replaceHash} function. - * - * @ui5-protected Do not call from applications (only from related classes in the framework) - */ - setHash( - /** - * New hash - */ - sHash: string - ): void; - } - /** - * Parameters of the HashChangerBase#hashChanged event. - * - * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) - */ - export interface HashChangerBase$HashChangedEventParameters { - /** - * The hash segment before it's changed - */ - oldHash?: string; - - /** - * The new hash segment - */ - newHash?: object; - - /** - * The full format of the hash if the newHash only contains part of the relevant hash - */ - fullHash?: string; - } - - /** - * Event object of the HashChangerBase#hashChanged event. - * - * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) - */ - export type HashChangerBase$HashChangedEvent = Event< - HashChangerBase$HashChangedEventParameters, - HashChangerBase - >; - - /** - * Parameters of the HashChangerBase#hashReplaced event. - * - * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) - */ - export interface HashChangerBase$HashReplacedEventParameters { - /** - * The relevant hash segment - */ - hash?: string; - } - - /** - * Event object of the HashChangerBase#hashReplaced event. - * - * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) - */ - export type HashChangerBase$HashReplacedEvent = Event< - HashChangerBase$HashReplacedEventParameters, - HashChangerBase - >; -} - -declare module "sap/ui/core/routing/History" { - import HashChanger from "sap/ui/core/routing/HashChanger"; - - import { routing } from "sap/ui/core/library"; - - export default class History { - /** - * Used to determine the {@link sap.ui.core.routing.HistoryDirection} of the current or a future navigation, - * done with a {@link sap.ui.core.routing.Router} or {@link sap.ui.core.routing.HashChanger}. - * - * **ATTENTION:** this class will not be accurate if someone does hash-replacement without the named classes - * above. If you are manipulating the hash directly, this class is not supported anymore. - */ - constructor( - /** - * required, without a HashChanger this class cannot work. The class needs to be aware of the hash-changes. - */ - oHashChanger: HashChanger - ); - - /** - * - * @returns a global singleton that gets created as soon as the sap.ui.core.routing.History is required - */ - static getInstance(): History; - /** - * Determines what the navigation direction for a newly given hash would be. - * - * Returns the direction as {@link sap.ui.core.routing.HistoryDirection} (for example: Forwards, Backwards, - * NewEntry). If no navigation has occurred yet, returns `undefined`. In cases where the direction cannot - * be determined (if the same hash appears in multiple places), returns {@link sap.ui.core.routing.HistoryDirection.Unknown}. - * For hash replacements, the history stack is updated at the current position. - * - * Example: It will say "Unknown" if there is a history "foo" - "bar" (current history) - "foo". If you - * now ask for the direction of the hash "foo" you get "Unknown" because it might be backwards or forwards. - * - * - * @returns Direction for the given hash or `undefined`, if no navigation has taken place yet. - */ - getDirection( - /** - * optional, if this parameter is not passed the last hashChange is taken. - */ - sNewHash?: string - ): routing.HistoryDirection | undefined; - /** - * Returns the length difference between the history state stored in browser's pushState and the state maintained - * in this class. - * - * The function returns `undefined` when - * - The current state in browser's history pushState isn't initialized, for example, between a new hash - * is set or replaced and the "hashChange" event is processed by this class - * - History pushState is already used before UI5 History is initialized, and UI5 can't maintain the hash - * history by using the browser pushState - * - * Once the "hashChange" event is processed by this class, this method always returns 0. However, before - * a "hashChange" event reaches this class, it returns the offset between the new hash and the previous - * one within the history state. - * - * @since 1.70 - * - * @returns The length difference or returns `undefined` when browser pushState can't be used at the moment - * when this function is called - */ - getHistoryStateOffset(): int | undefined; - /** - * Gets the previous hash in the history. - * - * If the last direction was Unknown or there was no navigation yet, `undefined` will be returned. - * - * - * @returns Previous hash in the history or `undefined` - */ - getPreviousHash(): string | undefined; - } -} - declare module "sap/ui/core/routing/Router" { import EventProvider from "sap/ui/base/EventProvider"; @@ -43255,6 +43309,21 @@ declare module "sap/ui/core/routing/Router" { import Control from "sap/ui/core/Control"; + export type ComponentTargetParameters = { + /** + * The name of the route which should be matched after this navTo call. + */ + route: string; + /** + * The parameters for the route + */ + parameters?: Record>; + /** + * Information for deeper nested component targets + */ + componentTargetInfo?: Record; + }; + export type RouteInfo = { /** * The route name @@ -44224,45 +44293,23 @@ declare module "sap/ui/core/routing/Router" { * **Parameter:** * ```javascript * - * { - * parameterName1: "parameterValue1", - * parameterName2: "parameterValue2", - * "?queryParameterName": { - * queryParameterName1: "queryParameterValue1" - * } - * } - * ``` + * { + * parameterName1: "parameterValue1", + * parameterName2: "parameterValue2", + * "?queryParameterName": { + * queryParameterName1: "queryParameterValue1" + * } + * } + * ``` */ oParameters?: object, /** - * Information for route name and parameters of the router in nested components. When any target of the - * route which is specified with the `sName` parameter loads a component and a route of this component whose - * pattern is different than an empty string should be matched directly with this navTo call, the route - * name and its parameters can be given by using this parameter. Information for deeper nested component - * target can be given within the `componentTargetInfo` property which contains the same properties as the - * top level. + * Defines routing information for nested component targets. For each nested component target, you can specify + * the route name and its parameters of the nested router. This allows matching a non-empty route pattern + * in the nested component directly during this `navTo` call. The same structure can be used recursively + * for deeper levels of nested component targets. */ - oComponentTargetInfo?: { - /** - * The name of a target which loads a component. This target is used in the Route which is specified by - * `sName`. - */ - anyName?: { - /** - * The name of the route which should be matched after this navTo call. - */ - route?: string; - /** - * The parameters for the route. See the documentation of the `oParameters`. - */ - parameters?: object; - /** - * The information for the targets within a nested component. This shares the same structure with the `oComponentTargetInfo` - * parameter. - */ - componentTargetInfo?: object; - }; - }, + oComponentTargetInfo?: Record, /** * If set to `true`, the hash is replaced, and there will be no entry in the browser history. If set to * `false`, the hash is set and the entry is stored in the browser history. @@ -44304,14 +44351,14 @@ declare module "sap/ui/core/routing/Router" { * **Parameter:** * ```javascript * - * { - * parameterName1: "parameterValue1", - * parameterName2: "parameterValue2", - * "?queryParameterName": { - * queryParameterName1: "queryParameterValue1" - * } - * } - * ``` + * { + * parameterName1: "parameterValue1", + * parameterName2: "parameterValue2", + * "?queryParameterName": { + * queryParameterName1: "queryParameterValue1" + * } + * } + * ``` */ oParameters?: object, /** @@ -44578,6 +44625,458 @@ declare module "sap/ui/core/routing/Router" { >; } +declare module "sap/ui/core/routing/HashChanger" { + import HashChangerBase from "sap/ui/core/routing/HashChangerBase"; + + import Metadata from "sap/ui/base/Metadata"; + + import { routing } from "sap/ui/core/library"; + + import Event from "sap/ui/base/Event"; + + /** + * Class for manipulating and receiving changes of the browser hash with `hasher` framework. + * + * **IMPORTANT:** To set or replace the current browser hash, use {@link #setHash} or {@link #replaceHash } + * and do NOT interact with the `hasher` framework directly in order to have the navigation direction calculated + * as accurate as possible. + * + * Fires a `hashChanged` event if the browser hash changes. + */ + export default class HashChanger extends HashChangerBase { + constructor(); + + /** + * Creates a new subclass of class sap.ui.core.routing.HashChanger 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.routing.HashChangerBase.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; + /** + * Gets a global singleton of the HashChanger. The singleton will get created when this function is invoked + * for the first time. + * + * + * @returns The global HashChanger + */ + static getInstance(): HashChanger; + /** + * Returns a metadata object for class sap.ui.core.routing.HashChanger. + * + * + * @returns Metadata object describing this class + */ + static getMetadata(): Metadata; + /** + * Sets the hashChanger to a new instance, destroys the old one and copies all its event listeners to the + * new one + * + * @ui5-protected Do not call from applications (only from related classes in the framework) + */ + static replaceHashChanger( + /** + * the new instance for the global singleton + */ + oHashChanger: HashChanger + ): void; + /** + * Cleans the event registration + * See: + * sap.ui.base.Object.prototype.destroy + * + * @ui5-protected Do not call from applications (only from related classes in the framework) + */ + destroy(): void; + /** + * Fires the `hashChanged` event, may be extended to modify the hash before firing the event + * + * @ui5-protected Do not call from applications (only from related classes in the framework) + */ + fireHashChanged( + /** + * the new hash of the browser + */ + sNewHash: string, + /** + * the previous hash + */ + sOldHash: string + ): void; + /** + * Gets the current hash + * + * + * @returns the current hash + */ + getHash(): string; + /** + * Defines the events and its parameters which should be used for tracking the hash changes + * + * @ui5-protected Do not call from applications (only from related classes in the framework) + * + * @returns The array containing the events info + */ + getRelevantEventsInfo(): HashChangerEventInfo[]; + /** + * Will start listening to hash changes. This will also fire a `hashChanged` event with the initial hash. + * + * + * @returns false if it was initialized before, true if it was initialized the first time + */ + init(): boolean; + /** + * Replaces the hash with a certain value. When using the replace function, no browser history entry is + * written. If you want to have an entry in the browser history, please use the {@link #setHash} function. + * + * The `sDirection` parameter can be used to provide direction information on the navigation which leads + * to this hash replacement. This is typically used when synchronizing the hashes between multiple frames + * to provide information to the frame where the hash is replaced with the navigation direction in the other + * frame where the navigation occurs. + */ + replaceHash( + /** + * New hash + */ + sHash: string, + /** + * The direction information for this hash replacement + */ + sDirection: + | routing.HistoryDirection + | keyof typeof routing.HistoryDirection + ): void; + /** + * Sets the hash to a certain value. When using this function, a browser history entry is written. If you + * do not want to have an entry in the browser history, please use the {@link #replaceHash} function. + */ + setHash( + /** + * New hash + */ + sHash: string + ): void; + } + /** + * The object containing the event info for the events that are forwarded to {@link sap.ui.core.routing.RouterHashChanger}. + * + * @since 1.82.0 + * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) + */ + export type HashChangerEventInfo = { + /** + * The name of the event that is fired by the HashChanger and should be forwarded to the RouterHashChanger + * + * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) + */ + name: string; + /** + * The optional defined parameter name mapping that is used for forwarding the event to the {@link sap.ui.core.routing.RouterHashChanger}. + * + * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) + */ + paramMapping?: HashChangerEventParameterMapping; + /** + * Indicates whether the event is ignored by every RouterHashChanger instance and is only relevant for the + * other routing classes, for example {@link sap.ui.core.routing.History}. + * + * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) + */ + updateHashOnly: boolean; + }; + + /** + * The object containing the parameter mapping for forwarding the event to the {@link sap.ui.core.routing.RouterHashChanger}. + * + * @since 1.82.0 + * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) + */ + export type HashChangerEventParameterMapping = { + /** + * The name of the parameter whose value is used as the `newHash` parameter in the event that is forwarded + * to the {@link sap.ui.core.routing.RouterHashChanger}. If this isn't set, the value is taken from the + * property `newHash`. + * + * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) + */ + newHash?: string; + /** + * The name of the parameter whose value is used as the `oldHash` parameter in the event that is forwarded + * to the {@link sap.ui.core.routing.RouterHashChanger}. If this isn't set, the value is taken from the + * property `oldHash`. + * + * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) + */ + oldHash?: string; + /** + * The name of the parameter whose value is used as the `fullHash` parameter in the event that is forwarded + * to the {@link sap.ui.core.routing.RouterHashChanger}. If this isn't set, the value is taken from the + * property `fullHash`. + * + * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) + */ + fullHash?: string; + }; + + /** + * Parameters of the HashChanger#hashSet event. + */ + export interface HashChanger$HashSetEventParameters { + /** + * The relevant hash segment + */ + hash?: string; + } + + /** + * Event object of the HashChanger#hashSet event. + */ + export type HashChanger$HashSetEvent = Event< + HashChanger$HashSetEventParameters, + HashChanger + >; +} + +declare module "sap/ui/core/routing/HashChangerBase" { + import EventProvider from "sap/ui/base/EventProvider"; + + import Metadata from "sap/ui/base/Metadata"; + + import { routing } from "sap/ui/core/library"; + + import Event from "sap/ui/base/Event"; + + /** + * Base Class for manipulating and receiving changes of hash segment. + * + * Fires a `hashChanged` event if the relevant hash changes. + * + * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) + */ + export default class HashChangerBase extends EventProvider { + /** + * @ui5-protected Do not call from applications (only from related classes in the framework) + */ + protected constructor(); + + /** + * Creates a new subclass of class sap.ui.core.routing.HashChangerBase 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.base.EventProvider.extend}. + * + * @ui5-protected Do not call from applications (only from related classes in the framework) + * + * @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.ui.core.routing.HashChangerBase. + * + * @ui5-protected Do not call from applications (only from related classes in the framework) + * + * @returns Metadata object describing this class + */ + static getMetadata(): Metadata; + /** + * Replaces the hash with a certain value. When using the replace function, no browser history entry is + * written. If you want to have an entry in the browser history, please use the {@link #setHash} function. + * + * The `sDirection` parameter can be used to provide direction information on the navigation which leads + * to this hash replacement. This is typically used when synchronizing the hashes between multiple frames + * to provide information to the frame where the hash is replaced with the navigation direction in the other + * frame where the navigation occurs. + * + * @ui5-protected Do not call from applications (only from related classes in the framework) + */ + replaceHash( + /** + * New hash + */ + sHash: string, + /** + * The direction information for this hash replacement + */ + sDirection: + | routing.HistoryDirection + | keyof typeof routing.HistoryDirection + ): void; + /** + * Sets the hash to a certain value. When using this function, a browser history entry is written. If you + * do not want to have an entry in the browser history, please use the {@link #replaceHash} function. + * + * @ui5-protected Do not call from applications (only from related classes in the framework) + */ + setHash( + /** + * New hash + */ + sHash: string + ): void; + } + /** + * Parameters of the HashChangerBase#hashChanged event. + * + * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) + */ + export interface HashChangerBase$HashChangedEventParameters { + /** + * The hash segment before it's changed + */ + oldHash?: string; + + /** + * The new hash segment + */ + newHash?: object; + + /** + * The full format of the hash if the newHash only contains part of the relevant hash + */ + fullHash?: string; + } + + /** + * Event object of the HashChangerBase#hashChanged event. + * + * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) + */ + export type HashChangerBase$HashChangedEvent = Event< + HashChangerBase$HashChangedEventParameters, + HashChangerBase + >; + + /** + * Parameters of the HashChangerBase#hashReplaced event. + * + * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) + */ + export interface HashChangerBase$HashReplacedEventParameters { + /** + * The relevant hash segment + */ + hash?: string; + } + + /** + * Event object of the HashChangerBase#hashReplaced event. + * + * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) + */ + export type HashChangerBase$HashReplacedEvent = Event< + HashChangerBase$HashReplacedEventParameters, + HashChangerBase + >; +} + +declare module "sap/ui/core/routing/History" { + import HashChanger from "sap/ui/core/routing/HashChanger"; + + import { routing } from "sap/ui/core/library"; + + export default class History { + /** + * Used to determine the {@link sap.ui.core.routing.HistoryDirection} of the current or a future navigation, + * done with a {@link sap.ui.core.routing.Router} or {@link sap.ui.core.routing.HashChanger}. + * + * **ATTENTION:** this class will not be accurate if someone does hash-replacement without the named classes + * above. If you are manipulating the hash directly, this class is not supported anymore. + */ + constructor( + /** + * required, without a HashChanger this class cannot work. The class needs to be aware of the hash-changes. + */ + oHashChanger: HashChanger + ); + + /** + * + * @returns a global singleton that gets created as soon as the sap.ui.core.routing.History is required + */ + static getInstance(): History; + /** + * Determines what the navigation direction for a newly given hash would be. + * + * Returns the direction as {@link sap.ui.core.routing.HistoryDirection} (for example: Forwards, Backwards, + * NewEntry). If no navigation has occurred yet, returns `undefined`. In cases where the direction cannot + * be determined (if the same hash appears in multiple places), returns {@link sap.ui.core.routing.HistoryDirection.Unknown}. + * For hash replacements, the history stack is updated at the current position. + * + * Example: It will say "Unknown" if there is a history "foo" - "bar" (current history) - "foo". If you + * now ask for the direction of the hash "foo" you get "Unknown" because it might be backwards or forwards. + * + * + * @returns Direction for the given hash or `undefined`, if no navigation has taken place yet. + */ + getDirection( + /** + * optional, if this parameter is not passed the last hashChange is taken. + */ + sNewHash?: string + ): routing.HistoryDirection | undefined; + /** + * Returns the length difference between the history state stored in browser's pushState and the state maintained + * in this class. + * + * The function returns `undefined` when + * - The current state in browser's history pushState isn't initialized, for example, between a new hash + * is set or replaced and the "hashChange" event is processed by this class + * - History pushState is already used before UI5 History is initialized, and UI5 can't maintain the hash + * history by using the browser pushState + * + * Once the "hashChange" event is processed by this class, this method always returns 0. However, before + * a "hashChange" event reaches this class, it returns the offset between the new hash and the previous + * one within the history state. + * + * @since 1.70 + * + * @returns The length difference or returns `undefined` when browser pushState can't be used at the moment + * when this function is called + */ + getHistoryStateOffset(): int | undefined; + /** + * Gets the previous hash in the history. + * + * If the last direction was Unknown or there was no navigation yet, `undefined` will be returned. + * + * + * @returns Previous hash in the history or `undefined` + */ + getPreviousHash(): string | undefined; + } +} + declare module "sap/ui/core/routing/RouterHashChanger" { import HashChangerBase from "sap/ui/core/routing/HashChangerBase"; @@ -59765,6 +60264,10 @@ declare module "sap/ui/model/json/JSONModel" { * Sets `oValue` as new value for the property defined by the given `sPath` and `oContext`. Once the new * model value has been set, all interested parties are informed. * + * Consecutive calls of this method which update bindings ***synchronously*** may cause performance issues; + * see {@link https://ui5.sap.com/#/topic/18a76b577b144bc2b9b424e39d379c06 Performance Impact of Model Updates } + * for details. + * * * @returns `true` if the value was set correctly, and `false` if errors occurred, for example if the entry * was not found. @@ -59783,7 +60286,7 @@ declare module "sap/ui/model/json/JSONModel" { */ oContext?: Context, /** - * Whether to update other bindings dependent on this property asynchronously + * Whether to update bindings dependent on this property asynchronously */ bAsyncUpdate?: boolean ): boolean; @@ -67402,7 +67905,7 @@ declare module "sap/ui/model/odata/type/Decimal" { * `Edm.Decimal`. * * In both {@link sap.ui.model.odata.v2.ODataModel} and {@link sap.ui.model.odata.v4.ODataModel} this type - * is represented as a `string`. It never uses exponential format ("1e-5"). + * is represented as a `string`. * * @since 1.27.0 */ @@ -67414,7 +67917,8 @@ declare module "sap/ui/model/odata/type/Decimal" { /** * Format options as defined in {@link sap.ui.core.format.NumberFormat.getFloatInstance}. In contrast to * NumberFormat `groupingEnabled` defaults to `true`. Note that `maxFractionDigits` and `minFractionDigits` - * are set to the value of the constraint `scale` unless it is "variable". They can however be overwritten. + * are set to the value of the constraint `scale` unless it is "variable" or "floating". They can however + * be overwritten. */ oFormatOptions?: { /** @@ -67457,15 +67961,26 @@ declare module "sap/ui/model/odata/type/Decimal" { */ precision?: int | string; /** - * the maximum number of digits allowed to the right of the decimal point; the number must be less than - * or equal to `precision` (if given). As a special case, "variable" is supported. + * The maximum number of digits allowed to the right of the decimal point; the number must be less than + * or equal to `precision` (if given). The `Decimal` is then always displayed with exactly that number of + * digits to the right of the decimal point. If `scale` is equal to `precision`, a single zero has to precede + * the decimal point. + * + * In addition, the `scale` values "variable" and (as of UI5 version 1.142.0) "floating" are supported. * - * The number of digits to the right of the decimal point may vary from zero to `scale`, and the number - * of digits to the left of the decimal point may vary from one to `precision` minus `scale`. If `scale` - * is equal to `precision`, a single zero has to precede the decimal point. + * For `scale="variable"`, the number of digits to the right of the decimal point can vary from zero to + * `precision` minus the number of digits to the left of the decimal point. * - * The number is always displayed with exactly `scale` digits to the right of the decimal point (unless - * `scale` is "variable"). + * **Examples for `Decimal`s with precision=3 and scale="variable":** + * - Valid values: 123, 1.23, 12.3, 0.12 + * - Invalid values: 1230, 1.234, 12.34, 0.123 For `scale="floating"`, the number of + * significant digits, i.e. the number of digits excluding leading or trailing zeros, must be less than + * or equal to `precision`. For more information on `scale="floating"`, see + * OData Version 4.01 Common Schema Definition Language (CSDL) XML Representation - Scale . + * + * **Examples for `Decimal`s with precision=3 and scale="floating":** + * - Valid values: 1230, 1.23, 12.3, 0.123 + * - Invalid values: 1234, 1.234, 12.34, 0.001234 */ scale?: int | string; } @@ -71238,23 +71753,23 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" { * * * Supported Expressions: - * "14.4 Constant Expressions" for "edm:Bool", "edm:Date", "edm:DateTimeOffset", "edm:Decimal", "edm:Float", - * "edm:Guid", "edm:Int", "edm:TimeOfDay". constant "14.4.11 Expression edm:String": This is turned + * "14.3 Constant Expressions" for "edm:Bool", "edm:Date", "edm:DateTimeOffset", "edm:Decimal", "edm:Float", + * "edm:Guid", "edm:Int", "edm:TimeOfDay". constant "14.3.11 Expression edm:String": This is turned * into a fixed text (for example `"Width"`). String constants that contain a simple binding `"{@i18n>...}"` * to the hard-coded model name "@i18n" with arbitrary path are not turned into a fixed text, but kept as * a data binding expression; this allows local annotation files to refer to a resource bundle for internationalization. - * dynamic "14.5.1 Comparison and Logical Operators": These are turned into expression bindings to - * perform the operations at runtime. dynamic "14.5.3 Expression edm:Apply": - * "14.5.3.1.1 Function odata.concat": This is turned into a data binding expression relative to an entity. - * "14.5.3.1.2 Function odata.fillUriTemplate": This is turned into an expression binding to fill the - * template at runtime. "14.5.3.1.3 Function odata.uriEncode": This is turned into an expression binding - * to encode the parameter at runtime. Apply functions may be nested arbitrarily. dynamic - * "14.5.5 Expression edm:Collection": This is turned into an expression binding to be evaluated at runtime. - * Elements can be conditionally added to the collection when using dynamic "14.5.6 Expression edm:If" as - * a direct child. dynamic "14.5.6 Expression edm:If": This is turned into an expression binding to - * be evaluated at runtime. The expression is a conditional expression like `"{=condition ? expression1 - * : expression2}"`. dynamic "14.5.10 Expression edm:Null": This is turned into a `null` value. It - * is ignored in `odata.concat`. dynamic "14.5.12 Expression edm:Path" and "14.5.13 Expression edm:PropertyPath": + * dynamic "14.4.2 Comparison and Logical Operators": These are turned into expression bindings to + * perform the operations at runtime. dynamic "14.4.4 Expression edm:Apply": + * "odata.concat" from "14.4.4.1 Canonical Functions": This is turned into a data binding expression relative + * to an entity. "14.4.4.2 Function odata.fillUriTemplate": This is turned into an expression binding + * to fill the template at runtime. "14.4.4.4 Function odata.uriEncode": This is turned into an expression + * binding to encode the parameter at runtime. Apply functions may be nested arbitrarily. + * dynamic "14.4.6 Expression edm:Collection": This is turned into an expression binding to be evaluated + * at runtime. Elements can be conditionally added to the collection when using dynamic "14.4.7 Expression + * edm:If" as a direct child. dynamic "14.4.7 Expression edm:If": This is turned into an expression + * binding to be evaluated at runtime. The expression is a conditional expression like `"{=condition ? expression1 + * : expression2}"`. dynamic "14.4.11 Expression edm:Null": This is turned into a `null` value. It + * is ignored in `odata.concat`. dynamic "14.4.1.7 Expression edm:Path" and "14.4.1.6 Expression edm:PropertyPath": * These are turned into data bindings relative to an entity, including type information and constraints * as available from metadata, for example `"{path : 'Name', type : 'sap.ui.model.odata.type.String', constraints * : {'maxLength' : 255}, formatOptions : {'parseKeepsEmptyString' : true}}"`. Depending on the used type, @@ -71270,11 +71785,11 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" { * note that in this case only constant expressions are supported to determine the annotation value. The * "parseKeepsEmptyString" format option is set. Since 1.78.0, both "edm:Path" and "edm:PropertyPath" * are also supported if `vRawValue` is the path itself, and not the object wrapping it. **Note: Import - * the `sap/ui/model/odata/ODataExpressionAddons` module when using 14.5.1 or 14.5.3** + * the `sap/ui/model/odata/ODataExpressionAddons` module when using 14.4.2 or 14.4.4** * * $AnnotationPath and $Path: If `oDetails.context.getPath()` contains a single "$AnnotationPath" or "$Path" * segment, the value corresponding to that segment is considered as a data binding path prefix whenever - * a dynamic "14.5.12 Expression edm:Path" or "14.5.13 Expression edm:PropertyPath" is turned into a data + * a dynamic "14.4.1.7 Expression edm:Path" or "14.4.1.6 Expression edm:PropertyPath" is turned into a data * binding. Use {@link sap.ui.model.odata.v4.AnnotationHelper.resolve$Path} to avoid these prefixes in cases * where they are not applicable. * @@ -71325,12 +71840,12 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" { * `format` returns a binding with path "EQUIPMENT_2_PRODUCT/PRODUCT_2_SUPPLIER/Supplier_Name". * * Annotations on an Operation or a Parameter: Since 1.71.0, for annotations on an operation or a parameter, - * the binding parameter's name is stripped off any dynamic "14.5.12 Expression edm:Path" and "14.5.13 Expression - * edm:PropertyPath" where it might be used as a first segment. Since 1.76.0, this does not apply to annotations - * on a parameter. In the former case, we assume that the resulting data binding is relative to the parent - * context of the operation binding, that is, to the context representing the binding parameter itself. - * In the latter case, we assume that the resulting data binding is relative to the parameter context of - * the operation binding (see {@link sap.ui.model.odata.v4.ODataContextBinding#getParameterContext}). + * the binding parameter's name is stripped off any dynamic "14.4.1.7 Expression edm:Path" and "14.4.1.6 + * Expression edm:PropertyPath" where it might be used as a first segment. Since 1.76.0, this does not apply + * to annotations on a parameter. In the former case, we assume that the resulting data binding is relative + * to the parent context of the operation binding, that is, to the context representing the binding parameter + * itself. In the latter case, we assume that the resulting data binding is relative to the parameter context + * of the operation binding (see {@link sap.ui.model.odata.v4.ODataContextBinding#getParameterContext}). * * Example: * ```javascript @@ -71364,7 +71879,7 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" { * on. * * Operation Parameters: Since 1.73.0, this function can be used on action or function parameters and results - * in a relative data binding, just like a "14.5.12 Expression edm:Path". + * in a relative data binding, just like a "14.4.1.7 Expression edm:Path". * * Assume we have the following metadata for an unbound action "AcChangeTeamBudgetByID": * ```javascript @@ -71400,7 +71915,7 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" { * in case no binding parameters are needed. * * Structural Properties: Since 1.78.0, this function can be used on a structural property and results in - * a relative data binding, just like a "14.5.12 Expression edm:Path". The usage + * a relative data binding, just like a "14.4.1.7 Expression edm:Path". The usage * ```javascript * * @@ -71440,7 +71955,7 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" { context: Context; /** * The single operation overload that was targeted by annotations on an operation or a parameter; needed - * to strip off the binding parameter's name from any dynamic "14.5.12 Expression edm:Path" and "14.5.13 + * to strip off the binding parameter's name from any dynamic "14.4.1.7 Expression edm:Path" and "14.4.1.6 * Expression edm:PropertyPath" where it might be used as a first segment (since 1.71.0). This does not * apply to annotations on a parameter (since 1.76.0). */ @@ -71465,10 +71980,10 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" { /** * A function that helps to interpret OData V4 annotations. It knows about the syntax of the path value * used by the following dynamic expressions: - * "14.5.2 Expression edm:AnnotationPath" "14.5.11 Expression edm:NavigationPropertyPath" "14.5.12 - * Expression edm:Path" "14.5.13 Expression edm:PropertyPath" It returns the path of structural - * and navigation properties from the given path value, but removes "$count", types casts, term casts, and - * annotations on navigation properties. + * "14.4.1.3 Expression edm:AnnotationPath" "14.4.1.5 Expression edm:NavigationPropertyPath" + * "14.4.1.7 Expression edm:Path" "14.4.1.6 Expression edm:PropertyPath" It returns the path + * of structural and navigation properties from the given path value, but removes "$count", types casts, + * term casts, and annotations on navigation properties. * * @since 1.43.0 * @@ -71516,10 +72031,10 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" { /** * A function that helps to interpret OData V4 annotations. It knows about the syntax of the path value * used by the following dynamic expressions: - * "14.5.2 Expression edm:AnnotationPath" "14.5.11 Expression edm:NavigationPropertyPath" "14.5.12 - * Expression edm:Path" "14.5.13 Expression edm:PropertyPath" It returns the information whether - * the given path ends with "$count" or with a multi-valued structural or navigation property. Term casts - * and annotations on navigation properties are ignored. + * "14.4.1.3 Expression edm:AnnotationPath" "14.4.1.5 Expression edm:NavigationPropertyPath" + * "14.4.1.7 Expression edm:Path" "14.4.1.6 Expression edm:PropertyPath" It returns the information + * whether the given path ends with "$count" or with a multi-valued structural or navigation property. Term + * casts and annotations on navigation properties are ignored. * * Example: * ```javascript @@ -71625,33 +72140,33 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" { * * * Supported Expressions: - * "14.4 Constant Expressions" for "edm:Bool", "edm:Date", "edm:DateTimeOffset", "edm:Decimal", "edm:Float", - * "edm:Guid", "edm:Int", "edm:TimeOfDay". constant "14.4.11 Expression edm:String": This is turned + * "14.3 Constant Expressions" for "edm:Bool", "edm:Date", "edm:DateTimeOffset", "edm:Decimal", "edm:Float", + * "edm:Guid", "edm:Int", "edm:TimeOfDay". constant "14.3.11 Expression edm:String": This is turned * into a fixed text (for example `"Width"`). String constants that contain a simple binding `"{@i18n>...}"` * to the hard-coded model name "@i18n" with arbitrary path are not turned into a fixed text, but kept as * a data binding expression; this allows local annotation files to refer to a resource bundle for internationalization. - * dynamic "14.5.1 Comparison and Logical Operators": These are turned into expression bindings to - * perform the operations at runtime. dynamic "14.5.3 Expression edm:Apply": - * "14.5.3.1.1 Function odata.concat": This is turned into a data binding expression. "14.5.3.1.2 - * Function odata.fillUriTemplate": This is turned into an expression binding to fill the template at runtime. - * "14.5.3.1.3 Function odata.uriEncode": This is turned into an expression binding to encode the parameter - * at runtime. Apply functions may be nested arbitrarily. dynamic "14.5.5 Expression edm:Collection": - * This is turned into an expression binding to be evaluated at runtime. Elements can be conditionally added - * to the collection when using dynamic "14.5.6 Expression edm:If" as a direct child. dynamic "14.5.6 - * Expression edm:If": This is turned into an expression binding to be evaluated at runtime. The expression - * is a conditional expression like `"{=condition ? expression1 : expression2}"`. dynamic "14.5.10 - * Expression edm:Null": This is turned into a `null` value. It is ignored in `odata.concat`. dynamic - * "14.5.12 Expression edm:Path" and "14.5.13 Expression edm:PropertyPath": These are turned into simple - * data bindings, for example `"{Name}"`. Since 1.78.0, both are also supported if `vRawValue` is the path - * itself, and not the object wrapping it. + * dynamic "14.4.2 Comparison and Logical Operators": These are turned into expression bindings to + * perform the operations at runtime. dynamic "14.4.4 Expression edm:Apply": + * "odata.concat" from "14.4.4.1 Canonical Functions": This is turned into a data binding expression. + * "14.4.4.2 Function odata.fillUriTemplate": This is turned into an expression binding to fill the + * template at runtime. "14.4.4.4 Function odata.uriEncode": This is turned into an expression binding + * to encode the parameter at runtime. Apply functions may be nested arbitrarily. dynamic + * "14.4.6 Expression edm:Collection": This is turned into an expression binding to be evaluated at runtime. + * Elements can be conditionally added to the collection when using dynamic "14.4.7 Expression edm:If" as + * a direct child. dynamic "14.4.7 Expression edm:If": This is turned into an expression binding to + * be evaluated at runtime. The expression is a conditional expression like `"{=condition ? expression1 + * : expression2}"`. dynamic "14.4.11 Expression edm:Null": This is turned into a `null` value. It + * is ignored in `odata.concat`. dynamic "14.4.1.7 Expression edm:Path" and "14.4.1.6 Expression edm:PropertyPath": + * These are turned into simple data bindings, for example `"{Name}"`. Since 1.78.0, both are also supported + * if `vRawValue` is the path itself, and not the object wrapping it. * * Annotations on an Operation or a Parameter: Since 1.71.0, for annotations on an operation or a parameter, - * the binding parameter's name is stripped off any dynamic "14.5.12 Expression edm:Path" and "14.5.13 Expression - * edm:PropertyPath" where it might be used as a first segment. Since 1.76.0, this does not apply to annotations - * on a parameter. In the former case, we assume that the resulting data binding is relative to the parent - * context of the operation binding, that is, to the context representing the binding parameter itself. - * In the latter case, we assume that the resulting data binding is relative to the parameter context of - * the operation binding (see {@link sap.ui.model.odata.v4.ODataContextBinding#getParameterContext}). + * the binding parameter's name is stripped off any dynamic "14.4.1.7 Expression edm:Path" and "14.4.1.6 + * Expression edm:PropertyPath" where it might be used as a first segment. Since 1.76.0, this does not apply + * to annotations on a parameter. In the former case, we assume that the resulting data binding is relative + * to the parent context of the operation binding, that is, to the context representing the binding parameter + * itself. In the latter case, we assume that the resulting data binding is relative to the parameter context + * of the operation binding (see {@link sap.ui.model.odata.v4.ODataContextBinding#getParameterContext}). * * Example: * ```javascript @@ -71685,7 +72200,7 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" { * on. * * Operation Parameters: Since 1.73.0, this function can be used on action or function parameters and results - * in a relative data binding, just like a "14.5.12 Expression edm:Path". + * in a relative data binding, just like a "14.4.1.7 Expression edm:Path". * * Assume we have the following metadata for an unbound action "AcChangeTeamBudgetByID": * ```javascript @@ -71719,7 +72234,7 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" { * brackets must be replaced by `$(` and `$)` respectively. * * Structural Properties: Since 1.78.0, this function can be used on a structural property and results in - * a relative data binding, just like a "14.5.12 Expression edm:Path". The usage + * a relative data binding, just like a "14.4.1.7 Expression edm:Path". The usage * ```javascript * * @@ -71757,13 +72272,13 @@ declare module "sap/ui/model/odata/v4/AnnotationHelper" { context: Context; /** * The single operation overload that was targeted by annotations on an operation or a parameter; needed - * to strip off the binding parameter's name from any dynamic "14.5.12 Expression edm:Path" and "14.5.13 + * to strip off the binding parameter's name from any dynamic "14.4.1.7 Expression edm:Path" and "14.4.1.6 * Expression edm:PropertyPath" where it might be used as a first segment (since 1.72.0). This does not * apply to annotations on a parameter (since 1.76.0). */ overload?: object; /** - * Optional prefix to be added to each dynamic "14.5.12 Expression edm:Path" and "14.5.13 Expression edm:PropertyPath"; + * Optional prefix to be added to each dynamic "14.4.1.7 Expression edm:Path" and "14.4.1.6 Expression edm:PropertyPath"; * is either an empty string or a path ending with a "/" (since 1.141.0) */ prefix?: string; @@ -71988,7 +72503,7 @@ declare module "sap/ui/model/odata/v4/Context" { */ getBinding(): ODataContextBinding | ODataListBinding; /** - * Returns the "canonical path" of the entity for this context. According to "4.3.1 Canonical URL" of the specification "OData Version 4.0 Part 2: URL Conventions", this is + * Returns the "canonical path" of the entity for this context. According to "4.3.1 Canonical URL" of the specification "OData Version 4.01. Part 2: URL Conventions", this is * the "name of the entity set associated with the entity followed by the key predicate identifying the * entity within the collection". Use the canonical path in {@link sap.ui.core.Element#bindElement} to create * an element binding. @@ -72038,7 +72553,7 @@ declare module "sap/ui/model/odata/v4/Context" { /** * Returns the value for the given path relative to this context. The function allows access to the complete * data the context points to (if `sPath` is "") or any part thereof. The data is a JSON structure as described - * in "OData JSON Format Version 4.0". + * in "OData JSON Format Version 4.01". * Note that the function clones the result. Modify values via {@link sap.ui.model.odata.v4.ODataPropertyBinding#setValue}. * * Returns `undefined` if the data is not (yet) available; no request is initiated. Use {@link #requestObject } @@ -72285,7 +72800,8 @@ declare module "sap/ui/model/odata/v4/Context" { * If the context belongs to a list binding, the parameter allows the list binding to remove the context * from the list binding's collection because the entity does not match the binding's filter anymore, see * {@link sap.ui.model.odata.v4.ODataListBinding#filter}; a removed context is destroyed, see {@link #destroy}. - * If the context belongs to a context binding, the parameter must not be used. Supported since 1.55.0 + * If the context belongs to a context binding or to a list binding with "$$aggregation", the parameter + * must not be used. Supported since 1.55.0 * * Since 1.84.0, if this context is {@link #isKeepAlive kept alive}, it is only destroyed if the corresponding * entity does no longer exist in the back end. In this case, the `fnOnBeforeDestroy` callback passed with @@ -72307,7 +72823,7 @@ declare module "sap/ui/model/odata/v4/Context" { oOtherContext: Context ): void; /** - * Returns a promise for the "canonical path" of the entity for this context. According to "4.3.1 Canonical URL" of the specification "OData Version 4.0 Part 2: URL Conventions", this is + * Returns a promise for the "canonical path" of the entity for this context. According to "4.3.1 Canonical URL" of the specification "OData Version 4.01. Part 2: URL Conventions", this is * the "name of the entity set associated with the entity followed by the key predicate identifying the * entity within the collection". Use the canonical path in {@link sap.ui.core.Element#bindElement} to create * an element binding. @@ -72328,7 +72844,7 @@ declare module "sap/ui/model/odata/v4/Context" { * Returns a promise on the value for the given path relative to this context. The function allows access * to the complete data the context points to (if `sPath` is "") or any part thereof. The data is a JSON * structure as described in "OData - * JSON Format Version 4.0". Note that the function clones the result. Modify values via {@link #setProperty}. + * JSON Format Version 4.01". Note that the function clones the result. Modify values via {@link #setProperty}. * * The header context of a list binding only delivers `$count` and `@$ui5.context.isSelected` (wrapped in * an object if `sPath` is ""). @@ -72410,10 +72926,10 @@ declare module "sap/ui/model/odata/v4/Context" { bAllowRemoval?: boolean ): Promise; /** - * Loads side effects for this context using the given "14.5.11 Expression edm:NavigationPropertyPath" or - * "14.5.13 Expression edm:PropertyPath" objects. Use this method to explicitly load side effects in case - * implicit loading is switched off via the binding-specific parameter `$$patchWithoutSideEffects`. The - * method can be called on + * Loads side effects for this context using the given "14.4.1.5 Expression edm:NavigationPropertyPath" + * or "14.4.1.6 Expression edm:PropertyPath" objects. Use this method to explicitly load side effects in + * case implicit loading is switched off via the binding-specific parameter `$$patchWithoutSideEffects`. + * The method can be called on * the bound context of a context binding, the return value context of an operation binding, * a context of a list binding representing a single entity, the header context of a list binding; * side effects are loaded for the whole binding in this case. Key predicates must be available in @@ -72459,7 +72975,7 @@ declare module "sap/ui/model/odata/v4/Context" { */ requestSideEffects( /** - * The "14.5.11 Expression edm:NavigationPropertyPath" or "14.5.13 Expression edm:PropertyPath" objects + * The "14.4.1.5 Expression edm:NavigationPropertyPath" or "14.4.1.6 Expression edm:PropertyPath" objects * describing which properties need to be loaded because they may have changed due to side effects of a * previous update, for example `[{$PropertyPath : "TEAM_ID"}, {$NavigationPropertyPath : "EMPLOYEE_2_MANAGER"}, * {$PropertyPath : "EMPLOYEE_2_TEAM/Team_Id"}]`. An empty navigation property path means that the whole @@ -72470,7 +72986,7 @@ declare module "sap/ui/model/odata/v4/Context" { * * Since 1.82.0, absolute paths are supported. Absolute paths must start with the entity container (example * "/com.sap.gateway.default.iwbep.tea_busi.v0001.Container/TEAMS") of the service. All (navigation) properties - * in the complete model matching such an absolute path are updated. Since 1.85.0, "14.4.11 Expression edm:String" + * in the complete model matching such an absolute path are updated. Since 1.85.0, "14.3.11 Expression edm:String" * is accepted as well. * * Since 1.108.8, a property path matching the "com.sap.vocabularies.Common.v1.Messages" annotation of a @@ -73105,7 +73621,7 @@ declare module "sap/ui/model/odata/v4/ODataContextBinding" { * Returns a promise on the value for the given path relative to this binding. The function allows access * to the complete data the binding points to (if `sPath` is "") or any part thereof. The data is a JSON * structure as described in "OData - * JSON Format Version 4.0". Note that the function clones the result. Modify values via {@link sap.ui.model.odata.v4.Context#setProperty}. + * JSON Format Version 4.01". Note that the function clones the result. Modify values via {@link sap.ui.model.odata.v4.Context#setProperty}. * * If you want {@link #requestObject} to read fresh data, call `oBinding.refresh()` first. * See: @@ -74359,7 +74875,7 @@ declare module "sap/ui/model/odata/v4/ODataListBinding" { */ hierarchyQualifier?: string; /** - * Like the "5.1.7 System Query Option $search", but applied before data aggregation (since 1.93.0). Note that + * Like the "5.1.8 System Query Option $search", but applied before data aggregation (since 1.93.0). Note that * certain content will break the syntax of the system query option `$apply` and result in an invalid request. * If the OData service supports the proposal ODATA-1452, * then `ODataUtils.formatLiteral(sSearch, "Edm.String");` should be used to encapsulate the whole search @@ -75189,12 +75705,12 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" { * ``` * * - * The basic idea is that every path described in "14.2.1 Attribute Target" in specification "OData Version 4.0 Part 3: Common Schema Definition Language" - * is a valid absolute path within the metadata model if a leading slash is added; for example "/" + "MySchema.MyEntityContainer/MyEntitySet/MyComplexProperty/MyNavigationProperty". - * Also, every path described in "14.5.2 Expression edm:AnnotationPath", "14.5.11 Expression edm:NavigationPropertyPath", - * "14.5.12 Expression edm:Path", and "14.5.13 Expression edm:PropertyPath" is a valid relative path within - * the metadata model if a suitable prefix is added which addresses an entity container, entity set, singleton, - * complex type, entity type, or property; for example "/MySchema.MyEntityType/MyProperty" + "@vCard.Address#work/FullName". + * The basic idea is that every path described in "14.2.2 Target" in specification "OData Common Schema Definition Language (CSDL) XML Representation + * Version 4.01" is a valid absolute path within the metadata model if a leading slash is added; for example + * "/" + "MySchema.MyEntityContainer/MyEntitySet/MyComplexProperty/MyNavigationProperty". Also, every path + * described in "14.4.1.1 Path Syntax" is a valid relative path within the metadata model if a suitable + * prefix is added which addresses an entity container, entity set, singleton, complex type, entity type, + * or property; for example "/MySchema.MyEntityType/MyProperty" + "@vCard.Address#work/FullName". * * The absolute path is split into segments and followed step-by-step, starting at the global scope of all * known qualified OData names. There are two technical properties there: "$Version" (typically "4.0") and @@ -75224,21 +75740,21 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" { * and followed step-by-step before the next segment is processed. Except for this, a path must not continue * if it comes across a non-object value. Such a string value can be a qualified name (example path "/$EntityContainer/..."), * a simple identifier (example path "/TEAMS/$NavigationPropertyBinding/TEAM_2_EMPLOYEES/...") including - * the special name "$ReturnType" (since 1.71.0), or even a path according to "14.5.12 Expression edm:Path" - * etc. (example path "/TEAMS/@com.sap.vocabularies.UI.v1.LineItem/0/Value/$Path/...". + * the special name "$ReturnType" (since 1.71.0), or even a path according to "14.4.1.1 Path Syntax" (example + * path "/TEAMS/@com.sap.vocabularies.UI.v1.LineItem/0/Value/$Path/...". * * Segments starting with an "@" character, for example "@com.sap.vocabularies.Common.v1.Label", address * annotations at the current object. As the first segment, they refer to the single entity container. For - * objects which can only be annotated inline (see "14.3 Element edm:Annotation" minus "14.2.1 Attribute - * Target"), the object already contains the annotations as a property. For objects which can (only or also) - * be annotated via external targeting, the object does not contain any annotation as a property. Such annotations - * MUST be accessed via a path. Such objects include operations (that is, actions and functions) and their - * parameters, which can be annotated for a single overload or for all overloads at the same time. + * objects which can only be annotated inline (see "14.2 Annotation" minus "14.2.2 Target"), the object + * already contains the annotations as a property. For objects which can (only or also) be annotated via + * external targeting, the object does not contain any annotation as a property. Such annotations MUST be + * accessed via a path. Such objects include operations (that is, actions and functions) and their parameters, + * which can be annotated for a single overload or for all overloads at the same time. * * Segments starting with an OData name followed by an "@" character, for example "/TEAMS@Org.OData.Capabilities.V1.TopSupported", * address annotations at an entity set, singleton, or property, not at the corresponding type. In contrast, * "/TEAMS/@com.sap.vocabularies.Common.v1.Deletable" (note the separating slash) addresses an annotation - * at the entity set's type. This is in line with the special rule of "14.5.12 Expression edm:Path" regarding + * at the entity set's type. This is in line with the special rule of "14.4.1.2 Path Evaluation" regarding * annotations at a navigation property itself. * * "@" can be used as a segment to address a map of all annotations of the current object. This is useful @@ -75248,11 +75764,11 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" { * "@com.sap.vocabularies.Common.v1.Text@com.sap.vocabularies.Common.v1.TextArrangement". Each annotation * can have a qualifier, for example "@first#foo@second#bar". Note: If the first annotation's value is a * record, a separate segment addresses an annotation of that record, not an annotation of the first annotation - * itself. In a similar way, annotations of "7.2 Element edm:ReferentialConstraint", "7.3 Element edm:OnDelete", - * "10.2 Element edm:Member" and "14.5.14.2 Element edm:PropertyValue" are addressed by segments like "<7.2.1 - * Attribute Property>@...", "$OnDelete@...", "<10.2.1 Attribute Name>@..." and "<14.5.14.2.1 Attribute - * Property>@..." (where angle brackets denote a variable part and sections refer to specification "OData Version 4.0 Part 3: - * Common Schema Definition Language"). + * itself. In a similar way, annotations of "8.5 Element edm:ReferentialConstraint", "8.6 Element edm:OnDelete", + * "10.3 Element edm:Member" and "14.4.12 Element edm:PropertyValue" are addressed by segments like "<8.5 + * Attribute Property>@...", "$OnDelete@...", "<10.3 Attribute Name>@..." and "<14.4.12 Attribute + * Property>@..." (where angle brackets denote a variable part and sections refer to specification "OData Common Schema + * Definition Language (CSDL) XML Representation Version 4.01"). * * Annotations starting with "@@", for example "@@sap.ui.model.odata.v4.AnnotationHelper.isMultiple" or * "@@.AH.isMultiple" or "@@.isMultiple", represent computed annotations. Their name without the "@@" prefix @@ -75497,7 +76013,7 @@ declare module "sap/ui/model/odata/v4/ODataMetaModel" { */ bAutoExpandSelect?: boolean, /** - * Context to resolve "14.5.12 Expression edm:Path" references contained in a "com.sap.vocabularies.Common.v1.ValueListRelevantQualifiers" + * Context to resolve "14.4.1.7 Expression edm:Path" references contained in a "com.sap.vocabularies.Common.v1.ValueListRelevantQualifiers" * annotation. Supported since 1.84.0 */ oContext?: Context1 @@ -75578,9 +76094,9 @@ declare module "sap/ui/model/odata/v4/ODataModel" { * * This model is not prepared to be inherited from. * - * Every resource path (relative to the service root URL, no query options) according to "4 Resource Path" in specification "OData Version 4.0 Part 2: URL Conventions" is a valid data binding - * path within this model if a leading slash is added; for example "/" + "SalesOrderList('A%2FB%26C')" to - * access an entity instance with key "A/B&C". Note that appropriate URI encoding is necessary, see the + * Every resource path (relative to the service root URL, no query options) according to "4 Resource Path" in specification "OData Version 4.01. Part 2: URL Conventions" is a valid data + * binding path within this model if a leading slash is added; for example "/" + "SalesOrderList('A%2FB%26C')" + * to access an entity instance with key "A/B&C". Note that appropriate URI encoding is necessary, see the * example of {@link sap.ui.model.odata.v4.ODataUtils.formatLiteral}. "4.5.1 Addressing Actions" needs an * operation binding, see {@link sap.ui.model.odata.v4.ODataContextBinding}. * @@ -75662,7 +76178,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" { */ metadataUrlParams?: object; /** - * The version of the OData service. Supported values are "2.0" and "4.0". + * The version of the OData service. Supported values are "2.0", "4.0", and "4.01". */ odataVersion?: string; /** @@ -75676,7 +76192,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" { * Root URL of the service to request data from. The path part of the URL must end with a forward slash * according to OData V4 specification ABNF, rule "serviceRoot". You may append OData custom query options * to the service root URL separated with a "?", for example "/MyService/?custom=foo". See specification - * "OData Version 4.0 Part 2: URL Conventions", "5.2 Custom Query Options". OData system query options + * "OData Version 4.01. Part 2: URL Conventions", "5.2 Custom Query Options". OData system query options * and OData parameter aliases lead to an error. */ serviceUrl: string; @@ -75812,7 +76328,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" { */ oContext?: Context, /** - * Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2: URL Conventions" or the binding-specific parameters as specified below. + * Map of binding parameters which can be OData query options as specified in "OData Version 4.01. Part 2: URL Conventions" or the binding-specific parameters as specified below. * Note: The binding creates its own data service request if it is absolute or if it has any parameters * or if it is relative and has a context created via {@link #createBindingContext}. The following OData * query options are allowed: @@ -75824,7 +76340,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" { */ mParameters?: { /** - * The value for the "5.1.2 System Query Option $expand" or an object which determines that value. The object + * The value for the "5.1.3 System Query Option $expand" or an object which determines that value. The object * is a map from expand path to expand options, where the options are again maps of system query options, * typically with string values. $count can also be given as a `boolean` value, $expand can recursively * be given as a map, $levels can also be given as a `number` value, and $select can also be given as an @@ -75832,9 +76348,9 @@ declare module "sap/ui/model/odata/v4/ODataModel" { */ $expand?: string | object; /** - * A comma separated list or an array of items which determine the value for the "5.1.3 System Query Option + * A comma separated list or an array of items which determine the value for the "5.1.4 System Query Option * $select". Since 1.75.0, when using the "autoExpandSelect" model parameter (see {@link #constructor}), - * paths with navigation properties can be included and will contribute to the "5.1.2 System Query Option + * paths with navigation properties can be included and will contribute to the "5.1.3 System Query Option * $expand". */ $select?: string | string[]; @@ -75908,10 +76424,10 @@ declare module "sap/ui/model/odata/v4/ODataModel" { */ vFilters?: Filter | Filter[], /** - * Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2: URL Conventions" or binding-specific parameters as specified below. Note: - * The binding creates its own data service request if it is absolute or if it has any parameters or if - * it is relative and has a context created via {@link #createBindingContext} or if it has sorters or filters. - * The following OData query options are allowed: + * Map of binding parameters which can be OData query options as specified in "OData Version 4.01. Part 2: URL Conventions" or binding-specific parameters as specified below. + * Note: The binding creates its own data service request if it is absolute or if it has any parameters + * or if it is relative and has a context created via {@link #createBindingContext} or if it has sorters + * or filters. The following OData query options are allowed: * All "5.2 Custom Query Options" except for those with a name starting with "sap-" (unless starting with * "sap-valid-") The $apply, $count, $expand, $filter, $levels, $orderby, $search, and $select "5.1 * System Query Options"; OData V4 only allows $levels inside $expand. All other query options lead @@ -75924,11 +76440,11 @@ declare module "sap/ui/model/odata/v4/ODataModel" { */ $apply?: string; /** - * The value for the "5.1.6 System Query Option $count", useful for creation at the end and {@link sap.ui.model.odata.v4.ODataListBinding#getCount} + * The value for the "5.1.7 System Query Option $count", useful for creation at the end and {@link sap.ui.model.odata.v4.ODataListBinding#getCount} */ $count?: string | boolean; /** - * The value for the "5.1.2 System Query Option $expand" or an object which determines that value. The object + * The value for the "5.1.3 System Query Option $expand" or an object which determines that value. The object * is a map from expand path to expand options, where the options are again maps of system query options, * typically with string values. $count can also be given as a `boolean` value, $expand can recursively * be given as a map, $levels can also be given as a `number` value, and $select can also be given as an @@ -75936,22 +76452,22 @@ declare module "sap/ui/model/odata/v4/ODataModel" { */ $expand?: string | object; /** - * The value for the "5.1.1 System Query Option $filter" used in addition to `vFilters` + * The value for the "5.1.2 System Query Option $filter" used in addition to `vFilters` */ $filter?: string; /** - * The value for the "5.1.4 System Query Option $orderby" used in addition to `vSorters` + * The value for the "5.1.5 System Query Option $orderby" used in addition to `vSorters` */ $orderby?: string | number; /** - * The value for the "5.1.7 System Query Option $search"; see also `oAggregation.search` at {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation } + * The value for the "5.1.8 System Query Option $search"; see also `oAggregation.search` at {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation } * and the note there! */ $search?: string; /** - * A comma separated list or an array of items which determine the value for the "5.1.3 System Query Option + * A comma separated list or an array of items which determine the value for the "5.1.4 System Query Option * $select". Since 1.75.0, when using the "autoExpandSelect" model parameter (see {@link #constructor}), - * paths with navigation properties can be included and will contribute to the "5.1.2 System Query Option + * paths with navigation properties can be included and will contribute to the "5.1.3 System Query Option * $expand". */ $select?: string | string[]; @@ -76086,7 +76602,7 @@ declare module "sap/ui/model/odata/v4/ODataModel" { */ oContext?: Context1, /** - * Map of binding parameters which can be OData query options as specified in "OData Version 4.0 Part 2: URL Conventions" or the binding-specific parameters as specified below. + * Map of binding parameters which can be OData query options as specified in "OData Version 4.01. Part 2: URL Conventions" or the binding-specific parameters as specified below. * The following OData query options are allowed: * All "5.2 Custom Query Options" except for those with a name starting with "sap-" (unless starting with * "sap-valid-") The $apply, $filter, and $search "5.1 System Query Options" if the path ends with @@ -76102,11 +76618,11 @@ declare module "sap/ui/model/odata/v4/ODataModel" { */ $apply?: string; /** - * The value for the "5.1.1 System Query Option $filter", if the path ends with a "$count" segment + * The value for the "5.1.2 System Query Option $filter", if the path ends with a "$count" segment */ $filter?: string; /** - * The value for the "5.1.7 System Query Option $search", if the path ends with a "$count" segment + * The value for the "5.1.8 System Query Option $search", if the path ends with a "$count" segment */ $search?: string; /** @@ -76164,10 +76680,10 @@ declare module "sap/ui/model/odata/v4/ODataModel" { * requests within the batch. The headers are changed according to the given map of headers: Headers with * an `undefined` value are removed, the other headers are set, and missing headers remain unchanged. The * following headers must not be used: - * OData V4 requests headers as specified in "8.1 Common Headers" and "8.2 Request Headers" of the specification "OData Version 4.0 Part 1: Protocol" - * OData V2 request headers as specified in "2.2.5 HTTP Header Fields" of the specification "OData - * Version 2 v10.1" The headers "Content-Id" and "Content-Transfer-Encoding" The header "SAP-ContextId" - * Note: The "X-CSRF-Token" header will not be used for metadata requests. + * OData V4 requests headers as specified in "8.1 Common Headers" and "8.2 Request Headers" of the specification "OData Version 4.01. Part 1: + * Protocol" OData V2 request headers as specified in "2.2.5 HTTP Header Fields" of the specification + * "OData Version 2 v10.1" The headers "Content-Id" and "Content-Transfer-Encoding" The header + * "SAP-ContextId" Note: The "X-CSRF-Token" header will not be used for metadata requests. * * If not `undefined`, a header value must conform to the following rules: * It must be a non-empty string. It must be completely in the US-ASCII character set. It must @@ -76551,10 +77067,11 @@ declare module "sap/ui/model/odata/v4/ODataModel" { sGroupId?: string | boolean ): void; /** - * Returns a promise for the "canonical path" of the entity for the given context. According to "4.3.1 Canonical URL" of the specification "OData Version 4.0 Part 2: URL Conventions", this is - * the "name of the entity set associated with the entity followed by the key predicate identifying the - * entity within the collection". Use the canonical path in {@link sap.ui.core.Element#bindElement} to create - * an element binding. + * Returns a promise for the "canonical path" of the entity for the given context. According to "4.3.1 + * Canonical URL" of the specification "OData Version 4.01. Part 2: URL Conventions", this is the "name + * of the entity set associated with the entity followed by the key predicate identifying the entity within + * the collection". Use the canonical path in {@link sap.ui.core.Element#bindElement} to create an element + * binding. * * @since 1.37.0 * @deprecated As of version 1.39.0. Use {@link sap.ui.model.odata.v4.Context#requestCanonicalPath} instead. @@ -77276,11 +77793,11 @@ declare module "sap/ui/model/odata/v4/ODataUtils" { * * @since 1.64.0 * - * @returns The literal according to "OData Version 4.0 Part 2: URL Conventions" section "5.1.1.11.1 Primitive Literals" + * @returns The literal according to "OData Version 4.01. Part 2: URL Conventions" section "5.1.1.14.1 Primitive Literals" */ formatLiteral( /** - * The value according to "OData JSON Format Version 4.0" section "7.1 Primitive Value" + * The value according to "OData JSON Format Version 4.01" section "7.1 Primitive Value" */ vValue: any, /** @@ -77367,7 +77884,7 @@ declare module "sap/ui/model/odata/v4/ts" { export default ts; /** - * An object representing a "14.5.11 Expression edm:NavigationPropertyPath". Its shape corresponds exactly + * An object representing a "14.4.1.5 Expression edm:NavigationPropertyPath". Its shape corresponds exactly * to the shape of such an expression in the {@link https://ui5.sap.com/#/topic/87aac894a40640f89920d7b2a414499b OData V4 Metadata JSON Format } * as returned by {@link sap.ui.model.odata.v4.ODataMetaModel#requestObject}. * See: @@ -77383,7 +77900,7 @@ declare module "sap/ui/model/odata/v4/ts" { }; /** - * An object representing a "14.5.13 Expression edm:PropertyPath". Its shape corresponds exactly to the + * An object representing a "14.4.1.6 Expression edm:PropertyPath". Its shape corresponds exactly to the * shape of such an expression in the {@link https://ui5.sap.com/#/topic/87aac894a40640f89920d7b2a414499b OData V4 Metadata JSON Format } * as returned by {@link sap.ui.model.odata.v4.ODataMetaModel#requestObject}. * See: @@ -89258,12 +89775,16 @@ declare namespace sap { "sap/ui/test/RecordReplay": undefined; + "sap/ui/test/starter/config": undefined; + "sap/ui/test/utils/nextUIUpdate": undefined; "sap/ui/test/utils/waitForThemeApplied": undefined; "sap/ui/thirdparty/jquery": undefined; + "sap/ui/util/_URL": undefined; + "sap/ui/util/ActivityDetection": undefined; "sap/ui/util/defaultLinkTypes": undefined; diff --git a/types/openui5/sap.ui.dt.d.ts b/types/openui5/sap.ui.dt.d.ts index fe7cacd98511f9..b9b521da11f749 100644 --- a/types/openui5/sap.ui.dt.d.ts +++ b/types/openui5/sap.ui.dt.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/ui/dt/library" { export namespace designtime { diff --git a/types/openui5/sap.ui.fl.d.ts b/types/openui5/sap.ui.fl.d.ts index 3e32fae42cd4ae..7523632e93e44a 100644 --- a/types/openui5/sap.ui.fl.d.ts +++ b/types/openui5/sap.ui.fl.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/ui/fl/library" {} diff --git a/types/openui5/sap.ui.integration.d.ts b/types/openui5/sap.ui.integration.d.ts index b60b247c8f8d91..67196ea339c476 100644 --- a/types/openui5/sap.ui.integration.d.ts +++ b/types/openui5/sap.ui.integration.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/ui/integration/library" { import { URI } from "sap/ui/core/library"; diff --git a/types/openui5/sap.ui.layout.d.ts b/types/openui5/sap.ui.layout.d.ts index 82f69adeb6ef75..67ee8e0a4dd3c1 100644 --- a/types/openui5/sap.ui.layout.d.ts +++ b/types/openui5/sap.ui.layout.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/ui/layout/library" { import Control from "sap/ui/core/Control"; @@ -6212,11 +6212,11 @@ declare module "sap/ui/layout/form/ColumnLayout" { * So the last row of the {@link sap.ui.layout.form.Form Form} control will not be fully used. * * The default size of the {@link sap.ui.layout.form.FormContainer FormContainer} element can be overwritten - * by using {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData} as `LayoutData`. If one {@link sap.ui.layout.form.FormContainer FormContainer } - * element has {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData} set, the size calculation - * of the other {@link sap.ui.layout.form.FormContainer FormContainer} elements might not lead to the expected - * result. In this case, use {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData} also for - * the other {@link sap.ui.layout.form.FormContainer FormContainer} elements. + * by using {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData} as {@link sap.ui.core.Element#setLayoutData LayoutData}. + * If one {@link sap.ui.layout.form.FormContainer FormContainer} element has {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData } + * set, the size calculation of the other {@link sap.ui.layout.form.FormContainer FormContainer} elements + * might not lead to the expected result. In this case, use {@link sap.ui.layout.form.ColumnContainerData ColumnContainerData } + * also for the other {@link sap.ui.layout.form.FormContainer FormContainer} elements. * * The {@link sap.ui.layout.form.FormElement FormElement} elements are spread out to the columns of a {@link sap.ui.layout.form.FormContainer FormContainer } * element arranged in a newspaper-like order. The position of the labels and fields depends on the size @@ -6523,8 +6523,8 @@ declare module "sap/ui/layout/form/Form" { * UI requirements without changing the `Form` itself. * * For the content of a `Form`, {@link sap.ui.core.VariantLayoutData VariantLayoutData} are supported to - * allow simple switching of the `FormLayout`. `LayoutData` on the content can be used to overwrite the - * default layout of the `Form`. + * allow simple switching of the {@link sap.ui.layout.form.FormLayout FormLayout}. {@link sap.ui.core.Element#setLayoutData LayoutData } + * on the content can be used to overwrite the default layout of the `Form`. * * The `Form` (and its sub-controls) automatically add label and field assignment to enable screen reader * support. It also adds keyboard support to navigate between the fields and groups inside the form. @@ -6533,10 +6533,10 @@ declare module "sap/ui/layout/form/Form" { * Views are also not supported. This could damage the visual layout, keyboard support and screen-reader * support. * - * If editable controls are used as content, the `editable` property must be set to `true`, otherwise to - * `false`. If the `editable` property is set incorrectly, there will be visual issues like wrong label - * alignment or wrong spacing between the controls. In addition to that, wrong screen reader announcements - * might occur. + * If editable controls are used as content, the {@link #setEditable editable} property must be set to `true`, + * otherwise to `false`. If the {@link #setEditable editable} property is set incorrectly, there will be + * visual issues like wrong label alignment or wrong spacing between the controls. In addition to that, + * wrong screen reader announcements might occur. * * @since 1.16.0 */ @@ -6672,7 +6672,7 @@ declare module "sap/ui/layout/form/Form" { * * The labels inside the form will be rendered by default in the according mode. * - * **Note:** The setting of this property does not change the content of the form. For example, `Input` + * **Note:** The setting of this property does not change the content of the form. For example, {@link sap.m.Input Input } * controls in a form with `editable` set to false are still editable. * * **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields @@ -6706,7 +6706,7 @@ declare module "sap/ui/layout/form/Form" { * Title of the `Form`. Can either be a `Title` element or a string. If a `Title` element it used, the style * of the title can be set. * - * **Note:** If a `Toolbar` is used, the `Title` is ignored. + * **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored. * * **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default * level. As the `Form` control cannot know the structure of the page, this might not fit the page structure. @@ -6719,9 +6719,9 @@ declare module "sap/ui/layout/form/Form" { * * Toolbar of the `Form`. * - * **Note:** If a `Toolbar` is used, the `Title` is ignored. If a title is needed inside the `Toolbar` it - * must be added at content to the `Toolbar`. In this case, add the `Title` to the `ariaLabelledBy` association. - * Use the right title level to meet the visual requirements. This might be theme-dependent. + * **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside + * the `Toolbar` it must be added at content to the `Toolbar`. In this case, add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy } + * association. Use the right title level to meet the visual requirements. This might be theme-dependent. * * @since 1.36.0 */ @@ -6817,7 +6817,7 @@ declare module "sap/ui/layout/form/Form" { * * The labels inside the form will be rendered by default in the according mode. * - * **Note:** The setting of this property does not change the content of the form. For example, `Input` + * **Note:** The setting of this property does not change the content of the form. For example, {@link sap.m.Input Input } * controls in a form with `editable` set to false are still editable. * * **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields @@ -6909,7 +6909,7 @@ declare module "sap/ui/layout/form/Form" { * * The labels inside the form will be rendered by default in the according mode. * - * **Note:** The setting of this property does not change the content of the form. For example, `Input` + * **Note:** The setting of this property does not change the content of the form. For example, {@link sap.m.Input Input } * controls in a form with `editable` set to false are still editable. * * **Warning:** If this property is wrongly set, this might lead to visual issues. The labels and fields @@ -6934,7 +6934,7 @@ declare module "sap/ui/layout/form/Form" { * Title of the `Form`. Can either be a `Title` element or a string. If a `Title` element it used, the style * of the title can be set. * - * **Note:** If a `Toolbar` is used, the `Title` is ignored. + * **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored. * * **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default * level. As the `Form` control cannot know the structure of the page, this might not fit the page structure. @@ -6946,9 +6946,9 @@ declare module "sap/ui/layout/form/Form" { /** * Toolbar of the `Form`. * - * **Note:** If a `Toolbar` is used, the `Title` is ignored. If a title is needed inside the `Toolbar` it - * must be added at content to the `Toolbar`. In this case, add the `Title` to the `ariaLabelledBy` association. - * Use the right title level to meet the visual requirements. This might be theme-dependent. + * **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside + * the `Toolbar` it must be added at content to the `Toolbar`. In this case, add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy } + * association. Use the right title level to meet the visual requirements. This might be theme-dependent. * * @since 1.36.0 */ @@ -6964,7 +6964,7 @@ declare module "sap/ui/layout/form/Form" { * Association to controls / IDs that label this control (see WAI-ARIA attribute `aria-labelledby`). * * **Note:** Every `Form` needs to have some title or label (at least for screen reader support). If no - * `Title` is set, and the `Form` is not a child or a control with a title, such as {@link sap.m.Panel Panel } + * {@link #getTitle Title} is set, and the `Form` is not a child or a control with a title, such as {@link sap.m.Panel Panel } * or {@link sap.m.Dialog Dialog}, a label or title needs to be assigned using the `ariaLabelledBy` association. * * @since 1.28.0 @@ -6992,8 +6992,9 @@ declare module "sap/ui/layout/form/FormContainer" { } from "sap/ui/base/ManagedObject"; /** - * A `FormContainer` represents a group inside a `Form`. It consists of `FormElements`. The rendering of - * the `FormContainer` is done by the `FormLayout` assigned to the `Form`. + * A `FormContainer` represents a group inside a {@link sap.ui.layout.form.Form Form}. It consists of {@link sap.ui.layout.form.FormElement FormElements}. + * The rendering of the `FormContainer` is done by the {@link sap.ui.layout.form.Form#getLayout FormLayout } + * assigned to the {@link sap.ui.layout.form.Form Form}. * * @since 1.16.0 */ @@ -7134,7 +7135,7 @@ declare module "sap/ui/layout/form/FormContainer" { * * Defines if the `FormContainer` is expandable. * - * **Note:** The expander icon will only be shown if a `title` is set for the `FormContainer`. + * **Note:** The expander icon will only be shown if a {@link #getTitle Title} is set for the `FormContainer`. * * Default value is `false`. * @@ -7147,7 +7148,7 @@ declare module "sap/ui/layout/form/FormContainer" { * * Container is expanded. * - * **Note:** This property only works if `expandable` is set to `true`. + * **Note:** This property only works if {@link #getExpandable expandable} is set to `true`. * * Default value is `true`. * @@ -7167,7 +7168,7 @@ declare module "sap/ui/layout/form/FormContainer" { * Title of the `FormContainer`. Can either be a `Title` element or a string. If a `Title` element is used, * the style of the title can be set. * - * **Note:** If a `Toolbar` is used, the `Title` is ignored. + * **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored. * * **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default * level. As the `Form` control cannot know the structure of the page, this might not fit the page structure. @@ -7180,9 +7181,9 @@ declare module "sap/ui/layout/form/FormContainer" { * * Toolbar of the `FormContainer`. * - * **Note:** If a `Toolbar` is used, the `Title` is ignored. If a title is needed inside the `Toolbar` it - * must be added at content to the `Toolbar`. In this case add the `Title` to the `ariaLabelledBy` association. - * Use the right title level to meet the visual requirements. This might be theme-dependent. + * **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside + * the `Toolbar` it must be added at content to the `Toolbar`. In this case add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy } + * association. Use the right title level to meet the visual requirements. This might be theme-dependent. * * @since 1.36.0 */ @@ -7286,7 +7287,7 @@ declare module "sap/ui/layout/form/FormContainer" { * * Defines if the `FormContainer` is expandable. * - * **Note:** The expander icon will only be shown if a `title` is set for the `FormContainer`. + * **Note:** The expander icon will only be shown if a {@link #getTitle Title} is set for the `FormContainer`. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * @@ -7306,7 +7307,7 @@ declare module "sap/ui/layout/form/FormContainer" { * * Container is expanded. * - * **Note:** This property only works if `expandable` is set to `true`. + * **Note:** This property only works if {@link #getExpandable expandable} is set to `true`. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * @@ -7372,14 +7373,14 @@ declare module "sap/ui/layout/form/FormContainer" { /** * Container is expanded. * - * **Note:** This property only works if `expandable` is set to `true`. + * **Note:** This property only works if {@link #getExpandable expandable} is set to `true`. */ expanded?: boolean | PropertyBindingInfo | `{${string}}`; /** * Defines if the `FormContainer` is expandable. * - * **Note:** The expander icon will only be shown if a `title` is set for the `FormContainer`. + * **Note:** The expander icon will only be shown if a {@link #getTitle Title} is set for the `FormContainer`. */ expandable?: boolean | PropertyBindingInfo | `{${string}}`; @@ -7401,7 +7402,7 @@ declare module "sap/ui/layout/form/FormContainer" { * Title of the `FormContainer`. Can either be a `Title` element or a string. If a `Title` element is used, * the style of the title can be set. * - * **Note:** If a `Toolbar` is used, the `Title` is ignored. + * **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored. * * **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default * level. As the `Form` control cannot know the structure of the page, this might not fit the page structure. @@ -7413,9 +7414,9 @@ declare module "sap/ui/layout/form/FormContainer" { /** * Toolbar of the `FormContainer`. * - * **Note:** If a `Toolbar` is used, the `Title` is ignored. If a title is needed inside the `Toolbar` it - * must be added at content to the `Toolbar`. In this case add the `Title` to the `ariaLabelledBy` association. - * Use the right title level to meet the visual requirements. This might be theme-dependent. + * **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside + * the `Toolbar` it must be added at content to the `Toolbar`. In this case add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy } + * association. Use the right title level to meet the visual requirements. This might be theme-dependent. * * @since 1.36.0 */ @@ -7428,8 +7429,8 @@ declare module "sap/ui/layout/form/FormContainer" { * used `FormLayout`. * * **Note:** If there is more than one `FormContainers`, every `FormContainer` needs to have some title - * or label (at least for screen reader support). If no `Title` is set, a label or title needs to be assigned - * using the `ariaLabelledBy` association. + * or label (at least for screen reader support). If no {@link #getTitle Title} is set, a label or title + * needs to be assigned using the `ariaLabelledBy` association. * * @since 1.36.0 */ @@ -7452,8 +7453,8 @@ declare module "sap/ui/layout/form/FormElement" { } from "sap/ui/base/ManagedObject"; /** - * A `FormElement` represents a row in a `FormContainer`. A `FormElement` is a combination of one label - * and different controls associated to this label. + * A `FormElement` represents a row in a {@link sap.ui.layout.form.FormContainer FormContainer}. A `FormElement` + * is a combination of one label and different controls associated to this label. * * @since 1.16.0 */ @@ -7553,7 +7554,7 @@ declare module "sap/ui/layout/form/FormElement" { * * **Warning:** Do not put any layout or other container controls in here. This could damage the visual * layout, keyboard support and screen-reader support. Only form controls are allowed. Views are also not - * supported. Allowed controls implement the interface `sap.ui.core.IFormContent`. + * supported. Allowed controls implement the interface {@link sap.ui.core.IFormContent}. */ getFields(): Control[]; /** @@ -7705,7 +7706,7 @@ declare module "sap/ui/layout/form/FormElement" { * * **Warning:** Do not put any layout or other container controls in here. This could damage the visual * layout, keyboard support and screen-reader support. Only form controls are allowed. Views are also not - * supported. Allowed controls implement the interface `sap.ui.core.IFormContent`. + * supported. Allowed controls implement the interface {@link sap.ui.core.IFormContent}. */ fields?: Control[] | Control | AggregationBindingInfo | `{${string}}`; } @@ -9540,8 +9541,8 @@ declare module "sap/ui/layout/form/SimpleForm" { * - A new `Label` control starts a new row (`{@link sap.ui.layout.form.FormElement FormElement}`) in * the form. * - All other controls will be assigned to the row (`{@link sap.ui.layout.form.FormElement FormElement}`) - * that started with the last label. Use `LayoutData` to influence the layout for special cases in - * the Input/Display controls. + * that started with the last label. Use {@link sap.ui.core.Element#setLayoutData LayoutData} to influence + * the layout for special cases in the Input/Display controls. * * **Note:** If a more complex form is needed, use the `{@link sap.ui.layout.form.Form Form}` control instead. * @@ -9793,18 +9794,19 @@ declare module "sap/ui/layout/form/SimpleForm" { * The content of the form is structured in the following way: * - Add a {@link sap.ui.core.Title Title} element or `Toolbar` control to start a new group (`{@link sap.ui.layout.form.FormContainer FormContainer}`). * - * - Add a `Label` control to start a new row (`{@link sap.ui.layout.form.FormElement FormElement}`). + * - Add a {@link sap.m.Label Label} control to start a new row (`{@link sap.ui.layout.form.FormElement FormElement}`). * * - Add controls as input fields, text fields or other as needed. - * - Use `LayoutData` to influence the layout for special cases in the single controls. For example, if - * a `ColumnLayout` is used as a layout, the form content is weighted using 4 cells for the labels and 8 - * cells for the field part, for large size. If there is only little space, the labels are above the fields - * and each field uses 12 cells. If your input controls should influence their width, you can add {@link sap.ui.layout.form.ColumnElementData ColumnElementData } - * to them via the {@link #setLayoutData setLayoutData} method. Ensure that the sum of the weights in the - * {@link sap.ui.layout.form.ColumnElementData ColumnElementData} is not more than 12, as this is the total - * width of the input control part of each form row. Example for a row where the {@link sap.m.Input Input } - * uses 6 cells and the second {@link sap.m.Input Input} uses 2 cells (using {@link sap.ui.layout.form.ColumnElementData ColumnElementData}): - * + * - Use {@link sap.ui.core.Element#setLayoutData LayoutData} to influence the layout for special cases + * in the single controls. For example, if a {@link sap.ui.layout.ColumnLayout ColumnLayout} is used as + * a layout, the form content is weighted using 4 cells for the labels and 8 cells for the field part, for + * large size. If there is only little space, the labels are above the fields and each field uses 12 cells. + * If your input controls should influence their width, you can add {@link sap.ui.layout.form.ColumnElementData ColumnElementData } + * to them via the {@link sap.ui.core.Element#setLayoutData setLayoutData} method. Ensure that the sum of + * the weights in the {@link sap.ui.layout.form.ColumnElementData ColumnElementData} is not more than 12, + * as this is the total width of the input control part of each form row. Example for a row where + * the {@link sap.m.Input Input} uses 6 cells and the second {@link sap.m.Input Input} uses 2 cells (using + * {@link sap.ui.layout.form.ColumnElementData ColumnElementData}): * ```javascript * * new sap.m.Label({text:"Label"}); @@ -9817,10 +9819,10 @@ declare module "sap/ui/layout/form/SimpleForm" { * there are 12 cells in one row. Depending on the screen size the labels use the defined `labelSpan`. The * remaining cells are used for the fields (and `emptySpan` if defined). The available cells are distributed * to all fields in the row. If one field should use a fixed number of cells you can add {@link sap.ui.layout.GridData GridData } - * to them via the {@link #setLayoutData setLayoutData} method. If there are additional fields in the row - * they will get the remaining cells. Example for a row with two {@link sap.m.Input Input} controls - * where one uses four cells on small screens, one cell on medium screens and 2 cells on larger screens - * (using {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout}): + * to them via the {@link sap.ui.core.Element#setLayoutData setLayoutData} method. If there are additional + * fields in the row they will get the remaining cells. Example for a row with two {@link sap.m.Input Input } + * controls where one uses four cells on small screens, one cell on medium screens and 2 cells on larger + * screens (using {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout}): * ```javascript * * new sap.m.Label({text:"Label"}); @@ -9831,12 +9833,12 @@ declare module "sap/ui/layout/form/SimpleForm" { * * **Warning:** Do not put any layout or other container controls in here. This could damage the visual * layout, keyboard support and screen-reader support. Only labels, titles, toolbars and form controls are - * allowed. Views are also not supported. Allowed form controls implement the interface `sap.ui.core.IFormContent`. + * allowed. Views are also not supported. Allowed form controls implement the interface {@link sap.ui.core.IFormContent}. * - * If editable controls are used as content, the `editable` property must be set to `true`, otherwise to - * `false`. If the `editable` property is set incorrectly, there will be visual issues like wrong label - * alignment or wrong spacing between the controls. In addition to that, wrong screen reader announcements - * might occur. + * If editable controls are used as content, the {@link #setEditable editable} property must be set to `true`, + * otherwise to `false`. If the {@link #setEditable editable} property is set incorrectly, there will be + * visual issues like wrong label alignment or wrong spacing between the controls. In addition to that, + * wrong screen reader announcements might occur. */ getContent(): UI5Element[]; /** @@ -10078,7 +10080,7 @@ declare module "sap/ui/layout/form/SimpleForm" { * * Title element of the `SimpleForm`. Can either be a `Title` element, or a string. * - * **Note:** If a `Toolbar` is used, the `Title` is ignored. + * **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored. * * **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default * level. As the `Form` control cannot know the structure of the page, this might not fit the page structure. @@ -10093,8 +10095,9 @@ declare module "sap/ui/layout/form/SimpleForm" { * * Toolbar of the `SimpleForm`. * - * **Note:** If a `Toolbar` is used, the `Title` is ignored. If a title is needed inside the `Toolbar` it - * must be added at content to the `Toolbar`. In this case, add the `Title` to the `ariaLabelledBy` association. + * **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside + * the `Toolbar` it must be added at content to the `Toolbar`. In this case, add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy } + * association. Use the right title level to meet the visual requirements. This might be theme-dependent. * * @since 1.36.0 */ @@ -11002,18 +11005,19 @@ declare module "sap/ui/layout/form/SimpleForm" { * The content of the form is structured in the following way: * - Add a {@link sap.ui.core.Title Title} element or `Toolbar` control to start a new group (`{@link sap.ui.layout.form.FormContainer FormContainer}`). * - * - Add a `Label` control to start a new row (`{@link sap.ui.layout.form.FormElement FormElement}`). + * - Add a {@link sap.m.Label Label} control to start a new row (`{@link sap.ui.layout.form.FormElement FormElement}`). * * - Add controls as input fields, text fields or other as needed. - * - Use `LayoutData` to influence the layout for special cases in the single controls. For example, if - * a `ColumnLayout` is used as a layout, the form content is weighted using 4 cells for the labels and 8 - * cells for the field part, for large size. If there is only little space, the labels are above the fields - * and each field uses 12 cells. If your input controls should influence their width, you can add {@link sap.ui.layout.form.ColumnElementData ColumnElementData } - * to them via the {@link #setLayoutData setLayoutData} method. Ensure that the sum of the weights in the - * {@link sap.ui.layout.form.ColumnElementData ColumnElementData} is not more than 12, as this is the total - * width of the input control part of each form row. Example for a row where the {@link sap.m.Input Input } - * uses 6 cells and the second {@link sap.m.Input Input} uses 2 cells (using {@link sap.ui.layout.form.ColumnElementData ColumnElementData}): - * + * - Use {@link sap.ui.core.Element#setLayoutData LayoutData} to influence the layout for special cases + * in the single controls. For example, if a {@link sap.ui.layout.ColumnLayout ColumnLayout} is used as + * a layout, the form content is weighted using 4 cells for the labels and 8 cells for the field part, for + * large size. If there is only little space, the labels are above the fields and each field uses 12 cells. + * If your input controls should influence their width, you can add {@link sap.ui.layout.form.ColumnElementData ColumnElementData } + * to them via the {@link sap.ui.core.Element#setLayoutData setLayoutData} method. Ensure that the sum of + * the weights in the {@link sap.ui.layout.form.ColumnElementData ColumnElementData} is not more than 12, + * as this is the total width of the input control part of each form row. Example for a row where + * the {@link sap.m.Input Input} uses 6 cells and the second {@link sap.m.Input Input} uses 2 cells (using + * {@link sap.ui.layout.form.ColumnElementData ColumnElementData}): * ```javascript * * new sap.m.Label({text:"Label"}); @@ -11026,10 +11030,10 @@ declare module "sap/ui/layout/form/SimpleForm" { * there are 12 cells in one row. Depending on the screen size the labels use the defined `labelSpan`. The * remaining cells are used for the fields (and `emptySpan` if defined). The available cells are distributed * to all fields in the row. If one field should use a fixed number of cells you can add {@link sap.ui.layout.GridData GridData } - * to them via the {@link #setLayoutData setLayoutData} method. If there are additional fields in the row - * they will get the remaining cells. Example for a row with two {@link sap.m.Input Input} controls - * where one uses four cells on small screens, one cell on medium screens and 2 cells on larger screens - * (using {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout}): + * to them via the {@link sap.ui.core.Element#setLayoutData setLayoutData} method. If there are additional + * fields in the row they will get the remaining cells. Example for a row with two {@link sap.m.Input Input } + * controls where one uses four cells on small screens, one cell on medium screens and 2 cells on larger + * screens (using {@link sap.ui.layout.ResponsiveGridLayout ResponsiveGridLayout}): * ```javascript * * new sap.m.Label({text:"Label"}); @@ -11040,12 +11044,12 @@ declare module "sap/ui/layout/form/SimpleForm" { * * **Warning:** Do not put any layout or other container controls in here. This could damage the visual * layout, keyboard support and screen-reader support. Only labels, titles, toolbars and form controls are - * allowed. Views are also not supported. Allowed form controls implement the interface `sap.ui.core.IFormContent`. + * allowed. Views are also not supported. Allowed form controls implement the interface {@link sap.ui.core.IFormContent}. * - * If editable controls are used as content, the `editable` property must be set to `true`, otherwise to - * `false`. If the `editable` property is set incorrectly, there will be visual issues like wrong label - * alignment or wrong spacing between the controls. In addition to that, wrong screen reader announcements - * might occur. + * If editable controls are used as content, the {@link #setEditable editable} property must be set to `true`, + * otherwise to `false`. If the {@link #setEditable editable} property is set incorrectly, there will be + * visual issues like wrong label alignment or wrong spacing between the controls. In addition to that, + * wrong screen reader announcements might occur. */ content?: | UI5Element[] @@ -11056,7 +11060,7 @@ declare module "sap/ui/layout/form/SimpleForm" { /** * Title element of the `SimpleForm`. Can either be a `Title` element, or a string. * - * **Note:** If a `Toolbar` is used, the `Title` is ignored. + * **Note:** If a {@link #getToolbar Toolbar} is used, the `Title` is ignored. * * **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default * level. As the `Form` control cannot know the structure of the page, this might not fit the page structure. @@ -11070,8 +11074,9 @@ declare module "sap/ui/layout/form/SimpleForm" { /** * Toolbar of the `SimpleForm`. * - * **Note:** If a `Toolbar` is used, the `Title` is ignored. If a title is needed inside the `Toolbar` it - * must be added at content to the `Toolbar`. In this case, add the `Title` to the `ariaLabelledBy` association. + * **Note:** If a `Toolbar` is used, the {@link #getTitle Title} is ignored. If a title is needed inside + * the `Toolbar` it must be added at content to the `Toolbar`. In this case, add the `Title` to the {@link #addAriaLabelledBy ariaLabelledBy } + * association. Use the right title level to meet the visual requirements. This might be theme-dependent. * * @since 1.36.0 */ @@ -11081,8 +11086,9 @@ declare module "sap/ui/layout/form/SimpleForm" { * Association to controls / IDs which label this control (see WAI-ARIA attribute `aria-labelledby`). * * **Note:** Every `Form` needs to have some title or label (at least for screen reader support). If no - * `Title` is set, and the `Form` is not a child or a control with a title, such as {@link sap.m.Panel Panel } - * or {@link sap.m.Dialog Dialog}, a label or title needs to be assigned using the `ariaLabelledBy` association. + * {@link #getTitle Title} is set, and the `SimpleForm` is not a child or a control with a title, such as + * {@link sap.m.Panel Panel} or {@link sap.m.Dialog Dialog}, a label or title needs to be assigned using + * the `ariaLabelledBy` association. * * @since 1.32.0 */ diff --git a/types/openui5/sap.ui.mdc.d.ts b/types/openui5/sap.ui.mdc.d.ts index 7440d5de7a9bd9..fd79eea0680b34 100644 --- a/types/openui5/sap.ui.mdc.d.ts +++ b/types/openui5/sap.ui.mdc.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/ui/mdc/AggregationBaseDelegate" { import BaseDelegate from "sap/ui/mdc/BaseDelegate"; @@ -1442,6 +1442,7 @@ declare module "sap/ui/mdc/field/MultiValueFieldDelegate" { * Items can be removed, updated, or added. Use the binding information of the `MultiValueField` control * to update the data in the related model. * + * @deprecated As of version 1.142. replaced by {@link module:sap/ui/mdc/field/MultiValueFieldDelegate.updateItemsFromConditions updateItemsFromConditions}. * @experimental */ updateItems( @@ -1459,6 +1460,26 @@ declare module "sap/ui/mdc/field/MultiValueFieldDelegate" { */ oMultiValueField: MultiValueField ): void; + /** + * Implements the model-specific logic to update items after conditions have been updated. + * + * Items can be removed, updated, or added. Use the binding information of the `MultiValueField` control + * to update the data in the related model. + * + * @since 1.142 + * @experimental + */ + updateItemsFromConditions( + /** + * Current `MultiValueField` control to determine binding information to update the values of the related + * model + */ + oMultiValueField: MultiValueField, + /** + * Current conditions of the `MultiValueField` control + */ + aConditions: ConditionObject[] + ): void; } const MultiValueFieldDelegate: MultiValueFieldDelegate; export default MultiValueFieldDelegate; @@ -1654,6 +1675,330 @@ declare module "sap/ui/mdc/FilterBarDelegate" { export default FilterBarDelegate; } +declare module "sap/ui/mdc/GeomapDelegate" { + import AggregationBaseDelegate from "sap/ui/mdc/AggregationBaseDelegate"; + + import Geomap from "sap/ui/mdc/Geomap"; + + import Control from "sap/ui/core/Control"; + + import { AggregationBindingInfo } from "sap/ui/base/ManagedObject"; + + import { URI } from "sap/ui/core/library"; + + /** + * Base Delegate for {@link sap.ui.mdc.Geomap Geomap}. Extend this object in your project to use all functionalities + * of the {@link sap.ui.mdc.GeoMap GeoMap}. + * This class provides method calls, that are called by the `geomap` for specific operations and overwrite + * the internal behavior. + * + * @experimental As of version 1.142. + */ + interface GeomapDelegate extends AggregationBaseDelegate { + /** + * Returns the instance of the inner geomap. + * + * + * @returns Instance of the inner geomap + */ + _getInnerGeomap( + /** + * Reference to the MDC geomap + */ + oGeomap: Geomap + ): Control; + /** + * Creates a new geomap item for a given property name and updates the inner geomap. + * **Note:** This does **not** add the geomap item to the `Items` aggregation of the geomap. Called and + * used by `p13n`. + * + * + * @returns `Promise` that resolves with new geomap `Item` as parameter + */ + addItem( + /** + * Reference to the MDC geomap to add the property to + */ + oGeomap: Geomap, + /** + * The name of the property added + */ + sPropertyName: string, + /** + * The property bag containing useful information about the change + */ + mPropertyBag: object, + /** + * New role for given item + */ + sRole?: string + ): Promise; + /** + * Creates the initial content for the geomap before the metadata is retrieved. + * This can be used by geomap libraries that can already show some information without the actual data + * (for example, axis labels, legend, ...). + */ + createInitialGeomapContent( + /** + * Reference to the geomap + */ + oGeomap: Geomap + ): void; + /** + * Binds the inner geomap to the back-end data and creates the inner geomap content. + */ + createInnerGeomapContent( + /** + * Reference to the geomap + */ + oGeomap: Geomap, + /** + * Callback function when data is loaded + */ + fnCallbackDataLoaded: Function + ): void; + /** + * Returns the relevant property info based on the metadata used with the geomap instance. + * + * **Note:** The result of this function must be kept stable throughout the lifecycle of your application. + * Any changes of the returned values might result in undesired effects. + * + * **Note**: Existing properties (set via `sap.ui.mdc.GeoMap#setPropertyInfo`) must not be removed and their + * attributes must not be changed during the {@link module:sap/ui/mdc/GeoMapDelegate.fetchProperties fetchProperties } + * callback. Otherwise validation errors might occur whenever personalization-related control features (such + * as the opening of any personalization dialog) are activated. + * + * + * @returns Array of the property infos that is used within the geomap + */ + fetchProperties( + /** + * Reference to the geomap + */ + oGeomap: Geomap + ): Promise; + /** + * Returns the binding info for given geomap. + * + * + * @returns BindingInfo object + */ + getBindingInfo( + /** + * Reference to the geomap + */ + oGeomap: Geomap + ): AggregationBindingInfo; + /** + * Returns the information for control positions on the map. + * + * + * @returns with defined control positions + */ + getControlPositions(): object; + /** + * Gets the information whether the inner geomap is currently bound. + * + * + * @returns `true` if inner geomap is bound; `false` if not + */ + getGeomapBound( + /** + * Reference to the geomap + */ + oGeomap: Geomap + ): boolean; + /** + * Returns the current geomap type. + * + * + * @returns Information about the current geomap type + */ + getGeomapTypeInfo( + /** + * Reference to the MDC geomap + */ + oGeomap: Geomap + ): /* was: sap.ui.mdc.GeoMap.GeomapTypeObject */ any[]; + /** + * Gets the current zooming information for the geomap. + * + * + * @returns Current `zoom` level of the inner geomap + */ + getZoomLevel( + /** + * Reference to the geomap + */ + oGeomap: Geomap + ): float; + /** + * Loads the required libraries and creates the inner geomap. + * By default, the method returns `Promise.reject()`. + * + * + * @returns Resolved once the inner geomap has been initialized + */ + initializeGeomap( + /** + * Reference to the geomap + */ + oGeomap: Geomap + ): Promise; + /** + * Inserts a geomap item (spot / circle for `sap.geomap.geomap`) into the inner geomap. + * This function is called by the geomap for a change of the `Items` aggregation. + * **Note:** Do not call this yourself, as it would not be synced with the geomap, but insert the item + * into the geomap instead. + */ + insertItemToGeomap( + /** + * geomap into which the item is insert + */ + oGeomap: Geomap, + /** + * geomap item (spot, container, circle & etc. )that is inserted into the inner geomap + */ + oGeomapItem: object, + /** + * The index into which the geomap item is inserted + */ + iIndex: int, + /** + * the type of item which should be added to the geomap + */ + sType: string + ): void; + /** + * Checks the binding of the geomap and rebinds it if required. + */ + rebind( + /** + * Reference to the geomap + */ + oGeomap: Geomap, + /** + * BindingInfo of the geomap + */ + oBindingInfo: AggregationBindingInfo + ): void; + /** + * Removes an existing geomap item for a given property name and updates the inner geomap.. + * + * + * @returns `Promise` containing information whether the item was deleted + */ + removeItem( + /** + * Reference to the MDC geomap from which property is removed + */ + oGeomap: Geomap, + /** + * The `item` that is removed from the geomap + */ + oItem: object, + /** + * The property bag containing useful information about the change + */ + mPropertyBag: object + ): Promise; + /** + * Removes a geomap item (spot / circle for `sap.geomap.geomap`) from the inner geomap. + * This function is called by the geomap for a change of the `Items` aggregation. + * **Note:** Do not call this yourself, as it would not be synced with the geomap, but remove the item + * from the geomap instead. + */ + removeItemFromGeomap( + /** + * geomap from which the item is removed + */ + oGeoap: Geomap, + /** + * geomap item that is removed from the geomap + */ + oGeomapItem: object, + /** + * geomap item type that should be removed from the geomap + */ + sType: string + ): void; + /** + * Updates the binding info with the relevant information. + * By default, this method updates a given {@link sap.ui.base.ManagedObject.AggregationBindingInfo AggregationBindingInfo}. + */ + updateBindingInfo( + /** + * Reference to the geomap + */ + oGeomap: Geomap, + /** + * Binding info of the geomap + */ + oBindingInfo: AggregationBindingInfo + ): void; + /** + * Notifies the inner geomap to zoom in. + */ + zoomIn( + /** + * Reference to the geomap + */ + oGeomap: Geomap + ): void; + /** + * Notifies the inner geomap to zoom out. + */ + zoomOut( + /** + * Reference to the geomap + */ + oGeoMap: /* was: sap.ui.mdc.GeoMap */ any + ): void; + } + const GeomapDelegate: GeomapDelegate; + export default GeomapDelegate; + + /** + * Geomap `GeomapTypeObject` type. + * + * @experimental As of version 1.142. + */ + export type GeomapTypeObject = { + /** + * Unique key of the geomap type + */ + key: string; + /** + * URI for the icon for the current geomap type + */ + icon: URI; + /** + * Name of the current geomap type + */ + text: string; + /** + * Whether the geomap type is the one currently used + */ + selected: boolean; + }; + + /** + * geomap `ZoomState` type. + * + * @experimental As of version 1.142. + */ + export type ZoomState = { + /** + * Zooming is enabled if set to `true` + */ + enabled: boolean; + /** + * Current zoom level of the geomap in percent (between 0 and 1) + */ + currentZoomLevel: number; + }; +} + declare module "sap/ui/mdc/LinkDelegate" { import BaseDelegate from "sap/ui/mdc/BaseDelegate"; @@ -2989,9 +3334,8 @@ declare module "sap/ui/mdc/ValueHelpDelegate" { /** * Returns filters that are used when updating the binding of the `ValueHelp`. * By default, this method returns a set of {@link sap.ui.model.Filter Filters} originating from an available - * {@link sap.ui.mdc.FilterBar FilterBar}, the delegate's own {@link module:sap/ui/mdc/ValueHelpDelegate.getFilterConditions getFilterConditions}, - * and/or the {@link sap.ui.mdc.valuehelp.base.FilterableListContent#getFilterFields filterFields} configuration - * of the given {@link sap.ui.mdc.valuehelp.base.FilterableListContent FilterableListContent}. + * {@link sap.ui.mdc.FilterBar FilterBar} or the delegate's own {@link module:sap/ui/mdc/ValueHelpDelegate.getFilterConditions getFilterConditions } + * implementation. * * @since 1.121 * @ui5-protected Do not call from applications (only from related classes in the framework) @@ -7744,6 +8088,16 @@ declare module "sap/ui/mdc/enums/FilterBarValidationStatus" { export default FilterBarValidationStatus; } +declare module "sap/ui/mdc/enums/GeomapControlPosition" { + /** + * Enumeration of the `position` property of the Geomap controls + * + * @experimental As of version 1.142. + */ + enum GeomapControlPosition {} + export default GeomapControlPosition; +} + declare module "sap/ui/mdc/enums/LinkType" { /** * Defines the behavior of the {@link sap.ui.mdc.Link}. @@ -8994,6 +9348,9 @@ declare module "sap/ui/mdc/Field" { * To display the key and the description in one field, the description must be set on the `additionalValue` * property. * + * **Warning:** Don't use a `Formatter` in the binding of this property since this only allows one-way binding. + * Therefore, no parsing of user input and no model updates are possible. + * * * @returns Value of property `additionalValue` */ @@ -9058,6 +9415,9 @@ declare module "sap/ui/mdc/Field" { * * To display the key and the description in one field, the key must be set on the `value` property. * + * **Warning:** Don't use a `Formatter` in the binding of this property since this only allows one-way binding. + * Therefore, no parsing of user input and no model updates are possible. + * * * @returns Value of property `value` */ @@ -9070,6 +9430,9 @@ declare module "sap/ui/mdc/Field" { * To display the key and the description in one field, the description must be set on the `additionalValue` * property. * + * **Warning:** Don't use a `Formatter` in the binding of this property since this only allows one-way binding. + * Therefore, no parsing of user input and no model updates are possible. + * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @@ -9174,6 +9537,9 @@ declare module "sap/ui/mdc/Field" { * * To display the key and the description in one field, the key must be set on the `value` property. * + * **Warning:** Don't use a `Formatter` in the binding of this property since this only allows one-way binding. + * Therefore, no parsing of user input and no model updates are possible. + * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @@ -9219,6 +9585,9 @@ declare module "sap/ui/mdc/Field" { * The value of the field. * * To display the key and the description in one field, the key must be set on the `value` property. + * + * **Warning:** Don't use a `Formatter` in the binding of this property since this only allows one-way binding. + * Therefore, no parsing of user input and no model updates are possible. */ value?: any | PropertyBindingInfo | `{${string}}`; @@ -9227,6 +9596,9 @@ declare module "sap/ui/mdc/Field" { * * To display the key and the description in one field, the description must be set on the `additionalValue` * property. + * + * **Warning:** Don't use a `Formatter` in the binding of this property since this only allows one-way binding. + * Therefore, no parsing of user input and no model updates are possible. */ additionalValue?: any | PropertyBindingInfo | `{${string}}`; @@ -11562,6 +11934,23 @@ declare module "sap/ui/mdc/field/FieldBase" { */ sWidth?: CSSSize ): this; + /** + * Checks if a condition update needs to fire a `ValidationSuccess` event. + * + * This is required in {@link sap.ui.mdc.field.Field Field} if the condition update doesn't lead to an update + * of the {@link sap.ui.mdc.field.Field#setValue value} property. (If only description or payload is changed.) + * + * @since 1.142.0 + * @ui5-protected Do not call from applications (only from related classes in the framework) + * + * @returns `true` if the `ValidationSuccess` event is fired + */ + shouldFireValidationSuccessOnConditionUpdate( + /** + * Current conditions + */ + aConditions: ConditionObject[] + ): boolean; /** * Triggers a check if all relevant properties are set to create the internal content control. * @@ -12695,6 +13084,8 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" { import { IFilterSource, IFilter, IxState, State } from "sap/ui/mdc/library"; + import InvisibleText from "sap/ui/core/InvisibleText"; + import FilterBarValidationStatus from "sap/ui/mdc/enums/FilterBarValidationStatus"; import FilterField from "sap/ui/mdc/FilterField"; @@ -12788,6 +13179,18 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" { * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; + /** + * Adds an `InvisibleText` to the `FilterBar` that can be used for accessibility purposes. + * + * @since 1.142 + * @ui5-protected Do not call from applications (only from related classes in the framework) + */ + addInvisibleText( + /** + * The invisible text to be added + */ + oInvisibleText: InvisibleText + ): void; /** * Attaches event handler `fnFunction` to the {@link #event:filtersChanged filtersChanged} event of this * `sap.ui.mdc.filterbar.FilterBarBase`. @@ -13052,9 +13455,23 @@ declare module "sap/ui/mdc/filterbar/FilterBarBase" { */ getFilterItems(): FilterField[]; /** - * Gets current value of property {@link #getLiveMode liveMode}. + * Retrieves an `InvisibleText` by ID. * - * Triggers a search automatically after a filter value has been changed. + * @since 1.142 + * @ui5-protected Do not call from applications (only from related classes in the framework) + * + * @returns The invisible text with the given ID + */ + getInvisibleText( + /** + * ID of the invisible text to be retrieved + */ + sId: string + ): InvisibleText; + /** + * Gets current value of property {@link #getLiveMode liveMode}. + * + * Triggers a search automatically after a filter value has been changed. * **Note:** The `liveMode` property only operates in non-mobile scenarios. * Additionally, if the `liveMode` property is active, the following applies: * The error message box is not displayed, and the `showMessages` property is ignored. @@ -13966,125 +14383,1112 @@ declare module "sap/ui/mdc/FilterField" { * * @since 1.73.0 * - * @returns Value of property `operators` + * @returns Value of property `operators` + */ + getOperators(): string[]; + /** + * Gets current value of property {@link #getPropertyKey propertyKey}. + * + * Key of the property the `FilterField` represents. + * + * Default value is `empty string`. + * + * @since 1.115.0 + * + * @returns Value of property `propertyKey` + */ + getPropertyKey(): string; + /** + * Removes all operators from the list of known operators. + */ + removeAllOperators(): void; + /** + * Removes an operator from the list of known operators. The standard operators can are mentioned in {@link sap.ui.mdc.enums.OperatorName OperatorName}. + */ + removeOperator( + /** + * The operator instance or operator name + */ + vOperator: Operator | string + ): void; + /** + * Removes all given operators from the list of known operators. + * + * **Note**: `aOperators` can be the name of an {@link sap.ui.mdc.condition.Operator Operator}, the instance + * itself, or multiple operators inside an array. The standard operators are mentioned in {@link sap.ui.mdc.enums.OperatorName OperatorName}. + */ + removeOperators( + /** + * Array of operators + */ + aOperators: Operator[] + ): void; + /** + * Sets a new value for property {@link #getAdditionalDataType additionalDataType}. + * + * The type of data for the description part of an "equal to" condition. This type is used to parse, format, + * and validate the value. + * + * Here a data type instance can be provided or an object containing `name`, `formatOptions`, and `constraints`. + * + * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * + * @since 1.118.0 + * + * @returns Reference to `this` in order to allow method chaining + */ + setAdditionalDataType( + /** + * New value for property `additionalDataType` + */ + oAdditionalDataType?: object + ): this; + /** + * Sets a new value for property {@link #getDefaultOperator defaultOperator}. + * + * Default operator name for conditions. If empty, the relevant default operator depending on the data type + * used is taken. + * + * **Note**: `defaultOperator` can be the name of an {@link sap.ui.mdc.condition.Operator Operator} or the + * instance itself. + * + * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * + * @since 1.88.0 + * + * @returns Reference to `this` in order to allow method chaining + */ + setDefaultOperator( + /** + * New value for property `defaultOperator` + */ + sDefaultOperator?: string + ): this; + /** + * Sets a new value for property {@link #getOperators operators}. + * + * Supported operator names for conditions. + * + * If empty, default operators depending on used data type are taken. The standard operators are mentioned + * in {@link sap.ui.mdc.enums.OperatorName OperatorName}. + * + * **Note:** If a custom control is used as {@link sap.ui.mdc.field.FieldBase#setContent Content}, {@link sap.ui.mdc.field.FieldBase#setContentEdit ContentEdit}, + * or {@link sap.ui.mdc.field.FieldBase#setContentDisplay ContentDisplay}, and the custom control only supports + * one operator (as no operator can be shown), only the required operator must be set. So the user input + * into the custom control creates a condition with the set operator, and a condition with this operator + * provides the value the custom control needs. + * + * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * + * Default value is `[]`. + * + * @since 1.73.0 + * + * @returns Reference to `this` in order to allow method chaining + */ + setOperators( + /** + * New value for property `operators` + */ + sOperators?: string[] + ): this; + /** + * Sets a new value for property {@link #getPropertyKey propertyKey}. + * + * Key of the property the `FilterField` represents. + * + * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * + * Default value is `empty string`. + * + * @since 1.115.0 + * + * @returns Reference to `this` in order to allow method chaining + */ + setPropertyKey( + /** + * New value for property `propertyKey` + */ + sPropertyKey?: string + ): this; + } + /** + * Describes the settings that can be provided to the FilterField constructor. + */ + export interface $FilterFieldSettings extends $FieldBaseSettings { + /** + * Supported operator names for conditions. + * + * If empty, default operators depending on used data type are taken. The standard operators are mentioned + * in {@link sap.ui.mdc.enums.OperatorName OperatorName}. + * + * **Note:** If a custom control is used as {@link sap.ui.mdc.field.FieldBase#setContent Content}, {@link sap.ui.mdc.field.FieldBase#setContentEdit ContentEdit}, + * or {@link sap.ui.mdc.field.FieldBase#setContentDisplay ContentDisplay}, and the custom control only supports + * one operator (as no operator can be shown), only the required operator must be set. So the user input + * into the custom control creates a condition with the set operator, and a condition with this operator + * provides the value the custom control needs. + * + * @since 1.73.0 + */ + operators?: string[] | PropertyBindingInfo | `{${string}}`; + + /** + * Default operator name for conditions. If empty, the relevant default operator depending on the data type + * used is taken. + * + * **Note**: `defaultOperator` can be the name of an {@link sap.ui.mdc.condition.Operator Operator} or the + * instance itself. + * + * @since 1.88.0 + */ + defaultOperator?: string | PropertyBindingInfo; + + /** + * Key of the property the `FilterField` represents. + * + * @since 1.115.0 + */ + propertyKey?: string | PropertyBindingInfo; + + /** + * The type of data for the description part of an "equal to" condition. This type is used to parse, format, + * and validate the value. + * + * Here a data type instance can be provided or an object containing `name`, `formatOptions`, and `constraints`. + * + * @since 1.118.0 + */ + additionalDataType?: object | PropertyBindingInfo | `{${string}}`; + + /** + * This event is fired when the `conditions` property of the `FilterField` is changed by a user interaction. + * + * **Note** This event is only triggered if the used content control has a change event. + */ + change?: (oEvent: FilterField$ChangeEvent) => void; + } + + /** + * Parameters of the FilterField#change event. + */ + export interface FilterField$ChangeEventParameters { + /** + * The new value of the `control` + */ + value?: string; + + /** + * Flag that indicates if the entered `value` is valid + */ + valid?: boolean; + + /** + * Conditions of the field. This includes all conditions, not only the changed ones. + * + * **Note:** A condition must have the structure of {@link sap.ui.mdc.condition.ConditionObject ConditionObject}. + */ + conditions?: object[]; + + /** + * Returns a `Promise` for the change. The `Promise` returns the value if it is resolved. If the `change` + * event is synchronous, the `Promise` has already been resolved. If it is asynchronous, it will be resolved + * after the value has been updated. + * + * The `FilterField` should be set to busy during the parsing to prevent user input. As there might be a + * whole group of fields that needs to be busy, this cannot be done automatically. + */ + promise?: boolean; + } + + /** + * Event object of the FilterField#change event. + */ + export type FilterField$ChangeEvent = Event< + FilterField$ChangeEventParameters, + FilterField + >; +} + +declare module "sap/ui/mdc/Geomap" { + import { default as Control, $ControlSettings } from "sap/ui/mdc/Control"; + + import { IFilterSource, IxState } from "sap/ui/mdc/library"; + + import Event from "sap/ui/base/Event"; + + import { CSSSize } from "sap/ui/core/library"; + + import Item from "sap/ui/mdc/geomap/Item"; + + import ElementMetadata from "sap/ui/core/ElementMetadata"; + + import { PropertyInfo as PropertyInfo1 } from "sap/ui/mdc/util/PropertyHelper"; + + import { + PropertyBindingInfo, + AggregationBindingInfo, + } from "sap/ui/base/ManagedObject"; + + /** + * The `Geomap` control creates a geomap based on metadata and the configuration specified. + * **Note:** The geomap needs to be created inside the `GeomapDelegate`. + * + * @experimental As of version 1.142. + */ + export default class Geomap + extends Control + implements IFilterSource, IxState + { + __implements__sap_ui_mdc_IFilterSource: boolean; + __implements__sap_ui_mdc_IxState: boolean; + /** + * Constructor for a new GeoMap. + * + * 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. + * See: + * {@link https://ui5.sap.com/#/topic/1dd2aa91115d43409452a271d11be95b sap.ui.mdc} + */ + constructor( + /** + * Initial settings for the new control + */ + mSettings?: $GeomapSettings + ); + /** + * Constructor for a new GeoMap. + * + * 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. + * See: + * {@link https://ui5.sap.com/#/topic/1dd2aa91115d43409452a271d11be95b sap.ui.mdc} + */ + constructor( + /** + * ID for the new control, generated automatically if no id is given + */ + sId?: string, + /** + * Initial settings for the new control + */ + mSettings?: $GeomapSettings + ); + + /** + * Creates a new subclass of class sap.ui.mdc.Geomap 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.mdc.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.ui.mdc.Geomap. + * + * + * @returns Metadata object describing this class + */ + static getMetadata(): ElementMetadata; + /** + * Attaches event handler `fnFunction` to the {@link #event:zoomChange zoomChange} event of this `sap.ui.mdc.Geomap`. + * + * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, + * otherwise it will be bound to this `sap.ui.mdc.Geomap` itself. + * + * This event is fired when zooming is performed on the map. + * + * + * @returns Reference to `this` in order to allow method chaining + */ + attachZoomChange( + /** + * An application-specific payload object that will be passed to the event handler along with the event + * object when firing the event + */ + oData: object, + /** + * The function to be called when the event occurs + */ + fnFunction: (p1: Event) => void, + /** + * Context object to call the event handler with. Defaults to this `sap.ui.mdc.Geomap` itself + */ + oListener?: object + ): this; + /** + * Attaches event handler `fnFunction` to the {@link #event:zoomChange zoomChange} event of this `sap.ui.mdc.Geomap`. + * + * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, + * otherwise it will be bound to this `sap.ui.mdc.Geomap` itself. + * + * This event is fired when zooming is performed on the map. + * + * + * @returns Reference to `this` in order to allow method chaining + */ + attachZoomChange( + /** + * The function to be called when the event occurs + */ + fnFunction: (p1: Event) => void, + /** + * Context object to call the event handler with. Defaults to this `sap.ui.mdc.Geomap` itself + */ + oListener?: object + ): this; + /** + * Destroys all the items in the aggregation {@link #getItems items}. + * + * + * @returns Reference to `this` in order to allow method chaining + */ + destroyItems(): this; + /** + * Detaches event handler `fnFunction` from the {@link #event:zoomChange zoomChange} event of this `sap.ui.mdc.Geomap`. + * + * The passed function and listener object must match the ones used for event registration. + * + * + * @returns Reference to `this` in order to allow method chaining + */ + detachZoomChange( + /** + * The function to be called, when the event occurs + */ + fnFunction: (p1: Event) => void, + /** + * Context object on which the given function had to be called + */ + oListener?: object + ): this; + /** + * Fires event {@link #event:zoomChange zoomChange} to attached listeners. + * + * @ui5-protected Do not call from applications (only from related classes in the framework) + * + * @returns Reference to `this` in order to allow method chaining + */ + fireZoomChange( + /** + * Parameters to pass along with the event + */ + mParameters?: object + ): this; + /** + * Gets current value of property {@link #getCenterLat centerLat}. + * + * Latitude of the point where the map is centered + * + * + * @returns Value of property `centerLat` + */ + getCenterLat(): float; + /** + * Gets current value of property {@link #getCenterLng centerLng}. + * + * Longitude of the point where the map is centered + * + * + * @returns Value of property `centerLng` + */ + getCenterLng(): float; + /** + * Gets current value of property {@link #getDelegate delegate}. + * + * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic. + * The object has the following properties: + * - `name` defines the path to the `Delegate` module + * - `payload` (optional) defines application-specific information that can be used in the given delegate + * Sample delegate object: + * ```javascript + * { + * name: "sap/ui/mdc/BaseDelegate", + * payload: {} + * }``` + * **Note:** Ensure that the related file can be requested (any required library has to be loaded before + * that). + * Do not bind or modify the module. This property can only be configured during control initialization. + * + * Default value is `...see text or source`. + * + * @experimental + * + * @returns Value of property `delegate` + */ + getDelegate(): object; + /** + * Gets current value of property {@link #getEnableCopyrightControl enableCopyrightControl}. + * + * Enables the copyright control for the map + * + * Default value is `false`. + * + * + * @returns Value of property `enableCopyrightControl` + */ + getEnableCopyrightControl(): boolean; + /** + * Gets current value of property {@link #getEnableFullscreenControl enableFullscreenControl}. + * + * Enables the full screen control for the map + * + * Default value is `true`. + * + * + * @returns Value of property `enableFullscreenControl` + */ + getEnableFullscreenControl(): boolean; + /** + * Gets current value of property {@link #getEnableNavigationControl enableNavigationControl}. + * + * Enables the navigation & compas control for the map + * + * Default value is `true`. + * + * + * @returns Value of property `enableNavigationControl` + */ + getEnableNavigationControl(): boolean; + /** + * Gets current value of property {@link #getEnableScaleControl enableScaleControl}. + * + * Enables the scale control for the map + * + * Default value is `true`. + * + * + * @returns Value of property `enableScaleControl` + */ + getEnableScaleControl(): boolean; + /** + * Gets current value of property {@link #getEnableSelectionControl enableSelectionControl}. + * + * Enables the selection control for the map + * + * Default value is `false`. + * + * + * @returns Value of property `enableSelectionControl` + */ + getEnableSelectionControl(): boolean; + /** + * Gets current value of property {@link #getHeader header}. + * + * Header text that appears in the geomap + * + * Default value is `empty string`. + * + * + * @returns Value of property `header` + */ + getHeader(): string; + /** + * Gets current value of property {@link #getHeight height}. + * + * Defines the height of the geomap. + * + * Default value is `"700px"`. + * + * + * @returns Value of property `height` + */ + getHeight(): CSSSize; + /** + * Gets content of aggregation {@link #getItems items}. + * + * Aggregates the items to be displayed in the geomap. Note: As items are custom elements defined as part + * of the webc library the type here could not be strictly defined or used a generic one so supported types + * are limited to those supported by the webc library. + */ + getItems(): Item[]; + /** + * Gets current value of property {@link #getWidth width}. + * + * Defines the width of the geomap. + * + * Default value is `"700px"`. + * + * + * @returns Value of property `width` + */ + getWidth(): CSSSize; + /** + * Gets current value of property {@link #getZoom zoom}. + * + * Zoom level of the map - the bigger, the more the map is zoomed + * + * + * @returns Value of property `zoom` + */ + getZoom(): float; + /** + * Checks for the provided `sap.ui.mdc.geomap.Item` in the aggregation {@link #getItems items}. and returns + * its index if found or -1 otherwise. + * + * + * @returns The index of the provided control in the aggregation if found, or -1 otherwise + */ + indexOfItem( + /** + * The item whose index is looked for + */ + oItem: Item + ): int; + /** + * Inserts a item into the aggregation {@link #getItems items}. + * + * + * @returns Reference to `this` in order to allow method chaining + */ + insertItem( + /** + * The item to insert; if empty, nothing is inserted + */ + oItem: Item, + /** + * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted + * at position 0; for a value greater than the current size of the aggregation, the item is inserted at + * the last position + */ + iIndex: int + ): this; + /** + * Executes a rebind considering the provided external and inbuilt filtering. + * + * @since 1.98 + * + * @returns A `Promise` that resolves after rebind is executed, and rejects if rebind cannot be executed, + * for example because there are invalid filters. + */ + rebind(): Promise; + /** + * Sets a new value for property {@link #getCenterLat centerLat}. + * + * Latitude of the point where the map is centered + * + * 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 + */ + setCenterLat( + /** + * New value for property `centerLat` + */ + fCenterLat: float + ): this; + /** + * Sets a new value for property {@link #getCenterLng centerLng}. + * + * Longitude of the point where the map is centered + * + * 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 + */ + setCenterLng( + /** + * New value for property `centerLng` + */ + fCenterLng: float + ): this; + /** + * Sets a new value for property {@link #getDelegate delegate}. + * + * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic. + * The object has the following properties: + * - `name` defines the path to the `Delegate` module + * - `payload` (optional) defines application-specific information that can be used in the given delegate + * Sample delegate object: + * ```javascript + * { + * name: "sap/ui/mdc/BaseDelegate", + * payload: {} + * }``` + * **Note:** Ensure that the related file can be requested (any required library has to be loaded before + * that). + * Do not bind or modify the module. This property can only be configured during control initialization. + * + * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * + * Default value is `...see text or source`. + * + * @experimental + * + * @returns Reference to `this` in order to allow method chaining + */ + setDelegate( + /** + * New value for property `delegate` + */ + oDelegate?: object + ): this; + /** + * Sets a new value for property {@link #getEnableCopyrightControl enableCopyrightControl}. + * + * Enables the copyright control for the map + * + * 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 + */ + setEnableCopyrightControl( + /** + * New value for property `enableCopyrightControl` + */ + bEnableCopyrightControl?: boolean + ): this; + /** + * Sets a new value for property {@link #getEnableFullscreenControl enableFullscreenControl}. + * + * Enables the full screen control for the map + * + * 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 + */ + setEnableFullscreenControl( + /** + * New value for property `enableFullscreenControl` + */ + bEnableFullscreenControl?: boolean + ): this; + /** + * Sets a new value for property {@link #getEnableNavigationControl enableNavigationControl}. + * + * Enables the navigation & compas control for the map + * + * 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 + */ + setEnableNavigationControl( + /** + * New value for property `enableNavigationControl` + */ + bEnableNavigationControl?: boolean + ): this; + /** + * Sets a new value for property {@link #getEnableScaleControl enableScaleControl}. + * + * Enables the scale control for the map + * + * 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 + */ + setEnableScaleControl( + /** + * New value for property `enableScaleControl` + */ + bEnableScaleControl?: boolean + ): this; + /** + * Sets a new value for property {@link #getEnableSelectionControl enableSelectionControl}. + * + * Enables the selection control for the map + * + * 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 + */ + setEnableSelectionControl( + /** + * New value for property `enableSelectionControl` + */ + bEnableSelectionControl?: boolean + ): this; + /** + * Sets a new value for property {@link #getHeader header}. + * + * Header text that appears in the geomap + * + * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * + * Default value is `empty string`. + * + * + * @returns Reference to `this` in order to allow method chaining + */ + setHeader( + /** + * New value for property `header` + */ + sHeader?: string + ): this; + /** + * Sets a new value for property {@link #getHeight height}. + * + * Defines the height of the geomap. + * + * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * + * Default value is `"700px"`. + * + * + * @returns Reference to `this` in order to allow method chaining + */ + setHeight( + /** + * New value for property `height` + */ + sHeight?: CSSSize + ): this; + /** + * Sets a new value for property {@link #getWidth width}. + * + * Defines the width of the geomap. + * + * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * + * Default value is `"700px"`. + * + * + * @returns Reference to `this` in order to allow method chaining + */ + setWidth( + /** + * New value for property `width` + */ + sWidth?: CSSSize + ): this; + /** + * Sets a new value for property {@link #getZoom zoom}. + * + * Zoom level of the map - the bigger, the more the map is zoomed + * + * 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 + */ + setZoom( + /** + * New value for property `zoom` + */ + fZoom: float + ): this; + } + /** + * An object literal describing a data property in the context of a {@link sap.ui.mdc.GeoMap}. + * + * When specifying the `PropertyInfo` objects in the {@link sap.ui.mdc.GeoMap#getPropertyInfo propertyInfo } + * property, the following attributes need to be specified: + * - `key` + * - `label` + * - `visible` + * - `path` + * - `dataType` + * - `formatOptions` + * - `constraints` + * + * @experimental As of version 1.142. + */ + export type PropertyInfo = PropertyInfo1 & { + /** + * Defines the key that the property is related to + */ + key?: string; + /** + * Defines the label of the property associated with the key. + */ + label?: string; + /** + * Defines the visibility of the property. + */ + visible?: boolean; + /** + * The path of the property in the data source. + */ + path?: string; + /** + * Defines the data type associated to the property. + */ + dataType?: string; + /** + * Defines if any format options are applied to the property. + */ + formatOptions?: object; + /** + * Defines if any constraints are applied to the property. + */ + constraints?: object; + }; + + /** + * Describes the settings that can be provided to the Geomap constructor. + * + * @experimental As of version 1.142. + */ + export interface $GeomapSettings extends $ControlSettings { + /** + * Defines the width of the geomap. + */ + width?: CSSSize | PropertyBindingInfo | `{${string}}`; + + /** + * Defines the height of the geomap. + */ + height?: CSSSize | PropertyBindingInfo | `{${string}}`; + + /** + * Header text that appears in the geomap + */ + header?: string | PropertyBindingInfo; + + /** + * Latitude of the point where the map is centered + */ + centerLat?: float | PropertyBindingInfo | `{${string}}`; + + /** + * Longitude of the point where the map is centered + */ + centerLng?: float | PropertyBindingInfo | `{${string}}`; + + /** + * Zoom level of the map - the bigger, the more the map is zoomed + */ + zoom?: float | PropertyBindingInfo | `{${string}}`; + + /** + * Enables the selection control for the map + */ + enableSelectionControl?: boolean | PropertyBindingInfo | `{${string}}`; + + /** + * Enables the navigation & compas control for the map + */ + enableNavigationControl?: boolean | PropertyBindingInfo | `{${string}}`; + + /** + * Enables the full screen control for the map + */ + enableFullscreenControl?: boolean | PropertyBindingInfo | `{${string}}`; + + /** + * Enables the scale control for the map + */ + enableScaleControl?: boolean | PropertyBindingInfo | `{${string}}`; + + /** + * Enables the copyright control for the map + */ + enableCopyrightControl?: boolean | PropertyBindingInfo | `{${string}}`; + + /** + * Object related to the `Delegate` module that provides the required APIs to execute model-specific logic. + * The object has the following properties: + * - `name` defines the path to the `Delegate` module + * - `payload` (optional) defines application-specific information that can be used in the given delegate + * Sample delegate object: + * ```javascript + * { + * name: "sap/ui/mdc/BaseDelegate", + * payload: {} + * }``` + * **Note:** Ensure that the related file can be requested (any required library has to be loaded before + * that). + * Do not bind or modify the module. This property can only be configured during control initialization. + * + * @experimental + */ + delegate?: object | PropertyBindingInfo | `{${string}}`; + + /** + * Specifies the geomap metadata. + * **Note:** This property must not be bound. + * **Note:** This property is exclusively used for handling SAPUI5 flexibility changes. Do not use it otherwise. + * **Note**: Existing properties (set via `sap.ui.mdc.Geomap#setPropertyInfo`) must not be removed and + * their attributes must not be changed during the {@link module:sap/ui/mdc/GeoMapDelegate.fetchProperties fetchProperties } + * callback. Otherwise validation errors might occur whenever personalization-related control features (such + * as the opening of any personalization dialog) are activated. + * + * **Note**: For more information about the supported inner elements, see {@link sap.ui.mdc.geomap.PropertyInfo PropertyInfo}. */ - getOperators(): string[]; + propertyInfo?: object | PropertyBindingInfo | `{${string}}`; + /** - * Gets current value of property {@link #getPropertyKey propertyKey}. - * - * Key of the property the `FilterField` represents. - * - * Default value is `empty string`. - * - * @since 1.115.0 - * - * @returns Value of property `propertyKey` + * Aggregates the items to be displayed in the geomap. Note: As items are custom elements defined as part + * of the webc library the type here could not be strictly defined or used a generic one so supported types + * are limited to those supported by the webc library. */ - getPropertyKey(): string; + items?: Item[] | Item | AggregationBindingInfo | `{${string}}`; + /** - * Removes all operators from the list of known operators. + * This event is fired when zooming is performed on the map. */ - removeAllOperators(): void; + zoomChange?: (oEvent: Event) => void; + } + + /** + * Parameters of the Geomap#zoomChange event. + */ + export interface Geomap$ZoomChangeEventParameters {} + + /** + * Event object of the Geomap#zoomChange event. + */ + export type Geomap$ZoomChangeEvent = Event< + Geomap$ZoomChangeEventParameters, + Geomap + >; +} + +declare module "sap/ui/mdc/geomap/Item" { + import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element"; + + import ElementMetadata from "sap/ui/core/ElementMetadata"; + + import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; + + /** + * The `Item` element for the geomap/property metadata used within MDC Geomap. + * + * @experimental As of version 1.142. + */ + export default class Item extends UI5Element { /** - * Removes an operator from the list of known operators. The standard operators can are mentioned in {@link sap.ui.mdc.enums.OperatorName OperatorName}. + * Constructor for a new `Item`. + * + * 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. */ - removeOperator( + constructor( /** - * The operator instance or operator name + * initial settings for the new element */ - vOperator: Operator | string - ): void; + mSettings?: $ItemSettings + ); /** - * Removes all given operators from the list of known operators. + * Constructor for a new `Item`. * - * **Note**: `aOperators` can be the name of an {@link sap.ui.mdc.condition.Operator Operator}, the instance - * itself, or multiple operators inside an array. The standard operators are mentioned in {@link sap.ui.mdc.enums.OperatorName OperatorName}. + * 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. */ - removeOperators( + constructor( /** - * Array of operators + * ID for the new element, generated automatically if no ID is given */ - aOperators: Operator[] - ): void; + sId?: string, + /** + * initial settings for the new element + */ + mSettings?: $ItemSettings + ); + /** - * Sets a new value for property {@link #getAdditionalDataType additionalDataType}. - * - * The type of data for the description part of an "equal to" condition. This type is used to parse, format, - * and validate the value. - * - * Here a data type instance can be provided or an object containing `name`, `formatOptions`, and `constraints`. + * Creates a new subclass of class sap.ui.mdc.geomap.Item with name `sClassName` and enriches it with the + * information contained in `oClassInfo`. * - * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * - * @since 1.118.0 * - * @returns Reference to `this` in order to allow method chaining + * @returns Created class / constructor function */ - setAdditionalDataType( + static extend>( /** - * New value for property `additionalDataType` + * Name of the class being created */ - oAdditionalDataType?: object - ): this; + 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; /** - * Sets a new value for property {@link #getDefaultOperator defaultOperator}. + * Returns a metadata object for class sap.ui.mdc.geomap.Item. * - * Default operator name for conditions. If empty, the relevant default operator depending on the data type - * used is taken. * - * **Note**: `defaultOperator` can be the name of an {@link sap.ui.mdc.condition.Operator Operator} or the - * instance itself. + * @returns Metadata object describing this class + */ + static getMetadata(): ElementMetadata; + /** + * Gets current value of property {@link #getLabel label}. * - * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * Label for the item, either as a string literal or by a pointer, using the binding to some property containing + * the label. * - * @since 1.88.0 * - * @returns Reference to `this` in order to allow method chaining + * @returns Value of property `label` */ - setDefaultOperator( - /** - * New value for property `defaultOperator` - */ - sDefaultOperator?: string - ): this; + getLabel(): string; /** - * Sets a new value for property {@link #getOperators operators}. + * Gets current value of property {@link #getPropertyKey propertyKey}. * - * Supported operator names for conditions. + * The unique identifier of the geomap item that reflects the name of property in the PropertyInfo. * - * If empty, default operators depending on used data type are taken. The standard operators are mentioned - * in {@link sap.ui.mdc.enums.OperatorName OperatorName}. + * @since 1.142 * - * **Note:** If a custom control is used as {@link sap.ui.mdc.field.FieldBase#setContent Content}, {@link sap.ui.mdc.field.FieldBase#setContentEdit ContentEdit}, - * or {@link sap.ui.mdc.field.FieldBase#setContentDisplay ContentDisplay}, and the custom control only supports - * one operator (as no operator can be shown), only the required operator must be set. So the user input - * into the custom control creates a condition with the set operator, and a condition with this operator - * provides the value the custom control needs. + * @returns Value of property `propertyKey` + */ + getPropertyKey(): string; + /** + * Sets a new value for property {@link #getLabel label}. * - * When called with a value of `null` or `undefined`, the default value of the property will be restored. + * Label for the item, either as a string literal or by a pointer, using the binding to some property containing + * the label. * - * Default value is `[]`. + * When called with a value of `null` or `undefined`, the default value of the property will be restored. * - * @since 1.73.0 * * @returns Reference to `this` in order to allow method chaining */ - setOperators( + setLabel( /** - * New value for property `operators` + * New value for property `label` */ - sOperators?: string[] + sLabel: string ): this; /** * Sets a new value for property {@link #getPropertyKey propertyKey}. * - * Key of the property the `FilterField` represents. + * The unique identifier of the geomap item that reflects the name of property in the PropertyInfo. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * - * Default value is `empty string`. - * - * @since 1.115.0 + * @since 1.142 * * @returns Reference to `this` in order to allow method chaining */ @@ -14092,104 +15496,28 @@ declare module "sap/ui/mdc/FilterField" { /** * New value for property `propertyKey` */ - sPropertyKey?: string + sPropertyKey: string ): this; } /** - * Describes the settings that can be provided to the FilterField constructor. + * Describes the settings that can be provided to the Item constructor. + * + * @experimental As of version 1.142. */ - export interface $FilterFieldSettings extends $FieldBaseSettings { - /** - * Supported operator names for conditions. - * - * If empty, default operators depending on used data type are taken. The standard operators are mentioned - * in {@link sap.ui.mdc.enums.OperatorName OperatorName}. - * - * **Note:** If a custom control is used as {@link sap.ui.mdc.field.FieldBase#setContent Content}, {@link sap.ui.mdc.field.FieldBase#setContentEdit ContentEdit}, - * or {@link sap.ui.mdc.field.FieldBase#setContentDisplay ContentDisplay}, and the custom control only supports - * one operator (as no operator can be shown), only the required operator must be set. So the user input - * into the custom control creates a condition with the set operator, and a condition with this operator - * provides the value the custom control needs. - * - * @since 1.73.0 - */ - operators?: string[] | PropertyBindingInfo | `{${string}}`; - - /** - * Default operator name for conditions. If empty, the relevant default operator depending on the data type - * used is taken. - * - * **Note**: `defaultOperator` can be the name of an {@link sap.ui.mdc.condition.Operator Operator} or the - * instance itself. - * - * @since 1.88.0 - */ - defaultOperator?: string | PropertyBindingInfo; - + export interface $ItemSettings extends $ElementSettings { /** - * Key of the property the `FilterField` represents. + * The unique identifier of the geomap item that reflects the name of property in the PropertyInfo. * - * @since 1.115.0 + * @since 1.142 */ propertyKey?: string | PropertyBindingInfo; /** - * The type of data for the description part of an "equal to" condition. This type is used to parse, format, - * and validate the value. - * - * Here a data type instance can be provided or an object containing `name`, `formatOptions`, and `constraints`. - * - * @since 1.118.0 - */ - additionalDataType?: object | PropertyBindingInfo | `{${string}}`; - - /** - * This event is fired when the `conditions` property of the `FilterField` is changed by a user interaction. - * - * **Note** This event is only triggered if the used content control has a change event. - */ - change?: (oEvent: FilterField$ChangeEvent) => void; - } - - /** - * Parameters of the FilterField#change event. - */ - export interface FilterField$ChangeEventParameters { - /** - * The new value of the `control` - */ - value?: string; - - /** - * Flag that indicates if the entered `value` is valid - */ - valid?: boolean; - - /** - * Conditions of the field. This includes all conditions, not only the changed ones. - * - * **Note:** A condition must have the structure of {@link sap.ui.mdc.condition.ConditionObject ConditionObject}. - */ - conditions?: object[]; - - /** - * Returns a `Promise` for the change. The `Promise` returns the value if it is resolved. If the `change` - * event is synchronous, the `Promise` has already been resolved. If it is asynchronous, it will be resolved - * after the value has been updated. - * - * The `FilterField` should be set to busy during the parsing to prevent user input. As there might be a - * whole group of fields that needs to be busy, this cannot be done automatically. + * Label for the item, either as a string literal or by a pointer, using the binding to some property containing + * the label. */ - promise?: boolean; + label?: string | PropertyBindingInfo; } - - /** - * Event object of the FilterField#change event. - */ - export type FilterField$ChangeEvent = Event< - FilterField$ChangeEventParameters, - FilterField - >; } declare module "sap/ui/mdc/Link" { @@ -15181,7 +16509,7 @@ declare module "sap/ui/mdc/MultiValueField" { * Items of the `MultiValueField` control. * * The items are not updated by user input or value help selection automatically. That's because an aggregation - * binding can only be updated by the model, not by the bound aggregation. Therefore, the {@link module:sap/ui/mdc/field/MultiValueFieldDelegate.updateItems MultiValueFieldDelegate.updateItems } + * binding can only be updated by the model, not by the bound aggregation. Therefore, the {@link module:sap/ui/mdc/field/MultiValueFieldDelegate.updateItemsFromConditions MultiValueFieldDelegate.updateItemsFromConditions } * function needs to be implemented to update the items after a user interaction. */ getItems(): MultiValueFieldItem[]; @@ -15422,7 +16750,7 @@ declare module "sap/ui/mdc/MultiValueField" { * Items of the `MultiValueField` control. * * The items are not updated by user input or value help selection automatically. That's because an aggregation - * binding can only be updated by the model, not by the bound aggregation. Therefore, the {@link module:sap/ui/mdc/field/MultiValueFieldDelegate.updateItems MultiValueFieldDelegate.updateItems } + * binding can only be updated by the model, not by the bound aggregation. Therefore, the {@link module:sap/ui/mdc/field/MultiValueFieldDelegate.updateItemsFromConditions MultiValueFieldDelegate.updateItemsFromConditions } * function needs to be implemented to update the items after a user interaction. */ items?: @@ -15569,7 +16897,7 @@ declare module "sap/ui/mdc/p13n/StateUtil" { * Retrieves the externalized state for a given control instance. The retrieved state is equivalent to the * `getCurrentState` API for the given control, after all necessary changes have been applied (for example, * variant appliance and `p13n, StateUtil` changes). After the returned `Promise` has been resolved, the - * returned state is in sync with the according state object of the MDC control (for example, `filterConditions` + * returned state is in sync with the corresponding state object of the MDC control (for example, `filterConditions` * for the `FilterBar` control). * * @@ -25918,6 +27246,8 @@ declare namespace sap { "sap/ui/mdc/enums/FilterBarValidationStatus": undefined; + "sap/ui/mdc/enums/GeomapControlPosition": undefined; + "sap/ui/mdc/enums/LinkType": undefined; "sap/ui/mdc/enums/OperatorName": undefined; @@ -26018,6 +27348,12 @@ declare namespace sap { "sap/ui/mdc/FilterField": undefined; + "sap/ui/mdc/Geomap": undefined; + + "sap/ui/mdc/geomap/Item": undefined; + + "sap/ui/mdc/GeomapDelegate": undefined; + "sap/ui/mdc/library": undefined; "sap/ui/mdc/Link": undefined; @@ -26044,6 +27380,8 @@ declare namespace sap { "sap/ui/mdc/odata/v4/ChartDelegate": undefined; + "sap/ui/mdc/odata/v4/GeomapDelegate": undefined; + "sap/ui/mdc/odata/v4/TableDelegate": undefined; "sap/ui/mdc/odata/v4/TypeMap": undefined; diff --git a/types/openui5/sap.ui.rta.d.ts b/types/openui5/sap.ui.rta.d.ts index 811541bcb24b38..be648a99e1c08e 100644 --- a/types/openui5/sap.ui.rta.d.ts +++ b/types/openui5/sap.ui.rta.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/ui/rta/api/startAdaptation" { import Control from "sap/ui/core/Control"; diff --git a/types/openui5/sap.ui.suite.d.ts b/types/openui5/sap.ui.suite.d.ts index e76defba125c8d..8011fafa06dccf 100644 --- a/types/openui5/sap.ui.suite.d.ts +++ b/types/openui5/sap.ui.suite.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/ui/suite/library" { /** diff --git a/types/openui5/sap.ui.support.d.ts b/types/openui5/sap.ui.support.d.ts index b8c7bf7f95db0f..6f2b6987263023 100644 --- a/types/openui5/sap.ui.support.d.ts +++ b/types/openui5/sap.ui.support.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/ui/support/library" { /** diff --git a/types/openui5/sap.ui.table.d.ts b/types/openui5/sap.ui.table.d.ts index 0848160040bb10..dc7c7678dcbdad 100644 --- a/types/openui5/sap.ui.table.d.ts +++ b/types/openui5/sap.ui.table.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/ui/table/library" { import TreeAutoExpandMode1 from "sap/ui/model/TreeAutoExpandMode"; @@ -4541,6 +4541,9 @@ declare module "sap/ui/table/RowAction" { * more action items are available as the available space allows to display an overflow mechanism is provided. * This control must only be used in the context of the `sap.ui.table.Table` control to define row actions. * + * **Note**: The `RowActionItem` of type `Navigation` has a special role and is shown as the rightmost icon + * independent of the order in the `items` aggregation. + * * @since 1.45 */ export default class RowAction extends Control { @@ -4938,7 +4941,7 @@ declare module "sap/ui/table/RowActionItem" { * @returns Value of property `visible` */ getVisible(): boolean; - /** + /* * Sets a new value for property {@link #getIcon icon}. * * The icon of the item. @@ -8487,8 +8490,9 @@ declare module "sap/ui/table/Table" { /** * Gets current value of property {@link #getRowActionCount rowActionCount}. * - * Number of row actions made visible which determines the width of the row action column. The values `0`, - * `1` and `2` are possible. + * Number of row actions made visible, hence this property also determines the width of the row action column. + * The maximum number of visible row actions is 3. If the `rowActionTemplate` contains more `rowActionItems`, + * they are shown in an overflow menu. * * Default value is `0`. * @@ -9476,8 +9480,9 @@ declare module "sap/ui/table/Table" { /** * Sets a new value for property {@link #getRowActionCount rowActionCount}. * - * Number of row actions made visible which determines the width of the row action column. The values `0`, - * `1` and `2` are possible. + * Number of row actions made visible, hence this property also determines the width of the row action column. + * The maximum number of visible row actions is 3. If the `rowActionTemplate` contains more `rowActionItems`, + * they are shown in an overflow menu. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * @@ -10169,8 +10174,9 @@ declare module "sap/ui/table/Table" { enableBusyIndicator?: boolean | PropertyBindingInfo | `{${string}}`; /** - * Number of row actions made visible which determines the width of the row action column. The values `0`, - * `1` and `2` are possible. + * Number of row actions made visible, hence this property also determines the width of the row action column. + * The maximum number of visible row actions is 3. If the `rowActionTemplate` contains more `rowActionItems`, + * they are shown in an overflow menu. * * @since 1.45.0 */ diff --git a/types/openui5/sap.ui.testrecorder.d.ts b/types/openui5/sap.ui.testrecorder.d.ts index 7486144de79350..d0148feb575c6a 100644 --- a/types/openui5/sap.ui.testrecorder.d.ts +++ b/types/openui5/sap.ui.testrecorder.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/ui/testrecorder/library" {} diff --git a/types/openui5/sap.ui.unified.d.ts b/types/openui5/sap.ui.unified.d.ts index ac8222b6656a1c..e04bb52e8ec2bc 100644 --- a/types/openui5/sap.ui.unified.d.ts +++ b/types/openui5/sap.ui.unified.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/ui/unified/library" { /** @@ -15224,8 +15224,7 @@ declare module "sap/ui/unified/FileUploader" { * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.unified.FileUploader` itself. * - * Event is fired when the size of a file is above the `maximumFileSize` property. This event is not supported - * by Internet Explorer 9 (same restriction as for the property `maximumFileSize`). + * Event is fired when the size of a file is above the `maximumFileSize` property. * * * @returns Reference to `this` in order to allow method chaining @@ -15252,8 +15251,7 @@ declare module "sap/ui/unified/FileUploader" { * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.unified.FileUploader` itself. * - * Event is fired when the size of a file is above the `maximumFileSize` property. This event is not supported - * by Internet Explorer 9 (same restriction as for the property `maximumFileSize`). + * Event is fired when the size of a file is above the `maximumFileSize` property. * * * @returns Reference to `this` in order to allow method chaining @@ -15323,8 +15321,7 @@ declare module "sap/ui/unified/FileUploader" { * * Event is fired after the current upload has been aborted. * - * This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in - * Internet Explorer 9. + * This event is only supported with property `sendXHR` set to true. * * @since 1.24.0 * @@ -15353,8 +15350,7 @@ declare module "sap/ui/unified/FileUploader" { * * Event is fired after the current upload has been aborted. * - * This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in - * Internet Explorer 9. + * This event is only supported with property `sendXHR` set to true. * * @since 1.24.0 * @@ -15439,8 +15435,7 @@ declare module "sap/ui/unified/FileUploader" { * It contains progress information related to the running upload. Depending on file size, band width and * used browser the event is fired once or multiple times. * - * This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in - * Internet Explorer 9. + * This event is only supported with property `sendXHR` set to true. * * @since 1.24.0 * @@ -15473,8 +15468,7 @@ declare module "sap/ui/unified/FileUploader" { * It contains progress information related to the running upload. Depending on file size, band width and * used browser the event is fired once or multiple times. * - * This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in - * Internet Explorer 9. + * This event is only supported with property `sendXHR` set to true. * * @since 1.24.0 * @@ -16040,8 +16034,7 @@ declare module "sap/ui/unified/FileUploader" { * * The chosen files will be checked against an array of file types. * - * If at least one file does not fit the file type restriction, the upload is prevented. **Note:** This - * property is not supported by Microsoft Edge. + * If at least one file does not fit the file type restriction, the upload is prevented. * * Example: `["jpg", "png", "bmp"]`. * @@ -16052,8 +16045,7 @@ declare module "sap/ui/unified/FileUploader" { /** * Gets content of aggregation {@link #getHeaderParameters headerParameters}. * - * The header parameters for the `FileUploader` which are only submitted with XHR requests. Header parameters - * are not supported by Internet Explorer 9. + * The header parameters for the `FileUploader` which are only submitted with XHR requests. */ getHeaderParameters(): FileUploaderParameter[]; /** @@ -16153,8 +16145,6 @@ declare module "sap/ui/unified/FileUploader" { * * A file size limit in megabytes which prevents the upload if at least one file exceeds it. * - * This property is not supported by Internet Explorer 9. - * * * @returns Value of property `maximumFileSize` */ @@ -16166,11 +16156,10 @@ declare module "sap/ui/unified/FileUploader" { * * If at least one file does not fit the MIME type restriction, the upload is prevented. * - * **Note:** This property is not supported by Internet Explorer. It is only reliable for common file types - * like images, audio, video, plain text and HTML documents. File types that are not recognized by the browser - * result in `file.type` to be returned as an empty string. In this case the verification could not be performed. - * The file upload is not prevented and the validation based on file type is left to the receiving backend - * side. + * **Note:** This property is only reliable for common file types like images, audio, video, plain text + * and HTML documents. File types that are not recognized by the browser result in `file.type` to be returned + * as an empty string. In this case the verification could not be performed. The file upload is not prevented + * and the validation based on file type is left to the receiving backend side. * * Example: `["image/png", "image/jpeg"]`. * @@ -16183,8 +16172,6 @@ declare module "sap/ui/unified/FileUploader" { * * Allows multiple files to be chosen and uploaded from the same folder. * - * This property is not supported by Internet Explorer 9. - * * **Note:** Keep in mind that the various operating systems for mobile devices can react differently to * the property so that fewer upload functions may be available in some cases. * @@ -16261,8 +16248,6 @@ declare module "sap/ui/unified/FileUploader" { * * If set to "true", the request will be sent as XHR request instead of a form submit. * - * This property is not supported by Internet Explorer 9. - * * Default value is `false`. * * @@ -16615,8 +16600,7 @@ declare module "sap/ui/unified/FileUploader" { * * The chosen files will be checked against an array of file types. * - * If at least one file does not fit the file type restriction, the upload is prevented. **Note:** This - * property is not supported by Microsoft Edge. + * If at least one file does not fit the file type restriction, the upload is prevented. * * Example: `["jpg", "png", "bmp"]`. * @@ -16777,8 +16761,6 @@ declare module "sap/ui/unified/FileUploader" { * * A file size limit in megabytes which prevents the upload if at least one file exceeds it. * - * This property is not supported by Internet Explorer 9. - * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @@ -16797,11 +16779,10 @@ declare module "sap/ui/unified/FileUploader" { * * If at least one file does not fit the MIME type restriction, the upload is prevented. * - * **Note:** This property is not supported by Internet Explorer. It is only reliable for common file types - * like images, audio, video, plain text and HTML documents. File types that are not recognized by the browser - * result in `file.type` to be returned as an empty string. In this case the verification could not be performed. - * The file upload is not prevented and the validation based on file type is left to the receiving backend - * side. + * **Note:** This property is only reliable for common file types like images, audio, video, plain text + * and HTML documents. File types that are not recognized by the browser result in `file.type` to be returned + * as an empty string. In this case the verification could not be performed. The file upload is not prevented + * and the validation based on file type is left to the receiving backend side. * * Example: `["image/png", "image/jpeg"]`. * @@ -16821,8 +16802,6 @@ declare module "sap/ui/unified/FileUploader" { * * Allows multiple files to be chosen and uploaded from the same folder. * - * This property is not supported by Internet Explorer 9. - * * **Note:** Keep in mind that the various operating systems for mobile devices can react differently to * the property so that fewer upload functions may be available in some cases. * @@ -16898,8 +16877,6 @@ declare module "sap/ui/unified/FileUploader" { * * If set to "true", the request will be sent as XHR request instead of a form submit. * - * This property is not supported by Internet Explorer 9. - * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. @@ -17150,8 +17127,7 @@ declare module "sap/ui/unified/FileUploader" { /** * The chosen files will be checked against an array of file types. * - * If at least one file does not fit the file type restriction, the upload is prevented. **Note:** This - * property is not supported by Microsoft Edge. + * If at least one file does not fit the file type restriction, the upload is prevented. * * Example: `["jpg", "png", "bmp"]`. */ @@ -17160,8 +17136,6 @@ declare module "sap/ui/unified/FileUploader" { /** * Allows multiple files to be chosen and uploaded from the same folder. * - * This property is not supported by Internet Explorer 9. - * * **Note:** Keep in mind that the various operating systems for mobile devices can react differently to * the property so that fewer upload functions may be available in some cases. */ @@ -17169,8 +17143,6 @@ declare module "sap/ui/unified/FileUploader" { /** * A file size limit in megabytes which prevents the upload if at least one file exceeds it. - * - * This property is not supported by Internet Explorer 9. */ maximumFileSize?: float | PropertyBindingInfo | `{${string}}`; @@ -17179,11 +17151,10 @@ declare module "sap/ui/unified/FileUploader" { * * If at least one file does not fit the MIME type restriction, the upload is prevented. * - * **Note:** This property is not supported by Internet Explorer. It is only reliable for common file types - * like images, audio, video, plain text and HTML documents. File types that are not recognized by the browser - * result in `file.type` to be returned as an empty string. In this case the verification could not be performed. - * The file upload is not prevented and the validation based on file type is left to the receiving backend - * side. + * **Note:** This property is only reliable for common file types like images, audio, video, plain text + * and HTML documents. File types that are not recognized by the browser result in `file.type` to be returned + * as an empty string. In this case the verification could not be performed. The file upload is not prevented + * and the validation based on file type is left to the receiving backend side. * * Example: `["image/png", "image/jpeg"]`. */ @@ -17191,8 +17162,6 @@ declare module "sap/ui/unified/FileUploader" { /** * If set to "true", the request will be sent as XHR request instead of a form submit. - * - * This property is not supported by Internet Explorer 9. */ sendXHR?: boolean | PropertyBindingInfo | `{${string}}`; @@ -17323,8 +17292,7 @@ declare module "sap/ui/unified/FileUploader" { | `{${string}}`; /** - * The header parameters for the `FileUploader` which are only submitted with XHR requests. Header parameters - * are not supported by Internet Explorer 9. + * The header parameters for the `FileUploader` which are only submitted with XHR requests. */ headerParameters?: | FileUploaderParameter[] @@ -17373,8 +17341,7 @@ declare module "sap/ui/unified/FileUploader" { typeMissmatch?: (oEvent: FileUploader$TypeMissmatchEvent) => void; /** - * Event is fired when the size of a file is above the `maximumFileSize` property. This event is not supported - * by Internet Explorer 9 (same restriction as for the property `maximumFileSize`). + * Event is fired when the size of a file is above the `maximumFileSize` property. */ fileSizeExceed?: (oEvent: FileUploader$FileSizeExceedEvent) => void; @@ -17394,8 +17361,7 @@ declare module "sap/ui/unified/FileUploader" { * It contains progress information related to the running upload. Depending on file size, band width and * used browser the event is fired once or multiple times. * - * This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in - * Internet Explorer 9. + * This event is only supported with property `sendXHR` set to true. * * @since 1.24.0 */ @@ -17404,8 +17370,7 @@ declare module "sap/ui/unified/FileUploader" { /** * Event is fired after the current upload has been aborted. * - * This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in - * Internet Explorer 9. + * This event is only supported with property `sendXHR` set to true. * * @since 1.24.0 */ @@ -17604,8 +17569,7 @@ declare module "sap/ui/unified/FileUploader" { /** * Http-Request-Headers. * - * Required for receiving `requestHeader` is to set the property `sendXHR` to true. This property is not - * supported by Internet Explorer 9. + * Required for receiving `requestHeader` is to set the property `sendXHR` to true. */ requestHeaders?: object[]; } @@ -17639,16 +17603,14 @@ declare module "sap/ui/unified/FileUploader" { /** * ReadyState of the XHR request. * - * Required for receiving a `readyStateXHR` is to set the property `sendXHR` to true. This property is not - * supported by Internet Explorer 9. + * Required for receiving a `readyStateXHR` is to set the property `sendXHR` to true. */ readyStateXHR?: string; /** * Status of the XHR request. * - * Required for receiving a `status` is to set the property `sendXHR` to true. This property is not supported - * by Internet Explorer 9. + * Required for receiving a `status` is to set the property `sendXHR` to true. */ status?: int; @@ -17656,8 +17618,6 @@ declare module "sap/ui/unified/FileUploader" { * Http-Response which comes from the server. * * Required for receiving `responseRaw` is to set the property `sendXHR` to true. - * - * This property is not supported by Internet Explorer 9. */ responseRaw?: string; @@ -17667,16 +17627,14 @@ declare module "sap/ui/unified/FileUploader" { * Provided as a JSON-map, i.e. each header-field is reflected by a property in the `headers` object, with * the property value reflecting the header-field's content. * - * Required for receiving `headers` is to set the property `sendXHR` to true. This property is not supported - * by Internet Explorer 9. + * Required for receiving `headers` is to set the property `sendXHR` to true. */ headers?: object; /** * Http-Request-Headers. * - * Required for receiving `requestHeaders` is to set the property `sendXHR` to true. This property is not - * supported by Internet Explorer 9. + * Required for receiving `requestHeaders` is to set the property `sendXHR` to true. */ requestHeaders?: object[]; } @@ -17716,8 +17674,7 @@ declare module "sap/ui/unified/FileUploader" { /** * Http-Request-Headers. * - * Required for receiving `requestHeaders` is to set the property `sendXHR` to true. This property is not - * supported by Internet Explorer 9. + * Required for receiving `requestHeaders` is to set the property `sendXHR` to true. */ requestHeaders?: object[]; } @@ -17742,8 +17699,7 @@ declare module "sap/ui/unified/FileUploader" { /** * Http-Request-Headers. * - * Required for receiving `requestHeaders` is to set the property `sendXHR` to true. This property is not - * supported by Internet Explorer 9. + * Required for receiving `requestHeaders` is to set the property `sendXHR` to true. */ requestHeaders?: object[]; } diff --git a/types/openui5/sap.ui.ux3.d.ts b/types/openui5/sap.ui.ux3.d.ts index 9ff3ec7b544257..51fdbf952914df 100644 --- a/types/openui5/sap.ui.ux3.d.ts +++ b/types/openui5/sap.ui.ux3.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/ui/ux3/library" { /** diff --git a/types/openui5/sap.ui.webc.common.d.ts b/types/openui5/sap.ui.webc.common.d.ts index 0276291b315885..1aace19ff0ab34 100644 --- a/types/openui5/sap.ui.webc.common.d.ts +++ b/types/openui5/sap.ui.webc.common.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/ui/webc/common/library" {} diff --git a/types/openui5/sap.ui.webc.fiori.d.ts b/types/openui5/sap.ui.webc.fiori.d.ts index e50f14f4cdbafe..1820f3d6cba42d 100644 --- a/types/openui5/sap.ui.webc.fiori.d.ts +++ b/types/openui5/sap.ui.webc.fiori.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/ui/webc/fiori/library" { /** diff --git a/types/openui5/sap.ui.webc.main.d.ts b/types/openui5/sap.ui.webc.main.d.ts index 6b4e6e26b75aca..712d389e084324 100644 --- a/types/openui5/sap.ui.webc.main.d.ts +++ b/types/openui5/sap.ui.webc.main.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/ui/webc/main/library" { /** diff --git a/types/openui5/sap.uxap.d.ts b/types/openui5/sap.uxap.d.ts index b2363f3234488f..414cf8bc8a3863 100644 --- a/types/openui5/sap.uxap.d.ts +++ b/types/openui5/sap.uxap.d.ts @@ -1,4 +1,4 @@ -// For Library Version: 1.141.0 +// For Library Version: 1.142.0 declare module "sap/uxap/library" { /**