@openui5/types 1.122.1 → 1.123.1

package/types/sap.uxap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.122.1
+// For Library Version: 1.123.1
 
 declare module "sap/uxap/library" {
   /**
@@ -416,7 +416,9 @@ declare module "sap/uxap/AnchorBar" {
       bUpperCase?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the AnchorBar constructor.
+   */
   export interface $AnchorBarSettings extends $ToolbarSettings {
     /**
      * Determines whether to show a Popover with Subsection links when clicking on Section links in the Anchor
@@ -909,7 +911,9 @@ declare module "sap/uxap/BlockBase" {
       bVisible?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the BlockBase constructor.
+   */
   export interface $BlockBaseSettings extends $ControlSettings {
     /**
      * Determines the mode of the block. See {@link sap.uxap.ObjectPageSubSectionMode ObjectPageSubSectionMode}.
@@ -977,6 +981,9 @@ declare module "sap/uxap/BlockBase" {
     viewInit?: (oEvent: BlockBase$ViewInitEvent) => void;
   }
 
+  /**
+   * Parameters of the BlockBase#viewInit event.
+   */
   export interface BlockBase$ViewInitEventParameters {
     /**
      * The initialized view.
@@ -984,6 +991,9 @@ declare module "sap/uxap/BlockBase" {
     view?: View;
   }
 
+  /**
+   * Event object of the BlockBase#viewInit event.
+   */
   export type BlockBase$ViewInitEvent = Event<
     BlockBase$ViewInitEventParameters,
     BlockBase
@@ -1214,7 +1224,9 @@ declare module "sap/uxap/BreadCrumbs" {
       bShowCurrentLocation?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the BreadCrumbs constructor.
+   */
   export interface $BreadCrumbsSettings extends $ControlSettings {
     /**
      * Sets the visibility of the current/last element in the BreadCrumbs path.
@@ -1341,7 +1353,9 @@ declare module "sap/uxap/HierarchicalSelect" {
       bUpperCase?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the HierarchicalSelect constructor.
+   */
   export interface $HierarchicalSelectSettings extends $SelectSettings {
     /**
      * Determines whether the HierarchicalSelect items are displayed in upper case.
@@ -1505,7 +1519,9 @@ declare module "sap/uxap/ModelMapping" {
       sInternalModelName?: string
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ModelMapping constructor.
+   */
   export interface $ModelMappingSettings extends $ElementSettings {
     /**
      * Determines the external model name.
@@ -1946,7 +1962,9 @@ declare module "sap/uxap/ObjectPageAccessibleLandmarkInfo" {
       sRootRole?: AccessibleLandmarkRole | keyof typeof AccessibleLandmarkRole
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ObjectPageAccessibleLandmarkInfo constructor.
+   */
   export interface $ObjectPageAccessibleLandmarkInfoSettings
     extends $ElementSettings {
     /**
@@ -2145,7 +2163,9 @@ declare module "sap/uxap/ObjectPageDynamicHeaderContent" {
      */
     static getMetadata(): ElementMetadata;
   }
-
+  /**
+   * Describes the settings that can be provided to the ObjectPageDynamicHeaderContent constructor.
+   */
   export interface $ObjectPageDynamicHeaderContentSettings
     extends $DynamicPageHeaderSettings {}
 }
@@ -2254,7 +2274,9 @@ declare module "sap/uxap/ObjectPageDynamicHeaderTitle" {
      */
     static getMetadata(): ElementMetadata;
   }
-
+  /**
+   * Describes the settings that can be provided to the ObjectPageDynamicHeaderTitle constructor.
+   */
   export interface $ObjectPageDynamicHeaderTitleSettings
     extends $DynamicPageTitleSettings {}
 }
@@ -2729,7 +2751,7 @@ declare module "sap/uxap/ObjectPageHeader" {
      *
      * Default value is `Light`.
      *
-     * @deprecated (since 1.40.1)
+     * @deprecated (since 1.40.1) - without replacement.
      *
      * @returns Value of property `headerDesign`
      */
@@ -3447,7 +3469,9 @@ declare module "sap/uxap/ObjectPageHeader" {
       vTitleSelectorTooltip: TooltipBase | string
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ObjectPageHeader constructor.
+   */
   export interface $ObjectPageHeaderSettings extends $ControlSettings {
     /**
      * The URL of the image, representing the business object
@@ -3520,7 +3544,7 @@ declare module "sap/uxap/ObjectPageHeader" {
      * Determines the design of the header - Light or Dark. **Note: **This property is deprecated. It will continue
      * to work in the Blue Crystal theme, but it will not be taken into account for the Belize themes.
      *
-     * @deprecated (since 1.40.1)
+     * @deprecated (since 1.40.1) - without replacement.
      */
     headerDesign?:
       | (ObjectPageHeaderDesign | keyof typeof ObjectPageHeaderDesign)
@@ -3636,6 +3660,9 @@ declare module "sap/uxap/ObjectPageHeader" {
     markChangesPress?: (oEvent: ObjectPageHeader$MarkChangesPressEvent) => void;
   }
 
+  /**
+   * Parameters of the ObjectPageHeader#markChangesPress event.
+   */
   export interface ObjectPageHeader$MarkChangesPressEventParameters {
     /**
      * DOM reference of the changed item's icon to be used for positioning.
@@ -3643,11 +3670,17 @@ declare module "sap/uxap/ObjectPageHeader" {
     domRef?: string;
   }
 
+  /**
+   * Event object of the ObjectPageHeader#markChangesPress event.
+   */
   export type ObjectPageHeader$MarkChangesPressEvent = Event<
     ObjectPageHeader$MarkChangesPressEventParameters,
     ObjectPageHeader
   >;
 
+  /**
+   * Parameters of the ObjectPageHeader#markLockedPress event.
+   */
   export interface ObjectPageHeader$MarkLockedPressEventParameters {
     /**
      * DOM reference of the lock item's icon to be used for positioning.
@@ -3655,11 +3688,17 @@ declare module "sap/uxap/ObjectPageHeader" {
     domRef?: string;
   }
 
+  /**
+   * Event object of the ObjectPageHeader#markLockedPress event.
+   */
   export type ObjectPageHeader$MarkLockedPressEvent = Event<
     ObjectPageHeader$MarkLockedPressEventParameters,
     ObjectPageHeader
   >;
 
+  /**
+   * Parameters of the ObjectPageHeader#titleSelectorPress event.
+   */
   export interface ObjectPageHeader$TitleSelectorPressEventParameters {
     /**
      * DOM reference of the title item's icon to be used for positioning.
@@ -3667,6 +3706,9 @@ declare module "sap/uxap/ObjectPageHeader" {
     domRef?: string;
   }
 
+  /**
+   * Event object of the ObjectPageHeader#titleSelectorPress event.
+   */
   export type ObjectPageHeader$TitleSelectorPressEvent = Event<
     ObjectPageHeader$TitleSelectorPressEventParameters,
     ObjectPageHeader
@@ -3856,7 +3898,9 @@ declare module "sap/uxap/ObjectPageHeaderActionButton" {
       sImportance?: Importance | keyof typeof Importance
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ObjectPageHeaderActionButton constructor.
+   */
   export interface $ObjectPageHeaderActionButtonSettings
     extends $ButtonSettings {
     /**
@@ -4017,7 +4061,7 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
      *
      * Default value is `Light`.
      *
-     * @deprecated (since 1.40.1)
+     * @deprecated (since 1.40.1) - without replacement.
      *
      * @returns Value of property `contentDesign`
      */
@@ -4086,7 +4130,7 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
      *
      * Default value is `Light`.
      *
-     * @deprecated (since 1.40.1)
+     * @deprecated (since 1.40.1) - without replacement.
      *
      * @returns Reference to `this` in order to allow method chaining
      */
@@ -4099,13 +4143,15 @@ declare module "sap/uxap/ObjectPageHeaderContent" {
         | keyof typeof ObjectPageHeaderDesign
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ObjectPageHeaderContent constructor.
+   */
   export interface $ObjectPageHeaderContentSettings extends $ControlSettings {
     /**
      * Determines the design of the header - Light or Dark. **Note: **This property is deprecated. It will continue
      * to work in the Blue Crystal theme, but it will not be taken into account for the Belize themes.
      *
-     * @deprecated (since 1.40.1)
+     * @deprecated (since 1.40.1) - without replacement.
      */
     contentDesign?:
       | (ObjectPageHeaderDesign | keyof typeof ObjectPageHeaderDesign)
@@ -4378,7 +4424,9 @@ declare module "sap/uxap/ObjectPageHeaderLayoutData" {
       sWidth?: CSSSize
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ObjectPageHeaderLayoutData constructor.
+   */
   export interface $ObjectPageHeaderLayoutDataSettings
     extends $LayoutDataSettings {
     /**
@@ -6273,7 +6321,9 @@ declare module "sap/uxap/ObjectPageLayout" {
       bUseTwoColumnsForLargeScreen?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ObjectPageLayout constructor.
+   */
   export interface $ObjectPageLayoutSettings extends $ControlSettings {
     /**
      * Determines whether the Navigation bar (Anchor bar) is displayed.
@@ -6587,6 +6637,9 @@ declare module "sap/uxap/ObjectPageLayout" {
     ) => void;
   }
 
+  /**
+   * Parameters of the ObjectPageLayout#beforeNavigate event.
+   */
   export interface ObjectPageLayout$BeforeNavigateEventParameters {
     /**
      * The selected section object.
@@ -6599,18 +6652,30 @@ declare module "sap/uxap/ObjectPageLayout" {
     subSection?: ObjectPageSubSection;
   }
 
+  /**
+   * Event object of the ObjectPageLayout#beforeNavigate event.
+   */
   export type ObjectPageLayout$BeforeNavigateEvent = Event<
     ObjectPageLayout$BeforeNavigateEventParameters,
     ObjectPageLayout
   >;
 
+  /**
+   * Parameters of the ObjectPageLayout#editHeaderButtonPress event.
+   */
   export interface ObjectPageLayout$EditHeaderButtonPressEventParameters {}
 
+  /**
+   * Event object of the ObjectPageLayout#editHeaderButtonPress event.
+   */
   export type ObjectPageLayout$EditHeaderButtonPressEvent = Event<
     ObjectPageLayout$EditHeaderButtonPressEventParameters,
     ObjectPageLayout
   >;
 
+  /**
+   * Parameters of the ObjectPageLayout#headerContentPinnedStateChange event.
+   */
   export interface ObjectPageLayout$HeaderContentPinnedStateChangeEventParameters {
     /**
      * False or True values indicate the new pinned property value.
@@ -6618,11 +6683,17 @@ declare module "sap/uxap/ObjectPageLayout" {
     pinned?: boolean;
   }
 
+  /**
+   * Event object of the ObjectPageLayout#headerContentPinnedStateChange event.
+   */
   export type ObjectPageLayout$HeaderContentPinnedStateChangeEvent = Event<
     ObjectPageLayout$HeaderContentPinnedStateChangeEventParameters,
     ObjectPageLayout
   >;
 
+  /**
+   * Parameters of the ObjectPageLayout#navigate event.
+   */
   export interface ObjectPageLayout$NavigateEventParameters {
     /**
      * The selected section object.
@@ -6635,11 +6706,17 @@ declare module "sap/uxap/ObjectPageLayout" {
     subSection?: ObjectPageSubSection;
   }
 
+  /**
+   * Event object of the ObjectPageLayout#navigate event.
+   */
   export type ObjectPageLayout$NavigateEvent = Event<
     ObjectPageLayout$NavigateEventParameters,
     ObjectPageLayout
   >;
 
+  /**
+   * Parameters of the ObjectPageLayout#sectionChange event.
+   */
   export interface ObjectPageLayout$SectionChangeEventParameters {
     /**
      * The section which the layout is scrolled to.
@@ -6652,11 +6729,17 @@ declare module "sap/uxap/ObjectPageLayout" {
     subSection?: ObjectPageSubSection;
   }
 
+  /**
+   * Event object of the ObjectPageLayout#sectionChange event.
+   */
   export type ObjectPageLayout$SectionChangeEvent = Event<
     ObjectPageLayout$SectionChangeEventParameters,
     ObjectPageLayout
   >;
 
+  /**
+   * Parameters of the ObjectPageLayout#subSectionVisibilityChange event.
+   */
   export interface ObjectPageLayout$SubSectionVisibilityChangeEventParameters {
     /**
      * Object whose keys are the visible SubSection IDs and their values are the SubSection instances
@@ -6664,11 +6747,17 @@ declare module "sap/uxap/ObjectPageLayout" {
     visibleSubSections?: object;
   }
 
+  /**
+   * Event object of the ObjectPageLayout#subSectionVisibilityChange event.
+   */
   export type ObjectPageLayout$SubSectionVisibilityChangeEvent = Event<
     ObjectPageLayout$SubSectionVisibilityChangeEventParameters,
     ObjectPageLayout
   >;
 
+  /**
+   * Parameters of the ObjectPageLayout#toggleAnchorBar event.
+   */
   export interface ObjectPageLayout$ToggleAnchorBarEventParameters {
     /**
      * False indicates that the Anchor bar has just detached from the Header and became part of the scrolling
@@ -6677,6 +6766,9 @@ declare module "sap/uxap/ObjectPageLayout" {
     fixed?: boolean;
   }
 
+  /**
+   * Event object of the ObjectPageLayout#toggleAnchorBar event.
+   */
   export type ObjectPageLayout$ToggleAnchorBarEvent = Event<
     ObjectPageLayout$ToggleAnchorBarEventParameters,
     ObjectPageLayout
@@ -6849,7 +6941,9 @@ declare module "sap/uxap/ObjectPageLazyLoader" {
       vContent: int | string | Control
     ): Control | null;
   }
-
+  /**
+   * Describes the settings that can be provided to the ObjectPageLazyLoader constructor.
+   */
   export interface $ObjectPageLazyLoaderSettings extends $ElementSettings {
     /**
      * Controls to be displayed after this element is unstashed
@@ -7198,7 +7292,9 @@ declare module "sap/uxap/ObjectPageSection" {
       bWrapTitle?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ObjectPageSection constructor.
+   */
   export interface $ObjectPageSectionSettings
     extends $ObjectPageSectionBaseSettings {
     /**
@@ -7545,7 +7641,9 @@ declare module "sap/uxap/ObjectPageSectionBase" {
      */
     updateInvisibleTextLabelValue(): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ObjectPageSectionBase constructor.
+   */
   export interface $ObjectPageSectionBaseSettings extends $ControlSettings {
     /**
      * Defines the title of the respective section/subsection.
@@ -8073,7 +8171,9 @@ declare module "sap/uxap/ObjectPageSubSection" {
       bTitleUppercase?: boolean
     ): this;
   }
-
+  /**
+   * Describes the settings that can be provided to the ObjectPageSubSection constructor.
+   */
   export interface $ObjectPageSubSectionSettings
     extends $ObjectPageSectionBaseSettings {
     /**