@openui5/types 1.117.0 → 1.118.0

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

@@ -1,14 +1,19 @@
-// For Library Version: 1.117.0
+// For Library Version: 1.118.0
 
 declare module "sap/ui/webc/common/library" {}
 
 declare module "sap/ui/webc/common/WebComponent" {
-  import { default as Control, $ControlSettings } from "sap/ui/core/Control";
+  import {
+    default as WebComponent1,
+    MetadataOptions as MetadataOptions1,
+    $WebComponentSettings as $WebComponentSettings1,
+  } from "sap/ui/core/webc/WebComponent";
 
   import WebComponentMetadata from "sap/ui/webc/common/WebComponentMetadata";
 
   /**
    * @since 1.92.0
+   * @deprecated (since 1.118.0) - Use sap.ui.core.webc.WebComponent instead!
    * @experimental (since 1.92.0) - The API might change. It is not intended for productive usage yet!
    *
    * Base Class for Web Components. Web Components are agnostic UI elements which can be integrated into the
@@ -16,27 +21,76 @@ declare module "sap/ui/webc/common/WebComponent" {
    * properties, the aggregations and the events. It also ensures to render the control and put the aggregated
    * controls in the dedicated slots of the Web Component.
    */
-  export default class WebComponent extends Control {
+  export default class WebComponent extends WebComponent1 {
+    /**
+     * Constructs and initializes a Web Component Wrapper with the given `sId` and settings.
+     */
+    constructor(
+      /**
+       * Object with initial settings for the new control
+       */
+      mSettings?: $WebComponentSettings
+    );
     /**
      * Constructs and initializes a Web Component Wrapper with the given `sId` and settings.
-     *
-     * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
-     * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
-     * of the syntax of the settings object.
      */
-    constructor();
+    constructor(
+      /**
+       * Optional ID for the new control; generated automatically if no non-empty ID is given Note: this can be
+       * omitted, no matter whether `mSettings` will be given or not!
+       */
+      sId?: string,
+      /**
+       * Object with initial settings for the new control
+       */
+      mSettings?: $WebComponentSettings
+    );
 
     /**
-     * Creates a new subclass of class sap.ui.webc.common.WebComponent with name `sClassName` and enriches it
-     * with the information contained in `oClassInfo`.
+     * Defines a new subclass of WebComponent with the name `sClassName` and enriches it with the information
+     * contained in `oClassInfo`.
+     *
+     * `oClassInfo` can contain the same information that {@link sap.ui.base.ManagedObject.extend} already accepts,
+     * plus the `dnd` property in the metadata object literal to configure drag-and-drop behavior (see {@link sap.ui.core.webc.WebComponent.MetadataOptions MetadataOptions }
+     * for details). Objects describing aggregations can also have a `dnd` property when used for a class extending
+     * `WebComponent` (see {@link sap.ui.base.ManagedObject.MetadataOptions.AggregationDnD AggregationDnD}).
+     *
+     * Example:
+     * ```javascript
+     *
+     * WebComponent.extend('sap.mylib.MyElement', {
+     *   metadata : {
+     *     library : 'sap.mylib',
+     *     tag : 'my-webcomponent',
+     *     properties : {
+     *       value : 'string',
+     *       width : {
+     *         type: 'sap.ui.core.CSSSize',
+     *         mapping: 'style'
+     *       }
+     *     },
+     *     defaultAggregation: "content",
+     *     aggregations : {
+     *       content : {
+     *         type: 'sap.ui.core.Control',
+     *         multiple : true
+     *       },
+     *       header : {
+     *         type : 'sap.ui.core.Control',
+     *         multiple : false,
+     *         slot: 'header'
+     *       }
+     *     }
+     *   }
+     * });
+     * ```
      *
-     * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
      *
      * @returns Created class / constructor function
      */
     static extend<T extends Record<string, unknown>>(
       /**
-       * Name of the class being created
+       * Name of the class to be created
        */
       sClassName: string,
       /**
@@ -44,8 +98,7 @@ declare module "sap/ui/webc/common/WebComponent" {
        */
       oClassInfo?: sap.ClassInfo<T, WebComponent>,
       /**
-       * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
-       * used by this class
+       * Constructor function for the metadata object. If not given, it defaults to `sap.ui.core.ElementMetadata`.
        */
       FNMetaImpl?: Function
     ): Function;
@@ -56,18 +109,24 @@ declare module "sap/ui/webc/common/WebComponent" {
      */
     static getMetadata(): WebComponentMetadata;
   }
+  /**
+   * The structure of the "metadata" object which is passed when inheriting from sap.ui.core.Element using
+   * its static "extend" method. See {@link sap.ui.core.Element.extend} for details on its usage.
+   */
+  export type MetadataOptions = MetadataOptions1;
 
-  export interface $WebComponentSettings extends $ControlSettings {}
+  export interface $WebComponentSettings extends $WebComponentSettings1 {}
 }
 
 declare module "sap/ui/webc/common/WebComponentMetadata" {
-  import ElementMetadata from "sap/ui/core/ElementMetadata";
+  import WebComponentMetadata1 from "sap/ui/core/webc/WebComponentMetadata";
 
   /**
    * @since 1.92.0
+   * @deprecated (since 1.118.0) - Use sap.ui.core.webc.WebComponentMetadata instead!
    * @experimental (since 1.92.0) - The API might change. It is not intended for productive usage yet!
    */
-  export default class WebComponentMetadata extends ElementMetadata {
+  export default class WebComponentMetadata extends WebComponentMetadata1 {
     /**
      * Creates a new metadata object for a WebComponent Wrapper subclass.
      */
@@ -81,24 +140,6 @@ declare module "sap/ui/webc/common/WebComponentMetadata" {
        */
       oClassInfo: object
     );
-
-    /**
-     * Returns the list of public getters, proxied by the Component Wrapper to the component itself
-     */
-    getGetters(): any[];
-    /**
-     * Returns the list of public methods, proxied by the Component Wrapper to the component itself
-     */
-    getMethods(): any[];
-    /**
-     * Retrieves the renderer for the described web component class. Note: this is always the default renderer
-     * and Web Component wrappers should not define their own renderers.
-     */
-    getRenderer(): void;
-    /**
-     * Returns the tag, used to render the Component Wrapper
-     */
-    getTag(): string;
   }
 }
 

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.117.0
+// For Library Version: 1.118.0
 
 declare module "sap/ui/webc/fiori/library" {
   /**

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.117.0
+// For Library Version: 1.118.0
 
 declare module "sap/ui/webc/main/library" {
   /**

package/types/sap.uxap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.117.0
+// For Library Version: 1.118.0
 
 declare module "sap/uxap/library" {
   /**
@@ -4411,6 +4411,59 @@ declare module "sap/uxap/ObjectPageLayout" {
        */
       oSection: ObjectPageSection
     ): this;
+    /**
+     * @since 1.118
+     *
+     * Attaches event handler `fnFunction` to the {@link #event:beforeNavigate beforeNavigate} event of this
+     * `sap.uxap.ObjectPageLayout`.
+     *
+     * 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.uxap.ObjectPageLayout` itself.
+     *
+     * The event is fired before the selected section is changed using the navigation. This event can be aborted
+     * by the application with preventDefault(), which means that there will be no navigation.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachBeforeNavigate(
+      /**
+       * 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: ObjectPageLayout$BeforeNavigateEvent) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
+       */
+      oListener?: object
+    ): this;
+    /**
+     * @since 1.118
+     *
+     * Attaches event handler `fnFunction` to the {@link #event:beforeNavigate beforeNavigate} event of this
+     * `sap.uxap.ObjectPageLayout`.
+     *
+     * 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.uxap.ObjectPageLayout` itself.
+     *
+     * The event is fired before the selected section is changed using the navigation. This event can be aborted
+     * by the application with preventDefault(), which means that there will be no navigation.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    attachBeforeNavigate(
+      /**
+       * The function to be called when the event occurs
+       */
+      fnFunction: (p1: ObjectPageLayout$BeforeNavigateEvent) => void,
+      /**
+       * Context object to call the event handler with. Defaults to this `sap.uxap.ObjectPageLayout` itself
+       */
+      oListener?: object
+    ): this;
     /**
      * Attaches event handler `fnFunction` to the {@link #event:editHeaderButtonPress editHeaderButtonPress }
      * event of this `sap.uxap.ObjectPageLayout`.
@@ -4747,6 +4800,26 @@ declare module "sap/uxap/ObjectPageLayout" {
      * @returns Reference to `this` in order to allow method chaining
      */
     destroySections(): this;
+    /**
+     * @since 1.118
+     *
+     * Detaches event handler `fnFunction` from the {@link #event:beforeNavigate beforeNavigate} event of this
+     * `sap.uxap.ObjectPageLayout`.
+     *
+     * The passed function and listener object must match the ones used for event registration.
+     *
+     * @returns Reference to `this` in order to allow method chaining
+     */
+    detachBeforeNavigate(
+      /**
+       * The function to be called, when the event occurs
+       */
+      fnFunction: (p1: ObjectPageLayout$BeforeNavigateEvent) => void,
+      /**
+       * Context object on which the given function had to be called
+       */
+      oListener?: object
+    ): this;
     /**
      * Detaches event handler `fnFunction` from the {@link #event:editHeaderButtonPress editHeaderButtonPress }
      * event of this `sap.uxap.ObjectPageLayout`.
@@ -4866,6 +4939,23 @@ declare module "sap/uxap/ObjectPageLayout" {
        */
       oListener?: object
     ): this;
