@openui5/types 1.117.1 → 1.119.0

package/types/sap.uxap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.117.1
+// For Library Version: 1.119.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<