@openui5/ts-types 1.138.0 → 1.140.0

package/types/sap.ui.table.d.ts

@@ -1,10 +1,21 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.140.0
 
 declare namespace sap {
   namespace ui {
     /**
      * Table-like controls, mainly for desktop scenarios.
      *
+     * Basic support for OData V4 is provided, especially by the following plugins:
+     * 	 - {@link sap.ui.table.plugins.ODataV4MultiSelection ODataV4MultiSelection}
+     * 	 - {@link sap.ui.table.plugins.ODataV4SingleSelection ODataV4SingleSelection}
+     * 	 - {@link sap.ui.table.plugins.ODataV4Aggregation ODataV4Aggregation}
+     * 	 - {@link sap.ui.table.plugins.ODataV4Hierarchy ODataV4Hierarchy}  With OData V4, use one of the
+     *     OData V4 selection plugins instead of the table's built-in selection or a different selection plugin.
+     *
+     * For more extensive functionality, the SAP Fiori Elements framework for OData V4 provides the {@link https://ui5.sap.com/#/topic/549749bd901440d4bb242282a16b0ec2 Flexible Programming Model}.
+     * It offers building blocks that can be used without additional integration effort. For more table-related
+     * information, see the {@link https://ui5.sap.com/#/topic/3801656db27b4b7a9099b6ed5fa1d769 Table Building Block}.
+     *
      * @since 0.8
      */
     namespace table {
@@ -68,6 +79,77 @@ declare namespace sap {
           ) => void;
         }
 
+        /**
+         * Describes the settings that can be provided to the ODataV4Aggregation constructor.
+         */
+        interface $ODataV4AggregationSettings
+          extends sap.ui.core.$ElementSettings {
+          /**
+           * Indicates whether this plugin is enabled.
+           */
+          enabled?:
+            | boolean
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
+          /**
+           * Provides a custom group header title.
+           *
+           * This function is called for each group header row in the table. It receives the binding context of the
+           * row and the group level property path according to `groupLevels` in {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}).
+           * The function must return a string that is used as the title of the group header row.
+           *
+           * Function signature: `groupHeaderFormatter(oContext: sap.ui.model.odata.v4.Context, sPropertyPath: string):
+           * string`
+           */
+          groupHeaderFormatter?:
+            | Function
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+        }
+
+        /**
+         * Describes the settings that can be provided to the ODataV4Hierarchy constructor.
+         */
+        interface $ODataV4HierarchySettings
+          extends sap.ui.core.$ElementSettings {
+          /**
+           * Indicates whether this plugin is enabled.
+           */
+          enabled?:
+            | boolean
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+        }
+
+        /**
+         * Describes the settings that can be provided to the ODataV4MultiSelection constructor.
+         */
+        interface $ODataV4MultiSelectionSettings
+          extends sap.ui.table.plugins.$SelectionPluginSettings {
+          /**
+           * Enables notifications that are displayed once a selection has been limited.
+           */
+          enableNotification?:
+            | boolean
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+
+          /**
+           * Hide the header selector.
+           */
+          hideHeaderSelector?:
+            | boolean
+            | sap.ui.base.ManagedObject.PropertyBindingInfo
+            | `{${string}}`;
+        }
+
+        /**
+         * Describes the settings that can be provided to the ODataV4SingleSelection constructor.
+         */
+        interface $ODataV4SingleSelectionSettings
+          extends sap.ui.table.plugins.$SelectionPluginSettings {}
+
         /**
          * Describes the settings that can be provided to the SelectionPlugin constructor.
          */
@@ -132,6 +214,10 @@ declare namespace sap {
          * Select All, only work properly if the count is known. Make sure the model/binding is configured to request
          * the count from the service. For ease of use, client-side models and single selection are also supported.
          *
+         * With ODataV4, use the {@link sap.ui.table.plugins.ODataV4MultiSelection ODataV4MultiSelection} plugin
+         * or the {@link sap.ui.table.plugins.ODataV4SingleSelection ODataV4SingleSelection} plugin instead of this
+         * one.
+         *
          * @since 1.64
          */
         class MultiSelectionPlugin extends sap.ui.table.plugins
@@ -547,6 +633,469 @@ declare namespace sap {
             bShowHeaderSelector?: boolean
           ): this;
         }
+        /**
+         * Integrates the information about the data structure of the {@link sap.ui.model.odata.v4.ODataListBinding }
+         * and the table. The table is enabled to visualize grouped data with summary rows. Works only in combination
+         * with a {@link sap.ui.model.odata.v4.ODataModel}.
+         *
+         * For details about data aggregation, see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}.
+         *
+         * @since 1.140
+         */
+        class ODataV4Aggregation extends sap.ui.core.Element {
+          /**
+           * 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/7d914317c0b64c23824bf932cc8a4ae1 OData V4: Data Aggregation and Recursive Hierarchy}
+           */
+          constructor();
+
+          /**
+           * Creates a new subclass of class sap.ui.table.plugins.ODataV4Aggregation with name `sClassName` and enriches
+           * it with the information contained in `oClassInfo`.
+           *
+           * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
+           *
+           *
+           * @returns Created class / constructor function
+           */
+          static extend<T extends Record<string, unknown>>(
+            /**
+             * Name of the class being created
+             */
+            sClassName: string,
+            /**
+             * Object literal with information about the class
+             */
+            oClassInfo?: sap.ClassInfo<
+              T,
+              sap.ui.table.plugins.ODataV4Aggregation
+            >,
+            /**
+             * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+             * used by this class
+             */
+            FNMetaImpl?: Function
+          ): Function;
+          /**
+           * Searches a plugin of the corresponding type in the aggregations of the given `Table` instance. The first
+           * plugin that is found is returned.
+           *
+           *
+           * @returns The found plugin instance or `undefined` if not found
+           */
+          static findOn(
+            /**
+             * The `Table` instance to check for
+             */
+            oTable: sap.ui.table.Table
+          ): sap.ui.core.Element | undefined;
+          /**
+           * Returns a metadata object for class sap.ui.table.plugins.ODataV4Aggregation.
+           *
+           *
+           * @returns Metadata object describing this class
+           */
+          static getMetadata(): sap.ui.core.ElementMetadata;
+          /**
+           * Gets current value of property {@link #getEnabled enabled}.
+           *
+           * Indicates whether this plugin is enabled.
+           *
+           * Default value is `true`.
+           *
+           *
+           * @returns Value of property `enabled`
+           */
+          getEnabled(): boolean;
+          /**
+           * Gets current value of property {@link #getGroupHeaderFormatter groupHeaderFormatter}.
+           *
+           * Provides a custom group header title.
+           *
+           * This function is called for each group header row in the table. It receives the binding context of the
+           * row and the group level property path according to `groupLevels` in {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}).
+           * The function must return a string that is used as the title of the group header row.
+           *
+           * Function signature: `groupHeaderFormatter(oContext: sap.ui.model.odata.v4.Context, sPropertyPath: string):
+           * string`
+           *
+           *
+           * @returns Value of property `groupHeaderFormatter`
+           */
+          getGroupHeaderFormatter(): Function;
+          /**
+           * Sets a new value for property {@link #getEnabled enabled}.
+           *
+           * Indicates whether this plugin is enabled.
+           *
+           * 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
+           */
+          setEnabled(
+            /**
+             * New value for property `enabled`
+             */
+            bEnabled?: boolean
+          ): this;
+          /**
+           * Sets a new value for property {@link #getGroupHeaderFormatter groupHeaderFormatter}.
+           *
+           * Provides a custom group header title.
+           *
+           * This function is called for each group header row in the table. It receives the binding context of the
+           * row and the group level property path according to `groupLevels` in {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}).
+           * The function must return a string that is used as the title of the group header row.
+           *
+           * Function signature: `groupHeaderFormatter(oContext: sap.ui.model.odata.v4.Context, sPropertyPath: string):
+           * string`
+           *
+           * 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
+           */
+          setGroupHeaderFormatter(
+            /**
+             * New value for property `groupHeaderFormatter`
+             */
+            fnGroupHeaderFormatter: Function
+          ): this;
+        }
+        /**
+         * Integrates the information about the data structure of the {@link sap.ui.model.odata.v4.ODataListBinding }
+         * and the table. The table is enabled to visualize hierarchical data. Works only in combination with a
+         * {@link sap.ui.model.odata.v4.ODataModel}.
+         *
+         * For details about hierarchies, see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}.
+         *
+         * @since 1.140
+         */
+        class ODataV4Hierarchy extends sap.ui.core.Element {
+          /**
+           * 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/7d914317c0b64c23824bf932cc8a4ae1 OData V4: Data Aggregation and Recursive Hierarchy}
+           */
+          constructor();
+
+          /**
+           * Creates a new subclass of class sap.ui.table.plugins.ODataV4Hierarchy with name `sClassName` and enriches
+           * it with the information contained in `oClassInfo`.
+           *
+           * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
+           *
+           *
+           * @returns Created class / constructor function
+           */
+          static extend<T extends Record<string, unknown>>(
+            /**
+             * Name of the class being created
+             */
+            sClassName: string,
+            /**
+             * Object literal with information about the class
+             */
+            oClassInfo?: sap.ClassInfo<
+              T,
+              sap.ui.table.plugins.ODataV4Hierarchy
+            >,
+            /**
+             * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+             * used by this class
+             */
+            FNMetaImpl?: Function
+          ): Function;
+          /**
+           * Searches a plugin of the corresponding type in the aggregations of the given `Table` instance. The first
+           * plugin that is found is returned.
+           *
+           *
+           * @returns The found plugin instance or `undefined` if not found
+           */
+          static findOn(
+            /**
+             * The `Table` instance to check for
+             */
+            oTable: sap.ui.table.Table
+          ): sap.ui.core.Element | undefined;
+          /**
+           * Returns a metadata object for class sap.ui.table.plugins.ODataV4Hierarchy.
+           *
+           *
+           * @returns Metadata object describing this class
+           */
+          static getMetadata(): sap.ui.core.ElementMetadata;
+          /**
+           * Gets current value of property {@link #getEnabled enabled}.
+           *
+           * Indicates whether this plugin is enabled.
+           *
+           * Default value is `true`.
+           *
+           *
+           * @returns Value of property `enabled`
+           */
+          getEnabled(): boolean;
+          /**
+           * Sets a new value for property {@link #getEnabled enabled}.
+           *
+           * Indicates whether this plugin is enabled.
+           *
+           * 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
+           */
+          setEnabled(
+            /**
+             * New value for property `enabled`
+             */
+            bEnabled?: boolean
+          ): this;
+        }
+        /**
+         * Integrates the selection of the {@link sap.ui.model.odata.v4.ODataListBinding} and the table. Works only
+         * in combination with a {@link sap.ui.model.odata.v4.ODataModel}.
+         *
+         * The selection of a context that is not selectable is not allowed. The following contexts are not selectable:
+         *
+         * 	 - Header context
+         * 	 - Contexts that represent group headers
+         * 	 - Contexts that contain totals
+         *
+         * All binding-related limitations also apply in the context of this plugin. For details, see {@link sap.ui.model.odata.v4.Context#setSelected }
+         * and {@link sap.ui.model.odata.v4.ODataModel#bindList}.
+         *
+         * @since 1.140
+         */
+        class ODataV4MultiSelection extends sap.ui.table.plugins
+          .SelectionPlugin {
+          /**
+           * 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/ec55312f796f45e8883810af3b68b46c OData V4: Selection}
+           */
+          constructor();
+
+          /**
+           * Creates a new subclass of class sap.ui.table.plugins.ODataV4MultiSelection 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.table.plugins.SelectionPlugin.extend}.
+           *
+           *
+           * @returns Created class / constructor function
+           */
+          static extend<T extends Record<string, unknown>>(
+            /**
+             * Name of the class being created
+             */
+            sClassName: string,
+            /**
+             * Object literal with information about the class
+             */
+            oClassInfo?: sap.ClassInfo<
+              T,
+              sap.ui.table.plugins.ODataV4MultiSelection
+            >,
+            /**
+             * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+             * used by this class
+             */
+            FNMetaImpl?: Function
+          ): Function;
+          /**
+           * Searches a plugin of the corresponding type in the aggregations of the given `Table` instance. The first
+           * plugin that is found is returned.
+           *
+           *
+           * @returns The found plugin instance or `undefined` if not found
+           */
+          static findOn(
+            /**
+             * The `Table` instance to check for
+             */
+            oTable: sap.ui.table.Table
+          ): sap.ui.core.Element | undefined;
+          /**
+           * Returns a metadata object for class sap.ui.table.plugins.ODataV4MultiSelection.
+           *
+           *
+           * @returns Metadata object describing this class
+           */
+          static getMetadata(): sap.ui.core.ElementMetadata;
+          /**
+           * Clears the selection.
+           */
+          clearSelection(): void;
+          /**
+           * Gets current value of property {@link #getEnableNotification enableNotification}.
+           *
+           * Enables notifications that are displayed once a selection has been limited.
+           *
+           * Default value is `false`.
+           *
+           *
+           * @returns Value of property `enableNotification`
+           */
+          getEnableNotification(): boolean;
+          /**
+           * Gets current value of property {@link #getHideHeaderSelector hideHeaderSelector}.
+           *
+           * Hide the header selector.
+           *
+           * Default value is `false`.
+           *
+           *
+           * @returns Value of property `hideHeaderSelector`
+           */
+          getHideHeaderSelector(): boolean;
+          /**
+           * Returns the selected contexts.
+           *
+           *
+           * @returns The selected contexts
+           */
+          getSelectedContexts(): sap.ui.model.odata.v4.Context[];
+          /**
+           * Sets a new value for property {@link #getEnableNotification enableNotification}.
+           *
+           * Enables notifications that are displayed once a selection has been limited.
+           *
+           * 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
+           */
+          setEnableNotification(
+            /**
+             * New value for property `enableNotification`
+             */
+            bEnableNotification?: boolean
+          ): this;
+          /**
+           * Sets a new value for property {@link #getHideHeaderSelector hideHeaderSelector}.
+           *
+           * Hide the header selector.
+           *
+           * 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
+           */
+          setHideHeaderSelector(
+            /**
+             * New value for property `hideHeaderSelector`
+             */
+            bHideHeaderSelector?: boolean
+          ): this;
+        }
+        /**
+         * Integrates the selection of the {@link sap.ui.model.odata.v4.ODataListBinding} and the table. Works only
+         * in combination with a {@link sap.ui.model.odata.v4.ODataModel}. The selection of multiple contexts is
+         * not allowed. Only one context can be selected at a time.
+         *
+         * The selection of a context that is not selectable is not allowed. The following contexts are not selectable:
+         *
+         * 	 - Header context
+         * 	 - Contexts that represent group headers
+         * 	 - Contexts that contain totals
+         *
+         * All binding-related limitations also apply in the context of this plugin. For details, see {@link sap.ui.model.odata.v4.Context#setSelected }
+         * and {@link sap.ui.model.odata.v4.ODataModel#bindList}.
+         *
+         * @since 1.140
+         */
+        class ODataV4SingleSelection extends sap.ui.table.plugins
+          .SelectionPlugin {
+          /**
+           * 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.
+           *
+           * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.table.plugins.SelectionPlugin#constructor sap.ui.table.plugins.SelectionPlugin }
+           * can be used.
+           * See:
+           * 	{@link https://ui5.sap.com/#/topic/ec55312f796f45e8883810af3b68b46c OData V4: Selection}
+           */
+          constructor();
+
+          /**
+           * Creates a new subclass of class sap.ui.table.plugins.ODataV4SingleSelection 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.table.plugins.SelectionPlugin.extend}.
+           *
+           *
+           * @returns Created class / constructor function
+           */
+          static extend<T extends Record<string, unknown>>(
+            /**
+             * Name of the class being created
+             */
+            sClassName: string,
+            /**
+             * Object literal with information about the class
+             */
+            oClassInfo?: sap.ClassInfo<
+              T,
+              sap.ui.table.plugins.ODataV4SingleSelection
+            >,
+            /**
+             * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+             * used by this class
+             */
+            FNMetaImpl?: Function
+          ): Function;
+          /**
+           * Searches a plugin of the corresponding type in the aggregations of the given `Table` instance. The first
+           * plugin that is found is returned.
+           *
+           *
+           * @returns The found plugin instance or `undefined` if not found
+           */
+          static findOn(
+            /**
+             * The `Table` instance to check for
+             */
+            oTable: sap.ui.table.Table
+          ): sap.ui.core.Element | undefined;
+          /**
+           * Returns a metadata object for class sap.ui.table.plugins.ODataV4SingleSelection.
+           *
+           *
+           * @returns Metadata object describing this class
+           */
+          static getMetadata(): sap.ui.core.ElementMetadata;
+          /**
+           * Clears the selection.
+           */
+          clearSelection(): void;
+          /**
+           * Returns the selected context.
+           *
+           *
+           * @returns The selected context
+           */
+          getSelectedContext(): sap.ui.model.odata.v4.Context;
+        }
         /**
          * Base class for the selection plugins. A selection plugin is responsible for the selection behavior of
          * the table. It handles the selection state and provides information about the selection state to the table.
@@ -11475,6 +12024,14 @@ declare namespace sap {
 
     "sap/ui/table/plugins/MultiSelectionPlugin": undefined;
 
+    "sap/ui/table/plugins/ODataV4Aggregation": undefined;
+
+    "sap/ui/table/plugins/ODataV4Hierarchy": undefined;
+
+    "sap/ui/table/plugins/ODataV4MultiSelection": undefined;
+
+    "sap/ui/table/plugins/ODataV4SingleSelection": undefined;
+
     "sap/ui/table/plugins/SelectionPlugin": undefined;
 
     "sap/ui/table/Row": undefined;

package/types/sap.ui.testrecorder.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.140.0
 
 declare namespace sap {
   interface IUI5DefineDependencyNames {

package/types/sap.ui.unified.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.140.0
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.ux3.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.140.0
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.webc.common.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.140.0
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.webc.fiori.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.140.0
 
 declare namespace sap {
   namespace ui {

package/types/sap.ui.webc.main.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.140.0
 
 declare namespace sap {
   namespace ui {

package/types/sap.uxap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.138.0
+// For Library Version: 1.140.0
 
 declare namespace sap {
   /**