// For Library Version: 1.147.0 declare module "sap/ui/commons/library" { import { ColorPickerMode as ColorPickerMode1 } from "sap/ui/unified/library"; import { TitleLevel as TitleLevel1 } from "sap/ui/core/library"; import { form as form1 } from "sap/ui/layout/library"; /** * different styles for a button. * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'ButtonStyle'. * * @deprecated As of version 1.38. (altogether with sap.ui.commons.Button). Use sap.m.Button with its sap.m.ButtonType * instead. */ export enum ButtonStyle { /** * Accept button (normally green). */ Accept = "Accept", /** * default style (no special styling). */ Default = "Default", /** * Button is emphasized. */ Emph = "Emph", /** * Reject button (normally red). */ Reject = "Reject", } /** * Different styles for a ColorPicker. * * This enum is an alias for {@link sap.ui.unified.ColorPickerMode} and was only kept for compatibility * reasons. Please switch to the {@link sap.ui.unified.ColorPicker} API. * * @deprecated As of version 1.48.0. Use {@link sap.ui.unified.ColorPickerMode} instead. */ export type ColorPickerMode = ColorPickerMode1; /** * Marker interface for common controls which are suitable for use within a FormattedTextView. * * @deprecated As of version 1.38. the concept has been discarded. */ export interface FormattedTextViewControl { __implements__sap_ui_commons_FormattedTextViewControl: boolean; } /** * Enumeration of possible HorizontalDivider height settings. * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'HorizontalDividerHeight'. * * @deprecated As of version 1.38. without replacement. */ export enum HorizontalDividerHeight { /** * Divider gets a large top and bottom margin. */ Large = "Large", /** * Divider gets a medium top and bottom margin. */ Medium = "Medium", /** * Divider gets no top and bottom margin. */ Ruleheight = "Ruleheight", /** * Divider gets a small top and bottom margin. */ Small = "Small", } /** * Enumeration of possible HorizontalDivider types. * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'HorizontalDividerType'. * * @deprecated As of version 1.38. without a replacement. */ export enum HorizontalDividerType { /** * Type Area */ Area = "Area", /** * Type Page */ Page = "Page", } /** * Marker interface for controls that process instances of `window.Blob`, such as `window.File`. The implementation * of this Interface should implement the following Interface methods: * - `getProcessedBlobsFromArray` * * @deprecated As of version 1.38. because it is part of the deprecated package sap.ui.commons */ export interface IProcessableBlobs { __implements__sap_ui_commons_IProcessableBlobs: boolean; /** * Allows to process Blobs before they get uploaded. This API can be used to create custom Blobs and upload * these custom Blobs instead of the received/initials Blobs in the parameter `aBlobs`. One use case could * be to create and upload zip archives based on the passed Blobs. The default implementation of this API * should simply resolve with the received Blobs (parameter `aBlobs`). * * @since 1.144 * @deprecated As of version 1.144. Please use the IProcessableBlobs of the library sap.ui.unified instead. * * @returns A Promise that resolves with an array of Blobs which is used for the final uploading. */ getProcessedBlobsFromArray( /** * The initial Blobs which can be used to determine a new array of Blobs for further processing. */ aBlobs: Blob[] ): Promise; } /** * Available label display modes. * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'LabelDesign'. * * @deprecated As of version 1.38. the concept has been discarded. */ export enum LabelDesign { /** * Displays the label in bold. */ Bold = "Bold", /** * Displays the label in normal mode. */ Standard = "Standard", } /** * Determines the visual design of a MenuBar. The feature might be not supported by all themes. * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'MenuBarDesign'. * * @deprecated As of version 1.38. (altogether with sap.ui.commons.Toolbar). Use sap.m.Toolbar and its sap.m.ToolbarDesign * instead. */ export enum MenuBarDesign { /** * The MenuBar appears in header design. */ Header = "Header", /** * The MenuBar appears in standard design. */ Standard = "Standard", } /** * [Enter description for MessageType] * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'MessageType'. * * @deprecated As of version 1.38. Instead, use the `sap.ui.core.MessageType`. */ export enum MessageType { /** * Error message */ Error = "Error", /** * Successful message */ Success = "Success", /** * Warning message */ Warning = "Warning", } /** * Distinct paginator event types * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'PaginatorEvent'. * * @deprecated As of version 1.38. the concept has been discarded. */ export enum PaginatorEvent { /** * First page event */ First = "First", /** * Go to page event */ Goto = "Goto", /** * Last page event */ Last = "Last", /** * Next page event */ Next = "Next", /** * Previous page event */ Previous = "Previous", } /** * Possible values for the visualization of float values in the RatingIndicator Control. * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'RatingIndicatorVisualMode'. * * @deprecated As of version 1.38. Instead, use `sap.m.RatingIndicator` control. */ export enum RatingIndicatorVisualMode { /** * Values are not rounded. */ Continuous = "Continuous", /** * 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", } /** * Determines the visual design of a RowRepeater. * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'RowRepeaterDesign'. * * @deprecated As of version 1.38. */ export enum RowRepeaterDesign { /** * The RowRepeater will be displayed without header, toolbar or footer. Background will be transparent. */ BareShell = "BareShell", /** * The RowRepeater header and footer elements, as well as the row container background, appear solid. */ Standard = "Standard", /** * The RowRepeater header and footer elements, as well as the row container background, appear transparent. */ Transparent = "Transparent", } /** * A string type that represents subset of CSS size values. For the Splitter only px and % are allowed. * * @deprecated As of version 1.38. Instead, use `sap.ui.layout.Splitter` control. */ export type SplitterSize = string; /** * Semantic Colors of a text. * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'TextViewColor'. * * @deprecated As of version 1.38. the concept has been discarded. */ export enum TextViewColor { /** * Critical color */ Critical = "Critical", /** * Default color */ Default = "Default", /** * Negative color */ Negative = "Negative", /** * Positive color */ Positive = "Positive", } /** * Designs for TextView. * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'TextViewDesign'. * * @deprecated As of version 1.38. the concept has been discarded. */ export enum TextViewDesign { /** * Displays the text in bold letters */ Bold = "Bold", /** * Displays the text in header 1 letters. */ H1 = "H1", /** * Displays the text in header 2 letters. */ H2 = "H2", /** * Displays the text in header 3 letters. */ H3 = "H3", /** * Displays the text in header 4 letters. */ H4 = "H4", /** * Displays the text in header 5 letters. */ H5 = "H5", /** * Displays the text in header 6 letters. */ H6 = "H6", /** * Displays the text in italic letters */ Italic = "Italic", /** * Displays the text in monospace letters. */ Monospace = "Monospace", /** * Displays the text in smaller letters. */ Small = "Small", /** * Displays the text in standard letters. */ Standard = "Standard", /** * underlined Text */ Underline = "Underline", } /** * Level of a title. * * This is an alias for {@link sap.ui.core.TitleLevel} and only kept for compatibility reasons. * * @since 1.9.1 * @deprecated As of version 1.16.0. Use {@link sap.ui.core.TitleLevel} instead. */ export type TitleLevel = TitleLevel1; /** * Determines the visual design of a Toolbar. * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'ToolbarDesign'. * * @deprecated As of version 1.38. */ export enum ToolbarDesign { /** * The included controls have a very light appearance. The feature might be not supported by all themes. */ Flat = "Flat", /** * The toolbar elements such as buttons for example have their normal visual design, and the toolbar appears * solid. The feature might be not supported by all themes. */ Standard = "Standard", /** * The controls included in the toolbar have a normal visual design where the toolbar appears transparent. * The feature might be not supported by all themes. */ Transparent = "Transparent", } /** * Marker interface for common controls which are suitable for use within a toolbar. The most prominent * example of a toolbar item is a button which is mostly used with an icon instead of a text caption. * * Toolbar items must have a fixed height compatible with the toolbar being a single horizontal row. They * can refer to the toolbar's marker class "sapUiTb" to adjust their own theming when used inside a toolbar. * * @deprecated As of version 1.38. (altogether with sap.ui.commons.Toolbar). Use sap.m.Toolbar instead. */ export interface ToolbarItem { __implements__sap_ui_commons_ToolbarItem: boolean; } /** * Design of the Toolbar Separator. * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'ToolbarSeparatorDesign'. * * @deprecated As of version 1.38. (altogether wuith sap.ui.commons.Toolbar). Use sap.m.Toolbar and its * sap.m.ToolbarSeparator instead. */ export enum ToolbarSeparatorDesign { /** * 100% height Separator before and after specific controls */ FullHeight = "FullHeight", /** * Standard Separator between controls */ Standard = "Standard", } /** * Selection mode of the tree * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'TreeSelectionMode'. * * @deprecated As of version 1.38. (altogether with sap.ui.commons.Tree). Use sap.m.Tree with its items * instead. */ export enum TreeSelectionMode { /** * Behavior of the former Tree. It is possible to select a plurality of nodes via the API. */ Legacy = "Legacy", /** * Select multiple rows at a time. */ Multi = "Multi", /** * No rows can be selected. */ None = "None", /** * Select one row at a time. */ Single = "Single", } /** * States for TriStateCheckBox * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'TriStateCheckBoxState'. * * @since 1.7.2 * @deprecated As of version 1.38. Use {@link sap.m.CheckBox} and its properties instead. */ export enum TriStateCheckBoxState { /** * checked value for tri-state checkbox */ Checked = "Checked", /** * mixed state for tri-state checkbox */ Mixed = "Mixed", /** * unchecked, default value for tri-state checkbox */ Unchecked = "Unchecked", } export namespace enums { /** * Value set for the background design of areas * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'enums.AreaDesign'. * * @deprecated As of version 1.38. */ enum AreaDesign { /** * Shows the label in a filled look */ Fill = "Fill", /** * Shows the area in a plain look */ Plain = "Plain", /** * Shows the background as transparent */ Transparent = "Transparent", } /** * Value set for the border design of areas * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'enums.BorderDesign'. * * @deprecated As of version 1.38. */ enum BorderDesign { /** * Draws the border as a box around the area */ Box = "Box", /** * Suppresses the border */ None = "None", } /** * Orientation of a UI element * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'enums.Orientation'. * * @deprecated As of version 1.38. */ enum Orientation { /** * Horizontal orientation */ horizontal = "horizontal", /** * Vertical orientation */ vertical = "vertical", } } export namespace form { /** * Available FormLayouts used for the SimpleForm. * * This is an alias for {@link sap.ui.layout.form.SimpleFormLayout} and only kept for compatibility reasons. * * @deprecated As of version 1.16.0. Use {@link sap.ui.layout.form.SimpleFormLayout} instead. */ type SimpleFormLayout = form1.SimpleFormLayout; } export namespace layout { /** * Background design (i.e. color), e.g. of a layout cell. * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'layout.BackgroundDesign'. * * @deprecated As of version 1.38. */ enum BackgroundDesign { /** * A background design suitable for borders. */ Border = "Border", /** * An opaque background design that looks dark filled. */ Fill1 = "Fill1", /** * An opaque background design that looks medium filled. */ Fill2 = "Fill2", /** * An opaque background design that looks light filled. */ Fill3 = "Fill3", /** * A background design suitable for headers. */ Header = "Header", /** * A plain but opaque background design. */ Plain = "Plain", /** * A transparent background. */ Transparent = "Transparent", } /** * The type (=position) of a BorderLayoutArea * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'layout.BorderLayoutAreaTypes'. * * @deprecated As of version 1.38. (altogether with sap.ui.commons.layout.BorderLayout). Use sap.m.Page * instead with its aggregations. */ enum BorderLayoutAreaTypes { /** * Value to identify the begin area. */ begin = "begin", /** * Value to identify the bottom area. */ bottom = "bottom", /** * Value to identify the center area. */ center = "center", /** * Value to identify the end area. */ end = "end", /** * Value to identify the top area. */ top = "top", } /** * Horizontal alignment, e.g. of a layout cell's content within the cell's borders. Note that some values * depend on the current locale's writing direction while others do not. * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'layout.HAlign'. * * @deprecated As of version 1.38. */ enum HAlign { /** * Aligned towards the beginning of a line, in the current locale's writing direction. */ Begin = "Begin", /** * Horizontally centered. */ Center = "Center", /** * Aligned towards the end of a line, in the current locale's writing direction. */ End = "End", /** * Left aligned, regardless of the current locale's writing direction. */ Left = "Left", /** * Right aligned, regardless of the current locale's writing direction. */ Right = "Right", } /** * Padding, e.g. of a layout cell's content within the cell's borders. Note that all options except "None" * include a padding of 2px at the top and bottom, and differ only in the presence of a 4px padding towards * the beginning or end of a line, in the current locale's writing direction. * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'layout.Padding'. * * @deprecated As of version 1.38. */ enum Padding { /** * Top and bottom padding of 2px. Padding of 4px towards the beginning of a line, in the current locale's * writing direction, but none towards its end. */ Begin = "Begin", /** * Top and bottom padding of 2px. Padding of 4px towards both the beginning and end of a line. */ Both = "Both", /** * Top and bottom padding of 2px. Padding of 4px towards the end of a line, in the current locale's writing * direction, but none towards its beginning. */ End = "End", /** * Top and bottom padding of 2px. No padding towards neither the beginning nor end of a line. */ Neither = "Neither", /** * No padding at all. */ None = "None", } /** * Separation, e.g. of a layout cell from its neighbor, via a vertical gutter of defined width, with or * without a vertical line in its middle. * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'layout.Separation'. * * @deprecated As of version 1.38. */ enum Separation { /** * A large (63px) vertical gutter without a vertical line. */ Large = "Large", /** * A large (63px) vertical gutter with a vertical line in its middle. */ LargeWithLine = "LargeWithLine", /** * A medium (31px) vertical gutter without a vertical line. */ Medium = "Medium", /** * A medium (31px) vertical gutter with a vertical line in its middle. */ MediumWithLine = "MediumWithLine", /** * No gutter at all (0px), and without a vertical line, of course. */ None = "None", /** * A small (17px) vertical gutter without a vertical line. */ Small = "Small", /** * A small (17px) vertical gutter with a vertical line in its middle. */ SmallWithLine = "SmallWithLine", } /** * Vertical alignment, e.g. of a layout cell's content within the cell's borders. * * This enum is part of the 'sap/ui/commons/library' module export and must be accessed by the property * 'layout.VAlign'. * * @deprecated As of version 1.38. */ enum VAlign { /** * Aligned at the bottom. */ Bottom = "Bottom", /** * Vertically centered. */ Middle = "Middle", /** * Aligned at the top. */ Top = "Top", } } } declare module "sap/ui/commons/Accordion" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import AccordionSection from "sap/ui/commons/AccordionSection"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { CSSSize } from "sap/ui/core/library"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; import Event from "sap/ui/base/Event"; /** * Contains N sections, acting as containers for any library control * * @deprecated As of version 1.38. replaced by {@link sap.m.Panel}. */ export default class Accordion extends Control { /** * Constructor for a new Accordion. * * 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?: $AccordionSettings ); /** * Constructor for a new Accordion. * * 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?: $AccordionSettings ); /** * Creates a new subclass of class sap.ui.commons.Accordion with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.Accordion. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some section to the aggregation {@link #getSections sections}. * * * @returns Reference to `this` in order to allow method chaining */ addSection( /** * The section to add; if empty, nothing is inserted */ oSection: AccordionSection ): this; /** * Attaches event handler `fnFunction` to the {@link #event:sectionClose sectionClose} event of this `sap.ui.commons.Accordion`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Accordion` itself. * * Event is triggered when the user closes a section. * * * @returns Reference to `this` in order to allow method chaining */ attachSectionClose( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Accordion$SectionCloseEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Accordion` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:sectionClose sectionClose} event of this `sap.ui.commons.Accordion`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Accordion` itself. * * Event is triggered when the user closes a section. * * * @returns Reference to `this` in order to allow method chaining */ attachSectionClose( /** * The function to be called when the event occurs */ fnFunction: (p1: Accordion$SectionCloseEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Accordion` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:sectionOpen sectionOpen} event of this `sap.ui.commons.Accordion`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Accordion` itself. * * Event is triggered when the user opens a section. * * * @returns Reference to `this` in order to allow method chaining */ attachSectionOpen( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Accordion$SectionOpenEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Accordion` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:sectionOpen sectionOpen} event of this `sap.ui.commons.Accordion`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Accordion` itself. * * Event is triggered when the user opens a section. * * * @returns Reference to `this` in order to allow method chaining */ attachSectionOpen( /** * The function to be called when the event occurs */ fnFunction: (p1: Accordion$SectionOpenEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Accordion` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:sectionsReorder sectionsReorder} event of this * `sap.ui.commons.Accordion`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Accordion` itself. * * Event is triggered when the user changes the position of a section. * * * @returns Reference to `this` in order to allow method chaining */ attachSectionsReorder( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Accordion$SectionsReorderEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Accordion` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:sectionsReorder sectionsReorder} event of this * `sap.ui.commons.Accordion`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Accordion` itself. * * Event is triggered when the user changes the position of a section. * * * @returns Reference to `this` in order to allow method chaining */ attachSectionsReorder( /** * The function to be called when the event occurs */ fnFunction: (p1: Accordion$SectionsReorderEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Accordion` itself */ oListener?: object ): this; /** * Closes a section and opens the default one */ closeSection( /** * Id of the section that is being closed */ sSectionId: string ): void; /** * Destroys all the sections in the aggregation {@link #getSections sections}. * * * @returns Reference to `this` in order to allow method chaining */ destroySections(): this; /** * Detaches event handler `fnFunction` from the {@link #event:sectionClose sectionClose} event of this `sap.ui.commons.Accordion`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSectionClose( /** * The function to be called, when the event occurs */ fnFunction: (p1: Accordion$SectionCloseEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:sectionOpen sectionOpen} event of this `sap.ui.commons.Accordion`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSectionOpen( /** * The function to be called, when the event occurs */ fnFunction: (p1: Accordion$SectionOpenEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:sectionsReorder sectionsReorder} event of * this `sap.ui.commons.Accordion`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSectionsReorder( /** * The function to be called, when the event occurs */ fnFunction: (p1: Accordion$SectionsReorderEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:sectionClose sectionClose} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSectionClose( /** * Parameters to pass along with the event */ mParameters?: Accordion$SectionCloseEventParameters ): this; /** * Fires event {@link #event:sectionOpen sectionOpen} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSectionOpen( /** * Parameters to pass along with the event */ mParameters?: Accordion$SectionOpenEventParameters ): this; /** * Fires event {@link #event:sectionsReorder sectionsReorder} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSectionsReorder( /** * Parameters to pass along with the event */ mParameters?: Accordion$SectionsReorderEventParameters ): this; /** * Gets current value of property {@link #getOpenedSectionsId openedSectionsId}. * * Section IDs that are opened by default at application start * * * @returns Value of property `openedSectionsId` */ getOpenedSectionsId(): string; /** * Gets content of aggregation {@link #getSections sections}. * * Empty container used to display any library control */ getSections(): AccordionSection[]; /** * Gets current value of property {@link #getWidth width}. * * When the specified width is less than the width of a section content, a horizontal scroll bar is provided. * * Default value is `'200px'`. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Checks for the provided `sap.ui.commons.AccordionSection` in the aggregation {@link #getSections sections}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfSection( /** * The section whose index is looked for */ oSection: AccordionSection ): int; /** * Inserts a section into the aggregation {@link #getSections sections}. * * * @returns Reference to `this` in order to allow method chaining */ insertSection( /** * The section to insert; if empty, nothing is inserted */ oSection: AccordionSection, /** * The `0`-based index the section should be inserted at; for a negative value of `iIndex`, the section * is inserted at position 0; for a value greater than the current size of the aggregation, the section * is inserted at the last position */ iIndex: int ): this; /** * Opens a section */ openSection( /** * Id of the section that is being opened */ sSectionId: string ): void; /** * Removes all the controls from the aggregation {@link #getSections sections}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllSections(): AccordionSection[]; /** * Removes a section from the aggregation {@link #getSections sections}. * * * @returns The removed section or `null` */ removeSection( /** * The section to remove or its index or id */ vSection: int | string | AccordionSection ): AccordionSection | null; /** * Redefinition of the method to add additional handling * * * @returns 'this' to allow method chaining */ setOpenedSectionsId( /** * New value for property openedSectionsId */ sOpenedSectionsId: string ): this; /** * Sets a new value for property {@link #getWidth width}. * * When the specified width is less than the width of a section content, a horizontal scroll bar is provided. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'200px'`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; } /** * Describes the settings that can be provided to the Accordion constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.Panel}. */ export interface $AccordionSettings extends $ControlSettings { /** * When the specified width is less than the width of a section content, a horizontal scroll bar is provided. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Section IDs that are opened by default at application start */ openedSectionsId?: string | PropertyBindingInfo; /** * Empty container used to display any library control */ sections?: | AccordionSection[] | AccordionSection | AggregationBindingInfo | `{${string}}`; /** * Event is triggered when the user opens a section. */ sectionOpen?: (oEvent: Accordion$SectionOpenEvent) => void; /** * Event is triggered when the user closes a section. */ sectionClose?: (oEvent: Accordion$SectionCloseEvent) => void; /** * Event is triggered when the user changes the position of a section. */ sectionsReorder?: (oEvent: Accordion$SectionsReorderEvent) => void; } /** * Parameters of the Accordion#sectionClose event. */ export interface Accordion$SectionCloseEventParameters { /** * ID of the closed section */ closeSectionId?: string; } /** * Event object of the Accordion#sectionClose event. */ export type Accordion$SectionCloseEvent = Event< Accordion$SectionCloseEventParameters, Accordion >; /** * Parameters of the Accordion#sectionOpen event. */ export interface Accordion$SectionOpenEventParameters { /** * ID of the opened section */ openSectionId?: string; /** * IDs of the sections to be closed. Can be initial in the case of no previously opened section. */ closeSectionIds?: string[]; } /** * Event object of the Accordion#sectionOpen event. */ export type Accordion$SectionOpenEvent = Event< Accordion$SectionOpenEventParameters, Accordion >; /** * Parameters of the Accordion#sectionsReorder event. */ export interface Accordion$SectionsReorderEventParameters { /** * ID of the moved section */ movedSectionId?: string; /** * New index of the moved section */ newIndex?: int; } /** * Event object of the Accordion#sectionsReorder event. */ export type Accordion$SectionsReorderEvent = Event< Accordion$SectionsReorderEventParameters, Accordion >; } declare module "sap/ui/commons/AccordionSection" { import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element"; import Control from "sap/ui/core/Control"; import { CSSSize } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; import Event from "sap/ui/base/Event"; /** * Represents a panel which is a container for other controls. The container does not have any layout function. * * @deprecated As of version 1.38. the concept has been discarded. */ export default class AccordionSection extends UI5Element { /** * Constructor for a new AccordionSection. * * 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?: $AccordionSectionSettings ); /** * Constructor for a new AccordionSection. * * 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?: $AccordionSectionSettings ); /** * Creates a new subclass of class sap.ui.commons.AccordionSection with name `sClassName` and enriches it * with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @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.ui.commons.AccordionSection. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some content to the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ addContent( /** * The content to add; if empty, nothing is inserted */ oContent: Control ): this; /** * Attaches event handler `fnFunction` to the {@link #event:scroll scroll} event of this `sap.ui.commons.AccordionSection`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.AccordionSection` itself. * * Event is fired when the user scrolls the panel * * * @returns Reference to `this` in order to allow method chaining */ attachScroll( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: AccordionSection$ScrollEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.AccordionSection` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:scroll scroll} event of this `sap.ui.commons.AccordionSection`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.AccordionSection` itself. * * Event is fired when the user scrolls the panel * * * @returns Reference to `this` in order to allow method chaining */ attachScroll( /** * The function to be called when the event occurs */ fnFunction: (p1: AccordionSection$ScrollEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.AccordionSection` itself */ oListener?: object ): this; /** * Destroys all the content in the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Detaches event handler `fnFunction` from the {@link #event:scroll scroll} event of this `sap.ui.commons.AccordionSection`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachScroll( /** * The function to be called, when the event occurs */ fnFunction: (p1: AccordionSection$ScrollEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:scroll scroll} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireScroll( /** * Parameters to pass along with the event */ mParameters?: AccordionSection$ScrollEventParameters ): this; /** * Gets current value of property {@link #getCollapsed collapsed}. * * It is recommended to adjust the settings for the width when the section is set to 'collapsed'. * * Default value is `false`. * * @deprecated As of version 1.34. Use Accordion's "openedSectionsId" property * * @returns Value of property `collapsed` */ getCollapsed(): boolean; /** * Gets content of aggregation {@link #getContent content}. * * Aggregates the controls that are contained in the panel. The control layout is browser-dependent. For * a stable content layout, use a layout control as direct single child. When the panel dimensions are set, * the child control may have width and height of 100%; when the panel dimensions are not set, the child * defines the panel size. */ getContent(): Control[]; /** * Gets current value of property {@link #getEnabled enabled}. * * It is required that the used theme supports the control. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getMaxHeight maxHeight}. * * When the section content exceeds maxHeight, a vertical scroll bar appears. * * * @returns Value of property `maxHeight` */ getMaxHeight(): CSSSize; /** * Gets current value of property {@link #getTitle title}. * * Text for the section header * * * @returns Value of property `title` */ getTitle(): string; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContent( /** * The content whose index is looked for */ oContent: Control ): int; /** * Inserts a content into the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ insertContent( /** * The content to insert; if empty, nothing is inserted */ oContent: Control, /** * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content * is inserted at position 0; for a value greater than the current size of the aggregation, the content * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getContent content}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllContent(): Control[]; /** * Removes a content from the aggregation {@link #getContent content}. * * * @returns The removed content or `null` */ removeContent( /** * The content to remove or its index or id */ vContent: int | string | Control ): Control | null; /** * Property setter for the "collapsed" state * * * @returns 'this' to allow method chaining */ setCollapsed( /** * Whether the AccordionSection is collapsed or not */ bCollapsed: boolean ): this; /** * Property setter for the "enabled" state * * * @returns 'this' to allow method chaining */ setEnabled( /** * Whether the AccordionSection is enabled or not */ bEnabled: boolean ): this; /** * Sets a new value for property {@link #getMaxHeight maxHeight}. * * When the section content exceeds maxHeight, a vertical scroll bar appears. * * 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 */ setMaxHeight( /** * New value for property `maxHeight` */ sMaxHeight?: CSSSize ): this; /** * Sets a new value for property {@link #getTitle title}. * * Text for the section header * * 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 */ setTitle( /** * New value for property `title` */ sTitle?: string ): this; } /** * Describes the settings that can be provided to the AccordionSection constructor. * * @deprecated As of version 1.38. the concept has been discarded. */ export interface $AccordionSectionSettings extends $ElementSettings { /** * When the section content exceeds maxHeight, a vertical scroll bar appears. */ maxHeight?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * It is required that the used theme supports the control. */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * It is recommended to adjust the settings for the width when the section is set to 'collapsed'. * * @deprecated As of version 1.34. Use Accordion's "openedSectionsId" property */ collapsed?: boolean | PropertyBindingInfo | `{${string}}`; /** * Text for the section header */ title?: string | PropertyBindingInfo; /** * Aggregates the controls that are contained in the panel. The control layout is browser-dependent. For * a stable content layout, use a layout control as direct single child. When the panel dimensions are set, * the child control may have width and height of 100%; when the panel dimensions are not set, the child * defines the panel size. */ content?: Control[] | Control | AggregationBindingInfo | `{${string}}`; /** * Event is fired when the user scrolls the panel */ scroll?: (oEvent: AccordionSection$ScrollEvent) => void; } /** * Parameters of the AccordionSection#scroll event. */ export interface AccordionSection$ScrollEventParameters { /** * Horizontal scroll position */ left?: int; /** * Vertical scroll position */ top?: int; } /** * Event object of the AccordionSection#scroll event. */ export type AccordionSection$ScrollEvent = Event< AccordionSection$ScrollEventParameters, AccordionSection >; } declare module "sap/ui/commons/ApplicationHeader" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import Event from "sap/ui/base/Event"; import { URI } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * The application header control stands on the top of any application page. It consists of 4 areas: Logo * area, Function area provided by application, Search area, Logout area. * * @deprecated As of version 1.38. Instead, use the `sap.tnt.ToolHeader` control. */ export default class ApplicationHeader extends Control { /** * Constructor for a new ApplicationHeader. * * 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?: $ApplicationHeaderSettings ); /** * Constructor for a new ApplicationHeader. * * 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?: $ApplicationHeaderSettings ); /** * Creates a new subclass of class sap.ui.commons.ApplicationHeader with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.ApplicationHeader. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:logoff logoff} event of this `sap.ui.commons.ApplicationHeader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.ApplicationHeader` itself. * * Fires an event to log off the user from the application. No parameters. * * * @returns Reference to `this` in order to allow method chaining */ attachLogoff( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.ApplicationHeader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:logoff logoff} event of this `sap.ui.commons.ApplicationHeader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.ApplicationHeader` itself. * * Fires an event to log off the user from the application. No parameters. * * * @returns Reference to `this` in order to allow method chaining */ attachLogoff( /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.ApplicationHeader` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:logoff logoff} event of this `sap.ui.commons.ApplicationHeader`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachLogoff( /** * The function to be called, when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:logoff logoff} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireLogoff( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Gets current value of property {@link #getDisplayLogoff displayLogoff}. * * Determines if the logoff area will be displayed at the right hand side of the application header. * * Default value is `true`. * * * @returns Value of property `displayLogoff` */ getDisplayLogoff(): boolean; /** * Gets current value of property {@link #getDisplayWelcome displayWelcome}. * * Determines if the welcome text is displayed * * Default value is `true`. * * * @returns Value of property `displayWelcome` */ getDisplayWelcome(): boolean; /** * Gets current value of property {@link #getLogoSrc logoSrc}. * * Path (src) to the logo icon to be displayed in the application header. * * * @returns Value of property `logoSrc` */ getLogoSrc(): URI; /** * Gets current value of property {@link #getLogoText logoText}. * * The text that will be displayed beside the logo in the application header. This property is optional. * * * @returns Value of property `logoText` */ getLogoText(): string; /** * Gets current value of property {@link #getUserName userName}. * * User name that will be displayed beside the welcome text * * * @returns Value of property `userName` */ getUserName(): string; /** * Sets a new value for property {@link #getDisplayLogoff displayLogoff}. * * Determines if the logoff area will be displayed at the right hand side of the application header. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setDisplayLogoff( /** * New value for property `displayLogoff` */ bDisplayLogoff?: boolean ): this; /** * Sets a new value for property {@link #getDisplayWelcome displayWelcome}. * * Determines if the welcome text is displayed * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setDisplayWelcome( /** * New value for property `displayWelcome` */ bDisplayWelcome?: boolean ): this; /** * Sets a new value for property {@link #getLogoSrc logoSrc}. * * Path (src) to the logo icon to be displayed in the application header. * * 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 */ setLogoSrc( /** * New value for property `logoSrc` */ sLogoSrc?: URI ): this; /** * Sets a new value for property {@link #getLogoText logoText}. * * The text that will be displayed beside the logo in the application header. This property is optional. * * 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 */ setLogoText( /** * New value for property `logoText` */ sLogoText?: string ): this; /** * Sets a new value for property {@link #getUserName userName}. * * User name that will be displayed beside the welcome text * * 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 */ setUserName( /** * New value for property `userName` */ sUserName?: string ): this; } /** * Describes the settings that can be provided to the ApplicationHeader constructor. * * @deprecated As of version 1.38. Instead, use the `sap.tnt.ToolHeader` control. */ export interface $ApplicationHeaderSettings extends $ControlSettings { /** * Path (src) to the logo icon to be displayed in the application header. */ logoSrc?: URI | PropertyBindingInfo | `{${string}}`; /** * The text that will be displayed beside the logo in the application header. This property is optional. */ logoText?: string | PropertyBindingInfo; /** * Determines if the logoff area will be displayed at the right hand side of the application header. */ displayLogoff?: boolean | PropertyBindingInfo | `{${string}}`; /** * User name that will be displayed beside the welcome text */ userName?: string | PropertyBindingInfo; /** * Determines if the welcome text is displayed */ displayWelcome?: boolean | PropertyBindingInfo | `{${string}}`; /** * Fires an event to log off the user from the application. No parameters. */ logoff?: (oEvent: Event) => void; } /** * Parameters of the ApplicationHeader#logoff event. */ export interface ApplicationHeader$LogoffEventParameters {} /** * Event object of the ApplicationHeader#logoff event. */ export type ApplicationHeader$LogoffEvent = Event< ApplicationHeader$LogoffEventParameters, ApplicationHeader >; } declare module "sap/ui/commons/Area" { import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element"; import { URI } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Used for defining areas in an image map. At runtime, the user can trigger an action, or start a URL, * from the single image areas. * * @deprecated As of version 1.38. */ export default class Area extends UI5Element { /** * Constructor for a new Area. * * 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?: $AreaSettings ); /** * Constructor for a new Area. * * 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?: $AreaSettings ); /** * Creates a new subclass of class sap.ui.commons.Area with name `sClassName` and enriches it with the information * contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @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.ui.commons.Area. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Gets current value of property {@link #getAlt alt}. * * Alternative text that is displayed in the case the image is not available * * * @returns Value of property `alt` */ getAlt(): string; /** * Gets current value of property {@link #getCoords coords}. * * Coordinates of the area * * * @returns Value of property `coords` */ getCoords(): string; /** * Gets current value of property {@link #getHref href}. * * Hyper link that is executed when the area is clicked * * * @returns Value of property `href` */ getHref(): URI; /** * Gets current value of property {@link #getShape shape}. * * The value is a string and can be 'rect' for rectangle, 'poly' for poligon, 'circle', or default. * * * @returns Value of property `shape` */ getShape(): string; /** * Sets a new value for property {@link #getAlt alt}. * * Alternative text that is displayed in the case the image is not available * * 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 */ setAlt( /** * New value for property `alt` */ sAlt?: string ): this; /** * Sets a new value for property {@link #getCoords coords}. * * Coordinates of the area * * 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 */ setCoords( /** * New value for property `coords` */ sCoords?: string ): this; /** * Sets a new value for property {@link #getHref href}. * * Hyper link that is executed when the area is clicked * * 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 */ setHref( /** * New value for property `href` */ sHref?: URI ): this; /** * Sets a new value for property {@link #getShape shape}. * * The value is a string and can be 'rect' for rectangle, 'poly' for poligon, 'circle', or default. * * 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 */ setShape( /** * New value for property `shape` */ sShape?: string ): this; } /** * Describes the settings that can be provided to the Area constructor. * * @deprecated As of version 1.38. */ export interface $AreaSettings extends $ElementSettings { /** * The value is a string and can be 'rect' for rectangle, 'poly' for poligon, 'circle', or default. */ shape?: string | PropertyBindingInfo; /** * Coordinates of the area */ coords?: string | PropertyBindingInfo; /** * Hyper link that is executed when the area is clicked */ href?: URI | PropertyBindingInfo | `{${string}}`; /** * Alternative text that is displayed in the case the image is not available */ alt?: string | PropertyBindingInfo; } } declare module "sap/ui/commons/AutoComplete" { import { default as ComboBox, $ComboBoxSettings, } from "sap/ui/commons/ComboBox"; import { ToolbarItem } from "sap/ui/commons/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import ListBox from "sap/ui/commons/ListBox"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; import Event from "sap/ui/base/Event"; /** * Textfield with list based text completion. * * @since 1.10.0 * @deprecated As of version 1.38. replaced by {@link sap.m.Input}. */ export default class AutoComplete extends ComboBox implements ToolbarItem { __implements__sap_ui_commons_ToolbarItem: boolean; /** * Constructor for a new AutoComplete. * * 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?: $AutoCompleteSettings ); /** * Constructor for a new AutoComplete. * * 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?: $AutoCompleteSettings ); /** * Creates a new subclass of class sap.ui.commons.AutoComplete with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.commons.ComboBox.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.ui.commons.AutoComplete. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:suggest suggest} event of this `sap.ui.commons.AutoComplete`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.AutoComplete` itself. * * Fired when the user has changed the value and a suggestion list update should occur. * * * @returns Reference to `this` in order to allow method chaining */ attachSuggest( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: AutoComplete$SuggestEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.AutoComplete` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:suggest suggest} event of this `sap.ui.commons.AutoComplete`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.AutoComplete` itself. * * Fired when the user has changed the value and a suggestion list update should occur. * * * @returns Reference to `this` in order to allow method chaining */ attachSuggest( /** * The function to be called when the event occurs */ fnFunction: (p1: AutoComplete$SuggestEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.AutoComplete` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:suggest suggest} event of this `sap.ui.commons.AutoComplete`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSuggest( /** * The function to be called, when the event occurs */ fnFunction: (p1: AutoComplete$SuggestEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:suggest suggest} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSuggest( /** * Parameters to pass along with the event */ mParameters?: AutoComplete$SuggestEventParameters ): this; /** * Gets current value of property {@link #getEnableScrolling enableScrolling}. * * Determines whether scrolling should be enabled when the number of items is higher than maxPopupItems. * If set to false only the first n items (n=maxPopupItems) are shown. * * Default value is `true`. * * * @returns Value of property `enableScrolling` */ getEnableScrolling(): boolean; /** * @deprecated As of version 1.10.0. NOT SUPPORTED */ getListBox(): string; /** * @deprecated As of version 1.10.0. NOT SUPPORTED */ getSelectedItemId(): string; /** * @deprecated As of version 1.10.0. NOT SUPPORTED */ getSelectedKey(): string; /** * Sets a new value for property {@link #getEnableScrolling enableScrolling}. * * Determines whether scrolling should be enabled when the number of items is higher than maxPopupItems. * If set to false only the first n items (n=maxPopupItems) are shown. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableScrolling( /** * New value for property `enableScrolling` */ bEnableScrolling?: boolean ): this; /** * Sets a custom filter function for items. Default is to check whether the item text begins with the typed * value. * * Example: ` function(sValue, oItem){ return jQuery.sap.startsWithIgnoreCase(oItem.getText(), sValue); * } ` */ setFilterFunction( /** * The filter function. If not set the default filter function will be used. */ fFilter?: Function ): void; /** * @deprecated As of version 1.10.0. NOT SUPPORTED */ setListBox(oListBox: string | ListBox): this; /** * @deprecated As of version 1.10.0. NOT SUPPORTED */ setSelectedItemId(sSelectedItemId: string): this; /** * @deprecated As of version 1.10.0. NOT SUPPORTED */ setSelectedKey(sSelectedKey: string): this; } /** * Describes the settings that can be provided to the AutoComplete constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.Input}. */ export interface $AutoCompleteSettings extends $ComboBoxSettings { /** * Determines whether scrolling should be enabled when the number of items is higher than maxPopupItems. * If set to false only the first n items (n=maxPopupItems) are shown. */ enableScrolling?: boolean | PropertyBindingInfo | `{${string}}`; /** * Fired when the user has changed the value and a suggestion list update should occur. */ suggest?: (oEvent: AutoComplete$SuggestEvent) => void; } /** * Parameters of the AutoComplete#suggest event. */ export interface AutoComplete$SuggestEventParameters { /** * The current value which was typed in. */ suggestValue?: string; } /** * Event object of the AutoComplete#suggest event. */ export type AutoComplete$SuggestEvent = Event< AutoComplete$SuggestEventParameters, AutoComplete >; } declare module "sap/ui/commons/layout/BorderLayout" { import { CSSSize } from "sap/ui/core/library"; import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { layout } from "sap/ui/commons/library"; import BorderLayoutArea from "sap/ui/commons/layout/BorderLayoutArea"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * The object contains the available parameters for BorderLayout's Area. * * @since 1.110 * @deprecated As of version 1.110. as it is an integral part of the already deprecated {@link sap.ui.commons.BorderLayout}. */ export type BorderLayoutAreaData = { /** * Defines the height or the width. Is not used when the area element is in Center. */ size?: CSSSize; /** * Invisible controls are not rendered. */ visible?: boolean; /** * The overflow mode of the area in horizontal direction as CSS value. */ overflowX?: string; /** * The overflow mode of the area in vertical direction as CSS value. */ overflowY?: string; /** * The content alignment as CSS value. */ contentAlign?: string; }; /** * Based upon the border layout as it comes with the Java standard. Using this layout, you are able to divide * your available UI space into five areas whose sizes can be defined. These areas are: Top: Header; Bottom: * Footer; Begin: Left/right-hand side panel; Center: Content area in the middle; End: Right/left-hand side * panel. * * @deprecated As of version 1.38. replaced by {@link sap.m.Page} */ export default class BorderLayout extends Control { /** * Constructor for a new layout/BorderLayout. * * 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?: $BorderLayoutSettings ); /** * Constructor for a new layout/BorderLayout. * * 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?: $BorderLayoutSettings ); /** * Creates a new subclass of class sap.ui.commons.layout.BorderLayout with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.layout.BorderLayout. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds controls to the specified area. * * * @returns Reference to `this` for method chaining */ addContent( /** * Specifies the area where controls will be added */ sAreaId: | layout.BorderLayoutAreaTypes | keyof typeof layout.BorderLayoutAreaTypes ): this; /** * Creates the specified area and adds the given controls to it. Returns the created area. * * * @returns The created aria */ createArea( /** * Specifies which area will be created. If the area is already available, the method call is ignored. */ sAreaId: | layout.BorderLayoutAreaTypes | keyof typeof layout.BorderLayoutAreaTypes, /** * Any number of controls can be submitted to be added to the newly created area; where each control is * submitted as one argument. */ oContent: Control ): BorderLayoutArea; /** * Destroys the begin in the aggregation {@link #getBegin begin}. * * * @returns Reference to `this` in order to allow method chaining */ destroyBegin(): this; /** * Destroys the bottom in the aggregation {@link #getBottom bottom}. * * * @returns Reference to `this` in order to allow method chaining */ destroyBottom(): this; /** * Destroys the center in the aggregation {@link #getCenter center}. * * * @returns Reference to `this` in order to allow method chaining */ destroyCenter(): this; /** * Destroys the content of the specified area. * * * @returns Reference to `this` for method chaining */ destroyContent( /** * Specifies the area whose content will be destroyed */ sAreaId: | layout.BorderLayoutAreaTypes | keyof typeof layout.BorderLayoutAreaTypes ): this; /** * Destroys the end in the aggregation {@link #getEnd end}. * * * @returns Reference to `this` in order to allow method chaining */ destroyEnd(): this; /** * Destroys the top in the aggregation {@link #getTop top}. * * * @returns Reference to `this` in order to allow method chaining */ destroyTop(): this; /** * Returns the area of the given type. If the area does not exist, it will be created when create is set * to true. * * * @returns The aria */ getArea( /** * The aria ID */ sAreaId: | layout.BorderLayoutAreaTypes | keyof typeof layout.BorderLayoutAreaTypes, /** * Whether the aria must be created */ bCreate: boolean ): BorderLayoutArea; /** * Returns the object of the specified area. If the area does not exist, the area will be created and returned. * * * @returns The aria */ getAreaById( /** * Specifies the area whose object will be returned. */ sAreaId: | layout.BorderLayoutAreaTypes | keyof typeof layout.BorderLayoutAreaTypes ): BorderLayoutArea; /** * Returns a JSON-like object that contains all property values of the requested area. * * * @returns The aria data */ getAreaData( /** * Specifies the area whose data will be returned */ sAreaId: | layout.BorderLayoutAreaTypes | keyof typeof layout.BorderLayoutAreaTypes ): BorderLayoutAreaData; /** * Gets content of aggregation {@link #getBegin begin}. * * Represents the Begin area */ getBegin(): BorderLayoutArea; /** * Gets content of aggregation {@link #getBottom bottom}. * * Represents the Bottom area */ getBottom(): BorderLayoutArea; /** * Gets content of aggregation {@link #getCenter center}. * * Represents the Center area */ getCenter(): BorderLayoutArea; /** * Returns all controls inside the specified area inside an array. * * * @returns The array with the content */ getContent( /** * Specifies the area whose content controls shall be returned. */ sAreaId: | layout.BorderLayoutAreaTypes | keyof typeof layout.BorderLayoutAreaTypes ): Control[]; /** * Gets content of aggregation {@link #getEnd end}. * * Represents the End area */ getEnd(): BorderLayoutArea; /** * Gets current value of property {@link #getHeight height}. * * Defines the overall height of the layout * * Default value is `'100%'`. * * * @returns Value of property `height` */ getHeight(): CSSSize; /** * Gets current value of property {@link #getRtl rtl}. * * The RTL setting swaps the areas Begin and End. * * Default value is `false`. * * @deprecated As of version 1.5.2. replaced by the global configuration for the page * * @returns Value of property `rtl` */ getRtl(): boolean; /** * Gets content of aggregation {@link #getTop top}. * * Represents the Top area */ getTop(): BorderLayoutArea; /** * Gets current value of property {@link #getWidth width}. * * Defines the overall width of the layout * * Default value is `'100%'`. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Determines the index of a given content control. * * * @returns The index of the content */ indexOfContent( /** * Specifies the area that will be searched */ sAreaId: | layout.BorderLayoutAreaTypes | keyof typeof layout.BorderLayoutAreaTypes, /** * Specifies the control whose index will be searched */ oContent: Control ): int; /** * Inserts controls to an area at a given index. * * * @returns Reference to `this` for method chaining */ insertContent( /** * Specifies the area where the controls shall be inserted. */ sAreaId: | layout.BorderLayoutAreaTypes | keyof typeof layout.BorderLayoutAreaTypes, /** * Specifies the index where the controls shall be added. For a negative value of iIndex, the content is * inserted at position '0'; for a value greater than the current size of the aggregation, the content is * inserted at the last position. */ iIndex: int ): this; /** * Removes all content from an area. * * * @returns Reference to `this` for method chaining */ removeAllContent( /** * Specifies the area whose content shall be removed */ sAreaId: | layout.BorderLayoutAreaTypes | keyof typeof layout.BorderLayoutAreaTypes ): this; /** * Removes the content with the given index from an area. * * * @returns Reference to `this` for method chaining */ removeContent( /** * Specifies the area whose content shall be removed */ oAreaId: | layout.BorderLayoutAreaTypes | keyof typeof layout.BorderLayoutAreaTypes, /** * The content to be removed Specifies the control that shall be removed */ vElement: any ): this; /** * Sets the properties of the specified area with the given values. * * * @returns Reference to `this` for method chaining */ setAreaData( /** * Specifies the area whose properties will be set */ sAreaId: | layout.BorderLayoutAreaTypes | keyof typeof layout.BorderLayoutAreaTypes, /** * JSON-like object that contains the values to be set */ oData: BorderLayoutAreaData ): this; /** * Sets the aggregated {@link #getBegin begin}. * * * @returns Reference to `this` in order to allow method chaining */ setBegin( /** * The begin to set */ oBegin: BorderLayoutArea ): this; /** * Sets the aggregated {@link #getBottom bottom}. * * * @returns Reference to `this` in order to allow method chaining */ setBottom( /** * The bottom to set */ oBottom: BorderLayoutArea ): this; /** * Sets the aggregated {@link #getCenter center}. * * * @returns Reference to `this` in order to allow method chaining */ setCenter( /** * The center to set */ oCenter: BorderLayoutArea ): this; /** * Sets the aggregated {@link #getEnd end}. * * * @returns Reference to `this` in order to allow method chaining */ setEnd( /** * The end to set */ oEnd: BorderLayoutArea ): this; /** * Sets a new value for property {@link #getHeight height}. * * Defines the overall height of the layout * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'100%'`. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ sHeight?: CSSSize ): this; /** * Sets a new value for property {@link #getRtl rtl}. * * The RTL setting swaps the areas Begin and End. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @deprecated As of version 1.5.2. replaced by the global configuration for the page * * @returns Reference to `this` in order to allow method chaining */ setRtl( /** * New value for property `rtl` */ bRtl?: boolean ): this; /** * Sets the aggregated {@link #getTop top}. * * * @returns Reference to `this` in order to allow method chaining */ setTop( /** * The top to set */ oTop: BorderLayoutArea ): this; /** * Sets a new value for property {@link #getWidth width}. * * Defines the overall width of the layout * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'100%'`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; } /** * Describes the settings that can be provided to the BorderLayout constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.Page} */ export interface $BorderLayoutSettings extends $ControlSettings { /** * The RTL setting swaps the areas Begin and End. * * @deprecated As of version 1.5.2. replaced by the global configuration for the page */ rtl?: boolean | PropertyBindingInfo | `{${string}}`; /** * Defines the overall width of the layout */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Defines the overall height of the layout */ height?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Represents the Top area */ top?: BorderLayoutArea; /** * Represents the Begin area */ begin?: BorderLayoutArea; /** * Represents the Center area */ center?: BorderLayoutArea; /** * Represents the End area */ end?: BorderLayoutArea; /** * Represents the Bottom area */ bottom?: BorderLayoutArea; } } declare module "sap/ui/commons/Button" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { ToolbarItem, ButtonStyle } from "sap/ui/commons/library"; import { IFormContent, ID, AccessibilityInfo, CSSSize, URI, } from "sap/ui/core/library"; import Event from "sap/ui/base/Event"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Enables users to trigger actions such as save or print. For the button UI, you can define some text or * an icon, or both. * * @deprecated As of version 1.38. replaced by {@link sap.m.Button} */ export default class Button extends Control implements ToolbarItem, IFormContent { __implements__sap_ui_commons_ToolbarItem: boolean; __implements__sap_ui_core_IFormContent: boolean; /** * Constructor for a new Button. * * 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?: $ButtonSettings ); /** * Constructor for a new Button. * * 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?: $ButtonSettings ); /** * Creates a new subclass of class sap.ui.commons.Button with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.Button. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaDescribedBy( /** * The ariaDescribedBy to add; if empty, nothing is inserted */ vAriaDescribedBy: ID | Control ): this; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaLabelledBy( /** * The ariaLabelledBy to add; if empty, nothing is inserted */ vAriaLabelledBy: ID | Control ): this; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.commons.Button`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Button` itself. * * Event is fired when the user presses the control. * * * @returns Reference to `this` in order to allow method chaining */ attachPress( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Button` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.commons.Button`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Button` itself. * * Event is fired when the user presses the control. * * * @returns Reference to `this` in order to allow method chaining */ attachPress( /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Button` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.commons.Button`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachPress( /** * The function to be called, when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:press press} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ firePress( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Puts the focus to the button. */ focus(): void; /** * See: * sap.ui.core.Control#getAccessibilityInfo * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Current accessibility state of the control. */ getAccessibilityInfo(): AccessibilityInfo; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): ID[]; /** * Gets current value of property {@link #getEnabled enabled}. * * Boolean property to enable the control (default is true). Buttons that are disabled have other colors * than enabled ones, depending on custom settings. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getHeight height}. * * Specifies the button height. If this property is set, the height which is specified by the underlying * theme is not used any longer. * * * @returns Value of property `height` */ getHeight(): CSSSize; /** * Gets current value of property {@link #getHelpId helpId}. * * Unique identifier used for help service * * Default value is `empty string`. * * * @returns Value of property `helpId` */ getHelpId(): string; /** * Gets current value of property {@link #getIcon icon}. * * Icon to be displayed as graphical element within the button. This can be a URI to an image or an icon * font URI. * * Default value is `empty string`. * * * @returns Value of property `icon` */ getIcon(): URI; /** * Gets current value of property {@link #getIconFirst iconFirst}. * * If set to true (default), the display sequence is 1. icon 2. control text . * * Default value is `true`. * * * @returns Value of property `iconFirst` */ getIconFirst(): boolean; /** * Gets current value of property {@link #getIconHovered iconHovered}. * * Icon to be displayed as graphical element within the button when it is hovered (only if also a base icon * was specified). If not specified the base icon is used. If an icon font icon is used, this property is * ignored. * * Default value is `empty string`. * * * @returns Value of property `iconHovered` */ getIconHovered(): URI; /** * Gets current value of property {@link #getIconSelected iconSelected}. * * Icon to be displayed as graphical element within the button when it is selected (only if also a base * icon was specified). If not specified the base or hovered icon is used. If an icon font icon is used, * this property is ignored. * * Default value is `empty string`. * * * @returns Value of property `iconSelected` */ getIconSelected(): URI; /** * Gets current value of property {@link #getLite lite}. * * The button is rendered as lite button. * * Default value is `false`. * * * @returns Value of property `lite` */ getLite(): boolean; /** * Gets current value of property {@link #getStyle style}. * * Style of the button. (e.g. emphasized) * * Default value is `Default`. * * * @returns Value of property `style` */ getStyle(): ButtonStyle; /** * Gets current value of property {@link #getStyled styled}. * * Indicates if the button is styled. If not it is rendered as native HTML-button. In this case a custom * styling can be added usig addStyleClass. * * Default value is `true`. * * * @returns Value of property `styled` */ getStyled(): boolean; /** * Gets current value of property {@link #getText text}. * * Button text displayed at runtime. * * Default value is `empty string`. * * * @returns Value of property `text` */ getText(): string; /** * Gets current value of property {@link #getWidth width}. * * Control width as common CSS-size (px or % as unit, for example) * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaDescribedBy(): ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): ID[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns The removed ariaDescribedBy or `null` */ removeAriaDescribedBy( /** * The ariaDescribedBy to be removed or its index or ID */ vAriaDescribedBy: int | ID | Control ): ID | null; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns The removed ariaLabelledBy or `null` */ removeAriaLabelledBy( /** * The ariaLabelledBy to be removed or its index or ID */ vAriaLabelledBy: int | ID | Control ): ID | null; /** * Sets a new value for property {@link #getEnabled enabled}. * * Boolean property to enable the control (default is true). Buttons that are disabled have other colors * than enabled ones, depending on custom settings. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getHeight height}. * * Specifies the button height. If this property is set, the height which is specified by the underlying * theme is not used any longer. * * 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 */ setHeight( /** * New value for property `height` */ sHeight?: CSSSize ): this; /** * Sets a new value for property {@link #getHelpId helpId}. * * Unique identifier used for help service * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setHelpId( /** * New value for property `helpId` */ sHelpId?: string ): this; /** * Sets a new value for property {@link #getIcon icon}. * * Icon to be displayed as graphical element within the button. This can be a URI to an image or an icon * font URI. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setIcon( /** * New value for property `icon` */ sIcon?: URI ): this; /** * Sets a new value for property {@link #getIconFirst iconFirst}. * * If set to true (default), the display sequence is 1. icon 2. control text . * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setIconFirst( /** * New value for property `iconFirst` */ bIconFirst?: boolean ): this; /** * Sets a new value for property {@link #getIconHovered iconHovered}. * * Icon to be displayed as graphical element within the button when it is hovered (only if also a base icon * was specified). If not specified the base icon is used. If an icon font icon is used, this property is * ignored. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setIconHovered( /** * New value for property `iconHovered` */ sIconHovered?: URI ): this; /** * Sets a new value for property {@link #getIconSelected iconSelected}. * * Icon to be displayed as graphical element within the button when it is selected (only if also a base * icon was specified). If not specified the base or hovered icon is used. If an icon font icon is used, * this property is ignored. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setIconSelected( /** * New value for property `iconSelected` */ sIconSelected?: URI ): this; /** * Sets a new value for property {@link #getLite lite}. * * The button is rendered as lite button. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setLite( /** * New value for property `lite` */ bLite?: boolean ): this; /** * Sets a new value for property {@link #getStyle style}. * * Style of the button. (e.g. emphasized) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Default`. * * * @returns Reference to `this` in order to allow method chaining */ setStyle( /** * New value for property `style` */ sStyle?: ButtonStyle | keyof typeof ButtonStyle ): this; /** * Sets a new value for property {@link #getStyled styled}. * * Indicates if the button is styled. If not it is rendered as native HTML-button. In this case a custom * styling can be added usig addStyleClass. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setStyled( /** * New value for property `styled` */ bStyled?: boolean ): this; /** * Sets a new value for property {@link #getText text}. * * Button text displayed at runtime. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setText( /** * New value for property `text` */ sText?: string ): this; /** * Sets a new value for property {@link #getWidth width}. * * Control width as common CSS-size (px or % as unit, for example) * * 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 */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; } /** * Describes the settings that can be provided to the Button constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.Button} */ export interface $ButtonSettings extends $ControlSettings { /** * Button text displayed at runtime. */ text?: string | PropertyBindingInfo; /** * Boolean property to enable the control (default is true). Buttons that are disabled have other colors * than enabled ones, depending on custom settings. */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * Control width as common CSS-size (px or % as unit, for example) */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Unique identifier used for help service */ helpId?: string | PropertyBindingInfo; /** * Icon to be displayed as graphical element within the button. This can be a URI to an image or an icon * font URI. */ icon?: URI | PropertyBindingInfo | `{${string}}`; /** * Icon to be displayed as graphical element within the button when it is hovered (only if also a base icon * was specified). If not specified the base icon is used. If an icon font icon is used, this property is * ignored. */ iconHovered?: URI | PropertyBindingInfo | `{${string}}`; /** * Icon to be displayed as graphical element within the button when it is selected (only if also a base * icon was specified). If not specified the base or hovered icon is used. If an icon font icon is used, * this property is ignored. */ iconSelected?: URI | PropertyBindingInfo | `{${string}}`; /** * If set to true (default), the display sequence is 1. icon 2. control text . */ iconFirst?: boolean | PropertyBindingInfo | `{${string}}`; /** * Specifies the button height. If this property is set, the height which is specified by the underlying * theme is not used any longer. */ height?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Indicates if the button is styled. If not it is rendered as native HTML-button. In this case a custom * styling can be added usig addStyleClass. */ styled?: boolean | PropertyBindingInfo | `{${string}}`; /** * The button is rendered as lite button. */ lite?: boolean | PropertyBindingInfo | `{${string}}`; /** * Style of the button. (e.g. emphasized) */ style?: | (ButtonStyle | keyof typeof ButtonStyle) | PropertyBindingInfo | `{${string}}`; /** * Association to controls / ids which describe this control (see WAI-ARIA attribute aria-describedby). */ ariaDescribedBy?: Array; /** * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby). */ ariaLabelledBy?: Array; /** * Event is fired when the user presses the control. */ press?: (oEvent: Event) => void; } /** * Parameters of the Button#press event. */ export interface Button$PressEventParameters {} /** * Event object of the Button#press event. */ export type Button$PressEvent = Event; } declare module "sap/ui/commons/Callout" { import { default as CalloutBase, $CalloutBaseSettings, } from "sap/ui/commons/CalloutBase"; import Control from "sap/ui/core/Control"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { AggregationBindingInfo } from "sap/ui/base/ManagedObject"; /** * Callout is a small popup with some useful information and links that is shown when a mouse is hovered * over a specific view element. * * @deprecated As of version 1.38. If you want to achieve a similar behavior, use a `sap.m.Popover` control * and open it next to your control. */ export default class Callout extends CalloutBase { /** * Constructor for a new Callout. * * 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?: $CalloutSettings ); /** * Constructor for a new Callout. * * 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?: $CalloutSettings ); /** * Creates a new subclass of class sap.ui.commons.Callout with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.commons.CalloutBase.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.ui.commons.Callout. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some content to the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ addContent( /** * The content to add; if empty, nothing is inserted */ oContent: Control ): this; /** * Destroys all the content in the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Gets content of aggregation {@link #getContent content}. * * Determines the content of the Callout */ getContent(): Control[]; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContent( /** * The content whose index is looked for */ oContent: Control ): int; /** * Inserts a content into the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ insertContent( /** * The content to insert; if empty, nothing is inserted */ oContent: Control, /** * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content * is inserted at position 0; for a value greater than the current size of the aggregation, the content * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getContent content}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllContent(): Control[]; /** * Removes a content from the aggregation {@link #getContent content}. * * * @returns The removed content or `null` */ removeContent( /** * The content to remove or its index or id */ vContent: int | string | Control ): Control | null; } /** * Describes the settings that can be provided to the Callout constructor. * * @deprecated As of version 1.38. If you want to achieve a similar behavior, use a `sap.m.Popover` control * and open it next to your control. */ export interface $CalloutSettings extends $CalloutBaseSettings { /** * Determines the content of the Callout */ content?: Control[] | Control | AggregationBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/CalloutBase" { import { default as TooltipBase, $TooltipBaseSettings, } from "sap/ui/core/TooltipBase"; import Event from "sap/ui/base/Event"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { Dock } from "sap/ui/core/library"; import Control from "sap/ui/core/Control"; /** * CalloutBase is a building block for Callout. Do not use it directly. Use the Callout control instead * * @deprecated As of version 1.38. If you want to achieve a similar behavior, use the `sap.m.Popover` control * and open it next to your control. */ export default class CalloutBase extends TooltipBase { /** * Constructor for a new CalloutBase. * * 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?: $CalloutBaseSettings ); /** * Constructor for a new CalloutBase. * * 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?: $CalloutBaseSettings ); /** * Creates a new subclass of class sap.ui.commons.CalloutBase with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.TooltipBase.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.ui.commons.CalloutBase. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adjust position of the already opened Callout window. Call this method each time when the size of the * opened Callout window may be changed due to new or changed contents. */ adjustPosition(): void; /** * Attaches event handler `fnFunction` to the {@link #event:beforeOpen beforeOpen} event of this `sap.ui.commons.CalloutBase`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.CalloutBase` itself. * * Event is fired before a Callout is displayed. Call the preventDefault method of the event object to postpone * opening. Application may use this event to start asynchronous Ajax call to load the Callout content * * * @returns Reference to `this` in order to allow method chaining */ attachBeforeOpen( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: CalloutBase$BeforeOpenEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.CalloutBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeOpen beforeOpen} event of this `sap.ui.commons.CalloutBase`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.CalloutBase` itself. * * Event is fired before a Callout is displayed. Call the preventDefault method of the event object to postpone * opening. Application may use this event to start asynchronous Ajax call to load the Callout content * * * @returns Reference to `this` in order to allow method chaining */ attachBeforeOpen( /** * The function to be called when the event occurs */ fnFunction: (p1: CalloutBase$BeforeOpenEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.CalloutBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:close close} event of this `sap.ui.commons.CalloutBase`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.CalloutBase` itself. * * Event is fired when the Callout window is closed. * * * @returns Reference to `this` in order to allow method chaining */ attachClose( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.CalloutBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:close close} event of this `sap.ui.commons.CalloutBase`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.CalloutBase` itself. * * Event is fired when the Callout window is closed. * * * @returns Reference to `this` in order to allow method chaining */ attachClose( /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.CalloutBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:open open} event of this `sap.ui.commons.CalloutBase`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.CalloutBase` itself. * * The event is fired when the popup is opened. * * * @returns Reference to `this` in order to allow method chaining */ attachOpen( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: CalloutBase$OpenEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.CalloutBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:open open} event of this `sap.ui.commons.CalloutBase`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.CalloutBase` itself. * * The event is fired when the popup is opened. * * * @returns Reference to `this` in order to allow method chaining */ attachOpen( /** * The function to be called when the event occurs */ fnFunction: (p1: CalloutBase$OpenEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.CalloutBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:opened opened} event of this `sap.ui.commons.CalloutBase`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.CalloutBase` itself. * * Is fired when the Callout has been opened * * @since 1.11.0 * * @returns Reference to `this` in order to allow method chaining */ attachOpened( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.CalloutBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:opened opened} event of this `sap.ui.commons.CalloutBase`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.CalloutBase` itself. * * Is fired when the Callout has been opened * * @since 1.11.0 * * @returns Reference to `this` in order to allow method chaining */ attachOpened( /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.CalloutBase` itself */ oListener?: object ): this; /** * Closes Callout */ close(): void; /** * Detaches event handler `fnFunction` from the {@link #event:beforeOpen beforeOpen} event of this `sap.ui.commons.CalloutBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachBeforeOpen( /** * The function to be called, when the event occurs */ fnFunction: (p1: CalloutBase$BeforeOpenEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:close close} event of this `sap.ui.commons.CalloutBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachClose( /** * The function to be called, when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:open open} event of this `sap.ui.commons.CalloutBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachOpen( /** * The function to be called, when the event occurs */ fnFunction: (p1: CalloutBase$OpenEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:opened opened} event of this `sap.ui.commons.CalloutBase`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.11.0 * * @returns Reference to `this` in order to allow method chaining */ detachOpened( /** * The function to be called, when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:beforeOpen beforeOpen} to attached listeners. * * Listeners may prevent the default action of this event by calling the `preventDefault` method on the * event object. The return value of this method indicates whether the default action should be executed. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Whether or not to prevent the default action */ fireBeforeOpen( /** * Parameters to pass along with the event */ mParameters?: CalloutBase$BeforeOpenEventParameters ): boolean; /** * Fires event {@link #event:close close} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireClose( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:open open} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireOpen( /** * Parameters to pass along with the event */ mParameters?: CalloutBase$OpenEventParameters ): this; /** * Fires event {@link #event:opened opened} to attached listeners. * * @since 1.11.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireOpened( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Set position of the Callout window relative to the parent control. This function automatically calculates * and sets the correct offset, use it instead of `setMyPosition/setAtPosition`. * * * @returns `this` to allow method chaining */ setPosition( /** * docking position of the Callout */ myPosition: Dock, /** * docking position of the parent control */ atPosition: Dock ): this; } /** * Describes the settings that can be provided to the CalloutBase constructor. * * @deprecated As of version 1.38. If you want to achieve a similar behavior, use the `sap.m.Popover` control * and open it next to your control. */ export interface $CalloutBaseSettings extends $TooltipBaseSettings { /** * The event is fired when the popup is opened. */ open?: (oEvent: CalloutBase$OpenEvent) => void; /** * Event is fired when the Callout window is closed. */ close?: (oEvent: Event) => void; /** * Event is fired before a Callout is displayed. Call the preventDefault method of the event object to postpone * opening. Application may use this event to start asynchronous Ajax call to load the Callout content */ beforeOpen?: (oEvent: CalloutBase$BeforeOpenEvent) => void; /** * Is fired when the Callout has been opened * * @since 1.11.0 */ opened?: (oEvent: Event) => void; } /** * Parameters of the CalloutBase#beforeOpen event. */ export interface CalloutBase$BeforeOpenEventParameters { /** * Parent control that has this Callout as a tooltip */ parent?: Control; } /** * Event object of the CalloutBase#beforeOpen event. */ export type CalloutBase$BeforeOpenEvent = Event< CalloutBase$BeforeOpenEventParameters, CalloutBase >; /** * Parameters of the CalloutBase#close event. */ export interface CalloutBase$CloseEventParameters {} /** * Event object of the CalloutBase#close event. */ export type CalloutBase$CloseEvent = Event< CalloutBase$CloseEventParameters, CalloutBase >; /** * Parameters of the CalloutBase#open event. */ export interface CalloutBase$OpenEventParameters { /** * Parent control that has this Callout as a tooltip */ parent?: Control; } /** * Event object of the CalloutBase#open event. */ export type CalloutBase$OpenEvent = Event< CalloutBase$OpenEventParameters, CalloutBase >; /** * Parameters of the CalloutBase#opened event. */ export interface CalloutBase$OpenedEventParameters {} /** * Event object of the CalloutBase#opened event. */ export type CalloutBase$OpenedEvent = Event< CalloutBase$OpenedEventParameters, CalloutBase >; } declare module "sap/ui/commons/Carousel" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { AggregationBindingInfo, PropertyBindingInfo, } from "sap/ui/base/ManagedObject"; import { CSSSize } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { enums } from "sap/ui/commons/library"; /** * Carousel holds multiple controls and displays them vertically or horizontally next to each other. You * can define how many content items should be displayed at once or let the Carousel determine that for * you. Navigation is done through buttons or keys. * * @since 1.8.0 * @deprecated As of version 1.38. Instead, use the `sap.m.Carousel` control. */ export default class Carousel extends Control { /** * Constructor for a new Carousel. * * 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?: $CarouselSettings ); /** * Constructor for a new Carousel. * * 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?: $CarouselSettings ); /** * Creates a new subclass of class sap.ui.commons.Carousel with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.Carousel. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some content to the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ addContent( /** * The content to add; if empty, nothing is inserted */ oContent: Control ): this; /** * Binds aggregation {@link #getContent content} to model data. * * See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description * of the possible properties of `oBindingInfo`. * * * @returns Reference to `this` in order to allow method chaining */ bindContent( /** * The binding information */ oBindingInfo: AggregationBindingInfo ): this; /** * Calculates and sets the size of the carousel, its items and its buttons */ calculateAndSetSize(): void; /** * Destroys all the content in the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Gets current value of property {@link #getAnimationDuration animationDuration}. * * Duration for animation when navigating through the contents of the Carousel * * Default value is `500`. * * * @returns Value of property `animationDuration` */ getAnimationDuration(): int; /** * Gets content of aggregation {@link #getContent content}. * * Controls which are displayed inside the Carousel */ getContent(): Control[]; /** * Gets current value of property {@link #getDefaultItemHeight defaultItemHeight}. * * Default height of the item in a carousel if no height can be determined * * Default value is `150`. * * * @returns Value of property `defaultItemHeight` */ getDefaultItemHeight(): int; /** * Gets current value of property {@link #getDefaultItemWidth defaultItemWidth}. * * Default width of the item in a carousel if no height can be determined * * Default value is `150`. * * * @returns Value of property `defaultItemWidth` */ getDefaultItemWidth(): int; /** * Gets current value of property {@link #getFirstVisibleIndex firstVisibleIndex}. * * The index of the element in the content aggreation which is displayed first on rendering * * Default value is `0`. * * @since 1.11.0 * * @returns Value of property `firstVisibleIndex` */ getFirstVisibleIndex(): int; /** * Returns the DOM Element that should get the focus. * * To be overwritten by the specific control method. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Returns the DOM Element that should get the focus */ getFocusDomRef(): Element; /** * Gets current value of property {@link #getHandleSize handleSize}. * * Determines the size of the handle in pixels. (Height for vertical carousel, width for horizontal carousel) * * Default value is `22`. * * * @returns Value of property `handleSize` */ getHandleSize(): int; /** * Gets current value of property {@link #getHeight height}. * * Determines the height of the Carousel * * * @returns Value of property `height` */ getHeight(): CSSSize; /** * Gets current value of property {@link #getOrientation orientation}. * * Determines the orientation of the Carousel. Can be either "horizontal" or "vertical" * * Default value is `horizontal`. * * * @returns Value of property `orientation` */ getOrientation(): enums.Orientation; /** * Gets current value of property {@link #getVisibleItems visibleItems}. * * If defined, the carousel displays the number of items defined. Items will be resized to fit the area. * * * @returns Value of property `visibleItems` */ getVisibleItems(): int; /** * Gets current value of property {@link #getWidth width}. * * Determines the width of the Carousel * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContent( /** * The content whose index is looked for */ oContent: Control ): int; /** * Inserts a content into the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ insertContent( /** * The content to insert; if empty, nothing is inserted */ oContent: Control, /** * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content * is inserted at position 0; for a value greater than the current size of the aggregation, the content * is inserted at the last position */ iIndex: int ): this; /** * If the device supports touch gestures and left swipe is triggered shows the next carousel item */ onswipeleft(oEvent: jQuery.Event): void; /** * If the device supports touch gestures and right swipe is triggered shows the previous carousel item */ onswiperight(oEvent: jQuery.Event): void; /** * Removes all the controls from the aggregation {@link #getContent content}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllContent(): Control[]; /** * Removes a content from the aggregation {@link #getContent content}. * * * @returns The removed content or `null` */ removeContent( /** * The content to remove or its index or id */ vContent: int | string | Control ): Control | null; /** * Sets a new value for property {@link #getAnimationDuration animationDuration}. * * Duration for animation when navigating through the contents of the Carousel * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `500`. * * * @returns Reference to `this` in order to allow method chaining */ setAnimationDuration( /** * New value for property `animationDuration` */ iAnimationDuration?: int ): this; /** * Sets a new value for property {@link #getDefaultItemHeight defaultItemHeight}. * * Default height of the item in a carousel if no height can be determined * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `150`. * * * @returns Reference to `this` in order to allow method chaining */ setDefaultItemHeight( /** * New value for property `defaultItemHeight` */ iDefaultItemHeight?: int ): this; /** * Sets a new value for property {@link #getDefaultItemWidth defaultItemWidth}. * * Default width of the item in a carousel if no height can be determined * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `150`. * * * @returns Reference to `this` in order to allow method chaining */ setDefaultItemWidth( /** * New value for property `defaultItemWidth` */ iDefaultItemWidth?: int ): this; /** * Setter for property `firstVisibleIndex`. * * Default value is `0` * * @since 1.11.0 * * @returns `this` to allow method chaining */ setFirstVisibleIndex( /** * new value for property `firstVisibleIndex` */ iFirstVisibleIndex: int ): this; /** * Sets a new value for property {@link #getHandleSize handleSize}. * * Determines the size of the handle in pixels. (Height for vertical carousel, width for horizontal carousel) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `22`. * * * @returns Reference to `this` in order to allow method chaining */ setHandleSize( /** * New value for property `handleSize` */ iHandleSize?: int ): this; /** * Sets a new value for property {@link #getHeight height}. * * Determines the height of the Carousel * * 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 */ setHeight( /** * New value for property `height` */ sHeight?: CSSSize ): this; /** * Sets a new value for property {@link #getOrientation orientation}. * * Determines the orientation of the Carousel. Can be either "horizontal" or "vertical" * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `horizontal`. * * * @returns Reference to `this` in order to allow method chaining */ setOrientation( /** * New value for property `orientation` */ sOrientation?: enums.Orientation | keyof typeof enums.Orientation ): this; /** * Sets a new value for property {@link #getVisibleItems visibleItems}. * * If defined, the carousel displays the number of items defined. Items will be resized to fit the area. * * 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 */ setVisibleItems( /** * New value for property `visibleItems` */ iVisibleItems?: int ): this; /** * Sets a new value for property {@link #getWidth width}. * * Determines the width of the Carousel * * 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 */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; /** * Shows the element with the specified Id. This can be only used after the component is rendered. */ showElementWithId( /** * Id of the element to slide to. */ sElementId: string ): void; /** * Shows the next item in carousel. This can be only used after the component is rendered. */ showNext(): void; /** * Shows the previous item in carousel. This can be only used after the component is rendered. */ showPrevious(): void; /** * Unbinds aggregation {@link #getContent content} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindContent(): this; } /** * Describes the settings that can be provided to the Carousel constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.Carousel` control. */ export interface $CarouselSettings extends $ControlSettings { /** * Determines the orientation of the Carousel. Can be either "horizontal" or "vertical" */ orientation?: | (enums.Orientation | keyof typeof enums.Orientation) | PropertyBindingInfo | `{${string}}`; /** * Determines the width of the Carousel */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Determines the height of the Carousel */ height?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Default height of the item in a carousel if no height can be determined */ defaultItemHeight?: int | PropertyBindingInfo | `{${string}}`; /** * Default width of the item in a carousel if no height can be determined */ defaultItemWidth?: int | PropertyBindingInfo | `{${string}}`; /** * Duration for animation when navigating through the contents of the Carousel */ animationDuration?: int | PropertyBindingInfo | `{${string}}`; /** * If defined, the carousel displays the number of items defined. Items will be resized to fit the area. */ visibleItems?: int | PropertyBindingInfo | `{${string}}`; /** * Determines the size of the handle in pixels. (Height for vertical carousel, width for horizontal carousel) */ handleSize?: int | PropertyBindingInfo | `{${string}}`; /** * The index of the element in the content aggreation which is displayed first on rendering * * @since 1.11.0 */ firstVisibleIndex?: int | PropertyBindingInfo | `{${string}}`; /** * Controls which are displayed inside the Carousel */ content?: Control[] | Control | AggregationBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/CheckBox" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { IFormContent, ID, AccessibilityInfo, TextDirection, ValueState, CSSSize, } from "sap/ui/core/library"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import Event from "sap/ui/base/Event"; /** * Provides a box which can be flagged, the box has a label. A check box can either stand alone, or in a * group with other check boxes. As an option, the boxes can initially be set to status 'Not Editable'. * * @deprecated As of version 1.38. Instead, use the `sap.m.CheckBox` control. */ export default class CheckBox extends Control implements IFormContent { __implements__sap_ui_core_IFormContent: boolean; /** * Constructor for a new CheckBox. * * 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?: $CheckBoxSettings ); /** * Constructor for a new CheckBox. * * 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?: $CheckBoxSettings ); /** * Creates a new subclass of class sap.ui.commons.CheckBox with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.CheckBox. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaDescribedBy( /** * The ariaDescribedBy to add; if empty, nothing is inserted */ vAriaDescribedBy: ID | Control ): this; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaLabelledBy( /** * The ariaLabelledBy to add; if empty, nothing is inserted */ vAriaLabelledBy: ID | Control ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.commons.CheckBox`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.CheckBox` itself. * * Event is triggered when the control status is changed by the user by flagging or unflagging the checkbox. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: CheckBox$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.CheckBox` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.commons.CheckBox`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.CheckBox` itself. * * Event is triggered when the control status is changed by the user by flagging or unflagging the checkbox. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * The function to be called when the event occurs */ fnFunction: (p1: CheckBox$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.CheckBox` itself */ oListener?: object ): this; /** * Binds property {@link #getChecked checked} to model data. * * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description * of the possible properties of `oBindingInfo` * * * @returns Reference to `this` in order to allow method chaining */ bindChecked( /** * The binding information */ oBindingInfo: PropertyBindingInfo ): this; /** * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.commons.CheckBox`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: CheckBox$ChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:change change} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireChange( /** * Parameters to pass along with the event */ mParameters?: CheckBox$ChangeEventParameters ): this; /** * See: * sap.ui.core.Control#getAccessibilityInfo * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns The object contains the accessibility information of `sap.ui.commons.CheckBox` */ getAccessibilityInfo(): AccessibilityInfo; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): ID[]; /** * Gets current value of property {@link #getChecked checked}. * * Contains the state of the control whether it is flagged with a check mark, or not * * Default value is `false`. * * * @returns Value of property `checked` */ getChecked(): boolean; /** * Gets current value of property {@link #getEditable editable}. * * Specifies whether the user shall be allowed to select the check box. * * Default value is `true`. * * * @returns Value of property `editable` */ getEditable(): boolean; /** * Gets current value of property {@link #getEnabled enabled}. * * Using this property, the control could be disabled, if required. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getName name}. * * The 'name' property to be used in the HTML code, for example for HTML forms that send data to the server * via submit. * * * @returns Value of property `name` */ getName(): string; /** * Gets current value of property {@link #getText text}. * * Defines the text displayed next to the check box * * * @returns Value of property `text` */ getText(): string; /** * Gets current value of property {@link #getTextDirection textDirection}. * * The value can be set to LTR or RTL. Otherwise, the control inherits the text direction from its parent * control. * * Default value is `Inherit`. * * * @returns Value of property `textDirection` */ getTextDirection(): TextDirection; /** * Gets current value of property {@link #getValueState valueState}. * * Accepts the core enumeration ValueState.type that supports 'None', 'Error', 'Warning' and 'Success'. * * Default value is `None`. * * * @returns Value of property `valueState` */ getValueState(): ValueState; /** * Gets current value of property {@link #getWidth width}. * * The width can be set to an absolute value. If no value is set, the control width results from the text * length. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaDescribedBy(): ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): ID[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns The removed ariaDescribedBy or `null` */ removeAriaDescribedBy( /** * The ariaDescribedBy to be removed or its index or ID */ vAriaDescribedBy: int | ID | Control ): ID | null; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns The removed ariaLabelledBy or `null` */ removeAriaLabelledBy( /** * The ariaLabelledBy to be removed or its index or ID */ vAriaLabelledBy: int | ID | Control ): ID | null; /** * Sets a new value for property {@link #getChecked checked}. * * Contains the state of the control whether it is flagged with a check mark, or not * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setChecked( /** * New value for property `checked` */ bChecked?: boolean ): this; /** * Sets a new value for property {@link #getEditable editable}. * * Specifies whether the user shall be allowed to select the check box. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEditable( /** * New value for property `editable` */ bEditable?: boolean ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * Using this property, the control could be disabled, if required. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getName name}. * * The 'name' property to be used in the HTML code, for example for HTML forms that send data to the server * via submit. * * 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 */ setName( /** * New value for property `name` */ sName?: string ): this; /** * Sets a new value for property {@link #getText text}. * * Defines the text displayed next to the check box * * 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; /** * Sets a new value for property {@link #getTextDirection textDirection}. * * The value can be set to LTR or RTL. Otherwise, the control inherits the text direction from its parent * control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Inherit`. * * * @returns Reference to `this` in order to allow method chaining */ setTextDirection( /** * New value for property `textDirection` */ sTextDirection?: TextDirection | keyof typeof TextDirection ): this; /** * Sets a new value for property {@link #getValueState valueState}. * * Accepts the core enumeration ValueState.type that supports 'None', 'Error', 'Warning' and 'Success'. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `None`. * * * @returns Reference to `this` in order to allow method chaining */ setValueState( /** * New value for property `valueState` */ sValueState?: ValueState | keyof typeof ValueState ): this; /** * Sets a new value for property {@link #getWidth width}. * * The width can be set to an absolute value. If no value is set, the control width results from the text * length. * * 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 */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; /** * Inverts the current value of the control. */ toggle(): this; /** * Unbinds property {@link #getChecked checked} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindChecked(): this; } /** * Describes the settings that can be provided to the CheckBox constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.CheckBox` control. */ export interface $CheckBoxSettings extends $ControlSettings { /** * Contains the state of the control whether it is flagged with a check mark, or not */ checked?: boolean | PropertyBindingInfo | `{${string}}`; /** * Defines the text displayed next to the check box */ text?: string | PropertyBindingInfo; /** * Using this property, the control could be disabled, if required. */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * Specifies whether the user shall be allowed to select the check box. */ editable?: boolean | PropertyBindingInfo | `{${string}}`; /** * Accepts the core enumeration ValueState.type that supports 'None', 'Error', 'Warning' and 'Success'. */ valueState?: | (ValueState | keyof typeof ValueState) | PropertyBindingInfo | `{${string}}`; /** * The width can be set to an absolute value. If no value is set, the control width results from the text * length. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * The value can be set to LTR or RTL. Otherwise, the control inherits the text direction from its parent * control. */ textDirection?: | (TextDirection | keyof typeof TextDirection) | PropertyBindingInfo | `{${string}}`; /** * The 'name' property to be used in the HTML code, for example for HTML forms that send data to the server * via submit. */ name?: string | PropertyBindingInfo; /** * Association to controls / ids which describe this control (see WAI-ARIA attribute aria-describedby). */ ariaDescribedBy?: Array; /** * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby). */ ariaLabelledBy?: Array; /** * Event is triggered when the control status is changed by the user by flagging or unflagging the checkbox. */ change?: (oEvent: CheckBox$ChangeEvent) => void; } /** * Parameters of the CheckBox#change event. */ export interface CheckBox$ChangeEventParameters { /** * Checks whether the box is flagged or not flagged. */ checked?: boolean; } /** * Event object of the CheckBox#change event. */ export type CheckBox$ChangeEvent = Event< CheckBox$ChangeEventParameters, CheckBox >; } declare module "sap/ui/commons/ColorPicker" { import { default as ColorPicker1, $ColorPickerSettings as $ColorPickerSettings1, } from "sap/ui/unified/ColorPicker"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * This control gives the user the opportunity to choose a color. The color can be defined using HEX-, RGB- * or HSV-values or a CSS colorname. * * @deprecated As of version 1.38. replaced by {@link sap.ui.unified.ColorPicker} */ export default class ColorPicker extends ColorPicker1 { /** * Constructor for a new ColorPicker. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.unified.ColorPicker#constructor sap.ui.unified.ColorPicker } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: $ColorPickerSettings ); /** * Constructor for a new ColorPicker. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.unified.ColorPicker#constructor sap.ui.unified.ColorPicker } * can be used. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: $ColorPickerSettings ); /** * Creates a new subclass of class sap.ui.commons.ColorPicker with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.unified.ColorPicker.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.ui.commons.ColorPicker. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; } /** * Describes the settings that can be provided to the ColorPicker constructor. * * @deprecated As of version 1.38. replaced by {@link sap.ui.unified.ColorPicker} */ export interface $ColorPickerSettings extends $ColorPickerSettings1 {} } declare module "sap/ui/commons/ComboBox" { import { default as TextField, $TextFieldSettings, TextField$ChangeEventParameters, } from "sap/ui/commons/TextField"; import { ToolbarItem } from "sap/ui/commons/library"; import ListItem from "sap/ui/core/ListItem"; import { AggregationBindingInfo, PropertyBindingInfo, } from "sap/ui/base/ManagedObject"; import { AccessibilityInfo, ID } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import ListBox from "sap/ui/commons/ListBox"; import Event from "sap/ui/base/Event"; /** * The control provides a field that allows end users to either enter some text, or to choose an entry out * of a list of pre-defined items. The choosable items can be provided in the form of a complete `ListBox`, * single `ListItems`. * * @deprecated As of version 1.38. replaced by {@link sap.m.ComboBox} */ export default class ComboBox extends TextField implements ToolbarItem { __implements__sap_ui_commons_ToolbarItem: boolean; /** * Constructor for a new ComboBox. * * 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?: $ComboBoxSettings ); /** * Constructor for a new ComboBox. * * 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?: $ComboBoxSettings ); /** * Creates a new subclass of class sap.ui.commons.ComboBox with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.commons.TextField.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.ui.commons.ComboBox. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Compares the previous value with the current value and fires the "Change" event if the ComboBox is editable * and the value has changed or whether the value has been changed e.g. via up/down or auto-complete feature * * @ui5-protected Do not call from applications (only from related classes in the framework) */ _checkChange( /** * The event object. */ oEvent: jQuery.Event, /** * indicate whether the check should happen immediately or delayed (e.g. to avoid focusout / click double * event processing) */ bImmediate?: boolean ): void; /** * Adds some item to the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ addItem( /** * The item to add; if empty, nothing is inserted */ oItem: ListItem ): this; /** * Binds aggregation {@link #getItems items} to model data. * * See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description * of the possible properties of `oBindingInfo`. * * * @returns Reference to `this` in order to allow method chaining */ bindItems( /** * The binding information */ oBindingInfo: AggregationBindingInfo ): this; /** * Destroys all the items in the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ destroyItems(): this; /** * Fire event change to attached listeners. * * Expects following event parameters: * - 'newValue' of type `string` The new / changed value of the textfield. * - 'selectedItem' of type `sap.ui.core.ListItem` selected item * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns `this` to allow method chaining */ fireChange( /** * the arguments to pass along with the event. */ mArguments?: object ): this; /** * See: * sap.ui.core.Control#getAccessibilityInfo * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns The accessibility info */ getAccessibilityInfo(): AccessibilityInfo; /** * Gets current value of property {@link #getDisplaySecondaryValues displaySecondaryValues}. * * Indicates whether the `additionalText` property that is available for `sap.ui.core.ListItem` shall be * displayed in the list. * * Default value is `false`. * * * @returns Value of property `displaySecondaryValues` */ getDisplaySecondaryValues(): boolean; /** * Returns the DOM element which represents the icon for value help. Could be overwritten in child-classes. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns The F4-element's DOM reference or `null` */ getF4ButtonDomRef(): Element | null; /** * Gets content of aggregation {@link #getItems items}. * * `ListItems` (see `sap.ui.core.ListBox`) that shall be displayed in the list. */ getItems(): ListItem[]; /** * ID of the element which is the current target of the association {@link #getListBox listBox}, or `null`. */ getListBox(): ID | null; /** * Gets current value of property {@link #getMaxPopupItems maxPopupItems}. * * Defines the number of items that shall be displayed at once. If the overall number of items is higher * than this setting, a scrollbar is provided. * * Default value is `10`. * * * @returns Value of property `maxPopupItems` */ getMaxPopupItems(): int; /** * Gets current value of property {@link #getSelectedItemId selectedItemId}. * * Id of the selected item. If the value has no corresponding item, the `selectedItemId` is empty. * * If the `selectedItemId` is set to a not existing item, it will not be changed. * * * @returns Value of property `selectedItemId` */ getSelectedItemId(): string; /** * Gets current value of property {@link #getSelectedKey selectedKey}. * * Key of the selected item. * * If the value has no corresponding item the key is empty. * * If duplicate keys exists the first item matching the key is used. * * If the key is set to a not existing value it will not be changed. * * * @returns Value of property `selectedKey` */ getSelectedKey(): string; /** * Checks for the provided `sap.ui.core.ListItem` in the aggregation {@link #getItems items}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfItem( /** * The item whose index is looked for */ oItem: ListItem ): int; /** * Inserts a item into the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ insertItem( /** * The item to insert; if empty, nothing is inserted */ oItem: ListItem, /** * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted * at position 0; for a value greater than the current size of the aggregation, the item is inserted at * the last position */ iIndex: int ): this; /** * Handle sapenter pseudo events on the control * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onsapenter( /** * The event object. */ oEvent: jQuery.Event ): void; /** * Handle sapescape pseudo events on the control * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onsapescape( /** * The event object. */ oEvent: jQuery.Event ): void; /** * Handle saphide pseudo events on the control * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onsaphide( /** * The event object. */ oEvent: jQuery.Event ): void; /** * Handle sapnextmodifiers pseudo events on the control if in toolbar prevent item navigation if popup is * opened. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onsapnextmodifiers( /** * The event object. */ oEvent: jQuery.Event ): void; /** * Handle sapshow pseudo events on the control * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onsapshow( /** * The event object. */ oEvent: jQuery.Event ): void; /** * Removes all the controls from the aggregation {@link #getItems items}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllItems(): ListItem[]; /** * Removes a item from the aggregation {@link #getItems items}. * * * @returns The removed item or `null` */ removeItem( /** * The item to remove or its index or id */ vItem: int | string | ListItem ): ListItem | null; /** * Sets a new value for property {@link #getDisplaySecondaryValues displaySecondaryValues}. * * Indicates whether the `additionalText` property that is available for `sap.ui.core.ListItem` shall be * displayed in the list. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setDisplaySecondaryValues( /** * New value for property `displaySecondaryValues` */ bDisplaySecondaryValues?: boolean ): this; /** * Sets the associated {@link #getListBox listBox}. * * * @returns Reference to `this` in order to allow method chaining */ setListBox( /** * ID of an element which becomes the new target of this listBox association; alternatively, an element * instance may be given */ oListBox: ID | ListBox ): this; /** * Sets a new value for property {@link #getMaxPopupItems maxPopupItems}. * * Defines the number of items that shall be displayed at once. If the overall number of items is higher * than this setting, a scrollbar is provided. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `10`. * * * @returns Reference to `this` in order to allow method chaining */ setMaxPopupItems( /** * New value for property `maxPopupItems` */ iMaxPopupItems?: int ): this; /** * Sets a new value for property {@link #getSelectedItemId selectedItemId}. * * Id of the selected item. If the value has no corresponding item, the `selectedItemId` is empty. * * If the `selectedItemId` is set to a not existing item, it will not be changed. * * 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 */ setSelectedItemId( /** * New value for property `selectedItemId` */ sSelectedItemId?: string ): this; /** * Sets a new value for property {@link #getSelectedKey selectedKey}. * * Key of the selected item. * * If the value has no corresponding item the key is empty. * * If duplicate keys exists the first item matching the key is used. * * If the key is set to a not existing value it will not be changed. * * 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 */ setSelectedKey( /** * New value for property `selectedKey` */ sSelectedKey?: string ): this; /** * Unbinds aggregation {@link #getItems items} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindItems(): this; } /** * Describes the settings that can be provided to the ComboBox constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.ComboBox} */ export interface $ComboBoxSettings extends $TextFieldSettings { /** * Defines the number of items that shall be displayed at once. If the overall number of items is higher * than this setting, a scrollbar is provided. */ maxPopupItems?: int | PropertyBindingInfo | `{${string}}`; /** * Indicates whether the `additionalText` property that is available for `sap.ui.core.ListItem` shall be * displayed in the list. */ displaySecondaryValues?: boolean | PropertyBindingInfo | `{${string}}`; /** * Key of the selected item. * * If the value has no corresponding item the key is empty. * * If duplicate keys exists the first item matching the key is used. * * If the key is set to a not existing value it will not be changed. */ selectedKey?: string | PropertyBindingInfo; /** * Id of the selected item. If the value has no corresponding item, the `selectedItemId` is empty. * * If the `selectedItemId` is set to a not existing item, it will not be changed. */ selectedItemId?: string | PropertyBindingInfo; /** * `ListItems` (see `sap.ui.core.ListBox`) that shall be displayed in the list. */ items?: ListItem[] | ListItem | AggregationBindingInfo | `{${string}}`; /** * Using this method, you provide a `ListBox` control. This allows reuse of item lists in different controls. * Either a control id can be used as new target, or a control instance. * * **Note:** The ListBox must not be rendered somewhere in the UI. But if you want to bind the `ListBox` * items to a model it must be in the control tree. So we suggest to add it as dependent somewhere (e.g. * to the view or the first used `ComboBox`). If it is not set as child or dependant to an other control * it will be automatically set as dependent to the first ComboBox where it is assigned. */ listBox?: ListBox | string; } /** * Parameters of the ComboBox#change event. */ export interface ComboBox$ChangeEventParameters extends TextField$ChangeEventParameters { /** * The new / changed item of the ComboBox. */ selectedItem?: ListItem; } /** * Event object of the ComboBox#change event. */ export type ComboBox$ChangeEvent = Event< ComboBox$ChangeEventParameters, ComboBox >; } declare module "sap/ui/commons/DatePicker" { import { default as TextField, $TextFieldSettings, } from "sap/ui/commons/TextField"; import { AccessibilityInfo } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Allows end users to interact with dates. Entries can directly be written in, or selected from a calendar * pad. Note: Dates can always be manually entered in the fix YYYYMMDD format, on top of the flexible "locale" * format. If the value is provided via data binding, using a Date.type the formatter of the Date.type is * used. Since version 1.22 the unified.Calendar is used inside the datePicker. So applications using the * DatePicker should load the unified library. Otherwise it will be loaded the first time a DatePicker is * opened. * * @deprecated As of version 1.38. replaced by {@link sap.m.DatePicker} */ export default class DatePicker extends TextField { /** * Constructor for a new DatePicker. * * 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?: $DatePickerSettings ); /** * Constructor for a new DatePicker. * * 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?: $DatePickerSettings ); /** * Creates a new subclass of class sap.ui.commons.DatePicker with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.commons.TextField.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.ui.commons.DatePicker. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Fire event change to attached listeners. * * Provides the following event parameters: * - 'newValue' of type `string` The new / changed value of the DatePicker. * - 'newYyyymmdd' of type `string` The new / changed Yyyymmdd of the DatePicker. * - 'invalidValue' of type `boolean` The new / changed value of the DatePicker is not a valid date. * * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns `this` to allow method chaining */ fireChange( /** * Parameters to pass along with the event - do not use: value is ignored */ mParameters?: object, /** * true if value is invalid */ bInvalidValue?: boolean ): this; /** * See: * sap.ui.core.Control#getAccessibilityInfo * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Current accessibility state of the control */ getAccessibilityInfo(): AccessibilityInfo; /** * Gets current value of property {@link #getLocale locale}. * * Defines the locale (language and country), e.g. "en-US", whose translations and Date formatters should * be used to render the DatePicker.If the value property is bound to a model using a Date type the locale * will be ignored, because the locale information of the model are used. * * * @returns Value of property `locale` */ getLocale(): string; /** * Gets current value of property {@link #getYyyymmdd yyyymmdd}. * * Defines the date as a "yyyymmdd" string, independent from the format used. The inherited textField "value" * attribute uses the date format as configured via the locale. The date is interpreted as gregorian date * * * @returns Value of property `yyyymmdd` */ getYyyymmdd(): string; /** * Sets a new value for property {@link #getLocale locale}. * * Defines the locale (language and country), e.g. "en-US", whose translations and Date formatters should * be used to render the DatePicker.If the value property is bound to a model using a Date type the locale * will be ignored, because the locale information of the model are used. * * 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 */ setLocale( /** * New value for property `locale` */ sLocale?: string ): this; /** * Sets a new value for property {@link #getYyyymmdd yyyymmdd}. * * Defines the date as a "yyyymmdd" string, independent from the format used. The inherited textField "value" * attribute uses the date format as configured via the locale. The date is interpreted as gregorian date * * 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 */ setYyyymmdd( /** * New value for property `yyyymmdd` */ sYyyymmdd?: string ): this; } /** * Describes the settings that can be provided to the DatePicker constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.DatePicker} */ export interface $DatePickerSettings extends $TextFieldSettings { /** * Defines the locale (language and country), e.g. "en-US", whose translations and Date formatters should * be used to render the DatePicker.If the value property is bound to a model using a Date type the locale * will be ignored, because the locale information of the model are used. */ locale?: string | PropertyBindingInfo; /** * Defines the date as a "yyyymmdd" string, independent from the format used. The inherited textField "value" * attribute uses the date format as configured via the locale. The date is interpreted as gregorian date */ yyyymmdd?: string | PropertyBindingInfo; } } declare module "sap/ui/commons/Dialog" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { PopupInterface, AccessibleRole, ID, CSSSize, OpenState, } from "sap/ui/core/library"; import { enums } from "sap/ui/commons/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import Button from "sap/ui/commons/Button"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; import Event from "sap/ui/base/Event"; /** * An interactive window appearing on request displaying information to the user. The API supports features * such as popups with fixed sizes, popups with unlimited width, scrolling bars for large windows, and control * nesting (for example, a drop-down list can be included in the window). * * @deprecated As of version 1.38. Instead, use the `sap.m.Dialog` control. */ export default class Dialog extends Control implements PopupInterface { __implements__sap_ui_core_PopupInterface: boolean; /** * Constructor for a new Dialog. * * 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?: $DialogSettings ); /** * Constructor for a new Dialog. * * 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?: $DialogSettings ); /** * Creates a new subclass of class sap.ui.commons.Dialog with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.Dialog. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some button to the aggregation {@link #getButtons buttons}. * * * @returns Reference to `this` in order to allow method chaining */ addButton( /** * The button to add; if empty, nothing is inserted */ oButton: Control ): this; /** * Adds some content to the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ addContent( /** * The content to add; if empty, nothing is inserted */ oContent: Control ): this; /** * Attaches event handler `fnFunction` to the {@link #event:closed closed} event of this `sap.ui.commons.Dialog`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Dialog` itself. * * Event is fired when the dialog has been closed (after closing-animation etc.). Event parameters provide * information about last position and last size. * * * @returns Reference to `this` in order to allow method chaining */ attachClosed( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Dialog$ClosedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Dialog` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:closed closed} event of this `sap.ui.commons.Dialog`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Dialog` itself. * * Event is fired when the dialog has been closed (after closing-animation etc.). Event parameters provide * information about last position and last size. * * * @returns Reference to `this` in order to allow method chaining */ attachClosed( /** * The function to be called when the event occurs */ fnFunction: (p1: Dialog$ClosedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Dialog` itself */ oListener?: object ): this; /** * Closes the dialog control instance. */ close(): void; /** * Destroys all the buttons in the aggregation {@link #getButtons buttons}. * * * @returns Reference to `this` in order to allow method chaining */ destroyButtons(): this; /** * Destroys all the content in the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Detaches event handler `fnFunction` from the {@link #event:closed closed} event of this `sap.ui.commons.Dialog`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachClosed( /** * The function to be called, when the event occurs */ fnFunction: (p1: Dialog$ClosedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:closed closed} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireClosed( /** * Parameters to pass along with the event */ mParameters?: Dialog$ClosedEventParameters ): this; /** * Gets current value of property {@link #getAccessibleRole accessibleRole}. * * The ARIA role for the control. E.g. for alert-style Dialogs this can be set to "AlertDialog". * * Default value is `Dialog`. * * * @returns Value of property `accessibleRole` */ getAccessibleRole(): AccessibleRole; /** * Gets current value of property {@link #getApplyContentPadding applyContentPadding}. * * Padding is theme-dependent. When set to "false", the content extends to the dialog borders. * * Default value is `true`. * * * @returns Value of property `applyContentPadding` */ getApplyContentPadding(): boolean; /** * Gets current value of property {@link #getAutoClose autoClose}. * * If this property is set to true the Dialog will close if the Dialog loses its focus * * Default value is `false`. * * @since 1.10 * * @returns Value of property `autoClose` */ getAutoClose(): boolean; /** * Gets content of aggregation {@link #getButtons buttons}. * * Aggregation of the buttons to display at the bottom of the dialog, for example OK and Cancel. Association * defaultButton can be used for one of the defined buttons. */ getButtons(): Control[]; /** * Gets content of aggregation {@link #getContent content}. * * Aggregation of the content of the dialog (one or more controls). * * Warning: when content is added with width given as a percentage, the Dialog itself should have a width * set. */ getContent(): Control[]; /** * Gets current value of property {@link #getContentBorderDesign contentBorderDesign}. * * Specifies the border design. Border design is theme dependent. * * Default value is `None`. * * * @returns Value of property `contentBorderDesign` */ getContentBorderDesign(): enums.BorderDesign; /** * ID of the element which is the current target of the association {@link #getDefaultButton defaultButton}, * or `null`. */ getDefaultButton(): ID | null; /** * Determines whether the dialog is currently enabled or not. * * Applications can't control the enabled state via a property. A dialog is implicitly enabled depending * on its `openState`. Descendant controls that honor the enabled state of their ancestors will appear disabled * after the dialog is closed. * * @experimental Whether a dialog is regarded as "enabled" during the state transitions (OPENING, CLOSING) * is not fully decided. Currently, it is enabled during the OPENING phase and disabled during the CLOSING * phase. The only potential change would be to treat the OPENING phase as disabled as well. Applications * should be prepared to receive events from "enabled" controls after they called open() on the dialog until * close() is called on it. If the mentioned potential change should happen, the dialog will become enabled * only after the transition to OPEN. Events from "enabled" children then can still only arrive between * open() and close(), so applications that obey the previous rule should continue to work. Only end users * or code that explicitly triggers pseudo user events will notice a difference. * A second aspect that might change is the visual behavior of the content: during the CLOSING phase it * 'looks' enabled but in fact it is already disabled. This avoids unnecessary redraws for content that * becomes hidden soon. Should this show to be confusing for end users, it might be changed. * * @returns indicates whether the dialog is currently enabled or not. */ getEnabled(): boolean; /** * Gets current value of property {@link #getHeight height}. * * Outer height of dialog window. When not set and not constrained by one of the height parameters (minHeight/maxHeight), * the window size is automatically adapted to the content. * * * @returns Value of property `height` */ getHeight(): CSSSize; /** * ID of the element which is the current target of the association {@link #getInitialFocus initialFocus}, * or `null`. */ getInitialFocus(): ID | null; /** * Gets current value of property {@link #getKeepInWindow keepInWindow}. * * Specifies whether Dialog movement should be restricted to the visible area of the window. This only affects * drag&drop movements by the user. This doesn't affect modal dialogs -> modal dialogs always stay in the * window. * * Default value is `false`. * * @since 1.9.0 * * @returns Value of property `keepInWindow` */ getKeepInWindow(): boolean; /** * Gets current value of property {@link #getMaxHeight maxHeight}. * * Maximum outer height of the dialog window. If set, neither the user nor some layout settings can make * the window larger. * * * @returns Value of property `maxHeight` */ getMaxHeight(): CSSSize; /** * Gets current value of property {@link #getMaxWidth maxWidth}. * * Maximum outer width of the dialog window. If set, neither the user nor some layout settings can make * the window larger. * * * @returns Value of property `maxWidth` */ getMaxWidth(): CSSSize; /** * Gets current value of property {@link #getMinHeight minHeight}. * * Minimum outer height of the dialog window. When set, neither the user nor some layout settings can make * the window smaller. * * * @returns Value of property `minHeight` */ getMinHeight(): CSSSize; /** * Gets current value of property {@link #getMinWidth minWidth}. * * Minimum outer width of the dialog window. When set, neither the user nor some layout settings can make * the window smaller. * * * @returns Value of property `minWidth` */ getMinWidth(): CSSSize; /** * Gets current value of property {@link #getModal modal}. * * Specifies whether the dialog should be modal, or not. In case of `true` the focus is kept inside the * dialog. * * Default value is `false`. * * * @returns Value of property `modal` */ getModal(): boolean; /** * Indicates whether the Dialog is currently open, closed, or transitioning between these states. */ getOpenState(): OpenState; /** * Gets current value of property {@link #getResizable resizable}. * * Specifies whether the dialog window can be resized by the user. The dialog frame contains the visual * symbol. * * Default value is `true`. * * * @returns Value of property `resizable` */ getResizable(): boolean; /** * Gets current value of property {@link #getScrollLeft scrollLeft}. * * Scroll position from left to right. "0" means leftmost position. * * Default value is `0`. * * * @returns Value of property `scrollLeft` */ getScrollLeft(): int; /** * Gets current value of property {@link #getScrollTop scrollTop}. * * Scroll position from top to bottom. "0" means topmost position. * * Default value is `0`. * * * @returns Value of property `scrollTop` */ getScrollTop(): int; /** * Gets current value of property {@link #getShowCloseButton showCloseButton}. * * Displays a close button in the title bar. * * Default value is `true`. * * * @returns Value of property `showCloseButton` */ getShowCloseButton(): boolean; /** * Gets current value of property {@link #getTitle title}. * * Dialog title displayed in the header. * * Default value is `empty string`. * * * @returns Value of property `title` */ getTitle(): string; /** * Gets current value of property {@link #getWidth width}. * * Outer width of dialog window. When not set and not constrained by one of the width parameters (minWidth/maxWidth), * the window size is automatically adapted to the content. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getButtons buttons}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfButton( /** * The button whose index is looked for */ oButton: Control ): int; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContent( /** * The content whose index is looked for */ oContent: Control ): int; /** * Inserts a button into the aggregation {@link #getButtons buttons}. * * * @returns Reference to `this` in order to allow method chaining */ insertButton( /** * The button to insert; if empty, nothing is inserted */ oButton: Control, /** * The `0`-based index the button should be inserted at; for a negative value of `iIndex`, the button is * inserted at position 0; for a value greater than the current size of the aggregation, the button is inserted * at the last position */ iIndex: int ): this; /** * Inserts a content into the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ insertContent( /** * The content to insert; if empty, nothing is inserted */ oContent: Control, /** * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content * is inserted at position 0; for a value greater than the current size of the aggregation, the content * is inserted at the last position */ iIndex: int ): this; /** * Indicates whether the Dialog is open (this includes opening and closing animations). For more detailed * information about the current state check Dialog.getOpenState(). */ isOpen(): boolean; /** * Opens the dialog control instance. */ open(): void; /** * Removes all the controls from the aggregation {@link #getButtons buttons}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllButtons(): Control[]; /** * Removes all the controls from the aggregation {@link #getContent content}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllContent(): Control[]; /** * Removes a button from the aggregation {@link #getButtons buttons}. * * * @returns The removed button or `null` */ removeButton( /** * The button to remove or its index or id */ vButton: int | string | Control ): Control | null; /** * Removes a content from the aggregation {@link #getContent content}. * * * @returns The removed content or `null` */ removeContent( /** * The content to remove or its index or id */ vContent: int | string | Control ): Control | null; /** * Sets a new value for property {@link #getAccessibleRole accessibleRole}. * * The ARIA role for the control. E.g. for alert-style Dialogs this can be set to "AlertDialog". * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Dialog`. * * * @returns Reference to `this` in order to allow method chaining */ setAccessibleRole( /** * New value for property `accessibleRole` */ sAccessibleRole?: AccessibleRole | keyof typeof AccessibleRole ): this; /** * Sets a new value for property {@link #getApplyContentPadding applyContentPadding}. * * Padding is theme-dependent. When set to "false", the content extends to the dialog borders. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setApplyContentPadding( /** * New value for property `applyContentPadding` */ bApplyContentPadding?: boolean ): this; /** * Sets a new value for property {@link #getAutoClose autoClose}. * * If this property is set to true the Dialog will close if the Dialog loses its focus * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.10 * * @returns Reference to `this` in order to allow method chaining */ setAutoClose( /** * New value for property `autoClose` */ bAutoClose?: boolean ): this; /** * Sets a new value for property {@link #getContentBorderDesign contentBorderDesign}. * * Specifies the border design. Border design is theme dependent. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `None`. * * * @returns Reference to `this` in order to allow method chaining */ setContentBorderDesign( /** * New value for property `contentBorderDesign` */ sContentBorderDesign?: | enums.BorderDesign | keyof typeof enums.BorderDesign ): this; /** * Sets the associated {@link #getDefaultButton defaultButton}. * * * @returns Reference to `this` in order to allow method chaining */ setDefaultButton( /** * ID of an element which becomes the new target of this defaultButton association; alternatively, an element * instance may be given */ oDefaultButton: ID | Button ): this; /** * Sets a new value for property {@link #getHeight height}. * * Outer height of dialog window. When not set and not constrained by one of the height parameters (minHeight/maxHeight), * the window size is automatically adapted to the content. * * 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 */ setHeight( /** * New value for property `height` */ sHeight?: CSSSize ): this; /** * Sets the associated {@link #getInitialFocus initialFocus}. * * * @returns Reference to `this` in order to allow method chaining */ setInitialFocus( /** * ID of an element which becomes the new target of this initialFocus association; alternatively, an element * instance may be given */ oInitialFocus: ID | Control ): this; /** * Sets a new value for property {@link #getKeepInWindow keepInWindow}. * * Specifies whether Dialog movement should be restricted to the visible area of the window. This only affects * drag&drop movements by the user. This doesn't affect modal dialogs -> modal dialogs always stay in the * window. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.9.0 * * @returns Reference to `this` in order to allow method chaining */ setKeepInWindow( /** * New value for property `keepInWindow` */ bKeepInWindow?: boolean ): this; /** * Sets a new value for property {@link #getMaxHeight maxHeight}. * * Maximum outer height of the dialog window. If set, neither the user nor some layout settings can make * the window larger. * * 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 */ setMaxHeight( /** * New value for property `maxHeight` */ sMaxHeight?: CSSSize ): this; /** * Sets a new value for property {@link #getMaxWidth maxWidth}. * * Maximum outer width of the dialog window. If set, neither the user nor some layout settings can make * the window larger. * * 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 */ setMaxWidth( /** * New value for property `maxWidth` */ sMaxWidth?: CSSSize ): this; /** * Sets a new value for property {@link #getMinHeight minHeight}. * * Minimum outer height of the dialog window. When set, neither the user nor some layout settings can make * the window smaller. * * 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 */ setMinHeight( /** * New value for property `minHeight` */ sMinHeight?: CSSSize ): this; /** * Sets a new value for property {@link #getMinWidth minWidth}. * * Minimum outer width of the dialog window. When set, neither the user nor some layout settings can make * the window smaller. * * 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 */ setMinWidth( /** * New value for property `minWidth` */ sMinWidth?: CSSSize ): this; /** * Sets a new value for property {@link #getModal modal}. * * Specifies whether the dialog should be modal, or not. In case of `true` the focus is kept inside the * dialog. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setModal( /** * New value for property `modal` */ bModal?: boolean ): this; /** * Sets a new value for property {@link #getResizable resizable}. * * Specifies whether the dialog window can be resized by the user. The dialog frame contains the visual * symbol. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setResizable( /** * New value for property `resizable` */ bResizable?: boolean ): this; /** * Sets a new value for property {@link #getScrollLeft scrollLeft}. * * Scroll position from left to right. "0" means leftmost position. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setScrollLeft( /** * New value for property `scrollLeft` */ iScrollLeft?: int ): this; /** * Sets a new value for property {@link #getScrollTop scrollTop}. * * Scroll position from top to bottom. "0" means topmost position. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setScrollTop( /** * New value for property `scrollTop` */ iScrollTop?: int ): this; /** * Sets a new value for property {@link #getShowCloseButton showCloseButton}. * * Displays a close button in the title bar. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowCloseButton( /** * New value for property `showCloseButton` */ bShowCloseButton?: boolean ): this; /** * Sets a new value for property {@link #getTitle title}. * * Dialog title displayed in the header. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setTitle( /** * New value for property `title` */ sTitle?: string ): this; /** * Sets a new value for property {@link #getWidth width}. * * Outer width of dialog window. When not set and not constrained by one of the width parameters (minWidth/maxWidth), * the window size is automatically adapted to the content. * * 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 */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; } /** * Describes the settings that can be provided to the Dialog constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.Dialog` control. */ export interface $DialogSettings extends $ControlSettings { /** * Outer width of dialog window. When not set and not constrained by one of the width parameters (minWidth/maxWidth), * the window size is automatically adapted to the content. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Outer height of dialog window. When not set and not constrained by one of the height parameters (minHeight/maxHeight), * the window size is automatically adapted to the content. */ height?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Scroll position from left to right. "0" means leftmost position. */ scrollLeft?: int | PropertyBindingInfo | `{${string}}`; /** * Scroll position from top to bottom. "0" means topmost position. */ scrollTop?: int | PropertyBindingInfo | `{${string}}`; /** * Dialog title displayed in the header. */ title?: string | PropertyBindingInfo; /** * Padding is theme-dependent. When set to "false", the content extends to the dialog borders. */ applyContentPadding?: boolean | PropertyBindingInfo | `{${string}}`; /** * Displays a close button in the title bar. */ showCloseButton?: boolean | PropertyBindingInfo | `{${string}}`; /** * Specifies whether the dialog window can be resized by the user. The dialog frame contains the visual * symbol. */ resizable?: boolean | PropertyBindingInfo | `{${string}}`; /** * Minimum outer width of the dialog window. When set, neither the user nor some layout settings can make * the window smaller. */ minWidth?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Minimum outer height of the dialog window. When set, neither the user nor some layout settings can make * the window smaller. */ minHeight?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Maximum outer width of the dialog window. If set, neither the user nor some layout settings can make * the window larger. */ maxWidth?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Maximum outer height of the dialog window. If set, neither the user nor some layout settings can make * the window larger. */ maxHeight?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Specifies the border design. Border design is theme dependent. */ contentBorderDesign?: | (enums.BorderDesign | keyof typeof enums.BorderDesign) | PropertyBindingInfo | `{${string}}`; /** * Specifies whether the dialog should be modal, or not. In case of `true` the focus is kept inside the * dialog. */ modal?: boolean | PropertyBindingInfo | `{${string}}`; /** * The ARIA role for the control. E.g. for alert-style Dialogs this can be set to "AlertDialog". */ accessibleRole?: | (AccessibleRole | keyof typeof AccessibleRole) | PropertyBindingInfo | `{${string}}`; /** * Specifies whether Dialog movement should be restricted to the visible area of the window. This only affects * drag&drop movements by the user. This doesn't affect modal dialogs -> modal dialogs always stay in the * window. * * @since 1.9.0 */ keepInWindow?: boolean | PropertyBindingInfo | `{${string}}`; /** * If this property is set to true the Dialog will close if the Dialog loses its focus * * @since 1.10 */ autoClose?: boolean | PropertyBindingInfo | `{${string}}`; /** * Aggregation of the buttons to display at the bottom of the dialog, for example OK and Cancel. Association * defaultButton can be used for one of the defined buttons. */ buttons?: Control[] | Control | AggregationBindingInfo | `{${string}}`; /** * Aggregation of the content of the dialog (one or more controls). * * Warning: when content is added with width given as a percentage, the Dialog itself should have a width * set. */ content?: Control[] | Control | AggregationBindingInfo | `{${string}}`; /** * Defines one of the buttons that have been provided via button aggregation to be the default button. This * default button is initially selected, if no control is set via the initialFocus association explicitly. * The default button is activated when Enter is pressed in the context of the dialog and when the currently * selected element does not handle the Enter event itself. */ defaultButton?: Button | string; /** * Defines the control that shall get the focus when the dialog is opened. */ initialFocus?: Control | string; /** * Event is fired when the dialog has been closed (after closing-animation etc.). Event parameters provide * information about last position and last size. */ closed?: (oEvent: Dialog$ClosedEvent) => void; } /** * Parameters of the Dialog#closed event. */ export interface Dialog$ClosedEventParameters { /** * The width of the dialog when closed */ width?: int; /** * The height of the dialog when closed */ height?: int; /** * The top position of the dialog when closed */ top?: int; /** * The left position of the dialog when closed */ left?: int; } /** * Event object of the Dialog#closed event. */ export type Dialog$ClosedEvent = Event; } declare module "sap/ui/commons/DropdownBox" { import { default as ComboBox, $ComboBoxSettings, } from "sap/ui/commons/ComboBox"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { URI } from "sap/ui/core/library"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; import Event from "sap/ui/base/Event"; /** * The control provides a field that allows end users to an entry out of a list of pre-defined items. The * choosable items can be provided in the form of a complete `ListBox`, single `ListItems`. * * @deprecated As of version 1.38. replaced by {@link sap.m.ComboBox} */ export default class DropdownBox extends ComboBox { /** * Constructor for a new DropdownBox. * * 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?: $DropdownBoxSettings ); /** * Constructor for a new DropdownBox. * * 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?: $DropdownBoxSettings ); /** * Creates a new subclass of class sap.ui.commons.DropdownBox with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.commons.ComboBox.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.ui.commons.DropdownBox. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:searchHelp searchHelp} event of this `sap.ui.commons.DropdownBox`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.DropdownBox` itself. * * Event fired whenever the configured searchHelpItem is clicked or the searchHelpItem is configured and * F4 key is pressed. * * * @returns Reference to `this` in order to allow method chaining */ attachSearchHelp( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: DropdownBox$SearchHelpEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.DropdownBox` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:searchHelp searchHelp} event of this `sap.ui.commons.DropdownBox`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.DropdownBox` itself. * * Event fired whenever the configured searchHelpItem is clicked or the searchHelpItem is configured and * F4 key is pressed. * * * @returns Reference to `this` in order to allow method chaining */ attachSearchHelp( /** * The function to be called when the event occurs */ fnFunction: (p1: DropdownBox$SearchHelpEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.DropdownBox` itself */ oListener?: object ): this; /** * Using this method the history of the DropdownBox can be cleared. This might be necessary if the items * of the DropdownBox have changed. Otherwise invalid items may appear in the history. */ clearHistory(): void; /** * Detaches event handler `fnFunction` from the {@link #event:searchHelp searchHelp} event of this `sap.ui.commons.DropdownBox`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSearchHelp( /** * The function to be called, when the event occurs */ fnFunction: (p1: DropdownBox$SearchHelpEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:searchHelp searchHelp} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSearchHelp( /** * Parameters to pass along with the event */ mParameters?: DropdownBox$SearchHelpEventParameters ): this; /** * Gets current value of property {@link #getMaxHistoryItems maxHistoryItems}. * * Maximum number of history items in the list. * * If 0 no history is displayed or stored. The history is locally stored on the client. Therefore do not * activate this feature when this control handles confidential data. * * Default value is `0`. * * * @returns Value of property `maxHistoryItems` */ getMaxHistoryItems(): int; /** * Gets current value of property {@link #getSearchHelpAdditionalText searchHelpAdditionalText}. * * (optional) The additional Text to use for the search help entry. * * * @returns Value of property `searchHelpAdditionalText` */ getSearchHelpAdditionalText(): string; /** * Gets current value of property {@link #getSearchHelpEnabled searchHelpEnabled}. * * Whether the DropdownBox's search help should be enabled. * * Default value is `false`. * * * @returns Value of property `searchHelpEnabled` */ getSearchHelpEnabled(): boolean; /** * Gets current value of property {@link #getSearchHelpIcon searchHelpIcon}. * * (optional) The URI of the icon to use for the search help entry. * * * @returns Value of property `searchHelpIcon` */ getSearchHelpIcon(): URI; /** * Gets current value of property {@link #getSearchHelpText searchHelpText}. * * (optional) The text to use for the search help entry. * * * @returns Value of property `searchHelpText` */ getSearchHelpText(): string; /** * Overrides the method inherited from {@link sap.ui.core.Element} by providing information on Search Help * access (if needed) * * * @returns string tooltip or `undefined` */ getTooltip_AsString(): string | undefined; /** * Ensure that handed in ListBoxes are taken from the visible UI immediately. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onAfterRendering( /** * The event object. */ oEvent: jQuery.Event ): void; /** * Handle the click event happening in the DropdownBox * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onclick( /** * The event object. */ oEvent: jQuery.Event ): void; /** * Handle focusin event Ensures the text gets selected when focus gets into the field * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onfocusin( /** * the occuring event */ oEvent: jQuery.Event ): void; /** * Handle keydown event * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onkeydown( /** * the occuring event */ oEvent: jQuery.Event ): void; /** * Handle keypress event * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onkeypress( /** * the occuring event */ oEvent: jQuery.Event ): void; /** * Handle keyup event This must only be considered if it is from Backspace-key in IE or after paste. In * case there is a keyup with a tab this results from being entered via tabbing and can be ignored, too. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onkeyup( /** * the occuring event */ oEvent: jQuery.Event ): void; /** * Handle paste event * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onpaste( /** * the occuring event */ oEvent: jQuery.Event ): void; /** * Handle pseudo event onsapdelete. If triggered with open dropdown and current item provided by history * feature, removes the selected item from this instance's history. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onsapdelete( /** * the occuring event */ oEvent: jQuery.Event ): void; /** * Handle pseudo event onsaphome * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onsaphome( /** * the occuring event */ oEvent: jQuery.Event ): void; /** * Move the cursor one step to the left (and adapt selection) * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onsapleft( /** * The event object. */ oEvent: jQuery.Event ): void; /** * Move the cursor one step to the right (and adapt selection) * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onsapright( /** * The event object. */ oEvent: jQuery.Event ): void; /** * Handle sapshow pseudo events on the control * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onsapshow( /** * The event object. */ oEvent: jQuery.Event ): void; /** * Handle the select event happening in the DropdownBox * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onselect( /** * The event object. */ oEvent: jQuery.Event ): void; /** * Sets a new value for property {@link #getMaxHistoryItems maxHistoryItems}. * * Maximum number of history items in the list. * * If 0 no history is displayed or stored. The history is locally stored on the client. Therefore do not * activate this feature when this control handles confidential data. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setMaxHistoryItems( /** * New value for property `maxHistoryItems` */ iMaxHistoryItems?: int ): this; /** * Overwrite of Setter for property `searchHelpAdditionalText`. * * Default value is empty/`undefined` * * * @returns `this` to allow method chaining */ setSearchHelpAdditionalText( /** * new value for property `searchHelpAdditionalText` */ sSearchHelpAdditionalText: string ): this; /** * Overwrite of Setter for property `searchHelpEnabled`. This method accepts additional parameter to be * compatiple with the previous functionality * * Default value is `false` * * * @returns `this` to allow method chaining */ setSearchHelpEnabled( /** * new value for property `searchHelpEnabled` */ bEnabled: boolean, /** * new value for property `searchHelpText` */ sText: string, /** * new value for property `searchHelpAdditionalText` */ sAdditionalText: string, /** * new value for property `searchHelpIcon` */ sIcon: string ): this; /** * Overwrite of Setter for property `searchHelpIcon`. * * Default value is empty/`undefined` * * * @returns `this` to allow method chaining */ setSearchHelpIcon( /** * new value for property `searchHelpIcon` */ sSearchHelpIcon: URI ): this; /** * Overwrite of Setter for property `searchHelpText`. * * Default value is empty/`undefined` * * * @returns `this` to allow method chaining */ setSearchHelpText( /** * new value for property `searchHelpText` */ sSearchHelpText: string ): this; } /** * Describes the settings that can be provided to the DropdownBox constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.ComboBox} */ export interface $DropdownBoxSettings extends $ComboBoxSettings { /** * Whether the DropdownBox's search help should be enabled. */ searchHelpEnabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * (optional) The text to use for the search help entry. */ searchHelpText?: string | PropertyBindingInfo; /** * (optional) The additional Text to use for the search help entry. */ searchHelpAdditionalText?: string | PropertyBindingInfo; /** * (optional) The URI of the icon to use for the search help entry. */ searchHelpIcon?: URI | PropertyBindingInfo | `{${string}}`; /** * Maximum number of history items in the list. * * If 0 no history is displayed or stored. The history is locally stored on the client. Therefore do not * activate this feature when this control handles confidential data. */ maxHistoryItems?: int | PropertyBindingInfo | `{${string}}`; /** * Event fired whenever the configured searchHelpItem is clicked or the searchHelpItem is configured and * F4 key is pressed. */ searchHelp?: (oEvent: DropdownBox$SearchHelpEvent) => void; } /** * Parameters of the DropdownBox#searchHelp event. */ export interface DropdownBox$SearchHelpEventParameters { /** * The current value of the DropdownBox. */ value?: string; } /** * Event object of the DropdownBox#searchHelp event. */ export type DropdownBox$SearchHelpEvent = Event< DropdownBox$SearchHelpEventParameters, DropdownBox >; } declare module "sap/ui/commons/FileUploader" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { IFormContent, ID, URI, ValueState, CSSSize, } from "sap/ui/core/library"; import { IProcessableBlobs } from "sap/ui/commons/library"; import FileUploaderParameter from "sap/ui/commons/FileUploaderParameter"; import Event from "sap/ui/base/Event"; import FileUploaderHttpRequestMethod from "sap/ui/commons/FileUploaderHttpRequestMethod"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import FileUploaderXHRSettings from "sap/ui/commons/FileUploaderXHRSettings"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; /** * The framework generates an input field and a button with text "Browse ...". The API supports features * such as on change uploads (the upload starts immediately after a file has been selected), file uploads * with explicit calls, adjustable control sizes, text display after uploads, or tooltips containing complete * file paths. * * @deprecated As of version 1.21.0. Please use the control sap.ui.unified.FileUploader of the library sap.ui.unified * instead. */ export default class FileUploader extends Control implements IFormContent, IProcessableBlobs { __implements__sap_ui_core_IFormContent: boolean; __implements__sap_ui_commons_IProcessableBlobs: boolean; /** * Constructor for a new FileUploader. * * 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?: $FileUploaderSettings ); /** * Constructor for a new FileUploader. * * 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?: $FileUploaderSettings ); /** * Creates a new subclass of class sap.ui.commons.FileUploader with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.FileUploader. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Aborts the currently running upload. * * @since 1.24.0 */ abort( /** * The name of the parameter within the `headerParameters` aggregation to be checked. * * **Note:** aborts the request, sent with a header parameter with the provided name. The parameter is taken * into account if the sHeaderParameterValue parameter is provided too. */ sHeaderParameterName: string, /** * The value of the parameter within the `headerParameters` aggregation to be checked. * * **Note:** aborts the request, sent with a header parameter with the provided value. The parameter is * taken into account if the sHeaderParameterName parameter is provided too. */ sHeaderParameterValue: string ): void; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaDescribedBy( /** * The ariaDescribedBy to add; if empty, nothing is inserted */ vAriaDescribedBy: ID | Control ): this; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaLabelledBy( /** * The ariaLabelledBy to add; if empty, nothing is inserted */ vAriaLabelledBy: ID | Control ): this; /** * Adds some headerParameter to the aggregation {@link #getHeaderParameters headerParameters}. * * * @returns Reference to `this` in order to allow method chaining */ addHeaderParameter( /** * The headerParameter to add; if empty, nothing is inserted */ oHeaderParameter: FileUploaderParameter ): this; /** * Adds some parameter to the aggregation {@link #getParameters parameters}. * * @since 1.12.2 * * @returns Reference to `this` in order to allow method chaining */ addParameter( /** * The parameter to add; if empty, nothing is inserted */ oParameter: FileUploaderParameter ): this; /** * Attaches event handler `fnFunction` to the {@link #event:afterDialogClose afterDialogClose} event of * this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Fired after select file dialog closes. * * @since 1.102.0 * * @returns Reference to `this` in order to allow method chaining */ attachAfterDialogClose( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:afterDialogClose afterDialogClose} event of * this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Fired after select file dialog closes. * * @since 1.102.0 * * @returns Reference to `this` in order to allow method chaining */ attachAfterDialogClose( /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeDialogOpen beforeDialogOpen} event of * this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Fired before select file dialog opens. * * @since 1.102.0 * * @returns Reference to `this` in order to allow method chaining */ attachBeforeDialogOpen( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeDialogOpen beforeDialogOpen} event of * this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Fired before select file dialog opens. * * @since 1.102.0 * * @returns Reference to `this` in order to allow method chaining */ attachBeforeDialogOpen( /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired when the value of the file path has been changed. * * **Note:** Keep in mind that because of the HTML input element of type file, the event is also fired in * Chrome browser when the Cancel button of the uploads window is pressed. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired when the value of the file path has been changed. * * **Note:** Keep in mind that because of the HTML input element of type file, the event is also fired in * Chrome browser when the Cancel button of the uploads window is pressed. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:fileAllowed fileAllowed} event of this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired when the file is allowed for upload on client side. * * * @returns Reference to `this` in order to allow method chaining */ attachFileAllowed( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:fileAllowed fileAllowed} event of this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired when the file is allowed for upload on client side. * * * @returns Reference to `this` in order to allow method chaining */ attachFileAllowed( /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:fileEmpty fileEmpty} event of this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired when the size of the file is 0 * * * @returns Reference to `this` in order to allow method chaining */ attachFileEmpty( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$FileEmptyEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:fileEmpty fileEmpty} event of this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired when the size of the file is 0 * * * @returns Reference to `this` in order to allow method chaining */ attachFileEmpty( /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$FileEmptyEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:filenameLengthExceed filenameLengthExceed} event * of this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired, if the filename of a chosen file is longer than the value specified with the `maximumFilenameLength` * property. * * @since 1.24.0 * * @returns Reference to `this` in order to allow method chaining */ attachFilenameLengthExceed( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$FilenameLengthExceedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:filenameLengthExceed filenameLengthExceed} event * of this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired, if the filename of a chosen file is longer than the value specified with the `maximumFilenameLength` * property. * * @since 1.24.0 * * @returns Reference to `this` in order to allow method chaining */ attachFilenameLengthExceed( /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$FilenameLengthExceedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:fileSizeExceed fileSizeExceed} event of this * `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired when the size of a file is above the `maximumFileSize` property. This event is not supported * by Internet Explorer 9 (same restriction as for the property `maximumFileSize`). * * * @returns Reference to `this` in order to allow method chaining */ attachFileSizeExceed( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$FileSizeExceedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:fileSizeExceed fileSizeExceed} event of this * `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired when the size of a file is above the `maximumFileSize` property. This event is not supported * by Internet Explorer 9 (same restriction as for the property `maximumFileSize`). * * * @returns Reference to `this` in order to allow method chaining */ attachFileSizeExceed( /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$FileSizeExceedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:typeMissmatch typeMissmatch} event of this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired when the type of a file does not match the `mimeType` or `fileType` property. * * * @returns Reference to `this` in order to allow method chaining */ attachTypeMissmatch( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$TypeMissmatchEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:typeMissmatch typeMissmatch} event of this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired when the type of a file does not match the `mimeType` or `fileType` property. * * * @returns Reference to `this` in order to allow method chaining */ attachTypeMissmatch( /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$TypeMissmatchEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:uploadAborted uploadAborted} event of this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired after the current upload has been aborted. * * This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in * Internet Explorer 9. * * @since 1.24.0 * * @returns Reference to `this` in order to allow method chaining */ attachUploadAborted( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$UploadAbortedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:uploadAborted uploadAborted} event of this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired after the current upload has been aborted. * * This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in * Internet Explorer 9. * * @since 1.24.0 * * @returns Reference to `this` in order to allow method chaining */ attachUploadAborted( /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$UploadAbortedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:uploadComplete uploadComplete} event of this * `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired as soon as the upload request is completed (either successful or unsuccessful). * * To see if the upload request was successful, check the `status` parameter for a value 2xx. The actual * progress of the upload can be monitored by listening to the `uploadProgress` event. However, this covers * only the client side of the upload process and does not give any success status from the server. * * * @returns Reference to `this` in order to allow method chaining */ attachUploadComplete( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$UploadCompleteEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:uploadComplete uploadComplete} event of this * `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired as soon as the upload request is completed (either successful or unsuccessful). * * To see if the upload request was successful, check the `status` parameter for a value 2xx. The actual * progress of the upload can be monitored by listening to the `uploadProgress` event. However, this covers * only the client side of the upload process and does not give any success status from the server. * * * @returns Reference to `this` in order to allow method chaining */ attachUploadComplete( /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$UploadCompleteEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:uploadProgress uploadProgress} event of this * `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired after the upload has started and before the upload is completed. * * It contains progress information related to the running upload. Depending on file size, band width and * used browser the event is fired once or multiple times. * * This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in * Internet Explorer 9. * * @since 1.24.0 * * @returns Reference to `this` in order to allow method chaining */ attachUploadProgress( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$UploadProgressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:uploadProgress uploadProgress} event of this * `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired after the upload has started and before the upload is completed. * * It contains progress information related to the running upload. Depending on file size, band width and * used browser the event is fired once or multiple times. * * This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in * Internet Explorer 9. * * @since 1.24.0 * * @returns Reference to `this` in order to allow method chaining */ attachUploadProgress( /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$UploadProgressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:uploadStart uploadStart} event of this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired before an upload is started. * * @since 1.30.0 * * @returns Reference to `this` in order to allow method chaining */ attachUploadStart( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$UploadStartEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:uploadStart uploadStart} event of this `sap.ui.commons.FileUploader`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.FileUploader` itself. * * Event is fired before an upload is started. * * @since 1.30.0 * * @returns Reference to `this` in order to allow method chaining */ attachUploadStart( /** * The function to be called when the event occurs */ fnFunction: (p1: FileUploader$UploadStartEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.FileUploader` itself */ oListener?: object ): this; /** * Checks if the chosen file is readable. * * * @returns A promise that resolves successfully if the chosen file can be read and fails with an error * message if it cannot */ checkFileReadable(): Promise; /** * Clears the content of the `FileUploader`. * * **Note:** The attached additional data however is retained. * * @since 1.25.0 * * @returns Reference to `this` for method chaining */ clear(): this; /** * Destroys all the headerParameters in the aggregation {@link #getHeaderParameters headerParameters}. * * * @returns Reference to `this` in order to allow method chaining */ destroyHeaderParameters(): this; /** * Destroys all the parameters in the aggregation {@link #getParameters parameters}. * * @since 1.12.2 * * @returns Reference to `this` in order to allow method chaining */ destroyParameters(): this; /** * Destroys the xhrSettings in the aggregation {@link #getXhrSettings xhrSettings}. * * @since 1.52 * * @returns Reference to `this` in order to allow method chaining */ destroyXhrSettings(): this; /** * Detaches event handler `fnFunction` from the {@link #event:afterDialogClose afterDialogClose} event of * this `sap.ui.commons.FileUploader`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.102.0 * * @returns Reference to `this` in order to allow method chaining */ detachAfterDialogClose( /** * The function to be called, when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:beforeDialogOpen beforeDialogOpen} event of * this `sap.ui.commons.FileUploader`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.102.0 * * @returns Reference to `this` in order to allow method chaining */ detachBeforeDialogOpen( /** * The function to be called, when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.commons.FileUploader`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: FileUploader$ChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:fileAllowed fileAllowed} event of this `sap.ui.commons.FileUploader`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachFileAllowed( /** * The function to be called, when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:fileEmpty fileEmpty} event of this `sap.ui.commons.FileUploader`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachFileEmpty( /** * The function to be called, when the event occurs */ fnFunction: (p1: FileUploader$FileEmptyEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:filenameLengthExceed filenameLengthExceed } * event of this `sap.ui.commons.FileUploader`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.24.0 * * @returns Reference to `this` in order to allow method chaining */ detachFilenameLengthExceed( /** * The function to be called, when the event occurs */ fnFunction: (p1: FileUploader$FilenameLengthExceedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:fileSizeExceed fileSizeExceed} event of this * `sap.ui.commons.FileUploader`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachFileSizeExceed( /** * The function to be called, when the event occurs */ fnFunction: (p1: FileUploader$FileSizeExceedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:typeMissmatch typeMissmatch} event of this * `sap.ui.commons.FileUploader`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachTypeMissmatch( /** * The function to be called, when the event occurs */ fnFunction: (p1: FileUploader$TypeMissmatchEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:uploadAborted uploadAborted} event of this * `sap.ui.commons.FileUploader`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.24.0 * * @returns Reference to `this` in order to allow method chaining */ detachUploadAborted( /** * The function to be called, when the event occurs */ fnFunction: (p1: FileUploader$UploadAbortedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:uploadComplete uploadComplete} event of this * `sap.ui.commons.FileUploader`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachUploadComplete( /** * The function to be called, when the event occurs */ fnFunction: (p1: FileUploader$UploadCompleteEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:uploadProgress uploadProgress} event of this * `sap.ui.commons.FileUploader`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.24.0 * * @returns Reference to `this` in order to allow method chaining */ detachUploadProgress( /** * The function to be called, when the event occurs */ fnFunction: (p1: FileUploader$UploadProgressEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:uploadStart uploadStart} event of this `sap.ui.commons.FileUploader`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.30.0 * * @returns Reference to `this` in order to allow method chaining */ detachUploadStart( /** * The function to be called, when the event occurs */ fnFunction: (p1: FileUploader$UploadStartEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:afterDialogClose afterDialogClose} to attached listeners. * * @since 1.102.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireAfterDialogClose( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:beforeDialogOpen beforeDialogOpen} to attached listeners. * * @since 1.102.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireBeforeDialogOpen( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:change change} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireChange( /** * Parameters to pass along with the event */ mParameters?: FileUploader$ChangeEventParameters ): this; /** * Fires event {@link #event:fileAllowed fileAllowed} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireFileAllowed( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:fileEmpty fileEmpty} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireFileEmpty( /** * Parameters to pass along with the event */ mParameters?: FileUploader$FileEmptyEventParameters ): this; /** * Fires event {@link #event:filenameLengthExceed filenameLengthExceed} to attached listeners. * * @since 1.24.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireFilenameLengthExceed( /** * Parameters to pass along with the event */ mParameters?: FileUploader$FilenameLengthExceedEventParameters ): this; /** * Fires event {@link #event:fileSizeExceed fileSizeExceed} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireFileSizeExceed( /** * Parameters to pass along with the event */ mParameters?: FileUploader$FileSizeExceedEventParameters ): this; /** * Fires event {@link #event:typeMissmatch typeMissmatch} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireTypeMissmatch( /** * Parameters to pass along with the event */ mParameters?: FileUploader$TypeMissmatchEventParameters ): this; /** * Fires event {@link #event:uploadAborted uploadAborted} to attached listeners. * * @since 1.24.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireUploadAborted( /** * Parameters to pass along with the event */ mParameters?: FileUploader$UploadAbortedEventParameters ): this; /** * Fires event {@link #event:uploadComplete uploadComplete} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireUploadComplete( /** * Parameters to pass along with the event */ mParameters?: FileUploader$UploadCompleteEventParameters ): this; /** * Fires event {@link #event:uploadProgress uploadProgress} to attached listeners. * * @since 1.24.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireUploadProgress( /** * Parameters to pass along with the event */ mParameters?: FileUploader$UploadProgressEventParameters ): this; /** * Fires event {@link #event:uploadStart uploadStart} to attached listeners. * * @since 1.30.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireUploadStart( /** * Parameters to pass along with the event */ mParameters?: FileUploader$UploadStartEventParameters ): this; /** * Gets current value of property {@link #getAdditionalData additionalData}. * * Additional data that is sent to the back end service. * * Data will be transmitted as value of a hidden input where the name is derived from the `name` property * with suffix "-data". * * * @returns Value of property `additionalData` */ getAdditionalData(): string; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): ID[]; /** * Gets current value of property {@link #getButtonOnly buttonOnly}. * * If set to "true", the `FileUploader` will be rendered as Button only, without showing the input field. * * Default value is `false`. * * * @returns Value of property `buttonOnly` */ getButtonOnly(): boolean; /** * Gets current value of property {@link #getButtonText buttonText}. * * The button's text can be overwritten using this property. * * * @returns Value of property `buttonText` */ getButtonText(): string; /** * Gets current value of property {@link #getDirectory directory}. * * Allows users to upload all files from a given directory and its corresponding subdirectories. * * Default value is `false`. * * @since 1.105.0 * * @returns Value of property `directory` */ getDirectory(): boolean; /** * Gets current value of property {@link #getEnabled enabled}. * * Disabled controls have different colors, depending on customer settings. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getFileType fileType}. * * The chosen files will be checked against an array of file types. * * If at least one file does not fit the file type restriction, the upload is prevented. **Note:** This * property is not supported by Microsoft Edge. * * Example: `["jpg", "png", "bmp"]`. * * * @returns Value of property `fileType` */ getFileType(): string[]; /** * Gets content of aggregation {@link #getHeaderParameters headerParameters}. * * The header parameters for the `FileUploader` which are only submitted with XHR requests. Header parameters * are not supported by Internet Explorer 9. */ getHeaderParameters(): FileUploaderParameter[]; /** * Gets current value of property {@link #getHttpRequestMethod httpRequestMethod}. * * Chosen HTTP request method for file upload. * * Default value is `Post`. * * @since 1.81.0 * * @returns Value of property `httpRequestMethod` */ getHttpRequestMethod(): FileUploaderHttpRequestMethod; /** * Gets current value of property {@link #getIcon icon}. * * Icon to be displayed as graphical element within the button. * * This can be a URI to an image or an icon font URI. * * Default value is `empty string`. * * @since 1.26.0 * * @returns Value of property `icon` */ getIcon(): URI; /** * Gets current value of property {@link #getIconFirst iconFirst}. * * If set to true (default), the display sequence is 1. icon 2. control text. * * Default value is `true`. * * @since 1.26.0 * * @returns Value of property `iconFirst` */ getIconFirst(): boolean; /** * Gets current value of property {@link #getIconHovered iconHovered}. * * Icon to be displayed as graphical element within the button when it is hovered (only if also a base icon * was specified). * * If not specified, the base icon is used. If an icon font icon is used, this property is ignored. * * Default value is `empty string`. * * @since 1.26.0 * * @returns Value of property `iconHovered` */ getIconHovered(): URI; /** * Gets current value of property {@link #getIconOnly iconOnly}. * * If set to true, the button is displayed without any text. * * Default value is `false`. * * @since 1.26.0 * * @returns Value of property `iconOnly` */ getIconOnly(): boolean; /** * Gets current value of property {@link #getIconSelected iconSelected}. * * Icon to be displayed as graphical element within the button when it is selected (only if also a base * icon was specified). * * If not specified, the base or hovered icon is used. If an icon font icon is used, this property is ignored. * * Default value is `empty string`. * * @since 1.26.0 * * @returns Value of property `iconSelected` */ getIconSelected(): URI; /** * Gets current value of property {@link #getMaximumFilenameLength maximumFilenameLength}. * * The maximum length of a filename which the `FileUploader` will accept. * * If the maximum filename length is exceeded, the corresponding event `filenameLengthExceed` is fired. * * @since 1.24.0 * * @returns Value of property `maximumFilenameLength` */ getMaximumFilenameLength(): int; /** * Gets current value of property {@link #getMaximumFileSize maximumFileSize}. * * A file size limit in megabytes which prevents the upload if at least one file exceeds it. * * This property is not supported by Internet Explorer 9. * * * @returns Value of property `maximumFileSize` */ getMaximumFileSize(): float; /** * Gets current value of property {@link #getMimeType mimeType}. * * The chosen files will be checked against an array of MIME types defined in this property. * * If at least one file does not fit the MIME type restriction, the upload is prevented. * * **Note:** This property is not supported by Internet Explorer. It is only reliable for common file types * like images, audio, video, plain text and HTML documents. File types that are not recognized by the browser * result in `file.type` to be returned as an empty string. In this case the verification could not be performed. * The file upload is not prevented and the validation based on file type is left to the receiving backend * side. * * Example: `["image/png", "image/jpeg"]`. * * * @returns Value of property `mimeType` */ getMimeType(): string[]; /** * Gets current value of property {@link #getMultiple multiple}. * * Allows multiple files to be chosen and uploaded from the same folder. * * This property is not supported by Internet Explorer 9. * * **Note:** Keep in mind that the various operating systems for mobile devices can react differently to * the property so that fewer upload functions may be available in some cases. * * Default value is `false`. * * * @returns Value of property `multiple` */ getMultiple(): boolean; /** * Gets current value of property {@link #getName name}. * * Unique control name for identification on the server side after sending data to the server. * * * @returns Value of property `name` */ getName(): string; /** * Gets content of aggregation {@link #getParameters parameters}. * * The parameters for the `FileUploader` which are rendered as a hidden input field. * * @since 1.12.2 */ getParameters(): FileUploaderParameter[]; /** * Gets current value of property {@link #getPlaceholder placeholder}. * * Placeholder for the text field. * * * @returns Value of property `placeholder` */ getPlaceholder(): string; /** * Allows to process Blobs before they get uploaded. This API can be used to create custom Blobs and upload * these custom Blobs instead of the received/initials Blobs in the parameter `aBlobs`. One use case could * be to create and upload zip archives based on the passed Blobs. The default implementation of this API * should simply resolve with the received Blobs (parameter `aBlobs`). * * This API is only supported in case `sendXHR` is `true`. This means only IE10+ is supported, while IE9 * and below is not. * * This is a default implementation of the interface `sap.ui.commons.IProcessableBlobs`. * * @since 1.52 * * @returns A Promise that resolves with an array of Blobs which is used for the final uploading. */ getProcessedBlobsFromArray( /** * The initial Blobs which can be used to determine/calculate a new array of Blobs for further processing. */ aBlobs: Blob[] ): Promise; /** * Gets current value of property {@link #getSameFilenameAllowed sameFilenameAllowed}. * * If the FileUploader is configured to upload the file directly after the file is selected, it is not allowed * to upload a file with the same name again. If a user should be allowed to upload a file with the same * name again this parameter has to be "true". * * A typical use case would be if the files have different paths. * * Default value is `false`. * * * @returns Value of property `sameFilenameAllowed` */ getSameFilenameAllowed(): boolean; /** * Gets current value of property {@link #getSendXHR sendXHR}. * * If set to "true", the request will be sent as XHR request instead of a form submit. * * This property is not supported by Internet Explorer 9. * * Default value is `false`. * * * @returns Value of property `sendXHR` */ getSendXHR(): boolean; /** * Gets current value of property {@link #getStyle style}. * * Style of the button. * * Values "Transparent, "Accept", "Reject", or "Emphasized" are allowed. * * * @returns Value of property `style` */ getStyle(): string; /** * Gets current value of property {@link #getUploadOnChange uploadOnChange}. * * If set to "true", the upload immediately starts after file selection. With the default setting, the upload * needs to be explicitly triggered. * * Default value is `false`. * * * @returns Value of property `uploadOnChange` */ getUploadOnChange(): boolean; /** * Gets current value of property {@link #getUploadUrl uploadUrl}. * * Used when URL address is on a remote server. * * Default value is `empty string`. * * * @returns Value of property `uploadUrl` */ getUploadUrl(): URI; /** * Gets current value of property {@link #getUseMultipart useMultipart}. * * If set to "false", the request will be sent as file only request instead of a multipart/form-data request. * * Only one file could be uploaded using this type of request. Required for sending such a request is to * set the property `sendXHR` to "true". This property is not supported by Internet Explorer 9. * * Default value is `true`. * * * @returns Value of property `useMultipart` */ getUseMultipart(): boolean; /** * Gets current value of property {@link #getValue value}. * * Value of the path for file upload. * * Default value is `empty string`. * * * @returns Value of property `value` */ getValue(): string; /** * Gets current value of property {@link #getValueState valueState}. * * Visualizes warnings or errors related to the text field. * * Possible values: Warning, Error, Success, None. * * Default value is `None`. * * @since 1.24.0 * * @returns Value of property `valueState` */ getValueState(): ValueState; /** * Gets current value of property {@link #getValueStateText valueStateText}. * * Custom text for the value state message pop-up. * * **Note:** If not specified, a default text, based on the value state type, will be used instead. * * @since 1.52 * * @returns Value of property `valueStateText` */ getValueStateText(): string; /** * Gets current value of property {@link #getWidth width}. * * Specifies the displayed control width. * * Default value is `empty string`. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Gets content of aggregation {@link #getXhrSettings xhrSettings}. * * Settings for the `XMLHttpRequest` object. **Note:** This aggregation is only used when the `sendXHR` * property is set to `true`. * * @since 1.52 */ getXhrSettings(): FileUploaderXHRSettings; /** * Checks for the provided `sap.ui.commons.FileUploaderParameter` in the aggregation {@link #getHeaderParameters headerParameters}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfHeaderParameter( /** * The headerParameter whose index is looked for */ oHeaderParameter: FileUploaderParameter ): int; /** * Checks for the provided `sap.ui.commons.FileUploaderParameter` in the aggregation {@link #getParameters parameters}. * and returns its index if found or -1 otherwise. * * @since 1.12.2 * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfParameter( /** * The parameter whose index is looked for */ oParameter: FileUploaderParameter ): int; /** * Inserts a headerParameter into the aggregation {@link #getHeaderParameters headerParameters}. * * * @returns Reference to `this` in order to allow method chaining */ insertHeaderParameter( /** * The headerParameter to insert; if empty, nothing is inserted */ oHeaderParameter: FileUploaderParameter, /** * The `0`-based index the headerParameter should be inserted at; for a negative value of `iIndex`, the * headerParameter is inserted at position 0; for a value greater than the current size of the aggregation, * the headerParameter is inserted at the last position */ iIndex: int ): this; /** * Inserts a parameter into the aggregation {@link #getParameters parameters}. * * @since 1.12.2 * * @returns Reference to `this` in order to allow method chaining */ insertParameter( /** * The parameter to insert; if empty, nothing is inserted */ oParameter: FileUploaderParameter, /** * The `0`-based index the parameter should be inserted at; for a negative value of `iIndex`, the parameter * is inserted at position 0; for a value greater than the current size of the aggregation, the parameter * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaDescribedBy(): ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): ID[]; /** * Removes all the controls from the aggregation {@link #getHeaderParameters headerParameters}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllHeaderParameters(): FileUploaderParameter[]; /** * Removes all the controls from the aggregation {@link #getParameters parameters}. * * Additionally, it unregisters them from the hosting UIArea. * * @since 1.12.2 * * @returns An array of the removed elements (might be empty) */ removeAllParameters(): FileUploaderParameter[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns The removed ariaDescribedBy or `null` */ removeAriaDescribedBy( /** * The ariaDescribedBy to be removed or its index or ID */ vAriaDescribedBy: int | ID | Control ): ID | null; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns The removed ariaLabelledBy or `null` */ removeAriaLabelledBy( /** * The ariaLabelledBy to be removed or its index or ID */ vAriaLabelledBy: int | ID | Control ): ID | null; /** * Removes a headerParameter from the aggregation {@link #getHeaderParameters headerParameters}. * * * @returns The removed headerParameter or `null` */ removeHeaderParameter( /** * The headerParameter to remove or its index or id */ vHeaderParameter: int | string | FileUploaderParameter ): FileUploaderParameter | null; /** * Removes a parameter from the aggregation {@link #getParameters parameters}. * * @since 1.12.2 * * @returns The removed parameter or `null` */ removeParameter( /** * The parameter to remove or its index or id */ vParameter: int | string | FileUploaderParameter ): FileUploaderParameter | null; /** * Sets a new value for property {@link #getAdditionalData additionalData}. * * Additional data that is sent to the back end service. * * Data will be transmitted as value of a hidden input where the name is derived from the `name` property * with suffix "-data". * * 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 */ setAdditionalData( /** * New value for property `additionalData` */ sAdditionalData?: string ): this; /** * Sets a new value for property {@link #getButtonOnly buttonOnly}. * * If set to "true", the `FileUploader` will be rendered as Button only, without showing the input field. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setButtonOnly( /** * New value for property `buttonOnly` */ bButtonOnly?: boolean ): this; /** * Sets a new value for property {@link #getButtonText buttonText}. * * The button's text can be overwritten using this property. * * 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 */ setButtonText( /** * New value for property `buttonText` */ sButtonText?: string ): this; /** * Sets a new value for property {@link #getDirectory directory}. * * Allows users to upload all files from a given directory and its corresponding subdirectories. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.105.0 * * @returns Reference to `this` in order to allow method chaining */ setDirectory( /** * New value for property `directory` */ bDirectory?: boolean ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * Disabled controls have different colors, depending on customer settings. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getFileType fileType}. * * The chosen files will be checked against an array of file types. * * If at least one file does not fit the file type restriction, the upload is prevented. **Note:** This * property is not supported by Microsoft Edge. * * Example: `["jpg", "png", "bmp"]`. * * 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 */ setFileType( /** * New value for property `fileType` */ sFileType?: string[] ): this; /** * Sets a new value for property {@link #getHttpRequestMethod httpRequestMethod}. * * Chosen HTTP request method for file upload. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Post`. * * @since 1.81.0 * * @returns Reference to `this` in order to allow method chaining */ setHttpRequestMethod( /** * New value for property `httpRequestMethod` */ sHttpRequestMethod?: FileUploaderHttpRequestMethod ): this; /** * Sets a new value for property {@link #getIcon icon}. * * Icon to be displayed as graphical element within the button. * * This can be a URI to an image or an icon font URI. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setIcon( /** * New value for property `icon` */ sIcon?: URI ): this; /** * Sets a new value for property {@link #getIconFirst iconFirst}. * * If set to true (default), the display sequence is 1. icon 2. control text. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setIconFirst( /** * New value for property `iconFirst` */ bIconFirst?: boolean ): this; /** * Sets a new value for property {@link #getIconHovered iconHovered}. * * Icon to be displayed as graphical element within the button when it is hovered (only if also a base icon * was specified). * * If not specified, the base icon is used. If an icon font icon is used, this property is ignored. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setIconHovered( /** * New value for property `iconHovered` */ sIconHovered?: URI ): this; /** * Sets a new value for property {@link #getIconOnly iconOnly}. * * If set to true, the button is displayed without any text. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setIconOnly( /** * New value for property `iconOnly` */ bIconOnly?: boolean ): this; /** * Sets a new value for property {@link #getIconSelected iconSelected}. * * Icon to be displayed as graphical element within the button when it is selected (only if also a base * icon was specified). * * If not specified, the base or hovered icon is used. If an icon font icon is used, this property is ignored. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setIconSelected( /** * New value for property `iconSelected` */ sIconSelected?: URI ): this; /** * Sets a new value for property {@link #getMaximumFilenameLength maximumFilenameLength}. * * The maximum length of a filename which the `FileUploader` will accept. * * If the maximum filename length is exceeded, the corresponding event `filenameLengthExceed` is fired. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.24.0 * * @returns Reference to `this` in order to allow method chaining */ setMaximumFilenameLength( /** * New value for property `maximumFilenameLength` */ iMaximumFilenameLength?: int ): this; /** * Sets a new value for property {@link #getMaximumFileSize maximumFileSize}. * * A file size limit in megabytes which prevents the upload if at least one file exceeds it. * * This property is not supported by Internet Explorer 9. * * 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 */ setMaximumFileSize( /** * New value for property `maximumFileSize` */ fMaximumFileSize?: float ): this; /** * Sets a new value for property {@link #getMimeType mimeType}. * * The chosen files will be checked against an array of MIME types defined in this property. * * If at least one file does not fit the MIME type restriction, the upload is prevented. * * **Note:** This property is not supported by Internet Explorer. It is only reliable for common file types * like images, audio, video, plain text and HTML documents. File types that are not recognized by the browser * result in `file.type` to be returned as an empty string. In this case the verification could not be performed. * The file upload is not prevented and the validation based on file type is left to the receiving backend * side. * * Example: `["image/png", "image/jpeg"]`. * * 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 */ setMimeType( /** * New value for property `mimeType` */ sMimeType?: string[] ): this; /** * Sets a new value for property {@link #getMultiple multiple}. * * Allows multiple files to be chosen and uploaded from the same folder. * * This property is not supported by Internet Explorer 9. * * **Note:** Keep in mind that the various operating systems for mobile devices can react differently to * the property so that fewer upload functions may be available in some cases. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setMultiple( /** * New value for property `multiple` */ bMultiple?: boolean ): this; /** * Sets a new value for property {@link #getName name}. * * Unique control name for identification on the server side after sending data to the server. * * 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 */ setName( /** * New value for property `name` */ sName?: string ): this; /** * Sets a new value for property {@link #getPlaceholder placeholder}. * * Placeholder for the text field. * * 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 */ setPlaceholder( /** * New value for property `placeholder` */ sPlaceholder?: string ): this; /** * Sets a new value for property {@link #getSameFilenameAllowed sameFilenameAllowed}. * * If the FileUploader is configured to upload the file directly after the file is selected, it is not allowed * to upload a file with the same name again. If a user should be allowed to upload a file with the same * name again this parameter has to be "true". * * A typical use case would be if the files have different paths. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setSameFilenameAllowed( /** * New value for property `sameFilenameAllowed` */ bSameFilenameAllowed?: boolean ): this; /** * Sets a new value for property {@link #getSendXHR sendXHR}. * * If set to "true", the request will be sent as XHR request instead of a form submit. * * This property is not supported by Internet Explorer 9. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setSendXHR( /** * New value for property `sendXHR` */ bSendXHR?: boolean ): this; /** * Sets a new value for property {@link #getStyle style}. * * Style of the button. * * Values "Transparent, "Accept", "Reject", or "Emphasized" are allowed. * * 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 */ setStyle( /** * New value for property `style` */ sStyle?: string ): this; /** * Sets a new value for property {@link #getUploadOnChange uploadOnChange}. * * If set to "true", the upload immediately starts after file selection. With the default setting, the upload * needs to be explicitly triggered. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setUploadOnChange( /** * New value for property `uploadOnChange` */ bUploadOnChange?: boolean ): this; /** * Sets a new value for property {@link #getUploadUrl uploadUrl}. * * Used when URL address is on a remote server. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setUploadUrl( /** * New value for property `uploadUrl` */ sUploadUrl?: URI ): this; /** * Sets a new value for property {@link #getUseMultipart useMultipart}. * * If set to "false", the request will be sent as file only request instead of a multipart/form-data request. * * Only one file could be uploaded using this type of request. Required for sending such a request is to * set the property `sendXHR` to "true". This property is not supported by Internet Explorer 9. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setUseMultipart( /** * New value for property `useMultipart` */ bUseMultipart?: boolean ): this; /** * Sets a new value for property {@link #getValue value}. * * Value of the path for file upload. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setValue( /** * New value for property `value` */ sValue?: string ): this; /** * Sets a new value for property {@link #getValueState valueState}. * * Visualizes warnings or errors related to the text field. * * Possible values: Warning, Error, Success, None. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `None`. * * @since 1.24.0 * * @returns Reference to `this` in order to allow method chaining */ setValueState( /** * New value for property `valueState` */ sValueState?: ValueState | keyof typeof ValueState ): this; /** * Sets a new value for property {@link #getValueStateText valueStateText}. * * Custom text for the value state message pop-up. * * **Note:** If not specified, a default text, based on the value state type, will be used instead. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.52 * * @returns Reference to `this` in order to allow method chaining */ setValueStateText( /** * New value for property `valueStateText` */ sValueStateText?: string ): this; /** * Sets a new value for property {@link #getWidth width}. * * Specifies the displayed control width. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; /** * Sets the aggregated {@link #getXhrSettings xhrSettings}. * * @since 1.52 * * @returns Reference to `this` in order to allow method chaining */ setXhrSettings( /** * The xhrSettings to set */ oXhrSettings: FileUploaderXHRSettings ): this; /** * Starts the upload (as defined by uploadUrl). */ upload( /** * Set to `true` to allow pre-processing of the files before sending the request. As a result, the `upload` * method becomes asynchronous. See {@link sap.ui.commons.IProcessableBlobs} for more information. **Note:** * This parameter is only taken into account when `sendXHR` is set to `true`. */ bPreProcessFiles?: boolean ): void; } /** * Describes the settings that can be provided to the FileUploader constructor. * * @deprecated As of version 1.21.0. Please use the control sap.ui.unified.FileUploader of the library sap.ui.unified * instead. */ export interface $FileUploaderSettings extends $ControlSettings { /** * Value of the path for file upload. */ value?: string | PropertyBindingInfo; /** * Disabled controls have different colors, depending on customer settings. */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * Used when URL address is on a remote server. */ uploadUrl?: URI | PropertyBindingInfo | `{${string}}`; /** * Unique control name for identification on the server side after sending data to the server. */ name?: string | PropertyBindingInfo; /** * Specifies the displayed control width. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * If set to "true", the upload immediately starts after file selection. With the default setting, the upload * needs to be explicitly triggered. */ uploadOnChange?: boolean | PropertyBindingInfo | `{${string}}`; /** * Additional data that is sent to the back end service. * * Data will be transmitted as value of a hidden input where the name is derived from the `name` property * with suffix "-data". */ additionalData?: string | PropertyBindingInfo; /** * If the FileUploader is configured to upload the file directly after the file is selected, it is not allowed * to upload a file with the same name again. If a user should be allowed to upload a file with the same * name again this parameter has to be "true". * * A typical use case would be if the files have different paths. */ sameFilenameAllowed?: boolean | PropertyBindingInfo | `{${string}}`; /** * The button's text can be overwritten using this property. */ buttonText?: string | PropertyBindingInfo; /** * The chosen files will be checked against an array of file types. * * If at least one file does not fit the file type restriction, the upload is prevented. **Note:** This * property is not supported by Microsoft Edge. * * Example: `["jpg", "png", "bmp"]`. */ fileType?: string[] | PropertyBindingInfo | `{${string}}`; /** * Allows multiple files to be chosen and uploaded from the same folder. * * This property is not supported by Internet Explorer 9. * * **Note:** Keep in mind that the various operating systems for mobile devices can react differently to * the property so that fewer upload functions may be available in some cases. */ multiple?: boolean | PropertyBindingInfo | `{${string}}`; /** * A file size limit in megabytes which prevents the upload if at least one file exceeds it. * * This property is not supported by Internet Explorer 9. */ maximumFileSize?: float | PropertyBindingInfo | `{${string}}`; /** * The chosen files will be checked against an array of MIME types defined in this property. * * If at least one file does not fit the MIME type restriction, the upload is prevented. * * **Note:** This property is not supported by Internet Explorer. It is only reliable for common file types * like images, audio, video, plain text and HTML documents. File types that are not recognized by the browser * result in `file.type` to be returned as an empty string. In this case the verification could not be performed. * The file upload is not prevented and the validation based on file type is left to the receiving backend * side. * * Example: `["image/png", "image/jpeg"]`. */ mimeType?: string[] | PropertyBindingInfo | `{${string}}`; /** * If set to "true", the request will be sent as XHR request instead of a form submit. * * This property is not supported by Internet Explorer 9. */ sendXHR?: boolean | PropertyBindingInfo | `{${string}}`; /** * Chosen HTTP request method for file upload. * * @since 1.81.0 */ httpRequestMethod?: | FileUploaderHttpRequestMethod | PropertyBindingInfo | `{${string}}`; /** * Placeholder for the text field. */ placeholder?: string | PropertyBindingInfo; /** * Style of the button. * * Values "Transparent, "Accept", "Reject", or "Emphasized" are allowed. */ style?: string | PropertyBindingInfo; /** * If set to "true", the `FileUploader` will be rendered as Button only, without showing the input field. */ buttonOnly?: boolean | PropertyBindingInfo | `{${string}}`; /** * If set to "false", the request will be sent as file only request instead of a multipart/form-data request. * * Only one file could be uploaded using this type of request. Required for sending such a request is to * set the property `sendXHR` to "true". This property is not supported by Internet Explorer 9. */ useMultipart?: boolean | PropertyBindingInfo | `{${string}}`; /** * The maximum length of a filename which the `FileUploader` will accept. * * If the maximum filename length is exceeded, the corresponding event `filenameLengthExceed` is fired. * * @since 1.24.0 */ maximumFilenameLength?: int | PropertyBindingInfo | `{${string}}`; /** * Visualizes warnings or errors related to the text field. * * Possible values: Warning, Error, Success, None. * * @since 1.24.0 */ valueState?: | (ValueState | keyof typeof ValueState) | PropertyBindingInfo | `{${string}}`; /** * Custom text for the value state message pop-up. * * **Note:** If not specified, a default text, based on the value state type, will be used instead. * * @since 1.52 */ valueStateText?: string | PropertyBindingInfo; /** * Icon to be displayed as graphical element within the button. * * This can be a URI to an image or an icon font URI. * * @since 1.26.0 */ icon?: URI | PropertyBindingInfo | `{${string}}`; /** * Icon to be displayed as graphical element within the button when it is hovered (only if also a base icon * was specified). * * If not specified, the base icon is used. If an icon font icon is used, this property is ignored. * * @since 1.26.0 */ iconHovered?: URI | PropertyBindingInfo | `{${string}}`; /** * Icon to be displayed as graphical element within the button when it is selected (only if also a base * icon was specified). * * If not specified, the base or hovered icon is used. If an icon font icon is used, this property is ignored. * * @since 1.26.0 */ iconSelected?: URI | PropertyBindingInfo | `{${string}}`; /** * If set to true (default), the display sequence is 1. icon 2. control text. * * @since 1.26.0 */ iconFirst?: boolean | PropertyBindingInfo | `{${string}}`; /** * If set to true, the button is displayed without any text. * * @since 1.26.0 */ iconOnly?: boolean | PropertyBindingInfo | `{${string}}`; /** * Allows users to upload all files from a given directory and its corresponding subdirectories. * * @since 1.105.0 */ directory?: boolean | PropertyBindingInfo | `{${string}}`; /** * The parameters for the `FileUploader` which are rendered as a hidden input field. * * @since 1.12.2 */ parameters?: | FileUploaderParameter[] | FileUploaderParameter | AggregationBindingInfo | `{${string}}`; /** * The header parameters for the `FileUploader` which are only submitted with XHR requests. Header parameters * are not supported by Internet Explorer 9. */ headerParameters?: | FileUploaderParameter[] | FileUploaderParameter | AggregationBindingInfo | `{${string}}`; /** * Settings for the `XMLHttpRequest` object. **Note:** This aggregation is only used when the `sendXHR` * property is set to `true`. * * @since 1.52 */ xhrSettings?: FileUploaderXHRSettings; /** * Association to controls / IDs which describe this control (see WAI-ARIA attribute `aria-describedby`). */ ariaDescribedBy?: Array; /** * Association to controls / IDs which label this control (see WAI-ARIA attribute `aria-labelledby`). */ ariaLabelledBy?: Array; /** * Event is fired when the value of the file path has been changed. * * **Note:** Keep in mind that because of the HTML input element of type file, the event is also fired in * Chrome browser when the Cancel button of the uploads window is pressed. */ change?: (oEvent: FileUploader$ChangeEvent) => void; /** * Event is fired as soon as the upload request is completed (either successful or unsuccessful). * * To see if the upload request was successful, check the `status` parameter for a value 2xx. The actual * progress of the upload can be monitored by listening to the `uploadProgress` event. However, this covers * only the client side of the upload process and does not give any success status from the server. */ uploadComplete?: (oEvent: FileUploader$UploadCompleteEvent) => void; /** * Event is fired when the type of a file does not match the `mimeType` or `fileType` property. */ typeMissmatch?: (oEvent: FileUploader$TypeMissmatchEvent) => void; /** * Event is fired when the size of a file is above the `maximumFileSize` property. This event is not supported * by Internet Explorer 9 (same restriction as for the property `maximumFileSize`). */ fileSizeExceed?: (oEvent: FileUploader$FileSizeExceedEvent) => void; /** * Event is fired when the size of the file is 0 */ fileEmpty?: (oEvent: FileUploader$FileEmptyEvent) => void; /** * Event is fired when the file is allowed for upload on client side. */ fileAllowed?: (oEvent: Event) => void; /** * Event is fired after the upload has started and before the upload is completed. * * It contains progress information related to the running upload. Depending on file size, band width and * used browser the event is fired once or multiple times. * * This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in * Internet Explorer 9. * * @since 1.24.0 */ uploadProgress?: (oEvent: FileUploader$UploadProgressEvent) => void; /** * Event is fired after the current upload has been aborted. * * This event is only supported with property `sendXHR` set to true, i.e. the event is not supported in * Internet Explorer 9. * * @since 1.24.0 */ uploadAborted?: (oEvent: FileUploader$UploadAbortedEvent) => void; /** * Event is fired, if the filename of a chosen file is longer than the value specified with the `maximumFilenameLength` * property. * * @since 1.24.0 */ filenameLengthExceed?: ( oEvent: FileUploader$FilenameLengthExceedEvent ) => void; /** * Event is fired before an upload is started. * * @since 1.30.0 */ uploadStart?: (oEvent: FileUploader$UploadStartEvent) => void; /** * Fired before select file dialog opens. * * @since 1.102.0 */ beforeDialogOpen?: (oEvent: Event) => void; /** * Fired after select file dialog closes. * * @since 1.102.0 */ afterDialogClose?: (oEvent: Event) => void; } /** * Parameters of the FileUploader#afterDialogClose event. */ export interface FileUploader$AfterDialogCloseEventParameters {} /** * Event object of the FileUploader#afterDialogClose event. */ export type FileUploader$AfterDialogCloseEvent = Event< FileUploader$AfterDialogCloseEventParameters, FileUploader >; /** * Parameters of the FileUploader#beforeDialogOpen event. */ export interface FileUploader$BeforeDialogOpenEventParameters {} /** * Event object of the FileUploader#beforeDialogOpen event. */ export type FileUploader$BeforeDialogOpenEvent = Event< FileUploader$BeforeDialogOpenEventParameters, FileUploader >; /** * Parameters of the FileUploader#change event. */ export interface FileUploader$ChangeEventParameters { /** * New file path value. */ newValue?: string; /** * Files. */ files?: object[]; } /** * Event object of the FileUploader#change event. */ export type FileUploader$ChangeEvent = Event< FileUploader$ChangeEventParameters, FileUploader >; /** * Parameters of the FileUploader#fileAllowed event. */ export interface FileUploader$FileAllowedEventParameters {} /** * Event object of the FileUploader#fileAllowed event. */ export type FileUploader$FileAllowedEvent = Event< FileUploader$FileAllowedEventParameters, FileUploader >; /** * Parameters of the FileUploader#fileEmpty event. */ export interface FileUploader$FileEmptyEventParameters { /** * The name of the file to be uploaded. */ fileName?: string; } /** * Event object of the FileUploader#fileEmpty event. */ export type FileUploader$FileEmptyEvent = Event< FileUploader$FileEmptyEventParameters, FileUploader >; /** * Parameters of the FileUploader#filenameLengthExceed event. */ export interface FileUploader$FilenameLengthExceedEventParameters { /** * The filename, which is longer than specified by the value of the property `maximumFilenameLength`. */ fileName?: string; } /** * Event object of the FileUploader#filenameLengthExceed event. */ export type FileUploader$FilenameLengthExceedEvent = Event< FileUploader$FilenameLengthExceedEventParameters, FileUploader >; /** * Parameters of the FileUploader#fileSizeExceed event. */ export interface FileUploader$FileSizeExceedEventParameters { /** * The name of a file to be uploaded. */ fileName?: string; /** * The size in MB of a file to be uploaded. */ fileSize?: string; } /** * Event object of the FileUploader#fileSizeExceed event. */ export type FileUploader$FileSizeExceedEvent = Event< FileUploader$FileSizeExceedEventParameters, FileUploader >; /** * Parameters of the FileUploader#typeMissmatch event. */ export interface FileUploader$TypeMissmatchEventParameters { /** * The name of a file to be uploaded. */ fileName?: string; /** * The file ending of a file to be uploaded. */ fileType?: string; /** * The MIME type of a file to be uploaded. */ mimeType?: string; } /** * Event object of the FileUploader#typeMissmatch event. */ export type FileUploader$TypeMissmatchEvent = Event< FileUploader$TypeMissmatchEventParameters, FileUploader >; /** * Parameters of the FileUploader#uploadAborted event. */ export interface FileUploader$UploadAbortedEventParameters { /** * The name of a file to be uploaded. */ fileName?: string; /** * Http-Request-Headers. * * Required for receiving `requestHeader` is to set the property `sendXHR` to true. This property is not * supported by Internet Explorer 9. */ requestHeaders?: object[]; } /** * Event object of the FileUploader#uploadAborted event. */ export type FileUploader$UploadAbortedEvent = Event< FileUploader$UploadAbortedEventParameters, FileUploader >; /** * Parameters of the FileUploader#uploadComplete event. */ export interface FileUploader$UploadCompleteEventParameters { /** * The name of a file to be uploaded. */ fileName?: string; /** * Response message which comes from the server. * * On the server side this response has to be put within the "body" tags of the response document * of the iFrame. It can consist of a return code and an optional message. This does not work in cross-domain * scenarios. */ response?: string; /** * ReadyState of the XHR request. * * Required for receiving a `readyStateXHR` is to set the property `sendXHR` to true. This property is not * supported by Internet Explorer 9. */ readyStateXHR?: string; /** * Status of the XHR request. * * Required for receiving a `status` is to set the property `sendXHR` to true. This property is not supported * by Internet Explorer 9. */ status?: int; /** * Http-Response which comes from the server. * * Required for receiving `responseRaw` is to set the property `sendXHR` to true. * * This property is not supported by Internet Explorer 9. */ responseRaw?: string; /** * Http-Response-Headers which come from the server. * * Provided as a JSON-map, i.e. each header-field is reflected by a property in the `headers` object, with * the property value reflecting the header-field's content. * * Required for receiving `headers` is to set the property `sendXHR` to true. This property is not supported * by Internet Explorer 9. */ headers?: object; /** * Http-Request-Headers. * * Required for receiving `requestHeaders` is to set the property `sendXHR` to true. This property is not * supported by Internet Explorer 9. */ requestHeaders?: object[]; } /** * Event object of the FileUploader#uploadComplete event. */ export type FileUploader$UploadCompleteEvent = Event< FileUploader$UploadCompleteEventParameters, FileUploader >; /** * Parameters of the FileUploader#uploadProgress event. */ export interface FileUploader$UploadProgressEventParameters { /** * Indicates whether or not the relative upload progress can be calculated out of loaded and total. */ lengthComputable?: boolean; /** * The number of bytes of the file which have been uploaded by the time the event was fired. */ loaded?: float; /** * The total size of the file to be uploaded in bytes. */ total?: float; /** * The name of a file to be uploaded. */ fileName?: string; /** * Http-Request-Headers. * * Required for receiving `requestHeaders` is to set the property `sendXHR` to true. This property is not * supported by Internet Explorer 9. */ requestHeaders?: object[]; } /** * Event object of the FileUploader#uploadProgress event. */ export type FileUploader$UploadProgressEvent = Event< FileUploader$UploadProgressEventParameters, FileUploader >; /** * Parameters of the FileUploader#uploadStart event. */ export interface FileUploader$UploadStartEventParameters { /** * The name of a file to be uploaded. */ fileName?: string; /** * Http-Request-Headers. * * Required for receiving `requestHeaders` is to set the property `sendXHR` to true. This property is not * supported by Internet Explorer 9. */ requestHeaders?: object[]; } /** * Event object of the FileUploader#uploadStart event. */ export type FileUploader$UploadStartEvent = Event< FileUploader$UploadStartEventParameters, FileUploader >; } declare module "sap/ui/commons/FileUploaderHttpRequestMethod" { /** * Types of HTTP request methods. * * @since 1.144.0 * @deprecated As of version 1.144.0. Please use the control sap.ui.unified.FileUploaderHttpRequestMethod * of the library sap.ui.unified instead. */ enum FileUploaderHttpRequestMethod { /** * HTTP request POST method. */ Post = "POST", /** * HTTP request PUT method. */ Put = "PUT", } export default FileUploaderHttpRequestMethod; } declare module "sap/ui/commons/FileUploaderParameter" { import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Represents a parameter for the FileUploader which is rendered as a hidden inputfield. * * @deprecated As of version 1.21.0. Please use the control sap.ui.unified.FileUploaderParameter of the * library sap.ui.unified instead. */ export default class FileUploaderParameter extends UI5Element { /** * Constructor for a new FileUploaderParameter. * * 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?: $FileUploaderParameterSettings ); /** * Constructor for a new FileUploaderParameter. * * 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?: $FileUploaderParameterSettings ); /** * Creates a new subclass of class sap.ui.commons.FileUploaderParameter with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @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.ui.commons.FileUploaderParameter. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Gets current value of property {@link #getName name}. * * The name of the hidden inputfield. * * @since 1.12.2 * * @returns Value of property `name` */ getName(): string; /** * Gets current value of property {@link #getValue value}. * * The value of the hidden inputfield. * * @since 1.12.2 * * @returns Value of property `value` */ getValue(): string; /** * Sets a new value for property {@link #getName name}. * * The name of the hidden inputfield. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.12.2 * * @returns Reference to `this` in order to allow method chaining */ setName( /** * New value for property `name` */ sName?: string ): this; /** * Sets a new value for property {@link #getValue value}. * * The value of the hidden inputfield. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.12.2 * * @returns Reference to `this` in order to allow method chaining */ setValue( /** * New value for property `value` */ sValue?: string ): this; } /** * Describes the settings that can be provided to the FileUploaderParameter constructor. * * @deprecated As of version 1.21.0. Please use the control sap.ui.unified.FileUploaderParameter of the * library sap.ui.unified instead. */ export interface $FileUploaderParameterSettings extends $ElementSettings { /** * The name of the hidden inputfield. * * @since 1.12.2 */ name?: string | PropertyBindingInfo; /** * The value of the hidden inputfield. * * @since 1.12.2 */ value?: string | PropertyBindingInfo; } } declare module "sap/ui/commons/FileUploaderXHRSettings" { import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Properties for the `XMLHttpRequest` object used for file uploads. * * @since 1.144 * @deprecated As of version 1.144.0. Please use the control sap.ui.unified.FileUploaderXHRSettings of the * library sap.ui.unified instead. */ export default class FileUploaderXHRSettings extends UI5Element { /** * Constructor for a new FileUploaderXHRSettings. * * 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?: $FileUploaderXHRSettingsSettings ); /** * Constructor for a new FileUploaderXHRSettings. * * 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?: $FileUploaderXHRSettingsSettings ); /** * Creates a new subclass of class sap.ui.commons.FileUploaderXHRSettings with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @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.ui.commons.FileUploaderXHRSettings. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Gets current value of property {@link #getWithCredentials withCredentials}. * * Determines the value of the `XMLHttpRequest.withCredentials` property * * Default value is `false`. * * @since 1.52 * * @returns Value of property `withCredentials` */ getWithCredentials(): boolean; /** * Sets a new value for property {@link #getWithCredentials withCredentials}. * * Determines the value of the `XMLHttpRequest.withCredentials` property * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.52 * * @returns Reference to `this` in order to allow method chaining */ setWithCredentials( /** * New value for property `withCredentials` */ bWithCredentials?: boolean ): this; } /** * Describes the settings that can be provided to the FileUploaderXHRSettings constructor. * * @deprecated As of version 1.144.0. Please use the control sap.ui.unified.FileUploaderXHRSettings of the * library sap.ui.unified instead. */ export interface $FileUploaderXHRSettingsSettings extends $ElementSettings { /** * Determines the value of the `XMLHttpRequest.withCredentials` property * * @since 1.52 */ withCredentials?: boolean | PropertyBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/TextField" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { ToolbarItem } from "sap/ui/commons/library"; import { IFormContent, ID, AccessibilityInfo, AccessibleRole, Design, ImeMode, TextAlign, TextDirection, ValueState, CSSSize, } from "sap/ui/core/library"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import Event from "sap/ui/base/Event"; /** * The object representing the serialized focus information. * * @since 1.110 * @deprecated As of version 1.110. as it is an integral part of the already deprecated {@link sap.ui.commons.TextField}. * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ export type FocusInfo = { /** * ID of the component * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ id?: string; /** * User input * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ userinput?: /* was: sap.ui.commons.UserInputInfo */ any | null; }; /** * Renders an input field for text input. * * @deprecated As of version 1.38. replaced by {@link sap.m.Input} */ export default class TextField extends Control implements ToolbarItem, IFormContent { __implements__sap_ui_commons_ToolbarItem: boolean; __implements__sap_ui_core_IFormContent: boolean; /** * Constructor for a new TextField. * * 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?: $TextFieldSettings ); /** * Constructor for a new TextField. * * 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?: $TextFieldSettings ); /** * Creates a new subclass of class sap.ui.commons.TextField with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.TextField. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Compares the previous value with the current value and fires the change event if the TextField is editable * and the value has changed. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ _checkChange( /** * The event object. */ oEvent: jQuery.Event ): void; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaDescribedBy( /** * The ariaDescribedBy to add; if empty, nothing is inserted */ vAriaDescribedBy: ID | Control ): this; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaLabelledBy( /** * The ariaLabelledBy to add; if empty, nothing is inserted */ vAriaLabelledBy: ID | Control ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.commons.TextField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.TextField` itself. * * Event is fired when the text in the field has changed AND the focus leaves the TextField or the Enter * key is pressed. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: TextField$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.TextField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.commons.TextField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.TextField` itself. * * Event is fired when the text in the field has changed AND the focus leaves the TextField or the Enter * key is pressed. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * The function to be called when the event occurs */ fnFunction: (p1: TextField$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.TextField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:liveChange liveChange} event of this `sap.ui.commons.TextField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.TextField` itself. * * This event if fired during typing into the `TextField` and returns the currently entered value. **Note:** * This is not the content of the value property. The value property is only updated by ENTER and by leaving * the control. * * * @returns Reference to `this` in order to allow method chaining */ attachLiveChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: TextField$LiveChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.TextField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:liveChange liveChange} event of this `sap.ui.commons.TextField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.TextField` itself. * * This event if fired during typing into the `TextField` and returns the currently entered value. **Note:** * This is not the content of the value property. The value property is only updated by ENTER and by leaving * the control. * * * @returns Reference to `this` in order to allow method chaining */ attachLiveChange( /** * The function to be called when the event occurs */ fnFunction: (p1: TextField$LiveChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.TextField` itself */ oListener?: object ): this; /** * Binds property {@link #getValue value} to model data. * * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description * of the possible properties of `oBindingInfo` * * * @returns Reference to `this` in order to allow method chaining */ bindValue( /** * The binding information */ oBindingInfo: PropertyBindingInfo ): this; /** * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.commons.TextField`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: TextField$ChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:liveChange liveChange} event of this `sap.ui.commons.TextField`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachLiveChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: TextField$LiveChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:change change} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireChange( /** * Parameters to pass along with the event */ mParameters?: TextField$ChangeEventParameters ): this; /** * Fires event {@link #event:liveChange liveChange} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireLiveChange( /** * Parameters to pass along with the event */ mParameters?: TextField$LiveChangeEventParameters ): this; /** * See: * sap.ui.core.Control#getAccessibilityInfo * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Current accessibility state of the control */ getAccessibilityInfo(): AccessibilityInfo; /** * Gets current value of property {@link #getAccessibleRole accessibleRole}. * * Accessibility role for the text field. * * Default value is `Textbox`. * * * @returns Value of property `accessibleRole` */ getAccessibleRole(): AccessibleRole; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): ID[]; /** * Gets current value of property {@link #getDesign design}. * * Font type. valid values are Standard and Monospace. * * Default value is `Standard`. * * * @returns Value of property `design` */ getDesign(): Design; /** * Gets current value of property {@link #getEditable editable}. * * Switches edit state of the control. Read-only fields have different colors, depending on theme setting. * * Default value is `true`. * * * @returns Value of property `editable` */ getEditable(): boolean; /** * Gets current value of property {@link #getEnabled enabled}. * * Switches enabled state of the control. Disabled fields have different colors, and can not be focused. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Returns an object representing the serialized focus information * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns an object representing the serialized focus information */ getFocusInfo(): FocusInfo; /** * Gets current value of property {@link #getHelpId helpId}. * * Unique identifier used for help service. * * Default value is `empty string`. * * * @returns Value of property `helpId` */ getHelpId(): string; /** * Gets current value of property {@link #getImeMode imeMode}. * * State of the Input Method Editor (IME). * * Default value is `Auto`. * * * @returns Value of property `imeMode` */ getImeMode(): ImeMode; /** * Method for accessing the DOM Ref of the input element. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns DOM reference or `null` */ getInputDomRef(): HTMLElement | null; /** * Returns the current value of the `TextField`. In case of editing the `TextField` you can access the current * value via this method. The validated value is accessible via the property value. * * * @returns live value */ getLiveValue(): string; /** * Gets current value of property {@link #getMaxLength maxLength}. * * Maximum number of characters. Value '0' means the feature is switched off. * * Default value is `0`. * * * @returns Value of property `maxLength` */ getMaxLength(): int; /** * Gets current value of property {@link #getName name}. * * The `name` property to be used in the HTML code (e.g. for HTML forms that send data to the server via * 'submit'). * * * @returns Value of property `name` */ getName(): string; /** * Gets current value of property {@link #getPlaceholder placeholder}. * * Placeholder for the text field. * * @since 1.14.0 * * @returns Value of property `placeholder` */ getPlaceholder(): string; /** * Gets current value of property {@link #getRequired required}. * * Depending on theme the `TextField` is shown as required. If a `Label` is assigned to the `TextField` * it will visualize the requires state too. * * Default value is `false`. * * * @returns Value of property `required` */ getRequired(): boolean; /** * Gets current value of property {@link #getTextAlign textAlign}. * * Sets the horizontal alignment of the text. * * Default value is `Begin`. * * * @returns Value of property `textAlign` */ getTextAlign(): TextAlign; /** * Gets current value of property {@link #getTextDirection textDirection}. * * Direction of the text. Possible values: "rtl", "ltr". * * Default value is `Inherit`. * * * @returns Value of property `textDirection` */ getTextDirection(): TextDirection; /** * Gets current value of property {@link #getValue value}. * * Text inside the `TextField` * * Default value is `empty string`. * * * @returns Value of property `value` */ getValue(): string; /** * Gets current value of property {@link #getValueState valueState}. * * Visualizes warnings or errors related to the text field. Possible values: Warning, Error, Success. * * Default value is `None`. * * * @returns Value of property `valueState` */ getValueState(): ValueState; /** * Gets current value of property {@link #getWidth width}. * * Width of text field. When it is set (CSS-size such as % or px), this is the exact size. When left blank, * the text field length defines the width. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Event handler called when control is receiving the focus * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onfocusin( /** * The event object. */ oEvent: jQuery.Event ): void; /** * Event handler for keyup. fire the liveChange event * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onkeyup( /** * The event object. */ oEvent: jQuery.Event ): void; /** * Event handler called when enter key is pressed. * See: * sap.ui.commons.TextField#onfocusout * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onsapenter( /** * The event object. */ oEvent: jQuery.Event ): void; /** * Event handler called when control is losing the focus * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onsapfocusleave( /** * The event object. */ oEvent: jQuery.Event ): void; /** * Event handler called when text selection starts. When the text field is disabled, the text should not * be selectable, so cancel the event. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onselectstart( /** * The event object. */ oEvent: jQuery.Event ): void; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaDescribedBy(): ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): ID[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns The removed ariaDescribedBy or `null` */ removeAriaDescribedBy( /** * The ariaDescribedBy to be removed or its index or ID */ vAriaDescribedBy: int | ID | Control ): ID | null; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns The removed ariaLabelledBy or `null` */ removeAriaLabelledBy( /** * The ariaLabelledBy to be removed or its index or ID */ vAriaLabelledBy: int | ID | Control ): ID | null; /** * Sets a new value for property {@link #getAccessibleRole accessibleRole}. * * Accessibility role for the text field. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Textbox`. * * * @returns Reference to `this` in order to allow method chaining */ setAccessibleRole( /** * New value for property `accessibleRole` */ sAccessibleRole?: AccessibleRole | keyof typeof AccessibleRole ): this; /** * Sets a new value for property {@link #getDesign design}. * * Font type. valid values are Standard and Monospace. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Standard`. * * * @returns Reference to `this` in order to allow method chaining */ setDesign( /** * New value for property `design` */ sDesign?: Design | keyof typeof Design ): this; /** * Sets a new value for property {@link #getEditable editable}. * * Switches edit state of the control. Read-only fields have different colors, depending on theme setting. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEditable( /** * New value for property `editable` */ bEditable?: boolean ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * Switches enabled state of the control. Disabled fields have different colors, and can not be focused. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getHelpId helpId}. * * Unique identifier used for help service. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setHelpId( /** * New value for property `helpId` */ sHelpId?: string ): this; /** * Sets a new value for property {@link #getImeMode imeMode}. * * State of the Input Method Editor (IME). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Auto`. * * * @returns Reference to `this` in order to allow method chaining */ setImeMode( /** * New value for property `imeMode` */ sImeMode?: ImeMode | keyof typeof ImeMode ): this; /** * Sets a new value for property {@link #getMaxLength maxLength}. * * Maximum number of characters. Value '0' means the feature is switched off. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setMaxLength( /** * New value for property `maxLength` */ iMaxLength?: int ): this; /** * Sets a new value for property {@link #getName name}. * * The `name` property to be used in the HTML code (e.g. for HTML forms that send data to the server via * 'submit'). * * 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 */ setName( /** * New value for property `name` */ sName?: string ): this; /** * Sets a new value for property {@link #getPlaceholder placeholder}. * * Placeholder for the text field. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.14.0 * * @returns Reference to `this` in order to allow method chaining */ setPlaceholder( /** * New value for property `placeholder` */ sPlaceholder?: string ): this; /** * Sets a new value for property {@link #getRequired required}. * * Depending on theme the `TextField` is shown as required. If a `Label` is assigned to the `TextField` * it will visualize the requires state too. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setRequired( /** * New value for property `required` */ bRequired?: boolean ): this; /** * Sets a new value for property {@link #getTextAlign textAlign}. * * Sets the horizontal alignment of the text. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Begin`. * * * @returns Reference to `this` in order to allow method chaining */ setTextAlign( /** * New value for property `textAlign` */ sTextAlign?: TextAlign | keyof typeof TextAlign ): this; /** * Sets a new value for property {@link #getTextDirection textDirection}. * * Direction of the text. Possible values: "rtl", "ltr". * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Inherit`. * * * @returns Reference to `this` in order to allow method chaining */ setTextDirection( /** * New value for property `textDirection` */ sTextDirection?: TextDirection | keyof typeof TextDirection ): this; /** * Sets a new value for property {@link #getValue value}. * * Text inside the `TextField` * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setValue( /** * New value for property `value` */ sValue?: string ): this; /** * Sets a new value for property {@link #getValueState valueState}. * * Visualizes warnings or errors related to the text field. Possible values: Warning, Error, Success. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `None`. * * * @returns Reference to `this` in order to allow method chaining */ setValueState( /** * New value for property `valueState` */ sValueState?: ValueState | keyof typeof ValueState ): this; /** * Sets a new value for property {@link #getWidth width}. * * Width of text field. When it is set (CSS-size such as % or px), this is the exact size. When left blank, * the text field length defines the width. * * 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 */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; /** * Unbinds property {@link #getValue value} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindValue(): this; } /** * Describes the settings that can be provided to the TextField constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.Input} */ export interface $TextFieldSettings extends $ControlSettings { /** * Text inside the `TextField` */ value?: string | PropertyBindingInfo; /** * Direction of the text. Possible values: "rtl", "ltr". */ textDirection?: | (TextDirection | keyof typeof TextDirection) | PropertyBindingInfo | `{${string}}`; /** * Switches enabled state of the control. Disabled fields have different colors, and can not be focused. */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * Switches edit state of the control. Read-only fields have different colors, depending on theme setting. */ editable?: boolean | PropertyBindingInfo | `{${string}}`; /** * Depending on theme the `TextField` is shown as required. If a `Label` is assigned to the `TextField` * it will visualize the requires state too. */ required?: boolean | PropertyBindingInfo | `{${string}}`; /** * Width of text field. When it is set (CSS-size such as % or px), this is the exact size. When left blank, * the text field length defines the width. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Maximum number of characters. Value '0' means the feature is switched off. */ maxLength?: int | PropertyBindingInfo | `{${string}}`; /** * Visualizes warnings or errors related to the text field. Possible values: Warning, Error, Success. */ valueState?: | (ValueState | keyof typeof ValueState) | PropertyBindingInfo | `{${string}}`; /** * Sets the horizontal alignment of the text. */ textAlign?: | (TextAlign | keyof typeof TextAlign) | PropertyBindingInfo | `{${string}}`; /** * State of the Input Method Editor (IME). */ imeMode?: | (ImeMode | keyof typeof ImeMode) | PropertyBindingInfo | `{${string}}`; /** * Font type. valid values are Standard and Monospace. */ design?: | (Design | keyof typeof Design) | PropertyBindingInfo | `{${string}}`; /** * Unique identifier used for help service. */ helpId?: string | PropertyBindingInfo; /** * Accessibility role for the text field. */ accessibleRole?: | (AccessibleRole | keyof typeof AccessibleRole) | PropertyBindingInfo | `{${string}}`; /** * The `name` property to be used in the HTML code (e.g. for HTML forms that send data to the server via * 'submit'). */ name?: string | PropertyBindingInfo; /** * Placeholder for the text field. * * @since 1.14.0 */ placeholder?: string | PropertyBindingInfo; /** * Association to controls / IDs which describe this control (see WAI-ARIA attribute aria-describedby). */ ariaDescribedBy?: Array; /** * Association to controls / IDs which label this control (see WAI-ARIA attribute aria-labelledby). */ ariaLabelledBy?: Array; /** * Event is fired when the text in the field has changed AND the focus leaves the TextField or the Enter * key is pressed. */ change?: (oEvent: TextField$ChangeEvent) => void; /** * This event if fired during typing into the `TextField` and returns the currently entered value. **Note:** * This is not the content of the value property. The value property is only updated by ENTER and by leaving * the control. */ liveChange?: (oEvent: TextField$LiveChangeEvent) => void; } /** * Parameters of the TextField#change event. */ export interface TextField$ChangeEventParameters { /** * The new / changed value of the `TextField`. */ newValue?: string; } /** * Event object of the TextField#change event. */ export type TextField$ChangeEvent = Event< TextField$ChangeEventParameters, TextField >; /** * Parameters of the TextField#liveChange event. */ export interface TextField$LiveChangeEventParameters { /** * Current visible value of the `TextField`. */ liveValue?: string; } /** * Event object of the TextField#liveChange event. */ export type TextField$LiveChangeEvent = Event< TextField$LiveChangeEventParameters, TextField >; } declare module "sap/ui/commons/form/Form" { import { default as Form1, $FormSettings as $FormSettings1, } from "sap/ui/layout/form/Form"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * Form control. Holder for form control to be rendered in a specific form layout. A Form supports VariantLayoutData * for it's conent to allow a simple switching of Layouts. * * @since 1.9.1 * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export default class Form extends Form1 { /** * Constructor for a new form/Form. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.form.Form#constructor sap.ui.layout.form.Form } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: $FormSettings ); /** * Constructor for a new form/Form. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.form.Form#constructor sap.ui.layout.form.Form } * can be used. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: $FormSettings ); /** * Creates a new subclass of class sap.ui.commons.form.Form with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.form.Form.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.ui.commons.form.Form. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Getter for property `visible`. Invisible Forms are not rendered. * * Default value is `true` * * @since 1.12.0 * * @returns the value of property `visible` */ getVisible(): boolean; /** * Setter for property `visible`. * * Default value is `true` * * @since 1.12.0 * * @returns `this` to allow method chaining */ setVisible( /** * new value for property `visible` */ bVisible: boolean ): this; } /** * Describes the settings that can be provided to the Form constructor. * * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export interface $FormSettings extends $FormSettings1 {} } declare module "sap/ui/commons/form/FormContainer" { import { default as FormContainer1, $FormContainerSettings as $FormContainerSettings1, } from "sap/ui/layout/form/FormContainer"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * Used to group form elements. * * @since 1.9.1 * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export default class FormContainer extends FormContainer1 { /** * Constructor for a new form/FormContainer. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.form.FormContainer#constructor sap.ui.layout.form.FormContainer } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: $FormContainerSettings ); /** * Constructor for a new form/FormContainer. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.form.FormContainer#constructor sap.ui.layout.form.FormContainer } * can be used. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: $FormContainerSettings ); /** * Creates a new subclass of class sap.ui.commons.form.FormContainer with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.form.FormContainer.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.ui.commons.form.FormContainer. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Getter for property `visible`. Invisible FormContainers are not rendered. * * Default value is `true` * * @since 1.12.0 * * @returns the value of property `visible` */ getVisible(): boolean; /** * Setter for property `visible`. * * Default value is `true` * * @since 1.12.0 * * @returns `this` to allow method chaining */ setVisible( /** * new value for property `visible` */ bVisible: boolean ): this; } /** * Describes the settings that can be provided to the FormContainer constructor. * * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export interface $FormContainerSettings extends $FormContainerSettings1 {} } declare module "sap/ui/commons/form/FormElement" { import { default as FormElement1, $FormElementSettings as $FormElementSettings1, } from "sap/ui/layout/form/FormElement"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * A form element is a combination of one label and different controls associated to this label. * * @since 1.9.1 * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export default class FormElement extends FormElement1 { /** * Constructor for a new form/FormElement. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.form.FormElement#constructor sap.ui.layout.form.FormElement } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: $FormElementSettings ); /** * Constructor for a new form/FormElement. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.form.FormElement#constructor sap.ui.layout.form.FormElement } * can be used. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: $FormElementSettings ); /** * Creates a new subclass of class sap.ui.commons.form.FormElement with name `sClassName` and enriches it * with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.form.FormElement.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.ui.commons.form.FormElement. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Getter for property `visible`. Invisible FormElements are not rendered. * * Default value is `true` * * @since 1.12.0 * * @returns the value of property `visible` */ getVisible(): boolean; /** * Setter for property `visible`. * * Default value is `true` * * @since 1.12.0 * * @returns `this` to allow method chaining */ setVisible( /** * new value for property `visible` */ bVisible: boolean ): this; } /** * Describes the settings that can be provided to the FormElement constructor. * * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export interface $FormElementSettings extends $FormElementSettings1 {} } declare module "sap/ui/commons/form/FormLayout" { import { default as FormLayout1, $FormLayoutSettings as $FormLayoutSettings1, } from "sap/ui/layout/form/FormLayout"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * Base layout for Forms. Other Layouts must inherit from this one. * * @since 1.9.1 * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export default class FormLayout extends FormLayout1 { /** * Constructor for a new form/FormLayout. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.form.FormLayout#constructor sap.ui.layout.form.FormLayout } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: $FormLayoutSettings ); /** * Constructor for a new form/FormLayout. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.form.FormLayout#constructor sap.ui.layout.form.FormLayout } * can be used. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: $FormLayoutSettings ); /** * Creates a new subclass of class sap.ui.commons.form.FormLayout with name `sClassName` and enriches it * with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.form.FormLayout.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.ui.commons.form.FormLayout. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; } /** * Describes the settings that can be provided to the FormLayout constructor. * * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export interface $FormLayoutSettings extends $FormLayoutSettings1 {} } declare module "sap/ui/commons/form/GridContainerData" { import { default as GridContainerData1, $GridContainerDataSettings as $GridContainerDataSettings1, } from "sap/ui/layout/form/GridContainerData"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * Grid layout specific properties for FormContainers. The width and height properties of the elements are * ignored since the witdh and heights are defined by the grid cells. * * @since 1.9.1 * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export default class GridContainerData extends GridContainerData1 { /** * Constructor for a new form/GridContainerData. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.form.GridContainerData#constructor sap.ui.layout.form.GridContainerData } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: $GridContainerDataSettings ); /** * Constructor for a new form/GridContainerData. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.form.GridContainerData#constructor sap.ui.layout.form.GridContainerData } * can be used. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: $GridContainerDataSettings ); /** * Creates a new subclass of class sap.ui.commons.form.GridContainerData with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.form.GridContainerData.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.ui.commons.form.GridContainerData. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; } /** * Describes the settings that can be provided to the GridContainerData constructor. * * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export interface $GridContainerDataSettings extends $GridContainerDataSettings1 {} } declare module "sap/ui/commons/form/GridElementData" { import { default as GridElementData1, $GridElementDataSettings as $GridElementDataSettings1, } from "sap/ui/layout/form/GridElementData"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * The grid specific layout data for FormElement fields. The width property of the elements is ignored since * the width is defined by grid cells. * * @since 1.9.1 * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export default class GridElementData extends GridElementData1 { /** * Constructor for a new form/GridElementData. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.form.GridElementData#constructor sap.ui.layout.form.GridElementData } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: $GridElementDataSettings ); /** * Constructor for a new form/GridElementData. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.form.GridElementData#constructor sap.ui.layout.form.GridElementData } * can be used. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: $GridElementDataSettings ); /** * Creates a new subclass of class sap.ui.commons.form.GridElementData with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.form.GridElementData.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.ui.commons.form.GridElementData. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; } /** * Describes the settings that can be provided to the GridElementData constructor. * * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export interface $GridElementDataSettings extends $GridElementDataSettings1 {} } declare module "sap/ui/commons/form/GridLayout" { import { default as GridLayout1, $GridLayoutSettings as $GridLayoutSettings1, } from "sap/ui/layout/form/GridLayout"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * This Layout implements a guideline 2.0 grid. This can be a 16 column grid or an 8 column grid. * * To adjust the content inside the GridLayout GridContainerData and GridElementData could be used. * * @since 1.9.1 * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export default class GridLayout extends GridLayout1 { /** * Constructor for a new form/GridLayout. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.form.GridLayout#constructor sap.ui.layout.form.GridLayout } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: $GridLayoutSettings ); /** * Constructor for a new form/GridLayout. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.form.GridLayout#constructor sap.ui.layout.form.GridLayout } * can be used. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: $GridLayoutSettings ); /** * Creates a new subclass of class sap.ui.commons.form.GridLayout with name `sClassName` and enriches it * with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.form.GridLayout.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.ui.commons.form.GridLayout. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; } /** * Describes the settings that can be provided to the GridLayout constructor. * * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export interface $GridLayoutSettings extends $GridLayoutSettings1 {} } declare module "sap/ui/commons/form/ResponsiveLayout" { import { default as ResponsiveLayout1, $ResponsiveLayoutSettings as $ResponsiveLayoutSettings1, } from "sap/ui/layout/form/ResponsiveLayout"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * Renders a form with responsive layout. Internally the ResponsiveFlowLayout is used. * * @since 1.10.0 * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export default class ResponsiveLayout extends ResponsiveLayout1 { /** * Constructor for a new form/ResponsiveLayout. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.form.ResponsiveLayout#constructor sap.ui.layout.form.ResponsiveLayout } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: $ResponsiveLayoutSettings ); /** * Constructor for a new form/ResponsiveLayout. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.form.ResponsiveLayout#constructor sap.ui.layout.form.ResponsiveLayout } * can be used. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: $ResponsiveLayoutSettings ); /** * Creates a new subclass of class sap.ui.commons.form.ResponsiveLayout with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.form.ResponsiveLayout.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.ui.commons.form.ResponsiveLayout. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; } /** * Describes the settings that can be provided to the ResponsiveLayout constructor. * * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export interface $ResponsiveLayoutSettings extends $ResponsiveLayoutSettings1 {} } declare module "sap/ui/commons/form/SimpleForm" { import { default as SimpleForm1, $SimpleFormSettings as $SimpleFormSettings1, } from "sap/ui/layout/form/SimpleForm"; import { form } from "sap/ui/layout/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Use the SimpleForm to create a form based on title, label and fields that are stacked in the content * aggregation. Add Title to start a new FormContainer(Group). Add Label to start a new row in the container. * Add Input/Display controls as needed. Use LayoutData to influence the layout for special cases in the * Input/Display controls. * * @since 1.12 * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export default class SimpleForm extends SimpleForm1 { /** * Constructor for a new form/SimpleForm. * * 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?: $SimpleFormSettings ); /** * Constructor for a new form/SimpleForm. * * 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?: $SimpleFormSettings ); /** * Creates a new subclass of class sap.ui.commons.form.SimpleForm with name `sClassName` and enriches it * with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.form.SimpleForm.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.ui.commons.form.SimpleForm. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Gets current value of property {@link #getLayout layout}. * * The `FormLayout` that is used to render the `SimpleForm`. * * We recommend using the `GridLayout` for rendering a `SimpleForm` in `sap.ui.commons` library, as responsive * layouts are not designed for this library. * * **Note** If possible, set the `layout` before adding content to prevent calculations for the default * layout. * * **Note** The `ResponsiveLayout` has been deprecated and must no longer be used. * * Default value is `ResponsiveLayout`. * * @since 1.14 * * @returns Value of property `layout` */ getLayout(): form.SimpleFormLayout; /** * Sets a new value for property {@link #getLayout layout}. * * The `FormLayout` that is used to render the `SimpleForm`. * * We recommend using the `GridLayout` for rendering a `SimpleForm` in `sap.ui.commons` library, as responsive * layouts are not designed for this library. * * **Note** If possible, set the `layout` before adding content to prevent calculations for the default * layout. * * **Note** The `ResponsiveLayout` has been deprecated and must no longer be used. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `ResponsiveLayout`. * * @since 1.14 * * @returns Reference to `this` in order to allow method chaining */ setLayout( /** * New value for property `layout` */ sLayout?: form.SimpleFormLayout | keyof typeof form.SimpleFormLayout ): this; } /** * Describes the settings that can be provided to the SimpleForm constructor. * * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export interface $SimpleFormSettings extends $SimpleFormSettings1 { /** * The `FormLayout` that is used to render the `SimpleForm`. * * We recommend using the `GridLayout` for rendering a `SimpleForm` in `sap.ui.commons` library, as responsive * layouts are not designed for this library. * * **Note** If possible, set the `layout` before adding content to prevent calculations for the default * layout. * * **Note** The `ResponsiveLayout` has been deprecated and must no longer be used. * * @since 1.14 */ layout?: | (form.SimpleFormLayout | keyof typeof form.SimpleFormLayout) | PropertyBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/FormattedTextView" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { AccessibleRole } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { FormattedTextViewControl } from "sap/ui/commons/library"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; /** * The FormattedTextView control allows the usage of a limited set of HTML tags for display. * * @since 1.9.0 * @deprecated As of version 1.38. Instead, use the `sap.ui.core.HTML` control. */ export default class FormattedTextView extends Control { /** * Constructor for a new FormattedTextView. * * 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?: $FormattedTextViewSettings ); /** * Constructor for a new FormattedTextView. * * 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?: $FormattedTextViewSettings ); /** * Creates a new subclass of class sap.ui.commons.FormattedTextView with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.FormattedTextView. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some control to the aggregation {@link #getControls controls}. * * * @returns Reference to `this` in order to allow method chaining */ addControl( /** * The control to add; if empty, nothing is inserted */ oControl: Control ): this; /** * Destroys all the controls in the aggregation {@link #getControls controls}. * * * @returns Reference to `this` in order to allow method chaining */ destroyControls(): this; /** * Gets current value of property {@link #getAccessibleRole accessibleRole}. * * The ARIA role for the control. * * Default value is `Document`. * * * @returns Value of property `accessibleRole` */ getAccessibleRole(): AccessibleRole; /** * Gets content of aggregation {@link #getControls controls}. * * Array of controls that should be replaced within htmlText. */ getControls(): Control[]; /** * Gets current value of property {@link #getHtmlText htmlText}. * * Determines text with placeholders. * * Default value is `empty string`. * * * @returns Value of property `htmlText` */ getHtmlText(): string; /** * Indicates whether the FormattedTextView contains other controls. */ hasControls(): boolean; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getControls controls}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfControl( /** * The control whose index is looked for */ oControl: Control ): int; /** * Inserts a control into the aggregation {@link #getControls controls}. * * * @returns Reference to `this` in order to allow method chaining */ insertControl( /** * The control to insert; if empty, nothing is inserted */ oControl: Control, /** * The `0`-based index the control should be inserted at; for a negative value of `iIndex`, the control * is inserted at position 0; for a value greater than the current size of the aggregation, the control * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getControls controls}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllControls(): Control[]; /** * Removes a control from the aggregation {@link #getControls controls}. * * * @returns The removed control or `null` */ removeControl( /** * The control to remove or its index or id */ vControl: int | string | Control ): Control | null; /** * Sets a new value for property {@link #getAccessibleRole accessibleRole}. * * The ARIA role for the control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Document`. * * * @returns Reference to `this` in order to allow method chaining */ setAccessibleRole( /** * New value for property `accessibleRole` */ sAccessibleRole?: AccessibleRole | keyof typeof AccessibleRole ): this; /** * Sets text with placeholders and given array of controls. */ setContent( /** * Contains the corresponding HTML text */ sHtmlText: string, /** * Array of controls that should be used within given HTML text */ aControls: FormattedTextViewControl ): void; /** * Sets the HTML text to be displayed. */ setHtmlText( /** * HTML text as a string */ sText: string ): void; } /** * Describes the settings that can be provided to the FormattedTextView constructor. * * @deprecated As of version 1.38. Instead, use the `sap.ui.core.HTML` control. */ export interface $FormattedTextViewSettings extends $ControlSettings { /** * The ARIA role for the control. */ accessibleRole?: | (AccessibleRole | keyof typeof AccessibleRole) | PropertyBindingInfo | `{${string}}`; /** * Determines text with placeholders. */ htmlText?: string | PropertyBindingInfo; /** * Array of controls that should be replaced within htmlText. */ controls?: Control[] | Control | AggregationBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/HorizontalDivider" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { HorizontalDividerHeight, HorizontalDividerType, } from "sap/ui/commons/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { CSSSize } from "sap/ui/core/library"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Divides the screen in visual areas. * * @deprecated As of version 1.38. Use the layout controls instead, e.g {@link sap.ui.layout.Splitter} or * {@link sap.ui.layout.BlockLayout} among others. */ export default class HorizontalDivider extends Control { /** * Constructor for a new HorizontalDivider. * * 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?: $HorizontalDividerSettings ); /** * Constructor for a new HorizontalDivider. * * 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?: $HorizontalDividerSettings ); /** * Creates a new subclass of class sap.ui.commons.HorizontalDivider with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.HorizontalDivider. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Gets current value of property {@link #getHeight height}. * * Defines the height of the divider. * * Default value is `Medium`. * * * @returns Value of property `height` */ getHeight(): HorizontalDividerHeight; /** * Gets current value of property {@link #getType type}. * * Defines the type of the divider. * * Default value is `Area`. * * * @returns Value of property `type` */ getType(): HorizontalDividerType; /** * Gets current value of property {@link #getWidth width}. * * Defines the width of the divider. * * Default value is `'100%'`. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Sets a new value for property {@link #getHeight height}. * * Defines the height of the divider. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Medium`. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ sHeight?: HorizontalDividerHeight | keyof typeof HorizontalDividerHeight ): this; /** * Sets a new value for property {@link #getType type}. * * Defines the type of the divider. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Area`. * * * @returns Reference to `this` in order to allow method chaining */ setType( /** * New value for property `type` */ sType?: HorizontalDividerType | keyof typeof HorizontalDividerType ): this; /** * Sets a new value for property {@link #getWidth width}. * * Defines the width of the divider. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'100%'`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; } /** * Describes the settings that can be provided to the HorizontalDivider constructor. * * @deprecated As of version 1.38. Use the layout controls instead, e.g {@link sap.ui.layout.Splitter} or * {@link sap.ui.layout.BlockLayout} among others. */ export interface $HorizontalDividerSettings extends $ControlSettings { /** * Defines the width of the divider. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Defines the type of the divider. */ type?: | (HorizontalDividerType | keyof typeof HorizontalDividerType) | PropertyBindingInfo | `{${string}}`; /** * Defines the height of the divider. */ height?: | (HorizontalDividerHeight | keyof typeof HorizontalDividerHeight) | PropertyBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/Image" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { ToolbarItem, FormattedTextViewControl, } from "sap/ui/commons/library"; import { IFormContent, CSSSize, URI } from "sap/ui/core/library"; import Event from "sap/ui/base/Event"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * A wrapper around the IMG tag. The image can be loaded from a remote or local server. There are various * size setting options available, and the images can be combined with actions. * * @deprecated As of version 1.38. replaced by {@link sap.m.Image} */ export default class Image extends Control implements ToolbarItem, FormattedTextViewControl, IFormContent { __implements__sap_ui_commons_ToolbarItem: boolean; __implements__sap_ui_commons_FormattedTextViewControl: boolean; __implements__sap_ui_core_IFormContent: boolean; /** * Constructor for a new Image. * * 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?: $ImageSettings ); /** * Constructor for a new Image. * * 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?: $ImageSettings ); /** * Creates a new subclass of class sap.ui.commons.Image with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.Image. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.commons.Image`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Image` itself. * * Event is fired when the user clicks on the control. * * * @returns Reference to `this` in order to allow method chaining */ attachPress( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Image` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.commons.Image`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Image` itself. * * Event is fired when the user clicks on the control. * * * @returns Reference to `this` in order to allow method chaining */ attachPress( /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Image` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.commons.Image`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachPress( /** * The function to be called, when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:press press} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ firePress( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Gets current value of property {@link #getAlt alt}. * * The alternative text that is displayed in case the Image is not available, or cannot be displayed. If * the image is set to decorative this property is ignored. * * * @returns Value of property `alt` */ getAlt(): string; /** * Gets current value of property {@link #getDecorative decorative}. * * A decorative image is included for design reasons. Accessibility tools will ignore decorative images. * Note: If the Image has an image map (useMap is set), this property will be overridden (the image will * not be rendered as decorative). A decorative image has no ALT attribute, so the Alt property is ignored * if the image is decorative. * * Default value is `true`. * * * @returns Value of property `decorative` */ getDecorative(): boolean; /** * Gets current value of property {@link #getHeight height}. * * When the empty value is kept, the original size is not changed. It is also possible to make settings * for width or height only, the overall size is maintained then, considering the aspect ratio. * * * @returns Value of property `height` */ getHeight(): CSSSize; /** * Gets current value of property {@link #getSrc src}. * * Relative or absolute path to URL where the image file is stored. * * * @returns Value of property `src` */ getSrc(): URI; /** * Gets current value of property {@link #getUseMap useMap}. * * The name of the image map that defines the clickable areas * * * @returns Value of property `useMap` */ getUseMap(): string; /** * Gets current value of property {@link #getWidth width}. * * When the empty value is kept, the original size is not changed. It is also possible to make settings * for width or height only, the overall size is maintained then, considering the aspect ratio. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Sets a new value for property {@link #getAlt alt}. * * The alternative text that is displayed in case the Image is not available, or cannot be displayed. If * the image is set to decorative this property is ignored. * * 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 */ setAlt( /** * New value for property `alt` */ sAlt?: string ): this; /** * Sets a new value for property {@link #getDecorative decorative}. * * A decorative image is included for design reasons. Accessibility tools will ignore decorative images. * Note: If the Image has an image map (useMap is set), this property will be overridden (the image will * not be rendered as decorative). A decorative image has no ALT attribute, so the Alt property is ignored * if the image is decorative. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setDecorative( /** * New value for property `decorative` */ bDecorative?: boolean ): this; /** * Sets a new value for property {@link #getHeight height}. * * When the empty value is kept, the original size is not changed. It is also possible to make settings * for width or height only, the overall size is maintained then, considering the aspect ratio. * * 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 */ setHeight( /** * New value for property `height` */ sHeight?: CSSSize ): this; /** * Sets a new value for property {@link #getSrc src}. * * Relative or absolute path to URL where the image file is stored. * * 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 */ setSrc( /** * New value for property `src` */ sSrc?: URI ): this; /** * Sets a new value for property {@link #getUseMap useMap}. * * The name of the image map that defines the clickable areas * * 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 */ setUseMap( /** * New value for property `useMap` */ sUseMap?: string ): this; /** * Sets a new value for property {@link #getWidth width}. * * When the empty value is kept, the original size is not changed. It is also possible to make settings * for width or height only, the overall size is maintained then, considering the aspect ratio. * * 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 */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; } /** * Describes the settings that can be provided to the Image constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.Image} */ export interface $ImageSettings extends $ControlSettings { /** * Relative or absolute path to URL where the image file is stored. */ src?: URI | PropertyBindingInfo | `{${string}}`; /** * When the empty value is kept, the original size is not changed. It is also possible to make settings * for width or height only, the overall size is maintained then, considering the aspect ratio. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * When the empty value is kept, the original size is not changed. It is also possible to make settings * for width or height only, the overall size is maintained then, considering the aspect ratio. */ height?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * A decorative image is included for design reasons. Accessibility tools will ignore decorative images. * Note: If the Image has an image map (useMap is set), this property will be overridden (the image will * not be rendered as decorative). A decorative image has no ALT attribute, so the Alt property is ignored * if the image is decorative. */ decorative?: boolean | PropertyBindingInfo | `{${string}}`; /** * The alternative text that is displayed in case the Image is not available, or cannot be displayed. If * the image is set to decorative this property is ignored. */ alt?: string | PropertyBindingInfo; /** * The name of the image map that defines the clickable areas */ useMap?: string | PropertyBindingInfo; /** * Event is fired when the user clicks on the control. */ press?: (oEvent: Event) => void; } /** * Parameters of the Image#press event. */ export interface Image$PressEventParameters {} /** * Event object of the Image#press event. */ export type Image$PressEvent = Event; } declare module "sap/ui/commons/ImageMap" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import Area from "sap/ui/commons/Area"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; import Event from "sap/ui/base/Event"; /** * Combination of image areas where at runtime these areas are starting points for hyperlinks or actions * * @deprecated As of version 1.38. There's not replacement because of the archaic design pattern. */ export default class ImageMap extends Control { /** * Constructor for a new ImageMap. * * 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?: $ImageMapSettings ); /** * Constructor for a new ImageMap. * * 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?: $ImageMapSettings ); /** * Creates a new subclass of class sap.ui.commons.ImageMap with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.ImageMap. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some area to the aggregation {@link #getAreas areas}. * * * @returns Reference to `this` in order to allow method chaining */ addArea( /** * The area to add; if empty, nothing is inserted */ oArea: Area ): this; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.commons.ImageMap`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.ImageMap` itself. * * Event for the areas that can be clicked in an ImageMap * * * @returns Reference to `this` in order to allow method chaining */ attachPress( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: ImageMap$PressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.ImageMap` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.commons.ImageMap`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.ImageMap` itself. * * Event for the areas that can be clicked in an ImageMap * * * @returns Reference to `this` in order to allow method chaining */ attachPress( /** * The function to be called when the event occurs */ fnFunction: (p1: ImageMap$PressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.ImageMap` itself */ oListener?: object ): this; /** * Adds areas to the Image Map. * * Each argument must be either a JSon object or a list of objects or the area element or elements. * * * @returns `this` to allow method chaining */ createArea( /** * Area content to add */ content: any ): this; /** * Destroys all the areas in the aggregation {@link #getAreas areas}. * * * @returns Reference to `this` in order to allow method chaining */ destroyAreas(): this; /** * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.commons.ImageMap`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachPress( /** * The function to be called, when the event occurs */ fnFunction: (p1: ImageMap$PressEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:press press} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ firePress( /** * Parameters to pass along with the event */ mParameters?: ImageMap$PressEventParameters ): this; /** * Gets content of aggregation {@link #getAreas areas}. * * Area representing the reference to the target location */ getAreas(): Area[]; /** * Gets current value of property {@link #getName name}. * * Name for the image that serves as reference * * * @returns Value of property `name` */ getName(): string; /** * Checks for the provided `sap.ui.commons.Area` in the aggregation {@link #getAreas areas}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfArea( /** * The area whose index is looked for */ oArea: Area ): int; /** * Inserts a area into the aggregation {@link #getAreas areas}. * * * @returns Reference to `this` in order to allow method chaining */ insertArea( /** * The area to insert; if empty, nothing is inserted */ oArea: Area, /** * The `0`-based index the area should be inserted at; for a negative value of `iIndex`, the area is inserted * at position 0; for a value greater than the current size of the aggregation, the area is inserted at * the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getAreas areas}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllAreas(): Area[]; /** * Removes a area from the aggregation {@link #getAreas areas}. * * * @returns The removed area or `null` */ removeArea( /** * The area to remove or its index or id */ vArea: int | string | Area ): Area | null; /** * Sets a new value for property {@link #getName name}. * * Name for the image that serves as reference * * 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 */ setName( /** * New value for property `name` */ sName?: string ): this; } /** * Describes the settings that can be provided to the ImageMap constructor. * * @deprecated As of version 1.38. There's not replacement because of the archaic design pattern. */ export interface $ImageMapSettings extends $ControlSettings { /** * Name for the image that serves as reference */ name?: string | PropertyBindingInfo; /** * Area representing the reference to the target location */ areas?: Area[] | Area | AggregationBindingInfo | `{${string}}`; /** * Event for the areas that can be clicked in an ImageMap */ press?: (oEvent: ImageMap$PressEvent) => void; } /** * Parameters of the ImageMap#press event. */ export interface ImageMap$PressEventParameters { /** * Id of clicked Area. */ areaId?: string; } /** * Event object of the ImageMap#press event. */ export type ImageMap$PressEvent = Event< ImageMap$PressEventParameters, ImageMap >; } declare module "sap/ui/commons/InPlaceEdit" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { AccessibilityInfo, ValueState } from "sap/ui/core/library"; import { TextViewDesign } from "sap/ui/commons/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import TooltipBase from "sap/ui/core/TooltipBase"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; import Event from "sap/ui/base/Event"; /** * The InPlaceEdit is a functionality to have text in display mode that can be changed in place. * * @since 1.8.0 * @deprecated As of version 1.38. replaced by {@link sap.m.Input} */ export default class InPlaceEdit extends Control { /** * Constructor for a new InPlaceEdit. * * 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?: $InPlaceEditSettings ); /** * Constructor for a new InPlaceEdit. * * 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?: $InPlaceEditSettings ); /** * Creates a new subclass of class sap.ui.commons.InPlaceEdit with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.InPlaceEdit. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.commons.InPlaceEdit`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.InPlaceEdit` itself. * * Event is fired when the text in the field has changed AND the focus leaves the InPlaceEdit or the Enter * key is pressed. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: InPlaceEdit$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.InPlaceEdit` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.commons.InPlaceEdit`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.InPlaceEdit` itself. * * Event is fired when the text in the field has changed AND the focus leaves the InPlaceEdit or the Enter * key is pressed. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * The function to be called when the event occurs */ fnFunction: (p1: InPlaceEdit$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.InPlaceEdit` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:liveChange liveChange} event of this `sap.ui.commons.InPlaceEdit`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.InPlaceEdit` itself. * * This event if fired during typing into the InPlaceEdit and returns the currently entered value. This * is not the content of the value property. The value property is only updated by ENTER and by leaving * the control. * * @since 1.16.5 * * @returns Reference to `this` in order to allow method chaining */ attachLiveChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: InPlaceEdit$LiveChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.InPlaceEdit` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:liveChange liveChange} event of this `sap.ui.commons.InPlaceEdit`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.InPlaceEdit` itself. * * This event if fired during typing into the InPlaceEdit and returns the currently entered value. This * is not the content of the value property. The value property is only updated by ENTER and by leaving * the control. * * @since 1.16.5 * * @returns Reference to `this` in order to allow method chaining */ attachLiveChange( /** * The function to be called when the event occurs */ fnFunction: (p1: InPlaceEdit$LiveChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.InPlaceEdit` itself */ oListener?: object ): this; /** * Clear the old text after a change to disable the undo functionality. If undoEnabled is false this has * no effect. */ clearOldText(): void; /** * Destroys the content in the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.commons.InPlaceEdit`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: InPlaceEdit$ChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:liveChange liveChange} event of this `sap.ui.commons.InPlaceEdit`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.16.5 * * @returns Reference to `this` in order to allow method chaining */ detachLiveChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: InPlaceEdit$LiveChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:change change} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireChange( /** * Parameters to pass along with the event */ mParameters?: InPlaceEdit$ChangeEventParameters ): this; /** * Fires event {@link #event:liveChange liveChange} to attached listeners. * * @since 1.16.5 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireLiveChange( /** * Parameters to pass along with the event */ mParameters?: InPlaceEdit$LiveChangeEventParameters ): this; /** * See: * sap.ui.core.Control#getAccessibilityInfo * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Current accessibility state of the control. */ getAccessibilityInfo(): AccessibilityInfo; /** * Gets content of aggregation {@link #getContent content}. * * Content control of the InPlaceEdit. The following controls are allowed: TextField, ComboBox, DropdownBox * and Link */ getContent(): Control; /** * Gets current value of property {@link #getDesign design}. * * Defines the visual appearance of the control. Currently this is not supported for Labels. * * Default value is `Standard`. * * @since 1.9.0 * * @returns Value of property `design` */ getDesign(): TextViewDesign; /** * Returns the tooltip for this InPlaceEdit if any or an undefined value. The tooltip can either be a simple * string or a subclass of {@link sap.ui.core.TooltipBase}. * * Callers that are only interested in tooltips of type string (e.g. to render them as a `title` attribute), * should call the convenience method {@link #getTooltip_AsString} instead. If they want to get a tooltip * text no matter where it comes from (be it a string tooltip or the text from a TooltipBase instance) then * they could call {@link #getTooltip_Text} instead. * * If a content control is assigned to the InPlaceEdit the tooltip of this control is used. A directly set * tooltip to the InPlaceEdit is ignored in this case. * * * @returns The tooltip for this Element. */ getTooltip(): string | TooltipBase; /** * Gets current value of property {@link #getUndoEnabled undoEnabled}. * * If undo is enabled after changing the text an undo button appears. * * Default value is `true`. * * * @returns Value of property `undoEnabled` */ getUndoEnabled(): boolean; /** * Gets current value of property {@link #getValueState valueState}. * * Visualizes warnings or errors related to the InPlaceEdit. Possible values: Warning, Error, Success. If * the content control has an own valueState property this will be used. * * Default value is `None`. * * * @returns Value of property `valueState` */ getValueState(): ValueState; /** * Sets the aggregated {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ setContent( /** * The content to set */ oContent: Control ): this; /** * Sets a new value for property {@link #getDesign design}. * * Defines the visual appearance of the control. Currently this is not supported for Labels. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Standard`. * * @since 1.9.0 * * @returns Reference to `this` in order to allow method chaining */ setDesign( /** * New value for property `design` */ sDesign?: TextViewDesign | keyof typeof TextViewDesign ): this; /** * Sets a new tooltip for this InPlaceEdit. The tooltip can either be a simple string (which in most cases * will be rendered as the `title` attribute of this Element) or an instance of {@link sap.ui.core.TooltipBase}. * * If a new tooltip is set, any previously set tooltip is deactivated. * * If a content control is assigned to the InPlaceEdit the tooltip of this control is used. A directly set * tooltip to the InPlaceEdit is ignored in this case. * * * @returns `this` to allow method chaining */ setTooltip( /** * Tooltip as string or RichTooltip. */ oTooltip: string | TooltipBase ): this; /** * Sets a new value for property {@link #getUndoEnabled undoEnabled}. * * If undo is enabled after changing the text an undo button appears. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setUndoEnabled( /** * New value for property `undoEnabled` */ bUndoEnabled?: boolean ): this; /** * Sets a new value for property {@link #getValueState valueState}. * * Visualizes warnings or errors related to the InPlaceEdit. Possible values: Warning, Error, Success. If * the content control has an own valueState property this will be used. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `None`. * * * @returns Reference to `this` in order to allow method chaining */ setValueState( /** * New value for property `valueState` */ sValueState?: ValueState | keyof typeof ValueState ): this; } /** * Describes the settings that can be provided to the InPlaceEdit constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.Input} */ export interface $InPlaceEditSettings extends $ControlSettings { /** * Visualizes warnings or errors related to the InPlaceEdit. Possible values: Warning, Error, Success. If * the content control has an own valueState property this will be used. */ valueState?: | (ValueState | keyof typeof ValueState) | PropertyBindingInfo | `{${string}}`; /** * If undo is enabled after changing the text an undo button appears. */ undoEnabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * Defines the visual appearance of the control. Currently this is not supported for Labels. * * @since 1.9.0 */ design?: | (TextViewDesign | keyof typeof TextViewDesign) | PropertyBindingInfo | `{${string}}`; /** * Content control of the InPlaceEdit. The following controls are allowed: TextField, ComboBox, DropdownBox * and Link */ content?: Control; /** * Event is fired when the text in the field has changed AND the focus leaves the InPlaceEdit or the Enter * key is pressed. */ change?: (oEvent: InPlaceEdit$ChangeEvent) => void; /** * This event if fired during typing into the InPlaceEdit and returns the currently entered value. This * is not the content of the value property. The value property is only updated by ENTER and by leaving * the control. * * @since 1.16.5 */ liveChange?: (oEvent: InPlaceEdit$LiveChangeEvent) => void; } /** * Parameters of the InPlaceEdit#change event. */ export interface InPlaceEdit$ChangeEventParameters { /** * The new / changed value of the InPlaceEdit. */ newValue?: string; } /** * Event object of the InPlaceEdit#change event. */ export type InPlaceEdit$ChangeEvent = Event< InPlaceEdit$ChangeEventParameters, InPlaceEdit >; /** * Parameters of the InPlaceEdit#liveChange event. */ export interface InPlaceEdit$LiveChangeEventParameters { /** * Current value of the Textfield. */ liveValue?: string; } /** * Event object of the InPlaceEdit#liveChange event. */ export type InPlaceEdit$LiveChangeEvent = Event< InPlaceEdit$LiveChangeEventParameters, InPlaceEdit >; } declare module "sap/ui/commons/Label" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { ToolbarItem, LabelDesign } from "sap/ui/commons/library"; import { Label as Label1, AccessibilityInfo, URI, ID, TextAlign, TextDirection, CSSSize, } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * The control is used for labeling other controls. The API provides formatting options, for example, for * bold display or alignment. A label can have an icon. * * @deprecated As of version 1.38. Instead, use the `sap.m.Label` control. */ export default class Label extends Control implements ToolbarItem, Label1 { __implements__sap_ui_commons_ToolbarItem: boolean; __implements__sap_ui_core_Label: boolean; /** * Constructor for a new Label. * * 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?: $LabelSettings ); /** * Constructor for a new Label. * * 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?: $LabelSettings ); /** * Creates a new subclass of class sap.ui.commons.Label with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.Label. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * See: * sap.ui.core.Control#getAccessibilityInfo * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns The accessibility info */ getAccessibilityInfo(): AccessibilityInfo; /** * Gets current value of property {@link #getDesign design}. * * Defines whether the labels are in bold format. * * Default value is `Standard`. * * * @returns Value of property `design` */ getDesign(): LabelDesign; /** * Gets current value of property {@link #getIcon icon}. * * Determines the icon to be displayed in the control. This can be a URI to an image or an icon font URI. * * * @returns Value of property `icon` */ getIcon(): URI; /** * ID of the element which is the current target of the association {@link #getLabelFor labelFor}, or `null`. */ getLabelFor(): ID | null; /** * Gets current value of property {@link #getRequired required}. * * Allows to enforce the required indicator even when the associated control doesn't have a getRequired * method (a required property) or when the flag is not set. If the associated control has a required property, * the values of both required flags are combined with the OR operator, so a Label can't override a required=true * value. * * Default value is `false`. * * @since 1.11.0 * * @returns Value of property `required` */ getRequired(): boolean; /** * Gets current value of property {@link #getRequiredAtBegin requiredAtBegin}. * * Determines whether the required indicator is at the beginning of the label (if set) or at the end (if * not set). * * @since 1.14.0 * * @returns Value of property `requiredAtBegin` */ getRequiredAtBegin(): boolean; /** * Gets current value of property {@link #getText text}. * * Determines the text to be displayed. * * Default value is `empty string`. * * * @returns Value of property `text` */ getText(): string; /** * Gets current value of property {@link #getTextAlign textAlign}. * * Determines the alignment of the text. Available options are `Begin`, `Center`, `End`, `Left`, and `Right`. * * Default value is `Begin`. * * * @returns Value of property `textAlign` */ getTextAlign(): TextAlign; /** * Gets current value of property {@link #getTextDirection textDirection}. * * Determines the text direction - right-to-left (RTL) and left-to-right (LTR). * * Default value is `Inherit`. * * * @returns Value of property `textDirection` */ getTextDirection(): TextDirection; /** * Gets current value of property {@link #getWidth width}. * * Determines the control width as common CSS-size (for example, px or % as unit). * * Default value is `empty string`. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Gets current value of property {@link #getWrapping wrapping}. * * Specifies whether a line wrapping width shall be displayed when the text value is longer than the width * is. * * Default value is `false`. * * * @returns Value of property `wrapping` */ getWrapping(): boolean; /** * Sets a new value for property {@link #getDesign design}. * * Defines whether the labels are in bold format. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Standard`. * * * @returns Reference to `this` in order to allow method chaining */ setDesign( /** * New value for property `design` */ sDesign?: LabelDesign | keyof typeof LabelDesign ): this; /** * Sets a new value for property {@link #getIcon icon}. * * Determines the icon to be displayed in the control. This can be a URI to an image or an icon font URI. * * 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 */ setIcon( /** * New value for property `icon` */ sIcon?: URI ): this; /** * Sets the associated {@link #getLabelFor labelFor}. * * * @returns Reference to `this` in order to allow method chaining */ setLabelFor( /** * ID of an element which becomes the new target of this labelFor association; alternatively, an element * instance may be given */ oLabelFor: ID | Control ): this; /** * Sets a new value for property {@link #getRequired required}. * * Allows to enforce the required indicator even when the associated control doesn't have a getRequired * method (a required property) or when the flag is not set. If the associated control has a required property, * the values of both required flags are combined with the OR operator, so a Label can't override a required=true * value. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.11.0 * * @returns Reference to `this` in order to allow method chaining */ setRequired( /** * New value for property `required` */ bRequired?: boolean ): this; /** * Sets a new value for property {@link #getRequiredAtBegin requiredAtBegin}. * * Determines whether the required indicator is at the beginning of the label (if set) or at the end (if * not set). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.14.0 * * @returns Reference to `this` in order to allow method chaining */ setRequiredAtBegin( /** * New value for property `requiredAtBegin` */ bRequiredAtBegin?: boolean ): this; /** * Sets a new value for property {@link #getText text}. * * Determines the text to be displayed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setText( /** * New value for property `text` */ sText?: string ): this; /** * Sets a new value for property {@link #getTextAlign textAlign}. * * Determines the alignment of the text. Available options are `Begin`, `Center`, `End`, `Left`, and `Right`. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Begin`. * * * @returns Reference to `this` in order to allow method chaining */ setTextAlign( /** * New value for property `textAlign` */ sTextAlign?: TextAlign | keyof typeof TextAlign ): this; /** * Sets a new value for property {@link #getTextDirection textDirection}. * * Determines the text direction - right-to-left (RTL) and left-to-right (LTR). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Inherit`. * * * @returns Reference to `this` in order to allow method chaining */ setTextDirection( /** * New value for property `textDirection` */ sTextDirection?: TextDirection | keyof typeof TextDirection ): this; /** * Sets a new value for property {@link #getWidth width}. * * Determines the control width as common CSS-size (for example, px or % as unit). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; /** * Sets a new value for property {@link #getWrapping wrapping}. * * Specifies whether a line wrapping width shall be displayed when the text value is longer than the width * is. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setWrapping( /** * New value for property `wrapping` */ bWrapping?: boolean ): this; } /** * Describes the settings that can be provided to the Label constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.Label` control. */ export interface $LabelSettings extends $ControlSettings { /** * Defines whether the labels are in bold format. */ design?: | (LabelDesign | keyof typeof LabelDesign) | PropertyBindingInfo | `{${string}}`; /** * Determines the text direction - right-to-left (RTL) and left-to-right (LTR). */ textDirection?: | (TextDirection | keyof typeof TextDirection) | PropertyBindingInfo | `{${string}}`; /** * Specifies whether a line wrapping width shall be displayed when the text value is longer than the width * is. */ wrapping?: boolean | PropertyBindingInfo | `{${string}}`; /** * Determines the control width as common CSS-size (for example, px or % as unit). */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Determines the text to be displayed. */ text?: string | PropertyBindingInfo; /** * Determines the icon to be displayed in the control. This can be a URI to an image or an icon font URI. */ icon?: URI | PropertyBindingInfo | `{${string}}`; /** * Determines the alignment of the text. Available options are `Begin`, `Center`, `End`, `Left`, and `Right`. */ textAlign?: | (TextAlign | keyof typeof TextAlign) | PropertyBindingInfo | `{${string}}`; /** * Allows to enforce the required indicator even when the associated control doesn't have a getRequired * method (a required property) or when the flag is not set. If the associated control has a required property, * the values of both required flags are combined with the OR operator, so a Label can't override a required=true * value. * * @since 1.11.0 */ required?: boolean | PropertyBindingInfo | `{${string}}`; /** * Determines whether the required indicator is at the beginning of the label (if set) or at the end (if * not set). * * @since 1.14.0 */ requiredAtBegin?: boolean | PropertyBindingInfo | `{${string}}`; /** * Defines the association to the labeled control. By default, the label is set the for the attribute to * the ID of the labeled control. This can be changed with the implementation of function getIdForLabel * on the labelled control. */ labelFor?: Control | string; } } declare module "sap/ui/commons/layout/AbsoluteLayout" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { CSSSize, Scrolling } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import PositionContainer from "sap/ui/commons/layout/PositionContainer"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; /** * The Absolute Layout positions its child controls absolutely * * @deprecated As of version 1.38. the concept has been discarded. */ export default class AbsoluteLayout extends Control { /** * Constructor for a new layout/AbsoluteLayout. * * 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?: $AbsoluteLayoutSettings ); /** * Constructor for a new layout/AbsoluteLayout. * * 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?: $AbsoluteLayoutSettings ); /** * Creates a new subclass of class sap.ui.commons.layout.AbsoluteLayout with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.layout.AbsoluteLayout. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds the given control and a corresponding position container into the aggregation named 'positions'. * Returns 'this' to allow method chaining. */ addContent( /** * The content to add; if empty, nothing is inserted. */ oContent: Control, /** * JSON-like object which defines the position of the child control in the layout. The object is expected * to have one or more from the attribute set top, bottom, left, right; each with a value of type sap.ui.core.CSSSize. */ oPos?: { left: string; right: string; } ): this; /** * Adds element to the layout. * * * @returns `this` Control reference for chaining. */ addPosition( /** * Element which must be positioned in the layout. */ oPosition: Control ): this; /** * Destroys all aggregated position containers and their child controls. Returns 'this' to allow method * chaining. */ destroyContent(): this; /** * Destroys all elements from the layout. * * * @returns `this` Control reference for chaining. */ destroyPositions(): this; /** * Returns an array of the controls contained in the aggregated position containers (might be empty). */ getContent(): Control[]; /** * Gets current value of property {@link #getHeight height}. * * The overall height of the control. When not set, 100% is automatically set. * * Default value is `'100%'`. * * * @returns Value of property `height` */ getHeight(): CSSSize; /** * Gets current value of property {@link #getHorizontalScrolling horizontalScrolling}. * * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode. * * Default value is `Hidden`. * * * @returns Value of property `horizontalScrolling` */ getHorizontalScrolling(): Scrolling; /** * Gets content of aggregation {@link #getPositions positions}. * * Positioned child controls within the layout */ getPositions(): PositionContainer[]; /** * Gets current value of property {@link #getVerticalScrolling verticalScrolling}. * * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode. * * Default value is `Hidden`. * * * @returns Value of property `verticalScrolling` */ getVerticalScrolling(): Scrolling; /** * Gets current value of property {@link #getWidth width}. * * The overall width of the control. When not set, 100% is automatically set. * * Default value is `'100%'`. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Checks for the provided sap.ui.core.Control in the aggregated position containers, and returns the index * of the container in the positions aggregation if found, or '-1' otherwise. */ indexOfContent( /** * The content of which the index is looked for */ oContent: Control ): int; /** * Checks for the provided `sap.ui.commons.layout.PositionContainer` in the aggregation {@link #getPositions positions}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfPosition( /** * The position whose index is looked for */ oPosition: PositionContainer ): int; /** * Inserts the given control and a corresponding position container into the aggregation named 'positions'. * Returns 'this' to allow method chaining. */ insertContent( /** * The content to insert; if empty, nothing is inserted */ oContent: Control, /** * The '0'-based index where the content shall be inserted at. For a negative value of iIndex, the content * is inserted at position '0'; for a value greater than the current size of the aggregation, the content * is inserted at the last position. */ iIndex: int, /** * JSON-like object which defines the position of the child control in the layout. The object is expected * to have one or more from the attribute set top, bottom, left, right; each with a value of type sap.ui.core.CSSSize. */ oPos?: { left: string; right: string; } ): this; /** * Inserts element to the layout on a specific index. * * * @returns `this` Control reference for chaining. */ insertPosition( /** * Element which must be positioned in the layout. */ oPosition: Control, /** * Index of the element which is to be positioned. */ iIndex: int ): this; /** * Removes all aggregated position containers. Returns an array of the controls contained in the removed * position containers (might be empty). */ removeAllContent(): Control[]; /** * Removes all elements from the layout. * * * @returns Removed elements. */ removeAllPositions(): Control[]; /** * Removes the given control and its corresponding position container from the aggregation named 'positions'. */ removeContent( /** * The content control to remove, its ID, or the index of the corresponding position container in the 'positions' * aggregation. */ vContent: string | Control ): Control; /** * Removes element from the layout. * * * @returns Removed element. */ removePosition( /** * Element which must be removed from the positions element within the layout. */ vPosition: any ): Control; /** * Sets the `height` property. * * * @returns `this` Control reference for chaining. */ setHeight( /** * The passed height of the control. */ sHeight: string ): this; /** * Sets the `horizontalScrolling` property. * * * @returns `this` Control reference for chaining. */ setHorizontalScrolling( /** * Object that contains settings for Horizontal scrolling. */ oHorizontalScrolling: Scrolling | keyof typeof Scrolling ): this; /** * Allows to set or change the position information of the given child control */ setPositionOfChild( /** * The child control for which to change the position information; if empty or not aggregated, nothing is * changed */ oControl: Control, /** * JSON-like object which defines the position of the child control in the layout. The object is expected * to have one or more from the attribute set top, bottom, left, right; each with a value of type sap.ui.core.CSSSize. */ oPos?: { left: string; right: string; } ): boolean; /** * Sets the `verticalScrolling` property. * * * @returns `this` Control reference for chaining. */ setVerticalScrolling( /** * Object that contains settings for Vertical scrolling. */ oVerticalScrolling: Scrolling | keyof typeof Scrolling ): this; /** * Sets the `width` property. * * * @returns `this` Control reference for chaining. */ setWidth( /** * The passed width of the control. */ sWidth: string ): this; } /** * Describes the settings that can be provided to the AbsoluteLayout constructor. * * @deprecated As of version 1.38. the concept has been discarded. */ export interface $AbsoluteLayoutSettings extends $ControlSettings { /** * The overall width of the control. When not set, 100% is automatically set. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * The overall height of the control. When not set, 100% is automatically set. */ height?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode. */ verticalScrolling?: | (Scrolling | keyof typeof Scrolling) | PropertyBindingInfo | `{${string}}`; /** * 'Auto', 'Scroll', 'Hidden', and 'None' are the available values for setting the vertical scrolling mode. */ horizontalScrolling?: | (Scrolling | keyof typeof Scrolling) | PropertyBindingInfo | `{${string}}`; /** * Positioned child controls within the layout */ positions?: | PositionContainer[] | PositionContainer | AggregationBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/layout/BorderLayoutArea" { import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element"; import Control from "sap/ui/core/Control"; import { layout } from "sap/ui/commons/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { CSSSize } from "sap/ui/core/library"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; /** * The BorderLayoutArea represents one area of a BorderLayout * * @deprecated As of version 1.38. Instead, use the `sap.m.Page` control. */ export default class BorderLayoutArea extends UI5Element { /** * Constructor for a new layout/BorderLayoutArea. * * 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?: $BorderLayoutAreaSettings ); /** * Constructor for a new layout/BorderLayoutArea. * * 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?: $BorderLayoutAreaSettings ); /** * Creates a new subclass of class sap.ui.commons.layout.BorderLayoutArea with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @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.ui.commons.layout.BorderLayoutArea. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some content to the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ addContent( /** * The content to add; if empty, nothing is inserted */ oContent: Control ): this; /** * Destroys all the content in the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Gets current value of property {@link #getAreaId areaId}. * * Defines which area the element represents: top, begin, center, end, bottom * * Default value is `top`. * * @deprecated As of version 1.3.3. Redundant to the aggregation by the parent border layout. * * @returns Value of property `areaId` */ getAreaId(): layout.BorderLayoutAreaTypes; /** * Gets content of aggregation {@link #getContent content}. * * Controls within the area */ getContent(): Control[]; /** * Gets current value of property {@link #getContentAlign contentAlign}. * * The content alignment as CSS value * * Default value is `'left'`. * * * @returns Value of property `contentAlign` */ getContentAlign(): string; /** * Gets current value of property {@link #getOverflowX overflowX}. * * The overflow mode of the area in horizontal direction as CSS value * * Default value is `'auto'`. * * * @returns Value of property `overflowX` */ getOverflowX(): string; /** * Gets current value of property {@link #getOverflowY overflowY}. * * The overflow mode of the area in vertical direction as CSS value * * Default value is `'auto'`. * * * @returns Value of property `overflowY` */ getOverflowY(): string; /** * Gets current value of property {@link #getSize size}. * * Defines the height or the width. Is not used when the area element is in Center. * * Default value is `'100px'`. * * * @returns Value of property `size` */ getSize(): CSSSize; /** * Gets current value of property {@link #getVisible visible}. * * Invisible controls are not rendered * * Default value is `true`. * * * @returns Value of property `visible` */ getVisible(): boolean; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContent( /** * The content whose index is looked for */ oContent: Control ): int; /** * Inserts a content into the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ insertContent( /** * The content to insert; if empty, nothing is inserted */ oContent: Control, /** * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content * is inserted at position 0; for a value greater than the current size of the aggregation, the content * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getContent content}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllContent(): Control[]; /** * Removes a content from the aggregation {@link #getContent content}. * * * @returns The removed content or `null` */ removeContent( /** * The content to remove or its index or id */ vContent: int | string | Control ): Control | null; /** * Sets a new value for property {@link #getAreaId areaId}. * * Defines which area the element represents: top, begin, center, end, bottom * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `top`. * * @deprecated As of version 1.3.3. Redundant to the aggregation by the parent border layout. * * @returns Reference to `this` in order to allow method chaining */ setAreaId( /** * New value for property `areaId` */ sAreaId?: | layout.BorderLayoutAreaTypes | keyof typeof layout.BorderLayoutAreaTypes ): this; /** * Sets a new value for property {@link #getContentAlign contentAlign}. * * The content alignment as CSS value * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'left'`. * * * @returns Reference to `this` in order to allow method chaining */ setContentAlign( /** * New value for property `contentAlign` */ sContentAlign?: string ): this; /** * Sets a new value for property {@link #getOverflowX overflowX}. * * The overflow mode of the area in horizontal direction as CSS value * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'auto'`. * * * @returns Reference to `this` in order to allow method chaining */ setOverflowX( /** * New value for property `overflowX` */ sOverflowX?: string ): this; /** * Sets a new value for property {@link #getOverflowY overflowY}. * * The overflow mode of the area in vertical direction as CSS value * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'auto'`. * * * @returns Reference to `this` in order to allow method chaining */ setOverflowY( /** * New value for property `overflowY` */ sOverflowY?: string ): this; /** * Sets a new value for property {@link #getSize size}. * * Defines the height or the width. Is not used when the area element is in Center. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'100px'`. * * * @returns Reference to `this` in order to allow method chaining */ setSize( /** * New value for property `size` */ sSize?: CSSSize ): this; /** * Sets a new value for property {@link #getVisible visible}. * * Invisible controls are not rendered * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setVisible( /** * New value for property `visible` */ bVisible?: boolean ): this; } /** * Describes the settings that can be provided to the BorderLayoutArea constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.Page` control. */ export interface $BorderLayoutAreaSettings extends $ElementSettings { /** * Defines which area the element represents: top, begin, center, end, bottom * * @deprecated As of version 1.3.3. Redundant to the aggregation by the parent border layout. */ areaId?: | ( | layout.BorderLayoutAreaTypes | keyof typeof layout.BorderLayoutAreaTypes ) | PropertyBindingInfo | `{${string}}`; /** * The overflow mode of the area in horizontal direction as CSS value */ overflowX?: string | PropertyBindingInfo; /** * The overflow mode of the area in vertical direction as CSS value */ overflowY?: string | PropertyBindingInfo; /** * The content alignment as CSS value */ contentAlign?: string | PropertyBindingInfo; /** * Defines the height or the width. Is not used when the area element is in Center. */ size?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Invisible controls are not rendered */ visible?: boolean | PropertyBindingInfo | `{${string}}`; /** * Controls within the area */ content?: Control[] | Control | AggregationBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/layout/HorizontalLayout" { import { default as HorizontalLayout1, $HorizontalLayoutSettings as $HorizontalLayoutSettings1, } from "sap/ui/layout/HorizontalLayout"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * A layout that provides support for horizontal alignment of controls * * @deprecated As of version 1.38. Instead, use the `sap.ui.layout.HorizontalLayout` control. */ export default class HorizontalLayout extends HorizontalLayout1 { /** * Constructor for a new layout/HorizontalLayout. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.HorizontalLayout#constructor sap.ui.layout.HorizontalLayout } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: $HorizontalLayoutSettings ); /** * Constructor for a new layout/HorizontalLayout. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.HorizontalLayout#constructor sap.ui.layout.HorizontalLayout } * can be used. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: $HorizontalLayoutSettings ); /** * Creates a new subclass of class sap.ui.commons.layout.HorizontalLayout with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.HorizontalLayout.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.ui.commons.layout.HorizontalLayout. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; } /** * Describes the settings that can be provided to the HorizontalLayout constructor. * * @deprecated As of version 1.38. Instead, use the `sap.ui.layout.HorizontalLayout` control. */ export interface $HorizontalLayoutSettings extends $HorizontalLayoutSettings1 {} } declare module "sap/ui/commons/layout/MatrixLayout" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import MatrixLayoutRow from "sap/ui/commons/layout/MatrixLayoutRow"; import { CSSSize } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; /** * A matrix layout arranges controls in a grid structure, using rows which need not have the same number * of cells. * * It uses predefined cell classes that guarantee appropriate distances between cells in the grid. The * cell's `vGutter` property lets you specify additional horizontal distances easily. You can set these * additional distances (known as gutters) with or without separators. The distance for each cell is specified * by assigning a specific enumeration value of the class `LayoutCellSeparator` of the matrix data object. * * * You should **avoid nesting** matrix layouts. You should only use a matrix layout if you need to align * controls horizontally across rows. * * @deprecated As of version 1.38. Instead, use the `sap.ui.layout.Grid` control. */ export default class MatrixLayout extends Control { /** * Constructor for a new layout/MatrixLayout. * * 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?: $MatrixLayoutSettings ); /** * Constructor for a new layout/MatrixLayout. * * 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?: $MatrixLayoutSettings ); /** * Creates a new subclass of class sap.ui.commons.layout.MatrixLayout with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.layout.MatrixLayout. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some row to the aggregation {@link #getRows rows}. * * * @returns Reference to `this` in order to allow method chaining */ addRow( /** * The row to add; if empty, nothing is inserted */ oRow: MatrixLayoutRow ): this; /** * Creates a new matrix layout row and appends it to this matrix layout. * * Each argument must be either a matrix layout cell, which is added to the row "as is", or an arbitrary * content control, which is wrapped with a new (default) matrix layout cell first and then added to the * row. * * * @returns `this` to allow method chaining */ createRow(): this; /** * Destroys all the rows in the aggregation {@link #getRows rows}. * * * @returns Reference to `this` in order to allow method chaining */ destroyRows(): this; /** * Gets current value of property {@link #getColumns columns}. * * Number of columns. If not specified, the number of columns will be determined from the given cells. * * * @returns Value of property `columns` */ getColumns(): int; /** * Gets current value of property {@link #getHeight height}. * * CSS height of the matrix layout. * * * @returns Value of property `height` */ getHeight(): CSSSize; /** * Gets current value of property {@link #getLayoutFixed layoutFixed}. * * Sets the table layout. If fixed the width parameter of a column has priority, if not the width of the * content of the colums has priority. The default is "fixed". If the fixed layout is used an adequate width * of the MatrixLayout should be provided. Otherwise the column width displayed could be different than * the given ones because of browser dependend optimazations. * * Default value is `true`. * * * @returns Value of property `layoutFixed` */ getLayoutFixed(): boolean; /** * Gets content of aggregation {@link #getRows rows}. * * The matrix layout's individual rows. */ getRows(): MatrixLayoutRow[]; /** * Gets current value of property {@link #getWidth width}. * * CSS width of the matrix layout. If the LayoutFixed = true an adequate width should be provided. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Gets current value of property {@link #getWidths widths}. * * Widths of the columns. Use an array to define the widths of the columns. If a column shall have an automatical * sizing enter "auto" for this column width. * * * @returns Value of property `widths` */ getWidths(): CSSSize[]; /** * Checks for the provided `sap.ui.commons.layout.MatrixLayoutRow` in the aggregation {@link #getRows rows}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfRow( /** * The row whose index is looked for */ oRow: MatrixLayoutRow ): int; /** * Inserts a row into the aggregation {@link #getRows rows}. * * * @returns Reference to `this` in order to allow method chaining */ insertRow( /** * The row to insert; if empty, nothing is inserted */ oRow: MatrixLayoutRow, /** * The `0`-based index the row should be inserted at; for a negative value of `iIndex`, the row is inserted * at position 0; for a value greater than the current size of the aggregation, the row is inserted at the * last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getRows rows}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllRows(): MatrixLayoutRow[]; /** * Removes a row from the aggregation {@link #getRows rows}. * * * @returns The removed row or `null` */ removeRow( /** * The row to remove or its index or id */ vRow: int | string | MatrixLayoutRow ): MatrixLayoutRow | null; /** * Sets a new value for property {@link #getColumns columns}. * * Number of columns. If not specified, the number of columns will be determined from the given cells. * * 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 */ setColumns( /** * New value for property `columns` */ iColumns?: int ): this; /** * Sets a new value for property {@link #getHeight height}. * * CSS height of the matrix layout. * * 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 */ setHeight( /** * New value for property `height` */ sHeight?: CSSSize ): this; /** * Sets a new value for property {@link #getLayoutFixed layoutFixed}. * * Sets the table layout. If fixed the width parameter of a column has priority, if not the width of the * content of the colums has priority. The default is "fixed". If the fixed layout is used an adequate width * of the MatrixLayout should be provided. Otherwise the column width displayed could be different than * the given ones because of browser dependend optimazations. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setLayoutFixed( /** * New value for property `layoutFixed` */ bLayoutFixed?: boolean ): this; /** * Sets a new value for property {@link #getWidth width}. * * CSS width of the matrix layout. If the LayoutFixed = true an adequate width should be provided. * * 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 */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; /** * Sets a new value for property {@link #getWidths widths}. * * Widths of the columns. Use an array to define the widths of the columns. If a column shall have an automatical * sizing enter "auto" for this column width. * * 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 */ setWidths( /** * New value for property `widths` */ sWidths?: CSSSize[] ): this; } /** * Describes the settings that can be provided to the MatrixLayout constructor. * * @deprecated As of version 1.38. Instead, use the `sap.ui.layout.Grid` control. */ export interface $MatrixLayoutSettings extends $ControlSettings { /** * CSS width of the matrix layout. If the LayoutFixed = true an adequate width should be provided. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * CSS height of the matrix layout. */ height?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Sets the table layout. If fixed the width parameter of a column has priority, if not the width of the * content of the colums has priority. The default is "fixed". If the fixed layout is used an adequate width * of the MatrixLayout should be provided. Otherwise the column width displayed could be different than * the given ones because of browser dependend optimazations. */ layoutFixed?: boolean | PropertyBindingInfo | `{${string}}`; /** * Number of columns. If not specified, the number of columns will be determined from the given cells. */ columns?: int | PropertyBindingInfo | `{${string}}`; /** * Widths of the columns. Use an array to define the widths of the columns. If a column shall have an automatical * sizing enter "auto" for this column width. */ widths?: CSSSize[] | PropertyBindingInfo | `{${string}}`; /** * The matrix layout's individual rows. */ rows?: | MatrixLayoutRow[] | MatrixLayoutRow | AggregationBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/layout/MatrixLayoutCell" { import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element"; import Control from "sap/ui/core/Control"; import { layout } from "sap/ui/commons/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; /** * Non-control element used as part of a matrix layout's inner structure. * * @deprecated As of version 1.38. Instead, use the `sap.ui.layout.Grid` control. */ export default class MatrixLayoutCell extends UI5Element { /** * Constructor for a new layout/MatrixLayoutCell. * * 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?: $MatrixLayoutCellSettings ); /** * Constructor for a new layout/MatrixLayoutCell. * * 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?: $MatrixLayoutCellSettings ); /** * Creates a new subclass of class sap.ui.commons.layout.MatrixLayoutCell with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @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.ui.commons.layout.MatrixLayoutCell. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some content to the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ addContent( /** * The content to add; if empty, nothing is inserted */ oContent: Control ): this; /** * The string given as "sStyleClass" will be added to the "class" attribute of this element's root HTML * element. * * This method is intended to be used to mark controls as being of a special type for which special styling * can be provided using CSS selectors that reference this style class name. * * * ```javascript * * Example: * myButton.addStyleClass("myRedTextButton"); // add a CSS class to one button instance * * ...and in CSS: * .myRedTextButton { * color: red; * } * ``` * * * This will add the CSS class "myRedTextButton" to the Button HTML and the CSS code above will then make * the text in this particular button red. * * Only characters allowed inside HTML attributes are allowed. Quotes are not allowed and this method will * ignore any strings containing quotes. Strings containing spaces are interpreted as ONE custom style class * (even though CSS selectors interpret them as different classes) and can only removed later by calling * removeStyleClass() with exactly the same (space-containing) string as parameter. Multiple calls with * the same sStyleClass will have no different effect than calling once. If sStyleClass is null, the call * is ignored. * * Returns `this` to allow method chaining */ addStyleClass( /** * the CSS class name to be added */ sStyleClass: string ): this; /** * Destroys all the content in the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Gets current value of property {@link #getBackgroundDesign backgroundDesign}. * * Determines the matrix layout cell's background design. * * Default value is `'Transparent'`. * * * @returns Value of property `backgroundDesign` */ getBackgroundDesign(): layout.BackgroundDesign; /** * Gets current value of property {@link #getColSpan colSpan}. * * Determines how many columns of the underlying grid structure are occupied by this matrix layout cell. * * Default value is `1`. * * * @returns Value of property `colSpan` */ getColSpan(): int; /** * Gets content of aggregation {@link #getContent content}. * * The matrix layout cell's content (arbitrary controls). * * If the matrix row has a defined height and the matrix has layoutFixed = true, the controls inside of * a cell should all use the same unit for its height property. */ getContent(): Control[]; /** * Gets current value of property {@link #getHAlign hAlign}. * * Determines the horizontal alignment of the matrix layout cell's content with the cell's borders. * * Default value is `'Begin'`. * * * @returns Value of property `hAlign` */ getHAlign(): layout.HAlign; /** * Gets current value of property {@link #getPadding padding}. * * Determines the padding of the matrix layout cell's content within the cell's borders. The default value * is appropriate for all cells in a form-like layout. Consider to remove the padding on the outer layout * in case of nesting. * * Default value is `'End'`. * * * @returns Value of property `padding` */ getPadding(): layout.Padding; /** * Gets current value of property {@link #getRowSpan rowSpan}. * * Determines how many rows of the underlying grid structure are occupied by this matrix layout cell. In * case a row-height is used, all rows affected by the RowSpan must have the same unit. * * Default value is `1`. * * * @returns Value of property `rowSpan` */ getRowSpan(): int; /** * Gets current value of property {@link #getSeparation separation}. * * Determines how a matrix layout cell is separated from its predecessor, via a vertical gutter of variable * width, with or without a vertical line. * * Default value is `'None'`. * * * @returns Value of property `separation` */ getSeparation(): layout.Separation; /** * Gets current value of property {@link #getVAlign vAlign}. * * Determines the vertical alignment of the matrix layout cell's content with the cell's borders. * * Default value is `'Middle'`. * * * @returns Value of property `vAlign` */ getVAlign(): layout.VAlign; /** * Returns true if the given style class string is valid and if this Element has this style class set via * a previous call to addStyleClass(). */ hasStyleClass( /** * the style to check for */ sStyleClass: string ): boolean; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContent( /** * The content whose index is looked for */ oContent: Control ): int; /** * Inserts a content into the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ insertContent( /** * The content to insert; if empty, nothing is inserted */ oContent: Control, /** * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content * is inserted at position 0; for a value greater than the current size of the aggregation, the content * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getContent content}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllContent(): Control[]; /** * Removes a content from the aggregation {@link #getContent content}. * * * @returns The removed content or `null` */ removeContent( /** * The content to remove or its index or id */ vContent: int | string | Control ): Control | null; /** * Removes the given string from the list of custom style classes that have been set previously. Regular * style classes like "sapUiBtn" cannot be removed. * * Returns `this` to allow method chaining */ removeStyleClass( /** * the style to be removed */ sStyleClass: string ): this; /** * Sets a new value for property {@link #getBackgroundDesign backgroundDesign}. * * Determines the matrix layout cell's background design. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'Transparent'`. * * * @returns Reference to `this` in order to allow method chaining */ setBackgroundDesign( /** * New value for property `backgroundDesign` */ sBackgroundDesign?: | layout.BackgroundDesign | keyof typeof layout.BackgroundDesign ): this; /** * Sets a new value for property {@link #getColSpan colSpan}. * * Determines how many columns of the underlying grid structure are occupied by this matrix layout cell. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `1`. * * * @returns Reference to `this` in order to allow method chaining */ setColSpan( /** * New value for property `colSpan` */ iColSpan?: int ): this; /** * Sets a new value for property {@link #getHAlign hAlign}. * * Determines the horizontal alignment of the matrix layout cell's content with the cell's borders. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'Begin'`. * * * @returns Reference to `this` in order to allow method chaining */ setHAlign( /** * New value for property `hAlign` */ sHAlign?: layout.HAlign | keyof typeof layout.HAlign ): this; /** * Sets a new value for property {@link #getPadding padding}. * * Determines the padding of the matrix layout cell's content within the cell's borders. The default value * is appropriate for all cells in a form-like layout. Consider to remove the padding on the outer layout * in case of nesting. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'End'`. * * * @returns Reference to `this` in order to allow method chaining */ setPadding( /** * New value for property `padding` */ sPadding?: layout.Padding | keyof typeof layout.Padding ): this; /** * Sets a new value for property {@link #getRowSpan rowSpan}. * * Determines how many rows of the underlying grid structure are occupied by this matrix layout cell. In * case a row-height is used, all rows affected by the RowSpan must have the same unit. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `1`. * * * @returns Reference to `this` in order to allow method chaining */ setRowSpan( /** * New value for property `rowSpan` */ iRowSpan?: int ): this; /** * Sets a new value for property {@link #getSeparation separation}. * * Determines how a matrix layout cell is separated from its predecessor, via a vertical gutter of variable * width, with or without a vertical line. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'None'`. * * * @returns Reference to `this` in order to allow method chaining */ setSeparation( /** * New value for property `separation` */ sSeparation?: layout.Separation | keyof typeof layout.Separation ): this; /** * Sets a new value for property {@link #getVAlign vAlign}. * * Determines the vertical alignment of the matrix layout cell's content with the cell's borders. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'Middle'`. * * * @returns Reference to `this` in order to allow method chaining */ setVAlign( /** * New value for property `vAlign` */ sVAlign?: layout.VAlign | keyof typeof layout.VAlign ): this; } /** * Describes the settings that can be provided to the MatrixLayoutCell constructor. * * @deprecated As of version 1.38. Instead, use the `sap.ui.layout.Grid` control. */ export interface $MatrixLayoutCellSettings extends $ElementSettings { /** * Determines the matrix layout cell's background design. */ backgroundDesign?: | (layout.BackgroundDesign | keyof typeof layout.BackgroundDesign) | PropertyBindingInfo | `{${string}}`; /** * Determines how many columns of the underlying grid structure are occupied by this matrix layout cell. */ colSpan?: int | PropertyBindingInfo | `{${string}}`; /** * Determines the horizontal alignment of the matrix layout cell's content with the cell's borders. */ hAlign?: | (layout.HAlign | keyof typeof layout.HAlign) | PropertyBindingInfo | `{${string}}`; /** * Determines the padding of the matrix layout cell's content within the cell's borders. The default value * is appropriate for all cells in a form-like layout. Consider to remove the padding on the outer layout * in case of nesting. */ padding?: | (layout.Padding | keyof typeof layout.Padding) | PropertyBindingInfo | `{${string}}`; /** * Determines how many rows of the underlying grid structure are occupied by this matrix layout cell. In * case a row-height is used, all rows affected by the RowSpan must have the same unit. */ rowSpan?: int | PropertyBindingInfo | `{${string}}`; /** * Determines how a matrix layout cell is separated from its predecessor, via a vertical gutter of variable * width, with or without a vertical line. */ separation?: | (layout.Separation | keyof typeof layout.Separation) | PropertyBindingInfo | `{${string}}`; /** * Determines the vertical alignment of the matrix layout cell's content with the cell's borders. */ vAlign?: | (layout.VAlign | keyof typeof layout.VAlign) | PropertyBindingInfo | `{${string}}`; /** * The matrix layout cell's content (arbitrary controls). * * If the matrix row has a defined height and the matrix has layoutFixed = true, the controls inside of * a cell should all use the same unit for its height property. */ content?: Control[] | Control | AggregationBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/layout/MatrixLayoutRow" { import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element"; import MatrixLayoutCell from "sap/ui/commons/layout/MatrixLayoutCell"; import { CSSSize } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; /** * Non-control element used as part of a matrix layout's inner structure. * * @deprecated As of version 1.38. Instead, use the `sap.ui.layout.Grid` control. */ export default class MatrixLayoutRow extends UI5Element { /** * Constructor for a new layout/MatrixLayoutRow. * * 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?: $MatrixLayoutRowSettings ); /** * Constructor for a new layout/MatrixLayoutRow. * * 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?: $MatrixLayoutRowSettings ); /** * Creates a new subclass of class sap.ui.commons.layout.MatrixLayoutRow with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @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.ui.commons.layout.MatrixLayoutRow. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some cell to the aggregation {@link #getCells cells}. * * * @returns Reference to `this` in order to allow method chaining */ addCell( /** * The cell to add; if empty, nothing is inserted */ oCell: MatrixLayoutCell ): this; /** * The string given as "sStyleClass" will be added to the "class" attribute of this element's root HTML * element. * * This method is intended to be used to mark controls as being of a special type for which special styling * can be provided using CSS selectors that reference this style class name. * * * ```javascript * * Example: * myButton.addStyleClass("myRedTextButton"); // add a CSS class to one button instance * * ...and in CSS: * .myRedTextButton { * color: red; * } * ``` * * * This will add the CSS class "myRedTextButton" to the Button HTML and the CSS code above will then make * the text in this particular button red. * * Only characters allowed inside HTML attributes are allowed. Quotes are not allowed and this method will * ignore any strings containing quotes. Strings containing spaces are interpreted as ONE custom style class * (even though CSS selectors interpret them as different classes) and can only removed later by calling * removeStyleClass() with exactly the same (space-containing) string as parameter. Multiple calls with * the same sStyleClass will have no different effect than calling once. If sStyleClass is null, the call * is ignored. * * Returns `this` to allow method chaining */ addStyleClass( /** * the CSS class name to be added */ sStyleClass: string ): this; /** * Destroys all the cells in the aggregation {@link #getCells cells}. * * * @returns Reference to `this` in order to allow method chaining */ destroyCells(): this; /** * Gets content of aggregation {@link #getCells cells}. * * The matrix layout row's individual cells. */ getCells(): MatrixLayoutCell[]; /** * Gets current value of property {@link #getHeight height}. * * Height of the row. * * * @returns Value of property `height` */ getHeight(): CSSSize; /** * Returns true if the given style class string is valid and if this Element has this style class set via * a previous call to addStyleClass(). */ hasStyleClass( /** * the style to check for */ sStyleClass: string ): boolean; /** * Checks for the provided `sap.ui.commons.layout.MatrixLayoutCell` in the aggregation {@link #getCells cells}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfCell( /** * The cell whose index is looked for */ oCell: MatrixLayoutCell ): int; /** * Inserts a cell into the aggregation {@link #getCells cells}. * * * @returns Reference to `this` in order to allow method chaining */ insertCell( /** * The cell to insert; if empty, nothing is inserted */ oCell: MatrixLayoutCell, /** * The `0`-based index the cell should be inserted at; for a negative value of `iIndex`, the cell is inserted * at position 0; for a value greater than the current size of the aggregation, the cell is inserted at * the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getCells cells}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllCells(): MatrixLayoutCell[]; /** * Removes a cell from the aggregation {@link #getCells cells}. * * * @returns The removed cell or `null` */ removeCell( /** * The cell to remove or its index or id */ vCell: int | string | MatrixLayoutCell ): MatrixLayoutCell | null; /** * Removes the given string from the list of custom style classes that have been set previously. Regular * style classes like "sapUiBtn" cannot be removed. * * Returns `this` to allow method chaining */ removeStyleClass( /** * the style to be removed */ sStyleClass: string ): this; /** * Sets a new value for property {@link #getHeight height}. * * Height of the row. * * 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 */ setHeight( /** * New value for property `height` */ sHeight?: CSSSize ): this; } /** * Describes the settings that can be provided to the MatrixLayoutRow constructor. * * @deprecated As of version 1.38. Instead, use the `sap.ui.layout.Grid` control. */ export interface $MatrixLayoutRowSettings extends $ElementSettings { /** * Height of the row. */ height?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * The matrix layout row's individual cells. */ cells?: | MatrixLayoutCell[] | MatrixLayoutCell | AggregationBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/layout/PositionContainer" { import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element"; import { CSSSize } from "sap/ui/core/library"; import Control from "sap/ui/core/Control"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Is used to specify the position of a control in the AbsoluteLayout * * @deprecated As of version 1.38. */ export default class PositionContainer extends UI5Element { /** * Constructor for a new layout/PositionContainer. * * 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?: $PositionContainerSettings ); /** * Constructor for a new layout/PositionContainer. * * 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?: $PositionContainerSettings ); /** * Creates a new subclass of class sap.ui.commons.layout.PositionContainer with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @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.ui.commons.layout.PositionContainer. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Destroys the control in the aggregation {@link #getControl control}. * * * @returns Reference to `this` in order to allow method chaining */ destroyControl(): this; /** * Gets current value of property {@link #getBottom bottom}. * * Defines the distance to the bottom of the layout (as specified in HTML) * * * @returns Value of property `bottom` */ getBottom(): CSSSize; /** * Gets current value of property {@link #getCenterHorizontally centerHorizontally}. * * Indicates whether this container shall be centered horizontally within the AbsoluteLayout area. The values * of the attributes left and right are ignored when this feature is activated. * * Default value is `false`. * * * @returns Value of property `centerHorizontally` */ getCenterHorizontally(): boolean; /** * Gets current value of property {@link #getCenterVertically centerVertically}. * * Indicates whether this container should be centered vertically within the AbsoluteLayout area. The values * of the attributes top and bottom are ignored when this feature is activated. * * Default value is `false`. * * * @returns Value of property `centerVertically` */ getCenterVertically(): boolean; /** * Gets content of aggregation {@link #getControl control}. * * Child control of the position container */ getControl(): Control; /** * Gets current value of property {@link #getLeft left}. * * Defines the distance to the left of the layout (as specified in HTML) * * * @returns Value of property `left` */ getLeft(): CSSSize; /** * Gets current value of property {@link #getRight right}. * * Defines the distance to the right of the layout (as specified in HTML) * * * @returns Value of property `right` */ getRight(): CSSSize; /** * Gets current value of property {@link #getTop top}. * * Defines the distance to the top of the layout (as specified in HTML) * * * @returns Value of property `top` */ getTop(): CSSSize; /** * Sets a new value for property {@link #getBottom bottom}. * * Defines the distance to the bottom of the layout (as specified in HTML) * * 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 */ setBottom( /** * New value for property `bottom` */ sBottom?: CSSSize ): this; /** * Sets a new value for property {@link #getCenterHorizontally centerHorizontally}. * * Indicates whether this container shall be centered horizontally within the AbsoluteLayout area. The values * of the attributes left and right are ignored when this feature is activated. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setCenterHorizontally( /** * New value for property `centerHorizontally` */ bCenterHorizontally?: boolean ): this; /** * Sets a new value for property {@link #getCenterVertically centerVertically}. * * Indicates whether this container should be centered vertically within the AbsoluteLayout area. The values * of the attributes top and bottom are ignored when this feature is activated. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setCenterVertically( /** * New value for property `centerVertically` */ bCenterVertically?: boolean ): this; /** * Sets the aggregated {@link #getControl control}. * * * @returns Reference to `this` in order to allow method chaining */ setControl( /** * The control to set */ oControl: Control ): this; /** * Sets a new value for property {@link #getLeft left}. * * Defines the distance to the left of the layout (as specified in HTML) * * 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 */ setLeft( /** * New value for property `left` */ sLeft?: CSSSize ): this; /** * Sets a new value for property {@link #getRight right}. * * Defines the distance to the right of the layout (as specified in HTML) * * 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 */ setRight( /** * New value for property `right` */ sRight?: CSSSize ): this; /** * Sets a new value for property {@link #getTop top}. * * Defines the distance to the top of the layout (as specified in HTML) * * 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 */ setTop( /** * New value for property `top` */ sTop?: CSSSize ): this; /** * Updates the position properties of the container according to the given position in JSON style. */ updatePosition( /** * JSON-like object which defines the position of the child control in the absolute layout. The object is * expected to have one or more out of the attributes top, bottom, left, right (each with a value of type * sap.ui.core.CSSSize). If no object is given, nothing is updated. */ oPos: object ): void; } /** * Describes the settings that can be provided to the PositionContainer constructor. * * @deprecated As of version 1.38. */ export interface $PositionContainerSettings extends $ElementSettings { /** * Defines the distance to the top of the layout (as specified in HTML) */ top?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Defines the distance to the bottom of the layout (as specified in HTML) */ bottom?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Defines the distance to the left of the layout (as specified in HTML) */ left?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Defines the distance to the right of the layout (as specified in HTML) */ right?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Indicates whether this container shall be centered horizontally within the AbsoluteLayout area. The values * of the attributes left and right are ignored when this feature is activated. */ centerHorizontally?: boolean | PropertyBindingInfo | `{${string}}`; /** * Indicates whether this container should be centered vertically within the AbsoluteLayout area. The values * of the attributes top and bottom are ignored when this feature is activated. */ centerVertically?: boolean | PropertyBindingInfo | `{${string}}`; /** * Child control of the position container */ control?: Control; } } declare module "sap/ui/commons/layout/ResponsiveFlowLayout" { import { default as ResponsiveFlowLayout1, $ResponsiveFlowLayoutSettings as $ResponsiveFlowLayoutSettings1, } from "sap/ui/layout/ResponsiveFlowLayout"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * This is a layout where several controls can be added. These controls are blown up to fit a whole line. * If the window resizes the controls are moved between the lines and resized again. * * @since 1.9.1 * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export default class ResponsiveFlowLayout extends ResponsiveFlowLayout1 { /** * Constructor for a new layout/ResponsiveFlowLayout. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.ResponsiveFlowLayout#constructor sap.ui.layout.ResponsiveFlowLayout } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: $ResponsiveFlowLayoutSettings ); /** * Constructor for a new layout/ResponsiveFlowLayout. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.ResponsiveFlowLayout#constructor sap.ui.layout.ResponsiveFlowLayout } * can be used. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: $ResponsiveFlowLayoutSettings ); /** * Creates a new subclass of class sap.ui.commons.layout.ResponsiveFlowLayout with name `sClassName` and * enriches it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.ResponsiveFlowLayout.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.ui.commons.layout.ResponsiveFlowLayout. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; } /** * Describes the settings that can be provided to the ResponsiveFlowLayout constructor. * * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export interface $ResponsiveFlowLayoutSettings extends $ResponsiveFlowLayoutSettings1 {} } declare module "sap/ui/commons/layout/ResponsiveFlowLayoutData" { import { default as ResponsiveFlowLayoutData1, $ResponsiveFlowLayoutDataSettings as $ResponsiveFlowLayoutDataSettings1, } from "sap/ui/layout/ResponsiveFlowLayoutData"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * This is a LayoutData Element that can be added to a control if this control is used within a ResponsiveFlowLayout * * @since 1.9.1 * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export default class ResponsiveFlowLayoutData extends ResponsiveFlowLayoutData1 { /** * Constructor for a new layout/ResponsiveFlowLayoutData. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.ResponsiveFlowLayoutData#constructor sap.ui.layout.ResponsiveFlowLayoutData } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: $ResponsiveFlowLayoutDataSettings ); /** * Constructor for a new layout/ResponsiveFlowLayoutData. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.ResponsiveFlowLayoutData#constructor sap.ui.layout.ResponsiveFlowLayoutData } * can be used. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: $ResponsiveFlowLayoutDataSettings ); /** * Creates a new subclass of class sap.ui.commons.layout.ResponsiveFlowLayoutData with name `sClassName` * and enriches it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.ResponsiveFlowLayoutData.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.ui.commons.layout.ResponsiveFlowLayoutData. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Getter for property `margin`. This property prevents any margin of the element if set to false * * Default value is `true` * * @since 1.11.0 * * @returns the value of property `margin` */ getMargin(): boolean; /** * Setter for property `margin`. * * Default value is `true` * * @since 1.11.0 * * @returns `this` to allow method chaining */ setMargin( /** * new value for property `margin` */ bMargin: boolean ): this; } /** * Describes the settings that can be provided to the ResponsiveFlowLayoutData constructor. * * @deprecated As of version 1.16.0. moved to sap.ui.layout library. Please use this one. */ export interface $ResponsiveFlowLayoutDataSettings extends $ResponsiveFlowLayoutDataSettings1 {} } declare module "sap/ui/commons/layout/VerticalLayout" { import { default as VerticalLayout1, $VerticalLayoutSettings as $VerticalLayoutSettings1, } from "sap/ui/layout/VerticalLayout"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * In this layout the elements are ordered one below the other * * @deprecated As of version 1.16.0. Moved to sap.ui.layout library. Please use this one. */ export default class VerticalLayout extends VerticalLayout1 { /** * Constructor for a new layout/VerticalLayout. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.VerticalLayout#constructor sap.ui.layout.VerticalLayout } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: $VerticalLayoutSettings ); /** * Constructor for a new layout/VerticalLayout. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.layout.VerticalLayout#constructor sap.ui.layout.VerticalLayout } * can be used. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: $VerticalLayoutSettings ); /** * Creates a new subclass of class sap.ui.commons.layout.VerticalLayout with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.VerticalLayout.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.ui.commons.layout.VerticalLayout. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; } /** * Describes the settings that can be provided to the VerticalLayout constructor. * * @deprecated As of version 1.16.0. Moved to sap.ui.layout library. Please use this one. */ export interface $VerticalLayoutSettings extends $VerticalLayoutSettings1 {} } declare module "sap/ui/commons/Link" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { ToolbarItem, FormattedTextViewControl, } from "sap/ui/commons/library"; import { IFormContent, ID, AccessibilityInfo, URI, CSSSize, } from "sap/ui/core/library"; import Event from "sap/ui/base/Event"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Provides an absolute or relative reference to an internal or external URL. The classical target parameters * are supported. Another usage scenario is triggering an action, for example to open a popup window. In * both cases, the link is a hypertext link. * * @deprecated As of version 1.38. Instead, use the `sap.m.Link` control. */ export default class Link extends Control implements ToolbarItem, FormattedTextViewControl, IFormContent { __implements__sap_ui_commons_ToolbarItem: boolean; __implements__sap_ui_commons_FormattedTextViewControl: boolean; __implements__sap_ui_core_IFormContent: boolean; /** * Constructor for a new Link. * * 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?: $LinkSettings ); /** * Constructor for a new Link. * * 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?: $LinkSettings ); /** * Creates a new subclass of class sap.ui.commons.Link with name `sClassName` and enriches it with the information * contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.Link. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaDescribedBy( /** * The ariaDescribedBy to add; if empty, nothing is inserted */ vAriaDescribedBy: ID | Control ): this; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaLabelledBy( /** * The ariaLabelledBy to add; if empty, nothing is inserted */ vAriaLabelledBy: ID | Control ): this; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.commons.Link`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Link` itself. * * Event is fired when the user clicks the control. * * * @returns Reference to `this` in order to allow method chaining */ attachPress( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Link` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.commons.Link`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Link` itself. * * Event is fired when the user clicks the control. * * * @returns Reference to `this` in order to allow method chaining */ attachPress( /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Link` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.commons.Link`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachPress( /** * The function to be called, when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:press press} to attached listeners. * * Listeners may prevent the default action of this event by calling the `preventDefault` method on the * event object. The return value of this method indicates whether the default action should be executed. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Whether or not to prevent the default action */ firePress( /** * Parameters to pass along with the event */ mParameters?: object ): boolean; /** * Puts the focus to the link. */ focus(): void; /** * See: * sap.ui.core.Control#getAccessibilityInfo * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns The object contains the accessibility information of `sap.ui.commons.Link` */ getAccessibilityInfo(): AccessibilityInfo; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): ID[]; /** * Gets current value of property {@link #getEnabled enabled}. * * Whether the link can be triggered by the user. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getHelpId helpId}. * * Unique identifier used for help service. * * Default value is `empty string`. * * * @returns Value of property `helpId` */ getHelpId(): string; /** * Gets current value of property {@link #getHref href}. * * The link target URI. Supports standard hyperlink behavior. If an action should be triggered, this should * not be set, but instead an event handler for the "press" event should be registered. * * * @returns Value of property `href` */ getHref(): URI; /** * Gets current value of property {@link #getTarget target}. * * Options are _self, _top, _blank, _parent, _search. Alternatively, a frame name can be entered. * * * @returns Value of property `target` */ getTarget(): string; /** * Gets current value of property {@link #getText text}. * * Link text to be displayed. * * Default value is `empty string`. * * * @returns Value of property `text` */ getText(): string; /** * Gets current value of property {@link #getWidth width}. * * Width of text link. When it is set (CSS-size such as % or px), this is the exact size. When left blank, * the text defines the size. * * @since 1.8.0 * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaDescribedBy(): ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): ID[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns The removed ariaDescribedBy or `null` */ removeAriaDescribedBy( /** * The ariaDescribedBy to be removed or its index or ID */ vAriaDescribedBy: int | ID | Control ): ID | null; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns The removed ariaLabelledBy or `null` */ removeAriaLabelledBy( /** * The ariaLabelledBy to be removed or its index or ID */ vAriaLabelledBy: int | ID | Control ): ID | null; /** * Sets a new value for property {@link #getEnabled enabled}. * * Whether the link can be triggered by the user. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getHelpId helpId}. * * Unique identifier used for help service. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setHelpId( /** * New value for property `helpId` */ sHelpId?: string ): this; /** * Sets a new value for property {@link #getHref href}. * * The link target URI. Supports standard hyperlink behavior. If an action should be triggered, this should * not be set, but instead an event handler for the "press" event should be registered. * * 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 */ setHref( /** * New value for property `href` */ sHref?: URI ): this; /** * Sets a new value for property {@link #getTarget target}. * * Options are _self, _top, _blank, _parent, _search. Alternatively, a frame name can be entered. * * 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 */ setTarget( /** * New value for property `target` */ sTarget?: string ): this; /** * Sets a new value for property {@link #getText text}. * * Link text to be displayed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setText( /** * New value for property `text` */ sText?: string ): this; /** * Sets a new value for property {@link #getWidth width}. * * Width of text link. When it is set (CSS-size such as % or px), this is the exact size. When left blank, * the text defines the size. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.8.0 * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; } /** * Describes the settings that can be provided to the Link constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.Link` control. */ export interface $LinkSettings extends $ControlSettings { /** * Link text to be displayed. */ text?: string | PropertyBindingInfo; /** * Whether the link can be triggered by the user. */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * Unique identifier used for help service. */ helpId?: string | PropertyBindingInfo; /** * The link target URI. Supports standard hyperlink behavior. If an action should be triggered, this should * not be set, but instead an event handler for the "press" event should be registered. */ href?: URI | PropertyBindingInfo | `{${string}}`; /** * Options are _self, _top, _blank, _parent, _search. Alternatively, a frame name can be entered. */ target?: string | PropertyBindingInfo; /** * Width of text link. When it is set (CSS-size such as % or px), this is the exact size. When left blank, * the text defines the size. * * @since 1.8.0 */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Association to controls / ids which describe this control (see WAI-ARIA attribute aria-describedby). */ ariaDescribedBy?: Array; /** * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby). */ ariaLabelledBy?: Array; /** * Event is fired when the user clicks the control. */ press?: (oEvent: Event) => void; } /** * Parameters of the Link#press event. */ export interface Link$PressEventParameters {} /** * Event object of the Link#press event. */ export type Link$PressEvent = Event; } declare module "sap/ui/commons/ListBox" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { ID, CSSSize, TextAlign } from "sap/ui/core/library"; import Item from "sap/ui/core/Item"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import ListItem from "sap/ui/core/ListItem"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; import Event from "sap/ui/base/Event"; /** * Provides a list of items from which users can choose an item. For the design of the list box, features * such as defining the list box height, fixing the number of visible items, choosing one item to be the * item that is marked by default when the list box is shown, or a scroll bar for large list boxes are available. * * @deprecated As of version 1.38. Instead, use the `sap.m.List` control. */ export default class ListBox extends Control { /** * Constructor for a new ListBox. * * 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?: $ListBoxSettings ); /** * Constructor for a new ListBox. * * 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?: $ListBoxSettings ); /** * Creates a new subclass of class sap.ui.commons.ListBox with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.ListBox. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaDescribedBy( /** * The ariaDescribedBy to add; if empty, nothing is inserted */ vAriaDescribedBy: ID | Control ): this; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaLabelledBy( /** * The ariaLabelledBy to add; if empty, nothing is inserted */ vAriaLabelledBy: ID | Control ): this; /** * Adds some item to the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ addItem( /** * The item to add; if empty, nothing is inserted */ oItem: Item ): this; /** * Adds the given index to current selection. When multiple selection is disabled, this replaces the current * selection. When the given index is invalid, the call is ignored. * * * @returns `this` to allow method chaining. */ addSelectedIndex( /** * Index to add to selection.. */ iSelectedIndex: int ): this; /** * Adds the given indices to selection. Any invalid indices are ignored. * * * @returns `this` to allow method chaining. */ addSelectedIndices( /** * Indices of the items that shall additionally be selected. */ aSelectedIndices: int[] ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.commons.ListBox`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.ListBox` itself. * * Event is fired when selection is changed by user interaction. * * * @returns Reference to `this` in order to allow method chaining */ attachSelect( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: ListBox$SelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.ListBox` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.commons.ListBox`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.ListBox` itself. * * Event is fired when selection is changed by user interaction. * * * @returns Reference to `this` in order to allow method chaining */ attachSelect( /** * The function to be called when the event occurs */ fnFunction: (p1: ListBox$SelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.ListBox` itself */ oListener?: object ): this; /** * Removes complete selection. * * * @returns `this` to allow method chaining. */ clearSelection(): this; /** * Destroys all the items in the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ destroyItems(): this; /** * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.ui.commons.ListBox`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSelect( /** * The function to be called, when the event occurs */ fnFunction: (p1: ListBox$SelectEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:select select} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSelect( /** * Parameters to pass along with the event */ mParameters?: ListBox$SelectEventParameters ): this; /** * Gets current value of property {@link #getAllowMultiSelect allowMultiSelect}. * * Determines whether multiple selection is allowed. * * Default value is `false`. * * * @returns Value of property `allowMultiSelect` */ getAllowMultiSelect(): boolean; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): ID[]; /** * Gets current value of property {@link #getDisplayIcons displayIcons}. * * Determines whether the icons of the list items shall also be displayed. Enabling icons requires some * space to be reserved for them. Displaying icons can also influence the width and height of a single item, * which affects the overall height of the ListBox when defined in number of items. Note that the number * of icons that can be displayed in the ListBox depends on the size of the icons themselves and of the * total ListBox height. * * Default value is `false`. * * * @returns Value of property `displayIcons` */ getDisplayIcons(): boolean; /** * Gets current value of property {@link #getDisplaySecondaryValues displaySecondaryValues}. * * Determines whether the text values from the additionalText property (see sap.ui.core.ListItems) shall * be displayed. * * Default value is `false`. * * * @returns Value of property `displaySecondaryValues` */ getDisplaySecondaryValues(): boolean; /** * Gets current value of property {@link #getEditable editable}. * * Determines whether the ListBox is interactive or not. Can be used to disable interaction with mouse or * keyboard. * * Default value is `true`. * * * @returns Value of property `editable` */ getEditable(): boolean; /** * Gets current value of property {@link #getEnabled enabled}. * * Determines whether the ListBox is enabled or not. Can be used to disable interaction with mouse or keyboard. * Disabled controls have another color display depending on custom settings. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getHeight height}. * * Control height as common CSS-size (px or % as unit, for example). The setting overrides any definitions * made for the setVisibleItems() method. * * * @returns Value of property `height` */ getHeight(): CSSSize; /** * Gets content of aggregation {@link #getItems items}. * * Aggregation of items to be displayed. Must be either of type sap.ui.core.ListItem or sap.ui.core.SeparatorItem. */ getItems(): Item[]; /** * Gets current value of property {@link #getMaxWidth maxWidth}. * * Determines the maximum width of the ListBox. If not set, there is no maximum width. * * * @returns Value of property `maxWidth` */ getMaxWidth(): CSSSize; /** * Gets current value of property {@link #getMinWidth minWidth}. * * Determines the minimum width of the ListBox. If not set, there is no minimum width. * * * @returns Value of property `minWidth` */ getMinWidth(): CSSSize; /** * Returns how many pixels the ListBox contents are currently scrolled down. * * * @returns Vertical scroll position. */ getScrollTop(): int; /** * Gets current value of property {@link #getSecondaryValueTextAlign secondaryValueTextAlign}. * * Determines the text alignment in the secondary ListBox text column (if available). * * Default value is `Begin`. * * * @returns Value of property `secondaryValueTextAlign` */ getSecondaryValueTextAlign(): TextAlign; /** * Zero-based index of selected item. Index value for no selection is -1. When multiple selection is enabled * and multiple items are selected, the method returns the first selected item. * * * @returns Selected index */ getSelectedIndex(): int; /** * Zero-based indices of selected items, wrapped in an array. An empty array means "no selection". * * * @returns Array of selected indices. */ getSelectedIndices(): int[]; /** * Returns selected item. When no item is selected, "null" is returned. When multi-selection is enabled * and multiple items are selected, only the first selected item is returned. * * * @returns Selected item */ getSelectedItem(): Item; /** * Returns an array containing the selected items. In the case of no selection, an empty array is returned. * * * @returns Selected items. */ getSelectedItems(): Item[]; /** * Returns the keys of the selected items in an array. If a selected item does not have a key, the respective * array entry will be undefined. * * * @returns Array with selected keys. */ getSelectedKeys(): string[]; /** * Gets current value of property {@link #getValueTextAlign valueTextAlign}. * * Determines the text alignment in the primary ListBox column. * * Default value is `Begin`. * * * @returns Value of property `valueTextAlign` */ getValueTextAlign(): TextAlign; /** * Returns the number of visible items. * * * @returns Number of visible items. */ getVisibleItems(): int; /** * Gets current value of property {@link #getWidth width}. * * Control width as common CSS-size (px or % as unit, for example). * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Checks for the provided `sap.ui.core.Item` in the aggregation {@link #getItems items}. and returns its * index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfItem( /** * The item whose index is looked for */ oItem: Item ): int; /** * Inserts a item into the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ insertItem( /** * The item to insert; if empty, nothing is inserted */ oItem: Item, /** * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted * at position 0; for a value greater than the current size of the aggregation, the item is inserted at * the last position */ iIndex: int ): this; /** * Returns whether the given index is selected. * * * @returns Whether index is selected. */ isIndexSelected( /** * Index which is checked for selection state. */ iIndex: int ): boolean; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaDescribedBy(): ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): ID[]; /** * Removes all the controls from the aggregation {@link #getItems items}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllItems(): Item[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns The removed ariaDescribedBy or `null` */ removeAriaDescribedBy( /** * The ariaDescribedBy to be removed or its index or ID */ vAriaDescribedBy: int | ID | Control ): ID | null; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns The removed ariaLabelledBy or `null` */ removeAriaLabelledBy( /** * The ariaLabelledBy to be removed or its index or ID */ vAriaLabelledBy: int | ID | Control ): ID | null; /** * Removes a item from the aggregation {@link #getItems items}. * * * @returns The removed item or `null` */ removeItem( /** * The item to remove or its index or id */ vItem: int | string | Item ): Item | null; /** * Removes the given index from this selection. When the index is invalid or not selected, the call is ignored. * * * @returns `this` to allow method chaining. */ removeSelectedIndex( /** * Index that shall be removed from selection. */ iIndex: int ): this; /** * If the ListBox has a scroll bar because the number of items is larger than the number of visible items, * this method scrolls to the item with the given index. If there are enough items, this item will then * appear at the topmost visible position in the ListBox. If bLazy is true, it only scrolls as far as required * to make the item visible. Setting the scrollTop property and calling scrollToIndex are two operations * influencing the same "physical" property, so the last call "wins". * * * @returns `this` to allow method chaining. */ scrollToIndex( /** * The index to which the ListBox should scroll. */ iIndex: int, /** * If set to true, the ListBox only scrolls if the item is not completely visible, and it scrolls for exactly * the space to make it fully visible. If set to false, the item is scrolled to the top position (if possible). */ bLazy: boolean ): this; /** * Sets a new value for property {@link #getAllowMultiSelect allowMultiSelect}. * * Determines whether multiple selection is allowed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setAllowMultiSelect( /** * New value for property `allowMultiSelect` */ bAllowMultiSelect?: boolean ): this; /** * Sets a new value for property {@link #getDisplayIcons displayIcons}. * * Determines whether the icons of the list items shall also be displayed. Enabling icons requires some * space to be reserved for them. Displaying icons can also influence the width and height of a single item, * which affects the overall height of the ListBox when defined in number of items. Note that the number * of icons that can be displayed in the ListBox depends on the size of the icons themselves and of the * total ListBox height. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setDisplayIcons( /** * New value for property `displayIcons` */ bDisplayIcons?: boolean ): this; /** * Sets a new value for property {@link #getDisplaySecondaryValues displaySecondaryValues}. * * Determines whether the text values from the additionalText property (see sap.ui.core.ListItems) shall * be displayed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setDisplaySecondaryValues( /** * New value for property `displaySecondaryValues` */ bDisplaySecondaryValues?: boolean ): this; /** * Sets a new value for property {@link #getEditable editable}. * * Determines whether the ListBox is interactive or not. Can be used to disable interaction with mouse or * keyboard. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEditable( /** * New value for property `editable` */ bEditable?: boolean ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * Determines whether the ListBox is enabled or not. Can be used to disable interaction with mouse or keyboard. * Disabled controls have another color display depending on custom settings. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets the height of this ListBox in CSS units. * * * @returns `this` to allow method chaining. */ setHeight( /** * New height for the ListBox. */ sHeight: CSSSize ): this; /** * Allows setting the list items as array for this instance of ListBox. * * * @returns `this` to allow method chaining. */ setItems( /** * The items to set for this ListBox. */ aItems: ListItem[], /** * Optional boolean parameter to indicate that the formerly set items should be destroyed, instead of just * removed. */ bDestroyItems: boolean ): this; /** * Sets a new value for property {@link #getMaxWidth maxWidth}. * * Determines the maximum width of the ListBox. If not set, there is no maximum width. * * 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 */ setMaxWidth( /** * New value for property `maxWidth` */ sMaxWidth?: CSSSize ): this; /** * Sets a new value for property {@link #getMinWidth minWidth}. * * Determines the minimum width of the ListBox. If not set, there is no minimum width. * * 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 */ setMinWidth( /** * New value for property `minWidth` */ sMinWidth?: CSSSize ): this; /** * Positions the ListBox contents so that they are scrolled-down by the given number of pixels. * * * @returns `this` to allow method chaining. */ setScrollTop( /** * Vertical scroll position in pixels. */ iScrollTop: int ): this; /** * Sets a new value for property {@link #getSecondaryValueTextAlign secondaryValueTextAlign}. * * Determines the text alignment in the secondary ListBox text column (if available). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Begin`. * * * @returns Reference to `this` in order to allow method chaining */ setSecondaryValueTextAlign( /** * New value for property `secondaryValueTextAlign` */ sSecondaryValueTextAlign?: TextAlign | keyof typeof TextAlign ): this; /** * Sets the zero-based index of the currently selected item. This method removes any previous selections. * When the given index is invalid, the call is ignored. * * * @returns `this` to allow method chaining. */ setSelectedIndex( /** * Index to be selected. */ iSelectedIndex: int ): this; /** * Zero-based indices of selected items, wrapped in an array. An empty array means "no selection". When * multiple selection is disabled and multiple items are given, the selection is set to the index of the * first valid index in the given array. Any invalid indices are ignored. The previous selection is in any * case replaced. * * * @returns `this` to allow method chaining. */ setSelectedIndices( /** * Indices of the items to be selected. */ aSelectedIndices: int[] ): this; /** * Keys of the items to be selected, wrapped in an array. An empty array means no selection. When multiple * selection is disabled, and multiple keys are given, the selection is set to the item with the first valid * key in the given array. Any invalid keys are ignored. The previous selection is replaced in any case. * * * @returns `this` to allow method chaining. */ setSelectedKeys( /** * The keys of the items to be selected. */ aSelectedKeys: string[] ): this; /** * Sets a new value for property {@link #getValueTextAlign valueTextAlign}. * * Determines the text alignment in the primary ListBox column. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Begin`. * * * @returns Reference to `this` in order to allow method chaining */ setValueTextAlign( /** * New value for property `valueTextAlign` */ sValueTextAlign?: TextAlign | keyof typeof TextAlign ): this; /** * Makes the ListBox render with a height that allows it to display exactly the given number of items. * * * @returns `this` to allow method chaining. */ setVisibleItems( /** * The number of items that should fit into the ListBox without scrolling. */ iItemCount: int ): this; /** * Sets the width of this ListBox in CSS units. * * * @returns `this` to allow method chaining. */ setWidth( /** * New width for the ListBox. */ sWidth: CSSSize ): this; } /** * Describes the settings that can be provided to the ListBox constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.List` control. */ export interface $ListBoxSettings extends $ControlSettings { /** * Determines whether the ListBox is interactive or not. Can be used to disable interaction with mouse or * keyboard. */ editable?: boolean | PropertyBindingInfo | `{${string}}`; /** * Determines whether the ListBox is enabled or not. Can be used to disable interaction with mouse or keyboard. * Disabled controls have another color display depending on custom settings. */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * Determines whether multiple selection is allowed. */ allowMultiSelect?: boolean | PropertyBindingInfo | `{${string}}`; /** * Control width as common CSS-size (px or % as unit, for example). */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Control height as common CSS-size (px or % as unit, for example). The setting overrides any definitions * made for the setVisibleItems() method. */ height?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Scroll bar position from the top. Setting the scrollTop property and calling scrollToIndex are two operations * influencing the same "physical" property, so the last call "wins". */ scrollTop?: int | PropertyBindingInfo | `{${string}}`; /** * Determines whether the icons of the list items shall also be displayed. Enabling icons requires some * space to be reserved for them. Displaying icons can also influence the width and height of a single item, * which affects the overall height of the ListBox when defined in number of items. Note that the number * of icons that can be displayed in the ListBox depends on the size of the icons themselves and of the * total ListBox height. */ displayIcons?: boolean | PropertyBindingInfo | `{${string}}`; /** * Determines whether the text values from the additionalText property (see sap.ui.core.ListItems) shall * be displayed. */ displaySecondaryValues?: boolean | PropertyBindingInfo | `{${string}}`; /** * Determines the text alignment in the primary ListBox column. */ valueTextAlign?: | (TextAlign | keyof typeof TextAlign) | PropertyBindingInfo | `{${string}}`; /** * Determines the text alignment in the secondary ListBox text column (if available). */ secondaryValueTextAlign?: | (TextAlign | keyof typeof TextAlign) | PropertyBindingInfo | `{${string}}`; /** * Determines the minimum width of the ListBox. If not set, there is no minimum width. */ minWidth?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Determines the maximum width of the ListBox. If not set, there is no maximum width. */ maxWidth?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * The ListBox height in number of items that are initially displayed without scrolling. This setting overwrites * height settings in terms of CSS size that have been made. When the items have different heights, the * height of the first item is used for all other item height calculations. Note that if there are one or * more separators between the visible ListBox items, the displayed items might not relate 1:1 to the initially * specified number of items. When the value is retrieved, it equals the previously set value if it was * set; otherwise, it will be the number of items completely fitting into the ListBox without scrolling * in the case the control was already rendered. Note that if the control was not rendered, the behavior * will be undefined, it may return -1 or any other number. */ visibleItems?: int | PropertyBindingInfo | `{${string}}`; /** * Aggregation of items to be displayed. Must be either of type sap.ui.core.ListItem or sap.ui.core.SeparatorItem. */ items?: Item[] | Item | AggregationBindingInfo | `{${string}}`; /** * Association to controls / ids which describe this control (see WAI-ARIA attribute aria-describedby). */ ariaDescribedBy?: Array; /** * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby). */ ariaLabelledBy?: Array; /** * Event is fired when selection is changed by user interaction. */ select?: (oEvent: ListBox$SelectEvent) => void; } /** * Parameters of the ListBox#select event. */ export interface ListBox$SelectEventParameters { /** * ID of the ListBox which triggered the event. */ id?: string; /** * The currently selected index of the ListBox. In the case of multiple selection, this is exactly one of * the selected indices - the one whose selection has triggered the selection change. To get all currently * selected indices, use selectedIndices. */ selectedIndex?: int; /** * The currently selected item of the ListBox. In the case of multiple selection, this is exactly one of * the selected items - the one whose selection has triggered the selection change. */ selectedItem?: Item; /** * Array containing the indices which are selected. */ selectedIndices?: int[]; } /** * Event object of the ListBox#select event. */ export type ListBox$SelectEvent = Event< ListBox$SelectEventParameters, ListBox >; } declare module "sap/ui/commons/Menu" { import { default as Menu1, $MenuSettings as $MenuSettings1, } from "sap/ui/unified/Menu"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * A menu is an interactive element which provides a choice of different actions to the user. These actions * (items) can also be organized in submenus. Like other dialog-like controls, the menu is not rendered * within the control hierarchy. Instead it can be opened at a specified position via a function call. * * @since 1.0.0 * @deprecated As of version 1.21.0. replaced by {@link sap.ui.unified.Menu} */ export default class Menu extends Menu1 { /** * Constructor for a new Menu control. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.unified.Menu#constructor sap.ui.unified.Menu } * can be used. */ constructor( /** * Initial settings for the new control */ mSettings?: $MenuSettings ); /** * Constructor for a new Menu control. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.unified.Menu#constructor sap.ui.unified.Menu } * can be used. */ constructor( /** * Id for the new control, generated automatically if no id is given */ sId?: string, /** * Initial settings for the new control */ mSettings?: $MenuSettings ); /** * Creates a new subclass of class sap.ui.commons.Menu with name `sClassName` and enriches it with the information * contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.unified.Menu.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.ui.commons.Menu. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; } /** * Describes the settings that can be provided to the Menu constructor. * * @deprecated As of version 1.21.0. replaced by {@link sap.ui.unified.Menu} */ export interface $MenuSettings extends $MenuSettings1 {} } declare module "sap/ui/commons/MenuBar" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import MenuItem from "sap/ui/unified/MenuItem"; import { MenuBarDesign } from "sap/ui/commons/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { CSSSize } from "sap/ui/core/library"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; /** * Represents a user interface area which is the entry point for menus with their menu items. MenuBar is * useful for applications which shall offer a set of actions that shall be provided in a structured way. * The MenuBar contains the menu titles from where users navigate to the single items. The control supports * for example long menu item texts, automated scrolling for menu items when the browser space is not large * enough to display all items, defining images for single or all items in a menu, automated layouting of * items with or w/o image, and active/non-active items. * * @deprecated As of version 1.38. Instead, use the `sap.m.OverflowToolbar` control. */ export default class MenuBar extends Control { /** * Constructor for a new MenuBar. * * 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?: $MenuBarSettings ); /** * Constructor for a new MenuBar. * * 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?: $MenuBarSettings ); /** * Creates a new subclass of class sap.ui.commons.MenuBar with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.MenuBar. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some item to the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ addItem( /** * The item to add; if empty, nothing is inserted */ oItem: MenuItem ): this; /** * Destroys all the items in the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ destroyItems(): this; /** * Gets current value of property {@link #getDesign design}. * * Available design options are Header and Standard. Note that design settings are theme-dependent. * * Default value is `Standard`. * * * @returns Value of property `design` */ getDesign(): MenuBarDesign; /** * Gets current value of property {@link #getEnabled enabled}. * * When the MenuBar is not enabled, automatically all single menu items are also displayed as 'disabled'. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets content of aggregation {@link #getItems items}. * * Aggregation of menu items. */ getItems(): MenuItem[]; /** * Gets current value of property {@link #getWidth width}. * * Specifies the width of the MenuBar * * Default value is `'100%'`. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Checks for the provided `sap.ui.unified.MenuItem` in the aggregation {@link #getItems items}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfItem( /** * The item whose index is looked for */ oItem: MenuItem ): int; /** * Inserts a item into the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ insertItem( /** * The item to insert; if empty, nothing is inserted */ oItem: MenuItem, /** * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted * at position 0; for a value greater than the current size of the aggregation, the item is inserted at * the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getItems items}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllItems(): MenuItem[]; /** * Removes a item from the aggregation {@link #getItems items}. * * * @returns The removed item or `null` */ removeItem( /** * The item to remove or its index or id */ vItem: int | string | MenuItem ): MenuItem | null; /** * Sets a new value for property {@link #getDesign design}. * * Available design options are Header and Standard. Note that design settings are theme-dependent. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Standard`. * * * @returns Reference to `this` in order to allow method chaining */ setDesign( /** * New value for property `design` */ sDesign?: MenuBarDesign | keyof typeof MenuBarDesign ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * When the MenuBar is not enabled, automatically all single menu items are also displayed as 'disabled'. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getWidth width}. * * Specifies the width of the MenuBar * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'100%'`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; } /** * Describes the settings that can be provided to the MenuBar constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.OverflowToolbar` control. */ export interface $MenuBarSettings extends $ControlSettings { /** * When the MenuBar is not enabled, automatically all single menu items are also displayed as 'disabled'. */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * Specifies the width of the MenuBar */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Available design options are Header and Standard. Note that design settings are theme-dependent. */ design?: | (MenuBarDesign | keyof typeof MenuBarDesign) | PropertyBindingInfo | `{${string}}`; /** * Aggregation of menu items. */ items?: MenuItem[] | MenuItem | AggregationBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/MenuButton" { import { default as Button, $ButtonSettings, Button$PressEventParameters, } from "sap/ui/commons/Button"; import Menu from "sap/ui/unified/Menu"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; import MenuItemBase from "sap/ui/unified/MenuItemBase"; import Event from "sap/ui/base/Event"; import MenuItemBase1 from "sap/ui/commons/MenuItemBase"; /** * Common button control that opens a menu when clicked by the user. The control provides an API for configuring * the docking position of the menu. * * @deprecated As of version 1.38. Instead, use the `sap.m.MenuButton` control. */ export default class MenuButton extends Button { /** * Constructor for a new MenuButton. * * 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?: $MenuButtonSettings ); /** * Constructor for a new MenuButton. * * 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?: $MenuButtonSettings ); /** * Creates a new subclass of class sap.ui.commons.MenuButton with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.commons.Button.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.ui.commons.MenuButton. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:itemSelected itemSelected} event of this `sap.ui.commons.MenuButton`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.MenuButton` itself. * * Event that is fired when a menu item is selected by the user * * * @returns Reference to `this` in order to allow method chaining */ attachItemSelected( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: MenuButton$ItemSelectedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.MenuButton` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemSelected itemSelected} event of this `sap.ui.commons.MenuButton`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.MenuButton` itself. * * Event that is fired when a menu item is selected by the user * * * @returns Reference to `this` in order to allow method chaining */ attachItemSelected( /** * The function to be called when the event occurs */ fnFunction: (p1: MenuButton$ItemSelectedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.MenuButton` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.commons.MenuButton`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.MenuButton` itself. * * Event is fired when an item from the menu was selected. * See: * sap.ui.commons.MenuButton#attachItemSelected * * * @returns Reference to `this` in order to allow method chaining */ attachPress( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called, when the event occurs */ fnFunction: (evt: MenuButton$PressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.MenuButton` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.commons.MenuButton`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.MenuButton` itself. * * Event is fired when an item from the menu was selected. * See: * sap.ui.commons.MenuButton#attachItemSelected * * * @returns Reference to `this` in order to allow method chaining */ attachPress( /** * The function to be called, when the event occurs */ fnFunction: (evt: MenuButton$PressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.MenuButton` itself */ oListener?: object ): this; /** * Destroys the menu in the aggregation named `menu`. * * * @returns `this` to allow method chaining */ destroyMenu(): this; /** * Detaches event handler `fnFunction` from the {@link #event:itemSelected itemSelected} event of this `sap.ui.commons.MenuButton`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachItemSelected( /** * The function to be called, when the event occurs */ fnFunction: (p1: MenuButton$ItemSelectedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.commons.MenuButton`. * * The passed function and listener object must match the ones used for event registration. * See: * sap.ui.commons.MenuButton#detachItemSelected * * * @returns Reference to `this` to allow method chaining */ detachPress( /** * The function to be called, when the event occurs */ fnFunction: (evt: MenuButton$PressEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:itemSelected itemSelected} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireItemSelected( /** * Parameters to pass along with the event */ mParameters?: MenuButton$ItemSelectedEventParameters ): this; /** * Fires event {@link #event:press press} to attached listeners. * See: * sap.ui.commons.MenuButton#fireItemSelected * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` to allow method chaining */ firePress( /** * Parameters to pass along with the event */ oParameters?: MenuButton$PressEventParameters ): this; /** * Gets current value of property {@link #getDockButton dockButton}. * * The position / edge (see sap.ui.core.Popup.Dock) of the button where the menu is docked. Default is 'begin * bottom'. * * * @returns Value of property `dockButton` */ getDockButton(): string; /** * Gets current value of property {@link #getDockMenu dockMenu}. * * The position / edge (see sap.ui.core.Popup.Dock) of the menu which is docked to the button. Default is * 'begin top'. * * * @returns Value of property `dockMenu` */ getDockMenu(): string; /** * Gets content of aggregation {@link #getMenu menu}. * * Menu that shall be opened when the button is clicked */ getMenu(): Menu; /** * Sets a new value for property {@link #getDockButton dockButton}. * * The position / edge (see sap.ui.core.Popup.Dock) of the button where the menu is docked. Default is 'begin * bottom'. * * 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 */ setDockButton( /** * New value for property `dockButton` */ sDockButton?: string ): this; /** * Sets a new value for property {@link #getDockMenu dockMenu}. * * The position / edge (see sap.ui.core.Popup.Dock) of the menu which is docked to the button. Default is * 'begin top'. * * 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 */ setDockMenu( /** * New value for property `dockMenu` */ sDockMenu?: string ): this; /** * Setter for the aggregated `menu`. * * * @returns `this` to allow method chaining */ setMenu( /** * The menu to be set to the menu aggregation */ oMenu: Menu ): this; } /** * Describes the settings that can be provided to the MenuButton constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.MenuButton` control. */ export interface $MenuButtonSettings extends $ButtonSettings { /** * The position / edge (see sap.ui.core.Popup.Dock) of the button where the menu is docked. Default is 'begin * bottom'. */ dockButton?: string | PropertyBindingInfo; /** * The position / edge (see sap.ui.core.Popup.Dock) of the menu which is docked to the button. Default is * 'begin top'. */ dockMenu?: string | PropertyBindingInfo; /** * Menu that shall be opened when the button is clicked */ menu?: Menu; /** * Event that is fired when a menu item is selected by the user */ itemSelected?: (oEvent: MenuButton$ItemSelectedEvent) => void; } /** * Parameters of the MenuButton#itemSelected event. */ export interface MenuButton$ItemSelectedEventParameters { /** * The ID of the selected item */ itemId?: string; /** * The selected item */ item?: MenuItemBase; } /** * Event object of the MenuButton#itemSelected event. */ export type MenuButton$ItemSelectedEvent = Event< MenuButton$ItemSelectedEventParameters, MenuButton >; /** * Parameters of the MenuButton#press event. */ export interface MenuButton$PressEventParameters extends Button$PressEventParameters { /** * The id of the selected item */ itemId?: string; /** * The selected item */ item?: MenuItemBase1; } /** * Event object of the MenuButton#press event. */ export type MenuButton$PressEvent = Event< MenuButton$PressEventParameters, MenuButton >; } declare module "sap/ui/commons/MenuItem" { import { default as MenuItem1, $MenuItemSettings as $MenuItemSettings1, } from "sap/ui/unified/MenuItem"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * Standard item to be used inside a menu. A menu item represents an action which can be selected by the * user in the menu or it can provide a submenu to organize the actions hierarchically. * * @since 1.0.0 * @deprecated As of version 1.21.0. replaced by {@link sap.ui.unified.MenuItem} */ export default class MenuItem extends MenuItem1 { /** * Constructor for a new MenuItem element. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.unified.MenuItem#constructor sap.ui.unified.MenuItem } * can be used. */ constructor( /** * Initial settings for the new control */ mSettings?: $MenuItemSettings ); /** * Constructor for a new MenuItem element. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.unified.MenuItem#constructor sap.ui.unified.MenuItem } * can be used. */ constructor( /** * Id for the new control, generated automatically if no id is given */ sId?: string, /** * Initial settings for the new control */ mSettings?: $MenuItemSettings ); /** * Creates a new subclass of class sap.ui.commons.MenuItem with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.unified.MenuItem.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.ui.commons.MenuItem. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; } /** * Describes the settings that can be provided to the MenuItem constructor. * * @deprecated As of version 1.21.0. replaced by {@link sap.ui.unified.MenuItem} */ export interface $MenuItemSettings extends $MenuItemSettings1 {} } declare module "sap/ui/commons/MenuItemBase" { import { default as MenuItemBase1, $MenuItemBaseSettings as $MenuItemBaseSettings1, } from "sap/ui/unified/MenuItemBase"; /** * Abstract base class for menu item which provides common properties and events for all concrete item implementations. * * @since 1.0.0 * @deprecated As of version 1.21.0. replaced by {@link sap.ui.unified.MenuItemBase} */ export default abstract class MenuItemBase extends MenuItemBase1 { /** * Abstract base class `MenuItemBase` for menu item elements. Please use concrete subclasses. */ constructor( /** * Initial settings for the new control */ mSettings?: $MenuItemBaseSettings ); /** * Abstract base class `MenuItemBase` for menu item elements. Please use concrete subclasses. */ constructor( /** * Id for the new control, generated automatically if no id is given */ sId?: string, /** * Initial settings for the new control */ mSettings?: $MenuItemBaseSettings ); } /** * Describes the settings that can be provided to the MenuItemBase constructor. * * @deprecated As of version 1.21.0. replaced by {@link sap.ui.unified.MenuItemBase} */ export interface $MenuItemBaseSettings extends $MenuItemBaseSettings1 {} } declare module "sap/ui/commons/MenuTextFieldItem" { import { default as MenuTextFieldItem1, $MenuTextFieldItemSettings as $MenuTextFieldItemSettings1, } from "sap/ui/unified/MenuTextFieldItem"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * Special menu item which contains a label and a text field. This menu item is e.g. helpful for filter * implementations. The aggregation `submenu` (inherited from parent class) is not supported for this type * of menu item. * * @deprecated As of version 1.21.0. Please use the control `sap.ui.unified.MenuTextFieldItem` of the library * `sap.ui.unified` instead. */ export default class MenuTextFieldItem extends MenuTextFieldItem1 { /** * Constructor for a new MenuTextFieldItem element. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.unified.MenuTextFieldItem#constructor sap.ui.unified.MenuTextFieldItem } * can be used. */ constructor( /** * Initial settings for the new control */ mSettings?: $MenuTextFieldItemSettings ); /** * Constructor for a new MenuTextFieldItem element. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.unified.MenuTextFieldItem#constructor sap.ui.unified.MenuTextFieldItem } * can be used. */ constructor( /** * Id for the new control, generated automatically if no id is given */ sId?: string, /** * Initial settings for the new control */ mSettings?: $MenuTextFieldItemSettings ); /** * Creates a new subclass of class sap.ui.commons.MenuTextFieldItem with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.unified.MenuTextFieldItem.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.ui.commons.MenuTextFieldItem. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; } /** * Describes the settings that can be provided to the MenuTextFieldItem constructor. * * @deprecated As of version 1.21.0. Please use the control `sap.ui.unified.MenuTextFieldItem` of the library * `sap.ui.unified` instead. */ export interface $MenuTextFieldItemSettings extends $MenuTextFieldItemSettings1 {} } declare module "sap/ui/commons/Message" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { MessageType } from "sap/ui/commons/library"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Creates the "Message"s to be supplied to the "MessageBar" Control. * * @deprecated As of version 1.4.0. A new messaging concept will be created in future. Therefore this control * might be removed in one of the next versions. */ export default class Message extends Control { /** * Constructor for a new Message. * * 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?: $MessageSettings ); /** * Constructor for a new Message. * * 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?: $MessageSettings ); /** * Creates a new subclass of class sap.ui.commons.Message with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.Message. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Registers a callback function to be invoked if long text Details are to be made available. * * This callback function will be supplied the corresponding Message "id", and should return the (simple) * HTML string to be displayed within the Message Details Dialog. * * E.g.: myMessage.bindDetails(getDetails); function getDetails(sId) {... return htmlString;} */ bindDetails( /** * the callback function */ fnCallBack: Function ): void; /** * Gets current value of property {@link #getAssociatedElementId associatedElementId}. * * Associated UI element ID. (Optional) For navigation to error field. * * * @returns Value of property `associatedElementId` */ getAssociatedElementId(): string; /** * Gets current value of property {@link #getDesign design}. * * Internal attribute, used to force the display of the "short" or the "long" text only. * * * @returns Value of property `design` */ getDesign(): string; /** * Gets current value of property {@link #getText text}. * * Message short text. (Mandatory) * * * @returns Value of property `text` */ getText(): string; /** * Gets current value of property {@link #getType type}. * * "Success", or "Warning", or "Error" messages. (Mandatory) * * * @returns Value of property `type` */ getType(): MessageType; /** * Sets a new value for property {@link #getAssociatedElementId associatedElementId}. * * Associated UI element ID. (Optional) For navigation to error field. * * 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 */ setAssociatedElementId( /** * New value for property `associatedElementId` */ sAssociatedElementId?: string ): this; /** * Sets a new value for property {@link #getDesign design}. * * Internal attribute, used to force the display of the "short" or the "long" text only. * * 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 */ setDesign( /** * New value for property `design` */ sDesign?: string ): this; /** * Sets a new value for property {@link #getText text}. * * Message short text. (Mandatory) * * 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; /** * Sets a new value for property {@link #getType type}. * * "Success", or "Warning", or "Error" messages. (Mandatory) * * 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 */ setType( /** * New value for property `type` */ sType?: MessageType | keyof typeof MessageType ): this; } /** * Describes the settings that can be provided to the Message constructor. * * @deprecated As of version 1.4.0. A new messaging concept will be created in future. Therefore this control * might be removed in one of the next versions. */ export interface $MessageSettings extends $ControlSettings { /** * "Success", or "Warning", or "Error" messages. (Mandatory) */ type?: | (MessageType | keyof typeof MessageType) | PropertyBindingInfo | `{${string}}`; /** * Message short text. (Mandatory) */ text?: string | PropertyBindingInfo; /** * Associated UI element ID. (Optional) For navigation to error field. */ associatedElementId?: string | PropertyBindingInfo; /** * Internal attribute, used to force the display of the "short" or the "long" text only. */ design?: string | PropertyBindingInfo; } } declare module "sap/ui/commons/MessageBar" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import Message from "sap/ui/commons/Message"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Creates an instance of a MessageBar Control, for displaying messages. * * @deprecated As of version 1.4.0. Instead, use the `sap.m.MessagePopover` control. */ export default class MessageBar extends Control { /** * Constructor for a new MessageBar. * * 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?: $MessageBarSettings ); /** * Constructor for a new MessageBar. * * 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?: $MessageBarSettings ); /** * Creates a new subclass of class sap.ui.commons.MessageBar with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.MessageBar. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds/updates a supplied list of messages. The MessageBar will appear if at least one message exists. */ addMessages( /** * Array of messages. */ aAMessages: Message[] ): void; /** * Deletes all messages. * * * @returns `this` to allow method chaining */ deleteAllMessages(): this; /** * Deletes a supplied list of messages. The MessageBar will disappear when no message remains. */ deleteMessages( /** * Messages IDs to be deleted. */ aIds: string[] ): void; /** * Gets current value of property {@link #getAnchorID anchorID}. * * Element ID upon which the MessageBar will be initially positioned. * * Default value is `empty string`. * * * @returns Value of property `anchorID` */ getAnchorID(): string; /** * Gets current value of property {@link #getAnchorSnapPoint anchorSnapPoint}. * * Type: sap.ui.core.Popup.Dock SnapPoint of MessageBar over anchorId. Note: Use "begin" or "end" for RTL * support. Note: "center" is not indicated, as positioning is only set once, either via the css "left" * or the "right" attribute. Therefore a MessageBar will only be extended in one direction, as Messages * come in. * * Default value is `"begin top"`. * * * @returns Value of property `anchorSnapPoint` */ getAnchorSnapPoint(): string; /** * Gets current value of property {@link #getMaxListed maxListed}. * * Maximum number of messages being displayed in the List before a scrollbar appears. Value '0' means no * limit. * * Default value is `7`. * * * @returns Value of property `maxListed` */ getMaxListed(): int; /** * Gets current value of property {@link #getMaxToasted maxToasted}. * * Maximum number of simultaneous messages being toasted in a row. Value '0' means this dynamic part is * switched off. * * Default value is `3`. * * * @returns Value of property `maxToasted` */ getMaxToasted(): int; /** * Gets current value of property {@link #getVisible visible}. * * Specifies whether or not the MessageBar is visible. Invisible controls are not rendered. * * Default value is `true`. * * * @returns Value of property `visible` */ getVisible(): boolean; /** * Sets a new value for property {@link #getAnchorID anchorID}. * * Element ID upon which the MessageBar will be initially positioned. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setAnchorID( /** * New value for property `anchorID` */ sAnchorID?: string ): this; /** * Sets a new value for property {@link #getAnchorSnapPoint anchorSnapPoint}. * * Type: sap.ui.core.Popup.Dock SnapPoint of MessageBar over anchorId. Note: Use "begin" or "end" for RTL * support. Note: "center" is not indicated, as positioning is only set once, either via the css "left" * or the "right" attribute. Therefore a MessageBar will only be extended in one direction, as Messages * come in. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"begin top"`. * * * @returns Reference to `this` in order to allow method chaining */ setAnchorSnapPoint( /** * New value for property `anchorSnapPoint` */ sAnchorSnapPoint?: string ): this; /** * Sets a new value for property {@link #getMaxListed maxListed}. * * Maximum number of messages being displayed in the List before a scrollbar appears. Value '0' means no * limit. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `7`. * * * @returns Reference to `this` in order to allow method chaining */ setMaxListed( /** * New value for property `maxListed` */ iMaxListed?: int ): this; /** * Sets a new value for property {@link #getMaxToasted maxToasted}. * * Maximum number of simultaneous messages being toasted in a row. Value '0' means this dynamic part is * switched off. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `3`. * * * @returns Reference to `this` in order to allow method chaining */ setMaxToasted( /** * New value for property `maxToasted` */ iMaxToasted?: int ): this; /** * Setter for property `visible`. * * Default value is `true` * * The default implementation of function `setVisible()` is enhanced in order to toggle the `visibility:hidden;` * attribute over the control. * * * @returns `this` to allow method chaining */ setVisible( /** * New value for property `visible` */ bVisible: boolean ): this; } /** * Describes the settings that can be provided to the MessageBar constructor. * * @deprecated As of version 1.4.0. Instead, use the `sap.m.MessagePopover` control. */ export interface $MessageBarSettings extends $ControlSettings { /** * Element ID upon which the MessageBar will be initially positioned. */ anchorID?: string | PropertyBindingInfo; /** * Specifies whether or not the MessageBar is visible. Invisible controls are not rendered. */ visible?: boolean | PropertyBindingInfo | `{${string}}`; /** * Maximum number of simultaneous messages being toasted in a row. Value '0' means this dynamic part is * switched off. */ maxToasted?: int | PropertyBindingInfo | `{${string}}`; /** * Maximum number of messages being displayed in the List before a scrollbar appears. Value '0' means no * limit. */ maxListed?: int | PropertyBindingInfo | `{${string}}`; /** * Type: sap.ui.core.Popup.Dock SnapPoint of MessageBar over anchorId. Note: Use "begin" or "end" for RTL * support. Note: "center" is not indicated, as positioning is only set once, either via the css "left" * or the "right" attribute. Therefore a MessageBar will only be extended in one direction, as Messages * come in. */ anchorSnapPoint?: string | PropertyBindingInfo; } } declare module "sap/ui/commons/MessageBox" { import Control from "sap/ui/core/Control"; /** * Provides methods to create standard alerts, confirmation dialogs, or arbitrary message boxes. * * As `MessageBox` is a static class, a `jQuery.sap.require("sap.ui.commons.MessageBox");` statement must * be explicitly executed before the class can be used. Example: * ```javascript * * jQuery.sap.require("sap.ui.commons.MessageBox"); * sap.ui.commons.MessageBox.show( * "This message should appear in the message box.", * sap.ui.commons.MessageBox.Icon.INFORMATION, * "My message box title", * [sap.ui.commons.MessageBox.Action.YES, sap.ui.commons.MessageBox.Action.NO], * function() { / * do something * / } * ); * ``` * * * @since 0.8.8 * @deprecated As of version 1.38. Instead, use the `sap.m.MessageBox` control. */ interface MessageBox { /** * Enumeration of supported actions in a MessageBox. * * Each action is represented as a button in the message box. The values of this enumeration are used for * both, specifying the set of allowed actions as well as reporting back the user choice. * * This enum is part of the 'sap/ui/commons/MessageBox' module export and must be accessed by the property * 'Action'. * * @deprecated As of version 1.38. Instead, use the `sap.m.MessageBox.Action`. */ Action: typeof Action; /** * Enumeration of the pre-defined icons that can be used in a MessageBox. * * This enum is part of the 'sap/ui/commons/MessageBox' module export and must be accessed by the property * 'Icon'. * * @deprecated As of version 1.38. Instead, use the `sap.m.MessageBox.Icon`. */ Icon: typeof Icon; /** * Displays an alert box with the given message and an OK button (no icons). If a callback is given, it * is called after the alert box has been closed by the user via the OK button or via the Close icon. The * callback is called with the following signature: * * * ```javascript * * function () * ``` * * * The alert box opened by this method is modal and it is processed asynchronously. Applications have to * use the `fnCallback` to continue work after the user closed the alert box. */ alert( /** * Message to be displayed in the alert box */ vMessage: string | Control, /** * callback function to be called when the user closed the dialog */ fnCallback?: Function, /** * Title to be displayed in the alert box */ sTitle?: string, /** * ID to be used for the alert box. Intended for test scenarios, not recommended for productive apps */ sDialogId?: string ): void; /** * Displays a confirmation dialog box with the given message, a question icon, an OK button, and a Cancel * button. If a callback is given, it is called after the alert box has been closed by the user via one * of the buttons or via the close icon. The callback is called with the following signature * * * ```javascript * * function(bConfirmed) * ``` * * * where bConfirmed is set to true when the user has activated the OK button. * * The confirmation dialog box opened by this method is modal and it is processed asynchronously. Applications * have to use the `fnCallback` to continue work after the user closed the alert box. */ confirm( /** * Message to display */ vMessage: string | Control, /** * Callback to be called */ fnCallback?: Function, /** * Title to display */ sTitle?: string, /** * ID to be used for the confirmation dialog. Intended for test scenarios, not recommended for productive * apps */ sDialogId?: string ): void; /** * Creates and displays a simple message box with the given text and buttons, and optionally other parts. * After the user has selected a button or closed the message box using the close icon, the `callback` function * is invoked when given. * * The only mandatory parameter is `vMessage`. Either a string with the corresponding text or even a layout * control could be provided. * * The created dialog box is executed asynchronously. When it has been created and registered for rendering, * this function returns without waiting for a user reaction. * * When applications have to react on the users choice, they have to provide a callback function and postpone * any reaction on the user choice until that callback is triggered. * * The signature of the callback is * * function (oAction); * * where `oAction` is the button that the user has pressed. When the user has pressed the close button, * a MessageBox.Action.Close is returned. */ show( /** * The message to be displayed. */ vMessage: string | Control, /** * The icon to be displayed. */ oIcon?: Icon | keyof typeof Icon, /** * The title of the message box. */ sTitle?: string, /** * Either a single action, or an array of actions. If no action(s) are given, the single action MessageBox.Action.OK * is taken as a default for the parameter. */ vActions?: | (Action | keyof typeof Action) | Array, /** * Function to be called when the user has pressed a button or has closed the message box. */ fnCallback?: Function, /** * Must be one of the actions provided in vActions. */ oDefaultAction?: Action | keyof typeof Action, /** * ID to be used for the dialog. Intended for test scenarios, not recommended for productive apps */ sDialogId?: string ): void; } const MessageBox: MessageBox; /** * @deprecated As of version 1.38. Instead, use the `sap.m.MessageBox` control. */ export default MessageBox; /** * Enumeration of supported actions in a MessageBox. * * Each action is represented as a button in the message box. The values of this enumeration are used for * both, specifying the set of allowed actions as well as reporting back the user choice. * * This enum is part of the 'sap/ui/commons/MessageBox' module export and must be accessed by the property * 'Action'. * * @deprecated As of version 1.38. Instead, use the `sap.m.MessageBox.Action`. */ enum Action { /** * Adds an "Abort" button to the message box. */ ABORT = "ABORT", /** * Adds a "Cancel" button to the message box. */ CANCEL = "CANCEL", /** * Adds a "Close" button to the message box. */ CLOSE = "CLOSE", /** * Adds an "Ignore" button to the message box. */ IGNORE = "IGNORE", /** * Adds a "No" button to the message box. */ NO = "NO", /** * Adds an "Ok" button to the message box. */ OK = "OK", /** * Adds a "Retry" button to the message box. */ RETRY = "RETRY", /** * Adds a "Yes" button to the message box. */ YES = "YES", } /** * Enumeration of the pre-defined icons that can be used in a MessageBox. * * This enum is part of the 'sap/ui/commons/MessageBox' module export and must be accessed by the property * 'Icon'. * * @deprecated As of version 1.38. Instead, use the `sap.m.MessageBox.Icon`. */ enum Icon { /** * Shows the critical error icon in the message box. * * @deprecated As of version 1.9.1. The error icon is used instead */ CRITICAL = "CRITICAL", /** * Shows the error icon in the message box. */ ERROR = "ERROR", /** * Shows the information icon in the message box. */ INFORMATION = "INFORMATION", /** * Shows no icon in the message box. */ NONE = "NONE", /** * Shows the question icon in the message box. */ QUESTION = "QUESTION", /** * Shows the success icon in the message box. */ SUCCESS = "SUCCESS", /** * Shows the warning icon in the message box. */ WARNING = "WARNING", } } declare module "sap/ui/commons/MessageList" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import Message from "sap/ui/commons/Message"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Instantiated by the "MessageBar" Control if the user requests to generate the corresponding "MessageList". * * @deprecated As of version 1.4.0. A new messaging concept will be created in future. Therefore this control * might be removed in one of the next versions. */ export default class MessageList extends Control { /** * Constructor for a new MessageList. * * 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?: $MessageListSettings ); /** * Constructor for a new MessageList. * * 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?: $MessageListSettings ); /** * Creates a new subclass of class sap.ui.commons.MessageList with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.MessageList. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Gets current value of property {@link #getAnchorId anchorId}. * * ID of the anchor under which the MessageList will render. * * * @returns Value of property `anchorId` */ getAnchorId(): string; /** * Gets current value of property {@link #getMaxListed maxListed}. * * Maximum number of messages being display in the List before a scrollbar appears. Value '0' means no limit. * * Default value is `'7'`. * * * @returns Value of property `maxListed` */ getMaxListed(): string; /** * Gets current value of property {@link #getVisible visible}. * * Specifies whether or not the MessageList is visible. Invisible controls are not rendered. * * Default value is `false`. * * * @returns Value of property `visible` */ getVisible(): boolean; /** * Sets a new value for property {@link #getAnchorId anchorId}. * * ID of the anchor under which the MessageList will render. * * 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 */ setAnchorId( /** * New value for property `anchorId` */ sAnchorId?: string ): this; /** * Sets a new value for property {@link #getMaxListed maxListed}. * * Maximum number of messages being display in the List before a scrollbar appears. Value '0' means no limit. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'7'`. * * * @returns Reference to `this` in order to allow method chaining */ setMaxListed( /** * New value for property `maxListed` */ sMaxListed?: string ): this; /** * Sets the list of Messages to be displayed and re-renders this Control if it is visible. */ setMessages( /** * Message list. */ aMessages: Message[] ): void; /** * Setter for property `visible`. * * Default value is `true` * * The default implementation of function "setVisible()" is overwritten in order to invoke the open() and * close() of the MessageList Popup. * * * @returns `this` to allow method chaining */ setVisible( /** * New value for property `visible` */ bVisible: boolean ): this; } /** * Describes the settings that can be provided to the MessageList constructor. * * @deprecated As of version 1.4.0. A new messaging concept will be created in future. Therefore this control * might be removed in one of the next versions. */ export interface $MessageListSettings extends $ControlSettings { /** * Specifies whether or not the MessageList is visible. Invisible controls are not rendered. */ visible?: boolean | PropertyBindingInfo | `{${string}}`; /** * ID of the anchor under which the MessageList will render. */ anchorId?: string | PropertyBindingInfo; /** * Maximum number of messages being display in the List before a scrollbar appears. Value '0' means no limit. */ maxListed?: string | PropertyBindingInfo; } } declare module "sap/ui/commons/MessageToast" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import Event from "sap/ui/base/Event"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import Message from "sap/ui/commons/Message"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Responsible for displaying the new incoming messages, one at the time, on top of the MessageBar. * * @deprecated As of version 1.4.0. Instead, use the `sap.m.MessageToast` control. */ export default class MessageToast extends Control { /** * Constructor for a new MessageToast. * * 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?: $MessageToastSettings ); /** * Constructor for a new MessageToast. * * 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?: $MessageToastSettings ); /** * Creates a new subclass of class sap.ui.commons.MessageToast with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.MessageToast. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:next next} event of this `sap.ui.commons.MessageToast`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.MessageToast` itself. * * Fired once the `toast()` method is over, so that the MessageBar can "toast" another message if needed. * * * @returns Reference to `this` in order to allow method chaining */ attachNext( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.MessageToast` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:next next} event of this `sap.ui.commons.MessageToast`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.MessageToast` itself. * * Fired once the `toast()` method is over, so that the MessageBar can "toast" another message if needed. * * * @returns Reference to `this` in order to allow method chaining */ attachNext( /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.MessageToast` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:next next} event of this `sap.ui.commons.MessageToast`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachNext( /** * The function to be called, when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:next next} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireNext( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Gets current value of property {@link #getAnchorId anchorId}. * * ID of the anchor on top of which the MessageToast is to render. * * * @returns Value of property `anchorId` */ getAnchorId(): string; /** * Returns the idle state of the control. Returns true if no message is being toasted. */ isIdle(): boolean; /** * Sets a new value for property {@link #getAnchorId anchorId}. * * ID of the anchor on top of which the MessageToast is to render. * * 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 */ setAnchorId( /** * New value for property `anchorId` */ sAnchorId?: string ): this; /** * Triggers the toasting of a message, on top of the MessageBar. If no message is supplied, displays the * "Multiple new messages..." message. * * Receives the list of Messages to be displayed, and re-renders this Control if it is visible. */ toast( /** * The Message to be toasted. */ oMessage: Message, /** * DOM ID of the anchor against which the Toast Arrow should align for a given Toast. */ sAnchorId: string ): void; } /** * Describes the settings that can be provided to the MessageToast constructor. * * @deprecated As of version 1.4.0. Instead, use the `sap.m.MessageToast` control. */ export interface $MessageToastSettings extends $ControlSettings { /** * ID of the anchor on top of which the MessageToast is to render. */ anchorId?: string | PropertyBindingInfo; /** * Fired once the `toast()` method is over, so that the MessageBar can "toast" another message if needed. */ next?: (oEvent: Event) => void; } /** * Parameters of the MessageToast#next event. */ export interface MessageToast$NextEventParameters {} /** * Event object of the MessageToast#next event. */ export type MessageToast$NextEvent = Event< MessageToast$NextEventParameters, MessageToast >; } declare module "sap/ui/commons/Paginator" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; import { PaginatorEvent } from "sap/ui/commons/library"; import Event from "sap/ui/base/Event"; /** * Provides navigation between pages within a list of numbered pages. * * @deprecated As of version 1.38. the concept has been discarded. */ export default class Paginator extends Control { /** * Constructor for a new Paginator. * * 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?: $PaginatorSettings ); /** * Constructor for a new Paginator. * * 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?: $PaginatorSettings ); /** * Creates a new subclass of class sap.ui.commons.Paginator with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.Paginator. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:page page} event of this `sap.ui.commons.Paginator`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Paginator` itself. * * Event is fired when the user navigates to another page by selecting it directly, or by jumping forward/backward. * * * @returns Reference to `this` in order to allow method chaining */ attachPage( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Paginator$PageEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Paginator` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:page page} event of this `sap.ui.commons.Paginator`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Paginator` itself. * * Event is fired when the user navigates to another page by selecting it directly, or by jumping forward/backward. * * * @returns Reference to `this` in order to allow method chaining */ attachPage( /** * The function to be called when the event occurs */ fnFunction: (p1: Paginator$PageEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Paginator` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:page page} event of this `sap.ui.commons.Paginator`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachPage( /** * The function to be called, when the event occurs */ fnFunction: (p1: Paginator$PageEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:page page} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ firePage( /** * Parameters to pass along with the event */ mParameters?: Paginator$PageEventParameters ): this; /** * Gets current value of property {@link #getCurrentPage currentPage}. * * Represents the current page (first page has index 1, not 0, to match the visual number) * * Default value is `1`. * * * @returns Value of property `currentPage` */ getCurrentPage(): int; /** * Gets current value of property {@link #getNumberOfPages numberOfPages}. * * Represents the overall number of pages that are embedded into the parent control * * * @returns Value of property `numberOfPages` */ getNumberOfPages(): int; /** * Sets a new value for property {@link #getCurrentPage currentPage}. * * Represents the current page (first page has index 1, not 0, to match the visual number) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `1`. * * * @returns Reference to `this` in order to allow method chaining */ setCurrentPage( /** * New value for property `currentPage` */ iCurrentPage?: int ): this; /** * Sets a new value for property {@link #getNumberOfPages numberOfPages}. * * Represents the overall number of pages that are embedded into the parent 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 */ setNumberOfPages( /** * New value for property `numberOfPages` */ iNumberOfPages?: int ): this; } /** * Describes the settings that can be provided to the Paginator constructor. * * @deprecated As of version 1.38. the concept has been discarded. */ export interface $PaginatorSettings extends $ControlSettings { /** * Represents the current page (first page has index 1, not 0, to match the visual number) */ currentPage?: int | PropertyBindingInfo | `{${string}}`; /** * Represents the overall number of pages that are embedded into the parent control */ numberOfPages?: int | PropertyBindingInfo | `{${string}}`; /** * Event is fired when the user navigates to another page by selecting it directly, or by jumping forward/backward. */ page?: (oEvent: Paginator$PageEvent) => void; } /** * Parameters of the Paginator#page event. */ export interface Paginator$PageEventParameters { /** * The page which is the current one before the page event is fired (and another page is displayed) */ srcPage?: int; /** * The page that shall be displayed next after the page event is fired. * * The page number is 1-based: the first page has index 1, not 0, to match the number visible in the UI. */ targetPage?: int; /** * Provides the values 'First', 'Last', 'Next', 'Previous', 'Goto'. The event parameter informs the application * how the user navigated to the new page: Whether the 'Next' button was used, or another button, or whether * the page was directly selected */ type?: PaginatorEvent | keyof typeof PaginatorEvent; } /** * Event object of the Paginator#page event. */ export type Paginator$PageEvent = Event< Paginator$PageEventParameters, Paginator >; } declare module "sap/ui/commons/Panel" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import Button from "sap/ui/commons/Button"; import { enums } from "sap/ui/commons/library"; import { CSSSize } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import Title from "sap/ui/core/Title"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; /** * Represents a container with scroll functionality, that can be used for text and controls. The Panel does * not layout the embedded controls. * * @deprecated As of version 1.38. Instead, use the `sap.m.Panel` control. */ export default class Panel extends Control { /** * Constructor for a new Panel. * * 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?: $PanelSettings ); /** * Constructor for a new Panel. * * 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?: $PanelSettings ); /** * Creates a new subclass of class sap.ui.commons.Panel with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.Panel. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some button to the aggregation {@link #getButtons buttons}. * * * @returns Reference to `this` in order to allow method chaining */ addButton( /** * The button to add; if empty, nothing is inserted */ oButton: Button ): this; /** * Adds some content to the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ addContent( /** * The content to add; if empty, nothing is inserted */ oContent: Control ): this; /** * Destroys all the buttons in the aggregation {@link #getButtons buttons}. * * * @returns Reference to `this` in order to allow method chaining */ destroyButtons(): this; /** * Destroys all the content in the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Destroys the title in the aggregation {@link #getTitle title}. * * * @returns Reference to `this` in order to allow method chaining */ destroyTitle(): this; /** * Gets current value of property {@link #getApplyContentPadding applyContentPadding}. * * Determines whether the Panel will have padding. Padding is theme-dependent. * * Default value is `true`. * * * @returns Value of property `applyContentPadding` */ getApplyContentPadding(): boolean; /** * Gets current value of property {@link #getAreaDesign areaDesign}. * * Determines the background color. Note that color settings are theme-dependent. * * Default value is `Fill`. * * * @returns Value of property `areaDesign` */ getAreaDesign(): enums.AreaDesign; /** * Gets current value of property {@link #getBorderDesign borderDesign}. * * Determines if the Panel can have a box as border. Note that displaying borders is theme-dependent. * * Default value is `Box`. * * * @returns Value of property `borderDesign` */ getBorderDesign(): enums.BorderDesign; /** * Gets content of aggregation {@link #getButtons buttons}. * * The buttons that shall be displayed in the Panel header */ getButtons(): Button[]; /** * Gets current value of property {@link #getCollapsed collapsed}. * * Determines whether the Panel will be initially collapsed. When it is initially collapsed, the contents * are not rendered. A collapsed Panel consumes less space than an expanded one. * * Default value is `false`. * * * @returns Value of property `collapsed` */ getCollapsed(): boolean; /** * Gets content of aggregation {@link #getContent content}. * * Aggregates the controls that are contained in the Panel. It is recommended to use a layout control as * single direct child. When the Panel dimensions are set, the child control may have width and height of * 100%. When the dimensions are not set, the child defines the size of the Panel. */ getContent(): Control[]; /** * Gets current value of property {@link #getEnabled enabled}. * * Represents the state of the of the Panel (enabled or disabled) * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Returns an object representing the serialized focus information. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns an object representing the serialized focus information */ getFocusInfo(): object; /** * Gets current value of property {@link #getHeight height}. * * Determines the height of the Panel in CSS size. Per default, the height for the Panel is automatically * adjusted to the content. Dimension allows to explicitly specify the height. * * * @returns Value of property `height` */ getHeight(): CSSSize; /** * Returns the scroll position of the panel in pixels from the left. Returns 0 if not rendered yet. Also * internally updates the control property. * * * @returns The scroll position. */ getScrollLeft(): int; /** * Returns the scroll position of the panel in pixels from the top. Returns 0 if not rendered yet. Also * internally updates the control property. * * * @returns The scroll position. */ getScrollTop(): int; /** * Gets current value of property {@link #getShowCollapseIcon showCollapseIcon}. * * Determines whether the Panel will have an icon for collapsing/expanding, or not. * * Default value is `true`. * * * @returns Value of property `showCollapseIcon` */ getShowCollapseIcon(): boolean; /** * Returns the text that is rendered in the Panel header. If a Title control was used it returns the text * of the Title control. * * * @returns The text in the Panel header. */ getText(): string; /** * Gets content of aggregation {@link #getTitle title}. * * Aggregates the title element of the Panel. For text titles only, you alternatively could use setText() * which also creates a title in the background. */ getTitle(): Title; /** * Gets current value of property {@link #getWidth width}. * * Determines the width of the Panel in CSS size. * * Default value is `'100%'`. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Checks for the provided `sap.ui.commons.Button` in the aggregation {@link #getButtons buttons}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfButton( /** * The button whose index is looked for */ oButton: Button ): int; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContent( /** * The content whose index is looked for */ oContent: Control ): int; /** * Inserts a button into the aggregation {@link #getButtons buttons}. * * * @returns Reference to `this` in order to allow method chaining */ insertButton( /** * The button to insert; if empty, nothing is inserted */ oButton: Button, /** * The `0`-based index the button should be inserted at; for a negative value of `iIndex`, the button is * inserted at position 0; for a value greater than the current size of the aggregation, the button is inserted * at the last position */ iIndex: int ): this; /** * Inserts a content into the aggregation {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ insertContent( /** * The content to insert; if empty, nothing is inserted */ oContent: Control, /** * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content * is inserted at position 0; for a value greater than the current size of the aggregation, the content * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getButtons buttons}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllButtons(): Button[]; /** * Removes all the controls from the aggregation {@link #getContent content}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllContent(): Control[]; /** * Removes a button from the aggregation {@link #getButtons buttons}. * * * @returns The removed button or `null` */ removeButton( /** * The button to remove or its index or id */ vButton: int | string | Button ): Button | null; /** * Removes a content from the aggregation {@link #getContent content}. * * * @returns The removed content or `null` */ removeContent( /** * The content to remove or its index or id */ vContent: int | string | Control ): Control | null; /** * Property setter for the padding * * * @returns `this` to allow method chaining. */ setApplyContentPadding( /** * Whether the Panel should have padding. */ bPadding: boolean ): this; /** * Sets a new value for property {@link #getAreaDesign areaDesign}. * * Determines the background color. Note that color settings are theme-dependent. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Fill`. * * * @returns Reference to `this` in order to allow method chaining */ setAreaDesign( /** * New value for property `areaDesign` */ sAreaDesign?: enums.AreaDesign | keyof typeof enums.AreaDesign ): this; /** * Sets a new value for property {@link #getBorderDesign borderDesign}. * * Determines if the Panel can have a box as border. Note that displaying borders is theme-dependent. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Box`. * * * @returns Reference to `this` in order to allow method chaining */ setBorderDesign( /** * New value for property `borderDesign` */ sBorderDesign?: enums.BorderDesign | keyof typeof enums.BorderDesign ): this; /** * Property setter for the "collapsed" state * * * @returns `this` to allow method chaining. */ setCollapsed( /** * Whether the Panel should be collapsed or not. */ bCollapsed: boolean ): this; /** * Sets the dimensions of the panel. * * * @returns `this` to allow method chaining. */ setDimensions( /** * The width of the panel as CSS size. */ sWidth: CSSSize, /** * The height of the panel as CSS size. */ sHeight: CSSSize ): this; /** * Property setter for the "enabled" state * * * @returns `this` to allow method chaining. */ setEnabled( /** * Whether the Panel should be enabled or not. */ bEnabled: boolean ): this; /** * Sets the height of the panel. * * * @returns `this` to allow method chaining. */ setHeight( /** * The height of the panel as CSS size. */ sHeight: CSSSize ): this; /** * Sets the scroll position of the panel in pixels from the left. * * * @returns `this` to allow method chaining. */ setScrollLeft( /** * The position to scroll to. */ iPosition: int ): this; /** * Sets the scrolls position of the panel in pixels from the top. * * * @returns `this` to allow method chaining. */ setScrollTop( /** * The position to scroll to. */ iPosition: int ): this; /** * Sets a new value for property {@link #getShowCollapseIcon showCollapseIcon}. * * Determines whether the Panel will have an icon for collapsing/expanding, or not. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowCollapseIcon( /** * New value for property `showCollapseIcon` */ bShowCollapseIcon?: boolean ): this; /** * Sets the text that will be rendered in the Panel header. * * * @returns `this` to allow method chaining. */ setText( /** * The text to render in the header. */ sText: string ): this; /** * Sets a Tille control that will be rendered in the Panel header. * * * @returns `this` to allow method chaining. */ setTitle( /** * The Title to render in the header. */ oTitle: Title ): this; /** * Sets the width of the panel. * * * @returns `this` to allow method chaining. */ setWidth( /** * The width of the panel as CSS size. */ sWidth: CSSSize ): this; } /** * Describes the settings that can be provided to the Panel constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.Panel` control. */ export interface $PanelSettings extends $ControlSettings { /** * Determines the width of the Panel in CSS size. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Determines the height of the Panel in CSS size. Per default, the height for the Panel is automatically * adjusted to the content. Dimension allows to explicitly specify the height. */ height?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Represents the state of the of the Panel (enabled or disabled) */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * Determines the scroll position from left to right. Value "0" means leftmost position. */ scrollLeft?: int | PropertyBindingInfo | `{${string}}`; /** * Determines the scroll position from top to bottom. Value "0" means topmost position. */ scrollTop?: int | PropertyBindingInfo | `{${string}}`; /** * Determines whether the Panel will have padding. Padding is theme-dependent. */ applyContentPadding?: boolean | PropertyBindingInfo | `{${string}}`; /** * Determines whether the Panel will be initially collapsed. When it is initially collapsed, the contents * are not rendered. A collapsed Panel consumes less space than an expanded one. */ collapsed?: boolean | PropertyBindingInfo | `{${string}}`; /** * Determines the background color. Note that color settings are theme-dependent. */ areaDesign?: | (enums.AreaDesign | keyof typeof enums.AreaDesign) | PropertyBindingInfo | `{${string}}`; /** * Determines if the Panel can have a box as border. Note that displaying borders is theme-dependent. */ borderDesign?: | (enums.BorderDesign | keyof typeof enums.BorderDesign) | PropertyBindingInfo | `{${string}}`; /** * Determines whether the Panel will have an icon for collapsing/expanding, or not. */ showCollapseIcon?: boolean | PropertyBindingInfo | `{${string}}`; /** * Specifies the text that is rendered in the Panel header. Can be used to create a simple titles that do * not require an icon in the header. */ text?: string | PropertyBindingInfo; /** * Aggregates the controls that are contained in the Panel. It is recommended to use a layout control as * single direct child. When the Panel dimensions are set, the child control may have width and height of * 100%. When the dimensions are not set, the child defines the size of the Panel. */ content?: Control[] | Control | AggregationBindingInfo | `{${string}}`; /** * Aggregates the title element of the Panel. For text titles only, you alternatively could use setText() * which also creates a title in the background. */ title?: Title; /** * The buttons that shall be displayed in the Panel header */ buttons?: Button[] | Button | AggregationBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/PasswordField" { import { default as TextField, $TextFieldSettings, } from "sap/ui/commons/TextField"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * A text field with masked characters which borrows its properties and methods from TextField. * * @deprecated As of version 1.38. Instead, use the `sap.m.Input` control. */ export default class PasswordField extends TextField { /** * Constructor for a new PasswordField. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.commons.TextField#constructor sap.ui.commons.TextField } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: $PasswordFieldSettings ); /** * Constructor for a new PasswordField. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.commons.TextField#constructor sap.ui.commons.TextField } * can be used. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: $PasswordFieldSettings ); /** * Creates a new subclass of class sap.ui.commons.PasswordField with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.commons.TextField.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.ui.commons.PasswordField. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; } /** * Describes the settings that can be provided to the PasswordField constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.Input` control. */ export interface $PasswordFieldSettings extends $TextFieldSettings {} } declare module "sap/ui/commons/ProgressIndicator" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { BarColor, CSSSize } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Shows the progress of a process in a graphical way. The indicator can be displayed with or without numerical * values. The filling can be displayed in color only, or additionally with the percentage rate. The indicator * status can be interactive. * * @deprecated As of version 1.38. Instead, use the `sap.m.ProgressIndicator` control. */ export default class ProgressIndicator extends Control { /** * Constructor for a new ProgressIndicator. * * 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?: $ProgressIndicatorSettings ); /** * Constructor for a new ProgressIndicator. * * 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?: $ProgressIndicatorSettings ); /** * Creates a new subclass of class sap.ui.commons.ProgressIndicator with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.ProgressIndicator. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * See: * sap.ui.core.Control#getAccessibilityInfo * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns The accessibility info */ getAccessibilityInfo(): object; /** * Gets current value of property {@link #getBarColor barColor}. * * Determines the color of the bar which visualizes the progress. Possible values defined in the sap.ui.core.BarColor * enumeration are the following: CRITICAL (yellow), NEGATIVE (red), POSITIVE (green), NEUTRAL (blue) (default * value). * * Default value is `NEUTRAL`. * * * @returns Value of property `barColor` */ getBarColor(): BarColor; /** * Gets current value of property {@link #getDisplayValue displayValue}. * * Determines the text value that will be displayed in the bar. * * Default value is `'0%'`. * * * @returns Value of property `displayValue` */ getDisplayValue(): string; /** * Gets current value of property {@link #getEnabled enabled}. * * Determines whether the control is enabled or not. Disabled controls have different colors, and can not * be focused. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getPercentValue percentValue}. * * Determines the numerical value for the displayed length of the progress bar. * * Default value is `0`. * * * @returns Value of property `percentValue` */ getPercentValue(): int; /** * Gets current value of property {@link #getShowValue showValue}. * * Determines whether the percent value shall be rendered inside the bar. * * Default value is `true`. * * * @returns Value of property `showValue` */ getShowValue(): boolean; /** * Gets current value of property {@link #getWidth width}. * * Determines the width of the control. * * Default value is `'100%'`. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Sets a new value for property {@link #getBarColor barColor}. * * Determines the color of the bar which visualizes the progress. Possible values defined in the sap.ui.core.BarColor * enumeration are the following: CRITICAL (yellow), NEGATIVE (red), POSITIVE (green), NEUTRAL (blue) (default * value). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `NEUTRAL`. * * * @returns Reference to `this` in order to allow method chaining */ setBarColor( /** * New value for property `barColor` */ sBarColor?: BarColor | keyof typeof BarColor ): this; /** * Sets a new value for property {@link #getDisplayValue displayValue}. * * Determines the text value that will be displayed in the bar. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'0%'`. * * * @returns Reference to `this` in order to allow method chaining */ setDisplayValue( /** * New value for property `displayValue` */ sDisplayValue?: string ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * Determines whether the control is enabled or not. Disabled controls have different colors, and can not * be focused. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets the new percent value which the ProgressIndicator should display. A new rendering is not necessary, * only the bar has to be moved. * * * @returns `this` to allow method chaining. */ setPercentValue( /** * The new percent value of the ProgressIndicator. */ iPercentValue: int ): this; /** * Sets a new value for property {@link #getShowValue showValue}. * * Determines whether the percent value shall be rendered inside the bar. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowValue( /** * New value for property `showValue` */ bShowValue?: boolean ): this; /** * Sets a new value for property {@link #getWidth width}. * * Determines the width of the control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'100%'`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; } /** * Describes the settings that can be provided to the ProgressIndicator constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.ProgressIndicator` control. */ export interface $ProgressIndicatorSettings extends $ControlSettings { /** * Determines whether the control is enabled or not. Disabled controls have different colors, and can not * be focused. */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * Determines the color of the bar which visualizes the progress. Possible values defined in the sap.ui.core.BarColor * enumeration are the following: CRITICAL (yellow), NEGATIVE (red), POSITIVE (green), NEUTRAL (blue) (default * value). */ barColor?: | (BarColor | keyof typeof BarColor) | PropertyBindingInfo | `{${string}}`; /** * Determines the text value that will be displayed in the bar. */ displayValue?: string | PropertyBindingInfo; /** * Determines the numerical value for the displayed length of the progress bar. */ percentValue?: int | PropertyBindingInfo | `{${string}}`; /** * Determines whether the percent value shall be rendered inside the bar. */ showValue?: boolean | PropertyBindingInfo | `{${string}}`; /** * Determines the width of the control. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/RadioButton" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { IFormContent, ID, TextDirection, ValueState, CSSSize, } from "sap/ui/core/library"; import Event from "sap/ui/base/Event"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * RadioButton is a control similar to CheckBox, but it allows the user to choose only one of the predefined * set of options. * * Usually, RadioButton is used in a group with other RadioButtons (with the groupName property or by using * sap.ui.commons.RadioButtonGroup), thus providing a limited choice for the user. An event is triggered * when the user makes a change of the selection. * * @deprecated As of version 1.38. Instead, use the `sap.m.RadioButton` control. */ export default class RadioButton extends Control implements IFormContent { __implements__sap_ui_core_IFormContent: boolean; /** * Constructor for a new RadioButton. * * 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?: $RadioButtonSettings ); /** * Constructor for a new RadioButton. * * 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?: $RadioButtonSettings ); /** * Creates a new subclass of class sap.ui.commons.RadioButton with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.RadioButton. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaDescribedBy( /** * The ariaDescribedBy to add; if empty, nothing is inserted */ vAriaDescribedBy: ID | Control ): this; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaLabelledBy( /** * The ariaLabelledBy to add; if empty, nothing is inserted */ vAriaLabelledBy: ID | Control ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.commons.RadioButton`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RadioButton` itself. * * Triggers when the user makes a change on the RadioButton. * * * @returns Reference to `this` in order to allow method chaining */ attachSelect( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RadioButton` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.commons.RadioButton`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RadioButton` itself. * * Triggers when the user makes a change on the RadioButton. * * * @returns Reference to `this` in order to allow method chaining */ attachSelect( /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RadioButton` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.ui.commons.RadioButton`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSelect( /** * The function to be called, when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:select select} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSelect( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): ID[]; /** * Gets current value of property {@link #getEditable editable}. * * Specifies whether the user can select the RadioButton. * * Default value is `true`. * * * @returns Value of property `editable` */ getEditable(): boolean; /** * Gets current value of property {@link #getEnabled enabled}. * * Displays the disabled controls in another color, depending on the customer settings. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getGroupName groupName}. * * Defines the name of the RadioButtonGroup, in which the current RadioButton belongs to. You can define * a new name for the group. If no new name is specified, the default is sapUiRbDefaultGroup. By default, * when one of the RadioButtons in a group is selected, all others are unselected. * * Default value is `'sapUiRbDefaultGroup'`. * * * @returns Value of property `groupName` */ getGroupName(): string; /** * Gets current value of property {@link #getKey key}. * * Can be used for subsequent actions. * * * @returns Value of property `key` */ getKey(): string; /** * Gets current value of property {@link #getSelected selected}. * * Specifies the select state of the RadioButton. * * Default value is `false`. * * * @returns Value of property `selected` */ getSelected(): boolean; /** * Gets current value of property {@link #getText text}. * * Defines the text displayed next to the RadioButton. * * * @returns Value of property `text` */ getText(): string; /** * Gets current value of property {@link #getTextDirection textDirection}. * * Defines the text direction - options are left-to-right (LTR) and right-to-left (RTL). Alternatively, * the control can inherit the text direction from its parent container. * * Default value is `Inherit`. * * * @returns Value of property `textDirection` */ getTextDirection(): TextDirection; /** * Gets current value of property {@link #getValueState valueState}. * * Enumeration sap.ui.core.ValueState provides state values Error, Success, Warning and None. * * Default value is `None`. * * * @returns Value of property `valueState` */ getValueState(): ValueState; /** * Gets current value of property {@link #getWidth width}. * * Determines the control width. By default, it depends on the text length. Alternatively, CSS sizes in * % or px can be set. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaDescribedBy(): ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): ID[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns The removed ariaDescribedBy or `null` */ removeAriaDescribedBy( /** * The ariaDescribedBy to be removed or its index or ID */ vAriaDescribedBy: int | ID | Control ): ID | null; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns The removed ariaLabelledBy or `null` */ removeAriaLabelledBy( /** * The ariaLabelledBy to be removed or its index or ID */ vAriaLabelledBy: int | ID | Control ): ID | null; /** * Sets a new value for property {@link #getEditable editable}. * * Specifies whether the user can select the RadioButton. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEditable( /** * New value for property `editable` */ bEditable?: boolean ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * Displays the disabled controls in another color, depending on the customer settings. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getGroupName groupName}. * * Defines the name of the RadioButtonGroup, in which the current RadioButton belongs to. You can define * a new name for the group. If no new name is specified, the default is sapUiRbDefaultGroup. By default, * when one of the RadioButtons in a group is selected, all others are unselected. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'sapUiRbDefaultGroup'`. * * * @returns Reference to `this` in order to allow method chaining */ setGroupName( /** * New value for property `groupName` */ sGroupName?: string ): this; /** * Sets a new value for property {@link #getKey key}. * * Can be used for subsequent actions. * * 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 */ setKey( /** * New value for property `key` */ sKey?: string ): this; /** * Sets a new value for property {@link #getSelected selected}. * * Specifies the select state of the RadioButton. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setSelected( /** * New value for property `selected` */ bSelected?: boolean ): this; /** * Sets a new value for property {@link #getText text}. * * Defines the text displayed next to the RadioButton. * * 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; /** * Sets a new value for property {@link #getTextDirection textDirection}. * * Defines the text direction - options are left-to-right (LTR) and right-to-left (RTL). Alternatively, * the control can inherit the text direction from its parent container. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Inherit`. * * * @returns Reference to `this` in order to allow method chaining */ setTextDirection( /** * New value for property `textDirection` */ sTextDirection?: TextDirection | keyof typeof TextDirection ): this; /** * Sets a new value for property {@link #getValueState valueState}. * * Enumeration sap.ui.core.ValueState provides state values Error, Success, Warning and None. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `None`. * * * @returns Reference to `this` in order to allow method chaining */ setValueState( /** * New value for property `valueState` */ sValueState?: ValueState | keyof typeof ValueState ): this; /** * Sets a new value for property {@link #getWidth width}. * * Determines the control width. By default, it depends on the text length. Alternatively, CSS sizes in * % or px can be set. * * 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 */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; } /** * Describes the settings that can be provided to the RadioButton constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.RadioButton` control. */ export interface $RadioButtonSettings extends $ControlSettings { /** * Defines the text displayed next to the RadioButton. */ text?: string | PropertyBindingInfo; /** * Displays the disabled controls in another color, depending on the customer settings. */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * Specifies whether the user can select the RadioButton. */ editable?: boolean | PropertyBindingInfo | `{${string}}`; /** * Specifies the select state of the RadioButton. */ selected?: boolean | PropertyBindingInfo | `{${string}}`; /** * Enumeration sap.ui.core.ValueState provides state values Error, Success, Warning and None. */ valueState?: | (ValueState | keyof typeof ValueState) | PropertyBindingInfo | `{${string}}`; /** * Determines the control width. By default, it depends on the text length. Alternatively, CSS sizes in * % or px can be set. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Defines the text direction - options are left-to-right (LTR) and right-to-left (RTL). Alternatively, * the control can inherit the text direction from its parent container. */ textDirection?: | (TextDirection | keyof typeof TextDirection) | PropertyBindingInfo | `{${string}}`; /** * Defines the name of the RadioButtonGroup, in which the current RadioButton belongs to. You can define * a new name for the group. If no new name is specified, the default is sapUiRbDefaultGroup. By default, * when one of the RadioButtons in a group is selected, all others are unselected. */ groupName?: string | PropertyBindingInfo; /** * Can be used for subsequent actions. */ key?: string | PropertyBindingInfo; /** * Association to controls / IDs, which describe this control (see WAI-ARIA attribute aria-describedby). */ ariaDescribedBy?: Array; /** * Association to controls / IDs, which label this control (see WAI-ARIA attribute aria-labelledby). */ ariaLabelledBy?: Array; /** * Triggers when the user makes a change on the RadioButton. */ select?: (oEvent: Event) => void; } /** * Parameters of the RadioButton#select event. */ export interface RadioButton$SelectEventParameters {} /** * Event object of the RadioButton#select event. */ export type RadioButton$SelectEvent = Event< RadioButton$SelectEventParameters, RadioButton >; } declare module "sap/ui/commons/RadioButtonGroup" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { IFormContent, ID, ValueState, CSSSize } from "sap/ui/core/library"; import Item from "sap/ui/core/Item"; import { AggregationBindingInfo, PropertyBindingInfo, } from "sap/ui/base/ManagedObject"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import Event from "sap/ui/base/Event"; /** * The RadioButtonGroup is a basic control that is used to provide area for making interactive choice out * of a set of options. It represents a list with items where exactly one item can be selected in a session. * For the representation of the single group entries, the RadioButton items are created automatically. * For the RadioButton choice, mouse and keyboard navigation usage is supported. * * @deprecated As of version 1.38. Instead, use the `sap.m.RadioButtonGroup` control. */ export default class RadioButtonGroup extends Control implements IFormContent { __implements__sap_ui_core_IFormContent: boolean; /** * Constructor for a new RadioButtonGroup. * * 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?: $RadioButtonGroupSettings ); /** * Constructor for a new RadioButtonGroup. * * 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?: $RadioButtonGroupSettings ); /** * Creates a new subclass of class sap.ui.commons.RadioButtonGroup with name `sClassName` and enriches it * with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.RadioButtonGroup. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaDescribedBy( /** * The ariaDescribedBy to add; if empty, nothing is inserted */ vAriaDescribedBy: ID | Control ): this; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaLabelledBy( /** * The ariaLabelledBy to add; if empty, nothing is inserted */ vAriaLabelledBy: ID | Control ): this; /** * Adds some item to the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ addItem( /** * The item to add; if empty, nothing is inserted */ oItem: Item ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.commons.RadioButtonGroup`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RadioButtonGroup` itself. * * Fires when selection is changed by user interaction. * * * @returns Reference to `this` in order to allow method chaining */ attachSelect( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: RadioButtonGroup$SelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RadioButtonGroup` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.commons.RadioButtonGroup`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RadioButtonGroup` itself. * * Fires when selection is changed by user interaction. * * * @returns Reference to `this` in order to allow method chaining */ attachSelect( /** * The function to be called when the event occurs */ fnFunction: (p1: RadioButtonGroup$SelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RadioButtonGroup` itself */ oListener?: object ): this; /** * Binds aggregation {@link #getItems items} to model data. * * See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description * of the possible properties of `oBindingInfo`. * * * @returns Reference to `this` in order to allow method chaining */ bindItems( /** * The binding information */ oBindingInfo: AggregationBindingInfo ): this; /** * Creates a new instance of RadioButtonGroup, with the same settings as the RadioButtonGroup on which the * method is called. Event handlers are not cloned. * * * @returns New instance of RadioButtonGroup */ clone(): this; /** * Destroys all the items in the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ destroyItems(): this; /** * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.ui.commons.RadioButtonGroup`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSelect( /** * The function to be called, when the event occurs */ fnFunction: (p1: RadioButtonGroup$SelectEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:select select} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSelect( /** * Parameters to pass along with the event */ mParameters?: RadioButtonGroup$SelectEventParameters ): this; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): ID[]; /** * Gets current value of property {@link #getColumns columns}. * * Determines the maximum number of RadioButtons displayed in one line. * * Default value is `1`. * * * @returns Value of property `columns` */ getColumns(): int; /** * Gets current value of property {@link #getEditable editable}. * * Specifies whether the user can change the selected value of the RadioButtonGroup. When the property is * set to false, the control obtains visual styles different from its visual styles for the normal and the * disabled state. Additionally the control is no longer interactive, but can receive focus. * * Default value is `true`. * * * @returns Value of property `editable` */ getEditable(): boolean; /** * Gets current value of property {@link #getEnabled enabled}. * * Enables/disables the RadioButtonGroup. If it is disabled all RadioButtons will be displayed as disabled. * The enabled property of the Item will not be used in this case. If the RadioButtonGroup is enabled, the * enabled property of the Item will define if a RadioButton is enabled or not. * * Default value is `true`. * * @since 1.10.3 * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets content of aggregation {@link #getItems items}. * * The RadioButtons of this RadioButtonGroup. */ getItems(): Item[]; /** * Gets current value of property {@link #getSelectedIndex selectedIndex}. * * The index of the selected/checked RadioButton. * * Default value is `0`. * * * @returns Value of property `selectedIndex` */ getSelectedIndex(): int; /** * When no item is selected, "null" is returned. * * * @returns Selected Item */ getSelectedItem(): Item; /** * Gets current value of property {@link #getValueState valueState}. * * The value state to be displayed for the RadioButton. Possible values are: sap.ui.core.ValueState.Error, * sap.ui.core.ValueState.Warning, sap.ui.core.ValueState.Success and sap.ui.core.ValueState.None. Note: * Setting this attribute to sap.ui.core.ValueState.Error when the accessibility feature is enabled, sets * the value of the invalid property for the whole RadioButtonGroup to true. * * Default value is `None`. * * * @returns Value of property `valueState` */ getValueState(): ValueState; /** * Gets current value of property {@link #getWidth width}. * * Defines the width of the RadioButtonGroup. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Checks for the provided `sap.ui.core.Item` in the aggregation {@link #getItems items}. and returns its * index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfItem( /** * The item whose index is looked for */ oItem: Item ): int; /** * Inserts a item into the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ insertItem( /** * The item to insert; if empty, nothing is inserted */ oItem: Item, /** * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted * at position 0; for a value greater than the current size of the aggregation, the item is inserted at * the last position */ iIndex: int ): this; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaDescribedBy(): ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): ID[]; /** * Removes all the controls from the aggregation {@link #getItems items}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllItems(): Item[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns The removed ariaDescribedBy or `null` */ removeAriaDescribedBy( /** * The ariaDescribedBy to be removed or its index or ID */ vAriaDescribedBy: int | ID | Control ): ID | null; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns The removed ariaLabelledBy or `null` */ removeAriaLabelledBy( /** * The ariaLabelledBy to be removed or its index or ID */ vAriaLabelledBy: int | ID | Control ): ID | null; /** * Removes a item from the aggregation {@link #getItems items}. * * * @returns The removed item or `null` */ removeItem( /** * The item to remove or its index or id */ vItem: int | string | Item ): Item | null; /** * Sets a new value for property {@link #getColumns columns}. * * Determines the maximum number of RadioButtons displayed in one line. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `1`. * * * @returns Reference to `this` in order to allow method chaining */ setColumns( /** * New value for property `columns` */ iColumns?: int ): this; /** * Sets a new value for property {@link #getEditable editable}. * * Specifies whether the user can change the selected value of the RadioButtonGroup. When the property is * set to false, the control obtains visual styles different from its visual styles for the normal and the * disabled state. Additionally the control is no longer interactive, but can receive focus. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEditable( /** * New value for property `editable` */ bEditable?: boolean ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * Enables/disables the RadioButtonGroup. If it is disabled all RadioButtons will be displayed as disabled. * The enabled property of the Item will not be used in this case. If the RadioButtonGroup is enabled, the * enabled property of the Item will define if a RadioButton is enabled or not. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.10.3 * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getSelectedIndex selectedIndex}. * * The index of the selected/checked RadioButton. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setSelectedIndex( /** * New value for property `selectedIndex` */ iSelectedIndex?: int ): this; /** * Sets the Item as selected and removes the selection from the previous one. */ setSelectedItem( /** * Selected item */ oSelectedItem: Item ): void; /** * Sets a new value for property {@link #getValueState valueState}. * * The value state to be displayed for the RadioButton. Possible values are: sap.ui.core.ValueState.Error, * sap.ui.core.ValueState.Warning, sap.ui.core.ValueState.Success and sap.ui.core.ValueState.None. Note: * Setting this attribute to sap.ui.core.ValueState.Error when the accessibility feature is enabled, sets * the value of the invalid property for the whole RadioButtonGroup to true. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `None`. * * * @returns Reference to `this` in order to allow method chaining */ setValueState( /** * New value for property `valueState` */ sValueState?: ValueState | keyof typeof ValueState ): this; /** * Sets a new value for property {@link #getWidth width}. * * Defines the width of the RadioButtonGroup. * * 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 */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; /** * Unbinds aggregation {@link #getItems items} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindItems(): this; } /** * Describes the settings that can be provided to the RadioButtonGroup constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.RadioButtonGroup` control. */ export interface $RadioButtonGroupSettings extends $ControlSettings { /** * Defines the width of the RadioButtonGroup. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Determines the maximum number of RadioButtons displayed in one line. */ columns?: int | PropertyBindingInfo | `{${string}}`; /** * Specifies whether the user can change the selected value of the RadioButtonGroup. When the property is * set to false, the control obtains visual styles different from its visual styles for the normal and the * disabled state. Additionally the control is no longer interactive, but can receive focus. */ editable?: boolean | PropertyBindingInfo | `{${string}}`; /** * The value state to be displayed for the RadioButton. Possible values are: sap.ui.core.ValueState.Error, * sap.ui.core.ValueState.Warning, sap.ui.core.ValueState.Success and sap.ui.core.ValueState.None. Note: * Setting this attribute to sap.ui.core.ValueState.Error when the accessibility feature is enabled, sets * the value of the invalid property for the whole RadioButtonGroup to true. */ valueState?: | (ValueState | keyof typeof ValueState) | PropertyBindingInfo | `{${string}}`; /** * The index of the selected/checked RadioButton. */ selectedIndex?: int | PropertyBindingInfo | `{${string}}`; /** * Enables/disables the RadioButtonGroup. If it is disabled all RadioButtons will be displayed as disabled. * The enabled property of the Item will not be used in this case. If the RadioButtonGroup is enabled, the * enabled property of the Item will define if a RadioButton is enabled or not. * * @since 1.10.3 */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * The RadioButtons of this RadioButtonGroup. */ items?: Item[] | Item | AggregationBindingInfo | `{${string}}`; /** * Association to controls / IDs, which describe this control (see WAI-ARIA attribute aria-describedby). */ ariaDescribedBy?: Array; /** * Association to controls / IDs, which label this control (see WAI-ARIA attribute aria-labelledby). */ ariaLabelledBy?: Array; /** * Fires when selection is changed by user interaction. */ select?: (oEvent: RadioButtonGroup$SelectEvent) => void; } /** * Parameters of the RadioButtonGroup#select event. */ export interface RadioButtonGroup$SelectEventParameters { /** * Index of the selected RadioButton. */ selectedIndex?: int; } /** * Event object of the RadioButtonGroup#select event. */ export type RadioButtonGroup$SelectEvent = Event< RadioButtonGroup$SelectEventParameters, RadioButtonGroup >; } declare module "sap/ui/commons/RangeSlider" { import { default as Slider, $SliderSettings } from "sap/ui/commons/Slider"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * The interactive control is displayed either as a horizontal or a vertical line with two pointers and * units of measurement. Users can move the pointers along the line to change a range with graphical support. * * @since 1.8.0 * @deprecated As of version 1.38. replaced by {@link sap.m.RangeSlider} */ export default class RangeSlider extends Slider { /** * Constructor for a new `RangeSlider`. * * 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?: $RangeSliderSettings ); /** * Constructor for a new `RangeSlider`. * * 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?: $RangeSliderSettings ); /** * Creates a new subclass of class sap.ui.commons.RangeSlider with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.commons.Slider.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.ui.commons.RangeSlider. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Gets current value of property {@link #getValue2 value2}. * * Current second value of the slider. (Position of the second grip.) * * **Note:** If the value is not in the valid range (between `min` and `max`) it will be changed to be in * the valid range. If it is smaller than `value` it will be set to the same value. * * Default value is `80`. * * * @returns Value of property `value2` */ getValue2(): float; /** * Sets a new value for property {@link #getValue2 value2}. * * Current second value of the slider. (Position of the second grip.) * * **Note:** If the value is not in the valid range (between `min` and `max`) it will be changed to be in * the valid range. If it is smaller than `value` it will be set to the same value. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `80`. * * * @returns Reference to `this` in order to allow method chaining */ setValue2( /** * New value for property `value2` */ fValue2?: float ): this; } /** * Describes the settings that can be provided to the RangeSlider constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.RangeSlider} */ export interface $RangeSliderSettings extends $SliderSettings { /** * Current second value of the slider. (Position of the second grip.) * * **Note:** If the value is not in the valid range (between `min` and `max`) it will be changed to be in * the valid range. If it is smaller than `value` it will be set to the same value. */ value2?: float | PropertyBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/RatingIndicator" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { ID, URI } from "sap/ui/core/library"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { RatingIndicatorVisualMode } from "sap/ui/commons/library"; import Event from "sap/ui/base/Event"; /** * RatingIndicator is used to let the user do some rating on a given topic. The amount of rating symbols * can be specified, as well as the URIs to the image icons which shall be used as rating symbols. When * the user performs a rating, an event is fired. * * @deprecated As of version 1.38. Instead, use the `sap.m.RatingIndicator` control. */ export default class RatingIndicator extends Control { /** * Constructor for a new RatingIndicator. * * 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?: $RatingIndicatorSettings ); /** * Constructor for a new RatingIndicator. * * 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?: $RatingIndicatorSettings ); /** * Creates a new subclass of class sap.ui.commons.RatingIndicator with name `sClassName` and enriches it * with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.RatingIndicator. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaDescribedBy( /** * The ariaDescribedBy to add; if empty, nothing is inserted */ vAriaDescribedBy: ID | Control ): this; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaLabelledBy( /** * The ariaLabelledBy to add; if empty, nothing is inserted */ vAriaLabelledBy: ID | Control ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.commons.RatingIndicator`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RatingIndicator` itself. * * The event is fired when the user has done a rating. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: RatingIndicator$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RatingIndicator` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.commons.RatingIndicator`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RatingIndicator` itself. * * The event is fired when the user has done a rating. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * The function to be called when the event occurs */ fnFunction: (p1: RatingIndicator$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RatingIndicator` itself */ oListener?: object ): this; /** * Binds property {@link #getValue value} to model data. * * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description * of the possible properties of `oBindingInfo` * * * @returns Reference to `this` in order to allow method chaining */ bindValue( /** * The binding information */ oBindingInfo: PropertyBindingInfo ): this; /** * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.commons.RatingIndicator`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: RatingIndicator$ChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:change change} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireChange( /** * Parameters to pass along with the event */ mParameters?: RatingIndicator$ChangeEventParameters ): this; /** * See: * sap.ui.core.Control#getAccessibilityInfo * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns The accessibility info */ getAccessibilityInfo(): object; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): ID[]; /** * Gets current value of property {@link #getAverageValue averageValue}. * * Determines the average value. This value is shown if no value is set. This can be used to display an * average Value before the user votes. * * Default value is `0`. * * * @returns Value of property `averageValue` */ getAverageValue(): float; /** * Gets current value of property {@link #getEditable editable}. * * Determines if the rating symbols can be edited. * * Default value is `true`. * * * @returns Value of property `editable` */ getEditable(): boolean; /** * Gets current value of property {@link #getIconHovered iconHovered}. * * The URI to the image which is displayed when the mouse hovers onto a rating symbol. If used, a requirement * is that all custom icons need to have the same size. Note that when this attribute is used also the other * icon attributes need to be set. * * * @returns Value of property `iconHovered` */ getIconHovered(): URI; /** * Gets current value of property {@link #getIconSelected iconSelected}. * * The URI to the image which shall be displayed for all selected rating symbols. Note that when this attribute * is used, also the other icon attributes need to be set. * * * @returns Value of property `iconSelected` */ getIconSelected(): URI; /** * Gets current value of property {@link #getIconUnselected iconUnselected}. * * The URI to the image which shall be displayed for all unselected rating symbols. If this attribute is * used, a requirement is that all custom icons need to have the same size. Note that when this attribute * is used also the other icon attributes need to be set. * * * @returns Value of property `iconUnselected` */ getIconUnselected(): URI; /** * Gets current value of property {@link #getMaxValue maxValue}. * * Determines the number of displayed rating symbols * * Default value is `5`. * * * @returns Value of property `maxValue` */ getMaxValue(): int; /** * Gets current value of property {@link #getValue value}. * * Determines the currently selected value. If value is set to sap.ui.commons.RatingIndicator.NoValue, the * averageValue is shown. * * Default value is `0`. * * * @returns Value of property `value` */ getValue(): float; /** * Gets current value of property {@link #getVisualMode visualMode}. * * Defines how float values are visualized: Full, Half, Continuous (see enumeration RatingIndicatorVisualMode) * * Default value is `Half`. * * * @returns Value of property `visualMode` */ getVisualMode(): RatingIndicatorVisualMode; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaDescribedBy(): ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): ID[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns The removed ariaDescribedBy or `null` */ removeAriaDescribedBy( /** * The ariaDescribedBy to be removed or its index or ID */ vAriaDescribedBy: int | ID | Control ): ID | null; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns The removed ariaLabelledBy or `null` */ removeAriaLabelledBy( /** * The ariaLabelledBy to be removed or its index or ID */ vAriaLabelledBy: int | ID | Control ): ID | null; /** * Sets a new value for property {@link #getAverageValue averageValue}. * * Determines the average value. This value is shown if no value is set. This can be used to display an * average Value before the user votes. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setAverageValue( /** * New value for property `averageValue` */ fAverageValue?: float ): this; /** * Sets a new value for property {@link #getEditable editable}. * * Determines if the rating symbols can be edited. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEditable( /** * New value for property `editable` */ bEditable?: boolean ): this; /** * Sets a new value for property {@link #getIconHovered iconHovered}. * * The URI to the image which is displayed when the mouse hovers onto a rating symbol. If used, a requirement * is that all custom icons need to have the same size. Note that when this attribute is used also the other * icon attributes need to be set. * * 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 */ setIconHovered( /** * New value for property `iconHovered` */ sIconHovered?: URI ): this; /** * Sets a new value for property {@link #getIconSelected iconSelected}. * * The URI to the image which shall be displayed for all selected rating symbols. Note that when this attribute * is used, also the other icon attributes need to be set. * * 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 */ setIconSelected( /** * New value for property `iconSelected` */ sIconSelected?: URI ): this; /** * Sets a new value for property {@link #getIconUnselected iconUnselected}. * * The URI to the image which shall be displayed for all unselected rating symbols. If this attribute is * used, a requirement is that all custom icons need to have the same size. Note that when this attribute * is used also the other icon attributes need to be set. * * 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 */ setIconUnselected( /** * New value for property `iconUnselected` */ sIconUnselected?: URI ): this; /** * Setter for property `maxValue`. * * Default value is `5` Minimum value is `1` * * * @returns `this` to allow method chaining */ setMaxValue( /** * new value for property `maxValue` */ iMaxValue: int ): this; /** * Sets a new value for property {@link #getValue value}. * * Determines the currently selected value. If value is set to sap.ui.commons.RatingIndicator.NoValue, the * averageValue is shown. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setValue( /** * New value for property `value` */ fValue?: float ): this; /** * Sets a new value for property {@link #getVisualMode visualMode}. * * Defines how float values are visualized: Full, Half, Continuous (see enumeration RatingIndicatorVisualMode) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Half`. * * * @returns Reference to `this` in order to allow method chaining */ setVisualMode( /** * New value for property `visualMode` */ sVisualMode?: | RatingIndicatorVisualMode | keyof typeof RatingIndicatorVisualMode ): this; /** * Unbinds property {@link #getValue value} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindValue(): this; } /** * Describes the settings that can be provided to the RatingIndicator constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.RatingIndicator` control. */ export interface $RatingIndicatorSettings extends $ControlSettings { /** * Determines if the rating symbols can be edited. */ editable?: boolean | PropertyBindingInfo | `{${string}}`; /** * Determines the number of displayed rating symbols */ maxValue?: int | PropertyBindingInfo | `{${string}}`; /** * Determines the currently selected value. If value is set to sap.ui.commons.RatingIndicator.NoValue, the * averageValue is shown. */ value?: float | PropertyBindingInfo | `{${string}}`; /** * Determines the average value. This value is shown if no value is set. This can be used to display an * average Value before the user votes. */ averageValue?: float | PropertyBindingInfo | `{${string}}`; /** * The URI to the image which shall be displayed for all selected rating symbols. Note that when this attribute * is used, also the other icon attributes need to be set. */ iconSelected?: URI | PropertyBindingInfo | `{${string}}`; /** * The URI to the image which shall be displayed for all unselected rating symbols. If this attribute is * used, a requirement is that all custom icons need to have the same size. Note that when this attribute * is used also the other icon attributes need to be set. */ iconUnselected?: URI | PropertyBindingInfo | `{${string}}`; /** * The URI to the image which is displayed when the mouse hovers onto a rating symbol. If used, a requirement * is that all custom icons need to have the same size. Note that when this attribute is used also the other * icon attributes need to be set. */ iconHovered?: URI | PropertyBindingInfo | `{${string}}`; /** * Defines how float values are visualized: Full, Half, Continuous (see enumeration RatingIndicatorVisualMode) */ visualMode?: | (RatingIndicatorVisualMode | keyof typeof RatingIndicatorVisualMode) | PropertyBindingInfo | `{${string}}`; /** * Association to controls / ids which describe this control (see WAI-ARIA attribute aria-describedby). */ ariaDescribedBy?: Array; /** * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby). */ ariaLabelledBy?: Array; /** * The event is fired when the user has done a rating. */ change?: (oEvent: RatingIndicator$ChangeEvent) => void; } /** * Parameters of the RatingIndicator#change event. */ export interface RatingIndicator$ChangeEventParameters { /** * The value of the user rating */ value?: int; } /** * Event object of the RatingIndicator#change event. */ export type RatingIndicator$ChangeEvent = Event< RatingIndicator$ChangeEventParameters, RatingIndicator >; } declare module "sap/ui/commons/ResponsiveContainer" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import ResponsiveContainerRange from "sap/ui/commons/ResponsiveContainerRange"; import { ID, CSSSize } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; import Event from "sap/ui/base/Event"; /** * Is used to provide a container, which can show different content depending on its current width. It fires * an event, whenever a new range is reached. In addition the content of the new range is automatically * shown, if it is set. * * @deprecated As of version 1.38. Use a container by choice from the {@link sap.m} library, instead. */ export default class ResponsiveContainer extends Control { /** * Constructor for a new ResponsiveContainer. * * 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?: $ResponsiveContainerSettings ); /** * Constructor for a new ResponsiveContainer. * * 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?: $ResponsiveContainerSettings ); /** * Creates a new subclass of class sap.ui.commons.ResponsiveContainer with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.ResponsiveContainer. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some range to the aggregation {@link #getRanges ranges}. * * * @returns Reference to `this` in order to allow method chaining */ addRange( /** * The range to add; if empty, nothing is inserted */ oRange: ResponsiveContainerRange ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rangeSwitch rangeSwitch} event of this `sap.ui.commons.ResponsiveContainer`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.ResponsiveContainer` itself. * * The event is fired the width of the container reaches a new range. * * * @returns Reference to `this` in order to allow method chaining */ attachRangeSwitch( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: ResponsiveContainer$RangeSwitchEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.ResponsiveContainer` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:rangeSwitch rangeSwitch} event of this `sap.ui.commons.ResponsiveContainer`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.ResponsiveContainer` itself. * * The event is fired the width of the container reaches a new range. * * * @returns Reference to `this` in order to allow method chaining */ attachRangeSwitch( /** * The function to be called when the event occurs */ fnFunction: (p1: ResponsiveContainer$RangeSwitchEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.ResponsiveContainer` * itself */ oListener?: object ): this; /** * Destroys all the ranges in the aggregation {@link #getRanges ranges}. * * * @returns Reference to `this` in order to allow method chaining */ destroyRanges(): this; /** * Detaches event handler `fnFunction` from the {@link #event:rangeSwitch rangeSwitch} event of this `sap.ui.commons.ResponsiveContainer`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachRangeSwitch( /** * The function to be called, when the event occurs */ fnFunction: (p1: ResponsiveContainer$RangeSwitchEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:rangeSwitch rangeSwitch} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireRangeSwitch( /** * Parameters to pass along with the event */ mParameters?: ResponsiveContainer$RangeSwitchEventParameters ): this; /** * ID of the element which is the current target of the association {@link #getDefaultContent defaultContent}, * or `null`. */ getDefaultContent(): ID | null; /** * Gets current value of property {@link #getHeight height}. * * The width of the responsive container. * * Default value is `'100%'`. * * * @returns Value of property `height` */ getHeight(): CSSSize; /** * Gets content of aggregation {@link #getRanges ranges}. * * The ranges defined for this container */ getRanges(): ResponsiveContainerRange[]; /** * Gets current value of property {@link #getWidth width}. * * The width of the responsive container. * * Default value is `'100%'`. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Checks for the provided `sap.ui.commons.ResponsiveContainerRange` in the aggregation {@link #getRanges ranges}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfRange( /** * The range whose index is looked for */ oRange: ResponsiveContainerRange ): int; /** * Inserts a range into the aggregation {@link #getRanges ranges}. * * * @returns Reference to `this` in order to allow method chaining */ insertRange( /** * The range to insert; if empty, nothing is inserted */ oRange: ResponsiveContainerRange, /** * The `0`-based index the range should be inserted at; for a negative value of `iIndex`, the range is inserted * at position 0; for a value greater than the current size of the aggregation, the range is inserted at * the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getRanges ranges}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllRanges(): ResponsiveContainerRange[]; /** * Removes a range from the aggregation {@link #getRanges ranges}. * * * @returns The removed range or `null` */ removeRange( /** * The range to remove or its index or id */ vRange: int | string | ResponsiveContainerRange ): ResponsiveContainerRange | null; /** * Sets the associated {@link #getDefaultContent defaultContent}. * * * @returns Reference to `this` in order to allow method chaining */ setDefaultContent( /** * ID of an element which becomes the new target of this defaultContent association; alternatively, an element * instance may be given */ oDefaultContent: ID | Control ): this; /** * Sets a new value for property {@link #getHeight height}. * * The width of the responsive container. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'100%'`. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ sHeight?: CSSSize ): this; /** * Sets a new value for property {@link #getWidth width}. * * The width of the responsive container. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'100%'`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; } /** * Describes the settings that can be provided to the ResponsiveContainer constructor. * * @deprecated As of version 1.38. Use a container by choice from the {@link sap.m} library, instead. */ export interface $ResponsiveContainerSettings extends $ControlSettings { /** * The width of the responsive container. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * The width of the responsive container. */ height?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * The ranges defined for this container */ ranges?: | ResponsiveContainerRange[] | ResponsiveContainerRange | AggregationBindingInfo | `{${string}}`; /** * The default content to show, in case the range does not provide content */ defaultContent?: Control | string; /** * The event is fired the width of the container reaches a new range. */ rangeSwitch?: (oEvent: ResponsiveContainer$RangeSwitchEvent) => void; } /** * Parameters of the ResponsiveContainer#rangeSwitch event. */ export interface ResponsiveContainer$RangeSwitchEventParameters { /** * The current range */ currentRange?: ResponsiveContainerRange; } /** * Event object of the ResponsiveContainer#rangeSwitch event. */ export type ResponsiveContainer$RangeSwitchEvent = Event< ResponsiveContainer$RangeSwitchEventParameters, ResponsiveContainer >; } declare module "sap/ui/commons/ResponsiveContainerRange" { import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element"; import { ID, CSSSize } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import Control from "sap/ui/core/Control"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Defines a range for the ResponsiveContainer * * @deprecated As of version 1.38. (altogether with sap.ui.commons.ResponsiveContainer). Use a container * of your choice from the sap.m library instead. */ export default class ResponsiveContainerRange extends UI5Element { /** * Constructor for a new ResponsiveContainerRange. * * 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?: $ResponsiveContainerRangeSettings ); /** * Constructor for a new ResponsiveContainerRange. * * 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?: $ResponsiveContainerRangeSettings ); /** * Creates a new subclass of class sap.ui.commons.ResponsiveContainerRange with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @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.ui.commons.ResponsiveContainerRange. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * ID of the element which is the current target of the association {@link #getContent content}, or `null`. */ getContent(): ID | null; /** * Gets current value of property {@link #getHeight height}. * * The minimal height for this range to be displayed. * * Default value is `empty string`. * * * @returns Value of property `height` */ getHeight(): CSSSize; /** * Gets current value of property {@link #getKey key}. * * A key which can be used to identify the range (optional). * * Default value is `empty string`. * * * @returns Value of property `key` */ getKey(): string; /** * Gets current value of property {@link #getWidth width}. * * The minimal width for this range to be displayed. * * Default value is `empty string`. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Sets the associated {@link #getContent content}. * * * @returns Reference to `this` in order to allow method chaining */ setContent( /** * ID of an element which becomes the new target of this content association; alternatively, an element * instance may be given */ oContent: ID | Control ): this; /** * Sets a new value for property {@link #getHeight height}. * * The minimal height for this range to be displayed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ sHeight?: CSSSize ): this; /** * Sets a new value for property {@link #getKey key}. * * A key which can be used to identify the range (optional). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setKey( /** * New value for property `key` */ sKey?: string ): this; /** * Sets a new value for property {@link #getWidth width}. * * The minimal width for this range to be displayed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; } /** * Describes the settings that can be provided to the ResponsiveContainerRange constructor. * * @deprecated As of version 1.38. (altogether with sap.ui.commons.ResponsiveContainer). Use a container * of your choice from the sap.m library instead. */ export interface $ResponsiveContainerRangeSettings extends $ElementSettings { /** * The minimal width for this range to be displayed. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * The minimal height for this range to be displayed. */ height?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * A key which can be used to identify the range (optional). */ key?: string | PropertyBindingInfo; /** * The content to show for this range (optional). */ content?: Control | string; } } declare module "sap/ui/commons/RichTooltip" { import { default as TooltipBase, $TooltipBaseSettings, } from "sap/ui/core/TooltipBase"; import { URI } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Is used to provide tool tips that can have long text, image and title. This tool tip extends the TooltipBase. * * @deprecated As of version 1.38. Tf you want to achieve a similar behavior, use a `sap.m.Popover` control * and open it next to your control. */ export default class RichTooltip extends TooltipBase { /** * Constructor for a new RichTooltip. * * 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?: $RichTooltipSettings ); /** * Constructor for a new RichTooltip. * * 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?: $RichTooltipSettings ); /** * Creates a new subclass of class sap.ui.commons.RichTooltip with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.TooltipBase.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.ui.commons.RichTooltip. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Gets current value of property {@link #getImageAltText imageAltText}. * * This is the alt text for the image * * @since 1.11.1 * * @returns Value of property `imageAltText` */ getImageAltText(): string; /** * Gets current value of property {@link #getImageSrc imageSrc}. * * If RichTooltip contains an image, this property is used to define the source path. * * * @returns Value of property `imageSrc` */ getImageSrc(): URI; /** * Gets current value of property {@link #getTitle title}. * * Tool tip title to be displayed in the header. * * * @returns Value of property `title` */ getTitle(): string; /** * This returns the previously set text. Since a FormattedTextView is used for rendering and stuff the corresponding * property of the FormattedTextView is being read and returned. If no text was set an empty string is being * returned. * * * @returns the ValueState text that was previously set. */ getValueStateText(): string; /** * Calculates the height of the RichTooltip to set a proper min-height. Additionally the ARIA attributes * are set to the corresponding elements. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onAfterRendering(): void; /** * Sets a new value for property {@link #getImageAltText imageAltText}. * * This is the alt text for the image * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.11.1 * * @returns Reference to `this` in order to allow method chaining */ setImageAltText( /** * New value for property `imageAltText` */ sImageAltText?: string ): this; /** * Sets a new value for property {@link #getImageSrc imageSrc}. * * If RichTooltip contains an image, this property is used to define the source path. * * 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 */ setImageSrc( /** * New value for property `imageSrc` */ sImageSrc?: URI ): this; /** * Sets a new value for property {@link #getTitle title}. * * Tool tip title to be displayed in the header. * * 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 */ setTitle( /** * New value for property `title` */ sTitle?: string ): this; /** * This sets an individual text for the ValueState of the parent element of the RichTooltip. * * * @returns Returns `this` to facilitate method chaining. */ setValueStateText( /** * the text that should be shown as individual ValueState text */ sText: string ): this; } /** * Describes the settings that can be provided to the RichTooltip constructor. * * @deprecated As of version 1.38. Tf you want to achieve a similar behavior, use a `sap.m.Popover` control * and open it next to your control. */ export interface $RichTooltipSettings extends $TooltipBaseSettings { /** * Tool tip title to be displayed in the header. */ title?: string | PropertyBindingInfo; /** * If RichTooltip contains an image, this property is used to define the source path. */ imageSrc?: URI | PropertyBindingInfo | `{${string}}`; /** * This property is an individual text that will be used instead of the default ValueState text * * @since 1.11.1 */ valueStateText?: string | PropertyBindingInfo; /** * This is the alt text for the image * * @since 1.11.1 */ imageAltText?: string | PropertyBindingInfo; } } declare module "sap/ui/commons/RoadMap" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import RoadMapStep from "sap/ui/commons/RoadMapStep"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { CSSSize } from "sap/ui/core/library"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; import Event from "sap/ui/base/Event"; /** * RoadMap is used to display step-by-step work flows of a clearly defined work process. * * @deprecated As of version 1.38. Instead, use the `sap.m.Wizard` control. */ export default class RoadMap extends Control { /** * Constructor for a new RoadMap. * * 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?: $RoadMapSettings ); /** * Constructor for a new RoadMap. * * 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?: $RoadMapSettings ); /** * Creates a new subclass of class sap.ui.commons.RoadMap with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.RoadMap. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some step to the aggregation {@link #getSteps steps}. * * * @returns Reference to `this` in order to allow method chaining */ addStep( /** * The step to add; if empty, nothing is inserted */ oStep: RoadMapStep ): this; /** * Attaches event handler `fnFunction` to the {@link #event:stepExpanded stepExpanded} event of this `sap.ui.commons.RoadMap`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RoadMap` itself. * * Event is fired when a given step is expanded or collapsed by user. * * * @returns Reference to `this` in order to allow method chaining */ attachStepExpanded( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: RoadMap$StepExpandedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RoadMap` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:stepExpanded stepExpanded} event of this `sap.ui.commons.RoadMap`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RoadMap` itself. * * Event is fired when a given step is expanded or collapsed by user. * * * @returns Reference to `this` in order to allow method chaining */ attachStepExpanded( /** * The function to be called when the event occurs */ fnFunction: (p1: RoadMap$StepExpandedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RoadMap` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:stepSelected stepSelected} event of this `sap.ui.commons.RoadMap`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RoadMap` itself. * * Event is fired when the user selects a step. * * * @returns Reference to `this` in order to allow method chaining */ attachStepSelected( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: RoadMap$StepSelectedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RoadMap` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:stepSelected stepSelected} event of this `sap.ui.commons.RoadMap`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RoadMap` itself. * * Event is fired when the user selects a step. * * * @returns Reference to `this` in order to allow method chaining */ attachStepSelected( /** * The function to be called when the event occurs */ fnFunction: (p1: RoadMap$StepSelectedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RoadMap` itself */ oListener?: object ): this; /** * Destroys all the steps in the aggregation {@link #getSteps steps}. * * * @returns Reference to `this` in order to allow method chaining */ destroySteps(): this; /** * Detaches event handler `fnFunction` from the {@link #event:stepExpanded stepExpanded} event of this `sap.ui.commons.RoadMap`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachStepExpanded( /** * The function to be called, when the event occurs */ fnFunction: (p1: RoadMap$StepExpandedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:stepSelected stepSelected} event of this `sap.ui.commons.RoadMap`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachStepSelected( /** * The function to be called, when the event occurs */ fnFunction: (p1: RoadMap$StepSelectedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:stepExpanded stepExpanded} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireStepExpanded( /** * Parameters to pass along with the event */ mParameters?: RoadMap$StepExpandedEventParameters ): this; /** * Fires event {@link #event:stepSelected stepSelected} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireStepSelected( /** * Parameters to pass along with the event */ mParameters?: RoadMap$StepSelectedEventParameters ): this; /** * Gets current value of property {@link #getFirstVisibleStep firstVisibleStep}. * * ID of the first step to be displayed * * * @returns Value of property `firstVisibleStep` */ getFirstVisibleStep(): string; /** * Gets current value of property {@link #getNumberOfVisibleSteps numberOfVisibleSteps}. * * Total number of steps to be displayed at once * * * @returns Value of property `numberOfVisibleSteps` */ getNumberOfVisibleSteps(): int; /** * Gets current value of property {@link #getSelectedStep selectedStep}. * * ID of the step which is currently selected * * * @returns Value of property `selectedStep` */ getSelectedStep(): string; /** * Gets content of aggregation {@link #getSteps steps}. * * Steps that are composing the RoadMap */ getSteps(): RoadMapStep[]; /** * Gets current value of property {@link #getWidth width}. * * Determines the control width in CSS size * * Default value is `'100%'`. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Checks for the provided `sap.ui.commons.RoadMapStep` in the aggregation {@link #getSteps steps}. and * returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfStep( /** * The step whose index is looked for */ oStep: RoadMapStep ): int; /** * Inserts a step into the aggregation {@link #getSteps steps}. * * * @returns Reference to `this` in order to allow method chaining */ insertStep( /** * The step to insert; if empty, nothing is inserted */ oStep: RoadMapStep, /** * The `0`-based index the step should be inserted at; for a negative value of `iIndex`, the step is inserted * at position 0; for a value greater than the current size of the aggregation, the step is inserted at * the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getSteps steps}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllSteps(): RoadMapStep[]; /** * Removes a step from the aggregation {@link #getSteps steps}. * * * @returns The removed step or `null` */ removeStep( /** * The step to remove or its index or id */ vStep: int | string | RoadMapStep ): RoadMapStep | null; /** * Sets a new value for property {@link #getFirstVisibleStep firstVisibleStep}. * * ID of the first step to be displayed * * 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 */ setFirstVisibleStep( /** * New value for property `firstVisibleStep` */ sFirstVisibleStep?: string ): this; /** * Sets a new value for property {@link #getNumberOfVisibleSteps numberOfVisibleSteps}. * * Total number of steps to be displayed at once * * 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 */ setNumberOfVisibleSteps( /** * New value for property `numberOfVisibleSteps` */ iNumberOfVisibleSteps?: int ): this; /** * Sets a new value for property {@link #getSelectedStep selectedStep}. * * ID of the step which is currently selected * * 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 */ setSelectedStep( /** * New value for property `selectedStep` */ sSelectedStep?: string ): this; /** * Sets a new value for property {@link #getWidth width}. * * Determines the control width in CSS size * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'100%'`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; } /** * Describes the settings that can be provided to the RoadMap constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.Wizard` control. */ export interface $RoadMapSettings extends $ControlSettings { /** * Total number of steps to be displayed at once */ numberOfVisibleSteps?: int | PropertyBindingInfo | `{${string}}`; /** * ID of the first step to be displayed */ firstVisibleStep?: string | PropertyBindingInfo; /** * ID of the step which is currently selected */ selectedStep?: string | PropertyBindingInfo; /** * Determines the control width in CSS size */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Steps that are composing the RoadMap */ steps?: | RoadMapStep[] | RoadMapStep | AggregationBindingInfo | `{${string}}`; /** * Event is fired when the user selects a step. */ stepSelected?: (oEvent: RoadMap$StepSelectedEvent) => void; /** * Event is fired when a given step is expanded or collapsed by user. */ stepExpanded?: (oEvent: RoadMap$StepExpandedEvent) => void; } /** * Parameters of the RoadMap#stepExpanded event. */ export interface RoadMap$StepExpandedEventParameters { /** * ID of the expanded/collapsed step */ stepId?: string; } /** * Event object of the RoadMap#stepExpanded event. */ export type RoadMap$StepExpandedEvent = Event< RoadMap$StepExpandedEventParameters, RoadMap >; /** * Parameters of the RoadMap#stepSelected event. */ export interface RoadMap$StepSelectedEventParameters { /** * ID of the selected step */ stepId?: string; } /** * Event object of the RoadMap#stepSelected event. */ export type RoadMap$StepSelectedEvent = Event< RoadMap$StepSelectedEventParameters, RoadMap >; } declare module "sap/ui/commons/RoadMapStep" { import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; /** * Step used within a RoadMap Control. * * @deprecated As of version 1.38. Instead, use the `sap.m.Wizard` control. */ export default class RoadMapStep extends UI5Element { /** * Constructor for a new RoadMapStep. * * 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?: $RoadMapStepSettings ); /** * Constructor for a new RoadMapStep. * * 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?: $RoadMapStepSettings ); /** * Creates a new subclass of class sap.ui.commons.RoadMapStep with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @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.ui.commons.RoadMapStep. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some subStep to the aggregation {@link #getSubSteps subSteps}. * * @deprecated As of version 1.10.5. Sub steps will not be supported in future. This feature might be removed * in one of the next releases. * * @returns Reference to `this` in order to allow method chaining */ addSubStep( /** * The subStep to add; if empty, nothing is inserted */ oSubStep: RoadMapStep ): this; /** * Destroys all the subSteps in the aggregation {@link #getSubSteps subSteps}. * * @deprecated As of version 1.10.5. Sub steps will not be supported in future. This feature might be removed * in one of the next releases. * * @returns Reference to `this` in order to allow method chaining */ destroySubSteps(): this; /** * Gets current value of property {@link #getEnabled enabled}. * * Specifies whether the user shall be allowed to click a step, or not * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getExpanded expanded}. * * This property is only relevant when using sub steps. * * Default value is `false`. * * @deprecated As of version 1.10.5. Note that sub steps will not be supported in future. This feature might * be removed in one of the next releases. * * @returns Value of property `expanded` */ getExpanded(): boolean; /** * Gets current value of property {@link #getLabel label}. * * Label of the step * * * @returns Value of property `label` */ getLabel(): string; /** * Gets content of aggregation {@link #getSubSteps subSteps}. * * Sub steps for the current step. Will be displayed only in the case that the step is expanded. Otherwise, * special arrows show the availability of sub steps. One level of sub steps supported. * * @deprecated As of version 1.10.5. Sub steps will not be supported in future. This feature might be removed * in one of the next releases. */ getSubSteps(): RoadMapStep[]; /** * Gets current value of property {@link #getVisible visible}. * * Step is visible * * Default value is `true`. * * * @returns Value of property `visible` */ getVisible(): boolean; /** * Checks for the provided `sap.ui.commons.RoadMapStep` in the aggregation {@link #getSubSteps subSteps}. * and returns its index if found or -1 otherwise. * * @deprecated As of version 1.10.5. Sub steps will not be supported in future. This feature might be removed * in one of the next releases. * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfSubStep( /** * The subStep whose index is looked for */ oSubStep: RoadMapStep ): int; /** * Inserts a subStep into the aggregation {@link #getSubSteps subSteps}. * * @deprecated As of version 1.10.5. Sub steps will not be supported in future. This feature might be removed * in one of the next releases. * * @returns Reference to `this` in order to allow method chaining */ insertSubStep( /** * The subStep to insert; if empty, nothing is inserted */ oSubStep: RoadMapStep, /** * The `0`-based index the subStep should be inserted at; for a negative value of `iIndex`, the subStep * is inserted at position 0; for a value greater than the current size of the aggregation, the subStep * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getSubSteps subSteps}. * * Additionally, it unregisters them from the hosting UIArea. * * @deprecated As of version 1.10.5. Sub steps will not be supported in future. This feature might be removed * in one of the next releases. * * @returns An array of the removed elements (might be empty) */ removeAllSubSteps(): RoadMapStep[]; /** * Removes a subStep from the aggregation {@link #getSubSteps subSteps}. * * @deprecated As of version 1.10.5. Sub steps will not be supported in future. This feature might be removed * in one of the next releases. * * @returns The removed subStep or `null` */ removeSubStep( /** * The subStep to remove or its index or id */ vSubStep: int | string | RoadMapStep ): RoadMapStep | null; /** * Sets a new value for property {@link #getEnabled enabled}. * * Specifies whether the user shall be allowed to click a step, or not * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getExpanded expanded}. * * This property is only relevant when using sub steps. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @deprecated As of version 1.10.5. Note that sub steps will not be supported in future. This feature might * be removed in one of the next releases. * * @returns Reference to `this` in order to allow method chaining */ setExpanded( /** * New value for property `expanded` */ bExpanded?: boolean ): this; /** * Sets a new value for property {@link #getLabel label}. * * Label of the step * * 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 */ setLabel( /** * New value for property `label` */ sLabel?: string ): this; /** * Sets a new value for property {@link #getVisible visible}. * * Step is visible * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setVisible( /** * New value for property `visible` */ bVisible?: boolean ): this; } /** * Describes the settings that can be provided to the RoadMapStep constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.Wizard` control. */ export interface $RoadMapStepSettings extends $ElementSettings { /** * Label of the step */ label?: string | PropertyBindingInfo; /** * Specifies whether the user shall be allowed to click a step, or not */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * This property is only relevant when using sub steps. * * @deprecated As of version 1.10.5. Note that sub steps will not be supported in future. This feature might * be removed in one of the next releases. */ expanded?: boolean | PropertyBindingInfo | `{${string}}`; /** * Step is visible */ visible?: boolean | PropertyBindingInfo | `{${string}}`; /** * Sub steps for the current step. Will be displayed only in the case that the step is expanded. Otherwise, * special arrows show the availability of sub steps. One level of sub steps supported. * * @deprecated As of version 1.10.5. Sub steps will not be supported in future. This feature might be removed * in one of the next releases. */ subSteps?: | RoadMapStep[] | RoadMapStep | AggregationBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/RowRepeater" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import RowRepeaterFilter from "sap/ui/commons/RowRepeaterFilter"; import RowRepeaterSorter from "sap/ui/commons/RowRepeaterSorter"; import { AggregationBindingInfo, PropertyBindingInfo, } from "sap/ui/base/ManagedObject"; import { RowRepeaterDesign } from "sap/ui/commons/library"; import { CSSSize } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import Title from "sap/ui/core/Title"; import Event from "sap/ui/base/Event"; /** * This control displays items in a stacked list format, allowing the user to page in order to see more * items or to use the offered filtering and sorting capabilities in order to manipulate the displayed data. * * @deprecated As of version 1.38. Instead, use the `sap.ui.table.Table` control. */ export default class RowRepeater extends Control { /** * Constructor for a new RowRepeater. * * 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?: $RowRepeaterSettings ); /** * Constructor for a new RowRepeater. * * 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?: $RowRepeaterSettings ); /** * Creates a new subclass of class sap.ui.commons.RowRepeater with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.RowRepeater. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some filter to the aggregation {@link #getFilters filters}. * * * @returns Reference to `this` in order to allow method chaining */ addFilter( /** * The filter to add; if empty, nothing is inserted */ oFilter: RowRepeaterFilter ): this; /** * Adds some row to the aggregation {@link #getRows rows}. * * * @returns Reference to `this` in order to allow method chaining */ addRow( /** * The row to add; if empty, nothing is inserted */ oRow: Control ): this; /** * Adds some sorter to the aggregation {@link #getSorters sorters}. * * * @returns Reference to `this` in order to allow method chaining */ addSorter( /** * The sorter to add; if empty, nothing is inserted */ oSorter: RowRepeaterSorter ): this; /** * Applies a filter. */ applyFilter( /** * The ID if the filter. */ sId: string ): void; /** * Attaches event handler `fnFunction` to the {@link #event:filter filter} event of this `sap.ui.commons.RowRepeater`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RowRepeater` itself. * * This event is triggered when a filter is set. * * * @returns Reference to `this` in order to allow method chaining */ attachFilter( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: RowRepeater$FilterEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RowRepeater` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:filter filter} event of this `sap.ui.commons.RowRepeater`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RowRepeater` itself. * * This event is triggered when a filter is set. * * * @returns Reference to `this` in order to allow method chaining */ attachFilter( /** * The function to be called when the event occurs */ fnFunction: (p1: RowRepeater$FilterEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RowRepeater` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:page page} event of this `sap.ui.commons.RowRepeater`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RowRepeater` itself. * * This event is triggered when paging was executed. * * * @returns Reference to `this` in order to allow method chaining */ attachPage( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: RowRepeater$PageEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RowRepeater` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:page page} event of this `sap.ui.commons.RowRepeater`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RowRepeater` itself. * * This event is triggered when paging was executed. * * * @returns Reference to `this` in order to allow method chaining */ attachPage( /** * The function to be called when the event occurs */ fnFunction: (p1: RowRepeater$PageEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RowRepeater` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:resize resize} event of this `sap.ui.commons.RowRepeater`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RowRepeater` itself. * * This event is triggered when the number of rows was changed. * * * @returns Reference to `this` in order to allow method chaining */ attachResize( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: RowRepeater$ResizeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RowRepeater` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:resize resize} event of this `sap.ui.commons.RowRepeater`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RowRepeater` itself. * * This event is triggered when the number of rows was changed. * * * @returns Reference to `this` in order to allow method chaining */ attachResize( /** * The function to be called when the event occurs */ fnFunction: (p1: RowRepeater$ResizeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RowRepeater` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:sort sort} event of this `sap.ui.commons.RowRepeater`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RowRepeater` itself. * * This event is triggered when a sorting is applied. * * * @returns Reference to `this` in order to allow method chaining */ attachSort( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: RowRepeater$SortEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RowRepeater` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:sort sort} event of this `sap.ui.commons.RowRepeater`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.RowRepeater` itself. * * This event is triggered when a sorting is applied. * * * @returns Reference to `this` in order to allow method chaining */ attachSort( /** * The function to be called when the event occurs */ fnFunction: (p1: RowRepeater$SortEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.RowRepeater` itself */ oListener?: object ): this; /** * Binds aggregation {@link #getRows rows} to model data. * * See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description * of the possible properties of `oBindingInfo`. * * * @returns Reference to `this` in order to allow method chaining */ bindRows( /** * The binding information */ oBindingInfo: AggregationBindingInfo ): this; /** * Destroys all the filters in the aggregation {@link #getFilters filters}. * * * @returns Reference to `this` in order to allow method chaining */ destroyFilters(): this; /** * Destroys the noData in the aggregation {@link #getNoData noData}. * * * @returns Reference to `this` in order to allow method chaining */ destroyNoData(): this; /** * Destroys all the rows in the aggregation {@link #getRows rows}. * * * @returns Reference to `this` in order to allow method chaining */ destroyRows(): this; /** * Destroys all the sorters in the aggregation {@link #getSorters sorters}. * * * @returns Reference to `this` in order to allow method chaining */ destroySorters(): this; /** * Destroys the title in the aggregation {@link #getTitle title}. * * * @returns Reference to `this` in order to allow method chaining */ destroyTitle(): this; /** * Detaches event handler `fnFunction` from the {@link #event:filter filter} event of this `sap.ui.commons.RowRepeater`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachFilter( /** * The function to be called, when the event occurs */ fnFunction: (p1: RowRepeater$FilterEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:page page} event of this `sap.ui.commons.RowRepeater`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachPage( /** * The function to be called, when the event occurs */ fnFunction: (p1: RowRepeater$PageEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:resize resize} event of this `sap.ui.commons.RowRepeater`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachResize( /** * The function to be called, when the event occurs */ fnFunction: (p1: RowRepeater$ResizeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:sort sort} event of this `sap.ui.commons.RowRepeater`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSort( /** * The function to be called, when the event occurs */ fnFunction: (p1: RowRepeater$SortEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:filter filter} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireFilter( /** * Parameters to pass along with the event */ mParameters?: RowRepeater$FilterEventParameters ): this; /** * Fires event {@link #event:page page} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ firePage( /** * Parameters to pass along with the event */ mParameters?: RowRepeater$PageEventParameters ): this; /** * Fires event {@link #event:resize resize} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireResize( /** * Parameters to pass along with the event */ mParameters?: RowRepeater$ResizeEventParameters ): this; /** * Fires event {@link #event:sort sort} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSort( /** * Parameters to pass along with the event */ mParameters?: RowRepeater$SortEventParameters ): this; /** * Switch to first page. */ firstPage(): void; /** * Gets current value of property {@link #getCurrentPage currentPage}. * * The index of the page currently displayed. The index starts at 1. * * Default value is `1`. * * * @returns Value of property `currentPage` */ getCurrentPage(): int; /** * Gets current value of property {@link #getDesign design}. * * The visual design of the control. * * Default value is `Standard`. * * * @returns Value of property `design` */ getDesign(): RowRepeaterDesign; /** * Gets content of aggregation {@link #getFilters filters}. * * Filters to be provided in toolbar. */ getFilters(): RowRepeaterFilter[]; /** * Gets current value of property {@link #getFixedRowHeight fixedRowHeight}. * * Row height adapts to rendered content. If a fixed height is specified the cells have a maximum height * and the overflow will be hidden. * * Default value is `empty string`. * * * @returns Value of property `fixedRowHeight` */ getFixedRowHeight(): CSSSize; /** * Gets content of aggregation {@link #getNoData noData}. * * This control is shown, in case there is no data available to be displayed in the RowRepeater. */ getNoData(): Control; /** * Gets current value of property {@link #getNumberOfRows numberOfRows}. * * Number of rows displayed. * * Default value is `5`. * * * @returns Value of property `numberOfRows` */ getNumberOfRows(): int; /** * Gets content of aggregation {@link #getRows rows}. * * Rows to be repeated. */ getRows(): Control[]; /** * Gets current value of property {@link #getShowMoreSteps showMoreSteps}. * * Step size used to increase the numberOfRows value. This feature is only active if value is greater than * 0. This will deactivate the paging feature. * * Default value is `0`. * * * @returns Value of property `showMoreSteps` */ getShowMoreSteps(): int; /** * Gets content of aggregation {@link #getSorters sorters}. * * Sorters to be provided in secondary toolbar. */ getSorters(): RowRepeaterSorter[]; /** * Gets current value of property {@link #getThreshold threshold}. * * Threshold to fetch the next chunk of data. The minimal threshold can be the numberOfRows of the RR. * * * @returns Value of property `threshold` */ getThreshold(): int; /** * Gets content of aggregation {@link #getTitle title}. * * Title to be displayed in top left corner. Either text or icon. */ getTitle(): Title; /** * Switch to specified page. */ gotoPage( /** * The index of the page to go to. */ iPageNumber: int ): void; /** * Checks for the provided `sap.ui.commons.RowRepeaterFilter` in the aggregation {@link #getFilters filters}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfFilter( /** * The filter whose index is looked for */ oFilter: RowRepeaterFilter ): int; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getRows rows}. and returns its * index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfRow( /** * The row whose index is looked for */ oRow: Control ): int; /** * Checks for the provided `sap.ui.commons.RowRepeaterSorter` in the aggregation {@link #getSorters sorters}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfSorter( /** * The sorter whose index is looked for */ oSorter: RowRepeaterSorter ): int; /** * Inserts a filter into the aggregation {@link #getFilters filters}. * * * @returns Reference to `this` in order to allow method chaining */ insertFilter( /** * The filter to insert; if empty, nothing is inserted */ oFilter: RowRepeaterFilter, /** * The `0`-based index the filter should be inserted at; for a negative value of `iIndex`, the filter is * inserted at position 0; for a value greater than the current size of the aggregation, the filter is inserted * at the last position */ iIndex: int ): this; /** * Inserts a row into the aggregation {@link #getRows rows}. * * * @returns Reference to `this` in order to allow method chaining */ insertRow( /** * The row to insert; if empty, nothing is inserted */ oRow: Control, /** * The `0`-based index the row should be inserted at; for a negative value of `iIndex`, the row is inserted * at position 0; for a value greater than the current size of the aggregation, the row is inserted at the * last position */ iIndex: int ): this; /** * Inserts a sorter into the aggregation {@link #getSorters sorters}. * * * @returns Reference to `this` in order to allow method chaining */ insertSorter( /** * The sorter to insert; if empty, nothing is inserted */ oSorter: RowRepeaterSorter, /** * The `0`-based index the sorter should be inserted at; for a negative value of `iIndex`, the sorter is * inserted at position 0; for a value greater than the current size of the aggregation, the sorter is inserted * at the last position */ iIndex: int ): this; /** * Switch to last page. */ lastPage(): void; /** * Switch to next page. */ nextPage(): void; /** * Switch to previous page. */ previousPage(): void; /** * Removes all the controls from the aggregation {@link #getFilters filters}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllFilters(): RowRepeaterFilter[]; /** * Removes all the controls from the aggregation {@link #getRows rows}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllRows(): Control[]; /** * Removes all the controls from the aggregation {@link #getSorters sorters}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllSorters(): RowRepeaterSorter[]; /** * Removes a filter from the aggregation {@link #getFilters filters}. * * * @returns The removed filter or `null` */ removeFilter( /** * The filter to remove or its index or id */ vFilter: int | string | RowRepeaterFilter ): RowRepeaterFilter | null; /** * Removes a row from the aggregation {@link #getRows rows}. * * * @returns The removed row or `null` */ removeRow( /** * The row to remove or its index or id */ vRow: int | string | Control ): Control | null; /** * Removes a sorter from the aggregation {@link #getSorters sorters}. * * * @returns The removed sorter or `null` */ removeSorter( /** * The sorter to remove or its index or id */ vSorter: int | string | RowRepeaterSorter ): RowRepeaterSorter | null; /** * Resizes the row repeater by changing the number of displayed rows. This method will only resize the RowRepeater * if the property showMoreSteps is set. */ resize( /** * The new value of number of rows displayed. */ iNumberOfRows: int ): void; /** * Setter for property `currentPage`. * * * @returns `this` to allow method chaining */ setCurrentPage( /** * new value for property `currentPage` */ iCurrentPage: int ): this; /** * Sets a new value for property {@link #getDesign design}. * * The visual design of the control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Standard`. * * * @returns Reference to `this` in order to allow method chaining */ setDesign( /** * New value for property `design` */ sDesign?: RowRepeaterDesign | keyof typeof RowRepeaterDesign ): this; /** * Sets a new value for property {@link #getFixedRowHeight fixedRowHeight}. * * Row height adapts to rendered content. If a fixed height is specified the cells have a maximum height * and the overflow will be hidden. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setFixedRowHeight( /** * New value for property `fixedRowHeight` */ sFixedRowHeight?: CSSSize ): this; /** * Sets the aggregated {@link #getNoData noData}. * * * @returns Reference to `this` in order to allow method chaining */ setNoData( /** * The noData to set */ oNoData: Control ): this; /** * Setter for property `numberOfRows`. * * Default value is `5` * * * @returns `this` to allow method chaining */ setNumberOfRows( /** * new value for property `numberOfRows` */ iNumberOfRows: int ): this; /** * Override the default behavior of `setShowMoreSteps` to update the paging mode flag. Any change to the * paging mode flag will result in the current page being set to the first page. * * * @returns `this` to allow method chaining */ setShowMoreSteps( /** * new value for property `showMoreSteps` */ iShowMoreSteps: int ): this; /** * Sets a new value for property {@link #getThreshold threshold}. * * Threshold to fetch the next chunk of data. The minimal threshold can be the numberOfRows of the RR. * * 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 */ setThreshold( /** * New value for property `threshold` */ iThreshold?: int ): this; /** * Sets the aggregated {@link #getTitle title}. * * * @returns Reference to `this` in order to allow method chaining */ setTitle( /** * The title to set */ oTitle: Title ): this; /** * The `triggerShowMore` function increments the number of rows by the value of `showMoreSteps`. * * This method will only trigger a showMore if the property showMoreSteps is set. * * * @returns `this` to allow method chaining */ triggerShowMore(): this; /** * Sort the data. */ triggerSort( /** * The ID of the sorter. */ sId: string ): void; /** * Unbinds aggregation {@link #getRows rows} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindRows(): this; } /** * Describes the settings that can be provided to the RowRepeater constructor. * * @deprecated As of version 1.38. Instead, use the `sap.ui.table.Table` control. */ export interface $RowRepeaterSettings extends $ControlSettings { /** * Number of rows displayed. */ numberOfRows?: int | PropertyBindingInfo | `{${string}}`; /** * The index of the page currently displayed. The index starts at 1. */ currentPage?: int | PropertyBindingInfo | `{${string}}`; /** * Step size used to increase the numberOfRows value. This feature is only active if value is greater than * 0. This will deactivate the paging feature. */ showMoreSteps?: int | PropertyBindingInfo | `{${string}}`; /** * Row height adapts to rendered content. If a fixed height is specified the cells have a maximum height * and the overflow will be hidden. */ fixedRowHeight?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * The visual design of the control. */ design?: | (RowRepeaterDesign | keyof typeof RowRepeaterDesign) | PropertyBindingInfo | `{${string}}`; /** * Threshold to fetch the next chunk of data. The minimal threshold can be the numberOfRows of the RR. */ threshold?: int | PropertyBindingInfo | `{${string}}`; /** * Rows to be repeated. */ rows?: Control[] | Control | AggregationBindingInfo | `{${string}}`; /** * Title to be displayed in top left corner. Either text or icon. */ title?: Title; /** * Filters to be provided in toolbar. */ filters?: | RowRepeaterFilter[] | RowRepeaterFilter | AggregationBindingInfo | `{${string}}`; /** * Sorters to be provided in secondary toolbar. */ sorters?: | RowRepeaterSorter[] | RowRepeaterSorter | AggregationBindingInfo | `{${string}}`; /** * This control is shown, in case there is no data available to be displayed in the RowRepeater. */ noData?: Control; /** * This event is triggered when a filter is set. */ filter?: (oEvent: RowRepeater$FilterEvent) => void; /** * This event is triggered when a sorting is applied. */ sort?: (oEvent: RowRepeater$SortEvent) => void; /** * This event is triggered when paging was executed. */ page?: (oEvent: RowRepeater$PageEvent) => void; /** * This event is triggered when the number of rows was changed. */ resize?: (oEvent: RowRepeater$ResizeEvent) => void; } /** * Parameters of the RowRepeater#filter event. */ export interface RowRepeater$FilterEventParameters { /** * The ID of the filter that has just been applied. */ filterId?: string; } /** * Event object of the RowRepeater#filter event. */ export type RowRepeater$FilterEvent = Event< RowRepeater$FilterEventParameters, RowRepeater >; /** * Parameters of the RowRepeater#page event. */ export interface RowRepeater$PageEventParameters { /** * The value of the currentPage property after the change. */ currentPage?: int; /** * The value of the currentPage property before the change. */ previousPage?: int; } /** * Event object of the RowRepeater#page event. */ export type RowRepeater$PageEvent = Event< RowRepeater$PageEventParameters, RowRepeater >; /** * Parameters of the RowRepeater#resize event. */ export interface RowRepeater$ResizeEventParameters { /** * The value of the numberOfRows property after the change. */ numberOfRows?: int; /** * The value of the numberOfRows property before the change. */ previousNumberOfRows?: int; } /** * Event object of the RowRepeater#resize event. */ export type RowRepeater$ResizeEvent = Event< RowRepeater$ResizeEventParameters, RowRepeater >; /** * Parameters of the RowRepeater#sort event. */ export interface RowRepeater$SortEventParameters { /** * The ID of the sorter that has just been applied. */ sorterId?: string; } /** * Event object of the RowRepeater#sort event. */ export type RowRepeater$SortEvent = Event< RowRepeater$SortEventParameters, RowRepeater >; } declare module "sap/ui/commons/RowRepeaterFilter" { import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * This element is used by the RowRepeater and allows to define a filter in this context along with the * related data such as a text and an icon. * * @deprecated As of version 1.38. Instead, use the `sap.ui.table.Table` control. */ export default class RowRepeaterFilter extends UI5Element { /** * Constructor for a new RowRepeaterFilter. * * 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?: $RowRepeaterFilterSettings ); /** * Constructor for a new RowRepeaterFilter. * * 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?: $RowRepeaterFilterSettings ); /** * Creates a new subclass of class sap.ui.commons.RowRepeaterFilter with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @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.ui.commons.RowRepeaterFilter. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Gets current value of property {@link #getFilters filters}. * * The set of filter objects. * * * @returns Value of property `filters` */ getFilters(): object; /** * Gets current value of property {@link #getIcon icon}. * * The filter icon if needed for display. * * * @returns Value of property `icon` */ getIcon(): string; /** * Gets current value of property {@link #getText text}. * * The filter title if needed for display. * * * @returns Value of property `text` */ getText(): string; /** * Sets a new value for property {@link #getFilters filters}. * * The set of filter objects. * * 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 */ setFilters( /** * New value for property `filters` */ oFilters?: object ): this; /** * Sets a new value for property {@link #getIcon icon}. * * The filter icon if needed for display. * * 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 */ setIcon( /** * New value for property `icon` */ sIcon?: string ): this; /** * Sets a new value for property {@link #getText text}. * * The filter title if needed for display. * * 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 RowRepeaterFilter constructor. * * @deprecated As of version 1.38. Instead, use the `sap.ui.table.Table` control. */ export interface $RowRepeaterFilterSettings extends $ElementSettings { /** * The filter title if needed for display. */ text?: string | PropertyBindingInfo; /** * The filter icon if needed for display. */ icon?: string | PropertyBindingInfo; /** * The set of filter objects. */ filters?: object | PropertyBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/RowRepeaterSorter" { import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * This element is used by the RowRepeater and allows to define a sorter in this context along with the * related data such as a text and an icon. * * @deprecated As of version 1.38. Instead, use the `sap.ui.table.Table` control. */ export default class RowRepeaterSorter extends UI5Element { /** * Constructor for a new RowRepeaterSorter. * * 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?: $RowRepeaterSorterSettings ); /** * Constructor for a new RowRepeaterSorter. * * 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?: $RowRepeaterSorterSettings ); /** * Creates a new subclass of class sap.ui.commons.RowRepeaterSorter with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @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.ui.commons.RowRepeaterSorter. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Gets current value of property {@link #getIcon icon}. * * The sorter icon if needed for display. * * * @returns Value of property `icon` */ getIcon(): string; /** * Gets current value of property {@link #getSorter sorter}. * * The sorter object. * * * @returns Value of property `sorter` */ getSorter(): object; /** * Gets current value of property {@link #getText text}. * * The sorter title if needed for display. * * * @returns Value of property `text` */ getText(): string; /** * Sets a new value for property {@link #getIcon icon}. * * The sorter icon if needed for display. * * 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 */ setIcon( /** * New value for property `icon` */ sIcon?: string ): this; /** * Sets a new value for property {@link #getSorter sorter}. * * The sorter object. * * 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 */ setSorter( /** * New value for property `sorter` */ oSorter?: object ): this; /** * Sets a new value for property {@link #getText text}. * * The sorter title if needed for display. * * 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 RowRepeaterSorter constructor. * * @deprecated As of version 1.38. Instead, use the `sap.ui.table.Table` control. */ export interface $RowRepeaterSorterSettings extends $ElementSettings { /** * The sorter title if needed for display. */ text?: string | PropertyBindingInfo; /** * The sorter icon if needed for display. */ icon?: string | PropertyBindingInfo; /** * The sorter object. */ sorter?: object | PropertyBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/SearchField" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { ToolbarItem } from "sap/ui/commons/library"; import { ID, TextAlign, ValueState, CSSSize } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import SearchProvider from "sap/ui/core/search/SearchProvider"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; import Event from "sap/ui/base/Event"; /** * Allows the user to type search queries and to trigger the search. Optionally, suggestions can be added. * * @deprecated As of version 1.38. Instead, use the `sap.m.SearchField` control. */ export default class SearchField extends Control implements ToolbarItem { __implements__sap_ui_commons_ToolbarItem: boolean; /** * Constructor for a new SearchField. * * 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?: $SearchFieldSettings ); /** * Constructor for a new SearchField. * * 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?: $SearchFieldSettings ); /** * Creates a new subclass of class sap.ui.commons.SearchField with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.SearchField. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaDescribedBy( /** * The ariaDescribedBy to add; if empty, nothing is inserted */ vAriaDescribedBy: ID | Control ): this; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaLabelledBy( /** * The ariaLabelledBy to add; if empty, nothing is inserted */ vAriaLabelledBy: ID | Control ): this; /** * Attaches event handler `fnFunction` to the {@link #event:search search} event of this `sap.ui.commons.SearchField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.SearchField` itself. * * Event which is fired when the user triggers a search * * * @returns Reference to `this` in order to allow method chaining */ attachSearch( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: SearchField$SearchEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.SearchField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:search search} event of this `sap.ui.commons.SearchField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.SearchField` itself. * * Event which is fired when the user triggers a search * * * @returns Reference to `this` in order to allow method chaining */ attachSearch( /** * The function to be called when the event occurs */ fnFunction: (p1: SearchField$SearchEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.SearchField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:suggest suggest} event of this `sap.ui.commons.SearchField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.SearchField` itself. * * Event which is fired when new suggest values are required. * * * @returns Reference to `this` in order to allow method chaining */ attachSuggest( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: SearchField$SuggestEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.SearchField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:suggest suggest} event of this `sap.ui.commons.SearchField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.SearchField` itself. * * Event which is fired when new suggest values are required. * * * @returns Reference to `this` in order to allow method chaining */ attachSuggest( /** * The function to be called when the event occurs */ fnFunction: (p1: SearchField$SuggestEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.SearchField` itself */ oListener?: object ): this; /** * Clears the history of the control */ clearHistory(): void; /** * Destroys the searchProvider in the aggregation {@link #getSearchProvider searchProvider}. * * * @returns Reference to `this` in order to allow method chaining */ destroySearchProvider(): this; /** * Detaches event handler `fnFunction` from the {@link #event:search search} event of this `sap.ui.commons.SearchField`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSearch( /** * The function to be called, when the event occurs */ fnFunction: (p1: SearchField$SearchEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:suggest suggest} event of this `sap.ui.commons.SearchField`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSuggest( /** * The function to be called, when the event occurs */ fnFunction: (p1: SearchField$SuggestEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:search search} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSearch( /** * Parameters to pass along with the event */ mParameters?: SearchField$SearchEventParameters ): this; /** * Fires event {@link #event:suggest suggest} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSuggest( /** * Parameters to pass along with the event */ mParameters?: SearchField$SuggestEventParameters ): this; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): ID[]; /** * Gets current value of property {@link #getEditable editable}. * * Non-editable controls have different colors, depending on custom settings * * Default value is `true`. * * * @returns Value of property `editable` */ getEditable(): boolean; /** * Gets current value of property {@link #getEnableCache enableCache}. * * When list suggestion is enabled all suggestions are cached and no suggest event is fired. * * Default value is `true`. * * @since 1.10.3 * * @returns Value of property `enableCache` */ getEnableCache(): boolean; /** * Gets current value of property {@link #getEnableClear enableClear}. * * Defines whether the clear functionality shall be active * * Default value is `false`. * * * @returns Value of property `enableClear` */ getEnableClear(): boolean; /** * Gets current value of property {@link #getEnabled enabled}. * * Disabled fields have different colors, and they can not be focused. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getEnableFilterMode enableFilterMode}. * * Defines whether the search event should also be fired when the SearchField is empty (like a Filter field) * and when the clear button (if activated) is pressed. * * Default value is `false`. * * * @returns Value of property `enableFilterMode` */ getEnableFilterMode(): boolean; /** * Gets current value of property {@link #getEnableListSuggest enableListSuggest}. * * Defines whether a pop up list shall be provided for suggestions * * Default value is `true`. * * * @returns Value of property `enableListSuggest` */ getEnableListSuggest(): boolean; /** * Gets current value of property {@link #getMaxHistoryItems maxHistoryItems}. * * Maximum number of history items in the suggestion list. 0 displays and stores no history. The history * is locally stored on the client. Therefore do not activate this feature when this control handles confidential * data. * * Default value is `0`. * * * @returns Value of property `maxHistoryItems` */ getMaxHistoryItems(): int; /** * Gets current value of property {@link #getMaxLength maxLength}. * * Maximum number of characters. Value '0' means the feature is switched off. * * Default value is `0`. * * * @returns Value of property `maxLength` */ getMaxLength(): int; /** * Gets current value of property {@link #getMaxSuggestionItems maxSuggestionItems}. * * Maximum number of suggestion items in the suggestion list. * * Default value is `10`. * * * @returns Value of property `maxSuggestionItems` */ getMaxSuggestionItems(): int; /** * Gets current value of property {@link #getPlaceholder placeholder}. * * Placeholder for the input field. * * Default value is `empty string`. * * @since 1.32 * * @returns Value of property `placeholder` */ getPlaceholder(): string; /** * Gets content of aggregation {@link #getSearchProvider searchProvider}. * * Search provider instance which handles the suggestions for this SearchField (e.g. Open Search Protocol). */ getSearchProvider(): SearchProvider; /** * Gets current value of property {@link #getShowExternalButton showExternalButton}. * * Defines whether an additional search button shall be displayed * * Default value is `false`. * * * @returns Value of property `showExternalButton` */ getShowExternalButton(): boolean; /** * Gets current value of property {@link #getShowListExpander showListExpander}. * * Defines whether the list expander shall be displayed in the case of an enabled list for suggestions. * This feature is deactivated on mobile devices. * * Default value is `true`. * * * @returns Value of property `showListExpander` */ getShowListExpander(): boolean; /** * Gets current value of property {@link #getStartSuggestion startSuggestion}. * * Minimum length of the entered string triggering the suggestion list. * * Default value is `3`. * * * @returns Value of property `startSuggestion` */ getStartSuggestion(): int; /** * Gets current value of property {@link #getTextAlign textAlign}. * * Sets the horizontal alignment of the text * * Default value is `Begin`. * * * @returns Value of property `textAlign` */ getTextAlign(): TextAlign; /** * Gets current value of property {@link #getValue value}. * * Text that shall be displayed within the search field * * Default value is `empty string`. * * * @returns Value of property `value` */ getValue(): string; /** * Gets current value of property {@link #getValueState valueState}. * * Visualizes warnings or errors related to the input field. Possible values: Warning, Error, Success, None. * * Default value is `None`. * * @since 1.32 * * @returns Value of property `valueState` */ getValueState(): ValueState; /** * Gets current value of property {@link #getVisibleItemCount visibleItemCount}. * * Defines the number of items in the suggestion list that shall be displayed at once. If the overall number * of list items is higher than the setting, a scroll bar is provided. * * Default value is `20`. * * * @returns Value of property `visibleItemCount` */ getVisibleItemCount(): int; /** * Gets current value of property {@link #getWidth width}. * * Control width in CSS-size * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaDescribedBy(): ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): ID[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns The removed ariaDescribedBy or `null` */ removeAriaDescribedBy( /** * The ariaDescribedBy to be removed or its index or ID */ vAriaDescribedBy: int | ID | Control ): ID | null; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns The removed ariaLabelledBy or `null` */ removeAriaLabelledBy( /** * The ariaLabelledBy to be removed or its index or ID */ vAriaLabelledBy: int | ID | Control ): ID | null; /** * Sets a new value for property {@link #getEditable editable}. * * Non-editable controls have different colors, depending on custom settings * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEditable( /** * New value for property `editable` */ bEditable?: boolean ): this; /** * Sets a new value for property {@link #getEnableCache enableCache}. * * When list suggestion is enabled all suggestions are cached and no suggest event is fired. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.10.3 * * @returns Reference to `this` in order to allow method chaining */ setEnableCache( /** * New value for property `enableCache` */ bEnableCache?: boolean ): this; /** * Sets a new value for property {@link #getEnableClear enableClear}. * * Defines whether the clear functionality shall be active * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableClear( /** * New value for property `enableClear` */ bEnableClear?: boolean ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * Disabled fields have different colors, and they can not be focused. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getEnableFilterMode enableFilterMode}. * * Defines whether the search event should also be fired when the SearchField is empty (like a Filter field) * and when the clear button (if activated) is pressed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableFilterMode( /** * New value for property `enableFilterMode` */ bEnableFilterMode?: boolean ): this; /** * Sets a new value for property {@link #getEnableListSuggest enableListSuggest}. * * Defines whether a pop up list shall be provided for suggestions * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnableListSuggest( /** * New value for property `enableListSuggest` */ bEnableListSuggest?: boolean ): this; /** * Sets a new value for property {@link #getMaxHistoryItems maxHistoryItems}. * * Maximum number of history items in the suggestion list. 0 displays and stores no history. The history * is locally stored on the client. Therefore do not activate this feature when this control handles confidential * data. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setMaxHistoryItems( /** * New value for property `maxHistoryItems` */ iMaxHistoryItems?: int ): this; /** * Sets a new value for property {@link #getMaxLength maxLength}. * * Maximum number of characters. Value '0' means the feature is switched off. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setMaxLength( /** * New value for property `maxLength` */ iMaxLength?: int ): this; /** * Sets a new value for property {@link #getMaxSuggestionItems maxSuggestionItems}. * * Maximum number of suggestion items in the suggestion list. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `10`. * * * @returns Reference to `this` in order to allow method chaining */ setMaxSuggestionItems( /** * New value for property `maxSuggestionItems` */ iMaxSuggestionItems?: int ): this; /** * Sets a new value for property {@link #getPlaceholder placeholder}. * * Placeholder for the input field. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * @since 1.32 * * @returns Reference to `this` in order to allow method chaining */ setPlaceholder( /** * New value for property `placeholder` */ sPlaceholder?: string ): this; /** * Sets the aggregated {@link #getSearchProvider searchProvider}. * * * @returns Reference to `this` in order to allow method chaining */ setSearchProvider( /** * The searchProvider to set */ oSearchProvider: SearchProvider ): this; /** * Sets a new value for property {@link #getShowExternalButton showExternalButton}. * * Defines whether an additional search button shall be displayed * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShowExternalButton( /** * New value for property `showExternalButton` */ bShowExternalButton?: boolean ): this; /** * Sets a new value for property {@link #getShowListExpander showListExpander}. * * Defines whether the list expander shall be displayed in the case of an enabled list for suggestions. * This feature is deactivated on mobile devices. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowListExpander( /** * New value for property `showListExpander` */ bShowListExpander?: boolean ): this; /** * Sets a new value for property {@link #getStartSuggestion startSuggestion}. * * Minimum length of the entered string triggering the suggestion list. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `3`. * * * @returns Reference to `this` in order to allow method chaining */ setStartSuggestion( /** * New value for property `startSuggestion` */ iStartSuggestion?: int ): this; /** * Sets a new value for property {@link #getTextAlign textAlign}. * * Sets the horizontal alignment of the text * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Begin`. * * * @returns Reference to `this` in order to allow method chaining */ setTextAlign( /** * New value for property `textAlign` */ sTextAlign?: TextAlign | keyof typeof TextAlign ): this; /** * Sets a new value for property {@link #getValue value}. * * Text that shall be displayed within the search field * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setValue( /** * New value for property `value` */ sValue?: string ): this; /** * Sets a new value for property {@link #getValueState valueState}. * * Visualizes warnings or errors related to the input field. Possible values: Warning, Error, Success, None. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `None`. * * @since 1.32 * * @returns Reference to `this` in order to allow method chaining */ setValueState( /** * New value for property `valueState` */ sValueState?: ValueState | keyof typeof ValueState ): this; /** * Sets a new value for property {@link #getVisibleItemCount visibleItemCount}. * * Defines the number of items in the suggestion list that shall be displayed at once. If the overall number * of list items is higher than the setting, a scroll bar is provided. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `20`. * * * @returns Reference to `this` in order to allow method chaining */ setVisibleItemCount( /** * New value for property `visibleItemCount` */ iVisibleItemCount?: int ): this; /** * Sets a new value for property {@link #getWidth width}. * * Control width in CSS-size * * 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 */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; /** * Callback function used to provide the suggest values in the handler of the suggest event (only in list * suggestion mode) */ suggest( /** * The value which was provided in the corresponding suggest event (parameter 'value') */ sSSuggestValue: string, /** * The list of suggestions belonging to the suggest value */ aASuggestions: string[] ): void; } /** * Describes the settings that can be provided to the SearchField constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.SearchField` control. */ export interface $SearchFieldSettings extends $ControlSettings { /** * Defines whether a pop up list shall be provided for suggestions */ enableListSuggest?: boolean | PropertyBindingInfo | `{${string}}`; /** * Defines whether the list expander shall be displayed in the case of an enabled list for suggestions. * This feature is deactivated on mobile devices. */ showListExpander?: boolean | PropertyBindingInfo | `{${string}}`; /** * Defines whether the clear functionality shall be active */ enableClear?: boolean | PropertyBindingInfo | `{${string}}`; /** * Defines whether an additional search button shall be displayed */ showExternalButton?: boolean | PropertyBindingInfo | `{${string}}`; /** * When list suggestion is enabled all suggestions are cached and no suggest event is fired. * * @since 1.10.3 */ enableCache?: boolean | PropertyBindingInfo | `{${string}}`; /** * Defines whether the search event should also be fired when the SearchField is empty (like a Filter field) * and when the clear button (if activated) is pressed. */ enableFilterMode?: boolean | PropertyBindingInfo | `{${string}}`; /** * Text that shall be displayed within the search field */ value?: string | PropertyBindingInfo; /** * Disabled fields have different colors, and they can not be focused. */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * Non-editable controls have different colors, depending on custom settings */ editable?: boolean | PropertyBindingInfo | `{${string}}`; /** * Control width in CSS-size */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Maximum number of characters. Value '0' means the feature is switched off. */ maxLength?: int | PropertyBindingInfo | `{${string}}`; /** * Visualizes warnings or errors related to the input field. Possible values: Warning, Error, Success, None. * * @since 1.32 */ valueState?: | (ValueState | keyof typeof ValueState) | PropertyBindingInfo | `{${string}}`; /** * Placeholder for the input field. * * @since 1.32 */ placeholder?: string | PropertyBindingInfo; /** * Sets the horizontal alignment of the text */ textAlign?: | (TextAlign | keyof typeof TextAlign) | PropertyBindingInfo | `{${string}}`; /** * Defines the number of items in the suggestion list that shall be displayed at once. If the overall number * of list items is higher than the setting, a scroll bar is provided. */ visibleItemCount?: int | PropertyBindingInfo | `{${string}}`; /** * Minimum length of the entered string triggering the suggestion list. */ startSuggestion?: int | PropertyBindingInfo | `{${string}}`; /** * Maximum number of suggestion items in the suggestion list. */ maxSuggestionItems?: int | PropertyBindingInfo | `{${string}}`; /** * Maximum number of history items in the suggestion list. 0 displays and stores no history. The history * is locally stored on the client. Therefore do not activate this feature when this control handles confidential * data. */ maxHistoryItems?: int | PropertyBindingInfo | `{${string}}`; /** * Search provider instance which handles the suggestions for this SearchField (e.g. Open Search Protocol). */ searchProvider?: SearchProvider; /** * Association to controls / IDs which describe this control (see WAI-ARIA attribute aria-describedby). */ ariaDescribedBy?: Array; /** * Association to controls / IDs which label this control (see WAI-ARIA attribute aria-labelledby). */ ariaLabelledBy?: Array; /** * Event which is fired when the user triggers a search */ search?: (oEvent: SearchField$SearchEvent) => void; /** * Event which is fired when new suggest values are required. */ suggest?: (oEvent: SearchField$SuggestEvent) => void; } /** * Parameters of the SearchField#search event. */ export interface SearchField$SearchEventParameters { /** * The search query */ query?: string; } /** * Event object of the SearchField#search event. */ export type SearchField$SearchEvent = Event< SearchField$SearchEventParameters, SearchField >; /** * Parameters of the SearchField#suggest event. */ export interface SearchField$SuggestEventParameters { /** * The value for which suggestions are required. */ value?: string; } /** * Event object of the SearchField#suggest event. */ export type SearchField$SuggestEvent = Event< SearchField$SuggestEventParameters, SearchField >; } declare module "sap/ui/commons/SearchProvider" { import { default as OpenSearchProvider, $OpenSearchProviderSettings, } from "sap/ui/core/search/OpenSearchProvider"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * A SearchProvider which can be attached to a Search Field. * * @deprecated As of version 1.6.0. Replaced by sap.ui.core.search.OpenSearchProvider */ export default class SearchProvider extends OpenSearchProvider { /** * Constructor for a new SearchProvider. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.search.OpenSearchProvider#constructor sap.ui.core.search.OpenSearchProvider } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: $SearchProviderSettings ); /** * Constructor for a new SearchProvider. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.search.OpenSearchProvider#constructor sap.ui.core.search.OpenSearchProvider } * can be used. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: $SearchProviderSettings ); /** * Creates a new subclass of class sap.ui.commons.SearchProvider with name `sClassName` and enriches it * with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.search.OpenSearchProvider.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.ui.commons.SearchProvider. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; } /** * Describes the settings that can be provided to the SearchProvider constructor. * * @deprecated As of version 1.6.0. Replaced by sap.ui.core.search.OpenSearchProvider */ export interface $SearchProviderSettings extends $OpenSearchProviderSettings {} } declare module "sap/ui/commons/SegmentedButton" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { ToolbarItem } from "sap/ui/commons/library"; import { IFormContent, ID } from "sap/ui/core/library"; import Button from "sap/ui/commons/Button"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; import Event from "sap/ui/base/Event"; /** * The SegmentedButton provides a group of multiple buttons. Only one button can be active. The behaviour * is more ore less like a radio button group. * * @deprecated As of version 1.38. replaced by {@link sap.m.SegmentedButton} */ export default class SegmentedButton extends Control implements ToolbarItem, IFormContent { __implements__sap_ui_commons_ToolbarItem: boolean; __implements__sap_ui_core_IFormContent: boolean; /** * Constructor for a new SegmentedButton. * * 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?: $SegmentedButtonSettings ); /** * Constructor for a new SegmentedButton. * * 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?: $SegmentedButtonSettings ); /** * Creates a new subclass of class sap.ui.commons.SegmentedButton with name `sClassName` and enriches it * with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.SegmentedButton. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Rerendering of the Buttons * * @ui5-protected Do not call from applications (only from related classes in the framework) */ _rerenderButtons(): void; /** * Adds some button to the aggregation {@link #getButtons buttons}. * * * @returns Reference to `this` in order to allow method chaining */ addButton( /** * The button to add; if empty, nothing is inserted */ oButton: Button ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.commons.SegmentedButton`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.SegmentedButton` itself. * * Event fired when button selected * * * @returns Reference to `this` in order to allow method chaining */ attachSelect( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: SegmentedButton$SelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.SegmentedButton` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.commons.SegmentedButton`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.SegmentedButton` itself. * * Event fired when button selected * * * @returns Reference to `this` in order to allow method chaining */ attachSelect( /** * The function to be called when the event occurs */ fnFunction: (p1: SegmentedButton$SelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.SegmentedButton` itself */ oListener?: object ): this; /** * Destroys all the buttons in the aggregation {@link #getButtons buttons}. * * * @returns Reference to `this` in order to allow method chaining */ destroyButtons(): this; /** * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.ui.commons.SegmentedButton`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSelect( /** * The function to be called, when the event occurs */ fnFunction: (p1: SegmentedButton$SelectEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:select select} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSelect( /** * Parameters to pass along with the event */ mParameters?: SegmentedButton$SelectEventParameters ): this; /** * Gets content of aggregation {@link #getButtons buttons}. * * Buttons */ getButtons(): Button[]; /** * Gets current value of property {@link #getEnabled enabled}. * * enabled * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * ID of the element which is the current target of the association {@link #getSelectedButton selectedButton}, * or `null`. */ getSelectedButton(): ID | null; /** * Checks for the provided `sap.ui.commons.Button` in the aggregation {@link #getButtons buttons}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfButton( /** * The button whose index is looked for */ oButton: Button ): int; /** * Inserts a button into the aggregation {@link #getButtons buttons}. * * * @returns Reference to `this` in order to allow method chaining */ insertButton( /** * The button to insert; if empty, nothing is inserted */ oButton: Button, /** * The `0`-based index the button should be inserted at; for a negative value of `iIndex`, the button is * inserted at position 0; for a value greater than the current size of the aggregation, the button is inserted * at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getButtons buttons}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllButtons(): Button[]; /** * Removes a button from the aggregation {@link #getButtons buttons}. * * * @returns The removed button or `null` */ removeButton( /** * The button to remove or its index or id */ vButton: int | string | Button ): Button | null; /** * Sets a new value for property {@link #getEnabled enabled}. * * enabled * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets the associated {@link #getSelectedButton selectedButton}. * * * @returns Reference to `this` in order to allow method chaining */ setSelectedButton( /** * ID of an element which becomes the new target of this selectedButton association; alternatively, an element * instance may be given */ oSelectedButton: ID | Button ): this; } /** * Describes the settings that can be provided to the SegmentedButton constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.SegmentedButton} */ export interface $SegmentedButtonSettings extends $ControlSettings { /** * enabled */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * Buttons */ buttons?: Button[] | Button | AggregationBindingInfo | `{${string}}`; /** * Selected Button */ selectedButton?: Button | string; /** * Event fired when button selected */ select?: (oEvent: SegmentedButton$SelectEvent) => void; } /** * Parameters of the SegmentedButton#select event. */ export interface SegmentedButton$SelectEventParameters { /** * Id of selected ToggleButton */ selectedButtonId?: string; } /** * Event object of the SegmentedButton#select event. */ export type SegmentedButton$SelectEvent = Event< SegmentedButton$SelectEventParameters, SegmentedButton >; } declare module "sap/ui/commons/Slider" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { IFormContent, ID, CSSSize } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; import Event from "sap/ui/base/Event"; /** * The interactive control is displayed either as a horizontal or a vertical line with a pointer and units * of measurement. Users can move the pointer along the line to change values with graphical support. * * @deprecated As of version 1.38. replaced by {@link sap.m.Slider} */ export default class Slider extends Control implements IFormContent { __implements__sap_ui_core_IFormContent: boolean; /** * Constructor for a new `Slider`. * * 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?: $SliderSettings ); /** * Constructor for a new `Slider`. * * 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?: $SliderSettings ); /** * Creates a new subclass of class sap.ui.commons.Slider with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.Slider. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaDescribedBy( /** * The ariaDescribedBy to add; if empty, nothing is inserted */ vAriaDescribedBy: ID | Control ): this; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaLabelledBy( /** * The ariaLabelledBy to add; if empty, nothing is inserted */ vAriaLabelledBy: ID | Control ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.commons.Slider`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Slider` itself. * * Value was changed. This event is fired if the value has changed by a user action. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Slider$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Slider` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.commons.Slider`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Slider` itself. * * Value was changed. This event is fired if the value has changed by a user action. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * The function to be called when the event occurs */ fnFunction: (p1: Slider$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Slider` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:liveChange liveChange} event of this `sap.ui.commons.Slider`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Slider` itself. * * Value was changed. This event is fired during the mouse move. The normal change event is only fired by * mouseup. * * * @returns Reference to `this` in order to allow method chaining */ attachLiveChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Slider$LiveChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Slider` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:liveChange liveChange} event of this `sap.ui.commons.Slider`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Slider` itself. * * Value was changed. This event is fired during the mouse move. The normal change event is only fired by * mouseup. * * * @returns Reference to `this` in order to allow method chaining */ attachLiveChange( /** * The function to be called when the event occurs */ fnFunction: (p1: Slider$LiveChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Slider` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.commons.Slider`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: Slider$ChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:liveChange liveChange} event of this `sap.ui.commons.Slider`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachLiveChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: Slider$LiveChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:change change} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireChange( /** * Parameters to pass along with the event */ mParameters?: Slider$ChangeEventParameters ): this; /** * Fires event {@link #event:liveChange liveChange} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireLiveChange( /** * Parameters to pass along with the event */ mParameters?: Slider$LiveChangeEventParameters ): this; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): ID[]; /** * Gets current value of property {@link #getEditable editable}. * * Using the slider interactively requires value "true". * * Default value is `true`. * * * @returns Value of property `editable` */ getEditable(): boolean; /** * Gets current value of property {@link #getEnabled enabled}. * * Switches enabled state of the control. Disabled fields have different colors, and can not be focused. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getHeight height}. * * Height of the vertical slider. * * Default value is `'100%'`. * * @since 1.7.1 * * @returns Value of property `height` */ getHeight(): CSSSize; /** * Gets current value of property {@link #getLabels labels}. * * Labels to be displayed instead of numbers. Attribute totalUnits and label count should be the same * * **Note:** To show the labels `stepLabels` must be activated. * * * @returns Value of property `labels` */ getLabels(): string[]; /** * Gets current value of property {@link #getMax max}. * * Maximal value of the slider * * **Note:** If `min` is larger than `max` both values will be switched * * Default value is `100`. * * * @returns Value of property `max` */ getMax(): float; /** * Gets current value of property {@link #getMin min}. * * Minimal value of the slider. * * **Note:** If `min` is larger than `max` both values will be switched * * Default value is `0`. * * * @returns Value of property `min` */ getMin(): float; /** * Gets current value of property {@link #getSmallStepWidth smallStepWidth}. * * The grip can only be moved in steps of this width. * * * @returns Value of property `smallStepWidth` */ getSmallStepWidth(): float; /** * Gets current value of property {@link #getStepLabels stepLabels}. * * Display step numbers for the ticks on the slider. * * Default value is `false`. * * * @returns Value of property `stepLabels` */ getStepLabels(): boolean; /** * Gets current value of property {@link #getTotalUnits totalUnits}. * * Number of units that are displayed by ticks. The PageUp and PageDown keys navigate according to these * units. * * * @returns Value of property `totalUnits` */ getTotalUnits(): int; /** * Gets current value of property {@link #getValue value}. * * Current value of the slider. (Position of the grip.) * * **Note:** If the value is not in the valid range (between `min` and `max`) it will be changed to be in * the valid range. * * Default value is `50`. * * * @returns Value of property `value` */ getValue(): float; /** * Gets current value of property {@link #getVertical vertical}. * * Orientation of slider * * Default value is `false`. * * @since 1.7.1 * * @returns Value of property `vertical` */ getVertical(): boolean; /** * Gets current value of property {@link #getWidth width}. * * Width of the horizontal slider. * * Default value is `'100%'`. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaDescribedBy(): ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): ID[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns The removed ariaDescribedBy or `null` */ removeAriaDescribedBy( /** * The ariaDescribedBy to be removed or its index or ID */ vAriaDescribedBy: int | ID | Control ): ID | null; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns The removed ariaLabelledBy or `null` */ removeAriaLabelledBy( /** * The ariaLabelledBy to be removed or its index or ID */ vAriaLabelledBy: int | ID | Control ): ID | null; /** * Sets a new value for property {@link #getEditable editable}. * * Using the slider interactively requires value "true". * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEditable( /** * New value for property `editable` */ bEditable?: boolean ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * Switches enabled state of the control. Disabled fields have different colors, and can not be focused. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getHeight height}. * * Height of the vertical slider. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'100%'`. * * @since 1.7.1 * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ sHeight?: CSSSize ): this; /** * Sets a new value for property {@link #getLabels labels}. * * Labels to be displayed instead of numbers. Attribute totalUnits and label count should be the same * * **Note:** To show the labels `stepLabels` must be activated. * * 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 */ setLabels( /** * New value for property `labels` */ sLabels?: string[] ): this; /** * Sets a new value for property {@link #getMax max}. * * Maximal value of the slider * * **Note:** If `min` is larger than `max` both values will be switched * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `100`. * * * @returns Reference to `this` in order to allow method chaining */ setMax( /** * New value for property `max` */ fMax?: float ): this; /** * Sets a new value for property {@link #getMin min}. * * Minimal value of the slider. * * **Note:** If `min` is larger than `max` both values will be switched * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setMin( /** * New value for property `min` */ fMin?: float ): this; /** * Sets a new value for property {@link #getSmallStepWidth smallStepWidth}. * * The grip can only be moved in steps of this width. * * 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 */ setSmallStepWidth( /** * New value for property `smallStepWidth` */ fSmallStepWidth?: float ): this; /** * Sets a new value for property {@link #getStepLabels stepLabels}. * * Display step numbers for the ticks on the slider. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setStepLabels( /** * New value for property `stepLabels` */ bStepLabels?: boolean ): this; /** * Sets a new value for property {@link #getTotalUnits totalUnits}. * * Number of units that are displayed by ticks. The PageUp and PageDown keys navigate according to these * units. * * 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 */ setTotalUnits( /** * New value for property `totalUnits` */ iTotalUnits?: int ): this; /** * Sets a new value for property {@link #getValue value}. * * Current value of the slider. (Position of the grip.) * * **Note:** If the value is not in the valid range (between `min` and `max`) it will be changed to be in * the valid range. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `50`. * * * @returns Reference to `this` in order to allow method chaining */ setValue( /** * New value for property `value` */ fValue?: float ): this; /** * Sets a new value for property {@link #getVertical vertical}. * * Orientation of slider * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.7.1 * * @returns Reference to `this` in order to allow method chaining */ setVertical( /** * New value for property `vertical` */ bVertical?: boolean ): this; /** * Sets a new value for property {@link #getWidth width}. * * Width of the horizontal slider. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'100%'`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; } /** * Describes the settings that can be provided to the Slider constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.Slider} */ export interface $SliderSettings extends $ControlSettings { /** * Width of the horizontal slider. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Minimal value of the slider. * * **Note:** If `min` is larger than `max` both values will be switched */ min?: float | PropertyBindingInfo | `{${string}}`; /** * Maximal value of the slider * * **Note:** If `min` is larger than `max` both values will be switched */ max?: float | PropertyBindingInfo | `{${string}}`; /** * Current value of the slider. (Position of the grip.) * * **Note:** If the value is not in the valid range (between `min` and `max`) it will be changed to be in * the valid range. */ value?: float | PropertyBindingInfo | `{${string}}`; /** * The grip can only be moved in steps of this width. */ smallStepWidth?: float | PropertyBindingInfo | `{${string}}`; /** * Number of units that are displayed by ticks. The PageUp and PageDown keys navigate according to these * units. */ totalUnits?: int | PropertyBindingInfo | `{${string}}`; /** * Display step numbers for the ticks on the slider. */ stepLabels?: boolean | PropertyBindingInfo | `{${string}}`; /** * Using the slider interactively requires value "true". */ editable?: boolean | PropertyBindingInfo | `{${string}}`; /** * Switches enabled state of the control. Disabled fields have different colors, and can not be focused. */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * Labels to be displayed instead of numbers. Attribute totalUnits and label count should be the same * * **Note:** To show the labels `stepLabels` must be activated. */ labels?: string[] | PropertyBindingInfo | `{${string}}`; /** * Orientation of slider * * @since 1.7.1 */ vertical?: boolean | PropertyBindingInfo | `{${string}}`; /** * Height of the vertical slider. * * @since 1.7.1 */ height?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Association to controls / IDs which describe this control (see WAI-ARIA attribute aria-describedby). */ ariaDescribedBy?: Array; /** * Association to controls / IDs which label this control (see WAI-ARIA attribute aria-labelledby). */ ariaLabelledBy?: Array; /** * Value was changed. This event is fired if the value has changed by a user action. */ change?: (oEvent: Slider$ChangeEvent) => void; /** * Value was changed. This event is fired during the mouse move. The normal change event is only fired by * mouseup. */ liveChange?: (oEvent: Slider$LiveChangeEvent) => void; } /** * Parameters of the Slider#change event. */ export interface Slider$ChangeEventParameters { /** * Current value of the slider after a change. */ value?: float; } /** * Event object of the Slider#change event. */ export type Slider$ChangeEvent = Event; /** * Parameters of the Slider#liveChange event. */ export interface Slider$LiveChangeEventParameters { /** * Current value of the slider after a change. */ value?: float; } /** * Event object of the Slider#liveChange event. */ export type Slider$LiveChangeEvent = Event< Slider$LiveChangeEventParameters, Slider >; } declare module "sap/ui/commons/Splitter" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { SplitterSize } from "sap/ui/commons/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { Percentage, Orientation } from "sap/ui/core/library"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; /** * Allows to split the screen into two areas. Make sure that the container for the splitter has an absolute * height or set an absolute height for the splitter using the height property. Otherwise the height of * the splitter is calculated by the height of its contents. * * @deprecated As of version 1.38. Instead, use the `sap.ui.layout.Splitter` control. */ export default class Splitter extends Control { /** * Constructor for a new Splitter. * * 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?: $SplitterSettings ); /** * Constructor for a new Splitter. * * 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?: $SplitterSettings ); /** * Creates a new subclass of class sap.ui.commons.Splitter with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.Splitter. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some firstPaneContent to the aggregation {@link #getFirstPaneContent firstPaneContent}. * * * @returns Reference to `this` in order to allow method chaining */ addFirstPaneContent( /** * The firstPaneContent to add; if empty, nothing is inserted */ oFirstPaneContent: Control ): this; /** * Adds some secondPaneContent to the aggregation {@link #getSecondPaneContent secondPaneContent}. * * * @returns Reference to `this` in order to allow method chaining */ addSecondPaneContent( /** * The secondPaneContent to add; if empty, nothing is inserted */ oSecondPaneContent: Control ): this; /** * Destroys all the firstPaneContent in the aggregation {@link #getFirstPaneContent firstPaneContent}. * * * @returns Reference to `this` in order to allow method chaining */ destroyFirstPaneContent(): this; /** * Destroys all the secondPaneContent in the aggregation {@link #getSecondPaneContent secondPaneContent}. * * * @returns Reference to `this` in order to allow method chaining */ destroySecondPaneContent(): this; /** * Gets content of aggregation {@link #getFirstPaneContent firstPaneContent}. * * Controls inside the first pane. These are the left ones in case of defining a vertical splitter, and * the top ones in case of using the horizontal splitter. */ getFirstPaneContent(): Control[]; /** * Gets current value of property {@link #getHeight height}. * * The height of the split area in px or in % * * Default value is `'100%'`. * * * @returns Value of property `height` */ getHeight(): SplitterSize; /** * Gets current value of property {@link #getMinSizeFirstPane minSizeFirstPane}. * * The minimum size (width for vertical splitter or height for horizontal splitter) of the first Pane * * Default value is `'0%'`. * * * @returns Value of property `minSizeFirstPane` */ getMinSizeFirstPane(): Percentage; /** * Gets current value of property {@link #getMinSizeSecondPane minSizeSecondPane}. * * The minimum size (width for vertical splitter or height for horizontal splitter) of the second Pane * * Default value is `'0%'`. * * * @returns Value of property `minSizeSecondPane` */ getMinSizeSecondPane(): Percentage; /** * Gets content of aggregation {@link #getSecondPaneContent secondPaneContent}. * * Controls inside the second pane. These are the right ones in case of defining a vertical splitter, and * the bottom ones in case of using the horizontal splitter. */ getSecondPaneContent(): Control[]; /** * Gets current value of property {@link #getShowScrollBars showScrollBars}. * * Specifies if the browser should display scroll bars or simply cut the content of a splitter pane when * the content does not fit into its pane. * * Default value is `true`. * * * @returns Value of property `showScrollBars` */ getShowScrollBars(): boolean; /** * Gets current value of property {@link #getSplitterBarVisible splitterBarVisible}. * * set the splitter bar to be visible or not. * * Default value is `true`. * * * @returns Value of property `splitterBarVisible` */ getSplitterBarVisible(): boolean; /** * Gets current value of property {@link #getSplitterOrientation splitterOrientation}. * * The splitter can have horizontal or vertical orientation. * * Default value is `Vertical`. * * * @returns Value of property `splitterOrientation` */ getSplitterOrientation(): Orientation; /** * Gets current value of property {@link #getSplitterPosition splitterPosition}. * * Position of splitter bar in percentage. The default value means that the splitter is positioned in the * middle of the area that is available for the splitter. * * Default value is `'50%'`. * * * @returns Value of property `splitterPosition` */ getSplitterPosition(): Percentage; /** * Gets current value of property {@link #getWidth width}. * * The width of the split area in px or in % * * Default value is `'100%'`. * * * @returns Value of property `width` */ getWidth(): SplitterSize; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getFirstPaneContent firstPaneContent}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfFirstPaneContent( /** * The firstPaneContent whose index is looked for */ oFirstPaneContent: Control ): int; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getSecondPaneContent secondPaneContent}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfSecondPaneContent( /** * The secondPaneContent whose index is looked for */ oSecondPaneContent: Control ): int; /** * Inserts a firstPaneContent into the aggregation {@link #getFirstPaneContent firstPaneContent}. * * * @returns Reference to `this` in order to allow method chaining */ insertFirstPaneContent( /** * The firstPaneContent to insert; if empty, nothing is inserted */ oFirstPaneContent: Control, /** * The `0`-based index the firstPaneContent should be inserted at; for a negative value of `iIndex`, the * firstPaneContent is inserted at position 0; for a value greater than the current size of the aggregation, * the firstPaneContent is inserted at the last position */ iIndex: int ): this; /** * Inserts a secondPaneContent into the aggregation {@link #getSecondPaneContent secondPaneContent}. * * * @returns Reference to `this` in order to allow method chaining */ insertSecondPaneContent( /** * The secondPaneContent to insert; if empty, nothing is inserted */ oSecondPaneContent: Control, /** * The `0`-based index the secondPaneContent should be inserted at; for a negative value of `iIndex`, the * secondPaneContent is inserted at position 0; for a value greater than the current size of the aggregation, * the secondPaneContent is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getFirstPaneContent firstPaneContent}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllFirstPaneContent(): Control[]; /** * Removes all the controls from the aggregation {@link #getSecondPaneContent secondPaneContent}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllSecondPaneContent(): Control[]; /** * Removes a firstPaneContent from the aggregation {@link #getFirstPaneContent firstPaneContent}. * * * @returns The removed firstPaneContent or `null` */ removeFirstPaneContent( /** * The firstPaneContent to remove or its index or id */ vFirstPaneContent: int | string | Control ): Control | null; /** * Removes a secondPaneContent from the aggregation {@link #getSecondPaneContent secondPaneContent}. * * * @returns The removed secondPaneContent or `null` */ removeSecondPaneContent( /** * The secondPaneContent to remove or its index or id */ vSecondPaneContent: int | string | Control ): Control | null; /** * Sets a new value for property {@link #getHeight height}. * * The height of the split area in px or in % * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'100%'`. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ sHeight?: SplitterSize ): this; /** * Sets a new value for property {@link #getMinSizeFirstPane minSizeFirstPane}. * * The minimum size (width for vertical splitter or height for horizontal splitter) of the first Pane * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'0%'`. * * * @returns Reference to `this` in order to allow method chaining */ setMinSizeFirstPane( /** * New value for property `minSizeFirstPane` */ sMinSizeFirstPane?: Percentage ): this; /** * Sets a new value for property {@link #getMinSizeSecondPane minSizeSecondPane}. * * The minimum size (width for vertical splitter or height for horizontal splitter) of the second Pane * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'0%'`. * * * @returns Reference to `this` in order to allow method chaining */ setMinSizeSecondPane( /** * New value for property `minSizeSecondPane` */ sMinSizeSecondPane?: Percentage ): this; /** * Sets a new value for property {@link #getShowScrollBars showScrollBars}. * * Specifies if the browser should display scroll bars or simply cut the content of a splitter pane when * the content does not fit into its pane. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowScrollBars( /** * New value for property `showScrollBars` */ bShowScrollBars?: boolean ): this; /** * Sets a new value for property {@link #getSplitterBarVisible splitterBarVisible}. * * set the splitter bar to be visible or not. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setSplitterBarVisible( /** * New value for property `splitterBarVisible` */ bSplitterBarVisible?: boolean ): this; /** * Sets a new value for property {@link #getSplitterOrientation splitterOrientation}. * * The splitter can have horizontal or vertical orientation. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Vertical`. * * * @returns Reference to `this` in order to allow method chaining */ setSplitterOrientation( /** * New value for property `splitterOrientation` */ sSplitterOrientation?: Orientation | keyof typeof Orientation ): this; /** * Sets a new value for property {@link #getSplitterPosition splitterPosition}. * * Position of splitter bar in percentage. The default value means that the splitter is positioned in the * middle of the area that is available for the splitter. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'50%'`. * * * @returns Reference to `this` in order to allow method chaining */ setSplitterPosition( /** * New value for property `splitterPosition` */ sSplitterPosition?: Percentage ): this; /** * Sets a new value for property {@link #getWidth width}. * * The width of the split area in px or in % * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'100%'`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: SplitterSize ): this; } /** * Describes the settings that can be provided to the Splitter constructor. * * @deprecated As of version 1.38. Instead, use the `sap.ui.layout.Splitter` control. */ export interface $SplitterSettings extends $ControlSettings { /** * The splitter can have horizontal or vertical orientation. */ splitterOrientation?: | (Orientation | keyof typeof Orientation) | PropertyBindingInfo | `{${string}}`; /** * Position of splitter bar in percentage. The default value means that the splitter is positioned in the * middle of the area that is available for the splitter. */ splitterPosition?: Percentage | PropertyBindingInfo | `{${string}}`; /** * The minimum size (width for vertical splitter or height for horizontal splitter) of the first Pane */ minSizeFirstPane?: Percentage | PropertyBindingInfo | `{${string}}`; /** * The minimum size (width for vertical splitter or height for horizontal splitter) of the second Pane */ minSizeSecondPane?: Percentage | PropertyBindingInfo | `{${string}}`; /** * The width of the split area in px or in % */ width?: SplitterSize | PropertyBindingInfo | `{${string}}`; /** * The height of the split area in px or in % */ height?: SplitterSize | PropertyBindingInfo | `{${string}}`; /** * Specifies if the browser should display scroll bars or simply cut the content of a splitter pane when * the content does not fit into its pane. */ showScrollBars?: boolean | PropertyBindingInfo | `{${string}}`; /** * set the splitter bar to be visible or not. */ splitterBarVisible?: boolean | PropertyBindingInfo | `{${string}}`; /** * Controls inside the first pane. These are the left ones in case of defining a vertical splitter, and * the top ones in case of using the horizontal splitter. */ firstPaneContent?: | Control[] | Control | AggregationBindingInfo | `{${string}}`; /** * Controls inside the second pane. These are the right ones in case of defining a vertical splitter, and * the bottom ones in case of using the horizontal splitter. */ secondPaneContent?: | Control[] | Control | AggregationBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/Tab" { import { default as Panel, $PanelSettings } from "sap/ui/commons/Panel"; import { Scrolling } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Represents a single tab in a TabStrip control. * * @deprecated As of version 1.38. Instead, use the `sap.m.TabContainer` control. */ export default class Tab extends Panel { /** * Constructor for a new Tab. * * 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?: $TabSettings ); /** * Constructor for a new Tab. * * 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?: $TabSettings ); /** * Creates a new subclass of class sap.ui.commons.Tab with name `sClassName` and enriches it with the information * contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.commons.Panel.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.ui.commons.Tab. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Gets current value of property {@link #getClosable closable}. * * Specifies whether the tab contains a close button. * * Default value is `false`. * * * @returns Value of property `closable` */ getClosable(): boolean; /** * Gets current value of property {@link #getHorizontalScrolling horizontalScrolling}. * * Specifies the horizontal scrolling. * * Default value is `None`. * * * @returns Value of property `horizontalScrolling` */ getHorizontalScrolling(): Scrolling; /** * Gets current value of property {@link #getSelected selected}. * * Defines whether the tab is the active one. * * Default value is `false`. * * @deprecated As of version 0.17.0. This property is not used. To identify the selected tab in a TabStrip * selectedIndex is used. * * @returns Value of property `selected` */ getSelected(): boolean; /** * Gets current value of property {@link #getVerticalScrolling verticalScrolling}. * * Specifies the vertical scrolling. * * Default value is `None`. * * * @returns Value of property `verticalScrolling` */ getVerticalScrolling(): Scrolling; /** * Sets a new value for property {@link #getClosable closable}. * * Specifies whether the tab contains a close button. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setClosable( /** * New value for property `closable` */ bClosable?: boolean ): this; /** * Sets a new value for property {@link #getHorizontalScrolling horizontalScrolling}. * * Specifies the horizontal scrolling. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `None`. * * * @returns Reference to `this` in order to allow method chaining */ setHorizontalScrolling( /** * New value for property `horizontalScrolling` */ sHorizontalScrolling?: Scrolling | keyof typeof Scrolling ): this; /** * Sets a new value for property {@link #getSelected selected}. * * Defines whether the tab is the active one. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @deprecated As of version 0.17.0. This property is not used. To identify the selected tab in a TabStrip * selectedIndex is used. * * @returns Reference to `this` in order to allow method chaining */ setSelected( /** * New value for property `selected` */ bSelected?: boolean ): this; /** * Sets a new value for property {@link #getVerticalScrolling verticalScrolling}. * * Specifies the vertical scrolling. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `None`. * * * @returns Reference to `this` in order to allow method chaining */ setVerticalScrolling( /** * New value for property `verticalScrolling` */ sVerticalScrolling?: Scrolling | keyof typeof Scrolling ): this; } /** * Describes the settings that can be provided to the Tab constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.TabContainer` control. */ export interface $TabSettings extends $PanelSettings { /** * Specifies the vertical scrolling. */ verticalScrolling?: | (Scrolling | keyof typeof Scrolling) | PropertyBindingInfo | `{${string}}`; /** * Specifies the horizontal scrolling. */ horizontalScrolling?: | (Scrolling | keyof typeof Scrolling) | PropertyBindingInfo | `{${string}}`; /** * Specifies whether the tab contains a close button. */ closable?: boolean | PropertyBindingInfo | `{${string}}`; /** * Defines whether the tab is the active one. * * @deprecated As of version 0.17.0. This property is not used. To identify the selected tab in a TabStrip * selectedIndex is used. */ selected?: boolean | PropertyBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/TabStrip" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import Tab from "sap/ui/commons/Tab"; import { CSSSize } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; import Event from "sap/ui/base/Event"; /** * TabStrip represents a container for tab controls, which contain the content and generally other controls. * The user switches between the tabs to display the content. * * @deprecated As of version 1.38. Instead, use the `sap.m.TabContainer` control. */ export default class TabStrip extends Control { /** * Constructor for a new TabStrip. * * 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?: $TabStripSettings ); /** * Constructor for a new TabStrip. * * 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?: $TabStripSettings ); /** * Creates a new subclass of class sap.ui.commons.TabStrip with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.TabStrip. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some tab to the aggregation {@link #getTabs tabs}. * * * @returns Reference to `this` in order to allow method chaining */ addTab( /** * The tab to add; if empty, nothing is inserted */ oTab: Tab ): this; /** * Attaches event handler `fnFunction` to the {@link #event:close close} event of this `sap.ui.commons.TabStrip`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.TabStrip` itself. * * Fires when the user closes a tab. * * * @returns Reference to `this` in order to allow method chaining */ attachClose( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: TabStrip$CloseEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.TabStrip` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:close close} event of this `sap.ui.commons.TabStrip`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.TabStrip` itself. * * Fires when the user closes a tab. * * * @returns Reference to `this` in order to allow method chaining */ attachClose( /** * The function to be called when the event occurs */ fnFunction: (p1: TabStrip$CloseEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.TabStrip` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.commons.TabStrip`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.TabStrip` itself. * * Fires when the user selects a tab. * * * @returns Reference to `this` in order to allow method chaining */ attachSelect( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: TabStrip$SelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.TabStrip` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.commons.TabStrip`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.TabStrip` itself. * * Fires when the user selects a tab. * * * @returns Reference to `this` in order to allow method chaining */ attachSelect( /** * The function to be called when the event occurs */ fnFunction: (p1: TabStrip$SelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.TabStrip` itself */ oListener?: object ): this; /** * Closes a tab (if the tab is selected, the next one will be selected; if it's the last tab, the previous * one will be selected). * * This method should be called if the close event is fired. It can not be called automatically because * the consumer might need to run some logic before the tab is closed. */ closeTab( /** * The index of the tab that should be closed */ iIndex: int ): void; /** * Creates a Tab and adds it to the TabStrip. * * * @returns oTab The created tab control */ createTab( /** * Defines the title text of the newly created tab */ sText: string, /** * Defines the root control of the content area */ oContent: Control ): Tab; /** * Destroys all the tabs in the aggregation {@link #getTabs tabs}. * * * @returns Reference to `this` in order to allow method chaining */ destroyTabs(): this; /** * Detaches event handler `fnFunction` from the {@link #event:close close} event of this `sap.ui.commons.TabStrip`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachClose( /** * The function to be called, when the event occurs */ fnFunction: (p1: TabStrip$CloseEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.ui.commons.TabStrip`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSelect( /** * The function to be called, when the event occurs */ fnFunction: (p1: TabStrip$SelectEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:close close} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireClose( /** * Parameters to pass along with the event */ mParameters?: TabStrip$CloseEventParameters ): this; /** * Fires event {@link #event:select select} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSelect( /** * Parameters to pass along with the event */ mParameters?: TabStrip$SelectEventParameters ): this; /** * Gets current value of property {@link #getEnableTabReordering enableTabReordering}. * * Specifies whether tab reordering is enabled. * * Default value is `false`. * * * @returns Value of property `enableTabReordering` */ getEnableTabReordering(): boolean; /** * Gets current value of property {@link #getHeight height}. * * Specifies the height of the tab bar and content area. * * * @returns Value of property `height` */ getHeight(): CSSSize; /** * Gets current value of property {@link #getSelectedIndex selectedIndex}. * * Specifies the index of the currently selected tab. * * Default value is `0`. * * * @returns Value of property `selectedIndex` */ getSelectedIndex(): int; /** * Gets content of aggregation {@link #getTabs tabs}. * * The tabs contained in the TabStrip. */ getTabs(): Tab[]; /** * Gets current value of property {@link #getWidth width}. * * Specifies the width of the bar and content area. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Checks for the provided `sap.ui.commons.Tab` in the aggregation {@link #getTabs tabs}. and returns its * index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfTab( /** * The tab whose index is looked for */ oTab: Tab ): int; /** * Inserts a tab into the aggregation {@link #getTabs tabs}. * * * @returns Reference to `this` in order to allow method chaining */ insertTab( /** * The tab to insert; if empty, nothing is inserted */ oTab: Tab, /** * The `0`-based index the tab should be inserted at; for a negative value of `iIndex`, the tab is inserted * at position 0; for a value greater than the current size of the aggregation, the tab is inserted at the * last position */ iIndex: int ): this; /** * Called before the rendering of the control is started. */ onBeforeRendering(): void; /** * Removes all the controls from the aggregation {@link #getTabs tabs}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllTabs(): Tab[]; /** * Removes a tab from the aggregation {@link #getTabs tabs}. * * * @returns The removed tab or `null` */ removeTab( /** * The tab to remove or its index or id */ vTab: int | string | Tab ): Tab | null; /** * Sets whether tab reordering is enabled. * * * @returns Pointer to the control instance for chaining. */ setEnableTabReordering( /** * The value. */ bValue: boolean ): this; /** * Sets a new value for property {@link #getHeight height}. * * Specifies the height of the tab bar and content area. * * 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 */ setHeight( /** * New value for property `height` */ sHeight?: CSSSize ): this; /** * Sets a new value for property {@link #getSelectedIndex selectedIndex}. * * Specifies the index of the currently selected tab. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setSelectedIndex( /** * New value for property `selectedIndex` */ iSelectedIndex?: int ): this; /** * Sets a new value for property {@link #getWidth width}. * * Specifies the width of the bar and content area. * * 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 */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; } /** * Describes the settings that can be provided to the TabStrip constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.TabContainer` control. */ export interface $TabStripSettings extends $ControlSettings { /** * Specifies the height of the tab bar and content area. */ height?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Specifies the width of the bar and content area. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Specifies the index of the currently selected tab. */ selectedIndex?: int | PropertyBindingInfo | `{${string}}`; /** * Specifies whether tab reordering is enabled. */ enableTabReordering?: boolean | PropertyBindingInfo | `{${string}}`; /** * The tabs contained in the TabStrip. */ tabs?: Tab[] | Tab | AggregationBindingInfo | `{${string}}`; /** * Fires when the user selects a tab. */ select?: (oEvent: TabStrip$SelectEvent) => void; /** * Fires when the user closes a tab. */ close?: (oEvent: TabStrip$CloseEvent) => void; } /** * Parameters of the TabStrip#close event. */ export interface TabStrip$CloseEventParameters { /** * The index of the closed tab. */ index?: int; } /** * Event object of the TabStrip#close event. */ export type TabStrip$CloseEvent = Event< TabStrip$CloseEventParameters, TabStrip >; /** * Parameters of the TabStrip#select event. */ export interface TabStrip$SelectEventParameters { /** * The index of the selected tab. */ index?: int; } /** * Event object of the TabStrip#select event. */ export type TabStrip$SelectEvent = Event< TabStrip$SelectEventParameters, TabStrip >; } declare module "sap/ui/commons/TextArea" { import { default as TextField, $TextFieldSettings, } from "sap/ui/commons/TextField"; import { CSSSize, Wrapping } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * Control to enter or display multible row text. * * @deprecated As of version 1.38. Instead, use the `sap.m.TextArea` control. */ export default class TextArea extends TextField { /** * Constructor for a new TextArea. * * 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?: $TextAreaSettings ); /** * Constructor for a new TextArea. * * 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?: $TextAreaSettings ); /** * Creates a new subclass of class sap.ui.commons.TextArea with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.commons.TextField.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.ui.commons.TextArea. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Gets current value of property {@link #getCols cols}. * * Number of Columns. Cols means number of characters per row. This proprty is only used if Width is not * used. * * * @returns Value of property `cols` */ getCols(): int; /** * Gets current value of property {@link #getCursorPos cursorPos}. * * Position of cursor, e.g., to let the user re-start typing at the same position as before the server roundtrip * * * @returns Value of property `cursorPos` */ getCursorPos(): int; /** * Gets current value of property {@link #getExplanation explanation}. * * text which appears, in case quick-help is switched on * * * @returns Value of property `explanation` */ getExplanation(): string; /** * Gets current value of property {@link #getHeight height}. * * Height of text field. When it is set (CSS-size such as % or px), this is the exact size. * * * @returns Value of property `height` */ getHeight(): CSSSize; /** * Gets current value of property {@link #getLabeledBy labeledBy}. * * ID of label control * * @deprecated As of version 1.5.2. Please use association AriaLabelledBy instead. * * @returns Value of property `labeledBy` */ getLabeledBy(): string; /** * Gets current value of property {@link #getRows rows}. * * Number of Rows. This proprty is only used if Height is not used. * * * @returns Value of property `rows` */ getRows(): int; /** * Gets current value of property {@link #getWrapping wrapping}. * * Text wrapping. Possible values are: Soft, Hard, Off. * * * @returns Value of property `wrapping` */ getWrapping(): Wrapping; /** * Sets a new value for property {@link #getCols cols}. * * Number of Columns. Cols means number of characters per row. This proprty is only used if Width is not * used. * * 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 */ setCols( /** * New value for property `cols` */ iCols?: int ): this; /** * Property setter for the cursor position * * * @returns `this` to allow method chaining */ setCursorPos( /** * cursor position */ iCursorPos: int ): this; /** * Sets a new value for property {@link #getExplanation explanation}. * * text which appears, in case quick-help is switched on * * 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 */ setExplanation( /** * New value for property `explanation` */ sExplanation?: string ): this; /** * Sets a new value for property {@link #getHeight height}. * * Height of text field. When it is set (CSS-size such as % or px), this is the exact size. * * 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 */ setHeight( /** * New value for property `height` */ sHeight?: CSSSize ): this; /** * Sets a new value for property {@link #getLabeledBy labeledBy}. * * ID of label control * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @deprecated As of version 1.5.2. Please use association AriaLabelledBy instead. * * @returns Reference to `this` in order to allow method chaining */ setLabeledBy( /** * New value for property `labeledBy` */ sLabeledBy?: string ): this; /** * Property setter for MaxLength * * * @returns `this` to allow method chaining */ setMaxLength( /** * maximal length of text */ iMaxLength: int ): this; /** * Sets a new value for property {@link #getRows rows}. * * Number of Rows. This proprty is only used if Height is not used. * * 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 */ setRows( /** * New value for property `rows` */ iRows?: int ): this; /** * Sets a new value for property {@link #getWrapping wrapping}. * * Text wrapping. Possible values are: Soft, Hard, Off. * * 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 */ setWrapping( /** * New value for property `wrapping` */ sWrapping?: Wrapping | keyof typeof Wrapping ): this; } /** * Describes the settings that can be provided to the TextArea constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.TextArea` control. */ export interface $TextAreaSettings extends $TextFieldSettings { /** * Height of text field. When it is set (CSS-size such as % or px), this is the exact size. */ height?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Number of Columns. Cols means number of characters per row. This proprty is only used if Width is not * used. */ cols?: int | PropertyBindingInfo | `{${string}}`; /** * Number of Rows. This proprty is only used if Height is not used. */ rows?: int | PropertyBindingInfo | `{${string}}`; /** * Text wrapping. Possible values are: Soft, Hard, Off. */ wrapping?: | (Wrapping | keyof typeof Wrapping) | PropertyBindingInfo | `{${string}}`; /** * Position of cursor, e.g., to let the user re-start typing at the same position as before the server roundtrip */ cursorPos?: int | PropertyBindingInfo | `{${string}}`; /** * text which appears, in case quick-help is switched on */ explanation?: string | PropertyBindingInfo; /** * ID of label control * * @deprecated As of version 1.5.2. Please use association AriaLabelledBy instead. */ labeledBy?: string | PropertyBindingInfo; } } declare module "sap/ui/commons/TextView" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { ToolbarItem, TextViewDesign, TextViewColor, } from "sap/ui/commons/library"; import { IFormContent, ID, AccessibilityInfo, AccessibleRole, TextAlign, TextDirection, CSSSize, } from "sap/ui/core/library"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * Is used to display some continous text. The control can inherit the text direction from its parent control. * * @deprecated As of version 1.38. replaced by {@link sap.m.Text}. */ export default class TextView extends Control implements ToolbarItem, IFormContent { __implements__sap_ui_commons_ToolbarItem: boolean; __implements__sap_ui_core_IFormContent: boolean; /** * Constructor for a new TextView. * * 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?: $TextViewSettings ); /** * Constructor for a new TextView. * * 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?: $TextViewSettings ); /** * Creates a new subclass of class sap.ui.commons.TextView with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.TextView. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaDescribedBy( /** * The ariaDescribedBy to add; if empty, nothing is inserted */ vAriaDescribedBy: ID | Control ): this; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaLabelledBy( /** * The ariaLabelledBy to add; if empty, nothing is inserted */ vAriaLabelledBy: ID | Control ): this; /** * Binds property {@link #getText text} to model data. * * See {@link sap.ui.base.ManagedObject#bindProperty ManagedObject.bindProperty} for a detailed description * of the possible properties of `oBindingInfo` * * * @returns Reference to `this` in order to allow method chaining */ bindText( /** * The binding information */ oBindingInfo: PropertyBindingInfo ): this; /** * See: * sap.ui.core.Control#getAccessibilityInfo * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns The accessibility info */ getAccessibilityInfo(): AccessibilityInfo; /** * Gets current value of property {@link #getAccessibleRole accessibleRole}. * * The ARIA role for the control. * * * @returns Value of property `accessibleRole` */ getAccessibleRole(): AccessibleRole; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): ID[]; /** * Gets current value of property {@link #getDesign design}. * * Defines the visual appearance of the control. * * Default value is `Standard`. * * * @returns Value of property `design` */ getDesign(): TextViewDesign; /** * Gets current value of property {@link #getEnabled enabled}. * * Switches the enabled state of the control. When the control is disabled, it is greyed out and no longer * focusable. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getHelpId helpId}. * * Unique identifier used for help services. * * Default value is `empty string`. * * * @returns Value of property `helpId` */ getHelpId(): string; /** * Gets current value of property {@link #getSemanticColor semanticColor}. * * Semantic color of the text View * * Default value is `Default`. * * * @returns Value of property `semanticColor` */ getSemanticColor(): TextViewColor; /** * Gets current value of property {@link #getText text}. * * Text to be displayed. * * Default value is `empty string`. * * * @returns Value of property `text` */ getText(): string; /** * Gets current value of property {@link #getTextAlign textAlign}. * * Sets the horizontal alignment of the text. * * Default value is `Begin`. * * * @returns Value of property `textAlign` */ getTextAlign(): TextAlign; /** * Gets current value of property {@link #getTextDirection textDirection}. * * Determines the text directionality. Available options are LTR and RTL. Alternatively, the control can * inherit the text direction from its parent control. * * Default value is `Inherit`. * * * @returns Value of property `textDirection` */ getTextDirection(): TextDirection; /** * Gets current value of property {@link #getWidth width}. * * Width of the TextView * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Gets current value of property {@link #getWrapping wrapping}. * * Disabled automatic wrapping of the text. * * Default value is `true`. * * * @returns Value of property `wrapping` */ getWrapping(): boolean; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaDescribedBy(): ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): ID[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns The removed ariaDescribedBy or `null` */ removeAriaDescribedBy( /** * The ariaDescribedBy to be removed or its index or ID */ vAriaDescribedBy: int | ID | Control ): ID | null; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns The removed ariaLabelledBy or `null` */ removeAriaLabelledBy( /** * The ariaLabelledBy to be removed or its index or ID */ vAriaLabelledBy: int | ID | Control ): ID | null; /** * Sets a new value for property {@link #getAccessibleRole accessibleRole}. * * The ARIA role for 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 */ setAccessibleRole( /** * New value for property `accessibleRole` */ sAccessibleRole: AccessibleRole | keyof typeof AccessibleRole ): this; /** * Sets a new value for property {@link #getDesign design}. * * Defines the visual appearance of the control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Standard`. * * * @returns Reference to `this` in order to allow method chaining */ setDesign( /** * New value for property `design` */ sDesign?: TextViewDesign | keyof typeof TextViewDesign ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * Switches the enabled state of the control. When the control is disabled, it is greyed out and no longer * focusable. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getHelpId helpId}. * * Unique identifier used for help services. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setHelpId( /** * New value for property `helpId` */ sHelpId?: string ): this; /** * Sets a new value for property {@link #getSemanticColor semanticColor}. * * Semantic color of the text View * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Default`. * * * @returns Reference to `this` in order to allow method chaining */ setSemanticColor( /** * New value for property `semanticColor` */ sSemanticColor?: TextViewColor | keyof typeof TextViewColor ): this; /** * Sets a new value for property {@link #getText text}. * * Text to be displayed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setText( /** * New value for property `text` */ sText?: string ): this; /** * Sets a new value for property {@link #getTextAlign textAlign}. * * Sets the horizontal alignment of the text. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Begin`. * * * @returns Reference to `this` in order to allow method chaining */ setTextAlign( /** * New value for property `textAlign` */ sTextAlign?: TextAlign | keyof typeof TextAlign ): this; /** * Sets a new value for property {@link #getTextDirection textDirection}. * * Determines the text directionality. Available options are LTR and RTL. Alternatively, the control can * inherit the text direction from its parent control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Inherit`. * * * @returns Reference to `this` in order to allow method chaining */ setTextDirection( /** * New value for property `textDirection` */ sTextDirection?: TextDirection | keyof typeof TextDirection ): this; /** * Sets a new value for property {@link #getWidth width}. * * Width of the TextView * * 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 */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; /** * Sets a new value for property {@link #getWrapping wrapping}. * * Disabled automatic wrapping of the text. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setWrapping( /** * New value for property `wrapping` */ bWrapping?: boolean ): this; /** * Unbinds property {@link #getText text} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindText(): this; } /** * Describes the settings that can be provided to the TextView constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.Text}. */ export interface $TextViewSettings extends $ControlSettings { /** * Text to be displayed. */ text?: string | PropertyBindingInfo; /** * Determines the text directionality. Available options are LTR and RTL. Alternatively, the control can * inherit the text direction from its parent control. */ textDirection?: | (TextDirection | keyof typeof TextDirection) | PropertyBindingInfo | `{${string}}`; /** * Switches the enabled state of the control. When the control is disabled, it is greyed out and no longer * focusable. */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * Unique identifier used for help services. */ helpId?: string | PropertyBindingInfo; /** * The ARIA role for the control. */ accessibleRole?: | (AccessibleRole | keyof typeof AccessibleRole) | PropertyBindingInfo | `{${string}}`; /** * Defines the visual appearance of the control. */ design?: | (TextViewDesign | keyof typeof TextViewDesign) | PropertyBindingInfo | `{${string}}`; /** * Disabled automatic wrapping of the text. */ wrapping?: boolean | PropertyBindingInfo | `{${string}}`; /** * Semantic color of the text View */ semanticColor?: | (TextViewColor | keyof typeof TextViewColor) | PropertyBindingInfo | `{${string}}`; /** * Sets the horizontal alignment of the text. */ textAlign?: | (TextAlign | keyof typeof TextAlign) | PropertyBindingInfo | `{${string}}`; /** * Width of the TextView */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Association to controls / IDs which describe this control (see WAI-ARIA attribute aria-describedby). */ ariaDescribedBy?: Array; /** * Association to controls / IDs which label this control (see WAI-ARIA attribute aria-labelledby). */ ariaLabelledBy?: Array; } } declare module "sap/ui/commons/Title" { import { default as Title1, $TitleSettings as $TitleSettings1, } from "sap/ui/core/Title"; import { TitleLevel } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; /** * Represents a title element that can be used for aggregation with other controls * * @deprecated As of version 1.16.0. moved to sap.ui.core library. Please use this one. */ export default class Title extends Title1 { /** * Constructor for a new Title. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Title#constructor sap.ui.core.Title } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: $TitleSettings ); /** * Constructor for a new Title. * * 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. * * This class does not have its own settings, but all settings applicable to the base type {@link sap.ui.core.Title#constructor sap.ui.core.Title } * can be used. */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: $TitleSettings ); /** * Creates a new subclass of class sap.ui.commons.Title with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Title.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.ui.commons.Title. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Getter for property `level`. Defines the level of the title. If set to auto the level of the title is * chosen by the control rendering the title. * * Currently not all controls using the Title.control supporting this property. * * Default value is `Auto` * * @since 1.9.1 * * @returns the value of property `level` */ getLevel(): TitleLevel; /** * Setter for property `level`. * * Default value is `Auto` * * @since 1.9.1 * * @returns `this` to allow method chaining */ setLevel( /** * new value for property `level` */ oLevel: TitleLevel | keyof typeof TitleLevel ): this; } /** * Describes the settings that can be provided to the Title constructor. * * @deprecated As of version 1.16.0. moved to sap.ui.core library. Please use this one. */ export interface $TitleSettings extends $TitleSettings1 {} } declare module "sap/ui/commons/ToggleButton" { import { default as Button, $ButtonSettings } from "sap/ui/commons/Button"; import { AccessibilityInfo } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * The ToggleButton Control is a Button that can be toggled between pressed and normal state * * @deprecated As of version 1.38. replaced by {@link sap.m.ToggleButton} */ export default class ToggleButton extends Button { /** * Constructor for a new ToggleButton. * * 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?: $ToggleButtonSettings ); /** * Constructor for a new ToggleButton. * * 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?: $ToggleButtonSettings ); /** * Creates a new subclass of class sap.ui.commons.ToggleButton with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.commons.Button.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.ui.commons.ToggleButton. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * See: * sap.ui.core.Control#getAccessibilityInfo * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Current accessibility state of the control */ getAccessibilityInfo(): AccessibilityInfo; /** * Gets current value of property {@link #getPressed pressed}. * * The property is “true” when the control is toggled. The default state of this property is "false". * * Default value is `false`. * * * @returns Value of property `pressed` */ getPressed(): boolean; /** * Sets a new value for property {@link #getPressed pressed}. * * The property is “true” when the control is toggled. The default state of this property is "false". * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setPressed( /** * New value for property `pressed` */ bPressed?: boolean ): this; } /** * Describes the settings that can be provided to the ToggleButton constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.ToggleButton} */ export interface $ToggleButtonSettings extends $ButtonSettings { /** * The property is “true” when the control is toggled. The default state of this property is "false". */ pressed?: boolean | PropertyBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/Toolbar" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import { Toolbar as Toolbar1, CSSSize } from "sap/ui/core/library"; import { ToolbarItem, ToolbarDesign } from "sap/ui/commons/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; /** * A horizontal row of items where in many cases the single toolbar items are buttons containing icons. * Note that all controls with the sap.ui.commons.ToolbarItem interface can be used as item: Button, ComboBox, * TextField. * * @deprecated As of version 1.38. replaced by {@link sap.m.Toolbar} */ export default class Toolbar extends Control implements Toolbar1 { __implements__sap_ui_core_Toolbar: boolean; /** * Constructor for a new Toolbar. * * 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?: $ToolbarSettings ); /** * Constructor for a new Toolbar. * * 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?: $ToolbarSettings ); /** * Creates a new subclass of class sap.ui.commons.Toolbar with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.Toolbar. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some item to the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ addItem( /** * The item to add; if empty, nothing is inserted */ oItem: ToolbarItem ): this; /** * Adds some rightItem to the aggregation {@link #getRightItems rightItems}. * * * @returns Reference to `this` in order to allow method chaining */ addRightItem( /** * The rightItem to add; if empty, nothing is inserted */ oRightItem: ToolbarItem ): this; /** * Destroys all the items in the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ destroyItems(): this; /** * Destroys all the rightItems in the aggregation {@link #getRightItems rightItems}. * * * @returns Reference to `this` in order to allow method chaining */ destroyRightItems(): this; /** * Gets current value of property {@link #getDesign design}. * * Design settings are theme-dependent. * * Default value is `Flat`. * * * @returns Value of property `design` */ getDesign(): ToolbarDesign; /** * Gets content of aggregation {@link #getItems items}. * * Aggregating the tool bar items. */ getItems(): ToolbarItem[]; /** * Gets content of aggregation {@link #getRightItems rightItems}. * * Aggregating the right side tool bar items. */ getRightItems(): ToolbarItem[]; /** * Gets current value of property {@link #getStandalone standalone}. * * Per default, tool bars have the stand alone status. Alternatively, they can be nested in other controls * and then inherit the design from their parent control. * * Default value is `true`. * * * @returns Value of property `standalone` */ getStandalone(): boolean; /** * Gets current value of property {@link #getWidth width}. * * When there is not enough space for the toolbar to display all items, the rightmost items are overflowing * into a drop-down menu. * * Default value is `'auto'`. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Checks for the provided `sap.ui.commons.ToolbarItem` in the aggregation {@link #getItems items}. and * returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfItem( /** * The item whose index is looked for */ oItem: ToolbarItem ): int; /** * Checks for the provided `sap.ui.commons.ToolbarItem` in the aggregation {@link #getRightItems rightItems}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfRightItem( /** * The rightItem whose index is looked for */ oRightItem: ToolbarItem ): int; /** * Inserts a item into the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ insertItem( /** * The item to insert; if empty, nothing is inserted */ oItem: ToolbarItem, /** * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted * at position 0; for a value greater than the current size of the aggregation, the item is inserted at * the last position */ iIndex: int ): this; /** * Inserts a rightItem into the aggregation {@link #getRightItems rightItems}. * * * @returns Reference to `this` in order to allow method chaining */ insertRightItem( /** * The rightItem to insert; if empty, nothing is inserted */ oRightItem: ToolbarItem, /** * The `0`-based index the rightItem should be inserted at; for a negative value of `iIndex`, the rightItem * is inserted at position 0; for a value greater than the current size of the aggregation, the rightItem * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getItems items}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllItems(): ToolbarItem[]; /** * Removes all the controls from the aggregation {@link #getRightItems rightItems}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllRightItems(): ToolbarItem[]; /** * Removes a item from the aggregation {@link #getItems items}. * * * @returns The removed item or `null` */ removeItem( /** * The item to remove or its index or id */ vItem: int | string | ToolbarItem ): ToolbarItem | null; /** * Removes a rightItem from the aggregation {@link #getRightItems rightItems}. * * * @returns The removed rightItem or `null` */ removeRightItem( /** * The rightItem to remove or its index or id */ vRightItem: int | string | ToolbarItem ): ToolbarItem | null; /** * Sets a new value for property {@link #getDesign design}. * * Design settings are theme-dependent. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Flat`. * * * @returns Reference to `this` in order to allow method chaining */ setDesign( /** * New value for property `design` */ sDesign?: ToolbarDesign | keyof typeof ToolbarDesign ): this; /** * Sets a new value for property {@link #getStandalone standalone}. * * Per default, tool bars have the stand alone status. Alternatively, they can be nested in other controls * and then inherit the design from their parent control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setStandalone( /** * New value for property `standalone` */ bStandalone?: boolean ): this; /** * Sets a new value for property {@link #getWidth width}. * * When there is not enough space for the toolbar to display all items, the rightmost items are overflowing * into a drop-down menu. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'auto'`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; } /** * Describes the settings that can be provided to the Toolbar constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.Toolbar} */ export interface $ToolbarSettings extends $ControlSettings { /** * When there is not enough space for the toolbar to display all items, the rightmost items are overflowing * into a drop-down menu. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Design settings are theme-dependent. */ design?: | (ToolbarDesign | keyof typeof ToolbarDesign) | PropertyBindingInfo | `{${string}}`; /** * Per default, tool bars have the stand alone status. Alternatively, they can be nested in other controls * and then inherit the design from their parent control. */ standalone?: boolean | PropertyBindingInfo | `{${string}}`; /** * Aggregating the tool bar items. */ items?: | ToolbarItem[] | ToolbarItem | AggregationBindingInfo | `{${string}}`; /** * Aggregating the right side tool bar items. */ rightItems?: | ToolbarItem[] | ToolbarItem | AggregationBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/ToolbarSeparator" { import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element"; import { ToolbarItem, ToolbarSeparatorDesign } from "sap/ui/commons/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * A small vertical line that is generally added to the tool bar between the items to visually separate * them. * * @deprecated As of version 1.38. Instead, use the `sap.m.Toolbar` control. */ export default class ToolbarSeparator extends UI5Element implements ToolbarItem { __implements__sap_ui_commons_ToolbarItem: boolean; /** * Constructor for a new ToolbarSeparator. * * 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?: $ToolbarSeparatorSettings ); /** * Constructor for a new ToolbarSeparator. * * 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?: $ToolbarSeparatorSettings ); /** * Creates a new subclass of class sap.ui.commons.ToolbarSeparator with name `sClassName` and enriches it * with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @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.ui.commons.ToolbarSeparator. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Gets current value of property {@link #getDesign design}. * * Design of the Separator. * * * @returns Value of property `design` */ getDesign(): ToolbarSeparatorDesign; /** * Gets current value of property {@link #getDisplayVisualSeparator displayVisualSeparator}. * * When set to false, there is no visual indication of separation by a vertical line but by a wider space. * * Default value is `true`. * * * @returns Value of property `displayVisualSeparator` */ getDisplayVisualSeparator(): boolean; /** * Sets a new value for property {@link #getDesign design}. * * Design of the Separator. * * 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 */ setDesign( /** * New value for property `design` */ sDesign?: ToolbarSeparatorDesign | keyof typeof ToolbarSeparatorDesign ): this; /** * Sets a new value for property {@link #getDisplayVisualSeparator displayVisualSeparator}. * * When set to false, there is no visual indication of separation by a vertical line but by a wider space. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setDisplayVisualSeparator( /** * New value for property `displayVisualSeparator` */ bDisplayVisualSeparator?: boolean ): this; } /** * Describes the settings that can be provided to the ToolbarSeparator constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.Toolbar` control. */ export interface $ToolbarSeparatorSettings extends $ElementSettings { /** * When set to false, there is no visual indication of separation by a vertical line but by a wider space. */ displayVisualSeparator?: boolean | PropertyBindingInfo | `{${string}}`; /** * Design of the Separator. */ design?: | (ToolbarSeparatorDesign | keyof typeof ToolbarSeparatorDesign) | PropertyBindingInfo | `{${string}}`; } } declare module "sap/ui/commons/Tree" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import TreeNode from "sap/ui/commons/TreeNode"; import { AggregationBindingInfo, PropertyBindingInfo, } from "sap/ui/base/ManagedObject"; import { CSSSize } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import Context from "sap/ui/model/Context"; import { TreeSelectionMode } from "sap/ui/commons/library"; import Event from "sap/ui/base/Event"; /** * Simple tree to display item in a hierarchical way * * @deprecated As of version 1.38. replaced by {@link sap.m.Tree} */ export default class Tree extends Control { /** * Constructor for a new Tree. * * 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?: $TreeSettings ); /** * Constructor for a new Tree. * * 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?: $TreeSettings ); /** * Creates a new subclass of class sap.ui.commons.Tree with name `sClassName` and enriches it with the information * contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.Tree. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some node to the aggregation {@link #getNodes nodes}. * * * @returns Reference to `this` in order to allow method chaining */ addNode( /** * The node to add; if empty, nothing is inserted */ oNode: TreeNode ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.commons.Tree`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Tree` itself. * * Event is fired when a tree node is selected. * * * @returns Reference to `this` in order to allow method chaining */ attachSelect( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Tree$SelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.commons.Tree`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Tree` itself. * * Event is fired when a tree node is selected. * * * @returns Reference to `this` in order to allow method chaining */ attachSelect( /** * The function to be called when the event occurs */ fnFunction: (p1: Tree$SelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this * `sap.ui.commons.Tree`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Tree` itself. * * fired when the selection of the tree has been changed * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Tree$SelectionChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Tree` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this * `sap.ui.commons.Tree`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.Tree` itself. * * fired when the selection of the tree has been changed * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChange( /** * The function to be called when the event occurs */ fnFunction: (p1: Tree$SelectionChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.Tree` itself */ oListener?: object ): this; /** * Binds aggregation {@link #getNodes nodes} to model data. * * See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description * of the possible properties of `oBindingInfo`. * * * @returns Reference to `this` in order to allow method chaining */ bindNodes( /** * The binding information */ oBindingInfo: AggregationBindingInfo ): this; /** * Collapses all nodes in the tree. */ collapseAll(): void; /** * Destroys all the nodes in the aggregation {@link #getNodes nodes}. * * * @returns Reference to `this` in order to allow method chaining */ destroyNodes(): this; /** * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.ui.commons.Tree`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSelect( /** * The function to be called, when the event occurs */ fnFunction: (p1: Tree$SelectEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:selectionChange selectionChange} event of * this `sap.ui.commons.Tree`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSelectionChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: Tree$SelectionChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Expands all nodes in the tree. */ expandAll(): void; /** * Fires event {@link #event:select select} to attached listeners. * * Listeners may prevent the default action of this event by calling the `preventDefault` method on the * event object. The return value of this method indicates whether the default action should be executed. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Whether or not to prevent the default action */ fireSelect( /** * Parameters to pass along with the event */ mParameters?: Tree$SelectEventParameters ): boolean; /** * Fires event {@link #event:selectionChange selectionChange} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSelectionChange( /** * Parameters to pass along with the event */ mParameters?: Tree$SelectionChangeEventParameters ): this; /** * Gets current value of property {@link #getHeight height}. * * Tree height * * Default value is `'auto'`. * * * @returns Value of property `height` */ getHeight(): CSSSize; /** * Gets current value of property {@link #getMinWidth minWidth}. * * Minimal width for the Tree. Can be useful when, for example, the width is specified in percentage, to * avoid the tree to become too narrow when container is resize * * * @returns Value of property `minWidth` */ getMinWidth(): CSSSize; /** * Returns the node with the given context, or null if no such node currently exists. * * @since 1.19 * * @returns The found tree node */ getNodeByContext( /** * The context of the node to be retrieved */ oContext: Context ): TreeNode; /** * Gets content of aggregation {@link #getNodes nodes}. * * First level nodes */ getNodes(): TreeNode[]; /** * Gets current value of property {@link #getSelectionMode selectionMode}. * * Selection mode of the Tree. * * Default value is `Legacy`. * * * @returns Value of property `selectionMode` */ getSelectionMode(): TreeSelectionMode; /** * Gets current value of property {@link #getShowHeader showHeader}. * * Tree Header is display. If false, the tree will be in a transparent mode * * Default value is `true`. * * * @returns Value of property `showHeader` */ getShowHeader(): boolean; /** * Gets current value of property {@link #getShowHeaderIcons showHeaderIcons}. * * Show Header icons (e.g. Expand/Collapse all). Only consider if showHeader is true * * Default value is `true`. * * * @returns Value of property `showHeaderIcons` */ getShowHeaderIcons(): boolean; /** * Gets current value of property {@link #getShowHorizontalScrollbar showHorizontalScrollbar}. * * Display horizontal scrollbar. If false, the overflow content will be hidden * * Default value is `false`. * * * @returns Value of property `showHorizontalScrollbar` */ getShowHorizontalScrollbar(): boolean; /** * Gets current value of property {@link #getTitle title}. * * Tree title * * * @returns Value of property `title` */ getTitle(): string; /** * Gets current value of property {@link #getWidth width}. * * Tree width * * Default value is `'auto'`. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Checks for the provided `sap.ui.commons.TreeNode` in the aggregation {@link #getNodes nodes}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfNode( /** * The node whose index is looked for */ oNode: TreeNode ): int; /** * Inserts a node into the aggregation {@link #getNodes nodes}. * * * @returns Reference to `this` in order to allow method chaining */ insertNode( /** * The node to insert; if empty, nothing is inserted */ oNode: TreeNode, /** * The `0`-based index the node should be inserted at; for a negative value of `iIndex`, the node is inserted * at position 0; for a value greater than the current size of the aggregation, the node is inserted at * the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getNodes nodes}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllNodes(): TreeNode[]; /** * Removes a node from the aggregation {@link #getNodes nodes}. * * * @returns The removed node or `null` */ removeNode( /** * The node to remove or its index or id */ vNode: int | string | TreeNode ): TreeNode | null; /** * Sets a new value for property {@link #getHeight height}. * * Tree height * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'auto'`. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ sHeight?: CSSSize ): this; /** * Sets a new value for property {@link #getMinWidth minWidth}. * * Minimal width for the Tree. Can be useful when, for example, the width is specified in percentage, to * avoid the tree to become too narrow when container is resize * * 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 */ setMinWidth( /** * New value for property `minWidth` */ sMinWidth?: CSSSize ): this; /** * Sets a new value for property {@link #getSelectionMode selectionMode}. * * Selection mode of the Tree. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Legacy`. * * * @returns Reference to `this` in order to allow method chaining */ setSelectionMode( /** * New value for property `selectionMode` */ sSelectionMode?: TreeSelectionMode | keyof typeof TreeSelectionMode ): this; /** * Sets a new value for property {@link #getShowHeader showHeader}. * * Tree Header is display. If false, the tree will be in a transparent mode * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowHeader( /** * New value for property `showHeader` */ bShowHeader?: boolean ): this; /** * Sets a new value for property {@link #getShowHeaderIcons showHeaderIcons}. * * Show Header icons (e.g. Expand/Collapse all). Only consider if showHeader is true * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowHeaderIcons( /** * New value for property `showHeaderIcons` */ bShowHeaderIcons?: boolean ): this; /** * Sets a new value for property {@link #getShowHorizontalScrollbar showHorizontalScrollbar}. * * Display horizontal scrollbar. If false, the overflow content will be hidden * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShowHorizontalScrollbar( /** * New value for property `showHorizontalScrollbar` */ bShowHorizontalScrollbar?: boolean ): this; /** * Sets a new value for property {@link #getTitle title}. * * Tree title * * 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 */ setTitle( /** * New value for property `title` */ sTitle?: string ): this; /** * Sets a new value for property {@link #getWidth width}. * * Tree width * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'auto'`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; /** * Unbinds aggregation {@link #getNodes nodes} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindNodes(): this; } /** * Describes the settings that can be provided to the Tree constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.Tree} */ export interface $TreeSettings extends $ControlSettings { /** * Tree title */ title?: string | PropertyBindingInfo; /** * Tree width */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Tree height */ height?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Tree Header is display. If false, the tree will be in a transparent mode */ showHeader?: boolean | PropertyBindingInfo | `{${string}}`; /** * Show Header icons (e.g. Expand/Collapse all). Only consider if showHeader is true */ showHeaderIcons?: boolean | PropertyBindingInfo | `{${string}}`; /** * Display horizontal scrollbar. If false, the overflow content will be hidden */ showHorizontalScrollbar?: boolean | PropertyBindingInfo | `{${string}}`; /** * Minimal width for the Tree. Can be useful when, for example, the width is specified in percentage, to * avoid the tree to become too narrow when container is resize */ minWidth?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * Selection mode of the Tree. */ selectionMode?: | (TreeSelectionMode | keyof typeof TreeSelectionMode) | PropertyBindingInfo | `{${string}}`; /** * First level nodes */ nodes?: TreeNode[] | TreeNode | AggregationBindingInfo | `{${string}}`; /** * Event is fired when a tree node is selected. */ select?: (oEvent: Tree$SelectEvent) => void; /** * fired when the selection of the tree has been changed */ selectionChange?: (oEvent: Tree$SelectionChangeEvent) => void; } /** * Parameters of the Tree#select event. */ export interface Tree$SelectEventParameters { /** * The node which has been selected. */ node?: TreeNode; /** * The binding context of the selected node. */ nodeContext?: object; } /** * Event object of the Tree#select event. */ export type Tree$SelectEvent = Event; /** * Parameters of the Tree#selectionChange event. */ export interface Tree$SelectionChangeEventParameters { /** * The nodes which has been selected. */ nodes?: TreeNode[]; /** * The binding context of the selected nodes. */ nodeContexts?: object[]; } /** * Event object of the Tree#selectionChange event. */ export type Tree$SelectionChangeEvent = Event< Tree$SelectionChangeEventParameters, Tree >; } declare module "sap/ui/commons/TreeNode" { import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element"; import { ID, URI } from "sap/ui/core/library"; import Control from "sap/ui/core/Control"; import Event from "sap/ui/base/Event"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo, AggregationBindingInfo, } from "sap/ui/base/ManagedObject"; /** * Tree node element * * @deprecated As of version 1.38. replaced by {@link sap.m.Tree} */ export default class TreeNode extends UI5Element { /** * Constructor for a new TreeNode. * * 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?: $TreeNodeSettings ); /** * Constructor for a new TreeNode. * * 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?: $TreeNodeSettings ); /** * Creates a new subclass of class sap.ui.commons.TreeNode with name `sClassName` and enriches it with the * information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @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.ui.commons.TreeNode. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaDescribedBy( /** * The ariaDescribedBy to add; if empty, nothing is inserted */ vAriaDescribedBy: ID | Control ): this; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns Reference to `this` in order to allow method chaining */ addAriaLabelledBy( /** * The ariaLabelledBy to add; if empty, nothing is inserted */ vAriaLabelledBy: ID | Control ): this; /** * Adds some node to the aggregation {@link #getNodes nodes}. * * * @returns Reference to `this` in order to allow method chaining */ addNode( /** * The node to add; if empty, nothing is inserted */ oNode: TreeNode ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selected selected} event of this `sap.ui.commons.TreeNode`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.TreeNode` itself. * * Node is selected * * * @returns Reference to `this` in order to allow method chaining */ attachSelected( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.TreeNode` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selected selected} event of this `sap.ui.commons.TreeNode`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.TreeNode` itself. * * Node is selected * * * @returns Reference to `this` in order to allow method chaining */ attachSelected( /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.TreeNode` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:toggleOpenState toggleOpenState} event of this * `sap.ui.commons.TreeNode`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.TreeNode` itself. * * Node state has changed. * * * @returns Reference to `this` in order to allow method chaining */ attachToggleOpenState( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: TreeNode$ToggleOpenStateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.TreeNode` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:toggleOpenState toggleOpenState} event of this * `sap.ui.commons.TreeNode`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.TreeNode` itself. * * Node state has changed. * * * @returns Reference to `this` in order to allow method chaining */ attachToggleOpenState( /** * The function to be called when the event occurs */ fnFunction: (p1: TreeNode$ToggleOpenStateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.TreeNode` itself */ oListener?: object ): this; /** * Collapses the node. */ collapse( /** * Propagates collapse to node's children */ bCollapseChildren: boolean, /** * Disables the collapse finished handler */ bDisableCollapseFinishedHandler: boolean ): void; /** * Destroys all the nodes in the aggregation {@link #getNodes nodes}. * * * @returns Reference to `this` in order to allow method chaining */ destroyNodes(): this; /** * Detaches event handler `fnFunction` from the {@link #event:selected selected} event of this `sap.ui.commons.TreeNode`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSelected( /** * The function to be called, when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:toggleOpenState toggleOpenState} event of * this `sap.ui.commons.TreeNode`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachToggleOpenState( /** * The function to be called, when the event occurs */ fnFunction: (p1: TreeNode$ToggleOpenStateEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Expands the node. */ expand( /** * Propagates expand to node's children */ bExpandChildren: boolean, /** * Disables the expand finished handler */ bDisableExpandFinishedHandler: boolean ): void; /** * Fires event {@link #event:selected selected} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSelected( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:toggleOpenState toggleOpenState} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireToggleOpenState( /** * Parameters to pass along with the event */ mParameters?: TreeNode$ToggleOpenStateEventParameters ): this; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): ID[]; /** * Gets current value of property {@link #getExpanded expanded}. * * Node is expanded * * Default value is `true`. * * * @returns Value of property `expanded` */ getExpanded(): boolean; /** * Gets current value of property {@link #getHasExpander hasExpander}. * * Should the node has an expander. * * Default value is `false`. * * * @returns Value of property `hasExpander` */ getHasExpander(): boolean; /** * Gets current value of property {@link #getIcon icon}. * * Icon to display in front of the node * * * @returns Value of property `icon` */ getIcon(): URI; /** * Gets current value of property {@link #getIsSelected isSelected}. * * Node is selected * * Default value is `false`. * * * @returns Value of property `isSelected` */ getIsSelected(): boolean; /** * Gets content of aggregation {@link #getNodes nodes}. * * Subnodes for the current node */ getNodes(): TreeNode[]; /** * Gets current value of property {@link #getSelectable selectable}. * * The node is selectable. If true, clicking on the node text triggers "selected" event * * Default value is `true`. * * * @returns Value of property `selectable` */ getSelectable(): boolean; /** * Gets current value of property {@link #getText text}. * * Node text * * * @returns Value of property `text` */ getText(): string; /** * Checks for the provided `sap.ui.commons.TreeNode` in the aggregation {@link #getNodes nodes}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfNode( /** * The node whose index is looked for */ oNode: TreeNode ): int; /** * Inserts a node into the aggregation {@link #getNodes nodes}. * * * @returns Reference to `this` in order to allow method chaining */ insertNode( /** * The node to insert; if empty, nothing is inserted */ oNode: TreeNode, /** * The `0`-based index the node should be inserted at; for a negative value of `iIndex`, the node is inserted * at position 0; for a value greater than the current size of the aggregation, the node is inserted at * the last position */ iIndex: int ): this; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaDescribedBy(): ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): ID[]; /** * Removes all the controls from the aggregation {@link #getNodes nodes}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllNodes(): TreeNode[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * * @returns The removed ariaDescribedBy or `null` */ removeAriaDescribedBy( /** * The ariaDescribedBy to be removed or its index or ID */ vAriaDescribedBy: int | ID | Control ): ID | null; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns The removed ariaLabelledBy or `null` */ removeAriaLabelledBy( /** * The ariaLabelledBy to be removed or its index or ID */ vAriaLabelledBy: int | ID | Control ): ID | null; /** * Removes a node from the aggregation {@link #getNodes nodes}. * * * @returns The removed node or `null` */ removeNode( /** * The node to remove or its index or id */ vNode: int | string | TreeNode ): TreeNode | null; /** * Select the node, and if any, deselects the previously selected node */ select(bSuppressEvent: boolean): void; /** * Sets a new value for property {@link #getExpanded expanded}. * * Node is expanded * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setExpanded( /** * New value for property `expanded` */ bExpanded?: boolean ): this; /** * Sets a new value for property {@link #getHasExpander hasExpander}. * * Should the node has an expander. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setHasExpander( /** * New value for property `hasExpander` */ bHasExpander?: boolean ): this; /** * Sets a new value for property {@link #getIcon icon}. * * Icon to display in front of the node * * 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 */ setIcon( /** * New value for property `icon` */ sIcon?: URI ): this; /** * Redefinition of Setter for property `isSelected` for validation purpose * * Default value is empty/`undefined` * * * @returns `this` to allow method chaining */ setIsSelected( /** * new value for property `isSelected` */ bIsSelected: boolean ): this; /** * Redefinition of Setter for property `selectable` for validation purpose. * * Default value is `true` * * * @returns `this` to allow method chaining */ setSelectable( /** * new value for property `selectable` */ bSelectable: boolean ): this; /** * Sets a new value for property {@link #getText text}. * * Node text * * 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 TreeNode constructor. * * @deprecated As of version 1.38. replaced by {@link sap.m.Tree} */ export interface $TreeNodeSettings extends $ElementSettings { /** * Node text */ text?: string | PropertyBindingInfo; /** * Node is expanded */ expanded?: boolean | PropertyBindingInfo | `{${string}}`; /** * Should the node has an expander. */ hasExpander?: boolean | PropertyBindingInfo | `{${string}}`; /** * Icon to display in front of the node */ icon?: URI | PropertyBindingInfo | `{${string}}`; /** * Node is selected */ isSelected?: boolean | PropertyBindingInfo | `{${string}}`; /** * The node is selectable. If true, clicking on the node text triggers "selected" event */ selectable?: boolean | PropertyBindingInfo | `{${string}}`; /** * Subnodes for the current node */ nodes?: TreeNode[] | TreeNode | AggregationBindingInfo | `{${string}}`; /** * Association to controls / ids which describe this control (see WAI-ARIA attribute aria-describedby). */ ariaDescribedBy?: Array; /** * Association to controls / ids which label this control (see WAI-ARIA attribute aria-labelledby). */ ariaLabelledBy?: Array; /** * Node state has changed. */ toggleOpenState?: (oEvent: TreeNode$ToggleOpenStateEvent) => void; /** * Node is selected */ selected?: (oEvent: Event) => void; } /** * Parameters of the TreeNode#selected event. */ export interface TreeNode$SelectedEventParameters {} /** * Event object of the TreeNode#selected event. */ export type TreeNode$SelectedEvent = Event< TreeNode$SelectedEventParameters, TreeNode >; /** * Parameters of the TreeNode#toggleOpenState event. */ export interface TreeNode$ToggleOpenStateEventParameters { /** * Node has been opened if true */ opened?: boolean; } /** * Event object of the TreeNode#toggleOpenState event. */ export type TreeNode$ToggleOpenStateEvent = Event< TreeNode$ToggleOpenStateEventParameters, TreeNode >; } declare module "sap/ui/commons/TriStateCheckBox" { import { default as Control, $ControlSettings } from "sap/ui/core/Control"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { TriStateCheckBoxState } from "sap/ui/commons/library"; import { TextDirection, ValueState, CSSSize } from "sap/ui/core/library"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; import Event from "sap/ui/base/Event"; /** * TriStateCheckBox to reflect mixed state for checkboxes. The control can display three states, namely * checked, unchecked and mixed. However, mixed state cannot be directly reached by user interaction on * the particular control. It can be only set by the control's public toggle function, to make a behaviour * possible which is e.g. required in checkbox trees. * * @since 1.7.2 * @deprecated As of version 1.38. Use {@link sap.m.CheckBox} instead. */ export default class TriStateCheckBox extends Control { /** * Constructor for a new TriStateCheckBox. * * 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?: $TriStateCheckBoxSettings ); /** * Constructor for a new TriStateCheckBox. * * 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?: $TriStateCheckBoxSettings ); /** * Creates a new subclass of class sap.ui.commons.TriStateCheckBox with name `sClassName` and enriches it * with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.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.ui.commons.TriStateCheckBox. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.commons.TriStateCheckBox`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.TriStateCheckBox` itself. * * Event is triggered when the control status is changed by the user by flagging or unflagging the checkbox. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: TriStateCheckBox$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.TriStateCheckBox` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.commons.TriStateCheckBox`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.TriStateCheckBox` itself. * * Event is triggered when the control status is changed by the user by flagging or unflagging the checkbox. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * The function to be called when the event occurs */ fnFunction: (p1: TriStateCheckBox$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.TriStateCheckBox` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.commons.TriStateCheckBox`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: TriStateCheckBox$ChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:change change} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireChange( /** * Parameters to pass along with the event */ mParameters?: TriStateCheckBox$ChangeEventParameters ): this; /** * Gets current value of property {@link #getEditable editable}. * * Specifies whether the user shall be allowed to flag the check box * * Default value is `true`. * * * @returns Value of property `editable` */ getEditable(): boolean; /** * Gets current value of property {@link #getEnabled enabled}. * * Using this property, the control could be disabled, if required. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getSelectionState selectionState}. * * Defines the states of the checkbox * * Default value is `Unchecked`. * * * @returns Value of property `selectionState` */ getSelectionState(): TriStateCheckBoxState; /** * Gets current value of property {@link #getText text}. * * Defines the text displayed next to the check box * * * @returns Value of property `text` */ getText(): string; /** * Gets current value of property {@link #getTextDirection textDirection}. * * The value can be set to LTR or RTL. Otherwise, the control inherits the text direction from its parent * control. * * Default value is `Inherit`. * * * @returns Value of property `textDirection` */ getTextDirection(): TextDirection; /** * Gets current value of property {@link #getValueState valueState}. * * Accepts the core enumeration ValueState.type that supports 'None', 'Error', 'Warning' and 'Success'. * * Default value is `None`. * * * @returns Value of property `valueState` */ getValueState(): ValueState; /** * Gets current value of property {@link #getWidth width}. * * The width can be set to an absolute value. If no value is set, the control width results from the text * length. * * * @returns Value of property `width` */ getWidth(): CSSSize; /** * Sets a new value for property {@link #getEditable editable}. * * Specifies whether the user shall be allowed to flag the check box * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEditable( /** * New value for property `editable` */ bEditable?: boolean ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * Using this property, the control could be disabled, if required. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getSelectionState selectionState}. * * Defines the states of the checkbox * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Unchecked`. * * * @returns Reference to `this` in order to allow method chaining */ setSelectionState( /** * New value for property `selectionState` */ sSelectionState?: | TriStateCheckBoxState | keyof typeof TriStateCheckBoxState ): this; /** * Sets a new value for property {@link #getText text}. * * Defines the text displayed next to the check box * * 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; /** * Sets a new value for property {@link #getTextDirection textDirection}. * * The value can be set to LTR or RTL. Otherwise, the control inherits the text direction from its parent * control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Inherit`. * * * @returns Reference to `this` in order to allow method chaining */ setTextDirection( /** * New value for property `textDirection` */ sTextDirection?: TextDirection | keyof typeof TextDirection ): this; /** * Sets a new value for property {@link #getValueState valueState}. * * Accepts the core enumeration ValueState.type that supports 'None', 'Error', 'Warning' and 'Success'. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `None`. * * * @returns Reference to `this` in order to allow method chaining */ setValueState( /** * New value for property `valueState` */ sValueState?: ValueState | keyof typeof ValueState ): this; /** * Sets a new value for property {@link #getWidth width}. * * The width can be set to an absolute value. If no value is set, the control width results from the text * length. * * 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 */ setWidth( /** * New value for property `width` */ sWidth?: CSSSize ): this; /** * Method called whenever a user clicks on a tri-state checkbox */ toggle( /** * destined selection state of checkbox */ destState: TriStateCheckBoxState | keyof typeof TriStateCheckBoxState ): void; } /** * Describes the settings that can be provided to the TriStateCheckBox constructor. * * @deprecated As of version 1.38. Use {@link sap.m.CheckBox} instead. */ export interface $TriStateCheckBoxSettings extends $ControlSettings { /** * Defines the states of the checkbox */ selectionState?: | (TriStateCheckBoxState | keyof typeof TriStateCheckBoxState) | PropertyBindingInfo | `{${string}}`; /** * Defines the text displayed next to the check box */ text?: string | PropertyBindingInfo; /** * Using this property, the control could be disabled, if required. */ enabled?: boolean | PropertyBindingInfo | `{${string}}`; /** * Specifies whether the user shall be allowed to flag the check box */ editable?: boolean | PropertyBindingInfo | `{${string}}`; /** * Accepts the core enumeration ValueState.type that supports 'None', 'Error', 'Warning' and 'Success'. */ valueState?: | (ValueState | keyof typeof ValueState) | PropertyBindingInfo | `{${string}}`; /** * The width can be set to an absolute value. If no value is set, the control width results from the text * length. */ width?: CSSSize | PropertyBindingInfo | `{${string}}`; /** * The value can be set to LTR or RTL. Otherwise, the control inherits the text direction from its parent * control. */ textDirection?: | (TextDirection | keyof typeof TextDirection) | PropertyBindingInfo | `{${string}}`; /** * Event is triggered when the control status is changed by the user by flagging or unflagging the checkbox. */ change?: (oEvent: TriStateCheckBox$ChangeEvent) => void; } /** * Parameters of the TriStateCheckBox#change event. */ export interface TriStateCheckBox$ChangeEventParameters { /** * Checks whether the box is flagged or not flagged. */ selectionState?: string; } /** * Event object of the TriStateCheckBox#change event. */ export type TriStateCheckBox$ChangeEvent = Event< TriStateCheckBox$ChangeEventParameters, TriStateCheckBox >; } declare module "sap/ui/commons/ValueHelpField" { import { default as TextField, $TextFieldSettings, } from "sap/ui/commons/TextField"; import Event from "sap/ui/base/Event"; import { URI } from "sap/ui/core/library"; import ElementMetadata from "sap/ui/core/ElementMetadata"; import { PropertyBindingInfo } from "sap/ui/base/ManagedObject"; /** * A TextField with an attached icon which triggeres an event. * * @deprecated As of version 1.38. Instead, use the `sap.m.Input` control. */ export default class ValueHelpField extends TextField { /** * Constructor for a new ValueHelpField. * * 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?: $ValueHelpFieldSettings ); /** * Constructor for a new ValueHelpField. * * 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?: $ValueHelpFieldSettings ); /** * Creates a new subclass of class sap.ui.commons.ValueHelpField with name `sClassName` and enriches it * with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.commons.TextField.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.ui.commons.ValueHelpField. * * * @returns Metadata object describing this class */ static getMetadata(): ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:valueHelpRequest valueHelpRequest} event of * this `sap.ui.commons.ValueHelpField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.ValueHelpField` itself. * * Event which is fired when the ValueHelp is requested. * * * @returns Reference to `this` in order to allow method chaining */ attachValueHelpRequest( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.ValueHelpField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:valueHelpRequest valueHelpRequest} event of * this `sap.ui.commons.ValueHelpField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.commons.ValueHelpField` itself. * * Event which is fired when the ValueHelp is requested. * * * @returns Reference to `this` in order to allow method chaining */ attachValueHelpRequest( /** * The function to be called when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.commons.ValueHelpField` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:valueHelpRequest valueHelpRequest} event of * this `sap.ui.commons.ValueHelpField`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachValueHelpRequest( /** * The function to be called, when the event occurs */ fnFunction: (p1: Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:valueHelpRequest valueHelpRequest} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireValueHelpRequest( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Gets current value of property {@link #getIconDisabledURL iconDisabledURL}. * * URL of the icon for the value help when disabled. If no parameter is supplied the default icon image * will be shown. If an icon font icon is used, this property is ignored. * * * @returns Value of property `iconDisabledURL` */ getIconDisabledURL(): URI; /** * Gets current value of property {@link #getIconHoverURL iconHoverURL}. * * URL of the icon for the value help when hovered. If no parameter is supplied the standard icon image * will be shown. If an icon font icon is used, this property is ignored. * * * @returns Value of property `iconHoverURL` */ getIconHoverURL(): URI; /** * Gets current value of property {@link #getIconURL iconURL}. * * URL of the standard icon for the value help. If no parameter is supplied the default icon image will * be shown. This can be a URI to an image or an icon font URI. * * * @returns Value of property `iconURL` */ getIconURL(): URI; /** * Handle F4 event * * @ui5-protected Do not call from applications (only from related classes in the framework) */ onsapshow( /** * the occurring event */ oEvent: jQuery.Event ): void; /** * Sets a new value for property {@link #getIconDisabledURL iconDisabledURL}. * * URL of the icon for the value help when disabled. If no parameter is supplied the default icon image * will be shown. If an icon font icon is used, this property is ignored. * * 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 */ setIconDisabledURL( /** * New value for property `iconDisabledURL` */ sIconDisabledURL?: URI ): this; /** * Sets a new value for property {@link #getIconHoverURL iconHoverURL}. * * URL of the icon for the value help when hovered. If no parameter is supplied the standard icon image * will be shown. If an icon font icon is used, this property is ignored. * * 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 */ setIconHoverURL( /** * New value for property `iconHoverURL` */ sIconHoverURL?: URI ): this; /** * Sets a new value for property {@link #getIconURL iconURL}. * * URL of the standard icon for the value help. If no parameter is supplied the default icon image will * be shown. This can be a URI to an image or an icon font URI. * * 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 */ setIconURL( /** * New value for property `iconURL` */ sIconURL?: URI ): this; } /** * Describes the settings that can be provided to the ValueHelpField constructor. * * @deprecated As of version 1.38. Instead, use the `sap.m.Input` control. */ export interface $ValueHelpFieldSettings extends $TextFieldSettings { /** * URL of the standard icon for the value help. If no parameter is supplied the default icon image will * be shown. This can be a URI to an image or an icon font URI. */ iconURL?: URI | PropertyBindingInfo | `{${string}}`; /** * URL of the icon for the value help when hovered. If no parameter is supplied the standard icon image * will be shown. If an icon font icon is used, this property is ignored. */ iconHoverURL?: URI | PropertyBindingInfo | `{${string}}`; /** * URL of the icon for the value help when disabled. If no parameter is supplied the default icon image * will be shown. If an icon font icon is used, this property is ignored. */ iconDisabledURL?: URI | PropertyBindingInfo | `{${string}}`; /** * Event which is fired when the ValueHelp is requested. */ valueHelpRequest?: (oEvent: Event) => void; } /** * Parameters of the ValueHelpField#valueHelpRequest event. */ export interface ValueHelpField$ValueHelpRequestEventParameters {} /** * Event object of the ValueHelpField#valueHelpRequest event. */ export type ValueHelpField$ValueHelpRequestEvent = Event< ValueHelpField$ValueHelpRequestEventParameters, ValueHelpField >; } declare namespace sap { interface IUI5DefineDependencyNames { "sap/ui/commons/Accordion": undefined; "sap/ui/commons/AccordionSection": undefined; "sap/ui/commons/ApplicationHeader": undefined; "sap/ui/commons/Area": undefined; "sap/ui/commons/AutoComplete": undefined; "sap/ui/commons/Button": undefined; "sap/ui/commons/Callout": undefined; "sap/ui/commons/CalloutBase": undefined; "sap/ui/commons/Carousel": undefined; "sap/ui/commons/CheckBox": undefined; "sap/ui/commons/ColorPicker": undefined; "sap/ui/commons/ComboBox": undefined; "sap/ui/commons/DatePicker": undefined; "sap/ui/commons/Dialog": undefined; "sap/ui/commons/DropdownBox": undefined; "sap/ui/commons/FileUploader": undefined; "sap/ui/commons/FileUploaderHttpRequestMethod": undefined; "sap/ui/commons/FileUploaderParameter": undefined; "sap/ui/commons/FileUploaderXHRSettings": undefined; "sap/ui/commons/form/Form": undefined; "sap/ui/commons/form/FormContainer": undefined; "sap/ui/commons/form/FormElement": undefined; "sap/ui/commons/form/FormLayout": undefined; "sap/ui/commons/form/GridContainerData": undefined; "sap/ui/commons/form/GridElementData": undefined; "sap/ui/commons/form/GridLayout": undefined; "sap/ui/commons/form/ResponsiveLayout": undefined; "sap/ui/commons/form/SimpleForm": undefined; "sap/ui/commons/FormattedTextView": undefined; "sap/ui/commons/HorizontalDivider": undefined; "sap/ui/commons/Image": undefined; "sap/ui/commons/ImageMap": undefined; "sap/ui/commons/InPlaceEdit": undefined; "sap/ui/commons/Label": undefined; "sap/ui/commons/layout/AbsoluteLayout": undefined; "sap/ui/commons/layout/BorderLayout": undefined; "sap/ui/commons/layout/BorderLayoutArea": undefined; "sap/ui/commons/layout/HorizontalLayout": undefined; "sap/ui/commons/layout/MatrixLayout": undefined; "sap/ui/commons/layout/MatrixLayoutCell": undefined; "sap/ui/commons/layout/MatrixLayoutRow": undefined; "sap/ui/commons/layout/PositionContainer": undefined; "sap/ui/commons/layout/ResponsiveFlowLayout": undefined; "sap/ui/commons/layout/ResponsiveFlowLayoutData": undefined; "sap/ui/commons/layout/VerticalLayout": undefined; "sap/ui/commons/library": undefined; "sap/ui/commons/Link": undefined; "sap/ui/commons/ListBox": undefined; "sap/ui/commons/Menu": undefined; "sap/ui/commons/MenuBar": undefined; "sap/ui/commons/MenuButton": undefined; "sap/ui/commons/MenuItem": undefined; "sap/ui/commons/MenuItemBase": undefined; "sap/ui/commons/MenuTextFieldItem": undefined; "sap/ui/commons/Message": undefined; "sap/ui/commons/MessageBar": undefined; "sap/ui/commons/MessageBox": undefined; "sap/ui/commons/MessageList": undefined; "sap/ui/commons/MessageToast": undefined; "sap/ui/commons/Paginator": undefined; "sap/ui/commons/Panel": undefined; "sap/ui/commons/PasswordField": undefined; "sap/ui/commons/ProgressIndicator": undefined; "sap/ui/commons/RadioButton": undefined; "sap/ui/commons/RadioButtonGroup": undefined; "sap/ui/commons/RangeSlider": undefined; "sap/ui/commons/RatingIndicator": undefined; "sap/ui/commons/ResponsiveContainer": undefined; "sap/ui/commons/ResponsiveContainerRange": undefined; "sap/ui/commons/RichTooltip": undefined; "sap/ui/commons/RoadMap": undefined; "sap/ui/commons/RoadMapStep": undefined; "sap/ui/commons/RowRepeater": undefined; "sap/ui/commons/RowRepeaterFilter": undefined; "sap/ui/commons/RowRepeaterSorter": undefined; "sap/ui/commons/SearchField": undefined; "sap/ui/commons/SearchProvider": undefined; "sap/ui/commons/SegmentedButton": undefined; "sap/ui/commons/Slider": undefined; "sap/ui/commons/Splitter": undefined; "sap/ui/commons/Tab": undefined; "sap/ui/commons/TabStrip": undefined; "sap/ui/commons/TextArea": undefined; "sap/ui/commons/TextField": undefined; "sap/ui/commons/TextView": undefined; "sap/ui/commons/Title": undefined; "sap/ui/commons/ToggleButton": undefined; "sap/ui/commons/Toolbar": undefined; "sap/ui/commons/ToolbarSeparator": undefined; "sap/ui/commons/Tree": undefined; "sap/ui/commons/TreeNode": undefined; "sap/ui/commons/TriStateCheckBox": undefined; "sap/ui/commons/ValueHelpField": undefined; } }