@openui5/ts-types 1.120.11 → 1.120.13

package/types/sap.uxap.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.120.11
+// For Library Version: 1.120.13
 
 declare namespace sap {
   /**
@@ -48,6 +48,9 @@ declare namespace sap {
       __implements__sap_uxap_IHeaderTitle: boolean;
     }
 
+    /**
+     * Describes the settings that can be provided to the AnchorBar constructor.
+     */
     interface $AnchorBarSettings extends sap.m.$ToolbarSettings {
       /**
        * Determines whether to show a Popover with Subsection links when clicking on Section links in the Anchor
@@ -85,6 +88,9 @@ declare namespace sap {
       selectedButton?: sap.m.Button | string;
     }
 
+    /**
+     * Describes the settings that can be provided to the BlockBase constructor.
+     */
     interface $BlockBaseSettings extends sap.ui.core.$ControlSettings {
       /**
        * Determines the mode of the block. See {@link sap.uxap.ObjectPageSubSectionMode ObjectPageSubSectionMode}.
@@ -161,6 +167,9 @@ declare namespace sap {
       viewInit?: (oEvent: BlockBase$ViewInitEvent) => void;
     }
 
+    /**
+     * Describes the settings that can be provided to the BreadCrumbs constructor.
+     */
     interface $BreadCrumbsSettings extends sap.ui.core.$ControlSettings {
       /**
        * Sets the visibility of the current/last element in the BreadCrumbs path.
@@ -185,6 +194,9 @@ declare namespace sap {
       currentLocation?: sap.m.Text;
     }
 
+    /**
+     * Describes the settings that can be provided to the HierarchicalSelect constructor.
+     */
     interface $HierarchicalSelectSettings extends sap.m.$SelectSettings {
       /**
        * Determines whether the HierarchicalSelect items are displayed in upper case.
@@ -195,6 +207,9 @@ declare namespace sap {
         | `{${string}}`;
     }
 
+    /**
+     * Describes the settings that can be provided to the ModelMapping constructor.
+     */
     interface $ModelMappingSettings extends sap.ui.core.$ElementSettings {
       /**
        * Determines the external model name.
@@ -216,6 +231,9 @@ declare namespace sap {
       externalPath?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
     }
 
+    /**
+     * Describes the settings that can be provided to the ObjectPageAccessibleLandmarkInfo constructor.
+     */
     interface $ObjectPageAccessibleLandmarkInfoSettings
       extends sap.ui.core.$ElementSettings {
       /**
@@ -314,12 +332,21 @@ declare namespace sap {
       footerLabel?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
     }
 
+    /**
+     * Describes the settings that can be provided to the ObjectPageDynamicHeaderContent constructor.
+     */
     interface $ObjectPageDynamicHeaderContentSettings
       extends sap.f.$DynamicPageHeaderSettings {}
 
+    /**
+     * Describes the settings that can be provided to the ObjectPageDynamicHeaderTitle constructor.
+     */
     interface $ObjectPageDynamicHeaderTitleSettings
       extends sap.f.$DynamicPageTitleSettings {}
 
+    /**
+     * Describes the settings that can be provided to the ObjectPageHeader constructor.
+     */
     interface $ObjectPageHeaderSettings extends sap.ui.core.$ControlSettings {
       /**
        * The URL of the image, representing the business object
@@ -554,6 +581,9 @@ declare namespace sap {
       ) => void;
     }
 
+    /**
+     * Describes the settings that can be provided to the ObjectPageHeaderActionButton constructor.
+     */
     interface $ObjectPageHeaderActionButtonSettings
       extends sap.m.$ButtonSettings {
       /**
@@ -587,6 +617,9 @@ declare namespace sap {
         | `{${string}}`;
     }
 
+    /**
+     * Describes the settings that can be provided to the ObjectPageHeaderContent constructor.
+     */
     interface $ObjectPageHeaderContentSettings
       extends sap.ui.core.$ControlSettings {
       /**
@@ -610,6 +643,9 @@ declare namespace sap {
         | `{${string}}`;
     }
 
+    /**
+     * Describes the settings that can be provided to the ObjectPageHeaderLayoutData constructor.
+     */
     interface $ObjectPageHeaderLayoutDataSettings
       extends sap.ui.core.$LayoutDataSettings {
       /**
@@ -661,6 +697,9 @@ declare namespace sap {
         | `{${string}}`;
     }
 
+    /**
+     * Describes the settings that can be provided to the ObjectPageLayout constructor.
+     */
     interface $ObjectPageLayoutSettings extends sap.ui.core.$ControlSettings {
       /**
        * Determines whether the Navigation bar (Anchor bar) is displayed.
@@ -1031,6 +1070,9 @@ declare namespace sap {
       ) => void;
     }
 
+    /**
+     * Describes the settings that can be provided to the ObjectPageLazyLoader constructor.
+     */
     interface $ObjectPageLazyLoaderSettings
       extends sap.ui.core.$ElementSettings {
       /**
@@ -1043,6 +1085,9 @@ declare namespace sap {
         | `{${string}}`;
     }
 
+    /**
+     * Describes the settings that can be provided to the ObjectPageSection constructor.
+     */
     interface $ObjectPageSectionSettings
       extends sap.uxap.$ObjectPageSectionBaseSettings {
       /**
@@ -1093,6 +1138,9 @@ declare namespace sap {
       selectedSubSection?: sap.uxap.ObjectPageSubSection | string;
     }
 
+    /**
+     * Describes the settings that can be provided to the ObjectPageSectionBase constructor.
+     */
     interface $ObjectPageSectionBaseSettings
       extends sap.ui.core.$ControlSettings {
       /**
@@ -1149,6 +1197,9 @@ declare namespace sap {
       customAnchorBarButton?: sap.m.Button;
     }
 
+    /**
+     * Describes the settings that can be provided to the ObjectPageSubSection constructor.
+     */
     interface $ObjectPageSubSectionSettings
       extends sap.uxap.$ObjectPageSectionBaseSettings {
       /**
@@ -1237,6 +1288,9 @@ declare namespace sap {
         | `{${string}}`;
     }
 
+    /**
+     * Parameters of the BlockBase#viewInit event.
+     */
     interface BlockBase$ViewInitEventParameters {
       /**
        * The initialized view.
@@ -1244,6 +1298,9 @@ declare namespace sap {
       view?: sap.ui.core.mvc.View;
     }
 
+    /**
+     * Parameters of the ObjectPageHeader#markChangesPress event.
+     */
     interface ObjectPageHeader$MarkChangesPressEventParameters {
       /**
        * DOM reference of the changed item's icon to be used for positioning.
@@ -1251,6 +1308,9 @@ declare namespace sap {
       domRef?: string;
     }
 
+    /**
+     * Parameters of the ObjectPageHeader#markLockedPress event.
+     */
     interface ObjectPageHeader$MarkLockedPressEventParameters {
       /**
        * DOM reference of the lock item's icon to be used for positioning.
@@ -1258,6 +1318,9 @@ declare namespace sap {
       domRef?: string;
     }
 
+    /**
+     * Parameters of the ObjectPageHeader#titleSelectorPress event.
+     */
     interface ObjectPageHeader$TitleSelectorPressEventParameters {
       /**
        * DOM reference of the title item's icon to be used for positioning.
@@ -1265,6 +1328,9 @@ declare namespace sap {
       domRef?: string;
     }
 
+    /**
+     * Parameters of the ObjectPageLayout#beforeNavigate event.
+     */
     interface ObjectPageLayout$BeforeNavigateEventParameters {
       /**
        * The selected section object.
@@ -1277,8 +1343,14 @@ declare namespace sap {
       subSection?: sap.uxap.ObjectPageSubSection;
     }
 
+    /**
+     * Parameters of the ObjectPageLayout#editHeaderButtonPress event.
+     */
     interface ObjectPageLayout$EditHeaderButtonPressEventParameters {}
 
+    /**
+     * Parameters of the ObjectPageLayout#headerContentPinnedStateChange event.
+     */
     interface ObjectPageLayout$HeaderContentPinnedStateChangeEventParameters {
       /**
        * False or True values indicate the new pinned property value.
@@ -1286,6 +1358,9 @@ declare namespace sap {
       pinned?: boolean;
     }
 
+    /**
+     * Parameters of the ObjectPageLayout#navigate event.
+     */
     interface ObjectPageLayout$NavigateEventParameters {
       /**
        * The selected section object.
@@ -1298,6 +1373,9 @@ declare namespace sap {
       subSection?: sap.uxap.ObjectPageSubSection;
     }
 
+    /**
+     * Parameters of the ObjectPageLayout#sectionChange event.
+     */
     interface ObjectPageLayout$SectionChangeEventParameters {
       /**
        * The section which the layout is scrolled to.
@@ -1310,6 +1388,9 @@ declare namespace sap {
       subSection?: sap.uxap.ObjectPageSubSection;
     }
 
+    /**
+     * Parameters of the ObjectPageLayout#subSectionVisibilityChange event.
+     */
     interface ObjectPageLayout$SubSectionVisibilityChangeEventParameters {
       /**
        * Object whose keys are the visible SubSection IDs and their values are the SubSection instances
@@ -1317,6 +1398,9 @@ declare namespace sap {
       visibleSubSections?: object;
     }
 
+    /**
+     * Parameters of the ObjectPageLayout#toggleAnchorBar event.
+     */
     interface ObjectPageLayout$ToggleAnchorBarEventParameters {
       /**
        * False indicates that the Anchor bar has just detached from the Header and became part of the scrolling
@@ -7887,56 +7971,89 @@ declare namespace sap {
      */
     type BlockBaseColumnLayout = string;
 
+    /**
+     * Event object of the BlockBase#viewInit event.
+     */
     type BlockBase$ViewInitEvent = sap.ui.base.Event<
       BlockBase$ViewInitEventParameters,
       BlockBase
     >;
 
+    /**
+     * Event object of the ObjectPageHeader#markChangesPress event.
+     */
     type ObjectPageHeader$MarkChangesPressEvent = sap.ui.base.Event<
       ObjectPageHeader$MarkChangesPressEventParameters,
       ObjectPageHeader
     >;
 
+    /**
+     * Event object of the ObjectPageHeader#markLockedPress event.
+     */
     type ObjectPageHeader$MarkLockedPressEvent = sap.ui.base.Event<
       ObjectPageHeader$MarkLockedPressEventParameters,
       ObjectPageHeader
     >;
 
+    /**
+     * Event object of the ObjectPageHeader#titleSelectorPress event.
+     */
     type ObjectPageHeader$TitleSelectorPressEvent = sap.ui.base.Event<
       ObjectPageHeader$TitleSelectorPressEventParameters,
       ObjectPageHeader
     >;
 
+    /**
+     * Event object of the ObjectPageLayout#beforeNavigate event.
+     */
     type ObjectPageLayout$BeforeNavigateEvent = sap.ui.base.Event<
       ObjectPageLayout$BeforeNavigateEventParameters,
       ObjectPageLayout
     >;
 
+    /**
+     * Event object of the ObjectPageLayout#editHeaderButtonPress event.
+     */
     type ObjectPageLayout$EditHeaderButtonPressEvent = sap.ui.base.Event<
       ObjectPageLayout$EditHeaderButtonPressEventParameters,
       ObjectPageLayout
     >;
 
+    /**
+     * Event object of the ObjectPageLayout#headerContentPinnedStateChange event.
+     */
     type ObjectPageLayout$HeaderContentPinnedStateChangeEvent = sap.ui.base.Event<
       ObjectPageLayout$HeaderContentPinnedStateChangeEventParameters,
       ObjectPageLayout
     >;
 
+    /**
+     * Event object of the ObjectPageLayout#navigate event.
+     */
     type ObjectPageLayout$NavigateEvent = sap.ui.base.Event<
       ObjectPageLayout$NavigateEventParameters,
       ObjectPageLayout
     >;
 
+    /**
+     * Event object of the ObjectPageLayout#sectionChange event.
+     */
     type ObjectPageLayout$SectionChangeEvent = sap.ui.base.Event<
       ObjectPageLayout$SectionChangeEventParameters,
       ObjectPageLayout
     >;
 
+    /**
+     * Event object of the ObjectPageLayout#subSectionVisibilityChange event.
+     */
     type ObjectPageLayout$SubSectionVisibilityChangeEvent = sap.ui.base.Event<
       ObjectPageLayout$SubSectionVisibilityChangeEventParameters,
       ObjectPageLayout
     >;
 
+    /**
+     * Event object of the ObjectPageLayout#toggleAnchorBar event.
+     */
     type ObjectPageLayout$ToggleAnchorBarEvent = sap.ui.base.Event<
       ObjectPageLayout$ToggleAnchorBarEventParameters,
       ObjectPageLayout