+    /**
+     * @since 1.118
+     * @ui5-protected Do not call from applications (only from related classes in the framework)
+     *
+     * Fires event {@link #event:beforeNavigate beforeNavigate} to attached listeners.
+     *
+     * Listeners may prevent the default action of this event by calling the `preventDefault` method on the
+     * event object. The return value of this method indicates whether the default action should be executed.
+     *
+     * @returns Whether or not to prevent the default action
+     */
+    fireBeforeNavigate(
+      /**
+       * Parameters to pass along with the event
+       */
+      mParameters?: ObjectPageLayout$BeforeNavigateEventParameters
+    ): boolean;
     /**
      * @ui5-protected Do not call from applications (only from related classes in the framework)
      *
@@ -6258,6 +6348,14 @@ declare module "sap/uxap/ObjectPageLayout" {
      */
     editHeaderButtonPress?: (oEvent: Event) => void;
 
+    /**
+     * @since 1.118
+     *
+     * The event is fired before the selected section is changed using the navigation. This event can be aborted
+     * by the application with preventDefault(), which means that there will be no navigation.
+     */
+    beforeNavigate?: (oEvent: ObjectPageLayout$BeforeNavigateEvent) => void;
+
     /**
      * @since 1.40
      *
@@ -6275,6 +6373,23 @@ declare module "sap/uxap/ObjectPageLayout" {
     ) => void;
   }
 
+  export interface ObjectPageLayout$BeforeNavigateEventParameters {
+    /**
+     * The selected section object.
+     */
+    section?: ObjectPageSection;
+
+    /**
+     * The selected subsection object.
+     */
+    subSection?: ObjectPageSubSection;
+  }
+
+  export type ObjectPageLayout$BeforeNavigateEvent = Event<
+    ObjectPageLayout$BeforeNavigateEventParameters,
+    ObjectPageLayout
+  >;
+
   export interface ObjectPageLayout$EditHeaderButtonPressEventParameters {}
 
   export type ObjectPageLayout$EditHeaderButtonPressEvent = Event<