// For Library Version: 1.147.0 declare module "sap/f/library" { export interface IShellBar { __implements__sap_f_IShellBar: boolean; } export interface IDynamicPageStickyContent { __implements__sap_f_IDynamicPageStickyContent: boolean; } } declare module "sap/m/p13n/Engine" { import Control from "sap/ui/core/Control"; import { FilterStateItem } from "sap/m/p13n/FilterController"; import Event from "sap/ui/base/Event"; import Metadata from "sap/ui/base/Metadata"; import Popup from "sap/m/p13n/Popup"; import MetadataHelper from "sap/m/p13n/MetadataHelper"; import SelectionController from "sap/m/p13n/SelectionController"; /** * The personalization state change event. * * @since 1.140.0 */ export type Engine$StateChangeEvent = { /** * Control for which the state change event was fired. */ control?: Control; /** * Changed (delta) state of the control. The keys of the object refer to the controller keys used in the * `Engine` registration. The values can be an array of any of the following types: * - {@link module:sap/m/p13n/Engine$StateChangeEventSelectionState StateChangeEventSelectionState} * - {@link module:sap/m/p13n/Engine$StateChangeEventSortState StateChangeEventSortState} * - {@link module:sap/m/p13n/Engine$StateChangeEventGroupState StateChangeEventGroupState} * - {@link module:sap/m/p13n/Engine$StateChangeEventFilterState StateChangeEventFilterState} * - Custom controller state definitions */ state?: Record< string, | Engine$StateChangeEventSelectionState[] | Engine$StateChangeEventSortState[] | Engine$StateChangeEventGroupState[] | Engine$StateChangeEventFilterState[] | any[] >; }; /** * The state for changes of the `FilterController`. The keys of the object are the filter keys used in the * `Engine` registration. The values are arrays of {@link sap.ui.mdc.condition.ConditionObject ConditionObject}. * * @since 1.140.0 */ export type Engine$StateChangeEventFilterState = Record< string, FilterStateItem[] >; /** * The state for changes of the `GroupController`. * * @since 1.140.0 */ export type Engine$StateChangeEventGroupState = { /** * The key of the affected group order */ key: string; /** * The position of the group order */ index: number; }; /** * The state for changes of the `SelectionController`. * * @since 1.140.0 */ export type Engine$StateChangeEventSelectionState = { /** * The key of the item affected */ key: string; }; /** * The state for changes of the `SortController`. * * @since 1.140.0 */ export type Engine$StateChangeEventSortState = { /** * The key of the affected sort order */ key: string; /** * The position of the sort order */ index: number; /** * Indicates whether the sort order is descending */ descending: boolean; }; /** * The `Engine` entity offers personalization capabilities by registering a control instance for modification, * such as: * * * - `sap.m.p13n.Popup` initialization * - Storing personalization states by choosing the desired persistence layer * - State appliance considering the persistence layer * * The Engine must be used whenever personalization should be enabled by taking a certain persistence layer * into account. Available controller implementations for the registration process are: * * * - {@link sap.m.p13n.SelectionController SelectionController}: Used to define a list of selectable entries * * - {@link sap.m.p13n.SortController SortController}: Used to define a list of sortable properties * - {@link sap.m.p13n.GroupController GroupController}: Used to define a list of groupable properties * * * Can be used in combination with `sap.ui.fl.variants.VariantManagement` to persist a state in variants * using `sap.ui.fl` capabilities. * * @since 1.104 */ export default class Engine extends /* was: sap.m.p13n.modules.AdaptationProvider */ Object { /** * See: * {@link https://ui5.sap.com/#/topic/75c08fdebf784575947927e052712bab Personalization} */ constructor(); /** * Creates a new subclass of class sap.m.p13n.Engine 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.m.p13n.modules.AdaptationProvider.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * This method is the central point of access to the Engine Singleton. * * * @returns The Engine instance */ static getInstance(): Engine; /** * Returns a metadata object for class sap.m.p13n.Engine. * * * @returns Metadata object describing this class */ static getMetadata(): Metadata; /** * Applies a state to a control by passing an object that contains the registered controller key and an * object matching the inner subcontroller logic. * * * @returns A Promise resolving after the state has been applied */ applyState( /** * The registered control instance */ oControl: Control, /** * The state object */ oState: State ): Promise; /** * Attaches an event handler to the `StateHandlerRegistry` class. The event handler is fired every time * a user triggers a personalization change for a control instance during runtime. * * * @returns Returns `this` to allow method chaining */ attachStateChange( /** * The handler function to call when the event occurs */ fnStateEventHandler: (p1: Engine$StateChangeEvent) => void, /** * The context object to call the event handler with (value of `this` in the event handler function). */ oListener?: object ): this; /** * Unregisters a registered control. By unregistering a control the control is removed from the `Engine` * registry, and all instance-specific submodules, such as the registered controllers, are destroyed. */ deregister( /** * The registered control instance */ oControl: Control ): void; /** * Removes a previously attached state change event handler from the `StateHandlerRegistry` class. The passed * parameters must match those used for registration with {@link sap.m.p13n.Engine#attachStateChange} beforehand. * * * @returns Returns `this` to allow method chaining */ detachStateChange( /** * The handler function to detach from the event */ fnStateEventHandler: (p1: Event) => void, /** * The context object to call the event handler with (value of `this` in the event handler function). */ oListener?: object ): this; register( /** * The control instance to be registered for adaptation */ oControl: Control, /** * The Engine registration configuration */ oConfig: EngineRegistrationConfig ): void; /** * This method can be used to trigger a reset to the provided control instance. * * * @returns A Promise resolving once the reset is completed */ reset( /** * The related control instance */ oControl: Control, /** * The key for the affected configuration */ aKeys: string ): Promise; /** * Retrieves the state for a given control instance after all necessary changes have been applied (e.g. * modification handler appliance). After the returned `Promise` has been resolved, the returned state is * in sync with the related state object of the control. * * * @returns A Promise resolving in the current control state */ retrieveState( /** * The control instance implementing IxState to retrieve the externalized state */ oControl: Control ): Promise; /** * Opens the personalization dialog. * * * @returns Promise resolving in the `sap.m.p13n.Popup` instance */ show( /** * The control instance that is personalized */ oControl: Control, /** * The affected panels that are added to the `sap.m.p13n.Popup` */ vPanelKeys: string | string[], /** * The settings object for the personalization */ mSettings: { /** * The title for the `sap.m.p13n.Popup` control */ title?: string; /** * The source control to be used by the `sap.m.p13n.Popup` control (only necessary if the mode is set to * `ResponsivePopover`) */ source?: Control; /** * The mode is used by the `sap.m.p13n.Popup` control */ mode?: object; /** * Height configuration for the related popup container */ contentHeight?: object; /** * Width configuration for the related popup container */ contentWidth?: object; } ): Promise; } /** * The central registration for personalization functionality. The registration is a precondition for using * `Engine` functionality for a control instance. Once the control instance has been registered, it can * be passed to the related `Engine` methods that always expect a control instance as parameter. Only registered * control instances can be used for personalization through the `Engine`. */ export type EngineRegistrationConfig = { /** * The `{@link sap.m.p13n.MetadataHelper MetadataHelper}` to provide metadata-specific information. It may * be used to define more granular information for the selection of items. */ helper: MetadataHelper; /** * A map of arbitrary keys that contain a controller instance as value. The key must be unique and needs * to be provided for later access when using `Engine` functionality specific for one controller type. */ controller: Record; }; export type State = { /** * A map of arbitrary keys that contain a controller instance as value. The key must be unique and needs * to be provided for later access when using `Engine` functionality specific for one controller type. */ controller: Record; }; } declare module "sap/m/library" { import Control from "sap/ui/core/Control"; import Locale from "sap/ui/core/Locale"; import LocaleData from "sap/ui/core/LocaleData"; import RenderManager from "sap/ui/core/RenderManager"; import { CSSColor, URI } from "sap/ui/core/library"; import Event from "sap/ui/base/Event"; import Slider from "sap/m/Slider"; import RangeSlider from "sap/m/RangeSlider"; /** * Hide the soft keyboard. * * @since 1.20 */ export function closeKeyboard(): void; /** * Returns invalid date value of UI5. * * @since 1.10 * @deprecated As of version 1.12. UI5 returns null for invalid date * * @returns `null` as value for an invalid date */ export function getInvalidDate(): null; /** * Search given control's parents and try to find iScroll. * * @since 1.11 * * @returns iScroll reference or `undefined` if cannot find */ export function getIScroll( /** * Control to start the search at */ oControl: Control ): Object | undefined; /** * Finds default locale settings once and returns always the same. * * We should not need to create new instance to get same locale settings This method keeps the locale instance * in the scope and returns the same after first run * * @since 1.10 * * @returns Locale instance */ export function getLocale(): Locale; /** * Finds default locale data once and returns always the same. * * @since 1.10 * * @returns LocaleData instance */ export function getLocaleData(): LocaleData; /** * Search given control's parents and try to find a ScrollDelegate. * * @since 1.11 * * @returns ScrollDelegate or `undefined` if it cannot be found */ export function getScrollDelegate( /** * Starting point for the search */ oControl: Control, /** * Whether the search should stop on component level (`false`) or not */ bGlobal: boolean ): Object | undefined; /** * Checks if the given parameter is a valid JsDate Object. * * @since 1.10 * * @returns Whether the given parameter is a valid JsDate Object. */ export function isDate( /** * Any variable to test. */ value: any ): boolean; /** * Available Background Design. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'BackgroundDesign'. */ export enum BackgroundDesign { /** * A solid background color dependent on the theme. */ Solid = "Solid", /** * A translucent background depending on the opacity value of the theme. */ Translucent = "Translucent", /** * Transparent background. */ Transparent = "Transparent", } /** * Helper for rendering themable background. * * @since 1.12 * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ interface BackgroundHelper { /** * Adds CSS classes and styles to the given RenderManager, depending on the given configuration for background * color and background image. To be called by control renderers supporting the global themable background * image within their root tag, before they call openEnd, voidEnd, writeClasses() and writeStyles(). * * @ui5-protected Do not call from applications (only from related classes in the framework) */ addBackgroundColorStyles( /** * The RenderManager */ rm: RenderManager, /** * A configured custom background color for the control, if any */ sBgColor?: CSSColor, /** * The configured custom background image for the control, if any */ sBgImgUrl?: URI ): void; /** * Renders an HTML tag into the given RenderManager which carries the background image which is either configured * and given or coming from the current theme. Should be called right after the opening root tag has been * completed, so this is the first child element inside the control. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ renderBackgroundImageTag( /** * The RenderManager */ rm: RenderManager, /** * Control within which the tag will be rendered; its ID will be used to generate the element ID */ oControl: Control, /** * A CSS class or an array of CSS classes to add to the element */ vCssClass: string | string[], /** * The image of a configured background image; if this is not given, the theme background will be used and * also the other settings are ignored. */ sBgImgUrl?: URI, /** * Whether the background image should be repeated/tiled (or stretched) */ bRepeat?: boolean, /** * The background image opacity, if any */ fOpacity?: float ): void; } export const BackgroundHelper: BackgroundHelper; /** * Types of animation performed by {@link sap.m.BadgeEnabler}. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'BadgeAnimationType'. * * @since 1.87 */ export enum BadgeAnimationType { /** * Badge indicator will perform Appear,Update,and Disappear animation. */ Full = "Full", /** * No animation is performed. */ None = "None", /** * Badge indicator will perform only Update animation (suitable for controls, which invalidate often). */ Update = "Update", } /** * Types of state of {@link sap.m.BadgeEnabler} to expose its current state. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'BadgeState'. * * @since 1.81 */ export enum BadgeState { /** * Informing interested parties that the badge has appeared. */ Appear = "Appear", /** * Informing interested parties that the badge has disappeared. */ Disappear = "Disappear", /** * Informing interested parties that the badge has been updated. */ Updated = "Updated", } /** * Types of badge rendering style. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'BadgeStyle'. */ export enum BadgeStyle { /** * Attention style. This badge is rendered as a single dot meant to grab attention. */ Attention = "Attention", /** * Default style. Use for badges which contain text or numbers. */ Default = "Default", } /** * Types of the Bar design. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'BarDesign'. * * @since 1.20 */ export enum BarDesign { /** * The Bar can be inserted into other controls and if the design is "Auto" then it inherits the design from * parent control. */ Auto = "Auto", /** * The bar will be styled like a footer of the page. */ Footer = "Footer", /** * The bar will be styled like a header of the page. */ Header = "Header", /** * The bar will be styled like a subheader of the page. */ SubHeader = "SubHeader", } /** * Available Border Design. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'BorderDesign'. */ export enum BorderDesign { /** * Specifies no border. */ None = "None", /** * A solid border color dependent on the theme. */ Solid = "Solid", } /** * Variations of the {@link sap.m.Breadcrumbs} separators. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'BreadcrumbsSeparatorStyle'. * * @since 1.69 */ export enum BreadcrumbsSeparatorStyle { /** * The separator will appear as "\" */ BackSlash = "BackSlash", /** * The separator will appear as "\\" */ DoubleBackSlash = "DoubleBackSlash", /** * The separator will appear as ">>" */ DoubleGreaterThan = "DoubleGreaterThan", /** * The separator will appear as "//" */ DoubleSlash = "DoubleSlash", /** * The separator will appear as ">" */ GreaterThan = "GreaterThan", /** * The separator will appear as "/" */ Slash = "Slash", } /** * Enumeration for possible Button accessibility roles. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ButtonAccessibleRole'. * * @since 1.114.0 */ export enum ButtonAccessibleRole { /** * Default mode. */ Default = "Default", /** * Button will receive `role="Link"` attibute. */ Link = "Link", } /** * Different predefined button types for the {@link sap.m.Button sap.m.Button}. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ButtonType'. */ export enum ButtonType { /** * Accept type */ Accept = "Accept", /** * Attention type * * @since 1.77 */ Attention = "Attention", /** * Back type (back navigation button for header) */ Back = "Back", /** * Critical type * * **Note:** To be used only in controls of type `sap.m.Button`. When the button opens a `sap.m.MessagePopover` * list, use this `ButtonType` if the message with the highest severity is `Warning` type. * * @since 1.73 */ Critical = "Critical", /** * Default type (no special styling) */ Default = "Default", /** * Emphasized type */ Emphasized = "Emphasized", /** * Ghost type */ Ghost = "Ghost", /** * Negative type * * **Note:** To be used only in controls of type `sap.m.Button`. When the button opens a `sap.m.MessagePopover` * list, use this `ButtonType` if the message with the highest severity is `Error` type. * * @since 1.73 */ Negative = "Negative", /** * Neutral type * * **Note:** To be used only in controls of type `sap.m.Button`. When the button opens a `sap.m.MessagePopover` * list, use this `ButtonType` if the message with the highest severity is `Information` type. * * @since 1.73 */ Neutral = "Neutral", /** * Reject style */ Reject = "Reject", /** * Success type * * **Note:** To be used only in controls of type `sap.m.Button`. When the button opens a `sap.m.MessagePopover` * list, use this `ButtonType` if the message with the highest severity is `Success` type. * * @since 1.73 */ Success = "Success", /** * Transparent type */ Transparent = "Transparent", /** * Unstyled type (no styling) */ Unstyled = "Unstyled", /** * Up type (up navigation button for header) */ Up = "Up", } /** * Carousel arrows align. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'CarouselArrowsPlacement'. */ export enum CarouselArrowsPlacement { /** * Carousel arrows are placed on the sides of the current Carousel page. */ Content = "Content", /** * Carousel arrows are placed on the sides of the page indicator of the Carousel. */ PageIndicator = "PageIndicator", } /** * Types for the placement of the page indicator of the Carousel control. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'CarouselPageIndicatorPlacementType'. */ export enum CarouselPageIndicatorPlacementType { /** * Page indicator will be placed at the bottom of the Carousel. */ Bottom = "Bottom", /** * Page indicator will be placed over the Carousel content, bottom aligned. */ OverContentBottom = "OverContentBottom", /** * Page indicator will be placed over the Carousel content, top aligned. */ OverContentTop = "OverContentTop", /** * Page indicator will be placed at the top of the Carousel. */ Top = "Top", } /** * Defines how pages will be scrolled, when clicking the arrow. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'CarouselScrollMode'. */ export enum CarouselScrollMode { /** * Pages will be scrolled one at a time */ SinglePage = "SinglePage", /** * Pages will be scrolled, depending on the value of `visiblePagesCount` */ VisiblePages = "VisiblePages", } /** * Defines the rendering type of the TileAttribute * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ContentConfigType'. * * @since 1.122 */ export enum ContentConfigType { /** * Renders a link inside the TileAttribute */ Link = "Link", /** * Renders a text inside the TileAttribute */ Text = "Text", } /** * A subset of DateTimeInput types that fit to a simple API returning one string. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'DateTimeInputType'. * * @deprecated As of version 1.32.8. Instead, use dedicated `sap.m.DatePicker` and/or `sap.m.TimePicker` * controls. */ export enum DateTimeInputType { /** * An input control for specifying a date value. The user can select a month, day of the month, and year. * * @deprecated As of version 1.22.0. Instead, use dedicated `sap.m.DatePicker` control. */ Date = "Date", /** * An input control for specifying a date and time value. The user can select a month, day of the month, * year, and time of day. * * @deprecated As of version 1.32.8. Instead, use dedicated `sap.m.DatePicker` and `sap.m.TimePicker` controls. */ DateTime = "DateTime", /** * An input control for specifying a time value. The user can select the hour, minute, and optionally AM * or PM. * * @deprecated As of version 1.32.8. Instead, use dedicated `sap.m.TimePicker` control. */ Time = "Time", } /** * Enum of the available deviation markers for the NumericContent control. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'DeviationIndicator'. * * @since 1.34 */ export enum DeviationIndicator { /** * The actual value is less than the target value. */ Down = "Down", /** * No value. */ None = "None", /** * The actual value is more than the target value. */ Up = "Up", } /** * Enum for the ARIA role of {@link sap.m.Dialog} control. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'DialogRoleType'. * * @since 1.65 */ export enum DialogRoleType { /** * Represents the ARIA role `alertdialog`. */ AlertDialog = "AlertDialog", /** * Represents the ARIA role `dialog`. */ Dialog = "Dialog", } /** * Enum for the type of {@link sap.m.Dialog} control. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'DialogType'. */ export enum DialogType { /** * Dialog with type Message looks the same as the Standard Dialog in Android. It puts the Left and the Right * buttons at the bottom of the Dialog in iOS. */ Message = "Message", /** * This is the default value for Dialog type. * * The Standard Dialog in iOS has a header on the top. The Left and the Right buttons are put inside the * header. In Android, the Left and the Right buttons are put at the bottom of the Dialog. */ Standard = "Standard", } /** * Enum for the state of {@link sap.m.DraftIndicator} control. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'DraftIndicatorState'. */ export enum DraftIndicatorState { /** * This is the default value for DraftIndicatorState type. This state has no visual information displayed. */ Clear = "Clear", /** * Indicates that the draft is already saved */ Saved = "Saved", /** * Indicates that the draft currently is being saved */ Saving = "Saving", } /** * Defines the groups in {@link sap.m.DynamicDateRange}. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'DynamicDateRangeGroups'. * * @since 1.118 */ export enum DynamicDateRangeGroups { /** * Group of options that provide selection of date ranges. */ DateRanges = "DateRanges", /** * Group of options that provide selection of month related ranges. */ Month = "Month", /** * Group of options that provide selection of quarter related ranges. */ Quarters = "Quarters", /** * Group of options that provide selection of single dates. */ SingleDates = "SingleDates", /** * Group of options that provide selection of week related ranges. */ Weeks = "Weeks", /** * Group of options that provide selection of year related ranges. */ Years = "Years", } /** * Defines the `value` property of the DynamicDateRange control. The object has two properties: 'operator' * - a string, the key of a DynamicDateOption 'values' - an array of parameters for the same option see * {@link sap.m.DynamicDateRange} * * @since 1.111 */ export type DynamicDateRangeValue = { /** * The key of a DynamicDateOption. */ operator: string; /** * An array of parameters for the same option. */ values: Array; }; /** * Modes in which a control will render empty indicator if its content is empty. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'EmptyIndicatorMode'. * * @since 1.87 */ export enum EmptyIndicatorMode { /** * Empty indicator will be rendered depending on the context in which the control is placed. If one of the * parents has the context class sapMShowEmpty-CTX then the empty indicator will be shown. */ Auto = "Auto", /** * Empty indicator is never rendered. */ Off = "Off", /** * Empty indicator is rendered always when the control's content is empty. */ On = "On", } /** * Expandable text overflow mode * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ExpandableTextOverflowMode'. */ export enum ExpandableTextOverflowMode { /** * InPlace */ InPlace = "InPlace", /** * Popover */ Popover = "Popover", } /** * FacetFilterList data types. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'FacetFilterListDataType'. */ export enum FacetFilterListDataType { /** * An input control for specifying a Boolean value */ Boolean = "Boolean", /** * An input control for specifying a date value. The user can select a month, day of the month, and year. */ Date = "Date", /** * An input control for specifying a date and time value. The user can select a month, day of the month, * year, and time of day. */ DateTime = "DateTime", /** * An input control for specifying a Float value */ Float = "Float", /** * >An input control for specifying an Integer value */ Integer = "Integer", /** * An input control for specifying a String value */ String = "String", /** * An input control for specifying a time value. The user can select the hour, minute, and optionally AM * or PM. */ Time = "Time", } /** * Used by the FacetFilter control to adapt its design according to type. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'FacetFilterType'. */ export enum FacetFilterType { /** * Forces FacetFilter to display in light mode. */ Light = "Light", /** * Forces FacetFilter to display facet lists as a row of buttons, one button per facet. * * The FacetFilter will automatically adapt to the Light type when it detects smart phone sized displays. */ Simple = "Simple", } /** * An object type that represents sap.m.upload.FilterPanel fields properties. */ export type FilterPanelField = { /** * field name. */ label: string; /** * model path. */ path: string; }; /** * Available options for the layout of container lines along the cross axis of the flexbox layout. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'FlexAlignContent'. */ export enum FlexAlignContent { /** * Line are packed toward the center of the line. */ Center = "Center", /** * Lines are packed toward the end of the line. */ End = "End", /** * Inherits the value from its parent. */ Inherit = "Inherit", /** * Lines are evenly distributed in the line, with half-size spaces on either end. */ SpaceAround = "SpaceAround", /** * Lines are evenly distributed in the line. */ SpaceBetween = "SpaceBetween", /** * Lines are packed toward the start of the line. */ Start = "Start", /** * Lines stretch to take up the remaining space. */ Stretch = "Stretch", } /** * Available options for the layout of all elements along the cross axis of the flexbox layout. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'FlexAlignItems'. */ export enum FlexAlignItems { /** * If the flex item`s inline axes are the same as the cross axis, this value is identical to "Start". * * Otherwise, it participates in baseline alignment: all participating box items on the line are aligned * such that their baselines align, and the item with the largest distance between its baseline and its * cross-start margin edge is placed flush against the cross-start edge of the line. */ Baseline = "Baseline", /** * The flex item's margin boxes are centered in the cross axis within the line. */ Center = "Center", /** * The cross-start margin edges of the flex items are placed flush with the cross-end edge of the line. */ End = "End", /** * Inherits the value from its parent. */ Inherit = "Inherit", /** * The cross-start margin edges of the flex items are placed flush with the cross-start edge of the line. */ Start = "Start", /** * Make the cross size of the item's margin boxes as close to the same size as the line as possible. */ Stretch = "Stretch", } /** * Available options for the layout of individual elements along the cross axis of the flexbox layout overriding * the default alignment. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'FlexAlignSelf'. */ export enum FlexAlignSelf { /** * Takes up the value of alignItems from the parent FlexBox */ Auto = "Auto", /** * If the flex item's inline axis is the same as the cross axis, this value is identical to "Start". * * Otherwise, it participates in baseline alignment: all participating box items on the line are aligned * such that their baselines align, and the item with the largest distance between its baseline and its * cross-start margin edge is placed flush against the cross-start edge of the line. */ Baseline = "Baseline", /** * The flex item's margin box is centered in the cross axis within the line. */ Center = "Center", /** * The cross-start margin edges of the flex item is placed flush with the cross-end edge of the line. */ End = "End", /** * Inherits the value from its parent. */ Inherit = "Inherit", /** * The cross-start margin edges of the flex item is placed flush with the cross-start edge of the line. */ Start = "Start", /** * Make the cross size of the item's margin box as close to the same size as the line as possible. */ Stretch = "Stretch", } /** * Available directions for flex layouts. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'FlexDirection'. */ export enum FlexDirection { /** * Flex items are laid out along the direction of the block axis (usually top to bottom). */ Column = "Column", /** * Flex items are laid out along the reverse direction of the block axis (usually bottom to top). */ ColumnReverse = "ColumnReverse", /** * Inherits the value from its parent. */ Inherit = "Inherit", /** * Flex items are laid out along the direction of the inline axis (text direction). */ Row = "Row", /** * Flex items are laid out along the reverse direction of the inline axis (against the text direction). */ RowReverse = "RowReverse", } /** * Available options for the layout of elements along the main axis of the flexbox layout. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'FlexJustifyContent'. */ export enum FlexJustifyContent { /** * Flex items are packed toward the center of the line. */ Center = "Center", /** * Flex items are packed toward the end of the line. */ End = "End", /** * Inherits the value from its parent. */ Inherit = "Inherit", /** * Flex items are evenly distributed in the line, with half-size spaces on either end. */ SpaceAround = "SpaceAround", /** * Flex items are evenly distributed in the line. */ SpaceBetween = "SpaceBetween", /** * Flex items are packed toward the start of the line. */ Start = "Start", } /** * Determines the type of HTML elements used for rendering controls. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'FlexRendertype'. */ export enum FlexRendertype { /** * The UI5 controls are not wrapped in an additional HTML element, the surrounding Flex Box is a DIV element. * * @since 1.42.1 */ Bare = "Bare", /** * The UI5 controls are wrapped in DIV elements. */ Div = "Div", /** * The UI5 controls are wrapped in LI elements, the surrounding Flex Box is an unordered list (UL). */ List = "List", } /** * Available options for the wrapping behavior of a flex container. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'FlexWrap'. */ export enum FlexWrap { /** * The flex container is single-line. */ NoWrap = "NoWrap", /** * The flex container is multi-line. */ Wrap = "Wrap", /** * The flex container is multi-line with the cross-axis start and end being swapped. */ WrapReverse = "WrapReverse", } /** * Enum for possible frame size types for sap.m.TileContent and sap.m.GenericTile control. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'FrameType'. * * @since 1.34.0 */ export enum FrameType { /** * The Auto frame type that adjusts the size of the control to the content. Support for this type in sap.m.GenericTile * is deprecated since 1.48.0. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ Auto = "Auto", /** * The 2x1 frame type. **Note:** The 2x1 frame type is currently only supported for Generic tile. * * @since 1.83 */ OneByHalf = "OneByHalf", /** * The 2x2 frame type. */ OneByOne = "OneByOne", /** * The 4x1 frame type. **Note:** The 4x1 frame type is currently only supported for Generic tile. * * @since 1.83 */ TwoByHalf = "TwoByHalf", /** * The 4x2 frame type. */ TwoByOne = "TwoByOne", /** * The 2/3 frame type. * * @deprecated As of version 1.48.0. * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ TwoThirds = "TwoThirds", } /** * Design modes for the `GenericTag` control. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'GenericTagDesign'. * * @since 1.62.0 */ export enum GenericTagDesign { /** * Everything from the control is rendered. */ Full = "Full", /** * Everything from the control is rendered except the status icon. */ StatusIconHidden = "StatusIconHidden", } /** * Value states for the `GenericTag` control. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'GenericTagValueState'. * * @since 1.62.0 */ export enum GenericTagValueState { /** * Warning icon is rendered that overrides the control set in the `value` aggregation of the `GenericTag` * control. */ Error = "Error", /** * The value is rendered in its normal state. */ None = "None", } /** * Defines the mode of GenericTile. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'GenericTileMode'. * * @since 1.38.0 */ export enum GenericTileMode { /** * Action Mode (Two lines for the header). * * Generic Tile renders buttons that are specified under 'actionButtons' aggregation * * @since 1.96.0 */ ActionMode = "ActionMode", /** * Article Mode (Two lines for the header and one line for the subtitle). * * Enables Article Mode. * * @since 1.96.0 */ ArticleMode = "ArticleMode", /** * Default mode (Two lines for the header and one line for the subtitle). */ ContentMode = "ContentMode", /** * Header mode (Four lines for the header and one line for the subtitle). */ HeaderMode = "HeaderMode", /** * Icon mode. * * GenericTile displays a combination of icon and header title. * * It is applicable only for the OneByOne FrameType and TwoByHalf FrameType. * * @since 1.96 */ IconMode = "IconMode", /** * Line mode (Implemented for both, cozy and compact densities). * * Generic Tile is displayed as in-line element, header and subheader are displayed in one line. In case * the texts need more than one line, the representation depends on the used density. **Cozy:** The text * will be truncated and the full text is shown in a tooltip as soon as the tile is hovered (desktop only). * **Compact:** Header and subheader are rendered continuously spanning multiple lines, no tooltip is provided). * * @since 1.44.0 */ LineMode = "LineMode", } /** * Defines the scopes of GenericTile enabling the developer to implement different "flavors" of tiles. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'GenericTileScope'. * * @since 1.46.0 */ export enum GenericTileScope { /** * More action scope (Only the More icon is added to the tile) * * @since 1.76 */ ActionMore = "ActionMore", /** * Remove action scope (Only the Remove icon is added to the tile) * * @since 1.76 */ ActionRemove = "ActionRemove", /** * Action scope (Possible footer and Error State information is overlaid, "Remove" and "More" icons are * added to the tile). */ Actions = "Actions", /** * Default scope (The default scope of the tile, no action icons are rendered). */ Display = "Display", } /** * Different levels for headers. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'HeaderLevel'. */ export enum HeaderLevel { /** * Header level 1 */ H1 = "H1", /** * Header level 2 */ H2 = "H2", /** * Header level 3 */ H3 = "H3", /** * Header level 4 */ H4 = "H4", /** * Header level 5 */ H5 = "H5", /** * Header level 6 */ H6 = "H6", } /** * Interface for controls which implement the notification badge concept. * * @since 1.80 */ export interface IBadge { __implements__sap_m_IBadge: boolean; } /** * Interface for controls which are suitable as a Header, Subheader or Footer of a Page. If the control * does not want to get a context base style class, it has to implement the isContextSensitive method and * return false * * @since 1.22 */ export interface IBar { __implements__sap_m_IBar: boolean; } /** * Allowed tags for the implementation of the IBar interface. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'IBarHTMLTag'. * * @since 1.22 */ export enum IBarHTMLTag { /** * Renders as a div element. */ Div = "Div", /** * Renders as a footer element. */ Footer = "Footer", /** * Renders as a header element. */ Header = "Header", } /** * Interface for controls which have the meaning of a breadcrumbs navigation. * * @since 1.52 */ export interface IBreadcrumbs { __implements__sap_m_IBreadcrumbs: boolean; } /** * Represents an interface for controls, which are suitable as items for the sap.m.IconTabBar. */ export interface IconTab { __implements__sap_m_IconTab: boolean; } /** * Specifies `IconTabBar` tab density mode. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'IconTabDensityMode'. */ export enum IconTabDensityMode { /** * Compact. In this mode the tabs will be set explicitly to compact mode independent of what mode is applied * globally. */ Compact = "Compact", /** * Cozy. In this mode the tabs will be set explicitly to compact mode independent of what mode is applied * globally. */ Cozy = "Cozy", /** * Inherit. In this mode the global configuration of the density mode will be applied. */ Inherit = "Inherit", } /** * Available Filter Item Design. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'IconTabFilterDesign'. */ export enum IconTabFilterDesign { /** * A horizontally layouted design providing more space for texts. */ Horizontal = "Horizontal", /** * A vertically layouted design using minimum horizontal space. */ Vertical = "Vertical", } /** * Available Interaction Modes. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'IconTabFilterInteractionMode'. * * @experimental As of version 1.121. */ export enum IconTabFilterInteractionMode { /** * The item is selectable if it has own content. Select event will not be fired if it has no own content. * Note: When IconTabHeader is placed in ToolHeader the items will act as selectable items even if they * don’t explicitly have content. */ Auto = "Auto", /** * The item is selectable and select event will be fired. */ Select = "Select", /** * The item is selectable (and select event is fired) only if it doesn't have any sub items. Select event * will not be fired if it has sub items. */ SelectLeavesOnly = "SelectLeavesOnly", } /** * Specifies `IconTabBar` header mode. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'IconTabHeaderMode'. */ export enum IconTabHeaderMode { /** * Inline. In this mode when the `count` and the `text` are set, they are displayed in one line. */ Inline = "Inline", /** * Standard. In this mode when the `count` and the `text` are set, they are displayed in two separate lines. */ Standard = "Standard", } /** * Determines how the source image is used on the output DOM element. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ImageMode'. * * @since 1.30.0 */ export enum ImageMode { /** * The image is rendered with 'span' tag and the 'src' property is set to the 'background-image' CSS style * on the output DOM element */ Background = "Background", /** * The image is rendered with 'img' tag and the 'src' property is set to the src attribute on the output * DOM element. */ Image = "Image", /** * The image is rendered with 'div' tag, containing the inline 'svg' **Note:** Please, be aware that this * feature works under the Browser's Cross-Origin Resource Sharing (CORS) policy. This means that a web * application using those APIs can only request resources from the same origin the application was loaded * from unless the response from other origins includes the right CORS headers. */ InlineSvg = "InlineSvg", } /** * Interface definition for controls suitable to be used as items of `sap.m.Menu`. * * @since 1.127.0 */ export interface IMenuItem { __implements__sap_m_IMenuItem: boolean; } /** * Interface definition for controls suitable to be used as items of `sap.m.Menu`. This interface is used * to define the behavior of the menu item. * * @since 1.137.0 */ export interface IMenuItemBehavior { __implements__sap_m_IMenuItemBehavior: boolean; /** * Returns whether the item can be counted in total items count. **Note:** This method can be overridden * by subclasses to implement custom behavior. * * * @returns Whether the item is counted in total items count */ isCountable(): boolean; /** * Returns whether the item can be focused. **Note:** This method can be overridden by subclasses to implement * custom behavior. * * * @returns Whether the item is enabled for focus */ isFocusable(): boolean; /** * Returns whether the firing of `press` event is allowed. **Note:** This method can be overridden by subclasses * to implement custom behavior. * * * @returns Whether the item is enabled for click/press */ isInteractive(): boolean; } /** * The object contains accessibility state for a control. * * @since 1.111 * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ export type InputBaseAccessibilityState = { /** * The WAI-ARIA role which is implemented by the control. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ role?: string; /** * Whether the control is invalid. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ invalid?: boolean; /** * The errormessage property. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ errormessage?: string; /** * The labelledby property. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ labelledby?: { value: string; append: boolean; }; /** * The describedby property. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ describedby?: { value: string; append: boolean; }; /** * Whether the control is disabled. If not relevant, it shouldn`t be set or set as `null`. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ disabled?: boolean | null; /** * Whether the control is readonly. If not relevant, it shouldn`t be set or set as `null`. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ readonly?: boolean | null; }; /** * Defines the available content sizes for the `InputListItem` control. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'InputListItemContentSize'. */ export enum InputListItemContentSize { /** * Large: Recommended for larger input controls, such as {@link sap.m.Input} or {@link sap.m.RatingIndicator}. * If there is limited space, the input control moves to a new line below the label. */ L = "L", /** * Small: Recommended for smaller controls, such as {@link sap.m.Switch} or {@link sap.m.CheckBox}. If there * is limited space, only the label is wrapped. The input control is always right-aligned horizontally and * middle-aligned vertically. */ S = "S", } /** * Suggestion helper for `sap.m.Input` fields when used with an OData model. * * Creates a multi-column suggest list for an `sap.m.Input` field based on a `ValueList` annotation. The * `ValueList` annotation will be resolved via the binding information of the input field. * * If the annotation describes multiple input parameters, the suggest provider will resolve all of these * relative to the context of the input field and use them for the suggest query. The suggest provider will * write all values that are described as output parameters back to the model (relative to the context of * the input field). This can only be done if the model runs in "TwoWay" binding mode. Both features can * be switched off via the `bResolveInput/bResolveOutput` parameter of the suggest function. * * @since 1.21.2 * @deprecated As of version 1.120. In case of SAPUI5, see demokit sample 'Smart Field with ValueList Annotation'. * In case of OpenUI5, see demokit sample 'Input - Suggestions - Dynamic'. */ interface InputODataSuggestProvider { suggest( oEvent: Event, /** * SuggestProvider resolves all input parameters for the data query */ bResolveInput: boolean, /** * SuggestProvider writes back all output parameters. */ bResolveOutput: boolean, /** * If iLength is provided only these number of entries will be requested. */ iLength: int ): void; } export const InputODataSuggestProvider: InputODataSuggestProvider; /** * Defines how the input display text should be formatted. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'InputTextFormatMode'. * * @since 1.44.0 */ export enum InputTextFormatMode { /** * Key */ Key = "Key", /** * A key-value pair formatted like "(key) text" */ KeyValue = "KeyValue", /** * Text */ Value = "Value", /** * A value-key pair formatted like "text (key)" */ ValueKey = "ValueKey", } /** * A subset of input types that fits to a simple API returning one string. * * Not available on purpose: button, checkbox, hidden, image, password, radio, range, reset, search, submit. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'InputType'. */ export enum InputType { /** * An input control for specifying a date value. The user can select a month, day of the month, and year. * * @deprecated As of version 1.9.1. Please use dedicated {@link sap.m.DatePicker} to create date input. */ Date = "Date", /** * An input control for specifying a date and time value. The user can select a month, day of the month, * year, and time of day. * * @deprecated As of version 1.9.1. Please use dedicated {@link sap.m.DateTimePicker} control to create * date-time input. */ Datetime = "Datetime", /** * An input control for specifying a date and time value where the format depends on the locale. * * @deprecated As of version 1.9.1. Please use dedicated {@link sap.m.DateTimePicker} control create date-time * input. */ DatetimeLocale = "DatetimeLocale", /** * A text field for specifying an email address. Brings up a keyboard optimized for email address entry. */ Email = "Email", /** * An input control for selecting a month. * * @deprecated As of version 1.9.1. There is no cross-platform support. Please do not use this Input type. */ Month = "Month", /** * A text field for specifying a number. Brings up a number pad keyboard. Specifying an input type of \d* * or [0-9]* is equivalent to using this type. */ Number = "Number", /** * Password input where the user entry cannot be seen. */ Password = "Password", /** * A text field for specifying a phone number. Brings up a phone pad keyboard. */ Tel = "Tel", /** * default (text) */ Text = "Text", /** * An input control for specifying a time value. The user can select the hour, minute, and optionally AM * or PM. * * @deprecated As of version 1.9.1. Please use dedicated {@link sap.m.TimePicker} control to create time * input. */ Time = "Time", /** * A text field for specifying a URL. Brings up a keyboard optimized for URL entry. */ Url = "Url", /** * An input control for selecting a week. * * @deprecated As of version 1.9.1. There is no cross-platform support. Please do not use this Input type. */ Week = "Week", } /** * Interface for controls which can have special behavior inside `sap.m.OverflowToolbar`. Controls that * implement this interface must provide a `getOverflowToolbarConfig` method that accepts no arguments and * returns an object of type `sap.m.OverflowToolbarConfig`. * * **Important:** In addition, the control can implement a CSS class, scoped with the `.sapMOverflowToolbarMenu-CTX` * context selector, that will be applied whenever the control is inside the overflow menu. For example, * to make your control take up the whole width of the overflow menu, you can add a context class to your * control's base CSS file like this: * * * ```javascript * * .sapMOverflowToolbarMenu-CTX .sapMyControlClass { * width: 100%; * } * ``` * * * @since 1.52 */ export interface IOverflowToolbarContent { __implements__sap_m_IOverflowToolbarContent: boolean; } /** * Interface for controls which are suitable as a Scale for the Slider/RangeSlider. Implementation of this * interface should implement the following methods: * - `getTickmarksBetweenLabels` * - `calcNumberOfTickmarks` * - `handleResize` * - `getLabel` * * @since 1.46 */ export interface IScale { __implements__sap_m_IScale: boolean; /** * Returns how many tickmarks would be drawn on the screen. The start and the end tickmark should be specified * in this method. * * * @returns The number of tickmarks */ calcNumberOfTickmarks( /** * Size of the scale. This is the distance between the start and end point i.e. 0..100 */ fSize: float, /** * The step walking from start to end. */ fStep: float, /** * Limits the number of tickmarks. */ iTickmarksThreshold: int ): int; /** * Provides a custom tickmark label. * * This method is optional. If it is not provided, the slider values will be placed as labels. If provided, * the value of the tickmark labels and accessibility attributes (aria-valuenow and aria-valuetext) of the * slider are changed accordingly. * * * @returns The label that should be placed in the current position. */ getLabel?( /** * Value represented by the tickmark */ fValue: float, /** * Slider control that asks for a label */ oSlider: Slider | RangeSlider ): string | number; /** * Returns the number of tickmarks, which should be placed between labels. * * * @returns The number of tickmarks */ getTickmarksBetweenLabels(): int; /** * Called, when the slider is getting resized. * * The Slider/RangeSlider control could be accessed via the oEvent.control parameter. * * Implementing this method is optional. */ handleResize?( /** * The event object passed. */ oEvent: jQuery.Event ): void; } /** * Common interface for sap.m.ColumnListItem and sap.m.GroupHeaderListItem * * @since 1.119 */ export interface ITableItem { __implements__sap_m_ITableItem: boolean; } /** * Interface for controls placed in the `content` aggregation of `{@link sap.m.Toolbar}` or `{@link sap.m.OverflowToolbar}`, * which need to indicate whether they are interactive or not. * * Controls that implement this interface should have the following method: `_getToolbarInteractive` - returns * boolean value that shows whether the control is interactive or not */ export interface IToolbarInteractiveControl { __implements__sap_m_IToolbarInteractiveControl: boolean; } /** * Available label display modes. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'LabelDesign'. */ export enum LabelDesign { /** * Displays the label in bold. */ Bold = "Bold", /** * Displays the label in normal mode. */ Standard = "Standard", } /** * Types of LightBox loading stages. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'LightBoxLoadingStates'. * * @since 1.40 */ export enum LightBoxLoadingStates { /** * The LightBox image could not load. */ Error = "ERROR", /** * The LightBox image has loaded. */ Loaded = "LOADED", /** * The LightBox image is still loading. */ Loading = "LOADING", /** * The LightBox image has timed out, could not load. */ TimeOutError = "TIME_OUT_ERROR", } /** * Enumeration for possible Link accessibility roles. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'LinkAccessibleRole'. * * @since 1.104.0 */ export enum LinkAccessibleRole { /** * Link will receive `role="Button"` attibute. */ Button = "Button", /** * Default mode. */ Default = "Default", } /** * Enumeration for possible link-to-anchor conversion strategy. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'LinkConversion'. * * @since 1.45.5 */ export enum LinkConversion { /** * Valid links with protocols, such as http, https, ftp and those starting with the string "www". */ All = "All", /** * Default mode (no conversion). */ None = "None", /** * Valid links with protocols, such as http, https, ftp. */ ProtocolOnly = "ProtocolOnly", } /** * Defines the growing direction of the `sap.m.List` or `sap.m.Table`. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ListGrowingDirection'. * * @since 1.40.0 */ export enum ListGrowingDirection { /** * User has to scroll down to load more items or the growing button is displayed at the bottom. */ Downwards = "Downwards", /** * User has to scroll up to load more items or the growing button is displayed at the top. * * **Note:** If this option is active, there should not be any other control than `sap.m.List` inside its * `ScollContainer`. */ Upwards = "Upwards", } /** * Defines the different header styles. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ListHeaderDesign'. * * @deprecated As of version 1.16. Has no functionality since 1.16. */ export enum ListHeaderDesign { /** * Plain header style */ Plain = "Plain", /** * Standard header style */ Standard = "Standard", } /** * Defines the action types available for list items. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ListItemActionType'. * * @since 1.137 */ export enum ListItemActionType { /** * Defines a custom action for a list item. **Note:** The `icon` and `text` properties in the `sap.m.ListItemAction` * are required for this action type. */ Custom = "Custom", /** * Indicates that the list item is deletable. **Note:** The `icon` and `text` properties must not be set * in `sap.m.ListItemAction` for this action type. */ Delete = "Delete", /** * Indicates that the list item is editable. **Note:** The `icon` and `text` properties must not be set * in `sap.m.ListItemAction` for this action type. */ Edit = "Edit", } /** * Defines the keyboard handling behavior of the `sap.m.List` or `sap.m.Table`. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ListKeyboardMode'. * * @since 1.38.0 */ export enum ListKeyboardMode { /** * This mode is suitable if there are only editable fields within the item. * * In this mode, the first focus goes to the first interactive element within the first item and this is * the only difference between the `Edit` and `Navigation` mode. */ Edit = "Edit", /** * This default mode is suitable if the List or Table contains editable and/or non-editable fields. * * In this mode, the first focus goes to the first item. If the focus is on the item, or cell, pressing * tab/shift+tab moves the focus to the next/previous element in the tab chain after/before the `sap.m.List` * or `sap.m.Table` control. If the focus is on the interactive element, pressing tab/shift+tab moves the * focus to the next/previous element in the tab chain after/before the focused interactive element. */ Navigation = "Navigation", } /** * Defines the mode of the list. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ListMode'. */ export enum ListMode { /** * Delete mode (only one list item can be deleted via provided delete button) */ Delete = "Delete", /** * Multi selection mode (more than one list item can be selected). */ MultiSelect = "MultiSelect", /** * Default mode (no selection). */ None = "None", /** * Right-positioned single selection mode (only one list item can be selected). * * @deprecated As of version 1.143. replaced by {@link sap.m.ListMode.SingleSelectLeft}. */ SingleSelect = "SingleSelect", /** * Left-positioned single selection mode (only one list item can be selected). */ SingleSelectLeft = "SingleSelectLeft", /** * Selected item is highlighted but no selection control is visible (only one list item can be selected). */ SingleSelectMaster = "SingleSelectMaster", } /** * Defines which separator style will be applied for the items. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ListSeparators'. */ export enum ListSeparators { /** * Separators between the items including the last and the first one. */ All = "All", /** * Separators between the items. **Note:** This enumeration depends on the theme. */ Inner = "Inner", /** * No item separators. */ None = "None", } /** * Defines the visual indication and behaviour of the list items. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ListType'. */ export enum ListType { /** * Indicates that the item is clickable via active feedback when item is pressed. */ Active = "Active", /** * Enables the detail button of the list item that fires the {@link sap.m.ListItemBase#event:detailPress detailPress } * event. */ Detail = "Detail", /** * Enables {@link sap.m.ListType.Detail} and {@link sap.m.ListType.Active} enumerations together. */ DetailAndActive = "DetailAndActive", /** * Indicates the list item does not have any active feedback when item is pressed. **Note:** `Inactive` * type cannot be used to disable list items. */ Inactive = "Inactive", /** * Enables the navigation button of the list item to navigate and display additional information about the * item. Fires the {@link sap.m.ListBase#event:itemPress} event when pressed. */ Navigation = "Navigation", } /** * Enumeration of possible load statuses. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'LoadState'. * * @since 1.34.0 */ export enum LoadState { /** * The control is disabled. */ Disabled = "Disabled", /** * The control failed to load. */ Failed = "Failed", /** * The control has loaded. */ Loaded = "Loaded", /** * The control is loading. */ Loading = "Loading", } /** * Different modes for a MenuButton (predefined types). * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'MenuButtonMode'. * * @since 1.38.0 */ export enum MenuButtonMode { /** * Default Regular type - MenuButton appears as a regular button, pressing it opens a menu. */ Regular = "Regular", /** * Split type - MenuButton appears as a split button separated into two areas: the text and the arrow button. * Pressing the text area fires the default (or last) action, pressing the arrow part opens a menu. */ Split = "Split", } /** * Available color set variants for the {@link sap.m.MessageStrip} control. * * **Notes:** * - The Default color set uses standard semantic colors based on the message type (Information, Success, * Warning, Error). * - ColorSet1 and ColorSet2 provide custom color palettes with 10 predefined color schemes each. * - When using ColorSet1 or ColorSet2, the `colorScheme` property determines which color variation is * applied. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'MessageStripColorSet'. * * @since 1.143.0 */ export enum MessageStripColorSet { /** * Uses a custom color palette with predefined color schemes */ ColorSet1 = "ColorSet1", /** * Uses an alternative custom color palette with predefined color schemes */ ColorSet2 = "ColorSet2", /** * Uses standard semantic colors based on the type property (Information, Success, Warning, Error) */ Default = "Default", } /** * Enumeration of the `multiSelectMode>/code> in ListBase`. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'MultiSelectMode'. * * @since 1.93 */ export enum MultiSelectMode { /** * The Select All functionality is not available. Instead, it is only possible to remove the selection of * all items. For a `sap.m.Table`, a Deselect All icon is rendered. */ ClearAll = "ClearAll", /** * The Select All functionality is available (default behavior). For a `sap.m.Table`, a Select All checkbox * is rendered. */ Default = "Default", /** * The Select All functionality is available. For a `sap.m.Table`, a Select All checkbox with a warning * popover is rendered if not all items could be selected (for example, because of growing). * * @since 1.109 */ SelectAll = "SelectAll", } /** * Marker interface for controls which are suitable as items for the ObjectHeader. */ export interface ObjectHeaderContainer { __implements__sap_m_ObjectHeaderContainer: boolean; } /** * Used by the `ObjectHeader` control to define which shape to use for the image. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ObjectHeaderPictureShape'. * * @since 1.61 */ export enum ObjectHeaderPictureShape { /** * Circle shape for the images in the `ObjectHeader`. */ Circle = "Circle", /** * Square shape for the images in the `ObjectHeader`. */ Square = "Square", } /** * Predefined types for ObjectMarker. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ObjectMarkerType'. */ export enum ObjectMarkerType { /** * Draft type */ Draft = "Draft", /** * Favorite type */ Favorite = "Favorite", /** * Flagged type */ Flagged = "Flagged", /** * Locked type */ Locked = "Locked", /** * LockedBy type Use when you need to display the name of the user who locked the object. */ LockedBy = "LockedBy", /** * Unsaved type */ Unsaved = "Unsaved", /** * UnsavedBy type Use when you need to display the name of the user whose changes were unsaved. */ UnsavedBy = "UnsavedBy", } /** * Predefined visibility for ObjectMarker. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ObjectMarkerVisibility'. */ export enum ObjectMarkerVisibility { /** * Shows icon and text */ IconAndText = "IconAndText", /** * Shows only icon */ IconOnly = "IconOnly", /** * Shows only text */ TextOnly = "TextOnly", } /** * The object contains configuration information for the {@link sap.m.IOverflowToolbarContent} interface. * * @since 1.110 */ export type OverflowToolbarConfig = { /** * A boolean that tells whether the control can move to the overflow menu or not. **Notes:** * - Even if `canOverflow` is set to `false`, the `propsUnrelatedToSize` field is taken into account, * allowing to optimize the behavior of controls that do not need to overflow, but are used in an `sap.m.OverflowToolbar` * regardless. * - If `canOverflow` is not provided, its default value is `false`. In this case, the control is shown * in the content of the `sap.m.OverflowToolbar` but it's not possible to enter the overflow area. */ canOverflow?: boolean; /** * An array of strings, listing all of the control's events that should trigger the closing of the overflow * menu, when fired. */ autoCloseEvents?: string[]; /** * An array of strings, listing all of the control's events that should trigger the invalidation of the * `sap.m.OverflowToolbar`, when fired. **Note:** By default `sap.m.OverflowToolbar` invalidates whenever * any property of a child control changes. This is to ensure that whenever the size of a child control * changes, the overflow toolbar's layout is recalculated. Some properties however do not affect control * size, making it unnecessary to invalidate the overflow toolbar when they change. You can list them here * for optimization purposes. */ invalidationEvents?: string[]; /** * An array of strings, listing all of the control's properties that, when changed, should not cause the * overflow toolbar to invalidate. */ propsUnrelatedToSize?: string[]; /** * A callback function that will be invoked before moving the control into the overflow menu. The control * instance will be passed as an argument. **Note:** The context of the function is not the control instance * (use the `oControl` parameter for this purpose), but rather an internal helper object, associated with * the current `sap.m.OverflowToolbar` instance. This object only needs to be manipulated in special cases * (e.g. when you want to store state on it, rather than on the control instance). */ onBeforeEnterOverflow?: Function; /** * A callback function that will be invoked after taking the control out of the overflow menu (before moving * it back to the toolbar itself). The control instance will be passed as an argument. **Note:** See: `onBeforeEnterOverflow` * for details about the function's context. */ onAfterExitOverflow?: Function; /** * A function that, if provided, will be called to determine the priority of the control. This function * must return a value of type `sap.m.OverflowToolbarPriority`. The string "Medium" is also accepted and * interpreted as priority between `Low` and `High`. **Note:** Normally priority in `sap.m.OverflowToolbar` * is managed with the `priority` property of `sap.m.OverflowToolbarLayoutData`. However, some controls * may have other means of defining priority, such as dedicated properties or other types of layout data * for that purpose. In summary, implementing this function allows a control to override the default priority * logic (`sap.m.OverflowToolbarLayoutData`) by providing its own. */ getCustomImportance?: Function; }; /** * Defines the priorities of the controls within {@link sap.m.OverflowToolbar}. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'OverflowToolbarPriority'. * * @since 1.32 */ export enum OverflowToolbarPriority { /** * Deprecated - Use `sap.m.OverflowToolbarPriority.AlwaysOverflow` instead * * @deprecated As of version 1.48. */ Always = "Always", /** * Forces `OverflowToolbar` items to remain always in the overflow area. */ AlwaysOverflow = "AlwaysOverflow", /** * Items with priority `Disappear` overflow before the items with higher priority, such as `Low` and `High`, * and remain hidden in the overflow area. */ Disappear = "Disappear", /** * Items with priority `High` overflow after the items with lower priority. */ High = "High", /** * Items with priority `Low` overflow before the items with higher priority, such as `High` priority items. */ Low = "Low", /** * Deprecated - Use `sap.m.OverflowToolbarPriority.NeverOverflow` instead. * * @deprecated As of version 1.48. */ Never = "Never", /** * Forces `OverflowToolbar` items to remain always in the toolbar. */ NeverOverflow = "NeverOverflow", } /** * Types of `sap.m.OverflowToolbarTokenizerRenderMode` responsive modes * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'OverflowToolbarTokenizerRenderMode'. * * @since 1.139 */ export enum OverflowToolbarTokenizerRenderMode { /** * In `Loose` mode, `sap.m.OverflowToolbarTokenizer` shows all its tokens, even if it requires scrolling. */ Loose = "Loose", /** * In `Narrow` mode, `sap.m.OverflowToolbarTokenizer` shows as many tokens as its width allows and an n-More * indicator with the count of the hidden tokens. The rest of the tokens remain hidden. */ Narrow = "Narrow", /** * In `Overflow` mode, `sap.m.OverflowToolbarTokenizer` shows only a `sap.m.Button` as an n-More indicator * without visible tokens. This mode is used when `sap.m.OverflowToolbarTokenizer` is within the `sap.m.OverflowToolbar` * overflow area. */ Overflow = "Overflow", } /** * undefined * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'P13nConditionOperation'. */ export enum P13nConditionOperation { Ascending = "Ascending", Average = "Average", BT = "BT", Contains = "Contains", Descending = "Descending", Empty = "Empty", EndsWith = "EndsWith", EQ = "EQ", GE = "GE", GroupAscending = "GroupAscending", GroupDescending = "GroupDescending", GT = "GT", Initial = "Initial", LE = "LE", LT = "LT", Maximum = "Maximum", Minimum = "Minimum", NotBT = "NotBT", NotContains = "NotContains", NotEmpty = "NotEmpty", NotEndsWith = "NotEndsWith", NotEQ = "NotEQ", NotGE = "NotGE", NotGT = "NotGT", NotInitial = "NotInitial", NotLE = "NotLE", NotLT = "NotLT", NotStartsWith = "NotStartsWith", StartsWith = "StartsWith", Total = "Total", } /** * Type of panels used in the personalization dialog. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'P13nPanelType'. */ export enum P13nPanelType { /** * Panel type for column settings. */ columns = "columns", /** * Panel type for dimension and measure settings. */ dimeasure = "dimeasure", /** * Panel type for filtering. */ filter = "filter", /** * Panel type for grouping. */ group = "group", /** * Panel type for sorting. */ sort = "sort", } /** * Type of popup used in the `sap.m.p13n.Popup`. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'P13nPopupMode'. */ export enum P13nPopupMode { /** * Dialog type as popup type. */ Dialog = "Dialog", /** * ResponsivePopover type as popup type. */ ResponsivePopover = "ResponsivePopover", } /** * Available Page Background Design. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'PageBackgroundDesign'. */ export enum PageBackgroundDesign { /** * Page background color when a List is set as the Page content. */ List = "List", /** * A solid background color dependent on the theme. */ Solid = "Solid", /** * Standard Page background color. */ Standard = "Standard", /** * Transparent background for the page. */ Transparent = "Transparent", } /** * Available Panel Accessible Landmark Roles. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'PanelAccessibleRole'. */ export enum PanelAccessibleRole { /** * Represents the ARIA role `complementary`. A section of the page, designed to be complementary to the * main content at a similar level in the DOM hierarchy. */ Complementary = "Complementary", /** * Represents the ARIA role `Form`. A landmark region that contains a collection of items and objects that, * as a whole, create a form. */ Form = "Form", /** * Represents the ARIA role `Region`. A section of a page, that is important enough to be included in a * page summary or table of contents. */ Region = "Region", } /** * PDF viewer display types. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'PDFViewerDisplayType'. */ export enum PDFViewerDisplayType { /** * The PDF viewer switches between the `Link` display type and the `Embedded` display type, depending on * the device being used. */ Auto = "Auto", /** * The PDF viewer appears embedded in the parent container and displays the PDF file. */ Embedded = "Embedded", /** * The PDF viewer appears as a toolbar with a download button that can be used to download the PDF file * or open it in a new tab. */ Link = "Link", } /** * Types for the placement of Popover control. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'PlacementType'. */ export enum PlacementType { /** * Popover will be placed automatically at the reference control. */ Auto = "Auto", /** * Popover will be placed at the bottom of the reference control. */ Bottom = "Bottom", /** * Popover will be placed at the right or left side of the reference control. */ Horizontal = "Horizontal", /** * Deprecated - use `sap.m.PlacementType.HorizontalPreferredLeft` type. * * @since 1.29 * @deprecated As of version 1.36. Instead, use `sap.m.PlacementType.HorizontalPreferredLeft` type. */ HorizontalPreferedLeft = "HorizontalPreferedLeft", /** * Deprecated - use `sap.m.PlacementType.HorizontalPreferredRight` type. * * @since 1.29 * @deprecated As of version 1.36. Instead, use `sap.m.PlacementType.HorizontalPreferredRight` type. */ HorizontalPreferedRight = "HorizontalPreferedRight", /** * Popover will be placed at the right or left side of the reference control but will try to position on * the left side if the space is greater than the Popover's width. * * @since 1.36 */ HorizontalPreferredLeft = "HorizontalPreferredLeft", /** * Popover will be placed at the right or left side of the reference control but will try to position on * the right side if the space is greater than the Popover's width. * * @since 1.36 */ HorizontalPreferredRight = "HorizontalPreferredRight", /** * Popover will be placed at the left side of the reference control. */ Left = "Left", /** * Popover will be placed to the bottom of the reference control. If the available space is less than the * Popover's height, it will appear to the top of the same reference control bottom border. * * @since 1.38 */ PreferredBottomOrFlip = "PreferredBottomOrFlip", /** * Popover will be placed to the left of the reference control. If the available space is less than the * Popover's width, it will appear to the right of the same reference control left border. * * @since 1.38 */ PreferredLeftOrFlip = "PreferredLeftOrFlip", /** * Popover will be placed to the right of the reference control. If the available space is less than the * Popover's width, it will appear to the left of the same reference control right border. * * @since 1.38 */ PreferredRightOrFlip = "PreferredRightOrFlip", /** * Popover will be placed to the top of the reference control. If the available space is less than the Popover's * height, it will appear to the bottom of the same reference control top border. * * @since 1.38 */ PreferredTopOrFlip = "PreferredTopOrFlip", /** * Popover will be placed at the right side of the reference control. */ Right = "Right", /** * Popover will be placed at the top of the reference control. */ Top = "Top", /** * Popover will be placed at the top or bottom of the reference control. */ Vertical = "Vertical", /** * Deprecated - use `sap.m.PlacementType.VerticalPreferredBottom` type. * * @since 1.29 * @deprecated As of version 1.36. Instead, use `sap.m.PlacementType.VerticalPreferredBottom` type. */ VerticalPreferedBottom = "VerticalPreferedBottom", /** * Deprecated - use `sap.m.PlacementType.VerticalPreferredTop` type. * * @since 1.29 * @deprecated As of version 1.36. Instead, use `sap.m.PlacementType.VerticalPreferredTop` type. */ VerticalPreferedTop = "VerticalPreferedTop", /** * Popover will be placed at the top or bottom of the reference control but will try to position on the * bottom side if the space is greater than the Popover's height. * * @since 1.36 */ VerticalPreferredBottom = "VerticalPreferredBottom", /** * Popover will be placed at the top or bottom of the reference control but will try to position on the * top side if the space is greater than the Popover's height. * * @since 1.36 */ VerticalPreferredTop = "VerticalPreferredTop", } /** * A list of the default built-in views in a {@link sap.m.PlanningCalendar}, described by their keys. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'PlanningCalendarBuiltInView'. * * @since 1.50 */ export enum PlanningCalendarBuiltInView { /** * Represents the key of the built-in view, in which the intervals have the size of one day. */ Day = "Day", /** * Represents the key of the built-in view, in which the intervals have the size of one hour. */ Hour = "Hour", /** * Represents the key of the built-in view, in which the intervals have the size of one month. */ Month = "Month", /** * Represents the key of the built-in view, in which the intervals have the size of one day where 31 days * are displayed, starting with the first day of the month. */ OneMonth = "One Month", /** * Represents the key of the built-in view, in which the intervals have the size of one day where 7 days * are displayed, starting with the first day of the week. */ Week = "Week", } /** * Available sticky modes for the {@link sap.m.SinglePlanningCalendar} * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'PlanningCalendarStickyMode'. * * @since 1.62 */ export enum PlanningCalendarStickyMode { /** * Actions toolbar, navigation toolbar and the column headers will be sticky. */ All = "All", /** * Only the navigation toolbar and column headers will be sticky. */ NavBarAndColHeaders = "NavBarAndColHeaders", /** * Nothing will stick at the top. */ None = "None", } /** * Defines the display of table pop-ins. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'PopinDisplay'. * * @since 1.13.2 */ export enum PopinDisplay { /** * Inside the table popin, header is displayed at the first line and cell content is displayed at the next * line. */ Block = "Block", /** * Inside the table popin, cell content is displayed next to the header in the same line. **Note:** If there * is not enough space for the cell content then it jumps to the next line. */ Inline = "Inline", /** * Inside the table popin, only the cell content will be visible. * * @since 1.28 */ WithoutHeader = "WithoutHeader", } /** * Defines the layout options of the table popins. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'PopinLayout'. * * @since 1.52 */ export enum PopinLayout { /** * Sets block layout for rendering the table popins. The elements inside the popin container are rendered * one below the other. **Note:** This option enables the former rendering behavior of the table popins. * * @since 1.52 */ Block = "Block", /** * Sets grid layout for rendering the table popins. The grid width for each table popin is comparatively * larger than `GridSmall`, hence this allows less content to be rendered in a single popin row. * * @since 1.52 */ GridLarge = "GridLarge", /** * Sets grid layout for rendering the table popins. The grid width for each table popin is small, hence * this allows more content to be rendered in a single popin row. This value defines small grid width for * the table popins. * * @since 1.52 */ GridSmall = "GridSmall", } /** * Helper for Popups. * * @since 1.16.7 * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ interface PopupHelper { /** * Converts the given percentage value to an absolute number based on the given base size. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns The calculated size string with "px" as unit or `null` when the format of given parameter is * wrong. */ calcPercentageSize( /** * A percentage value in string format, for example "25%" */ sPercentage: string, /** * A float number which the calculation is based on. */ fBaseSize: float ): string | null; } export const PopupHelper: PopupHelper; /** * Defines the priority for the TileContent in ActionMode * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'Priority'. */ export enum Priority { /** * It displays high priority color for the GenericTag */ High = "High", /** * It displays low priority color for the GenericTag */ Low = "Low", /** * It displays medium priority color for the GenericTag */ Medium = "Medium", /** * The priority is not set */ None = "None", /** * It displays very high priority color for the GenericTag */ VeryHigh = "VeryHigh", } /** * QuickViewGroupElement is a combination of one label and another control (Link or Text) associated to * this label. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'QuickViewGroupElementType'. */ export enum QuickViewGroupElementType { /** * Displays an e-mail link */ email = "email", /** * Displays a regular HTML link */ link = "link", /** * Displays a phone number link for direct dialing and an icon for sending a text message */ mobile = "mobile", /** * Displays a link for navigating to another QuickViewPage */ pageLink = "pageLink", /** * Displays a phone number link for direct dialing */ phone = "phone", /** * Displays text */ text = "text", } /** * Possible values for the visualization of float values in the RatingIndicator control. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'RatingIndicatorVisualMode'. */ export enum RatingIndicatorVisualMode { /** * Values are rounded to the nearest integer value (e.g. 1.7 -> 2). */ Full = "Full", /** * Values are rounded to the nearest half value (e.g. 1.7 -> 1.5). */ Half = "Half", } /** * Reactive area modes of interactable elements. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ReactiveAreaMode'. */ export enum ReactiveAreaMode { /** * The target element is displayed as part of a sentence. */ Inline = "Inline", /** * The target element is displayed as on overlay on top of other interactive parts of the page. */ Overlay = "Overlay", } /** * Enumeration of the `ResetAllMode` that can be used in a `TablePersoController`. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ResetAllMode'. */ export enum ResetAllMode { /** * Default behavior of the `TablePersoDialog` Reset All button. */ Default = "Default", /** * Resets the table to the default of the attached `PersoService`. */ ServiceDefault = "ServiceDefault", /** * Resets the table to the result of `getResetPersData` of the attached `PersoService`. */ ServiceReset = "ServiceReset", } /** * Breakpoint names for different screen sizes. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ScreenSize'. */ export enum ScreenSize { /** * 1024px wide */ Desktop = "Desktop", /** * 768px wide */ Large = "Large", /** * 560px wide */ Medium = "Medium", /** * 240px wide */ Phone = "Phone", /** * 480px wide */ Small = "Small", /** * 600px wide */ Tablet = "Tablet", /** * 960px wide */ XLarge = "XLarge", /** * 320px wide */ XSmall = "XSmall", /** * 1120px wide */ XXLarge = "XXLarge", /** * 240px wide */ XXSmall = "XXSmall", } /** * Different SegmentedButton items sizing modes. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'SegmentedButtonContentMode'. */ export enum SegmentedButtonContentMode { /** * Each item fits its content and extra space is placed after the last item. * * @since 1.142.0 */ ContentFit = "ContentFit", /** * All items are sized equally to fill the available space. * * @since 1.142.0 */ EqualSized = "EqualSized", } /** * A string type that represents column ratio. * * Allowed values are strings that follow the number:number (3:2) format. * * @since 1.86 */ export type SelectColumnRatio = string; /** * Defines the control that will receive the initial focus in the `sap.m.SelectDialog` or `sap.m.TableSelectDialog`. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'SelectDialogInitialFocus'. * * @since 1.117.0 */ export enum SelectDialogInitialFocus { /** * Content list. */ List = "List", /** * SearchField control */ SearchField = "SearchField", } /** * Enumeration for different action levels in sap.m.SelectionDetails control. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'SelectionDetailsActionLevel'. * * @since 1.48 * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ export enum SelectionDetailsActionLevel { /** * ActionGroup on SelectionDetails list level. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ Group = "Group", /** * Action on SelectionDetailsItem level. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ Item = "Item", /** * Action on SelectionDetails list level. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ List = "List", } /** * Defines the keyboard navigation mode. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'SelectListKeyboardNavigationMode'. * * @since 1.38 */ export enum SelectListKeyboardNavigationMode { /** * Keyboard navigation is delimited at the last item or first item of the list. */ Delimited = "Delimited", /** * Keyboard navigation is disabled. */ None = "None", } /** * Enumeration for different separators for two columns layout when Select is in read-only mode. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'SelectTwoColumnSeparator'. * * @since 1.140 */ export enum SelectTwoColumnSeparator { /** * Will show bullet(·) as separator on two columns layout when Select is in read-only mode. */ Bullet = "Bullet", /** * Will show N-dash(–) as separator on two columns layout when Select is in read-only mode. */ Dash = "Dash", /** * Will show vertical line(|) as separator on two columns layout when Select is in read-only mode. */ VerticalLine = "VerticalLine", } /** * Enumeration for different Select types. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'SelectType'. * * @since 1.16 */ export enum SelectType { /** * Will show the text. */ Default = "Default", /** * Will show only the specified icon. */ IconOnly = "IconOnly", } /** * Enumeration of the `SharingMode` that can be used in a `VariantItem`. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'SharingMode'. */ export enum SharingMode { /** * Private mode of the `VariantItem`. */ Private = "Private", /** * Public mode of the `VariantItem`. */ Public = "Public", } /** * Available selection modes for the {@link sap.m.SinglePlanningCalendar} * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'SinglePlanningCalendarSelectionMode'. * * @since 1.113 */ export enum SinglePlanningCalendarSelectionMode { /** * Мore than one date will be available to selection. */ MultiSelect = "MultiSelect", /** * Single date selection. */ SingleSelect = "SingleSelect", } /** * Enumeration of possible size settings. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'Size'. * * @since 1.34.0 */ export enum Size { /** * The size depends on the device it is running on. It is medium size for desktop and tablet and small size * for phone. */ Auto = "Auto", /** * Large size. */ L = "L", /** * Medium size. */ M = "M", /** * The width and height of the control are determined by the width and height of the container the control * is placed in. Please note: it is decided by the control whether or not sap.m.Size.Responsive is supported. * * @since 1.44.0 */ Responsive = "Responsive", /** * Small size. */ S = "S", /** * Extra small size. */ XS = "XS", } /** * The mode of SplitContainer or SplitApp control to show/hide the master area. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'SplitAppMode'. */ export enum SplitAppMode { /** * Master area is hidden initially both in portrait and landscape. * * Master area can be opened by clicking on the top left corner button or swiping right. Swipe is only enabled * on mobile devices. Master will keep the open state when changing the orientation of the device. */ HideMode = "HideMode", /** * Master will be shown inside a Popover when in portrait mode */ PopoverMode = "PopoverMode", /** * Master will automatically be hidden in portrait mode. */ ShowHideMode = "ShowHideMode", /** * Master will always be shown but in a compressed version when in portrait mode. */ StretchCompressMode = "StretchCompressMode", } /** * The option keys of all the standard options of a DynamicDateRange control. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'StandardDynamicDateRangeKeys'. */ export enum StandardDynamicDateRangeKeys { /** * The date will be selected from a calendar. */ DATE = "DATE", /** * The range will be selected from a calendar. */ DATERANGE = "DATERANGE", /** * The date and time will be selected from a calendar and time picker. */ DATETIME = "DATETIME", /** * The range will be selected from two DateTimePicker controls. */ DATETIMERANGE = "DATETIMERANGE", /** * The range will start from the date selected from a calendar and ends with the last day of the current * year. */ DATETOYEAR = "DATETOYEAR", /** * The date will be the first day of the current month. */ FIRSTDAYMONTH = "FIRSTDAYMONTH", /** * The date will be the first day of the current quarter. */ FIRSTDAYQUARTER = "FIRSTDAYQUARTER", /** * The date will be the first day of the current week. */ FIRSTDAYWEEK = "FIRSTDAYWEEK", /** * The date will be the first day of the current year. */ FIRSTDAYYEAR = "FIRSTDAYYEAR", /** * The range will start from a date selected from a calendar. */ FROM = "FROM", /** * The range will start from a date and time selected from a calendar and time picker. */ FROMDATETIME = "FROMDATETIME", /** * The date will be the last day of the current month. */ LASTDAYMONTH = "LASTDAYMONTH", /** * The date will be the last day of the current quarter. */ LASTDAYQUARTER = "LASTDAYQUARTER", /** * The range will contain the last X days. The count of the days is selected from a StepInput. */ LASTDAYS = "LASTDAYS", /** * The range will contain the last X days including the current one. The count of the days is selected from * a StepInput. */ LASTDAYSINCLUDED = "LASTDAYSINCLUDED", /** * The date will be the last day of the current week. */ LASTDAYWEEK = "LASTDAYWEEK", /** * The date will be the last day of the current year. */ LASTDAYYEAR = "LASTDAYYEAR", /** * The range will contain the last X hours. The count of the hours is selected from a StepInput. */ LASTHOURS = "LASTHOURS", /** * The range will contain the last X hours including the current one. The count of the hours is selected * from a StepInput. */ LASTHOURSINCLUDED = "LASTHOURSINCLUDED", /** * The range will contain the last X minutes. The count of the minutes is selected from a StepInput. */ LASTMINUTES = "LASTMINUTES", /** * The range will contain the last X minutes including the current one. The count of the minutes is selected * from a StepInput. */ LASTMINUTESINCLUDED = "LASTMINUTESINCLUDED", /** * The range will contain the days in the last month. */ LASTMONTH = "LASTMONTH", /** * The range will contain the last X months. The count of the months is selected from a StepInput. */ LASTMONTHS = "LASTMONTHS", /** * The range will contain the last X months including the current one. The count of the months is selected * from a StepInput. */ LASTMONTHSINCLUDED = "LASTMONTHSINCLUDED", /** * The range will contain the days in the last quarter. */ LASTQUARTER = "LASTQUARTER", /** * The range will contain the last X quarters. The count of the quarters is selected from a StepInput. */ LASTQUARTERS = "LASTQUARTERS", /** * The range will contain the last X quarters including the current one. The count of the quarters is selected * from a StepInput. */ LASTQUARTERSINCLUDED = "LASTQUARTERSINCLUDED", /** * The range will contain the days of the last week. */ LASTWEEK = "LASTWEEK", /** * The range will contain the last X weeks. The count of the weeks is selected from a StepInput. */ LASTWEEKS = "LASTWEEKS", /** * The range will contain the last X weeks including the current one. The count of the weeks is selected * from a StepInput. */ LASTWEEKSINCLUDED = "LASTWEEKSINCLUDED", /** * The range will contain the days in the last year. */ LASTYEAR = "LASTYEAR", /** * The range will contain the last X years. The count of the years is selected from a StepInput. */ LASTYEARS = "LASTYEARS", /** * The range will contain the last X years including the current one. The count of the years is selected * from a StepInput. */ LASTYEARSINCLUDED = "LASTYEARSINCLUDED", /** * The range will contain the next X days. The count of the days is selected from a StepInput. */ NEXTDAYS = "NEXTDAYS", /** * The range will contain the next X days including the current one. The count of the days is selected from * a StepInput. */ NEXTDAYSINCLUDED = "NEXTDAYSINCLUDED", /** * The range will contain the next X hours. The count of the hours is selected from a StepInput. */ NEXTHOURS = "NEXTHOURS", /** * The range will contain the next X hours including the current one. The count of the hours is selected * from a StepInput. */ NEXTHOURSINCLUDED = "NEXTHOURSINCLUDED", /** * The range will contain the next X minutes. The count of the minutes is selected from a StepInput. */ NEXTMINUTES = "NEXTMINUTES", /** * The range will contain the next X minutes including the current one. The count of the minutes is selected * from a StepInput. */ NEXTMINUTESINCLUDED = "NEXTMINUTESINCLUDED", /** * The range will contain the days in the next month. */ NEXTMONTH = "NEXTMONTH", /** * The range will contain the next X months. The count of the months is selected from a StepInput. */ NEXTMONTHS = "NEXTMONTHS", /** * The range will contain the next X months including the current one. The count of the months is selected * from a StepInput. */ NEXTMONTHSINCLUDED = "NEXTMONTHSINCLUDED", /** * The range will contain the days in the next quarter. */ NEXTQUARTER = "NEXTQUARTER", /** * The range will contain the next X quarters. The count of the quarters is selected from a StepInput. */ NEXTQUARTERS = "NEXTQUARTERS", /** * The range will contain the next X quarters including the current one. The count of the quarters is selected * from a StepInput. */ NEXTQUARTERSINCLUDED = "NEXTQUARTERSINCLUDED", /** * The range will contain the days of the next week. */ NEXTWEEK = "NEXTWEEK", /** * The range will contain the next X weeks. The count of the weeks is selected from a StepInput. */ NEXTWEEKS = "NEXTWEEKS", /** * The range will contain the next X weeks including the current one. The count of the weeks is selected * from a StepInput. */ NEXTWEEKSINCLUDED = "NEXTWEEKSINCLUDED", /** * The range will contain the days in the next year. */ NEXTYEAR = "NEXTYEAR", /** * The range will contain the next X years. The count of the years is selected from a StepInput. */ NEXTYEARS = "NEXTYEARS", /** * The range will contain the next X years including the current one. The count of the years is selected * from a StepInput. */ NEXTYEARSINCLUDED = "NEXTYEARSINCLUDED", /** * The range will contain the days in the first quarter. */ QUARTER1 = "QUARTER1", /** * The range will contain the days in the second quarter. */ QUARTER2 = "QUARTER2", /** * The range will contain the days in the third quarter. */ QUARTER3 = "QUARTER3", /** * The range will contain the days in the fourth quarter. */ QUARTER4 = "QUARTER4", /** * The range will contain a month selected from a MonthPicker. */ SPECIFICMONTH = "SPECIFICMONTH", /** * The range will contain a month in exact year selected from a MonthPicker. */ SPECIFICMONTHINYEAR = "SPECIFICMONTHINYEAR", /** * The range will contain the days in the current month. */ THISMONTH = "THISMONTH", /** * The range will contain the days in the current quarter. */ THISQUARTER = "THISQUARTER", /** * The range will contain the days of the current week. */ THISWEEK = "THISWEEK", /** * The range will contain the days in the current year. */ THISYEAR = "THISYEAR", /** * The range will end in a date selected from a calendar. */ TO = "TO", /** * The range will end in a date and time selected from a calendar and time picker. */ TODATETIME = "TODATETIME", /** * The date will be the day of selection. */ TODAY = "TODAY", /** * The range will contain the last X days and the next Y days. The count of the days is selected from a * StepInput. */ TODAYFROMTO = "TODAYFROMTO", /** * The date will be the day after the day of selection. */ TOMORROW = "TOMORROW", /** * The range will start from the first day of the current year and ends with the date selected from a calendar. */ YEARTODATE = "YEARTODATE", /** * The date will be the day before the day of selection. */ YESTERDAY = "YESTERDAY", } /** * Types for StandardTile. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'StandardTileType'. */ export enum StandardTileType { /** * Tile representing that something needs to be created */ Create = "Create", /** * Monitor tile */ Monitor = "Monitor", /** * Default type */ None = "None", } /** * Available step modes for {@link sap.m.StepInput}. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'StepInputStepModeType'. * * @since 1.54 */ export enum StepInputStepModeType { /** * Choosing increase/decrease button will add/subtract the `step` value to/from the current value. For example, * if `step` is 5, current `value` is 17 and increase button is chosen, the result will be 22 (5+17). * * **Note:** Using keyboard PageUp/PageDown will add/subtract the `step` multiplied by the `largerStep` * values to/from the current `value`. For example, if `step` is 5, `largerStep` is 3, current `value` is * 17 and PageUp is chosen, the result would be 32 (5*3+17). * * For more information, see {@link sap.m.StepInput}'s `step`, `largerStep` and `stepMode` properties. */ AdditionAndSubtraction = "AdditionAndSubtraction", /** * Pressing increase/decrease button will increase/decrease the current `value` to the closest number that * is divisible by the `step`. * * For example, if `step` is 5, current `value` is 17 and increase button is chosen, the result will be * 20 as it is the closest larger number that is divisible by 5. * * **Note:** Using keyboard PageUp/PageDown will increase/decrease the current `value` to the closest number * that is divisible by the multiplication of the `step` and the `largerStep` values. For example, if `step` * is 5, `largerStep` is 3, current `value` is 17 and PageUp is chosen, the result would be 30 as it is * the closest larger number that is divisible by 15. * * The logic above will work only if both `step` and `largerStep` are integers. * * For more information, see {@link sap.m.StepInput}'s `step`, `largerStep` and `stepMode` properties. */ Multiple = "Multiple", } /** * Available validation modes for {@link sap.m.StepInput}. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'StepInputValidationMode'. */ export enum StepInputValidationMode { /** * Validation happens on `FocusOut`. */ FocusOut = "FocusOut", /** * Validation happens on `LiveChange`. */ LiveChange = "LiveChange", } /** * Defines which area of the control remains fixed at the top of the page during vertical scrolling as long * as the control is in the viewport. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'Sticky'. * * @since 1.54 */ export enum Sticky { /** * The column headers remain in a fixed position. */ ColumnHeaders = "ColumnHeaders", /** * The group headers remain in a fixed position at the top of the page during vertical scrolling. * * @since 1.128 */ GroupHeaders = "GroupHeaders", /** * The header toolbar remains in a fixed position. * * @since 1.56 */ HeaderToolbar = "HeaderToolbar", /** * The info toolbar remains in a fixed position. * * @since 1.56 */ InfoToolbar = "InfoToolbar", } /** * Types of string filter operators. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'StringFilterOperator'. * * @since 1.42 */ export enum StringFilterOperator { /** * Checks if any word in the text starts with the search string. */ AnyWordStartsWith = "AnyWordStartsWith", /** * Checks if the text contains the search string. */ Contains = "Contains", /** * Checks if the text is equal with the search string. */ Equals = "Equals", /** * Checks if the text starts with the search string. */ StartsWith = "StartsWith", } /** * Directions for swipe event. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'SwipeDirection'. */ export enum SwipeDirection { /** * Swipe from the beginning to the end - left to right in LTR languages and right to left in RTL languages. * * @since 1.72 */ BeginToEnd = "BeginToEnd", /** * Both directions (left to right or right to left) */ Both = "Both", /** * Swipe from the end to the beginning - right to left in LTR languages and left to right in RTL languages. * * @since 1.72 */ EndToBegin = "EndToBegin", /** * Swipe from left to right * * @deprecated As of version 1.72. replaced by {@link BeginToEnd} */ LeftToRight = "LeftToRight", /** * Swipe from right to left. * * @deprecated As of version 1.72. replaced by {@link EndToBegin} */ RightToLeft = "RightToLeft", } /** * Enumeration for different switch types. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'SwitchType'. */ export enum SwitchType { /** * Switch with accept and reject icons */ AcceptReject = "AcceptReject", /** * Will show "ON" and "OFF" translated to the current language or the custom text if provided */ Default = "Default", } /** * Specifies `IconTabBar` tab overflow mode. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'TabsOverflowMode'. * * @since 1.90.0 */ export enum TabsOverflowMode { /** * Default behavior: One overflow tab at the end of the header. */ End = "End", /** * Two overflow tabs at both ends of the header to keep tabs order intact. */ StartAndEnd = "StartAndEnd", } /** * Colors to highlight certain UI elements. * * In contrast to the `ValueState`, the semantic meaning must be defined by the application. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'TileInfoColor'. * See: * {@link fiori:/how-to-use-semantic-colors/ Semantic Colors} * * @since 1.124 */ export enum TileInfoColor { /** * SAP Brand Color */ BrandColor = "BrandColor", /** * Critical Text Color */ CriticalTextColor = "CriticalTextColor", /** * Indication Color 1 */ Indication1 = "Indication1", /** * Indication Color 10 */ Indication10 = "Indication10", /** * Indication Color 2 */ Indication2 = "Indication2", /** * Indication Color 3 */ Indication3 = "Indication3", /** * Indication Color 4 */ Indication4 = "Indication4", /** * Indication Color 5 */ Indication5 = "Indication5", /** * Indication Color 6 */ Indication6 = "Indication6", /** * Indication Color 7 */ Indication7 = "Indication7", /** * Indication Color 8 */ Indication8 = "Indication8", /** * Indication Color 9 */ Indication9 = "Indication9", /** * Information Background Color */ InformationBackgroundColor = "InformationBackgroundColor", /** * Information Border Color */ InformationBorderColor = "InformationBorderColor", /** * Neutral Background Color */ NeutralBackgroundColor = "NeutralBackgroundColor", /** * Neutral Border Color */ NeutralBorderColor = "NeutralBorderColor", /** * Neutral Element Color */ NeutralElementColor = "NeutralElementColor", /** * Warning Background Color */ WarningBackground = "WarningBackground", /** * Warning Border Color */ WarningBorderColor = "WarningBorderColor", } /** * Describes the behavior of tiles when displayed on a small-screened phone (374px wide and lower). * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'TileSizeBehavior'. * * @since 1.56.0 */ export enum TileSizeBehavior { /** * Default behavior: Tiles adapt to the size of the screen, getting smaller on small screens. */ Responsive = "Responsive", /** * Tiles are small all the time, regardless of the actual screen size. */ Small = "Small", } /** * Different modes for the `sap.m.TimePicker` mask. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'TimePickerMaskMode'. * * @since 1.54 */ export enum TimePickerMaskMode { /** * The mask will always be enforced for any time patterns. **Note:** The mask functions correctly only with * fixed-length time formats. Using the `Enforce` value with time formats that do not have a fixed length * may lead to unpredictable behavior. */ Enforce = "Enforce", /** * The mask is disabled for the `sap.m.TimePicker`. */ Off = "Off", /** * The mask is automatically enabled for all valid fixed-length time patterns, and it is disabled when the * time format does not have a fixed length. */ On = "On", } /** * Declares the type of title alignment for some controls * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'TitleAlignment'. */ export enum TitleAlignment { /** * The default type (if specified in the theme) */ Auto = "Auto", /** * Explicitly sets the alignment to the center */ Center = "Center", /** * Disables an automatic title alignment depending on theme Mostly used in sap.m.Bar */ None = "None", /** * Explicitly sets the alignment to the start (left or right depending on LTR/RTL) */ Start = "Start", } /** * Types of the `sap.m.Tokenizer` responsive modes. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'TokenizerRenderMode'. * * @since 1.80 */ export enum TokenizerRenderMode { /** * In `Loose` mode, the `sap.m.Tokenizer` will show all its tokens, even if this means that scrolling needs * to be used. */ Loose = "Loose", /** * In `Narrow` mode, the `sap.m.Tokenizer` will show as many tokens as its width allows, as well as an n-More * indicator with the count of the hidden tokens. The rest tokens will be hidden. */ Narrow = "Narrow", } /** * Types of the Toolbar Design. * * To preview the different combinations of `sap.m.ToolbarDesign` and `sap.m.ToolbarStyle`, see the **OverflowToolbar * - Design and styling** sample of the {@link sap.m.OverflowToolbar} control. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ToolbarDesign'. * * @since 1.16.8 */ export enum ToolbarDesign { /** * The toolbar can be inserted into other controls and if the design is "Auto" then it inherits the design * from parent control. */ Auto = "Auto", /** * The toolbar appears smaller than the regular size to show information(e.g: text, icon). */ Info = "Info", /** * The toolbar has a solid background. Its content will be rendered in a standard way. * * @since 1.22 */ Solid = "Solid", /** * The toolbar and its content will be displayed transparent. */ Transparent = "Transparent", } /** * Types of visual styles for the {@link sap.m.Toolbar}. * * **Note:** Keep in mind that the styles are theme-dependent and can differ based on the currently used * theme. * * To preview the different combinations of `sap.m.ToolbarDesign` and `sap.m.ToolbarStyle`, see the **OverflowToolbar * - Design and styling** sample of the {@link sap.m.OverflowToolbar} control. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ToolbarStyle'. * * @since 1.54 */ export enum ToolbarStyle { /** * Simplified visual style dependent on the used theme. * * **Note:** For the Belize themes, the `sap.m.Toolbar` is displayed with no border. */ Clear = "Clear", /** * Default visual style dependent on the used theme. */ Standard = "Standard", } /** * Defines the placeholder type for the control to be replaced. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'UploadSetwithTableActionPlaceHolder'. * * @since 1.120 */ export enum UploadSetwithTableActionPlaceHolder { /** * Placeholder for cloud file picker button. */ CloudFilePickerButtonPlaceholder = "CloudFilePickerButtonPlaceholder", /** * Placeholder for personalization settings button. * * @deprecated As of version 1.124. the concept has been discarded. */ PersonalizationSettingsPlaceholder = "PersonalizationSettingsPlaceholder", /** * Placeholder for upload button control. */ UploadButtonPlaceholder = "UploadButtonPlaceholder", /** * Placeholder for variant management. * * @deprecated As of version 1.124. the concept has been discarded. */ VariantManagementPlaceholder = "VariantManagementPlaceholder", } /** * States of the upload process of {@link sap.m.UploadCollectionItem}. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'UploadState'. */ export enum UploadState { /** * The file has been uploaded successfully. */ Complete = "Complete", /** * The file cannot be uploaded due to an error. */ Error = "Error", /** * The file is awaiting an explicit command to start being uploaded. */ Ready = "Ready", /** * The file is currently being uploaded. */ Uploading = "Uploading", } /** * Type of the upload {@link sap.m.upload.UploadSetItem}. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'UploadType'. */ export enum UploadType { /** * The file has been uploaded from cloud. */ Cloud = "Cloud", /** * The file has been uploaded from your system. */ Native = "Native", } /** * URL (Uniform Resource Locator) Helper. * * This helper can be used to trigger a native application (e.g. email, sms, phone) from the browser. That * means we are restricted of browser or application implementation. e.g. * - Some browsers do not let you pass more than 2022 characters in the URL * - MAPI (Outlook) limit is 2083, max. path under Internet Explorer is 2048 * - Different Internet Explorer versions have a different URL length limits (IE9 approximately 1000 characters) * * - MS mail app under Windows 8 cuts mail links after approximately 100 characters * - Safari gets a confirmation from user before opening a native application and can block other triggers * if the user cancels it * - Some mail applications(Outlook) do not respect all encodings (e.g. Cyrillic texts are not encoded * correctly) * * **Note:** all the given maximum lengths are for URL encoded text (e.g a space character will be encoded * as "%20"). * * It has been reported by some users that the content send through the `URLHelper` is not correctly displayed * by the native applications (e.g. a native mail application). * * After sending the body to the application, `URLHelper` cannot affect its rendering and the application * takes responsibility to correctly display the content. Inconsistencies between different native applications * or operative systems (OS) can lead to different behaviors and differences in the displayed content. * * **Example:** * * What happens with a link added to the content of an email using the `URLHelper` ? * * Apart from the correct generation of URL, everything else is outside of the scope of `URLHelper` as responsibility * from then on is passed to the browser and the native applications handling the URL. For instance, clicking * on an email link should result in triggering an action in the default mail application for the user's * OS and it is this application's responsibility to correctly handle the URL, given it is generated correctly. * See: * {@link https://ui5.sap.com/#/topic/4f1c1075d88c41a5904389fa12b28f6b URL Helper} * * @since 1.10 */ interface URLHelper { /** * Adds an event listener for the `redirect` event. * * * @returns The URLHelper instance */ attachRedirect( /** * The function to call, when the event occurs. */ fnFunction: Function, /** * The object that wants to be notified when the event occurs. */ oListener?: Object ): URLHelper; /** * Detach an already registered listener of the `redirect` event. * * * @returns The URLHelper instance */ detachRedirect( /** * The function to call, when the event occurs. */ fnFunction: Function, /** * The object, that wants to be notified, when the event occurs. */ oListener?: Object ): URLHelper; /** * Builds Email URI from given parameter. Trims spaces from email addresses. * * * @returns Email URI using the `mailto:` scheme */ normalizeEmail( /** * Destination email address */ sEmail?: string, /** * Subject of the email address */ sSubject?: string, /** * Default message text */ sBody?: string, /** * Carbon Copy email address */ sCC?: string, /** * Blind carbon copy email address */ sBCC?: string ): string; /** * Sanitizes the given telephone number and returns a URI using the `sms:` scheme. * * * @returns SMS URI using the `sms:` scheme */ normalizeSms( /** * Telephone number */ sTel?: string ): string; /** * Sanitizes the given telephone number and returns a URI using the `tel:` scheme. * * * @returns Telephone URI using the `tel:` scheme */ normalizeTel( /** * Telephone number */ sTel?: string ): string; /** * Redirects to the given URL. * * This method fires "redirect" event before opening the URL. */ redirect( /** * Uniform resource locator */ sURL: string, /** * Opens URL in a new browser window or tab. Please note that, opening a new window/tab can be ignored by * browsers (e.g. on Windows Phone) or by popup blockers. NOTE: On Windows Phone the URL will be enforced * to open in the same window if opening in a new window/tab fails (because of a known system restriction * on cross-window communications). Use sap.m.Link instead (with blank target) if you necessarily need to * open URL in a new window. */ bNewWindow?: boolean ): void; /** * Trigger email application to send email. Trims spaces from email addresses. */ triggerEmail( /** * Destination email address */ sEmail?: string, /** * Subject of the email address */ sSubject?: string, /** * Default message text */ sBody?: string, /** * Carbon Copy email address */ sCC?: string, /** * Blind carbon copy email address */ sBCC?: string, /** * Opens email template in a new browser window or tab. */ bNewWindow?: boolean ): void; /** * Trigger SMS application to send SMS to given telephone number. */ triggerSms( /** * Telephone number */ sTel?: string ): void; /** * Trigger telephone app to call the given telephone number. */ triggerTel( /** * Telephone number */ sTel?: string ): void; } export const URLHelper: URLHelper; /** * Enumeration of possible value color settings. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'ValueColor'. */ export enum ValueColor { /** * Critical value color. */ Critical = "Critical", /** * Error value color. */ Error = "Error", /** * Good value color. */ Good = "Good", /** * Neutral value color. */ Neutral = "Neutral", /** * None value color. * * **Note:** The None value color is set to prevent the display of tooltip 'Neutral' for numeric content. * * @since 1.84 */ None = "None", } /** * A string type that represents CSS color values, sap.m.ValueColor or less parameter values. * * Allowed values are {@link sap.ui.core.CSSColor}, {@link sap.m.ValueColor} or a less parameter name (string). * In case the less parameter color cannot be determined, the validation fails. You need to check if less * parameters are supported on control level. An empty string is also allowed and has the same effect as * setting no color. * * @deprecated As of version 1.135. the concept has been discarded. */ export type ValueCSSColor = string; /** * An object type that represents the {@link sap.m.VariantManagement} `manage`-event property `exe`. */ export type VariantManagementExe = { /** * the variant key. */ key: string; /** * flag describing the associated Appy Automatically indicator. */ exe: boolean; }; /** * An object type that represents the {@link sap.m.VariantManagement} `manage`-event property `fav`. */ export type VariantManagementFav = { /** * the variant key. */ key: string; /** * flag describing the associated Favorite indicator. */ visible: boolean; }; /** * An object type that represents the {@link sap.m.VariantManagement} `manage`-event property `rename`. */ export type VariantManagementRename = { /** * the variant key. */ key: string; /** * the new title of the variant. */ name: string; }; /** * Types for the placement of message Popover control. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'VerticalPlacementType'. */ export enum VerticalPlacementType { /** * Popover will be placed at the bottom of the reference control. */ Bottom = "Bottom", /** * Popover will be placed at the top of the reference control. */ Top = "Top", /** * Popover will be placed at the top or bottom of the reference control. */ Vertical = "Vertical", } /** * Wizard rendering mode. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'WizardRenderMode'. * * @since 1.83 */ export enum WizardRenderMode { /** * Display steps as separate, single pages. */ Page = "Page", /** * Display all steps into a scroll section. */ Scroll = "Scroll", } /** * Available wrapping types for text controls that can be wrapped that enable you to display the text as * hyphenated. * * For more information about text hyphenation, see {@link sap.ui.core.hyphenation.Hyphenation} and {@link https://ui5.sap.com/#/topic/6322164936f047de941ec522b95d7b70 Text Controls Hyphenation}. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'WrappingType'. * * @since 1.60 */ export enum WrappingType { /** * Hyphenation will be used to break words on syllables where possible. */ Hyphenated = "Hyphenated", /** * Normal text wrapping will be used. Words won't break based on hyphenation. */ Normal = "Normal", } export namespace p13n { /** * Interface for P13nPopup which are suitable as content for the `sap.m.p13n.Popup`. Implementation of this * interface should include the following methods: * * * - `getTitle` * * Implementation of this interface can optionally provide the following methods: * * * - `getVerticalScrolling` * - `onReset` * * @since 1.97 */ interface IContent { __implements__sap_m_p13n_IContent: boolean; /** * Returns the title, which should be displayed in the P13nPopup to describe related content. * * * @returns The title for the corresponding content to be displayed in the `sap.m.p13n.Popup`. */ getTitle(): string; /** * Optionally returns the enablement of the contents vertical scrolling in case only one panel is used to * determine if the content provides its own scrolling capabilites. * * * @returns The enablement of the vertical scrolling enablement for the `sap.m.p13n.Popup`. */ getVerticalScrolling?(): boolean; /** * Optional hook that will be executed when the panel is used by a `sap.m.p13n.Popup` that is called before * the popup is closed * * @since 1.145 * * @returns A Promise that is fullfilled if the panel is ready to be closed */ onBeforeClose?( /** * reason for closing the container */ sReason: string ): Promise; /** * Optional hook that will be executed when the panel is used by a `sap.m.p13n.Popup` that may trigger a * reset on the panel */ onReset?(): void; } } export namespace plugins { /** * Defines the states of list items when the context menu is opened. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'plugins.ContextMenuScope'. * * @since 1.121 */ enum ContextMenuScope { /** * The scope is set to the default value where the focus is unaffected by the opening of the context menu. */ Default = "Default", /** * The focus will be on the clicked item and also on other selected items, if the clicked item is selected. */ Selection = "Selection", } /** * Enumeration of the `copyPreference` in `CopyProvider`. Determines what is copied during a copy operation. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'plugins.CopyPreference'. * * @since 1.119 */ enum CopyPreference { /** * If cells are selected, only the content of the selected cells is copied, regardless of any other rows * or elements that might also be selected. If no cells are selected, the copy operation will default to * copying the selected rows. */ Cells = "Cells", /** * The entire selected scope is copied, including both row and cell selection. */ Full = "Full", } } export namespace semantic { /** * Marker interface for controls which are suitable as items of the filter aggregation of sap.m.Semantic.MasterPage. */ interface IFilter { __implements__sap_m_semantic_IFilter: boolean; } /** * Marker interface for controls which are suitable as items of the group aggregation of sap.m.Semantic.MasterPage. */ interface IGroup { __implements__sap_m_semantic_IGroup: boolean; } /** * Marker interface for controls which are suitable as items of the sort aggregation of sap.m.Semantic.MasterPage. */ interface ISort { __implements__sap_m_semantic_ISort: boolean; } /** * Declares the type of semantic ruleset that will govern the styling and positioning of semantic content. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'semantic.SemanticRuleSetType'. * * @since 1.44 */ enum SemanticRuleSetType { /** * The default ruleset type, for which the Share Menu is always in the footer of the page. */ Classic = "Classic", /** * Offers an optimized user experience, with displaying the Share Menu in the header, rather than the footer, * for Fullscreen mode. */ Optimized = "Optimized", } } export namespace table { namespace columnmenu { /** * Categories of column menu entries. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'table.columnmenu.Category'. * * @since 1.110 */ enum Category { /** * Aggregate category */ Aggregate = "Aggregate", /** * Filter category */ Filter = "Filter", /** * Generic category */ Generic = "Generic", /** * Group category */ Group = "Group", /** * Sort category */ Sort = "Sort", } /** * Defines the available content sizes for the `sap.m.table.columnmenu.QuickAction` control. * * This enum is part of the 'sap/m/library' module export and must be accessed by the property 'table.columnmenu.QuickActionContentSize'. */ enum QuickActionContentSize { /** * Large: Recommended for larger input controls, such as {@link sap.m.Input} or {@link sap.m.RatingIndicator}. * If there is limited space, the input control moves to a new line below the label. */ L = "L", /** * Small: Recommended for smaller controls, such as {@link sap.m.Switch} or {@link sap.m.CheckBox}. If there * is limited space, only the label is wrapped. The input control is always right-aligned horizontally and * middle-aligned vertically. */ S = "S", } } } export namespace touch { /** * Given a list of touches, count the number of touches related with the given element. * * * @returns The number of touches related with the given element. */ function countContained( /** * The list of touch objects to search. */ oTouchList: TouchList, /** * A jQuery element or an element reference or an element id. */ vElement: jQuery | Element | string ): number; /** * Given a list of touch objects, find the touch that matches the given one. * * * @returns The touch matching if any. */ function find( /** * The list of touch objects to search. */ oTouchList: TouchList, /** * A touch object to find or a Touch.identifier that uniquely identifies the current finger in the touch * session. */ oTouch: Touch | number ): object | undefined; } } declare module "sap/m/Support" { /** * * ```javascript * * `sap.m.Support` shows the technical information for SAPUI5 Mobile Applications. * This technical information includes: * * SAPUI5 Version * * User Agent * * Configurations (Bootstrap and Computed) * * URI parameters * * All loaded module names * * In order to show the device information, the user must follow the following gestures. * 1 - Hold two fingers for 3 seconds minimum. * 2 - Tab with a third finger while holding the first two fingers. * * NOTE: This class is internal and all its functions must not be used by an application * * Enable Support: * -------------------------------------------------- * //import * sap.ui.require("sap/m/Support", function (Support) { * // Support is initialized and is listening for fingers gestures combination * }); * * //By default after require, support is enabled but implicitly we can call * Support.on(); * * Disable Support: * -------------------------------------------------- * Support.off(); * ``` * * * @since 1.11.0 * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ const Support: undefined; export default Support; } declare module "sap/m/ActionListItem" { import { default as ListItemBase, $ListItemBaseSettings, } from "sap/m/ListItemBase"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { ListMode } from "sap/m/library"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * The `sap.m.ActionListItem` can be used like a `button` to fire actions when pressed. **Note:** The inherited * `selected` property of the `sap.m.ListItemBase` is not supported. */ export default class ActionListItem extends ListItemBase { /** * Constructor for a new ActionListItem. * * 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. * See: * {@link fiori:/action-list-item/ Action List Item} */ constructor( /** * Initial settings for the new control */ mSettings?: $ActionListItemSettings ); /** * Constructor for a new ActionListItem. * * 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. * See: * {@link fiori:/action-list-item/ Action List Item} */ constructor( /** * Id for the new control, generated automatically if no id is given */ sId?: string, /** * Initial settings for the new control */ mSettings?: $ActionListItemSettings ); /** * Creates a new subclass of class sap.m.ActionListItem 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.m.ListItemBase.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.m.ActionListItem. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Determines item specific mode. * * ActionListItems are not selectable because they are command controls (like Button or Link), so triggering * the associated command, rather than selection is appropriate to happen upon user action on these items. * * By overwriting `getMode` (inherited from `ListItemBase`), we exclude the item from processing steps that * are specific for selectable list-items. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Mode of the list item. */ getMode(): ListMode | ""; /** * Gets current value of property {@link #getText text}. * * Defines the text that appears in the control. * * * @returns Value of property `text` */ getText(): string; /** * Sets a new value for property {@link #getText text}. * * Defines the text that appears in the control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setText( /** * New value for property `text` */ sText?: string ): this; } /** * Describes the settings that can be provided to the ActionListItem constructor. */ export interface $ActionListItemSettings extends $ListItemBaseSettings { /** * Defines the text that appears in the control. */ text?: string | PropertyBindingInfo; } } declare module "sap/m/ActionSelect" { import { default as Select, $SelectSettings } from "sap/m/Select"; import { ID } from "sap/ui/core/library"; import Button from "sap/m/Button"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * The ActionSelect control provides a list of predefined items that allows end users to choose options * and additionally trigger some actions. * * @since 1.16 * @deprecated As of version 1.111. with no replacement. The control is no longer considered part of the * Fiori concept. */ export default class ActionSelect extends Select { /** * Constructor for a new ActionSelect. * * 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 control */ mSettings?: $ActionSelectSettings ); /** * Constructor for a new ActionSelect. * * 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 control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: $ActionSelectSettings ); /** * Creates a new subclass of class sap.m.ActionSelect 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.m.Select.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * 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.m.ActionSelect. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some button into the association {@link #getButtons buttons}. * * * @returns Reference to `this` in order to allow method chaining */ addButton( /** * The buttons to add; if empty, nothing is inserted */ vButton: ID | Button ): this; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getButtons buttons}. */ getButtons(): ID[]; /** * Remove all buttons from the ActionSelect. * * * @returns An array with the ids of the removed elements (might be empty). */ removeAllButtons(): string[]; /** * Removes the given button from the `ActionSelect` content. * * * @returns The ID of the removed button or `null`. */ removeButton( /** * The button to remove or its index or ID. */ vButton: int | ID | Button ): string | null; } /** * Describes the settings that can be provided to the ActionSelect constructor. * * @deprecated As of version 1.111. with no replacement. The control is no longer considered part of the * Fiori concept. */ export interface $ActionSelectSettings extends $SelectSettings { /** * Buttons to be added to the ActionSelect content. */ buttons?: Array