@openui5/ts-types 1.94.0 → 1.97.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openui5/ts-types",
-  "version": "1.94.0",
+  "version": "1.97.0",
   "description": "OpenUI5 TypeScript Definitions",
   "homepage": "https://openui5.org",
   "author": "SAP SE (https://www.sap.com)",

package/types/sap.f.d.ts

@@ -1,4 +1,4 @@
-// For Library Version: 1.94.0
+// For Library Version: 1.97.0
 
 declare namespace sap {
   /**
@@ -154,6 +154,13 @@ declare namespace sap {
          */
         details?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
+        /**
+         * The alignment of the side indicators.
+         */
+        sideIndicatorsAlignment?:
+          | sap.f.cards.NumericHeaderSideIndicatorsAlignment
+          | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
         /**
          * Additional side number indicators. For example "Deviation" and "Target". Not more than two side indicators
          * should be used.
@@ -185,6 +192,15 @@ declare namespace sap {
          * Defines the unit of measurement (scaling prefix) for the numeric value
          */
         unit?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * @EXPERIMENTAL (since 1.95)
+         *
+         * The semantic color which represents the state of the side indicator.
+         */
+        state?:
+          | sap.m.ValueColor
+          | sap.ui.base.ManagedObject.PropertyBindingInfo;
       }
 
       /**
@@ -628,8 +644,8 @@ declare namespace sap {
        * Displays general information in the header of the {@link sap.f.Card} and allows the configuration of
        * a numeric value visualization.
        *
-       * You can configure the title, subtitle, status text and icon, using the provided properties. To add more
-       * side number indicators, use the `sideIndicators` aggregation.
+       * You can configure the title, subtitle, and status text, using the provided properties. To add more side
+       * number indicators, use the `sideIndicators` aggregation.
        *
        * **Notes:**
        * 	 - You should always set a title.
@@ -802,6 +818,14 @@ declare namespace sap {
          * should be used.
          */
         getSideIndicators(): sap.f.cards.NumericSideIndicator[];
+        /**
+         * Gets current value of property {@link #getSideIndicatorsAlignment sideIndicatorsAlignment}.
+         *
+         * The alignment of the side indicators.
+         *
+         * Default value is `"Begin"`.
+         */
+        getSideIndicatorsAlignment(): sap.f.cards.NumericHeaderSideIndicatorsAlignment;
         /**
          * @EXPERIMENTAL (since 1.64)
          *
@@ -913,6 +937,21 @@ declare namespace sap {
            */
           sValue: string
         ): this;
+        /**
+         * Sets a new value for property {@link #getSideIndicatorsAlignment sideIndicatorsAlignment}.
+         *
+         * The alignment of the side indicators.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * Default value is `"Begin"`.
+         */
+        setSideIndicatorsAlignment(
+          /**
+           * New value for property `sideIndicatorsAlignment`
+           */
+          sSideIndicatorsAlignment?: sap.f.cards.NumericHeaderSideIndicatorsAlignment
+        ): this;
         /**
          * Sets the semantic color which represents the state of the main number indicator.
          */
@@ -1042,6 +1081,16 @@ declare namespace sap {
          * The numeric value
          */
         getNumber(): string;
+        /**
+         * @EXPERIMENTAL (since 1.95)
+         *
+         * Gets current value of property {@link #getState state}.
+         *
+         * The semantic color which represents the state of the side indicator.
+         *
+         * Default value is `"None"`.
+         */
+        getState(): sap.m.ValueColor;
         /**
          * Gets current value of property {@link #getTitle title}.
          *
@@ -1063,6 +1112,23 @@ declare namespace sap {
            */
           sValue: string
         ): this;
+        /**
+         * @EXPERIMENTAL (since 1.95)
+         *
+         * Sets a new value for property {@link #getState state}.
+         *
+         * The semantic color which represents the state of the side indicator.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * Default value is `"None"`.
+         */
+        setState(
+          /**
+           * New value for property `state`
+           */
+          sState?: sap.m.ValueColor
+        ): this;
         /**
          * Sets the title.
          */
@@ -1097,6 +1163,21 @@ declare namespace sap {
          */
         Top = "Top",
       }
