@openui5/ts-types 1.117.1 → 1.118.0

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

@@ -1,4 +1,4 @@
-// For Library Version: 1.117.1
+// For Library Version: 1.118.0
 
 declare namespace sap {
   namespace ui {
@@ -16,10 +16,20 @@ declare namespace sap {
        * UI5 library: sap.ui.webc.common
        */
       namespace common {
-        interface $WebComponentSettings extends sap.ui.core.$ControlSettings {}
+        namespace WebComponent {
+          /**
+           * 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.
+           */
+          type MetadataOptions = sap.ui.core.webc.WebComponent.MetadataOptions;
+        }
+
+        interface $WebComponentSettings
+          extends sap.ui.core.webc.$WebComponentSettings {}
 
         /**
          * @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
@@ -27,27 +37,76 @@ declare namespace sap {
          * 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.
          */
-        class WebComponent extends sap.ui.core.Control {
+        class WebComponent extends sap.ui.core.webc.WebComponent {
           /**
            * 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(
+            /**
+             * Object with initial settings for the new control
+             */
+            mSettings?: sap.ui.webc.common.$WebComponentSettings
+          );
+          /**
+           * Constructs and initializes a Web Component Wrapper with the given `sId` and settings.
+           */
+          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?: sap.ui.webc.common.$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,
             /**
@@ -55,8 +114,7 @@ declare namespace sap {
              */
             oClassInfo?: sap.ClassInfo<T, sap.ui.webc.common.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;
@@ -69,9 +127,11 @@ declare namespace sap {
         }
         /**
          * @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!
          */
-        class WebComponentMetadata extends sap.ui.core.ElementMetadata {
+        class WebComponentMetadata extends sap.ui.core.webc
+          .WebComponentMetadata {
           /**
            * Creates a new metadata object for a WebComponent Wrapper subclass.
            */
@@ -85,24 +145,6 @@ declare namespace sap {
              */
             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.1
+// For Library Version: 1.118.0
 
 declare namespace sap {
   namespace ui {

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

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

package/types/sap.uxap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.117.1
+// For Library Version: 1.118.0
 
 declare namespace sap {
   /**
@@ -1006,6 +1006,14 @@ declare namespace sap {
        */
       editHeaderButtonPress?: (oEvent: sap.ui.base.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
        *
@@ -1257,6 +1265,18 @@ declare namespace sap {
       domRef?: string;
     }
 
+    interface ObjectPageLayout$BeforeNavigateEventParameters {
+      /**
+       * The selected section object.
+       */
+      section?: sap.uxap.ObjectPageSection;
+
+      /**
+       * The selected subsection object.
+       */
+      subSection?: sap.uxap.ObjectPageSubSection;
+    }
+
     interface ObjectPageLayout$EditHeaderButtonPressEventParameters {}
 
     interface ObjectPageLayout$HeaderContentPinnedStateChangeEventParameters {
@@ -4775,6 +4795,59 @@ declare namespace sap {
          */
         oSection: sap.uxap.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`.
@@ -5111,6 +5184,26 @@ declare namespace sap {
        * @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`.
@@ -5230,6 +5323,23 @@ declare namespace sap {
          */
         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?: sap.uxap.ObjectPageLayout$BeforeNavigateEventParameters
+      ): boolean;
       /**
        * @ui5-protected Do not call from applications (only from related classes in the framework)
        *
@@ -7542,6 +7652,11 @@ declare namespace sap {
       ObjectPageHeader
     >;
 
+    type ObjectPageLayout$BeforeNavigateEvent = sap.ui.base.Event<
+      ObjectPageLayout$BeforeNavigateEventParameters,
+      ObjectPageLayout
+    >;
+
     type ObjectPageLayout$EditHeaderButtonPressEvent = sap.ui.base.Event<
       ObjectPageLayout$EditHeaderButtonPressEventParameters,
       ObjectPageLayout