@openui5/ts-types 1.117.0 → 1.118.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openui5/ts-types",
-  "version": "1.117.0",
+  "version": "1.118.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.117.0
+// For Library Version: 1.118.0
 
 declare namespace sap {
   /**
@@ -87,6 +87,18 @@ declare namespace sap {
          * Defines the toolbar.
          */
         toolbar?: sap.ui.core.Control;
+
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Show as a banner in the header area. Use for example for system info and application shortcut.
+         */
+        bannerLines?:
+          | sap.m.Text[]
+          | sap.m.Text
+          | sap.ui.base.ManagedObject.AggregationBindingInfo
+          | `{${string}}`;
       }
 
       interface $HeaderSettings extends sap.f.cards.$BaseHeaderSettings {
@@ -215,6 +227,66 @@ declare namespace sap {
          */
         statusText?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Defines the shape of the icon.
+         */
+        iconDisplayShape?:
+          | sap.m.AvatarShape
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Defines the icon source.
+         */
+        iconSrc?:
+          | sap.ui.core.URI
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Defines the initials of the icon.
+         */
+        iconInitials?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Defines an alt text for the avatar or icon.
+         */
+        iconAlt?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
+
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Defines a background color for the avatar or icon.
+         */
+        iconBackgroundColor?:
+          | sap.m.AvatarColor
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Defines whether the card icon is visible.
+         */
+        iconVisible?:
+          | boolean
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
         /**
          * General unit of measurement for the header. Displayed as side information to the subtitle.
          */
@@ -269,6 +341,17 @@ declare namespace sap {
          */
         details?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
 
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * The semantic color which represents the state of the details text.
+         */
+        detailsState?:
+          | sap.ui.core.ValueState
+          | sap.ui.base.ManagedObject.PropertyBindingInfo
+          | `{${string}}`;
+
         /**
          * @experimental (since 1.101)
          *
@@ -402,6 +485,29 @@ declare namespace sap {
          * @returns Metadata object describing this class
          */
         static getMetadata(): sap.ui.core.ElementMetadata;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Adds some bannerLine to the aggregation {@link #getBannerLines bannerLines}.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        addBannerLine(
+          /**
+           * The bannerLine to add; if empty, nothing is inserted
+           */
+          oBannerLine: sap.m.Text
+        ): this;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Destroys all the bannerLines in the aggregation {@link #getBannerLines bannerLines}.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        destroyBannerLines(): this;
         /**
          * @since 1.86
          * @experimental (since 1.86)
@@ -411,6 +517,15 @@ declare namespace sap {
          * @returns Reference to `this` in order to allow method chaining
          */
         destroyToolbar(): this;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Gets content of aggregation {@link #getBannerLines bannerLines}.
+         *
+         * Show as a banner in the header area. Use for example for system info and application shortcut.
+         */
+        getBannerLines(): sap.m.Text[];
         /**
          * @experimental (since 1.89) - this feature is experimental and the API may change.
          *
@@ -449,6 +564,66 @@ declare namespace sap {
          * Defines the toolbar.
          */
         getToolbar(): sap.ui.core.Control;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Checks for the provided `sap.m.Text` in the aggregation {@link #getBannerLines bannerLines}. and returns
+         * its index if found or -1 otherwise.
+         *
+         * @returns The index of the provided control in the aggregation if found, or -1 otherwise
+         */
+        indexOfBannerLine(
+          /**
+           * The bannerLine whose index is looked for
+           */
+          oBannerLine: sap.m.Text
+        ): int;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Inserts a bannerLine into the aggregation {@link #getBannerLines bannerLines}.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        insertBannerLine(
+          /**
+           * The bannerLine to insert; if empty, nothing is inserted
+           */
+          oBannerLine: sap.m.Text,
+          /**
+           * The `0`-based index the bannerLine should be inserted at; for a negative value of `iIndex`, the bannerLine
+           * is inserted at position 0; for a value greater than the current size of the aggregation, the bannerLine
+           * is inserted at the last position
+           */
+          iIndex: int
+        ): this;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Removes all the controls from the aggregation {@link #getBannerLines bannerLines}.
+         *
+         * Additionally, it unregisters them from the hosting UIArea.
+         *
+         * @returns An array of the removed elements (might be empty)
+         */
+        removeAllBannerLines(): sap.m.Text[];
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Removes a bannerLine from the aggregation {@link #getBannerLines bannerLines}.
+         *
+         * @returns The removed bannerLine or `null`
+         */
+        removeBannerLine(
+          /**
+           * The bannerLine to remove or its index or id
+           */
+          vBannerLine: int | string | sap.m.Text
+        ): sap.m.Text | null;
         /**
          * @experimental (since 1.116) - this feature is experimental and the API may change.
          *
@@ -1188,6 +1363,97 @@ declare namespace sap {
          * @returns Value of property `detailsMaxLines`
          */
         getDetailsMaxLines(): int;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Gets current value of property {@link #getDetailsState detailsState}.
+         *
+         * The semantic color which represents the state of the details text.
+         *
+         * Default value is `None`.
+         *
+         * @returns Value of property `detailsState`
+         */
+        getDetailsState(): sap.ui.core.ValueState;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Gets current value of property {@link #getIconAlt iconAlt}.
+         *
+         * Defines an alt text for the avatar or icon.
+         *
+         * Default value is `empty string`.
+         *
+         * @returns Value of property `iconAlt`
+         */
+        getIconAlt(): string;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Gets current value of property {@link #getIconBackgroundColor iconBackgroundColor}.
+         *
+         * Defines a background color for the avatar or icon.
+         *
+         * Default value is `Transparent`.
+         *
+         * @returns Value of property `iconBackgroundColor`
+         */
+        getIconBackgroundColor(): sap.m.AvatarColor;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Gets current value of property {@link #getIconDisplayShape iconDisplayShape}.
+         *
+         * Defines the shape of the icon.
+         *
+         * Default value is `Circle`.
+         *
+         * @returns Value of property `iconDisplayShape`
+         */
+        getIconDisplayShape(): sap.m.AvatarShape;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Gets current value of property {@link #getIconInitials iconInitials}.
+         *
+         * Defines the initials of the icon.
+         *
+         * Default value is `empty string`.
+         *
+         * @returns Value of property `iconInitials`
+         */
+        getIconInitials(): string;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Gets current value of property {@link #getIconSrc iconSrc}.
+         *
+         * Defines the icon source.
+         *
+         * Default value is `empty string`.
+         *
+         * @returns Value of property `iconSrc`
+         */
+        getIconSrc(): sap.ui.core.URI;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Gets current value of property {@link #getIconVisible iconVisible}.
+         *
+         * Defines whether the card icon is visible.
+         *
+         * Default value is `true`.
+         *
+         * @returns Value of property `iconVisible`
+         */
+        getIconVisible(): boolean;
         /**
          * Gets current value of property {@link #getNumber number}.
          *
@@ -1399,6 +1665,146 @@ declare namespace sap {
            */
           iDetailsMaxLines?: int
         ): this;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Sets a new value for property {@link #getDetailsState detailsState}.
+         *
+         * The semantic color which represents the state of the details text.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * Default value is `None`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setDetailsState(
+          /**
+           * New value for property `detailsState`
+           */
+          sDetailsState?: sap.ui.core.ValueState
+        ): this;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Sets a new value for property {@link #getIconAlt iconAlt}.
+         *
+         * Defines an alt text for the avatar or icon.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * Default value is `empty string`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setIconAlt(
+          /**
+           * New value for property `iconAlt`
+           */
+          sIconAlt?: string
+        ): this;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Sets a new value for property {@link #getIconBackgroundColor iconBackgroundColor}.
+         *
+         * Defines a background color for the avatar or icon.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * Default value is `Transparent`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setIconBackgroundColor(
+          /**
+           * New value for property `iconBackgroundColor`
+           */
+          sIconBackgroundColor?: sap.m.AvatarColor
+        ): this;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Sets a new value for property {@link #getIconDisplayShape iconDisplayShape}.
+         *
+         * Defines the shape of the icon.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * Default value is `Circle`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setIconDisplayShape(
+          /**
+           * New value for property `iconDisplayShape`
+           */
+          sIconDisplayShape?: sap.m.AvatarShape
+        ): this;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Sets a new value for property {@link #getIconInitials iconInitials}.
+         *
+         * Defines the initials of the icon.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * Default value is `empty string`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setIconInitials(
+          /**
+           * New value for property `iconInitials`
+           */
+          sIconInitials?: string
+        ): this;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Sets a new value for property {@link #getIconSrc iconSrc}.
+         *
+         * Defines the icon source.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * Default value is `empty string`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setIconSrc(
+          /**
+           * New value for property `iconSrc`
+           */
+          sIconSrc?: sap.ui.core.URI
+        ): this;
+        /**
+         * @since 1.118
+         * @experimental (since 1.118) - For usage only by Work Zone.
+         *
+         * Sets a new value for property {@link #getIconVisible iconVisible}.
+         *
+         * Defines whether the card icon is visible.
+         *
+         * When called with a value of `null` or `undefined`, the default value of the property will be restored.
+         *
+         * Default value is `true`.
+         *
+         * @returns Reference to `this` in order to allow method chaining
+         */
+        setIconVisible(
+          /**
+           * New value for property `iconVisible`
+           */
+          bIconVisible?: boolean
+        ): this;
         /**
          * Sets a new value for property {@link #getNumber number}.
          *
@@ -1605,6 +2011,13 @@ declare namespace sap {
            */
           sUnitOfMeasurement: string
         ): this;
+        /**
+         * @ui5-protected Do not call from applications (only from related classes in the framework)
+         *
+         *
+         * @returns If the icon should be shown.
+         */
+        shouldShowIcon(): boolean;
       }
       /**
        * @since 1.64