+      /**
+       * @SINCE 1.96
+       *
+       * Different options for the alignment of the side indicators in the numeric header.
+       */
+      enum NumericHeaderSideIndicatorsAlignment {
+        /**
+         * Sets the alignment to the beginning (left or right depending on LTR/RTL).
+         */
+        Begin = "Begin",
+        /**
+         * Explicitly sets the alignment to the end (left or right depending on LTR/RTL).
+         */
+        End = "End",
+      }
     }
 
     namespace dnd {
@@ -1328,8 +1409,11 @@ declare namespace sap {
        * Used for closing dialogs and showing transitions in `NavContainers` when targets are displayed.
        *
        * **Note:** You should not create an own instance of this class. It is created when using `{@link sap.f.routing.Router}`
-       * or `{@link sap.f.routing.Targets}`. You may use the `{@link #setCloseDialogs}` function to specify if
-       * dialogs should be closed on displaying other views.
+       * or `{@link sap.f.routing.Targets}`.
+       *
+       * **Note:** You may use the `{@link #setCloseDialogs}` function to specify if dialogs should be closed
+       * on displaying other views. The dialogs are closed when a different target is displayed than the previously
+       * displayed one, otherwise the dialogs are kept open.
        */
       class TargetHandler extends sap.ui.base.Object {
         /**
@@ -1337,10 +1421,10 @@ declare namespace sap {
          */
         constructor(
           /**
-           * Closes all open dialogs before navigating, if set to `true` (default). If set to `false`, it just navigates
-           * without closing dialogs.
+           * Closes all open dialogs before navigating to a different target, if set to `true` (default). If set to
+           * `false`, it will just navigate without closing dialogs.
            */
-          bCloseDialogs: boolean
+          closeDialogs: boolean
         );
 
         /**
@@ -1374,6 +1458,9 @@ declare namespace sap {
         getCloseDialogs(): boolean;
         /**
          * Sets if a navigation should close dialogs.
+         *
+         * **Note:** The dialogs are closed when a different target is displayed than the previous one, otherwise
+         * the dialogs are kept open even when `bCloseDialogs` is `true`.
          */
         setCloseDialogs(
           /**
@@ -2341,6 +2428,8 @@ declare namespace sap {
          * The `customShareActions` are placed in the `ShareMenu` area of the `SemanticPage` title, right after
          * the semantic actions.
          *
+         * The text and icon of the button inside the `customShareActions` aggregation, can be customized.
+         *
          * **Note:** If the `titleSnappedOnMobile` aggregation is set, its content overrides this aggregation when
          * the control is viewed on a phone mobile device and the `SemanticPage` header is in its collapsed (snapped)
          * state.
@@ -4135,6 +4224,8 @@ declare namespace sap {
          * The `customShareActions` are placed in the `ShareMenu` area of the `SemanticPage` title, right after
          * the semantic actions.
          *
+         * The text and icon of the button inside the `customShareActions` aggregation, can be customized.
+         *
          * **Note:** If the `titleSnappedOnMobile` aggregation is set, its content overrides this aggregation when
          * the control is viewed on a phone mobile device and the `SemanticPage` header is in its collapsed (snapped)
          * state.
@@ -6422,6 +6513,15 @@ declare namespace sap {
         | sap.ui.core.Control
         | sap.ui.base.ManagedObject.AggregationBindingInfo;
 
+      /**
+       * @SINCE 1.95
+       *
+       * Accessible landmark settings to be applied on the containers of the `sap.f.FlexibleColumnLayout` control.
+       *
+       * If not set, no landmarks will be written.
+       */
+      landmarkInfo?: sap.f.FlexibleColumnLayoutAccessibleLandmarkInfo;
+
       /**
        * Sets the initial `Begin` column page, which is displayed on application launch.
        */
@@ -6501,6 +6601,35 @@ declare namespace sap {
       columnResize?: (oEvent: sap.ui.base.Event) => void;
     }
 
+    interface $FlexibleColumnLayoutAccessibleLandmarkInfoSettings
+      extends sap.ui.core.$ElementSettings {
+      /**
+       * Text that describes the landmark of the first column of the corresponding `sap.f.FlexibleColumnLayout`
+       * control.
+       *
+       * If not set, a predefined text is used.
+       */
+      firstColumnLabel?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+      /**
+       * Text that describes the landmark of the middle column of the corresponding `sap.f.FlexibleColumnLayout`
+       * control.
+       *
+       * If not set, a predefined text is used.
+       */
+      middleColumnLabel?:
+        | string
+        | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+      /**
+       * Text that describes the landmark of the last column of the corresponding `sap.f.FlexibleColumnLayout`
+       * control.
+       *
+       * If not set, a predefined text is used.
+       */
+      lastColumnLabel?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+    }
+
     interface $GridContainerSettings extends sap.ui.core.$ControlSettings {
       /**
        * Defines the width of the control.
@@ -10482,6 +10611,12 @@ declare namespace sap {
        * Destroys all the endColumnPages in the aggregation {@link #getEndColumnPages endColumnPages}.
        */
       destroyEndColumnPages(): this;
+      /**
+       * @SINCE 1.95
+       *
+       * Destroys the landmarkInfo in the aggregation {@link #getLandmarkInfo landmarkInfo}.
+       */
+      destroyLandmarkInfo(): this;
       /**
        * Destroys all the midColumnPages in the aggregation {@link #getMidColumnPages midColumnPages}.
        */
@@ -11086,6 +11221,16 @@ declare namespace sap {
        * or `null`.
        */
       getInitialMidColumnPage(): sap.ui.core.ID;
+      /**
+       * @SINCE 1.95
+       *
+       * Gets content of aggregation {@link #getLandmarkInfo landmarkInfo}.
+       *
+       * Accessible landmark settings to be applied on the containers of the `sap.f.FlexibleColumnLayout` control.
+       *
+       * If not set, no landmarks will be written.
+       */
+      getLandmarkInfo(): sap.f.FlexibleColumnLayoutAccessibleLandmarkInfo;
       /**
        * Gets current value of property {@link #getLayout layout}.
        *
@@ -11121,22 +11266,6 @@ declare namespace sap {
        * Default value is `false`.
        */
       getRestoreFocusOnBackNavigation(): boolean;
-      /**
-       * @SINCE 1.91
-       *
-       * Hides the placeholder on the corresponding column for the provided aggregation name.
-       */
-      hidePlaceholder(
-        /**
-         * Object containing the aggregation name
-         */
-        mSettings: {
-          /**
-           * The aggregation name to decide on which column/container the placeholder should be hidden
-           */
-          aggregation: string;
-        }
-      ): void;
       /**
        * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getBeginColumnPages beginColumnPages}.
        * and returns its index if found or -1 otherwise.
@@ -11376,6 +11505,17 @@ declare namespace sap {
          */
         oInitialMidColumnPage: sap.ui.core.ID | sap.ui.core.Control
       ): this;
+      /**
+       * @SINCE 1.95
+       *
+       * Sets the aggregated {@link #getLandmarkInfo landmarkInfo}.
+       */
+      setLandmarkInfo(
+        /**
+         * The landmarkInfo to set
+         */
+        oLandmarkInfo: sap.f.FlexibleColumnLayoutAccessibleLandmarkInfo
+      ): this;
       /**
        * Sets a new value for property {@link #getLayout layout}.
        *
@@ -11411,22 +11551,6 @@ declare namespace sap {
          */
         bRestoreFocusOnBackNavigation?: boolean
       ): this;
-      /**
-       * @SINCE 1.91
-       *
-       * Shows the placeholder on the corresponding column for the provided aggregation name.
-       */
-      showPlaceholder(
-        /**
-         * Object containing the aggregation name
-         */
-        mSettings: {
-          /**
-           * The aggregation name to decide on which column/container the placeholder should be shown
-           */
-          aggregation: string;
-        }
-      ): void;
       /**
        * Navigates to the given page inside the FlexibleColumnLayout. Columns are scanned for the page in the
        * following order: `Begin`, `Mid`, `End`.
@@ -11722,6 +11846,150 @@ declare namespace sap {
         oTransitionParameters: object
       ): this;
     }
+    /**
+     * @SINCE 1.95
+     *
+     * Settings for accessible landmarks which can be applied to the container elements of a `sap.f.FlexibleColumnLayout`
+     * control. For example, these landmarks are used by assistive technologies (such as screen readers) to
+     * provide a meaningful columns overview.
+     */
+    class FlexibleColumnLayoutAccessibleLandmarkInfo extends sap.ui.core
+      .Element {
+      /**
+       * Constructor for a new `sap.f.FlexibleColumnLayoutAccessibleLandmarkInfo` element.
+       *
+       * 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(
+        /**
+         * Initial settings for the new element
+         */
+        mSettings?: sap.f.$FlexibleColumnLayoutAccessibleLandmarkInfoSettings
+      );
+      /**
+       * Constructor for a new `sap.f.FlexibleColumnLayoutAccessibleLandmarkInfo` element.
+       *
+       * 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(
+        /**
+         * ID for the new element, generated automatically if no ID is given
+         */
+        sId?: string,
+        /**
+         * Initial settings for the new element
+         */
+        mSettings?: sap.f.$FlexibleColumnLayoutAccessibleLandmarkInfoSettings
+      );
+
+      /**
+       * Creates a new subclass of class sap.f.FlexibleColumnLayoutAccessibleLandmarkInfo with name `sClassName`
+       * and enriches it with the information contained in `oClassInfo`.
+       *
+       * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
+       */
+      static extend<T extends Record<string, unknown>>(
+        /**
+         * Name of the class being created
+         */
+        sClassName: string,
+        /**
+         * Object literal with information about the class
+         */
+        oClassInfo?: sap.ClassInfo<
+          T,
+          sap.f.FlexibleColumnLayoutAccessibleLandmarkInfo
+        >,
+        /**
+         * Constructor function for the metadata object; if not given, it defaults to the metadata implementation
+         * used by this class
+         */
+        FNMetaImpl?: Function
+      ): Function;
+      /**
+       * Returns a metadata object for class sap.f.FlexibleColumnLayoutAccessibleLandmarkInfo.
+       */
+      static getMetadata(): sap.ui.core.ElementMetadata;
+      /**
+       * Gets current value of property {@link #getFirstColumnLabel firstColumnLabel}.
+       *
+       * Text that describes the landmark of the first column of the corresponding `sap.f.FlexibleColumnLayout`
+       * control.
+       *
+       * If not set, a predefined text is used.
+       */
+      getFirstColumnLabel(): string;
+      /**
+       * Gets current value of property {@link #getLastColumnLabel lastColumnLabel}.
+       *
+       * Text that describes the landmark of the last column of the corresponding `sap.f.FlexibleColumnLayout`
+       * control.
+       *
+       * If not set, a predefined text is used.
+       */
+      getLastColumnLabel(): string;
+      /**
+       * Gets current value of property {@link #getMiddleColumnLabel middleColumnLabel}.
+       *
+       * Text that describes the landmark of the middle column of the corresponding `sap.f.FlexibleColumnLayout`
+       * control.
+       *
+       * If not set, a predefined text is used.
+       */
+      getMiddleColumnLabel(): string;
+      /**
+       * Sets a new value for property {@link #getFirstColumnLabel firstColumnLabel}.
+       *
+       * Text that describes the landmark of the first column of the corresponding `sap.f.FlexibleColumnLayout`
+       * control.
+       *
+       * If not set, a predefined text is used.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       */
+      setFirstColumnLabel(
+        /**
+         * New value for property `firstColumnLabel`
+         */
+        sFirstColumnLabel?: string
+      ): this;
+      /**
+       * Sets a new value for property {@link #getLastColumnLabel lastColumnLabel}.
+       *
+       * Text that describes the landmark of the last column of the corresponding `sap.f.FlexibleColumnLayout`
+       * control.
+       *
+       * If not set, a predefined text is used.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       */
+      setLastColumnLabel(
+        /**
+         * New value for property `lastColumnLabel`
+         */
+        sLastColumnLabel?: string
+      ): this;
+      /**
+       * Sets a new value for property {@link #getMiddleColumnLabel middleColumnLabel}.
+       *
+       * Text that describes the landmark of the middle column of the corresponding `sap.f.FlexibleColumnLayout`
+       * control.
+       *
+       * If not set, a predefined text is used.
+       *
+       * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+       */
+      setMiddleColumnLabel(
+        /**
+         * New value for property `middleColumnLabel`
+         */
+        sMiddleColumnLabel?: string
+      ): this;
+    }
     /**
      * @SINCE 1.46.0
      *
@@ -16242,6 +16510,8 @@ declare namespace sap {
 
     "sap/f/FlexibleColumnLayout": undefined;
 
+    "sap/f/FlexibleColumnLayoutAccessibleLandmarkInfo": undefined;
+
     "sap/f/FlexibleColumnLayoutSemanticHelper": undefined;
 
     "sap/f/GridContainer": undefined;