// For Library Version: 1.149.0 declare namespace sap { /** * SAPUI5 library with controls specialized for administrative applications. * * @since 1.36 */ namespace tnt { /** * Interface for controls suitable for the `header` aggregation of {@link sap.tnt.ToolPage}. * * @since 1.68 * @deprecated As of version 1.135. This interface is not needed anymore. The `ToolPage` now accepts any * control as a header or subheader. */ interface IToolHeader { __implements__sap_tnt_IToolHeader: boolean; } /** * Describes the settings that can be provided to the InfoLabel constructor. */ interface $InfoLabelSettings extends sap.ui.core.$ControlSettings { /** * Specifies the text inside the `InfoLabel` control. */ text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Specifies the type of the `InfoLabel` paddings - loose or narrow. **Note:** By default the padding is * loose. It is recommended to use narrow (smaller) paddings for numeric texts. **Note:** In Horizon theme * there is only one mode and setting this property will not have effect. */ renderMode?: | sap.tnt.RenderMode | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies the fill and text color of the control. Accepts a number between 1 and 10 as a value. You can * choose from 10 predefined background and text color combinations. The color schemes are non-semantic, * you can select them according to your own preferences. **Note:** ColorScheme 10 is available only in * Fiori 3 and Horizon themes. The default `colorScheme` is 7. */ colorScheme?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies the width of the `InfoLabel` control. By default, the `InfoLabel` control has the width of * the content. Set this property to restrict the width to a custom value. */ width?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines if the `InfoLabel` is in `displayOnly` mode. When set to `true` the control size adjusts to * fit other controls, for example non-editable `Forms`. */ displayOnly?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Available options for the text direction are LTR and RTL. By default the control inherits the text direction * from its parent control. */ textDirection?: | sap.ui.core.TextDirection | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from * the icon font. * * @since 1.74 */ icon?: | sap.ui.core.URI | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the NavigationList constructor. */ interface $NavigationListSettings extends sap.ui.core.$ControlSettings { /** * Specifies the width of the control. */ width?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies if the control is in expanded or collapsed mode. */ expanded?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies the currently selected key. * * @since 1.62.0 */ selectedKey?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The items displayed in the list. */ items?: | sap.tnt.NavigationListItemBase[] | sap.tnt.NavigationListItemBase | sap.ui.base.ManagedObject.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; /** * The currently selected `NavigationListItem`. * * @since 1.52.0 */ selectedItem?: sap.tnt.NavigationListItem | string; /** * Fired when an item is selected. */ itemSelect?: (oEvent: NavigationList$ItemSelectEvent) => void; /** * Fired when an item is pressed. */ itemPress?: (oEvent: NavigationList$ItemPressEvent) => void; } /** * Describes the settings that can be provided to the NavigationListGroup constructor. */ interface $NavigationListGroupSettings extends sap.tnt.$NavigationListItemBaseSettings { /** * The sub items. * * @since 1.121.0 */ items?: | sap.tnt.NavigationListItem[] | sap.tnt.NavigationListItem | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the NavigationListItem constructor. */ interface $NavigationListItemSettings extends sap.tnt.$NavigationListItemBaseSettings { /** * Specifies the icon for the item. * * **Note:** By design, icons on second-level (child) navigation items are not rendered. */ icon?: | sap.ui.core.URI | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies if the item should be shown. * * @since 1.52 */ visible?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies if the item can be selected. By default all items are selectable. * * When a parent item's `selectable` property is set to `false`, selecting it will only expand or collapse * its sub-items. * * To improve user experience do not mix selectable parent items with not selectable parent items within * a single side navigation. * * **Guidelines:** * - Items that have a set href and target set to `_blank` should not be selectable. * - Items that trigger actions (with design "Action") should not be selectable. * * @since 1.116 */ selectable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered, * this should not be set, but instead an event handler for the `select` event should be registered. */ href?: | sap.ui.core.URI | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies the browsing context where the linked content will open. * * Options are the standard values for window.open() supported by browsers: `_self`, `_top`, `_blank`, `_parent`, * `_search`. Alternatively, a frame name can be entered. * * **Guidelines:** * - Use only when `href` property is set. * - Items that have a set href and target set to `_blank` should not have children Items that have * a set href, should not use target for internal navigation/li> */ target?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Specifies if the item has a special design. **Note:** If the `design` property is not set to `NavigationListItemDesign.Default`, * sub-items cannot be added. * * @since 1.133.0 */ design?: | sap.tnt.NavigationListItemDesign | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies the value of the `aria-haspopup` attribute * * @since 1.133.0 */ ariaHasPopup?: | sap.ui.core.aria.HasPopup | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The sub items. */ items?: | sap.tnt.NavigationListItem[] | sap.tnt.NavigationListItem | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * A tag that uses Indication states to visually mark a navigation item. * * Use tags to display status information, counters, or metadata that helps users quickly identify the state * or importance of a navigation item. * * Tags can be added to: * - Single-click items without children * - Two-click items with children and expander arrow * - Child items nested under a parent item * * **Note:** Tags are visible when the `NavigationList` is in expanded mode, and hidden when collapsed, * but they are visible in the overflow of the collapsed mode. * * Usage: Common use cases include: * - Status indicators: "Beta", "New", "Deprecated" * - Counters: "5 Pending", "12 Items" * - Versions: "v2.0" * - Alerts: "Low Stock", "Critical" * * **Important:** Always set the `inverted` property to `true` for consistent styling. Use Indication states * (`Indication15` – `Indication20`) for consistent theming. * * **Important:** The `ObjectStatus` must never be interactive (i.e., `active` must not be set to `true`), * as this would lead to nesting of interactive elements, which is not allowed. * * @since 1.149 */ tag?: sap.m.ObjectStatus; /** * Fired when this item is selected. */ select?: (oEvent: NavigationListItem$SelectEvent) => void; } /** * Describes the settings that can be provided to the NavigationListItemBase constructor. */ interface $NavigationListItemBaseSettings extends sap.ui.core.$ItemSettings { /** * Specifies if the item is expanded. * * @since 1.121 */ expanded?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies if the item is allowed to be expanded or collapsed by the user. */ hasExpander?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies if the item should be shown. * * @since 1.121 */ visible?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Fired when an item is pressed. * * @since 1.133 */ press?: (oEvent: NavigationListItemBase$PressEvent) => void; } /** * Describes the settings that can be provided to the SideNavigation constructor. */ interface $SideNavigationSettings extends sap.ui.core.$ControlSettings { /** * Specifies the width of the control. * * Depending on the theme, there is a minimum width set (16rem for Horizon theme). This property * can be used to set a bigger width. * * @since 1.120 */ width?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies if the control is expanded. */ expanded?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies the currently selected key. * * @since 1.62.0 */ selectedKey?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Specifies an optional `aria-label` that can be used by the screen readers. * * @since 1.98 */ ariaLabel?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Specifies whether the control should have own container styling, such as a box-shadow and border, or * not. **Note:** This property has to be set to `Plain` when the control is used inside a `sap.m.ResponsivePopover` * to achieve a Side Navigation Overlay Mode. * * @since 1.134 */ design?: | sap.tnt.SideNavigationDesign | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the content inside the flexible part. */ item?: sap.tnt.NavigationList; /** * Defines the content inside the fixed part. */ fixedItem?: sap.tnt.NavigationList; /** * Defines the content inside the footer. * * @deprecated As of version 1.120. Use the aggregation `fixedItem` instead. */ footer?: sap.tnt.NavigationList; /** * The selected `NavigationListItem`. * * @since 1.52.0 */ selectedItem?: sap.tnt.NavigationListItem | string; /** * Fired when an item is selected. */ itemSelect?: (oEvent: SideNavigation$ItemSelectEvent) => void; /** * Fired when an item is pressed. */ itemPress?: (oEvent: SideNavigation$ItemPressEvent) => void; } /** * Describes the settings that can be provided to the ToolHeader constructor. */ interface $ToolHeaderSettings extends sap.m.$OverflowToolbarSettings {} /** * Describes the settings that can be provided to the ToolHeaderUtilitySeparator constructor. */ interface $ToolHeaderUtilitySeparatorSettings extends sap.ui.core.$ControlSettings {} /** * Describes the settings that can be provided to the ToolPage constructor. */ interface $ToolPageSettings extends sap.ui.core.$ControlSettings { /** * Indicates if the side menu is expanded. Overrides the `expanded` property of the `sideContent` aggregation. * **Note:** By default, on mobile phone devices and small screens, the side content is collapsed to provide * more space for the main content. On larger screens, excluding mobile phone devices, it is expanded. This * behavior can be overridden by setting this property. */ sideExpanded?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies the content background design. * * @since 1.115 */ contentBackgroundDesign?: | sap.m.PageBackgroundDesign | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The control to appear in the header area. */ header?: sap.ui.core.Control; /** * The control to appear in the subheader area. * * @since 1.93 */ subHeader?: sap.ui.core.Control; /** * The side menu of the layout. */ sideContent?: sap.tnt.SideNavigation; /** * The content section. */ mainContents?: | sap.ui.core.Control[] | sap.ui.core.Control | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; } /** * Parameters of the NavigationList#itemPress event. */ interface NavigationList$ItemPressEventParameters { /** * The pressed item. */ item?: sap.ui.core.Item; /** * Indicates whether the CTRL key was pressed when the link was selected. */ ctrlKey?: boolean; /** * Indicates whether the Shift key was pressed when the link was selected. */ shiftKey?: boolean; /** * Indicates whether the Alt key was pressed when the link was selected. */ altKey?: boolean; /** * Indicates whether the "meta" key was pressed when the link was selected. * * On Macintosh keyboards, this is the command key (⌘). On Windows keyboards, this is the windows key (⊞). */ metaKey?: boolean; } /** * Parameters of the NavigationList#itemSelect event. */ interface NavigationList$ItemSelectEventParameters { /** * The selected item. */ item?: sap.ui.core.Item; } /** * Parameters of the NavigationListItem#select event. */ interface NavigationListItem$SelectEventParameters { /** * The selected item. */ item?: sap.ui.core.Item; } /** * Parameters of the NavigationListItemBase#press event. */ interface NavigationListItemBase$PressEventParameters { /** * The pressed item. */ item?: sap.ui.core.Item; /** * Indicates whether the CTRL key was pressed when the link was selected. */ ctrlKey?: boolean; /** * Indicates whether the Shift key was pressed when the link was selected. */ shiftKey?: boolean; /** * Indicates whether the Alt key was pressed when the link was selected. */ altKey?: boolean; /** * Indicates whether the "meta" key was pressed when the link was selected. * * On Macintosh keyboards, this is the command key (⌘). On Windows keyboards, this is the windows key (⊞). */ metaKey?: boolean; } /** * Parameters of the SideNavigation#itemPress event. */ interface SideNavigation$ItemPressEventParameters { /** * The pressed item. */ item?: sap.ui.core.Item; /** * Indicates whether the CTRL key was pressed when the link was selected. */ ctrlKey?: boolean; /** * Indicates whether the Shift key was pressed when the link was selected. */ shiftKey?: boolean; /** * Indicates whether the Alt key was pressed when the link was selected. */ altKey?: boolean; /** * Indicates whether the "meta" key was pressed when the link was selected. * * On Macintosh keyboards, this is the command key (⌘). On Windows keyboards, this is the windows key (⊞). */ metaKey?: boolean; } /** * Parameters of the SideNavigation#itemSelect event. */ interface SideNavigation$ItemSelectEventParameters { /** * The selected item. */ item?: sap.ui.core.Item; } /** * The `InfoLabel` is a small non-interactive control which contains text information and non-semantic color * chosen from a list of predefined color schemes. It serves the purpose to attract the user attention to * some piece of information (state, quantity, condition, etc.). * * Overview: * * The control visualizes text information without user interaction. The text-background color pair can * be changed by setting a number between 1 and 10 that corresponds to the 10 predefined color combinations * of the `colorScheme` property. The control is designed to be vertically aligned with UI5 Input and Button * control families. When using `InfoLabel` in non-editable `Forms`, `Tables`, etc., set `displayOnly=true` * for best visual results. * * Usage Guidelines: * - If the text is longer than the width of the control, it doesn’t wrap. Instead, it’s represented as * ellipsis. * - When truncated, the full text in the control is not visible. Therefore, it’s recommended to make * more space for longer items to be fully displayed. * - Colors are not semantic and have no visual representation in sap_belize_hcb, sap_belize_hcw, sap_fiori_3_hcb * and sap_fiori_3_hcw themes. * - The control shows plain text only, formatting is not visualized. * * @since 1.54 */ class InfoLabel extends sap.ui.core.Control implements sap.ui.core.IFormContent { __implements__sap_ui_core_IFormContent: boolean; /** * Constructor for a new `InfoLabel`. * * 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?: sap.tnt.$InfoLabelSettings ); /** * Constructor for a new `InfoLabel`. * * 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?: sap.tnt.$InfoLabelSettings ); /** * Creates a new subclass of class sap.tnt.InfoLabel 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.tnt.InfoLabel. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * 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: sap.ui.base.ManagedObject.PropertyBindingInfo ): this; /** * Gets current value of property {@link #getColorScheme colorScheme}. * * Specifies the fill and text color of the control. Accepts a number between 1 and 10 as a value. You can * choose from 10 predefined background and text color combinations. The color schemes are non-semantic, * you can select them according to your own preferences. **Note:** ColorScheme 10 is available only in * Fiori 3 and Horizon themes. The default `colorScheme` is 7. * * Default value is `7`. * * * @returns Value of property `colorScheme` */ getColorScheme(): int; /** * Gets current value of property {@link #getDisplayOnly displayOnly}. * * Determines if the `InfoLabel` is in `displayOnly` mode. When set to `true` the control size adjusts to * fit other controls, for example non-editable `Forms`. * * Default value is `false`. * * * @returns Value of property `displayOnly` */ getDisplayOnly(): boolean; /** * Gets current value of property {@link #getIcon icon}. * * Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from * the icon font. * * Default value is `empty string`. * * @since 1.74 * * @returns Value of property `icon` */ getIcon(): sap.ui.core.URI; /** * Gets current value of property {@link #getRenderMode renderMode}. * * Specifies the type of the `InfoLabel` paddings - loose or narrow. **Note:** By default the padding is * loose. It is recommended to use narrow (smaller) paddings for numeric texts. **Note:** In Horizon theme * there is only one mode and setting this property will not have effect. * * Default value is `Loose`. * * * @returns Value of property `renderMode` */ getRenderMode(): sap.tnt.RenderMode; /** * Gets current value of property {@link #getText text}. * * Specifies the text inside the `InfoLabel` control. * * Default value is `empty string`. * * * @returns Value of property `text` */ getText(): string; /** * Gets current value of property {@link #getTextDirection textDirection}. * * Available options for the text direction are LTR and RTL. By default the control inherits the text direction * from its parent control. * * Default value is `Inherit`. * * * @returns Value of property `textDirection` */ getTextDirection(): sap.ui.core.TextDirection; /** * Gets current value of property {@link #getWidth width}. * * Specifies the width of the `InfoLabel` control. By default, the `InfoLabel` control has the width of * the content. Set this property to restrict the width to a custom value. * * * @returns Value of property `width` */ getWidth(): sap.ui.core.CSSSize; /** * Sets a new value for property {@link #getColorScheme colorScheme}. * * Specifies the fill and text color of the control. Accepts a number between 1 and 10 as a value. You can * choose from 10 predefined background and text color combinations. The color schemes are non-semantic, * you can select them according to your own preferences. **Note:** ColorScheme 10 is available only in * Fiori 3 and Horizon themes. The default `colorScheme` is 7. * * 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 */ setColorScheme( /** * New value for property `colorScheme` */ iColorScheme?: int ): this; /** * Sets a new value for property {@link #getDisplayOnly displayOnly}. * * Determines if the `InfoLabel` is in `displayOnly` mode. When set to `true` the control size adjusts to * fit other controls, for example non-editable `Forms`. * * 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 */ setDisplayOnly( /** * New value for property `displayOnly` */ bDisplayOnly?: boolean ): this; /** * Sets a new value for property {@link #getIcon icon}. * * Defines the icon to be displayed as graphical element within the `InfoLabel`. It can be an icon from * the icon font. * * 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.74 * * @returns Reference to `this` in order to allow method chaining */ setIcon( /** * New value for property `icon` */ sIcon?: sap.ui.core.URI ): this; /** * Sets a new value for property {@link #getRenderMode renderMode}. * * Specifies the type of the `InfoLabel` paddings - loose or narrow. **Note:** By default the padding is * loose. It is recommended to use narrow (smaller) paddings for numeric texts. **Note:** In Horizon theme * there is only one mode and setting this property will not have effect. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Loose`. * * * @returns Reference to `this` in order to allow method chaining */ setRenderMode( /** * New value for property `renderMode` */ sRenderMode?: sap.tnt.RenderMode ): this; /** * Sets a new value for property {@link #getText text}. * * Specifies the text inside the `InfoLabel` control. * * 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 #getTextDirection textDirection}. * * Available options for the text direction are LTR and RTL. By default 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?: sap.ui.core.TextDirection ): this; /** * Sets a new value for property {@link #getWidth width}. * * Specifies the width of the `InfoLabel` control. By default, the `InfoLabel` control has the width of * the content. Set this property to restrict the width to a custom value. * * 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?: sap.ui.core.CSSSize ): this; /** * Unbinds property {@link #getText text} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindText(): this; } /** * The NavigationList control is an interactive control, which provides a choice of different items, ordered * as a list. * * @since 1.34 */ class NavigationList extends sap.ui.core.Control { /** * Constructor for a new `NavigationList`. * * 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?: sap.tnt.$NavigationListSettings ); /** * Constructor for a new `NavigationList`. * * 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?: sap.tnt.$NavigationListSettings ); /** * Creates a new subclass of class sap.tnt.NavigationList 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.tnt.NavigationList. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.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: sap.ui.core.ID | sap.ui.core.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: sap.ui.core.ID | sap.ui.core.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: sap.tnt.NavigationListItemBase ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemPress itemPress} event of this `sap.tnt.NavigationList`. * * 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.tnt.NavigationList` itself. * * Fired when an item is pressed. * * * @returns Reference to `this` in order to allow method chaining */ attachItemPress( /** * 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: NavigationList$ItemPressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemPress itemPress} event of this `sap.tnt.NavigationList`. * * 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.tnt.NavigationList` itself. * * Fired when an item is pressed. * * * @returns Reference to `this` in order to allow method chaining */ attachItemPress( /** * The function to be called when the event occurs */ fnFunction: (p1: NavigationList$ItemPressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemSelect itemSelect} event of this `sap.tnt.NavigationList`. * * 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.tnt.NavigationList` itself. * * Fired when an item is selected. * * * @returns Reference to `this` in order to allow method chaining */ attachItemSelect( /** * 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: NavigationList$ItemSelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemSelect itemSelect} event of this `sap.tnt.NavigationList`. * * 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.tnt.NavigationList` itself. * * Fired when an item is selected. * * * @returns Reference to `this` in order to allow method chaining */ attachItemSelect( /** * The function to be called when the event occurs */ fnFunction: (p1: NavigationList$ItemSelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationList` itself */ oListener?: object ): 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:itemPress itemPress} event of this `sap.tnt.NavigationList`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachItemPress( /** * The function to be called, when the event occurs */ fnFunction: (p1: NavigationList$ItemPressEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:itemSelect itemSelect} event of this `sap.tnt.NavigationList`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachItemSelect( /** * The function to be called, when the event occurs */ fnFunction: (p1: NavigationList$ItemSelectEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:itemPress itemPress} 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 */ fireItemPress( /** * Parameters to pass along with the event */ mParameters?: sap.tnt.NavigationList$ItemPressEventParameters ): boolean; /** * Fires event {@link #event:itemSelect itemSelect} 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 */ fireItemSelect( /** * Parameters to pass along with the event */ mParameters?: sap.tnt.NavigationList$ItemSelectEventParameters ): this; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. */ getAriaDescribedBy(): sap.ui.core.ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. */ getAriaLabelledBy(): sap.ui.core.ID[]; /** * Gets current value of property {@link #getExpanded expanded}. * * Specifies if the control is in expanded or collapsed mode. * * Default value is `true`. * * * @returns Value of property `expanded` */ getExpanded(): boolean; /** * Gets content of aggregation {@link #getItems items}. * * The items displayed in the list. */ getItems(): sap.tnt.NavigationListItemBase[]; /** * Gets the currently selected `NavigationListItem`. * * * @returns The selected item or `null` if nothing is selected */ getSelectedItem(): sap.tnt.NavigationListItem | null; /** * Gets current value of property {@link #getSelectedKey selectedKey}. * * Specifies the currently selected key. * * @since 1.62.0 * * @returns Value of property `selectedKey` */ getSelectedKey(): string; /** * Gets current value of property {@link #getWidth width}. * * Specifies the width of the control. * * * @returns Value of property `width` */ getWidth(): sap.ui.core.CSSSize; /** * Checks for the provided `sap.tnt.NavigationListItemBase` 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: sap.tnt.NavigationListItemBase ): 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: sap.tnt.NavigationListItemBase, /** * 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(): sap.ui.core.ID[]; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): sap.ui.core.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(): sap.tnt.NavigationListItemBase[]; /** * 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 | sap.ui.core.ID | sap.ui.core.Control ): sap.ui.core.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 | sap.ui.core.ID | sap.ui.core.Control ): sap.ui.core.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 | sap.tnt.NavigationListItemBase ): sap.tnt.NavigationListItemBase | null; /** * Sets a new value for property {@link #getExpanded expanded}. * * Specifies if the control is in expanded or collapsed 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 */ setExpanded( /** * New value for property `expanded` */ bExpanded?: boolean ): this; /** * Sets the association for selectedItem. Set `null` to deselect. * * * @returns The `selectedItem` association */ setSelectedItem( /** * The control to be set as selected */ oItem: sap.ui.core.ID | sap.tnt.NavigationListItem ): sap.tnt.NavigationList | null; /** * Sets the selected item based on a key. * * * @returns this pointer for chaining */ setSelectedKey( /** * The key of the item to be selected */ sSelectedKey: string ): this; /** * Sets a new value for property {@link #getWidth width}. * * Specifies the width of 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 */ setWidth( /** * New value for property `width` */ sWidth: sap.ui.core.CSSSize ): this; } /** * The NavigationListGroup represents a group of navigation actions, which can be selected by the user. * * @since 1.121 */ class NavigationListGroup extends sap.tnt.NavigationListItemBase { /** * Constructor for a new NavigationListGroup. * * 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?: sap.tnt.$NavigationListGroupSettings ); /** * Constructor for a new NavigationListGroup. * * 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?: sap.tnt.$NavigationListGroupSettings ); /** * Creates a new subclass of class sap.tnt.NavigationListGroup 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.tnt.NavigationListItemBase.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.tnt.NavigationListGroup. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some item to the aggregation {@link #getItems items}. * * @since 1.121.0 * * @returns Reference to `this` in order to allow method chaining */ addItem( /** * The item to add; if empty, nothing is inserted */ oItem: sap.tnt.NavigationListItem ): this; /** * Destroys all the items in the aggregation {@link #getItems items}. * * @since 1.121.0 * * @returns Reference to `this` in order to allow method chaining */ destroyItems(): this; /** * Gets content of aggregation {@link #getItems items}. * * The sub items. * * @since 1.121.0 */ getItems(): sap.tnt.NavigationListItem[]; /** * Checks for the provided `sap.tnt.NavigationListItem` in the aggregation {@link #getItems items}. and * returns its index if found or -1 otherwise. * * @since 1.121.0 * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfItem( /** * The item whose index is looked for */ oItem: sap.tnt.NavigationListItem ): int; /** * Inserts a item into the aggregation {@link #getItems items}. * * @since 1.121.0 * * @returns Reference to `this` in order to allow method chaining */ insertItem( /** * The item to insert; if empty, nothing is inserted */ oItem: sap.tnt.NavigationListItem, /** * 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. * * @since 1.121.0 * * @returns An array of the removed elements (might be empty) */ removeAllItems(): sap.tnt.NavigationListItem[]; /** * Removes a item from the aggregation {@link #getItems items}. * * @since 1.121.0 * * @returns The removed item or `null` */ removeItem( /** * The item to remove or its index or id */ vItem: int | string | sap.tnt.NavigationListItem ): sap.tnt.NavigationListItem | null; } /** * The NavigationListItem represents a navigation action, which can be selected by the user. It can provide * sub items. * * @since 1.34 */ class NavigationListItem extends sap.tnt.NavigationListItemBase { /** * Constructor for a new NavigationListItem. * * 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?: sap.tnt.$NavigationListItemSettings ); /** * Constructor for a new NavigationListItem. * * 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?: sap.tnt.$NavigationListItemSettings ); /** * Creates a new subclass of class sap.tnt.NavigationListItem 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.tnt.NavigationListItemBase.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.tnt.NavigationListItem. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.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: sap.tnt.NavigationListItem ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.tnt.NavigationListItem`. * * 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.tnt.NavigationListItem` itself. * * Fired when this item 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: NavigationListItem$SelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.tnt.NavigationListItem`. * * 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.tnt.NavigationListItem` itself. * * Fired when this item is selected. * * * @returns Reference to `this` in order to allow method chaining */ attachSelect( /** * The function to be called when the event occurs */ fnFunction: (p1: NavigationListItem$SelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItem` itself */ oListener?: object ): this; /** * Destroys all the items in the aggregation {@link #getItems items}. * * * @returns Reference to `this` in order to allow method chaining */ destroyItems(): this; /** * Destroys the tag in the aggregation {@link #getTag tag}. * * @since 1.149 * * @returns Reference to `this` in order to allow method chaining */ destroyTag(): this; /** * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.tnt.NavigationListItem`. * * 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: NavigationListItem$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?: sap.tnt.NavigationListItem$SelectEventParameters ): this; /** * Gets current value of property {@link #getAriaHasPopup ariaHasPopup}. * * Specifies the value of the `aria-haspopup` attribute * * Default value is `None`. * * @since 1.133.0 * * @returns Value of property `ariaHasPopup` */ getAriaHasPopup(): sap.ui.core.aria.HasPopup; /** * Gets current value of property {@link #getDesign design}. * * Specifies if the item has a special design. **Note:** If the `design` property is not set to `NavigationListItemDesign.Default`, * sub-items cannot be added. * * Default value is `Default`. * * @since 1.133.0 * * @returns Value of property `design` */ getDesign(): sap.tnt.NavigationListItemDesign; /** * Gets current value of property {@link #getHref href}. * * Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered, * this should not be set, but instead an event handler for the `select` event should be registered. * * * @returns Value of property `href` */ getHref(): sap.ui.core.URI; /** * Gets current value of property {@link #getIcon icon}. * * Specifies the icon for the item. * * **Note:** By design, icons on second-level (child) navigation items are not rendered. * * Default value is `empty string`. * * * @returns Value of property `icon` */ getIcon(): sap.ui.core.URI; /** * Gets content of aggregation {@link #getItems items}. * * The sub items. */ getItems(): sap.tnt.NavigationListItem[]; /** * Gets current value of property {@link #getSelectable selectable}. * * Specifies if the item can be selected. By default all items are selectable. * * When a parent item's `selectable` property is set to `false`, selecting it will only expand or collapse * its sub-items. * * To improve user experience do not mix selectable parent items with not selectable parent items within * a single side navigation. * * **Guidelines:** * - Items that have a set href and target set to `_blank` should not be selectable. * - Items that trigger actions (with design "Action") should not be selectable. * * Default value is `true`. * * @since 1.116 * * @returns Value of property `selectable` */ getSelectable(): boolean; /** * Gets content of aggregation {@link #getTag tag}. * * A tag that uses Indication states to visually mark a navigation item. * * Use tags to display status information, counters, or metadata that helps users quickly identify the state * or importance of a navigation item. * * Tags can be added to: * - Single-click items without children * - Two-click items with children and expander arrow * - Child items nested under a parent item * * **Note:** Tags are visible when the `NavigationList` is in expanded mode, and hidden when collapsed, * but they are visible in the overflow of the collapsed mode. * * Usage: Common use cases include: * - Status indicators: "Beta", "New", "Deprecated" * - Counters: "5 Pending", "12 Items" * - Versions: "v2.0" * - Alerts: "Low Stock", "Critical" * * **Important:** Always set the `inverted` property to `true` for consistent styling. Use Indication states * (`Indication15` – `Indication20`) for consistent theming. * * **Important:** The `ObjectStatus` must never be interactive (i.e., `active` must not be set to `true`), * as this would lead to nesting of interactive elements, which is not allowed. * * @since 1.149 */ getTag(): sap.m.ObjectStatus; /** * Gets current value of property {@link #getTarget target}. * * Specifies the browsing context where the linked content will open. * * Options are the standard values for window.open() supported by browsers: `_self`, `_top`, `_blank`, `_parent`, * `_search`. Alternatively, a frame name can be entered. * * **Guidelines:** * - Use only when `href` property is set. * - Items that have a set href and target set to `_blank` should not have children Items that have * a set href, should not use target for internal navigation/li> * * * @returns Value of property `target` */ getTarget(): string; /** * Gets current value of property {@link #getVisible visible}. * * Specifies if the item should be shown. * * Default value is `true`. * * @since 1.52 * * @returns Value of property `visible` */ getVisible(): boolean; /** * Checks for the provided `sap.tnt.NavigationListItem` 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: sap.tnt.NavigationListItem ): 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: sap.tnt.NavigationListItem, /** * 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(): sap.tnt.NavigationListItem[]; /** * 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 | sap.tnt.NavigationListItem ): sap.tnt.NavigationListItem | null; /** * Sets a new value for property {@link #getAriaHasPopup ariaHasPopup}. * * Specifies the value of the `aria-haspopup` attribute * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `None`. * * @since 1.133.0 * * @returns Reference to `this` in order to allow method chaining */ setAriaHasPopup( /** * New value for property `ariaHasPopup` */ sAriaHasPopup?: sap.ui.core.aria.HasPopup ): this; /** * Sets a new value for property {@link #getDesign design}. * * Specifies if the item has a special design. **Note:** If the `design` property is not set to `NavigationListItemDesign.Default`, * sub-items cannot be added. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Default`. * * @since 1.133.0 * * @returns Reference to `this` in order to allow method chaining */ setDesign( /** * New value for property `design` */ sDesign?: sap.tnt.NavigationListItemDesign ): this; /** * Sets a new value for property {@link #getHref href}. * * Defines the link target URI. Supports standard hyperlink behavior. If a JavaScript action should be triggered, * this should not be set, but instead an event handler for the `select` 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?: sap.ui.core.URI ): this; /** * Sets a new value for property {@link #getIcon icon}. * * Specifies the icon for the item. * * **Note:** By design, icons on second-level (child) navigation items are not rendered. * * 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?: sap.ui.core.URI ): this; /** * Sets a new value for property {@link #getSelectable selectable}. * * Specifies if the item can be selected. By default all items are selectable. * * When a parent item's `selectable` property is set to `false`, selecting it will only expand or collapse * its sub-items. * * To improve user experience do not mix selectable parent items with not selectable parent items within * a single side navigation. * * **Guidelines:** * - Items that have a set href and target set to `_blank` should not be selectable. * - Items that trigger actions (with design "Action") should not be selectable. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.116 * * @returns Reference to `this` in order to allow method chaining */ setSelectable( /** * New value for property `selectable` */ bSelectable?: boolean ): this; /** * Sets the aggregated {@link #getTag tag}. * * @since 1.149 * * @returns Reference to `this` in order to allow method chaining */ setTag( /** * The tag to set */ oTag: sap.m.ObjectStatus ): this; /** * Sets a new value for property {@link #getTarget target}. * * Specifies the browsing context where the linked content will open. * * Options are the standard values for window.open() supported by browsers: `_self`, `_top`, `_blank`, `_parent`, * `_search`. Alternatively, a frame name can be entered. * * **Guidelines:** * - Use only when `href` property is set. * - Items that have a set href and target set to `_blank` should not have children Items that have * a set href, should not use target for internal navigation/li> * * 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 #getVisible visible}. * * Specifies if the item should be shown. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.52 * * @returns Reference to `this` in order to allow method chaining */ setVisible( /** * New value for property `visible` */ bVisible?: boolean ): this; } /** * The `NavigationListItemBase` class represents a base class for the items that are accepted by the `NavigationList` * control. * * @since 1.121 */ abstract class NavigationListItemBase extends sap.ui.core.Item { /** * Constructor for a new `NavigationListItemBase`. * * 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?: sap.tnt.$NavigationListItemBaseSettings ); /** * Constructor for a new `NavigationListItemBase`. * * 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?: sap.tnt.$NavigationListItemBaseSettings ); /** * Creates a new subclass of class sap.tnt.NavigationListItemBase 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.Item.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.tnt.NavigationListItemBase. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.tnt.NavigationListItemBase`. * * 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.tnt.NavigationListItemBase` itself. * * Fired when an item is pressed. * * @since 1.133 * * @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: NavigationListItemBase$PressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItemBase` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.tnt.NavigationListItemBase`. * * 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.tnt.NavigationListItemBase` itself. * * Fired when an item is pressed. * * @since 1.133 * * @returns Reference to `this` in order to allow method chaining */ attachPress( /** * The function to be called when the event occurs */ fnFunction: (p1: NavigationListItemBase$PressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.tnt.NavigationListItemBase` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.tnt.NavigationListItemBase`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.133 * * @returns Reference to `this` in order to allow method chaining */ detachPress( /** * The function to be called, when the event occurs */ fnFunction: (p1: NavigationListItemBase$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. * * 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. * * @since 1.133 * @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?: sap.tnt.NavigationListItemBase$PressEventParameters ): boolean; /** * Gets current value of property {@link #getExpanded expanded}. * * Specifies if the item is expanded. * * Default value is `true`. * * @since 1.121 * * @returns Value of property `expanded` */ getExpanded(): boolean; /** * Returns the DOM Element that should get the focus. * * @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 #getHasExpander hasExpander}. * * Specifies if the item is allowed to be expanded or collapsed by the user. * * Default value is `true`. * * * @returns Value of property `hasExpander` */ getHasExpander(): boolean; /** * Gets current value of property {@link #getVisible visible}. * * Specifies if the item should be shown. * * Default value is `true`. * * @since 1.121 * * @returns Value of property `visible` */ getVisible(): boolean; /** * Sets a new value for property {@link #getExpanded expanded}. * * Specifies if the item is expanded. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.121 * * @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}. * * Specifies if the item is allowed to be expanded or collapsed 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 */ setHasExpander( /** * New value for property `hasExpander` */ bHasExpander?: boolean ): this; /** * Sets a new value for property {@link #getVisible visible}. * * Specifies if the item should be shown. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.121 * * @returns Reference to `this` in order to allow method chaining */ setVisible( /** * New value for property `visible` */ bVisible?: boolean ): this; } /** * The `SideNavigation` control is a container, which consists of flexible and fixed parts on top of each * other. Responsive Behavior: * - The flexible part adapts its size to the fixed one. * - The flexible part has a scrollbar when the content is larger than the available space. **Note:** * In order for the `SideNavigation` to stretch properly, its parent layout control should only be the `sap.tnt.ToolPage`. * **Note:** If used outside the intended parent layout `sap.tnt.ToolPage`, for example inside a `sap.m.ResponsivePopover` * to achieve a Side Navigation Overlay Mode, the application developer should set the `design` property * to `Plain`. * * @since 1.34 */ class SideNavigation extends sap.ui.core.Control { /** * Constructor for a new `SideNavigation`. * * 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?: sap.tnt.$SideNavigationSettings ); /** * Constructor for a new `SideNavigation`. * * 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?: sap.tnt.$SideNavigationSettings ); /** * Creates a new subclass of class sap.tnt.SideNavigation 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.tnt.SideNavigation. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:itemPress itemPress} event of this `sap.tnt.SideNavigation`. * * 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.tnt.SideNavigation` itself. * * Fired when an item is pressed. * * * @returns Reference to `this` in order to allow method chaining */ attachItemPress( /** * 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: SideNavigation$ItemPressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemPress itemPress} event of this `sap.tnt.SideNavigation`. * * 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.tnt.SideNavigation` itself. * * Fired when an item is pressed. * * * @returns Reference to `this` in order to allow method chaining */ attachItemPress( /** * The function to be called when the event occurs */ fnFunction: (p1: SideNavigation$ItemPressEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemSelect itemSelect} event of this `sap.tnt.SideNavigation`. * * 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.tnt.SideNavigation` itself. * * Fired when an item is selected. * * * @returns Reference to `this` in order to allow method chaining */ attachItemSelect( /** * 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: SideNavigation$ItemSelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:itemSelect itemSelect} event of this `sap.tnt.SideNavigation`. * * 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.tnt.SideNavigation` itself. * * Fired when an item is selected. * * * @returns Reference to `this` in order to allow method chaining */ attachItemSelect( /** * The function to be called when the event occurs */ fnFunction: (p1: SideNavigation$ItemSelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.tnt.SideNavigation` itself */ oListener?: object ): this; /** * Binds aggregation {@link #getItem item} 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 */ bindItem( /** * The binding information */ oBindingInfo: sap.ui.base.ManagedObject.AggregationBindingInfo ): this; /** * Destroys the fixedItem in the aggregation {@link #getFixedItem fixedItem}. * * * @returns Reference to `this` in order to allow method chaining */ destroyFixedItem(): this; /** * Destroys the footer in the aggregation {@link #getFooter footer}. * * @deprecated As of version 1.120. Use the aggregation `fixedItem` instead. * * @returns Reference to `this` in order to allow method chaining */ destroyFooter(): this; /** * Destroys the item in the aggregation {@link #getItem item}. * * * @returns Reference to `this` in order to allow method chaining */ destroyItem(): this; /** * Detaches event handler `fnFunction` from the {@link #event:itemPress itemPress} event of this `sap.tnt.SideNavigation`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachItemPress( /** * The function to be called, when the event occurs */ fnFunction: (p1: SideNavigation$ItemPressEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:itemSelect itemSelect} event of this `sap.tnt.SideNavigation`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachItemSelect( /** * The function to be called, when the event occurs */ fnFunction: (p1: SideNavigation$ItemSelectEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:itemPress itemPress} 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 */ fireItemPress( /** * Parameters to pass along with the event */ mParameters?: sap.tnt.SideNavigation$ItemPressEventParameters ): boolean; /** * Fires event {@link #event:itemSelect itemSelect} 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 */ fireItemSelect( /** * Parameters to pass along with the event */ mParameters?: sap.tnt.SideNavigation$ItemSelectEventParameters ): this; /** * Gets current value of property {@link #getAriaLabel ariaLabel}. * * Specifies an optional `aria-label` that can be used by the screen readers. * * @since 1.98 * * @returns Value of property `ariaLabel` */ getAriaLabel(): string; /** * Gets current value of property {@link #getDesign design}. * * Specifies whether the control should have own container styling, such as a box-shadow and border, or * not. **Note:** This property has to be set to `Plain` when the control is used inside a `sap.m.ResponsivePopover` * to achieve a Side Navigation Overlay Mode. * * Default value is `Decorated`. * * @since 1.134 * * @returns Value of property `design` */ getDesign(): sap.tnt.SideNavigationDesign; /** * Gets current value of property {@link #getExpanded expanded}. * * Specifies if the control is expanded. * * Default value is `true`. * * * @returns Value of property `expanded` */ getExpanded(): boolean; /** * Gets content of aggregation {@link #getFixedItem fixedItem}. * * Defines the content inside the fixed part. */ getFixedItem(): sap.tnt.NavigationList; /** * Gets content of aggregation {@link #getFooter footer}. * * Defines the content inside the footer. * * @deprecated As of version 1.120. Use the aggregation `fixedItem` instead. */ getFooter(): sap.tnt.NavigationList; /** * Gets content of aggregation {@link #getItem item}. * * Defines the content inside the flexible part. */ getItem(): sap.tnt.NavigationList; /** * ID of the element which is the current target of the association {@link #getSelectedItem selectedItem}, * or `null`. * * @since 1.52.0 */ getSelectedItem(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getSelectedKey selectedKey}. * * Specifies the currently selected key. * * @since 1.62.0 * * @returns Value of property `selectedKey` */ getSelectedKey(): string; /** * Gets current value of property {@link #getWidth width}. * * Specifies the width of the control. * * Depending on the theme, there is a minimum width set (16rem for Horizon theme). This property * can be used to set a bigger width. * * @since 1.120 * * @returns Value of property `width` */ getWidth(): sap.ui.core.CSSSize; /** * Sets a new value for property {@link #getAriaLabel ariaLabel}. * * Specifies an optional `aria-label` that can be used by the screen readers. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.98 * * @returns Reference to `this` in order to allow method chaining */ setAriaLabel( /** * New value for property `ariaLabel` */ sAriaLabel?: string ): this; /** * Sets a new value for property {@link #getDesign design}. * * Specifies whether the control should have own container styling, such as a box-shadow and border, or * not. **Note:** This property has to be set to `Plain` when the control is used inside a `sap.m.ResponsivePopover` * to achieve a Side Navigation Overlay Mode. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Decorated`. * * @since 1.134 * * @returns Reference to `this` in order to allow method chaining */ setDesign( /** * New value for property `design` */ sDesign?: sap.tnt.SideNavigationDesign ): this; /** * Sets if the control is in expanded or collapsed mode. * * * @returns this SideNavigation reference for chaining. */ setExpanded( /** * Indication if the SideNavigation is expanded. */ bExpanded: boolean ): this; /** * Sets the aggregated {@link #getFixedItem fixedItem}. * * * @returns Reference to `this` in order to allow method chaining */ setFixedItem( /** * The fixedItem to set */ oFixedItem: sap.tnt.NavigationList ): this; /** * Sets the aggregated {@link #getFooter footer}. * * @deprecated As of version 1.120. Use the aggregation `fixedItem` instead. * * @returns Reference to `this` in order to allow method chaining */ setFooter( /** * The footer to set */ oFooter: sap.tnt.NavigationList ): this; /** * Sets the aggregated {@link #getItem item}. * * * @returns Reference to `this` in order to allow method chaining */ setItem( /** * The item to set */ oItem: sap.tnt.NavigationList ): this; /** * Sets the association for `selectedItem`. * * * @returns The `selectedItem` association */ setSelectedItem( /** * The control to be set as selected */ vSelectedItem: sap.ui.core.ID | sap.tnt.NavigationListItem ): sap.tnt.SideNavigation | null; /** * Sets the selected item based on a key. * * * @returns this pointer for chaining */ setSelectedKey( /** * The key of the item to be selected */ sSelectedKey: string ): this; /** * Sets a new value for property {@link #getWidth width}. * * Specifies the width of the control. * * Depending on the theme, there is a minimum width set (16rem for Horizon theme). This property * can be used to set a bigger width. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.120 * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth: sap.ui.core.CSSSize ): this; /** * Unbinds aggregation {@link #getItem item} from model data. * * * @returns Reference to `this` in order to allow method chaining */ unbindItem(): this; } /** * The ToolHeader control is a horizontal container that is most commonly used to display buttons, texts, * and other various input controls. Overview: The ToolHeader control is based on {@link sap.m.OverflowToolbar}. * It contains clearly structured menus of commands that are available across the various apps within the * same tool layout. Usage: * - This control is specialized for administrative applications. For other types of applications use: * {@link sap.m.Shell} * - If an app implements side navigation in addition to the tool header menu, the menu icon must be the * first item on the left-hand side of the tool header. * - The app menu and the side navigation must not have any dependencies and must work independently. * * - Not recommended: In accordance with the UX Consistency initiative, it is recommended to use the seamlessly * integrated UI5 Web Components' ui5-shellbar, as demonstrated in this UXC * integration sample app with UXC integration * sample source code. Horizon theme specifics: Only the following controls are supported: sap.m.Button, * sap.m.Image, sap.m.Title, sap.m.Text, sap.m.SearchField, sap.m.Avatar. Fiori 3 theme specifics: In Fiori * 3 Default theme the ToolHeader is with dark design unlike most of the other controls. This defines the * usage of limited controls inside it, which will result in good design combination. * The ToolHeader stylizes the contained controls with the Shell color parameters, to match the dark design * requirement. However, that's not a dark theme. * * Only the following controls are supported: Control name Supported * Not supported sap.m.Text Single line text, text truncation Wrapping * sap.m.Title Single line text, text truncation. Consider using title headings * of H4, H5, H6. Wrapping sap.m.Label Single line text, text truncation * Wrapping sap.m.ObjectStatus Labels, semantic colors Indication * colors sap.ui.core.Icon sap.ui.core.IconColor enumeration for both icons * and backgrounds. Interaction state colors sap.m.Button Buttons * in their Back, Default, Transparent and Up types. All four types are over-styled to look as transparent * buttons. - sap.m.MenuButton Emphasized button type. Should be used * for triggering Mega menu. If there is no Mega menu, use Title (H6) instead. * Default (over-styled as Transparent) and Transparent types are used for standard menu representation. * - sap.m.Select Default and IconOnly types. IconOnly looks like a button * while Default looks is like an input. Semantic states sap.m.SearchField * Support for the regular state of the control. - sap.m.IconTabHeader * All background design variations (all are transparent). Text tab filters or text and count tab filters * in Inline mode only. Semantic colors, icons and separators. sap.f.Avatar/sap.m.Avatar * Support for default (Accent 6) color. Image avatar. - sap.m.Image * Primarily used for displaying the company logo. Interaction states * * @since 1.34 */ class ToolHeader extends sap.m.OverflowToolbar { /** * Constructor for a new ToolHeader. * * 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.m.OverflowToolbar#constructor sap.m.OverflowToolbar } * can be used. */ constructor( /** * Initial settings for the new control */ mSettings?: sap.tnt.$ToolHeaderSettings ); /** * Constructor for a new ToolHeader. * * 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.m.OverflowToolbar#constructor sap.m.OverflowToolbar } * 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?: sap.tnt.$ToolHeaderSettings ); /** * Creates a new subclass of class sap.tnt.ToolHeader with name `sClassName` and enriches it with the information * contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.m.OverflowToolbar.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.tnt.ToolHeader. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; } /** * The ToolHeaderUtilitySeparator control is used in the sap.tnt.ToolHeader control to specify where the * overflow button is placed. * * @since 1.16 */ class ToolHeaderUtilitySeparator extends sap.ui.core.Control { /** * Constructor for a new ToolHeaderUtilitySeparator. * * 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.Control#constructor sap.ui.core.Control } * can be used. */ constructor( /** * Initial settings for the new control */ mSettings?: sap.tnt.$ToolHeaderUtilitySeparatorSettings ); /** * Constructor for a new ToolHeaderUtilitySeparator. * * 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.Control#constructor sap.ui.core.Control } * 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?: sap.tnt.$ToolHeaderUtilitySeparatorSettings ); /** * Creates a new subclass of class sap.tnt.ToolHeaderUtilitySeparator 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.tnt.ToolHeaderUtilitySeparator. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; } /** * The ToolPage is a layout control, used to create a basic tools app that has a header, side navigation * and contents area. Overview: The control has three main areas - a header on top, navigation to the side * and a content area that can hold any control. The header and side navigation use custom controls - {@link sap.tnt.ToolHeader } * and {@link sap.tnt.SideNavigation}. Usage: The main usage of the sap.tnt controls is for scenarios in * the tooling or administration space. * * @since 1.34 */ class ToolPage extends sap.ui.core.Control { /** * Constructor for a new ToolPage. * * 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?: sap.tnt.$ToolPageSettings ); /** * Constructor for a new ToolPage. * * 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?: sap.tnt.$ToolPageSettings ); /** * Creates a new subclass of class sap.tnt.ToolPage 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.tnt.ToolPage. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some mainContent to the aggregation {@link #getMainContents mainContents}. * * * @returns Reference to `this` in order to allow method chaining */ addMainContent( /** * The mainContent to add; if empty, nothing is inserted */ oMainContent: sap.ui.core.Control ): this; /** * Destroys the header in the aggregation {@link #getHeader header}. * * * @returns Reference to `this` in order to allow method chaining */ destroyHeader(): this; /** * Destroys all the mainContents in the aggregation {@link #getMainContents mainContents}. * * * @returns Reference to `this` in order to allow method chaining */ destroyMainContents(): this; /** * Destroys the sideContent in the aggregation {@link #getSideContent sideContent}. * * * @returns Reference to `this` in order to allow method chaining */ destroySideContent(): this; /** * Destroys the subHeader in the aggregation {@link #getSubHeader subHeader}. * * @since 1.93 * * @returns Reference to `this` in order to allow method chaining */ destroySubHeader(): this; /** * Gets current value of property {@link #getContentBackgroundDesign contentBackgroundDesign}. * * Specifies the content background design. * * Default value is `Standard`. * * @since 1.115 * * @returns Value of property `contentBackgroundDesign` */ getContentBackgroundDesign(): sap.m.PageBackgroundDesign; /** * Gets content of aggregation {@link #getHeader header}. * * The control to appear in the header area. */ getHeader(): sap.ui.core.Control; /** * Gets content of aggregation {@link #getMainContents mainContents}. * * The content section. */ getMainContents(): sap.ui.core.Control[]; /** * Gets content of aggregation {@link #getSideContent sideContent}. * * The side menu of the layout. */ getSideContent(): sap.tnt.SideNavigation; /** * Gets current value of property {@link #getSideExpanded sideExpanded}. * * Indicates if the side menu is expanded. Overrides the `expanded` property of the `sideContent` aggregation. * *Note:** By default, on mobile phone devices and small screens, the side content is collapsed to provide * more space for the main content. On larger screens, excluding mobile phone devices, it is expanded. This * behavior can be overridden by setting this property. * * Default value is `true`. * * * @returns Value of property `sideExpanded` */ getSideExpanded(): boolean; /** * Gets content of aggregation {@link #getSubHeader subHeader}. * * The control to appear in the subheader area. * * @since 1.93 */ getSubHeader(): sap.ui.core.Control; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getMainContents mainContents}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfMainContent( /** * The mainContent whose index is looked for */ oMainContent: sap.ui.core.Control ): int; /** * Inserts a mainContent into the aggregation {@link #getMainContents mainContents}. * * * @returns Reference to `this` in order to allow method chaining */ insertMainContent( /** * The mainContent to insert; if empty, nothing is inserted */ oMainContent: sap.ui.core.Control, /** * The `0`-based index the mainContent should be inserted at; for a negative value of `iIndex`, the mainContent * is inserted at position 0; for a value greater than the current size of the aggregation, the mainContent * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getMainContents mainContents}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllMainContents(): sap.ui.core.Control[]; /** * Removes a mainContent from the aggregation {@link #getMainContents mainContents}. * * * @returns The removed mainContent or `null` */ removeMainContent( /** * The mainContent to remove or its index or id */ vMainContent: int | string | sap.ui.core.Control ): sap.ui.core.Control | null; /** * Sets a new value for property {@link #getContentBackgroundDesign contentBackgroundDesign}. * * Specifies the content background design. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Standard`. * * @since 1.115 * * @returns Reference to `this` in order to allow method chaining */ setContentBackgroundDesign( /** * New value for property `contentBackgroundDesign` */ sContentBackgroundDesign?: sap.m.PageBackgroundDesign ): this; /** * Sets the aggregated {@link #getHeader header}. * * * @returns Reference to `this` in order to allow method chaining */ setHeader( /** * The header to set */ oHeader: sap.ui.core.Control ): this; /** * Sets the aggregated {@link #getSideContent sideContent}. * * * @returns Reference to `this` in order to allow method chaining */ setSideContent( /** * The sideContent to set */ oSideContent: sap.tnt.SideNavigation ): this; /** * Sets the expand/collapse state of the SideContent. * * * @returns Pointer to the control instance for chaining */ setSideExpanded( /** * defines whether the SideNavigation is expanded. */ bSideExpanded: boolean ): this; /** * Sets the aggregated {@link #getSubHeader subHeader}. * * @since 1.93 * * @returns Reference to `this` in order to allow method chaining */ setSubHeader( /** * The subHeader to set */ oSubHeader: sap.ui.core.Control ): this; /** * Toggles the expand/collapse state of the SideContent. * * * @returns Pointer to the control instance for chaining. */ toggleSideContentMode(): this; } /** * Available TNT `Illustration` types for the {@link sap.m.IllustratedMessage} control. * * @since 1.121 */ enum IllustratedMessageType { /** * "Avatar" illustration type. */ Avatar = "tnt-Avatar", /** * "Calculator" illustration type. */ Calculator = "tnt-Calculator", /** * "ChartArea" illustration type. */ ChartArea = "tnt-ChartArea", /** * "ChartArea2" illustration type. */ ChartArea2 = "tnt-ChartArea2", /** * "ChartBar" illustration type. */ ChartBar = "tnt-ChartBar", /** * "ChartBPMNFlow" illustration type. */ ChartBPMNFlow = "tnt-ChartBPMNFlow", /** * "ChartBullet" illustration type. */ ChartBullet = "tnt-ChartBullet", /** * "ChartDoughnut" illustration type. */ ChartDoughnut = "tnt-ChartDoughnut", /** * "ChartFlow" illustration type. */ ChartFlow = "tnt-ChartFlow", /** * "ChartGantt" illustration type. */ ChartGantt = "tnt-ChartGantt", /** * "ChartOrg" illustration type. */ ChartOrg = "tnt-ChartOrg", /** * "ChartPie" illustration type. */ ChartPie = "tnt-ChartPie", /** * "CodePlaceholder" illustration type. */ CodePlaceholder = "tnt-CodePlaceholder", /** * "Company" illustration type. */ Company = "tnt-Company", /** * "Compass" illustration type. */ Compass = "tnt-Compass", /** * "Components" illustration type. */ Components = "tnt-Components", /** * "Dialog" illustration type. */ Dialog = "tnt-Dialog", /** * "EmptyContentPane" illustration type. */ EmptyContentPane = "tnt-EmptyContentPane", /** * "ExternalLink" illustration type. */ ExternalLink = "tnt-ExternalLink", /** * "FaceID" illustration type. */ FaceID = "tnt-FaceID", /** * "Fingerprint" illustration type. */ Fingerprint = "tnt-Fingerprint", /** * "Handshake" illustration type. */ Handshake = "tnt-Handshake", /** * "Help" illustration type. */ Help = "tnt-Help", /** * "Lock" illustration type. */ Lock = "tnt-Lock", /** * "Mission" illustration type. */ Mission = "tnt-Mission", /** * "MissionFailed" illustration type. */ MissionFailed = "tnt-MissionFailed", /** * "NoApplications" illustration type. */ NoApplications = "tnt-NoApplications", /** * "NoFlows" illustration type. */ NoFlows = "tnt-NoFlows", /** * "NoUsers" illustration type. */ NoUsers = "tnt-NoUsers", /** * "Radar" illustration type. */ Radar = "tnt-Radar", /** * "RoadMap" illustration type. */ RoadMap = "tnt-RoadMap", /** * "Secrets" illustration type. */ Secrets = "tnt-Secrets", /** * "Services" illustration type. */ Services = "tnt-Services", /** * "SessionExpired" illustration type. */ SessionExpired = "tnt-SessionExpired", /** * "SessionExpiring" illustration type. */ SessionExpiring = "tnt-SessionExpiring", /** * "Settings" illustration type. */ Settings = "tnt-Settings", /** * "Success" illustration type. */ Success = "tnt-Success", /** * "SuccessfulAuth" illustration type. */ SuccessfulAuth = "tnt-SuccessfulAuth", /** * "Systems" illustration type. */ Systems = "tnt-Systems", /** * "Teams" illustration type. */ Teams = "tnt-Teams", /** * "Tools" illustration type. */ Tools = "tnt-Tools", /** * "Tutorials" illustration type. */ Tutorials = "tnt-Tutorials", /** * "UnableToLoad" illustration type. */ UnableToLoad = "tnt-UnableToLoad", /** * "Unlock" illustration type. */ Unlock = "tnt-Unlock", /** * "UnsuccessfulAuth" illustration type. */ UnsuccessfulAuth = "tnt-UnsuccessfulAuth", /** * "User2" illustration type. */ User2 = "tnt-User2", } /** * Available types for navigation list item. * * This enum is part of the 'sap/tnt/library' module export and must be accessed by the property 'NavigationListItemDesign'. * * @since 1.133.0 */ enum NavigationListItemDesign { /** * Navigation list item type which provides access to frequent functionality. */ Action = "Action", /** * Navigation list item type which enables navigation or contains navigation child items, or both. */ Default = "Default", } /** * Predefined types of `InfoLabel` * * This enum is part of the 'sap/tnt/library' module export and must be accessed by the property 'RenderMode'. */ enum RenderMode { /** * When type of the content of `InfoLabel` is text padding are loose */ Loose = "Loose", /** * When type of the content of `InfoLabel` is numeric paddings are narrow */ Narrow = "Narrow", } /** * Available options for the Side Navigation design. * * This enum is part of the 'sap/tnt/library' module export and must be accessed by the property 'SideNavigationDesign'. * * @since 1.134.0 */ enum SideNavigationDesign { /** * Side Navigation has a shadow and border. */ Decorated = "Decorated", /** * Side Navigation without any shadow or border. */ Plain = "Plain", } /** * Event object of the NavigationList#itemPress event. */ type NavigationList$ItemPressEvent = sap.ui.base.Event< NavigationList$ItemPressEventParameters, NavigationList >; /** * Event object of the NavigationList#itemSelect event. */ type NavigationList$ItemSelectEvent = sap.ui.base.Event< NavigationList$ItemSelectEventParameters, NavigationList >; /** * Event object of the NavigationListItem#select event. */ type NavigationListItem$SelectEvent = sap.ui.base.Event< NavigationListItem$SelectEventParameters, NavigationListItem >; /** * Event object of the NavigationListItemBase#press event. */ type NavigationListItemBase$PressEvent = sap.ui.base.Event< NavigationListItemBase$PressEventParameters, NavigationListItemBase >; /** * Event object of the SideNavigation#itemPress event. */ type SideNavigation$ItemPressEvent = sap.ui.base.Event< SideNavigation$ItemPressEventParameters, SideNavigation >; /** * Event object of the SideNavigation#itemSelect event. */ type SideNavigation$ItemSelectEvent = sap.ui.base.Event< SideNavigation$ItemSelectEventParameters, SideNavigation >; } interface IUI5DefineDependencyNames { "sap/tnt/IllustratedMessageType": undefined; "sap/tnt/InfoLabel": undefined; "sap/tnt/library": undefined; "sap/tnt/NavigationList": undefined; "sap/tnt/NavigationListGroup": undefined; "sap/tnt/NavigationListItem": undefined; "sap/tnt/NavigationListItemBase": undefined; "sap/tnt/SideNavigation": undefined; "sap/tnt/ToolHeader": undefined; "sap/tnt/ToolHeaderUtilitySeparator": undefined; "sap/tnt/ToolPage": undefined; } }