// For Library Version: 1.149.0 declare namespace sap { namespace ui { /** * SAPUI5 library with smart controls. * **Note:** The controls in this library only support OData V2 (see {@link sap.ui.model.odata.v2.ODataModel}) * and a default model (named `undefined`). * **Note:** Properties of a complex type (used in an OData entity type) cannot be bound by or used with * controls of this library. * **Note:** Most controls in this library do not support key user adaptation. Please see {@link https://ui5.sap.com/#/topic/f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App } * for a list of supported controls. */ namespace comp { namespace config { /** * Describes the settings that can be provided to the ControlConfigurationBase constructor. */ interface $ControlConfigurationBaseSettings extends sap.ui.core.$ElementSettings { /** * The `key` property corresponds to the field name from the OData service $metadata document. */ key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The `conditionType` class name to be used for this filter item. Implementation should derive from sap.ui.comp.config.condition.Type */ conditionType?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the FilterControlConfiguration constructor. */ interface $FilterControlConfigurationSettings extends sap.ui.comp.config.$ControlConfigurationBaseSettings {} /** * An abstract class for configuration of filters in the smart filter bar or in the smart table * * @since 1.126.0 */ class ControlConfigurationBase extends sap.ui.core.Element { /** * Constructor for a new `ControlConfigurationBase` * * 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.ui.comp.config.$ControlConfigurationBaseSettings ); /** * Constructor for a new `ControlConfigurationBase` * * 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.ui.comp.config.$ControlConfigurationBaseSettings ); /** * Creates a new subclass of class sap.ui.comp.config.ControlConfigurationBase with name `sClassName` and * enriches it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.comp.config.ControlConfigurationBase >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.config.ControlConfigurationBase. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getConditionType conditionType}. * * The `conditionType` class name to be used for this filter item. Implementation should derive from sap.ui.comp.config.condition.Type * * * @returns Value of property `conditionType` */ getConditionType(): any; /** * Gets current value of property {@link #getKey key}. * * The `key` property corresponds to the field name from the OData service $metadata document. * * * @returns Value of property `key` */ getKey(): string; /** * Sets a new value for property {@link #getConditionType conditionType}. * * The `conditionType` class name to be used for this filter item. Implementation should derive from sap.ui.comp.config.condition.Type * * 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 */ setConditionType( /** * New value for property `conditionType` */ oConditionType?: any ): this; /** * Sets a new value for property {@link #getKey key}. * * The `key` property corresponds to the field name from the OData service $metadata document. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setKey( /** * New value for property `key` */ sKey?: string ): this; } /** * The `FilterControlConfiguration` can be used to generate the dynamic date range control used for filtering * the smart table. * * @since 1.126.0 */ class FilterControlConfiguration extends sap.ui.comp.config .ControlConfigurationBase { /** * Constructor for a new `FilterControlConfiguration` * * 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.comp.config.ControlConfigurationBase#constructor sap.ui.comp.config.ControlConfigurationBase } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: sap.ui.comp.config.$FilterControlConfigurationSettings ); /** * Constructor for a new `FilterControlConfiguration` * * 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.comp.config.ControlConfigurationBase#constructor sap.ui.comp.config.ControlConfigurationBase } * 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.ui.comp.config.$FilterControlConfigurationSettings ); /** * Creates a new subclass of class sap.ui.comp.config.FilterControlConfiguration 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.comp.config.ControlConfigurationBase.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< T, sap.ui.comp.config.FilterControlConfiguration >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.config.FilterControlConfiguration. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; } } namespace filterbar { namespace FilterBar { type fetchVariantResponse = { filterBarVariant: string | Object; filterbar: Object; orderedFilterItems: string; singleInputsTextArrangementData: string; version: string | undefined; basicSearch: string | undefined; }; } /** * Describes the settings that can be provided to the FilterBar constructor. */ interface $FilterBarSettings extends sap.ui.core.$ControlSettings { /** * Key used to access personalization data. Only if the persistencyKey is provided, will the `VariantManagement` * control be used. */ persistencyKey?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The advanced mode is only relevant for the value help scenario. UI representation is different from the * standard FilterBar. */ advancedMode?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Collapses/expands the advanced area. * * @deprecated As of version 1.30.0. Replaced by property `filterBarExpanded` This property is mapped to * the filterBarExpanded property. */ expandAdvancedArea?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enables/disables the Search button. * * @deprecated As of version 1.32.0. with no replacement. */ searchEnabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Shows the filters area. When property `useToolbar` is set to `false`, `filterBarExpanded` is ignored * automatically and the `FilterBar` is always expanded. **Note:** When `SmartFilterBar` is used inside * a `ValueHelpDialog`, it is initially collapsed. The filter bar is initially expanded in the following * cases: * * - When there is no basic search field. * * - When `preventInitialDataFetchInValueHelpDialog` is set to `true` or the `fetchValues` property of the * `valueList` annotation is set to `2`. * * - When there are mandatory fields, all fields are expanded (not only the first 7). * * @since 1.26.1 */ filterBarExpanded?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If this property is set, then the label for filters will be prefixed with the group title. * * @since 1.28.0 */ considerGroupTitle?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `true`, when the `FilterBar` is expanded it will show all filters, not only the first 7. * * **Note:** This is valid only when the `FilterBar` is used inside a `ValueHelpDialog` * * @since 1.116.0 */ showAllFilters?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Handles visibility of the Clear button on the Filters dialog. * * @deprecated As of version 1.84. with no replacement. Users can select any Variant instead. */ showClearButton?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Handles visibility of the "Restore" button on the "Filters" dialog. **Note:** Restore works only automatically * when a property `persistencyKey` is set and therefore Variant Management is used. In all other cases * the "restore" behavior needs to be implemented by the app, based on the event `reset`. Since 1.84 the * "Restore" button text is changed to "Reset" * * @since 1.26.1 */ showRestoreButton?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Handles visibility of the Go button on the FilterBar. * * @since 1.28.0 */ showGoOnFB?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Handles visibility of the Restore button on the FilterBar. * * @since 1.28.0 */ showRestoreOnFB?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Handles visibility of the Clear button on the FilterBar. * * @since 1.28.0 */ showClearOnFB?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Handles visibility of the Go button on the FilterBar. * * @since 1.26.1 * @deprecated As of version 1.28.0. Replaced by property `showGoOnFB` */ showGoButton?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Stores the delta as compared to the standard variant. * * @since 1.34.0 */ deltaVariantMode?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets the width of the filters container. * * @since 1.34.0 */ filterContainerWidth?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Determines what design is used. Default is the design with toolbar. If the property `useToolbar` is set * to `false`, the property `filterBarExpanded` is ignored automatically and the `FilterBar` is always expanded. * **Note:** * If set to `false`, the `VariantManagement` control is not available at all. This scenario is only intended * for the {@link sap.ui.comp.smartfilterbar.SmartFilterBar}. * * @since 1.38.0 */ useToolbar?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies header text that is shown in the toolbar on the first position. This property is ignored, when * `useToolbar` is set to `false`. * * @since 1.38.0 */ header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Handles visibility of the Filters button on the FilterBar. * * @since 1.38.0 */ showFilterConfiguration?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines the behavior when `reset` is executed. * **Note:** This property is only relevant if no variant management is used, and the filter bar is not * used in the advanced mode. A snapshot shows the current state of the filter bar, just before the Filters * dialog is opened. * - `undefined` (default) defines the standard behavior: snapshot will be applied after `reset` was triggered * * - `false` defines that the snapshot will not be applied * - `true`is not considered at all * * @since 1.44 */ useSnapshot?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets whether the filter bar should look like the filters area in a ValueHelpDialog. True for SmartFilterBar * when used in a ValueHelpDialog. False otherwise. */ isRunningInValueHelpDialog?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Disables the warning for special symbols. * * **Note:** Changing the values here after the SmartFilter is initialized (`initialise` event was fired) * has no effect. * * @since 1.102 */ disableSearchMatchesPatternWarning?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies the semantic header level of the {@link #getHeader header} text property. For more information, * see {@link sap.m.Title#setLevel}. This property is ignored, when `useToolbar` is set to `false`. * * @since 1.121 */ headerLevel?: | sap.ui.core.TitleLevel | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Filters belonging to the basic group. * * @deprecated As of version 1.48.0. Use aggregation `filterGroupItems` instead. */ filterItems?: | sap.ui.comp.filterbar.FilterItem[] | sap.ui.comp.filterbar.FilterItem | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Contains all FilterBar filters. * `Note:`In case a filter has to be added to the basic group * - the property `groupName` has to be set to the constant `sap.ui.comp.filterbar.FilterBar.INTERNAL_GROUP` * * - the property `groupLabel` will be handled internally and will be ignored, if set * - the property `partOfCurrentVariant` has to be set to `true` * - if the property `visibleInFilterBar` is set to `true`, the property `partOfCurrentVariant` will be * set internally also to `true` */ filterGroupItems?: | sap.ui.comp.filterbar.FilterGroupItem[] | sap.ui.comp.filterbar.FilterGroupItem | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Do NOT use this aggregation directly. The `FilterBar` control is not meant to be used with arbitrary * content. It renders filterFields which are added by `filterGroupItems` aggregation. If you need to add * some content below the `FilterBar`, this can be done by adding it as sibling of the `FilterBar`. For * example, if `FilterBar` is child of `DynamicPageHeader`, the custom content can be added to the `DynamicPageHeader` * as well. * * @deprecated As of version 1.122. with no replacement. */ content?: | sap.ui.core.Control[] | sap.ui.core.Control | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Populates the basic search area on the FilterBar and the Filters dialog. * * @since 1.30.0 */ basicSearch?: sap.m.SearchField | string; /** * This event is fired when the Cancel button on the Filters dialog is pressed and the variant is marked * as dirty. */ cancel?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired when the Restore button is pressed. */ reset?: (oEvent: FilterBar$ResetEvent) => void; /** * This event is fired when the Go button is pressed. */ search?: (oEvent: FilterBar$SearchEvent) => void; /** * This event is fired before a variant is saved. The event can be used to adapt the data of the custom * filters, which will be saved as variant later. **Note:** This event is not fired during key user adaptation * of the `FilterBar` right away. The variant is saved when the key user saves the draft. Therefore it's * recommended to use the `beforeVariantFetch` event to adapt the data of custom filters for key user scenarios. */ beforeVariantSave?: ( oEvent: FilterBar$BeforeVariantSaveEvent ) => void; /** * This event is fired before a variant is fetched. * * @since 1.28.13 */ beforeVariantFetch?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired after a variant has been loaded and applied to the `FilterBar`. The event can be * used to adapt custom filters with data from the variant. */ afterVariantLoad?: (oEvent: FilterBar$AfterVariantLoadEvent) => void; /** * This event is fired when a filter or multiple filters has changed. */ filterChange?: (oEvent: FilterBar$FilterChangeEvent) => void; /** * This event is fired when the Clear button is pressed. The consumer has to clear all filters. */ clear?: (oEvent: FilterBar$ClearEvent) => void; /** * This event is fired when the FilterBar is initialized to indicate that metadata are available. */ initialise?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired after the `FilterBar` has been initialized, the user's default variant has been applied, * and a stable filter state has been achieved. With this event all relevant filter information, for example, * for navigation-related actions, is available via {@link sap.ui.comp.filterbar.FilterBar#getUiState}. * * @since 1.38.0 */ initialized?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired after a variant has been saved. */ afterVariantSave?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired after the filters dialog is closed. * * @since 1.34.0 */ filtersDialogClosed?: ( oEvent: FilterBar$FiltersDialogClosedEvent ) => void; /** * This event is fired after the filters dialog is opened. * * @since 1.48.0 */ filtersDialogBeforeOpen?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired when the Go button on the filters dialog is pressed. * * @since 1.48.0 * @deprecated As of version 1.84. with no replacement. */ filtersDialogSearch?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired when the Cancel button on the filters dialog is pressed. * * @since 1.48.0 */ filtersDialogCancel?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired when search field of the filter dialog is changed. * * @since 1.48.0 * @deprecated As of version 1.84. with no replacement. */ filtersDialogSearchForFilters?: ( oEvent: FilterBar$FiltersDialogSearchForFiltersEvent ) => void; /** * This event is fired when the filters information has changed. It indicates specifically that the count * of assigned filters may be changed. One of the intended reaction to this event would be to call `retrieveFiltersWithValuesAsText` * method. * * @since 1.38.0 */ assignedFiltersChanged?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the FilterGroupItem constructor. */ interface $FilterGroupItemSettings extends sap.ui.comp.filterbar.$FilterItemSettings { /** * Title of the group. */ groupTitle?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Name of the group. */ groupName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * If set to true, this filter is visible on the filter bar by default. Mapped against the `visibleInFilterBar` * property. * * @since 1.24.0 * @deprecated As of version 1.26.1. Replaced by property `visibleInFilterBar` */ visibleInAdvancedArea?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the FilterItem constructor. */ interface $FilterItemSettings extends sap.ui.core.$ElementSettings { /** * Label of the filter. */ label?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Name of the filter. This is an identifier for the filter and has to be unique. */ name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Mandatory flag. */ mandatory?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Visibility state of the filter. */ visible?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Tooltip for the filter. */ labelTooltip?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Tooltip for the filter'c control. * * @since 1.52.0 */ controlTooltip?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Determines if a filter is part of the currently selected variant. * **Note:** This property can also be changed using the `visibleInFilterBar` property and by user interaction * in the Select Filters dialog or the variant handling. * * @since 1.26.1 * @deprecated As of version 1.87. Will be internally treated as if always set to true */ partOfCurrentVariant?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of a filter item in the filter bar. * * @since 1.26.1 */ visibleInFilterBar?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * A hidden filter will never be visible in the filter bar control * * @since 1.44.0 */ hiddenFilter?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * EntitySet name to which the filter belongs * * @since 1.58.0 */ entitySetName?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * EntityType name to which the filter belongs * * @since 1.58.0 */ entityTypeName?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The control of the filter. */ control?: sap.ui.core.Control; /** * This event is fired when one of the properties is changed. */ change?: (oEvent: FilterItem$ChangeEvent) => void; } /** * Parameters of the FilterBar#afterVariantLoad event. */ interface FilterBar$AfterVariantLoadEventParameters { /** * Context of the event. Can also be `null` or `undefined` */ context?: string; /** * executeOnSelect indicates if the variant will trigger search */ executeOnSelect?: boolean; } /** * Parameters of the FilterBar#afterVariantSave event. */ interface FilterBar$AfterVariantSaveEventParameters {} /** * Parameters of the FilterBar#assignedFiltersChanged event. */ interface FilterBar$AssignedFiltersChangedEventParameters {} /** * Parameters of the FilterBar#beforeVariantFetch event. */ interface FilterBar$BeforeVariantFetchEventParameters {} /** * Parameters of the FilterBar#beforeVariantSave event. */ interface FilterBar$BeforeVariantSaveEventParameters { /** * Context of the event. Can also be `null` or `undefined` */ context?: string; } /** * Parameters of the FilterBar#cancel event. */ interface FilterBar$CancelEventParameters {} /** * Parameters of the FilterBar#clear event. */ interface FilterBar$ClearEventParameters { /** * Visible controls */ selectionSet?: sap.ui.core.Control[]; } /** * Parameters of the FilterBar#filterChange event. */ interface FilterBar$FilterChangeEventParameters { /** * This property is provided, whenever a filter is added via the add/remove filters dialog. */ added?: sap.ui.core.Control; /** * This property is provided, whenever a filter is removed via the add/remove filters dialog. */ deleted?: sap.ui.core.Control; /** * The filter item is only provided along with added or deleted properties. */ filterItem?: sap.ui.comp.filterbar.FilterGroupItem; } /** * Parameters of the FilterBar#filtersDialogBeforeOpen event. */ interface FilterBar$FiltersDialogBeforeOpenEventParameters {} /** * Parameters of the FilterBar#filtersDialogCancel event. */ interface FilterBar$FiltersDialogCancelEventParameters {} /** * Parameters of the FilterBar#filtersDialogClosed event. */ interface FilterBar$FiltersDialogClosedEventParameters { /** * Context of the event. Can also be `null` or `undefined` */ context?: string; } /** * Parameters of the FilterBar#filtersDialogSearch event. * * @deprecated As of version 1.84. with no replacement. */ interface FilterBar$FiltersDialogSearchEventParameters {} /** * Parameters of the FilterBar#filtersDialogSearchForFilters event. * * @deprecated As of version 1.84. with no replacement. */ interface FilterBar$FiltersDialogSearchForFiltersEventParameters { /** * Contains the entered search filed value */ newValue?: string; } /** * Parameters of the FilterBar#initialise event. */ interface FilterBar$InitialiseEventParameters {} /** * Parameters of the FilterBar#initialized event. */ interface FilterBar$InitializedEventParameters {} /** * Parameters of the FilterBar#reset event. */ interface FilterBar$ResetEventParameters { /** * Visible controls */ selectionSet?: sap.ui.core.Control[]; } /** * Parameters of the FilterBar#search event. */ interface FilterBar$SearchEventParameters { /** * Visible controls */ selectionSet?: sap.ui.core.Control[]; /** * Set to `true` when event is fired due to user action in `FilterBar` */ firedFromFilterBar?: boolean; } /** * Parameters of the FilterItem#change event. */ interface FilterItem$ChangeEventParameters { /** * Name of the changed property */ propertyName?: string; } /** * The `FilterBar` displays filters in a user-friendly manner to populate values for a query. The `FilterBar` * consists of a row containing the {@link sap.ui.comp.smartvariants.SmartVariantManagement `SmartVariantManagement` } * control, the related buttons, and an area underneath displaying the filters. * * The filters are arranged in a logical row that is divided depending on the space available and the width * of the filters. The area containing the filters can be hidden or shown using the **Hide FilterBar** / * **Show FilterBar** button. The **Go** button triggers the search event, and the **Adapt Filters** button * shows the `Adapt Filters Dialog`. * * In this dialog, the user has full control over the `FilterBar`. */ class FilterBar extends sap.ui.core.Control { /** * Constructor for a new FilterBar. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/2ae520a67c44495ab5dbc69668c47a7f Filter Bar} * {@link fiori:https://experience.sap.com/fiori-design-web/filter-bar/ Filter Bar} */ constructor( /** * initial settings for the new control */ mSettings?: sap.ui.comp.filterbar.$FilterBarSettings ); /** * Constructor for a new FilterBar. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/2ae520a67c44495ab5dbc69668c47a7f Filter Bar} * {@link fiori:https://experience.sap.com/fiori-design-web/filter-bar/ Filter Bar} */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string, /** * initial settings for the new control */ mSettings?: sap.ui.comp.filterbar.$FilterBarSettings ); /** * Creates a new subclass of class sap.ui.comp.filterbar.FilterBar with name `sClassName` and enriches it * with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.filterbar.FilterBar. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds a `FilterGroupItem` element to the aggregation `_parameters`. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to this in order to allow method chaining */ _addParameter( /** * adding a analytical parameter */ oParameter: sap.ui.comp.filterbar.FilterGroupItem ): this; /** * Checks if running on tablet. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns `True` if tablet, `false` otherwise */ _isTablet(): boolean; /** * Retrieves the controls for all visible filters. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns all visible controls/filter name & controls */ _retrieveCurrentSelectionSet( /** * determines the returning structure. Either list of controls, or list of filter name and control. */ bWithName: boolean, /** * determines if parameters should be considered. */ bConsiderParameters: boolean ): any[]; /** * Updates the 'Filters'-button text with the count of filters with values * * @ui5-protected Do not call from applications (only from related classes in the framework) */ _updateToolbarText(): void; /** * Enables to add application specific content as a custom view to the new adapt filters dialog. */ addAdaptFilterDialogCustomContent( /** * the setting for the custom view */ mCustomView: { /** * the custom button used in the view switch */ item: sap.m.SegmentedButtonItem; /** * the content displayed in the custom view */ content: sap.ui.core.Control; /** * Title to be displayed in the overflow toolbar for the custom view */ title?: string; /** * callback triggered by search - executed with the string as parameter */ search?: Function; /** * not used any more */ filterSelect?: Function; /** * callback triggered by selecting a view - executed with the key as parameter */ selectionChange?: Function; /** * callback triggered when restoreDefaults is called - allows custom views to reset their state * * Note: This API is designed to fulfill the need of adding visual filters to "Adapt Filters" dialog so * applications can achieve the ALP scenario in free style. Other usages are not encouraged. */ reset?: Function; } ): void; /** * Adds some content to the aggregation {@link #getContent content}. * * @deprecated As of version 1.122. with no replacement. * * @returns Reference to `this` in order to allow method chaining */ addContent( /** * The content to add; if empty, nothing is inserted */ oContent: sap.ui.core.Control ): this; /** * Enables to add application specific content to the filters dialog. If the content was not yet added it * will be added. The content will be set to visible, all other filters dialog content will be set to invisible. * Not implemented yet for the new Adapt Filters dialog * * @deprecated As of version 1.84. with no replacement. * * @returns `oContent` added or `null` when filters dialog is not active */ addFilterDialogContent( /** * to be added; if empty, nothing is inserted. */ oContent: sap.ui.core.Control ): sap.ui.core.Control | null; /** * Adds some filterGroupItem to the aggregation {@link #getFilterGroupItems filterGroupItems}. * * * @returns Reference to `this` in order to allow method chaining */ addFilterGroupItem( /** * The filterGroupItem to add; if empty, nothing is inserted */ oFilterGroupItem: sap.ui.comp.filterbar.FilterGroupItem ): this; /** * Adds some filterItem to the aggregation {@link #getFilterItems filterItems}. * * @deprecated As of version 1.48.0. Use aggregation `filterGroupItems` instead. * * @returns Reference to `this` in order to allow method chaining */ addFilterItem( /** * The filterItem to add; if empty, nothing is inserted */ oFilterItem: sap.ui.comp.filterbar.FilterItem ): this; /** * Applies the variant. */ applyVariant( /** * JSON object */ oVariant: Object, /** * Describes in which context the variant is applied. The context is passed on to the application via the * afterVariantLoad event */ sContext: string, /** * indicates if the apply was executed during the initialization phase. */ bInitial: boolean ): void; /** * Attaches event handler `fnFunction` to the {@link #event:afterVariantLoad afterVariantLoad} event of * this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired after a variant has been loaded and applied to the `FilterBar`. The event can be * used to adapt custom filters with data from the variant. * * * @returns Reference to `this` in order to allow method chaining */ attachAfterVariantLoad( /** * 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: FilterBar$AfterVariantLoadEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:afterVariantLoad afterVariantLoad} event of * this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired after a variant has been loaded and applied to the `FilterBar`. The event can be * used to adapt custom filters with data from the variant. * * * @returns Reference to `this` in order to allow method chaining */ attachAfterVariantLoad( /** * The function to be called when the event occurs */ fnFunction: (p1: FilterBar$AfterVariantLoadEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:afterVariantSave afterVariantSave} event of * this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired after a variant has been saved. * * * @returns Reference to `this` in order to allow method chaining */ attachAfterVariantSave( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:afterVariantSave afterVariantSave} event of * this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired after a variant has been saved. * * * @returns Reference to `this` in order to allow method chaining */ attachAfterVariantSave( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:assignedFiltersChanged assignedFiltersChanged } * event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when the filters information has changed. It indicates specifically that the count * of assigned filters may be changed. One of the intended reaction to this event would be to call `retrieveFiltersWithValuesAsText` * method. * * @since 1.38.0 * * @returns Reference to `this` in order to allow method chaining */ attachAssignedFiltersChanged( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:assignedFiltersChanged assignedFiltersChanged } * event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when the filters information has changed. It indicates specifically that the count * of assigned filters may be changed. One of the intended reaction to this event would be to call `retrieveFiltersWithValuesAsText` * method. * * @since 1.38.0 * * @returns Reference to `this` in order to allow method chaining */ attachAssignedFiltersChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeVariantFetch beforeVariantFetch} event * of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired before a variant is fetched. * * @since 1.28.13 * * @returns Reference to `this` in order to allow method chaining */ attachBeforeVariantFetch( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeVariantFetch beforeVariantFetch} event * of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired before a variant is fetched. * * @since 1.28.13 * * @returns Reference to `this` in order to allow method chaining */ attachBeforeVariantFetch( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeVariantSave beforeVariantSave} event of * this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired before a variant is saved. The event can be used to adapt the data of the custom * filters, which will be saved as variant later. **Note:** This event is not fired during key user adaptation * of the `FilterBar` right away. The variant is saved when the key user saves the draft. Therefore it's * recommended to use the `beforeVariantFetch` event to adapt the data of custom filters for key user scenarios. * * * @returns Reference to `this` in order to allow method chaining */ attachBeforeVariantSave( /** * 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: FilterBar$BeforeVariantSaveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeVariantSave beforeVariantSave} event of * this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired before a variant is saved. The event can be used to adapt the data of the custom * filters, which will be saved as variant later. **Note:** This event is not fired during key user adaptation * of the `FilterBar` right away. The variant is saved when the key user saves the draft. Therefore it's * recommended to use the `beforeVariantFetch` event to adapt the data of custom filters for key user scenarios. * * * @returns Reference to `this` in order to allow method chaining */ attachBeforeVariantSave( /** * The function to be called when the event occurs */ fnFunction: (p1: FilterBar$BeforeVariantSaveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when the Cancel button on the Filters dialog is pressed and the variant is marked * as dirty. * * * @returns Reference to `this` in order to allow method chaining */ attachCancel( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when the Cancel button on the Filters dialog is pressed and the variant is marked * as dirty. * * * @returns Reference to `this` in order to allow method chaining */ attachCancel( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:clear clear} event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when the Clear button is pressed. The consumer has to clear all filters. * * * @returns Reference to `this` in order to allow method chaining */ attachClear( /** * 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: FilterBar$ClearEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:clear clear} event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when the Clear button is pressed. The consumer has to clear all filters. * * * @returns Reference to `this` in order to allow method chaining */ attachClear( /** * The function to be called when the event occurs */ fnFunction: (p1: FilterBar$ClearEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:filterChange filterChange} event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when a filter or multiple filters has changed. * * * @returns Reference to `this` in order to allow method chaining */ attachFilterChange( /** * 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: FilterBar$FilterChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:filterChange filterChange} event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when a filter or multiple filters has changed. * * * @returns Reference to `this` in order to allow method chaining */ attachFilterChange( /** * The function to be called when the event occurs */ fnFunction: (p1: FilterBar$FilterChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:filtersDialogBeforeOpen filtersDialogBeforeOpen } * event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired after the filters dialog is opened. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ attachFiltersDialogBeforeOpen( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:filtersDialogBeforeOpen filtersDialogBeforeOpen } * event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired after the filters dialog is opened. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ attachFiltersDialogBeforeOpen( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:filtersDialogCancel filtersDialogCancel} event * of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when the Cancel button on the filters dialog is pressed. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ attachFiltersDialogCancel( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:filtersDialogCancel filtersDialogCancel} event * of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when the Cancel button on the filters dialog is pressed. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ attachFiltersDialogCancel( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:filtersDialogClosed filtersDialogClosed} event * of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired after the filters dialog is closed. * * @since 1.34.0 * * @returns Reference to `this` in order to allow method chaining */ attachFiltersDialogClosed( /** * 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: FilterBar$FiltersDialogClosedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:filtersDialogClosed filtersDialogClosed} event * of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired after the filters dialog is closed. * * @since 1.34.0 * * @returns Reference to `this` in order to allow method chaining */ attachFiltersDialogClosed( /** * The function to be called when the event occurs */ fnFunction: (p1: FilterBar$FiltersDialogClosedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:filtersDialogSearch filtersDialogSearch} event * of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when the Go button on the filters dialog is pressed. * * @since 1.48.0 * @deprecated As of version 1.84. with no replacement. * * @returns Reference to `this` in order to allow method chaining */ attachFiltersDialogSearch( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:filtersDialogSearch filtersDialogSearch} event * of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when the Go button on the filters dialog is pressed. * * @since 1.48.0 * @deprecated As of version 1.84. with no replacement. * * @returns Reference to `this` in order to allow method chaining */ attachFiltersDialogSearch( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:filtersDialogSearchForFilters filtersDialogSearchForFilters } * event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when search field of the filter dialog is changed. * * @since 1.48.0 * @deprecated As of version 1.84. with no replacement. * * @returns Reference to `this` in order to allow method chaining */ attachFiltersDialogSearchForFilters( /** * 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: FilterBar$FiltersDialogSearchForFiltersEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:filtersDialogSearchForFilters filtersDialogSearchForFilters } * event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when search field of the filter dialog is changed. * * @since 1.48.0 * @deprecated As of version 1.84. with no replacement. * * @returns Reference to `this` in order to allow method chaining */ attachFiltersDialogSearchForFilters( /** * The function to be called when the event occurs */ fnFunction: ( p1: FilterBar$FiltersDialogSearchForFiltersEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialise initialise} event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when the FilterBar is initialized to indicate that metadata are available. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialise( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialise initialise} event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when the FilterBar is initialized to indicate that metadata are available. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialise( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialized initialized} event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired after the `FilterBar` has been initialized, the user's default variant has been applied, * and a stable filter state has been achieved. With this event all relevant filter information, for example, * for navigation-related actions, is available via {@link sap.ui.comp.filterbar.FilterBar#getUiState}. * * @since 1.38.0 * * @returns Reference to `this` in order to allow method chaining */ attachInitialized( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialized initialized} event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired after the `FilterBar` has been initialized, the user's default variant has been applied, * and a stable filter state has been achieved. With this event all relevant filter information, for example, * for navigation-related actions, is available via {@link sap.ui.comp.filterbar.FilterBar#getUiState}. * * @since 1.38.0 * * @returns Reference to `this` in order to allow method chaining */ attachInitialized( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:reset reset} event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when the Restore button is pressed. * * * @returns Reference to `this` in order to allow method chaining */ attachReset( /** * 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: FilterBar$ResetEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:reset reset} event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when the Restore button is pressed. * * * @returns Reference to `this` in order to allow method chaining */ attachReset( /** * The function to be called when the event occurs */ fnFunction: (p1: FilterBar$ResetEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:search search} event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when the Go button is pressed. * * * @returns Reference to `this` in order to allow method chaining */ attachSearch( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: FilterBar$SearchEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:search search} event of this `sap.ui.comp.filterbar.FilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterBar` itself. * * This event is fired when the Go button is pressed. * * * @returns Reference to `this` in order to allow method chaining */ attachSearch( /** * The function to be called when the event occurs */ fnFunction: (p1: FilterBar$SearchEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterBar` itself */ oListener?: object ): this; /** * Resets the current selection in the variant management control to standard. */ clearVariantSelection(): void; /** * Destroys all the content in the aggregation {@link #getContent content}. * * @deprecated As of version 1.122. with no replacement. * * @returns Reference to `this` in order to allow method chaining */ destroyContent(): this; /** * Destroys all the filterGroupItems in the aggregation {@link #getFilterGroupItems filterGroupItems}. * * * @returns Reference to `this` in order to allow method chaining */ destroyFilterGroupItems(): this; /** * Destroys all the filterItems in the aggregation {@link #getFilterItems filterItems}. * * @deprecated As of version 1.48.0. Use aggregation `filterGroupItems` instead. * * @returns Reference to `this` in order to allow method chaining */ destroyFilterItems(): this; /** * Detaches event handler `fnFunction` from the {@link #event:afterVariantLoad afterVariantLoad} event of * this `sap.ui.comp.filterbar.FilterBar`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachAfterVariantLoad( /** * The function to be called, when the event occurs */ fnFunction: (p1: FilterBar$AfterVariantLoadEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:afterVariantSave afterVariantSave} event of * this `sap.ui.comp.filterbar.FilterBar`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachAfterVariantSave( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:assignedFiltersChanged assignedFiltersChanged } * event of this `sap.ui.comp.filterbar.FilterBar`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.38.0 * * @returns Reference to `this` in order to allow method chaining */ detachAssignedFiltersChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:beforeVariantFetch beforeVariantFetch} event * of this `sap.ui.comp.filterbar.FilterBar`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.28.13 * * @returns Reference to `this` in order to allow method chaining */ detachBeforeVariantFetch( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:beforeVariantSave beforeVariantSave} event * of this `sap.ui.comp.filterbar.FilterBar`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachBeforeVariantSave( /** * The function to be called, when the event occurs */ fnFunction: (p1: FilterBar$BeforeVariantSaveEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:cancel cancel} event of this `sap.ui.comp.filterbar.FilterBar`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachCancel( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:clear clear} event of this `sap.ui.comp.filterbar.FilterBar`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachClear( /** * The function to be called, when the event occurs */ fnFunction: (p1: FilterBar$ClearEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:filterChange filterChange} event of this `sap.ui.comp.filterbar.FilterBar`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachFilterChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: FilterBar$FilterChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:filtersDialogBeforeOpen filtersDialogBeforeOpen } * event of this `sap.ui.comp.filterbar.FilterBar`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ detachFiltersDialogBeforeOpen( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:filtersDialogCancel filtersDialogCancel} event * of this `sap.ui.comp.filterbar.FilterBar`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ detachFiltersDialogCancel( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:filtersDialogClosed filtersDialogClosed} event * of this `sap.ui.comp.filterbar.FilterBar`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.34.0 * * @returns Reference to `this` in order to allow method chaining */ detachFiltersDialogClosed( /** * The function to be called, when the event occurs */ fnFunction: (p1: FilterBar$FiltersDialogClosedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:filtersDialogSearch filtersDialogSearch} event * of this `sap.ui.comp.filterbar.FilterBar`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.48.0 * @deprecated As of version 1.84. with no replacement. * * @returns Reference to `this` in order to allow method chaining */ detachFiltersDialogSearch( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:filtersDialogSearchForFilters filtersDialogSearchForFilters } * event of this `sap.ui.comp.filterbar.FilterBar`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.48.0 * @deprecated As of version 1.84. with no replacement. * * @returns Reference to `this` in order to allow method chaining */ detachFiltersDialogSearchForFilters( /** * The function to be called, when the event occurs */ fnFunction: ( p1: FilterBar$FiltersDialogSearchForFiltersEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:initialise initialise} event of this `sap.ui.comp.filterbar.FilterBar`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachInitialise( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:initialized initialized} event of this `sap.ui.comp.filterbar.FilterBar`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.38.0 * * @returns Reference to `this` in order to allow method chaining */ detachInitialized( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:reset reset} event of this `sap.ui.comp.filterbar.FilterBar`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachReset( /** * The function to be called, when the event occurs */ fnFunction: (p1: FilterBar$ResetEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:search search} event of this `sap.ui.comp.filterbar.FilterBar`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSearch( /** * The function to be called, when the event occurs */ fnFunction: (p1: FilterBar$SearchEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Retrieves the control associated to the filter. * * * @returns The corresponding control. If no match is found `null` is returned. */ determineControlByFilterItem( /** * From the aggregations */ oFilterItem: sap.ui.comp.filterbar.FilterItem, /** * check also analytics parameter */ bConsiderParameters: boolean ): sap.ui.core.Control; /** * Retrieves the control based on the name and group name. * * * @returns The corresponding control, if no match is found, `null` is returned. */ determineControlByName( /** * Name of the filter. */ sName: string, /** * Group name of the filter; `null` for filter that belongs to basic group. */ sGroupName?: string ): sap.ui.core.Control; /** * Retrieves the filter corresponding to the filter name. * * * @returns the corresponding filter item. If no match is found `null` will returned. */ determineFilterItemByName( /** * the control's name */ sName: string, /** * the filter's group name */ sGroupName: string ): sap.ui.comp.filterbar.FilterGroupItem; /** * Retrieves the associated label based on the name and group name. * * * @returns The associated Label, if no match is found, `null` is returned. */ determineLabelByName( /** * Name of the filter. */ sName: string, /** * Group name of the filter; `null` for filter that belongs to basic group. */ sGroupName: string ): sap.m.Label; /** * Retrieves the mandatory filters. * * * @returns Of visible mandatory filters */ determineMandatoryFilterItems(): any[]; /** * Creates and returns the variant representation. * * * @returns An arbitrary Object with an example structure: * * ```javascript * { * filterBarVariant: any, * filterbar: [ * { * group: string, * name: string, * partOfCurrentVariant: boolean, * visible: boolean, * visibleInFilterBar: boolean * }, * ... * ], * orderedFilterItems: string, * singleInputsTextArrangementData: string, * version: string|undefined, * basicSearch: string|undefined * }``` */ fetchVariant(): sap.ui.comp.filterbar.FilterBar.fetchVariantResponse; /** * Fires event {@link #event:afterVariantSave afterVariantSave} 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 */ fireAfterVariantSave( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:assignedFiltersChanged assignedFiltersChanged} to attached listeners. * * @since 1.38.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireAssignedFiltersChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:beforeVariantFetch beforeVariantFetch} to attached listeners. * * @since 1.28.13 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireBeforeVariantFetch( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:cancel cancel} 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 */ fireCancel( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:clear clear} 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 */ fireClear( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.filterbar.FilterBar$ClearEventParameters ): this; /** * Fires event {@link #event:filterChange filterChange} 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 */ fireFilterChange( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.filterbar.FilterBar$FilterChangeEventParameters ): this; /** * Fires event {@link #event:filtersDialogBeforeOpen filtersDialogBeforeOpen} to attached listeners. * * @since 1.48.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireFiltersDialogBeforeOpen( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:filtersDialogCancel filtersDialogCancel} to attached listeners. * * @since 1.48.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireFiltersDialogCancel( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:filtersDialogClosed filtersDialogClosed} to attached listeners. * * @since 1.34.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireFiltersDialogClosed( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.filterbar.FilterBar$FiltersDialogClosedEventParameters ): this; /** * Fires event {@link #event:filtersDialogSearch filtersDialogSearch} to attached listeners. * * @since 1.48.0 * @deprecated As of version 1.84. with no replacement. * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireFiltersDialogSearch( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:filtersDialogSearchForFilters filtersDialogSearchForFilters} to attached listeners. * * @since 1.48.0 * @deprecated As of version 1.84. with no replacement. * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireFiltersDialogSearchForFilters( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.filterbar.FilterBar$FiltersDialogSearchForFiltersEventParameters ): this; /** * Fires event {@link #event:initialise initialise} 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 */ fireInitialise( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:initialized initialized} to attached listeners. * * @since 1.38.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireInitialized( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:reset reset} 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 */ fireReset( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.filterbar.FilterBar$ResetEventParameters ): this; /** * Fires event {@link #event:search search} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSearch( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.filterbar.FilterBar$SearchEventParameters ): this; /** * Gets current value of property {@link #getAdvancedMode advancedMode}. * * The advanced mode is only relevant for the value help scenario. UI representation is different from the * standard FilterBar. * * Default value is `false`. * * * @returns Value of property `advancedMode` */ getAdvancedMode(): boolean; /** * Retrieves filters belonging to the current variant. * * * @returns filters Of the current variant */ getAllFilterItems( /** * Indicates that only visible filters are retrieved. **Note:** hidden filters are treated as visible filters. */ bConsiderOnlyVisibleFields: boolean ): any[]; /** * ID of the element which is the current target of the association {@link #getBasicSearch basicSearch}, * or `null`. * * @since 1.30.0 */ getBasicSearch(): sap.ui.core.ID | null; /** * Determine the internal basic search field name. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns name of the basic search field. */ getBasicSearchName(): string; /** * Determine the value of the basic search. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns current value of the basic search field. */ getBasicSearchValue(): string; /** * Gets current value of property {@link #getConsiderGroupTitle considerGroupTitle}. * * If this property is set, then the label for filters will be prefixed with the group title. * * Default value is `false`. * * @since 1.28.0 * * @returns Value of property `considerGroupTitle` */ getConsiderGroupTitle(): boolean; /** * Gets content of aggregation {@link #getContent content}. * * Do NOT use this aggregation directly. The `FilterBar` control is not meant to be used with arbitrary * content. It renders filterFields which are added by `filterGroupItems` aggregation. If you need to add * some content below the `FilterBar`, this can be done by adding it as sibling of the `FilterBar`. For * example, if `FilterBar` is child of `DynamicPageHeader`, the custom content can be added to the `DynamicPageHeader` * as well. * * @deprecated As of version 1.122. with no replacement. */ getContent(): sap.ui.core.Control[]; /** * Retrieves the current variant ID. * * @since 1.28.0 * * @returns ID of the current variant */ getCurrentVariantId(): string; /** * Retrieves the current variant as selection variant for UI navigation * * @since 1.28.0 * @deprecated As of version 1.48. replaced by {@link sap.ui.comp.filterbar.FilterBar#getUiState} * * @returns JSON string representing the selection variant for UI navigation; `null` otherwise */ getDataSuiteFormat( /** * also include empty/invisible fields filter data */ bConsiderAllFilters: boolean ): string; /** * Gets current value of property {@link #getDeltaVariantMode deltaVariantMode}. * * Stores the delta as compared to the standard variant. * * Default value is `true`. * * @since 1.34.0 * * @returns Value of property `deltaVariantMode` */ getDeltaVariantMode(): boolean; /** * Reads the descriptions for given filters and value keys. * * @since 1.75 * @ui5-protected Do not call from applications (only from related classes in the framework) */ getDescriptionForKeys( /** * List of filters with value keys to be retrieved */ aFiltersWithValuesToBeRead: any[] ): void; /** * Gets current value of property {@link #getDisableSearchMatchesPatternWarning disableSearchMatchesPatternWarning}. * * Disables the warning for special symbols. * * **Note:** Changing the values here after the SmartFilter is initialized (`initialise` event was fired) * has no effect. * * Default value is `false`. * * @since 1.102 * * @returns Value of property `disableSearchMatchesPatternWarning` */ getDisableSearchMatchesPatternWarning(): boolean; /** * Gets current value of property {@link #getFilterBarExpanded filterBarExpanded}. * * Shows the filters area. When property `useToolbar` is set to `false`, `filterBarExpanded` is ignored * automatically and the `FilterBar` is always expanded. **Note:** When `SmartFilterBar` is used inside * a `ValueHelpDialog`, it is initially collapsed. The filter bar is initially expanded in the following * cases: * * - When there is no basic search field. * * - When `preventInitialDataFetchInValueHelpDialog` is set to `true` or the `fetchValues` property of the * `valueList` annotation is set to `2`. * * - When there are mandatory fields, all fields are expanded (not only the first 7). * * Default value is `true`. * * @since 1.26.1 * * @returns Value of property `filterBarExpanded` */ getFilterBarExpanded(): boolean; /** * Gets current value of property {@link #getFilterContainerWidth filterContainerWidth}. * * Sets the width of the filters container. * * Default value is `"12rem"`. * * @since 1.34.0 * * @returns Value of property `filterContainerWidth` */ getFilterContainerWidth(): string; /** * Returns the filter dialog content. `Node:`The original content is a {@link sap.ui.layout.form.Form Form}. * The form may be enhanced with a toolbar to enable the inner switch to an added custom content. Besides * such operations, the original content should not be manipulated in any way. * * @deprecated As of version 1.84. with no replacement. * * @returns of filters dialog content. */ getFilterDialogContent(): any[]; /** * Gets content of aggregation {@link #getFilterGroupItems filterGroupItems}. * * Contains all FilterBar filters. * `Note:`In case a filter has to be added to the basic group * - the property `groupName` has to be set to the constant `sap.ui.comp.filterbar.FilterBar.INTERNAL_GROUP` * * - the property `groupLabel` will be handled internally and will be ignored, if set * - the property `partOfCurrentVariant` has to be set to `true` * - if the property `visibleInFilterBar` is set to `true`, the property `partOfCurrentVariant` will be * set internally also to `true` */ getFilterGroupItems(): sap.ui.comp.filterbar.FilterGroupItem[]; /** * Gets content of aggregation {@link #getFilterItems filterItems}. * * Filters belonging to the basic group. * * @deprecated As of version 1.48.0. Use aggregation `filterGroupItems` instead. */ getFilterItems(): sap.ui.comp.filterbar.FilterItem[]; /** * Gets current value of property {@link #getHeader header}. * * Specifies header text that is shown in the toolbar on the first position. This property is ignored, when * `useToolbar` is set to `false`. * * Default value is `empty string`. * * @since 1.38.0 * * @returns Value of property `header` */ getHeader(): string; /** * Gets current value of property {@link #getHeaderLevel headerLevel}. * * Specifies the semantic header level of the {@link #getHeader header} text property. For more information, * see {@link sap.m.Title#setLevel}. This property is ignored, when `useToolbar` is set to `false`. * * Default value is `Auto`. * * @since 1.121 * * @returns Value of property `headerLevel` */ getHeaderLevel(): sap.ui.core.TitleLevel; /** * Returns promise which will be resolve when the initialized event is fired. */ getInitializedPromise(): Promise; /** * Gets current value of property {@link #getIsRunningInValueHelpDialog isRunningInValueHelpDialog}. * * Sets whether the filter bar should look like the filters area in a ValueHelpDialog. True for SmartFilterBar * when used in a ValueHelpDialog. False otherwise. * * Default value is `false`. * * * @returns Value of property `isRunningInValueHelpDialog` */ getIsRunningInValueHelpDialog(): boolean; /** * Gets current value of property {@link #getPersistencyKey persistencyKey}. * * Key used to access personalization data. Only if the persistencyKey is provided, will the `VariantManagement` * control be used. * * Default value is `empty string`. * * * @returns Value of property `persistencyKey` */ getPersistencyKey(): string; /** * Gets current value of property {@link #getSearchEnabled searchEnabled}. * * Enables/disables the Search button. * * Default value is `true`. * * @deprecated As of version 1.32.0. with no replacement. * * @returns Value of property `searchEnabled` */ getSearchEnabled(): boolean; /** * Gets current value of property {@link #getShowAllFilters showAllFilters}. * * If set to `true`, when the `FilterBar` is expanded it will show all filters, not only the first 7. * * **Note:** This is valid only when the `FilterBar` is used inside a `ValueHelpDialog` * * Default value is `false`. * * @since 1.116.0 * * @returns Value of property `showAllFilters` */ getShowAllFilters(): boolean; /** * Gets current value of property {@link #getShowClearButton showClearButton}. * * Handles visibility of the Clear button on the Filters dialog. * * Default value is `false`. * * @deprecated As of version 1.84. with no replacement. Users can select any Variant instead. * * @returns Value of property `showClearButton` */ getShowClearButton(): boolean; /** * Gets current value of property {@link #getShowClearOnFB showClearOnFB}. * * Handles visibility of the Clear button on the FilterBar. * * Default value is `false`. * * @since 1.28.0 * * @returns Value of property `showClearOnFB` */ getShowClearOnFB(): boolean; /** * Gets current value of property {@link #getShowFilterConfiguration showFilterConfiguration}. * * Handles visibility of the Filters button on the FilterBar. * * Default value is `true`. * * @since 1.38.0 * * @returns Value of property `showFilterConfiguration` */ getShowFilterConfiguration(): boolean; /** * Gets current value of property {@link #getShowGoButton showGoButton}. * * Handles visibility of the Go button on the FilterBar. * * @since 1.26.1 * @deprecated As of version 1.28.0. Replaced by property `showGoOnFB` * * @returns Value of property `showGoButton` */ getShowGoButton(): boolean; /** * Gets current value of property {@link #getShowGoOnFB showGoOnFB}. * * Handles visibility of the Go button on the FilterBar. * * Default value is `true`. * * @since 1.28.0 * * @returns Value of property `showGoOnFB` */ getShowGoOnFB(): boolean; /** * Gets current value of property {@link #getShowRestoreButton showRestoreButton}. * * Handles visibility of the "Restore" button on the "Filters" dialog. **Note:** Restore works only automatically * when a property `persistencyKey` is set and therefore Variant Management is used. In all other cases * the "restore" behavior needs to be implemented by the app, based on the event `reset`. Since 1.84 the * "Restore" button text is changed to "Reset" * * Default value is `true`. * * @since 1.26.1 * * @returns Value of property `showRestoreButton` */ getShowRestoreButton(): boolean; /** * Gets current value of property {@link #getShowRestoreOnFB showRestoreOnFB}. * * Handles visibility of the Restore button on the FilterBar. * * Default value is `false`. * * @since 1.28.0 * * @returns Value of property `showRestoreOnFB` */ getShowRestoreOnFB(): boolean; /** * Retrieves the current UI state of the `FilterBar` control. * The current UI state represents the data suite format. * * @since 1.48 * * @returns object representing the ui-state. Currently only the SelectionVariant part is considered. */ getUiState( /** * controls the API behavior */ mProperties: { /** * include empty/invisible fields filter data */ allFilters?: boolean; } ): sap.ui.comp.state.UIState; /** * Gets current value of property {@link #getUseSnapshot useSnapshot}. * * Determines the behavior when `reset` is executed. * **Note:** This property is only relevant if no variant management is used, and the filter bar is not * used in the advanced mode. A snapshot shows the current state of the filter bar, just before the Filters * dialog is opened. * - `undefined` (default) defines the standard behavior: snapshot will be applied after `reset` was triggered * * - `false` defines that the snapshot will not be applied * - `true`is not considered at all * * @since 1.44 * * @returns Value of property `useSnapshot` */ getUseSnapshot(): boolean; /** * Gets current value of property {@link #getUseToolbar useToolbar}. * * Determines what design is used. Default is the design with toolbar. If the property `useToolbar` is set * to `false`, the property `filterBarExpanded` is ignored automatically and the `FilterBar` is always expanded. * **Note:** * If set to `false`, the `VariantManagement` control is not available at all. This scenario is only intended * for the {@link sap.ui.comp.smartfilterbar.SmartFilterBar}. * * Default value is `true`. * * @since 1.38.0 * * @returns Value of property `useToolbar` */ getUseToolbar(): boolean; /** * Returns the associated VariantManagement control. The returned VariantManagement instance should not * be cached or manipulated in any ways. It should offer the application a convenient way to verify the * dirty state and to check for page variant scenario. The method may return `null` or a disabled VariantManagement * control. * * @since 1.44.0 * * @returns the associated VariantManagement control. */ getVariantManagement(): null | sap.ui.comp.variants.VariantManagement; /** * Hides the Go button on FilterBar. Allows to hide the Go-button for dedicated scenarios, like liveMode. * * @since 1.40.4 * @ui5-protected Do not call from applications (only from related classes in the framework) */ hideGoButton(): void; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getContent content}. and returns * its index if found or -1 otherwise. * * @deprecated As of version 1.122. with no replacement. * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfContent( /** * The content whose index is looked for */ oContent: sap.ui.core.Control ): int; /** * Checks for the provided `sap.ui.comp.filterbar.FilterGroupItem` in the aggregation {@link #getFilterGroupItems filterGroupItems}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfFilterGroupItem( /** * The filterGroupItem whose index is looked for */ oFilterGroupItem: sap.ui.comp.filterbar.FilterGroupItem ): int; /** * Checks for the provided `sap.ui.comp.filterbar.FilterItem` in the aggregation {@link #getFilterItems filterItems}. * and returns its index if found or -1 otherwise. * * @deprecated As of version 1.48.0. Use aggregation `filterGroupItems` instead. * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfFilterItem( /** * The filterItem whose index is looked for */ oFilterItem: sap.ui.comp.filterbar.FilterItem ): int; /** * Inserts a content into the aggregation {@link #getContent content}. * * @deprecated As of version 1.122. with no replacement. * * @returns Reference to `this` in order to allow method chaining */ insertContent( /** * The content to insert; if empty, nothing is inserted */ oContent: sap.ui.core.Control, /** * The `0`-based index the content should be inserted at; for a negative value of `iIndex`, the content * is inserted at position 0; for a value greater than the current size of the aggregation, the content * is inserted at the last position */ iIndex: int ): this; /** * Returns the information whether the flag 'executeOnSelect' is set or not on current variant. * * * @returns Flag 'executeOnSelect' flag. If variant management is disabled `false` is returned. */ isCurrentVariantExecuteOnSelectEnabled(): boolean; /** * Determines if the current variant is the standard variant * * @since 1.44.0 * * @returns indicates if the current variant is the standard variant. In case the variant management does * not exists, `undefined` is returned. */ isCurrentVariantStandard(): boolean | undefined; /** * Determines if the filters dialog is opened. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns State of filters dialog */ isDialogOpen(): boolean; /** * Registration of a callback function. The provided callback function is executed when a variant must be * applied. The callback function will receive the corresponding data set containing all relevant data in * JSON, as initially provided by the callback for fetchData. * * * @returns Returns `this` to allow method chaining. */ registerApplyData( /** * Called when a variant must be applied */ fCallBack: (p1: string, p2: string) => void ): this; /** * Registration of a callback function. The provided callback function is executed when saving a variant * is triggered and must provide all relevant fields and values in JSON. * * * @returns Returns `this` to allow method chaining. */ registerFetchData( /** * Called when a variant must be fetched */ fCallBack: (p1: string) => void ): this; /** * Registration of a callback function. The provided callback function is executed to obtain the filters * with values. * * @since 1.26.1 * * @returns Reference to this in order to allow method chaining. */ registerGetFiltersWithValues( /** * Called when a variant must be applied */ fCallBack: /* was: sap.ui.comp.filterbar.FilterBar.fGetFiltersWithValuesCallBack */ any ): this; /** * Removes all the controls from the aggregation {@link #getContent content}. * * Additionally, it unregisters them from the hosting UIArea. * * @deprecated As of version 1.122. with no replacement. * * @returns An array of the removed elements (might be empty) */ removeAllContent(): sap.ui.core.Control[]; /** * Removes all entries in the aggregation filterGroupItems. * * * @returns An array of the removed elements (might be empty). */ removeAllFilterGroupItems(): sap.ui.comp.filterbar.FilterGroupItem[]; /** * Removes all entries in the aggregation filterItems. * * @deprecated As of version 1.48.0. Use aggregation `filterGroupItems` instead. * * @returns An array of the removed elements (might be empty). */ removeAllFilterItems(): sap.ui.comp.filterbar.FilterItem[]; /** * Removes all entries in the aggregations filterItems, filterGroupItems, basicSearch */ removeAllFilters(): void; /** * Removes a content from the aggregation {@link #getContent content}. * * @deprecated As of version 1.122. with no replacement. * * @returns The removed content or `null` */ removeContent( /** * The content to remove or its index or id */ vContent: int | string | sap.ui.core.Control ): sap.ui.core.Control | null; /** * Removes a filterGroupItem from the aggregation {@link #getFilterGroupItems filterGroupItems}. * * * @returns The removed filterGroupItem or `null` */ removeFilterGroupItem( /** * The filterGroupItem to remove or its index or id */ vFilterGroupItem: | int | string | sap.ui.comp.filterbar.FilterGroupItem ): sap.ui.comp.filterbar.FilterGroupItem | null; /** * Removes a filterItem from the aggregation {@link #getFilterItems filterItems}. * * @deprecated As of version 1.48.0. Use aggregation `filterGroupItems` instead. * * @returns The removed filterItem or `null` */ removeFilterItem( /** * The filterItem to remove or its index or id */ vFilterItem: int | string | sap.ui.comp.filterbar.FilterItem ): sap.ui.comp.filterbar.FilterItem | null; /** * Restores the visibility of the Go button on FilterBar. The visibility of the Go button will be set, according * to the showGoOnFB property. * * @since 1.40.4 * @ui5-protected Do not call from applications (only from related classes in the framework) */ restoreGoButton(): void; /** * Retrieves the labels of all visible filters that belongs to the current variant and have an assigned * value. * * * @returns Filter labels that represents relevant filters with values */ retrieveFiltersWithValues(): any[]; /** * Returns a summary string that contains information about the filters currently assigned. The string starts * with the number of set filters, followed by "filters active" and their labels. * Example: * (3) filters active: Company Code, Fiscal Year, Customer * * * @returns A string that contains the number of set filters and their names */ retrieveFiltersWithValuesAsText(): string; /** * Returns a summary string that contains information about the filters currently assigned. This string * is intended to be used in expanded state. The string starts with the total number of filters set, followed * by "filters active" and if available non-visible, the number of the non-visible with label "hidden" in * brackets. * Example: * (3) filters active (1 hidden) * * * @returns A string that contains the number of set filters and their names */ retrieveFiltersWithValuesAsTextExpanded(): string; /** * Executes the search event. Controls of all visible filters will be passed as event-parameters. * * * @returns indicates the validation result. true means no validation errors. */ search(): boolean; /** * Sets a new value for property {@link #getAdvancedMode advancedMode}. * * The advanced mode is only relevant for the value help scenario. UI representation is different from the * standard FilterBar. * * 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 */ setAdvancedMode( /** * New value for property `advancedMode` */ bAdvancedMode?: boolean ): this; /** * Sets the associated {@link #getBasicSearch basicSearch}. * * @since 1.30.0 * * @returns Reference to `this` in order to allow method chaining */ setBasicSearch( /** * ID of an element which becomes the new target of this basicSearch association; alternatively, an element * instance may be given */ oBasicSearch: sap.ui.core.ID | sap.m.SearchField ): this; /** * Sets a new value for property {@link #getConsiderGroupTitle considerGroupTitle}. * * If this property is set, then the label for filters will be prefixed with the group title. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setConsiderGroupTitle( /** * New value for property `considerGroupTitle` */ bConsiderGroupTitle?: boolean ): this; /** * Sets the height of the content area of the dialog. The passed dimension will be interpreted as 'px'. */ setContentHeight( /** * the content height of the filters dialog. */ fHeight: float ): void; /** * Sets the width of the content area of the dialog. The passed dimension will be interpreted as 'px'. */ setContentWidth( /** * the content width of the filters dialog. */ fWidth: float ): void; /** * Sets the current variant ID. * * @since 1.28.0 */ setCurrentVariantId( /** * ID of the variant */ sVariantId: string, /** * If set to `true`, the `applyVariant` method is not executed yet. Relevant during navigation, when called * before the initialise event has been executed. */ bDoNotApplyVariant: boolean ): void; /** * Sets the selection variant for UI navigation to FilterBar. * * @since 1.28.0 * @deprecated As of version 1.48. replaced by {@link sap.ui.comp.filterbar.FilterBar#setUiState} */ setDataSuiteFormat( /** * Represents the selection variants for UI navigation */ sSuiteData: string, /** * Replaces existing filter data */ bReplace: boolean ): void; /** * Sets a new value for property {@link #getDeltaVariantMode deltaVariantMode}. * * Stores the delta as compared to the standard variant. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.34.0 * * @returns Reference to `this` in order to allow method chaining */ setDeltaVariantMode( /** * New value for property `deltaVariantMode` */ bDeltaVariantMode?: boolean ): this; /** * Sets a new value for property {@link #getDisableSearchMatchesPatternWarning disableSearchMatchesPatternWarning}. * * Disables the warning for special symbols. * * **Note:** Changing the values here after the SmartFilter is initialized (`initialise` event was fired) * has no effect. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.102 * * @returns Reference to `this` in order to allow method chaining */ setDisableSearchMatchesPatternWarning( /** * New value for property `disableSearchMatchesPatternWarning` */ bDisableSearchMatchesPatternWarning?: boolean ): this; /** * Sets a new value for property {@link #getFilterBarExpanded filterBarExpanded}. * * Shows the filters area. When property `useToolbar` is set to `false`, `filterBarExpanded` is ignored * automatically and the `FilterBar` is always expanded. **Note:** When `SmartFilterBar` is used inside * a `ValueHelpDialog`, it is initially collapsed. The filter bar is initially expanded in the following * cases: * * - When there is no basic search field. * * - When `preventInitialDataFetchInValueHelpDialog` is set to `true` or the `fetchValues` property of the * `valueList` annotation is set to `2`. * * - When there are mandatory fields, all fields are expanded (not only the first 7). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.26.1 * * @returns Reference to `this` in order to allow method chaining */ setFilterBarExpanded( /** * New value for property `filterBarExpanded` */ bFilterBarExpanded?: boolean ): this; /** * Sets a new value for property {@link #getFilterContainerWidth filterContainerWidth}. * * Sets the width of the filters container. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"12rem"`. * * @since 1.34.0 * * @returns Reference to `this` in order to allow method chaining */ setFilterContainerWidth( /** * New value for property `filterContainerWidth` */ sFilterContainerWidth?: string ): this; /** * Sets a new value for property {@link #getHeader header}. * * Specifies header text that is shown in the toolbar on the first position. This property is ignored, when * `useToolbar` is set to `false`. * * 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.38.0 * * @returns Reference to `this` in order to allow method chaining */ setHeader( /** * New value for property `header` */ sHeader?: string ): this; /** * Sets a new value for property {@link #getHeaderLevel headerLevel}. * * Specifies the semantic header level of the {@link #getHeader header} text property. For more information, * see {@link sap.m.Title#setLevel}. This property is ignored, when `useToolbar` is set to `false`. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Auto`. * * @since 1.121 * * @returns Reference to `this` in order to allow method chaining */ setHeaderLevel( /** * New value for property `headerLevel` */ sHeaderLevel?: sap.ui.core.TitleLevel ): this; /** * Sets a new value for property {@link #getIsRunningInValueHelpDialog isRunningInValueHelpDialog}. * * Sets whether the filter bar should look like the filters area in a ValueHelpDialog. True for SmartFilterBar * when used in a ValueHelpDialog. False otherwise. * * 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 */ setIsRunningInValueHelpDialog( /** * New value for property `isRunningInValueHelpDialog` */ bIsRunningInValueHelpDialog?: boolean ): this; /** * Sets a new value for property {@link #getPersistencyKey persistencyKey}. * * Key used to access personalization data. Only if the persistencyKey is provided, will the `VariantManagement` * control be used. * * 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 */ setPersistencyKey( /** * New value for property `persistencyKey` */ sPersistencyKey?: string ): this; /** * Sets a new value for property {@link #getSearchEnabled searchEnabled}. * * Enables/disables the Search button. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @deprecated As of version 1.32.0. with no replacement. * * @returns Reference to `this` in order to allow method chaining */ setSearchEnabled( /** * New value for property `searchEnabled` */ bSearchEnabled?: boolean ): this; /** * Sets a new value for property {@link #getShowAllFilters showAllFilters}. * * If set to `true`, when the `FilterBar` is expanded it will show all filters, not only the first 7. * * **Note:** This is valid only when the `FilterBar` is used inside a `ValueHelpDialog` * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.116.0 * * @returns Reference to `this` in order to allow method chaining */ setShowAllFilters( /** * New value for property `showAllFilters` */ bShowAllFilters?: boolean ): this; /** * Sets a new value for property {@link #getShowClearButton showClearButton}. * * Handles visibility of the Clear button on the Filters dialog. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @deprecated As of version 1.84. with no replacement. Users can select any Variant instead. * * @returns Reference to `this` in order to allow method chaining */ setShowClearButton( /** * New value for property `showClearButton` */ bShowClearButton?: boolean ): this; /** * Sets a new value for property {@link #getShowClearOnFB showClearOnFB}. * * Handles visibility of the Clear button on the FilterBar. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setShowClearOnFB( /** * New value for property `showClearOnFB` */ bShowClearOnFB?: boolean ): this; /** * Sets a new value for property {@link #getShowFilterConfiguration showFilterConfiguration}. * * Handles visibility of the Filters button on the FilterBar. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.38.0 * * @returns Reference to `this` in order to allow method chaining */ setShowFilterConfiguration( /** * New value for property `showFilterConfiguration` */ bShowFilterConfiguration?: boolean ): this; /** * Sets a new value for property {@link #getShowGoButton showGoButton}. * * Handles visibility of the Go button on the FilterBar. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.26.1 * @deprecated As of version 1.28.0. Replaced by property `showGoOnFB` * * @returns Reference to `this` in order to allow method chaining */ setShowGoButton( /** * New value for property `showGoButton` */ bShowGoButton?: boolean ): this; /** * Sets a new value for property {@link #getShowGoOnFB showGoOnFB}. * * Handles visibility of the Go button on the FilterBar. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setShowGoOnFB( /** * New value for property `showGoOnFB` */ bShowGoOnFB?: boolean ): this; /** * Once set, the activation of the 'Adapt Filters' button will open the 'old' filters dialog. This method * offers an intermediate solution for the visual filters scenario, which relies on the old filters dialog. * * @deprecated As of version 1.84. with no replacement. * @ui5-protected Do not call from applications (only from related classes in the framework) */ setShowOldFilterDialog(): void; /** * Sets a new value for property {@link #getShowRestoreButton showRestoreButton}. * * Handles visibility of the "Restore" button on the "Filters" dialog. **Note:** Restore works only automatically * when a property `persistencyKey` is set and therefore Variant Management is used. In all other cases * the "restore" behavior needs to be implemented by the app, based on the event `reset`. Since 1.84 the * "Restore" button text is changed to "Reset" * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.26.1 * * @returns Reference to `this` in order to allow method chaining */ setShowRestoreButton( /** * New value for property `showRestoreButton` */ bShowRestoreButton?: boolean ): this; /** * Sets a new value for property {@link #getShowRestoreOnFB showRestoreOnFB}. * * Handles visibility of the Restore button on the FilterBar. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setShowRestoreOnFB( /** * New value for property `showRestoreOnFB` */ bShowRestoreOnFB?: boolean ): this; /** * Sets the current UI state of the `FilterBar` control. * The current UI state represents the data suite format. * * **Note:** When this method is called, any "Default Values" entries from the current filter state are * removed before the new UI state is applied. The values passed via the SelectionVariant are always displayed * as regular filter tokens. This means that after calling `setUiState`, the filter bar will never show * "Default Values" tokens — only the concrete values from the SelectionVariant are shown. * * @since 1.48 */ setUiState( /** * object representing the ui-state. Currently only the SelectionVariant part is considered. */ oUiState: sap.ui.comp.state.UIState, /** * controls the API behavior */ mProperties: { /** * Replaces existing filter data */ replace: boolean; /** * Determines filters and parameters based on the name. * - `true`: Determines filters and parameters based on their exact name and type. If there is no exact * match, the filter/parameter will be ignored. * - `false`: Determines parameters first following this rule set: * If a parameter is found, use it. * - If a filter is found, check first if a matching parameter exists with the filter name prefixed with * "P_". If there is a match, use it as parameter, otherwise use it as filter. */ strictMode: boolean; } ): void; /** * Apply the SelectionPresentationVariant annotated information as a variant. The current UI state represents * the data suite format. * * @since 1.54 */ setUiStateAsVariant( /** * object representing the ui-state.Only the SelectionVariant part is considered */ oUiState: sap.ui.comp.state.UIState, /** * Describes in which context the variant is applied. The context is passed on to the application via the * afterVariantLoad event */ sContext: string ): void; /** * Sets a new value for property {@link #getUseSnapshot useSnapshot}. * * Determines the behavior when `reset` is executed. * **Note:** This property is only relevant if no variant management is used, and the filter bar is not * used in the advanced mode. A snapshot shows the current state of the filter bar, just before the Filters * dialog is opened. * - `undefined` (default) defines the standard behavior: snapshot will be applied after `reset` was triggered * * - `false` defines that the snapshot will not be applied * - `true`is not considered at all * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.44 * * @returns Reference to `this` in order to allow method chaining */ setUseSnapshot( /** * New value for property `useSnapshot` */ bUseSnapshot: boolean ): this; /** * Sets a new value for property {@link #getUseToolbar useToolbar}. * * Determines what design is used. Default is the design with toolbar. If the property `useToolbar` is set * to `false`, the property `filterBarExpanded` is ignored automatically and the `FilterBar` is always expanded. * **Note:** * If set to `false`, the `VariantManagement` control is not available at all. This scenario is only intended * for the {@link sap.ui.comp.smartfilterbar.SmartFilterBar}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.38.0 * * @returns Reference to `this` in order to allow method chaining */ setUseToolbar( /** * New value for property `useToolbar` */ bUseToolbar?: boolean ): this; /** * For backward compatibility. Creates adapt filters dialog */ showFilterDialog(): void; /** * This method will be called by the SmartVariantMangement and indicates, that the standard variant was * obtained. It indicates, that the variant management is fully initialized. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ variantsInitialized(): void; } /** * Represents a filter belonging to a group other than basic. */ class FilterGroupItem extends sap.ui.comp.filterbar.FilterItem { /** * Constructor for a new FilterBar/FilterGroupItem. * * 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.ui.comp.filterbar.$FilterGroupItemSettings ); /** * Constructor for a new FilterBar/FilterGroupItem. * * 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.ui.comp.filterbar.$FilterGroupItemSettings ); /** * Creates a new subclass of class sap.ui.comp.filterbar.FilterGroupItem 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.comp.filterbar.FilterItem.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< T, sap.ui.comp.filterbar.FilterGroupItem >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.filterbar.FilterGroupItem. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Destroys this element. */ destroy(): void; /** * Gets current value of property {@link #getGroupName groupName}. * * Name of the group. * * * @returns Value of property `groupName` */ getGroupName(): string; /** * Gets current value of property {@link #getGroupTitle groupTitle}. * * Title of the group. * * * @returns Value of property `groupTitle` */ getGroupTitle(): string; /** * Controls the visibility of a filter item in the filter bar. Default value is `false`. * * @since 1.26.1 * * @returns bValue State of visibility */ getVisibleInFilterBar(): boolean; /** * Sets a new value for property {@link #getGroupName groupName}. * * Name of the group. * * 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 */ setGroupName( /** * New value for property `groupName` */ sGroupName?: string ): this; /** * Setter for group title. */ setGroupTitle( /** * Group title */ sValue: string ): void; } /** * Represents a filter belonging to the basic group. */ class FilterItem extends sap.ui.core.Element { /** * Constructor for a new FilterBar/FilterItem. * * 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.ui.comp.filterbar.$FilterItemSettings ); /** * Constructor for a new FilterBar/FilterItem. * * 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.ui.comp.filterbar.$FilterItemSettings ); /** * Creates a new subclass of class sap.ui.comp.filterbar.FilterItem with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.filterbar.FilterItem. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.comp.filterbar.FilterItem`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterItem` itself. * * This event is fired when one of the properties is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: FilterItem$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterItem` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.comp.filterbar.FilterItem`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.filterbar.FilterItem` itself. * * This event is fired when one of the properties is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * The function to be called when the event occurs */ fnFunction: (p1: FilterItem$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.filterbar.FilterItem` itself */ oListener?: object ): this; /** * Destroys this element. */ destroy(): void; /** * Destroys the control in the aggregation {@link #getControl control}. * * * @returns Reference to `this` in order to allow method chaining */ destroyControl(): this; /** * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.comp.filterbar.FilterItem`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: FilterItem$ChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:change change} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireChange( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.filterbar.FilterItem$ChangeEventParameters ): this; /** * Always returns the initially added control. */ getControl(): sap.ui.core.Control | null; /** * Gets current value of property {@link #getControlTooltip controlTooltip}. * * Tooltip for the filter'c control. * * @since 1.52.0 * * @returns Value of property `controlTooltip` */ getControlTooltip(): string; /** * Gets current value of property {@link #getEntitySetName entitySetName}. * * EntitySet name to which the filter belongs * * @since 1.58.0 * * @returns Value of property `entitySetName` */ getEntitySetName(): string; /** * Gets current value of property {@link #getEntityTypeName entityTypeName}. * * EntityType name to which the filter belongs * * @since 1.58.0 * * @returns Value of property `entityTypeName` */ getEntityTypeName(): string; /** * Gets current value of property {@link #getHiddenFilter hiddenFilter}. * * A hidden filter will never be visible in the filter bar control * * Default value is `false`. * * @since 1.44.0 * * @returns Value of property `hiddenFilter` */ getHiddenFilter(): boolean; /** * Gets current value of property {@link #getLabel label}. * * Label of the filter. * * * @returns Value of property `label` */ getLabel(): string; /** * Gets current value of property {@link #getLabelTooltip labelTooltip}. * * Tooltip for the filter. * * * @returns Value of property `labelTooltip` */ getLabelTooltip(): string; /** * Gets current value of property {@link #getMandatory mandatory}. * * Mandatory flag. * * Default value is `false`. * * * @returns Value of property `mandatory` */ getMandatory(): boolean; /** * Gets current value of property {@link #getName name}. * * Name of the filter. This is an identifier for the filter and has to be unique. * * * @returns Value of property `name` */ getName(): string; /** * Gets current value of property {@link #getPartOfCurrentVariant partOfCurrentVariant}. * * Determines if a filter is part of the currently selected variant. * **Note:** This property can also be changed using the `visibleInFilterBar` property and by user interaction * in the Select Filters dialog or the variant handling. * * Default value is `true`. * * @since 1.26.1 * @deprecated As of version 1.87. Will be internally treated as if always set to true * * @returns Value of property `partOfCurrentVariant` */ getPartOfCurrentVariant(): boolean; /** * Gets current value of property {@link #getVisible visible}. * * Visibility state of the filter. * * Default value is `true`. * * * @returns Value of property `visible` */ getVisible(): boolean; /** * Gets current value of property {@link #getVisibleInFilterBar visibleInFilterBar}. * * Controls the visibility of a filter item in the filter bar. * * Default value is `true`. * * @since 1.26.1 * * @returns Value of property `visibleInFilterBar` */ getVisibleInFilterBar(): boolean; /** * Initializes the filter item. */ init(): void; /** * Sets the corresponding control. The control may not be overwritten by the application, once the filter * item is assigned to the FilterBar. */ setControl( /** * associated with the filter. */ oControl: sap.ui.core.Control ): void; /** * Sets a new value for property {@link #getControlTooltip controlTooltip}. * * Tooltip for the filter'c control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.52.0 * * @returns Reference to `this` in order to allow method chaining */ setControlTooltip( /** * New value for property `controlTooltip` */ sControlTooltip?: string ): this; /** * Sets a new value for property {@link #getEntitySetName entitySetName}. * * EntitySet name to which the filter belongs * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.58.0 * * @returns Reference to `this` in order to allow method chaining */ setEntitySetName( /** * New value for property `entitySetName` */ sEntitySetName?: string ): this; /** * Sets a new value for property {@link #getEntityTypeName entityTypeName}. * * EntityType name to which the filter belongs * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.58.0 * * @returns Reference to `this` in order to allow method chaining */ setEntityTypeName( /** * New value for property `entityTypeName` */ sEntityTypeName?: string ): this; /** * Setter for hiddenFilter. */ setHiddenFilter( /** * Hidden filter state */ bValue: boolean ): void; /** * Setter for label. */ setLabel( /** * Label text */ sValue: string ): void; /** * Setter for tooltip. */ setLabelTooltip( /** * Tooltip text */ sText: string ): void; /** * Setter for mandatory flag. */ setMandatory( /** * Mandatory state */ bValue: string ): void; /** * Sets a new value for property {@link #getName name}. * * Name of the filter. This is an identifier for the filter and has to be unique. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setName( /** * New value for property `name` */ sName?: string ): this; /** * Setter for partOfCurrentVariant in filter bar. * * @deprecated As of version 1.89. This property is treated as always set to `true`. */ setPartOfCurrentVariant( /** * State of visibility in filter bar */ bVisible: boolean ): void; /** * Setter for visible property. */ setVisible( /** * State of visibility */ bVisible: boolean ): void; /** * Setter for visible in filter bar. * * @since 1.26.1 */ setVisibleInFilterBar( /** * State of visibility in filter bar */ bVisible: boolean ): void; } /** * Event object of the FilterBar#afterVariantLoad event. */ type FilterBar$AfterVariantLoadEvent = sap.ui.base.Event< FilterBar$AfterVariantLoadEventParameters, FilterBar >; /** * Event object of the FilterBar#afterVariantSave event. */ type FilterBar$AfterVariantSaveEvent = sap.ui.base.Event< FilterBar$AfterVariantSaveEventParameters, FilterBar >; /** * Event object of the FilterBar#assignedFiltersChanged event. */ type FilterBar$AssignedFiltersChangedEvent = sap.ui.base.Event< FilterBar$AssignedFiltersChangedEventParameters, FilterBar >; /** * Event object of the FilterBar#beforeVariantFetch event. */ type FilterBar$BeforeVariantFetchEvent = sap.ui.base.Event< FilterBar$BeforeVariantFetchEventParameters, FilterBar >; /** * Event object of the FilterBar#beforeVariantSave event. */ type FilterBar$BeforeVariantSaveEvent = sap.ui.base.Event< FilterBar$BeforeVariantSaveEventParameters, FilterBar >; /** * Event object of the FilterBar#cancel event. */ type FilterBar$CancelEvent = sap.ui.base.Event< FilterBar$CancelEventParameters, FilterBar >; /** * Event object of the FilterBar#clear event. */ type FilterBar$ClearEvent = sap.ui.base.Event< FilterBar$ClearEventParameters, FilterBar >; /** * Event object of the FilterBar#filterChange event. */ type FilterBar$FilterChangeEvent = sap.ui.base.Event< FilterBar$FilterChangeEventParameters, FilterBar >; /** * Event object of the FilterBar#filtersDialogBeforeOpen event. */ type FilterBar$FiltersDialogBeforeOpenEvent = sap.ui.base.Event< FilterBar$FiltersDialogBeforeOpenEventParameters, FilterBar >; /** * Event object of the FilterBar#filtersDialogCancel event. */ type FilterBar$FiltersDialogCancelEvent = sap.ui.base.Event< FilterBar$FiltersDialogCancelEventParameters, FilterBar >; /** * Event object of the FilterBar#filtersDialogClosed event. */ type FilterBar$FiltersDialogClosedEvent = sap.ui.base.Event< FilterBar$FiltersDialogClosedEventParameters, FilterBar >; /** * Event object of the FilterBar#filtersDialogSearch event. * * @deprecated As of version 1.84. with no replacement. */ type FilterBar$FiltersDialogSearchEvent = sap.ui.base.Event< FilterBar$FiltersDialogSearchEventParameters, FilterBar >; /** * Event object of the FilterBar#filtersDialogSearchForFilters event. * * @deprecated As of version 1.84. with no replacement. */ type FilterBar$FiltersDialogSearchForFiltersEvent = sap.ui.base.Event< FilterBar$FiltersDialogSearchForFiltersEventParameters, FilterBar >; /** * Event object of the FilterBar#initialise event. */ type FilterBar$InitialiseEvent = sap.ui.base.Event< FilterBar$InitialiseEventParameters, FilterBar >; /** * Event object of the FilterBar#initialized event. */ type FilterBar$InitializedEvent = sap.ui.base.Event< FilterBar$InitializedEventParameters, FilterBar >; /** * Event object of the FilterBar#reset event. */ type FilterBar$ResetEvent = sap.ui.base.Event< FilterBar$ResetEventParameters, FilterBar >; /** * Event object of the FilterBar#search event. */ type FilterBar$SearchEvent = sap.ui.base.Event< FilterBar$SearchEventParameters, FilterBar >; /** * Event object of the FilterItem#change event. */ type FilterItem$ChangeEvent = sap.ui.base.Event< FilterItem$ChangeEventParameters, FilterItem >; } namespace navpopover { /** * Describes the settings that can be provided to the LinkData constructor. */ interface $LinkDataSettings extends sap.ui.mdc.link.$LinkItemSettings { /** * The standard values for the `target` property are: _self, _top, _blank, _parent, _search. Alternatively, * a frame name can be entered. This property is only used if the `href` property is set. */ target?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Describes whether the link should be visible on the screen. * * @since 1.44.0 */ visible?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Marker for superior action. * * @since 1.48.0 */ isSuperiorAction?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Describes whether the visibility is changed by end user or not. * * @since 1.58.0 * @deprecated As of version 1.122. The SmartLink now uses information stored on {@link sap.ui.mdc.link.PanelItem} */ visibleChangedByUser?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the NavigationPopover constructor. * * @deprecated As of version 1.121. SmartLink no longer opens a NavigationPopover, it got replaced by the * sap.ui.mdc.link.Panel in a sap.m.ResponsivePopover */ interface $NavigationPopoverSettings extends sap.m.$ResponsivePopoverSettings { /** * The name of the semantic object. * * @since 1.28.0 * @deprecated As of version 1.40.0. The property `semanticObjectName` is obsolete as target determination * is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target * determination. */ semanticObjectName?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Describes the semantic attributes. The attribute has to be a map. * * @since 1.28.0 * @deprecated As of version 1.40.0. The property `semanticAttributes` is obsolete as target determination * is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target * determination. */ semanticAttributes?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The application state key passed to retrieve the navigation targets. * * @since 1.28.0 * @deprecated As of version 1.40.0. The property `appStateKey` is obsolete as target determination is no * longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination. */ appStateKey?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Sets the description of the main navigation link. If `mainNavigation` also contains an href description, * then `mainNavigationId` is displayed. If `mainNavigationId` is set to an empty string `''`, neither description * nor subtitle are displayed. * * @since 1.28.0 */ mainNavigationId?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Determines the text of personalization link. If this property is set to some string, choosing the personalization * link will trigger the `availableActionsPersonalizationPress` event. If this property is not set, the * personalization link is not shown. * * @since 1.44.0 */ availableActionsPersonalizationText?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * A list of available actions shown as links. * * @since 1.28.0 */ availableActions?: | sap.ui.comp.navpopover.LinkData[] | sap.ui.comp.navpopover.LinkData | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * The main navigation link. If `mainNavigationId` is not set then `text` of `mainNavigation` is displayed. * Otherwise the `mainNavigationId` is displayed. * * @since 1.28.0 */ mainNavigation?: sap.ui.comp.navpopover.LinkData; /** * The navigation taking the user back to the source application. * * @since 1.28.0 * @deprecated As of version 1.40.0. The property `ownNavigation` is obsolete as target determination is * no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination. */ ownNavigation?: sap.ui.comp.navpopover.LinkData; /** * Source control for which the popover is displayed. * * @since 1.28.0 */ source?: sap.ui.core.Control | string; /** * In addition to main navigation link and available links some additional content can be displayed in the * popover. * * @since 1.28.0 */ extraContent?: sap.ui.core.Control | string; /** * The parent component. */ component?: sap.ui.core.Element | string; /** * The navigation targets that are shown. * * @since 1.28.0 * @deprecated As of version 1.40.0. The event `navigationTargetsObtained` is obsolete as target determination * is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target * determination. The event `navigationTargetsObtained` is fired from NavigationPopoverHandler after navigation * targets are determined. */ targetsObtained?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired when a link is chosen. * * @since 1.28.0 */ navigate?: (oEvent: NavigationPopover$NavigateEvent) => void; /** * This event is fired when personalization of `availableActions` is chosen. * * @since 1.44.0 */ availableActionsPersonalizationPress?: ( oEvent: sap.ui.base.Event ) => void; } /** * Describes the settings that can be provided to the NavigationPopoverHandler constructor. * * @deprecated As of version 1.121. SmartLink no longer uses the NavigationPopoverHandler, it got replaced * by a sap.ui.mdc.Link implementation. All event handlings can be done directly on the SmartLink / SemanticObjectController. */ interface $NavigationPopoverHandlerSettings extends sap.ui.base.$ManagedObjectSettings { /** * Name of semantic object which is used to determine target navigations. * * @since 1.36.0 */ semanticObject?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Names of additional semantic objects which are used to determine target navigations. * * @since 1.42.0 */ additionalSemanticObjects?: | string[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The semantic object controller controls events for several NavigationPopoverHandler controls. If the * controller is not set manually, it tries to find a SemanticObjectController in its parent hierarchy. * * @since 1.36.0 */ semanticObjectController?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The metadata field name for this NavigationPopoverHandler control. * * @since 1.36.0 */ fieldName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Shown title of semantic object. * * @since 1.36.0 * @deprecated As of version 1.40.0. Title section with `semanticObjectLabel` has been removed due to new * UI design */ semanticObjectLabel?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * If set to `false`, the NavigationPopoverHandler control will not replace its field name with the according * `semanticObject` property during the calculation of the semantic attributes. This enables the usage of * several NavigationPopoverHandler on the same semantic object. * * * @since 1.36.0 */ mapFieldToSemanticObject?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Navigation property that points from the current to the related entity type where the com.sap.vocabularies.Communication.v1.Contact * annotation is defined, for example, `'to_Supplier'`. An empty string means that the related entity type * is the current one. * * @since 1.40.0 */ contactAnnotationPath?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Determines whether the personalization link is shown inside the NavigationPopover control. * * @since 1.44.0 */ enableAvailableActionsPersonalization?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Function that is called before the actual navigation happens. This function has to return a `Promise` * resolving into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the * navigation will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the * following data: * - {String} text: Text of the navigation intent * - {String} href: HREF of the navigation intent * - {String} originalId: ID of the control that fires the navigation intent * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent * * * @since 1.75.0 */ beforeNavigationCallback?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained. * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}. * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}. * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `NavigationPopoverHandler`. * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained` * event. The event handling is ignored if this callback is set. * * @since 1.126 */ navigationTargetsObtainedCallback?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The parent control. * * @since 1.36.0 */ control?: sap.ui.core.Control | string; /** * Event is fired before the navigation popover opens and before navigation target links are getting retrieved. * Event can be used to change the parameters used to retrieve the navigation targets. In case of NavigationPopoverHandler, * the `beforePopoverOpens` is fired after the link has been clicked. * * @since 1.36.0 */ beforePopoverOpens?: ( oEvent: NavigationPopoverHandler$BeforePopoverOpensEvent ) => void; /** * After the navigation targets are retrieved, `navigationTargetsObtained` is fired and provides the possibility * to change the targets. * * @since 1.36.0 * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. */ navigationTargetsObtained?: ( oEvent: NavigationPopoverHandler$NavigationTargetsObtainedEvent ) => void; /** * This event is fired after a navigation link on the navigation popover has been clicked. This event is * only fired, if the user left-clicks the link. Right-clicking the link and selecting 'Open in New Window' * etc. in the context menu does not fire the event. * * @since 1.36.0 */ innerNavigate?: ( oEvent: NavigationPopoverHandler$InnerNavigateEvent ) => void; } /** * Describes the settings that can be provided to the SemanticObjectController constructor. */ interface $SemanticObjectControllerSettings extends sap.ui.core.$ElementSettings { /** * Comma-separated list of fields that must not be displayed as links. * * @since 1.28.0 */ ignoredFields?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * If set to `true`, the SemanticObjectController will retrieve all navigation targets once and will disable * links for which no targets were found. Setting this value to `true` will trigger an additional roundtrip. * * @since 1.28.0 * @deprecated As of version 1.42.0. The property `prefetchNavigationTargets` is obsolete as navigation * targets are determined automatically. The SmartLink controls are re-rendered as soon as the asynchronous * determination of navigation targets has been completed. */ prefetchNavigationTargets?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Maps the fields to the related semantic objects. When accessing this property for the first time, the * mapping will be calculated from the metadata within the provided model. * * @since 1.28.0 */ fieldSemanticObjectMap?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The name of the entity set used. If `entitySet` has not been defined, the SemanticObjectController tries * to retrieve the name from its parents. **Note:** This is not a dynamic UI5 property. * * @since 1.28.0 */ entitySet?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Navigation property that points from the current to the related entity type where the `com.sap.vocabularies.Communication.v1.Contact` * annotation is defined, for example, ` '\{"Supplier":"to_Supplier", "CompanyName":"to_Company"\}' `. An * empty string means that the related entity type is the current one. * * @since 1.40.0 */ contactAnnotationPaths?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines whether the personalization link is shown inside the NavigationPopover control. For example, * ` '\{"Supplier":false, "CompanyName":true\}' `. * * @since 1.44.0 */ enableAvailableActionsPersonalization?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `false`, the SmartLink control will not replace its field name with the according `semanticObject` * property during the calculation of the semantic attributes. * * @since 1.48.0 */ mapFieldToSemanticObject?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Object containing fields for which the corresponding `SmartLink` control is rendered as a link even if * `contactAnnotationPaths` is not set and navigation targets do not exist. Setting this property to `true` * allows the application, for example, to modify the `SmartLink` control in the event handler, after the * user has clicked on a link and the registered event handler has been called.\n * * **Note:** The `ignoredFields` property and the `ignoreLinkRendering` property of the `SmartLink` control * take precedence over `forceLinkRendering`.\n * * Example of usage: ` '\{"Supplier":"true", "CompanyName":"true"\}' ` * * @since 1.58.0 */ forceLinkRendering?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Function that is called before the actual navigation happens. This function has to return a promise resolving * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data: * * - {String} text: Text of the navigation intent * - {String} href: HREF of the navigation intent * - {String} originalId: ID of the control that fires the navigation intent * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent * * * @since 1.75.0 */ beforeNavigationCallback?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines if the `navigationTargetsObtained` event handling of the `SmartLink` should be replaced when * this `SemanticObjectController` is set as `SemanticObjectController` on the SmartLink. * * @since 1.97 */ replaceSmartLinkNavigationTargetsObtained?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained. * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}. * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}. * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `SmartLinkFieldInfo`. * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained` * event. The event handling is ignored if this callback is set. * * @since 1.126 */ navigationTargetsObtainedCallback?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * After the navigation targets have been retrieved, `navigationTargetsObtained` is fired and makes it possible * you to change the targets. * * @since 1.28.0 * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. */ navigationTargetsObtained?: ( oEvent: SemanticObjectController$NavigationTargetsObtainedEvent ) => void; /** * Event is fired before the navigation popover opens and before navigation target links are retrieved. * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink, * `beforePopoverOpens` is fired after the link has been clicked. * * @since 1.28.0 */ beforePopoverOpens?: ( oEvent: SemanticObjectController$BeforePopoverOpensEvent ) => void; /** * This event is fired after a navigation link on the navigation popover has been clicked. This event is * only fired, if the user left-clicks the link. Right-clicking the link and selecting 'Open in New Window' * etc. in the context menu does not fire the event. * * @since 1.28.0 */ navigate?: (oEvent: SemanticObjectController$NavigateEvent) => void; /** * If the property `prefetchNavigationTargets` is set to `true`, event `prefetchDone` is fired after all * navigation targets have been retrieved. * * @since 1.28.0 * @deprecated As of version 1.42.0. The event `prefetchDone` is obsolete because it depends on the property * `prefetchNavigationTargets` which has been deprecated. */ prefetchDone?: ( oEvent: SemanticObjectController$PrefetchDoneEvent ) => void; } /** * Describes the settings that can be provided to the SmartLink constructor. */ interface $SmartLinkSettings extends sap.m.$LinkSettings { /** * Name of semantic object which is used to fill the navigation popover. **Note**: Setting a value triggers * an asynchronous determination, so the effect can be delayed. * * @since 1.28.0 */ semanticObject?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Semantic object names which can be used additional to the default `semanticObject` property in order * to get navigation targets links. * * @since 1.42.0 */ additionalSemanticObjects?: | string[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The semantic object controller controls events for several SmartLink controls. If the controller is not * set manually, it tries to find a SemanticObjectController in its parent hierarchy. * * @since 1.28.0 */ semanticObjectController?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The metadata field name for this SmartLink control. * * @since 1.28.0 */ fieldName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Shown label of semantic object. * * @since 1.28.0 * @deprecated As of version 1.40.0. Title section with `semanticObjectLabel` has been removed due to new * UI design */ semanticObjectLabel?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Function that enables the SmartLink control to create an alternative control, which is displayed if `ignoreLinkRendering` * is enabled. The function has no parameters and has to return an instance of sap.ui.core.Control. * * @since 1.28.0 */ createControlCallback?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `false`, the SmartLink control will not replace its field name with the according `semanticObject` * property during the calculation of the semantic attributes. This enables the usage of several SmartLink * controls on the same semantic object. */ mapFieldToSemanticObject?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Navigation property that points from the current to the related entity type where the com.sap.vocabularies.Communication.v1.Contact * annotation is defined, for example, `'to_Supplier'`. An empty string means that the related entity type * is the current one. * * @since 1.40.0 */ contactAnnotationPath?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * If set to `true`, the SmartLink control will render the `innerControl` or the control provided by `createControlCallback` * instead of the actual link. This is used for example by the SemanticObjectController if this SmartLink * is listed in its `ignoredFields` or no navigation targets were found during prefetch. * * @since 1.28.0 */ ignoreLinkRendering?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines whether the personalization link is shown inside the NavigationPopover control. * * @since 1.44.0 */ enableAvailableActionsPersonalization?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to true, the `SmartLink` control is rendered as a link even if `contactAnnotationPath` is not * set and navigation targets do not exist. Setting this property to `true` allows the application, for * example, to modify the `SmartLink` control in the event handler, after the user has clicked on a link * and the registered event handler has been called. * * **Note:** The `ignoreLinkRendering` property and the `ignoredFields` property of the associated `SemanticObjectController` * take precedence over `forceLinkRendering`. * * @since 1.58.0 */ forceLinkRendering?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Additionally to the `text` property the Unit of Measure can be displayed. * * @since 1.48.0 */ uom?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Function that is called before the actual navigation happens. This function has to return a promise resolving * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data: * * - {String} text: Text of the navigation intent * - {String} href: HREF of the navigation intent * - {String} originalId: ID of the control that fires the navigation intent * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent * * * @since 1.75.0 */ beforeNavigationCallback?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines whether the link can be triggered by the user. */ enabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines whether the link text is allowed to wrap when there is no sufficient space. */ wrapping?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained. * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}. * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}. * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `NavigationPopoverHandler`. * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained` * event. The event handling is ignored if this callback is set. * * @since 1.126 */ navigationTargetsObtainedCallback?: | Function | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Control that is displayed instead of SmartLink control, if the SmartLink is disabled (for example, if * no navigation targets are available). If `innerControl` is not provided, the SmartLink control tries * to create one with property `createControlCallback`. * * @since 1.28.0 */ innerControl?: sap.ui.core.Control; /** * Event is fired before the navigation popover opens and before navigation target links are getting retrieved. * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink * control, the `beforePopoverOpens` is fired after the link has been clicked. * * @since 1.28.0 */ beforePopoverOpens?: ( oEvent: SmartLink$BeforePopoverOpensEvent ) => void; /** * After the navigation targets are retrieved, `navigationTargetsObtained` is fired and provides the possibility * to change the targets. * * @since 1.28.0 * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. */ navigationTargetsObtained?: ( oEvent: SmartLink$NavigationTargetsObtainedEvent ) => void; /** * This event is fired after a navigation link on the navigation popover has been clicked. This event is * only fired, if the user left-clicks the link. Right-clicking the link and selecting 'Open in New Window' * etc. in the context menu does not fire the event. * * @since 1.28.0 */ innerNavigate?: (oEvent: SmartLink$InnerNavigateEvent) => void; } /** * Parameters of the NavigationPopover#availableActionsPersonalizationPress event. */ interface NavigationPopover$AvailableActionsPersonalizationPressEventParameters {} /** * Parameters of the NavigationPopover#navigate event. */ interface NavigationPopover$NavigateEventParameters { /** * The UI text shown in the chosen link */ text?: string; /** * The navigation target of the chosen link */ href?: string; } /** * Parameters of the NavigationPopover#targetsObtained event. * * @deprecated As of version 1.40.0. The event `navigationTargetsObtained` is obsolete as target determination * is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target * determination. The event `navigationTargetsObtained` is fired from NavigationPopoverHandler after navigation * targets are determined. */ interface NavigationPopover$TargetsObtainedEventParameters {} /** * Parameters of the NavigationPopoverHandler#beforePopoverOpens event. */ interface NavigationPopoverHandler$BeforePopoverOpensEventParameters { /** * The semantic object for which the navigation targets will be retrieved. */ semanticObject?: string; /** * Map containing the semantic attributes calculated from the binding that will be used to retrieve the * navigation targets. */ semanticAttributes?: object; /** * A map of semantic objects for which the navigation targets will be retrieved and it's semantic attributes * calculated from the binding context. The semantic attributes will be used as parameters in order to retrieve * the navigation targets. */ semanticAttributesOfSemanticObjects?: object; /** * This callback function enables you to define a changed semantic attributes map. Signatures: `setSemanticAttributes(oSemanticAttributesMap)` * Parameter: * - {object} oSemanticAttributesMap New map containing the semantic attributes * - {string} sSemanticObject Semantic Object for which the oSemanticAttributesMap belongs */ setSemanticAttributes?: Function; /** * This callback function sets an application state key that is used over the cross-application navigation. * Signatures: `setAppStateKey(sAppStateKey)` Parameter: * - {string} sAppStateKey */ setAppStateKey?: Function; /** * The ID of the NavigationPopoverHandler. */ originalId?: string; /** * This callback function triggers the retrieval of navigation targets and leads to the opening of the navigation * popover. Signatures: `open()` If the `beforePopoverOpens` has been registered, the `open` function has * to be called manually in order to open the navigation popover. */ open?: Function; } /** * Parameters of the NavigationPopoverHandler#innerNavigate event. */ interface NavigationPopoverHandler$InnerNavigateEventParameters { /** * The UI text shown in the clicked link. */ text?: string; /** * The navigation target of the clicked link. */ href?: string; /** * The semantic object used to retrieve this target. */ semanticObject?: string; /** * Map containing the semantic attributes used to retrieve this target. */ semanticAttributes?: object; /** * The ID of the NavigationPopoverHandler. */ originalId?: string; } /** * Parameters of the NavigationPopoverHandler#navigationTargetsObtained event. * * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. */ interface NavigationPopoverHandler$NavigationTargetsObtainedEventParameters { /** * The main navigation object. */ mainNavigation?: sap.ui.comp.navpopover.LinkData; /** * Array of available navigation target objects. */ actions?: sap.ui.comp.navpopover.LinkData[]; /** * The navigation object for the own application. This navigation option is by default not visible on the * popover. */ ownNavigation?: sap.ui.comp.navpopover.LinkData; /** * Array containing contact data. */ popoverForms?: sap.ui.layout.form.SimpleForm[]; /** * The semantic object for which the navigation targets have been retrieved. */ semanticObject?: string; /** * Map containing the semantic attributes. */ semanticAttributes?: object; /** * The ID of the NavigationPopoverHandler. */ originalId?: string; /** * This callback function shows the actual navigation popover. If the `navigationTargetsObtained` has been * registered, the `show` function has to be called manually in order to open the navigation popover. Signatures: * `show()` * - `show(oMainNavigation, aAvailableActions, oAdditionalContent)` Parameters: * {sap.ui.comp.navpopover.LinkData | null | undefined} oMainNavigation The main navigation object. With * `null` the main navigation object will be removed. With `undefined` the old object will remain. * - {sap.ui.comp.navpopover.LinkData[] | [] | undefined} aAvailableActions Array containing the cross * application navigation links. With empty array all available links will be removed. With `undefined` * the old links will remain. * - {sap.ui.core.Control | null | undefined} oAdditionalContent Control that will be displayed in extra * content section on the popover. With `null` the main extra content object will be removed. With `undefined` * the old object still remains. * - `show(sMainNavigationId, oMainNavigation, aAvailableActions, oAdditionalContent)` Parameters: * {string | undefined} sMainNavigationId The visible description for the main navigation link. With `''`, * both the description and subtitle will be removed. With `undefined`, the description is calculated using * the binding context of a given source object (for example `SmartLink` control). * - {sap.ui.comp.navpopover.LinkData | null | undefined} oMainNavigation The main navigation object. * With `null` the main navigation object will be removed. With `undefined` the old object will remain. * * - {sap.ui.comp.navpopover.LinkData[] | [] | undefined} aAvailableActions Array containing the cross * application navigation links. With empty array all available links will be removed. With `undefined` * the old links will remain. * - {sap.ui.core.Control | null | undefined} oAdditionalContent Control that will be displayed in extra * content section on the popover. With `null` the main extra content object will be removed. With `undefined` * the old object still remains. */ show?: Function; } /** * Parameters of the SemanticObjectController#beforePopoverOpens event. */ interface SemanticObjectController$BeforePopoverOpensEventParameters { /** * The semantic object for which the navigation targets will be retrieved. */ semanticObject?: string; /** * Map containing the semantic attributes calculated from the binding that will be used to retrieve the * navigation targets. */ semanticAttributes?: object; /** * A map of semantic objects for which the navigation targets will be retrieved and it's semantic attributes * calculated from the binding context. The semantic attributes will be used as parameters in order to retrieve * the navigation targets. */ semanticAttributesOfSemanticObjects?: object; /** * This callback function enables you to define a changed semantic attributes map. Signatures: `setSemanticAttributes(oSemanticAttributesMap)` * Parameter: * - {object} oSemanticAttributesMap New map containing the semantic attributes * - {string} sSemanticObject Semantic Object for which the oSemanticAttributesMap belongs */ setSemanticAttributes?: Function; /** * This callback function sets an application state key that is used over the cross-application navigation. * Signatures: `setAppStateKey(sAppStateKey)` Parameter: * - {string} sAppStateKey */ setAppStateKey?: Function; /** * The ID of the control that fires this event. If `beforePopoverOpens` is registered on the SmartLink, * `originalId` is the same as the event's source ID which is also the SmartLink's ID. If the `beforePopoverOpens` * is registered on the SemanticObjectController, `originalId` helps to identify the original SmartLink * control which triggered the event. */ originalId?: string; /** * This callback function triggers the retrieval of navigation targets and leads to the opening of the navigation * popover. Signatures: `open()` If `beforePopoverOpens` has been registered, `open` function has to be * called manually in order to open the navigation popover or trigger a direct navigation. */ open?: Function; } /** * Parameters of the SemanticObjectController#navigate event. */ interface SemanticObjectController$NavigateEventParameters { /** * The UI text shown in the clicked link. */ text?: string; /** * The navigation target of the clicked link. */ href?: string; /** * The semantic object used to retrieve this target. */ semanticObject?: string; /** * Map containing the semantic attributes used to retrieve this target. */ semanticAttributes?: object; /** * The ID of the control that fires this event. If `navigate` is registered on the SmartLink, `originalId` * is the same as the event's source ID which is the SmartLink's ID. If `navigate` is registered on the * SemanticObjectController, `originalId` helps to identify the original SmartLink control which triggered * the event. */ originalId?: string; } /** * Parameters of the SemanticObjectController#navigationTargetsObtained event. * * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. */ interface SemanticObjectController$NavigationTargetsObtainedEventParameters { /** * The main navigation object. */ mainNavigation?: sap.ui.comp.navpopover.LinkData; /** * Array of available navigation target objects. */ actions?: sap.ui.comp.navpopover.LinkData[]; /** * The navigation object for the own application. This navigation option is by default not visible on the * popover. */ ownNavigation?: sap.ui.comp.navpopover.LinkData; /** * Array containing contact data. */ popoverForms?: sap.ui.layout.form.SimpleForm[]; /** * The semantic object for which the navigation targets have been retrieved. */ semanticObject?: string; /** * Map containing the semantic attributes. */ semanticAttributes?: object; /** * The ID of the control that fires this event. If `navigationTargetsObtained` is registered on the SmartLink, * `originalId` is the same as the event's source ID which is also the SmartLink's ID. If `navigationTargetsObtained` * is registered on the SemanticObjectController, `originalId` helps to identify the original SmartLink * control which triggered the event. */ originalId?: string; /** * This callback function shows the actual navigation popover. If the `navigationTargetsObtained` has been * registered, the `show` function has to be called manually in order to open the navigation popover. Signatures: * `show()` * - `show(oMainNavigation, aAvailableActions, oAdditionalContent)` Parameters: * {sap.ui.comp.navpopover.LinkData | null | undefined} oMainNavigation The main navigation object. With * `null` the main navigation object will be removed. With `undefined` the old object will remain. * - {sap.ui.comp.navpopover.LinkData[] | [] | undefined} aAvailableActions Array containing the cross-application * navigation links. With empty array all available links will be removed. With `undefined` the old links * will remain. * - {sap.ui.core.Control | null | undefined} oAdditionalContent Control that will be displayed in extra * content section on the popover. With `null` the main extra content object will be removed. With `undefined` * the old object still remains. * - `show(sMainNavigationId, oMainNavigation, aAvailableActions, oAdditionalContent)` Parameters: * {string | undefined} sMainNavigationId The visible description for the main navigation link. With `''`, * both the description and subtitle will be removed. With `undefined`, the description is calculated using * the binding context of a given source object (for example `SmartLink` control). * - {sap.ui.comp.navpopover.LinkData | null | undefined} oMainNavigation The main navigation object. * With `null` the main navigation object will be removed. With `undefined` the old object will remain. * * - {sap.ui.comp.navpopover.LinkData[] | [] | undefined} aAvailableActions Array containing the cross-application * navigation links. With empty array all available links will be removed. With `undefined` the old links * will remain. * - {sap.ui.core.Control | null | undefined} oAdditionalContent Control that will be displayed in extra * content section on the popover. With `null` the main extra content object will be removed. With `undefined` * the old object still remains. */ show?: Function; } /** * Parameters of the SemanticObjectController#prefetchDone event. * * @deprecated As of version 1.42.0. The event `prefetchDone` is obsolete because it depends on the property * `prefetchNavigationTargets` which has been deprecated. */ interface SemanticObjectController$PrefetchDoneEventParameters { /** * A map containing all semantic objects as keys for which at least one navigation target has been found. * The value for each semantic object key is an array containing the available actions found for this semantic * object. */ semanticObjects?: object; } /** * Parameters of the SmartLink#beforePopoverOpens event. */ interface SmartLink$BeforePopoverOpensEventParameters { /** * The semantic object for which the navigation targets will be retrieved. */ semanticObject?: string; /** * Map containing the semantic attributes calculated from the binding that will be used to retrieve the * navigation targets. */ semanticAttributes?: object; /** * A map of semantic objects for which the navigation targets will be retrieved and it's semantic attributes * calculated from the binding context. The semantic attributes will be used as parameters in order to retrieve * the navigation targets. */ semanticAttributesOfSemanticObjects?: object; /** * This callback function enables you to define a changed semantic attributes map. Signatures: `setSemanticAttributes(oSemanticAttributesMap)` * Parameter: * - {object} oSemanticAttributesMap New map containing the semantic attributes * - {string} sSemanticObject Semantic Object for which the oSemanticAttributesMap belongs */ setSemanticAttributes?: Function; /** * This callback function sets an application state key that is used over the cross-application navigation. * Signatures: `setAppStateKey(sAppStateKey)` Parameter: * - {string} sAppStateKey */ setAppStateKey?: Function; /** * The ID of the SmartLink control. */ originalId?: string; /** * This callback function triggers the retrieval of navigation targets and leads to the opening of the navigation * popover. Signatures: `open()` If the `beforePopoverOpens` has been registered, the `open` function has * to be called manually in order to open the navigation popover or trigger a direct navigation. */ open?: Function; } /** * Parameters of the SmartLink#innerNavigate event. */ interface SmartLink$InnerNavigateEventParameters { /** * The UI text shown in the clicked link. */ text?: string; /** * The navigation target of the clicked link. */ href?: string; /** * The semantic object used to retrieve this target. */ semanticObject?: string; /** * Map containing the semantic attributes used to retrieve this target. */ semanticAttributes?: object; /** * The ID of the SmartLink control. */ originalId?: string; } /** * Parameters of the SmartLink#navigationTargetsObtained event. * * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. */ interface SmartLink$NavigationTargetsObtainedEventParameters { /** * The main navigation object. */ mainNavigation?: sap.ui.comp.navpopover.LinkData; /** * Array of available navigation target objects. */ actions?: sap.ui.comp.navpopover.LinkData[]; /** * The navigation object for the own application. This navigation option is by default not visible on the * popover. */ ownNavigation?: sap.ui.comp.navpopover.LinkData; /** * Array containing contact data. */ popoverForms?: sap.ui.layout.form.SimpleForm[]; /** * The semantic object for which the navigation targets have been retrieved. */ semanticObject?: string; /** * Map containing the semantic attributes. */ semanticAttributes?: object; /** * The ID of the SmartLink control. */ originalId?: string; /** * This callback function shows the actual navigation popover. If the `navigationTargetsObtained` has been * registered, the `show` function has to be called manually in order to open the navigation popover. Signatures: * `show()` * - `show(oMainNavigation, aAvailableActions, oAdditionalContent)` Parameters: * {sap.ui.comp.navpopover.LinkData | null | undefined} oMainNavigation The main navigation object. With * `null` the main navigation object will be removed. With `undefined` the old object will remain. * - {sap.ui.comp.navpopover.LinkData[] | [] | undefined} aAvailableActions Array containing the cross * application navigation links. With empty array all available links will be removed. With `undefined` * the old links will remain. * - {sap.ui.core.Control | null | undefined} oAdditionalContent Control that will be displayed in extra * content section on the popover. With `null` the main extra content object will be removed. With `undefined` * the old object still remains. * - `show(sMainNavigationId, oMainNavigation, aAvailableActions, oAdditionalContent)` Parameters: * {string | undefined} sMainNavigationId The visible description for the main navigation link. With `''`, * both the description and subtitle will be removed. With `undefined`, the description is calculated using * the binding context of a given source object (for example `SmartLink` control). * - {sap.ui.comp.navpopover.LinkData | null | undefined} oMainNavigation The main navigation object. * With `null` the main navigation object will be removed. With `undefined` the old object will remain. * * - {sap.ui.comp.navpopover.LinkData[] | [] | undefined} aAvailableActions Array containing the cross * application navigation links. With empty array all available links will be removed. With `undefined` * the old links will remain. * - {sap.ui.core.Control | null | undefined} oAdditionalContent Control that will be displayed in extra * content section on the popover. With `null` the main extra content object will be removed. With `undefined` * the old object still remains. */ show?: Function; } /** * Stores display text together with a navigation target hyperlink. * The LinkData class is used by {@link sap.ui.comp.navpopover.SmartLink SmartLink} and {@link sap.ui.comp.navpopover.SemanticObjectController SemanticObjectController } * to define the visible links on {@link sap.ui.comp.navpopover.NavigationPopover NavigationPopover}. * * @since 1.28.0 */ class LinkData extends sap.ui.mdc.link.LinkItem { /** * Constructor for a new navpopover/LinkData. * * 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.ui.comp.navpopover.$LinkDataSettings ); /** * Constructor for a new navpopover/LinkData. * * 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.ui.comp.navpopover.$LinkDataSettings ); /** * Creates a new subclass of class sap.ui.comp.navpopover.LinkData 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.mdc.link.LinkItem.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.navpopover.LinkData. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getIsSuperiorAction isSuperiorAction}. * * Marker for superior action. * * @since 1.48.0 * * @returns Value of property `isSuperiorAction` */ getIsSuperiorAction(): boolean; /** * Gets current value of property {@link #getTarget target}. * * The standard values for the `target` property are: _self, _top, _blank, _parent, _search. Alternatively, * a frame name can be entered. This property is only used if the `href` property is set. * * * @returns Value of property `target` */ getTarget(): string; /** * Gets current value of property {@link #getVisible visible}. * * Describes whether the link should be visible on the screen. * * Default value is `true`. * * @since 1.44.0 * * @returns Value of property `visible` */ getVisible(): boolean; /** * Gets current value of property {@link #getVisibleChangedByUser visibleChangedByUser}. * * Describes whether the visibility is changed by end user or not. * * @since 1.58.0 * @deprecated As of version 1.122. The SmartLink now uses information stored on {@link sap.ui.mdc.link.PanelItem} * * @returns Value of property `visibleChangedByUser` */ getVisibleChangedByUser(): boolean; /** * Sets a new value for property {@link #getIsSuperiorAction isSuperiorAction}. * * Marker for superior action. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ setIsSuperiorAction( /** * New value for property `isSuperiorAction` */ bIsSuperiorAction: boolean ): this; /** * Sets a new value for property {@link #getTarget target}. * * The standard values for the `target` property are: _self, _top, _blank, _parent, _search. Alternatively, * a frame name can be entered. This property is only used if the `href` property is set. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setTarget( /** * New value for property `target` */ sTarget?: string ): this; /** * Sets a new value for property {@link #getVisible visible}. * * Describes whether the link should be visible on the screen. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.44.0 * * @returns Reference to `this` in order to allow method chaining */ setVisible( /** * New value for property `visible` */ bVisible?: boolean ): this; /** * Sets a new value for property {@link #getVisibleChangedByUser visibleChangedByUser}. * * Describes whether the visibility is changed by end user or not. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.58.0 * @deprecated As of version 1.122. The SmartLink now uses information stored on {@link sap.ui.mdc.link.PanelItem} * * @returns Reference to `this` in order to allow method chaining */ setVisibleChangedByUser( /** * New value for property `visibleChangedByUser` */ bVisibleChangedByUser: boolean ): this; } /** * The NavigationPopover control is used to present information in a specific format. **Note**: This control * is used by the {@link sap.ui.comp.navpopover.NavigationPopoverHandler NavigationPopoverHandler} and must * not be used manually. * * @deprecated As of version 1.121. SmartLink no longer opens a NavigationPopover, it got replaced by the * sap.ui.mdc.link.Panel in a sap.m.ResponsivePopover */ class NavigationPopover extends sap.m.ResponsivePopover { /** * Constructor for a new navpopover/NavigationPopover. * * 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.ui.comp.navpopover.$NavigationPopoverSettings ); /** * Constructor for a new navpopover/NavigationPopover. * * 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.ui.comp.navpopover.$NavigationPopoverSettings ); /** * Creates a new subclass of class sap.ui.comp.navpopover.NavigationPopover 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.ResponsivePopover.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< T, sap.ui.comp.navpopover.NavigationPopover >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.navpopover.NavigationPopover. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some availableAction to the aggregation {@link #getAvailableActions availableActions}. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ addAvailableAction( /** * The availableAction to add; if empty, nothing is inserted */ oAvailableAction: sap.ui.comp.navpopover.LinkData ): this; /** * Attaches event handler `fnFunction` to the {@link #event:availableActionsPersonalizationPress availableActionsPersonalizationPress } * event of this `sap.ui.comp.navpopover.NavigationPopover`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.NavigationPopover` itself. * * This event is fired when personalization of `availableActions` is chosen. * * @since 1.44.0 * * @returns Reference to `this` in order to allow method chaining */ attachAvailableActionsPersonalizationPress( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.NavigationPopover` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:availableActionsPersonalizationPress availableActionsPersonalizationPress } * event of this `sap.ui.comp.navpopover.NavigationPopover`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.NavigationPopover` itself. * * This event is fired when personalization of `availableActions` is chosen. * * @since 1.44.0 * * @returns Reference to `this` in order to allow method chaining */ attachAvailableActionsPersonalizationPress( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.NavigationPopover` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:navigate navigate} event of this `sap.ui.comp.navpopover.NavigationPopover`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.NavigationPopover` itself. * * This event is fired when a link is chosen. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachNavigate( /** * 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: NavigationPopover$NavigateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.NavigationPopover` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:navigate navigate} event of this `sap.ui.comp.navpopover.NavigationPopover`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.NavigationPopover` itself. * * This event is fired when a link is chosen. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachNavigate( /** * The function to be called when the event occurs */ fnFunction: (p1: NavigationPopover$NavigateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.NavigationPopover` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:targetsObtained targetsObtained} event of this * `sap.ui.comp.navpopover.NavigationPopover`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.NavigationPopover` itself. * * The navigation targets that are shown. * * @since 1.28.0 * @deprecated As of version 1.40.0. The event `navigationTargetsObtained` is obsolete as target determination * is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target * determination. The event `navigationTargetsObtained` is fired from NavigationPopoverHandler after navigation * targets are determined. * * @returns Reference to `this` in order to allow method chaining */ attachTargetsObtained( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.NavigationPopover` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:targetsObtained targetsObtained} event of this * `sap.ui.comp.navpopover.NavigationPopover`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.NavigationPopover` itself. * * The navigation targets that are shown. * * @since 1.28.0 * @deprecated As of version 1.40.0. The event `navigationTargetsObtained` is obsolete as target determination * is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target * determination. The event `navigationTargetsObtained` is fired from NavigationPopoverHandler after navigation * targets are determined. * * @returns Reference to `this` in order to allow method chaining */ attachTargetsObtained( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.NavigationPopover` * itself */ oListener?: object ): this; /** * Destroys all the availableActions in the aggregation {@link #getAvailableActions availableActions}. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ destroyAvailableActions(): this; /** * Destroys the mainNavigation in the aggregation {@link #getMainNavigation mainNavigation}. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ destroyMainNavigation(): this; /** * Destroys the ownNavigation in the aggregation {@link #getOwnNavigation ownNavigation}. * * @since 1.28.0 * @deprecated As of version 1.40.0. The property `ownNavigation` is obsolete as target determination is * no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination. * * @returns Reference to `this` in order to allow method chaining */ destroyOwnNavigation(): this; /** * Detaches event handler `fnFunction` from the {@link #event:availableActionsPersonalizationPress availableActionsPersonalizationPress } * event of this `sap.ui.comp.navpopover.NavigationPopover`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.44.0 * * @returns Reference to `this` in order to allow method chaining */ detachAvailableActionsPersonalizationPress( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:navigate navigate} event of this `sap.ui.comp.navpopover.NavigationPopover`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ detachNavigate( /** * The function to be called, when the event occurs */ fnFunction: (p1: NavigationPopover$NavigateEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:targetsObtained targetsObtained} event of * this `sap.ui.comp.navpopover.NavigationPopover`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.28.0 * @deprecated As of version 1.40.0. The event `navigationTargetsObtained` is obsolete as target determination * is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target * determination. The event `navigationTargetsObtained` is fired from NavigationPopoverHandler after navigation * targets are determined. * * @returns Reference to `this` in order to allow method chaining */ detachTargetsObtained( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:availableActionsPersonalizationPress availableActionsPersonalizationPress } * to attached listeners. * * @since 1.44.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireAvailableActionsPersonalizationPress( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:navigate navigate} to attached listeners. * * @since 1.28.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireNavigate( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.navpopover.NavigationPopover$NavigateEventParameters ): this; /** * Fires event {@link #event:targetsObtained targetsObtained} to attached listeners. * * @since 1.28.0 * @deprecated As of version 1.40.0. The event `navigationTargetsObtained` is obsolete as target determination * is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target * determination. The event `navigationTargetsObtained` is fired from NavigationPopoverHandler after navigation * targets are determined. * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireTargetsObtained( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Gets current value of property {@link #getAppStateKey appStateKey}. * * The application state key passed to retrieve the navigation targets. * * @since 1.28.0 * @deprecated As of version 1.40.0. The property `appStateKey` is obsolete as target determination is no * longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination. * * @returns Value of property `appStateKey` */ getAppStateKey(): string; /** * Gets content of aggregation {@link #getAvailableActions availableActions}. * * A list of available actions shown as links. * * @since 1.28.0 */ getAvailableActions(): sap.ui.comp.navpopover.LinkData[]; /** * Gets current value of property {@link #getAvailableActionsPersonalizationText availableActionsPersonalizationText}. * * Determines the text of personalization link. If this property is set to some string, choosing the personalization * link will trigger the `availableActionsPersonalizationPress` event. If this property is not set, the * personalization link is not shown. * * Default value is `undefined`. * * @since 1.44.0 * * @returns Value of property `availableActionsPersonalizationText` */ getAvailableActionsPersonalizationText(): string; /** * ID of the element which is the current target of the association {@link #getComponent component}, or * `null`. */ getComponent(): sap.ui.core.ID | null; /** * Returns link for direct navigation if the NavigationPopover has only `mainNavigation` or one `availableAction` * and no `extraContent`. * * * @returns Link for direct navigation */ getDirectLink(): sap.m.Link | null; /** * ID of the element which is the current target of the association {@link #getExtraContent extraContent}, * or `null`. * * @since 1.28.0 */ getExtraContent(): sap.ui.core.ID | null; /** * Gets content of aggregation {@link #getMainNavigation mainNavigation}. * * The main navigation link. If `mainNavigationId` is not set then `text` of `mainNavigation` is displayed. * Otherwise the `mainNavigationId` is displayed. * * @since 1.28.0 */ getMainNavigation(): sap.ui.comp.navpopover.LinkData; /** * Gets current value of property {@link #getMainNavigationId mainNavigationId}. * * Sets the description of the main navigation link. If `mainNavigation` also contains an href description, * then `mainNavigationId` is displayed. If `mainNavigationId` is set to an empty string `''`, neither description * nor subtitle are displayed. * * @since 1.28.0 * * @returns Value of property `mainNavigationId` */ getMainNavigationId(): string; /** * Gets content of aggregation {@link #getOwnNavigation ownNavigation}. * * The navigation taking the user back to the source application. * * @since 1.28.0 * @deprecated As of version 1.40.0. The property `ownNavigation` is obsolete as target determination is * no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination. */ getOwnNavigation(): sap.ui.comp.navpopover.LinkData; /** * Gets current value of property {@link #getSemanticAttributes semanticAttributes}. * * Describes the semantic attributes. The attribute has to be a map. * * @since 1.28.0 * @deprecated As of version 1.40.0. The property `semanticAttributes` is obsolete as target determination * is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target * determination. * * @returns Value of property `semanticAttributes` */ getSemanticAttributes(): object; /** * Gets current value of property {@link #getSemanticObjectName semanticObjectName}. * * The name of the semantic object. * * @since 1.28.0 * @deprecated As of version 1.40.0. The property `semanticObjectName` is obsolete as target determination * is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target * determination. * * @returns Value of property `semanticObjectName` */ getSemanticObjectName(): string; /** * ID of the element which is the current target of the association {@link #getSource source}, or `null`. * * @since 1.28.0 */ getSource(): sap.ui.core.ID | null; /** * Checks for the provided `sap.ui.comp.navpopover.LinkData` in the aggregation {@link #getAvailableActions availableActions}. * and returns its index if found or -1 otherwise. * * @since 1.28.0 * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfAvailableAction( /** * The availableAction whose index is looked for */ oAvailableAction: sap.ui.comp.navpopover.LinkData ): int; /** * Inserts a availableAction into the aggregation {@link #getAvailableActions availableActions}. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ insertAvailableAction( /** * The availableAction to insert; if empty, nothing is inserted */ oAvailableAction: sap.ui.comp.navpopover.LinkData, /** * The `0`-based index the availableAction should be inserted at; for a negative value of `iIndex`, the * availableAction is inserted at position 0; for a value greater than the current size of the aggregation, * the availableAction is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getAvailableActions availableActions}. * * Additionally, it unregisters them from the hosting UIArea. * * @since 1.28.0 * * @returns An array of the removed elements (might be empty) */ removeAllAvailableActions(): sap.ui.comp.navpopover.LinkData[]; /** * Removes a availableAction from the aggregation {@link #getAvailableActions availableActions}. * * @since 1.28.0 * * @returns The removed availableAction or `null` */ removeAvailableAction( /** * The availableAction to remove or its index or id */ vAvailableAction: int | string | sap.ui.comp.navpopover.LinkData ): sap.ui.comp.navpopover.LinkData | null; /** * Determines the potential navigation targets for the semantical object and visualize the popover. * * @deprecated As of version 1.42.0. Target determination is no longer done by NavigationPopover. Instead * the NavigationPopoverHandler is responsible for target determination. */ retrieveNavTargets(): void; /** * Sets a new value for property {@link #getAppStateKey appStateKey}. * * The application state key passed to retrieve the navigation targets. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.28.0 * @deprecated As of version 1.40.0. The property `appStateKey` is obsolete as target determination is no * longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination. * * @returns Reference to `this` in order to allow method chaining */ setAppStateKey( /** * New value for property `appStateKey` */ sAppStateKey?: string ): this; /** * Sets a new value for property {@link #getAvailableActionsPersonalizationText availableActionsPersonalizationText}. * * Determines the text of personalization link. If this property is set to some string, choosing the personalization * link will trigger the `availableActionsPersonalizationPress` event. If this property is not set, the * personalization link is not shown. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `undefined`. * * @since 1.44.0 * * @returns Reference to `this` in order to allow method chaining */ setAvailableActionsPersonalizationText( /** * New value for property `availableActionsPersonalizationText` */ sAvailableActionsPersonalizationText?: string ): this; /** * Sets the associated {@link #getComponent component}. * * * @returns Reference to `this` in order to allow method chaining */ setComponent( /** * ID of an element which becomes the new target of this component association; alternatively, an element * instance may be given */ oComponent: sap.ui.core.ID | sap.ui.core.Element ): this; /** * Sets the associated {@link #getExtraContent extraContent}. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setExtraContent( /** * ID of an element which becomes the new target of this extraContent association; alternatively, an element * instance may be given */ oExtraContent: sap.ui.core.ID | sap.ui.core.Control ): this; /** * Sets the aggregated {@link #getMainNavigation mainNavigation}. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setMainNavigation( /** * The mainNavigation to set */ oMainNavigation: sap.ui.comp.navpopover.LinkData ): this; /** * Sets a new value for property {@link #getMainNavigationId mainNavigationId}. * * Sets the description of the main navigation link. If `mainNavigation` also contains an href description, * then `mainNavigationId` is displayed. If `mainNavigationId` is set to an empty string `''`, neither description * nor subtitle are displayed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setMainNavigationId( /** * New value for property `mainNavigationId` */ sMainNavigationId?: string ): this; /** * Sets the aggregated {@link #getOwnNavigation ownNavigation}. * * @since 1.28.0 * @deprecated As of version 1.40.0. The property `ownNavigation` is obsolete as target determination is * no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target determination. * * @returns Reference to `this` in order to allow method chaining */ setOwnNavigation( /** * The ownNavigation to set */ oOwnNavigation: sap.ui.comp.navpopover.LinkData ): this; /** * Sets a new value for property {@link #getSemanticAttributes semanticAttributes}. * * Describes the semantic attributes. The attribute has to be a map. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.28.0 * @deprecated As of version 1.40.0. The property `semanticAttributes` is obsolete as target determination * is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target * determination. * * @returns Reference to `this` in order to allow method chaining */ setSemanticAttributes( /** * New value for property `semanticAttributes` */ oSemanticAttributes?: object ): this; /** * Sets a new value for property {@link #getSemanticObjectName semanticObjectName}. * * The name of the semantic object. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.28.0 * @deprecated As of version 1.40.0. The property `semanticObjectName` is obsolete as target determination * is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target * determination. * * @returns Reference to `this` in order to allow method chaining */ setSemanticObjectName( /** * New value for property `semanticObjectName` */ sSemanticObjectName?: string ): this; /** * Sets the associated {@link #getSource source}. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setSource( /** * ID of an element which becomes the new target of this source association; alternatively, an element instance * may be given */ oSource: sap.ui.core.ID | sap.ui.core.Control ): this; /** * Displays the popover. This method should be called, once all navigation targets are adapted by the application. */ show(): void; } /** * The NavigationPopoverHandler control determines navigation targets for a semantic object and shows them * together with further information in a Popover. * **Note:** Navigation targets are determined using {@link sap.ushell.services.CrossApplicationNavigation CrossApplicationNavigation } * of the unified shell service. * * @deprecated As of version 1.121. SmartLink no longer uses the NavigationPopoverHandler, it got replaced * by a sap.ui.mdc.Link implementation. All event handlings can be done directly on the SmartLink / SemanticObjectController. */ class NavigationPopoverHandler extends sap.ui.base.ManagedObject { /** * Constructor for a new navpopover/NavigationPopoverHandler. * * 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.ui.comp.navpopover.$NavigationPopoverHandlerSettings ); /** * Constructor for a new navpopover/NavigationPopoverHandler. * * 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.ui.comp.navpopover.$NavigationPopoverHandlerSettings ); /** * Creates a new subclass of class sap.ui.comp.navpopover.NavigationPopoverHandler 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.base.ManagedObject.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< T, sap.ui.comp.navpopover.NavigationPopoverHandler >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.navpopover.NavigationPopoverHandler. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:beforePopoverOpens beforePopoverOpens} event * of this `sap.ui.comp.navpopover.NavigationPopoverHandler`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.NavigationPopoverHandler` itself. * * Event is fired before the navigation popover opens and before navigation target links are getting retrieved. * Event can be used to change the parameters used to retrieve the navigation targets. In case of NavigationPopoverHandler, * the `beforePopoverOpens` is fired after the link has been clicked. * * @since 1.36.0 * * @returns Reference to `this` in order to allow method chaining */ attachBeforePopoverOpens( /** * 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: NavigationPopoverHandler$BeforePopoverOpensEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.NavigationPopoverHandler` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforePopoverOpens beforePopoverOpens} event * of this `sap.ui.comp.navpopover.NavigationPopoverHandler`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.NavigationPopoverHandler` itself. * * Event is fired before the navigation popover opens and before navigation target links are getting retrieved. * Event can be used to change the parameters used to retrieve the navigation targets. In case of NavigationPopoverHandler, * the `beforePopoverOpens` is fired after the link has been clicked. * * @since 1.36.0 * * @returns Reference to `this` in order to allow method chaining */ attachBeforePopoverOpens( /** * The function to be called when the event occurs */ fnFunction: ( p1: NavigationPopoverHandler$BeforePopoverOpensEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.NavigationPopoverHandler` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:innerNavigate innerNavigate} event of this `sap.ui.comp.navpopover.NavigationPopoverHandler`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.NavigationPopoverHandler` itself. * * This event is fired after a navigation link on the navigation popover has been clicked. This event is * only fired, if the user left-clicks the link. Right-clicking the link and selecting 'Open in New Window' * etc. in the context menu does not fire the event. * * @since 1.36.0 * * @returns Reference to `this` in order to allow method chaining */ attachInnerNavigate( /** * 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: NavigationPopoverHandler$InnerNavigateEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.NavigationPopoverHandler` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:innerNavigate innerNavigate} event of this `sap.ui.comp.navpopover.NavigationPopoverHandler`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.NavigationPopoverHandler` itself. * * This event is fired after a navigation link on the navigation popover has been clicked. This event is * only fired, if the user left-clicks the link. Right-clicking the link and selecting 'Open in New Window' * etc. in the context menu does not fire the event. * * @since 1.36.0 * * @returns Reference to `this` in order to allow method chaining */ attachInnerNavigate( /** * The function to be called when the event occurs */ fnFunction: ( p1: NavigationPopoverHandler$InnerNavigateEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.NavigationPopoverHandler` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:navigationTargetsObtained navigationTargetsObtained } * event of this `sap.ui.comp.navpopover.NavigationPopoverHandler`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.NavigationPopoverHandler` itself. * * After the navigation targets are retrieved, `navigationTargetsObtained` is fired and provides the possibility * to change the targets. * * @since 1.36.0 * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. * * @returns Reference to `this` in order to allow method chaining */ attachNavigationTargetsObtained( /** * 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: NavigationPopoverHandler$NavigationTargetsObtainedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.NavigationPopoverHandler` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:navigationTargetsObtained navigationTargetsObtained } * event of this `sap.ui.comp.navpopover.NavigationPopoverHandler`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.NavigationPopoverHandler` itself. * * After the navigation targets are retrieved, `navigationTargetsObtained` is fired and provides the possibility * to change the targets. * * @since 1.36.0 * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. * * @returns Reference to `this` in order to allow method chaining */ attachNavigationTargetsObtained( /** * The function to be called when the event occurs */ fnFunction: ( p1: NavigationPopoverHandler$NavigationTargetsObtainedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.NavigationPopoverHandler` * itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:beforePopoverOpens beforePopoverOpens} event * of this `sap.ui.comp.navpopover.NavigationPopoverHandler`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.36.0 * * @returns Reference to `this` in order to allow method chaining */ detachBeforePopoverOpens( /** * The function to be called, when the event occurs */ fnFunction: ( p1: NavigationPopoverHandler$BeforePopoverOpensEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:innerNavigate innerNavigate} event of this * `sap.ui.comp.navpopover.NavigationPopoverHandler`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.36.0 * * @returns Reference to `this` in order to allow method chaining */ detachInnerNavigate( /** * The function to be called, when the event occurs */ fnFunction: ( p1: NavigationPopoverHandler$InnerNavigateEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:navigationTargetsObtained navigationTargetsObtained } * event of this `sap.ui.comp.navpopover.NavigationPopoverHandler`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.36.0 * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. * * @returns Reference to `this` in order to allow method chaining */ detachNavigationTargetsObtained( /** * The function to be called, when the event occurs */ fnFunction: ( p1: NavigationPopoverHandler$NavigationTargetsObtainedEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:beforePopoverOpens beforePopoverOpens} to attached listeners. * * @since 1.36.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireBeforePopoverOpens( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.navpopover.NavigationPopoverHandler$BeforePopoverOpensEventParameters ): this; /** * Fires event {@link #event:innerNavigate innerNavigate} to attached listeners. * * @since 1.36.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireInnerNavigate( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.navpopover.NavigationPopoverHandler$InnerNavigateEventParameters ): this; /** * Fires event {@link #event:navigationTargetsObtained navigationTargetsObtained} to attached listeners. * * @since 1.36.0 * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireNavigationTargetsObtained( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.navpopover.NavigationPopoverHandler$NavigationTargetsObtainedEventParameters ): this; /** * Gets current value of property {@link #getAdditionalSemanticObjects additionalSemanticObjects}. * * Names of additional semantic objects which are used to determine target navigations. * * Default value is `[]`. * * @since 1.42.0 * * @returns Value of property `additionalSemanticObjects` */ getAdditionalSemanticObjects(): string[]; /** * Gets current value of property {@link #getBeforeNavigationCallback beforeNavigationCallback}. * * Function that is called before the actual navigation happens. This function has to return a `Promise` * resolving into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the * navigation will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the * following data: * - {String} text: Text of the navigation intent * - {String} href: HREF of the navigation intent * - {String} originalId: ID of the control that fires the navigation intent * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent * * * @since 1.75.0 * * @returns Value of property `beforeNavigationCallback` */ getBeforeNavigationCallback(): Function; /** * Gets current value of property {@link #getContactAnnotationPath contactAnnotationPath}. * * Navigation property that points from the current to the related entity type where the com.sap.vocabularies.Communication.v1.Contact * annotation is defined, for example, `'to_Supplier'`. An empty string means that the related entity type * is the current one. * * Default value is `undefined`. * * @since 1.40.0 * * @returns Value of property `contactAnnotationPath` */ getContactAnnotationPath(): string; /** * ID of the element which is the current target of the association {@link #getControl control}, or `null`. * * @since 1.36.0 */ getControl(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getEnableAvailableActionsPersonalization enableAvailableActionsPersonalization}. * * Determines whether the personalization link is shown inside the NavigationPopover control. * * Default value is `true`. * * @since 1.44.0 * * @returns Value of property `enableAvailableActionsPersonalization` */ getEnableAvailableActionsPersonalization(): boolean; /** * Gets current value of property {@link #getFieldName fieldName}. * * The metadata field name for this NavigationPopoverHandler control. * * @since 1.36.0 * * @returns Value of property `fieldName` */ getFieldName(): string; /** * Gets current value of property {@link #getMapFieldToSemanticObject mapFieldToSemanticObject}. * * If set to `false`, the NavigationPopoverHandler control will not replace its field name with the according * `semanticObject` property during the calculation of the semantic attributes. This enables the usage of * several NavigationPopoverHandler on the same semantic object. * * * Default value is `true`. * * @since 1.36.0 * * @returns Value of property `mapFieldToSemanticObject` */ getMapFieldToSemanticObject(): boolean; /** * Gets current value of property {@link #getNavigationTargetsObtainedCallback navigationTargetsObtainedCallback}. * * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained. * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}. * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}. * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `NavigationPopoverHandler`. * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained` * event. The event handling is ignored if this callback is set. * * @since 1.126 * * @returns Value of property `navigationTargetsObtainedCallback` */ getNavigationTargetsObtainedCallback(): Function; /** * Gets current value of property {@link #getSemanticObject semanticObject}. * * Name of semantic object which is used to determine target navigations. * * @since 1.36.0 * * @returns Value of property `semanticObject` */ getSemanticObject(): string; /** * Gets current value of property {@link #getSemanticObjectController semanticObjectController}. * * The semantic object controller controls events for several NavigationPopoverHandler controls. If the * controller is not set manually, it tries to find a SemanticObjectController in its parent hierarchy. * * @since 1.36.0 * * @returns Value of property `semanticObjectController` */ getSemanticObjectController(): any; /** * Gets current value of property {@link #getSemanticObjectLabel semanticObjectLabel}. * * Shown title of semantic object. * * @since 1.36.0 * @deprecated As of version 1.40.0. Title section with `semanticObjectLabel` has been removed due to new * UI design * * @returns Value of property `semanticObjectLabel` */ getSemanticObjectLabel(): string; /** * Gets the current value assigned to the field with the NavigationPopoverHandler's semantic object name. * * * @returns The semantic object's value. */ getSemanticObjectValue(): object; /** * Opens the `sap.m.Popover` with navigation targets in an asynchronous manner. * * * @returns A `Promise` for asynchronous execution */ openPopover( /** * Optional DOM reference to which the popover is attached. By default the `control` association is used * as DOM reference. */ oDomRef: object ): Promise; /** * Sets a new value for property {@link #getAdditionalSemanticObjects additionalSemanticObjects}. * * Names of additional semantic objects which are used to determine target navigations. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `[]`. * * @since 1.42.0 * * @returns Reference to `this` in order to allow method chaining */ setAdditionalSemanticObjects( /** * New value for property `additionalSemanticObjects` */ sAdditionalSemanticObjects?: string[] ): this; /** * Sets a new value for property {@link #getBeforeNavigationCallback beforeNavigationCallback}. * * Function that is called before the actual navigation happens. This function has to return a `Promise` * resolving into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the * navigation will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the * following data: * - {String} text: Text of the navigation intent * - {String} href: HREF of the navigation intent * - {String} originalId: ID of the control that fires the navigation intent * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent * * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.75.0 * * @returns Reference to `this` in order to allow method chaining */ setBeforeNavigationCallback( /** * New value for property `beforeNavigationCallback` */ fnBeforeNavigationCallback: Function ): this; /** * Sets a new value for property {@link #getContactAnnotationPath contactAnnotationPath}. * * Navigation property that points from the current to the related entity type where the com.sap.vocabularies.Communication.v1.Contact * annotation is defined, for example, `'to_Supplier'`. An empty string means that the related entity type * is the current one. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `undefined`. * * @since 1.40.0 * * @returns Reference to `this` in order to allow method chaining */ setContactAnnotationPath( /** * New value for property `contactAnnotationPath` */ sContactAnnotationPath?: string ): this; /** * Sets the associated {@link #getControl control}. * * @since 1.36.0 * * @returns Reference to `this` in order to allow method chaining */ setControl( /** * ID of an element which becomes the new target of this control association; alternatively, an element * instance may be given */ oControl: sap.ui.core.ID | sap.ui.core.Control ): this; /** * Sets a new value for property {@link #getEnableAvailableActionsPersonalization enableAvailableActionsPersonalization}. * * Determines whether the personalization link is shown inside the NavigationPopover control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.44.0 * * @returns Reference to `this` in order to allow method chaining */ setEnableAvailableActionsPersonalization( /** * New value for property `enableAvailableActionsPersonalization` */ bEnableAvailableActionsPersonalization?: boolean ): this; /** * Sets a new value for property {@link #getFieldName fieldName}. * * The metadata field name for this NavigationPopoverHandler control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.36.0 * * @returns Reference to `this` in order to allow method chaining */ setFieldName( /** * New value for property `fieldName` */ sFieldName?: string ): this; /** * Sets a new value for property {@link #getMapFieldToSemanticObject mapFieldToSemanticObject}. * * If set to `false`, the NavigationPopoverHandler control will not replace its field name with the according * `semanticObject` property during the calculation of the semantic attributes. This enables the usage of * several NavigationPopoverHandler on the same semantic object. * * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.36.0 * * @returns Reference to `this` in order to allow method chaining */ setMapFieldToSemanticObject( /** * New value for property `mapFieldToSemanticObject` */ bMapFieldToSemanticObject?: boolean ): this; /** * Sets a new value for property {@link #getNavigationTargetsObtainedCallback navigationTargetsObtainedCallback}. * * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained. * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}. * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}. * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `NavigationPopoverHandler`. * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained` * event. The event handling is ignored if this callback is set. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.126 * * @returns Reference to `this` in order to allow method chaining */ setNavigationTargetsObtainedCallback( /** * New value for property `navigationTargetsObtainedCallback` */ fnNavigationTargetsObtainedCallback: Function ): this; /** * Sets a new value for property {@link #getSemanticObject semanticObject}. * * Name of semantic object which is used to determine target navigations. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.36.0 * * @returns Reference to `this` in order to allow method chaining */ setSemanticObject( /** * New value for property `semanticObject` */ sSemanticObject?: string ): this; /** * Sets a new value for property {@link #getSemanticObjectController semanticObjectController}. * * The semantic object controller controls events for several NavigationPopoverHandler controls. If the * controller is not set manually, it tries to find a SemanticObjectController in its parent hierarchy. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.36.0 * * @returns Reference to `this` in order to allow method chaining */ setSemanticObjectController( /** * New value for property `semanticObjectController` */ oSemanticObjectController?: any ): this; /** * Sets a new value for property {@link #getSemanticObjectLabel semanticObjectLabel}. * * Shown title of semantic object. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.36.0 * @deprecated As of version 1.40.0. Title section with `semanticObjectLabel` has been removed due to new * UI design * * @returns Reference to `this` in order to allow method chaining */ setSemanticObjectLabel( /** * New value for property `semanticObjectLabel` */ sSemanticObjectLabel?: string ): this; } /** * The `SemanticObjectController` control operates as a single entry point for `SmartLink` controls created * automatically by {@link sap.ui.comp.smarttable.SmartTable SmartTable} control, {@link sap.ui.comp.smartchart.SmartChart SmartChart } * control, {@link sap.ui.comp.smartform.SmartForm SmartForm} control and {@link sap.ui.comp.smartfield.SmartField SmartField } * control based on OData metadata. Additionally, all events provided by the `SmartLink` control are registered * by the SemanticObjectController and can be consumed there in a single place. As usual, the SemanticObjectController * can be defined within the XML view as well as in the code. */ class SemanticObjectController extends sap.ui.core.Element { /** * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. */ constructor( /** * initial settings for the new control */ mSettings?: sap.ui.comp.navpopover.$SemanticObjectControllerSettings ); /** * 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.ui.comp.navpopover.$SemanticObjectControllerSettings ); /** * Creates a new subclass of class sap.ui.comp.navpopover.SemanticObjectController with name `sClassName` * and enriches it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.comp.navpopover.SemanticObjectController >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.navpopover.SemanticObjectController. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:beforePopoverOpens beforePopoverOpens} event * of this `sap.ui.comp.navpopover.SemanticObjectController`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself. * * Event is fired before the navigation popover opens and before navigation target links are retrieved. * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink, * `beforePopoverOpens` is fired after the link has been clicked. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachBeforePopoverOpens( /** * 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: SemanticObjectController$BeforePopoverOpensEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforePopoverOpens beforePopoverOpens} event * of this `sap.ui.comp.navpopover.SemanticObjectController`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself. * * Event is fired before the navigation popover opens and before navigation target links are retrieved. * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink, * `beforePopoverOpens` is fired after the link has been clicked. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachBeforePopoverOpens( /** * The function to be called when the event occurs */ fnFunction: ( p1: SemanticObjectController$BeforePopoverOpensEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:navigate navigate} event of this `sap.ui.comp.navpopover.SemanticObjectController`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself. * * This event is fired after a navigation link on the navigation popover has been clicked. This event is * only fired, if the user left-clicks the link. Right-clicking the link and selecting 'Open in New Window' * etc. in the context menu does not fire the event. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachNavigate( /** * 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: SemanticObjectController$NavigateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:navigate navigate} event of this `sap.ui.comp.navpopover.SemanticObjectController`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself. * * This event is fired after a navigation link on the navigation popover has been clicked. This event is * only fired, if the user left-clicks the link. Right-clicking the link and selecting 'Open in New Window' * etc. in the context menu does not fire the event. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachNavigate( /** * The function to be called when the event occurs */ fnFunction: (p1: SemanticObjectController$NavigateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:navigationTargetsObtained navigationTargetsObtained } * event of this `sap.ui.comp.navpopover.SemanticObjectController`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself. * * After the navigation targets have been retrieved, `navigationTargetsObtained` is fired and makes it possible * you to change the targets. * * @since 1.28.0 * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. * * @returns Reference to `this` in order to allow method chaining */ attachNavigationTargetsObtained( /** * 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: SemanticObjectController$NavigationTargetsObtainedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:navigationTargetsObtained navigationTargetsObtained } * event of this `sap.ui.comp.navpopover.SemanticObjectController`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself. * * After the navigation targets have been retrieved, `navigationTargetsObtained` is fired and makes it possible * you to change the targets. * * @since 1.28.0 * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. * * @returns Reference to `this` in order to allow method chaining */ attachNavigationTargetsObtained( /** * The function to be called when the event occurs */ fnFunction: ( p1: SemanticObjectController$NavigationTargetsObtainedEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:prefetchDone prefetchDone} event of this `sap.ui.comp.navpopover.SemanticObjectController`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself. * * If the property `prefetchNavigationTargets` is set to `true`, event `prefetchDone` is fired after all * navigation targets have been retrieved. * * @since 1.28.0 * @deprecated As of version 1.42.0. The event `prefetchDone` is obsolete because it depends on the property * `prefetchNavigationTargets` which has been deprecated. * * @returns Reference to `this` in order to allow method chaining */ attachPrefetchDone( /** * 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: SemanticObjectController$PrefetchDoneEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:prefetchDone prefetchDone} event of this `sap.ui.comp.navpopover.SemanticObjectController`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.SemanticObjectController` itself. * * If the property `prefetchNavigationTargets` is set to `true`, event `prefetchDone` is fired after all * navigation targets have been retrieved. * * @since 1.28.0 * @deprecated As of version 1.42.0. The event `prefetchDone` is obsolete because it depends on the property * `prefetchNavigationTargets` which has been deprecated. * * @returns Reference to `this` in order to allow method chaining */ attachPrefetchDone( /** * The function to be called when the event occurs */ fnFunction: ( p1: SemanticObjectController$PrefetchDoneEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SemanticObjectController` * itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:beforePopoverOpens beforePopoverOpens} event * of this `sap.ui.comp.navpopover.SemanticObjectController`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ detachBeforePopoverOpens( /** * The function to be called, when the event occurs */ fnFunction: ( p1: SemanticObjectController$BeforePopoverOpensEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:navigate navigate} event of this `sap.ui.comp.navpopover.SemanticObjectController`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ detachNavigate( /** * The function to be called, when the event occurs */ fnFunction: (p1: SemanticObjectController$NavigateEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:navigationTargetsObtained navigationTargetsObtained } * event of this `sap.ui.comp.navpopover.SemanticObjectController`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.28.0 * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. * * @returns Reference to `this` in order to allow method chaining */ detachNavigationTargetsObtained( /** * The function to be called, when the event occurs */ fnFunction: ( p1: SemanticObjectController$NavigationTargetsObtainedEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:prefetchDone prefetchDone} event of this `sap.ui.comp.navpopover.SemanticObjectController`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.28.0 * @deprecated As of version 1.42.0. The event `prefetchDone` is obsolete because it depends on the property * `prefetchNavigationTargets` which has been deprecated. * * @returns Reference to `this` in order to allow method chaining */ detachPrefetchDone( /** * The function to be called, when the event occurs */ fnFunction: ( p1: SemanticObjectController$PrefetchDoneEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:beforePopoverOpens beforePopoverOpens} to attached listeners. * * @since 1.28.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireBeforePopoverOpens( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.navpopover.SemanticObjectController$BeforePopoverOpensEventParameters ): this; /** * Fires event {@link #event:navigate navigate} to attached listeners. * * @since 1.28.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireNavigate( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.navpopover.SemanticObjectController$NavigateEventParameters ): this; /** * Fires event {@link #event:navigationTargetsObtained navigationTargetsObtained} to attached listeners. * * @since 1.28.0 * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireNavigationTargetsObtained( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.navpopover.SemanticObjectController$NavigationTargetsObtainedEventParameters ): this; /** * Fires event {@link #event:prefetchDone prefetchDone} to attached listeners. * * @since 1.28.0 * @deprecated As of version 1.42.0. The event `prefetchDone` is obsolete because it depends on the property * `prefetchNavigationTargets` which has been deprecated. * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ firePrefetchDone( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.navpopover.SemanticObjectController$PrefetchDoneEventParameters ): this; /** * Gets current value of property {@link #getBeforeNavigationCallback beforeNavigationCallback}. * * Function that is called before the actual navigation happens. This function has to return a promise resolving * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data: * * - {String} text: Text of the navigation intent * - {String} href: HREF of the navigation intent * - {String} originalId: ID of the control that fires the navigation intent * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent * * * @since 1.75.0 * * @returns Value of property `beforeNavigationCallback` */ getBeforeNavigationCallback(): Function; /** * Gets current value of property {@link #getContactAnnotationPaths contactAnnotationPaths}. * * Navigation property that points from the current to the related entity type where the `com.sap.vocabularies.Communication.v1.Contact` * annotation is defined, for example, ` '\{"Supplier":"to_Supplier", "CompanyName":"to_Company"\}' `. An * empty string means that the related entity type is the current one. * * @since 1.40.0 * * @returns Value of property `contactAnnotationPaths` */ getContactAnnotationPaths(): object; /** * Gets current value of property {@link #getEnableAvailableActionsPersonalization enableAvailableActionsPersonalization}. * * Determines whether the personalization link is shown inside the NavigationPopover control. For example, * ` '\{"Supplier":false, "CompanyName":true\}' `. * * @since 1.44.0 * * @returns Value of property `enableAvailableActionsPersonalization` */ getEnableAvailableActionsPersonalization(): object; /** * Gets current value of property {@link #getEntitySet entitySet}. * * The name of the entity set used. If `entitySet` has not been defined, the SemanticObjectController tries * to retrieve the name from its parents. **Note:** This is not a dynamic UI5 property. * * @since 1.28.0 * * @returns Value of property `entitySet` */ getEntitySet(): string; /** * Gets current value of property {@link #getFieldSemanticObjectMap fieldSemanticObjectMap}. * * Maps the fields to the related semantic objects. When accessing this property for the first time, the * mapping will be calculated from the metadata within the provided model. * * @since 1.28.0 * * @returns Value of property `fieldSemanticObjectMap` */ getFieldSemanticObjectMap(): object; /** * Gets current value of property {@link #getForceLinkRendering forceLinkRendering}. * * Object containing fields for which the corresponding `SmartLink` control is rendered as a link even if * `contactAnnotationPaths` is not set and navigation targets do not exist. Setting this property to `true` * allows the application, for example, to modify the `SmartLink` control in the event handler, after the * user has clicked on a link and the registered event handler has been called.\n * * **Note:** The `ignoredFields` property and the `ignoreLinkRendering` property of the `SmartLink` control * take precedence over `forceLinkRendering`.\n * * Example of usage: ` '\{"Supplier":"true", "CompanyName":"true"\}' ` * * @since 1.58.0 * * @returns Value of property `forceLinkRendering` */ getForceLinkRendering(): object; /** * Gets current value of property {@link #getIgnoredFields ignoredFields}. * * Comma-separated list of fields that must not be displayed as links. * * @since 1.28.0 * * @returns Value of property `ignoredFields` */ getIgnoredFields(): string; /** * Gets current value of property {@link #getMapFieldToSemanticObject mapFieldToSemanticObject}. * * If set to `false`, the SmartLink control will not replace its field name with the according `semanticObject` * property during the calculation of the semantic attributes. * * @since 1.48.0 * * @returns Value of property `mapFieldToSemanticObject` */ getMapFieldToSemanticObject(): boolean; /** * Gets current value of property {@link #getNavigationTargetsObtainedCallback navigationTargetsObtainedCallback}. * * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained. * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}. * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}. * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `SmartLinkFieldInfo`. * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained` * event. The event handling is ignored if this callback is set. * * @since 1.126 * * @returns Value of property `navigationTargetsObtainedCallback` */ getNavigationTargetsObtainedCallback(): Function; /** * Gets current value of property {@link #getPrefetchNavigationTargets prefetchNavigationTargets}. * * If set to `true`, the SemanticObjectController will retrieve all navigation targets once and will disable * links for which no targets were found. Setting this value to `true` will trigger an additional roundtrip. * * Default value is `false`. * * @since 1.28.0 * @deprecated As of version 1.42.0. The property `prefetchNavigationTargets` is obsolete as navigation * targets are determined automatically. The SmartLink controls are re-rendered as soon as the asynchronous * determination of navigation targets has been completed. * * @returns Value of property `prefetchNavigationTargets` */ getPrefetchNavigationTargets(): boolean; /** * Gets current value of property {@link #getReplaceSmartLinkNavigationTargetsObtained replaceSmartLinkNavigationTargetsObtained}. * * Determines if the `navigationTargetsObtained` event handling of the `SmartLink` should be replaced when * this `SemanticObjectController` is set as `SemanticObjectController` on the SmartLink. * * Default value is `false`. * * @since 1.97 * * @returns Value of property `replaceSmartLinkNavigationTargetsObtained` */ getReplaceSmartLinkNavigationTargetsObtained(): boolean; /** * Checks if the given semantic object name has a navigation link. **Note**: this method returns a valid * value only after the event `prefetchDone` has been raised. The event `prefetchDone` is raised if the * property `prefetchNavigationTargets` is set to `true`. * * @deprecated As of version 1.42.0. The method `hasSemanticObjectLinks` is obsolete because it depends * on the property `prefetchNavigationTargets` which has been deprecated. * * @returns true if the semantic object has any navigation links */ hasSemanticObjectLinks( /** * Name of semantic object */ sSemanticObject: string ): boolean; /** * Returns whether the given control has been registered by the SemanticObjectController. * * * @returns `true` if the given control has been registered */ isControlRegistered( /** * Control registered by `SemanticObjectController` */ oControl: sap.ui.comp.navpopover.SmartLink ): boolean; /** * Adds the given control to the SemanticObjectController and registers all relevant events. */ registerControl( /** * Control to be registered by `SemanticObjectController` */ oControl: sap.ui.comp.navpopover.SmartLink ): void; /** * Sets a new value for property {@link #getBeforeNavigationCallback beforeNavigationCallback}. * * Function that is called before the actual navigation happens. This function has to return a promise resolving * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data: * * - {String} text: Text of the navigation intent * - {String} href: HREF of the navigation intent * - {String} originalId: ID of the control that fires the navigation intent * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent * * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.75.0 * * @returns Reference to `this` in order to allow method chaining */ setBeforeNavigationCallback( /** * New value for property `beforeNavigationCallback` */ fnBeforeNavigationCallback: Function ): this; /** * Sets a new value for property {@link #getContactAnnotationPaths contactAnnotationPaths}. * * Navigation property that points from the current to the related entity type where the `com.sap.vocabularies.Communication.v1.Contact` * annotation is defined, for example, ` '\{"Supplier":"to_Supplier", "CompanyName":"to_Company"\}' `. An * empty string means that the related entity type is the current one. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.40.0 * * @returns Reference to `this` in order to allow method chaining */ setContactAnnotationPaths( /** * New value for property `contactAnnotationPaths` */ oContactAnnotationPaths?: object ): this; /** * Sets a new value for property {@link #getEnableAvailableActionsPersonalization enableAvailableActionsPersonalization}. * * Determines whether the personalization link is shown inside the NavigationPopover control. For example, * ` '\{"Supplier":false, "CompanyName":true\}' `. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.44.0 * * @returns Reference to `this` in order to allow method chaining */ setEnableAvailableActionsPersonalization( /** * New value for property `enableAvailableActionsPersonalization` */ oEnableAvailableActionsPersonalization?: object ): this; /** * Sets a new value for property {@link #getEntitySet entitySet}. * * The name of the entity set used. If `entitySet` has not been defined, the SemanticObjectController tries * to retrieve the name from its parents. **Note:** This is not a dynamic UI5 property. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setEntitySet( /** * New value for property `entitySet` */ sEntitySet?: string ): this; /** * Sets a new value for property {@link #getFieldSemanticObjectMap fieldSemanticObjectMap}. * * Maps the fields to the related semantic objects. When accessing this property for the first time, the * mapping will be calculated from the metadata within the provided model. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setFieldSemanticObjectMap( /** * New value for property `fieldSemanticObjectMap` */ oFieldSemanticObjectMap?: object ): this; /** * Sets a new value for property {@link #getForceLinkRendering forceLinkRendering}. * * Object containing fields for which the corresponding `SmartLink` control is rendered as a link even if * `contactAnnotationPaths` is not set and navigation targets do not exist. Setting this property to `true` * allows the application, for example, to modify the `SmartLink` control in the event handler, after the * user has clicked on a link and the registered event handler has been called.\n * * **Note:** The `ignoredFields` property and the `ignoreLinkRendering` property of the `SmartLink` control * take precedence over `forceLinkRendering`.\n * * Example of usage: ` '\{"Supplier":"true", "CompanyName":"true"\}' ` * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.58.0 * * @returns Reference to `this` in order to allow method chaining */ setForceLinkRendering( /** * New value for property `forceLinkRendering` */ oForceLinkRendering?: object ): this; /** * Sets a new value for property {@link #getIgnoredFields ignoredFields}. * * Comma-separated list of fields that must not be displayed as links. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setIgnoredFields( /** * New value for property `ignoredFields` */ sIgnoredFields?: string ): this; /** * Checks if the given SmartLink has to be enabled or disabled and sets the state. * * @deprecated As of version 1.42.0. The method `setIgnoredState` is obsolete as SmartLink is processing * the internal state on its own. */ setIgnoredState( /** * the SmartLink which should be enabled or disabled. */ oSmartLink: sap.ui.comp.navpopover.SmartLink ): void; /** * Sets a new value for property {@link #getMapFieldToSemanticObject mapFieldToSemanticObject}. * * If set to `false`, the SmartLink control will not replace its field name with the according `semanticObject` * property during the calculation of the semantic attributes. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ setMapFieldToSemanticObject( /** * New value for property `mapFieldToSemanticObject` */ bMapFieldToSemanticObject: boolean ): this; /** * Sets a new value for property {@link #getNavigationTargetsObtainedCallback navigationTargetsObtainedCallback}. * * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained. * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}. * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}. * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `SmartLinkFieldInfo`. * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained` * event. The event handling is ignored if this callback is set. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.126 * * @returns Reference to `this` in order to allow method chaining */ setNavigationTargetsObtainedCallback( /** * New value for property `navigationTargetsObtainedCallback` */ fnNavigationTargetsObtainedCallback: Function ): this; /** * Sets a new value for property {@link #getReplaceSmartLinkNavigationTargetsObtained replaceSmartLinkNavigationTargetsObtained}. * * Determines if the `navigationTargetsObtained` event handling of the `SmartLink` should be replaced when * this `SemanticObjectController` is set as `SemanticObjectController` on the SmartLink. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.97 * * @returns Reference to `this` in order to allow method chaining */ setReplaceSmartLinkNavigationTargetsObtained( /** * New value for property `replaceSmartLinkNavigationTargetsObtained` */ bReplaceSmartLinkNavigationTargetsObtained?: boolean ): this; /** * Removes the given control from the SemanticObjectController and unregisters all relevant events. */ unregisterControl( /** * Control to be unregistered by `SemanticObjectController` */ oControl: sap.ui.comp.navpopover.SmartLink ): void; } /** * The `SmartLink` control uses a semantic object to display {@link sap.ui.comp.navpopover.NavigationPopover NavigationPopover } * for further navigation steps. * **Note:** Navigation targets are determined using {@link sap.ushell.services.CrossApplicationNavigation CrossApplicationNavigation } * of the unified shell service. * * **Important:** Keep in mind that `SmartLink`, like all SAPUI5 smart controls, retrieves and analyzes * the metadata and annotations of OData services. **The OData metadata is its primary API. These OData * services are not part of the SAPUI5 framework and are usually maintained by the backend developers of * your application.** * * With time, `SmartLink` can evolve and acquire new features. This means that its behavior or functionalities * may change if the annotations that define this change are maintained in your backend metadata. To benefit * from the new functionalities, your application should be able to adapt the backend metadata. **Therefore, * we recommend using `SmartLink` only if you have control over the metadata of your application.** */ class SmartLink extends sap.m.Link { /** * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/f638884d0d624ad8a243f4005f8e9972 Smart Link} */ constructor( /** * Initial settings for the new control */ mSettings?: sap.ui.comp.navpopover.$SmartLinkSettings ); /** * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/f638884d0d624ad8a243f4005f8e9972 Smart Link} */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string, /** * Initial settings for the new control */ mSettings?: sap.ui.comp.navpopover.$SmartLinkSettings ); /** * Creates a new subclass of class sap.ui.comp.navpopover.SmartLink 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.Link.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.navpopover.SmartLink. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:beforePopoverOpens beforePopoverOpens} event * of this `sap.ui.comp.navpopover.SmartLink`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself. * * Event is fired before the navigation popover opens and before navigation target links are getting retrieved. * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink * control, the `beforePopoverOpens` is fired after the link has been clicked. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachBeforePopoverOpens( /** * 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: SmartLink$BeforePopoverOpensEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforePopoverOpens beforePopoverOpens} event * of this `sap.ui.comp.navpopover.SmartLink`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself. * * Event is fired before the navigation popover opens and before navigation target links are getting retrieved. * Event can be used to change the parameters used to retrieve the navigation targets. In case of SmartLink * control, the `beforePopoverOpens` is fired after the link has been clicked. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachBeforePopoverOpens( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartLink$BeforePopoverOpensEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:innerNavigate innerNavigate} event of this `sap.ui.comp.navpopover.SmartLink`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself. * * This event is fired after a navigation link on the navigation popover has been clicked. This event is * only fired, if the user left-clicks the link. Right-clicking the link and selecting 'Open in New Window' * etc. in the context menu does not fire the event. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachInnerNavigate( /** * 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: SmartLink$InnerNavigateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:innerNavigate innerNavigate} event of this `sap.ui.comp.navpopover.SmartLink`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself. * * This event is fired after a navigation link on the navigation popover has been clicked. This event is * only fired, if the user left-clicks the link. Right-clicking the link and selecting 'Open in New Window' * etc. in the context menu does not fire the event. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachInnerNavigate( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartLink$InnerNavigateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:navigationTargetsObtained navigationTargetsObtained } * event of this `sap.ui.comp.navpopover.SmartLink`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself. * * After the navigation targets are retrieved, `navigationTargetsObtained` is fired and provides the possibility * to change the targets. * * @since 1.28.0 * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. * * @returns Reference to `this` in order to allow method chaining */ attachNavigationTargetsObtained( /** * 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: SmartLink$NavigationTargetsObtainedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:navigationTargetsObtained navigationTargetsObtained } * event of this `sap.ui.comp.navpopover.SmartLink`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.navpopover.SmartLink` itself. * * After the navigation targets are retrieved, `navigationTargetsObtained` is fired and provides the possibility * to change the targets. * * @since 1.28.0 * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. * * @returns Reference to `this` in order to allow method chaining */ attachNavigationTargetsObtained( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartLink$NavigationTargetsObtainedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.navpopover.SmartLink` itself */ oListener?: object ): this; /** * Destroys the innerControl in the aggregation {@link #getInnerControl innerControl}. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ destroyInnerControl(): this; /** * Detaches event handler `fnFunction` from the {@link #event:beforePopoverOpens beforePopoverOpens} event * of this `sap.ui.comp.navpopover.SmartLink`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ detachBeforePopoverOpens( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartLink$BeforePopoverOpensEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:innerNavigate innerNavigate} event of this * `sap.ui.comp.navpopover.SmartLink`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ detachInnerNavigate( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartLink$InnerNavigateEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:navigationTargetsObtained navigationTargetsObtained } * event of this `sap.ui.comp.navpopover.SmartLink`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.28.0 * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. * * @returns Reference to `this` in order to allow method chaining */ detachNavigationTargetsObtained( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartLink$NavigationTargetsObtainedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:beforePopoverOpens beforePopoverOpens} to attached listeners. * * @since 1.28.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireBeforePopoverOpens( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.navpopover.SmartLink$BeforePopoverOpensEventParameters ): this; /** * Fires event {@link #event:innerNavigate innerNavigate} to attached listeners. * * @since 1.28.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireInnerNavigate( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.navpopover.SmartLink$InnerNavigateEventParameters ): this; /** * Fires event {@link #event:navigationTargetsObtained navigationTargetsObtained} to attached listeners. * * @since 1.28.0 * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireNavigationTargetsObtained( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.navpopover.SmartLink$NavigationTargetsObtainedEventParameters ): this; /** * Gets current value of property {@link #getAdditionalSemanticObjects additionalSemanticObjects}. * * Semantic object names which can be used additional to the default `semanticObject` property in order * to get navigation targets links. * * Default value is `[]`. * * @since 1.42.0 * * @returns Value of property `additionalSemanticObjects` */ getAdditionalSemanticObjects(): string[]; /** * Gets current value of property {@link #getBeforeNavigationCallback beforeNavigationCallback}. * * Function that is called before the actual navigation happens. This function has to return a promise resolving * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data: * * - {String} text: Text of the navigation intent * - {String} href: HREF of the navigation intent * - {String} originalId: ID of the control that fires the navigation intent * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent * * * @since 1.75.0 * * @returns Value of property `beforeNavigationCallback` */ getBeforeNavigationCallback(): Function; /** * Gets current value of property {@link #getContactAnnotationPath contactAnnotationPath}. * * Navigation property that points from the current to the related entity type where the com.sap.vocabularies.Communication.v1.Contact * annotation is defined, for example, `'to_Supplier'`. An empty string means that the related entity type * is the current one. * * Default value is `undefined`. * * @since 1.40.0 * * @returns Value of property `contactAnnotationPath` */ getContactAnnotationPath(): string; /** * Gets current value of property {@link #getCreateControlCallback createControlCallback}. * * Function that enables the SmartLink control to create an alternative control, which is displayed if `ignoreLinkRendering` * is enabled. The function has no parameters and has to return an instance of sap.ui.core.Control. * * @since 1.28.0 * * @returns Value of property `createControlCallback` */ getCreateControlCallback(): Function; /** * Gets current value of property {@link #getEnableAvailableActionsPersonalization enableAvailableActionsPersonalization}. * * Determines whether the personalization link is shown inside the NavigationPopover control. * * Default value is `true`. * * @since 1.44.0 * * @returns Value of property `enableAvailableActionsPersonalization` */ getEnableAvailableActionsPersonalization(): boolean; /** * Gets current value of property {@link #getEnabled enabled}. * * Determines whether the link can be triggered by the user. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getFieldName fieldName}. * * The metadata field name for this SmartLink control. * * @since 1.28.0 * * @returns Value of property `fieldName` */ getFieldName(): string; /** * Gets current value of property {@link #getForceLinkRendering forceLinkRendering}. * * If set to true, the `SmartLink` control is rendered as a link even if `contactAnnotationPath` is not * set and navigation targets do not exist. Setting this property to `true` allows the application, for * example, to modify the `SmartLink` control in the event handler, after the user has clicked on a link * and the registered event handler has been called. * * **Note:** The `ignoreLinkRendering` property and the `ignoredFields` property of the associated `SemanticObjectController` * take precedence over `forceLinkRendering`. * * Default value is `false`. * * @since 1.58.0 * * @returns Value of property `forceLinkRendering` */ getForceLinkRendering(): boolean; /** * Gets current value of property {@link #getIgnoreLinkRendering ignoreLinkRendering}. * * If set to `true`, the SmartLink control will render the `innerControl` or the control provided by `createControlCallback` * instead of the actual link. This is used for example by the SemanticObjectController if this SmartLink * is listed in its `ignoredFields` or no navigation targets were found during prefetch. * * Default value is `false`. * * @since 1.28.0 * * @returns Value of property `ignoreLinkRendering` */ getIgnoreLinkRendering(): boolean; /** * Gets content of aggregation {@link #getInnerControl innerControl}. * * Control that is displayed instead of SmartLink control, if the SmartLink is disabled (for example, if * no navigation targets are available). If `innerControl` is not provided, the SmartLink control tries * to create one with property `createControlCallback`. * * @since 1.28.0 */ getInnerControl(): sap.ui.core.Control; /** * Gets the value of the `innerControl` aggregate if available, otherwise the text of SmartLink control * will be returned. * * * @returns The value of `innerControl` aggregate or the text of the SmartLink */ getInnerControlValue(): object; /** * Gets current value of property {@link #getMapFieldToSemanticObject mapFieldToSemanticObject}. * * If set to `false`, the SmartLink control will not replace its field name with the according `semanticObject` * property during the calculation of the semantic attributes. This enables the usage of several SmartLink * controls on the same semantic object. * * Default value is `true`. * * * @returns Value of property `mapFieldToSemanticObject` */ getMapFieldToSemanticObject(): boolean; /** * Gets current value of property {@link #getNavigationTargetsObtainedCallback navigationTargetsObtainedCallback}. * * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained. * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}. * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}. * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `NavigationPopoverHandler`. * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained` * event. The event handling is ignored if this callback is set. * * @since 1.126 * * @returns Value of property `navigationTargetsObtainedCallback` */ getNavigationTargetsObtainedCallback(): Function; /** * Gets current value of property {@link #getSemanticObject semanticObject}. * * Name of semantic object which is used to fill the navigation popover. **Note**: Setting a value triggers * an asynchronous determination, so the effect can be delayed. * * @since 1.28.0 * * @returns Value of property `semanticObject` */ getSemanticObject(): string; /** * Gets current value of property {@link #getSemanticObjectController semanticObjectController}. * * The semantic object controller controls events for several SmartLink controls. If the controller is not * set manually, it tries to find a SemanticObjectController in its parent hierarchy. * * @since 1.28.0 * * @returns Value of property `semanticObjectController` */ getSemanticObjectController(): any; /** * Gets current value of property {@link #getSemanticObjectLabel semanticObjectLabel}. * * Shown label of semantic object. * * @since 1.28.0 * @deprecated As of version 1.40.0. Title section with `semanticObjectLabel` has been removed due to new * UI design * * @returns Value of property `semanticObjectLabel` */ getSemanticObjectLabel(): string; /** * Gets current value of property {@link #getUom uom}. * * Additionally to the `text` property the Unit of Measure can be displayed. * * Default value is `undefined`. * * @since 1.48.0 * * @returns Value of property `uom` */ getUom(): string; /** * Gets current value of property {@link #getWrapping wrapping}. * * Determines whether the link text is allowed to wrap when there is no sufficient space. * * Default value is `false`. * * * @returns Value of property `wrapping` */ getWrapping(): boolean; /** * Sets a new value for property {@link #getAdditionalSemanticObjects additionalSemanticObjects}. * * Semantic object names which can be used additional to the default `semanticObject` property in order * to get navigation targets links. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `[]`. * * @since 1.42.0 * * @returns Reference to `this` in order to allow method chaining */ setAdditionalSemanticObjects( /** * New value for property `additionalSemanticObjects` */ sAdditionalSemanticObjects?: string[] ): this; /** * Sets a new value for property {@link #getBeforeNavigationCallback beforeNavigationCallback}. * * Function that is called before the actual navigation happens. This function has to return a promise resolving * into a Boolean value for which the navigation will wait. If the Boolean value is `true`, the navigation * will be processed. The `beforeNavigationCallback(oNavigationInfo)` parameter contains the following data: * * - {String} text: Text of the navigation intent * - {String} href: HREF of the navigation intent * - {String} originalId: ID of the control that fires the navigation intent * - {String} semanticObject: Name of the `SemanticObject` of the navigation intent * - {Object} semanticAttributes: Object containing the `SemanticAttributes` of the navigation intent * * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.75.0 * * @returns Reference to `this` in order to allow method chaining */ setBeforeNavigationCallback( /** * New value for property `beforeNavigationCallback` */ fnBeforeNavigationCallback: Function ): this; /** * Sets a new value for property {@link #getContactAnnotationPath contactAnnotationPath}. * * Navigation property that points from the current to the related entity type where the com.sap.vocabularies.Communication.v1.Contact * annotation is defined, for example, `'to_Supplier'`. An empty string means that the related entity type * is the current one. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `undefined`. * * @since 1.40.0 * * @returns Reference to `this` in order to allow method chaining */ setContactAnnotationPath( /** * New value for property `contactAnnotationPath` */ sContactAnnotationPath?: string ): this; /** * Sets a new value for property {@link #getCreateControlCallback createControlCallback}. * * Function that enables the SmartLink control to create an alternative control, which is displayed if `ignoreLinkRendering` * is enabled. The function has no parameters and has to return an instance of sap.ui.core.Control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setCreateControlCallback( /** * New value for property `createControlCallback` */ fnCreateControlCallback?: Function ): this; /** * Sets a new value for property {@link #getEnableAvailableActionsPersonalization enableAvailableActionsPersonalization}. * * Determines whether the personalization link is shown inside the NavigationPopover control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.44.0 * * @returns Reference to `this` in order to allow method chaining */ setEnableAvailableActionsPersonalization( /** * New value for property `enableAvailableActionsPersonalization` */ bEnableAvailableActionsPersonalization?: boolean ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * Determines whether the link can be triggered by the user. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getFieldName fieldName}. * * The metadata field name for this SmartLink control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setFieldName( /** * New value for property `fieldName` */ sFieldName?: string ): this; /** * Sets a new value for property {@link #getForceLinkRendering forceLinkRendering}. * * If set to true, the `SmartLink` control is rendered as a link even if `contactAnnotationPath` is not * set and navigation targets do not exist. Setting this property to `true` allows the application, for * example, to modify the `SmartLink` control in the event handler, after the user has clicked on a link * and the registered event handler has been called. * * **Note:** The `ignoreLinkRendering` property and the `ignoredFields` property of the associated `SemanticObjectController` * take precedence over `forceLinkRendering`. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.58.0 * * @returns Reference to `this` in order to allow method chaining */ setForceLinkRendering( /** * New value for property `forceLinkRendering` */ bForceLinkRendering?: boolean ): this; /** * Sets a new value for property {@link #getIgnoreLinkRendering ignoreLinkRendering}. * * If set to `true`, the SmartLink control will render the `innerControl` or the control provided by `createControlCallback` * instead of the actual link. This is used for example by the SemanticObjectController if this SmartLink * is listed in its `ignoredFields` or no navigation targets were found during prefetch. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setIgnoreLinkRendering( /** * New value for property `ignoreLinkRendering` */ bIgnoreLinkRendering?: boolean ): this; /** * Sets the aggregated {@link #getInnerControl innerControl}. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setInnerControl( /** * The innerControl to set */ oInnerControl: sap.ui.core.Control ): this; /** * Sets a new value for property {@link #getMapFieldToSemanticObject mapFieldToSemanticObject}. * * If set to `false`, the SmartLink control will not replace its field name with the according `semanticObject` * property during the calculation of the semantic attributes. This enables the usage of several SmartLink * controls on the same semantic object. * * 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 */ setMapFieldToSemanticObject( /** * New value for property `mapFieldToSemanticObject` */ bMapFieldToSemanticObject?: boolean ): this; /** * Sets a new value for property {@link #getNavigationTargetsObtainedCallback navigationTargetsObtainedCallback}. * * Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained. * The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}. * This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}. * The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `NavigationPopoverHandler`. * The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained` * event. The event handling is ignored if this callback is set. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.126 * * @returns Reference to `this` in order to allow method chaining */ setNavigationTargetsObtainedCallback( /** * New value for property `navigationTargetsObtainedCallback` */ fnNavigationTargetsObtainedCallback: Function ): this; /** * Sets a new value for property {@link #getSemanticObject semanticObject}. * * Name of semantic object which is used to fill the navigation popover. **Note**: Setting a value triggers * an asynchronous determination, so the effect can be delayed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setSemanticObject( /** * New value for property `semanticObject` */ sSemanticObject?: string ): this; /** * Sets a new value for property {@link #getSemanticObjectController semanticObjectController}. * * The semantic object controller controls events for several SmartLink controls. If the controller is not * set manually, it tries to find a SemanticObjectController in its parent hierarchy. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setSemanticObjectController( /** * New value for property `semanticObjectController` */ oSemanticObjectController?: any ): this; /** * Sets a new value for property {@link #getSemanticObjectLabel semanticObjectLabel}. * * Shown label of semantic object. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.28.0 * @deprecated As of version 1.40.0. Title section with `semanticObjectLabel` has been removed due to new * UI design * * @returns Reference to `this` in order to allow method chaining */ setSemanticObjectLabel( /** * New value for property `semanticObjectLabel` */ sSemanticObjectLabel?: string ): this; /** * Sets a new value for property {@link #getUom uom}. * * Additionally to the `text` property the Unit of Measure can be displayed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `undefined`. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ setUom( /** * New value for property `uom` */ sUom?: string ): this; /** * Sets a new value for property {@link #getWrapping wrapping}. * * Determines whether the link text is allowed to wrap when there is no sufficient space. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setWrapping( /** * New value for property `wrapping` */ bWrapping?: boolean ): this; } /** * Type of change handler type for link personalization. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'navpopover.ChangeHandlerType'. */ enum ChangeHandlerType { /** * Change handler creating a change for an added link. */ addLink = "addLink", /** * Change handler creating a change for a moved link. */ moveLink = "moveLink", /** * Change handler creating a change for a removed link. */ removeLink = "removeLink", } /** * Object holding the information regarding the obtained navigation targets and extra content. This is used * as parameter and return value of the `Promise` in the `navigationTargetsObtainedCallback`. */ type NavigationTargets = { /** * The text of the main link / text that is displayed in the header of the popover. */ mainNavigationId: string; /** * The main navigation object */ mainNavigation: sap.ui.comp.navpopover.LinkData; /** * Array of available navigation target objects */ actions: sap.ui.comp.navpopover.LinkData[]; /** * The navigation object for the own application. This navigation option is not visible on the popover by * default. */ ownNavigation: sap.ui.comp.navpopover.LinkData; /** * Array containing contact data. Manipulating this property won't have an effect, it's only relevant to * be streamlined with the old API. The `extraContent` property is used to return the intended content. */ popoverForms: sap.ui.layout.form.SimpleForm[]; /** * The semantic object for which the navigation targets have been retrieved */ semanticObject: String; /** * Map containing the semantic attributes */ semanticAttributes: object; /** * The ID of the `SmartLink` or other parent control */ originalId: String; /** * The control that is displayed in the extra content section on the popover. If set to `null`, the extra * content is removed. If set to `undefined`, a {@link sap.m.VBox} containing the `popoverForms` as items * is used as extra content. The `popoverForms` can be empty. */ extraContent: sap.ui.core.Control | null | undefined; }; /** * Event object of the NavigationPopover#availableActionsPersonalizationPress event. */ type NavigationPopover$AvailableActionsPersonalizationPressEvent = sap.ui.base.Event< NavigationPopover$AvailableActionsPersonalizationPressEventParameters, NavigationPopover >; /** * Event object of the NavigationPopover#navigate event. */ type NavigationPopover$NavigateEvent = sap.ui.base.Event< NavigationPopover$NavigateEventParameters, NavigationPopover >; /** * Event object of the NavigationPopover#targetsObtained event. * * @deprecated As of version 1.40.0. The event `navigationTargetsObtained` is obsolete as target determination * is no longer done by NavigationPopover. Instead the NavigationPopoverHandler is responsible for target * determination. The event `navigationTargetsObtained` is fired from NavigationPopoverHandler after navigation * targets are determined. */ type NavigationPopover$TargetsObtainedEvent = sap.ui.base.Event< NavigationPopover$TargetsObtainedEventParameters, NavigationPopover >; /** * Event object of the NavigationPopoverHandler#beforePopoverOpens event. */ type NavigationPopoverHandler$BeforePopoverOpensEvent = sap.ui.base.Event< NavigationPopoverHandler$BeforePopoverOpensEventParameters, NavigationPopoverHandler >; /** * Event object of the NavigationPopoverHandler#innerNavigate event. */ type NavigationPopoverHandler$InnerNavigateEvent = sap.ui.base.Event< NavigationPopoverHandler$InnerNavigateEventParameters, NavigationPopoverHandler >; /** * Event object of the NavigationPopoverHandler#navigationTargetsObtained event. * * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. */ type NavigationPopoverHandler$NavigationTargetsObtainedEvent = sap.ui.base.Event< NavigationPopoverHandler$NavigationTargetsObtainedEventParameters, NavigationPopoverHandler >; /** * Event object of the SemanticObjectController#beforePopoverOpens event. */ type SemanticObjectController$BeforePopoverOpensEvent = sap.ui.base.Event< SemanticObjectController$BeforePopoverOpensEventParameters, SemanticObjectController >; /** * Event object of the SemanticObjectController#navigate event. */ type SemanticObjectController$NavigateEvent = sap.ui.base.Event< SemanticObjectController$NavigateEventParameters, SemanticObjectController >; /** * Event object of the SemanticObjectController#navigationTargetsObtained event. * * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. */ type SemanticObjectController$NavigationTargetsObtainedEvent = sap.ui.base.Event< SemanticObjectController$NavigationTargetsObtainedEventParameters, SemanticObjectController >; /** * Event object of the SemanticObjectController#prefetchDone event. * * @deprecated As of version 1.42.0. The event `prefetchDone` is obsolete because it depends on the property * `prefetchNavigationTargets` which has been deprecated. */ type SemanticObjectController$PrefetchDoneEvent = sap.ui.base.Event< SemanticObjectController$PrefetchDoneEventParameters, SemanticObjectController >; /** * Event object of the SmartLink#beforePopoverOpens event. */ type SmartLink$BeforePopoverOpensEvent = sap.ui.base.Event< SmartLink$BeforePopoverOpensEventParameters, SmartLink >; /** * Event object of the SmartLink#innerNavigate event. */ type SmartLink$InnerNavigateEvent = sap.ui.base.Event< SmartLink$InnerNavigateEventParameters, SmartLink >; /** * Event object of the SmartLink#navigationTargetsObtained event. * * @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property. */ type SmartLink$NavigationTargetsObtainedEvent = sap.ui.base.Event< SmartLink$NavigationTargetsObtainedEventParameters, SmartLink >; } namespace odata { /** * Describes the settings that can be provided to the ComboBox constructor. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ interface $ComboBoxSettings extends sap.m.$ComboBoxSettings { /** * Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType` * from the ValueList property. */ textArrangement?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * This event is fired when the selected key has changed only when: The key is valid. The control is visible * There is a change when the control gets visible. */ selectedKeyChange?: (oEvent: ComboBox$SelectedKeyChangeEvent) => void; } /** * Parameters of the ComboBox#selectedKeyChange event. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ interface ComboBox$SelectedKeyChangeEventParameters { /** * The selected key. */ selectedKey?: string; } /** * Extends the functionalities in sap.m.ComboBox * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ class ComboBox extends sap.m.ComboBox implements /* was: sap.ui.comp.IDropDownTextArrangement */ Object { __implements__sap_ui_comp_IDropDownTextArrangement: boolean; /** * Constructor for a new `odata/ComboBox`. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ protected constructor( /** * Initial settings for the new control */ mSettings?: sap.ui.comp.odata.$ComboBoxSettings ); /** * Constructor for a new `odata/ComboBox`. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ protected constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string, /** * Initial settings for the new control */ mSettings?: sap.ui.comp.odata.$ComboBoxSettings ); /** * Creates a new subclass of class sap.ui.comp.odata.ComboBox with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.m.ComboBox.extend}. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.odata.ComboBox. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:selectedKeyChange selectedKeyChange} event of * this `sap.ui.comp.odata.ComboBox`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.odata.ComboBox` itself. * * This event is fired when the selected key has changed only when: The key is valid. The control is visible * There is a change when the control gets visible. * * * @returns Reference to `this` in order to allow method chaining */ attachSelectedKeyChange( /** * 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: ComboBox$SelectedKeyChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.odata.ComboBox` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectedKeyChange selectedKeyChange} event of * this `sap.ui.comp.odata.ComboBox`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.odata.ComboBox` itself. * * This event is fired when the selected key has changed only when: The key is valid. The control is visible * There is a change when the control gets visible. * * * @returns Reference to `this` in order to allow method chaining */ attachSelectedKeyChange( /** * The function to be called when the event occurs */ fnFunction: (p1: ComboBox$SelectedKeyChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.odata.ComboBox` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:selectedKeyChange selectedKeyChange} event * of this `sap.ui.comp.odata.ComboBox`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSelectedKeyChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: ComboBox$SelectedKeyChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:selectedKeyChange selectedKeyChange} 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 */ fireSelectedKeyChange( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.odata.ComboBox$SelectedKeyChangeEventParameters ): this; /** * Gets current value of property {@link #getTextArrangement textArrangement}. * * Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType` * from the ValueList property. * * Default value is `empty string`. * * * @returns Value of property `textArrangement` */ getTextArrangement(): string; /** * Sets a new value for property {@link #getTextArrangement textArrangement}. * * Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType` * from the ValueList property. * * 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 */ setTextArrangement( /** * New value for property `textArrangement` */ sTextArrangement?: string ): this; } /** * Event object of the ComboBox#selectedKeyChange event. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ type ComboBox$SelectedKeyChangeEvent = sap.ui.base.Event< ComboBox$SelectedKeyChangeEventParameters, ComboBox >; } namespace p13n { /** * Describes the settings that can be provided to the P13nItem constructor. */ interface $P13nItemSettings extends sap.ui.core.$ElementSettings { /** * Can be used as input for subsequent actions. */ columnKey?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The text to be displayed for the item. */ text?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines visibility of column */ visible?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * data type of the column (text, numeric or date is supported) */ type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * data type instance of the column. Can be used instead of the type, precision, scale and formatSettings * properties * * @since 1.56 */ typeInstance?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * if type==numeric the precision will be used to format the entered value (maxIntegerDigits of the used * Formatter) */ precision?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * A JSON object containing the formatSettings which will be used to pass additional type/format settings * for the entered value. if type==time or date or datetime the object will be used for the DateFormatter, * TimeFormatter or DateTimeFormatter * * Below you can find a brief example * * * ```javascript * * { * UTC: false, * style: "medium" //"short" or "long" * } * ``` * * * @since 1.52 */ formatSettings?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * if type==numeric the scale will be used to format the entered value (maxFractionDigits of the used Formatter) */ scale?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * specifies the number of characters which can be entered in the value fields of the condition panel */ maxLength?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines column width */ width?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * the column with isDefault==true will be used as the selected column item on the conditionPanel */ isDefault?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * the array of values for type bool. e.g. ["", "Off", "On"]. The first entry can be empty (used to blank * the value field). Next value represent the false value, last entry the true value. * * @since 1.34.0 */ values?: | string[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines role. The role is reflected in the manner how the dimension will influence the chart layout. * * @since 1.34.0 */ role?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines aggregation role * * @since 1.34.0 */ aggregationRole?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines href of a link. * * @since 1.46.0 */ href?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines target of a link. */ target?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines press handler of a link. * * @since 1.46.0 */ press?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines additional information of the link. * * @since 1.56.0 */ description?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines if the item is nullable */ nullable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Base type for `items` aggregation in `P13nPanel` control. * * @since 1.136 */ class P13nItem extends sap.ui.core.Element { /** * Constructor for a new P13nItem. * * 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.ui.comp.p13n.$P13nItemSettings ); /** * Constructor for a new P13nItem. * * 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.ui.comp.p13n.$P13nItemSettings ); /** * Creates a new subclass of class sap.ui.comp.p13n.P13nItem with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.p13n.P13nItem. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getAggregationRole aggregationRole}. * * Defines aggregation role * * @since 1.34.0 * * @returns Value of property `aggregationRole` */ getAggregationRole(): string; /** * Gets current value of property {@link #getColumnKey columnKey}. * * Can be used as input for subsequent actions. * * * @returns Value of property `columnKey` */ getColumnKey(): string; /** * Gets current value of property {@link #getDescription description}. * * Defines additional information of the link. * * @since 1.56.0 * * @returns Value of property `description` */ getDescription(): string; /** * Gets current value of property {@link #getFormatSettings formatSettings}. * * A JSON object containing the formatSettings which will be used to pass additional type/format settings * for the entered value. if type==time or date or datetime the object will be used for the DateFormatter, * TimeFormatter or DateTimeFormatter * * Below you can find a brief example * * * ```javascript * * { * UTC: false, * style: "medium" //"short" or "long" * } * ``` * * * @since 1.52 * * @returns Value of property `formatSettings` */ getFormatSettings(): object; /** * Gets current value of property {@link #getHref href}. * * Defines href of a link. * * @since 1.46.0 * * @returns Value of property `href` */ getHref(): string; /** * Gets current value of property {@link #getIsDefault isDefault}. * * the column with isDefault==true will be used as the selected column item on the conditionPanel * * Default value is `false`. * * * @returns Value of property `isDefault` */ getIsDefault(): boolean; /** * Gets current value of property {@link #getMaxLength maxLength}. * * specifies the number of characters which can be entered in the value fields of the condition panel * * * @returns Value of property `maxLength` */ getMaxLength(): string; /** * Gets current value of property {@link #getNullable nullable}. * * Defines if the item is nullable * * Default value is `false`. * * * @returns Value of property `nullable` */ getNullable(): boolean; /** * Gets current value of property {@link #getPrecision precision}. * * if type==numeric the precision will be used to format the entered value (maxIntegerDigits of the used * Formatter) * * * @returns Value of property `precision` */ getPrecision(): string; /** * Gets current value of property {@link #getPress press}. * * Defines press handler of a link. * * @since 1.46.0 * * @returns Value of property `press` */ getPress(): object; /** * Gets current value of property {@link #getRole role}. * * Defines role. The role is reflected in the manner how the dimension will influence the chart layout. * * @since 1.34.0 * * @returns Value of property `role` */ getRole(): string; /** * Gets current value of property {@link #getScale scale}. * * if type==numeric the scale will be used to format the entered value (maxFractionDigits of the used Formatter) * * * @returns Value of property `scale` */ getScale(): string; /** * Gets current value of property {@link #getTarget target}. * * Defines target of a link. * * * @returns Value of property `target` */ getTarget(): string; /** * Gets current value of property {@link #getText text}. * * The text to be displayed for the item. * * Default value is `empty string`. * * * @returns Value of property `text` */ getText(): string; /** * Gets current value of property {@link #getType type}. * * data type of the column (text, numeric or date is supported) * * Default value is `"text"`. * * * @returns Value of property `type` */ getType(): string; /** * Gets current value of property {@link #getTypeInstance typeInstance}. * * data type instance of the column. Can be used instead of the type, precision, scale and formatSettings * properties * * @since 1.56 * * @returns Value of property `typeInstance` */ getTypeInstance(): object; /** * Gets current value of property {@link #getValues values}. * * the array of values for type bool. e.g. ["", "Off", "On"]. The first entry can be empty (used to blank * the value field). Next value represent the false value, last entry the true value. * * @since 1.34.0 * * @returns Value of property `values` */ getValues(): string[]; /** * Gets current value of property {@link #getVisible visible}. * * Defines visibility of column * * * @returns Value of property `visible` */ getVisible(): boolean; /** * Gets current value of property {@link #getWidth width}. * * Defines column width * * * @returns Value of property `width` */ getWidth(): string; /** * Sets a new value for property {@link #getAggregationRole aggregationRole}. * * Defines aggregation role * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.34.0 * * @returns Reference to `this` in order to allow method chaining */ setAggregationRole( /** * New value for property `aggregationRole` */ sAggregationRole?: string ): this; /** * Sets a new value for property {@link #getColumnKey columnKey}. * * Can be used as input for subsequent actions. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setColumnKey( /** * New value for property `columnKey` */ sColumnKey?: string ): this; /** * Sets a new value for property {@link #getDescription description}. * * Defines additional information of the link. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.56.0 * * @returns Reference to `this` in order to allow method chaining */ setDescription( /** * New value for property `description` */ sDescription?: string ): this; /** * Sets a new value for property {@link #getFormatSettings formatSettings}. * * A JSON object containing the formatSettings which will be used to pass additional type/format settings * for the entered value. if type==time or date or datetime the object will be used for the DateFormatter, * TimeFormatter or DateTimeFormatter * * Below you can find a brief example * * * ```javascript * * { * UTC: false, * style: "medium" //"short" or "long" * } * ``` * * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.52 * * @returns Reference to `this` in order to allow method chaining */ setFormatSettings( /** * New value for property `formatSettings` */ oFormatSettings?: object ): this; /** * Sets a new value for property {@link #getHref href}. * * Defines href of a link. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.46.0 * * @returns Reference to `this` in order to allow method chaining */ setHref( /** * New value for property `href` */ sHref?: string ): this; /** * Sets a new value for property {@link #getIsDefault isDefault}. * * the column with isDefault==true will be used as the selected column item on the conditionPanel * * 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 */ setIsDefault( /** * New value for property `isDefault` */ bIsDefault?: boolean ): this; /** * Sets a new value for property {@link #getMaxLength maxLength}. * * specifies the number of characters which can be entered in the value fields of the condition panel * * 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 */ setMaxLength( /** * New value for property `maxLength` */ sMaxLength?: string ): this; /** * Sets a new value for property {@link #getNullable nullable}. * * Defines if the item is nullable * * 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 */ setNullable( /** * New value for property `nullable` */ bNullable?: boolean ): this; /** * Sets a new value for property {@link #getPrecision precision}. * * if type==numeric the precision will be used to format the entered value (maxIntegerDigits of the used * Formatter) * * 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 */ setPrecision( /** * New value for property `precision` */ sPrecision?: string ): this; /** * Sets a new value for property {@link #getPress press}. * * Defines press handler of a link. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.46.0 * * @returns Reference to `this` in order to allow method chaining */ setPress( /** * New value for property `press` */ oPress?: object ): this; /** * Sets a new value for property {@link #getRole role}. * * Defines role. The role is reflected in the manner how the dimension will influence the chart layout. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.34.0 * * @returns Reference to `this` in order to allow method chaining */ setRole( /** * New value for property `role` */ sRole?: string ): this; /** * Sets a new value for property {@link #getScale scale}. * * if type==numeric the scale will be used to format the entered value (maxFractionDigits of the used Formatter) * * 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 */ setScale( /** * New value for property `scale` */ sScale?: string ): this; /** * Sets a new value for property {@link #getTarget target}. * * Defines target of a link. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setTarget( /** * New value for property `target` */ sTarget?: string ): this; /** * Sets a new value for property {@link #getText text}. * * The text to be displayed for the item. * * 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 #getType type}. * * data type of the column (text, numeric or date is supported) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"text"`. * * * @returns Reference to `this` in order to allow method chaining */ setType( /** * New value for property `type` */ sType?: string ): this; /** * Sets a new value for property {@link #getTypeInstance typeInstance}. * * data type instance of the column. Can be used instead of the type, precision, scale and formatSettings * properties * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.56 * * @returns Reference to `this` in order to allow method chaining */ setTypeInstance( /** * New value for property `typeInstance` */ oTypeInstance?: object ): this; /** * Sets a new value for property {@link #getValues values}. * * the array of values for type bool. e.g. ["", "Off", "On"]. The first entry can be empty (used to blank * the value field). Next value represent the false value, last entry the true value. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.34.0 * * @returns Reference to `this` in order to allow method chaining */ setValues( /** * New value for property `values` */ sValues?: string[] ): this; /** * Sets a new value for property {@link #getVisible visible}. * * Defines visibility of column * * 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 */ setVisible( /** * New value for property `visible` */ bVisible?: boolean ): this; /** * Sets a new value for property {@link #getWidth width}. * * Defines column width * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: string ): this; } } namespace personalization { /** * Provides enumeration sap.ui.comp.personalization.AggregationRole. A subset of aggregation roles used * in table personalization. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'personalization.AggregationRole'. */ enum AggregationRole { /** * Dimension role. */ Dimension = "Dimension", /** * Measure role. */ Measure = "Measure", /** * Role which is neither dimension nor measure. */ NotDimeasure = "NotDimeasure", } /** * Provides enumeration sap.ui.comp.personalization.ChangeType. A subset of changes done during table personalization. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'personalization.ChangeType'. */ enum ChangeType { /** * Change is applied to model but not applied to table */ ModelChanged = "ModelChanged", /** * Change is applied to model and to table */ TableChanged = "TableChanged", /** * Not changed */ Unchanged = "Unchanged", } /** * Provides enumeration sap.ui.comp.personalization.ColumnType. A subset of column types that fit for table * personalization. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'personalization.ColumnType'. */ enum ColumnType { /** * Represents `sap.ui.comp.personalization.ColumnWrapper`. */ ColumnWrapper = "ColumnWrapper", /** * Represents `sap.m.Column`. */ ResponsiveColumn = "ResponsiveColumn", /** * Represents `sap.ui.table.Column`. */ TableColumn = "TableColumn", } /** * Provides enumeration sap.ui.comp.personalization.ResetType. A subset of reset types used in table personalization. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'personalization.ResetType'. */ enum ResetType { /** * Reset back to Restore (i.e. the version of the table with which the controller was instantiated or via * setter updated) was triggered (either via API or via reset button) */ ResetFull = "ResetFull", /** * Reset back to the CurrentVariant was triggered */ ResetPartial = "ResetPartial", } /** * Provides enumeration sap.ui.comp.personalization.TableType. A subset of table types that fit for table * personalization. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'personalization.TableType'. */ enum TableType { /** * Represents `sap.ui.table.AnalyticalTable`. */ AnalyticalTable = "AnalyticalTable", /** * Represents `sap.ui.comp.personalization.ChartWrapper`. */ ChartWrapper = "ChartWrapper", /** * Represents `sap.m.Table`. */ ResponsiveTable = "ResponsiveTable", /** * Represents `sap.ui.comp.personalization.SelectionWrapper`. */ SelectionWrapper = "SelectionWrapper", /** * Represents `sap.ui.table.Table`. */ Table = "Table", /** * Represents `sap.ui.table.TreeTable`. */ TreeTable = "TreeTable", } } namespace smartchart { /** * Describes the settings that can be provided to the SmartChart constructor. */ interface $SmartChartSettings extends sap.m.$VBoxSettings { /** * The entity set name from which to fetch data and generate the columns. * **Note** This is not a dynamic property. */ entitySet?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * ID of the corresponding SmartFilter control. If specified, the SmartChart control searches for the SmartFilter * control (also in the closest parent view) and attaches to the relevant events of the SmartFilter control * to fetch data, show overlay etc. */ smartFilterId?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * CSV of fields that must be ignored in the OData metadata by the SmartChart control. * **Note:** No validation is done. Please ensure that you do not add spaces or special characters. */ ignoredFields?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * CSV of fields that must be always requested by the backend system. * This property is mainly meant to be used if there is no PresentationVariant annotation. * If both this property and the PresentationVariant annotation exist, the select request sent to the backend * would be a combination of both. * **Note:** No validation is done. Please ensure that you do not add spaces or special characters. Also, * setting this property during runtime, will delete the current drill-stack and lead to a loss of the drill * history. */ requestAtLeastFields?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * CSV of fields that is not shown in the personalization dialog. * **Note:** No validation is done. Please ensure that you do not add spaces or special characters. */ ignoreFromPersonalisation?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Specifies the type of chart to be created by the SmartChart control. */ chartType?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * CSV of fields that is not shown in the list of available chart types. * **Note:** No validation is done. Please ensure that you do not add spaces or special characters. */ ignoredChartTypes?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * If set to `true`, variants are used. As a prerequisite, you need to specify the persistencyKey property. */ useVariantManagement?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `true`, personalized chart settings are defined. If you want to persist the chart personalization, * you need to specify the persistencyKey property. */ useChartPersonalisation?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies header text that is shown in the chart. */ header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Semantic level of the header. * For more information, see {@link sap.m.Title#setLevel}. * * @since 1.118 */ headerLevel?: | sap.ui.core.TitleLevel | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines style of the header. * For more information, see {@link sap.m.Title#setTitle}. * * @since 1.119 */ headerStyle?: | sap.ui.core.TitleLevel | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Key used to access personalization data. */ persistencyKey?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Retrieves or applies the current variant. */ currentVariantId?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * If set to `true`, this enables automatic binding of the chart using the chartBindingPath (if it exists) * or entitySet property. This happens right after the `initialise` event has been fired. */ enableAutoBinding?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies the path that is used during the binding of the chart. If not specified, the entitySet property * is used instead. (used only if binding is established internally/automatically - See enableAutoBinding) */ chartBindingPath?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Controls the visibility of the Drill Up and Drill Down buttons. */ showDrillButtons?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the Zoom In and Zoom Out buttons. * * @since 1.36 */ showZoomButtons?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the Navigation button * * @since 1.36 */ showSemanticNavigationButton?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the Variant Management. * * @since 1.38 */ showVariantManagement?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the chart download button. * * @since 1.39 */ showDownloadButton?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the Details button. If set to `true`, the datapoint tooltip will be disabled * as the information of selected datapoints will be found in the details popover. This will also set the * drill-down button to invisible. * * @since 1.38 */ showDetailsButton?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the Breadcrumbs control for drilling up within the visible dimensions. If * set to `true`, the toolbar header will be replaced by the Breadcrumbs control. This will also set the * drill-up button to invisible. * * @since 1.38 */ showDrillBreadcrumbs?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the chart tooltip. If set to `true `, an instance of sap.viz.ui5.controls.VizTooltip * will be created and shown when hovering over a data point. * * @since 1.38 */ showChartTooltip?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the Navigation button * * @since 1.36 */ showLegendButton?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Set chart's legend properties. * * @since 1.36 */ legendVisible?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Chart selection mode. Supported values are {@link sap.ui.comp.smartchart.SelectionMode.Single} or {@link sap.ui.comp.smartchart.SelectionMode.Multi}, * case insensitive, always return in upper case. Unsupported values will be ignored. * * @since 1.36 */ selectionMode?: | sap.ui.comp.smartchart.SelectionMode | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the FullScreen button. * * @since 1.36 */ showFullScreenButton?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies weather an instance of {@link sap.viz.ui5.controls.VizTooltip} or {@link sap.viz.ui5.controls.Popover } * is used. If set to `true`, a tooltip will be displayed, a popover otherwise. * * @since 1.36 */ useTooltip?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visualization for chart type selection. If set to `true`, the list of available chart types * will be displayed. If set to `false` and there are three or fewer available chart types, the chart types * will be displayed as separate buttons in the toolbar. If there are more than three chart types, a list * will be shown. * * @since 1.38 * @deprecated As of version 1.48.0. Setting the property to `false` will have no effect on the visualization * of chart type selection. `SmartChart` will always show a list of chart types. */ useListForChartTypeSelection?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the chart type selection button. * * @since 1.48 */ showChartTypeSelectionButton?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the custom text that will be displayed in case no data is found for the current binding. * * @since 1.46 */ noData?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Controls the visibility of the toolbar. * * @since 1.54 */ showToolbar?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the visual style of the smart charts `Toolbar`. **Note:** The visual styles are theme-dependent. * * @since 1.54 */ toolbarStyle?: | sap.m.ToolbarStyle | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the title in the dimension area of the chart. * * @since 1.54 */ showDimensionsTitle?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the title in the measure area of the chart. * * @since 1.54 */ showMeasuresTitle?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enables the use of timeseries on the inner chart when corresponding annotation is given * * **Note:** This timeseries is only supported for the following {@link sap.chart.TimeUnitType TimeUnitTypes } * and the following chart types {@link sap.viz.ui5.controls.VizFrame#getVizType}. * * @since 1.84 */ activateTimeSeries?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Text that is shown for values of an empty string. **Note:** The property does not change the behavior * for charts of type `timeseries`. **Note:** Can only be changed in the XML/JS view. It cannot be changed * once the control has been initialized. * * @since 1.106 */ notAssignedText?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * A custom toolbar that can be specified by the user to define their own buttons, icons, etc. If this is * added, the SmartChart control does not create its own toolbar, but uses this one instead. However, if * default actions, such as showSemanticNavigation, showFullScreenButton etc. are set, these actions are * added at the left-hand side of the toolbar. */ toolbar?: sap.m.Toolbar; /** * The Semantic Object Controller allows the user to specify and overwrite functionality for semantic object * navigation. * * @since 1.36 */ semanticObjectController?: sap.ui.comp.navpopover.SemanticObjectController; /** * Actions on item level which can be specified for the selection details popover. * * @since 1.48 */ selectionDetailsItemActions?: | sap.ui.core.Item[] | sap.ui.core.Item | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Actions on footer level which can be specified for the selection details popover. * * @since 1.48 */ selectionDetailsActions?: | sap.ui.core.Item[] | sap.ui.core.Item | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Actions on group level which can be specified for the selection details popover. * * @since 1.48 */ selectionDetailsActionGroups?: | sap.ui.core.Item[] | sap.ui.core.Item | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * `IllustratedMessage` shown when no data is available. * * @since 1.142 */ noDataIllustratedMessage?: sap.m.IllustratedMessage; /** * Identifies the SmartVariant control which should be used for the personalization. Will be ignored if * the advanced mode is set. * * @since 1.38 */ smartVariant?: sap.ui.core.Control | string; /** * This event is fired once the control has been initialized. **Note:** For compatibility reasons the sap.chart * library is loaded synchroniously as soon as a event handler for the `initialise` event has been attached. * Since this event does not fulfill CSP requirements, please use event `initialized` instead. * * @deprecated As of version 1.65. replaced by {@link initialized}. */ initialise?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired once the control has been initialized, asynchronous successor of `initialise`. */ initialized?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired right before the `SmartChart` control triggers the binding / rebinding of the inner * chart. * **Note:** In certain cases the inner chart triggers a rebinding by itself. In these cases, the event * is not fired. */ beforeRebindChart?: ( oEvent: SmartChart$BeforeRebindChartEvent ) => void; /** * This event is fired when data is received after binding. This event is fired if the binding for the chart * is done by the SmartChart control itself. * * @deprecated As of version 1.56. Use `beforeRebindChart` event to attach/listen to the binding "events" * directly */ dataReceived?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired after the variant management in the SmartChart control has been initialized. */ afterVariantInitialise?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired after a variant has been saved. This event can be used to retrieve the ID of the * saved variant. */ afterVariantSave?: (oEvent: SmartChart$AfterVariantSaveEvent) => void; /** * This event is fired after a variant has been applied. */ afterVariantApply?: ( oEvent: SmartChart$AfterVariantApplyEvent ) => void; /** * This event is fired right before the overlay is shown. */ showOverlay?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired right after the full screen mode of the SmartChart control has been changed. * * @since 1.46 */ fullScreenToggled?: ( oEvent: SmartChart$FullScreenToggledEvent ) => void; /** * This event is fired when any action in the selection details popover is pressed. * * @since 1.48 */ selectionDetailsActionPress?: ( oEvent: SmartChart$SelectionDetailsActionPressEvent ) => void; /** * This event is fired when `SmartChart` control data changes, due to changes in the personalization dialog * or drill operations. * The data can be changed via sorters, filters or drill-ups/drill-downs. */ chartDataChanged?: (oEvent: SmartChart$ChartDataChangedEvent) => void; /** * This event is fired when the UI state changes either via the {@link sap.ui.comp.smartchart.SmartChart#setUiState } * method or the chart personalization. * * @since 1.96.15 */ uiStateChange?: (oEvent: sap.ui.base.Event) => void; } /** * Parameters of the SmartChart#afterVariantApply event. */ interface SmartChart$AfterVariantApplyEventParameters { /** * ID of the currently selected variant */ currentVariantId?: string; /** * Context in which the variant has been applied */ variantContext?: string; } /** * Parameters of the SmartChart#afterVariantInitialise event. */ interface SmartChart$AfterVariantInitialiseEventParameters {} /** * Parameters of the SmartChart#afterVariantSave event. */ interface SmartChart$AfterVariantSaveEventParameters { /** * ID of the currently selected variant */ currentVariantId?: string; } /** * Parameters of the SmartChart#beforeRebindChart event. */ interface SmartChart$BeforeRebindChartEventParameters { /** * The bindingParams object contains filters, sorters, and other binding-related information for the chart */ bindingParams?: object; } /** * Parameters of the SmartChart#chartDataChanged event. */ interface SmartChart$ChartDataChangedEventParameters { /** * Object which contains a boolean flag for dimeasure, filter, sort. If set to `true`, it has been changed. */ changeTypes?: object; } /** * Parameters of the SmartChart#dataReceived event. * * @deprecated As of version 1.56. Use `beforeRebindChart` event to attach/listen to the binding "events" * directly */ interface SmartChart$DataReceivedEventParameters {} /** * Parameters of the SmartChart#fullScreenToggled event. */ interface SmartChart$FullScreenToggledEventParameters { /** * If `true` the control is in full screen mode */ fullScreen?: boolean; } /** * Parameters of the SmartChart#initialise event. * * @deprecated As of version 1.65. replaced by {@link initialized}. */ interface SmartChart$InitialiseEventParameters {} /** * Parameters of the SmartChart#initialized event. */ interface SmartChart$InitializedEventParameters {} /** * Parameters of the SmartChart#selectionDetailsActionPress event. */ interface SmartChart$SelectionDetailsActionPressEventParameters { /** * The action that has to be processed once the action has been pressed */ action?: sap.ui.core.Item; /** * If the action is pressed on one of the {@link sap.m.SelectionDetailsItem items}, the parameter contains * the {@link sap.ui.model.Context context} of the pressed {@link sap.m.SelectionDetailsItem item}. If a * custom action or action group of the SelectionDetails popover is pressed, this parameter contains all * {@link sap.ui.model.Context contexts} of the {@link sap.m.SelectionDetailsItem items}. */ itemContexts?: sap.ui.model.Context; /** * The action level of action buttons. The available levels are Item, List and Group */ level?: sap.m.SelectionDetailsActionLevel; } /** * Parameters of the SmartChart#showOverlay event. */ interface SmartChart$ShowOverlayEventParameters {} /** * Parameters of the SmartChart#uiStateChange event. */ interface SmartChart$UiStateChangeEventParameters {} /** * The `SmartChart` control creates a chart based on the OData metadata and the provided configuration. * To use the control, the `entitySet` property must be specified. This property is used to fetch the metadata, * from which the chart UI will be generated. * Based on the `chartType` property, this control will render initially the corresponding chart. * **Note:** Most of the properties are not dynamic and cannot be changed once the control has been initialized. * * **Important:** Keep in mind that `SmartChart`, like all SAPUI5 smart controls, retrieves and analyzes * the metadata and annotations of OData services. **The OData metadata is its primary API. These OData * services are not part of the SAPUI5 framework and are usually maintained by the backend developers of * your application.** * * With time, `SmartChart` can evolve and acquire new features. This means that its behavior or functionalities * may change if the annotations that define this change are maintained in your backend metadata. To benefit * from the new functionalities, your application should be able to adapt the backend metadata. **Therefore, * we recommend using `SmartChart` only if you have control over the metadata of your application.** */ class SmartChart extends sap.m.VBox { /** * Constructor for a new SmartChart instance. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/7a32157697474864b041fa739fcc51ba Smart Chart} */ constructor( /** * Initial settings for the new control */ mSettings?: sap.ui.comp.smartchart.$SmartChartSettings ); /** * Constructor for a new SmartChart instance. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/7a32157697474864b041fa739fcc51ba Smart Chart} */ constructor( /** * ID for the new control that is generated automatically if no ID is given */ sId?: string, /** * Initial settings for the new control */ mSettings?: sap.ui.comp.smartchart.$SmartChartSettings ); /** * Creates a new subclass of class sap.ui.comp.smartchart.SmartChart 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.VBox.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartchart.SmartChart. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some selectionDetailsAction to the aggregation {@link #getSelectionDetailsActions selectionDetailsActions}. * * @since 1.48 * * @returns Reference to `this` in order to allow method chaining */ addSelectionDetailsAction( /** * The selectionDetailsAction to add; if empty, nothing is inserted */ oSelectionDetailsAction: sap.ui.core.Item ): this; /** * Adds some selectionDetailsActionGroup to the aggregation {@link #getSelectionDetailsActionGroups selectionDetailsActionGroups}. * * @since 1.48 * * @returns Reference to `this` in order to allow method chaining */ addSelectionDetailsActionGroup( /** * The selectionDetailsActionGroup to add; if empty, nothing is inserted */ oSelectionDetailsActionGroup: sap.ui.core.Item ): this; /** * Adds some selectionDetailsItemAction to the aggregation {@link #getSelectionDetailsItemActions selectionDetailsItemActions}. * * @since 1.48 * * @returns Reference to `this` in order to allow method chaining */ addSelectionDetailsItemAction( /** * The selectionDetailsItemAction to add; if empty, nothing is inserted */ oSelectionDetailsItemAction: sap.ui.core.Item ): this; /** * Interface function for SmartVariantManagement control that applies the current variant. */ applyVariant( /** * The variant JSON */ oVariantJSON: sap.ui.comp.SmartChart.Variant, /** * Describes the context in which the variant has been applied */ sContext: string ): void; /** * Attaches event handler `fnFunction` to the {@link #event:afterVariantApply afterVariantApply} event of * this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired after a variant has been applied. * * * @returns Reference to `this` in order to allow method chaining */ attachAfterVariantApply( /** * 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: SmartChart$AfterVariantApplyEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:afterVariantApply afterVariantApply} event of * this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired after a variant has been applied. * * * @returns Reference to `this` in order to allow method chaining */ attachAfterVariantApply( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartChart$AfterVariantApplyEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:afterVariantInitialise afterVariantInitialise } * event of this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired after the variant management in the SmartChart control has been initialized. * * * @returns Reference to `this` in order to allow method chaining */ attachAfterVariantInitialise( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:afterVariantInitialise afterVariantInitialise } * event of this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired after the variant management in the SmartChart control has been initialized. * * * @returns Reference to `this` in order to allow method chaining */ attachAfterVariantInitialise( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:afterVariantSave afterVariantSave} event of * this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired after a variant has been saved. This event can be used to retrieve the ID of the * saved variant. * * * @returns Reference to `this` in order to allow method chaining */ attachAfterVariantSave( /** * 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: SmartChart$AfterVariantSaveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:afterVariantSave afterVariantSave} event of * this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired after a variant has been saved. This event can be used to retrieve the ID of the * saved variant. * * * @returns Reference to `this` in order to allow method chaining */ attachAfterVariantSave( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartChart$AfterVariantSaveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeRebindChart beforeRebindChart} event of * this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired right before the `SmartChart` control triggers the binding / rebinding of the inner * chart. * **Note:** In certain cases the inner chart triggers a rebinding by itself. In these cases, the event * is not fired. * * * @returns Reference to `this` in order to allow method chaining */ attachBeforeRebindChart( /** * 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: SmartChart$BeforeRebindChartEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeRebindChart beforeRebindChart} event of * this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired right before the `SmartChart` control triggers the binding / rebinding of the inner * chart. * **Note:** In certain cases the inner chart triggers a rebinding by itself. In these cases, the event * is not fired. * * * @returns Reference to `this` in order to allow method chaining */ attachBeforeRebindChart( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartChart$BeforeRebindChartEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:chartDataChanged chartDataChanged} event of * this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired when `SmartChart` control data changes, due to changes in the personalization dialog * or drill operations. * The data can be changed via sorters, filters or drill-ups/drill-downs. * * * @returns Reference to `this` in order to allow method chaining */ attachChartDataChanged( /** * 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: SmartChart$ChartDataChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:chartDataChanged chartDataChanged} event of * this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired when `SmartChart` control data changes, due to changes in the personalization dialog * or drill operations. * The data can be changed via sorters, filters or drill-ups/drill-downs. * * * @returns Reference to `this` in order to allow method chaining */ attachChartDataChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartChart$ChartDataChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:dataReceived dataReceived} event of this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired when data is received after binding. This event is fired if the binding for the chart * is done by the SmartChart control itself. * * @deprecated As of version 1.56. Use `beforeRebindChart` event to attach/listen to the binding "events" * directly * * @returns Reference to `this` in order to allow method chaining */ attachDataReceived( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:dataReceived dataReceived} event of this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired when data is received after binding. This event is fired if the binding for the chart * is done by the SmartChart control itself. * * @deprecated As of version 1.56. Use `beforeRebindChart` event to attach/listen to the binding "events" * directly * * @returns Reference to `this` in order to allow method chaining */ attachDataReceived( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:fullScreenToggled fullScreenToggled} event of * this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired right after the full screen mode of the SmartChart control has been changed. * * @since 1.46 * * @returns Reference to `this` in order to allow method chaining */ attachFullScreenToggled( /** * 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: SmartChart$FullScreenToggledEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:fullScreenToggled fullScreenToggled} event of * this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired right after the full screen mode of the SmartChart control has been changed. * * @since 1.46 * * @returns Reference to `this` in order to allow method chaining */ attachFullScreenToggled( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartChart$FullScreenToggledEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Loads the chart lib synchronously before the event is attached. That is done for compatibility reasons. * **Note:** Attaching to this event causes the inner chart to load synchronously. This does not fulfill * CSP requirements. Please use event `initialized` instead. * * @deprecated As of version 1.94. replaced by {@link #event:initialized} */ attachInitialise(): void; /** * Attaches event handler `fnFunction` to the {@link #event:initialized initialized} event of this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired once the control has been initialized, asynchronous successor of `initialise`. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialized( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialized initialized} event of this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired once the control has been initialized, asynchronous successor of `initialise`. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialized( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionDetailsActionPress selectionDetailsActionPress } * event of this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired when any action in the selection details popover is pressed. * * @since 1.48 * * @returns Reference to `this` in order to allow method chaining */ attachSelectionDetailsActionPress( /** * 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: SmartChart$SelectionDetailsActionPressEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionDetailsActionPress selectionDetailsActionPress } * event of this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired when any action in the selection details popover is pressed. * * @since 1.48 * * @returns Reference to `this` in order to allow method chaining */ attachSelectionDetailsActionPress( /** * The function to be called when the event occurs */ fnFunction: ( p1: SmartChart$SelectionDetailsActionPressEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:showOverlay showOverlay} event of this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired right before the overlay is shown. * * * @returns Reference to `this` in order to allow method chaining */ attachShowOverlay( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:showOverlay showOverlay} event of this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired right before the overlay is shown. * * * @returns Reference to `this` in order to allow method chaining */ attachShowOverlay( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:uiStateChange uiStateChange} event of this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired when the UI state changes either via the {@link sap.ui.comp.smartchart.SmartChart#setUiState } * method or the chart personalization. * * @since 1.96.15 * * @returns Reference to `this` in order to allow method chaining */ attachUiStateChange( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:uiStateChange uiStateChange} event of this `sap.ui.comp.smartchart.SmartChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartchart.SmartChart` itself. * * This event is fired when the UI state changes either via the {@link sap.ui.comp.smartchart.SmartChart#setUiState } * method or the chart personalization. * * @since 1.96.15 * * @returns Reference to `this` in order to allow method chaining */ attachUiStateChange( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartchart.SmartChart` itself */ oListener?: object ): this; /** * Destroys the noDataIllustratedMessage in the aggregation {@link #getNoDataIllustratedMessage noDataIllustratedMessage}. * * @since 1.142 * * @returns Reference to `this` in order to allow method chaining */ destroyNoDataIllustratedMessage(): this; /** * Destroys all the selectionDetailsActionGroups in the aggregation {@link #getSelectionDetailsActionGroups selectionDetailsActionGroups}. * * @since 1.48 * * @returns Reference to `this` in order to allow method chaining */ destroySelectionDetailsActionGroups(): this; /** * Destroys all the selectionDetailsActions in the aggregation {@link #getSelectionDetailsActions selectionDetailsActions}. * * @since 1.48 * * @returns Reference to `this` in order to allow method chaining */ destroySelectionDetailsActions(): this; /** * Destroys all the selectionDetailsItemActions in the aggregation {@link #getSelectionDetailsItemActions selectionDetailsItemActions}. * * @since 1.48 * * @returns Reference to `this` in order to allow method chaining */ destroySelectionDetailsItemActions(): this; /** * Destroys the semanticObjectController in the aggregation {@link #getSemanticObjectController semanticObjectController}. * * @since 1.36 * * @returns Reference to `this` in order to allow method chaining */ destroySemanticObjectController(): this; /** * Destroys the toolbar in the aggregation {@link #getToolbar toolbar}. * * * @returns Reference to `this` in order to allow method chaining */ destroyToolbar(): this; /** * Detaches event handler `fnFunction` from the {@link #event:afterVariantApply afterVariantApply} event * of this `sap.ui.comp.smartchart.SmartChart`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachAfterVariantApply( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartChart$AfterVariantApplyEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:afterVariantInitialise afterVariantInitialise } * event of this `sap.ui.comp.smartchart.SmartChart`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachAfterVariantInitialise( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:afterVariantSave afterVariantSave} event of * this `sap.ui.comp.smartchart.SmartChart`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachAfterVariantSave( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartChart$AfterVariantSaveEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:beforeRebindChart beforeRebindChart} event * of this `sap.ui.comp.smartchart.SmartChart`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachBeforeRebindChart( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartChart$BeforeRebindChartEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:chartDataChanged chartDataChanged} event of * this `sap.ui.comp.smartchart.SmartChart`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachChartDataChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartChart$ChartDataChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:dataReceived dataReceived} event of this `sap.ui.comp.smartchart.SmartChart`. * * The passed function and listener object must match the ones used for event registration. * * @deprecated As of version 1.56. Use `beforeRebindChart` event to attach/listen to the binding "events" * directly * * @returns Reference to `this` in order to allow method chaining */ detachDataReceived( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:fullScreenToggled fullScreenToggled} event * of this `sap.ui.comp.smartchart.SmartChart`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.46 * * @returns Reference to `this` in order to allow method chaining */ detachFullScreenToggled( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartChart$FullScreenToggledEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:initialise initialise} event of this `sap.ui.comp.smartchart.SmartChart`. * * The passed function and listener object must match the ones used for event registration. * * @deprecated As of version 1.65. replaced by {@link initialized}. * * @returns Reference to `this` in order to allow method chaining */ detachInitialise( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:initialized initialized} event of this `sap.ui.comp.smartchart.SmartChart`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachInitialized( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:selectionDetailsActionPress selectionDetailsActionPress } * event of this `sap.ui.comp.smartchart.SmartChart`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.48 * * @returns Reference to `this` in order to allow method chaining */ detachSelectionDetailsActionPress( /** * The function to be called, when the event occurs */ fnFunction: ( p1: SmartChart$SelectionDetailsActionPressEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:showOverlay showOverlay} event of this `sap.ui.comp.smartchart.SmartChart`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachShowOverlay( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:uiStateChange uiStateChange} event of this * `sap.ui.comp.smartchart.SmartChart`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.96.15 * * @returns Reference to `this` in order to allow method chaining */ detachUiStateChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Cleans up the control. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ exit(): void; /** * Function for the {@link sap.ui.comp.smartvariants.SmartVariantManagement} control that returns the currently * used variant data in an internal format. **Note:** This function must not be used by applications. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns The currently used variant in an internal format */ fetchVariant(): sap.ui.comp.SmartChart.Variant; /** * Fires event {@link #event:afterVariantApply afterVariantApply} 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 */ fireAfterVariantApply( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartchart.SmartChart$AfterVariantApplyEventParameters ): this; /** * Fires event {@link #event:afterVariantInitialise afterVariantInitialise} 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 */ fireAfterVariantInitialise( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:afterVariantSave afterVariantSave} 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 */ fireAfterVariantSave( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartchart.SmartChart$AfterVariantSaveEventParameters ): this; /** * Fires event {@link #event:beforeRebindChart beforeRebindChart} 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 */ fireBeforeRebindChart( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartchart.SmartChart$BeforeRebindChartEventParameters ): this; /** * Fires event {@link #event:chartDataChanged chartDataChanged} 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 */ fireChartDataChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartchart.SmartChart$ChartDataChangedEventParameters ): this; /** * Fires event {@link #event:dataReceived dataReceived} to attached listeners. * * @deprecated As of version 1.56. Use `beforeRebindChart` event to attach/listen to the binding "events" * directly * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireDataReceived( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:fullScreenToggled fullScreenToggled} to attached listeners. * * @since 1.46 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireFullScreenToggled( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartchart.SmartChart$FullScreenToggledEventParameters ): this; /** * Fires event {@link #event:initialise initialise} to attached listeners. * * @deprecated As of version 1.65. replaced by {@link initialized}. * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireInitialise( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:initialized initialized} 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 */ fireInitialized( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:selectionDetailsActionPress selectionDetailsActionPress} to attached listeners. * * @since 1.48 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSelectionDetailsActionPress( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartchart.SmartChart$SelectionDetailsActionPressEventParameters ): this; /** * Fires event {@link #event:showOverlay showOverlay} 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 */ fireShowOverlay( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:uiStateChange uiStateChange} to attached listeners. * * @since 1.96.15 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireUiStateChange( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Gets current value of property {@link #getActivateTimeSeries activateTimeSeries}. * * Enables the use of timeseries on the inner chart when corresponding annotation is given * * **Note:** This timeseries is only supported for the following {@link sap.chart.TimeUnitType TimeUnitTypes } * and the following chart types {@link sap.viz.ui5.controls.VizFrame#getVizType}. * * Default value is `false`. * * @since 1.84 * * @returns Value of property `activateTimeSeries` */ getActivateTimeSeries(): boolean; /** * Returns the chart object used internally. * **Note:** Direct changes made to the inner {@link sap.chart.Chart chart} object or its {@link sap.viz.ui5.controls.VizFrame vizFrame } * might lead to inconsistencies and side effects during runtime, as the `SmartChart` control doesn"t listen * to all changes made to the inner {@link sap.chart.Chart chart} instance. To avoid this, please use the * API provided by the `SmartChart` control itself. **Note:** Calling this method when the chart is not * yet initialized causes the inner chart to load synchronously. This does not fulfill CSP requirements. * Please use `getChartAsync` instead. * * @deprecated As of version 1.57. replaced by {@link #getChartAsync} * * @returns The inner chart object */ getChart(): sap.chart.Chart; /** * Returns a promise which will be resolved with the internally used chart object, once all dependencies * have been loaded. * **Note:** Direct changes made to the inner {@link sap.chart.Chart chart} object or its {@link sap.viz.ui5.controls.VizFrame vizFrame } * might lead to inconsistencies and side effects during runtime, as the `SmartChart` control doesn't listen * to all changes made to the inner {@link sap.chart.Chart chart} instance. To avoid this, please use the * API provided by the `SmartChart` control itself. * * @since 1.57.0 * * @returns Promise for inner chart object */ getChartAsync(): Promise; /** * Gets current value of property {@link #getChartBindingPath chartBindingPath}. * * Specifies the path that is used during the binding of the chart. If not specified, the entitySet property * is used instead. (used only if binding is established internally/automatically - See enableAutoBinding) * * * @returns Value of property `chartBindingPath` */ getChartBindingPath(): string; /** * Gets current value of property {@link #getChartType chartType}. * * Specifies the type of chart to be created by the SmartChart control. * * * @returns Value of property `chartType` */ getChartType(): string; /** * Returns the ID of the currently selected variant. * * * @returns ID of the currently selected variant */ getCurrentVariantId(): string; /** * Gets current value of property {@link #getEnableAutoBinding enableAutoBinding}. * * If set to `true`, this enables automatic binding of the chart using the chartBindingPath (if it exists) * or entitySet property. This happens right after the `initialise` event has been fired. * * Default value is `false`. * * * @returns Value of property `enableAutoBinding` */ getEnableAutoBinding(): boolean; /** * Gets current value of property {@link #getEntitySet entitySet}. * * The entity set name from which to fetch data and generate the columns. * **Note** This is not a dynamic property. * * * @returns Value of property `entitySet` */ getEntitySet(): string; /** * Gets current value of property {@link #getHeader header}. * * Specifies header text that is shown in the chart. * * * @returns Value of property `header` */ getHeader(): string; /** * Gets current value of property {@link #getHeaderLevel headerLevel}. * * Semantic level of the header. * For more information, see {@link sap.m.Title#setLevel}. * * Default value is `Auto`. * * @since 1.118 * * @returns Value of property `headerLevel` */ getHeaderLevel(): sap.ui.core.TitleLevel; /** * Gets current value of property {@link #getHeaderStyle headerStyle}. * * Defines style of the header. * For more information, see {@link sap.m.Title#setTitle}. * * Default value is `Auto`. * * @since 1.119 * * @returns Value of property `headerStyle` */ getHeaderStyle(): sap.ui.core.TitleLevel; /** * Gets current value of property {@link #getIgnoredChartTypes ignoredChartTypes}. * * CSV of fields that is not shown in the list of available chart types. * **Note:** No validation is done. Please ensure that you do not add spaces or special characters. * * * @returns Value of property `ignoredChartTypes` */ getIgnoredChartTypes(): string; /** * Gets current value of property {@link #getIgnoredFields ignoredFields}. * * CSV of fields that must be ignored in the OData metadata by the SmartChart control. * **Note:** No validation is done. Please ensure that you do not add spaces or special characters. * * * @returns Value of property `ignoredFields` */ getIgnoredFields(): string; /** * Gets current value of property {@link #getIgnoreFromPersonalisation ignoreFromPersonalisation}. * * CSV of fields that is not shown in the personalization dialog. * **Note:** No validation is done. Please ensure that you do not add spaces or special characters. * * * @returns Value of property `ignoreFromPersonalisation` */ getIgnoreFromPersonalisation(): string; /** * Gets current value of property {@link #getLegendVisible legendVisible}. * * Set chart's legend properties. * * Default value is `true`. * * @since 1.36 * * @returns Value of property `legendVisible` */ getLegendVisible(): boolean; /** * Gets current value of property {@link #getNoData noData}. * * Defines the custom text that will be displayed in case no data is found for the current binding. * * @since 1.46 * * @returns Value of property `noData` */ getNoData(): string; /** * Gets content of aggregation {@link #getNoDataIllustratedMessage noDataIllustratedMessage}. * * `IllustratedMessage` shown when no data is available. * * @since 1.142 */ getNoDataIllustratedMessage(): sap.m.IllustratedMessage; /** * Gets current value of property {@link #getNotAssignedText notAssignedText}. * * Text that is shown for values of an empty string. **Note:** The property does not change the behavior * for charts of type `timeseries`. **Note:** Can only be changed in the XML/JS view. It cannot be changed * once the control has been initialized. * * Default value is `empty string`. * * @since 1.106 * * @returns Value of property `notAssignedText` */ getNotAssignedText(): string; /** * Gets current value of property {@link #getPersistencyKey persistencyKey}. * * Key used to access personalization data. * * * @returns Value of property `persistencyKey` */ getPersistencyKey(): string; /** * Gets current value of property {@link #getRequestAtLeastFields requestAtLeastFields}. * * CSV of fields that must be always requested by the backend system. * This property is mainly meant to be used if there is no PresentationVariant annotation. * If both this property and the PresentationVariant annotation exist, the select request sent to the backend * would be a combination of both. * **Note:** No validation is done. Please ensure that you do not add spaces or special characters. Also, * setting this property during runtime, will delete the current drill-stack and lead to a loss of the drill * history. * * * @returns Value of property `requestAtLeastFields` */ getRequestAtLeastFields(): string; /** * Gets content of aggregation {@link #getSelectionDetailsActionGroups selectionDetailsActionGroups}. * * Actions on group level which can be specified for the selection details popover. * * @since 1.48 */ getSelectionDetailsActionGroups(): sap.ui.core.Item[]; /** * Gets content of aggregation {@link #getSelectionDetailsActions selectionDetailsActions}. * * Actions on footer level which can be specified for the selection details popover. * * @since 1.48 */ getSelectionDetailsActions(): sap.ui.core.Item[]; /** * Gets content of aggregation {@link #getSelectionDetailsItemActions selectionDetailsItemActions}. * * Actions on item level which can be specified for the selection details popover. * * @since 1.48 */ getSelectionDetailsItemActions(): sap.ui.core.Item[]; /** * Gets current value of property {@link #getSelectionMode selectionMode}. * * Chart selection mode. Supported values are {@link sap.ui.comp.smartchart.SelectionMode.Single} or {@link sap.ui.comp.smartchart.SelectionMode.Multi}, * case insensitive, always return in upper case. Unsupported values will be ignored. * * Default value is `Multi`. * * @since 1.36 * * @returns Value of property `selectionMode` */ getSelectionMode(): sap.ui.comp.smartchart.SelectionMode; /** * Gets content of aggregation {@link #getSemanticObjectController semanticObjectController}. * * The Semantic Object Controller allows the user to specify and overwrite functionality for semantic object * navigation. * * @since 1.36 */ getSemanticObjectController(): sap.ui.comp.navpopover.SemanticObjectController; /** * Gets current value of property {@link #getShowChartTooltip showChartTooltip}. * * Controls the visibility of the chart tooltip. If set to `true `, an instance of sap.viz.ui5.controls.VizTooltip * will be created and shown when hovering over a data point. * * Default value is `true`. * * @since 1.38 * * @returns Value of property `showChartTooltip` */ getShowChartTooltip(): boolean; /** * Gets current value of property {@link #getShowChartTypeSelectionButton showChartTypeSelectionButton}. * * Controls the visibility of the chart type selection button. * * Default value is `true`. * * @since 1.48 * * @returns Value of property `showChartTypeSelectionButton` */ getShowChartTypeSelectionButton(): boolean; /** * Gets current value of property {@link #getShowDetailsButton showDetailsButton}. * * Controls the visibility of the Details button. If set to `true`, the datapoint tooltip will be disabled * as the information of selected datapoints will be found in the details popover. This will also set the * drill-down button to invisible. * * Default value is `false`. * * @since 1.38 * * @returns Value of property `showDetailsButton` */ getShowDetailsButton(): boolean; /** * Gets current value of property {@link #getShowDimensionsTitle showDimensionsTitle}. * * Controls the visibility of the title in the dimension area of the chart. * * Default value is `true`. * * @since 1.54 * * @returns Value of property `showDimensionsTitle` */ getShowDimensionsTitle(): boolean; /** * Gets current value of property {@link #getShowDownloadButton showDownloadButton}. * * Controls the visibility of the chart download button. * * Default value is `false`. * * @since 1.39 * * @returns Value of property `showDownloadButton` */ getShowDownloadButton(): boolean; /** * Gets current value of property {@link #getShowDrillBreadcrumbs showDrillBreadcrumbs}. * * Controls the visibility of the Breadcrumbs control for drilling up within the visible dimensions. If * set to `true`, the toolbar header will be replaced by the Breadcrumbs control. This will also set the * drill-up button to invisible. * * Default value is `false`. * * @since 1.38 * * @returns Value of property `showDrillBreadcrumbs` */ getShowDrillBreadcrumbs(): boolean; /** * Gets current value of property {@link #getShowDrillButtons showDrillButtons}. * * Controls the visibility of the Drill Up and Drill Down buttons. * * Default value is `true`. * * * @returns Value of property `showDrillButtons` */ getShowDrillButtons(): boolean; /** * Gets current value of property {@link #getShowFullScreenButton showFullScreenButton}. * * Controls the visibility of the FullScreen button. * * Default value is `true`. * * @since 1.36 * * @returns Value of property `showFullScreenButton` */ getShowFullScreenButton(): boolean; /** * Gets current value of property {@link #getShowLegendButton showLegendButton}. * * Controls the visibility of the Navigation button * * Default value is `true`. * * @since 1.36 * * @returns Value of property `showLegendButton` */ getShowLegendButton(): boolean; /** * Gets current value of property {@link #getShowMeasuresTitle showMeasuresTitle}. * * Controls the visibility of the title in the measure area of the chart. * * Default value is `true`. * * @since 1.54 * * @returns Value of property `showMeasuresTitle` */ getShowMeasuresTitle(): boolean; /** * Gets current value of property {@link #getShowSemanticNavigationButton showSemanticNavigationButton}. * * Controls the visibility of the Navigation button * * Default value is `true`. * * @since 1.36 * * @returns Value of property `showSemanticNavigationButton` */ getShowSemanticNavigationButton(): boolean; /** * Gets current value of property {@link #getShowToolbar showToolbar}. * * Controls the visibility of the toolbar. * * Default value is `true`. * * @since 1.54 * * @returns Value of property `showToolbar` */ getShowToolbar(): boolean; /** * Gets current value of property {@link #getShowVariantManagement showVariantManagement}. * * Controls the visibility of the Variant Management. * * Default value is `true`. * * @since 1.38 * * @returns Value of property `showVariantManagement` */ getShowVariantManagement(): boolean; /** * Gets current value of property {@link #getShowZoomButtons showZoomButtons}. * * Controls the visibility of the Zoom In and Zoom Out buttons. * * Default value is `true`. * * @since 1.36 * * @returns Value of property `showZoomButtons` */ getShowZoomButtons(): boolean; /** * Gets current value of property {@link #getSmartFilterId smartFilterId}. * * ID of the corresponding SmartFilter control. If specified, the SmartChart control searches for the SmartFilter * control (also in the closest parent view) and attaches to the relevant events of the SmartFilter control * to fetch data, show overlay etc. * * * @returns Value of property `smartFilterId` */ getSmartFilterId(): string; /** * ID of the element which is the current target of the association {@link #getSmartVariant smartVariant}, * or `null`. * * @since 1.38 */ getSmartVariant(): sap.ui.core.ID | null; /** * Gets content of aggregation {@link #getToolbar toolbar}. * * A custom toolbar that can be specified by the user to define their own buttons, icons, etc. If this is * added, the SmartChart control does not create its own toolbar, but uses this one instead. However, if * default actions, such as showSemanticNavigation, showFullScreenButton etc. are set, these actions are * added at the left-hand side of the toolbar. */ getToolbar(): sap.m.Toolbar; /** * Gets current value of property {@link #getToolbarStyle toolbarStyle}. * * Defines the visual style of the smart charts `Toolbar`. **Note:** The visual styles are theme-dependent. * * @since 1.54 * * @returns Value of property `toolbarStyle` */ getToolbarStyle(): sap.m.ToolbarStyle; /** * The method returns the current UI state of SmartChart control. * * * @returns Current UI state */ getUiState(): sap.ui.comp.state.UIState; /** * Gets current value of property {@link #getUseChartPersonalisation useChartPersonalisation}. * * If set to `true`, personalized chart settings are defined. If you want to persist the chart personalization, * you need to specify the persistencyKey property. * * Default value is `true`. * * * @returns Value of property `useChartPersonalisation` */ getUseChartPersonalisation(): boolean; /** * Gets current value of property {@link #getUseListForChartTypeSelection useListForChartTypeSelection}. * * Controls the visualization for chart type selection. If set to `true`, the list of available chart types * will be displayed. If set to `false` and there are three or fewer available chart types, the chart types * will be displayed as separate buttons in the toolbar. If there are more than three chart types, a list * will be shown. * * Default value is `true`. * * @since 1.38 * @deprecated As of version 1.48.0. Setting the property to `false` will have no effect on the visualization * of chart type selection. `SmartChart` will always show a list of chart types. * * @returns Value of property `useListForChartTypeSelection` */ getUseListForChartTypeSelection(): boolean; /** * Gets current value of property {@link #getUseTooltip useTooltip}. * * Specifies weather an instance of {@link sap.viz.ui5.controls.VizTooltip} or {@link sap.viz.ui5.controls.Popover } * is used. If set to `true`, a tooltip will be displayed, a popover otherwise. * * Default value is `true`. * * @since 1.36 * * @returns Value of property `useTooltip` */ getUseTooltip(): boolean; /** * Gets current value of property {@link #getUseVariantManagement useVariantManagement}. * * If set to `true`, variants are used. As a prerequisite, you need to specify the persistencyKey property. * * Default value is `true`. * * * @returns Value of property `useVariantManagement` */ getUseVariantManagement(): boolean; /** * Checks for the provided `sap.ui.core.Item` in the aggregation {@link #getSelectionDetailsActions selectionDetailsActions}. * and returns its index if found or -1 otherwise. * * @since 1.48 * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfSelectionDetailsAction( /** * The selectionDetailsAction whose index is looked for */ oSelectionDetailsAction: sap.ui.core.Item ): int; /** * Checks for the provided `sap.ui.core.Item` in the aggregation {@link #getSelectionDetailsActionGroups selectionDetailsActionGroups}. * and returns its index if found or -1 otherwise. * * @since 1.48 * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfSelectionDetailsActionGroup( /** * The selectionDetailsActionGroup whose index is looked for */ oSelectionDetailsActionGroup: sap.ui.core.Item ): int; /** * Checks for the provided `sap.ui.core.Item` in the aggregation {@link #getSelectionDetailsItemActions selectionDetailsItemActions}. * and returns its index if found or -1 otherwise. * * @since 1.48 * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfSelectionDetailsItemAction( /** * The selectionDetailsItemAction whose index is looked for */ oSelectionDetailsItemAction: sap.ui.core.Item ): int; /** * Inserts a selectionDetailsAction into the aggregation {@link #getSelectionDetailsActions selectionDetailsActions}. * * @since 1.48 * * @returns Reference to `this` in order to allow method chaining */ insertSelectionDetailsAction( /** * The selectionDetailsAction to insert; if empty, nothing is inserted */ oSelectionDetailsAction: sap.ui.core.Item, /** * The `0`-based index the selectionDetailsAction should be inserted at; for a negative value of `iIndex`, * the selectionDetailsAction is inserted at position 0; for a value greater than the current size of the * aggregation, the selectionDetailsAction is inserted at the last position */ iIndex: int ): this; /** * Inserts a selectionDetailsActionGroup into the aggregation {@link #getSelectionDetailsActionGroups selectionDetailsActionGroups}. * * @since 1.48 * * @returns Reference to `this` in order to allow method chaining */ insertSelectionDetailsActionGroup( /** * The selectionDetailsActionGroup to insert; if empty, nothing is inserted */ oSelectionDetailsActionGroup: sap.ui.core.Item, /** * The `0`-based index the selectionDetailsActionGroup should be inserted at; for a negative value of `iIndex`, * the selectionDetailsActionGroup is inserted at position 0; for a value greater than the current size * of the aggregation, the selectionDetailsActionGroup is inserted at the last position */ iIndex: int ): this; /** * Inserts a selectionDetailsItemAction into the aggregation {@link #getSelectionDetailsItemActions selectionDetailsItemActions}. * * @since 1.48 * * @returns Reference to `this` in order to allow method chaining */ insertSelectionDetailsItemAction( /** * The selectionDetailsItemAction to insert; if empty, nothing is inserted */ oSelectionDetailsItemAction: sap.ui.core.Item, /** * The `0`-based index the selectionDetailsItemAction should be inserted at; for a negative value of `iIndex`, * the selectionDetailsItemAction is inserted at position 0; for a value greater than the current size of * the aggregation, the selectionDetailsItemAction is inserted at the last position */ iIndex: int ): this; /** * Checks whether the control is initialized. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns returns whether the control is already initialized */ isInitialised(): boolean; /** * This can be used to trigger binding on the chart used in the SmartChart * * @ui5-protected Do not call from applications (only from related classes in the framework) */ rebindChart(): void; /** * Removes all the controls from the aggregation {@link #getSelectionDetailsActionGroups selectionDetailsActionGroups}. * * Additionally, it unregisters them from the hosting UIArea. * * @since 1.48 * * @returns An array of the removed elements (might be empty) */ removeAllSelectionDetailsActionGroups(): sap.ui.core.Item[]; /** * Removes all the controls from the aggregation {@link #getSelectionDetailsActions selectionDetailsActions}. * * Additionally, it unregisters them from the hosting UIArea. * * @since 1.48 * * @returns An array of the removed elements (might be empty) */ removeAllSelectionDetailsActions(): sap.ui.core.Item[]; /** * Removes all the controls from the aggregation {@link #getSelectionDetailsItemActions selectionDetailsItemActions}. * * Additionally, it unregisters them from the hosting UIArea. * * @since 1.48 * * @returns An array of the removed elements (might be empty) */ removeAllSelectionDetailsItemActions(): sap.ui.core.Item[]; /** * Removes a selectionDetailsAction from the aggregation {@link #getSelectionDetailsActions selectionDetailsActions}. * * @since 1.48 * * @returns The removed selectionDetailsAction or `null` */ removeSelectionDetailsAction( /** * The selectionDetailsAction to remove or its index or id */ vSelectionDetailsAction: int | string | sap.ui.core.Item ): sap.ui.core.Item | null; /** * Removes a selectionDetailsActionGroup from the aggregation {@link #getSelectionDetailsActionGroups selectionDetailsActionGroups}. * * @since 1.48 * * @returns The removed selectionDetailsActionGroup or `null` */ removeSelectionDetailsActionGroup( /** * The selectionDetailsActionGroup to remove or its index or id */ vSelectionDetailsActionGroup: int | string | sap.ui.core.Item ): sap.ui.core.Item | null; /** * Removes a selectionDetailsItemAction from the aggregation {@link #getSelectionDetailsItemActions selectionDetailsItemActions}. * * @since 1.48 * * @returns The removed selectionDetailsItemAction or `null` */ removeSelectionDetailsItemAction( /** * The selectionDetailsItemAction to remove or its index or id */ vSelectionDetailsItemAction: int | string | sap.ui.core.Item ): sap.ui.core.Item | null; /** * Sets a new value for property {@link #getActivateTimeSeries activateTimeSeries}. * * Enables the use of timeseries on the inner chart when corresponding annotation is given * * **Note:** This timeseries is only supported for the following {@link sap.chart.TimeUnitType TimeUnitTypes } * and the following chart types {@link sap.viz.ui5.controls.VizFrame#getVizType}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.84 * * @returns Reference to `this` in order to allow method chaining */ setActivateTimeSeries( /** * New value for property `activateTimeSeries` */ bActivateTimeSeries?: boolean ): this; /** * Sets a new value for property {@link #getChartBindingPath chartBindingPath}. * * Specifies the path that is used during the binding of the chart. If not specified, the entitySet property * is used instead. (used only if binding is established internally/automatically - See enableAutoBinding) * * 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 */ setChartBindingPath( /** * New value for property `chartBindingPath` */ sChartBindingPath?: string ): this; /** * Sets a new value for property {@link #getChartType chartType}. * * Specifies the type of chart to be created by the SmartChart 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 */ setChartType( /** * New value for property `chartType` */ sChartType?: string ): this; /** * Applies the current variant based on the sVariantId parameter. If an empty string or null or undefined * have been passed, the standard variant will be used. The standard variant will also be used if the passed * sVariantId cannot be found. If the flexibility variant, the content for the standard variant, or the * personalizable control cannot be obtained, no changes will be made. */ setCurrentVariantId( /** * ID of the currently selected variant */ sVariantId: string ): void; /** * Sets a new value for property {@link #getEnableAutoBinding enableAutoBinding}. * * If set to `true`, this enables automatic binding of the chart using the chartBindingPath (if it exists) * or entitySet property. This happens right after the `initialise` event has been fired. * * 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 */ setEnableAutoBinding( /** * New value for property `enableAutoBinding` */ bEnableAutoBinding?: boolean ): this; /** * The entity set name in the OData metadata against which the chart must be bound. */ setEntitySet( /** * The entity set */ sEntitySetName: string ): void; /** * Sets a new value for property {@link #getHeader header}. * * Specifies header text that is shown in the chart. * * 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 */ setHeader( /** * New value for property `header` */ sHeader?: string ): this; /** * Sets a new value for property {@link #getHeaderLevel headerLevel}. * * Semantic level of the header. * For more information, see {@link sap.m.Title#setLevel}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Auto`. * * @since 1.118 * * @returns Reference to `this` in order to allow method chaining */ setHeaderLevel( /** * New value for property `headerLevel` */ sHeaderLevel?: sap.ui.core.TitleLevel ): this; /** * Sets a new value for property {@link #getHeaderStyle headerStyle}. * * Defines style of the header. * For more information, see {@link sap.m.Title#setTitle}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Auto`. * * @since 1.119 * * @returns Reference to `this` in order to allow method chaining */ setHeaderStyle( /** * New value for property `headerStyle` */ sHeaderStyle?: sap.ui.core.TitleLevel ): this; /** * Sets a new value for property {@link #getIgnoredChartTypes ignoredChartTypes}. * * CSV of fields that is not shown in the list of available chart types. * **Note:** No validation is done. Please ensure that you do not add spaces or special characters. * * 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 */ setIgnoredChartTypes( /** * New value for property `ignoredChartTypes` */ sIgnoredChartTypes?: string ): this; /** * Sets a new value for property {@link #getIgnoredFields ignoredFields}. * * CSV of fields that must be ignored in the OData metadata by the SmartChart control. * **Note:** No validation is done. Please ensure that you do not add spaces or special characters. * * 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 */ setIgnoredFields( /** * New value for property `ignoredFields` */ sIgnoredFields?: string ): this; /** * Sets a new value for property {@link #getIgnoreFromPersonalisation ignoreFromPersonalisation}. * * CSV of fields that is not shown in the personalization dialog. * **Note:** No validation is done. Please ensure that you do not add spaces or special characters. * * 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 */ setIgnoreFromPersonalisation( /** * New value for property `ignoreFromPersonalisation` */ sIgnoreFromPersonalisation?: string ): this; /** * Sets a new value for property {@link #getNoData noData}. * * Defines the custom text that will be displayed in case no data is found for the current binding. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.46 * * @returns Reference to `this` in order to allow method chaining */ setNoData( /** * New value for property `noData` */ sNoData?: string ): this; /** * Sets the aggregated {@link #getNoDataIllustratedMessage noDataIllustratedMessage}. * * @since 1.142 * * @returns Reference to `this` in order to allow method chaining */ setNoDataIllustratedMessage( /** * The noDataIllustratedMessage to set */ oNoDataIllustratedMessage: sap.m.IllustratedMessage ): this; /** * Sets a new value for property {@link #getNotAssignedText notAssignedText}. * * Text that is shown for values of an empty string. **Note:** The property does not change the behavior * for charts of type `timeseries`. **Note:** Can only be changed in the XML/JS view. It cannot be changed * once the control has been initialized. * * 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.106 * * @returns Reference to `this` in order to allow method chaining */ setNotAssignedText( /** * New value for property `notAssignedText` */ sNotAssignedText?: string ): this; /** * Sets a new value for property {@link #getPersistencyKey persistencyKey}. * * Key used to access personalization data. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setPersistencyKey( /** * New value for property `persistencyKey` */ sPersistencyKey?: string ): this; /** * Sets a new value for property {@link #getRequestAtLeastFields requestAtLeastFields}. * * CSV of fields that must be always requested by the backend system. * This property is mainly meant to be used if there is no PresentationVariant annotation. * If both this property and the PresentationVariant annotation exist, the select request sent to the backend * would be a combination of both. * **Note:** No validation is done. Please ensure that you do not add spaces or special characters. Also, * setting this property during runtime, will delete the current drill-stack and lead to a loss of the drill * history. * * 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 */ setRequestAtLeastFields( /** * New value for property `requestAtLeastFields` */ sRequestAtLeastFields?: string ): this; /** * Sets the aggregated {@link #getSemanticObjectController semanticObjectController}. * * @since 1.36 * * @returns Reference to `this` in order to allow method chaining */ setSemanticObjectController( /** * The semanticObjectController to set */ oSemanticObjectController: sap.ui.comp.navpopover.SemanticObjectController ): this; /** * Sets a new value for property {@link #getShowChartTooltip showChartTooltip}. * * Controls the visibility of the chart tooltip. If set to `true `, an instance of sap.viz.ui5.controls.VizTooltip * will be created and shown when hovering over a data point. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.38 * * @returns Reference to `this` in order to allow method chaining */ setShowChartTooltip( /** * New value for property `showChartTooltip` */ bShowChartTooltip?: boolean ): this; /** * Sets a new value for property {@link #getShowChartTypeSelectionButton showChartTypeSelectionButton}. * * Controls the visibility of the chart type selection button. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.48 * * @returns Reference to `this` in order to allow method chaining */ setShowChartTypeSelectionButton( /** * New value for property `showChartTypeSelectionButton` */ bShowChartTypeSelectionButton?: boolean ): this; /** * Sets a new value for property {@link #getShowDetailsButton showDetailsButton}. * * Controls the visibility of the Details button. If set to `true`, the datapoint tooltip will be disabled * as the information of selected datapoints will be found in the details popover. This will also set the * drill-down button to invisible. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.38 * * @returns Reference to `this` in order to allow method chaining */ setShowDetailsButton( /** * New value for property `showDetailsButton` */ bShowDetailsButton?: boolean ): this; /** * Sets a new value for property {@link #getShowDownloadButton showDownloadButton}. * * Controls the visibility of the chart download button. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.39 * * @returns Reference to `this` in order to allow method chaining */ setShowDownloadButton( /** * New value for property `showDownloadButton` */ bShowDownloadButton?: boolean ): this; /** * Sets a new value for property {@link #getShowDrillBreadcrumbs showDrillBreadcrumbs}. * * Controls the visibility of the Breadcrumbs control for drilling up within the visible dimensions. If * set to `true`, the toolbar header will be replaced by the Breadcrumbs control. This will also set the * drill-up button to invisible. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.38 * * @returns Reference to `this` in order to allow method chaining */ setShowDrillBreadcrumbs( /** * New value for property `showDrillBreadcrumbs` */ bShowDrillBreadcrumbs?: boolean ): this; /** * Change the visibility of the toolbar * * @since 1.54 */ setShowToolbar( /** * If set to `true` the toolbar is shown, if set to `false` it is not visible */ bShowToolbar: boolean ): void; /** * Sets a new value for property {@link #getShowVariantManagement showVariantManagement}. * * Controls the visibility of the Variant Management. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.38 * * @returns Reference to `this` in order to allow method chaining */ setShowVariantManagement( /** * New value for property `showVariantManagement` */ bShowVariantManagement?: boolean ): this; /** * Sets a new value for property {@link #getSmartFilterId smartFilterId}. * * ID of the corresponding SmartFilter control. If specified, the SmartChart control searches for the SmartFilter * control (also in the closest parent view) and attaches to the relevant events of the SmartFilter control * to fetch data, show overlay etc. * * 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 */ setSmartFilterId( /** * New value for property `smartFilterId` */ sSmartFilterId?: string ): this; /** * Sets the associated {@link #getSmartVariant smartVariant}. * * @since 1.38 * * @returns Reference to `this` in order to allow method chaining */ setSmartVariant( /** * ID of an element which becomes the new target of this smartVariant association; alternatively, an element * instance may be given */ oSmartVariant: sap.ui.core.ID | sap.ui.core.Control ): this; /** * Change the style of the toolbar * * @since 1.54 */ setToolbarStyle( /** * The style of the toolbar. */ sStyle: sap.m.ToolbarStyle ): void; /** * The method replaces the current UI state of SmartChart control with the data represented in `uiState`. */ setUiState( /** * the new representation of UI state */ oUiState: sap.ui.comp.state.UIState ): void; /** * Sets a new value for property {@link #getUseChartPersonalisation useChartPersonalisation}. * * If set to `true`, personalized chart settings are defined. If you want to persist the chart personalization, * you need to specify the persistencyKey property. * * 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 */ setUseChartPersonalisation( /** * New value for property `useChartPersonalisation` */ bUseChartPersonalisation?: boolean ): this; /** * Sets a new value for property {@link #getUseListForChartTypeSelection useListForChartTypeSelection}. * * Controls the visualization for chart type selection. If set to `true`, the list of available chart types * will be displayed. If set to `false` and there are three or fewer available chart types, the chart types * will be displayed as separate buttons in the toolbar. If there are more than three chart types, a list * will 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.38 * @deprecated As of version 1.48.0. Setting the property to `false` will have no effect on the visualization * of chart type selection. `SmartChart` will always show a list of chart types. * * @returns Reference to `this` in order to allow method chaining */ setUseListForChartTypeSelection( /** * New value for property `useListForChartTypeSelection` */ bUseListForChartTypeSelection?: boolean ): this; /** * Sets a new value for property {@link #getUseTooltip useTooltip}. * * Specifies weather an instance of {@link sap.viz.ui5.controls.VizTooltip} or {@link sap.viz.ui5.controls.Popover } * is used. If set to `true`, a tooltip will be displayed, a popover otherwise. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.36 * * @returns Reference to `this` in order to allow method chaining */ setUseTooltip( /** * New value for property `useTooltip` */ bUseTooltip?: boolean ): this; /** * Sets a new value for property {@link #getUseVariantManagement useVariantManagement}. * * If set to `true`, variants are used. As a prerequisite, you need to specify the persistencyKey property. * * 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 */ setUseVariantManagement( /** * New value for property `useVariantManagement` */ bUseVariantManagement?: boolean ): this; } /** * Enumeration for supported selection mode in SmartChart * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartchart.SelectionMode'. */ enum SelectionMode { /** * Multi selection mode, multiple sets of data points can be selected at once. */ Multi = "MULTIPLE", /** * None selection mode, no data points can be selected. */ None = "NONE", /** * Single selection mode, only one set of data points can be selected at once. */ Single = "SINGLE", } /** * Event object of the SmartChart#afterVariantApply event. */ type SmartChart$AfterVariantApplyEvent = sap.ui.base.Event< SmartChart$AfterVariantApplyEventParameters, SmartChart >; /** * Event object of the SmartChart#afterVariantInitialise event. */ type SmartChart$AfterVariantInitialiseEvent = sap.ui.base.Event< SmartChart$AfterVariantInitialiseEventParameters, SmartChart >; /** * Event object of the SmartChart#afterVariantSave event. */ type SmartChart$AfterVariantSaveEvent = sap.ui.base.Event< SmartChart$AfterVariantSaveEventParameters, SmartChart >; /** * Event object of the SmartChart#beforeRebindChart event. */ type SmartChart$BeforeRebindChartEvent = sap.ui.base.Event< SmartChart$BeforeRebindChartEventParameters, SmartChart >; /** * Event object of the SmartChart#chartDataChanged event. */ type SmartChart$ChartDataChangedEvent = sap.ui.base.Event< SmartChart$ChartDataChangedEventParameters, SmartChart >; /** * Event object of the SmartChart#dataReceived event. * * @deprecated As of version 1.56. Use `beforeRebindChart` event to attach/listen to the binding "events" * directly */ type SmartChart$DataReceivedEvent = sap.ui.base.Event< SmartChart$DataReceivedEventParameters, SmartChart >; /** * Event object of the SmartChart#fullScreenToggled event. */ type SmartChart$FullScreenToggledEvent = sap.ui.base.Event< SmartChart$FullScreenToggledEventParameters, SmartChart >; /** * Event object of the SmartChart#initialise event. * * @deprecated As of version 1.65. replaced by {@link initialized}. */ type SmartChart$InitialiseEvent = sap.ui.base.Event< SmartChart$InitialiseEventParameters, SmartChart >; /** * Event object of the SmartChart#initialized event. */ type SmartChart$InitializedEvent = sap.ui.base.Event< SmartChart$InitializedEventParameters, SmartChart >; /** * Event object of the SmartChart#selectionDetailsActionPress event. */ type SmartChart$SelectionDetailsActionPressEvent = sap.ui.base.Event< SmartChart$SelectionDetailsActionPressEventParameters, SmartChart >; /** * Event object of the SmartChart#showOverlay event. */ type SmartChart$ShowOverlayEvent = sap.ui.base.Event< SmartChart$ShowOverlayEventParameters, SmartChart >; /** * Event object of the SmartChart#uiStateChange event. */ type SmartChart$UiStateChangeEvent = sap.ui.base.Event< SmartChart$UiStateChangeEventParameters, SmartChart >; } namespace SmartChart { namespace Variant { type Dimeasure = { /** * Internal key of the chart type stored in the variant */ chartTypeKey?: string; /** * Representation of all dimension and measures in the chart and their current state */ dimeasureItems: sap.ui.comp.SmartChart.Variant.DimeasureItem[]; }; type DimeasureItem = { /** * Aggregation role of the `DimeasureItem`, which can be either a `Dimension` or a `Measure` */ aggregationRole: string; /** * Name of the property this `DimeasureItem` refers to in the metadata */ columnKey: string; /** * Position of the dimension/name in the chart's drill stack */ index: int; /** * The chart role of the dimension or measure */ role: string; /** * Determines whether the dimension or measure is currently visualized in the chart */ visible: boolean; }; type Filter = { /** * Representation of all current filters of the chart */ filterItems: sap.ui.comp.SmartChart.Variant.FilterItem[]; }; type FilterItem = { /** * Name of the property this `DimeasureItem` refers to in the metadata */ columnKey: string; /** * Determines whether this is an exclude filter */ exclude: boolean; /** * Filter operation used for this filter */ operation: string; /** * Value 1 for the filter operation */ value1: any; /** * Value 2 for the filter operation */ value2?: any; }; type Sort = { /** * Representation of all current sorters of the chart */ sortItems: sap.ui.comp.SmartChart.Variant.SortItem[]; }; type SortItem = { /** * Name of the property this `DimeasureItem` refers to in the metadata */ columnKey: string; /** * Sort operation, which can be either `Ascending` or `Descending` */ operation: string; }; } type Variant = { /** * Information about all measures and dimensions of the chart */ dimeasure: sap.ui.comp.SmartChart.Variant.Dimeasure; /** * Information about the current filters applied to the chart */ filter?: sap.ui.comp.SmartChart.Variant.Filter; /** * Information about the current sorters applied to the chart */ sort?: sap.ui.comp.SmartChart.Variant.Sort; }; } namespace smartfield { /** * Describes the settings that can be provided to the ComboBox constructor. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ interface $ComboBoxSettings extends sap.m.$ComboBoxSettings { /** * Key of the selected item. * * **Note:** If duplicate keys exist, the first item matching the key is used. */ selectedKey?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; enteredValue?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Property works the same as sap.m.Input control `value` */ realValue?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType` * from the ValueList property. */ valueTextArrangement?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; } /** * Describes the settings that can be provided to the Configuration constructor. */ interface $ConfigurationSettings extends sap.ui.core.$ElementSettings { /** * By default the SmartField chooses the controls it hosts by interpreting OData metadata. This property * allows to overwrite the default behavior to some extent. For example makes it possible to define that * an OData property of type Edm.Boolean is displayed as a combo box. */ controlType?: | sap.ui.comp.smartfield.ControlType | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The property specifies how value help, that is available for input fields, is presented. For example, * it specifies whether the descriptions of the values shown in the result after a query are displayed. */ displayBehaviour?: | sap.ui.comp.smartfield.DisplayBehaviour | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The property specifies the qualifier of the `DataPoint` or `FieldGroup` annotation from which the criticality * annotation information should be taken. */ criticalityQualifier?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * If there are value help annotations for a smart field, it is possible to specify whether the table in * the value help dialog for this field will be filled initially. The default value is `false`, which means * the table will be filled as the data fetch is not prevented. **Note:** As of version 1.78 the default * value has been changed from `true` to `false`. */ preventInitialDataFetchInValueHelpDialog?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the ControlProposal constructor. */ interface $ControlProposalSettings extends sap.ui.core.$ElementSettings { /** * By default the SmartField chooses the controls it hosts by interpreting OData meta data. This property * allows to overwrite the default behavior to some extent; for example this property allows to define that * an OData property of type Edm.Boolean is displayed as combo box. */ controlType?: | sap.ui.comp.smartfield.ControlProposalType | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Optional definition to further qualify how an object status control should be rendered. * * @since 1.34.0 */ objectStatus?: sap.ui.comp.smartfield.ObjectStatus; } /** * Describes the settings that can be provided to the ObjectStatus constructor. */ interface $ObjectStatusSettings extends sap.ui.core.$ElementSettings { /** * Optional attribute to determine the rendered state. Possible values are the numeric representations of * the enum members of annotation `com.sap.vocabularies.UI.v1.CriticalityType`: 0: None 1: Error 2: Warning * 3: Success */ criticality?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Optional attribute, which can be set to control how the criticality is visualized. */ criticalityRepresentationType?: | sap.ui.comp.smartfield.CriticalityRepresentationType | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the SmartField constructor. */ interface $SmartFieldSettings extends sap.ui.core.$ControlSettings { /** * The binding path expression used to determine the bound Entity Data Model (EDM) property. **Important:** * The `SmartField` is a metadata-driven control. Avoid direct interaction with the `value` property, as * it should be accessed or modified via the model itself. * * **Note:** Composite binding expressions for this property are not supported. **Note:** Custom formatters * for this property are not supported. The `SmartField` control usually creates its own data type based * on the service metadata for the formatting of values. Also, when a custom formatter is specified for * a property, the binding mode is automatically switched to one-way binding mode. **Note:** Named models * are not supported, only the default model (named undefined) is supported. For example, when the binding * path expression contains a `>` sign, the string preceding it is a named model and the remainder after * the `>` is the binding path. */ value?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates whether the user can interact with the control or not. **Note:** Disabled controls cannot be * focused and they are out of the tab order. */ enabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The name of an entity set for which the control manages values. This is an optional property. * * If this property is left empty, the entity set is computed by parsing the binding context path, for example, * `Tasks('id-1428419016778-51')` is parsed to `Tasks`. */ entitySet?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Indicates whether the control is in display or edit mode. * * **Note:** The `SmartField` control is metadata-driven, and this control property can be ignored if the * following applies: * * * - The bound Entity Data Model (EDM) property or its entity set are annotated with the OData V2 `sap:updatable` * annotation. * - The bound EDM property or its entity set are annotated with the `sap:creatable` annotation. * - The entity set of the bound EDM property is annotated with the OData V2 `sap:updatable-path` annotation. * * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Capabilities.V1.InsertRestrictions` * annotation. * - The bound EDM property is annotated with the `com.sap.vocabularies.Common.v1.FieldControl` annotation. * * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Capabilities.V1.UpdateRestrictions` * annotation. */ editable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Notifies the control whether controls using the `SmartField` control are editable. * * @since 1.32.0 */ contextEditable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the width of the control. */ width?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Horizontal alignment of the text. */ textAlign?: | sap.ui.core.TextAlign | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The available text direction options are LTR and RTL. By default, the control inherits the text direction * from its parent control. * * The `textDirection` property can be used when, for example, the text direction in the application is * LTR but you want a specific field to have RTL text direction. * * **Note:** The `textDirection` property is not applicable for the `SmartField` control for units of measure * use cases. * * @since 1.86.0 */ textDirection?: | sap.ui.core.TextDirection | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Text shown when no value available. */ placeholder?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * To be used in the HTML code (for example, for HTML forms that send data to the server via 'submit'). */ name?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Visualizes the validation state of the control, e.g. `Error`, `Warning`, `Success`, `Information`. * * **Note:** This method is public because of an implementation side effect and should not be used for validation * purposes as it may conflict with the `SmartField` control's own binding type validation logic based on * the underlying metadata of the bound Entity Data Model (EDM) property. Invoking the `.setValueState()` * and/or `.setValueStateText()` methods in a `change` event handle to set an error state does not prevent * an invalid value from being stored in the binding/model in two-way data binding scenarios. In addition, * it does not fire the `validationError` event, which is usually required by some upstream modules, for * example, the message manager. * * Custom validation logic must be implemented in a custom binding type rather than in a `change` event * handler. */ valueState?: | sap.ui.core.ValueState | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the text of the value state message popup. * * **Note:** This method is public because of an implementation side effect and should not be used for validation * purposes as it may conflict with the `SmartField` control's own binding type validation logic based on * the underlying metadata of the bound Entity Data Model (EDM) property. Invoking the `.setValueState()` * and/or `.setValueStateText()` methods in a `change` event handle to set an error state does not prevent * an invalid value from being stored in the binding/model in two-way data binding scenarios. In addition, * it does not fire the `validationError` event, which is usually required by some upstream modules, for * example, the message manager. * * Custom validation logic must be implemented in a custom binding type rather than in a `change` event * handler. */ valueStateText?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines whether the value state message is shown or not. */ showValueStateMessage?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Data types to be used, if the `SmartField` control is interacting with a JSON model. If the value property * of the control is bound to a property of an OData entity set, this property is not taken into consideration. * * @deprecated As of version 1.31.0. with no replacement. */ jsontype?: | sap.ui.comp.smartfield.JSONType | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates whether user input is required. * * **Note:** The `SmartField` control is metadata-driven and this property can be ignored if the following * applies: * * * - The bound Entity Data Model (EDM) property is annotated with the `Nullable` annotation. The `Nullable` * annotation is a capability of the OData service that specifies whether a value is mandatory, hence it * overrules the control's API settings. Therefore, if the `Nullable` attribute is specified as `Nullable="false"`, * a value is mandatory. * - The bound EDM property is annotated with the `com.sap.vocabularies.Common.v1.FieldControl` annotation. */ mandatory?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the highest possible number of permitted input characters that the user can enter into the text * input field. * * Computed `maxLength`: If the specified `maxLength` value is greater than the `maxLength` value specified * for the underlying bound Entity Data Model (EDM) property in the service metadata document, the `maxLength` * value of the EDM property takes precedence. Likewise, if the application code provides a binding data * type for the `value` property of the `SmartField` control and the binding data type has `maxLength` constraints * defined, this `maxLength` is also taken into consideration to compute the final `maxLength` value. * * Validation Behavior: By design, the `SmartField` control does not restrict/validate the highest number * of permitted input characters for every keystroke, but only when the text input field has changed, and * the browser focus leaves the text input field or the ENTER key is pressed. The `SmartField` control is * used more generically in broader contexts, and adding a `maxLength` attribute to the HTML text input * control may break data type formatting in two-way data-binding scenarios. Let's say the `maxLength` property * is set to 3, but the text input control has a formatter function attached to it to format the entered * value "DE" to "Germany (DE)". In this case, the formatted value will be truncated by the `maxLength` * setting. */ maxLength?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `true`, the suggestion feature for a hosted control is enabled, if the hosted control supports * it. */ showSuggestion?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `true`, a value help indicator will be displayed inside the hosted control, if the hosted control * supports this. */ showValueHelp?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `false` the label is not displayed. */ showLabel?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * This property contains the text of an associated `SmartLabel`. */ textLabel?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * This property contains the tool tip of the associated `SmartLabel` control. */ tooltipLabel?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Indicates whether the unit of measure field is visible. * * **Note:** This control property is only valid if the `SmartField` control addresses a unit of measure * composite field, for example, an amount field and its associated currency field. The field must then * be annotated with one of the following annotations: * * * - The bound Entity Data Model (EDM) property or its entity set are annotated with the OData V2 `sap:unit` * annotation. * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Measures.V1.ISOCurrency` * annotation. * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Measures.V1.Unit` * annotation. * * **Note:** The `SmartField` control is metadata-driven, and this property can be ignored if the bound * EDM property is annotated with the `com.sap.vocabularies.Common.v1.FieldControl` annotation. */ uomVisible?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates whether the unit of measure field is in display or edit mode. * * **Note:** This control property is only valid if the `SmartField` control addresses a unit of measure * composite field, for example, an amount field and its associated currency field. The field must then * be annotated with one of the following annotations: * * * - The bound Entity Data Model (EDM) property or its entity set are annotated with the OData V2 `sap:unit` * annotation. * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Measures.V1.ISOCurrency` * annotation. * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Measures.V1.Unit` * annotation. * * **Note:** The `SmartField` control is metadata-driven, and this control property can be ignored if the * following applies: * * * - The bound Entity Data Model (EDM) property or its entity set are annotated with the OData V2 `sap:updatable` * annotation. * - The bound EDM property or its entity set are annotated with the `sap:creatable` annotation. * - The entity set of the bound EDM property is annotated with the OData V2 `sap:updatable-path` annotation. * * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Capabilities.V1.InsertRestrictions` * annotation. * - The bound EDM property is annotated with the `com.sap.vocabularies.Common.v1.FieldControl` annotation. * * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Capabilities.V1.UpdateRestrictions` * annotation. */ uomEditable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enabled state of the unit, if the `SmartField` control addresses unit of measure use cases, for example, * an amount and its associated currency. */ uomEnabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Contains a URL which is used to render a link. The link is rendered, if the OData property, to which * the value property of the control is bound, is of type `Edm.String` and the `SmartField` is in display * mode. */ url?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines the context in which the layout of the `SmartField` control has to be interpreted. * * @since 1.32.0 */ controlContext?: | sap.ui.comp.smartfield.ControlContextType | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Proposes a control to be rendered. The `SmartField` control can ignore the proposal. * * @since 1.32.0 * @deprecated As of version 1.32.0. with no replacement. */ proposedControl?: | sap.ui.comp.smartfield.ControlProposalType | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates whether the control break lines (in display mode) to prevent overflow. * * @since 1.36.6 */ wrapping?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines if the mandatory check of whether the field has a value happens on the client side - `true` * or on the server side - `false`. * * **Note:** If the {@link sap.ui.comp.smartfield.SmartField#value} property of the `SmartField` control * is bound to an Entity Data Model (EDM) property of type different from Edm.String annotated as `Nullable="false"`, * the mandatory validation is performed on the client side regardless of the `clientSideMandatoryCheck` * setting. * * Example: * * * ```javascript * * * ``` * * * @since 1.38.3 */ clientSideMandatoryCheck?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates whether the value list collection is fetched in display mode from the resource path specified * in the `com.sap.vocabularies.Common.v1.ValueList` annotation. * * This collection data is used to infer a descriptive text for the value of the `SmartField` control. However, * fetching the value list collection for every `SmartField` instance individually may not be ideal in some * performance-critical scenarios. To optimize this default behavior, you can set this property to `false` * and provide the `com.sap.vocabularies.Common.v1.Text` annotation, which is used to specify the URL path * name to the Entity Data Model (EDM) property from which the descriptive text for the value of the `SmartField` * control is fetched, for example, LT (Laptop). * * **Note:** Setting this property to `false` only has an effect if the `value` property of the `SmartField` * control is bound to an Entity Data Model (EDM) property typed as `Edm.String`. In addition, applications * or frameworks have to make sure the descriptive text is fetched, for example, by expanding a navigation * property. * * @since 1.42.0 */ fetchValueListReadOnly?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates if entities related to navigation properties inside the metadata are requested. If set to `true`, * then these related entities are loaded with an `$expand` request. * * Annotations that can have navigation properties are the following: * `com.sap.vocabularies.Common.v1.Text` for text arrangements `Org.OData.Measures.V1.Unit` and `Org.OData.Measures.V1.ISOCurrency` * for units `com.sap.vocabularies.Common.v1.FieldControl` for field control * * **Note:** Independent of the `fetchValueListReadOnly` value, setting this flag to `true` requests data * from the backend. * * **Note:** The back-end request to expand the navigation properties is sent only if the entity to which * `SmartField` is bound is persisted. For transient entities, there is no back-end request since no such * data is available. * * @since 1.48 * @deprecated As of version 1.117. It is recommended the expand to be using the OData Model. */ expandNavigationProperties?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets the source from which text descriptions for `IDs` are fetched in edit mode, for example, for LT * (Laptop). * * **Note**: The `sap.ui.comp.smartfield.TextInEditModeSource.NavigationProperty` and `sap.ui.comp.smartfield.TextInEditModeSource.ValueList` * enumeration members are only supported if the following applies: * * * - The `value` property of the `SmartField` control instance is bound to an Entity Data Model (EDM) * property typed as `Edm.String` or `Edm.Guid`. * - The `com.sap.vocabularies.UI.v1.TextArrangement` annotation for the bound EDM property or entity * type is specified in the service metadata document or annotation file. * - The binding mode for the `value` property of the `SmartField` control is the two-way binding mode. * * - The field from which the description is fetched is filterable. * * **Note**: In addition, the `sap.ui.comp.smartfield.TextInEditModeSource.NavigationProperty` enumeration * member is only supported if the following applies: * * * - The EDM navigation property association is defined in the service metadata document. * - The `com.sap.vocabularies.Common.v1.Text` annotation for the bound EDM property is specified in the * service metadata document or annotation file whose `Path` attribute points to a EDM navigation property * of a lookup entity set/type whose single key property is the `ID`, which contains (among other properties) * the descriptive value. * - The lookup entity must be loaded. The lookup entity can be loaded by expanding the EDM navigation * property via a `$expand` query parameter. * - The EDM navigation property association defines a referential constraint that ties values of the * dependent editable entity type/set to the lookup entity type/set in the service metadata document. * - The EDM navigation property association end multiplicity of the lookup entity type/set is defined * as `1` in the service metadata document. There must be a single-valued navigation from the editable entity * set/type to the lookup entity set/type. * - The lookup entity type/set from which the descriptive value is fetched contains a single-key EDM * property. * * **Note**: As of version 1.82, if `SmartField` is used inside a `SmartForm`, `defaultTextInEditModeSource` * can be added as custom data to the form and it will be propagated to all smart fields that cover the * above criteria. However, if `textInEditModeSource` is added to the `SmartField` as property, it will * override the `defaultTextInEditModeSource` propagated from the `SmartForm` custom data. * * **Note**: As of version 1.107 the property will be used to configure the validation for fixed list fields * of type `ComboBox`. The values that will be considered: * - ValueList - strict validation * - ValueListWarning - non-strict validation * * @since 1.83 */ textInEditModeSource?: | sap.ui.comp.smartfield.TextInEditModeSource | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If the property is set to `false`, history values are disabled. Changes at runtime are not reflected. * The `historyEnabled` property is not applied to custom controls. * * **Note:** For {@link sap.m.ComboBox} and {@link sap.m.MultiComboBox} the history values are disabled * by default. To enable them for these controls, you need to set the `historyEnabled` property to `true`. * * @since 1.84 */ historyEnabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies the importance of the field. Applicable only when the `SmartField` is used inside `SmartForm`. * * @since 1.87 */ importance?: | sap.ui.comp.smartfield.Importance | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If the property is set to `true`, a standard validation for {@link sap.m.ComboBox} is performed. An inner * control {@link sap.m.ComboBox} is created and the binding is to `selectedKey`. Changes at runtime are * not reflected. * * **Note:** This property switches the control in legacy mode. If set to `true` this will override any * setting to `textInEditModeSource` property regarding ComboBox validation. * * **Note:** If the property is set to `false`, the inner control is {@link sap.ui.comp.smartfield.ComboBox } * and the binding is to `enteredValue`. In this case, any entered value is valid irrespective of whether * it's in the predefined list or not. * * **Note:** This property is applicable only for fixed-value scenarios. * * @since 1.88 */ fixedValueListValidationEnabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls if a query is sent to the backend in case of an empty string. * * @since 1.124 */ suppressEmptyStringRequest?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls if the title is taken from the label of the main property or from the label of the value list. * * @since 1.132 */ valueHelpTitleSource?: | sap.ui.comp.smartfield.ValueHelpTitleSource | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls if changes to the InParameters should trigger a description request. * * @since 1.142 */ refreshOnInParamChange?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Optional configuration for `SmartField`. * * **Note**: By default, the value of the `displayBehaviour` property is not evaluated in edit mode. To * enable this feature in edit mode, set the `textInEditModeSource` control property to a non-default value. */ configuration?: sap.ui.comp.smartfield.Configuration; /** * Proposes a control to be rendered. The `SmartField` control can ignore the proposal. * * @since 1.32.0 * @deprecated As of version 1.34.0. with no replacement. */ controlProposal?: sap.ui.comp.smartfield.ControlProposal; /** * The Semantic Object Controller allows the user to specify and overwrite functionality for semantic object * navigation. */ semanticObjectController?: sap.ui.comp.navpopover.SemanticObjectController; /** * Association to controls / IDs which label this control (see WAI-ARIA attribute `aria-labelledby`). * * @since 1.34.2 */ ariaLabelledBy?: Array; /** * Association to controls / IDs that describe this control (see WAI-ARIA attribute `aria-describedby`). * * @since 1.96 */ ariaDescribedBy?: Array; /** * The OData entity set is either derived from the control's binding context or from control's entity set * property, if a value for it is specified. In both cases this event is fired. */ entitySetFound?: (oEvent: SmartField$EntitySetFoundEvent) => void; /** * The event is fired after the text in the field has been changed and the focus leaves the field, or after * the Enter key has been pressed. * * **Note:** This event is fired even if the value of the text input field is subject to data type constraints * and the constraints are violated. Also, the invalid value is not stored in the binding/model. */ change?: (oEvent: SmartField$ChangeEvent) => void; /** * Fired after the text in the field has been changed by user interaction in combination with one of the * following actions: * * * - The focus leaves the field * - The Enter key is pressed * - The value is selected from the suggestions list * - The value is selected from the `ValueHelpDialog` * * If the value of the text input field is subject to data type constraints, the constraints must be fulfilled, * which implies the value is stored in the binding/model before the event is fired. */ changeModelValue?: (oEvent: SmartField$ChangeModelValueEvent) => void; /** * The event is fired after the smart field has calculated its metadata. */ initialise?: (oEvent: sap.ui.base.Event) => void; /** * The event is fired after the visibility of the control has changed. */ visibleChanged?: (oEvent: SmartField$VisibleChangedEvent) => void; /** * Fired when the control is rendered if the value of `editable` property of the control has changed. * * @since 1.30.0 */ editableChanged?: (oEvent: SmartField$EditableChangedEvent) => void; /** * Fired when the control is rendered if the value of `contextEditable` property of the control has changed. * * @since 1.32.0 */ contextEditableChanged?: ( oEvent: SmartField$ContextEditableChangedEvent ) => void; /** * The event is fired after the inner controls have been toggled. * * @since 1.117.0 */ modeToggled?: (oEvent: sap.ui.base.Event) => void; /** * The event is fired after the inner controls have been created. */ innerControlsCreated?: (oEvent: sap.ui.base.Event) => void; /** * The event is fired when after selection of values with value help or auto-suggest, the model is updated * with the selected data. * * @since 1.31.0 */ valueListChanged?: (oEvent: SmartField$ValueListChangedEvent) => void; /** * Fires when the user triggers the link control or taps/clicks on an active title of the object identifier * control. When handler attached, the rendered control is `sap.m.Link` * * @since 1.36.0 * @deprecated As of version 1.116.0. with no replacement. */ press?: (oEvent: sap.ui.base.Event) => void; } /** * Parameters of the SmartField#change event. */ interface SmartField$ChangeEventParameters { /** * The current value inside the text field * * **Note:** This value is the formatted value, and in some cases it might differ from the value stored * in the binding/model. Usually, the value that is sent to the back-end system should be the value stored * in the binding/model, which is the parsed and validated value. */ value?: string; /** * The new value inside the text field */ newValue?: string; } /** * Parameters of the SmartField#changeModelValue event. */ interface SmartField$ChangeModelValueEventParameters { /** * Indicates whether the field quantity field has changed */ valueChanged?: boolean; /** * Last value of the `valueState` property of the field quantity field */ valueLastValueState?: boolean; /** * Indicates whether the field unit field has changed */ unitChanged?: boolean; /** * Last value of the `valueState` property of the field unit field */ unitLastValueState?: sap.ui.core.ValueState; } /** * Parameters of the SmartField#contextEditableChanged event. */ interface SmartField$ContextEditableChangedEventParameters { /** * The value of the context editable property of the control */ editable?: boolean; } /** * Parameters of the SmartField#editableChanged event. */ interface SmartField$EditableChangedEventParameters { /** * If `true`, the control is in edit mode */ editable?: boolean; } /** * Parameters of the SmartField#entitySetFound event. */ interface SmartField$EntitySetFoundEventParameters { /** * The path to the found entity set */ entitySet?: string; } /** * Parameters of the SmartField#initialise event. */ interface SmartField$InitialiseEventParameters {} /** * Parameters of the SmartField#innerControlsCreated event. */ interface SmartField$InnerControlsCreatedEventParameters {} /** * Parameters of the SmartField#linkPress event. */ interface SmartField$LinkPressEventParameters {} /** * Parameters of the SmartField#modeToggled event. */ interface SmartField$ModeToggledEventParameters {} /** * Parameters of the SmartField#press event. * * @deprecated As of version 1.116.0. with no replacement. */ interface SmartField$PressEventParameters {} /** * Parameters of the SmartField#valueListChanged event. */ interface SmartField$ValueListChangedEventParameters { /** * An array of selected values */ changes?: sap.ui.core.Control[]; } /** * Parameters of the SmartField#visibleChanged event. */ interface SmartField$VisibleChangedEventParameters { /** * If `true`, the control is visible */ visible?: boolean; } /** * Extends the functionalities in sap.m.ComboBox * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ class ComboBox extends sap.m.ComboBox { /** * Constructor for a new `SmartField/ComboBox`. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ protected constructor( /** * Initial settings for the new control */ mSettings?: sap.ui.comp.smartfield.$ComboBoxSettings ); /** * Constructor for a new `SmartField/ComboBox`. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ protected constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string, /** * Initial settings for the new control */ mSettings?: sap.ui.comp.smartfield.$ComboBoxSettings ); /** * Creates a new subclass of class sap.ui.comp.smartfield.ComboBox with name `sClassName` and enriches it * with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.m.ComboBox.extend}. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartfield.ComboBox. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getEnteredValue enteredValue}. * * * @returns Value of property `enteredValue` */ getEnteredValue(): string; /** * Gets current value of property {@link #getRealValue realValue}. * * Property works the same as sap.m.Input control `value` * * * @returns Value of property `realValue` */ getRealValue(): string; /** * Gets current value of property {@link #getSelectedKey selectedKey}. * * Key of the selected item. * * **Note:** If duplicate keys exist, the first item matching the key is used. * * * @returns Value of property `selectedKey` */ getSelectedKey(): string; /** * Gets current value of property {@link #getValueTextArrangement valueTextArrangement}. * * Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType` * from the ValueList property. * * Default value is `empty string`. * * * @returns Value of property `valueTextArrangement` */ getValueTextArrangement(): string; /** * Sets a new value for property {@link #getEnteredValue enteredValue}. * * 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 */ setEnteredValue( /** * New value for property `enteredValue` */ sEnteredValue?: string ): this; /** * Sets a new value for property {@link #getRealValue realValue}. * * Property works the same as sap.m.Input control `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 */ setRealValue( /** * New value for property `realValue` */ sRealValue?: string ): this; /** * Sets a new value for property {@link #getSelectedKey selectedKey}. * * Key of the selected item. * * **Note:** If duplicate keys exist, the first item matching the key is used. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setSelectedKey( /** * New value for property `selectedKey` */ sSelectedKey?: string ): this; /** * Sets a new value for property {@link #getValueTextArrangement valueTextArrangement}. * * Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType` * from the ValueList property. * * 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 */ setValueTextArrangement( /** * New value for property `valueTextArrangement` */ sValueTextArrangement?: string ): this; } /** * The configuration allows to further define the behavior of a `SmartField`. */ class Configuration extends sap.ui.core.Element { /** * Constructor for a new `Smartfield`/`Configuration`. * * 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.ui.comp.smartfield.$ConfigurationSettings ); /** * Constructor for a new `Smartfield`/`Configuration`. * * 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.ui.comp.smartfield.$ConfigurationSettings ); /** * Creates a new subclass of class sap.ui.comp.smartfield.Configuration with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartfield.Configuration. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getControlType controlType}. * * By default the SmartField chooses the controls it hosts by interpreting OData metadata. This property * allows to overwrite the default behavior to some extent. For example makes it possible to define that * an OData property of type Edm.Boolean is displayed as a combo box. * * * @returns Value of property `controlType` */ getControlType(): sap.ui.comp.smartfield.ControlType; /** * Gets current value of property {@link #getCriticalityQualifier criticalityQualifier}. * * The property specifies the qualifier of the `DataPoint` or `FieldGroup` annotation from which the criticality * annotation information should be taken. * * * @returns Value of property `criticalityQualifier` */ getCriticalityQualifier(): string; /** * Gets current value of property {@link #getDisplayBehaviour displayBehaviour}. * * The property specifies how value help, that is available for input fields, is presented. For example, * it specifies whether the descriptions of the values shown in the result after a query are displayed. * * * @returns Value of property `displayBehaviour` */ getDisplayBehaviour(): sap.ui.comp.smartfield.DisplayBehaviour; /** * Gets current value of property {@link #getPreventInitialDataFetchInValueHelpDialog preventInitialDataFetchInValueHelpDialog}. * * If there are value help annotations for a smart field, it is possible to specify whether the table in * the value help dialog for this field will be filled initially. The default value is `false`, which means * the table will be filled as the data fetch is not prevented. **Note:** As of version 1.78 the default * value has been changed from `true` to `false`. * * Default value is `false`. * * * @returns Value of property `preventInitialDataFetchInValueHelpDialog` */ getPreventInitialDataFetchInValueHelpDialog(): boolean; /** * Sets a new value for property {@link #getControlType controlType}. * * By default the SmartField chooses the controls it hosts by interpreting OData metadata. This property * allows to overwrite the default behavior to some extent. For example makes it possible to define that * an OData property of type Edm.Boolean is displayed as a combo box. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setControlType( /** * New value for property `controlType` */ sControlType?: sap.ui.comp.smartfield.ControlType ): this; /** * Sets a new value for property {@link #getCriticalityQualifier criticalityQualifier}. * * The property specifies the qualifier of the `DataPoint` or `FieldGroup` annotation from which the criticality * annotation information should be taken. * * 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 */ setCriticalityQualifier( /** * New value for property `criticalityQualifier` */ sCriticalityQualifier?: string ): this; /** * Sets a new value for property {@link #getDisplayBehaviour displayBehaviour}. * * The property specifies how value help, that is available for input fields, is presented. For example, * it specifies whether the descriptions of the values shown in the result after a query are displayed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setDisplayBehaviour( /** * New value for property `displayBehaviour` */ sDisplayBehaviour?: sap.ui.comp.smartfield.DisplayBehaviour ): this; /** * Sets a new value for property {@link #getPreventInitialDataFetchInValueHelpDialog preventInitialDataFetchInValueHelpDialog}. * * If there are value help annotations for a smart field, it is possible to specify whether the table in * the value help dialog for this field will be filled initially. The default value is `false`, which means * the table will be filled as the data fetch is not prevented. **Note:** As of version 1.78 the default * value has been changed from `true` to `false`. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setPreventInitialDataFetchInValueHelpDialog( /** * New value for property `preventInitialDataFetchInValueHelpDialog` */ bPreventInitialDataFetchInValueHelpDialog?: boolean ): this; } /** * Proposes a control to be rendered. The smart field may ignore the proposal. */ class ControlProposal extends sap.ui.core.Element { /** * Constructor for a new `smartfield/ControlProposal`. * * 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.ui.comp.smartfield.$ControlProposalSettings ); /** * Constructor for a new `smartfield/ControlProposal`. * * 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.ui.comp.smartfield.$ControlProposalSettings ); /** * Creates a new subclass of class sap.ui.comp.smartfield.ControlProposal with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.comp.smartfield.ControlProposal >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartfield.ControlProposal. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Destroys the objectStatus in the aggregation {@link #getObjectStatus objectStatus}. * * @since 1.34.0 * * @returns Reference to `this` in order to allow method chaining */ destroyObjectStatus(): this; /** * Gets current value of property {@link #getControlType controlType}. * * By default the SmartField chooses the controls it hosts by interpreting OData meta data. This property * allows to overwrite the default behavior to some extent; for example this property allows to define that * an OData property of type Edm.Boolean is displayed as combo box. * * Default value is `None`. * * * @returns Value of property `controlType` */ getControlType(): sap.ui.comp.smartfield.ControlProposalType; /** * Gets content of aggregation {@link #getObjectStatus objectStatus}. * * Optional definition to further qualify how an object status control should be rendered. * * @since 1.34.0 */ getObjectStatus(): sap.ui.comp.smartfield.ObjectStatus; /** * Sets a new value for property {@link #getControlType controlType}. * * By default the SmartField chooses the controls it hosts by interpreting OData meta data. This property * allows to overwrite the default behavior to some extent; for example this property allows to define that * an OData property of type Edm.Boolean is displayed as combo box. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `None`. * * * @returns Reference to `this` in order to allow method chaining */ setControlType( /** * New value for property `controlType` */ sControlType?: sap.ui.comp.smartfield.ControlProposalType ): this; /** * Sets the aggregated {@link #getObjectStatus objectStatus}. * * @since 1.34.0 * * @returns Reference to `this` in order to allow method chaining */ setObjectStatus( /** * The objectStatus to set */ oObjectStatus: sap.ui.comp.smartfield.ObjectStatus ): this; } /** * Defines a possible object status control to be rendered. The smart field may ignore the proposal. */ class ObjectStatus extends sap.ui.core.Element { /** * Constructor for a new `SmartField/ObjectStatus` to be used in the `controlProposal` configuration * * 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.ui.comp.smartfield.$ObjectStatusSettings ); /** * Constructor for a new `SmartField/ObjectStatus` to be used in the `controlProposal` configuration * * 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.ui.comp.smartfield.$ObjectStatusSettings ); /** * Creates a new subclass of class sap.ui.comp.smartfield.ObjectStatus with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartfield.ObjectStatus. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getCriticality criticality}. * * Optional attribute to determine the rendered state. Possible values are the numeric representations of * the enum members of annotation `com.sap.vocabularies.UI.v1.CriticalityType`: 0: None 1: Error 2: Warning * 3: Success * * * @returns Value of property `criticality` */ getCriticality(): any; /** * Gets current value of property {@link #getCriticalityRepresentationType criticalityRepresentationType}. * * Optional attribute, which can be set to control how the criticality is visualized. * * Default value is `WithIcon`. * * * @returns Value of property `criticalityRepresentationType` */ getCriticalityRepresentationType(): sap.ui.comp.smartfield.CriticalityRepresentationType; /** * Sets a new value for property {@link #getCriticality criticality}. * * Optional attribute to determine the rendered state. Possible values are the numeric representations of * the enum members of annotation `com.sap.vocabularies.UI.v1.CriticalityType`: 0: None 1: Error 2: Warning * 3: Success * * 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 */ setCriticality( /** * New value for property `criticality` */ oCriticality?: any ): this; /** * Sets a new value for property {@link #getCriticalityRepresentationType criticalityRepresentationType}. * * Optional attribute, which can be set to control how the criticality is visualized. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `WithIcon`. * * * @returns Reference to `this` in order to allow method chaining */ setCriticalityRepresentationType( /** * New value for property `criticalityRepresentationType` */ sCriticalityRepresentationType?: sap.ui.comp.smartfield.CriticalityRepresentationType ): this; } /** * The `SmartField` control interprets metadata that represents entity-relationship models, data types, * service capabilities, and annotations in OData services to automatically generate the underlying inner * controls and reduce the amount of code needed for developing applications. * * Binding and Context: **Important:** You must always use the standard two-way binding and provide binding * context. In some cases, the OData entity is derived from the control's binding context. The OData entity * property that is changed or displayed with the control is derived from the `value` property of the control. * * Structure : The `SmartField` control contains a basic UI element and an optional label. In `display` * mode the following UI elements are available to be rendered depending on the metadata: * - {@link sap.m.Text Text} * - {@link sap.m.Link Link} * - {@link sap.ui.comp.navpopover.SmartLink SmartLink} In `edit` mode, the available UI elements * are: * - One or two {@link sap.m.Input Input} fields (with or without a {@link sap.ui.comp.valuehelpdialog.ValueHelpDialog ValueHelpDialog}) * * - {@link sap.m.Select Select} * - {@link sap.m.ComboBox ComboBox} * - {@link sap.m.TextArea TextArea} * - {@link sap.m.CheckBox Checkbox} * - {@link sap.m.DatePicker DatePicker} * - {@link sap.m.DateTimePicker DateTimePicker} * - {@link sap.m.TimePicker TimePicker} The `SmartField` comes with additional built-in features, * such as autocomplete and suggestions, value help dialog, recently used and recommended values, textInEditModeSource, * validation, and message handling. * * Usage: When to use * - You use an OData service for your app (only OData version 2). * - You use the smart table and your app is not performance critical. The `SmartField` control offers * more flexibility than the controls provided directly by the smart table, especially for editing. * - You use a smart form. * * When not to use * - You are not using OData version 2. * - You need a different control for entering or displaying data, such as multi input, a multi combo * box, step input, a radio button, or a title. In this case, use the corresponding control directly. * - You need a different dialog for offering value help, such as the select dialog or table select dialog. * * - You use the smart table and your app is performance critical. In this case, the controls offered * directly by the smart table offer less flexibility but better performance. * - You need custom validations. * * **Important:** Keep in mind that the `SmartField` control, like all SAPUI5 smart controls, retrieves * and analyzes the metadata and annotations of OData services. **The OData metadata is its primary API. * These OData services are not part of the SAPUI5 framework and are usually maintained by the backend developers * of your application.** * * With time, `SmartField` can evolve and acquire new features. This means that its behavior or functionalities * may change if the annotations that define this change are maintained in your backend metadata. To benefit * from the new functionalities, your application should be able to adapt the backend metadata. **Therefore, * we recommend using `SmartField` only if you have control over the metadata of your application.** */ class SmartField extends sap.ui.core.Control implements sap.ui.core.IFormContent, sap.ui.core.ISemanticFormContent { __implements__sap_ui_core_IFormContent: boolean; __implements__sap_ui_core_ISemanticFormContent: boolean; /** * Constructor for a new `sap.ui.comp.smartfield.SmartField`. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/4864403f08c64ca08a2b0ee1fa9cb5e2 Smart Field} * {@link fiori:https://experience.sap.com/fiori-design-web/smart-field/ Smart Field} */ constructor( /** * Initial settings for the new control */ mSettings?: sap.ui.comp.smartfield.$SmartFieldSettings ); /** * Constructor for a new `sap.ui.comp.smartfield.SmartField`. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/4864403f08c64ca08a2b0ee1fa9cb5e2 Smart Field} * {@link fiori:https://experience.sap.com/fiori-design-web/smart-field/ Smart Field} */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string, /** * Initial settings for the new control */ mSettings?: sap.ui.comp.smartfield.$SmartFieldSettings ); /** * Creates a new subclass of class sap.ui.comp.smartfield.SmartField with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartfield.SmartField. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Calculates the paths to the annotations used by the `SmartField` control. * * * @returns The resulting paths are returned */ static getSupportedAnnotationPaths( /** * The given OData meta model */ oMetaModel: sap.ui.model.odata.ODataMetaModel, /** * The given entity set */ oEntitySet: object, /** * The path identifying the OData property to which the value property of the `SmartField` control is bound */ sValueBinding: string, /** * If set to `true`, no properties are returned */ bNavigationPathsOnly: boolean ): Record; /** * Adds some ariaDescribedBy into the association {@link #getAriaDescribedBy ariaDescribedBy}. * * @since 1.96 * * @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}. * * @since 1.34.2 * * @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; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * The event is fired after the text in the field has been changed and the focus leaves the field, or after * the Enter key has been pressed. * * **Note:** This event is fired even if the value of the text input field is subject to data type constraints * and the constraints are violated. Also, the invalid value is not stored in the binding/model. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: SmartField$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * The event is fired after the text in the field has been changed and the focus leaves the field, or after * the Enter key has been pressed. * * **Note:** This event is fired even if the value of the text input field is subject to data type constraints * and the constraints are violated. Also, the invalid value is not stored in the binding/model. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartField$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:changeModelValue changeModelValue} event of * this `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * Fired after the text in the field has been changed by user interaction in combination with one of the * following actions: * * * - The focus leaves the field * - The Enter key is pressed * - The value is selected from the suggestions list * - The value is selected from the `ValueHelpDialog` * * If the value of the text input field is subject to data type constraints, the constraints must be fulfilled, * which implies the value is stored in the binding/model before the event is fired. * * * @returns Reference to `this` in order to allow method chaining */ attachChangeModelValue( /** * 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: SmartField$ChangeModelValueEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:changeModelValue changeModelValue} event of * this `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * Fired after the text in the field has been changed by user interaction in combination with one of the * following actions: * * * - The focus leaves the field * - The Enter key is pressed * - The value is selected from the suggestions list * - The value is selected from the `ValueHelpDialog` * * If the value of the text input field is subject to data type constraints, the constraints must be fulfilled, * which implies the value is stored in the binding/model before the event is fired. * * * @returns Reference to `this` in order to allow method chaining */ attachChangeModelValue( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartField$ChangeModelValueEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contextEditableChanged contextEditableChanged } * event of this `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * Fired when the control is rendered if the value of `contextEditable` property of the control has changed. * * @since 1.32.0 * * @returns Reference to `this` in order to allow method chaining */ attachContextEditableChanged( /** * 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: SmartField$ContextEditableChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:contextEditableChanged contextEditableChanged } * event of this `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * Fired when the control is rendered if the value of `contextEditable` property of the control has changed. * * @since 1.32.0 * * @returns Reference to `this` in order to allow method chaining */ attachContextEditableChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartField$ContextEditableChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:editableChanged editableChanged} event of this * `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * Fired when the control is rendered if the value of `editable` property of the control has changed. * * @since 1.30.0 * * @returns Reference to `this` in order to allow method chaining */ attachEditableChanged( /** * 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: SmartField$EditableChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:editableChanged editableChanged} event of this * `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * Fired when the control is rendered if the value of `editable` property of the control has changed. * * @since 1.30.0 * * @returns Reference to `this` in order to allow method chaining */ attachEditableChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartField$EditableChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:entitySetFound entitySetFound} event of this * `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * The OData entity set is either derived from the control's binding context or from control's entity set * property, if a value for it is specified. In both cases this event is fired. * * * @returns Reference to `this` in order to allow method chaining */ attachEntitySetFound( /** * 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: SmartField$EntitySetFoundEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:entitySetFound entitySetFound} event of this * `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * The OData entity set is either derived from the control's binding context or from control's entity set * property, if a value for it is specified. In both cases this event is fired. * * * @returns Reference to `this` in order to allow method chaining */ attachEntitySetFound( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartField$EntitySetFoundEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialise initialise} event of this `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * The event is fired after the smart field has calculated its metadata. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialise( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialise initialise} event of this `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * The event is fired after the smart field has calculated its metadata. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialise( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:innerControlsCreated innerControlsCreated} event * of this `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * The event is fired after the inner controls have been created. * * * @returns Reference to `this` in order to allow method chaining */ attachInnerControlsCreated( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:innerControlsCreated innerControlsCreated} event * of this `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * The event is fired after the inner controls have been created. * * * @returns Reference to `this` in order to allow method chaining */ attachInnerControlsCreated( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:modeToggled modeToggled} event of this `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * The event is fired after the inner controls have been toggled. * * @since 1.117.0 * * @returns Reference to `this` in order to allow method chaining */ attachModeToggled( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:modeToggled modeToggled} event of this `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * The event is fired after the inner controls have been toggled. * * @since 1.117.0 * * @returns Reference to `this` in order to allow method chaining */ attachModeToggled( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * Fires when the user triggers the link control or taps/clicks on an active title of the object identifier * control. When handler attached, the rendered control is `sap.m.Link` * * @since 1.36.0 * @deprecated As of version 1.116.0. with no replacement. * * @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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:press press} event of this `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * Fires when the user triggers the link control or taps/clicks on an active title of the object identifier * control. When handler attached, the rendered control is `sap.m.Link` * * @since 1.36.0 * @deprecated As of version 1.116.0. with no replacement. * * @returns Reference to `this` in order to allow method chaining */ attachPress( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:valueListChanged valueListChanged} event of * this `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * The event is fired when after selection of values with value help or auto-suggest, the model is updated * with the selected data. * * @since 1.31.0 * * @returns Reference to `this` in order to allow method chaining */ attachValueListChanged( /** * 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: SmartField$ValueListChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:valueListChanged valueListChanged} event of * this `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * The event is fired when after selection of values with value help or auto-suggest, the model is updated * with the selected data. * * @since 1.31.0 * * @returns Reference to `this` in order to allow method chaining */ attachValueListChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartField$ValueListChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:visibleChanged visibleChanged} event of this * `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * The event is fired after the visibility of the control has changed. * * * @returns Reference to `this` in order to allow method chaining */ attachVisibleChanged( /** * 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: SmartField$VisibleChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:visibleChanged visibleChanged} event of this * `sap.ui.comp.smartfield.SmartField`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfield.SmartField` itself. * * The event is fired after the visibility of the control has changed. * * * @returns Reference to `this` in order to allow method chaining */ attachVisibleChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartField$VisibleChangedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfield.SmartField` itself */ oListener?: object ): this; /** * Checks whether a client error has been detected in edit mode. Additionally the error message is shown, * if this is not the case already. * * This method is typically used to check whether the value of every inner text input field in edit mode * is subject to data type constraints and whether the constraints are fulfilled. * * A data type constraint for a bound Entity Data Model (EDM) property can be violated in many ways, for * example: * * * - The `Nullable` constraint for an EDM property typed as `Edm.String` is violated. * - A user input is invalid for the bound EDM property typed as `Edm.DateTime`. * * If this happens, the following applies: * * * - A validation error state is set on the text input field. * - A validation error message is displayed for the text input field. * - The validation error message (possibly generated by a user input) is added to a `sap.ui.core.message.MessageManager` * object instance if, for example, a view object instance is registered to it. * - The inner private text input field fires a {@link sap.ui.base.EventProvider#event:validationError}, * or {@link sap.ui.base.EventProvider#event:parseError} event. * * @deprecated As of version 1.64. replaced by {@link sap.ui.comp.smartfield.SmartField#checkValuesValidity} * * @returns `true`, if a client error has been detected, `false` otherwise */ checkClientError( /** * Settings */ oSettings?: { /** * Indicates whether client error checks are performed for the current value regardless of the current error * state of the control. If the `handleSuccess` setting is set to `true`, the text input field fires a {@link sap.ui.base.EventProvider#event:validationSuccess } * if its validation passes. */ handleSuccess?: boolean; } ): boolean; /** * Checks the validity of the values for the given control. * * @since 1.90 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Indicates validity of the values */ checkUnitValidity( /** * Additional settings */ oSettings?: Object ): boolean; /** * Checks whether the value of every inner text input field in edit mode is valid. * * This method is typically used to check whether the value of every inner text input field in edit mode * is subject to data type constraints and whether the constraints are fulfilled. * * **Note:** In some scenarios, invoking this method may also trigger a back-end request to check whether * the value is valid. * * A data type constraint for a bound Entity Data Model (EDM) property can be violated in many ways, for * example: * * * - The `Nullable` constraint for an EDM property typed as `Edm.String` is violated. * - A user input is invalid for the bound EDM property typed as `Edm.DateTime`. * * If this happens, the following applies: * * * - A validation error state is set on the text input field. * - A validation error message is displayed for the text input field. * - The validation error message (possibly generated by a user input) is added to a `sap.ui.core.message.MessageManager` * object instance if, for example, a view object instance is registered to it. * - The inner private text input field fires a {@link sap.ui.base.EventProvider#event:validationError}, * or {@link sap.ui.base.EventProvider#event:parseError} event. Note that the events are fired synchronously * if the value is validated on client side or asynchronously if, for example, the value is validated on * back-end side. * * The inner private text input field fires a {@link sap.ui.base.EventProvider#event:validationSuccess } * if its validation passes. * * **Note:** In display mode, this method always returns a fulfilled `Promise` object. * * **Note:** In two-way data binding scenarios, it is usually not necessary to invoke this method explicitly * to validate user input, as the data type validation is done automatically when the value in the input * field has changed and the focus leaves the text input field or the enter key is pressed. However, in * two-way data binding scenarios, this method may be used to check whether a value is valid before submitting * it to the back-end system. * * @since 1.64 * * @returns A fulfilled `Promise` object or a `Promise` object to be fulfilled if the value of every text * input field is valid, otherwise a rejected `Promise` object or a `Promise` object to be rejected */ checkValuesValidity( /** * Settings */ oSettings?: { /** * Indicates whether client error checks are performed for the current value regardless of the current error * state of the control. If the `handleSuccess` setting is set to `false`, the text input field will not * fire a {@link sap.ui.base.EventProvider#event:validationSuccess} if its validation passes. */ handleSuccess?: boolean; } ): Promise; /** * Destroys the configuration in the aggregation {@link #getConfiguration configuration}. * * * @returns Reference to `this` in order to allow method chaining */ destroyConfiguration(): this; /** * Destroys the controlProposal in the aggregation {@link #getControlProposal controlProposal}. * * @since 1.32.0 * @deprecated As of version 1.34.0. with no replacement. * * @returns Reference to `this` in order to allow method chaining */ destroyControlProposal(): this; /** * Destroys the semanticObjectController in the aggregation {@link #getSemanticObjectController semanticObjectController}. * * * @returns Reference to `this` in order to allow method chaining */ destroySemanticObjectController(): this; /** * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.comp.smartfield.SmartField`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartField$ChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:changeModelValue changeModelValue} event of * this `sap.ui.comp.smartfield.SmartField`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachChangeModelValue( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartField$ChangeModelValueEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:contextEditableChanged contextEditableChanged } * event of this `sap.ui.comp.smartfield.SmartField`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.32.0 * * @returns Reference to `this` in order to allow method chaining */ detachContextEditableChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartField$ContextEditableChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:editableChanged editableChanged} event of * this `sap.ui.comp.smartfield.SmartField`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.30.0 * * @returns Reference to `this` in order to allow method chaining */ detachEditableChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartField$EditableChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:entitySetFound entitySetFound} event of this * `sap.ui.comp.smartfield.SmartField`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachEntitySetFound( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartField$EntitySetFoundEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:initialise initialise} event of this `sap.ui.comp.smartfield.SmartField`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachInitialise( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:innerControlsCreated innerControlsCreated } * event of this `sap.ui.comp.smartfield.SmartField`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachInnerControlsCreated( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:modeToggled modeToggled} event of this `sap.ui.comp.smartfield.SmartField`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.117.0 * * @returns Reference to `this` in order to allow method chaining */ detachModeToggled( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:press press} event of this `sap.ui.comp.smartfield.SmartField`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.36.0 * @deprecated As of version 1.116.0. with no replacement. * * @returns Reference to `this` in order to allow method chaining */ detachPress( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:valueListChanged valueListChanged} event of * this `sap.ui.comp.smartfield.SmartField`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.31.0 * * @returns Reference to `this` in order to allow method chaining */ detachValueListChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartField$ValueListChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:visibleChanged visibleChanged} event of this * `sap.ui.comp.smartfield.SmartField`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachVisibleChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartField$VisibleChangedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:change change} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireChange( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartfield.SmartField$ChangeEventParameters ): this; /** * Fires event {@link #event:changeModelValue changeModelValue} 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 */ fireChangeModelValue( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartfield.SmartField$ChangeModelValueEventParameters ): this; /** * Fires event {@link #event:contextEditableChanged contextEditableChanged} to attached listeners. * * @since 1.32.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireContextEditableChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartfield.SmartField$ContextEditableChangedEventParameters ): this; /** * Fires event {@link #event:editableChanged editableChanged} to attached listeners. * * @since 1.30.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireEditableChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartfield.SmartField$EditableChangedEventParameters ): this; /** * Fires event {@link #event:entitySetFound entitySetFound} 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 */ fireEntitySetFound( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartfield.SmartField$EntitySetFoundEventParameters ): this; /** * Fires event {@link #event:initialise initialise} 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 */ fireInitialise( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:innerControlsCreated innerControlsCreated} 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 */ fireInnerControlsCreated( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:modeToggled modeToggled} to attached listeners. * * @since 1.117.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireModeToggled( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:press press} to attached listeners. * * @since 1.36.0 * @deprecated As of version 1.116.0. with no replacement. * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ firePress( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:valueListChanged valueListChanged} to attached listeners. * * @since 1.31.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireValueListChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartfield.SmartField$ValueListChangedEventParameters ): this; /** * Fires event {@link #event:visibleChanged visibleChanged} 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 */ fireVisibleChanged( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartfield.SmartField$VisibleChangedEventParameters ): this; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaDescribedBy ariaDescribedBy}. * * @since 1.96 */ getAriaDescribedBy(): sap.ui.core.ID[]; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. * * @since 1.34.2 */ getAriaLabelledBy(): sap.ui.core.ID[]; /** * Gets current value of property {@link #getClientSideMandatoryCheck clientSideMandatoryCheck}. * * Determines if the mandatory check of whether the field has a value happens on the client side - `true` * or on the server side - `false`. * * **Note:** If the {@link sap.ui.comp.smartfield.SmartField#value} property of the `SmartField` control * is bound to an Entity Data Model (EDM) property of type different from Edm.String annotated as `Nullable="false"`, * the mandatory validation is performed on the client side regardless of the `clientSideMandatoryCheck` * setting. * * Example: * * * ```javascript * * * ``` * * * Default value is `true`. * * @since 1.38.3 * * @returns Value of property `clientSideMandatoryCheck` */ getClientSideMandatoryCheck(): boolean; /** * Gets content of aggregation {@link #getConfiguration configuration}. * * Optional configuration for `SmartField`. * * **Note**: By default, the value of the `displayBehaviour` property is not evaluated in edit mode. To * enable this feature in edit mode, set the `textInEditModeSource` control property to a non-default value. */ getConfiguration(): sap.ui.comp.smartfield.Configuration; /** * Gets current value of property {@link #getContextEditable contextEditable}. * * Notifies the control whether controls using the `SmartField` control are editable. * * Default value is `true`. * * @since 1.32.0 * * @returns Value of property `contextEditable` */ getContextEditable(): boolean; /** * Gets current value of property {@link #getControlContext controlContext}. * * Defines the context in which the layout of the `SmartField` control has to be interpreted. * * Default value is `None`. * * @since 1.32.0 * * @returns Value of property `controlContext` */ getControlContext(): sap.ui.comp.smartfield.ControlContextType; /** * Gets content of aggregation {@link #getControlProposal controlProposal}. * * Proposes a control to be rendered. The `SmartField` control can ignore the proposal. * * @since 1.32.0 * @deprecated As of version 1.34.0. with no replacement. */ getControlProposal(): sap.ui.comp.smartfield.ControlProposal; /** * Returns the OData property to which the `value` property of the control is bound. * * * @returns The OData property. */ getDataProperty(): Record | null; /** * Returns the EDM data type of the OData property to which the value property of the control is bound. * If no model or no OData property is available `null` is returned. * * * @returns The data type to which the value property is bound. */ getDataType(): string; /** * Gets current value of property {@link #getEditable editable}. * * Indicates whether the control is in display or edit mode. * * **Note:** The `SmartField` control is metadata-driven, and this control property can be ignored if the * following applies: * * * - The bound Entity Data Model (EDM) property or its entity set are annotated with the OData V2 `sap:updatable` * annotation. * - The bound EDM property or its entity set are annotated with the `sap:creatable` annotation. * - The entity set of the bound EDM property is annotated with the OData V2 `sap:updatable-path` annotation. * * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Capabilities.V1.InsertRestrictions` * annotation. * - The bound EDM property is annotated with the `com.sap.vocabularies.Common.v1.FieldControl` annotation. * * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Capabilities.V1.UpdateRestrictions` * annotation. * * Default value is `true`. * * * @returns Value of property `editable` */ getEditable(): boolean; /** * Gets current value of property {@link #getEnabled enabled}. * * Indicates whether the user can interact with the control or not. **Note:** Disabled controls cannot be * focused and they are out of the tab order. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getEntitySet entitySet}. * * The name of an entity set for which the control manages values. This is an optional property. * * If this property is left empty, the entity set is computed by parsing the binding context path, for example, * `Tasks('id-1428419016778-51')` is parsed to `Tasks`. * * Default value is `empty string`. * * * @returns Value of property `entitySet` */ getEntitySet(): string; /** * Gets current value of property {@link #getExpandNavigationProperties expandNavigationProperties}. * * Indicates if entities related to navigation properties inside the metadata are requested. If set to `true`, * then these related entities are loaded with an `$expand` request. * * Annotations that can have navigation properties are the following: * `com.sap.vocabularies.Common.v1.Text` for text arrangements `Org.OData.Measures.V1.Unit` and `Org.OData.Measures.V1.ISOCurrency` * for units `com.sap.vocabularies.Common.v1.FieldControl` for field control * * **Note:** Independent of the `fetchValueListReadOnly` value, setting this flag to `true` requests data * from the backend. * * **Note:** The back-end request to expand the navigation properties is sent only if the entity to which * `SmartField` is bound is persisted. For transient entities, there is no back-end request since no such * data is available. * * Default value is `false`. * * @since 1.48 * @deprecated As of version 1.117. It is recommended the expand to be using the OData Model. * * @returns Value of property `expandNavigationProperties` */ getExpandNavigationProperties(): boolean; /** * Gets current value of property {@link #getFetchValueListReadOnly fetchValueListReadOnly}. * * Indicates whether the value list collection is fetched in display mode from the resource path specified * in the `com.sap.vocabularies.Common.v1.ValueList` annotation. * * This collection data is used to infer a descriptive text for the value of the `SmartField` control. However, * fetching the value list collection for every `SmartField` instance individually may not be ideal in some * performance-critical scenarios. To optimize this default behavior, you can set this property to `false` * and provide the `com.sap.vocabularies.Common.v1.Text` annotation, which is used to specify the URL path * name to the Entity Data Model (EDM) property from which the descriptive text for the value of the `SmartField` * control is fetched, for example, LT (Laptop). * * **Note:** Setting this property to `false` only has an effect if the `value` property of the `SmartField` * control is bound to an Entity Data Model (EDM) property typed as `Edm.String`. In addition, applications * or frameworks have to make sure the descriptive text is fetched, for example, by expanding a navigation * property. * * Default value is `true`. * * @since 1.42.0 * * @returns Value of property `fetchValueListReadOnly` */ getFetchValueListReadOnly(): boolean; /** * Gets current value of property {@link #getFixedValueListValidationEnabled fixedValueListValidationEnabled}. * * If the property is set to `true`, a standard validation for {@link sap.m.ComboBox} is performed. An inner * control {@link sap.m.ComboBox} is created and the binding is to `selectedKey`. Changes at runtime are * not reflected. * * **Note:** This property switches the control in legacy mode. If set to `true` this will override any * setting to `textInEditModeSource` property regarding ComboBox validation. * * **Note:** If the property is set to `false`, the inner control is {@link sap.ui.comp.smartfield.ComboBox } * and the binding is to `enteredValue`. In this case, any entered value is valid irrespective of whether * it's in the predefined list or not. * * **Note:** This property is applicable only for fixed-value scenarios. * * Default value is `false`. * * @since 1.88 * * @returns Value of property `fixedValueListValidationEnabled` */ getFixedValueListValidationEnabled(): boolean; /** * Returns the DOM element that gets the focus. * * * @returns The DOM element that should get the focus, can be `null` */ getFocusDomRef(): Element; /** * Returns the formatted value of a control used in a `SemanticFormElement`. * * @since 1.88 * * @returns Formatted value or a `Promise` returning the formatted value if resolved */ getFormFormattedValue(): Promise; /** * Returns the name of the value-holding property of a control used in a `SemanticFormElement`. * * @since 1.88 */ getFormValueProperty(): string; /** * Gets current value of property {@link #getHistoryEnabled historyEnabled}. * * If the property is set to `false`, history values are disabled. Changes at runtime are not reflected. * The `historyEnabled` property is not applied to custom controls. * * **Note:** For {@link sap.m.ComboBox} and {@link sap.m.MultiComboBox} the history values are disabled * by default. To enable them for these controls, you need to set the `historyEnabled` property to `true`. * * Default value is `true`. * * @since 1.84 * * @returns Value of property `historyEnabled` */ getHistoryEnabled(): boolean; /** * Gets the ID of the control to which the label should point. * * * @returns The ID of the inner control if it exists, otherwise the ID of the `SmartField` control */ getIdForLabel(): string; /** * Gets current value of property {@link #getImportance importance}. * * Specifies the importance of the field. Applicable only when the `SmartField` is used inside `SmartForm`. * * Default value is `Low`. * * @since 1.87 * * @returns Value of property `importance` */ getImportance(): sap.ui.comp.smartfield.Importance; /** * Resolves the controls hosted currently by this `SmartField` control. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns The controls hosted currently by this `SmartField` */ getInnerControls(): any[]; /** * Gets current value of property {@link #getJsontype jsontype}. * * Data types to be used, if the `SmartField` control is interacting with a JSON model. If the value property * of the control is bound to a property of an OData entity set, this property is not taken into consideration. * * @deprecated As of version 1.31.0. with no replacement. * * @returns Value of property `jsontype` */ getJsontype(): sap.ui.comp.smartfield.JSONType; /** * Gets current value of property {@link #getMandatory mandatory}. * * Indicates whether user input is required. * * **Note:** The `SmartField` control is metadata-driven and this property can be ignored if the following * applies: * * * - The bound Entity Data Model (EDM) property is annotated with the `Nullable` annotation. The `Nullable` * annotation is a capability of the OData service that specifies whether a value is mandatory, hence it * overrules the control's API settings. Therefore, if the `Nullable` attribute is specified as `Nullable="false"`, * a value is mandatory. * - The bound EDM property is annotated with the `com.sap.vocabularies.Common.v1.FieldControl` annotation. * * * Default value is `false`. * * * @returns Value of property `mandatory` */ getMandatory(): boolean; /** * Gets current value of property {@link #getMaxLength maxLength}. * * Defines the highest possible number of permitted input characters that the user can enter into the text * input field. * * Computed `maxLength`: If the specified `maxLength` value is greater than the `maxLength` value specified * for the underlying bound Entity Data Model (EDM) property in the service metadata document, the `maxLength` * value of the EDM property takes precedence. Likewise, if the application code provides a binding data * type for the `value` property of the `SmartField` control and the binding data type has `maxLength` constraints * defined, this `maxLength` is also taken into consideration to compute the final `maxLength` value. * * Validation Behavior: By design, the `SmartField` control does not restrict/validate the highest number * of permitted input characters for every keystroke, but only when the text input field has changed, and * the browser focus leaves the text input field or the ENTER key is pressed. The `SmartField` control is * used more generically in broader contexts, and adding a `maxLength` attribute to the HTML text input * control may break data type formatting in two-way data-binding scenarios. Let's say the `maxLength` property * is set to 3, but the text input control has a formatter function attached to it to format the entered * value "DE" to "Germany (DE)". In this case, the formatted value will be truncated by the `maxLength` * setting. * * Default value is `0`. * * * @returns Value of property `maxLength` */ getMaxLength(): int; /** * Returns the current SmartField's edit mode * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Returns "edit" or "display" */ getMode(): string; /** * Gets current value of property {@link #getName name}. * * To be used in the HTML code (for example, for HTML forms that send data to the server via 'submit'). * * Default value is `empty string`. * * * @returns Value of property `name` */ getName(): string; /** * Gets current value of property {@link #getPlaceholder placeholder}. * * Text shown when no value available. * * Default value is `empty string`. * * * @returns Value of property `placeholder` */ getPlaceholder(): string; /** * Gets current value of property {@link #getProposedControl proposedControl}. * * Proposes a control to be rendered. The `SmartField` control can ignore the proposal. * * Default value is `None`. * * @since 1.32.0 * @deprecated As of version 1.32.0. with no replacement. * * @returns Value of property `proposedControl` */ getProposedControl(): sap.ui.comp.smartfield.ControlProposalType; /** * Gets current value of property {@link #getRefreshOnInParamChange refreshOnInParamChange}. * * Controls if changes to the InParameters should trigger a description request. * * Default value is `false`. * * @since 1.142 * * @returns Value of property `refreshOnInParamChange` */ getRefreshOnInParamChange(): boolean; /** * Gets the value of the `mandatory` property. * * This function is needed as the "mandatory" feature is named "required" in a lot of other controls (like * `Label` or `Form`). * * @since 1.48.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns the true if the `SmartField` should be marked as required */ getRequired(): boolean; /** * Gets content of aggregation {@link #getSemanticObjectController semanticObjectController}. * * The Semantic Object Controller allows the user to specify and overwrite functionality for semantic object * navigation. */ getSemanticObjectController(): sap.ui.comp.navpopover.SemanticObjectController; /** * Gets current value of property {@link #getShowLabel showLabel}. * * If set to `false` the label is not displayed. * * Default value is `true`. * * * @returns Value of property `showLabel` */ getShowLabel(): boolean; /** * Gets current value of property {@link #getShowSuggestion showSuggestion}. * * If set to `true`, the suggestion feature for a hosted control is enabled, if the hosted control supports * it. * * Default value is `true`. * * * @returns Value of property `showSuggestion` */ getShowSuggestion(): boolean; /** * Gets current value of property {@link #getShowValueHelp showValueHelp}. * * If set to `true`, a value help indicator will be displayed inside the hosted control, if the hosted control * supports this. * * Default value is `true`. * * * @returns Value of property `showValueHelp` */ getShowValueHelp(): boolean; /** * Gets current value of property {@link #getShowValueStateMessage showValueStateMessage}. * * Defines whether the value state message is shown or not. * * Default value is `true`. * * * @returns Value of property `showValueStateMessage` */ getShowValueStateMessage(): boolean; /** * Gets current value of property {@link #getSuppressEmptyStringRequest suppressEmptyStringRequest}. * * Controls if a query is sent to the backend in case of an empty string. * * Default value is `true`. * * @since 1.124 * * @returns Value of property `suppressEmptyStringRequest` */ getSuppressEmptyStringRequest(): boolean; /** * Gets current value of property {@link #getTextAlign textAlign}. * * Horizontal alignment of the text. * * Default value is `Initial`. * * * @returns Value of property `textAlign` */ getTextAlign(): sap.ui.core.TextAlign; /** * Gets current value of property {@link #getTextDirection textDirection}. * * The available text direction options are LTR and RTL. By default, the control inherits the text direction * from its parent control. * * The `textDirection` property can be used when, for example, the text direction in the application is * LTR but you want a specific field to have RTL text direction. * * **Note:** The `textDirection` property is not applicable for the `SmartField` control for units of measure * use cases. * * Default value is `Inherit`. * * @since 1.86.0 * * @returns Value of property `textDirection` */ getTextDirection(): sap.ui.core.TextDirection; /** * Gets current value of property {@link #getTextInEditModeSource textInEditModeSource}. * * Sets the source from which text descriptions for `IDs` are fetched in edit mode, for example, for LT * (Laptop). * * **Note**: The `sap.ui.comp.smartfield.TextInEditModeSource.NavigationProperty` and `sap.ui.comp.smartfield.TextInEditModeSource.ValueList` * enumeration members are only supported if the following applies: * * * - The `value` property of the `SmartField` control instance is bound to an Entity Data Model (EDM) * property typed as `Edm.String` or `Edm.Guid`. * - The `com.sap.vocabularies.UI.v1.TextArrangement` annotation for the bound EDM property or entity * type is specified in the service metadata document or annotation file. * - The binding mode for the `value` property of the `SmartField` control is the two-way binding mode. * * - The field from which the description is fetched is filterable. * * **Note**: In addition, the `sap.ui.comp.smartfield.TextInEditModeSource.NavigationProperty` enumeration * member is only supported if the following applies: * * * - The EDM navigation property association is defined in the service metadata document. * - The `com.sap.vocabularies.Common.v1.Text` annotation for the bound EDM property is specified in the * service metadata document or annotation file whose `Path` attribute points to a EDM navigation property * of a lookup entity set/type whose single key property is the `ID`, which contains (among other properties) * the descriptive value. * - The lookup entity must be loaded. The lookup entity can be loaded by expanding the EDM navigation * property via a `$expand` query parameter. * - The EDM navigation property association defines a referential constraint that ties values of the * dependent editable entity type/set to the lookup entity type/set in the service metadata document. * - The EDM navigation property association end multiplicity of the lookup entity type/set is defined * as `1` in the service metadata document. There must be a single-valued navigation from the editable entity * set/type to the lookup entity set/type. * - The lookup entity type/set from which the descriptive value is fetched contains a single-key EDM * property. * * **Note**: As of version 1.82, if `SmartField` is used inside a `SmartForm`, `defaultTextInEditModeSource` * can be added as custom data to the form and it will be propagated to all smart fields that cover the * above criteria. However, if `textInEditModeSource` is added to the `SmartField` as property, it will * override the `defaultTextInEditModeSource` propagated from the `SmartForm` custom data. * * **Note**: As of version 1.107 the property will be used to configure the validation for fixed list fields * of type `ComboBox`. The values that will be considered: * - ValueList - strict validation * - ValueListWarning - non-strict validation * * Default value is `None`. * * @since 1.83 * * @returns Value of property `textInEditModeSource` */ getTextInEditModeSource(): sap.ui.comp.smartfield.TextInEditModeSource; /** * Gets current value of property {@link #getTextLabel textLabel}. * * This property contains the text of an associated `SmartLabel`. * * Default value is `empty string`. * * * @returns Value of property `textLabel` */ getTextLabel(): string; /** * Gets current value of property {@link #getTooltipLabel tooltipLabel}. * * This property contains the tool tip of the associated `SmartLabel` control. * * Default value is `empty string`. * * * @returns Value of property `tooltipLabel` */ getTooltipLabel(): string; /** * If the OData property to which the control's value property is bound semantically represents a unit of * measure, the value of the current unit of measure is returned. Otherwise `null` is returned. * * * @returns The current unit of measure is returned, which can be null */ getUnitOfMeasure(): any; /** * Gets current value of property {@link #getUomEditable uomEditable}. * * Indicates whether the unit of measure field is in display or edit mode. * * **Note:** This control property is only valid if the `SmartField` control addresses a unit of measure * composite field, for example, an amount field and its associated currency field. The field must then * be annotated with one of the following annotations: * * * - The bound Entity Data Model (EDM) property or its entity set are annotated with the OData V2 `sap:unit` * annotation. * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Measures.V1.ISOCurrency` * annotation. * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Measures.V1.Unit` * annotation. * * **Note:** The `SmartField` control is metadata-driven, and this control property can be ignored if the * following applies: * * * - The bound Entity Data Model (EDM) property or its entity set are annotated with the OData V2 `sap:updatable` * annotation. * - The bound EDM property or its entity set are annotated with the `sap:creatable` annotation. * - The entity set of the bound EDM property is annotated with the OData V2 `sap:updatable-path` annotation. * * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Capabilities.V1.InsertRestrictions` * annotation. * - The bound EDM property is annotated with the `com.sap.vocabularies.Common.v1.FieldControl` annotation. * * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Capabilities.V1.UpdateRestrictions` * annotation. * * Default value is `true`. * * * @returns Value of property `uomEditable` */ getUomEditable(): boolean; /** * Gets current value of property {@link #getUomEnabled uomEnabled}. * * Enabled state of the unit, if the `SmartField` control addresses unit of measure use cases, for example, * an amount and its associated currency. * * Default value is `true`. * * * @returns Value of property `uomEnabled` */ getUomEnabled(): boolean; /** * Gets current value of property {@link #getUomVisible uomVisible}. * * Indicates whether the unit of measure field is visible. * * **Note:** This control property is only valid if the `SmartField` control addresses a unit of measure * composite field, for example, an amount field and its associated currency field. The field must then * be annotated with one of the following annotations: * * * - The bound Entity Data Model (EDM) property or its entity set are annotated with the OData V2 `sap:unit` * annotation. * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Measures.V1.ISOCurrency` * annotation. * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Measures.V1.Unit` * annotation. * * **Note:** The `SmartField` control is metadata-driven, and this property can be ignored if the bound * EDM property is annotated with the `com.sap.vocabularies.Common.v1.FieldControl` annotation. * * Default value is `true`. * * * @returns Value of property `uomVisible` */ getUomVisible(): boolean; /** * Gets current value of property {@link #getUrl url}. * * Contains a URL which is used to render a link. The link is rendered, if the OData property, to which * the value property of the control is bound, is of type `Edm.String` and the `SmartField` is in display * mode. * * Default value is `empty string`. * * * @returns Value of property `url` */ getUrl(): string; /** * Gets current value of property {@link #getValue value}. * * The binding path expression used to determine the bound Entity Data Model (EDM) property. **Important:** * The `SmartField` is a metadata-driven control. Avoid direct interaction with the `value` property, as * it should be accessed or modified via the model itself. * * **Note:** Composite binding expressions for this property are not supported. **Note:** Custom formatters * for this property are not supported. The `SmartField` control usually creates its own data type based * on the service metadata for the formatting of values. Also, when a custom formatter is specified for * a property, the binding mode is automatically switched to one-way binding mode. **Note:** Named models * are not supported, only the default model (named undefined) is supported. For example, when the binding * path expression contains a `>` sign, the string preceding it is a named model and the remainder after * the `>` is the binding path. * * * @returns Value of property `value` */ getValue(): any; /** * Gets current value of property {@link #getValueHelpTitleSource valueHelpTitleSource}. * * Controls if the title is taken from the label of the main property or from the label of the value list. * * Default value is `Property`. * * @since 1.132 * * @returns Value of property `valueHelpTitleSource` */ getValueHelpTitleSource(): sap.ui.comp.smartfield.ValueHelpTitleSource; /** * Gets current value of property {@link #getValueState valueState}. * * Visualizes the validation state of the control, e.g. `Error`, `Warning`, `Success`, `Information`. * * **Note:** This method is public because of an implementation side effect and should not be used for validation * purposes as it may conflict with the `SmartField` control's own binding type validation logic based on * the underlying metadata of the bound Entity Data Model (EDM) property. Invoking the `.setValueState()` * and/or `.setValueStateText()` methods in a `change` event handle to set an error state does not prevent * an invalid value from being stored in the binding/model in two-way data binding scenarios. In addition, * it does not fire the `validationError` event, which is usually required by some upstream modules, for * example, the message manager. * * Custom validation logic must be implemented in a custom binding type rather than in a `change` event * handler. * * Default value is `None`. * * * @returns Value of property `valueState` */ getValueState(): sap.ui.core.ValueState; /** * Gets current value of property {@link #getValueStateText valueStateText}. * * Defines the text of the value state message popup. * * **Note:** This method is public because of an implementation side effect and should not be used for validation * purposes as it may conflict with the `SmartField` control's own binding type validation logic based on * the underlying metadata of the bound Entity Data Model (EDM) property. Invoking the `.setValueState()` * and/or `.setValueStateText()` methods in a `change` event handle to set an error state does not prevent * an invalid value from being stored in the binding/model in two-way data binding scenarios. In addition, * it does not fire the `validationError` event, which is usually required by some upstream modules, for * example, the message manager. * * Custom validation logic must be implemented in a custom binding type rather than in a `change` event * handler. * * Default value is `empty string`. * * * @returns Value of property `valueStateText` */ getValueStateText(): string; /** * Gets current value of property {@link #getWidth width}. * * Defines the width of the control. * * Default value is `empty string`. * * * @returns Value of property `width` */ getWidth(): sap.ui.core.CSSSize; /** * Gets current value of property {@link #getWrapping wrapping}. * * Indicates whether the control break lines (in display mode) to prevent overflow. * * Default value is `true`. * * @since 1.36.6 * * @returns Value of property `wrapping` */ getWrapping(): boolean; /** * Removes all the controls in the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * @since 1.96 * * @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}. * * @since 1.34.2 * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): sap.ui.core.ID[]; /** * Removes an ariaDescribedBy from the association named {@link #getAriaDescribedBy ariaDescribedBy}. * * @since 1.96 * * @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}. * * @since 1.34.2 * * @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; /** * Sets a new value for property {@link #getClientSideMandatoryCheck clientSideMandatoryCheck}. * * Determines if the mandatory check of whether the field has a value happens on the client side - `true` * or on the server side - `false`. * * **Note:** If the {@link sap.ui.comp.smartfield.SmartField#value} property of the `SmartField` control * is bound to an Entity Data Model (EDM) property of type different from Edm.String annotated as `Nullable="false"`, * the mandatory validation is performed on the client side regardless of the `clientSideMandatoryCheck` * setting. * * Example: * * * ```javascript * * * ``` * * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.38.3 * * @returns Reference to `this` in order to allow method chaining */ setClientSideMandatoryCheck( /** * New value for property `clientSideMandatoryCheck` */ bClientSideMandatoryCheck?: boolean ): this; /** * Sets the aggregated {@link #getConfiguration configuration}. * * * @returns Reference to `this` in order to allow method chaining */ setConfiguration( /** * The configuration to set */ oConfiguration: sap.ui.comp.smartfield.Configuration ): this; /** * Sets a new value for property {@link #getContextEditable contextEditable}. * * Notifies the control whether controls using the `SmartField` control are editable. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.32.0 * * @returns Reference to `this` in order to allow method chaining */ setContextEditable( /** * New value for property `contextEditable` */ bContextEditable?: boolean ): this; /** * Sets a new value for property {@link #getControlContext controlContext}. * * Defines the context in which the layout of the `SmartField` control has to be interpreted. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `None`. * * @since 1.32.0 * * @returns Reference to `this` in order to allow method chaining */ setControlContext( /** * New value for property `controlContext` */ sControlContext?: sap.ui.comp.smartfield.ControlContextType ): this; /** * Sets the aggregated {@link #getControlProposal controlProposal}. * * @since 1.32.0 * @deprecated As of version 1.34.0. with no replacement. * * @returns Reference to `this` in order to allow method chaining */ setControlProposal( /** * The controlProposal to set */ oControlProposal: sap.ui.comp.smartfield.ControlProposal ): this; /** * Sets a new value for property {@link #getEditable editable}. * * Indicates whether the control is in display or edit mode. * * **Note:** The `SmartField` control is metadata-driven, and this control property can be ignored if the * following applies: * * * - The bound Entity Data Model (EDM) property or its entity set are annotated with the OData V2 `sap:updatable` * annotation. * - The bound EDM property or its entity set are annotated with the `sap:creatable` annotation. * - The entity set of the bound EDM property is annotated with the OData V2 `sap:updatable-path` annotation. * * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Capabilities.V1.InsertRestrictions` * annotation. * - The bound EDM property is annotated with the `com.sap.vocabularies.Common.v1.FieldControl` annotation. * * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Capabilities.V1.UpdateRestrictions` * annotation. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEditable( /** * New value for property `editable` */ bEditable?: boolean ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * Indicates whether the user can interact with the control or not. **Note:** Disabled controls cannot be * focused and they are out of the tab order. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getEntitySet entitySet}. * * The name of an entity set for which the control manages values. This is an optional property. * * If this property is left empty, the entity set is computed by parsing the binding context path, for example, * `Tasks('id-1428419016778-51')` is parsed to `Tasks`. * * 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 */ setEntitySet( /** * New value for property `entitySet` */ sEntitySet?: string ): this; /** * Sets a new value for property {@link #getExpandNavigationProperties expandNavigationProperties}. * * Indicates if entities related to navigation properties inside the metadata are requested. If set to `true`, * then these related entities are loaded with an `$expand` request. * * Annotations that can have navigation properties are the following: * `com.sap.vocabularies.Common.v1.Text` for text arrangements `Org.OData.Measures.V1.Unit` and `Org.OData.Measures.V1.ISOCurrency` * for units `com.sap.vocabularies.Common.v1.FieldControl` for field control * * **Note:** Independent of the `fetchValueListReadOnly` value, setting this flag to `true` requests data * from the backend. * * **Note:** The back-end request to expand the navigation properties is sent only if the entity to which * `SmartField` is bound is persisted. For transient entities, there is no back-end request since no such * data is available. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.48 * @deprecated As of version 1.117. It is recommended the expand to be using the OData Model. * * @returns Reference to `this` in order to allow method chaining */ setExpandNavigationProperties( /** * New value for property `expandNavigationProperties` */ bExpandNavigationProperties?: boolean ): this; /** * Sets a new value for property {@link #getFetchValueListReadOnly fetchValueListReadOnly}. * * Indicates whether the value list collection is fetched in display mode from the resource path specified * in the `com.sap.vocabularies.Common.v1.ValueList` annotation. * * This collection data is used to infer a descriptive text for the value of the `SmartField` control. However, * fetching the value list collection for every `SmartField` instance individually may not be ideal in some * performance-critical scenarios. To optimize this default behavior, you can set this property to `false` * and provide the `com.sap.vocabularies.Common.v1.Text` annotation, which is used to specify the URL path * name to the Entity Data Model (EDM) property from which the descriptive text for the value of the `SmartField` * control is fetched, for example, LT (Laptop). * * **Note:** Setting this property to `false` only has an effect if the `value` property of the `SmartField` * control is bound to an Entity Data Model (EDM) property typed as `Edm.String`. In addition, applications * or frameworks have to make sure the descriptive text is fetched, for example, by expanding a navigation * property. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.42.0 * * @returns Reference to `this` in order to allow method chaining */ setFetchValueListReadOnly( /** * New value for property `fetchValueListReadOnly` */ bFetchValueListReadOnly?: boolean ): this; /** * Sets a new value for property {@link #getFixedValueListValidationEnabled fixedValueListValidationEnabled}. * * If the property is set to `true`, a standard validation for {@link sap.m.ComboBox} is performed. An inner * control {@link sap.m.ComboBox} is created and the binding is to `selectedKey`. Changes at runtime are * not reflected. * * **Note:** This property switches the control in legacy mode. If set to `true` this will override any * setting to `textInEditModeSource` property regarding ComboBox validation. * * **Note:** If the property is set to `false`, the inner control is {@link sap.ui.comp.smartfield.ComboBox } * and the binding is to `enteredValue`. In this case, any entered value is valid irrespective of whether * it's in the predefined list or not. * * **Note:** This property is applicable only for fixed-value scenarios. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.88 * * @returns Reference to `this` in order to allow method chaining */ setFixedValueListValidationEnabled( /** * New value for property `fixedValueListValidationEnabled` */ bFixedValueListValidationEnabled?: boolean ): this; /** * Sets a new value for property {@link #getHistoryEnabled historyEnabled}. * * If the property is set to `false`, history values are disabled. Changes at runtime are not reflected. * The `historyEnabled` property is not applied to custom controls. * * **Note:** For {@link sap.m.ComboBox} and {@link sap.m.MultiComboBox} the history values are disabled * by default. To enable them for these controls, you need to set the `historyEnabled` property to `true`. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.84 * * @returns Reference to `this` in order to allow method chaining */ setHistoryEnabled( /** * New value for property `historyEnabled` */ bHistoryEnabled?: boolean ): this; /** * Sets a new value for property {@link #getImportance importance}. * * Specifies the importance of the field. Applicable only when the `SmartField` is used inside `SmartForm`. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Low`. * * @since 1.87 * * @returns Reference to `this` in order to allow method chaining */ setImportance( /** * New value for property `importance` */ sImportance?: sap.ui.comp.smartfield.Importance ): this; /** * Sets a new value for property {@link #getJsontype jsontype}. * * Data types to be used, if the `SmartField` control is interacting with a JSON model. If the value property * of the control is bound to a property of an OData entity set, this property is not taken into consideration. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @deprecated As of version 1.31.0. with no replacement. * * @returns Reference to `this` in order to allow method chaining */ setJsontype( /** * New value for property `jsontype` */ sJsontype?: sap.ui.comp.smartfield.JSONType ): this; /** * Sets a new value for property {@link #getMandatory mandatory}. * * Indicates whether user input is required. * * **Note:** The `SmartField` control is metadata-driven and this property can be ignored if the following * applies: * * * - The bound Entity Data Model (EDM) property is annotated with the `Nullable` annotation. The `Nullable` * annotation is a capability of the OData service that specifies whether a value is mandatory, hence it * overrules the control's API settings. Therefore, if the `Nullable` attribute is specified as `Nullable="false"`, * a value is mandatory. * - The bound EDM property is annotated with the `com.sap.vocabularies.Common.v1.FieldControl` annotation. * * * 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 */ setMandatory( /** * New value for property `mandatory` */ bMandatory?: boolean ): this; /** * Sets a new value for property {@link #getMaxLength maxLength}. * * Defines the highest possible number of permitted input characters that the user can enter into the text * input field. * * Computed `maxLength`: If the specified `maxLength` value is greater than the `maxLength` value specified * for the underlying bound Entity Data Model (EDM) property in the service metadata document, the `maxLength` * value of the EDM property takes precedence. Likewise, if the application code provides a binding data * type for the `value` property of the `SmartField` control and the binding data type has `maxLength` constraints * defined, this `maxLength` is also taken into consideration to compute the final `maxLength` value. * * Validation Behavior: By design, the `SmartField` control does not restrict/validate the highest number * of permitted input characters for every keystroke, but only when the text input field has changed, and * the browser focus leaves the text input field or the ENTER key is pressed. The `SmartField` control is * used more generically in broader contexts, and adding a `maxLength` attribute to the HTML text input * control may break data type formatting in two-way data-binding scenarios. Let's say the `maxLength` property * is set to 3, but the text input control has a formatter function attached to it to format the entered * value "DE" to "Germany (DE)". In this case, the formatted value will be truncated by the `maxLength` * setting. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setMaxLength( /** * New value for property `maxLength` */ iMaxLength?: int ): this; /** * Sets a new value for property {@link #getName name}. * * To be used in the HTML code (for example, for HTML forms that send data to the server via 'submit'). * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setName( /** * New value for property `name` */ sName?: string ): this; /** * Sets a new value for property {@link #getPlaceholder placeholder}. * * Text shown when no value available. * * 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 */ setPlaceholder( /** * New value for property `placeholder` */ sPlaceholder?: string ): this; /** * Sets a new value for property {@link #getProposedControl proposedControl}. * * Proposes a control to be rendered. The `SmartField` control can ignore the proposal. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `None`. * * @since 1.32.0 * @deprecated As of version 1.32.0. with no replacement. * * @returns Reference to `this` in order to allow method chaining */ setProposedControl( /** * New value for property `proposedControl` */ sProposedControl?: sap.ui.comp.smartfield.ControlProposalType ): this; /** * Sets a new value for property {@link #getRefreshOnInParamChange refreshOnInParamChange}. * * Controls if changes to the InParameters should trigger a description request. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.142 * * @returns Reference to `this` in order to allow method chaining */ setRefreshOnInParamChange( /** * New value for property `refreshOnInParamChange` */ bRefreshOnInParamChange?: boolean ): this; /** * Sets the aggregated {@link #getSemanticObjectController semanticObjectController}. * * * @returns Reference to `this` in order to allow method chaining */ setSemanticObjectController( /** * The semanticObjectController to set */ oSemanticObjectController: sap.ui.comp.navpopover.SemanticObjectController ): this; /** * Sets a new value for property {@link #getShowLabel showLabel}. * * If set to `false` the label is not displayed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowLabel( /** * New value for property `showLabel` */ bShowLabel?: boolean ): this; /** * Sets a new value for property {@link #getShowSuggestion showSuggestion}. * * If set to `true`, the suggestion feature for a hosted control is enabled, if the hosted control supports * it. * * 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 */ setShowSuggestion( /** * New value for property `showSuggestion` */ bShowSuggestion?: boolean ): this; /** * Sets a new value for property {@link #getShowValueHelp showValueHelp}. * * If set to `true`, a value help indicator will be displayed inside the hosted control, if the hosted control * supports this. * * 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 */ setShowValueHelp( /** * New value for property `showValueHelp` */ bShowValueHelp?: boolean ): this; /** * Sets a new value for property {@link #getShowValueStateMessage showValueStateMessage}. * * Defines whether the value state message is shown or not. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowValueStateMessage( /** * New value for property `showValueStateMessage` */ bShowValueStateMessage?: boolean ): this; /** * Sets a new value for property {@link #getSuppressEmptyStringRequest suppressEmptyStringRequest}. * * Controls if a query is sent to the backend in case of an empty string. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.124 * * @returns Reference to `this` in order to allow method chaining */ setSuppressEmptyStringRequest( /** * New value for property `suppressEmptyStringRequest` */ bSuppressEmptyStringRequest?: boolean ): this; /** * Sets a new value for property {@link #getTextAlign textAlign}. * * Horizontal alignment of the text. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Initial`. * * * @returns Reference to `this` in order to allow method chaining */ setTextAlign( /** * New value for property `textAlign` */ sTextAlign?: sap.ui.core.TextAlign ): this; /** * Sets a new value for property {@link #getTextDirection textDirection}. * * The available text direction options are LTR and RTL. By default, the control inherits the text direction * from its parent control. * * The `textDirection` property can be used when, for example, the text direction in the application is * LTR but you want a specific field to have RTL text direction. * * **Note:** The `textDirection` property is not applicable for the `SmartField` control for units of measure * use cases. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Inherit`. * * @since 1.86.0 * * @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 #getTextInEditModeSource textInEditModeSource}. * * Sets the source from which text descriptions for `IDs` are fetched in edit mode, for example, for LT * (Laptop). * * **Note**: The `sap.ui.comp.smartfield.TextInEditModeSource.NavigationProperty` and `sap.ui.comp.smartfield.TextInEditModeSource.ValueList` * enumeration members are only supported if the following applies: * * * - The `value` property of the `SmartField` control instance is bound to an Entity Data Model (EDM) * property typed as `Edm.String` or `Edm.Guid`. * - The `com.sap.vocabularies.UI.v1.TextArrangement` annotation for the bound EDM property or entity * type is specified in the service metadata document or annotation file. * - The binding mode for the `value` property of the `SmartField` control is the two-way binding mode. * * - The field from which the description is fetched is filterable. * * **Note**: In addition, the `sap.ui.comp.smartfield.TextInEditModeSource.NavigationProperty` enumeration * member is only supported if the following applies: * * * - The EDM navigation property association is defined in the service metadata document. * - The `com.sap.vocabularies.Common.v1.Text` annotation for the bound EDM property is specified in the * service metadata document or annotation file whose `Path` attribute points to a EDM navigation property * of a lookup entity set/type whose single key property is the `ID`, which contains (among other properties) * the descriptive value. * - The lookup entity must be loaded. The lookup entity can be loaded by expanding the EDM navigation * property via a `$expand` query parameter. * - The EDM navigation property association defines a referential constraint that ties values of the * dependent editable entity type/set to the lookup entity type/set in the service metadata document. * - The EDM navigation property association end multiplicity of the lookup entity type/set is defined * as `1` in the service metadata document. There must be a single-valued navigation from the editable entity * set/type to the lookup entity set/type. * - The lookup entity type/set from which the descriptive value is fetched contains a single-key EDM * property. * * **Note**: As of version 1.82, if `SmartField` is used inside a `SmartForm`, `defaultTextInEditModeSource` * can be added as custom data to the form and it will be propagated to all smart fields that cover the * above criteria. However, if `textInEditModeSource` is added to the `SmartField` as property, it will * override the `defaultTextInEditModeSource` propagated from the `SmartForm` custom data. * * **Note**: As of version 1.107 the property will be used to configure the validation for fixed list fields * of type `ComboBox`. The values that will be considered: * - ValueList - strict validation * - ValueListWarning - non-strict validation * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `None`. * * @since 1.83 * * @returns Reference to `this` in order to allow method chaining */ setTextInEditModeSource( /** * New value for property `textInEditModeSource` */ sTextInEditModeSource?: sap.ui.comp.smartfield.TextInEditModeSource ): this; /** * Sets a new value for property {@link #getTextLabel textLabel}. * * This property contains the text of an associated `SmartLabel`. * * 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 */ setTextLabel( /** * New value for property `textLabel` */ sTextLabel?: string ): this; /** * Sets a new value for property {@link #getTooltipLabel tooltipLabel}. * * This property contains the tool tip of the associated `SmartLabel` 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 */ setTooltipLabel( /** * New value for property `tooltipLabel` */ sTooltipLabel?: string ): this; /** * If the OData property the control's value property is bound to semantically represents a unit of measure, * the value of the current unit of measure can be changed. */ setUnitOfMeasure( /** * The new unit of measure to be set. */ sUnit: string ): void; /** * Sets a new value for property {@link #getUomEditable uomEditable}. * * Indicates whether the unit of measure field is in display or edit mode. * * **Note:** This control property is only valid if the `SmartField` control addresses a unit of measure * composite field, for example, an amount field and its associated currency field. The field must then * be annotated with one of the following annotations: * * * - The bound Entity Data Model (EDM) property or its entity set are annotated with the OData V2 `sap:unit` * annotation. * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Measures.V1.ISOCurrency` * annotation. * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Measures.V1.Unit` * annotation. * * **Note:** The `SmartField` control is metadata-driven, and this control property can be ignored if the * following applies: * * * - The bound Entity Data Model (EDM) property or its entity set are annotated with the OData V2 `sap:updatable` * annotation. * - The bound EDM property or its entity set are annotated with the `sap:creatable` annotation. * - The entity set of the bound EDM property is annotated with the OData V2 `sap:updatable-path` annotation. * * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Capabilities.V1.InsertRestrictions` * annotation. * - The bound EDM property is annotated with the `com.sap.vocabularies.Common.v1.FieldControl` annotation. * * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Capabilities.V1.UpdateRestrictions` * annotation. * * 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 */ setUomEditable( /** * New value for property `uomEditable` */ bUomEditable?: boolean ): this; /** * Sets a new value for property {@link #getUomEnabled uomEnabled}. * * Enabled state of the unit, if the `SmartField` control addresses unit of measure use cases, for example, * an amount and its associated currency. * * 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 */ setUomEnabled( /** * New value for property `uomEnabled` */ bUomEnabled?: boolean ): this; /** * Sets a new value for property {@link #getUomVisible uomVisible}. * * Indicates whether the unit of measure field is visible. * * **Note:** This control property is only valid if the `SmartField` control addresses a unit of measure * composite field, for example, an amount field and its associated currency field. The field must then * be annotated with one of the following annotations: * * * - The bound Entity Data Model (EDM) property or its entity set are annotated with the OData V2 `sap:unit` * annotation. * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Measures.V1.ISOCurrency` * annotation. * - The entity set of the bound EDM property is annotated with the OData V4 `Org.OData.Measures.V1.Unit` * annotation. * * **Note:** The `SmartField` control is metadata-driven, and this property can be ignored if the bound * EDM property is annotated with the `com.sap.vocabularies.Common.v1.FieldControl` annotation. * * 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 */ setUomVisible( /** * New value for property `uomVisible` */ bUomVisible?: boolean ): this; /** * Sets a new value for property {@link #getUrl url}. * * Contains a URL which is used to render a link. The link is rendered, if the OData property, to which * the value property of the control is bound, is of type `Edm.String` and the `SmartField` is in display * mode. * * 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 */ setUrl( /** * New value for property `url` */ sUrl?: string ): this; /** * Sets a new value for property {@link #getValue value}. * * The binding path expression used to determine the bound Entity Data Model (EDM) property. **Important:** * The `SmartField` is a metadata-driven control. Avoid direct interaction with the `value` property, as * it should be accessed or modified via the model itself. * * **Note:** Composite binding expressions for this property are not supported. **Note:** Custom formatters * for this property are not supported. The `SmartField` control usually creates its own data type based * on the service metadata for the formatting of values. Also, when a custom formatter is specified for * a property, the binding mode is automatically switched to one-way binding mode. **Note:** Named models * are not supported, only the default model (named undefined) is supported. For example, when the binding * path expression contains a `>` sign, the string preceding it is a named model and the remainder after * the `>` is the binding path. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setValue( /** * New value for property `value` */ oValue?: any ): this; /** * Sets a new value for property {@link #getValueHelpTitleSource valueHelpTitleSource}. * * Controls if the title is taken from the label of the main property or from the label of the value list. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Property`. * * @since 1.132 * * @returns Reference to `this` in order to allow method chaining */ setValueHelpTitleSource( /** * New value for property `valueHelpTitleSource` */ sValueHelpTitleSource?: sap.ui.comp.smartfield.ValueHelpTitleSource ): this; /** * Setter for property `valueState`. Default value is `None`. * * @since 1.30.0 * * @returns `this` to allow method chaining */ setValueState( /** * The new value for property `valueState` */ sValueState: sap.ui.core.ValueState ): this; /** * Setter for property `valueStateText`. Default value is empty/`undefined`. * * @since 1.29 * * @returns `this` to allow method chaining */ setValueStateText( /** * The new value for property `valueStateText` */ sText: string ): this; /** * Sets a new value for property {@link #getWidth width}. * * Defines the width of the control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `empty string`. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth?: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getWrapping wrapping}. * * Indicates whether the control break lines (in display mode) to prevent overflow. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.36.6 * * @returns Reference to `this` in order to allow method chaining */ setWrapping( /** * New value for property `wrapping` */ bWrapping?: boolean ): this; } /** * Enumeration of the different contexts supported by the SmartField, if it is using an OData model. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartfield.ControlContextType'. */ enum ControlContextType { /** * Behaves currently exactly like `sap.ui.comp.smartfield.ControlContextType.None`. */ Form = "form", /** * No special context is selected. The Smart Field applies its internal defaults. */ None = "", /** * Also the UoM layout is influenced. */ ResponsiveTable = "responsiveTable", /** * If this is selected the UoM layout is influenced. */ SmartFormGrid = "smartFormGrid", /** * If this is selected the UoM layout is influenced. */ Table = "table", } /** * Enumeration of the different control proposals supported by the Smart Field, if it is using an OData * model. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartfield.ControlProposalType'. */ enum ControlProposalType { /** * No special context is selected. The Smart Field applies its internal defaults. */ None = "", /** * If this is selected, the sap.m.ObjectIdentifier control is used to display IDs, if they are not editable. * The current OData property is assumed to have a text annotation. Otherwise the configuration is ignored. */ ObjectIdentifier = "ObjectIdentifier", /** * If this is selected, the sap.m.ObjectNumber control is used to display units of measure. If the value * property of the Smart Field is not bound to a unit of measure, the property is ignored. */ ObjectNumber = "ObjectNumber", } /** * The available control types to configure the internal control selection of a SmartField control. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartfield.ControlType'. */ enum ControlType { /** * The `SmartField` control chooses the control to be displayed. */ auto = "auto", /** * The `SmartField` control displays a check box control. */ checkBox = "checkBox", /** * The `SmartField` control displays a date picker control. */ datePicker = "datePicker", /** * The `SmartField` control displays a combo box control. */ dropDownList = "dropDownList", /** * The `SmartField` control displays a text input field control. */ input = "input", /** * The `SmartField` control displays a select control. */ selection = "selection", } /** * The different options to visualize the ObjectStatus control. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartfield.CriticalityRepresentationType'. */ enum CriticalityRepresentationType { /** * If this is selected, the sap.m.ObjectStatus control visualizes the criticality using an icon. */ WithIcon = "WithIcon", /** * If this is selected, the sap.m.ObjectStatus control does not visualize the criticality using an icon. */ WithoutIcon = "WithoutIcon", } /** * The different options to define display behavior for the value help of a SmartField control. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartfield.DisplayBehaviour'. */ enum DisplayBehaviour { /** * The SmartField chooses the display behavior. */ auto = "auto", /** * Description and ID are displayed for available values. */ descriptionAndId = "descriptionAndId", /** * Only the description of the available values is displayed. */ descriptionOnly = "descriptionOnly", /** * ID and description are displayed for available values. */ idAndDescription = "idAndDescription", /** * Shows the ID only. */ idOnly = "idOnly", /** * Shows Boolean value as On/Off */ OnOff = "OnOff", /** * Shows Boolean value as True/False */ TrueFalse = "TrueFalse", /** * Shows Boolean value as Yes/No */ YesNo = "YesNo", } /** * Provides information about the importance of the field * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartfield.Importance'. * * @since 1.87 */ enum Importance { /** * `SmartField` with high importance */ High = "High", /** * `SmartField` with low importance */ Low = "Low", /** * `SmartField` with medium importance */ Medium = "Medium", } /** * Enumeration of the different data types supported by the SmartField control, if it is using a JSON model. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartfield.JSONType'. */ enum JSONType { /** * Boolean Type */ Boolean = "Boolean", /** * The JavaScript Date Object */ Date = "Date", /** * Date Time Type */ DateTime = "DateTime", /** * Float type */ Float = "Float", /** * Integer type */ Integer = "Integer", /** * The JavaScript primary type String */ String = "String", } /** * Enumeration of sources from which text values for `Codes`/`IDs` are fetched in edit mode. The text is * usually visualized as description/text value for IDs, for example, for LT (Laptop). * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartfield.TextInEditModeSource'. * * @since 1.54 */ enum TextInEditModeSource { /** * The text is fetched from the OData model property specified in the `Path` attribute of the `com.sap.vocabularies.Common.v1.Text` * annotation. */ NavigationProperty = "NavigationProperty", /** * The `com.sap.vocabularies.UI.v1.TextArrangement` annotation and the value of the `displayBehaviour` property * of the `configuration` aggregation are not evaluated. */ None = "None", /** * The text is fetched from the OData model property specified in the `Path` attribute of the `com.sap.vocabularies.Common.v1.Text` * annotation of the associated value list entity. */ ValueList = "ValueList", /** * The text is fetched from the OData model property specified in the `Path` attribute of the `com.sap.vocabularies.Common.v1.Text` * annotation. Could be a value which is not included in the associated value list entity. * * **Note** Note that a scenario where more than one `SmartField` is bound to the same property could raise * a performance issue depending on the number of the smart fields. */ ValueListNoValidation = "ValueListNoValidation", /** * The same behavior as ValueListNoValidation but for values that are considered invalid a warning message * will be created. * * NOTE: In this mode when the value is sent to the backend there might be 2 messages for the same field * from both frontend and backend validation. */ ValueListWarning = "ValueListWarning", } /** * Provides information about the ValueHelpTitleSource of the field * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartfield.ValueHelpTitleSource'. * * @since 1.132 */ enum ValueHelpTitleSource { /** * `SmartField` with Property ValueHelpTitleSource */ Property = "Property", /** * `SmartField` with ValueList ValueHelpTitleSource */ ValueList = "ValueList", } type checkValuesValidityInfo = { /** * The Edm name of the property the control is bound to. */ property: string; /** * The instance of the control on which the checkValuesValidity method was called */ instance: sap.ui.comp.smartfield.SmartField; }; /** * Event object of the SmartField#change event. */ type SmartField$ChangeEvent = sap.ui.base.Event< SmartField$ChangeEventParameters, SmartField >; /** * Event object of the SmartField#changeModelValue event. */ type SmartField$ChangeModelValueEvent = sap.ui.base.Event< SmartField$ChangeModelValueEventParameters, SmartField >; /** * Event object of the SmartField#contextEditableChanged event. */ type SmartField$ContextEditableChangedEvent = sap.ui.base.Event< SmartField$ContextEditableChangedEventParameters, SmartField >; /** * Event object of the SmartField#editableChanged event. */ type SmartField$EditableChangedEvent = sap.ui.base.Event< SmartField$EditableChangedEventParameters, SmartField >; /** * Event object of the SmartField#entitySetFound event. */ type SmartField$EntitySetFoundEvent = sap.ui.base.Event< SmartField$EntitySetFoundEventParameters, SmartField >; /** * Event object of the SmartField#initialise event. */ type SmartField$InitialiseEvent = sap.ui.base.Event< SmartField$InitialiseEventParameters, SmartField >; /** * Event object of the SmartField#innerControlsCreated event. */ type SmartField$InnerControlsCreatedEvent = sap.ui.base.Event< SmartField$InnerControlsCreatedEventParameters, SmartField >; /** * Event object of the SmartField#linkPress event. */ type SmartField$LinkPressEvent = sap.ui.base.Event< SmartField$LinkPressEventParameters, SmartField >; /** * Event object of the SmartField#modeToggled event. */ type SmartField$ModeToggledEvent = sap.ui.base.Event< SmartField$ModeToggledEventParameters, SmartField >; /** * Event object of the SmartField#press event. * * @deprecated As of version 1.116.0. with no replacement. */ type SmartField$PressEvent = sap.ui.base.Event< SmartField$PressEventParameters, SmartField >; /** * Event object of the SmartField#valueListChanged event. */ type SmartField$ValueListChangedEvent = sap.ui.base.Event< SmartField$ValueListChangedEventParameters, SmartField >; /** * Event object of the SmartField#visibleChanged event. */ type SmartField$VisibleChangedEvent = sap.ui.base.Event< SmartField$VisibleChangedEventParameters, SmartField >; } namespace smartfilterbar { namespace SmartFilterBar { type DateRangeTypeByKeyResponse = { defaultValue: string; type: string; group: string; }; type SearchAllowed = { /** * Mandatory - Indicates that some mandatory filters or parameters are empty */ mandatory?: undefined | boolean; /** * Pending - Indicates that a token validation is going on */ pending?: undefined | boolean; /** * Error - Indicates that some filters or parameters are in error state */ error?: undefined | boolean; }; } /** * Describes the settings that can be provided to the ControlConfiguration constructor. */ interface $ControlConfigurationSettings extends sap.ui.comp.config.$ControlConfigurationBaseSettings { /** * The groupId can be used to move a field from one group to another. The groupId corresponds to the EntityName * from the OData metadata. It is also possible to move a field from the advanced area to the basic area * by specifying the groupId _BASIC. */ groupId?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Using this property it is possible to overwrite the label of a filter field in the SmartFilterBar. */ label?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Using this flag it is possible to hide fields from the OData metadata. */ visible?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies whether a value help dialog is available or not. */ hasValueHelpDialog?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies whether `sap.m.ComboBox` selectedKey has corresponding item or not. */ hasValidation?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The SmartFilterBar calculates which kind of control will be used for a filter fields based on multiple * OData Attributes and annotations. Using this property it is possible to overwrite the OData metadata. */ controlType?: | sap.ui.comp.smartfilterbar.ControlType | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The filter type specifies whether the filter field is of type single value, multi-value, or interval. * The filter type is calculated by the {@link sap.ui.comp.smartfilterbar.SmartFilterBar} control based * on the OData metadata. Using this property the filter type can be configured manually. */ filterType?: | sap.ui.comp.smartfilterbar.FilterType | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The index property specifies the initial order of fields without any variants. It's zero based so in * order for it to be taken into account, its value must be equal to or bigger than 0. **Note:** To ensure * the expected sorting behavior, the index property should have a unique value. */ index?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Property can be used to enable the TypeAhead service. TypeAhead does not work with all controls, e.g * it does not work for DropDownListbox */ hasTypeAhead?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Property can be used to overwrite the mandatory state of a filter field. Property can only be set during * initialization. Changes at runtime will be ignored. */ mandatory?: | sap.ui.comp.smartfilterbar.MandatoryType | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The width of the filter field in a CSS compatible format. The width can be set only once during initialization. * Changes at runtime will not be reflected. The width will not be applied to custom controls. */ width?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * If set to true this field will be added to the advanced area (aka. Dynamic Selection) by default. */ visibleInAdvancedArea?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * In case there are value help annotations for this filter field, it is possible to specify whether the * table in the value help dialog for this field will be filled initially. The default value is `false`, * which means the table will be filled as the data fetch is not prevented. **Note:** As of version 1.78 * the default value has been changed from `true` to `false`. */ preventInitialDataFetchInValueHelpDialog?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The displayBehaviour specifies how the content should be displayed on certain controls. Ex: DescriptionOnly * for Combobox (DropDown text) , Description and ID for MultiInput (token text) */ displayBehaviour?: | sap.ui.comp.smartfilterbar.DisplayBehaviour | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `false` history values are disabled. * * **Note:** For {@link sap.m.ComboBox} and {@link sap.m.MultiComboBox} the history values are disabled * by default. To enable them for these controls, you need to set the `historyEnabled` property to `true`. * * @since 1.84 */ historyEnabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets default operation for Condition Panel of the Value Help dialog. In case the newly set default operation * is not valid for the filter's EDM data type, then it is ignored. * * @since 1.99 */ conditionPanelDefaultOperation?: | sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets time zone for filter of type Edm.DateTimeOffset * * **Note:** The property is IANA timezone ID, e.g. "America/New_York". An invalid IANA timezone ID will * fall back to the UTC. * * @since 1.103 */ timezone?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Default value for a filter field. The aggregation expects {@link sap.ui.comp.smartfilterbar.SelectOption|SelectOption } * instances, where the values' format (properties `low` and `high`) match the type of the referneced property * and consider also the given constraints of the property. * * Samples for valid formats: `Edm.DateTime` with constraint `sap:display-format='Date'`: "2018-12-24" (you * optionally can provide a time-part and timezone, too, (2018-12-24T00:00:00Z) but this is ignored) * * `Edm.DateTimeOffset`: "2018-12-24T13:55:59Z" * * `Edm.Time`: "PT12H34M56S" * * `Edm.Boolean`: "false" * * `Edm.Decimal`: "2983.12" */ defaultFilterValues?: | sap.ui.comp.smartfilterbar.SelectOption[] | sap.ui.comp.smartfilterbar.SelectOption | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * If a custom control is specified, the SmartFilterBar will not create a control but use the custom control. * Additional services like TypeAhead have to implemented manually. */ customControl?: sap.ui.core.Control; /** * Fired when the value of a property, for example isVisible, has changed. */ change?: (oEvent: ControlConfiguration$ChangeEvent) => void; } /** * Describes the settings that can be provided to the GroupConfiguration constructor. */ interface $GroupConfigurationSettings extends sap.ui.core.$ElementSettings { /** * The key property must correspond to the `EntitySet` name or `FieldGroup Qualifier` from the OData service * $metadata document. */ key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Zero based integer index. The index can be used to specify the order of groups. If no index is specified, * the order like in the OData metadata will be used. */ index?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Using this property it is possible to overwrite the label of a group in the advanced area of the SmartFilterBar. */ label?: | any | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Fired when the value of a property, for example label, has changed */ change?: (oEvent: GroupConfiguration$ChangeEvent) => void; } /** * Describes the settings that can be provided to the SelectOption constructor. */ interface $SelectOptionSettings extends sap.ui.core.$ElementSettings { /** * The sign for a Select Option. Possible values are I for include or E for exclude. */ sign?: | sap.ui.comp.smartfilterbar.SelectOptionSign | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The operator for a select option. The default value is EQ "for equals". */ operator?: | sap.ui.model.FilterOperator | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The low value for a select option. */ low?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The high value for a select option. The high value is only required for a few operators, e.g. BT (between). */ high?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; } /** * Describes the settings that can be provided to the SFBMultiComboBox constructor. * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ interface $SFBMultiComboBoxSettings extends sap.m.$MultiComboBoxSettings { /** * Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType` * from the ValueList property. */ textArrangement?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; } /** * Describes the settings that can be provided to the SmartFilterBar constructor. */ interface $SmartFilterBarSettings extends sap.ui.comp.filterbar.$FilterBarSettings { /** * The OData entity type whose metadata is used to create the `SmartFilterBar`. **Note:** Changing this * value after the `SmartFilterBar` is initialized (`initialise` event was fired) has no effect. * * @deprecated As of version 1.40. Use `entitySet` property instead of this one, to enable V4 annotation * support */ entityType?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The OData entity set whose metadata is used to create the `SmartFilterBar`. **Note:** Changing this value * after the `SmartFilterBar` is initialized (`initialise` event was fired) has no effect. */ entitySet?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Optional. The OData service URL. If it is not specified, the service URL from the OData model (this.getModel()) * will be used. **Note:** Changing this value after the SmartFilterBar is initialized (initialise event * was fired) has no effect. * * @deprecated As of version 1.29. Set an ODataModel as the main model on your control/view instead */ resourceUri?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Name of the field that is the focus of the basic search. */ basicSearchFieldName?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Enables the basic search field. The entered value can be accessed with {@link sap.ui.comp.smartfilterbar.SmartFilterBar#getParameters}. * **Note:** When the `SmartFilterBar` control is used with a {@link sap.ui.comp.smarttable.SmartTable } * control the parameters are handled automatically. Therefore, this must only be enabled for OData service * entities that support basic search. * **Note:** basic search field is restricted to 1000 characters and spaces. */ enableBasicSearch?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set the search will be automatically triggered, when a filter value was set via the change * event. * **Note:** The liveMode only operates on non-mobile scenarios. * Additionally, if liveMode is set, the following applies: * - The error messagebox is not displayed, and the `showMessages` property is ignored. * - The search is triggered after a variant has been selected. * - Execute on Select for `VariantManagement` is not shown and not taken into account * * @since 1.40 */ liveMode?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `true`, any errors that occur during the search, are displayed in a message box in addition * to the `valueState` with the error. **Note:** As of version 1.89, the default value has been changed * from `true` to `false`. * * @since 1.40 */ showMessages?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates if the analytical parameters (SelectionVariant) must be taken into consideration. * * @since 1.42.0 */ considerAnalyticalParameters?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `true` all date fields with filter restriction `interval` will be treated as `DateTimeRange` * filters. The `useDateRangeType` can be set only once during initialization. **Note:** If this property * is set to `true` and any date filters with filter restriction `interval` were stored as part of a variant, * the values of these filters cannot be applied. If this property is set to `false`, any previously stored * filters which were treated as type `DateTimeRange` based on the former setting, cannot be converted back * to the standard date interval. * * @since 1.46.0 */ useDateRangeType?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `true` all search requests will be ignored. This functionality is only intended to be used * internally to enable an optimal solution when the filter bar is controlled by the smart templates. NOTE: * As long as this property is set to `true`, all search requests will be neglected. * * @since 1.44.0 */ suppressSelection?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates if the annotation `com.sap.vocabularies.UI.v1.SelectionVariant` is taken into account. * **Note**: Only relevant for control level personalization. * * @deprecated As of version 1.87. Please use the `com.sap.vocabularies.UI.v1.SelectionPresentationVariant` * annotation through the {@link sap.ui.comp.smartvariants.SmartVariantManagement#setEntitySet} */ considerSelectionVariants?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines one specific variant that is based on the `com.sap.vocabularies.UI.v1.SelectionVariant` annotation, * which is then used as the default variant. * This property is only relevant in case `considerSelectionVariants` is set to `true` and will only be * applied if there is no user-defined default variant specified. * **Note**: Only relevant for control level personalization. * * @deprecated As of version 1.87. Please use the `com.sap.vocabularies.UI.v1.SelectionPresentationVariant` * annotation through the {@link sap.ui.comp.smartvariants.SmartVariantManagement#setEntitySet} */ defaultSelectionVariantName?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * If set to `true`, only the navigation properties mentioned in property {@link sap.ui.comp.smartfilterbar.SmartFilterBar#getNavigationProperties } * are checked for further filters. * * @since 1.48 */ useProvidedNavigationProperties?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * This property is only evaluated if the property {@link sap.ui.comp.smartfilterbar.SmartFilterBar#getUseProvidedNavigationProperties } * is set to `true`. It contains a comma-separated list of `NavigationProperty`> names which are checked * for filters. It can also contain a list of separate filters from different `NavigationProperty` names. * * * * @since 1.48 */ navigationProperties?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Indicates if the annotation `com.sap.vocabularies.UI.v1.PresentationVariant` is taken into account. */ considerPresentationVariant?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Using control configurations you can add additional configuration to filter fields, for example set custom * labels, change the order of fields, or change the filter field control type. **Note:** Changing the values * here after the SmartFilter is initialized (`initialise` event was fired) has no effect. */ controlConfiguration?: | sap.ui.comp.smartfilterbar.ControlConfiguration[] | sap.ui.comp.smartfilterbar.ControlConfiguration | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Provides the possibility to add additional configuration to groups. Groups are used to show fields in * the advanced area of the SmartFilterBar. With additional configuration, you can for example set custom * labels or change the order of groups. **Note:** Changing the values here after the SmartFilter is initialized * (`initialise` event was fired) has no effect. */ groupConfiguration?: | sap.ui.comp.smartfilterbar.GroupConfiguration[] | sap.ui.comp.smartfilterbar.GroupConfiguration | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Identifies the SmartVariant control which should be used for the personalization. * * @since 1.38 */ smartVariant?: | sap.ui.comp.smartvariants.SmartVariantManagement | string; /** * This event is fired after the pending state of the `FilterBar` control changes. * * @since 1.36 */ pendingChange?: (oEvent: SmartFilterBar$PendingChangeEvent) => void; } /** * Describes the settings that can be provided to the SmartFilterBarFilterGroupItem constructor. */ interface $SmartFilterBarFilterGroupItemSettings extends sap.ui.comp.filterbar.$FilterGroupItemSettings {} /** * Parameters of the ControlConfiguration#change event. */ interface ControlConfiguration$ChangeEventParameters { /** * Name of the changed property */ propertyName?: string; } /** * Parameters of the GroupConfiguration#change event. */ interface GroupConfiguration$ChangeEventParameters { /** * Name of the changed property */ propertyName?: string; } /** * Parameters of the SmartFilterBar#pendingChange event. */ interface SmartFilterBar$PendingChangeEventParameters { /** * The current pending value. */ pendingValue?: boolean; } /** * ControlConfiguration can be used to add additional configuration for filter fields in the SmartFilterBar * control, in order to overwrite the default settings from the OData metadata. For instance, it is possible * to change the label, index or control type of a filter field. */ class ControlConfiguration extends sap.ui.comp.config .ControlConfigurationBase { /** * Constructor for a new smartfilterbar/ControlConfiguration. * * 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.ui.comp.smartfilterbar.$ControlConfigurationSettings ); /** * Constructor for a new smartfilterbar/ControlConfiguration. * * 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.ui.comp.smartfilterbar.$ControlConfigurationSettings ); /** * Creates a new subclass of class sap.ui.comp.smartfilterbar.ControlConfiguration 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.comp.config.ControlConfigurationBase.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< T, sap.ui.comp.smartfilterbar.ControlConfiguration >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartfilterbar.ControlConfiguration. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some defaultFilterValue to the aggregation {@link #getDefaultFilterValues defaultFilterValues}. * * * @returns Reference to `this` in order to allow method chaining */ addDefaultFilterValue( /** * The defaultFilterValue to add; if empty, nothing is inserted */ oDefaultFilterValue: sap.ui.comp.smartfilterbar.SelectOption ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.comp.smartfilterbar.ControlConfiguration`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfilterbar.ControlConfiguration` itself. * * Fired when the value of a property, for example isVisible, has changed. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: ControlConfiguration$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfilterbar.ControlConfiguration` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.comp.smartfilterbar.ControlConfiguration`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfilterbar.ControlConfiguration` itself. * * Fired when the value of a property, for example isVisible, has changed. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * The function to be called when the event occurs */ fnFunction: (p1: ControlConfiguration$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfilterbar.ControlConfiguration` * itself */ oListener?: object ): this; /** * Destroys the customControl in the aggregation {@link #getCustomControl customControl}. * * * @returns Reference to `this` in order to allow method chaining */ destroyCustomControl(): this; /** * Destroys all the defaultFilterValues in the aggregation {@link #getDefaultFilterValues defaultFilterValues}. * * * @returns Reference to `this` in order to allow method chaining */ destroyDefaultFilterValues(): this; /** * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.comp.smartfilterbar.ControlConfiguration`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: ControlConfiguration$ChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:change change} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireChange( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartfilterbar.ControlConfiguration$ChangeEventParameters ): this; /** * Gets current value of property {@link #getConditionPanelDefaultOperation conditionPanelDefaultOperation}. * * Sets default operation for Condition Panel of the Value Help dialog. In case the newly set default operation * is not valid for the filter's EDM data type, then it is ignored. * * @since 1.99 * * @returns Value of property `conditionPanelDefaultOperation` */ getConditionPanelDefaultOperation(): sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation; /** * Gets current value of property {@link #getControlType controlType}. * * The SmartFilterBar calculates which kind of control will be used for a filter fields based on multiple * OData Attributes and annotations. Using this property it is possible to overwrite the OData metadata. * * Default value is `'auto'`. * * * @returns Value of property `controlType` */ getControlType(): sap.ui.comp.smartfilterbar.ControlType; /** * Gets content of aggregation {@link #getCustomControl customControl}. * * If a custom control is specified, the SmartFilterBar will not create a control but use the custom control. * Additional services like TypeAhead have to implemented manually. */ getCustomControl(): sap.ui.core.Control; /** * Gets content of aggregation {@link #getDefaultFilterValues defaultFilterValues}. * * Default value for a filter field. The aggregation expects {@link sap.ui.comp.smartfilterbar.SelectOption|SelectOption } * instances, where the values' format (properties `low` and `high`) match the type of the referneced property * and consider also the given constraints of the property. * * Samples for valid formats: `Edm.DateTime` with constraint `sap:display-format='Date'`: "2018-12-24" (you * optionally can provide a time-part and timezone, too, (2018-12-24T00:00:00Z) but this is ignored) * * `Edm.DateTimeOffset`: "2018-12-24T13:55:59Z" * * `Edm.Time`: "PT12H34M56S" * * `Edm.Boolean`: "false" * * `Edm.Decimal`: "2983.12" */ getDefaultFilterValues(): sap.ui.comp.smartfilterbar.SelectOption[]; /** * Gets current value of property {@link #getDisplayBehaviour displayBehaviour}. * * The displayBehaviour specifies how the content should be displayed on certain controls. Ex: DescriptionOnly * for Combobox (DropDown text) , Description and ID for MultiInput (token text) * * Default value is `'auto'`. * * * @returns Value of property `displayBehaviour` */ getDisplayBehaviour(): sap.ui.comp.smartfilterbar.DisplayBehaviour; /** * Gets current value of property {@link #getFilterType filterType}. * * The filter type specifies whether the filter field is of type single value, multi-value, or interval. * The filter type is calculated by the {@link sap.ui.comp.smartfilterbar.SmartFilterBar} control based * on the OData metadata. Using this property the filter type can be configured manually. * * Default value is `'auto'`. * * * @returns Value of property `filterType` */ getFilterType(): sap.ui.comp.smartfilterbar.FilterType; /** * Gets current value of property {@link #getGroupId groupId}. * * The groupId can be used to move a field from one group to another. The groupId corresponds to the EntityName * from the OData metadata. It is also possible to move a field from the advanced area to the basic area * by specifying the groupId _BASIC. * * * @returns Value of property `groupId` */ getGroupId(): string; /** * Gets current value of property {@link #getHasTypeAhead hasTypeAhead}. * * Property can be used to enable the TypeAhead service. TypeAhead does not work with all controls, e.g * it does not work for DropDownListbox * * Default value is `true`. * * * @returns Value of property `hasTypeAhead` */ getHasTypeAhead(): boolean; /** * Gets current value of property {@link #getHasValidation hasValidation}. * * Specifies whether `sap.m.ComboBox` selectedKey has corresponding item or not. * * Default value is `true`. * * * @returns Value of property `hasValidation` */ getHasValidation(): boolean; /** * Gets current value of property {@link #getHasValueHelpDialog hasValueHelpDialog}. * * Specifies whether a value help dialog is available or not. * * Default value is `true`. * * * @returns Value of property `hasValueHelpDialog` */ getHasValueHelpDialog(): boolean; /** * Gets current value of property {@link #getHistoryEnabled historyEnabled}. * * If set to `false` history values are disabled. * * **Note:** For {@link sap.m.ComboBox} and {@link sap.m.MultiComboBox} the history values are disabled * by default. To enable them for these controls, you need to set the `historyEnabled` property to `true`. * * Default value is `true`. * * @since 1.84 * * @returns Value of property `historyEnabled` */ getHistoryEnabled(): boolean; /** * Gets current value of property {@link #getIndex index}. * * The index property specifies the initial order of fields without any variants. It's zero based so in * order for it to be taken into account, its value must be equal to or bigger than 0. **Note:** To ensure * the expected sorting behavior, the index property should have a unique value. * * Default value is `-1`. * * * @returns Value of property `index` */ getIndex(): int; /** * Gets current value of property {@link #getLabel label}. * * Using this property it is possible to overwrite the label of a filter field in the SmartFilterBar. * * * @returns Value of property `label` */ getLabel(): string; /** * Gets current value of property {@link #getMandatory mandatory}. * * Property can be used to overwrite the mandatory state of a filter field. Property can only be set during * initialization. Changes at runtime will be ignored. * * Default value is `'auto'`. * * * @returns Value of property `mandatory` */ getMandatory(): sap.ui.comp.smartfilterbar.MandatoryType; /** * Gets current value of property {@link #getPreventInitialDataFetchInValueHelpDialog preventInitialDataFetchInValueHelpDialog}. * * In case there are value help annotations for this filter field, it is possible to specify whether the * table in the value help dialog for this field will be filled initially. The default value is `false`, * which means the table will be filled as the data fetch is not prevented. **Note:** As of version 1.78 * the default value has been changed from `true` to `false`. * * Default value is `false`. * * * @returns Value of property `preventInitialDataFetchInValueHelpDialog` */ getPreventInitialDataFetchInValueHelpDialog(): boolean; /** * Gets current value of property {@link #getTimezone timezone}. * * Sets time zone for filter of type Edm.DateTimeOffset * * **Note:** The property is IANA timezone ID, e.g. "America/New_York". An invalid IANA timezone ID will * fall back to the UTC. * * @since 1.103 * * @returns Value of property `timezone` */ getTimezone(): string; /** * Gets current value of property {@link #getVisible visible}. * * Using this flag it is possible to hide fields from the OData metadata. * * Default value is `true`. * * * @returns Value of property `visible` */ getVisible(): boolean; /** * Gets current value of property {@link #getVisibleInAdvancedArea visibleInAdvancedArea}. * * If set to true this field will be added to the advanced area (aka. Dynamic Selection) by default. * * Default value is `false`. * * * @returns Value of property `visibleInAdvancedArea` */ getVisibleInAdvancedArea(): boolean; /** * Gets current value of property {@link #getWidth width}. * * The width of the filter field in a CSS compatible format. The width can be set only once during initialization. * Changes at runtime will not be reflected. The width will not be applied to custom controls. * * * @returns Value of property `width` */ getWidth(): string; /** * Checks for the provided `sap.ui.comp.smartfilterbar.SelectOption` in the aggregation {@link #getDefaultFilterValues defaultFilterValues}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfDefaultFilterValue( /** * The defaultFilterValue whose index is looked for */ oDefaultFilterValue: sap.ui.comp.smartfilterbar.SelectOption ): int; /** * Inserts a defaultFilterValue into the aggregation {@link #getDefaultFilterValues defaultFilterValues}. * * * @returns Reference to `this` in order to allow method chaining */ insertDefaultFilterValue( /** * The defaultFilterValue to insert; if empty, nothing is inserted */ oDefaultFilterValue: sap.ui.comp.smartfilterbar.SelectOption, /** * The `0`-based index the defaultFilterValue should be inserted at; for a negative value of `iIndex`, the * defaultFilterValue is inserted at position 0; for a value greater than the current size of the aggregation, * the defaultFilterValue is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getDefaultFilterValues defaultFilterValues}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllDefaultFilterValues(): sap.ui.comp.smartfilterbar.SelectOption[]; /** * Removes a defaultFilterValue from the aggregation {@link #getDefaultFilterValues defaultFilterValues}. * * * @returns The removed defaultFilterValue or `null` */ removeDefaultFilterValue( /** * The defaultFilterValue to remove or its index or id */ vDefaultFilterValue: | int | string | sap.ui.comp.smartfilterbar.SelectOption ): sap.ui.comp.smartfilterbar.SelectOption | null; /** * Sets a new value for property {@link #getConditionPanelDefaultOperation conditionPanelDefaultOperation}. * * Sets default operation for Condition Panel of the Value Help dialog. In case the newly set default operation * is not valid for the filter's EDM data type, then it is ignored. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.99 * * @returns Reference to `this` in order to allow method chaining */ setConditionPanelDefaultOperation( /** * New value for property `conditionPanelDefaultOperation` */ sConditionPanelDefaultOperation?: sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation ): this; /** * Sets a new value for property {@link #getControlType controlType}. * * The SmartFilterBar calculates which kind of control will be used for a filter fields based on multiple * OData Attributes and annotations. Using this property it is possible to overwrite the OData metadata. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'auto'`. * * * @returns Reference to `this` in order to allow method chaining */ setControlType( /** * New value for property `controlType` */ sControlType?: sap.ui.comp.smartfilterbar.ControlType ): this; /** * Sets the aggregated {@link #getCustomControl customControl}. * * * @returns Reference to `this` in order to allow method chaining */ setCustomControl( /** * The customControl to set */ oCustomControl: sap.ui.core.Control ): this; /** * Sets a new value for property {@link #getDisplayBehaviour displayBehaviour}. * * The displayBehaviour specifies how the content should be displayed on certain controls. Ex: DescriptionOnly * for Combobox (DropDown text) , Description and ID for MultiInput (token text) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'auto'`. * * * @returns Reference to `this` in order to allow method chaining */ setDisplayBehaviour( /** * New value for property `displayBehaviour` */ sDisplayBehaviour?: sap.ui.comp.smartfilterbar.DisplayBehaviour ): this; /** * Sets a new value for property {@link #getFilterType filterType}. * * The filter type specifies whether the filter field is of type single value, multi-value, or interval. * The filter type is calculated by the {@link sap.ui.comp.smartfilterbar.SmartFilterBar} control based * on the OData metadata. Using this property the filter type can be configured manually. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'auto'`. * * * @returns Reference to `this` in order to allow method chaining */ setFilterType( /** * New value for property `filterType` */ sFilterType?: sap.ui.comp.smartfilterbar.FilterType ): this; /** * Sets a new value for property {@link #getGroupId groupId}. * * The groupId can be used to move a field from one group to another. The groupId corresponds to the EntityName * from the OData metadata. It is also possible to move a field from the advanced area to the basic area * by specifying the groupId _BASIC. * * 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 */ setGroupId( /** * New value for property `groupId` */ sGroupId?: string ): this; /** * Sets a new value for property {@link #getHasTypeAhead hasTypeAhead}. * * Property can be used to enable the TypeAhead service. TypeAhead does not work with all controls, e.g * it does not work for DropDownListbox * * 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 */ setHasTypeAhead( /** * New value for property `hasTypeAhead` */ bHasTypeAhead?: boolean ): this; /** * Sets a new value for property {@link #getHasValidation hasValidation}. * * Specifies whether `sap.m.ComboBox` selectedKey has corresponding item or not. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setHasValidation( /** * New value for property `hasValidation` */ bHasValidation?: boolean ): this; /** * Sets a new value for property {@link #getHasValueHelpDialog hasValueHelpDialog}. * * Specifies whether a value help dialog is available or not. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setHasValueHelpDialog( /** * New value for property `hasValueHelpDialog` */ bHasValueHelpDialog?: boolean ): this; /** * Sets a new value for property {@link #getHistoryEnabled historyEnabled}. * * If set to `false` history values are disabled. * * **Note:** For {@link sap.m.ComboBox} and {@link sap.m.MultiComboBox} the history values are disabled * by default. To enable them for these controls, you need to set the `historyEnabled` property to `true`. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.84 * * @returns Reference to `this` in order to allow method chaining */ setHistoryEnabled( /** * New value for property `historyEnabled` */ bHistoryEnabled?: boolean ): this; /** * Sets a new value for property {@link #getIndex index}. * * The index property specifies the initial order of fields without any variants. It's zero based so in * order for it to be taken into account, its value must be equal to or bigger than 0. **Note:** To ensure * the expected sorting behavior, the index property should have a unique value. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `-1`. * * * @returns Reference to `this` in order to allow method chaining */ setIndex( /** * New value for property `index` */ iIndex?: int ): this; /** * Sets a new value for property {@link #getLabel label}. * * Using this property it is possible to overwrite the label of a filter field in the SmartFilterBar. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setLabel( /** * New value for property `label` */ sLabel?: string ): this; /** * Sets a new value for property {@link #getMandatory mandatory}. * * Property can be used to overwrite the mandatory state of a filter field. Property can only be set during * initialization. Changes at runtime will be ignored. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'auto'`. * * * @returns Reference to `this` in order to allow method chaining */ setMandatory( /** * New value for property `mandatory` */ sMandatory?: sap.ui.comp.smartfilterbar.MandatoryType ): this; /** * Sets a new value for property {@link #getPreventInitialDataFetchInValueHelpDialog preventInitialDataFetchInValueHelpDialog}. * * In case there are value help annotations for this filter field, it is possible to specify whether the * table in the value help dialog for this field will be filled initially. The default value is `false`, * which means the table will be filled as the data fetch is not prevented. **Note:** As of version 1.78 * the default value has been changed from `true` to `false`. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setPreventInitialDataFetchInValueHelpDialog( /** * New value for property `preventInitialDataFetchInValueHelpDialog` */ bPreventInitialDataFetchInValueHelpDialog?: boolean ): this; /** * Sets a new value for property {@link #getTimezone timezone}. * * Sets time zone for filter of type Edm.DateTimeOffset * * **Note:** The property is IANA timezone ID, e.g. "America/New_York". An invalid IANA timezone ID will * fall back to the UTC. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.103 * * @returns Reference to `this` in order to allow method chaining */ setTimezone( /** * New value for property `timezone` */ sTimezone?: string ): this; /** * Sets a new value for property {@link #getVisible visible}. * * Using this flag it is possible to hide fields from the OData metadata. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setVisible( /** * New value for property `visible` */ bVisible?: boolean ): this; /** * Sets a new value for property {@link #getVisibleInAdvancedArea visibleInAdvancedArea}. * * If set to true this field will be added to the advanced area (aka. Dynamic Selection) by default. * * 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 */ setVisibleInAdvancedArea( /** * New value for property `visibleInAdvancedArea` */ bVisibleInAdvancedArea?: boolean ): this; /** * Sets a new value for property {@link #getWidth width}. * * The width of the filter field in a CSS compatible format. The width can be set only once during initialization. * Changes at runtime will not be reflected. The width will not be applied to custom controls. * * 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?: string ): this; } /** * A GroupConfiguration can be used to add additional configurations for groups in the SmartFilterBar. A * group in the SmartFilterBar is a group of filter fields in the advanced search. */ class GroupConfiguration extends sap.ui.core.Element { /** * Constructor for a new smartfilterbar/GroupConfiguration. * * 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.ui.comp.smartfilterbar.$GroupConfigurationSettings ); /** * Constructor for a new smartfilterbar/GroupConfiguration. * * 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.ui.comp.smartfilterbar.$GroupConfigurationSettings ); /** * Creates a new subclass of class sap.ui.comp.smartfilterbar.GroupConfiguration with name `sClassName` * and enriches it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.comp.smartfilterbar.GroupConfiguration >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartfilterbar.GroupConfiguration. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.comp.smartfilterbar.GroupConfiguration`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfilterbar.GroupConfiguration` itself. * * Fired when the value of a property, for example label, has changed * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: GroupConfiguration$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfilterbar.GroupConfiguration` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.comp.smartfilterbar.GroupConfiguration`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfilterbar.GroupConfiguration` itself. * * Fired when the value of a property, for example label, has changed * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * The function to be called when the event occurs */ fnFunction: (p1: GroupConfiguration$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfilterbar.GroupConfiguration` * itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.comp.smartfilterbar.GroupConfiguration`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: GroupConfiguration$ChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:change change} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireChange( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartfilterbar.GroupConfiguration$ChangeEventParameters ): this; /** * Gets current value of property {@link #getIndex index}. * * Zero based integer index. The index can be used to specify the order of groups. If no index is specified, * the order like in the OData metadata will be used. * * Default value is `undefined`. * * * @returns Value of property `index` */ getIndex(): any; /** * Gets current value of property {@link #getKey key}. * * The key property must correspond to the `EntitySet` name or `FieldGroup Qualifier` from the OData service * $metadata document. * * * @returns Value of property `key` */ getKey(): string; /** * Gets current value of property {@link #getLabel label}. * * Using this property it is possible to overwrite the label of a group in the advanced area of the SmartFilterBar. * * Default value is `undefined`. * * * @returns Value of property `label` */ getLabel(): any; /** * Sets a new value for property {@link #getIndex index}. * * Zero based integer index. The index can be used to specify the order of groups. If no index is specified, * the order like in the OData metadata will be used. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `undefined`. * * * @returns Reference to `this` in order to allow method chaining */ setIndex( /** * New value for property `index` */ oIndex?: any ): this; /** * Sets a new value for property {@link #getKey key}. * * The key property must correspond to the `EntitySet` name or `FieldGroup Qualifier` from the OData service * $metadata document. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setKey( /** * New value for property `key` */ sKey?: string ): this; /** * Sets a new value for property {@link #getLabel label}. * * Using this property it is possible to overwrite the label of a group in the advanced area of the SmartFilterBar. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `undefined`. * * * @returns Reference to `this` in order to allow method chaining */ setLabel( /** * New value for property `label` */ oLabel?: any ): this; } /** * A Select Option can be used to specify default filter values for a control configuration of the SmartFilterBar. */ class SelectOption extends sap.ui.core.Element { /** * Constructor for a new smartfilterbar/SelectOption. * * 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.ui.comp.smartfilterbar.$SelectOptionSettings ); /** * Constructor for a new smartfilterbar/SelectOption. * * 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.ui.comp.smartfilterbar.$SelectOptionSettings ); /** * Creates a new subclass of class sap.ui.comp.smartfilterbar.SelectOption with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.comp.smartfilterbar.SelectOption >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartfilterbar.SelectOption. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getHigh high}. * * The high value for a select option. The high value is only required for a few operators, e.g. BT (between). * * * @returns Value of property `high` */ getHigh(): string; /** * Gets current value of property {@link #getLow low}. * * The low value for a select option. * * * @returns Value of property `low` */ getLow(): string; /** * Gets current value of property {@link #getOperator operator}. * * The operator for a select option. The default value is EQ "for equals". * * Default value is `'EQ'`. * * * @returns Value of property `operator` */ getOperator(): sap.ui.model.FilterOperator; /** * Gets current value of property {@link #getSign sign}. * * The sign for a Select Option. Possible values are I for include or E for exclude. * * Default value is `'I'`. * * * @returns Value of property `sign` */ getSign(): sap.ui.comp.smartfilterbar.SelectOptionSign; /** * Sets a new value for property {@link #getHigh high}. * * The high value for a select option. The high value is only required for a few operators, e.g. BT (between). * * 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 */ setHigh( /** * New value for property `high` */ sHigh?: string ): this; /** * Sets a new value for property {@link #getLow low}. * * The low value for a select option. * * 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 */ setLow( /** * New value for property `low` */ sLow?: string ): this; /** * Sets a new value for property {@link #getOperator operator}. * * The operator for a select option. The default value is EQ "for equals". * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'EQ'`. * * * @returns Reference to `this` in order to allow method chaining */ setOperator( /** * New value for property `operator` */ sOperator?: sap.ui.model.FilterOperator ): this; /** * Sets a new value for property {@link #getSign sign}. * * The sign for a Select Option. Possible values are I for include or E for exclude. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'I'`. * * * @returns Reference to `this` in order to allow method chaining */ setSign( /** * New value for property `sign` */ sSign?: sap.ui.comp.smartfilterbar.SelectOptionSign ): this; } /** * Extends the functionalities in sap.m.MultiComboBox * * @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework) */ class SFBMultiComboBox extends sap.m.MultiComboBox implements /* was: sap.ui.comp.IDropDownTextArrangement */ Object { __implements__sap_ui_comp_IDropDownTextArrangement: boolean; /** * Constructor for a new `SmartFilterBar/SFBMultiComboBox`. * * 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. * * @ui5-protected Do not call from applications (only from related classes in the framework) */ protected constructor(); /** * Creates a new subclass of class sap.ui.comp.smartfilterbar.SFBMultiComboBox 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.MultiComboBox.extend}. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @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< T, sap.ui.comp.smartfilterbar.SFBMultiComboBox >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartfilterbar.SFBMultiComboBox. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getTextArrangement textArrangement}. * * Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType` * from the ValueList property. * * Default value is `empty string`. * * * @returns Value of property `textArrangement` */ getTextArrangement(): string; /** * Sets a new value for property {@link #getTextArrangement textArrangement}. * * Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType` * from the ValueList property. * * 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 */ setTextArrangement( /** * New value for property `textArrangement` */ sTextArrangement?: string ): this; } /** * The `SmartFilterBar` is a wrapper that uses the OData metadata of an entity to create a filter bar based * on the content defined by the OData service. Whether a field is visible on the filter bar, supports type-ahead * and value help, for example, is automatically determined. * Note that all internally created instances are considered as private. * You can use the control configuration and group configuration classes to configure the filter fields * and adapt them to your needs. For example: * - Determine the type of control – for example whether a field is shown as a {@link sap.m.MultiInput multi input } * field or as a {@link sap.m.DatePicker date picker}. * - Enable the autocomplete suggestions feature. * - Enable the {@link sap.ui.comp.valuehelpdialog.ValueHelpDialog value help dialog}. * - Overwrite settings from the OData service. * - Set custom filter groups. * - Add custom fields. * - Access the settings of the underlying {@link sap.ui.comp.filterbar.FilterBar filter bar}. * * **Note:** Most of the attributes/properties are not dynamic and cannot be changed once the control has * been initialized. * * The SmartFilterBar control supports fiscal annotations, history of the recently used values and value * list IN/OUT parameters. * * Usage: When to use * - You use an OData service for your app (only OData version 2). * - You need a metadata-driven control and the features of the SmartFilterBar control are suitable for * your app. * - You want to develop quickly and efficiently. * * When not to use * - You are not using OData version 2. * - You need to implement extensive changes to the {@link sap.ui.comp.filterbar.FilterBar filter bar}. * * * **Important:** Keep in mind that `SmartFilterBar`, like all SAPUI5 smart controls, retrieves and analyzes * the metadata and annotations of OData services. **The OData metadata is its primary API. These OData * services are not part of the SAPUI5 framework and are usually maintained by the backend developers of * your application.** * * With time, `SmartFilterBar` can evolve and acquire new features. This means that its behavior or functionalities * may change if the annotations that define this change are maintained in your backend metadata. To benefit * from the new functionalities, your application should be able to adapt the backend metadata. **Therefore, * we recommend using `SmartFilterBar` only if you have control over the metadata of your application.** */ class SmartFilterBar extends sap.ui.comp.filterbar.FilterBar { /** * Constructor for a new smartfilterbar/SmartFilterBar. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/7bcdffc056a94731b4341db73251e32b Smart Filter Bar} * {@link fiori:https://experience.sap.com/fiori-design-web/smart-filter-bar-annotations/ Smart Filter Bar} */ constructor( /** * initial settings for the new control */ mSettings?: sap.ui.comp.smartfilterbar.$SmartFilterBarSettings ); /** * Constructor for a new smartfilterbar/SmartFilterBar. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/7bcdffc056a94731b4341db73251e32b Smart Filter Bar} * {@link fiori:https://experience.sap.com/fiori-design-web/smart-filter-bar-annotations/ Smart Filter Bar} */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sID?: string, /** * initial settings for the new control */ mSettings?: sap.ui.comp.smartfilterbar.$SmartFilterBarSettings ); /** * Creates a new subclass of class sap.ui.comp.smartfilterbar.SmartFilterBar 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.comp.filterbar.FilterBar.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< T, sap.ui.comp.smartfilterbar.SmartFilterBar >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartfilterbar.SmartFilterBar. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some controlConfiguration to the aggregation {@link #getControlConfiguration controlConfiguration}. * * * @returns Reference to `this` in order to allow method chaining */ addControlConfiguration( /** * The controlConfiguration to add; if empty, nothing is inserted */ oControlConfiguration: sap.ui.comp.smartfilterbar.ControlConfiguration ): this; /** * Searches for the filter field having the specified OData key and adds this filter field to the advanced * area. If there is no corresponding field in the OData metadata, this method has no effect. */ addFieldToAdvancedArea( /** * The key like specified in the OData metadata */ sKey: string ): void; /** * Adds some groupConfiguration to the aggregation {@link #getGroupConfiguration groupConfiguration}. * * * @returns Reference to `this` in order to allow method chaining */ addGroupConfiguration( /** * The groupConfiguration to add; if empty, nothing is inserted */ oGroupConfiguration: sap.ui.comp.smartfilterbar.GroupConfiguration ): this; /** * Applies the current variant as opposed to `fetchVariant`. The variant is retrieved via the flex layer. */ applyVariant( /** * The variant that must be applied. oVariant must contain a valid JSON object. */ oVariant: Object ): void; /** * Attaches event handler `fnFunction` to the {@link #event:pendingChange pendingChange} event of this `sap.ui.comp.smartfilterbar.SmartFilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfilterbar.SmartFilterBar` itself. * * This event is fired after the pending state of the `FilterBar` control changes. * * @since 1.36 * * @returns Reference to `this` in order to allow method chaining */ attachPendingChange( /** * 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: SmartFilterBar$PendingChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfilterbar.SmartFilterBar` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:pendingChange pendingChange} event of this `sap.ui.comp.smartfilterbar.SmartFilterBar`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartfilterbar.SmartFilterBar` itself. * * This event is fired after the pending state of the `FilterBar` control changes. * * @since 1.36 * * @returns Reference to `this` in order to allow method chaining */ attachPendingChange( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartFilterBar$PendingChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartfilterbar.SmartFilterBar` * itself */ oListener?: object ): this; /** * Destroys all the controlConfiguration in the aggregation {@link #getControlConfiguration controlConfiguration}. * * * @returns Reference to `this` in order to allow method chaining */ destroyControlConfiguration(): this; /** * Destroys all the groupConfiguration in the aggregation {@link #getGroupConfiguration groupConfiguration}. * * * @returns Reference to `this` in order to allow method chaining */ destroyGroupConfiguration(): this; /** * Detaches event handler `fnFunction` from the {@link #event:pendingChange pendingChange} event of this * `sap.ui.comp.smartfilterbar.SmartFilterBar`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.36 * * @returns Reference to `this` in order to allow method chaining */ detachPendingChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartFilterBar$PendingChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Retrieves the control associated to the filter. * * @deprecated As of version 1.99. Use {@link sap.ui.core.Core.byId} instead. * * @returns The corresponding control. If no match is found `null` is returned. */ determineControlByFilterItem( /** * From the aggregations */ oFilterItem: sap.ui.comp.filterbar.FilterItem, /** * check also analytics parameter */ bConsiderParameters: boolean ): sap.ui.core.Control; /** * Retrieves the control based on the name and group name. * * @deprecated As of version 1.99. Use {@link sap.ui.core.Core.byId} instead. * * @returns The corresponding control, if no match is found, `null` is returned. */ determineControlByName( /** * Name of the filter. */ sName: string, /** * Group name of the filter; `null` for filter that belongs to basic group. */ sGroupName?: string ): sap.ui.core.Control; /** * Ensures the associated ValueHelpProvider is loaded. */ ensureLoadedValueHelp( /** * is the name of the property from the entity type which is associated with a Value Help. */ sFieldName: string ): void; /** * Retrieves the currently visible filters and the values for storing them as variants. The result will * be passed on as a JSON object to the callee smart variant control. * * * @returns An arbitrary Object with an example structure: * * ```javascript * { * filterBarVariant: any, * filterbar: [ * { * group: string, * name: string, * partOfCurrentVariant: boolean, * visible: boolean, * visibleInFilterBar: boolean * }, * ... * ], * orderedFilterItems: string, * singleInputsTextArrangementData: string, * version: string|undefined, * basicSearch: string|undefined * }``` */ fetchVariant(): sap.ui.comp.filterbar.FilterBar.fetchVariantResponse; /** * Fires event {@link #event:pendingChange pendingChange} to attached listeners. * * @since 1.36 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ firePendingChange( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartfilterbar.SmartFilterBar$PendingChangeEventParameters ): this; /** * Returns the binding paths for the parameters. * * * @returns Binding path of the parameters */ getAnalyticBindingPath(): string; /** * Returns an instance of the control for the basic search. * * * @returns Basic search control */ getBasicSearchControl(): Record; /** * Gets current value of property {@link #getBasicSearchFieldName basicSearchFieldName}. * * Name of the field that is the focus of the basic search. * * * @returns Value of property `basicSearchFieldName` */ getBasicSearchFieldName(): string; /** * Gets current value of property {@link #getConsiderAnalyticalParameters considerAnalyticalParameters}. * * Indicates if the analytical parameters (SelectionVariant) must be taken into consideration. * * Default value is `false`. * * @since 1.42.0 * * @returns Value of property `considerAnalyticalParameters` */ getConsiderAnalyticalParameters(): boolean; /** * Gets current value of property {@link #getConsiderPresentationVariant considerPresentationVariant}. * * Indicates if the annotation `com.sap.vocabularies.UI.v1.PresentationVariant` is taken into account. * * * Default value is `true`. * * * @returns Value of property `considerPresentationVariant` */ getConsiderPresentationVariant(): boolean; /** * Gets current value of property {@link #getConsiderSelectionVariants considerSelectionVariants}. * * Indicates if the annotation `com.sap.vocabularies.UI.v1.SelectionVariant` is taken into account. * **Note**: Only relevant for control level personalization. * * Default value is `false`. * * @deprecated As of version 1.87. Please use the `com.sap.vocabularies.UI.v1.SelectionPresentationVariant` * annotation through the {@link sap.ui.comp.smartvariants.SmartVariantManagement#setEntitySet} * * @returns Value of property `considerSelectionVariants` */ getConsiderSelectionVariants(): boolean; /** * Returns the control (if any) with the specified key (Property name in OData entity). Use just the property * name as the key when getting a control from the basic area. Example: "CompanyCode" & Use "EntityName/GroupName.FieldName" * format to get controls from groups. Example:"Account.CompanyCode" * * @deprecated As of version 1.99. Use {@link sap.ui.core.Core.byId} for custom controls provided by you. * To modify data use {@link sap.ui.comp.smartfilterbar.SmartFilterBar#setFilterData} or {@link sap.ui.comp.filterbar.FilterBar#setUiState}. * * @returns The control in the filter bar, if any */ getControlByKey( /** * The key as present in the OData property name/control configuration */ sKey: string ): Object | sap.ui.core.Control | undefined; /** * Gets content of aggregation {@link #getControlConfiguration controlConfiguration}. * * Using control configurations you can add additional configuration to filter fields, for example set custom * labels, change the order of fields, or change the filter field control type. **Note:** Changing the values * here after the SmartFilter is initialized (`initialise` event was fired) has no effect. */ getControlConfiguration(): sap.ui.comp.smartfilterbar.ControlConfiguration[]; /** * Returns the condition type object (if any) with the specified key (Property name in OData entity). Use * just the property name as the key when getting a control from the basic area. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns returns Promise with condition type object */ getDateRangeTypeByKey( /** * The key as present in the OData property name/control configuration */ sKey: string ): Promise< | sap.ui.comp.smartfilterbar.SmartFilterBar.DateRangeTypeByKeyResponse | undefined >; /** * Gets current value of property {@link #getDefaultSelectionVariantName defaultSelectionVariantName}. * * Determines one specific variant that is based on the `com.sap.vocabularies.UI.v1.SelectionVariant` annotation, * which is then used as the default variant. * This property is only relevant in case `considerSelectionVariants` is set to `true` and will only be * applied if there is no user-defined default variant specified. * **Note**: Only relevant for control level personalization. * * @deprecated As of version 1.87. Please use the `com.sap.vocabularies.UI.v1.SelectionPresentationVariant` * annotation through the {@link sap.ui.comp.smartvariants.SmartVariantManagement#setEntitySet} * * @returns Value of property `defaultSelectionVariantName` */ getDefaultSelectionVariantName(): string; /** * Returns the currently configured default values as a map of property names to condition ranges. * * @since 1.148 * * @returns Map of property names to their condition ranges */ getDefaultValues(): Object; /** * Reads the descriptions for given filters and value keys. * * @since 1.75 * @ui5-protected Do not call from applications (only from related classes in the framework) */ getDescriptionForKeys( /** * List of filters with value keys to be retrieved */ aFiltersWithKeyValues: any[] ): void; /** * Gets current value of property {@link #getEnableBasicSearch enableBasicSearch}. * * Enables the basic search field. The entered value can be accessed with {@link sap.ui.comp.smartfilterbar.SmartFilterBar#getParameters}. * **Note:** When the `SmartFilterBar` control is used with a {@link sap.ui.comp.smarttable.SmartTable } * control the parameters are handled automatically. Therefore, this must only be enabled for OData service * entities that support basic search. * **Note:** basic search field is restricted to 1000 characters and spaces. * * Default value is `false`. * * * @returns Value of property `enableBasicSearch` */ getEnableBasicSearch(): boolean; /** * Gets current value of property {@link #getEntitySet entitySet}. * * The OData entity set whose metadata is used to create the `SmartFilterBar`. **Note:** Changing this value * after the `SmartFilterBar` is initialized (`initialise` event was fired) has no effect. * * * @returns Value of property `entitySet` */ getEntitySet(): string; /** * Gets current value of property {@link #getEntityType entityType}. * * The OData entity type whose metadata is used to create the `SmartFilterBar`. **Note:** Changing this * value after the `SmartFilterBar` is initialized (`initialise` event was fired) has no effect. * * @deprecated As of version 1.40. Use `entitySet` property instead of this one, to enable V4 annotation * support * * @returns Value of property `entityType` */ getEntityType(): string; /** * Get the filter context url. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Filter context url. */ getFilterContextUrl(): string; /** * Returns the data currently set in the filter data model. * * * @returns The JSON data in the filter bar */ getFilterData( /** * Also include empty/invisible fields filter data */ bAllFilterData?: boolean, /** * indication if the filter valueState should be omitted */ bIgnoreErrorState?: boolean ): Object; /** * Returns the data currently set in the filter data model as string. * * * @returns The JSON data string */ getFilterDataAsString( /** * Also include empty/invisible fields filter data */ bAllFilterData: boolean ): string | null; /** * Returns an array of filters (sap.ui.model.Filter instances), for visible fields, that can be used to * restrict the query result from OData. * The result of this method can directly be used during aggregation binding or OData read. * * * @returns array of sap.ui.model.Filter or multi-filters */ getFilters( /** * optional array of field names that filters should be returned, if not given all visible filters are returned */ aFieldNames?: string[] ): sap.ui.model.Filter[]; /** * Returns all filter items * - Containing a value * - With the `visible` property set to `true` * - That are either flagged as `partOfCurrentVariant` or `visibleInFilterBar` * - That are not custom filters Even hidden filters will be considered as long as the mentioned * criteria is fullfilled. * * * @returns Filter items containing a value */ getFiltersWithValues(): sap.ui.comp.filterbar.FilterGroupItem[]; /** * Gets content of aggregation {@link #getGroupConfiguration groupConfiguration}. * * Provides the possibility to add additional configuration to groups. Groups are used to show fields in * the advanced area of the SmartFilterBar. With additional configuration, you can for example set custom * labels or change the order of groups. **Note:** Changing the values here after the SmartFilter is initialized * (`initialise` event was fired) has no effect. */ getGroupConfiguration(): sap.ui.comp.smartfilterbar.GroupConfiguration[]; /** * Gets current value of property {@link #getLiveMode liveMode}. * * If set the search will be automatically triggered, when a filter value was set via the change * event. * **Note:** The liveMode only operates on non-mobile scenarios. * Additionally, if liveMode is set, the following applies: * - The error messagebox is not displayed, and the `showMessages` property is ignored. * - The search is triggered after a variant has been selected. * - Execute on Select for `VariantManagement` is not shown and not taken into account * * Default value is `false`. * * @since 1.40 * * @returns Value of property `liveMode` */ getLiveMode(): boolean; /** * Get the model data. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns of the model data. */ getModelData(): Record; /** * Gets current value of property {@link #getNavigationProperties navigationProperties}. * * This property is only evaluated if the property {@link sap.ui.comp.smartfilterbar.SmartFilterBar#getUseProvidedNavigationProperties } * is set to `true`. It contains a comma-separated list of `NavigationProperty`> names which are checked * for filters. It can also contain a list of separate filters from different `NavigationProperty` names. * * * * Default value is `empty string`. * * @since 1.48 * * @returns Value of property `navigationProperties` */ getNavigationProperties(): string; /** * Returns the binding paths for the parameters. This API can be used for both analytical and non-analytical * services. **Note**For analytical services, the API is NOT stable yet. Use at your own risk. * * @since 1.53.0 * * @returns Binding path of the parameters */ getParameterBindingPath(): string; /** * Get the parameter context url. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Parameter context url. */ getParameterContextUrl(): string; /** * Returns a parameter object that can be used to restrict the result of an OData service request if a basic * search is performed. Example of a returned object: * * * ```javascript * * { * "custom": { * "search-focus": "MySearchFocusFieldName", * "search": "MySearchString" * } * } * ``` * * * These parameters can be handed over as custom parameters, for example, to the {@link sap.ui.model.odata.v2.ODataListBinding}. * * * @returns A parameter object containing OData query parameters */ getParameters(): Record>; /** * Gets current value of property {@link #getResourceUri resourceUri}. * * Optional. The OData service URL. If it is not specified, the service URL from the OData model (this.getModel()) * will be used. **Note:** Changing this value after the SmartFilterBar is initialized (initialise event * was fired) has no effect. * * @deprecated As of version 1.29. Set an ODataModel as the main model on your control/view instead * * @returns Value of property `resourceUri` */ getResourceUri(): string; /** * Gets current value of property {@link #getShowMessages showMessages}. * * If set to `true`, any errors that occur during the search, are displayed in a message box in addition * to the `valueState` with the error. **Note:** As of version 1.89, the default value has been changed * from `true` to `false`. * * Default value is `false`. * * @since 1.40 * * @returns Value of property `showMessages` */ getShowMessages(): boolean; /** * ID of the element which is the current target of the association {@link #getSmartVariant smartVariant}, * or `null`. * * @since 1.38 */ getSmartVariant(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getSuppressSelection suppressSelection}. * * If set to `true` all search requests will be ignored. This functionality is only intended to be used * internally to enable an optimal solution when the filter bar is controlled by the smart templates. NOTE: * As long as this property is set to `true`, all search requests will be neglected. * * Default value is `false`. * * @since 1.44.0 * * @returns Value of property `suppressSelection` */ getSuppressSelection(): boolean; /** * Gets current value of property {@link #getUseDateRangeType useDateRangeType}. * * If set to `true` all date fields with filter restriction `interval` will be treated as `DateTimeRange` * filters. The `useDateRangeType` can be set only once during initialization. **Note:** If this property * is set to `true` and any date filters with filter restriction `interval` were stored as part of a variant, * the values of these filters cannot be applied. If this property is set to `false`, any previously stored * filters which were treated as type `DateTimeRange` based on the former setting, cannot be converted back * to the standard date interval. * * @since 1.46.0 * * @returns Value of property `useDateRangeType` */ getUseDateRangeType(): boolean; /** * Gets current value of property {@link #getUseProvidedNavigationProperties useProvidedNavigationProperties}. * * If set to `true`, only the navigation properties mentioned in property {@link sap.ui.comp.smartfilterbar.SmartFilterBar#getNavigationProperties } * are checked for further filters. * * Default value is `false`. * * @since 1.48 * * @returns Value of property `useProvidedNavigationProperties` */ getUseProvidedNavigationProperties(): boolean; /** * Checks for the provided `sap.ui.comp.smartfilterbar.ControlConfiguration` in the aggregation {@link #getControlConfiguration controlConfiguration}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfControlConfiguration( /** * The controlConfiguration whose index is looked for */ oControlConfiguration: sap.ui.comp.smartfilterbar.ControlConfiguration ): int; /** * Checks for the provided `sap.ui.comp.smartfilterbar.GroupConfiguration` in the aggregation {@link #getGroupConfiguration groupConfiguration}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfGroupConfiguration( /** * The groupConfiguration whose index is looked for */ oGroupConfiguration: sap.ui.comp.smartfilterbar.GroupConfiguration ): int; /** * Inserts a controlConfiguration into the aggregation {@link #getControlConfiguration controlConfiguration}. * * * @returns Reference to `this` in order to allow method chaining */ insertControlConfiguration( /** * The controlConfiguration to insert; if empty, nothing is inserted */ oControlConfiguration: sap.ui.comp.smartfilterbar.ControlConfiguration, /** * The `0`-based index the controlConfiguration should be inserted at; for a negative value of `iIndex`, * the controlConfiguration is inserted at position 0; for a value greater than the current size of the * aggregation, the controlConfiguration is inserted at the last position */ iIndex: int ): this; /** * Inserts a groupConfiguration into the aggregation {@link #getGroupConfiguration groupConfiguration}. * * * @returns Reference to `this` in order to allow method chaining */ insertGroupConfiguration( /** * The groupConfiguration to insert; if empty, nothing is inserted */ oGroupConfiguration: sap.ui.comp.smartfilterbar.GroupConfiguration, /** * The `0`-based index the groupConfiguration should be inserted at; for a negative value of `iIndex`, the * groupConfiguration is inserted at position 0; for a value greater than the current size of the aggregation, * the groupConfiguration is inserted at the last position */ iIndex: int ): this; /** * Checks whether the control is initialised * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns returns whether control is already initialised */ isInitialised(): boolean; /** * Determines if the custom data 'dateFormatSettings' is set with UTC mode `true` * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns returns whether the filter bar is running in UTC mode */ isInUTCMode(): boolean; /** * Checks the pending state of the FilterBar control * * * @returns true if at least one FilterItem element of the FilterBar control is pending */ isPending(): boolean; /** * Removes all the controls from the aggregation {@link #getControlConfiguration controlConfiguration}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllControlConfiguration(): sap.ui.comp.smartfilterbar.ControlConfiguration[]; /** * Removes all the controls from the aggregation {@link #getGroupConfiguration groupConfiguration}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllGroupConfiguration(): sap.ui.comp.smartfilterbar.GroupConfiguration[]; /** * Removes a controlConfiguration from the aggregation {@link #getControlConfiguration controlConfiguration}. * * * @returns The removed controlConfiguration or `null` */ removeControlConfiguration( /** * The controlConfiguration to remove or its index or id */ vControlConfiguration: | int | string | sap.ui.comp.smartfilterbar.ControlConfiguration ): sap.ui.comp.smartfilterbar.ControlConfiguration | null; /** * Removes a groupConfiguration from the aggregation {@link #getGroupConfiguration groupConfiguration}. * * * @returns The removed groupConfiguration or `null` */ removeGroupConfiguration( /** * The groupConfiguration to remove or its index or id */ vGroupConfiguration: | int | string | sap.ui.comp.smartfilterbar.GroupConfiguration ): sap.ui.comp.smartfilterbar.GroupConfiguration | null; /** * Resumes calls to the `search` method. If it was called during the suspension, the search will be triggered * once regardless of how many times it was called during suspension. */ resumeSelection(): void; /** * Overwrites method from base class. Called when user clicks the search button of the FilterBar. The search * is executed asynchronously per default, but can be forced to synchronously execution by providing the * `bSync` set to `true`. Synchronous mode is only supported for non live mode scenarios. In the synchronous * mode a mandatory check prior to the search execution is made. * * * @returns Indicates if there are validation errors. NOTE: can also return 'undefined' (e.g. when 'suppressSelection' * is set). This cannot be expressed in the TypeScript API because this is incompatible to the parent class' * 'search' method return value. */ search( /** * Indicates if the search should be triggered synchronously */ bSync?: boolean ): boolean; /** * Sets a new value for property {@link #getBasicSearchFieldName basicSearchFieldName}. * * Name of the field that is the focus of the basic search. * * 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 */ setBasicSearchFieldName( /** * New value for property `basicSearchFieldName` */ sBasicSearchFieldName?: string ): this; /** * Sets a new value for property {@link #getConsiderAnalyticalParameters considerAnalyticalParameters}. * * Indicates if the analytical parameters (SelectionVariant) must be taken into consideration. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.42.0 * * @returns Reference to `this` in order to allow method chaining */ setConsiderAnalyticalParameters( /** * New value for property `considerAnalyticalParameters` */ bConsiderAnalyticalParameters?: boolean ): this; /** * Sets a new value for property {@link #getConsiderPresentationVariant considerPresentationVariant}. * * Indicates if the annotation `com.sap.vocabularies.UI.v1.PresentationVariant` is taken into account. * * * 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 */ setConsiderPresentationVariant( /** * New value for property `considerPresentationVariant` */ bConsiderPresentationVariant?: boolean ): this; /** * Sets a new value for property {@link #getConsiderSelectionVariants considerSelectionVariants}. * * Indicates if the annotation `com.sap.vocabularies.UI.v1.SelectionVariant` is taken into account. * **Note**: Only relevant for control level personalization. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @deprecated As of version 1.87. Please use the `com.sap.vocabularies.UI.v1.SelectionPresentationVariant` * annotation through the {@link sap.ui.comp.smartvariants.SmartVariantManagement#setEntitySet} * * @returns Reference to `this` in order to allow method chaining */ setConsiderSelectionVariants( /** * New value for property `considerSelectionVariants` */ bConsiderSelectionVariants?: boolean ): this; /** * Sets the the Dynamic Date Option of condition type (if any) data in the filter data model. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns returns Promise */ setDateRangeTypeOperationByKey( /** * The key as present in the OData property name/control configuration */ sKey: string, /** * The key of Dynamic Date Option */ sOption: string ): Promise< | sap.ui.comp.smartfilterbar.SmartFilterBar.DateRangeTypeByKeyResponse | undefined >; /** * Sets a new value for property {@link #getDefaultSelectionVariantName defaultSelectionVariantName}. * * Determines one specific variant that is based on the `com.sap.vocabularies.UI.v1.SelectionVariant` annotation, * which is then used as the default variant. * This property is only relevant in case `considerSelectionVariants` is set to `true` and will only be * applied if there is no user-defined default variant specified. * **Note**: Only relevant for control level personalization. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @deprecated As of version 1.87. Please use the `com.sap.vocabularies.UI.v1.SelectionPresentationVariant` * annotation through the {@link sap.ui.comp.smartvariants.SmartVariantManagement#setEntitySet} * * @returns Reference to `this` in order to allow method chaining */ setDefaultSelectionVariantName( /** * New value for property `defaultSelectionVariantName` */ sDefaultSelectionVariantName?: string ): this; /** * Configures which filter fields support the DefaultValues operation and sets their predefined conditions. * Only the listed fields will have DefaultValues support enabled. Can be called before the SmartFilterBar * is initialized; the configuration will be applied once initialization completes. * * **Note:** When {@link sap.ui.comp.filterbar.FilterBar#setUiState} is called (e.g. during iAppState restore), * DefaultValues tokens are never displayed. Instead, only the concrete values from the SelectionVariant * are shown as regular filter tokens. This ensures that the externally provided state always takes precedence * over DefaultValues. * * @since 1.148 */ setDefaultValues( /** * Map of property names to their condition ranges, e.g. * ```javascript * * { * "Field1": [ * { Sign: "I", Option: "EQ", Low: "value", High: null } * ], * "Field2": [ * { Sign: "I", Option: "BT", Low: "low", High: "high" } * ] * } * ``` * Each key is a filter field property name. Each value is an array of condition objects with: * - `Sign` - "I" (include) or "E" (exclude) * - `Option` - Operator such as "EQ", "BT", "GT", "LT", "Contains", etc. * - `Low` - The low value of the condition * - `High` - The high value (used with "BT" operator, otherwise `null`) */ oFieldConditions: Record< string, /* was: sap.ui.comp.smartfilterbar.SelectOptionType */ any[] > ): void; /** * Sets a new value for property {@link #getEnableBasicSearch enableBasicSearch}. * * Enables the basic search field. The entered value can be accessed with {@link sap.ui.comp.smartfilterbar.SmartFilterBar#getParameters}. * **Note:** When the `SmartFilterBar` control is used with a {@link sap.ui.comp.smarttable.SmartTable } * control the parameters are handled automatically. Therefore, this must only be enabled for OData service * entities that support basic search. * **Note:** basic search field is restricted to 1000 characters and spaces. * * 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 */ setEnableBasicSearch( /** * New value for property `enableBasicSearch` */ bEnableBasicSearch?: boolean ): this; /** * Sets a new value for property {@link #getEntityType entityType}. * * The OData entity type whose metadata is used to create the `SmartFilterBar`. **Note:** Changing this * value after the `SmartFilterBar` is initialized (`initialise` event was fired) has no effect. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @deprecated As of version 1.40. Use `entitySet` property instead of this one, to enable V4 annotation * support * * @returns Reference to `this` in order to allow method chaining */ setEntityType( /** * New value for property `entityType` */ sEntityType?: string ): this; /** * Sets the data in the filter data model. The follow-on filterChange event is only triggered when none * _CUSTOM data is set. */ setFilterData( /** * The JSON data in the filter bar */ oJson: object, /** * Replace existing filter data */ bReplace: boolean ): void; /** * Sets the data in the filter data model as string. */ setFilterDataAsString( /** * The JSON data in the filter bar */ sJson: string, /** * Replace existing filter data */ bReplace: boolean ): void; /** * Sets a new value for property {@link #getLiveMode liveMode}. * * If set the search will be automatically triggered, when a filter value was set via the change * event. * **Note:** The liveMode only operates on non-mobile scenarios. * Additionally, if liveMode is set, the following applies: * - The error messagebox is not displayed, and the `showMessages` property is ignored. * - The search is triggered after a variant has been selected. * - Execute on Select for `VariantManagement` is not shown and not taken into account * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.40 * * @returns Reference to `this` in order to allow method chaining */ setLiveMode( /** * New value for property `liveMode` */ bLiveMode?: boolean ): this; /** * Sets a new value for property {@link #getNavigationProperties navigationProperties}. * * This property is only evaluated if the property {@link sap.ui.comp.smartfilterbar.SmartFilterBar#getUseProvidedNavigationProperties } * is set to `true`. It contains a comma-separated list of `NavigationProperty`> names which are checked * for filters. It can also contain a list of separate filters from different `NavigationProperty` names. * * * * 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.48 * * @returns Reference to `this` in order to allow method chaining */ setNavigationProperties( /** * New value for property `navigationProperties` */ sNavigationProperties?: string ): this; /** * Uses the provided resource URI to fetch the OData metadata instead of using the default ODataModel (getModel()). * You should only set this if you intend to get the metadata for the filter bar from elsewhere! * * @deprecated As of version 1.29. Set an ODataModel as the main model on your control/view instead * * @returns `this` to allow method chaining */ setResourceUri( /** * The URI of the oData service from which the metadata would be read */ sResourceUri: string ): this; /** * Sets a new value for property {@link #getShowMessages showMessages}. * * If set to `true`, any errors that occur during the search, are displayed in a message box in addition * to the `valueState` with the error. **Note:** As of version 1.89, the default value has been changed * from `true` to `false`. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.40 * * @returns Reference to `this` in order to allow method chaining */ setShowMessages( /** * New value for property `showMessages` */ bShowMessages?: boolean ): this; /** * Sets the associated {@link #getSmartVariant smartVariant}. * * @since 1.38 * * @returns Reference to `this` in order to allow method chaining */ setSmartVariant( /** * ID of an element which becomes the new target of this smartVariant association; alternatively, an element * instance may be given */ oSmartVariant: | sap.ui.core.ID | sap.ui.comp.smartvariants.SmartVariantManagement ): this; /** * Sets a new value for property {@link #getSuppressSelection suppressSelection}. * * If set to `true` all search requests will be ignored. This functionality is only intended to be used * internally to enable an optimal solution when the filter bar is controlled by the smart templates. NOTE: * As long as this property is set to `true`, all search requests will be neglected. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.44.0 * * @returns Reference to `this` in order to allow method chaining */ setSuppressSelection( /** * New value for property `suppressSelection` */ bSuppressSelection?: boolean ): this; /** * Sets a new value for property {@link #getUseDateRangeType useDateRangeType}. * * If set to `true` all date fields with filter restriction `interval` will be treated as `DateTimeRange` * filters. The `useDateRangeType` can be set only once during initialization. **Note:** If this property * is set to `true` and any date filters with filter restriction `interval` were stored as part of a variant, * the values of these filters cannot be applied. If this property is set to `false`, any previously stored * filters which were treated as type `DateTimeRange` based on the former setting, cannot be converted back * to the standard date interval. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.46.0 * * @returns Reference to `this` in order to allow method chaining */ setUseDateRangeType( /** * New value for property `useDateRangeType` */ bUseDateRangeType?: boolean ): this; /** * Sets a new value for property {@link #getUseProvidedNavigationProperties useProvidedNavigationProperties}. * * If set to `true`, only the navigation properties mentioned in property {@link sap.ui.comp.smartfilterbar.SmartFilterBar#getNavigationProperties } * are checked for further filters. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.48 * * @returns Reference to `this` in order to allow method chaining */ setUseProvidedNavigationProperties( /** * New value for property `useProvidedNavigationProperties` */ bUseProvidedNavigationProperties?: boolean ): this; /** * Suspends calls to the `search` method when not called with the `bSync` parameter. */ suspendSelection(): void; /** * Verifies if all mandatory filters or parameters have values. * * * @returns true indicates that all mandatory filters and parameters have values. */ validateMandatoryFields(): boolean; /** * Verifies if search is possible. * * * @returns An empty object indicates that all is fine and the search can be triggered. * An object with the property mandatory indicates that some mandatory filters or parameters are empty * * An object with the property pending indicates that a token validation is going on. * An object with the property error indicates that some filters, parameters or the BasicSearch are in * error state. */ verifySearchAllowed(): sap.ui.comp.smartfilterbar.SmartFilterBar.SearchAllowed; } /** * Represents a filter belonging to a group other than basic. */ class SmartFilterBarFilterGroupItem extends sap.ui.comp.filterbar .FilterGroupItem { /** * Constructor for a new FilterBar/FilterGroupItem. * * 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.comp.filterbar.FilterGroupItem#constructor sap.ui.comp.filterbar.FilterGroupItem } * can be used. */ constructor( /** * Initial settings for the new control */ mSettings?: sap.ui.comp.smartfilterbar.$SmartFilterBarFilterGroupItemSettings ); /** * Constructor for a new FilterBar/FilterGroupItem. * * 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.comp.filterbar.FilterGroupItem#constructor sap.ui.comp.filterbar.FilterGroupItem } * 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.ui.comp.smartfilterbar.$SmartFilterBarFilterGroupItemSettings ); /** * Creates a new subclass of class sap.ui.comp.smartfilterbar.SmartFilterBarFilterGroupItem 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.comp.filterbar.FilterGroupItem.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< T, sap.ui.comp.smartfilterbar.SmartFilterBarFilterGroupItem >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartfilterbar.SmartFilterBarFilterGroupItem. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Returns instance of the control * * @deprecated As of version 1.99. Use {@link sap.ui.core.Core.byId} instead! * * @returns A control or `null` if there is no control with provided name */ getControl(): sap.ui.core.Control | null; /** * @deprecated As of version 1.99. There is no replacement as all internal controls are considered private. */ setControl( /** * associated with the filter. */ oControl: sap.ui.core.Control ): void; } /** * The available control types to configure the internal control selection of a SmartFilterBar control. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartfilterbar.ControlType'. */ enum ControlType { /** * Shows field based on metadata. */ auto = "auto", /** * Shows a date picker field. */ date = "date", /** * Shows a date time picker field. */ dateTimePicker = "dateTimePicker", /** * Shows a drop down list field. */ dropDownList = "dropDownList", /** * Shows an input field. */ input = "input", } /** * The different options to define display behavior for fields in the SmartFilter control. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartfilterbar.DisplayBehaviour'. */ enum DisplayBehaviour { /** * Shows values based on metadata. */ auto = "auto", /** * Shows description and then an id in values. */ descriptionAndId = "descriptionAndId", /** * Shows only the description for values. */ descriptionOnly = "descriptionOnly", /** * Shows id and then a description in values. */ idAndDescription = "idAndDescription", /** * Shows only the id for values. */ idOnly = "idOnly", } /** * The available filter types to configure the internal control of a SmartFilterBar control. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartfilterbar.FilterType'. */ enum FilterType { /** * Restrict filter based on metadata. */ auto = "auto", /** * Restrict filter to an interval. */ interval = "interval", /** * Restrict filter to multiple entries. */ multiple = "multiple", /** * Restrict filter to be used as first operand in startswith, endswith, and contains clauses. * * @since 1.107 */ searchExpression = "searchExpression", /** * Restrict filter to a single entry. */ single = "single", } /** * The different options to define mandatory state for fields in the SmartFilter control. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartfilterbar.MandatoryType'. */ enum MandatoryType { /** * Shows values based on metadata. */ auto = "auto", /** * Shows field as mandatory. */ mandatory = "mandatory", /** * Shows field as not mandatory. */ notMandatory = "notMandatory", } /** * The different options to define Sign for Select Options used in SmartFilter control. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartfilterbar.SelectOptionSign'. */ enum SelectOptionSign { /** * Sign Exclude */ E = "E", /** * Sign Exclude */ exclude = "E", /** * Sign Include */ I = "I", /** * Sign Include */ include = "I", } /** * Event object of the ControlConfiguration#change event. */ type ControlConfiguration$ChangeEvent = sap.ui.base.Event< ControlConfiguration$ChangeEventParameters, ControlConfiguration >; /** * Event object of the GroupConfiguration#change event. */ type GroupConfiguration$ChangeEvent = sap.ui.base.Event< GroupConfiguration$ChangeEventParameters, GroupConfiguration >; /** * Event object of the SmartFilterBar#pendingChange event. */ type SmartFilterBar$PendingChangeEvent = sap.ui.base.Event< SmartFilterBar$PendingChangeEventParameters, SmartFilterBar >; } namespace smartform { /** * Marker interface for SmartForm layouts. * * @since 1.56.0 */ interface SmartFormLayout { __implements__sap_ui_comp_smartform_SmartFormLayout: boolean; } /** * Describes the settings that can be provided to the ColumnLayout constructor. */ interface $ColumnLayoutSettings extends sap.ui.core.$ElementSettings { /** * Number of columns for extra-large size. * * The number of columns for extra-large size must not be smaller than the number of columns for large size. */ columnsXL?: | sap.ui.layout.form.ColumnsXL | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Number of columns for large size. * * The number of columns for large size must not be smaller than the number of columns for medium size. */ columnsL?: | sap.ui.layout.form.ColumnsL | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Number of columns for medium size. */ columnsM?: | sap.ui.layout.form.ColumnsM | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines how many cells a label uses if the column is large. */ labelCellsLarge?: | sap.ui.layout.form.ColumnCells | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines how many cells are empty at the end of a row. This could be used to keep the fields small on * large screens. */ emptyCellsLarge?: | sap.ui.layout.form.EmptyCells | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the Group constructor. */ interface $GroupSettings extends sap.ui.layout.form.$FormContainerSettings { /** * Specifies whether the groups are rendered in a `ResponsiveLayout` with label on top of the group element. * Each group will be rendered in a new line. * * **Note:** If `Group` is assigned to a `SmartForm` control, this property is inherited from the `SmartForm` * control. * * So don't set it to a different value from the one in the `SmartForm` control. For performance reasons * it might make sense to set it manually to the same value as the one in the `SmartForm` control when creating * the `Group` element. * * @deprecated As of version 1.86. replaced by {@link sap.ui.comp.smartform.ColumnLayout ColumnLayout} in * the `layout` aggregation of the `SmartForm` control. */ useHorizontalLayout?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies the minimal size in pixels of all group elements of the form if horizontal Layout is used. * * **Note:** If `Group` is assigned to a `SmartForm` control, this property is inherited from the `SmartForm` * control. So don't set it manually. * * @deprecated As of version 1.48.0. please do not use this property as it does not have any effect on the * current layout of the `SmartForm` control. */ horizontalLayoutGroupElementMinWidth?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Label for the group. * * @deprecated As of version 1.88. replaced by `title` aggregation. */ label?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * A `GroupElement` is a combination of one label and different controls associated to this label. */ groupElements?: | sap.ui.comp.IFormGroupElement[] | sap.ui.comp.IFormGroupElement | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Layout to specify how the group shall be rendered (e.g. span and line-break) * * **Note:** Do not use `layout` and `layoutData` aggregations combined. * * @deprecated As of version 1.48.0. please use `layoutData` aggregation instead. */ layout?: sap.ui.layout.GridData; } /** * Describes the settings that can be provided to the GroupElement constructor. */ interface $GroupElementSettings extends sap.ui.layout.form.$FormElementSettings { /** * Specifies whether the groups shall be rendered in a `ResponsiveLayout` with label on top of the group * element. Each group will be rendered in a new line. * * **Note:** If `Group` is assigned to a `SmartForm` control, this property is inherited from the `SmartForm` * control. * * So don't set it to a different value from the one in the `SmartForm` control. For performance reasons * it might make sense to set it manually to the same value as the one in the `SmartForm` control when creating * the `GroupElement` element. * * @deprecated As of version 1.86. replaced by {@link sap.ui.comp.smartform.ColumnLayout ColumnLayout} in * the `layout` aggregation of the `SmartForm` control. */ useHorizontalLayout?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies the minimal size in pixels of all group elements of the form if horizontal Layout is used. * * **Note:** If `Group` is assigned to a `SmartForm` control, this property is inherited from the `SmartForm` * control. So don't set it manually. * * @deprecated As of version 1.48.0. please do not use this property as it does not have any effect on the * current layout of the `SmartForm` control. */ horizontalLayoutGroupElementMinWidth?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Index of element to be used for label determination */ elementForLabel?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Aggregation of controls to be displayed together with a label. * * **Warning:** Do not put any layout or other container controls in here. This could damage the visual * layout, keyboard support and screen-reader support. Only form controls are allowed. Views are also not * supported. Allowed controls implement the interface `sap.ui.core.IFormContent`. */ elements?: | sap.ui.core.Control[] | sap.ui.core.Control | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * The event is fired after the visibility of the control has changed. */ visibleChanged?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the Layout constructor. */ interface $LayoutSettings extends sap.ui.core.$ElementSettings { /** * Default span for labels in extra large size. * * @since 1.38.0 */ labelSpanXL?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Default span for labels in large size. This span is only used if more than 1 container is in one line, * if only 1 container is in the line the `labelSpanM` value is used. */ labelSpanL?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Default span for labels in medium size. This property is used for full size containers. If more than * one Container is in one line, `labelSpanL` is used. */ labelSpanM?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Default span for labels in small size. */ labelSpanS?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Number of grid cells that are empty at the end of each line on extra large size. * * @since 1.38.0 */ emptySpanXL?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Number of grid cells that are empty at the end of each line on large size. */ emptySpanL?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Number of grid cells that are empty at the end of each line on medium size. */ emptySpanM?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Number of grid cells that are empty at the end of each line on small size. */ emptySpanS?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Number of columns for extra large size. * The number of columns for extra large size must not be smaller than the number of columns for large * size. * * @since 1.38.0 */ columnsXL?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Number of columns for large size. * The number of columns for large size must not be smaller than the number of columns for medium size. */ columnsL?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Number of columns for medium size. */ columnsM?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If the `SmartForm` contains only one single Group and this property is set, the Group is displayed using * the full size of the `SmartForm`. In this case the properties `columnsL` and `columnsM` are ignored. * In all other cases the Group is displayed in the size of one column. * * @since 1.34.1 */ singleGroupFullSize?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Breakpoint (in pixel) between large size and extra large (XL) size. * * @since 1.38.0 */ breakpointXL?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Breakpoint (in pixel) between Medium size and Large size. */ breakpointL?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * reakpoint (in pixel) between Small size and Medium size. */ breakpointM?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * A string type that represents Grid's span values for large, medium and small screens. Allowed values * are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container * has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided * in the order large medium small. * The value set here will be set to all group elements when used with horizontal layout (`SmartForm` property * `useHorizontalLayout`) */ gridDataSpan?: | sap.ui.layout.GridSpan | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the SemanticGroupElement constructor. */ interface $SemanticGroupElementSettings extends sap.ui.layout.form.$SemanticFormElementSettings { /** * Index of element to be used for label determination */ elementForLabel?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Aggregation of controls to be displayed together with a label and separated by delimiter. * * **Warning:** Do not put any layout or other container controls in here. This could damage the visual * layout, keyboard support and screen-reader support. Views are also not supported. Only form controls * are allowed. Allowed controls implement the interface `sap.ui.core.IFormContent`. */ elements?: | sap.ui.core.Control[] | sap.ui.core.Control | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * The event is fired after the visibility of the control has changed. */ visibleChanged?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the SmartForm constructor. */ interface $SmartFormSettings extends sap.ui.core.$ControlSettings { /** * Title of the form. * * **Note:** The title is rendered with a theme-dependent default level. As the `SmartForm` control cannot * know the structure of the page, this might not fit the page structure. In this case provide the title * using a {@link sap.m.Title Title} control and set its {@link sap.m.Title#setLevel level} to the required * value. Add this title to a {@link sap.m.Toolbar Toolbar} control and assign it to the `SmartForm` using * the `customToolbar` aggregation. */ title?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Specifies whether the groups are rendered in a {@link sap.ui.layout.form.ResponsiveLayout ResponsiveLayout } * with the label above the field. Each group is rendered in a new line. * * **Note:** This property should no longer be used. To arrange the fields in columns, {@link sap.ui.comp.smartform.ColumnLayout ColumnLayout } * should be used in the `layout` aggregation. * * **Note:** The value of this property will be passed on to the `useHorizontalLayout` property of all `Group` * and `GroupElement` elements. * * @deprecated As of version 1.86. replaced by {@link sap.ui.comp.smartform.ColumnLayout ColumnLayout} in * the `layout` aggregation. */ useHorizontalLayout?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies the minimal size in pixels of all group elements of the form if the horizontal layout is used. * * @deprecated As of version 1.48.0. please do not use this property as it does not have any effect on the * current layout of the `SmartForm` control. */ horizontalLayoutGroupElementMinWidth?: | int | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies whether a check button is added to the toolbar. */ checkButton?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * CSV of entity types for which the flexibility features are available. * For more information about SAPUI5 flexibility, refer to the Developer Guide. * **Note:** No validation is done. Please ensure that you do not add spaces or special characters. */ entityType?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Specifies whether the control is expandable. Per default the control is not rendered as expanded. */ expandable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If expandable, this property indicates whether the state is expanded or not. If expanded, then the toolbar * (if available) and the content is rendered; if expanded is false, then only the headerText/headerToolbar * is rendered. */ expanded?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `true`, a button to toggle the `editable` property is shown in the toolbar. */ editTogglable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Applies a device-specific and theme-specific line height and label alignment to the form rows if the * form has editable content. If set, all (not only the editable) rows of the form will get the line height * of editable fields. * * The labels inside the form will be rendered by default in the according mode. * * **Note:** The setting of this property will be passed to all `SmartField` controls inside the form, so * they will be editable if the form is editable. * * **Warning:** The setting of this property will not be passed to controls other than `SmartField`. For * example, `Input` controls in a form with `editable` set to `false` are still editable. * * If controls other than `SmartField` controls are used, and the edit mode of their control is not set * correctly, this might lead to visual issues. The labels and fields might be misaligned, the labels might * be rendered in the wrong mode, and the spacing between the single controls might be wrong. Also, controls * that do not fit the mode might be rendered incorrectly. */ editable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * A list of fields that must not be available in the key-user adaptation dialog. Listed field names are * separated by commas. * * The property is designed to be used by SAP Fiori elements, and it’s not evaluated by the `SmartForm` * control itself. * * **Note:** * Please ensure that you do not add spaces or special characters as no validation is done for this property. */ ignoredFields?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Specifies whether the form enables flexibility features, such as adding new fields. * For more information about SAPUI5 flexibility, refer to the Developer Guide. */ flexEnabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the SmartForm validation mode. The default mode handles only nested `SmartField` controls with * synchronous validation. If the `SmartForm` should also handle controls with asynchronous validation the * property should be set to `Async` mode which is the recommended mode to be used as all types of nested * fields validation are handled. * * Note: Using `Async` mode the method `check` will return a promise instead of an array. * * Note: Using `Async` mode the event `checked` will be called asynchronously when all the nested `SmartField` * validations are executed. * * @since 1.81 */ validationMode?: | sap.ui.comp.smartform.SmartFormValidationMode | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies which smart fields will be visible inside the `SmartForm`. * * If set to **high**, only smart fields with high importance will be visible. * * If set to **medium**, only smart fields with high and medium importance will be visible. * * If set to **low** (default), all the smart fields will be visible regardless of their importance. * * Note: If a smart field is annotated as mandatory or hidden, its visibility will not be affected * by the `importance` property. * * @since 1.87 */ importance?: | sap.ui.comp.smartform.Importance | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Groups are used to group form elements. */ groups?: | sap.ui.comp.smartform.Group[] | sap.ui.comp.smartform.Group | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Layout settings to adjust the used layout. * * Use {@link sap.ui.comp.smartform.ColumnLayout ColumnLayout} to have the current UI. */ layout?: sap.ui.comp.smartform.SmartFormLayout; /** * The Semantic Object Controller allows the user to specify and overwrite functionality for semantic object * navigation. */ semanticObjectController?: sap.ui.comp.navpopover.SemanticObjectController; /** * An additional toolbar that can be added by the users, which can contain further custom buttons, controls, * etc. * * **Note:** If a special title is required inside the `Toolbar`, it must be added as content to the `Toolbar`. * In this case add the `Title` to the `ariaLabelledBy` association. Use the required title level to meet * the visual requirements. This might be theme-dependent. */ customToolbar?: sap.m.Toolbar; /** * Association to controls / IDs that label this control (see WAI-ARIA attribute `aria-labelledby`). * * @since 1.56.0 */ ariaLabelledBy?: Array; /** * This event is fired when the editable property is toggled. */ editToggled?: (oEvent: SmartForm$EditToggledEvent) => void; /** * This event is fired after check was performed. */ checked?: (oEvent: SmartForm$CheckedEvent) => void; } /** * Parameters of the GroupElement#visibleChanged event. */ interface GroupElement$VisibleChangedEventParameters {} /** * Parameters of the SemanticGroupElement#visibleChanged event. */ interface SemanticGroupElement$VisibleChangedEventParameters {} /** * Parameters of the SmartForm#checked event. */ interface SmartForm$CheckedEventParameters { /** * An array containing all smart fields with errors */ erroneousFields?: sap.ui.comp.smartfield.SmartField[]; } /** * Parameters of the SmartForm#editToggled event. */ interface SmartForm$EditToggledEventParameters { /** * If `true`, the control is in edit mode */ editable?: boolean; } /** * If this layout is used in a `SmartForm` control, a `ColumnLayout` control is used to render the `Form` * control. * * **Note:** If this layout is used, the `useHorizontalLayout` property of the `SmartForm` control must * not be set. * * @since 1.56.0 */ class ColumnLayout extends sap.ui.core.Element implements sap.ui.comp.smartform.SmartFormLayout { __implements__sap_ui_comp_smartform_SmartFormLayout: boolean; /** * Constructor for a new smartform/ColumnLayout. * * 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.ui.comp.smartform.$ColumnLayoutSettings ); /** * Constructor for a new smartform/ColumnLayout. * * 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.ui.comp.smartform.$ColumnLayoutSettings ); /** * Creates a new subclass of class sap.ui.comp.smartform.ColumnLayout with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartform.ColumnLayout. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getColumnsL columnsL}. * * Number of columns for large size. * * The number of columns for large size must not be smaller than the number of columns for medium size. * * Default value is `2`. * * * @returns Value of property `columnsL` */ getColumnsL(): sap.ui.layout.form.ColumnsL; /** * Gets current value of property {@link #getColumnsM columnsM}. * * Number of columns for medium size. * * Default value is `1`. * * * @returns Value of property `columnsM` */ getColumnsM(): sap.ui.layout.form.ColumnsM; /** * Gets current value of property {@link #getColumnsXL columnsXL}. * * Number of columns for extra-large size. * * The number of columns for extra-large size must not be smaller than the number of columns for large size. * * Default value is `2`. * * * @returns Value of property `columnsXL` */ getColumnsXL(): sap.ui.layout.form.ColumnsXL; /** * Gets current value of property {@link #getEmptyCellsLarge emptyCellsLarge}. * * Defines how many cells are empty at the end of a row. This could be used to keep the fields small on * large screens. * * Default value is `0`. * * * @returns Value of property `emptyCellsLarge` */ getEmptyCellsLarge(): sap.ui.layout.form.EmptyCells; /** * Gets current value of property {@link #getLabelCellsLarge labelCellsLarge}. * * Defines how many cells a label uses if the column is large. * * Default value is `4`. * * * @returns Value of property `labelCellsLarge` */ getLabelCellsLarge(): sap.ui.layout.form.ColumnCells; /** * Sets a new value for property {@link #getColumnsL columnsL}. * * Number of columns for large size. * * The number of columns for large size must not be smaller than the number of columns for medium size. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `2`. * * * @returns Reference to `this` in order to allow method chaining */ setColumnsL( /** * New value for property `columnsL` */ sColumnsL?: sap.ui.layout.form.ColumnsL ): this; /** * Sets a new value for property {@link #getColumnsM columnsM}. * * Number of columns for medium size. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `1`. * * * @returns Reference to `this` in order to allow method chaining */ setColumnsM( /** * New value for property `columnsM` */ sColumnsM?: sap.ui.layout.form.ColumnsM ): this; /** * Sets a new value for property {@link #getColumnsXL columnsXL}. * * Number of columns for extra-large size. * * The number of columns for extra-large size must not be smaller than the number of columns for large size. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `2`. * * * @returns Reference to `this` in order to allow method chaining */ setColumnsXL( /** * New value for property `columnsXL` */ sColumnsXL?: sap.ui.layout.form.ColumnsXL ): this; /** * Sets a new value for property {@link #getEmptyCellsLarge emptyCellsLarge}. * * Defines how many cells are empty at the end of a row. This could be used to keep the fields small on * large screens. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setEmptyCellsLarge( /** * New value for property `emptyCellsLarge` */ sEmptyCellsLarge?: sap.ui.layout.form.EmptyCells ): this; /** * Sets a new value for property {@link #getLabelCellsLarge labelCellsLarge}. * * Defines how many cells a label uses if the column is large. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `4`. * * * @returns Reference to `this` in order to allow method chaining */ setLabelCellsLarge( /** * New value for property `labelCellsLarge` */ sLabelCellsLarge?: sap.ui.layout.form.ColumnCells ): this; } /** * Groups are used to group group elements. */ class Group extends sap.ui.layout.form.FormContainer { /** * Constructor for a new smartform/Group. * * 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.ui.comp.smartform.$GroupSettings ); /** * Constructor for a new smartform/Group. * * 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.ui.comp.smartform.$GroupSettings ); /** * Creates a new subclass of class sap.ui.comp.smartform.Group with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.form.FormContainer.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartform.Group. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some CustomData into the aggregation `customData`. * * **Note:** `customData` that is used by the `SmartField` control itself is also added to the `GroupElement` * elements and the `SmartField` controls in the children hierarchy. Additional `customData` that is not * used by the `SmartField` control internally might not be added. * * * @returns Reference to `this` to allow method chaining. */ addCustomData( /** * the customData to add; if empty, nothing is added */ oCustomData: sap.ui.core.CustomData ): this; /** * Adds some groupElement to the aggregation {@link #getGroupElements groupElements}. * * * @returns Reference to `this` in order to allow method chaining */ addGroupElement( /** * The groupElement to add; if empty, nothing is inserted */ oGroupElement: sap.ui.comp.IFormGroupElement ): this; /** * Destroys all the groupElements in the aggregation {@link #getGroupElements groupElements}. * * * @returns Reference to `this` in order to allow method chaining */ destroyGroupElements(): this; /** * Destroys the layout in the aggregation {@link #getLayout layout}. * * @deprecated As of version 1.48.0. please use `layoutData` aggregation instead. * * @returns Reference to `this` in order to allow method chaining */ destroyLayout(): this; /** * Destroys the title in the aggregation `title`. * * * @returns `this` to allow method chaining */ destroyTitle(): this; /** * Gets content of aggregation {@link #getGroupElements groupElements}. * * A `GroupElement` is a combination of one label and different controls associated to this label. */ getGroupElements(): sap.ui.comp.IFormGroupElement[]; /** * Gets current value of property {@link #getHorizontalLayoutGroupElementMinWidth horizontalLayoutGroupElementMinWidth}. * * Specifies the minimal size in pixels of all group elements of the form if horizontal Layout is used. * * **Note:** If `Group` is assigned to a `SmartForm` control, this property is inherited from the `SmartForm` * control. So don't set it manually. * * @deprecated As of version 1.48.0. please do not use this property as it does not have any effect on the * current layout of the `SmartForm` control. * * @returns Value of property `horizontalLayoutGroupElementMinWidth` */ getHorizontalLayoutGroupElementMinWidth(): int; /** * Gets current value of property {@link #getLabel label}. * * Label for the group. * * @deprecated As of version 1.88. replaced by `title` aggregation. * * @returns Value of property `label` */ getLabel(): string; /** * Gets content of aggregation {@link #getLayout layout}. * * Layout to specify how the group shall be rendered (e.g. span and line-break) * * **Note:** Do not use `layout` and `layoutData` aggregations combined. * * @deprecated As of version 1.48.0. please use `layoutData` aggregation instead. */ getLayout(): sap.ui.layout.GridData; /** * Gets content of aggregation `title`. * * Can either be a `Title` element or a string. * * * @returns Title */ getTitle(): sap.ui.core.Title | string; /** * Gets current value of property {@link #getUseHorizontalLayout useHorizontalLayout}. * * Specifies whether the groups are rendered in a `ResponsiveLayout` with label on top of the group element. * Each group will be rendered in a new line. * * **Note:** If `Group` is assigned to a `SmartForm` control, this property is inherited from the `SmartForm` * control. * * So don't set it to a different value from the one in the `SmartForm` control. For performance reasons * it might make sense to set it manually to the same value as the one in the `SmartForm` control when creating * the `Group` element. * * @deprecated As of version 1.86. replaced by {@link sap.ui.comp.smartform.ColumnLayout ColumnLayout} in * the `layout` aggregation of the `SmartForm` control. * * @returns Value of property `useHorizontalLayout` */ getUseHorizontalLayout(): boolean; /** * Checks for the provided `sap.ui.comp.IFormGroupElement` in the aggregation {@link #getGroupElements groupElements}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfGroupElement( /** * The groupElement whose index is looked for */ oGroupElement: sap.ui.comp.IFormGroupElement ): int; /** * Inserts some customData into the aggregation `customData`. * * **Note:** `customData` that is used by the `SmartField` control itself is also added to the `GroupElement` * elements and the `SmartField` controls in the children hierarchy. Additional `customData` that is not * used by the `SmartField` control internally might not be added. * * * @returns Reference to `this` to allow method chaining. */ insertCustomData( /** * the customData to insert; if empty, nothing is inserted */ oCustomData: sap.ui.core.CustomData, /** * the 0-based index the customData should be inserted at; for a negative value of iIndex, the customData * is inserted at position 0; for a value greater than the current size of the aggregation, the customData * is inserted at the last position */ iIndex: int ): this; /** * Inserts a groupElement into the aggregation {@link #getGroupElements groupElements}. * * * @returns Reference to `this` in order to allow method chaining */ insertGroupElement( /** * The groupElement to insert; if empty, nothing is inserted */ oGroupElement: sap.ui.comp.IFormGroupElement, /** * The `0`-based index the groupElement should be inserted at; for a negative value of `iIndex`, the groupElement * is inserted at position 0; for a value greater than the current size of the aggregation, the groupElement * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getGroupElements groupElements}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllGroupElements(): sap.ui.comp.IFormGroupElement[]; /** * Removes a groupElement from the aggregation {@link #getGroupElements groupElements}. * * * @returns The removed groupElement or `null` */ removeGroupElement( /** * The groupElement to remove or its index or id */ vGroupElement: int | string | sap.ui.comp.IFormGroupElement ): sap.ui.comp.IFormGroupElement | null; /** * Setter for property `editable` of all smart fields in children hierarchy. * * @deprecated As of version 1.74.0. please do not change the edit mode on group level, let the SmartForm * inheritance do it * * @returns `this` to allow method chaining. */ setEditMode( /** * new value for editable property of smart fields. */ bEditMode: boolean ): this; /** * Sets a new value for property {@link #getHorizontalLayoutGroupElementMinWidth horizontalLayoutGroupElementMinWidth}. * * Specifies the minimal size in pixels of all group elements of the form if horizontal Layout is used. * * **Note:** If `Group` is assigned to a `SmartForm` control, this property is inherited from the `SmartForm` * control. So don't set it manually. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @deprecated As of version 1.48.0. please do not use this property as it does not have any effect on the * current layout of the `SmartForm` control. * * @returns Reference to `this` in order to allow method chaining */ setHorizontalLayoutGroupElementMinWidth( /** * New value for property `horizontalLayoutGroupElementMinWidth` */ iHorizontalLayoutGroupElementMinWidth?: int ): this; /** * Sets a new value for property {@link #getLabel label}. * * Label for the group. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @deprecated As of version 1.88. replaced by `title` aggregation. * * @returns Reference to `this` in order to allow method chaining */ setLabel( /** * New value for property `label` */ sLabel?: string ): this; /** * Sets the aggregated {@link #getLayout layout}. * * @deprecated As of version 1.48.0. please use `layoutData` aggregation instead. * * @returns Reference to `this` in order to allow method chaining */ setLayout( /** * The layout to set */ oLayout: sap.ui.layout.GridData ): this; /** * Sets the aggregated `title`. * * Can either be a `Title` element or a string. If a `Title` element is used, the style of the title can * be set. * * **Note:** If the title is provided as a string, the title is rendered with a theme-dependent default * level. As the `SmartForm` control cannot know the structure of the page, this might not fit the page * structure. In this case provide the title using a `Title` element and set its {@link sap.ui.core.Title#setLevel level } * to the required value. * * * @returns `this` to allow method chaining */ setTitle( /** * The title to set */ vTitle: sap.ui.core.Title | string ): this; /** * Sets a new value for property {@link #getUseHorizontalLayout useHorizontalLayout}. * * Specifies whether the groups are rendered in a `ResponsiveLayout` with label on top of the group element. * Each group will be rendered in a new line. * * **Note:** If `Group` is assigned to a `SmartForm` control, this property is inherited from the `SmartForm` * control. * * So don't set it to a different value from the one in the `SmartForm` control. For performance reasons * it might make sense to set it manually to the same value as the one in the `SmartForm` control when creating * the `Group` element. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @deprecated As of version 1.86. replaced by {@link sap.ui.comp.smartform.ColumnLayout ColumnLayout} in * the `layout` aggregation of the `SmartForm` control. * * @returns Reference to `this` in order to allow method chaining */ setUseHorizontalLayout( /** * New value for property `useHorizontalLayout` */ bUseHorizontalLayout?: boolean ): this; /** * Sets a new value for property `visible`. If set to `false`, the `Group` is not rendered. Default value * is true. * * * @returns `this` to allow method chaining. */ setVisible( /** * New value for property `visible` */ bVisible: boolean ): this; } /** * A GroupElement is a combination of one label and different controls associated to this label. */ class GroupElement extends sap.ui.layout.form.FormElement implements sap.ui.comp.IFormGroupElement { __implements__sap_ui_comp_IFormGroupElement: boolean; /** * Constructor for a new smartform/GroupElement. * * 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.ui.comp.smartform.$GroupElementSettings ); /** * Constructor for a new smartform/GroupElement. * * 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.ui.comp.smartform.$GroupElementSettings ); /** * Creates a new subclass of class sap.ui.comp.smartform.GroupElement with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.form.FormElement.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartform.GroupElement. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some customData into the aggregation `customData`. * * **Note:** `customData` that is used by the `SmartField` control itself is also added to the `SmartField` * controls in the children hierarchy. Additional `customData` that is not used by the `SmartField` control * internally might not be added. * * * @returns Reference to `this` to allow method chaining. */ addCustomData( /** * the customData to add; if empty, nothing is added */ oCustomData: sap.ui.core.CustomData ): this; /** * Adds some element to the aggregation {@link #getElements elements}. * * * @returns Reference to `this` in order to allow method chaining */ addElement( /** * The element to add; if empty, nothing is inserted */ oElement: sap.ui.core.Control ): this; /** * Attaches event handler `fnFunction` to the {@link #event:visibleChanged visibleChanged} event of this * `sap.ui.comp.smartform.GroupElement`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartform.GroupElement` itself. * * The event is fired after the visibility of the control has changed. * * * @returns Reference to `this` in order to allow method chaining */ attachVisibleChanged( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartform.GroupElement` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:visibleChanged visibleChanged} event of this * `sap.ui.comp.smartform.GroupElement`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartform.GroupElement` itself. * * The event is fired after the visibility of the control has changed. * * * @returns Reference to `this` in order to allow method chaining */ attachVisibleChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartform.GroupElement` * itself */ oListener?: object ): this; /** * Destroys all the elements in the aggregation {@link #getElements elements}. * * * @returns Reference to `this` in order to allow method chaining */ destroyElements(): this; /** * Detaches event handler `fnFunction` from the {@link #event:visibleChanged visibleChanged} event of this * `sap.ui.comp.smartform.GroupElement`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachVisibleChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:visibleChanged visibleChanged} 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 */ fireVisibleChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Gets current value of property {@link #getElementForLabel elementForLabel}. * * Index of element to be used for label determination * * Default value is `0`. * * * @returns Value of property `elementForLabel` */ getElementForLabel(): int; /** * Gets content of aggregation {@link #getElements elements}. * * Aggregation of controls to be displayed together with a label. * * **Warning:** Do not put any layout or other container controls in here. This could damage the visual * layout, keyboard support and screen-reader support. Only form controls are allowed. Views are also not * supported. Allowed controls implement the interface `sap.ui.core.IFormContent`. */ getElements(): sap.ui.core.Control[]; /** * Returns the from element. * * * @returns the form element. */ getFormElement(): sap.ui.layout.form.FormElement; /** * Gets current value of property {@link #getHorizontalLayoutGroupElementMinWidth horizontalLayoutGroupElementMinWidth}. * * Specifies the minimal size in pixels of all group elements of the form if horizontal Layout is used. * * **Note:** If `Group` is assigned to a `SmartForm` control, this property is inherited from the `SmartForm` * control. So don't set it manually. * * @deprecated As of version 1.48.0. please do not use this property as it does not have any effect on the * current layout of the `SmartForm` control. * * @returns Value of property `horizontalLayoutGroupElementMinWidth` */ getHorizontalLayoutGroupElementMinWidth(): int; /** * Returns the text of the label. * * * @returns text of the label. */ getLabelText(): string; /** * Gets current value of property {@link #getUseHorizontalLayout useHorizontalLayout}. * * Specifies whether the groups shall be rendered in a `ResponsiveLayout` with label on top of the group * element. Each group will be rendered in a new line. * * **Note:** If `Group` is assigned to a `SmartForm` control, this property is inherited from the `SmartForm` * control. * * So don't set it to a different value from the one in the `SmartForm` control. For performance reasons * it might make sense to set it manually to the same value as the one in the `SmartForm` control when creating * the `GroupElement` element. * * @deprecated As of version 1.86. replaced by {@link sap.ui.comp.smartform.ColumnLayout ColumnLayout} in * the `layout` aggregation of the `SmartForm` control. * * @returns Value of property `useHorizontalLayout` */ getUseHorizontalLayout(): boolean; /** * Determines the visibility of a `GroupElement` based on elements * * * @returns Returns true, in case one element of the group element is visible */ getVisibleBasedOnElements(): boolean; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getElements elements}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfElement( /** * The element whose index is looked for */ oElement: sap.ui.core.Control ): int; /** * Inserts some customData into the aggregation `customData`. * * **Note:** `customData` that is used by the `SmartField` control itself is also added to the `SmartField` * controls in the children hierarchy. Additional `customData` that is not used by the `SmartField` control * internally might not be added. * * * @returns Reference to `this` to allow method chaining. */ insertCustomData( /** * the customData to insert; if empty, nothing is inserted */ oCustomData: sap.ui.core.CustomData, /** * the 0-based index the customData should be inserted at; for a negative value of iIndex, the customData * is inserted at position 0; for a value greater than the current size of the aggregation, the customData * is inserted at the last position */ iIndex: int ): this; /** * Inserts a element into the aggregation {@link #getElements elements}. * * * @returns Reference to `this` in order to allow method chaining */ insertElement( /** * The element to insert; if empty, nothing is inserted */ oElement: sap.ui.core.Control, /** * The `0`-based index the element should be inserted at; for a negative value of `iIndex`, the element * is inserted at position 0; for a value greater than the current size of the aggregation, the element * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getElements elements}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllElements(): sap.ui.core.Control[]; /** * Removes a element from the aggregation {@link #getElements elements}. * * * @returns The removed element or `null` */ removeElement( /** * The element to remove or its index or id */ vElement: int | string | sap.ui.core.Control ): sap.ui.core.Control | null; /** * Setter for property editable of all smart fields in children hierarchy. * * @deprecated As of version 1.74.0. please do not change the edit mode on groupElement level, let the SmartForm * inheritance do it * * @returns `this` to allow method chaining. */ setEditMode( /** * new value for editable property of smart fields. */ bEditMode: boolean ): this; /** * Sets a new value for property {@link #getElementForLabel elementForLabel}. * * Index of element to be used for label determination * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setElementForLabel( /** * New value for property `elementForLabel` */ iElementForLabel?: int ): this; /** * Sets a new value for property {@link #getHorizontalLayoutGroupElementMinWidth horizontalLayoutGroupElementMinWidth}. * * Specifies the minimal size in pixels of all group elements of the form if horizontal Layout is used. * * **Note:** If `Group` is assigned to a `SmartForm` control, this property is inherited from the `SmartForm` * control. So don't set it manually. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @deprecated As of version 1.48.0. please do not use this property as it does not have any effect on the * current layout of the `SmartForm` control. * * @returns Reference to `this` in order to allow method chaining */ setHorizontalLayoutGroupElementMinWidth( /** * New value for property `horizontalLayoutGroupElementMinWidth` */ iHorizontalLayoutGroupElementMinWidth?: int ): this; /** * Sets a new value for property {@link #getUseHorizontalLayout useHorizontalLayout}. * * Specifies whether the groups shall be rendered in a `ResponsiveLayout` with label on top of the group * element. Each group will be rendered in a new line. * * **Note:** If `Group` is assigned to a `SmartForm` control, this property is inherited from the `SmartForm` * control. * * So don't set it to a different value from the one in the `SmartForm` control. For performance reasons * it might make sense to set it manually to the same value as the one in the `SmartForm` control when creating * the `GroupElement` element. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @deprecated As of version 1.86. replaced by {@link sap.ui.comp.smartform.ColumnLayout ColumnLayout} in * the `layout` aggregation of the `SmartForm` control. * * @returns Reference to `this` in order to allow method chaining */ setUseHorizontalLayout( /** * New value for property `useHorizontalLayout` */ bUseHorizontalLayout?: boolean ): this; } /** * Layout settings to adjust the `ResponsiveGridLayout` used inside the `Form`. */ class Layout extends sap.ui.core.Element implements sap.ui.comp.smartform.SmartFormLayout { __implements__sap_ui_comp_smartform_SmartFormLayout: boolean; /** * Constructor for a new smartform/Layout. * * 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.ui.comp.smartform.$LayoutSettings ); /** * Constructor for a new smartform/Layout. * * 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.ui.comp.smartform.$LayoutSettings ); /** * Creates a new subclass of class sap.ui.comp.smartform.Layout with name `sClassName` and enriches it with * the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartform.Layout. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getBreakpointL breakpointL}. * * Breakpoint (in pixel) between Medium size and Large size. * * * @returns Value of property `breakpointL` */ getBreakpointL(): int; /** * Gets current value of property {@link #getBreakpointM breakpointM}. * * reakpoint (in pixel) between Small size and Medium size. * * * @returns Value of property `breakpointM` */ getBreakpointM(): int; /** * Gets current value of property {@link #getBreakpointXL breakpointXL}. * * Breakpoint (in pixel) between large size and extra large (XL) size. * * @since 1.38.0 * * @returns Value of property `breakpointXL` */ getBreakpointXL(): int; /** * Gets current value of property {@link #getColumnsL columnsL}. * * Number of columns for large size. * The number of columns for large size must not be smaller than the number of columns for medium size. * * * @returns Value of property `columnsL` */ getColumnsL(): int; /** * Gets current value of property {@link #getColumnsM columnsM}. * * Number of columns for medium size. * * * @returns Value of property `columnsM` */ getColumnsM(): int; /** * Gets current value of property {@link #getColumnsXL columnsXL}. * * Number of columns for extra large size. * The number of columns for extra large size must not be smaller than the number of columns for large * size. * * @since 1.38.0 * * @returns Value of property `columnsXL` */ getColumnsXL(): int; /** * Gets current value of property {@link #getEmptySpanL emptySpanL}. * * Number of grid cells that are empty at the end of each line on large size. * * * @returns Value of property `emptySpanL` */ getEmptySpanL(): int; /** * Gets current value of property {@link #getEmptySpanM emptySpanM}. * * Number of grid cells that are empty at the end of each line on medium size. * * * @returns Value of property `emptySpanM` */ getEmptySpanM(): int; /** * Gets current value of property {@link #getEmptySpanS emptySpanS}. * * Number of grid cells that are empty at the end of each line on small size. * * * @returns Value of property `emptySpanS` */ getEmptySpanS(): int; /** * Gets current value of property {@link #getEmptySpanXL emptySpanXL}. * * Number of grid cells that are empty at the end of each line on extra large size. * * @since 1.38.0 * * @returns Value of property `emptySpanXL` */ getEmptySpanXL(): int; /** * Gets current value of property {@link #getGridDataSpan gridDataSpan}. * * A string type that represents Grid's span values for large, medium and small screens. Allowed values * are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container * has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided * in the order large medium small. * The value set here will be set to all group elements when used with horizontal layout (`SmartForm` property * `useHorizontalLayout`) * * Default value is `empty string`. * * * @returns Value of property `gridDataSpan` */ getGridDataSpan(): sap.ui.layout.GridSpan; /** * Gets current value of property {@link #getLabelSpanL labelSpanL}. * * Default span for labels in large size. This span is only used if more than 1 container is in one line, * if only 1 container is in the line the `labelSpanM` value is used. * * * @returns Value of property `labelSpanL` */ getLabelSpanL(): int; /** * Gets current value of property {@link #getLabelSpanM labelSpanM}. * * Default span for labels in medium size. This property is used for full size containers. If more than * one Container is in one line, `labelSpanL` is used. * * * @returns Value of property `labelSpanM` */ getLabelSpanM(): int; /** * Gets current value of property {@link #getLabelSpanS labelSpanS}. * * Default span for labels in small size. * * * @returns Value of property `labelSpanS` */ getLabelSpanS(): int; /** * Gets current value of property {@link #getLabelSpanXL labelSpanXL}. * * Default span for labels in extra large size. * * @since 1.38.0 * * @returns Value of property `labelSpanXL` */ getLabelSpanXL(): int; /** * Gets current value of property {@link #getSingleGroupFullSize singleGroupFullSize}. * * If the `SmartForm` contains only one single Group and this property is set, the Group is displayed using * the full size of the `SmartForm`. In this case the properties `columnsL` and `columnsM` are ignored. * In all other cases the Group is displayed in the size of one column. * * Default value is `true`. * * @since 1.34.1 * * @returns Value of property `singleGroupFullSize` */ getSingleGroupFullSize(): boolean; /** * Sets a new value for property {@link #getBreakpointL breakpointL}. * * Breakpoint (in pixel) between Medium size and Large size. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setBreakpointL( /** * New value for property `breakpointL` */ iBreakpointL?: int ): this; /** * Sets a new value for property {@link #getBreakpointM breakpointM}. * * reakpoint (in pixel) between Small size and Medium size. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setBreakpointM( /** * New value for property `breakpointM` */ iBreakpointM?: int ): this; /** * Sets a new value for property {@link #getBreakpointXL breakpointXL}. * * Breakpoint (in pixel) between large size and extra large (XL) size. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.38.0 * * @returns Reference to `this` in order to allow method chaining */ setBreakpointXL( /** * New value for property `breakpointXL` */ iBreakpointXL?: int ): this; /** * Sets a new value for property {@link #getColumnsL columnsL}. * * Number of columns for large size. * The number of columns for large size must not be smaller than the number of columns for medium size. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setColumnsL( /** * New value for property `columnsL` */ iColumnsL?: int ): this; /** * Sets a new value for property {@link #getColumnsM columnsM}. * * Number of columns for medium size. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setColumnsM( /** * New value for property `columnsM` */ iColumnsM?: int ): this; /** * Sets a new value for property {@link #getColumnsXL columnsXL}. * * Number of columns for extra large size. * The number of columns for extra large size must not be smaller than the number of columns for large * size. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.38.0 * * @returns Reference to `this` in order to allow method chaining */ setColumnsXL( /** * New value for property `columnsXL` */ iColumnsXL?: int ): this; /** * Sets a new value for property {@link #getEmptySpanL emptySpanL}. * * Number of grid cells that are empty at the end of each line on large size. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setEmptySpanL( /** * New value for property `emptySpanL` */ iEmptySpanL?: int ): this; /** * Sets a new value for property {@link #getEmptySpanM emptySpanM}. * * Number of grid cells that are empty at the end of each line on medium size. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setEmptySpanM( /** * New value for property `emptySpanM` */ iEmptySpanM?: int ): this; /** * Sets a new value for property {@link #getEmptySpanS emptySpanS}. * * Number of grid cells that are empty at the end of each line on small size. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setEmptySpanS( /** * New value for property `emptySpanS` */ iEmptySpanS?: int ): this; /** * Sets a new value for property {@link #getEmptySpanXL emptySpanXL}. * * Number of grid cells that are empty at the end of each line on extra large size. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.38.0 * * @returns Reference to `this` in order to allow method chaining */ setEmptySpanXL( /** * New value for property `emptySpanXL` */ iEmptySpanXL?: int ): this; /** * Sets a new value for property {@link #getGridDataSpan gridDataSpan}. * * A string type that represents Grid's span values for large, medium and small screens. Allowed values * are separated by space Letters L, M or S followed by number of columns from 1 to 12 that the container * has to take, for example: "L2 M4 S6", "M12", "s10" or "l4 m4". Note that the parameters has to be provided * in the order large medium small. * The value set here will be set to all group elements when used with horizontal layout (`SmartForm` property * `useHorizontalLayout`) * * 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 */ setGridDataSpan( /** * New value for property `gridDataSpan` */ sGridDataSpan?: sap.ui.layout.GridSpan ): this; /** * Sets a new value for property {@link #getLabelSpanL labelSpanL}. * * Default span for labels in large size. This span is only used if more than 1 container is in one line, * if only 1 container is in the line the `labelSpanM` value is used. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setLabelSpanL( /** * New value for property `labelSpanL` */ iLabelSpanL?: int ): this; /** * Sets a new value for property {@link #getLabelSpanM labelSpanM}. * * Default span for labels in medium size. This property is used for full size containers. If more than * one Container is in one line, `labelSpanL` is used. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setLabelSpanM( /** * New value for property `labelSpanM` */ iLabelSpanM?: int ): this; /** * Sets a new value for property {@link #getLabelSpanS labelSpanS}. * * Default span for labels in small size. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setLabelSpanS( /** * New value for property `labelSpanS` */ iLabelSpanS?: int ): this; /** * Sets a new value for property {@link #getLabelSpanXL labelSpanXL}. * * Default span for labels in extra large size. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.38.0 * * @returns Reference to `this` in order to allow method chaining */ setLabelSpanXL( /** * New value for property `labelSpanXL` */ iLabelSpanXL?: int ): this; /** * Sets a new value for property {@link #getSingleGroupFullSize singleGroupFullSize}. * * If the `SmartForm` contains only one single Group and this property is set, the Group is displayed using * the full size of the `SmartForm`. In this case the properties `columnsL` and `columnsM` are ignored. * In all other cases the Group is displayed in the size of one column. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.34.1 * * @returns Reference to `this` in order to allow method chaining */ setSingleGroupFullSize( /** * New value for property `singleGroupFullSize` */ bSingleGroupFullSize?: boolean ): this; } /** * SemanticGroupElement holds the semantically connected fields divided by a delimiter. **Note:** Semantically * connected fields don't support the text arrangement async control functionality. * * @since 1.88 */ class SemanticGroupElement extends sap.ui.layout.form.SemanticFormElement implements sap.ui.comp.IFormGroupElement { __implements__sap_ui_comp_IFormGroupElement: boolean; /** * Constructor for a new smartform/SemanticGroupElement. * * 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.ui.comp.smartform.$SemanticGroupElementSettings ); /** * Constructor for a new smartform/SemanticGroupElement. * * 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.ui.comp.smartform.$SemanticGroupElementSettings ); /** * Creates a new subclass of class sap.ui.comp.smartform.SemanticGroupElement with name `sClassName` and * enriches it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.layout.form.SemanticFormElement.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< T, sap.ui.comp.smartform.SemanticGroupElement >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartform.SemanticGroupElement. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some custom data into the aggregation `customData`. * * **Note:** `customData` that is used by the `SmartField` control itself is also added to the `SmartField` * controls in the children hierarchy. Additional `customData` that is not used by the `SmartField` control * internally might not be added. * * * @returns Reference to `this` to allow method chaining. */ addCustomData( /** * the customData to add; if empty, nothing is added */ oCustomData: sap.ui.core.CustomData ): this; /** * Adds some element to the aggregation {@link #getElements elements}. * * * @returns Reference to `this` in order to allow method chaining */ addElement( /** * The element to add; if empty, nothing is inserted */ oElement: sap.ui.core.Control ): this; /** * Attaches event handler `fnFunction` to the {@link #event:visibleChanged visibleChanged} event of this * `sap.ui.comp.smartform.SemanticGroupElement`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartform.SemanticGroupElement` itself. * * The event is fired after the visibility of the control has changed. * * * @returns Reference to `this` in order to allow method chaining */ attachVisibleChanged( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartform.SemanticGroupElement` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:visibleChanged visibleChanged} event of this * `sap.ui.comp.smartform.SemanticGroupElement`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartform.SemanticGroupElement` itself. * * The event is fired after the visibility of the control has changed. * * * @returns Reference to `this` in order to allow method chaining */ attachVisibleChanged( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartform.SemanticGroupElement` * itself */ oListener?: object ): this; /** * Destroys all the elements in the aggregation {@link #getElements elements}. * * * @returns Reference to `this` in order to allow method chaining */ destroyElements(): this; /** * Detaches event handler `fnFunction` from the {@link #event:visibleChanged visibleChanged} event of this * `sap.ui.comp.smartform.SemanticGroupElement`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachVisibleChanged( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:visibleChanged visibleChanged} 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 */ fireVisibleChanged( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Gets current value of property {@link #getElementForLabel elementForLabel}. * * Index of element to be used for label determination * * Default value is `0`. * * * @returns Value of property `elementForLabel` */ getElementForLabel(): int; /** * Gets content of aggregation {@link #getElements elements}. * * Aggregation of controls to be displayed together with a label and separated by delimiter. * * **Warning:** Do not put any layout or other container controls in here. This could damage the visual * layout, keyboard support and screen-reader support. Views are also not supported. Only form controls * are allowed. Allowed controls implement the interface `sap.ui.core.IFormContent`. */ getElements(): sap.ui.core.Control[]; /** * Returns the semantic form element. */ getFormElement(): sap.ui.layout.form.SemanticFormElement; /** * Returns the text of the label. * * * @returns The text of the label. */ getLabelText(): string; /** * Determines the visibility of a `SemanticGroupElement` based on the inner elements * * * @returns Returns true in case one element of the group elements is visible */ getVisibleBasedOnElements(): boolean; /** * Checks for the provided `sap.ui.core.Control` in the aggregation {@link #getElements elements}. and returns * its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfElement( /** * The element whose index is looked for */ oElement: sap.ui.core.Control ): int; /** * Inserts some custom data into the aggregation `customData`. * * **Note:** `customData` that is used by the `SmartField` control itself is also added to the `SmartField` * controls in the children hierarchy. Additional `customData` that is not used by the `SmartField` control * internally might not be added. * * * @returns Reference to `this` to allow method chaining. */ insertCustomData( /** * the custom data to insert; if empty, nothing is inserted */ oCustomData: sap.ui.core.CustomData, /** * the 0-based index the custom data should be inserted at; for a negative value of iIndex, the custom data * is inserted at position 0; for a value greater than the current size of the aggregation, the custom data * is inserted at the last position */ iIndex: int ): this; /** * Inserts a element into the aggregation {@link #getElements elements}. * * * @returns Reference to `this` in order to allow method chaining */ insertElement( /** * The element to insert; if empty, nothing is inserted */ oElement: sap.ui.core.Control, /** * The `0`-based index the element should be inserted at; for a negative value of `iIndex`, the element * is inserted at position 0; for a value greater than the current size of the aggregation, the element * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getElements elements}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllElements(): sap.ui.core.Control[]; /** * Removes a element from the aggregation {@link #getElements elements}. * * * @returns The removed element or `null` */ removeElement( /** * The element to remove or its index or id */ vElement: int | string | sap.ui.core.Control ): sap.ui.core.Control | null; /** * Sets a new value for property {@link #getElementForLabel elementForLabel}. * * Index of element to be used for label determination * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `0`. * * * @returns Reference to `this` in order to allow method chaining */ setElementForLabel( /** * New value for property `elementForLabel` */ iElementForLabel?: int ): this; } /** * The `SmartForm` control renders a form (`sap.ui.layout.form.Form`). When used with the `SmartField` control * the label is taken from the metadata annotation `sap:label` if not specified directly. * * **Warning:** Do not put any layout or other container controls into the `GroupElement`. Views are also * not supported. This could damage the visual layout, keyboard support and screen-reader support. */ class SmartForm extends sap.ui.core.Control { /** * Constructor for a new smartform/SmartForm. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/99e33bdfde074bb48d2e603fa5ecd2d0 Smart Form} */ constructor( /** * Initial settings for the new control */ mSettings?: sap.ui.comp.smartform.$SmartFormSettings ); /** * Constructor for a new smartform/SmartForm. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/99e33bdfde074bb48d2e603fa5ecd2d0 Smart Form} */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string, /** * Initial settings for the new control */ mSettings?: sap.ui.comp.smartform.$SmartFormSettings ); /** * Creates a new subclass of class sap.ui.comp.smartform.SmartForm with name `sClassName` and enriches it * with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartform.SmartForm. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * @since 1.56.0 * * @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 customData into the aggregation `customData`. * * **Note:** `customData` that is used by the `SmartField` control itself is also added to the `Group` elements, * `GroupElement` elements and the `SmartField` controls in the children hierarchy. Additional `customData` * that is not used by the `SmartField` control internally might not be added. * * * @returns Reference to `this` to allow method chaining. */ addCustomData( /** * the customData to add; if empty, nothing is added */ oCustomData: sap.ui.core.CustomData ): this; /** * Adds some group to the aggregation {@link #getGroups groups}. * * * @returns Reference to `this` in order to allow method chaining */ addGroup( /** * The group to add; if empty, nothing is inserted */ oGroup: sap.ui.comp.smartform.Group ): this; /** * Attaches event handler `fnFunction` to the {@link #event:checked checked} event of this `sap.ui.comp.smartform.SmartForm`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartform.SmartForm` itself. * * This event is fired after check was performed. * * * @returns Reference to `this` in order to allow method chaining */ attachChecked( /** * 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: SmartForm$CheckedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartform.SmartForm` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:checked checked} event of this `sap.ui.comp.smartform.SmartForm`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartform.SmartForm` itself. * * This event is fired after check was performed. * * * @returns Reference to `this` in order to allow method chaining */ attachChecked( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartForm$CheckedEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartform.SmartForm` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:editToggled editToggled} event of this `sap.ui.comp.smartform.SmartForm`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartform.SmartForm` itself. * * This event is fired when the editable property is toggled. * * * @returns Reference to `this` in order to allow method chaining */ attachEditToggled( /** * 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: SmartForm$EditToggledEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartform.SmartForm` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:editToggled editToggled} event of this `sap.ui.comp.smartform.SmartForm`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartform.SmartForm` itself. * * This event is fired when the editable property is toggled. * * * @returns Reference to `this` in order to allow method chaining */ attachEditToggled( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartForm$EditToggledEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartform.SmartForm` itself */ oListener?: object ): this; /** * Checks smart fields for client errors. * * This method is typically used to check whether the value of every text input field in edit mode is subject * to data type constraints and whether the constraints are fulfilled. * * A data type constraint for a bound Entity Data Model (EDM) property can be violated in many ways, for * example: * * * - The `Nullable` constraint for an EDM property typed as `Edm.String` is violated. * - A user input is invalid for the bound EDM property typed as `Edm.DateTime`. * * If this happens, the following applies: * * * - A validation error state is set on the text input field. * - A validation error message is displayed for the text input field. * - The validation error message (possibly generated by a user input) is added to a `sap.ui.core.message.MessageManager` * object instance if, for example, a view object instance is registered to it. * - The text input field fires a {@link sap.ui.base.EventProvider#event:validationError}, or {@link sap.ui.base.EventProvider#event:parseError } * event. * * * @returns An array of fields with errors or a promise depending on the `validationMode` property setting. * If the `validationMode` is asynchronous the returned promise will resolve with an array containing IDs * of all the fields with errors. */ check( /** * Settings object or a boolean which determines if only visible fields in visible groups should be considered */ vSettings?: | boolean | { /** * Determines if only visible fields in visible groups should be considered */ considerOnlyVisible?: boolean; /** * Indicates whether client error checks are performed for the current value regardless of the current error * state of the text input fields of the `SmartForm` control. If the `handleSuccess` setting is set to `true`, * the {@link sap.ui.base.EventProvider#event:validationSuccess} will be fired by every of the text input * fields if their validation passes */ handleSuccess?: boolean; } ): string[] | Promise; /** * Destroys the customToolbar in the aggregation {@link #getCustomToolbar customToolbar}. * * * @returns Reference to `this` in order to allow method chaining */ destroyCustomToolbar(): this; /** * Destroys all the groups in the aggregation {@link #getGroups groups}. * * * @returns Reference to `this` in order to allow method chaining */ destroyGroups(): this; /** * Destroys the layout in the aggregation {@link #getLayout layout}. * * * @returns Reference to `this` in order to allow method chaining */ destroyLayout(): this; /** * Destroys the semanticObjectController in the aggregation {@link #getSemanticObjectController semanticObjectController}. * * * @returns Reference to `this` in order to allow method chaining */ destroySemanticObjectController(): this; /** * Detaches event handler `fnFunction` from the {@link #event:checked checked} event of this `sap.ui.comp.smartform.SmartForm`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachChecked( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartForm$CheckedEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:editToggled editToggled} event of this `sap.ui.comp.smartform.SmartForm`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachEditToggled( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartForm$EditToggledEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:checked checked} 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 */ fireChecked( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartform.SmartForm$CheckedEventParameters ): this; /** * Fires event {@link #event:editToggled editToggled} 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 */ fireEditToggled( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartform.SmartForm$EditToggledEventParameters ): this; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. * * @since 1.56.0 */ getAriaLabelledBy(): sap.ui.core.ID[]; /** * Gets current value of property {@link #getCheckButton checkButton}. * * Specifies whether a check button is added to the toolbar. * * Default value is `false`. * * * @returns Value of property `checkButton` */ getCheckButton(): boolean; /** * Gets content of aggregation {@link #getCustomToolbar customToolbar}. * * An additional toolbar that can be added by the users, which can contain further custom buttons, controls, * etc. * * **Note:** If a special title is required inside the `Toolbar`, it must be added as content to the `Toolbar`. * In this case add the `Title` to the `ariaLabelledBy` association. Use the required title level to meet * the visual requirements. This might be theme-dependent. */ getCustomToolbar(): sap.m.Toolbar; /** * Gets current value of property {@link #getEditable editable}. * * Applies a device-specific and theme-specific line height and label alignment to the form rows if the * form has editable content. If set, all (not only the editable) rows of the form will get the line height * of editable fields. * * The labels inside the form will be rendered by default in the according mode. * * **Note:** The setting of this property will be passed to all `SmartField` controls inside the form, so * they will be editable if the form is editable. * * **Warning:** The setting of this property will not be passed to controls other than `SmartField`. For * example, `Input` controls in a form with `editable` set to `false` are still editable. * * If controls other than `SmartField` controls are used, and the edit mode of their control is not set * correctly, this might lead to visual issues. The labels and fields might be misaligned, the labels might * be rendered in the wrong mode, and the spacing between the single controls might be wrong. Also, controls * that do not fit the mode might be rendered incorrectly. * * Default value is `false`. * * * @returns Value of property `editable` */ getEditable(): boolean; /** * Gets current value of property {@link #getEditTogglable editTogglable}. * * If set to `true`, a button to toggle the `editable` property is shown in the toolbar. * * Default value is `false`. * * * @returns Value of property `editTogglable` */ getEditTogglable(): boolean; /** * Gets current value of property {@link #getEntityType entityType}. * * CSV of entity types for which the flexibility features are available. * For more information about SAPUI5 flexibility, refer to the Developer Guide. * **Note:** No validation is done. Please ensure that you do not add spaces or special characters. * * * @returns Value of property `entityType` */ getEntityType(): string; /** * Gets current value of property {@link #getExpandable expandable}. * * Specifies whether the control is expandable. Per default the control is not rendered as expanded. * * Default value is `false`. * * * @returns Value of property `expandable` */ getExpandable(): boolean; /** * Gets current value of property {@link #getExpanded expanded}. * * If expandable, this property indicates whether the state is expanded or not. If expanded, then the toolbar * (if available) and the content is rendered; if expanded is false, then only the headerText/headerToolbar * is rendered. * * * @returns Value of property `expanded` */ getExpanded(): boolean; /** * Gets current value of property {@link #getFlexEnabled flexEnabled}. * * Specifies whether the form enables flexibility features, such as adding new fields. * For more information about SAPUI5 flexibility, refer to the Developer Guide. * * Default value is `true`. * * * @returns Value of property `flexEnabled` */ getFlexEnabled(): boolean; /** * Gets content of aggregation {@link #getGroups groups}. * * Groups are used to group form elements. */ getGroups(): sap.ui.comp.smartform.Group[]; /** * Gets current value of property {@link #getHorizontalLayoutGroupElementMinWidth horizontalLayoutGroupElementMinWidth}. * * Specifies the minimal size in pixels of all group elements of the form if the horizontal layout is used. * * @deprecated As of version 1.48.0. please do not use this property as it does not have any effect on the * current layout of the `SmartForm` control. * * @returns Value of property `horizontalLayoutGroupElementMinWidth` */ getHorizontalLayoutGroupElementMinWidth(): int; /** * Gets current value of property {@link #getIgnoredFields ignoredFields}. * * A list of fields that must not be available in the key-user adaptation dialog. Listed field names are * separated by commas. * * The property is designed to be used by SAP Fiori elements, and it’s not evaluated by the `SmartForm` * control itself. * * **Note:** * Please ensure that you do not add spaces or special characters as no validation is done for this property. * * * @returns Value of property `ignoredFields` */ getIgnoredFields(): string; /** * Gets current value of property {@link #getImportance importance}. * * Specifies which smart fields will be visible inside the `SmartForm`. * * If set to **high**, only smart fields with high importance will be visible. * * If set to **medium**, only smart fields with high and medium importance will be visible. * * If set to **low** (default), all the smart fields will be visible regardless of their importance. * * Note: If a smart field is annotated as mandatory or hidden, its visibility will not be affected * by the `importance` property. * * Default value is `Low`. * * @since 1.87 * * @returns Value of property `importance` */ getImportance(): sap.ui.comp.smartform.Importance; /** * Gets content of aggregation {@link #getLayout layout}. * * Layout settings to adjust the used layout. * * Use {@link sap.ui.comp.smartform.ColumnLayout ColumnLayout} to have the current UI. */ getLayout(): sap.ui.comp.smartform.SmartFormLayout; /** * Gets content of aggregation {@link #getSemanticObjectController semanticObjectController}. * * The Semantic Object Controller allows the user to specify and overwrite functionality for semantic object * navigation. */ getSemanticObjectController(): sap.ui.comp.navpopover.SemanticObjectController; /** * Retrieves all the smart fields of the form. * * **Note:** Even invisible `SmartField` controls are returned if the `group` or `groupElement` is visible. * * * @returns An array of smart fields (might be empty). */ getSmartFields( /** * Determines if only visible `groups` are taken into account */ bConsiderOnlyVisibleGroups?: boolean, /** * Determines if only visible `groupElement` elements are taken into account */ bConsiderOnlyVisibleGroupElements?: boolean ): sap.ui.comp.smartfield.SmartField[]; /** * Gets current value of property {@link #getTitle title}. * * Title of the form. * * **Note:** The title is rendered with a theme-dependent default level. As the `SmartForm` control cannot * know the structure of the page, this might not fit the page structure. In this case provide the title * using a {@link sap.m.Title Title} control and set its {@link sap.m.Title#setLevel level} to the required * value. Add this title to a {@link sap.m.Toolbar Toolbar} control and assign it to the `SmartForm` using * the `customToolbar` aggregation. * * * @returns Value of property `title` */ getTitle(): string; /** * Gets current value of property {@link #getUseHorizontalLayout useHorizontalLayout}. * * Specifies whether the groups are rendered in a {@link sap.ui.layout.form.ResponsiveLayout ResponsiveLayout } * with the label above the field. Each group is rendered in a new line. * * **Note:** This property should no longer be used. To arrange the fields in columns, {@link sap.ui.comp.smartform.ColumnLayout ColumnLayout } * should be used in the `layout` aggregation. * * **Note:** The value of this property will be passed on to the `useHorizontalLayout` property of all `Group` * and `GroupElement` elements. * * @deprecated As of version 1.86. replaced by {@link sap.ui.comp.smartform.ColumnLayout ColumnLayout} in * the `layout` aggregation. * * @returns Value of property `useHorizontalLayout` */ getUseHorizontalLayout(): boolean; /** * Gets current value of property {@link #getValidationMode validationMode}. * * Controls the SmartForm validation mode. The default mode handles only nested `SmartField` controls with * synchronous validation. If the `SmartForm` should also handle controls with asynchronous validation the * property should be set to `Async` mode which is the recommended mode to be used as all types of nested * fields validation are handled. * * Note: Using `Async` mode the method `check` will return a promise instead of an array. * * Note: Using `Async` mode the event `checked` will be called asynchronously when all the nested `SmartField` * validations are executed. * * Default value is `Standard`. * * @since 1.81 * * @returns Value of property `validationMode` */ getValidationMode(): sap.ui.comp.smartform.SmartFormValidationMode; /** * Returns the array of properties currently visible on the UI. * * * @returns The properties currently visible */ getVisibleProperties(): string[]; /** * Checks for the provided `sap.ui.comp.smartform.Group` in the aggregation {@link #getGroups groups}. and * returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfGroup( /** * The group whose index is looked for */ oGroup: sap.ui.comp.smartform.Group ): int; /** * Inserts some customData into the aggregation `customData`. * * **Note:** `customData` that is used by the `SmartField` control itself is also added to the `Group` elements, * `GroupElement` elements and the `SmartField` controls in the children hierarchy. Additional `customData` * that is not used by the `SmartField` control internally might not be added. * * * @returns Reference to `this` to allow method chaining. */ insertCustomData( /** * the customData to insert; if empty, nothing is inserted */ oCustomData: sap.ui.core.CustomData, /** * the 0-based index the customData should be inserted at; for a negative value of iIndex, the customData * is inserted at position 0; for a value greater than the current size of the aggregation, the customData * is inserted at the last position */ iIndex: int ): this; /** * Inserts a group into the aggregation {@link #getGroups groups}. * * * @returns Reference to `this` in order to allow method chaining */ insertGroup( /** * The group to insert; if empty, nothing is inserted */ oGroup: sap.ui.comp.smartform.Group, /** * The `0`-based index the group should be inserted at; for a negative value of `iIndex`, the group is inserted * at position 0; for a value greater than the current size of the aggregation, the group is inserted at * the last position */ iIndex: int ): this; /** * Sets default span for `GridData` layout of group elements when used with horizontal layout. * * **Note:** There is no need to call this function as the update of all `GroupElement` elements inside * the `SmartForm` control is triggered automatically if the `GridDataSpan` property of the `Layout` aggregation * changes or the `Layout` aggregation is added. * * * @returns `this` to allow method chaining. */ propagateGridDataSpan(): this; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * @since 1.56.0 * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): sap.ui.core.ID[]; /** * Removes all the controls from the aggregation {@link #getGroups groups}. * * Additionally, it unregisters them from the hosting UIArea. * * * @returns An array of the removed elements (might be empty) */ removeAllGroups(): sap.ui.comp.smartform.Group[]; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * @since 1.56.0 * * @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 group from the aggregation {@link #getGroups groups}. * * * @returns The removed group or `null` */ removeGroup( /** * The group to remove or its index or id */ vGroup: int | string | sap.ui.comp.smartform.Group ): sap.ui.comp.smartform.Group | null; /** * Sets a new value for property {@link #getCheckButton checkButton}. * * Specifies whether a check button is added to the toolbar. * * 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 */ setCheckButton( /** * New value for property `checkButton` */ bCheckButton?: boolean ): this; /** * Sets the aggregated {@link #getCustomToolbar customToolbar}. * * * @returns Reference to `this` in order to allow method chaining */ setCustomToolbar( /** * The customToolbar to set */ oCustomToolbar: sap.m.Toolbar ): this; /** * Sets a new value for property {@link #getEditable editable}. * * Applies a device-specific and theme-specific line height and label alignment to the form rows if the * form has editable content. If set, all (not only the editable) rows of the form will get the line height * of editable fields. * * The labels inside the form will be rendered by default in the according mode. * * **Note:** The setting of this property will be passed to all `SmartField` controls inside the form, so * they will be editable if the form is editable. * * **Warning:** The setting of this property will not be passed to controls other than `SmartField`. For * example, `Input` controls in a form with `editable` set to `false` are still editable. * * If controls other than `SmartField` controls are used, and the edit mode of their control is not set * correctly, this might lead to visual issues. The labels and fields might be misaligned, the labels might * be rendered in the wrong mode, and the spacing between the single controls might be wrong. Also, controls * that do not fit the mode might be rendered incorrectly. * * 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 */ setEditable( /** * New value for property `editable` */ bEditable?: boolean ): this; /** * Sets a new value for property {@link #getEditTogglable editTogglable}. * * If set to `true`, a button to toggle the `editable` property is shown in the toolbar. * * 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 */ setEditTogglable( /** * New value for property `editTogglable` */ bEditTogglable?: boolean ): this; /** * Sets a new value for property {@link #getEntityType entityType}. * * CSV of entity types for which the flexibility features are available. * For more information about SAPUI5 flexibility, refer to the Developer Guide. * **Note:** No validation is done. Please ensure that you do not add spaces or special characters. * * 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 */ setEntityType( /** * New value for property `entityType` */ sEntityType?: string ): this; /** * Sets a new value for property {@link #getExpandable expandable}. * * Specifies whether the control is expandable. Per default the control is not rendered as expanded. * * 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 */ setExpandable( /** * New value for property `expandable` */ bExpandable?: boolean ): this; /** * Sets a new value for property {@link #getExpanded expanded}. * * If expandable, this property indicates whether the state is expanded or not. If expanded, then the toolbar * (if available) and the content is rendered; if expanded is false, then only the headerText/headerToolbar * is rendered. * * 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 */ setExpanded( /** * New value for property `expanded` */ bExpanded?: boolean ): this; /** * Sets a new value for property {@link #getFlexEnabled flexEnabled}. * * Specifies whether the form enables flexibility features, such as adding new fields. * For more information about SAPUI5 flexibility, refer to the Developer Guide. * * 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 */ setFlexEnabled( /** * New value for property `flexEnabled` */ bFlexEnabled?: boolean ): this; /** * Sets the focus on the first editable control. * * @since 1.36.0 */ setFocusOnEditableControl(): void; /** * Sets a new value for property {@link #getHorizontalLayoutGroupElementMinWidth horizontalLayoutGroupElementMinWidth}. * * Specifies the minimal size in pixels of all group elements of the form if the horizontal layout is used. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @deprecated As of version 1.48.0. please do not use this property as it does not have any effect on the * current layout of the `SmartForm` control. * * @returns Reference to `this` in order to allow method chaining */ setHorizontalLayoutGroupElementMinWidth( /** * New value for property `horizontalLayoutGroupElementMinWidth` */ iHorizontalLayoutGroupElementMinWidth?: int ): this; /** * Sets a new value for property {@link #getIgnoredFields ignoredFields}. * * A list of fields that must not be available in the key-user adaptation dialog. Listed field names are * separated by commas. * * The property is designed to be used by SAP Fiori elements, and it’s not evaluated by the `SmartForm` * control itself. * * **Note:** * Please ensure that you do not add spaces or special characters as no validation is done for this property. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setIgnoredFields( /** * New value for property `ignoredFields` */ sIgnoredFields?: string ): this; /** * Sets a new value for property {@link #getImportance importance}. * * Specifies which smart fields will be visible inside the `SmartForm`. * * If set to **high**, only smart fields with high importance will be visible. * * If set to **medium**, only smart fields with high and medium importance will be visible. * * If set to **low** (default), all the smart fields will be visible regardless of their importance. * * Note: If a smart field is annotated as mandatory or hidden, its visibility will not be affected * by the `importance` property. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Low`. * * @since 1.87 * * @returns Reference to `this` in order to allow method chaining */ setImportance( /** * New value for property `importance` */ sImportance?: sap.ui.comp.smartform.Importance ): this; /** * Sets the aggregated {@link #getLayout layout}. * * * @returns Reference to `this` in order to allow method chaining */ setLayout( /** * The layout to set */ oLayout: sap.ui.comp.smartform.SmartFormLayout ): this; /** * Sets the aggregated {@link #getSemanticObjectController semanticObjectController}. * * * @returns Reference to `this` in order to allow method chaining */ setSemanticObjectController( /** * The semanticObjectController to set */ oSemanticObjectController: sap.ui.comp.navpopover.SemanticObjectController ): this; /** * Sets a new value for property {@link #getTitle title}. * * Title of the form. * * **Note:** The title is rendered with a theme-dependent default level. As the `SmartForm` control cannot * know the structure of the page, this might not fit the page structure. In this case provide the title * using a {@link sap.m.Title Title} control and set its {@link sap.m.Title#setLevel level} to the required * value. Add this title to a {@link sap.m.Toolbar Toolbar} control and assign it to the `SmartForm` using * the `customToolbar` aggregation. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setTitle( /** * New value for property `title` */ sTitle?: string ): this; /** * Sets a new value for property {@link #getUseHorizontalLayout useHorizontalLayout}. * * Specifies whether the groups are rendered in a {@link sap.ui.layout.form.ResponsiveLayout ResponsiveLayout } * with the label above the field. Each group is rendered in a new line. * * **Note:** This property should no longer be used. To arrange the fields in columns, {@link sap.ui.comp.smartform.ColumnLayout ColumnLayout } * should be used in the `layout` aggregation. * * **Note:** The value of this property will be passed on to the `useHorizontalLayout` property of all `Group` * and `GroupElement` elements. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @deprecated As of version 1.86. replaced by {@link sap.ui.comp.smartform.ColumnLayout ColumnLayout} in * the `layout` aggregation. * * @returns Reference to `this` in order to allow method chaining */ setUseHorizontalLayout( /** * New value for property `useHorizontalLayout` */ bUseHorizontalLayout?: boolean ): this; /** * Sets a new value for property {@link #getValidationMode validationMode}. * * Controls the SmartForm validation mode. The default mode handles only nested `SmartField` controls with * synchronous validation. If the `SmartForm` should also handle controls with asynchronous validation the * property should be set to `Async` mode which is the recommended mode to be used as all types of nested * fields validation are handled. * * Note: Using `Async` mode the method `check` will return a promise instead of an array. * * Note: Using `Async` mode the event `checked` will be called asynchronously when all the nested `SmartField` * validations are executed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Standard`. * * @since 1.81 * * @returns Reference to `this` in order to allow method chaining */ setValidationMode( /** * New value for property `validationMode` */ sValidationMode?: sap.ui.comp.smartform.SmartFormValidationMode ): this; } /** * Enumeration of SmartForm Importance types * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartform.Importance'. * * @since 1.87 */ enum Importance { /** * Shows fields that are annotated with UI.ImportanceType/High or have importance property set to High */ High = "High", /** * Shows all fields */ Low = "Low", /** * Shows fields that are annotated with `UI.ImportanceType/Medium` or `UI.ImportanceType/High` or have the * `importance` property set to `medium` or `high`. */ Medium = "Medium", } /** * Enumeration of SmartForm validation mode. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartform.SmartFormValidationMode'. * * @since 1.81 */ enum SmartFormValidationMode { /** * Async validation mode. This mode handles all types of `SmartField` controls both with sync and async * validation. * * Note: This is the recommended validation mode. */ Async = "Async", /** * Standard validation mode which handles the validation only of nested `SmartField` with synchronous validation. */ Standard = "Standard", } /** * Event object of the GroupElement#visibleChanged event. */ type GroupElement$VisibleChangedEvent = sap.ui.base.Event< GroupElement$VisibleChangedEventParameters, GroupElement >; /** * Event object of the SemanticGroupElement#visibleChanged event. */ type SemanticGroupElement$VisibleChangedEvent = sap.ui.base.Event< SemanticGroupElement$VisibleChangedEventParameters, SemanticGroupElement >; /** * Event object of the SmartForm#checked event. */ type SmartForm$CheckedEvent = sap.ui.base.Event< SmartForm$CheckedEventParameters, SmartForm >; /** * Event object of the SmartForm#editToggled event. */ type SmartForm$EditToggledEvent = sap.ui.base.Event< SmartForm$EditToggledEventParameters, SmartForm >; } namespace smartlist { /** * Describes the settings that can be provided to the SmartList constructor. */ interface $SmartListSettings extends sap.m.$VBoxSettings { /** * The entity set name from which to fetch data. * Note: * This is not a dynamic UI5 property. * * @since 1.48.0 */ entitySet?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * CSV of fields that must be selected when request is sent to the backend. * Note: * No validation is done. Please ensure that you do not add spaces or special characters. * This property is only needed when used together with an `ODataModel`. * * @since 1.48.0 */ selectFields?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * CSV of fields that must be expanded when request is sent to the backend. * Note: * No validation is done. Please ensure that you do not add spaces or special characters. * This property is only needed when used together with an `ODataModel`. * * @since 1.48.0 */ expandFields?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The number of rows is shown along with the header text if the property `showRowCount` is set to `true`. * * **Note:** * - To improve your application's performance, activate the inline count for OData bindings to avoid * sending dedicated OData requests. * - If no stable overall count can be retrieved from the binding, the count will not be displayed. This * is currently the case for TreeBinding or if no count is requested by the binding. * * @since 1.48.0 */ showRowCount?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies header text that is shown in list. * * @since 1.48.0 */ header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * When set to `true`, this enables automatic binding of the list using the `listBindingPath` (if it exists) * or `entitySet` property. This happens right after the `initialise` event has been fired. * * @since 1.48.0 */ enableAutoBinding?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies the path that is used during the binding of the list. If not specified, the `entitySet` property * is used instead. (used only if binding is done automatically or when using `rebindList`) * * @since 1.48.0 */ listBindingPath?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Specifies the type of list to be created in the `SmartList` control. * Note: * If you add a `List` or `Tree` to the content of the `SmartList` control in the view, this property has * no effect. * * @since 1.48.0 */ listType?: | sap.ui.comp.smartlist.ListType | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the full screen button. * * @since 1.48.0 */ showFullScreenButton?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies the template that is used for the inner `List` or `Tree` control. * **Note:** * This template is used when binding the `items` of `sap.m.List` or `sap.m.Tree` control, and will not * be available in the `SmartList` control once the binding has been done. * * @since 1.48.0 */ listItemTemplate?: sap.m.ListItemBase; /** * The `SmartFilterBar` control to be linked to the `SmartList` control. Some events of the `SmartFilterBar` * control are then used to fetch data, show overlay etc. * * @since 1.48.0 */ smartFilter?: sap.ui.core.Control | string; /** * Event fired once the control has been initialized. * * @since 1.48.0 */ initialise?: (oEvent: sap.ui.base.Event) => void; /** * Event fired right before the binding is being done. * * @since 1.48.0 */ beforeRebindList?: (oEvent: sap.ui.base.Event) => void; /** * Event fired when data is received after binding. The event is usually only fired if the binding for the * list is done by the `SmartList` control itself. * * @since 1.48.0 */ dataReceived?: (oEvent: sap.ui.base.Event) => void; } /** * Parameters of the SmartList#beforeRebindList event. */ interface SmartList$BeforeRebindListEventParameters {} /** * Parameters of the SmartList#dataReceived event. */ interface SmartList$DataReceivedEventParameters {} /** * Parameters of the SmartList#initialise event. */ interface SmartList$InitialiseEventParameters {} /** * A smart control to simplify using the `sap.m.List` and `sap.m.Tree` controls in list patterns. Overview: * The `SmartList` control creates a list or tree based on the configuration specified. There is, however, * a difference to other smart controls: This control does not use annotations to automatically create its * content. Hence, a template must always be provided for this control. Structure: The `SmartList` control * consists of the following elements: * - `OverflowToolbar` control: Displays the header and other action buttons. Users can add their own * toolbar and buttons in the view. * - `List` or `Tree` control: The actual list/tree control. Users can also add this in the view with * the required configuration. The `entitySet` property must be specified to use the control. This * attribute is used to fetch the actual data. * The `listItemTemplate` aggregation must also be specified with the required item template, such as `StandardListItem/StandardTreeItem`, * which will be used during binding. **Note:**: Most of the attributes/properties are not dynamic and cannot * be changed once the control has been initialized. * * @since 1.48 */ class SmartList extends sap.m.VBox { /** * Constructor for a new smartlist/SmartList. * * 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.ui.comp.smartlist.$SmartListSettings ); /** * Constructor for a new smartlist/SmartList. * * 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.ui.comp.smartlist.$SmartListSettings ); /** * Creates a new subclass of class sap.ui.comp.smartlist.SmartList 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.VBox.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartlist.SmartList. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:beforeRebindList beforeRebindList} event of * this `sap.ui.comp.smartlist.SmartList`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartlist.SmartList` itself. * * Event fired right before the binding is being done. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ attachBeforeRebindList( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartlist.SmartList` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeRebindList beforeRebindList} event of * this `sap.ui.comp.smartlist.SmartList`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartlist.SmartList` itself. * * Event fired right before the binding is being done. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ attachBeforeRebindList( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartlist.SmartList` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:dataReceived dataReceived} event of this `sap.ui.comp.smartlist.SmartList`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartlist.SmartList` itself. * * Event fired when data is received after binding. The event is usually only fired if the binding for the * list is done by the `SmartList` control itself. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ attachDataReceived( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartlist.SmartList` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:dataReceived dataReceived} event of this `sap.ui.comp.smartlist.SmartList`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartlist.SmartList` itself. * * Event fired when data is received after binding. The event is usually only fired if the binding for the * list is done by the `SmartList` control itself. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ attachDataReceived( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartlist.SmartList` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialise initialise} event of this `sap.ui.comp.smartlist.SmartList`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartlist.SmartList` itself. * * Event fired once the control has been initialized. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ attachInitialise( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartlist.SmartList` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialise initialise} event of this `sap.ui.comp.smartlist.SmartList`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartlist.SmartList` itself. * * Event fired once the control has been initialized. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ attachInitialise( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartlist.SmartList` itself */ oListener?: object ): this; /** * Destroys the listItemTemplate in the aggregation {@link #getListItemTemplate listItemTemplate}. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ destroyListItemTemplate(): this; /** * Detaches event handler `fnFunction` from the {@link #event:beforeRebindList beforeRebindList} event of * this `sap.ui.comp.smartlist.SmartList`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ detachBeforeRebindList( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:dataReceived dataReceived} event of this `sap.ui.comp.smartlist.SmartList`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ detachDataReceived( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:initialise initialise} event of this `sap.ui.comp.smartlist.SmartList`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ detachInitialise( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Cleans up the control * * @ui5-protected Do not call from applications (only from related classes in the framework) */ exit(): void; /** * Fires event {@link #event:beforeRebindList beforeRebindList} to attached listeners. * * @since 1.48.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireBeforeRebindList( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:dataReceived dataReceived} to attached listeners. * * @since 1.48.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireDataReceived( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:initialise initialise} to attached listeners. * * @since 1.48.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireInitialise( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Gets current value of property {@link #getEnableAutoBinding enableAutoBinding}. * * When set to `true`, this enables automatic binding of the list using the `listBindingPath` (if it exists) * or `entitySet` property. This happens right after the `initialise` event has been fired. * * Default value is `false`. * * @since 1.48.0 * * @returns Value of property `enableAutoBinding` */ getEnableAutoBinding(): boolean; /** * Gets current value of property {@link #getEntitySet entitySet}. * * The entity set name from which to fetch data. * Note: * This is not a dynamic UI5 property. * * @since 1.48.0 * * @returns Value of property `entitySet` */ getEntitySet(): string; /** * Gets current value of property {@link #getExpandFields expandFields}. * * CSV of fields that must be expanded when request is sent to the backend. * Note: * No validation is done. Please ensure that you do not add spaces or special characters. * This property is only needed when used together with an `ODataModel`. * * @since 1.48.0 * * @returns Value of property `expandFields` */ getExpandFields(): string; /** * Gets current value of property {@link #getHeader header}. * * Specifies header text that is shown in list. * * @since 1.48.0 * * @returns Value of property `header` */ getHeader(): string; /** * Returns the `List` or `Tree` used internally. * * * @returns the control */ getList(): object; /** * Gets current value of property {@link #getListBindingPath listBindingPath}. * * Specifies the path that is used during the binding of the list. If not specified, the `entitySet` property * is used instead. (used only if binding is done automatically or when using `rebindList`) * * @since 1.48.0 * * @returns Value of property `listBindingPath` */ getListBindingPath(): string; /** * Gets content of aggregation {@link #getListItemTemplate listItemTemplate}. * * Specifies the template that is used for the inner `List` or `Tree` control. * **Note:** * This template is used when binding the `items` of `sap.m.List` or `sap.m.Tree` control, and will not * be available in the `SmartList` control once the binding has been done. * * @since 1.48.0 */ getListItemTemplate(): sap.m.ListItemBase; /** * Gets current value of property {@link #getListType listType}. * * Specifies the type of list to be created in the `SmartList` control. * Note: * If you add a `List` or `Tree` to the content of the `SmartList` control in the view, this property has * no effect. * * @since 1.48.0 * * @returns Value of property `listType` */ getListType(): sap.ui.comp.smartlist.ListType; /** * Gets current value of property {@link #getSelectFields selectFields}. * * CSV of fields that must be selected when request is sent to the backend. * Note: * No validation is done. Please ensure that you do not add spaces or special characters. * This property is only needed when used together with an `ODataModel`. * * @since 1.48.0 * * @returns Value of property `selectFields` */ getSelectFields(): string; /** * Gets current value of property {@link #getShowFullScreenButton showFullScreenButton}. * * Controls the visibility of the full screen button. * * Default value is `false`. * * @since 1.48.0 * * @returns Value of property `showFullScreenButton` */ getShowFullScreenButton(): boolean; /** * Gets current value of property {@link #getShowRowCount showRowCount}. * * The number of rows is shown along with the header text if the property `showRowCount` is set to `true`. * * **Note:** * - To improve your application's performance, activate the inline count for OData bindings to avoid * sending dedicated OData requests. * - If no stable overall count can be retrieved from the binding, the count will not be displayed. This * is currently the case for TreeBinding or if no count is requested by the binding. * * Default value is `true`. * * @since 1.48.0 * * @returns Value of property `showRowCount` */ getShowRowCount(): boolean; /** * ID of the element which is the current target of the association {@link #getSmartFilter smartFilter}, * or `null`. * * @since 1.48.0 */ getSmartFilter(): sap.ui.core.ID | null; /** * Checks whether the control is initialized. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns returns whether control has already been initialized */ isInitialised(): boolean; /** * This can be used to trigger binding on the list used in the SmartList * * @ui5-protected Do not call from applications (only from related classes in the framework) */ rebindList( /** * force bind call to be triggered on the inner list */ bForceRebind: boolean ): void; /** * Sets a new value for property {@link #getEnableAutoBinding enableAutoBinding}. * * When set to `true`, this enables automatic binding of the list using the `listBindingPath` (if it exists) * or `entitySet` property. This happens right after the `initialise` event has been fired. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ setEnableAutoBinding( /** * New value for property `enableAutoBinding` */ bEnableAutoBinding?: boolean ): this; /** * Sets a new value for property {@link #getEntitySet entitySet}. * * The entity set name from which to fetch data. * Note: * This is not a dynamic UI5 property. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ setEntitySet( /** * New value for property `entitySet` */ sEntitySet?: string ): this; /** * Sets a new value for property {@link #getExpandFields expandFields}. * * CSV of fields that must be expanded when request is sent to the backend. * Note: * No validation is done. Please ensure that you do not add spaces or special characters. * This property is only needed when used together with an `ODataModel`. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ setExpandFields( /** * New value for property `expandFields` */ sExpandFields?: string ): this; /** * Sets a new value for property {@link #getHeader header}. * * Specifies header text that is shown in list. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ setHeader( /** * New value for property `header` */ sHeader?: string ): this; /** * Sets a new value for property {@link #getListBindingPath listBindingPath}. * * Specifies the path that is used during the binding of the list. If not specified, the `entitySet` property * is used instead. (used only if binding is done automatically or when using `rebindList`) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ setListBindingPath( /** * New value for property `listBindingPath` */ sListBindingPath?: string ): this; /** * Sets the aggregated {@link #getListItemTemplate listItemTemplate}. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ setListItemTemplate( /** * The listItemTemplate to set */ oListItemTemplate: sap.m.ListItemBase ): this; /** * Sets a new value for property {@link #getListType listType}. * * Specifies the type of list to be created in the `SmartList` control. * Note: * If you add a `List` or `Tree` to the content of the `SmartList` control in the view, this property has * no effect. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ setListType( /** * New value for property `listType` */ sListType?: sap.ui.comp.smartlist.ListType ): this; /** * Sets a new value for property {@link #getSelectFields selectFields}. * * CSV of fields that must be selected when request is sent to the backend. * Note: * No validation is done. Please ensure that you do not add spaces or special characters. * This property is only needed when used together with an `ODataModel`. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ setSelectFields( /** * New value for property `selectFields` */ sSelectFields?: string ): this; /** * Sets a new value for property {@link #getShowFullScreenButton showFullScreenButton}. * * Controls the visibility of the full screen button. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ setShowFullScreenButton( /** * New value for property `showFullScreenButton` */ bShowFullScreenButton?: boolean ): this; /** * Sets a new value for property {@link #getShowRowCount showRowCount}. * * The number of rows is shown along with the header text if the property `showRowCount` is set to `true`. * * **Note:** * - To improve your application's performance, activate the inline count for OData bindings to avoid * sending dedicated OData requests. * - If no stable overall count can be retrieved from the binding, the count will not be displayed. This * is currently the case for TreeBinding or if no count is requested by the binding. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ setShowRowCount( /** * New value for property `showRowCount` */ bShowRowCount?: boolean ): this; /** * Sets the associated {@link #getSmartFilter smartFilter}. * * @since 1.48.0 * * @returns Reference to `this` in order to allow method chaining */ setSmartFilter( /** * ID of an element which becomes the new target of this smartFilter association; alternatively, an element * instance may be given */ oSmartFilter: sap.ui.core.ID | sap.ui.core.Control ): this; } /** * Provides enumeration sap.ui.comp.smartlist.ListType. A subset of list types that fit to a simple API * returning one string. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartlist.ListType'. * * @since 1.48 */ enum ListType { /** * A list (sap.m.List) control shall be created as the content of the SmartList, if no list already exists * (default) */ List = "List", /** * A tree (sap.m.Tree) control shall be created as the content of the SmartList, if no list/tree already * exists */ Tree = "Tree", } /** * Event object of the SmartList#beforeRebindList event. */ type SmartList$BeforeRebindListEvent = sap.ui.base.Event< SmartList$BeforeRebindListEventParameters, SmartList >; /** * Event object of the SmartList#dataReceived event. */ type SmartList$DataReceivedEvent = sap.ui.base.Event< SmartList$DataReceivedEventParameters, SmartList >; /** * Event object of the SmartList#initialise event. */ type SmartList$InitialiseEvent = sap.ui.base.Event< SmartList$InitialiseEventParameters, SmartList >; } namespace smartmicrochart { /** * Describes the settings that can be provided to the SmartAreaMicroChart constructor. */ interface $SmartAreaMicroChartSettings extends sap.ui.comp.smartmicrochart.$SmartMicroChartBaseSettings { /** * Only `true` value is supported: the chart will be bound to the chartBindingPath or to the entitySet */ enableAutoBinding?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the SmartBulletMicroChart constructor. */ interface $SmartBulletMicroChartSettings extends sap.ui.comp.smartmicrochart.$SmartMicroChartBaseSettings { /** * If set to `true`, this enables automatic binding of the chart using the chartBindingPath (if it exists) * property. */ enableAutoBinding?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the SmartColumnMicroChart constructor. */ interface $SmartColumnMicroChartSettings extends sap.ui.comp.smartmicrochart.$SmartMicroChartBaseSettings {} /** * Describes the settings that can be provided to the SmartComparisonMicroChart constructor. */ interface $SmartComparisonMicroChartSettings extends sap.ui.comp.smartmicrochart.$SmartMicroChartBaseSettings {} /** * Describes the settings that can be provided to the SmartDeltaMicroChart constructor. */ interface $SmartDeltaMicroChartSettings extends sap.ui.comp.smartmicrochart.$SmartMicroChartBaseSettings { /** * If set to `true`, this enables automatic data binding using the `chartBindingPath` property , if such * a property exists. */ enableAutoBinding?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the SmartHarveyBallMicroChart constructor. */ interface $SmartHarveyBallMicroChartSettings extends sap.ui.comp.smartmicrochart.$SmartMicroChartBaseSettings { /** * If set to `true`, the chart is automatically bound using the `chartBindingPath` property, if it is specified. */ enableAutoBinding?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If the associated control is provided, its `text` property is set to the free text provided by annotations. * The `Value` property of the `DataPoint` annotation should be annotated with this free text. The `Label` * annotation from the `OData Common` vocabulary can be used. */ freeText?: sap.m.Label | string; } /** * Describes the settings that can be provided to the SmartLineMicroChart constructor. */ interface $SmartLineMicroChartSettings extends sap.ui.comp.smartmicrochart.$SmartMicroChartBaseSettings {} /** * Describes the settings that can be provided to the SmartMicroChart constructor. */ interface $SmartMicroChartSettings extends sap.ui.core.$ControlSettings { /** * The entity set name to fetch data and create the internal chart representation from. Note that this is * not a dynamic UI5 property. */ entitySet?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Determines if any label is shown or not */ showLabel?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `true`, this enables automatic binding of the chart using the chartBindingPath (if it exists) * or entitySet property. */ enableAutoBinding?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * This attribute can be used to specify the path that is used during the binding of the chart. If not specified, * the entitySet attribute is used instead and also stored in this property. Calling `bindElement` binds * the control and sets this property. */ chartBindingPath?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Specifies the type of chart. Note that this property is read-only. */ chartType?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The width of the chart. Overrides the width specified in the `size` property. */ width?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The height of the chart. Overrides the height specified in the `size` property. */ height?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The size of the microchart. If not set, the default size is applied based on the size of the device tile. * Responsive size takes width and height of the parent container where the micro chart is included. * * @since 1.62 */ size?: | sap.m.Size | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If this set to true, width and height of the control are determined by the width and height of the container * in which the control is placed or by the width and height property. * * @deprecated As of version 1.62. the concept has been discarded. */ isResponsive?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If the associated control is provided, its `text` property is set to the Title property of the Chart * annotation. Title property of the DataPoint annotation is ignored. */ chartTitle?: sap.m.Label | string; /** * If the associated control is provided, its `text` property is set to the Description property of the * Chart annotation. Description property of the DataPoint annotation is ignored. */ chartDescription?: sap.m.Label | string; /** * If the associated control is provided, its `text` property is set to the Unit of Measure. The Value property * of the DataPoint annotation should be annotated with this Unit of Measure. It can be either ISOCurrency * or Unit from the OData Measures annotations. */ unitOfMeasure?: sap.m.Label | string; /** * If the associated control is provided, its `text` property is set to the free text provided by annotations. * The Value property of the DataPoint annotation should be annotated with this free text. As of 1.42.0, * this association is only available for chart type 'Donut'. * * @since 1.42.0 */ freeText?: sap.m.Label | string; /** * Controls or IDs that label this control. Can be used by screen reader software. * * @since 1.60.0 */ ariaLabelledBy?: Array; /** * Event fired once the control has been initialized. */ initialize?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the SmartMicroChartBase constructor. */ interface $SmartMicroChartBaseSettings extends sap.ui.core.$ControlSettings { /** * The OData entity set bound to the smart line micro chart. * This entity set is used to pull data into the micro chart and create its internal representation. * Please note that this property cannot be updated dynamically. */ entitySet?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Specifies the type of chart. Note that this property is read-only. */ chartType?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * This property can be used to specify a relative path (without '/') to an entity set (not a single entity) * that is used during the binding of the chart. * For example, it can be a navigation property that will be added to the context path. * If not specified, the `entitySet` property is used instead. */ chartBindingPath?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Determines if any label is shown or not. */ showLabel?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The width of the chart. Overrides the width specified in the `size` property. */ width?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The height of the chart. Overrides the height specified in the `size` property. */ height?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The size of the microchart. If not set, the default size is applied based on the size of the device tile. * Responsive size takes width and height of the parent container where the micro chart is included. * * @since 1.62 */ size?: | sap.m.Size | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If this set to true, width and height of the control are determined by the width and height of the container * in which the control is placed or by the width and height property. * * @deprecated As of version 1.62. the concept has been discarded. */ isResponsive?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If the associated control is provided, its `Text` property is set to the `Title` property of the Chart * annotation. The `Title` property of the DataPoint annotation is ignored. */ chartTitle?: sap.m.Label | string; /** * If the associated control is provided, its `Text` property is set to the `Description` property of the * Chart annotation. The `Description` property of the DataPoint annotation is ignored. */ chartDescription?: sap.m.Label | string; /** * If the associated control is provided, its `Text` property is set to the `Unit of Measure` property of * the Chart annotation. The `Value` property of the DataPoint annotation should be annotated with this * unit of measurement. It can be either ISOCurrency or Unit from the OData Measures annotations. */ unitOfMeasure?: sap.m.Label | string; /** * Controls or IDs that label this control. Can be used by screen reader software. * * @since 1.60.0 */ ariaLabelledBy?: Array; /** * This event is fired after the control has been initialized. */ initialize?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the SmartRadialMicroChart constructor. */ interface $SmartRadialMicroChartSettings extends sap.ui.comp.smartmicrochart.$SmartMicroChartBaseSettings { /** * If set to `true`, this enables automatic binding of the chart using the chartBindingPath (if it exists) * property. */ enableAutoBinding?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If the associated control is provided, its `text` property is set to the free text provided by annotations. * The Value property of the DataPoint annotation should be annotated with this free text. The Label annotation * from the OData Common vocabulary can be used. */ freeText?: sap.m.Label | string; } /** * Describes the settings that can be provided to the SmartStackedBarMicroChart constructor. */ interface $SmartStackedBarMicroChartSettings extends sap.ui.comp.smartmicrochart.$SmartMicroChartBaseSettings {} /** * Parameters of the SmartMicroChart#initialize event. */ interface SmartMicroChart$InitializeEventParameters {} /** * Parameters of the SmartMicroChartBase#initialize event. */ interface SmartMicroChartBase$InitializeEventParameters {} /** * The SmartAreaMicroChart control creates a AreaMicroChart based on OData metadata and the configuration * specified. The entitySet attribute must be specified to use the control. This attribute is used to fetch * fields from OData metadata, from which Micro Area Chart UI will be generated; it can also be used to * fetch the actual chart data. * **Note:** * Most of the attributes/properties are not dynamic and cannot be changed once the control has been initialised. * * @since 1.38 */ class SmartAreaMicroChart extends sap.ui.comp.smartmicrochart .SmartMicroChartBase { /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartAreaMicroChart. * * 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.ui.comp.smartmicrochart.$SmartAreaMicroChartSettings ); /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartAreaMicroChart. * * 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.ui.comp.smartmicrochart.$SmartAreaMicroChartSettings ); /** * Creates a new subclass of class sap.ui.comp.smartmicrochart.SmartAreaMicroChart 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.comp.smartmicrochart.SmartMicroChartBase.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< T, sap.ui.comp.smartmicrochart.SmartAreaMicroChart >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartmicrochart.SmartAreaMicroChart. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getEnableAutoBinding enableAutoBinding}. * * Only `true` value is supported: the chart will be bound to the chartBindingPath or to the entitySet * * Default value is `true`. * * * @returns Value of property `enableAutoBinding` */ getEnableAutoBinding(): boolean; } /** * The SmartBulletMicroChart control creates a `sap.suite.ui.microchart.BulletMicroChart` based on OData * metadata and the configuration specified by `mSettings`. The entitySet attribute must be specified to * use the control. This attribute is used to fetch metadata and annotation information from the given default * OData model. Based on this, the BulletMicroChart UI is created. * **Note:** * Most of the attributes/properties are not dynamic and cannot be changed once the control has been initialized. * * @since 1.38 */ class SmartBulletMicroChart extends sap.ui.comp.smartmicrochart .SmartMicroChartBase { /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartBulletMicroChart. * * 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.ui.comp.smartmicrochart.$SmartBulletMicroChartSettings ); /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartBulletMicroChart. * * 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.ui.comp.smartmicrochart.$SmartBulletMicroChartSettings ); /** * Creates a new subclass of class sap.ui.comp.smartmicrochart.SmartBulletMicroChart 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.comp.smartmicrochart.SmartMicroChartBase.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< T, sap.ui.comp.smartmicrochart.SmartBulletMicroChart >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartmicrochart.SmartBulletMicroChart. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getEnableAutoBinding enableAutoBinding}. * * If set to `true`, this enables automatic binding of the chart using the chartBindingPath (if it exists) * property. * * Default value is `false`. * * * @returns Value of property `enableAutoBinding` */ getEnableAutoBinding(): boolean; /** * Sets a new value for property {@link #getEnableAutoBinding enableAutoBinding}. * * If set to `true`, this enables automatic binding of the chart using the chartBindingPath (if it exists) * property. * * 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 */ setEnableAutoBinding( /** * New value for property `enableAutoBinding` */ bEnableAutoBinding?: boolean ): this; } /** * The SmartColumnMicroChart control creates a {@link sap.suite.ui.microchart.ColumnMicroChart ColumnMicroChart } * based on OData metadata and the configuration specified. * The `entitySet` property is required. The entity set you specify in this property is used to fetch OData * metadata and to generate the micro chart's UI. This property can also be used to fetch actual chart data. * **Note:** * Most properties are not dynamic and cannot be changed, once the control has been initialized. * * @since 1.60 */ class SmartColumnMicroChart extends sap.ui.comp.smartmicrochart .SmartMicroChartBase { /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartColumnMicroChart. * * 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.comp.smartmicrochart.SmartMicroChartBase#constructor sap.ui.comp.smartmicrochart.SmartMicroChartBase } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: sap.ui.comp.smartmicrochart.$SmartColumnMicroChartSettings ); /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartColumnMicroChart. * * 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.comp.smartmicrochart.SmartMicroChartBase#constructor sap.ui.comp.smartmicrochart.SmartMicroChartBase } * 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.ui.comp.smartmicrochart.$SmartColumnMicroChartSettings ); /** * Creates a new subclass of class sap.ui.comp.smartmicrochart.SmartColumnMicroChart 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.comp.smartmicrochart.SmartMicroChartBase.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< T, sap.ui.comp.smartmicrochart.SmartColumnMicroChart >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartmicrochart.SmartColumnMicroChart. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; } /** * The SmartComparisonMicroChart control creates a ComparisonMicroChart based on OData metadata and the * configuration specified. The `entitySet` property is required to use the control. The entity set you * specify in this property is used to feetch OData metadata and to generate the micro chart's UI. This * property can also be used to fetch actual data. * **Notes:** * * - Most properties are not dynamic and cannot be changed, once the control has been initialized. * - SmartComparisonMicroChart does not have its own ChartType/Enum annotation. This means that ChartType * annotation is not specified and SmartComparisonMicroChart cannot be created with a `SmartMicroChart`. * * @since 1.58 */ class SmartComparisonMicroChart extends sap.ui.comp.smartmicrochart .SmartMicroChartBase { /** * Constructor for a new SmartComparisonMicroChart. * * 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.comp.smartmicrochart.SmartMicroChartBase#constructor sap.ui.comp.smartmicrochart.SmartMicroChartBase } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: sap.ui.comp.smartmicrochart.$SmartComparisonMicroChartSettings ); /** * Constructor for a new SmartComparisonMicroChart. * * 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.comp.smartmicrochart.SmartMicroChartBase#constructor sap.ui.comp.smartmicrochart.SmartMicroChartBase } * 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.ui.comp.smartmicrochart.$SmartComparisonMicroChartSettings ); /** * Creates a new subclass of class sap.ui.comp.smartmicrochart.SmartComparisonMicroChart 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.comp.smartmicrochart.SmartMicroChartBase.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< T, sap.ui.comp.smartmicrochart.SmartComparisonMicroChart >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartmicrochart.SmartComparisonMicroChart. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; } /** * The SmartDeltaMicroChart control creates a {@link sap.suite.ui.microchart.DeltaMicroChart DeltaMicroChart } * based on OData metadata and the configuration specified. The delta micro chart represents the delta of * two values as a chart. * The `entitySet` property is required to use the control. The entity set you specify in this property * is used to fetch OData metadata and to generate the micro chart's UI. This property can also be used * to fetch actual data. * **Notes:** * * - Most properties are not dynamic and cannot be changed once the control has been initialized. * - SmartDeltaMicroChart does not have its own ChartType/Enum annotation. This means that ChartType * annotation is not specified and SmartDeltaMicroChart cannot be created with a `SmartMicroChart`. * * @since 1.61 */ class SmartDeltaMicroChart extends sap.ui.comp.smartmicrochart .SmartMicroChartBase { /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartDeltaMicroChart. * * 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.ui.comp.smartmicrochart.$SmartDeltaMicroChartSettings ); /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartDeltaMicroChart. * * 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.ui.comp.smartmicrochart.$SmartDeltaMicroChartSettings ); /** * Creates a new subclass of class sap.ui.comp.smartmicrochart.SmartDeltaMicroChart 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.comp.smartmicrochart.SmartMicroChartBase.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< T, sap.ui.comp.smartmicrochart.SmartDeltaMicroChart >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartmicrochart.SmartDeltaMicroChart. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getEnableAutoBinding enableAutoBinding}. * * If set to `true`, this enables automatic data binding using the `chartBindingPath` property , if such * a property exists. * * Default value is `false`. * * * @returns Value of property `enableAutoBinding` */ getEnableAutoBinding(): boolean; /** * Sets a new value for property {@link #getEnableAutoBinding enableAutoBinding}. * * If set to `true`, this enables automatic data binding using the `chartBindingPath` property , if such * a property exists. * * 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 */ setEnableAutoBinding( /** * New value for property `enableAutoBinding` */ bEnableAutoBinding?: boolean ): this; } /** * The SmartHarveyBallMicroChart control creates a {@link sap.suite.ui.microchart.HarveyBallMicroChart } * based on OData metadata and the configuration specified in the `mSettings` of the {@link sap.ui.base.ManagedObject}. * * The `entitySet` property is required. The entity set is used to fetch OData metadata and annotation information * from the provided default OData model. The chart's UI is created based on this data. * **Note:** * Most of the properties are not dynamic and cannot be changed once the control has been initialized. * * @since 1.62.0 */ class SmartHarveyBallMicroChart extends sap.ui.comp.smartmicrochart .SmartMicroChartBase { /** * Constructor for a new SmartHarveyBallMicroChart. * * 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.ui.comp.smartmicrochart.$SmartHarveyBallMicroChartSettings ); /** * Constructor for a new SmartHarveyBallMicroChart. * * 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.ui.comp.smartmicrochart.$SmartHarveyBallMicroChartSettings ); /** * Creates a new subclass of class sap.ui.comp.smartmicrochart.SmartHarveyBallMicroChart 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.comp.smartmicrochart.SmartMicroChartBase.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< T, sap.ui.comp.smartmicrochart.SmartHarveyBallMicroChart >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartmicrochart.SmartHarveyBallMicroChart. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getEnableAutoBinding enableAutoBinding}. * * If set to `true`, the chart is automatically bound using the `chartBindingPath` property, if it is specified. * * Default value is `false`. * * * @returns Value of property `enableAutoBinding` */ getEnableAutoBinding(): boolean; /** * ID of the element which is the current target of the association {@link #getFreeText freeText}, or `null`. */ getFreeText(): sap.ui.core.ID | null; /** * Sets a new value for property {@link #getEnableAutoBinding enableAutoBinding}. * * If set to `true`, the chart is automatically bound using the `chartBindingPath` property, if it is specified. * * 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 */ setEnableAutoBinding( /** * New value for property `enableAutoBinding` */ bEnableAutoBinding?: boolean ): this; /** * Sets the associated {@link #getFreeText freeText}. * * * @returns Reference to `this` in order to allow method chaining */ setFreeText( /** * ID of an element which becomes the new target of this freeText association; alternatively, an element * instance may be given */ oFreeText: sap.ui.core.ID | sap.m.Label ): this; } /** * The SmartLineMicroChart control creates a {@link sap.suite.ui.microchart.LineMicroChart LineMicroChart } * based on OData metadata and the configuration specified. * The `entitySet` property is required. The entity set you specify in this property is used to fetch OData * metadata and to generate the micro chart's UI. This property can also be used to fetch actual chart data. * **Note:** * Most properties are not dynamic and cannot be changed, once the control has been initialized. * * @since 1.60 */ class SmartLineMicroChart extends sap.ui.comp.smartmicrochart .SmartMicroChartBase { /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartLineMicroChart. * * 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.comp.smartmicrochart.SmartMicroChartBase#constructor sap.ui.comp.smartmicrochart.SmartMicroChartBase } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: sap.ui.comp.smartmicrochart.$SmartLineMicroChartSettings ); /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartLineMicroChart. * * 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.comp.smartmicrochart.SmartMicroChartBase#constructor sap.ui.comp.smartmicrochart.SmartMicroChartBase } * 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.ui.comp.smartmicrochart.$SmartLineMicroChartSettings ); /** * Creates a new subclass of class sap.ui.comp.smartmicrochart.SmartLineMicroChart 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.comp.smartmicrochart.SmartMicroChartBase.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< T, sap.ui.comp.smartmicrochart.SmartLineMicroChart >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartmicrochart.SmartLineMicroChart. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; } /** * The SmartMicroChart control creates a chart based on OData metadata and the configuration specified by * `mSettings`. * The `entitySet` property is required. This property is used to fetch metadata and annotation information * from the specified default OData model. Depending on the UI/ChartType annotation, the control creates * a corresponding {@link sap.ui.comp.smartmicrochart.SmartAreaMicroChart SmartAreaMicroChart}, {@link sap.ui.comp.smartmicrochart.SmartBulletMicroChart SmartBulletMicroChart}, * {@link sap.ui.comp.smartmicrochart.SmartStackedBarMicroChart SmartStackedBarMicroChart}, {@link sap.ui.comp.smartmicrochart.SmartLineMicroChart SmartLineMicroChart}, * or {@link sap.ui.comp.smartmicrochart.SmartRadialMicroChart SmartRadialMicroChart} instance and delegates * it to the internal control. * **Note:** Most of the attributes are not dynamic and cannot be changed once the control has been * initialized. * * @since 1.38 */ class SmartMicroChart extends sap.ui.core.Control { /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartMicroChart. * * 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.ui.comp.smartmicrochart.$SmartMicroChartSettings ); /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartMicroChart. * * 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.ui.comp.smartmicrochart.$SmartMicroChartSettings ); /** * Creates a new subclass of class sap.ui.comp.smartmicrochart.SmartMicroChart 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< T, sap.ui.comp.smartmicrochart.SmartMicroChart >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartmicrochart.SmartMicroChart. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * @since 1.60.0 * * @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; /** * Attaches event handler `fnFunction` to the {@link #event:initialize initialize} event of this `sap.ui.comp.smartmicrochart.SmartMicroChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartmicrochart.SmartMicroChart` itself. * * Event fired once the control has been initialized. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialize( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartmicrochart.SmartMicroChart` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialize initialize} event of this `sap.ui.comp.smartmicrochart.SmartMicroChart`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartmicrochart.SmartMicroChart` itself. * * Event fired once the control has been initialized. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialize( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartmicrochart.SmartMicroChart` * itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:initialize initialize} event of this `sap.ui.comp.smartmicrochart.SmartMicroChart`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachInitialize( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:initialize initialize} 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 */ fireInitialize( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. * * @since 1.60.0 */ getAriaLabelledBy(): sap.ui.core.ID[]; /** * Gets current value of property {@link #getChartBindingPath chartBindingPath}. * * This attribute can be used to specify the path that is used during the binding of the chart. If not specified, * the entitySet attribute is used instead and also stored in this property. Calling `bindElement` binds * the control and sets this property. * * * @returns Value of property `chartBindingPath` */ getChartBindingPath(): string; /** * ID of the element which is the current target of the association {@link #getChartDescription chartDescription}, * or `null`. */ getChartDescription(): sap.ui.core.ID | null; /** * ID of the element which is the current target of the association {@link #getChartTitle chartTitle}, or * `null`. */ getChartTitle(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getChartType chartType}. * * Specifies the type of chart. Note that this property is read-only. * * * @returns Value of property `chartType` */ getChartType(): string; /** * Gets current value of property {@link #getEnableAutoBinding enableAutoBinding}. * * If set to `true`, this enables automatic binding of the chart using the chartBindingPath (if it exists) * or entitySet property. * * Default value is `false`. * * * @returns Value of property `enableAutoBinding` */ getEnableAutoBinding(): boolean; /** * Gets current value of property {@link #getEntitySet entitySet}. * * The entity set name to fetch data and create the internal chart representation from. Note that this is * not a dynamic UI5 property. * * * @returns Value of property `entitySet` */ getEntitySet(): string; /** * ID of the element which is the current target of the association {@link #getFreeText freeText}, or `null`. * * @since 1.42.0 */ getFreeText(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getHeight height}. * * The height of the chart. Overrides the height specified in the `size` property. * * * @returns Value of property `height` */ getHeight(): sap.ui.core.CSSSize; /** * Gets current value of property {@link #getIsResponsive isResponsive}. * * If this set to true, width and height of the control are determined by the width and height of the container * in which the control is placed or by the width and height property. * * Default value is `false`. * * @deprecated As of version 1.62. the concept has been discarded. * * @returns Value of property `isResponsive` */ getIsResponsive(): boolean; /** * Gets current value of property {@link #getShowLabel showLabel}. * * Determines if any label is shown or not * * Default value is `true`. * * * @returns Value of property `showLabel` */ getShowLabel(): boolean; /** * Gets current value of property {@link #getSize size}. * * The size of the microchart. If not set, the default size is applied based on the size of the device tile. * Responsive size takes width and height of the parent container where the micro chart is included. * * Default value is `"Auto"`. * * @since 1.62 * * @returns Value of property `size` */ getSize(): sap.m.Size; /** * ID of the element which is the current target of the association {@link #getUnitOfMeasure unitOfMeasure}, * or `null`. */ getUnitOfMeasure(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getWidth width}. * * The width of the chart. Overrides the width specified in the `size` property. * * * @returns Value of property `width` */ getWidth(): sap.ui.core.CSSSize; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * @since 1.60.0 * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): sap.ui.core.ID[]; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * @since 1.60.0 * * @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; /** * Sets a new value for property {@link #getChartBindingPath chartBindingPath}. * * This attribute can be used to specify the path that is used during the binding of the chart. If not specified, * the entitySet attribute is used instead and also stored in this property. Calling `bindElement` binds * the control and sets this property. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setChartBindingPath( /** * New value for property `chartBindingPath` */ sChartBindingPath?: string ): this; /** * Sets the associated {@link #getChartDescription chartDescription}. * * * @returns Reference to `this` in order to allow method chaining */ setChartDescription( /** * ID of an element which becomes the new target of this chartDescription association; alternatively, an * element instance may be given */ oChartDescription: sap.ui.core.ID | sap.m.Label ): this; /** * Sets the associated {@link #getChartTitle chartTitle}. * * * @returns Reference to `this` in order to allow method chaining */ setChartTitle( /** * ID of an element which becomes the new target of this chartTitle association; alternatively, an element * instance may be given */ oChartTitle: sap.ui.core.ID | sap.m.Label ): this; /** * Sets a new value for property {@link #getEnableAutoBinding enableAutoBinding}. * * If set to `true`, this enables automatic binding of the chart using the chartBindingPath (if it exists) * or entitySet property. * * 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 */ setEnableAutoBinding( /** * New value for property `enableAutoBinding` */ bEnableAutoBinding?: boolean ): this; /** * Sets a new value for property {@link #getEntitySet entitySet}. * * The entity set name to fetch data and create the internal chart representation from. Note that this is * not a dynamic UI5 property. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setEntitySet( /** * New value for property `entitySet` */ sEntitySet?: string ): this; /** * Sets the associated {@link #getFreeText freeText}. * * @since 1.42.0 * * @returns Reference to `this` in order to allow method chaining */ setFreeText( /** * ID of an element which becomes the new target of this freeText association; alternatively, an element * instance may be given */ oFreeText: sap.ui.core.ID | sap.m.Label ): this; /** * Sets a new value for property {@link #getHeight height}. * * The height of the chart. Overrides the height specified in the `size` property. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ sHeight: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getIsResponsive isResponsive}. * * If this set to true, width and height of the control are determined by the width and height of the container * in which the control is placed or by the width and height property. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @deprecated As of version 1.62. the concept has been discarded. * * @returns Reference to `this` in order to allow method chaining */ setIsResponsive( /** * New value for property `isResponsive` */ bIsResponsive?: boolean ): this; /** * Sets a new value for property {@link #getShowLabel showLabel}. * * Determines if any label is shown or not * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowLabel( /** * New value for property `showLabel` */ bShowLabel?: boolean ): this; /** * Sets a new value for property {@link #getSize size}. * * The size of the microchart. If not set, the default size is applied based on the size of the device tile. * Responsive size takes width and height of the parent container where the micro chart is included. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"Auto"`. * * @since 1.62 * * @returns Reference to `this` in order to allow method chaining */ setSize( /** * New value for property `size` */ sSize?: sap.m.Size ): this; /** * Sets the associated {@link #getUnitOfMeasure unitOfMeasure}. * * * @returns Reference to `this` in order to allow method chaining */ setUnitOfMeasure( /** * ID of an element which becomes the new target of this unitOfMeasure association; alternatively, an element * instance may be given */ oUnitOfMeasure: sap.ui.core.ID | sap.m.Label ): this; /** * Sets a new value for property {@link #getWidth width}. * * The width of the chart. Overrides the width specified in the `size` property. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth: sap.ui.core.CSSSize ): this; } /** * This is an abstract base class for Smart Micro Charts. * * @since 1.60 */ abstract class SmartMicroChartBase extends sap.ui.core.Control { /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartMicroChartBase. * * 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 chart */ mSettings?: sap.ui.comp.smartmicrochart.$SmartMicroChartBaseSettings ); /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartMicroChartBase. * * 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 chart */ mSettings?: sap.ui.comp.smartmicrochart.$SmartMicroChartBaseSettings ); /** * Creates a new subclass of class sap.ui.comp.smartmicrochart.SmartMicroChartBase 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< T, sap.ui.comp.smartmicrochart.SmartMicroChartBase >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartmicrochart.SmartMicroChartBase. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some ariaLabelledBy into the association {@link #getAriaLabelledBy ariaLabelledBy}. * * @since 1.60.0 * * @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; /** * Attaches event handler `fnFunction` to the {@link #event:initialize initialize} event of this `sap.ui.comp.smartmicrochart.SmartMicroChartBase`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartmicrochart.SmartMicroChartBase` itself. * * This event is fired after the control has been initialized. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialize( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartmicrochart.SmartMicroChartBase` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialize initialize} event of this `sap.ui.comp.smartmicrochart.SmartMicroChartBase`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartmicrochart.SmartMicroChartBase` itself. * * This event is fired after the control has been initialized. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialize( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartmicrochart.SmartMicroChartBase` * itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:initialize initialize} event of this `sap.ui.comp.smartmicrochart.SmartMicroChartBase`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachInitialize( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:initialize initialize} 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 */ fireInitialize( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getAriaLabelledBy ariaLabelledBy}. * * @since 1.60.0 */ getAriaLabelledBy(): sap.ui.core.ID[]; /** * Gets current value of property {@link #getChartBindingPath chartBindingPath}. * * This property can be used to specify a relative path (without '/') to an entity set (not a single entity) * that is used during the binding of the chart. * For example, it can be a navigation property that will be added to the context path. * If not specified, the `entitySet` property is used instead. * * * @returns Value of property `chartBindingPath` */ getChartBindingPath(): string; /** * ID of the element which is the current target of the association {@link #getChartDescription chartDescription}, * or `null`. */ getChartDescription(): sap.ui.core.ID | null; /** * ID of the element which is the current target of the association {@link #getChartTitle chartTitle}, or * `null`. */ getChartTitle(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getChartType chartType}. * * Specifies the type of chart. Note that this property is read-only. * * * @returns Value of property `chartType` */ getChartType(): string; /** * Gets current value of property {@link #getEntitySet entitySet}. * * The OData entity set bound to the smart line micro chart. * This entity set is used to pull data into the micro chart and create its internal representation. * Please note that this property cannot be updated dynamically. * * * @returns Value of property `entitySet` */ getEntitySet(): string; /** * Gets current value of property {@link #getHeight height}. * * The height of the chart. Overrides the height specified in the `size` property. * * * @returns Value of property `height` */ getHeight(): sap.ui.core.CSSSize; /** * Gets current value of property {@link #getIsResponsive isResponsive}. * * If this set to true, width and height of the control are determined by the width and height of the container * in which the control is placed or by the width and height property. * * Default value is `false`. * * @deprecated As of version 1.62. the concept has been discarded. * * @returns Value of property `isResponsive` */ getIsResponsive(): boolean; /** * Gets current value of property {@link #getShowLabel showLabel}. * * Determines if any label is shown or not. * * Default value is `true`. * * * @returns Value of property `showLabel` */ getShowLabel(): boolean; /** * Gets current value of property {@link #getSize size}. * * The size of the microchart. If not set, the default size is applied based on the size of the device tile. * Responsive size takes width and height of the parent container where the micro chart is included. * * Default value is `"Auto"`. * * @since 1.62 * * @returns Value of property `size` */ getSize(): sap.m.Size; /** * ID of the element which is the current target of the association {@link #getUnitOfMeasure unitOfMeasure}, * or `null`. */ getUnitOfMeasure(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getWidth width}. * * The width of the chart. Overrides the width specified in the `size` property. * * * @returns Value of property `width` */ getWidth(): sap.ui.core.CSSSize; /** * Removes all the controls in the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * @since 1.60.0 * * @returns An array of the removed elements (might be empty) */ removeAllAriaLabelledBy(): sap.ui.core.ID[]; /** * Removes an ariaLabelledBy from the association named {@link #getAriaLabelledBy ariaLabelledBy}. * * @since 1.60.0 * * @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; /** * Sets a new value for property {@link #getChartBindingPath chartBindingPath}. * * This property can be used to specify a relative path (without '/') to an entity set (not a single entity) * that is used during the binding of the chart. * For example, it can be a navigation property that will be added to the context path. * If not specified, the `entitySet` property is used instead. * * 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 */ setChartBindingPath( /** * New value for property `chartBindingPath` */ sChartBindingPath?: string ): this; /** * Sets the associated {@link #getChartDescription chartDescription}. * * * @returns Reference to `this` in order to allow method chaining */ setChartDescription( /** * ID of an element which becomes the new target of this chartDescription association; alternatively, an * element instance may be given */ oChartDescription: sap.ui.core.ID | sap.m.Label ): this; /** * Sets the associated {@link #getChartTitle chartTitle}. * * * @returns Reference to `this` in order to allow method chaining */ setChartTitle( /** * ID of an element which becomes the new target of this chartTitle association; alternatively, an element * instance may be given */ oChartTitle: sap.ui.core.ID | sap.m.Label ): this; /** * Sets a new value for property {@link #getEntitySet entitySet}. * * The OData entity set bound to the smart line micro chart. * This entity set is used to pull data into the micro chart and create its internal representation. * Please note that this property cannot be updated dynamically. * * 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 */ setEntitySet( /** * New value for property `entitySet` */ sEntitySet?: string ): this; /** * Sets a new value for property {@link #getHeight height}. * * The height of the chart. Overrides the height specified in the `size` property. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setHeight( /** * New value for property `height` */ sHeight: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getIsResponsive isResponsive}. * * If this set to true, width and height of the control are determined by the width and height of the container * in which the control is placed or by the width and height property. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @deprecated As of version 1.62. the concept has been discarded. * * @returns Reference to `this` in order to allow method chaining */ setIsResponsive( /** * New value for property `isResponsive` */ bIsResponsive?: boolean ): this; /** * Sets a new value for property {@link #getShowLabel showLabel}. * * Determines if any label is shown or not. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setShowLabel( /** * New value for property `showLabel` */ bShowLabel?: boolean ): this; /** * Sets a new value for property {@link #getSize size}. * * The size of the microchart. If not set, the default size is applied based on the size of the device tile. * Responsive size takes width and height of the parent container where the micro chart is included. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"Auto"`. * * @since 1.62 * * @returns Reference to `this` in order to allow method chaining */ setSize( /** * New value for property `size` */ sSize?: sap.m.Size ): this; /** * Sets the associated {@link #getUnitOfMeasure unitOfMeasure}. * * * @returns Reference to `this` in order to allow method chaining */ setUnitOfMeasure( /** * ID of an element which becomes the new target of this unitOfMeasure association; alternatively, an element * instance may be given */ oUnitOfMeasure: sap.ui.core.ID | sap.m.Label ): this; /** * Sets a new value for property {@link #getWidth width}. * * The width of the chart. Overrides the width specified in the `size` property. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setWidth( /** * New value for property `width` */ sWidth: sap.ui.core.CSSSize ): this; } /** * The SmartRadialMicroChart control creates a `sap.suite.ui.microchart.RadialMicroChart` based on OData * metadata and the configuration specified by `mSettings`. The entitySet attribute must be specified to * use the control. This attribute is used to fetch metadata and annotation information from the given default * OData model. Based on this, the RadialMicroChart UI is created. * **Note:** * Most of the attributes/properties are not dynamic and cannot be changed once the control has been initialized. * * @since 1.42.0 */ class SmartRadialMicroChart extends sap.ui.comp.smartmicrochart .SmartMicroChartBase { /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartRadialMicroChart. * * 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.ui.comp.smartmicrochart.$SmartRadialMicroChartSettings ); /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartRadialMicroChart. * * 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.ui.comp.smartmicrochart.$SmartRadialMicroChartSettings ); /** * Creates a new subclass of class sap.ui.comp.smartmicrochart.SmartRadialMicroChart 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.comp.smartmicrochart.SmartMicroChartBase.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< T, sap.ui.comp.smartmicrochart.SmartRadialMicroChart >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartmicrochart.SmartRadialMicroChart. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getEnableAutoBinding enableAutoBinding}. * * If set to `true`, this enables automatic binding of the chart using the chartBindingPath (if it exists) * property. * * Default value is `false`. * * * @returns Value of property `enableAutoBinding` */ getEnableAutoBinding(): boolean; /** * ID of the element which is the current target of the association {@link #getFreeText freeText}, or `null`. */ getFreeText(): sap.ui.core.ID | null; /** * Sets a new value for property {@link #getEnableAutoBinding enableAutoBinding}. * * If set to `true`, this enables automatic binding of the chart using the chartBindingPath (if it exists) * property. * * 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 */ setEnableAutoBinding( /** * New value for property `enableAutoBinding` */ bEnableAutoBinding?: boolean ): this; /** * Sets the associated {@link #getFreeText freeText}. * * * @returns Reference to `this` in order to allow method chaining */ setFreeText( /** * ID of an element which becomes the new target of this freeText association; alternatively, an element * instance may be given */ oFreeText: sap.ui.core.ID | sap.m.Label ): this; } /** * The SmartStackedBarMicroChart control creates a StackedBarMicroChart based on OData metadata and the * configuration specified. The `entitySet` property is required. The entity set you specify in this property * is used to fetch OData metadata and to generate the micro chart's UI. This property can also be used * to fetch actual chart data. * **Note:** * Most properties are not dynamic and cannot be changed, once the control has been initialised. * * @since 1.58 */ class SmartStackedBarMicroChart extends sap.ui.comp.smartmicrochart .SmartMicroChartBase { /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartStackedBarMicroChart. * * 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.comp.smartmicrochart.SmartMicroChartBase#constructor sap.ui.comp.smartmicrochart.SmartMicroChartBase } * can be used. */ constructor( /** * initial settings for the new control */ mSettings?: sap.ui.comp.smartmicrochart.$SmartStackedBarMicroChartSettings ); /** * Constructor for a new sap.ui.comp.smartmicrochart.SmartStackedBarMicroChart. * * 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.comp.smartmicrochart.SmartMicroChartBase#constructor sap.ui.comp.smartmicrochart.SmartMicroChartBase } * 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.ui.comp.smartmicrochart.$SmartStackedBarMicroChartSettings ); /** * Creates a new subclass of class sap.ui.comp.smartmicrochart.SmartStackedBarMicroChart 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.comp.smartmicrochart.SmartMicroChartBase.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< T, sap.ui.comp.smartmicrochart.SmartStackedBarMicroChart >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartmicrochart.SmartStackedBarMicroChart. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; } /** * Event object of the SmartMicroChart#initialize event. */ type SmartMicroChart$InitializeEvent = sap.ui.base.Event< SmartMicroChart$InitializeEventParameters, SmartMicroChart >; /** * Event object of the SmartMicroChartBase#initialize event. */ type SmartMicroChartBase$InitializeEvent = sap.ui.base.Event< SmartMicroChartBase$InitializeEventParameters, SmartMicroChartBase >; } namespace smartmultiedit { /** * Describes the settings that can be provided to the Container constructor. */ interface $ContainerSettings extends sap.ui.core.$ControlSettings { /** * The entity set name to fetch metadata for. This entity set should have `sap:creatable` annotation set * to `true` as this control needs to create an entry internally for a short period of time. * Please note that this is not a dynamic SAP UI5 property: setting it twice will not result in an update * of the property. */ entitySet?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The binding contexts relevant to this mass editing operation. */ contexts?: | sap.ui.model.Context[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The form that contains smart multi edit fields ({@link sap.ui.comp.smartmultiedit.Field} controls). */ layout?: sap.ui.comp.smartform.SmartForm; } /** * Describes the settings that can be provided to the Field constructor. */ interface $FieldSettings extends sap.ui.core.$ControlSettings { /** * The OData property name to fetch metadata for. * Please note that this is not a dynamic SAP UI5 property: setting it twice will not result in a new binding. */ propertyName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Indicates whether to display applyToEmptyOnly flag. */ useApplyToEmptyOnly?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates whether to check for an existing value in the data model before applying the changes. * Please note that this property does not automatically update the model. It is up to you as the app developer * to decide whether you want to consider this property when updating the model or not. */ applyToEmptyOnly?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Optional description of the field. */ description?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines whether the existence of the selected token should be validated. * If you set this property to `true`, you should use the {@link sap.ui.comp.smartmultiedit.Container#getErroneousFieldsAndTokens } * method, as the validation becomes asynchronous. * * @since 1.61.0 */ validateTokenExistence?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Optional configuration for `SmartField`. */ configuration?: sap.ui.comp.smartfield.Configuration; /** * This event is fired when the selection focus moves from one item in the combo box to another. */ change?: (oEvent: Field$ChangeEvent) => void; } /** * Parameters of the Field#change event. */ interface Field$ChangeEventParameters { /** * The selected item. */ selectedItem?: sap.ui.core.Item; } /** * The SmartMultiEdit.Container control provides a layout for the smart multi edit fields ({@link sap.ui.comp.smartmultiedit.Field}) * it includes and enables them to access the updated binding contexts. * * @since 1.52.0 */ class Container extends sap.ui.core.Control { /** * Constructor for a new `sap.ui.comp.smartmultiedit.Container`. * * 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.ui.comp.smartmultiedit.$ContainerSettings ); /** * Constructor for a new `sap.ui.comp.smartmultiedit.Container`. * * 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.ui.comp.smartmultiedit.$ContainerSettings ); /** * Creates a new subclass of class sap.ui.comp.smartmultiedit.Container with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartmultiedit.Container. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Destroys the layout in the aggregation {@link #getLayout layout}. * * * @returns Reference to `this` in order to allow method chaining */ destroyLayout(): this; /** * Provides updated objects, including the values of all {@link sap.ui.comp.smartmultiedit.Field} instances * in the `layout` aggregation. * * The function returns a Promise that is resolved when each {@link sap.ui.model.Context} in the `contexts` * property is copied and updated. The fulfilled function is called with an array that contains an object * for each context in the `contexts` property. * Each object in this array contains: * - A `context` property that corresponds to the respective context. * - A `data` property that contains the updated data object. * * * @returns A Promise that is resolved when all contexts ({@link sap.ui.model.Context}) are copied and updated. */ getAllUpdatedContexts( /** * If true, the returned data structure includes all entity set properties per context. */ merge?: boolean ): Promise; /** * Gets current value of property {@link #getContexts contexts}. * * The binding contexts relevant to this mass editing operation. * * Default value is `[]`. * * * @returns Value of property `contexts` */ getContexts(): sap.ui.model.Context[]; /** * Gets current value of property {@link #getEntitySet entitySet}. * * The entity set name to fetch metadata for. This entity set should have `sap:creatable` annotation set * to `true` as this control needs to create an entry internally for a short period of time. * Please note that this is not a dynamic SAP UI5 property: setting it twice will not result in an update * of the property. * * * @returns Value of property `entitySet` */ getEntitySet(): string; /** * Collects all fields that have currently client errors. * * @deprecated As of version 1.61.0. replaced by `getErroneousFieldsAndTokens` * * @returns An array of fields having client errors. */ getErroneousFields(): sap.ui.comp.smartmultiedit.Field[]; /** * Collects all fields that currently have client errors. * * @since 1.61.0 * * @returns Resolves with an array of fields having client errors. */ getErroneousFieldsAndTokens(): Promise; /** * Collects all instances of {@link sap.ui.comp.smartmultiedit.Field} and/or {@link sap.ui.core.Control } * scattered across the smart form ({@link sap.ui.comp.smartform.SmartForm}) layout. * * * @returns An array of {@link sap.ui.comp.smartmultiedit.Field} and/or {@link sap.ui.core.Control}. */ getFields( /** * A boolean indicating whether or not to include {@link sap.ui.core.Control} in resultant array. By default * or if it is set to false, only instances of {@link sap.ui.comp.smartmultiedit.Field} are included in * resultant array. */ bFetchAllControls: boolean ): any[]; /** * Gets content of aggregation {@link #getLayout layout}. * * The form that contains smart multi edit fields ({@link sap.ui.comp.smartmultiedit.Field} controls). */ getLayout(): sap.ui.comp.smartform.SmartForm; /** * Explicitly pushes the smart multi edit container's ({@link sap.ui.comp.smartmultiedit.Container}) custom * data to the specified field ({@link sap.ui.comp.smartmultiedit.Field}). Can be useful when adding fields * to a container after it has already been rendered. */ indexField( /** * {@link sap.ui.comp.smartmultiedit.Field} to push the custom data to. */ oField: sap.ui.comp.smartmultiedit.Field ): void; /** * Sets the contexts to be updated. These contexts are required for offering possible values and are also * used by the {@link sap.ui.comp.smartmultiedit.Container#getAllUpdatedContexts} method. * * * @returns Returns `this` to allow method chaining. */ setContexts( /** * Contexts to be used. This property must be an array. */ contexts: sap.ui.model.Context[] ): this; /** * Sets the entity set to read the properties from. Setting this value twice will not result in an update * of the underlining components. * * * @returns Returns `this` to allow method chaining. */ setEntitySet( /** * Entity set to use. */ entitySet: string ): this; /** * Sets the layout to use. * * * @returns Returns `this` to allow method chaining. */ setLayout( /** * Smart form with the layout. */ oSmartForm: sap.ui.comp.smartmultiedit.Field ): this; } /** * The SmartMultiEdit.Field control enables you to edit multiple homogeneous objects simultaneously. It * allows you to select a predefined item from a combo box and apply your selection to all objects being * edited. * In addition, SmartMultiEdit.Field can handle metadata for a specific OData property when you need to * enable mass editing for multiple contexts. The contexts are handled by the {@link sap.ui.comp.smartmultiedit.Container } * control. * * @since 1.52.0 */ class Field extends sap.ui.core.Control { /** * Constructor for a new `sap.ui.comp.smartmultiedit.Field`. * * 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.ui.comp.smartmultiedit.$FieldSettings ); /** * Constructor for a new `sap.ui.comp.smartmultiedit.Field`. * * 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.ui.comp.smartmultiedit.$FieldSettings ); /** * Creates a new subclass of class sap.ui.comp.smartmultiedit.Field with name `sClassName` and enriches * it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartmultiedit.Field. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.comp.smartmultiedit.Field`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartmultiedit.Field` itself. * * This event is fired when the selection focus moves from one item in the combo box to another. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: Field$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartmultiedit.Field` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.comp.smartmultiedit.Field`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartmultiedit.Field` itself. * * This event is fired when the selection focus moves from one item in the combo box to another. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * The function to be called when the event occurs */ fnFunction: (p1: Field$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartmultiedit.Field` itself */ oListener?: object ): this; /** * Destroys the configuration in the aggregation {@link #getConfiguration configuration}. * * * @returns Reference to `this` in order to allow method chaining */ destroyConfiguration(): this; /** * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.comp.smartmultiedit.Field`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: Field$ChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:change change} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireChange( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartmultiedit.Field$ChangeEventParameters ): this; /** * Gets current value of property {@link #getApplyToEmptyOnly applyToEmptyOnly}. * * Indicates whether to check for an existing value in the data model before applying the changes. * Please note that this property does not automatically update the model. It is up to you as the app developer * to decide whether you want to consider this property when updating the model or not. * * Default value is `false`. * * * @returns Value of property `applyToEmptyOnly` */ getApplyToEmptyOnly(): boolean; /** * Gets content of aggregation {@link #getConfiguration configuration}. * * Optional configuration for `SmartField`. */ getConfiguration(): sap.ui.comp.smartfield.Configuration; /** * Returns the data type used by the smart field. This data type is determined from metadata. * * * @returns The EDM data type of the smart field as defined by its metadata. */ getDataType(): string; /** * Gets current value of property {@link #getDescription description}. * * Optional description of the field. * * * @returns Value of property `description` */ getDescription(): string; /** * Returns the label associated with this field. * * * @returns An instance of {@link sap.m.Label} or {@link sap.ui.comp.smartfield.SmartLabel} that displays * read-only values. */ getLabel(): | sap.m.Label | /* was: sap.ui.comp.smartfield.SmartLabel */ any; /** * Checks if the data type of the smart multi edit field is nullable as defined by its metadata. * * * @returns True if nullable, false otherwise. */ getNullable(): boolean; /** * Gets current value of property {@link #getPropertyName propertyName}. * * The OData property name to fetch metadata for. * Please note that this is not a dynamic SAP UI5 property: setting it twice will not result in a new binding. * * * @returns Value of property `propertyName` */ getPropertyName(): string; /** * Returns the raw value for the OData property that is determined by the `propertyName` property. If the * 'Keep existing value' item is selected, an empty plain object is returned. * * * @returns An object containing the property name and its raw (non-formatted) value. If the field represents * the boolean value,the 'value' property is boolean. If the field represents the numeric value, the 'value' * property is float. If the field represents a composite value with UOM,the object has a 'value' property * (Float) and a 'unit' property (UOM String). */ getRawValue(): { name: string; value: boolean | number | string; }; /** * Returns the path to the text property used by the combo box. * * * @returns Path to the text property of the record. */ getRecordTextPath(): string | null; /** * Returns the item that was selected using the Select action. * * * @returns The current target of the `selectedItem` association, or null. */ getSelectedItem(): sap.ui.core.Item | null; /** * Checks if a {@link sap.ui.comp.smartfield.SmartField} is present, which provides a way to define an explicit * value for the field. * * * @returns True if {@link sap.ui.comp.smartfield.SmartField} present, false otherwise. */ getShowValueHelp(): boolean; /** * Returns the smart field that is used for selecting a new value. * * * @returns An instance of {@link sap.ui.comp.smartfield.SmartField} that helps to define an explicit value. */ getSmartField(): sap.ui.comp.smartfield.SmartField; /** * Returns the unit of measurement for the underlying smart field. * * * @returns Value of the unit of measurement of the parent component. */ getUnitOfMeasure(): string; /** * Returns the name of the property used for the unit of measurement. * * * @returns Name of the property that defines the unit of measurement of the underlying component. */ getUnitOfMeasurePropertyName(): string | null; /** * Gets current value of property {@link #getUseApplyToEmptyOnly useApplyToEmptyOnly}. * * Indicates whether to display applyToEmptyOnly flag. * * Default value is `false`. * * * @returns Value of property `useApplyToEmptyOnly` */ getUseApplyToEmptyOnly(): boolean; /** * Gets current value of property {@link #getValidateTokenExistence validateTokenExistence}. * * Defines whether the existence of the selected token should be validated. * If you set this property to `true`, you should use the {@link sap.ui.comp.smartmultiedit.Container#getErroneousFieldsAndTokens } * method, as the validation becomes asynchronous. * * Default value is `true`. * * @since 1.61.0 * * @returns Value of property `validateTokenExistence` */ getValidateTokenExistence(): boolean; /** * Returns the current **formatted** value of the smart field. To get the raw value, use `getRawValue` instead. * * * @returns The current value of a {@link sap.ui.comp.smartfield.SmartField} instance. */ getValue(): any; /** * Returns true if there is a client error present, false otherwise. * * * @returns An indication of client error. */ hasClientError(): boolean; /** * Checks if the 'Leave blank' item is selected. * * * @returns True if the 'Leave blank' item is selected. */ isBlankSelected(): boolean; /** * Checks if the data type of the smart field is boolean. * * * @returns True if the field contains a boolean value, false otherwise. */ isBoolean(): boolean; /** * Checks if the field uses a combo box. This check doesn't rely on data type but rather a certain combination * of annotations. * * * @returns True if the field uses some kind of a combo box, false otherwise. */ isComboBox(): boolean; /** * Checks if the data type of the smart field is unit of measurement (UOM). * * * @returns True if the field contains a value along with a unit of measure, false otherwise. */ isComposite(): boolean; /** * Checks if the data type of the smart field is date. * * * @returns True if the smart field contains a date value, false otherwise. */ isDate(): boolean; /** * Checks if the data type of the smart field is date with time. * * * @returns True if the smart field contains some both date and time value, false otherwise. */ isDateTime(): boolean; /** * Checks if the data type of the smart field is some kind of a float number. * * * @returns True if the smart field contains some kind of a float number, false otherwise. */ isFloat(): boolean; /** * Checks if the data type of the smart field is some kind of a integer number. * * * @returns True if the smart field contains some kind of a integer number, false otherwise. */ isInteger(): boolean; /** * Checks if the 'Keep existing value' item is selected. * * * @returns True if the 'Keep existing value' item is selected. */ isKeepExistingSelected(): boolean; /** * Checks if the data type of the smart field is string. * * * @returns True if the smart field type is string, false otherwise. */ isString(): boolean; /** * Checks if the data type of the smart field is time. * * * @returns True if the field contains some kind of a time value, false otherwise. */ isTime(): boolean; /** * Checks if the 'Use Value Help' item is selected. * * * @returns True if the 'Use Value Help' item is selected. */ isValueHelpSelected(): boolean; /** * Sets a new value for property {@link #getApplyToEmptyOnly applyToEmptyOnly}. * * Indicates whether to check for an existing value in the data model before applying the changes. * Please note that this property does not automatically update the model. It is up to you as the app developer * to decide whether you want to consider this property when updating the model or not. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setApplyToEmptyOnly( /** * New value for property `applyToEmptyOnly` */ bApplyToEmptyOnly?: boolean ): this; /** * Sets the optional configuration aggregation. * * * @returns Returns `this` to allow method chaining. */ setConfiguration( /** * Optional configuration to set. */ oConfig: sap.ui.comp.smartfield.Configuration ): this; /** * Sets a new value for property {@link #getDescription description}. * * Optional description of the field. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setDescription( /** * New value for property `description` */ sDescription?: string ): this; /** * Sets the name of the property to bind to. * * * @returns Returns `this` to allow method chaining. */ setPropertyName( /** * Name of the property to bind to. */ sName: string ): this; /** * Sets the item to be selected in the `sap.m.Select` instance, using its index. * * * @returns Returns `this` to allow method chaining. */ setSelectedIndex( /** * An index of the item inside the Select action. */ iIndex: number ): this; /** * Sets the item to be treated as selected in the `sap.m.Select` instance. * * * @returns Returns `this` to allow method chaining. */ setSelectedItem( /** * An {@link sap.ui.core.Item} instance or `null`. */ oItem: sap.ui.core.Item | null ): this; /** * Sets a new value for property {@link #getUseApplyToEmptyOnly useApplyToEmptyOnly}. * * Indicates whether to display applyToEmptyOnly flag. * * 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 */ setUseApplyToEmptyOnly( /** * New value for property `useApplyToEmptyOnly` */ bUseApplyToEmptyOnly?: boolean ): this; /** * Sets a new value for property {@link #getValidateTokenExistence validateTokenExistence}. * * Defines whether the existence of the selected token should be validated. * If you set this property to `true`, you should use the {@link sap.ui.comp.smartmultiedit.Container#getErroneousFieldsAndTokens } * method, as the validation becomes asynchronous. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.61.0 * * @returns Reference to `this` in order to allow method chaining */ setValidateTokenExistence( /** * New value for property `validateTokenExistence` */ bValidateTokenExistence?: boolean ): this; } /** * Event object of the Field#change event. */ type Field$ChangeEvent = sap.ui.base.Event< Field$ChangeEventParameters, Field >; } namespace smartmultiinput { /** * Describes the settings that can be provided to the SmartMultiInput constructor. */ interface $SmartMultiInputSettings extends sap.ui.comp.smartfield.$SmartFieldSettings { /** * Enables value help with conditions. Can only be used without binding context. Otherwise, has no effect. */ supportRanges?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enables multiple selection in value help dialog. */ supportMultiSelect?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enables specific properties to be provided in the select query. */ enableODataSelect?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enables requestAtLeast properties to be added additionally when enableODataSelect is set to True. These * are comma-separated value of fields that must be requested from the backend. */ requestAtLeastFields?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Denotes the separator between texts in the display mode. The default value is loaded from the component * resource bundle. */ textSeparator?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Allows only one token to be added to the SmartMultiInput. Works only in No Data Binding Scenario. * * @since 1.101 */ singleTokenMode?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enable/Disable "Select All" checkbox in ValueHelpDialog. If set to true, the Select All checkbox is enabled * in the ValueHelpDialog. * * @since 1.120 */ enableValueHelpSelectAll?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Aggregation for storing the tokens. Works only in No Data Binding Scenario. * * @since 1.101 */ initialTokens?: | sap.m.Token[] | sap.m.Token | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * This event is fired before the OData model's `create` method is called. Provides object with parameters * of the call for editing. */ beforeCreate?: (oEvent: SmartMultiInput$BeforeCreateEvent) => void; /** * This event is fired before the OData model's `remove` method is called. Provides object with parameters * of the call in key:value format for editing. */ beforeRemove?: (oEvent: SmartMultiInput$BeforeRemoveEvent) => void; /** * This event is fired when the tokens aggregation is changed due to a user action (add / remove token). * This event is fired only for token changes in `SmartMultiInput` elements. */ tokenUpdate?: (oEvent: SmartMultiInput$TokenUpdateEvent) => void; /** * This event is fired when item selection is changed. It is relevant only for selection changes on `SmartMultiInput` * elements with fixed values, such as {@link sap.m.MultiComboBox}. */ selectionChange?: ( oEvent: SmartMultiInput$SelectionChangeEvent ) => void; /** * Event is fired when user has finished a selection of items in a list box and list box has been closed. * It is relevant only for selection finishes on `SmartMultiInput` elements with fixed values, such as {@link sap.m.MultiComboBox}. */ selectionFinish?: ( oEvent: SmartMultiInput$SelectionFinishEvent ) => void; } /** * Parameters of the SmartMultiInput#beforeCreate event. */ interface SmartMultiInput$BeforeCreateEventParameters { /** * Data of the entry that should be created. */ oData?: object; /** * Parameter map that will be passed to the OData model's `create` method, accepts the same properties as * mParameters of the `create` method. Parameters `success` and `error` have no meaning as they are changed * and used internally. */ mParameters?: object; } /** * Parameters of the SmartMultiInput#beforeRemove event. */ interface SmartMultiInput$BeforeRemoveEventParameters { /** * Parameter map that will be passed to the OData model's `remove` method, accepts the same properties as * mParameters of the `remove` method. Parameters `success` and `error` have no meaning as they are changed * and used internally. */ mParameters?: object; } /** * Parameters of the SmartMultiInput#selectionChange event. */ interface SmartMultiInput$SelectionChangeEventParameters { /** * Item that was selected or deselected. */ changedItem?: sap.ui.core.Item; /** * Selection state: `true` if the item is selected, `false` if item is not selected. */ selected?: boolean; } /** * Parameters of the SmartMultiInput#selectionFinish event. */ interface SmartMultiInput$SelectionFinishEventParameters { /** * The selected items which are selected after list box has been closed. */ selectedItems?: sap.ui.core.Item[]; } /** * Parameters of the SmartMultiInput#tokenUpdate event. */ interface SmartMultiInput$TokenUpdateEventParameters { /** * Type of TokenUpdate event. There are two TokenUpdate types: `added` and `removed`. Use Tokenizer.TokenUpdateType.Added * for "added" and Tokenizer.TokenUpdateType.Removed for "removed". See {@link sap.m.Tokenizer} for details. */ type?: string; /** * The array of tokens that are added. This parameter is used when tokenUpdate type is "added". */ addedTokens?: sap.m.Token[]; /** * The array of tokens that are removed. This parameter is used when tokenUpdate type is "removed". */ removedTokens?: sap.m.Token[]; } /** * The `SmartMultiInput` control is a wrapper for other controls that extends the {@link sap.ui.comp.smartfield.SmartField } * control and supports the same settings and annotations. * It interprets OData metadata to create multi-input controls, such as {@link sap.m.MultiInput} and {@link sap.m.MultiComboBox}. * The OData entity property that is changed or displayed in the control is derived from the control's * `value` property. You can use the `SmartMultiInput` control in two ways: * - With data binding - the `value` property is bound to a navigation property (1:N relationship). * - Without data binding - the `value` property is bound to an arbitrary property of the entity set that * is specified in the `entitySet` property. Both cases are shown in the example bellow as well as * in the samples. Tokens selected in `SmartMultiInput` can be retrieved using either the {@link #getTokens } * or the {@link #getValue} method. * * * ```javascript * * * * ``` * * * For more details, see the {@link https://ui5.sap.com/#/entity/sap.ui.comp.smartmultiinput.SmartMultiInput samples}. * * Note: Just as the rest of the {@link sap.ui.comp} library, this control supports only OData V2 (see {@link sap.ui.model.odata.v2.ODataModel}) * and default models. * * @since 1.56.0 */ class SmartMultiInput extends sap.ui.comp.smartfield.SmartField { /** * Constructor for a new `sap.ui.comp.smartfield.SmartMultiInput`. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/5644169deb76438f800f269b0cb715fc Smart Multi Input} */ constructor( /** * Initial settings for the new control */ mSettings?: sap.ui.comp.smartmultiinput.$SmartMultiInputSettings ); /** * Constructor for a new `sap.ui.comp.smartfield.SmartMultiInput`. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/5644169deb76438f800f269b0cb715fc Smart Multi Input} */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string, /** * Initial settings for the new control */ mSettings?: sap.ui.comp.smartmultiinput.$SmartMultiInputSettings ); /** * Creates a new subclass of class sap.ui.comp.smartmultiinput.SmartMultiInput 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.comp.smartfield.SmartField.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< T, sap.ui.comp.smartmultiinput.SmartMultiInput >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartmultiinput.SmartMultiInput. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some initialToken to the aggregation {@link #getInitialTokens initialTokens}. * * @since 1.101 * * @returns Reference to `this` in order to allow method chaining */ addInitialToken( /** * The initialToken to add; if empty, nothing is inserted */ oInitialToken: sap.m.Token ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeCreate beforeCreate} event of this `sap.ui.comp.smartmultiinput.SmartMultiInput`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartmultiinput.SmartMultiInput` itself. * * This event is fired before the OData model's `create` method is called. Provides object with parameters * of the call for editing. * * * @returns Reference to `this` in order to allow method chaining */ attachBeforeCreate( /** * 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: SmartMultiInput$BeforeCreateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartmultiinput.SmartMultiInput` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeCreate beforeCreate} event of this `sap.ui.comp.smartmultiinput.SmartMultiInput`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartmultiinput.SmartMultiInput` itself. * * This event is fired before the OData model's `create` method is called. Provides object with parameters * of the call for editing. * * * @returns Reference to `this` in order to allow method chaining */ attachBeforeCreate( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartMultiInput$BeforeCreateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartmultiinput.SmartMultiInput` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeRemove beforeRemove} event of this `sap.ui.comp.smartmultiinput.SmartMultiInput`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartmultiinput.SmartMultiInput` itself. * * This event is fired before the OData model's `remove` method is called. Provides object with parameters * of the call in key:value format for editing. * * * @returns Reference to `this` in order to allow method chaining */ attachBeforeRemove( /** * 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: SmartMultiInput$BeforeRemoveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartmultiinput.SmartMultiInput` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeRemove beforeRemove} event of this `sap.ui.comp.smartmultiinput.SmartMultiInput`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartmultiinput.SmartMultiInput` itself. * * This event is fired before the OData model's `remove` method is called. Provides object with parameters * of the call in key:value format for editing. * * * @returns Reference to `this` in order to allow method chaining */ attachBeforeRemove( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartMultiInput$BeforeRemoveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartmultiinput.SmartMultiInput` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this * `sap.ui.comp.smartmultiinput.SmartMultiInput`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartmultiinput.SmartMultiInput` itself. * * This event is fired when item selection is changed. It is relevant only for selection changes on `SmartMultiInput` * elements with fixed values, such as {@link sap.m.MultiComboBox}. * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: SmartMultiInput$SelectionChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartmultiinput.SmartMultiInput` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this * `sap.ui.comp.smartmultiinput.SmartMultiInput`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartmultiinput.SmartMultiInput` itself. * * This event is fired when item selection is changed. It is relevant only for selection changes on `SmartMultiInput` * elements with fixed values, such as {@link sap.m.MultiComboBox}. * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChange( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartMultiInput$SelectionChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartmultiinput.SmartMultiInput` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionFinish selectionFinish} event of this * `sap.ui.comp.smartmultiinput.SmartMultiInput`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartmultiinput.SmartMultiInput` itself. * * Event is fired when user has finished a selection of items in a list box and list box has been closed. * It is relevant only for selection finishes on `SmartMultiInput` elements with fixed values, such as {@link sap.m.MultiComboBox}. * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionFinish( /** * 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: SmartMultiInput$SelectionFinishEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartmultiinput.SmartMultiInput` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionFinish selectionFinish} event of this * `sap.ui.comp.smartmultiinput.SmartMultiInput`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartmultiinput.SmartMultiInput` itself. * * Event is fired when user has finished a selection of items in a list box and list box has been closed. * It is relevant only for selection finishes on `SmartMultiInput` elements with fixed values, such as {@link sap.m.MultiComboBox}. * * * @returns Reference to `this` in order to allow method chaining */ attachSelectionFinish( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartMultiInput$SelectionFinishEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartmultiinput.SmartMultiInput` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:tokenUpdate tokenUpdate} event of this `sap.ui.comp.smartmultiinput.SmartMultiInput`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartmultiinput.SmartMultiInput` itself. * * This event is fired when the tokens aggregation is changed due to a user action (add / remove token). * This event is fired only for token changes in `SmartMultiInput` elements. * * * @returns Reference to `this` in order to allow method chaining */ attachTokenUpdate( /** * 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: SmartMultiInput$TokenUpdateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartmultiinput.SmartMultiInput` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:tokenUpdate tokenUpdate} event of this `sap.ui.comp.smartmultiinput.SmartMultiInput`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartmultiinput.SmartMultiInput` itself. * * This event is fired when the tokens aggregation is changed due to a user action (add / remove token). * This event is fired only for token changes in `SmartMultiInput` elements. * * * @returns Reference to `this` in order to allow method chaining */ attachTokenUpdate( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartMultiInput$TokenUpdateEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartmultiinput.SmartMultiInput` * itself */ oListener?: object ): this; /** * Checks whether a client error has been detected. In addition, this method displays an error message, * if it is not already displayed. * * * @returns `true`, if a client error has been detected, `false` otherwise */ checkClientError(): boolean; /** * Destroys all the initialTokens in the aggregation {@link #getInitialTokens initialTokens}. * * @since 1.101 * * @returns Reference to `this` in order to allow method chaining */ destroyInitialTokens(): this; /** * Detaches event handler `fnFunction` from the {@link #event:beforeCreate beforeCreate} event of this `sap.ui.comp.smartmultiinput.SmartMultiInput`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachBeforeCreate( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartMultiInput$BeforeCreateEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:beforeRemove beforeRemove} event of this `sap.ui.comp.smartmultiinput.SmartMultiInput`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachBeforeRemove( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartMultiInput$BeforeRemoveEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:selectionChange selectionChange} event of * this `sap.ui.comp.smartmultiinput.SmartMultiInput`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSelectionChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartMultiInput$SelectionChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:selectionFinish selectionFinish} event of * this `sap.ui.comp.smartmultiinput.SmartMultiInput`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSelectionFinish( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartMultiInput$SelectionFinishEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:tokenUpdate tokenUpdate} event of this `sap.ui.comp.smartmultiinput.SmartMultiInput`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachTokenUpdate( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartMultiInput$TokenUpdateEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:beforeCreate beforeCreate} 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 */ fireBeforeCreate( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartmultiinput.SmartMultiInput$BeforeCreateEventParameters ): boolean; /** * Fires event {@link #event:beforeRemove beforeRemove} 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 */ fireBeforeRemove( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartmultiinput.SmartMultiInput$BeforeRemoveEventParameters ): boolean; /** * Fires event {@link #event:selectionChange selectionChange} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSelectionChange( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartmultiinput.SmartMultiInput$SelectionChangeEventParameters ): this; /** * Fires event {@link #event:selectionFinish selectionFinish} 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 */ fireSelectionFinish( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartmultiinput.SmartMultiInput$SelectionFinishEventParameters ): this; /** * Fires event {@link #event:tokenUpdate tokenUpdate} 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 */ fireTokenUpdate( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartmultiinput.SmartMultiInput$TokenUpdateEventParameters ): this; /** * Gets current value of property {@link #getEnableODataSelect enableODataSelect}. * * Enables specific properties to be provided in the select query. * * Default value is `false`. * * * @returns Value of property `enableODataSelect` */ getEnableODataSelect(): boolean; /** * Gets current value of property {@link #getEnableValueHelpSelectAll enableValueHelpSelectAll}. * * Enable/Disable "Select All" checkbox in ValueHelpDialog. If set to true, the Select All checkbox is enabled * in the ValueHelpDialog. * * Default value is `undefined`. * * @since 1.120 * * @returns Value of property `enableValueHelpSelectAll` */ getEnableValueHelpSelectAll(): boolean; /** * Returns a filter that can be applied to restrict the OData query. * * * @returns filter object based on current SmartMultiInput values */ getFilter(): sap.ui.model.Filter; /** * Gets content of aggregation {@link #getInitialTokens initialTokens}. * * Aggregation for storing the tokens. Works only in No Data Binding Scenario. * * @since 1.101 */ getInitialTokens(): sap.m.Token[]; /** * Returns an array of token values in range format. * * * @returns array of range values, one for each token */ getRangeData(): any[]; /** * Gets current value of property {@link #getRequestAtLeastFields requestAtLeastFields}. * * Enables requestAtLeast properties to be added additionally when enableODataSelect is set to True. These * are comma-separated value of fields that must be requested from the backend. * * Default value is `empty string`. * * * @returns Value of property `requestAtLeastFields` */ getRequestAtLeastFields(): string; /** * Gets current value of property {@link #getSingleTokenMode singleTokenMode}. * * Allows only one token to be added to the SmartMultiInput. Works only in No Data Binding Scenario. * * Default value is `false`. * * @since 1.101 * * @returns Value of property `singleTokenMode` */ getSingleTokenMode(): boolean; /** * Gets current value of property {@link #getSupportMultiSelect supportMultiSelect}. * * Enables multiple selection in value help dialog. * * Default value is `true`. * * * @returns Value of property `supportMultiSelect` */ getSupportMultiSelect(): boolean; /** * Gets current value of property {@link #getSupportRanges supportRanges}. * * Enables value help with conditions. Can only be used without binding context. Otherwise, has no effect. * * Default value is `false`. * * * @returns Value of property `supportRanges` */ getSupportRanges(): boolean; /** * Returns tokens selected in `SmartMultiInput` * * * @returns Selected tokens */ getTokens(): sap.m.Token[]; /** * Returns tokens selected in `SmartMultiInput` * * * @returns Selected tokens */ getValue(): sap.m.Token[]; /** * Checks for the provided `sap.m.Token` in the aggregation {@link #getInitialTokens initialTokens}. and * returns its index if found or -1 otherwise. * * @since 1.101 * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfInitialToken( /** * The initialToken whose index is looked for */ oInitialToken: sap.m.Token ): int; /** * Inserts a initialToken into the aggregation {@link #getInitialTokens initialTokens}. * * @since 1.101 * * @returns Reference to `this` in order to allow method chaining */ insertInitialToken( /** * The initialToken to insert; if empty, nothing is inserted */ oInitialToken: sap.m.Token, /** * The `0`-based index the initialToken should be inserted at; for a negative value of `iIndex`, the initialToken * is inserted at position 0; for a value greater than the current size of the aggregation, the initialToken * is inserted at the last position */ iIndex: int ): this; /** * Removes all the controls from the aggregation {@link #getInitialTokens initialTokens}. * * Additionally, it unregisters them from the hosting UIArea. * * @since 1.101 * * @returns An array of the removed elements (might be empty) */ removeAllInitialTokens(): sap.m.Token[]; /** * Removes a initialToken from the aggregation {@link #getInitialTokens initialTokens}. * * @since 1.101 * * @returns The removed initialToken or `null` */ removeInitialToken( /** * The initialToken to remove or its index or id */ vInitialToken: int | string | sap.m.Token ): sap.m.Token | null; /** * Sets a new value for property {@link #getEnableODataSelect enableODataSelect}. * * Enables specific properties to be provided in the select query. * * 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 */ setEnableODataSelect( /** * New value for property `enableODataSelect` */ bEnableODataSelect?: boolean ): this; /** * Sets a new value for property {@link #getEnableValueHelpSelectAll enableValueHelpSelectAll}. * * Enable/Disable "Select All" checkbox in ValueHelpDialog. If set to true, the Select All checkbox is enabled * in the ValueHelpDialog. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `undefined`. * * @since 1.120 * * @returns Reference to `this` in order to allow method chaining */ setEnableValueHelpSelectAll( /** * New value for property `enableValueHelpSelectAll` */ bEnableValueHelpSelectAll?: boolean ): this; /** * Sets tokens based on given objects with range data. Can only be used without a data binding. Otherwise, * has no effect. */ setRangeData( /** * object or array of objects with range data. Tokens are created based on this data and fed into the smart * multi input. */ vRangeData: object | object[] ): void; /** * Sets a new value for property {@link #getRequestAtLeastFields requestAtLeastFields}. * * Enables requestAtLeast properties to be added additionally when enableODataSelect is set to True. These * are comma-separated value of fields that must be requested from the backend. * * 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 */ setRequestAtLeastFields( /** * New value for property `requestAtLeastFields` */ sRequestAtLeastFields?: string ): this; /** * Sets a new value for property {@link #getSingleTokenMode singleTokenMode}. * * Allows only one token to be added to the SmartMultiInput. Works only in No Data Binding Scenario. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.101 * * @returns Reference to `this` in order to allow method chaining */ setSingleTokenMode( /** * New value for property `singleTokenMode` */ bSingleTokenMode?: boolean ): this; /** * Sets a new value for property {@link #getSupportMultiSelect supportMultiSelect}. * * Enables multiple selection in value help dialog. * * 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 */ setSupportMultiSelect( /** * New value for property `supportMultiSelect` */ bSupportMultiSelect?: boolean ): this; /** * Sets a new value for property {@link #getSupportRanges supportRanges}. * * Enables value help with conditions. Can only be used without binding context. Otherwise, has no effect. * * 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 */ setSupportRanges( /** * New value for property `supportRanges` */ bSupportRanges?: boolean ): this; /** * Sets a new value for property {@link #getTextSeparator textSeparator}. * * Denotes the separator between texts in the display mode. The default value is loaded from the component * resource bundle. * * 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 */ setTextSeparator( /** * New value for property `textSeparator` */ sTextSeparator?: string ): this; } /** * Event object of the SmartMultiInput#beforeCreate event. */ type SmartMultiInput$BeforeCreateEvent = sap.ui.base.Event< SmartMultiInput$BeforeCreateEventParameters, SmartMultiInput >; /** * Event object of the SmartMultiInput#beforeRemove event. */ type SmartMultiInput$BeforeRemoveEvent = sap.ui.base.Event< SmartMultiInput$BeforeRemoveEventParameters, SmartMultiInput >; /** * Event object of the SmartMultiInput#selectionChange event. */ type SmartMultiInput$SelectionChangeEvent = sap.ui.base.Event< SmartMultiInput$SelectionChangeEventParameters, SmartMultiInput >; /** * Event object of the SmartMultiInput#selectionFinish event. */ type SmartMultiInput$SelectionFinishEvent = sap.ui.base.Event< SmartMultiInput$SelectionFinishEventParameters, SmartMultiInput >; /** * Event object of the SmartMultiInput#tokenUpdate event. */ type SmartMultiInput$TokenUpdateEvent = sap.ui.base.Event< SmartMultiInput$TokenUpdateEventParameters, SmartMultiInput >; } namespace smarttable { /** * Describes the settings that can be provided to the SmartTable constructor. */ interface $SmartTableSettings extends sap.m.$VBoxSettings { /** * The entity set name from which to fetch data and generate the columns. Note that this is not a dynamic * UI5 property. * * **Note:** It is not allowed to have one of the following strings as field names for your OData entity: * * - `btnEditToggle` * - `btnExcelExport` * - `btnFullScreen` * - `btnPersonalisation` * - `header` * - `infoToolbarText` * - `persoController` * - `toolbarSeperator` * - `toolbarSpacer` * - `ui5table` * - `variant` * * This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.26.0 */ entitySet?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * ID of the corresponding SmartFilter control; When specified, the SmartTable searches for the SmartFilter * (also in the closest parent View) and attaches to the relevant events of the SmartFilter; to fetch data, * show overlay etc. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.26.0 */ smartFilterId?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Comma-separated value of fields that must be ignored in the OData metadata by the `SmartTable` control. * The `SmartTable` control will not create built-in columns for the fields defined by this property and * will not offer these fields in table personalization. * * **Note:** * * - Please ensure that you do not add spaces or special characters as no validation is done for this * property. * - This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.26.0 */ ignoredFields?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Comma-separated value of fields that must be shown initially in the SmartTable as visible columns and * in the order specified. * This property is mainly meant to be used when no LineItem annotation exists. * If you have fields in the XMLView they are always shown first; then, the columns are added based on * the LineItem annotation and finally based on this property. * **Note:** * * - If both this property and the LineItem annotation exist, the order of fields cannot be guaranteed * to be as mentioned here. * - Please ensure that you do not add spaces or special characters as no validation is done for this * property. * - This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.32.0 */ initiallyVisibleFields?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Comma-separated value of fields that must be always requested from the backend * This property is mainly meant to be used when there is no PresentationVariant annotation. * If both this property and the PresentationVariant annotation exist, the select request sent to the backend * would be a combination of both. * **Note:** * For `AnalyticalTable` (supported since 1.54), the following restrictions apply: * - The property name(s) must not point to a new dimension or a measure. * - The property name(s) must not point to a navigationProperty/association path, as this might not supported * by analytical services. Please ensure that you do not add spaces or special characters as no validation * is done for this property. * * @since 1.32.0 */ requestAtLeastFields?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Comma-separated value of fields that is not shown in the personalization dialog. * This property must only be used for use cases where a technical field/column is required to fetch some * data from the backend but is hidden in the table personalization and on the UI. * * **Note:** * * - Please ensure that you do not add spaces or special characters as no validation is done for this * property. * - Visible fields/columns cannot be included in this property as this is not supported by the `SmartTable` * control. * - This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.32.0 */ ignoreFromPersonalisation?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Specifies the type of table to be created in the SmartTable control. * **Note:** * * - If you add a table to the content of the SmartTable in the view, this property has no effect. * - This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.26.0 */ tableType?: | sap.ui.comp.smarttable.TableType | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The useVariantManagement attribute can be set to true or false depending on whether you want to use variants. * As a prerequisite you need to specify the persistencyKey property. * * @since 1.26.0 */ useVariantManagement?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If no tooltips have been provided, neither by the `QuickInfo` annotation nor for custom columns directly * via property, the column label will automatically be applied as a tooltip for the column. * * To enable this mechanism for custom columns, a `sap.m.Label` or `sap.m.Text` must be used as header label. * Custom tooltips are not affected by this functionality when they are provided on the column header label * for tables of type `ResponsiveTable` and on the column for other table types. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.114.0 */ useColumnLabelsAsTooltips?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The showVariantManagement attribute can be set to true or false for controlling the visibility of VariantManagement * button. * * @since 1.38.0 */ showVariantManagement?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Can be set to true or false depending on whether you want to export data to a spreadsheet application, * for example Microsoft Excel. * **Note:** * If `exportType` is `sap.ui.comp.smarttable.ExportType.GW`, any $expand parameters are removed when sending * the request to generate the spreadsheet. * As of UI5 version 1.56: If `exportType` is `sap.ui.comp.smarttable.ExportType.UI5Client` and `TreeTable` * is used, the `worksheet.hierarchyLevel` property (see {@link sap.ui.export.Spreadsheet}) is filled from * the binding, if the relevant information is available there for exporting hierarchical data in the spreadsheet. * * @since 1.26.0 * @deprecated As of version 1.100. replaced by `enableExport` property. */ useExportToExcel?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enables the export of data from the `SmartTable` control to another file, for example, a spreadsheet. * If `exportType` is `sap.ui.comp.smarttable.ExportType.GW`, any `$expand` parameters are removed when * sending the request to generate the file. * To use the export functionality, the {@link sap.ui.export} library is required. * * @since 1.100.0 */ enableExport?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies the type of export to be used in the `SmartTable` control. * * @since 1.50.0 */ exportType?: | sap.ui.comp.smarttable.ExportType | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enables the copy-to-clipboard functionality of the `SmartTable` control. * * When set to `true`, a {@link sap.m.plugins.CopyProvider} and a {@link sap.m.plugins.CellSelector} are * automatically created and added to the `SmartTable` control if a custom `CopyProvider` or `CellSelector` * are not already used by the application. When set to `false`, these created code>CopyProvider * and `CellSelector` plugins are removed again. * * **Note:** * We recommend that you set the `enableCopy` property to `false` in the following cases: * - The copy-to-clipboard functionality is not desired * - Plugins with property settings other than the default ones should be used * - Only one of the plugins should be used * - The functionality conflicts with the concrete application scenario, for example, custom columns with * special content * - The functionality conflicts with the known restrictions of the `CopyProvider` and `CellSelector` * plugins * * @since 1.124.0 */ enableCopy?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The `useTablePersonalisation` attribute can be set to true or false depending on whether you want to * define personalized table settings. If you want to persist the table personalization, you need to specify * the persistencyKey property. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.26.0 */ useTablePersonalisation?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The showTablePersonalisation attribute can be set to true or false for controlling the visibility of * the TablePersonalisation button. * * @since 1.38.0 */ showTablePersonalisation?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Provides customization to the columns/cell templates generated by the `SmartTable` control. * * List of supported settings for the `customizeConfig` property: * - `textInEditModeSource`: For more information, see {@link sap.ui.comp.smartfield.SmartField#setTextInEditModeSource } * * - `insertIgnoreRestrictions`: The `customData` setting for the `sap.ui.comp.smartfield.SmartField` * control. Supported as of version 1.103. * - `autoColumnWidth`: This property can be used to influence the column width calculation for columns * generated by the `SmartTable` control itself. The supported configuration settings are `truncateLabel`, * `min`, `max`, and `gap`. Supported as of version 1.108. For more information, see {@link sap.ui.comp.smarttable.SmartTable#getEnableAutoColumnWidth}. * * - `clientSideMandatoryCheck`: For more information, see {@link sap.ui.comp.smartfield.SmartField#setClientSideMandatoryCheck}. * Supported as of version 1.111 Examples for the `customizeConfig` property to change the * `textInEditModeSource` for the default `smartField` * ```javascript * * * * ``` * * ```javascript * * * * ``` * * ```javascript * * * * ``` * * * @since 1.97.0 */ customizeConfig?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The number of rows is shown along with the header text if the property `showRowCount` is set to `true`. * * **Note:** * * - To improve your application's performance, activate the inline count for OData bindings to avoid * sending dedicated OData requests. * - If no stable overall count can be retrieved from the binding, the count will not be displayed. This * is currently the case for TreeBinding or if no count is requested by the binding. * * @since 1.26.0 */ showRowCount?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies header text that is shown in table * * @since 1.26.0 */ header?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines the semantic level of the header. For more information, see {@link sap.m.Title#setLevel}. * * @since 1.84 */ headerLevel?: | sap.ui.core.TitleLevel | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * A style class which is defined for the toolbar of the table. * * @since 1.26.0 */ toolbarStyleClass?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Can be used to override the filter behavior. If set to true (default), instead of the filter input box * a button is rendered. When pressing this button, the SmartTable control opens the filter panel directly * in the table personalization dialog. * * @since 1.26.0 * @deprecated As of version 1.40.0. After personalization dialog has been introduced in SmartTable the * property `enableCustomFilter` does not make sense. When setting the property to `false`, the entered * custom filter value will not be shown in personalization dialog and will also not be persisted in variant * management. The custom filter will also be overwritten when rebindTable is called on the SmartTable. */ enableCustomFilter?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Key used to access personalization data. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.26.0 */ persistencyKey?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * If set to true, the standard toolbar and custom toolbar will be merged into one toolbar. The combined * toolbar will have a solid style. * * @since 1.26.0 * @deprecated As of version 1.29. This property has no effect */ useOnlyOneSolidToolbar?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Specifies whether the `Toolbar` control of the `SmartTable` is placed inside the corresponding aggregation * of the inner UI5 table control. * * @since 1.56 */ placeToolbarInTable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Retrieves or sets the current variant. * * @since 1.28.0 */ currentVariantId?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * This attribute can be used to specify if the controls created by the SmartTable control are editable. * (The automatic toggle of controls works only for the SmartField/SmartToggle scenario) * * @since 1.28.0 */ editable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * When set to true, this enables automatic binding of the table using the tableBindingPath (if it exists) * or entitySet property. This happens just after the `initialise` event has been fired. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.28.0 */ enableAutoBinding?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * This attribute can be used to specify the path that is used during the binding of the table. If not specified, * the entitySet attribute is used instead. (used only if binding is established after setting this property: * initially due to enableAutoBinding -or- by subsequently calling rebindTable) * * @since 1.28.0 */ tableBindingPath?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Specifies whether the editable property can be toggled via a button on the toolbar. (The automatic toggle * of controls works only for the SmartField/SmartToggle scenario) * * @since 1.28.0 */ editTogglable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The demandPopin attribute can be set to true or false depending on whether you want to display columns * as popins on the responsive table * * @since 1.30.0 */ demandPopin?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the FullScreen button. * * @since 1.38 */ showFullScreenButton?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The text shown initially before the control is bound and initialized. The special values `$FILTERBAR` * or `$NO_FILTERBAR` can be specified to make the `SmartTable` control show the initial text as if the * `SmartFilterBar` control were associated with it. If nothing is specified, the default behavior is to * show the initial text based on whether the `SmartFilterBar` control is actually associated with the `SmartTable` * control. * * @since 1.58 */ initialNoDataText?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Shows an info toolbar. * Filters that are applied using the table personalization dialog are shown in the info toolbar. * **Note:** * * - The default value for the property is `Auto`, which means that the info toolbar is shown by default * if table type is `ResponsiveTable`. * - The info toolbar is hidden if the property is set to `Off`. * - The info toolbar is visible if the property is set to `On`. Currently the info toolbar is only available * for the table type `ResponsiveTable`. * - If multiple filters are applied to the same column, then the info toolbar contains the column name * only once. * - In case there is a custom info toolbar used for the responsive table control, then the property must * be set to `Off`. Otherwise, an error is logged in the browser console. * * @since 1.70 */ useInfoToolbar?: | sap.ui.comp.smarttable.InfoToolbarBehavior | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the Show / Hide Details button for the `ResponsiveTable` scenario. * * If the available screen space gets too narrow, the columns configured with `High` and `Medium` importance * move to the pop-in area while the columns with `Low` importance are hidden. On mobile phones, the columns * with `Medium` importance are also hidden. As soon as the first column is hidden, this button appears * in the table toolbar and gives the user the possibility to toggle the visibility of the hidden columns * in the pop-in area. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.79 */ showDetailsButton?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines which columns should be hidden instead of moved into the pop-in area depending on their importance. * See {@link sap.m.Column#getImportance} and {@link sap.m.Table#getHiddenInPopin} for more details. * * **Note:** To hide columns based on their importance, it's mandatory to set `showDetailsButton="true"`. * If no priority is given, the default configuration of {@link sap.ui.comp.smarttable.SmartTable#getShowDetailsButton } * is used. If this property is changed after the `SmartTable` has been initialized, the new changes take * effect only when the Show / Hide Details button is pressed a second time. * * @since 1.86 */ detailsButtonSetting?: | sap.ui.core.Priority[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enables heuristic column width calculation for all supported table types based on metadata information * when set to `true`. The column width calculation takes OData type, column label, text arrangement, possible * cell templates, additional fields and many other metadata parameters into account. Providing more precise * `MaxLength` value for the `Edm.String` type or `precision` value for numeric OData types can help this * algorithm to produce better results. The calculated column widths can have a minimum of 3rem and a maximum * of 20rem. To avoid the heuristic column width calculation for a particular column, the {@link #annotation:CssDefaults CssDefaults } * annotation can be used. * * If `tableType="ResponsiveTable"`, the following changes are applied: * - {@link #getDemandPopin demandPopin} property of the `SmartTable` is set to `true`. * - {@link sap.m.Table#getFixedLayout fixedLayout} property of the inner table is set to `Strict`. * - {@link sap.m.Table#getContextualWidth contextualWidth} property of the inner table is set to `Auto`. * * - Column resizing feature gets enabled and the wrapping of column headers get disabled for all columns, * including custom columns. Those properties must not be managed by the application. * * * * By default, this feature has no effect on custom columns. To enable heuristic column width calculation * also for custom columns, the `autoColumnWidth` property must be specified in the `p13nData` custom data. * **Note:** The automatic column width calculation for custom columns works only when the `width` property * of the custom column is not set. * **Note:** The custom columns can have unexpected cell templates that might affect the result of the * column width calculation, for example, an `Edm.Byte` field that can only have three digits might be visualized * as a `sap.m.RatingIndicator` that requires more space. * **Note:** Defining the `leadingProperty` and a unique `columnKey` in the `p13nData` custom data is a * prerequisite for all other `p13nData` properties, including the `autoColumnWidth` property. * Examples with `autoColumnWidth` property of the `p13nData` custom data * ```javascript * * * * ``` * * ```javascript * * * * ``` * * ```javascript * * * * ``` * * ```javascript * * * * ``` * * ```javascript * * * * ``` * * * **Note:** * The `enableAutoColumnWidth` is not a dynamic property and cannot be changed once the control has been * initialized. * * @since 1.86 */ enableAutoColumnWidth?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Controls the visibility of the Paste button. * * @since 1.91 */ showPasteButton?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines whether the Paste button is enabled. * * @since 1.96 */ enablePaste?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `true`, all date fields in the Filter Panel of the settings dialog with filter restriction * `interval` will be treated as `DateTimeRange` filters. The `useDateRangeType` can be set only once during * initialization. **Note:** If this property is set to `true` and any date filters with filter restriction * `interval` were stored as part of a variant, the values of these filters cannot be applied. If this property * is set to `false`, any previously stored filters which were treated as type `DateTimeRange` based on * the former setting, cannot be converted back to the standard date interval. * * @since 1.126.0 */ useDateRangeType?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines default values shown in the export dialog. * * Configure default values that are displayed in the export dialog. For example, the `fileName` property * of {@link sap.ui.export.TableExportSettings} defines the default file name shown in the export dialog. * If not specified, the table header is used. * * **Note:** These values are defaults shown to the user. The user can still modify them before export. * If the user modifies a value in the dialog, the user choice takes precedence and is not overridden by * event handlers. * * @since 1.148 */ defaultExportSettings?: sap.ui.export.TableExportSettings; /** * A toolbar that can be added by the user to define their own custom buttons, icons, etc. If this is specified, * the SmartTable control does not create an additional toolbar, but makes use of this one. * **Note:** * The CSS class sapMTBHeader-CTX is applied on the given toolbar. * * @since 1.26.0 */ customToolbar?: sap.m.Toolbar; /** * The Semantic Object Controller allows the user to specify and overwrite functionality for semantic object * navigation. * * @since 1.28.0 */ semanticObjectController?: sap.ui.comp.navpopover.SemanticObjectController; /** * The value for the noData aggregation can be either a string value or a control instance. * The control is shown, in case there is no data for the Table available. In case of a string value this * will simply replace the no data text. * * * **Note:** If an `sap.m.IllustratedMessage` control is used without a title set, the SmartTable will automatically * update the illustration and text accordingly. * * @since 1.32.0 */ noData?: | string | sap.ui.core.Control | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Allows users to specify an additional control that will be added to a VBox for the first semantic key * field. * **Note:** * This property is not meant for public use. * * @since 1.38.0 */ semanticKeyAdditionalControl?: sap.ui.core.Control; /** * Defines an aggregation for the `DataStateIndicator` plugin that can be used to show binding-related messages. * If the {@link sap.m.plugins.DataStateIndicator#getEnableFiltering enableFiltering} property of the `DataStateIndicator` * is set to `true`, the `SmartTable` control prevents the original behavior of the `DataStateIndicator` * and manages the filtering of binding-related messages. If a user applies or clears message filters, the * `SmartTable` control fires the {@link #event:beforeRebindTable beforeRebindTable} event with the `messageFilterActive` * parameter that is used to determine whether message filtering is active or not. After the binding-related * messages have been filtered by the user, all the existing filters, for example, those defined using `SmartFilterBar` * are only taken into account once the message filter has been cleared again. Therefore the message filtering * should not be used in combination with a `SmartFilterBar`. Required additional filters must be added * by applications in the {@link #event:beforeRebindTable beforeRebindTable} event. * * @since 1.89 */ dataStateIndicator?: sap.m.plugins.DataStateIndicator; /** * Defines an aggregation for the `CopyProvider` plugin that provides copy to clipboard capabilities for * the selected rows of the table and creates a Copy button for the toolbar of the table. To disable the * copy function of the table, including the Copy button in the toolbar, the `enabled` property of the `CopyProvider` * must be set to `false`. To hide the Copy button from the toolbar, the `visible` property of the `CopyProvider` * must be set to `false`. * * **Note:** The {@link sap.m.plugins.CopyProvider#extractData extractData} property of the `CopyProvider` * must not be managed by the application. **Note:** The `CopyProvider` requires a secure context to access * the clipboard API. If the context is not secure, the plugin will not be added, and the copy button will * not be generated. * * @since 1.114 */ copyProvider?: sap.m.plugins.CopyProvider; /** * Allows the user to configure filters for the table personalization * * @since 1.126 */ filterControlConfiguration?: | sap.ui.comp.config.FilterControlConfiguration[] | sap.ui.comp.config.FilterControlConfiguration | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Identifies the SmartVariant control which should be used for the personalization. Will be ignored if * the advanced mode is set. * * @since 1.38 */ smartVariant?: sap.ui.core.Control | string; /** * This event is fired once the control has been initialized. * * @since 1.26.0 */ initialise?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired just before the binding is being done. * * @since 1.26.0 */ beforeRebindTable?: ( oEvent: SmartTable$BeforeRebindTableEvent ) => void; /** * This event is fired when display/edit button is clicked. * * @since 1.28.0 */ editToggled?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired when data is requested after binding. The event is fired if the binding for the table * is done by the SmartTable itself. * * @since 1.52.0 * @deprecated As of version 1.56. Use `beforeRebindTable` event to attach/listen to the binding "events" * directly */ dataRequested?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired when data is received after binding. The event is fired if the binding for the table * is done by the SmartTable itself. * * @since 1.28.0 * @deprecated As of version 1.56. Use `beforeRebindTable` event to attach/listen to the binding "events" * directly */ dataReceived?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired after variant management in the SmartTable has been initialized. * * @since 1.28.0 */ afterVariantInitialise?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired after a variant has been saved. This event can be used to retrieve the ID of the * saved variant. * * @since 1.28.0 */ afterVariantSave?: (oEvent: SmartTable$AfterVariantSaveEvent) => void; /** * This event is fired after a variant has been applied. * * @since 1.28.0 */ afterVariantApply?: ( oEvent: SmartTable$AfterVariantApplyEvent ) => void; /** * This event is fired just before the overlay is being shown. * * @since 1.32.0 */ showOverlay?: (oEvent: SmartTable$ShowOverlayEvent) => void; /** * This event is fired when an editable field, created internally by the SmartTable control, is changed. * * @since 1.34.0 */ fieldChange?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired right after the full screen mode of the SmartTable control has been changed. * * @since 1.46 */ fullScreenToggled?: ( oEvent: SmartTable$FullScreenToggledEvent ) => void; /** * This event is fired right before the export is triggered. Listeners can prevent the default action of * this event by calling the `preventDefault` method of the event object. * * @since 1.50 */ beforeExport?: (oEvent: SmartTable$BeforeExportEvent) => void; /** * This event is fired just before the paste event is triggered and can be used to prevent the default paste * behavior. * **Note**: If no validation is desired, applications can use the `rawData` parameter to directly access * the pasted data. * **Note**: If a column contains additional properties, they are considered as separate columns for the * pasting. * * @since 1.64 */ beforePaste?: (oEvent: SmartTable$BeforePasteEvent) => void; /** * This event is fired when pasting is triggered. * * @since 1.64 */ paste?: (oEvent: SmartTable$PasteEvent) => void; /** * This event is fired when the UI state changes either via the {@link sap.ui.comp.smarttable.SmartTable#setUiState } * method or the table personalization. * * @since 1.96.15 */ uiStateChange?: (oEvent: sap.ui.base.Event) => void; /** * Forwards the {@link sap.ui.comp.smartfield.SmartField#event:changeModelValue changeModelValue} event * from the {@link sap.ui.comp.smartfield.SmartField SmartField}. * * @since 1.139 */ changeModelValue?: (oEvent: sap.ui.base.Event) => void; } /** * Parameters of the SmartTable#afterVariantApply event. */ interface SmartTable$AfterVariantApplyEventParameters { /** * ID of the currently selected variant */ currentVariantId?: string; /** * Context in which the variant has been applied */ variantContext?: string; } /** * Parameters of the SmartTable#afterVariantInitialise event. */ interface SmartTable$AfterVariantInitialiseEventParameters {} /** * Parameters of the SmartTable#afterVariantSave event. */ interface SmartTable$AfterVariantSaveEventParameters { /** * ID of the currently selected variant */ currentVariantId?: string; } /** * Parameters of the SmartTable#beforeExport event. */ interface SmartTable$BeforeExportEventParameters { /** * General export configuration */ exportSettings?: object; /** * User specific settings */ userExportSettings?: object; /** * Filter settings that will be contained in the exported file */ filterSettings?: sap.ui.export.util.Filter[]; } /** * Parameters of the SmartTable#beforePaste event. */ interface SmartTable$BeforePasteEventParameters { /** * Contains an array of column info objects as determined by the `SmartTable` control. */ columnInfos?: sap.ui.comp.smarttable.ColumnInfoForPaste[]; /** * Two-dimensional array of strings with data from the clipboard. The first dimension represents the rows, * and the second dimension represents the cells of the tabular data. */ rawData?: string[][]; } /** * Parameters of the SmartTable#beforeRebindTable event. */ interface SmartTable$BeforeRebindTableEventParameters { /** * Indicates whether the message filtering is active or not */ messageFilterActive?: boolean; /** * The bindingParams object contains filters, sorters and other binding related information for the table. */ bindingParams?: object; } /** * Parameters of the SmartTable#changeModelValue event. */ interface SmartTable$ChangeModelValueEventParameters {} /** * Parameters of the SmartTable#dataReceived event. * * @deprecated As of version 1.56. Use `beforeRebindTable` event to attach/listen to the binding "events" * directly */ interface SmartTable$DataReceivedEventParameters {} /** * Parameters of the SmartTable#dataRequested event. * * @deprecated As of version 1.56. Use `beforeRebindTable` event to attach/listen to the binding "events" * directly */ interface SmartTable$DataRequestedEventParameters {} /** * Parameters of the SmartTable#editToggled event. */ interface SmartTable$EditToggledEventParameters {} /** * Parameters of the SmartTable#fieldChange event. */ interface SmartTable$FieldChangeEventParameters {} /** * Parameters of the SmartTable#fullScreenToggled event. */ interface SmartTable$FullScreenToggledEventParameters { /** * If `true`, control is in full screen mode */ fullScreen?: boolean; } /** * Parameters of the SmartTable#initialise event. */ interface SmartTable$InitialiseEventParameters {} /** * Parameters of the SmartTable#paste event. */ interface SmartTable$PasteEventParameters { /** * The result of the parsing returned by `PasteHelper.parse` API. * The result object contains parsed data if the validation was successful (the error array has the value * `null`), or it contains all collected errors if the validation failed (the data array has the value `null`). * * Example of the result object after the successful validation - the data array is filled, and the error * object is empty: * ```javascript * * oResult = { * parsedData: [ * {FirstName: "Max", LastName : "Mustermann"}, * {FirstName: "John", LastName: "Doe"} * ], * errors: null * }); * ``` * * * The error array contains objects with the following properties: * - row {number} Row index where the error occurred * - column {number} Column index where the error occurred * - property {string} The column-related property * - value {string} The pasted value * - type {object} The type instance that is used to parse the pasted value * - message {string} The error message * * Example of the result object after the failed validation - error information is available, and the data * array is empty: * ```javascript * * oResult = { * parsedData: null, * errors: [ * {row: 2, column: 3, property: 'age', value: 'x', type:'sap.ui.model.odata.type.Byte', message: 'Value "x" in row 2 and column 2 cannot be parsed.'} * ] * }); * ``` */ result?: object; } /** * Parameters of the SmartTable#showOverlay event. */ interface SmartTable$ShowOverlayEventParameters { /** * The overlay object contains information related to the table's overlay */ overlay?: object; } /** * Parameters of the SmartTable#uiStateChange event. */ interface SmartTable$UiStateChangeEventParameters {} /** * The `SmartTable` control creates a table based on OData metadata and the configuration specified. The * entitySet attribute must be specified to use the control. This attribute is used to fetch fields from * OData metadata, from which columns will be generated; it can also be used to fetch the actual table data. * Based on the tableType property, this control will render a standard, analytical, tree, or responsive * table. * * * **Note:** * - The `SmartTable` control supports the `Currency` and `Unit` customization referenced by the related * `entitySet`. The requested code list is then used for formatting the `Currency` and `Unit` cell template. * See {@link sap.ui.model.odata.v4.ODataMetaModel#requestCurrencyCodes} and {@link sap.ui.model.odata.v4.ODataMetaModel#requestUnitsOfMeasure } * for more information. * - The OData types, such as {@link sap.ui.model.odata.type.Decimal}, {@link sap.ui.model.odata.type.Currency}, * and {@link sap.ui.model.odata.type.Unit}, have the format option `preserveDecimals=true` by default, * which preserves the decimals returned by the back end. The `SmartTable` control offers a global `customData` * setting called **`preserveDecimals`** that can be used to configure the `preserveDecimals` format option. * The default is `preserveDecimals=true` for the `customData`. This `customData` is then used for formatting * the `Edm.Decimal` type as well as the `Currency` and `Unit` cell template. If the number of decimal digits * is different from the values returned by the code list, then the decimal point alignment for the `Currency` * and `Unit` values cannot be guaranteed. * - Cell data of type `string` containing whitespace characters are replaced with unicode characters * to visualize the whitespaces on the UI. This is enabled by default. * - The `SmartTable` must not be cloned or used as a template. Doing this might cause issues with its * behavior, personalization, or `VariantManagement`. */ class SmartTable extends sap.m.VBox { /** * Constructor for a new smarttable/SmartTable. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/bed8274140d04fc0b9bcb2db42d8bac2 Smart Table} */ constructor( /** * initial settings for the new control */ mSettings?: sap.ui.comp.smarttable.$SmartTableSettings ); /** * Constructor for a new smarttable/SmartTable. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/bed8274140d04fc0b9bcb2db42d8bac2 Smart Table} */ constructor( /** * id for the new control, generated automatically if no id is given */ sId?: string, /** * initial settings for the new control */ mSettings?: sap.ui.comp.smarttable.$SmartTableSettings ); /** * Creates a new subclass of class sap.ui.comp.smarttable.SmartTable 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.VBox.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smarttable.SmartTable. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some filterControlConfiguration to the aggregation {@link #getFilterControlConfiguration filterControlConfiguration}. * * @since 1.126 * * @returns Reference to `this` in order to allow method chaining */ addFilterControlConfiguration( /** * The filterControlConfiguration to add; if empty, nothing is inserted */ oFilterControlConfiguration: sap.ui.comp.config.FilterControlConfiguration ): this; /** * Interface function for SmartVariantManagement control, sets the current variant. **Note:** If an application * default variant exists, then all other variants are extended from this application default variant. * * **Note:** This method must only be called after the `SmartTable` has been fully initialized. If the `SmartTable` * has not been initialized, the variant changes will not take effect. */ applyVariant( /** * The variants json */ oVariantJSON: object, /** * Describes the context in which the apply was executed */ sContext: string ): void; /** * Attaches event handler `fnFunction` to the {@link #event:afterVariantApply afterVariantApply} event of * this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired after a variant has been applied. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachAfterVariantApply( /** * 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: SmartTable$AfterVariantApplyEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:afterVariantApply afterVariantApply} event of * this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired after a variant has been applied. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachAfterVariantApply( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartTable$AfterVariantApplyEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:afterVariantInitialise afterVariantInitialise } * event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired after variant management in the SmartTable has been initialized. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachAfterVariantInitialise( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:afterVariantInitialise afterVariantInitialise } * event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired after variant management in the SmartTable has been initialized. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachAfterVariantInitialise( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:afterVariantSave afterVariantSave} event of * this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired after a variant has been saved. This event can be used to retrieve the ID of the * saved variant. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachAfterVariantSave( /** * 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: SmartTable$AfterVariantSaveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:afterVariantSave afterVariantSave} event of * this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired after a variant has been saved. This event can be used to retrieve the ID of the * saved variant. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachAfterVariantSave( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartTable$AfterVariantSaveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeExport beforeExport} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired right before the export is triggered. Listeners can prevent the default action of * this event by calling the `preventDefault` method of the event object. * * @since 1.50 * * @returns Reference to `this` in order to allow method chaining */ attachBeforeExport( /** * 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: SmartTable$BeforeExportEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeExport beforeExport} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired right before the export is triggered. Listeners can prevent the default action of * this event by calling the `preventDefault` method of the event object. * * @since 1.50 * * @returns Reference to `this` in order to allow method chaining */ attachBeforeExport( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartTable$BeforeExportEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforePaste beforePaste} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired just before the paste event is triggered and can be used to prevent the default paste * behavior. * **Note**: If no validation is desired, applications can use the `rawData` parameter to directly access * the pasted data. * **Note**: If a column contains additional properties, they are considered as separate columns for the * pasting. * * @since 1.64 * * @returns Reference to `this` in order to allow method chaining */ attachBeforePaste( /** * 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: SmartTable$BeforePasteEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforePaste beforePaste} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired just before the paste event is triggered and can be used to prevent the default paste * behavior. * **Note**: If no validation is desired, applications can use the `rawData` parameter to directly access * the pasted data. * **Note**: If a column contains additional properties, they are considered as separate columns for the * pasting. * * @since 1.64 * * @returns Reference to `this` in order to allow method chaining */ attachBeforePaste( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartTable$BeforePasteEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeRebindTable beforeRebindTable} event of * this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired just before the binding is being done. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ attachBeforeRebindTable( /** * 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: SmartTable$BeforeRebindTableEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:beforeRebindTable beforeRebindTable} event of * this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired just before the binding is being done. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ attachBeforeRebindTable( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartTable$BeforeRebindTableEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:changeModelValue changeModelValue} event of * this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * Forwards the {@link sap.ui.comp.smartfield.SmartField#event:changeModelValue changeModelValue} event * from the {@link sap.ui.comp.smartfield.SmartField SmartField}. * * @since 1.139 * * @returns Reference to `this` in order to allow method chaining */ attachChangeModelValue( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:changeModelValue changeModelValue} event of * this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * Forwards the {@link sap.ui.comp.smartfield.SmartField#event:changeModelValue changeModelValue} event * from the {@link sap.ui.comp.smartfield.SmartField SmartField}. * * @since 1.139 * * @returns Reference to `this` in order to allow method chaining */ attachChangeModelValue( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:dataReceived dataReceived} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired when data is received after binding. The event is fired if the binding for the table * is done by the SmartTable itself. * * @since 1.28.0 * @deprecated As of version 1.56. Use `beforeRebindTable` event to attach/listen to the binding "events" * directly * * @returns Reference to `this` in order to allow method chaining */ attachDataReceived( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:dataReceived dataReceived} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired when data is received after binding. The event is fired if the binding for the table * is done by the SmartTable itself. * * @since 1.28.0 * @deprecated As of version 1.56. Use `beforeRebindTable` event to attach/listen to the binding "events" * directly * * @returns Reference to `this` in order to allow method chaining */ attachDataReceived( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:dataRequested dataRequested} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired when data is requested after binding. The event is fired if the binding for the table * is done by the SmartTable itself. * * @since 1.52.0 * @deprecated As of version 1.56. Use `beforeRebindTable` event to attach/listen to the binding "events" * directly * * @returns Reference to `this` in order to allow method chaining */ attachDataRequested( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:dataRequested dataRequested} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired when data is requested after binding. The event is fired if the binding for the table * is done by the SmartTable itself. * * @since 1.52.0 * @deprecated As of version 1.56. Use `beforeRebindTable` event to attach/listen to the binding "events" * directly * * @returns Reference to `this` in order to allow method chaining */ attachDataRequested( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:editToggled editToggled} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired when display/edit button is clicked. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachEditToggled( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:editToggled editToggled} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired when display/edit button is clicked. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ attachEditToggled( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:fieldChange fieldChange} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired when an editable field, created internally by the SmartTable control, is changed. * * @since 1.34.0 * * @returns Reference to `this` in order to allow method chaining */ attachFieldChange( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:fieldChange fieldChange} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired when an editable field, created internally by the SmartTable control, is changed. * * @since 1.34.0 * * @returns Reference to `this` in order to allow method chaining */ attachFieldChange( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:fullScreenToggled fullScreenToggled} event of * this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired right after the full screen mode of the SmartTable control has been changed. * * @since 1.46 * * @returns Reference to `this` in order to allow method chaining */ attachFullScreenToggled( /** * 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: SmartTable$FullScreenToggledEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:fullScreenToggled fullScreenToggled} event of * this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired right after the full screen mode of the SmartTable control has been changed. * * @since 1.46 * * @returns Reference to `this` in order to allow method chaining */ attachFullScreenToggled( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartTable$FullScreenToggledEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialise initialise} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired once the control has been initialized. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ attachInitialise( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialise initialise} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired once the control has been initialized. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ attachInitialise( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:paste paste} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired when pasting is triggered. * * @since 1.64 * * @returns Reference to `this` in order to allow method chaining */ attachPaste( /** * 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: SmartTable$PasteEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:paste paste} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired when pasting is triggered. * * @since 1.64 * * @returns Reference to `this` in order to allow method chaining */ attachPaste( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartTable$PasteEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:showOverlay showOverlay} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired just before the overlay is being shown. * * @since 1.32.0 * * @returns Reference to `this` in order to allow method chaining */ attachShowOverlay( /** * 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: SmartTable$ShowOverlayEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:showOverlay showOverlay} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired just before the overlay is being shown. * * @since 1.32.0 * * @returns Reference to `this` in order to allow method chaining */ attachShowOverlay( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartTable$ShowOverlayEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:uiStateChange uiStateChange} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired when the UI state changes either via the {@link sap.ui.comp.smarttable.SmartTable#setUiState } * method or the table personalization. * * @since 1.96.15 * * @returns Reference to `this` in order to allow method chaining */ attachUiStateChange( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:uiStateChange uiStateChange} event of this `sap.ui.comp.smarttable.SmartTable`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smarttable.SmartTable` itself. * * This event is fired when the UI state changes either via the {@link sap.ui.comp.smarttable.SmartTable#setUiState } * method or the table personalization. * * @since 1.96.15 * * @returns Reference to `this` in order to allow method chaining */ attachUiStateChange( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smarttable.SmartTable` itself */ oListener?: object ): this; /** * Deactivates existing columns in the personalization dialog based on the provided column keys. * Note: The columns are set to invisible and excluded from all panels in the table personalization. * Any existing sorting, filtering or grouping in the personalization dialog for such columns will no longer * be taken into account. * * @since 1.54.0 */ deactivateColumns( /** * An array of column keys by which the corresponding columns are deactivated. If `null` or `undefined` * or an empty array is passed, no column is deactivated, and all previously deactivated columns will be * reset */ aColumnKeys: string[] | null | undefined ): void; /** * Destroys the copyProvider in the aggregation {@link #getCopyProvider copyProvider}. * * @since 1.114 * * @returns Reference to `this` in order to allow method chaining */ destroyCopyProvider(): this; /** * Destroys the customToolbar in the aggregation {@link #getCustomToolbar customToolbar}. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ destroyCustomToolbar(): this; /** * Destroys the dataStateIndicator in the aggregation {@link #getDataStateIndicator dataStateIndicator}. * * @since 1.89 * * @returns Reference to `this` in order to allow method chaining */ destroyDataStateIndicator(): this; /** * Destroys the defaultExportSettings in the aggregation {@link #getDefaultExportSettings defaultExportSettings}. * * @since 1.148 * * @returns Reference to `this` in order to allow method chaining */ destroyDefaultExportSettings(): this; /** * Destroys all the filterControlConfiguration in the aggregation {@link #getFilterControlConfiguration filterControlConfiguration}. * * @since 1.126 * * @returns Reference to `this` in order to allow method chaining */ destroyFilterControlConfiguration(): this; /** * Destroys the noData in the aggregation {@link #getNoData noData}. * * @since 1.32.0 * * @returns Reference to `this` in order to allow method chaining */ destroyNoData(): this; /** * Destroys the semanticKeyAdditionalControl in the aggregation {@link #getSemanticKeyAdditionalControl semanticKeyAdditionalControl}. * * @since 1.38.0 * * @returns Reference to `this` in order to allow method chaining */ destroySemanticKeyAdditionalControl(): this; /** * Destroys the semanticObjectController in the aggregation {@link #getSemanticObjectController semanticObjectController}. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ destroySemanticObjectController(): this; /** * Detaches event handler `fnFunction` from the {@link #event:afterVariantApply afterVariantApply} event * of this `sap.ui.comp.smarttable.SmartTable`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ detachAfterVariantApply( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartTable$AfterVariantApplyEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:afterVariantInitialise afterVariantInitialise } * event of this `sap.ui.comp.smarttable.SmartTable`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ detachAfterVariantInitialise( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:afterVariantSave afterVariantSave} event of * this `sap.ui.comp.smarttable.SmartTable`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ detachAfterVariantSave( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartTable$AfterVariantSaveEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:beforeExport beforeExport} event of this `sap.ui.comp.smarttable.SmartTable`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.50 * * @returns Reference to `this` in order to allow method chaining */ detachBeforeExport( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartTable$BeforeExportEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:beforePaste beforePaste} event of this `sap.ui.comp.smarttable.SmartTable`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.64 * * @returns Reference to `this` in order to allow method chaining */ detachBeforePaste( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartTable$BeforePasteEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:beforeRebindTable beforeRebindTable} event * of this `sap.ui.comp.smarttable.SmartTable`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ detachBeforeRebindTable( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartTable$BeforeRebindTableEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:changeModelValue changeModelValue} event of * this `sap.ui.comp.smarttable.SmartTable`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.139 * * @returns Reference to `this` in order to allow method chaining */ detachChangeModelValue( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:dataReceived dataReceived} event of this `sap.ui.comp.smarttable.SmartTable`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.28.0 * @deprecated As of version 1.56. Use `beforeRebindTable` event to attach/listen to the binding "events" * directly * * @returns Reference to `this` in order to allow method chaining */ detachDataReceived( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:dataRequested dataRequested} event of this * `sap.ui.comp.smarttable.SmartTable`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.52.0 * @deprecated As of version 1.56. Use `beforeRebindTable` event to attach/listen to the binding "events" * directly * * @returns Reference to `this` in order to allow method chaining */ detachDataRequested( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:editToggled editToggled} event of this `sap.ui.comp.smarttable.SmartTable`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ detachEditToggled( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:fieldChange fieldChange} event of this `sap.ui.comp.smarttable.SmartTable`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.34.0 * * @returns Reference to `this` in order to allow method chaining */ detachFieldChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:fullScreenToggled fullScreenToggled} event * of this `sap.ui.comp.smarttable.SmartTable`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.46 * * @returns Reference to `this` in order to allow method chaining */ detachFullScreenToggled( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartTable$FullScreenToggledEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:initialise initialise} event of this `sap.ui.comp.smarttable.SmartTable`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ detachInitialise( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:paste paste} event of this `sap.ui.comp.smarttable.SmartTable`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.64 * * @returns Reference to `this` in order to allow method chaining */ detachPaste( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartTable$PasteEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:showOverlay showOverlay} event of this `sap.ui.comp.smarttable.SmartTable`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.32.0 * * @returns Reference to `this` in order to allow method chaining */ detachShowOverlay( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartTable$ShowOverlayEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:uiStateChange uiStateChange} event of this * `sap.ui.comp.smarttable.SmartTable`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.96.15 * * @returns Reference to `this` in order to allow method chaining */ detachUiStateChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Cleans up the control * * @ui5-protected Do not call from applications (only from related classes in the framework) */ exit(): void; /** * Interface function for SmartVariantManagement control, returns the current used variant data * * * @returns The currently set variant */ fetchVariant(): object; /** * Fires event {@link #event:afterVariantApply afterVariantApply} to attached listeners. * * @since 1.28.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireAfterVariantApply( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smarttable.SmartTable$AfterVariantApplyEventParameters ): this; /** * Fires event {@link #event:afterVariantInitialise afterVariantInitialise} to attached listeners. * * @since 1.28.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireAfterVariantInitialise( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:afterVariantSave afterVariantSave} to attached listeners. * * @since 1.28.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireAfterVariantSave( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smarttable.SmartTable$AfterVariantSaveEventParameters ): this; /** * Fires event {@link #event:beforeExport beforeExport} 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.50 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Whether or not to prevent the default action */ fireBeforeExport( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smarttable.SmartTable$BeforeExportEventParameters ): boolean; /** * Fires event {@link #event:beforePaste beforePaste} 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.64 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Whether or not to prevent the default action */ fireBeforePaste( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smarttable.SmartTable$BeforePasteEventParameters ): boolean; /** * Fires event {@link #event:beforeRebindTable beforeRebindTable} to attached listeners. * * @since 1.26.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireBeforeRebindTable( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smarttable.SmartTable$BeforeRebindTableEventParameters ): this; /** * Fires event {@link #event:changeModelValue changeModelValue} to attached listeners. * * @since 1.139 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireChangeModelValue( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:dataReceived dataReceived} to attached listeners. * * @since 1.28.0 * @deprecated As of version 1.56. Use `beforeRebindTable` event to attach/listen to the binding "events" * directly * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireDataReceived( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:dataRequested dataRequested} to attached listeners. * * @since 1.52.0 * @deprecated As of version 1.56. Use `beforeRebindTable` event to attach/listen to the binding "events" * directly * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireDataRequested( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:editToggled editToggled} to attached listeners. * * @since 1.28.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireEditToggled( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:fieldChange fieldChange} to attached listeners. * * @since 1.34.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireFieldChange( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:fullScreenToggled fullScreenToggled} to attached listeners. * * @since 1.46 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireFullScreenToggled( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smarttable.SmartTable$FullScreenToggledEventParameters ): this; /** * Fires event {@link #event:initialise initialise} to attached listeners. * * @since 1.26.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireInitialise( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:paste paste} to attached listeners. * * @since 1.64 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ firePaste( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smarttable.SmartTable$PasteEventParameters ): this; /** * Fires event {@link #event:showOverlay showOverlay} to attached listeners. * * @since 1.32.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireShowOverlay( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smarttable.SmartTable$ShowOverlayEventParameters ): this; /** * Fires event {@link #event:uiStateChange uiStateChange} to attached listeners. * * @since 1.96.15 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireUiStateChange( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Gets content of aggregation {@link #getCopyProvider copyProvider}. * * Defines an aggregation for the `CopyProvider` plugin that provides copy to clipboard capabilities for * the selected rows of the table and creates a Copy button for the toolbar of the table. To disable the * copy function of the table, including the Copy button in the toolbar, the `enabled` property of the `CopyProvider` * must be set to `false`. To hide the Copy button from the toolbar, the `visible` property of the `CopyProvider` * must be set to `false`. * * **Note:** The {@link sap.m.plugins.CopyProvider#extractData extractData} property of the `CopyProvider` * must not be managed by the application. **Note:** The `CopyProvider` requires a secure context to access * the clipboard API. If the context is not secure, the plugin will not be added, and the copy button will * not be generated. * * @since 1.114 */ getCopyProvider(): sap.m.plugins.CopyProvider; /** * returns the id of the currently selected variant. * * * @returns id of the currently selected variant */ getCurrentVariantId(): string; /** * Gets current value of property {@link #getCustomizeConfig customizeConfig}. * * Provides customization to the columns/cell templates generated by the `SmartTable` control. * * List of supported settings for the `customizeConfig` property: * - `textInEditModeSource`: For more information, see {@link sap.ui.comp.smartfield.SmartField#setTextInEditModeSource } * * - `insertIgnoreRestrictions`: The `customData` setting for the `sap.ui.comp.smartfield.SmartField` * control. Supported as of version 1.103. * - `autoColumnWidth`: This property can be used to influence the column width calculation for columns * generated by the `SmartTable` control itself. The supported configuration settings are `truncateLabel`, * `min`, `max`, and `gap`. Supported as of version 1.108. For more information, see {@link sap.ui.comp.smarttable.SmartTable#getEnableAutoColumnWidth}. * * - `clientSideMandatoryCheck`: For more information, see {@link sap.ui.comp.smartfield.SmartField#setClientSideMandatoryCheck}. * Supported as of version 1.111 Examples for the `customizeConfig` property to change the * `textInEditModeSource` for the default `smartField` * ```javascript * * * * ``` * * ```javascript * * * * ``` * * ```javascript * * * * ``` * * * @since 1.97.0 * * @returns Value of property `customizeConfig` */ getCustomizeConfig(): object; /** * Gets content of aggregation {@link #getCustomToolbar customToolbar}. * * A toolbar that can be added by the user to define their own custom buttons, icons, etc. If this is specified, * the SmartTable control does not create an additional toolbar, but makes use of this one. * **Note:** * The CSS class sapMTBHeader-CTX is applied on the given toolbar. * * @since 1.26.0 */ getCustomToolbar(): sap.m.Toolbar; /** * Gets content of aggregation {@link #getDataStateIndicator dataStateIndicator}. * * Defines an aggregation for the `DataStateIndicator` plugin that can be used to show binding-related messages. * If the {@link sap.m.plugins.DataStateIndicator#getEnableFiltering enableFiltering} property of the `DataStateIndicator` * is set to `true`, the `SmartTable` control prevents the original behavior of the `DataStateIndicator` * and manages the filtering of binding-related messages. If a user applies or clears message filters, the * `SmartTable` control fires the {@link #event:beforeRebindTable beforeRebindTable} event with the `messageFilterActive` * parameter that is used to determine whether message filtering is active or not. After the binding-related * messages have been filtered by the user, all the existing filters, for example, those defined using `SmartFilterBar` * are only taken into account once the message filter has been cleared again. Therefore the message filtering * should not be used in combination with a `SmartFilterBar`. Required additional filters must be added * by applications in the {@link #event:beforeRebindTable beforeRebindTable} event. * * @since 1.89 */ getDataStateIndicator(): sap.m.plugins.DataStateIndicator; /** * Returns the deactivated column keys. * * See {@link sap.ui.comp.smarttable.SmartTable#deactivateColumns} * * @since 1.105.0 * * @returns array of column keys */ getDeactivatedColumns(): string[]; /** * Gets content of aggregation {@link #getDefaultExportSettings defaultExportSettings}. * * Defines default values shown in the export dialog. * * Configure default values that are displayed in the export dialog. For example, the `fileName` property * of {@link sap.ui.export.TableExportSettings} defines the default file name shown in the export dialog. * If not specified, the table header is used. * * **Note:** These values are defaults shown to the user. The user can still modify them before export. * If the user modifies a value in the dialog, the user choice takes precedence and is not overridden by * event handlers. * * @since 1.148 */ getDefaultExportSettings(): sap.ui.export.TableExportSettings; /** * Gets current value of property {@link #getDemandPopin demandPopin}. * * The demandPopin attribute can be set to true or false depending on whether you want to display columns * as popins on the responsive table * * Default value is `false`. * * @since 1.30.0 * * @returns Value of property `demandPopin` */ getDemandPopin(): boolean; /** * Gets current value of property {@link #getDetailsButtonSetting detailsButtonSetting}. * * Defines which columns should be hidden instead of moved into the pop-in area depending on their importance. * See {@link sap.m.Column#getImportance} and {@link sap.m.Table#getHiddenInPopin} for more details. * * **Note:** To hide columns based on their importance, it's mandatory to set `showDetailsButton="true"`. * If no priority is given, the default configuration of {@link sap.ui.comp.smarttable.SmartTable#getShowDetailsButton } * is used. If this property is changed after the `SmartTable` has been initialized, the new changes take * effect only when the Show / Hide Details button is pressed a second time. * * @since 1.86 * * @returns Value of property `detailsButtonSetting` */ getDetailsButtonSetting(): sap.ui.core.Priority[]; /** * Gets current value of property {@link #getEditable editable}. * * This attribute can be used to specify if the controls created by the SmartTable control are editable. * (The automatic toggle of controls works only for the SmartField/SmartToggle scenario) * * Default value is `false`. * * @since 1.28.0 * * @returns Value of property `editable` */ getEditable(): boolean; /** * Gets current value of property {@link #getEditTogglable editTogglable}. * * Specifies whether the editable property can be toggled via a button on the toolbar. (The automatic toggle * of controls works only for the SmartField/SmartToggle scenario) * * Default value is `false`. * * @since 1.28.0 * * @returns Value of property `editTogglable` */ getEditTogglable(): boolean; /** * Gets current value of property {@link #getEnableAutoBinding enableAutoBinding}. * * When set to true, this enables automatic binding of the table using the tableBindingPath (if it exists) * or entitySet property. This happens just after the `initialise` event has been fired. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * Default value is `false`. * * @since 1.28.0 * * @returns Value of property `enableAutoBinding` */ getEnableAutoBinding(): boolean; /** * Gets current value of property {@link #getEnableAutoColumnWidth enableAutoColumnWidth}. * * Enables heuristic column width calculation for all supported table types based on metadata information * when set to `true`. The column width calculation takes OData type, column label, text arrangement, possible * cell templates, additional fields and many other metadata parameters into account. Providing more precise * `MaxLength` value for the `Edm.String` type or `precision` value for numeric OData types can help this * algorithm to produce better results. The calculated column widths can have a minimum of 3rem and a maximum * of 20rem. To avoid the heuristic column width calculation for a particular column, the {@link #annotation:CssDefaults CssDefaults } * annotation can be used. * * If `tableType="ResponsiveTable"`, the following changes are applied: * - {@link #getDemandPopin demandPopin} property of the `SmartTable` is set to `true`. * - {@link sap.m.Table#getFixedLayout fixedLayout} property of the inner table is set to `Strict`. * - {@link sap.m.Table#getContextualWidth contextualWidth} property of the inner table is set to `Auto`. * * - Column resizing feature gets enabled and the wrapping of column headers get disabled for all columns, * including custom columns. Those properties must not be managed by the application. * * * * By default, this feature has no effect on custom columns. To enable heuristic column width calculation * also for custom columns, the `autoColumnWidth` property must be specified in the `p13nData` custom data. * **Note:** The automatic column width calculation for custom columns works only when the `width` property * of the custom column is not set. * **Note:** The custom columns can have unexpected cell templates that might affect the result of the * column width calculation, for example, an `Edm.Byte` field that can only have three digits might be visualized * as a `sap.m.RatingIndicator` that requires more space. * **Note:** Defining the `leadingProperty` and a unique `columnKey` in the `p13nData` custom data is a * prerequisite for all other `p13nData` properties, including the `autoColumnWidth` property. * Examples with `autoColumnWidth` property of the `p13nData` custom data * ```javascript * * * * ``` * * ```javascript * * * * ``` * * ```javascript * * * * ``` * * ```javascript * * * * ``` * * ```javascript * * * * ``` * * * **Note:** * The `enableAutoColumnWidth` is not a dynamic property and cannot be changed once the control has been * initialized. * * Default value is `false`. * * @since 1.86 * * @returns Value of property `enableAutoColumnWidth` */ getEnableAutoColumnWidth(): boolean; /** * Gets current value of property {@link #getEnableCopy enableCopy}. * * Enables the copy-to-clipboard functionality of the `SmartTable` control. * * When set to `true`, a {@link sap.m.plugins.CopyProvider} and a {@link sap.m.plugins.CellSelector} are * automatically created and added to the `SmartTable` control if a custom `CopyProvider` or `CellSelector` * are not already used by the application. When set to `false`, these created code>CopyProvider * and `CellSelector` plugins are removed again. * * **Note:** * We recommend that you set the `enableCopy` property to `false` in the following cases: * - The copy-to-clipboard functionality is not desired * - Plugins with property settings other than the default ones should be used * - Only one of the plugins should be used * - The functionality conflicts with the concrete application scenario, for example, custom columns with * special content * - The functionality conflicts with the known restrictions of the `CopyProvider` and `CellSelector` * plugins * * Default value is `true`. * * @since 1.124.0 * * @returns Value of property `enableCopy` */ getEnableCopy(): boolean; /** * Gets current value of property {@link #getEnableCustomFilter enableCustomFilter}. * * Can be used to override the filter behavior. If set to true (default), instead of the filter input box * a button is rendered. When pressing this button, the SmartTable control opens the filter panel directly * in the table personalization dialog. * * Default value is `true`. * * @since 1.26.0 * @deprecated As of version 1.40.0. After personalization dialog has been introduced in SmartTable the * property `enableCustomFilter` does not make sense. When setting the property to `false`, the entered * custom filter value will not be shown in personalization dialog and will also not be persisted in variant * management. The custom filter will also be overwritten when rebindTable is called on the SmartTable. * * @returns Value of property `enableCustomFilter` */ getEnableCustomFilter(): boolean; /** * Gets current value of property {@link #getEnableExport enableExport}. * * Enables the export of data from the `SmartTable` control to another file, for example, a spreadsheet. * If `exportType` is `sap.ui.comp.smarttable.ExportType.GW`, any `$expand` parameters are removed when * sending the request to generate the file. * To use the export functionality, the {@link sap.ui.export} library is required. * * Default value is `true`. * * @since 1.100.0 * * @returns Value of property `enableExport` */ getEnableExport(): boolean; /** * Gets current value of property {@link #getEnablePaste enablePaste}. * * Determines whether the Paste button is enabled. * * Default value is `true`. * * @since 1.96 * * @returns Value of property `enablePaste` */ getEnablePaste(): boolean; /** * Gets current value of property {@link #getEntitySet entitySet}. * * The entity set name from which to fetch data and generate the columns. Note that this is not a dynamic * UI5 property. * * **Note:** It is not allowed to have one of the following strings as field names for your OData entity: * * - `btnEditToggle` * - `btnExcelExport` * - `btnFullScreen` * - `btnPersonalisation` * - `header` * - `infoToolbarText` * - `persoController` * - `toolbarSeperator` * - `toolbarSpacer` * - `ui5table` * - `variant` * * This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.26.0 * * @returns Value of property `entitySet` */ getEntitySet(): string; /** * Gets current value of property {@link #getExportType exportType}. * * Specifies the type of export to be used in the `SmartTable` control. * * Default value is `"UI5ClientPDF"`. * * @since 1.50.0 * * @returns Value of property `exportType` */ getExportType(): sap.ui.comp.smarttable.ExportType; /** * Gets content of aggregation {@link #getFilterControlConfiguration filterControlConfiguration}. * * Allows the user to configure filters for the table personalization * * @since 1.126 */ getFilterControlConfiguration(): sap.ui.comp.config.FilterControlConfiguration[]; /** * Gets current value of property {@link #getHeader header}. * * Specifies header text that is shown in table * * @since 1.26.0 * * @returns Value of property `header` */ getHeader(): string; /** * Gets current value of property {@link #getHeaderLevel headerLevel}. * * Defines the semantic level of the header. For more information, see {@link sap.m.Title#setLevel}. * * Default value is `Auto`. * * @since 1.84 * * @returns Value of property `headerLevel` */ getHeaderLevel(): sap.ui.core.TitleLevel; /** * Gets current value of property {@link #getIgnoredFields ignoredFields}. * * Comma-separated value of fields that must be ignored in the OData metadata by the `SmartTable` control. * The `SmartTable` control will not create built-in columns for the fields defined by this property and * will not offer these fields in table personalization. * * **Note:** * * - Please ensure that you do not add spaces or special characters as no validation is done for this * property. * - This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.26.0 * * @returns Value of property `ignoredFields` */ getIgnoredFields(): string; /** * Gets current value of property {@link #getIgnoreFromPersonalisation ignoreFromPersonalisation}. * * Comma-separated value of fields that is not shown in the personalization dialog. * This property must only be used for use cases where a technical field/column is required to fetch some * data from the backend but is hidden in the table personalization and on the UI. * * **Note:** * * - Please ensure that you do not add spaces or special characters as no validation is done for this * property. * - Visible fields/columns cannot be included in this property as this is not supported by the `SmartTable` * control. * - This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.32.0 * * @returns Value of property `ignoreFromPersonalisation` */ getIgnoreFromPersonalisation(): string; /** * Gets current value of property {@link #getInitiallyVisibleFields initiallyVisibleFields}. * * Comma-separated value of fields that must be shown initially in the SmartTable as visible columns and * in the order specified. * This property is mainly meant to be used when no LineItem annotation exists. * If you have fields in the XMLView they are always shown first; then, the columns are added based on * the LineItem annotation and finally based on this property. * **Note:** * * - If both this property and the LineItem annotation exist, the order of fields cannot be guaranteed * to be as mentioned here. * - Please ensure that you do not add spaces or special characters as no validation is done for this * property. * - This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.32.0 * * @returns Value of property `initiallyVisibleFields` */ getInitiallyVisibleFields(): string; /** * Gets current value of property {@link #getInitialNoDataText initialNoDataText}. * * The text shown initially before the control is bound and initialized. The special values `$FILTERBAR` * or `$NO_FILTERBAR` can be specified to make the `SmartTable` control show the initial text as if the * `SmartFilterBar` control were associated with it. If nothing is specified, the default behavior is to * show the initial text based on whether the `SmartFilterBar` control is actually associated with the `SmartTable` * control. * * @since 1.58 * * @returns Value of property `initialNoDataText` */ getInitialNoDataText(): string; /** * Gets content of aggregation {@link #getNoData noData}. * * The value for the noData aggregation can be either a string value or a control instance. * The control is shown, in case there is no data for the Table available. In case of a string value this * will simply replace the no data text. * * * **Note:** If an `sap.m.IllustratedMessage` control is used without a title set, the SmartTable will automatically * update the illustration and text accordingly. * * @since 1.32.0 */ getNoData(): sap.ui.core.Control | string; /** * Gets current value of property {@link #getPersistencyKey persistencyKey}. * * Key used to access personalization data. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.26.0 * * @returns Value of property `persistencyKey` */ getPersistencyKey(): string; /** * Gets current value of property {@link #getPlaceToolbarInTable placeToolbarInTable}. * * Specifies whether the `Toolbar` control of the `SmartTable` is placed inside the corresponding aggregation * of the inner UI5 table control. * * Default value is `false`. * * @since 1.56 * * @returns Value of property `placeToolbarInTable` */ getPlaceToolbarInTable(): boolean; /** * Gets current value of property {@link #getRequestAtLeastFields requestAtLeastFields}. * * Comma-separated value of fields that must be always requested from the backend * This property is mainly meant to be used when there is no PresentationVariant annotation. * If both this property and the PresentationVariant annotation exist, the select request sent to the backend * would be a combination of both. * **Note:** * For `AnalyticalTable` (supported since 1.54), the following restrictions apply: * - The property name(s) must not point to a new dimension or a measure. * - The property name(s) must not point to a navigationProperty/association path, as this might not supported * by analytical services. Please ensure that you do not add spaces or special characters as no validation * is done for this property. * * @since 1.32.0 * * @returns Value of property `requestAtLeastFields` */ getRequestAtLeastFields(): string; /** * Gets content of aggregation {@link #getSemanticKeyAdditionalControl semanticKeyAdditionalControl}. * * Allows users to specify an additional control that will be added to a VBox for the first semantic key * field. * **Note:** * This property is not meant for public use. * * @since 1.38.0 */ getSemanticKeyAdditionalControl(): sap.ui.core.Control; /** * Gets content of aggregation {@link #getSemanticObjectController semanticObjectController}. * * The Semantic Object Controller allows the user to specify and overwrite functionality for semantic object * navigation. * * @since 1.28.0 */ getSemanticObjectController(): sap.ui.comp.navpopover.SemanticObjectController; /** * Gets current value of property {@link #getShowDetailsButton showDetailsButton}. * * Controls the visibility of the Show / Hide Details button for the `ResponsiveTable` scenario. * * If the available screen space gets too narrow, the columns configured with `High` and `Medium` importance * move to the pop-in area while the columns with `Low` importance are hidden. On mobile phones, the columns * with `Medium` importance are also hidden. As soon as the first column is hidden, this button appears * in the table toolbar and gives the user the possibility to toggle the visibility of the hidden columns * in the pop-in area. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * Default value is `false`. * * @since 1.79 * * @returns Value of property `showDetailsButton` */ getShowDetailsButton(): boolean; /** * Gets current value of property {@link #getShowFullScreenButton showFullScreenButton}. * * Controls the visibility of the FullScreen button. * * Default value is `false`. * * @since 1.38 * * @returns Value of property `showFullScreenButton` */ getShowFullScreenButton(): boolean; /** * Gets current value of property {@link #getShowPasteButton showPasteButton}. * * Controls the visibility of the Paste button. * * Default value is `false`. * * @since 1.91 * * @returns Value of property `showPasteButton` */ getShowPasteButton(): boolean; /** * Gets current value of property {@link #getShowRowCount showRowCount}. * * The number of rows is shown along with the header text if the property `showRowCount` is set to `true`. * * **Note:** * * - To improve your application's performance, activate the inline count for OData bindings to avoid * sending dedicated OData requests. * - If no stable overall count can be retrieved from the binding, the count will not be displayed. This * is currently the case for TreeBinding or if no count is requested by the binding. * * Default value is `true`. * * @since 1.26.0 * * @returns Value of property `showRowCount` */ getShowRowCount(): boolean; /** * Gets current value of property {@link #getShowTablePersonalisation showTablePersonalisation}. * * The showTablePersonalisation attribute can be set to true or false for controlling the visibility of * the TablePersonalisation button. * * Default value is `true`. * * @since 1.38.0 * * @returns Value of property `showTablePersonalisation` */ getShowTablePersonalisation(): boolean; /** * Gets current value of property {@link #getShowVariantManagement showVariantManagement}. * * The showVariantManagement attribute can be set to true or false for controlling the visibility of VariantManagement * button. * * Default value is `true`. * * @since 1.38.0 * * @returns Value of property `showVariantManagement` */ getShowVariantManagement(): boolean; /** * Gets current value of property {@link #getSmartFilterId smartFilterId}. * * ID of the corresponding SmartFilter control; When specified, the SmartTable searches for the SmartFilter * (also in the closest parent View) and attaches to the relevant events of the SmartFilter; to fetch data, * show overlay etc. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.26.0 * * @returns Value of property `smartFilterId` */ getSmartFilterId(): string; /** * ID of the element which is the current target of the association {@link #getSmartVariant smartVariant}, * or `null`. * * @since 1.38 */ getSmartVariant(): sap.ui.core.ID | null; /** * Returns the internally used table control. Depending on the concrete scenario, the return type is a `sap.m.Table`, * `sap.ui.table.Table`, `sap.ui.table.TreeTable`, or `sap.ui.table.AnalyticalTable`. * * If the internal table has not been initialized, the function returns `undefined`. * * * @returns The table instance or undefined */ getTable(): sap.ui.core.Control | undefined; /** * Gets current value of property {@link #getTableBindingPath tableBindingPath}. * * This attribute can be used to specify the path that is used during the binding of the table. If not specified, * the entitySet attribute is used instead. (used only if binding is established after setting this property: * initially due to enableAutoBinding -or- by subsequently calling rebindTable) * * @since 1.28.0 * * @returns Value of property `tableBindingPath` */ getTableBindingPath(): string; /** * Gets current value of property {@link #getTableType tableType}. * * Specifies the type of table to be created in the SmartTable control. * **Note:** * * - If you add a table to the content of the SmartTable in the view, this property has no effect. * - This is not a dynamic property and cannot be changed once the control has been initialized. * * @since 1.26.0 * * @returns Value of property `tableType` */ getTableType(): sap.ui.comp.smarttable.TableType; /** * Returns the `Toolbar` instance used inside the `SmartTable` control. * * @since 1.56 * * @returns The `Toolbar` instance */ getToolbar(): sap.m.Toolbar; /** * Gets current value of property {@link #getToolbarStyleClass toolbarStyleClass}. * * A style class which is defined for the toolbar of the table. * * @since 1.26.0 * * @returns Value of property `toolbarStyleClass` */ getToolbarStyleClass(): string; /** * Returns the current UI state of the `SmartTable` control. * **Note:** * The following restrictions apply: * - Visualizations can only be used to modify the visibility, order, and width of columns, the template * or importance of the column cannot be changed * - MaxItems is not supported * - RequestAtLeast contains values that are combined from both the `SmartTable` control property and * PresentationVariant annotation, but when it is updated it only affects the internal array. The property * in the `SmartTable` stays the same as before * - Changes to RequestAtLeast alone will not lead to a new data request * - RequestAtLeast is not supported in `AnalyticalTable` scenario * - Support for column width changes is enabled as of version 1.98. * - Any other restrictions, like the ones mentioned in {@link sap.ui.comp.state.UIState}, also apply * * * @since 1.52 * * @returns Current UI state */ getUiState(): sap.ui.comp.state.UIState; /** * Gets current value of property {@link #getUseColumnLabelsAsTooltips useColumnLabelsAsTooltips}. * * If no tooltips have been provided, neither by the `QuickInfo` annotation nor for custom columns directly * via property, the column label will automatically be applied as a tooltip for the column. * * To enable this mechanism for custom columns, a `sap.m.Label` or `sap.m.Text` must be used as header label. * Custom tooltips are not affected by this functionality when they are provided on the column header label * for tables of type `ResponsiveTable` and on the column for other table types. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * Default value is `true`. * * @since 1.114.0 * * @returns Value of property `useColumnLabelsAsTooltips` */ getUseColumnLabelsAsTooltips(): boolean; /** * Gets current value of property {@link #getUseDateRangeType useDateRangeType}. * * If set to `true`, all date fields in the Filter Panel of the settings dialog with filter restriction * `interval` will be treated as `DateTimeRange` filters. The `useDateRangeType` can be set only once during * initialization. **Note:** If this property is set to `true` and any date filters with filter restriction * `interval` were stored as part of a variant, the values of these filters cannot be applied. If this property * is set to `false`, any previously stored filters which were treated as type `DateTimeRange` based on * the former setting, cannot be converted back to the standard date interval. * * Default value is `false`. * * @since 1.126.0 * * @returns Value of property `useDateRangeType` */ getUseDateRangeType(): boolean; /** * Gets current value of property {@link #getUseExportToExcel useExportToExcel}. * * Can be set to true or false depending on whether you want to export data to a spreadsheet application, * for example Microsoft Excel. * **Note:** * If `exportType` is `sap.ui.comp.smarttable.ExportType.GW`, any $expand parameters are removed when sending * the request to generate the spreadsheet. * As of UI5 version 1.56: If `exportType` is `sap.ui.comp.smarttable.ExportType.UI5Client` and `TreeTable` * is used, the `worksheet.hierarchyLevel` property (see {@link sap.ui.export.Spreadsheet}) is filled from * the binding, if the relevant information is available there for exporting hierarchical data in the spreadsheet. * * Default value is `true`. * * @since 1.26.0 * @deprecated As of version 1.100. replaced by `enableExport` property. * * @returns Value of property `useExportToExcel` */ getUseExportToExcel(): boolean; /** * Gets current value of property {@link #getUseInfoToolbar useInfoToolbar}. * * Shows an info toolbar. * Filters that are applied using the table personalization dialog are shown in the info toolbar. * **Note:** * * - The default value for the property is `Auto`, which means that the info toolbar is shown by default * if table type is `ResponsiveTable`. * - The info toolbar is hidden if the property is set to `Off`. * - The info toolbar is visible if the property is set to `On`. Currently the info toolbar is only available * for the table type `ResponsiveTable`. * - If multiple filters are applied to the same column, then the info toolbar contains the column name * only once. * - In case there is a custom info toolbar used for the responsive table control, then the property must * be set to `Off`. Otherwise, an error is logged in the browser console. * * Default value is `Auto`. * * @since 1.70 * * @returns Value of property `useInfoToolbar` */ getUseInfoToolbar(): sap.ui.comp.smarttable.InfoToolbarBehavior; /** * Gets current value of property {@link #getUseOnlyOneSolidToolbar useOnlyOneSolidToolbar}. * * If set to true, the standard toolbar and custom toolbar will be merged into one toolbar. The combined * toolbar will have a solid style. * * Default value is `false`. * * @since 1.26.0 * @deprecated As of version 1.29. This property has no effect * * @returns Value of property `useOnlyOneSolidToolbar` */ getUseOnlyOneSolidToolbar(): boolean; /** * Gets current value of property {@link #getUseTablePersonalisation useTablePersonalisation}. * * The `useTablePersonalisation` attribute can be set to true or false depending on whether you want to * define personalized table settings. If you want to persist the table personalization, you need to specify * the persistencyKey property. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * Default value is `true`. * * @since 1.26.0 * * @returns Value of property `useTablePersonalisation` */ getUseTablePersonalisation(): boolean; /** * Gets current value of property {@link #getUseVariantManagement useVariantManagement}. * * The useVariantManagement attribute can be set to true or false depending on whether you want to use variants. * As a prerequisite you need to specify the persistencyKey property. * * Default value is `true`. * * @since 1.26.0 * * @returns Value of property `useVariantManagement` */ getUseVariantManagement(): boolean; /** * Checks for the provided `sap.ui.comp.config.FilterControlConfiguration` in the aggregation {@link #getFilterControlConfiguration filterControlConfiguration}. * and returns its index if found or -1 otherwise. * * @since 1.126 * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfFilterControlConfiguration( /** * The filterControlConfiguration whose index is looked for */ oFilterControlConfiguration: sap.ui.comp.config.FilterControlConfiguration ): int; /** * Inserts a filterControlConfiguration into the aggregation {@link #getFilterControlConfiguration filterControlConfiguration}. * * @since 1.126 * * @returns Reference to `this` in order to allow method chaining */ insertFilterControlConfiguration( /** * The filterControlConfiguration to insert; if empty, nothing is inserted */ oFilterControlConfiguration: sap.ui.comp.config.FilterControlConfiguration, /** * The `0`-based index the filterControlConfiguration should be inserted at; for a negative value of `iIndex`, * the filterControlConfiguration is inserted at position 0; for a value greater than the current size of * the aggregation, the filterControlConfiguration is inserted at the last position */ iIndex: int ): this; /** * Checks whether the control is initialised * * * @returns returns whether control is already initialised */ isInitialised(): boolean; /** * Opens the desired panel of the personalization dialog. * Note: Calling this for panels that are globally hidden (E.g. manually by the application, or * due to unavailability of functionality) leads to an empty dialog being shown. * * @since 1.48.0 */ openPersonalisationDialog( /** * The desired panel; the value is either "Columns", "Sort", "Filter" or "Group" */ sPanel: string ): void; /** * This can be used to trigger binding on the table used in the SmartTable */ rebindTable( /** * force bind call to be triggered on the inner table */ bForceRebind: boolean ): void; /** * Removes all the controls from the aggregation {@link #getFilterControlConfiguration filterControlConfiguration}. * * Additionally, it unregisters them from the hosting UIArea. * * @since 1.126 * * @returns An array of the removed elements (might be empty) */ removeAllFilterControlConfiguration(): sap.ui.comp.config.FilterControlConfiguration[]; /** * Removes a filterControlConfiguration from the aggregation {@link #getFilterControlConfiguration filterControlConfiguration}. * * @since 1.126 * * @returns The removed filterControlConfiguration or `null` */ removeFilterControlConfiguration( /** * The filterControlConfiguration to remove or its index or id */ vFilterControlConfiguration: | int | string | sap.ui.comp.config.FilterControlConfiguration ): sap.ui.comp.config.FilterControlConfiguration | null; /** * Sets the aggregated {@link #getCopyProvider copyProvider}. * * @since 1.114 * * @returns Reference to `this` in order to allow method chaining */ setCopyProvider( /** * The copyProvider to set */ oCopyProvider: sap.m.plugins.CopyProvider ): this; /** * Set the current variant according to the sVariantId. In case an empty string or null or undefined was * passed the STANDARD will be set. STANDARD will also be set, in case the passed sVariantId could not be * found. In case neither a flexibility variant, nor the content for the standard variant could not be obtained, * nor the personalisable control obtained nothing will be executed/changed * * * @returns the control instance */ setCurrentVariantId( /** * id of the currently selected variant */ sVariantId: string ): object; /** * Sets a new value for property {@link #getCustomizeConfig customizeConfig}. * * Provides customization to the columns/cell templates generated by the `SmartTable` control. * * List of supported settings for the `customizeConfig` property: * - `textInEditModeSource`: For more information, see {@link sap.ui.comp.smartfield.SmartField#setTextInEditModeSource } * * - `insertIgnoreRestrictions`: The `customData` setting for the `sap.ui.comp.smartfield.SmartField` * control. Supported as of version 1.103. * - `autoColumnWidth`: This property can be used to influence the column width calculation for columns * generated by the `SmartTable` control itself. The supported configuration settings are `truncateLabel`, * `min`, `max`, and `gap`. Supported as of version 1.108. For more information, see {@link sap.ui.comp.smarttable.SmartTable#getEnableAutoColumnWidth}. * * - `clientSideMandatoryCheck`: For more information, see {@link sap.ui.comp.smartfield.SmartField#setClientSideMandatoryCheck}. * Supported as of version 1.111 Examples for the `customizeConfig` property to change the * `textInEditModeSource` for the default `smartField` * ```javascript * * * * ``` * * ```javascript * * * * ``` * * ```javascript * * * * ``` * * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.97.0 * * @returns Reference to `this` in order to allow method chaining */ setCustomizeConfig( /** * New value for property `customizeConfig` */ oCustomizeConfig?: object ): this; /** * Sets the aggregated {@link #getCustomToolbar customToolbar}. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setCustomToolbar( /** * The customToolbar to set */ oCustomToolbar: sap.m.Toolbar ): this; /** * Sets the aggregated {@link #getDataStateIndicator dataStateIndicator}. * * @since 1.89 * * @returns Reference to `this` in order to allow method chaining */ setDataStateIndicator( /** * The dataStateIndicator to set */ oDataStateIndicator: sap.m.plugins.DataStateIndicator ): this; /** * Sets the aggregated {@link #getDefaultExportSettings defaultExportSettings}. * * @since 1.148 * * @returns Reference to `this` in order to allow method chaining */ setDefaultExportSettings( /** * The defaultExportSettings to set */ oDefaultExportSettings: sap.ui.export.TableExportSettings ): this; /** * Sets a new value for property {@link #getDemandPopin demandPopin}. * * The demandPopin attribute can be set to true or false depending on whether you want to display columns * as popins on the responsive table * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.30.0 * * @returns Reference to `this` in order to allow method chaining */ setDemandPopin( /** * New value for property `demandPopin` */ bDemandPopin?: boolean ): this; /** * Sets a new value for property {@link #getDetailsButtonSetting detailsButtonSetting}. * * Defines which columns should be hidden instead of moved into the pop-in area depending on their importance. * See {@link sap.m.Column#getImportance} and {@link sap.m.Table#getHiddenInPopin} for more details. * * **Note:** To hide columns based on their importance, it's mandatory to set `showDetailsButton="true"`. * If no priority is given, the default configuration of {@link sap.ui.comp.smarttable.SmartTable#getShowDetailsButton } * is used. If this property is changed after the `SmartTable` has been initialized, the new changes take * effect only when the Show / Hide Details button is pressed a second time. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.86 * * @returns Reference to `this` in order to allow method chaining */ setDetailsButtonSetting( /** * New value for property `detailsButtonSetting` */ sDetailsButtonSetting: sap.ui.core.Priority[] ): this; /** * Sets a new value for property {@link #getEditable editable}. * * This attribute can be used to specify if the controls created by the SmartTable control are editable. * (The automatic toggle of controls works only for the SmartField/SmartToggle scenario) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setEditable( /** * New value for property `editable` */ bEditable?: boolean ): this; /** * Sets a new value for property {@link #getEditTogglable editTogglable}. * * Specifies whether the editable property can be toggled via a button on the toolbar. (The automatic toggle * of controls works only for the SmartField/SmartToggle scenario) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setEditTogglable( /** * New value for property `editTogglable` */ bEditTogglable?: boolean ): this; /** * Sets a new value for property {@link #getEnableAutoBinding enableAutoBinding}. * * When set to true, this enables automatic binding of the table using the tableBindingPath (if it exists) * or entitySet property. This happens just after the `initialise` event has been fired. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setEnableAutoBinding( /** * New value for property `enableAutoBinding` */ bEnableAutoBinding?: boolean ): this; /** * Sets a new value for property {@link #getEnableAutoColumnWidth enableAutoColumnWidth}. * * Enables heuristic column width calculation for all supported table types based on metadata information * when set to `true`. The column width calculation takes OData type, column label, text arrangement, possible * cell templates, additional fields and many other metadata parameters into account. Providing more precise * `MaxLength` value for the `Edm.String` type or `precision` value for numeric OData types can help this * algorithm to produce better results. The calculated column widths can have a minimum of 3rem and a maximum * of 20rem. To avoid the heuristic column width calculation for a particular column, the {@link #annotation:CssDefaults CssDefaults } * annotation can be used. * * If `tableType="ResponsiveTable"`, the following changes are applied: * - {@link #getDemandPopin demandPopin} property of the `SmartTable` is set to `true`. * - {@link sap.m.Table#getFixedLayout fixedLayout} property of the inner table is set to `Strict`. * - {@link sap.m.Table#getContextualWidth contextualWidth} property of the inner table is set to `Auto`. * * - Column resizing feature gets enabled and the wrapping of column headers get disabled for all columns, * including custom columns. Those properties must not be managed by the application. * * * * By default, this feature has no effect on custom columns. To enable heuristic column width calculation * also for custom columns, the `autoColumnWidth` property must be specified in the `p13nData` custom data. * **Note:** The automatic column width calculation for custom columns works only when the `width` property * of the custom column is not set. * **Note:** The custom columns can have unexpected cell templates that might affect the result of the * column width calculation, for example, an `Edm.Byte` field that can only have three digits might be visualized * as a `sap.m.RatingIndicator` that requires more space. * **Note:** Defining the `leadingProperty` and a unique `columnKey` in the `p13nData` custom data is a * prerequisite for all other `p13nData` properties, including the `autoColumnWidth` property. * Examples with `autoColumnWidth` property of the `p13nData` custom data * ```javascript * * * * ``` * * ```javascript * * * * ``` * * ```javascript * * * * ``` * * ```javascript * * * * ``` * * ```javascript * * * * ``` * * * **Note:** * The `enableAutoColumnWidth` is not a dynamic property and cannot be changed once the control has been * initialized. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.86 * * @returns Reference to `this` in order to allow method chaining */ setEnableAutoColumnWidth( /** * New value for property `enableAutoColumnWidth` */ bEnableAutoColumnWidth?: boolean ): this; /** * Sets a new value for property {@link #getEnableCopy enableCopy}. * * Enables the copy-to-clipboard functionality of the `SmartTable` control. * * When set to `true`, a {@link sap.m.plugins.CopyProvider} and a {@link sap.m.plugins.CellSelector} are * automatically created and added to the `SmartTable` control if a custom `CopyProvider` or `CellSelector` * are not already used by the application. When set to `false`, these created code>CopyProvider * and `CellSelector` plugins are removed again. * * **Note:** * We recommend that you set the `enableCopy` property to `false` in the following cases: * - The copy-to-clipboard functionality is not desired * - Plugins with property settings other than the default ones should be used * - Only one of the plugins should be used * - The functionality conflicts with the concrete application scenario, for example, custom columns with * special content * - The functionality conflicts with the known restrictions of the `CopyProvider` and `CellSelector` * plugins * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.124.0 * * @returns Reference to `this` in order to allow method chaining */ setEnableCopy( /** * New value for property `enableCopy` */ bEnableCopy?: boolean ): this; /** * Sets a new value for property {@link #getEnableCustomFilter enableCustomFilter}. * * Can be used to override the filter behavior. If set to true (default), instead of the filter input box * a button is rendered. When pressing this button, the SmartTable control opens the filter panel directly * in the table personalization dialog. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.26.0 * @deprecated As of version 1.40.0. After personalization dialog has been introduced in SmartTable the * property `enableCustomFilter` does not make sense. When setting the property to `false`, the entered * custom filter value will not be shown in personalization dialog and will also not be persisted in variant * management. The custom filter will also be overwritten when rebindTable is called on the SmartTable. * * @returns Reference to `this` in order to allow method chaining */ setEnableCustomFilter( /** * New value for property `enableCustomFilter` */ bEnableCustomFilter?: boolean ): this; /** * Sets the `exportEnable` property that enables the export of data. The export type can be defined using * the `exportType` property. * * @since 1.100.0 * * @returns Reference to this in order to allow method chaining */ setEnableExport( /** * New value for property enableExport */ bValue: boolean ): sap.ui.comp.smarttable.SmartTable; /** * Sets a new value for the `enablePaste` property. * * * @returns SmartTable control instance */ setEnablePaste( /** * New value for property enablePaste */ bValue: boolean ): sap.ui.comp.smarttable.SmartTable; /** * The entity set name from OData metadata, with which the table should be bound to * * * @returns the control instance */ setEntitySet( /** * The entity set */ sEntitySetName: string ): object; /** * Sets a new value for property {@link #getExportType exportType}. * * Specifies the type of export to be used in the `SmartTable` control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"UI5ClientPDF"`. * * @since 1.50.0 * * @returns Reference to `this` in order to allow method chaining */ setExportType( /** * New value for property `exportType` */ sExportType?: sap.ui.comp.smarttable.ExportType ): this; /** * Sets a new value for property {@link #getHeader header}. * * Specifies header text that is shown in table * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setHeader( /** * New value for property `header` */ sHeader?: string ): this; /** * Sets the value for the `headerLevel` property. * * * @returns Reference to this in order to allow method chaining */ setHeaderLevel( /** * The level that is set to the header */ sLevel: string ): sap.ui.comp.smarttable.SmartTable; /** * Sets the value for the `headerStyle` property. * * * @returns Reference to `this` in order to allow method chaining */ setHeaderStyle( /** * The style that is set to the header */ sStyle: string ): sap.ui.comp.smarttable.SmartTable; /** * Sets a new value for property {@link #getIgnoredFields ignoredFields}. * * Comma-separated value of fields that must be ignored in the OData metadata by the `SmartTable` control. * The `SmartTable` control will not create built-in columns for the fields defined by this property and * will not offer these fields in table personalization. * * **Note:** * * - Please ensure that you do not add spaces or special characters as no validation is done for this * property. * - This is not a dynamic property and cannot be changed once the control has been initialized. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setIgnoredFields( /** * New value for property `ignoredFields` */ sIgnoredFields?: string ): this; /** * Sets a new value for property {@link #getIgnoreFromPersonalisation ignoreFromPersonalisation}. * * Comma-separated value of fields that is not shown in the personalization dialog. * This property must only be used for use cases where a technical field/column is required to fetch some * data from the backend but is hidden in the table personalization and on the UI. * * **Note:** * * - Please ensure that you do not add spaces or special characters as no validation is done for this * property. * - Visible fields/columns cannot be included in this property as this is not supported by the `SmartTable` * control. * - This is not a dynamic property and cannot be changed once the control has been initialized. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.32.0 * * @returns Reference to `this` in order to allow method chaining */ setIgnoreFromPersonalisation( /** * New value for property `ignoreFromPersonalisation` */ sIgnoreFromPersonalisation?: string ): this; /** * Sets a new value for property {@link #getInitiallyVisibleFields initiallyVisibleFields}. * * Comma-separated value of fields that must be shown initially in the SmartTable as visible columns and * in the order specified. * This property is mainly meant to be used when no LineItem annotation exists. * If you have fields in the XMLView they are always shown first; then, the columns are added based on * the LineItem annotation and finally based on this property. * **Note:** * * - If both this property and the LineItem annotation exist, the order of fields cannot be guaranteed * to be as mentioned here. * - Please ensure that you do not add spaces or special characters as no validation is done for this * property. * - This is not a dynamic property and cannot be changed once the control has been initialized. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.32.0 * * @returns Reference to `this` in order to allow method chaining */ setInitiallyVisibleFields( /** * New value for property `initiallyVisibleFields` */ sInitiallyVisibleFields?: string ): this; /** * Sets a new value for property {@link #getInitialNoDataText initialNoDataText}. * * The text shown initially before the control is bound and initialized. The special values `$FILTERBAR` * or `$NO_FILTERBAR` can be specified to make the `SmartTable` control show the initial text as if the * `SmartFilterBar` control were associated with it. If nothing is specified, the default behavior is to * show the initial text based on whether the `SmartFilterBar` control is actually associated with the `SmartTable` * control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.58 * * @returns Reference to `this` in order to allow method chaining */ setInitialNoDataText( /** * New value for property `initialNoDataText` */ sInitialNoDataText?: string ): this; /** * Sets the aggregated {@link #getNoData noData}. * * @since 1.32.0 * * @returns Reference to `this` in order to allow method chaining */ setNoData( /** * The noData to set */ vNoData: sap.ui.core.Control | string ): this; /** * Sets a new value for property {@link #getPersistencyKey persistencyKey}. * * Key used to access personalization data. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setPersistencyKey( /** * New value for property `persistencyKey` */ sPersistencyKey?: string ): this; /** * Sets a new value for property {@link #getPlaceToolbarInTable placeToolbarInTable}. * * Specifies whether the `Toolbar` control of the `SmartTable` is placed inside the corresponding aggregation * of the inner UI5 table control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.56 * * @returns Reference to `this` in order to allow method chaining */ setPlaceToolbarInTable( /** * New value for property `placeToolbarInTable` */ bPlaceToolbarInTable?: boolean ): this; /** * Sets a new value for property {@link #getRequestAtLeastFields requestAtLeastFields}. * * Comma-separated value of fields that must be always requested from the backend * This property is mainly meant to be used when there is no PresentationVariant annotation. * If both this property and the PresentationVariant annotation exist, the select request sent to the backend * would be a combination of both. * **Note:** * For `AnalyticalTable` (supported since 1.54), the following restrictions apply: * - The property name(s) must not point to a new dimension or a measure. * - The property name(s) must not point to a navigationProperty/association path, as this might not supported * by analytical services. Please ensure that you do not add spaces or special characters as no validation * is done for this property. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.32.0 * * @returns Reference to `this` in order to allow method chaining */ setRequestAtLeastFields( /** * New value for property `requestAtLeastFields` */ sRequestAtLeastFields?: string ): this; /** * Sets the aggregated {@link #getSemanticKeyAdditionalControl semanticKeyAdditionalControl}. * * @since 1.38.0 * * @returns Reference to `this` in order to allow method chaining */ setSemanticKeyAdditionalControl( /** * The semanticKeyAdditionalControl to set */ oSemanticKeyAdditionalControl: sap.ui.core.Control ): this; /** * Sets the aggregated {@link #getSemanticObjectController semanticObjectController}. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setSemanticObjectController( /** * The semanticObjectController to set */ oSemanticObjectController: sap.ui.comp.navpopover.SemanticObjectController ): this; /** * Sets a new value for property {@link #getShowDetailsButton showDetailsButton}. * * Controls the visibility of the Show / Hide Details button for the `ResponsiveTable` scenario. * * If the available screen space gets too narrow, the columns configured with `High` and `Medium` importance * move to the pop-in area while the columns with `Low` importance are hidden. On mobile phones, the columns * with `Medium` importance are also hidden. As soon as the first column is hidden, this button appears * in the table toolbar and gives the user the possibility to toggle the visibility of the hidden columns * in the pop-in area. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.79 * * @returns Reference to `this` in order to allow method chaining */ setShowDetailsButton( /** * New value for property `showDetailsButton` */ bShowDetailsButton?: boolean ): this; /** * Sets a new value for property {@link #getShowFullScreenButton showFullScreenButton}. * * Controls the visibility of the FullScreen button. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.38 * * @returns Reference to `this` in order to allow method chaining */ setShowFullScreenButton( /** * New value for property `showFullScreenButton` */ bShowFullScreenButton?: boolean ): this; /** * Sets a new value for property {@link #getShowPasteButton showPasteButton}. * * Controls the visibility of the Paste button. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.91 * * @returns Reference to `this` in order to allow method chaining */ setShowPasteButton( /** * New value for property `showPasteButton` */ bShowPasteButton?: boolean ): this; /** * Sets a new value for property {@link #getShowRowCount showRowCount}. * * The number of rows is shown along with the header text if the property `showRowCount` is set to `true`. * * **Note:** * * - To improve your application's performance, activate the inline count for OData bindings to avoid * sending dedicated OData requests. * - If no stable overall count can be retrieved from the binding, the count will not be displayed. This * is currently the case for TreeBinding or if no count is requested by the binding. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setShowRowCount( /** * New value for property `showRowCount` */ bShowRowCount?: boolean ): this; /** * Sets a new value for property {@link #getShowTablePersonalisation showTablePersonalisation}. * * The showTablePersonalisation attribute can be set to true or false for controlling the visibility of * the TablePersonalisation button. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.38.0 * * @returns Reference to `this` in order to allow method chaining */ setShowTablePersonalisation( /** * New value for property `showTablePersonalisation` */ bShowTablePersonalisation?: boolean ): this; /** * Sets a new value for property {@link #getShowVariantManagement showVariantManagement}. * * The showVariantManagement attribute can be set to true or false for controlling the visibility of VariantManagement * button. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.38.0 * * @returns Reference to `this` in order to allow method chaining */ setShowVariantManagement( /** * New value for property `showVariantManagement` */ bShowVariantManagement?: boolean ): this; /** * Sets a new value for property {@link #getSmartFilterId smartFilterId}. * * ID of the corresponding SmartFilter control; When specified, the SmartTable searches for the SmartFilter * (also in the closest parent View) and attaches to the relevant events of the SmartFilter; to fetch data, * show overlay etc. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setSmartFilterId( /** * New value for property `smartFilterId` */ sSmartFilterId?: string ): this; /** * Sets the associated {@link #getSmartVariant smartVariant}. * * @since 1.38 * * @returns Reference to `this` in order to allow method chaining */ setSmartVariant( /** * ID of an element which becomes the new target of this smartVariant association; alternatively, an element * instance may be given */ oSmartVariant: sap.ui.core.ID | sap.ui.core.Control ): this; /** * Sets a new value for property {@link #getTableBindingPath tableBindingPath}. * * This attribute can be used to specify the path that is used during the binding of the table. If not specified, * the entitySet attribute is used instead. (used only if binding is established after setting this property: * initially due to enableAutoBinding -or- by subsequently calling rebindTable) * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setTableBindingPath( /** * New value for property `tableBindingPath` */ sTableBindingPath?: string ): this; /** * Sets a new value for property {@link #getTableType tableType}. * * Specifies the type of table to be created in the SmartTable control. * **Note:** * * - If you add a table to the content of the SmartTable in the view, this property has no effect. * - This is not a dynamic property and cannot be changed once the control has been initialized. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setTableType( /** * New value for property `tableType` */ sTableType?: sap.ui.comp.smarttable.TableType ): this; /** * Sets a new value for property {@link #getToolbarStyleClass toolbarStyleClass}. * * A style class which is defined for the toolbar of the table. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setToolbarStyleClass( /** * New value for property `toolbarStyleClass` */ sToolbarStyleClass?: string ): this; /** * Replaces the current UI state of the `SmartTable` control with the data represented in {@link sap.ui.comp.state.UIState}. * **Note:** * The following restrictions apply: * - Visualizations can only be used to modify the visibility, order, and width of columns, the template * or importance of the column cannot be changed * - MaxItems is not supported * - RequestAtLeast contains values that are combined from both the `SmartTable` control property and * PresentationVariant annotation, but when it is updated it only affects the internal array. The property * in the `SmartTable` stays the same as before * - Changes to RequestAtLeast alone will not lead to a new data request * - RequestAtLeast is not supported in `AnalyticalTable` scenario * - Support for column width changes is enabled as of version 1.98. * - Any other restrictions, like the ones mentioned in {@link sap.ui.comp.state.UIState}, also apply * * * @since 1.52 */ setUiState( /** * the new representation of UI state */ oUIState: sap.ui.comp.state.UIState ): void; /** * Sets a new value for property {@link #getUseColumnLabelsAsTooltips useColumnLabelsAsTooltips}. * * If no tooltips have been provided, neither by the `QuickInfo` annotation nor for custom columns directly * via property, the column label will automatically be applied as a tooltip for the column. * * To enable this mechanism for custom columns, a `sap.m.Label` or `sap.m.Text` must be used as header label. * Custom tooltips are not affected by this functionality when they are provided on the column header label * for tables of type `ResponsiveTable` and on the column for other table types. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.114.0 * * @returns Reference to `this` in order to allow method chaining */ setUseColumnLabelsAsTooltips( /** * New value for property `useColumnLabelsAsTooltips` */ bUseColumnLabelsAsTooltips?: boolean ): this; /** * Sets a new value for property {@link #getUseDateRangeType useDateRangeType}. * * If set to `true`, all date fields in the Filter Panel of the settings dialog with filter restriction * `interval` will be treated as `DateTimeRange` filters. The `useDateRangeType` can be set only once during * initialization. **Note:** If this property is set to `true` and any date filters with filter restriction * `interval` were stored as part of a variant, the values of these filters cannot be applied. If this property * is set to `false`, any previously stored filters which were treated as type `DateTimeRange` based on * the former setting, cannot be converted back to the standard date interval. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.126.0 * * @returns Reference to `this` in order to allow method chaining */ setUseDateRangeType( /** * New value for property `useDateRangeType` */ bUseDateRangeType?: boolean ): this; /** * Sets the `useExportToExcel` property which enables export of data. The export type can be defined using * `exportType` property. * * @deprecated As of version 1.100. replaced by {@link #setEnableExport}. * * @returns Reference to this in order to allow method chaining */ setUseExportToExcel( /** * New value for property useExportToExcel */ bValue: boolean ): sap.ui.comp.smarttable.SmartTable; /** * Sets a new value for property {@link #getUseInfoToolbar useInfoToolbar}. * * Shows an info toolbar. * Filters that are applied using the table personalization dialog are shown in the info toolbar. * **Note:** * * - The default value for the property is `Auto`, which means that the info toolbar is shown by default * if table type is `ResponsiveTable`. * - The info toolbar is hidden if the property is set to `Off`. * - The info toolbar is visible if the property is set to `On`. Currently the info toolbar is only available * for the table type `ResponsiveTable`. * - If multiple filters are applied to the same column, then the info toolbar contains the column name * only once. * - In case there is a custom info toolbar used for the responsive table control, then the property must * be set to `Off`. Otherwise, an error is logged in the browser console. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Auto`. * * @since 1.70 * * @returns Reference to `this` in order to allow method chaining */ setUseInfoToolbar( /** * New value for property `useInfoToolbar` */ sUseInfoToolbar?: sap.ui.comp.smarttable.InfoToolbarBehavior ): this; /** * Sets a new value for property {@link #getUseOnlyOneSolidToolbar useOnlyOneSolidToolbar}. * * If set to true, the standard toolbar and custom toolbar will be merged into one toolbar. The combined * toolbar will have a solid style. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.26.0 * @deprecated As of version 1.29. This property has no effect * * @returns Reference to `this` in order to allow method chaining */ setUseOnlyOneSolidToolbar( /** * New value for property `useOnlyOneSolidToolbar` */ bUseOnlyOneSolidToolbar?: boolean ): this; /** * Sets a new value for property {@link #getUseTablePersonalisation useTablePersonalisation}. * * The `useTablePersonalisation` attribute can be set to true or false depending on whether you want to * define personalized table settings. If you want to persist the table personalization, you need to specify * the persistencyKey property. * * **Note:** * This is not a dynamic property and cannot be changed once the control has been initialized. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setUseTablePersonalisation( /** * New value for property `useTablePersonalisation` */ bUseTablePersonalisation?: boolean ): this; /** * Sets a new value for property {@link #getUseVariantManagement useVariantManagement}. * * The useVariantManagement attribute can be set to true or false depending on whether you want to use variants. * As a prerequisite you need to specify the persistencyKey property. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setUseVariantManagement( /** * New value for property `useVariantManagement` */ bUseVariantManagement?: boolean ): this; /** * This can be called once data is received to update table header (count) and toolbar buttons(e.g. Excel * Export) enabled state */ updateTableHeaderState(): void; } /** * Provides the type of services available for export in the `SmartTable` control. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smarttable.ExportType'. */ enum ExportType { /** * Gateway backend spreadsheet export service is used * * @deprecated As of version 1.120. */ GW = "GW", /** * UI5 client-side spreadsheet export service is used */ UI5Client = "UI5Client", /** * UI5 client-side spreadsheet export service is used along with Gateway backend PDF export service. * * @since 1.100 */ UI5ClientPDF = "UI5ClientPDF", } /** * Enumeration `sap.ui.comp.smarttable.InfoToolbarBehavior` determines the behavior of the info toolbar * in the `SmartTable` control. * * The info toolbar represents the filters that are applied using the table personalization dialog. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smarttable.InfoToolbarBehavior'. * * @since 1.70 */ enum InfoToolbarBehavior { /** * The info toolbar is rendered for the `SmartTable` control of table type `ResponsiveTable` only. */ Auto = "Auto", /** * The info toolbar is not rendered. */ Off = "Off", /** * The info toolbar is rendered for the `SmartTable` control regardless of the table type. */ On = "On", } /** * Provides enumeration sap.ui.comp.smarttable.TableType. A subset of table types that fit to a simple API * returning one string. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smarttable.TableType'. */ enum TableType { /** * An analytical table (sap.ui.table.AnalyticalTable) control shall be created as the content of the SmartTable, * if no table already exists */ AnalyticalTable = "AnalyticalTable", /** * A responsive table (sap.m.Table) control that can be used on mobile devices shall be created as the content * of the SmartTable, if no table already exists */ ResponsiveTable = "ResponsiveTable", /** * A table (sap.ui.table.Table) control shall be created as the content of the SmartTable, if no table already * exists (default) */ Table = "Table", /** * A tree table (sap.ui.table.TreeTable) control shall be created as the content of the SmartTable, if no * table already exists */ TreeTable = "TreeTable", } /** * Paste-related column information * * @since 1.125 */ type ColumnInfoForPaste = { /** * ID of the column */ columnId: string; /** * Data property that is used when pasting data */ property: string; /** * Defines whether the column is ignored during pasting */ ignore: boolean; /** * The type instance that is used to parse the pasted value */ type: sap.ui.model.SimpleType; /** * Function that is used to parse the pasted value if no type instance is available (for example, for custom * columns) */ customParseFunction?: Function; }; /** * Event object of the SmartTable#afterVariantApply event. */ type SmartTable$AfterVariantApplyEvent = sap.ui.base.Event< SmartTable$AfterVariantApplyEventParameters, SmartTable >; /** * Event object of the SmartTable#afterVariantInitialise event. */ type SmartTable$AfterVariantInitialiseEvent = sap.ui.base.Event< SmartTable$AfterVariantInitialiseEventParameters, SmartTable >; /** * Event object of the SmartTable#afterVariantSave event. */ type SmartTable$AfterVariantSaveEvent = sap.ui.base.Event< SmartTable$AfterVariantSaveEventParameters, SmartTable >; /** * Event object of the SmartTable#beforeExport event. */ type SmartTable$BeforeExportEvent = sap.ui.base.Event< SmartTable$BeforeExportEventParameters, SmartTable >; /** * Event object of the SmartTable#beforePaste event. */ type SmartTable$BeforePasteEvent = sap.ui.base.Event< SmartTable$BeforePasteEventParameters, SmartTable >; /** * Event object of the SmartTable#beforeRebindTable event. */ type SmartTable$BeforeRebindTableEvent = sap.ui.base.Event< SmartTable$BeforeRebindTableEventParameters, SmartTable >; /** * Event object of the SmartTable#changeModelValue event. */ type SmartTable$ChangeModelValueEvent = sap.ui.base.Event< SmartTable$ChangeModelValueEventParameters, SmartTable >; /** * Event object of the SmartTable#dataReceived event. * * @deprecated As of version 1.56. Use `beforeRebindTable` event to attach/listen to the binding "events" * directly */ type SmartTable$DataReceivedEvent = sap.ui.base.Event< SmartTable$DataReceivedEventParameters, SmartTable >; /** * Event object of the SmartTable#dataRequested event. * * @deprecated As of version 1.56. Use `beforeRebindTable` event to attach/listen to the binding "events" * directly */ type SmartTable$DataRequestedEvent = sap.ui.base.Event< SmartTable$DataRequestedEventParameters, SmartTable >; /** * Event object of the SmartTable#editToggled event. */ type SmartTable$EditToggledEvent = sap.ui.base.Event< SmartTable$EditToggledEventParameters, SmartTable >; /** * Event object of the SmartTable#fieldChange event. */ type SmartTable$FieldChangeEvent = sap.ui.base.Event< SmartTable$FieldChangeEventParameters, SmartTable >; /** * Event object of the SmartTable#fullScreenToggled event. */ type SmartTable$FullScreenToggledEvent = sap.ui.base.Event< SmartTable$FullScreenToggledEventParameters, SmartTable >; /** * Event object of the SmartTable#initialise event. */ type SmartTable$InitialiseEvent = sap.ui.base.Event< SmartTable$InitialiseEventParameters, SmartTable >; /** * Event object of the SmartTable#paste event. */ type SmartTable$PasteEvent = sap.ui.base.Event< SmartTable$PasteEventParameters, SmartTable >; /** * Event object of the SmartTable#showOverlay event. */ type SmartTable$ShowOverlayEvent = sap.ui.base.Event< SmartTable$ShowOverlayEventParameters, SmartTable >; /** * Event object of the SmartTable#uiStateChange event. */ type SmartTable$UiStateChangeEvent = sap.ui.base.Event< SmartTable$UiStateChangeEventParameters, SmartTable >; } namespace smartvariants { /** * Describes the settings that can be provided to the PersonalizableInfo constructor. */ interface $PersonalizableInfoSettings extends sap.ui.core.$ElementSettings { /** * Describes the type of variant management. */ type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Name of the data service */ dataSource?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines the property name of the personalization key. */ keyName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Contains the control that can be personalized. */ control?: sap.ui.core.Control | string; } /** * Describes the settings that can be provided to the SmartVariantManagement constructor. */ interface $SmartVariantManagementSettings extends sap.ui.comp.smartvariants .$SmartVariantManagementBaseSettings { /** * Key used to access personalization data. */ persistencyKey?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The v2 oData entity set whose metadata is used to create the variant items based on the `SelectionPresentationVariant` * annotation. * **Note:**This property may be set only once during the initialization phase and may not be changed afterwords. */ entitySet?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * All controls that rely on variant handling have to be added to this aggregation. */ personalizableControls?: | sap.ui.comp.smartvariants.PersonalizableInfo[] | sap.ui.comp.smartvariants.PersonalizableInfo | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * This event is fired when the SmartVariantManagement control is initialized. * * @deprecated As of version 1.38.0. Replaced by providing the personalizable control and the callback via * the `initialise`-method. */ initialise?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired after a variant has been saved. */ save?: (oEvent: SmartVariantManagement$SaveEvent) => void; /** * This event is fired after all changes are successfully stored. */ afterSave?: (oEvent: sap.ui.base.Event) => void; } /** * Describes the settings that can be provided to the SmartVariantManagementAdapter constructor. */ interface $SmartVariantManagementAdapterSettings extends sap.ui.core.$ElementSettings { /** * assign an array of selectionPresentationVariants annotations. */ selectionPresentationVariants?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the SmartVariantManagementBase constructor. */ interface $SmartVariantManagementBaseSettings extends sap.ui.comp.smartvariants .$SmartVariantManagementMediatorSettings { /** * Defines the author of the standard variant, for example, the name of the own company. */ standardItemAuthor?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Enables the setting of the initially selected variant. * * @deprecated As of version 1.103. replaced by property `selectionKey` */ initialSelectionKey?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Enables the lifecycle support. If set to true, the VariantManagement control handles the transport information * for shared variants. * * @deprecated As of version 1.103. life-cycle handling of views is done internally by the SAPUI5 flexibility * service. */ lifecycleSupport?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the SmartVariantManagementMediator constructor. */ interface $SmartVariantManagementMediatorSettings extends sap.ui.core.$ControlSettings { /** * Provides a string value to set the default variant. Used for the save dialog. Has no effect on the selected * variant. */ defaultVariantKey?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application * controls this behavior. **Note:** The usage of this property is restricted to `sap.fe` components * only. */ displayTextForExecuteOnSelectionForStandardVariant?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Indicates whether the buttons on My Views are visible. */ editable?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Can be set to true or false depending on whether you want to enable or disable the control. */ enabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Determines the behavior for Apply Automatically if the standard variant is marked as the default variant. */ executeOnSelectionForStandardDefault?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}. * * @since 1.104 */ headerLevel?: | sap.ui.core.TitleLevel | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates whether the control is in error state. If set to `true`, an error message will be displayed * when the variant is opened. */ inErrorState?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets the maximum width of the control. * * @since 1.109 */ maxWidth?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * The name of the model containing the data. */ modelName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The key of the currently selected item. */ selectionKey?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Indicates that a Create Tile is visible in the Save As dialog. */ showCreateTile?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates that Execute on Selection is visible in the Save As and the Manage Views dialogs. */ showExecuteOnSelection?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates whether the functionality of setting a default variant is enabled. The Default column in Manage * Views and the Set as Default checkbox in Save View will be disabled if set to `false`. */ showSetAsDefault?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates that the Public checkbox is visible in the Save As and the Manage Views dialogs. Selecting * this checkbox allows you to share variants with other users. **Note**: this property is controlled by * the SAPUI5 flexibility service. */ showShare?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Overwrites the default standard variant title. By default, the standard variant displays the text "Standard". * Use this property to customize the text displayed for the standard variant in the variant management * dropdown. The property supports data binding, for example, to i18n models for translation. **Note:** * This property must be set during control initialization (in the constructor or XML view declaration). * Setting it later via `setStandardItemText()` will have no effect. * * @since 1.28.0 */ standardItemText?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}. * * @since 1.109 */ titleStyle?: | sap.ui.core.TitleLevel | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates that the 'Favorites' feature is used. Only variants marked as favorites will be displayed in * the variant list. */ useFavorites?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates that end users are allowed to create variants **Note**: this property is controlled by the * SAPUI5 flexibility service. */ variantCreationByUserAllowed?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Variant items displayed by the `SmartVariantManagement` control. **Note:** This aggregation is managed * by the control and is populated via the SAP Flexibility service. */ variantItems?: | sap.m.VariantItem[] | sap.m.VariantItem | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Contains the IDs of the relevant controls for which the variant management is used. */ for?: Array; /** * This event is fired when users press the Cancel button inside the Save As dialog. */ cancel?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired when users apply changes to variants in the Manage Views dialog. */ manage?: (oEvent: SmartVariantManagementMediator$ManageEvent) => void; /** * This event is fired when the Save View dialog or the Save As dialog is closed with the Save button. */ save?: (oEvent: SmartVariantManagementMediator$SaveEvent) => void; /** * This event is fired when a new variant is selected. */ select?: (oEvent: SmartVariantManagementMediator$SelectEvent) => void; } /** * Describes the settings that can be provided to the SmartVariantManagementUi2 constructor. * * @deprecated As of version 1.136. replaced by {@link sap.ui.comp.smartvariants.SmartVariantManagement SmartVariantManagement } * for smart controls / OData V2 and {@link sap.ui.fl.variants.VariantManagement VariantManagement} for * OData V4 and freestyle applications. */ interface $SmartVariantManagementUi2Settings extends sap.ui.core.$ControlSettings { /** * Can be set to true or false depending on whether you want to enable or disable the control. */ enabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets the maximum width of the control. * * @since 1.120 */ maxWidth?: | sap.ui.core.CSSSize | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Overwrites the default Standard variant title. * * @since 1.28.0 */ standardItemText?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}. * * @since 1.120 */ headerLevel?: | sap.ui.core.TitleLevel | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}. * * @since 1.120 */ titleStyle?: | sap.ui.core.TitleLevel | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * All controls that rely on variant handling have to be added to this aggregation. The only consumer currently * known is the `FilterBar` control. */ personalizableControl?: sap.ui.comp.smartvariants.PersonalizableInfo; /** * Once the `SmartVariantManagementUi2` control has been initialized, and especially after retrieving the * variants via the UI2 personalization service and the default variant was applied, the registered consumer * will be notified that this phase has completed. */ initialise?: (oEvent: sap.ui.base.Event) => void; /** * Fired after a variant is saved. This event can be used to retrieve the id of the saved variant. */ afterSave?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired when the Save Variant dialog is closed with OK for a variant. */ save?: (oEvent: SmartVariantManagementUi2$SaveEvent) => void; /** * This event is fired when users apply changes to variants in the Manage Variants dialog. */ manage?: (oEvent: SmartVariantManagementUi2$ManageEvent) => void; /** * This event is fired when a new variant is selected. */ select?: (oEvent: SmartVariantManagementUi2$SelectEvent) => void; } /** * Parameters of the SmartVariantManagement#afterSave event. */ interface SmartVariantManagement$AfterSaveEventParameters {} /** * Parameters of the SmartVariantManagement#initialise event. * * @deprecated As of version 1.38.0. Replaced by providing the personalizable control and the callback via * the `initialise`-method. */ interface SmartVariantManagement$InitialiseEventParameters {} /** * Parameters of the SmartVariantManagement#save event. */ interface SmartVariantManagement$SaveEventParameters extends sap.ui.comp.smartvariants .SmartVariantManagementMediator$SaveEventParameters { /** * If the property `showCreateTile` is set, the Create Tile checkbox is shown and its value is passed to * this event parameter. * If the property `showCreateTile` is not set, this event parameter is skipped. */ tile?: boolean; } /** * Parameters of the SmartVariantManagementMediator#cancel event. */ interface SmartVariantManagementMediator$CancelEventParameters {} /** * Parameters of the SmartVariantManagementMediator#manage event. */ interface SmartVariantManagementMediator$ManageEventParameters { /** * List of changed variants. Each entry contains a `key` (the variant key) and a `name` (the new title of * the variant). */ renamed?: object[]; /** * List of deleted variant keys */ deleted?: string[]; /** * List of variant keys and the associated Execute on Selection indicator. Each entry contains a `key` (the * variant key) and an `exe` flag describing the intention. */ exe?: object[]; /** * List of variant keys and the associated favorite indicator. Each entry contains a `key` (the variant * key) and a `visible` flag describing the intention. */ fav?: object[]; /** * The default variant key */ def?: string; /** * List of variant keys and the associated contexts array. Each entry contains a `key` (the variant key) * and a `contexts` array describing the contexts. **Note:** It is only used internally by the SAPUI5 flexibility * layer. */ contexts?: object[]; } /** * Parameters of the SmartVariantManagementMediator#save event. */ interface SmartVariantManagementMediator$SaveEventParameters { /** * Variant title */ name?: string; /** * Indicates whether an existing variant is overwritten or whether a new variant is created */ overwrite?: boolean; /** * Variant key. This property is set if `overwrite` is set to `true`. */ key?: string; /** * Apply Automatically indicator */ execute?: boolean; /** * Indicates the checkbox state for Public */ public?: boolean; /** * The default variant indicator */ def?: boolean; /** * Array describing the contexts. **Note:** It is only used internally by the SAPUI5 flexibility layer. */ contexts?: object[]; /** * The shared variant indicator */ global?: boolean; } /** * Parameters of the SmartVariantManagementMediator#select event. */ interface SmartVariantManagementMediator$SelectEventParameters { /** * Variant key */ key?: string; } /** * Parameters of the SmartVariantManagementUi2#afterSave event. */ interface SmartVariantManagementUi2$AfterSaveEventParameters {} /** * Parameters of the SmartVariantManagementUi2#initialise event. */ interface SmartVariantManagementUi2$InitialiseEventParameters {} /** * Parameters of the SmartVariantManagementUi2#manage event. */ interface SmartVariantManagementUi2$ManageEventParameters { /** * List of changed variants. Each entry contains a 'key' - the variant key and a 'name' - the new title * of the variant */ renamed?: object[]; /** * List of deleted variant keys */ deleted?: string[]; /** * The default variant key */ def?: string; } /** * Parameters of the SmartVariantManagementUi2#save event. */ interface SmartVariantManagementUi2$SaveEventParameters { /** * The variant title */ name?: string; /** * Indicates if an existing variant is overwritten or if a new variant is created */ overwrite?: boolean; /** * The variant key */ key?: string; /** * The default variant indicator */ def?: boolean; } /** * Parameters of the SmartVariantManagementUi2#select event. */ interface SmartVariantManagementUi2$SelectEventParameters { /** * The variant key */ key?: string; } /** * The PersonalizableInfo class describes the personalizable control associated with the `SmartVariantManagement` * control. */ class PersonalizableInfo extends sap.ui.core.Element { /** * Constructor for a new smartvariants/PersonalizableInfo. * * 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.ui.comp.smartvariants.$PersonalizableInfoSettings ); /** * Constructor for a new smartvariants/PersonalizableInfo. * * 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.ui.comp.smartvariants.$PersonalizableInfoSettings ); /** * Creates a new subclass of class sap.ui.comp.smartvariants.PersonalizableInfo with name `sClassName` and * enriches it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.comp.smartvariants.PersonalizableInfo >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartvariants.PersonalizableInfo. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * ID of the element which is the current target of the association {@link #getControl control}, or `null`. */ getControl(): sap.ui.core.ID | null; /** * Gets current value of property {@link #getDataSource dataSource}. * * Name of the data service * * * @returns Value of property `dataSource` */ getDataSource(): string; /** * Gets current value of property {@link #getKeyName keyName}. * * Defines the property name of the personalization key. * * * @returns Value of property `keyName` */ getKeyName(): string; /** * Gets current value of property {@link #getType type}. * * Describes the type of variant management. * * * @returns Value of property `type` */ getType(): string; /** * Sets the associated {@link #getControl control}. * * * @returns Reference to `this` in order to allow method chaining */ setControl( /** * ID of an element which becomes the new target of this control association; alternatively, an element * instance may be given */ oControl: sap.ui.core.ID | sap.ui.core.Control ): this; /** * Sets a new value for property {@link #getDataSource dataSource}. * * Name of the data service * * 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 */ setDataSource( /** * New value for property `dataSource` */ sDataSource?: string ): this; /** * Sets a new value for property {@link #getKeyName keyName}. * * Defines the property name of the personalization key. * * 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 */ setKeyName( /** * New value for property `keyName` */ sKeyName?: string ): this; /** * Sets a new value for property {@link #getType type}. * * Describes the type of variant management. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setType( /** * New value for property `type` */ sType?: string ): this; } /** * Overview: The `SmartVariantManagement` control communicates with the flexibility library that offers * SAPUI5 flexibility to manage the variants. * Usage: You can use this control in combination with the following controls: * - `SmartFilterBar` * - `SmartChart` * - `SmartTable` */ class SmartVariantManagement extends sap.ui.comp.smartvariants.SmartVariantManagementBase implements sap.ui.core.IShrinkable { __implements__sap_ui_core_IShrinkable: boolean; /** * Constructor for a new SmartVariantManagement. * The call sequence is as follows: * A control for which personalization is used has to be registered first via the `personalizableControls` * association. Then it has to call the `initialise` method with the arguments `fCallback` function which * will be called once the personalization data has been retrieved and `oPersoControl`, the control itself. * **Note:** the function callback has to be defined in the personalizable control. The old behavior, * where the control has to register to the `initialise` event, before the `initialise` method call, should * not be used any longer and is not supported at all for the page variant scenarios. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/06a4c3ac1cf545a7b51864e7f3aa02da Smart Variant Management} * {@link https://ui5.sap.com/#/topic/a8e55aa2f8bc4127923b20685a6d1621 SAPUI5 Flexibility: Adapting UIs Made Easy} */ constructor( /** * initial settings for the new control */ mSettings?: sap.ui.comp.smartvariants.$SmartVariantManagementSettings ); /** * Constructor for a new SmartVariantManagement. * The call sequence is as follows: * A control for which personalization is used has to be registered first via the `personalizableControls` * association. Then it has to call the `initialise` method with the arguments `fCallback` function which * will be called once the personalization data has been retrieved and `oPersoControl`, the control itself. * **Note:** the function callback has to be defined in the personalizable control. The old behavior, * where the control has to register to the `initialise` event, before the `initialise` method call, should * not be used any longer and is not supported at all for the page variant scenarios. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/06a4c3ac1cf545a7b51864e7f3aa02da Smart Variant Management} * {@link https://ui5.sap.com/#/topic/a8e55aa2f8bc4127923b20685a6d1621 SAPUI5 Flexibility: Adapting UIs Made Easy} */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string, /** * initial settings for the new control */ mSettings?: sap.ui.comp.smartvariants.$SmartVariantManagementSettings ); /** * Creates a new subclass of class sap.ui.comp.smartvariants.SmartVariantManagement 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.comp.smartvariants.SmartVariantManagementBase.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< T, sap.ui.comp.smartvariants.SmartVariantManagement >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartvariants.SmartVariantManagement. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Registers all controls interested and relying on variant handling. * * * @returns Current instance */ addPersonalizableControl( /** * Wrapper for the personalizable control */ oCurrentControlInfo: sap.ui.comp.smartvariants.PersonalizableInfo ): sap.ui.comp.smartvariants.SmartVariantManagement; /** * Attaches event handler `fnFunction` to the {@link #event:afterSave afterSave} event of this `sap.ui.comp.smartvariants.SmartVariantManagement`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagement` itself. * * This event is fired after all changes are successfully stored. * * * @returns Reference to `this` in order to allow method chaining */ attachAfterSave( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagement` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:afterSave afterSave} event of this `sap.ui.comp.smartvariants.SmartVariantManagement`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagement` itself. * * This event is fired after all changes are successfully stored. * * * @returns Reference to `this` in order to allow method chaining */ attachAfterSave( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagement` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialise initialise} event of this `sap.ui.comp.smartvariants.SmartVariantManagement`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagement` itself. * * This event is fired when the SmartVariantManagement control is initialized. * * @deprecated As of version 1.38.0. Replaced by providing the personalizable control and the callback via * the `initialise`-method. * * @returns Reference to `this` in order to allow method chaining */ attachInitialise( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagement` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialise initialise} event of this `sap.ui.comp.smartvariants.SmartVariantManagement`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagement` itself. * * This event is fired when the SmartVariantManagement control is initialized. * * @deprecated As of version 1.38.0. Replaced by providing the personalizable control and the callback via * the `initialise`-method. * * @returns Reference to `this` in order to allow method chaining */ attachInitialise( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagement` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:save save} event of this `sap.ui.comp.smartvariants.SmartVariantManagement`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagement` itself. * * This event is fired after a variant has been saved. * * * @returns Reference to `this` in order to allow method chaining */ attachSave( /** * 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: SmartVariantManagement$SaveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagement` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:save save} event of this `sap.ui.comp.smartvariants.SmartVariantManagement`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagement` itself. * * This event is fired after a variant has been saved. * * * @returns Reference to `this` in order to allow method chaining */ attachSave( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartVariantManagement$SaveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagement` * itself */ oListener?: object ): this; /** * Removes the current variant selection and resets to Standard. Note: this method only set the variant * title to Standard; it does not trigger a view selection change and does not change the modify indicator. * In case this is required, please use the corresponding method `setCurrentVariantId`. * * @since 1.22.0 */ clearVariantSelection(): void; /** * Sets the dirty flag of the current variant. */ currentVariantSetModified( /** * The value indicating the dirty state of the current variant */ bFlag: boolean ): void; /** * Destroys all the personalizableControls in the aggregation {@link #getPersonalizableControls personalizableControls}. * * * @returns Reference to `this` in order to allow method chaining */ destroyPersonalizableControls(): this; /** * Detaches event handler `fnFunction` from the {@link #event:afterSave afterSave} event of this `sap.ui.comp.smartvariants.SmartVariantManagement`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachAfterSave( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:initialise initialise} event of this `sap.ui.comp.smartvariants.SmartVariantManagement`. * * The passed function and listener object must match the ones used for event registration. * * @deprecated As of version 1.38.0. Replaced by providing the personalizable control and the callback via * the `initialise`-method. * * @returns Reference to `this` in order to allow method chaining */ detachInitialise( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:save save} event of this `sap.ui.comp.smartvariants.SmartVariantManagement`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSave( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartVariantManagement$SaveEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:afterSave afterSave} 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 */ fireAfterSave( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:initialise initialise} to attached listeners. * * @deprecated As of version 1.38.0. Replaced by providing the personalizable control and the callback via * the `initialise`-method. * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireInitialise( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Retrieves the current variant ID. For a standard variant, an empty string is returned. * * @since 1.28.1 * * @returns Current variant ID */ getCurrentVariantId(): string; /** * Gets current value of property {@link #getEntitySet entitySet}. * * The v2 oData entity set whose metadata is used to create the variant items based on the `SelectionPresentationVariant` * annotation. * **Note:**This property may be set only once during the initialization phase and may not be changed afterwords. * * * @returns Value of property `entitySet` */ getEntitySet(): string; /** * Gets current value of property {@link #getPersistencyKey persistencyKey}. * * Key used to access personalization data. * * * @returns Value of property `persistencyKey` */ getPersistencyKey(): string; /** * Gets content of aggregation {@link #getPersonalizableControls personalizableControls}. * * All controls that rely on variant handling have to be added to this aggregation. */ getPersonalizableControls(): sap.ui.comp.smartvariants.PersonalizableInfo[]; /** * Returns the standard variant. * * * @returns The standard variant. */ getStandardVariant( /** * Current personalizable control */ oCurrentControl: sap.ui.core.Control ): Object; /** * Retrieves the variant content. * * * @returns JSON Representing the content of the variant */ getVariantContent( /** * Current personalizable control */ oControl: sap.ui.core.Control, /** * The variant key */ sKey: string ): object; /** * Checks for the provided `sap.ui.comp.smartvariants.PersonalizableInfo` in the aggregation {@link #getPersonalizableControls personalizableControls}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfPersonalizableControl( /** * The personalizableControl whose index is looked for */ oPersonalizableControl: sap.ui.comp.smartvariants.PersonalizableInfo ): int; /** * Initializes the control by retrieving the variants from SAPUI5 flexibility. Once the initialization has * been completed, the controls for personalization are notified via the `initialise` event. */ initialise( /** * Function will be called whenever the data for the personalizable control is received */ fCallback: Function, /** * Current control that can be personalized */ oPersoControl: sap.ui.core.Control ): void; /** * Inserts a personalizableControl into the aggregation {@link #getPersonalizableControls personalizableControls}. * * * @returns Reference to `this` in order to allow method chaining */ insertPersonalizableControl( /** * The personalizableControl to insert; if empty, nothing is inserted */ oPersonalizableControl: sap.ui.comp.smartvariants.PersonalizableInfo, /** * The `0`-based index the personalizableControl should be inserted at; for a negative value of `iIndex`, * the personalizableControl is inserted at position 0; for a value greater than the current size of the * aggregation, the personalizableControl is inserted at the last position */ iIndex: int ): this; /** * Determines if the `SmartVariantManagement` instance is a page variant. * * * @returns `true` if it is a page variant, otherwise `false` */ isPageVariant(): boolean; /** * Removes all registered personalizable controls. */ removeAllPersonalizableControls(): void; /** * Removes a registered personalizable control. * * * @returns Removed wrapper for the personalizable control */ removePersonalizableControl( /** * Wrapper for the personalizable control */ oCurrentControlInfo: sap.ui.comp.smartvariants.PersonalizableInfo ): sap.ui.comp.smartvariants.PersonalizableInfo; /** * Removes a registered personalizable control. */ removePersonalizableControlById( /** * the personalizable control */ oControl: sap.ui.core.Control ): void; /** * Sets the current variant ID. * * @since 1.28.1 */ setCurrentVariantId( /** * ID of the variant */ sVariantId: string, /** * If set to `true`, the `applyVariant` method is not executed yet. */ bDoNotApplyVariant: boolean ): void; /** * The entity set name from OData metadata, with which the smart variant control must be bound. * * * @returns The control instance */ setEntitySet( /** * The entity set */ sEntitySetName: string ): sap.ui.comp.smartvariants.SmartVariantManagement; /** * Sets a new value for property {@link #getPersistencyKey persistencyKey}. * * Key used to access personalization data. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * * @returns Reference to `this` in order to allow method chaining */ setPersistencyKey( /** * New value for property `persistencyKey` */ sPersistencyKey?: string ): this; } /** * Handles the odata metadata based information. An instance of this class will be created and used by the * {@link sap.ui.comp.smartvariants.SmartVariantManagement SmartVariantManagement} control. The adapter * transforms odata metadata based SelectionPresentationVariant information to UIState object. For each * SelectionPresentationVariant annotation an entry will be added to the VariantManagement control. It will * be called by the SmartVariantManagement whenever the user selects the corresponding entry and will provide * a valid {@link sap.ui.comp.state.UIState UIState} object. */ class SmartVariantManagementAdapter extends sap.ui.core.Element { /** * Constructor for new instance of a SmartVariantManagementAdapter control. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. */ constructor( /** * initial settings for the new control */ mSettings?: sap.ui.comp.smartvariants.$SmartVariantManagementAdapterSettings ); /** * Constructor for new instance of a SmartVariantManagementAdapter control. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string, /** * initial settings for the new control */ mSettings?: sap.ui.comp.smartvariants.$SmartVariantManagementAdapterSettings ); /** * Creates a new subclass of class sap.ui.comp.smartvariants.SmartVariantManagementAdapter with name `sClassName` * and enriches it with the information contained in `oClassInfo`. * * `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo< T, sap.ui.comp.smartvariants.SmartVariantManagementAdapter >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartvariants.SmartVariantManagementAdapter. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getSelectionPresentationVariants selectionPresentationVariants}. * * assign an array of selectionPresentationVariants annotations. * * Default value is `false`. * * * @returns Value of property `selectionPresentationVariants` */ getSelectionPresentationVariants(): object; /** * Sets a new value for property {@link #getSelectionPresentationVariants selectionPresentationVariants}. * * assign an array of selectionPresentationVariants annotations. * * 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 */ setSelectionPresentationVariants( /** * New value for property `selectionPresentationVariants` */ oSelectionPresentationVariants?: object ): this; } /** * Overview: The `SmartVariantManagementBase` control embeds {@link sap.m.VariantManagement VariantManagement } * control and communicates with the flexibility library that offers SAPUI5 flexibility to manage the variants * for the UI Adaptation scenarios. * * * @since 1.56 */ class SmartVariantManagementBase extends sap.ui.comp.smartvariants.SmartVariantManagementMediator implements sap.m.IOverflowToolbarContent { __implements__sap_m_IOverflowToolbarContent: boolean; /** * Constructor for a new `SmartVariantManagementBase`. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App} */ constructor( /** * Initial settings for the new control */ mSettings?: sap.ui.comp.smartvariants.$SmartVariantManagementBaseSettings ); /** * Constructor for a new `SmartVariantManagementBase`. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App} */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string, /** * Initial settings for the new control */ mSettings?: sap.ui.comp.smartvariants.$SmartVariantManagementBaseSettings ); /** * Creates a new subclass of class sap.ui.comp.smartvariants.SmartVariantManagementBase 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.comp.smartvariants.SmartVariantManagementMediator.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< T, sap.ui.comp.smartvariants.SmartVariantManagementBase >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartvariants.SmartVariantManagementBase. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getInitialSelectionKey initialSelectionKey}. * * Enables the setting of the initially selected variant. * * @deprecated As of version 1.103. replaced by property `selectionKey` * * @returns Value of property `initialSelectionKey` */ getInitialSelectionKey(): string; /** * Gets current value of property {@link #getLifecycleSupport lifecycleSupport}. * * Enables the lifecycle support. If set to true, the VariantManagement control handles the transport information * for shared variants. * * Default value is `false`. * * @deprecated As of version 1.103. life-cycle handling of views is done internally by the SAPUI5 flexibility * service. * * @returns Value of property `lifecycleSupport` */ getLifecycleSupport(): boolean; /** * Gets current value of property {@link #getStandardItemAuthor standardItemAuthor}. * * Defines the author of the standard variant, for example, the name of the own company. * * Default value is `"SAP"`. * * * @returns Value of property `standardItemAuthor` */ getStandardItemAuthor(): string; /** * Sets a new value for property {@link #getInitialSelectionKey initialSelectionKey}. * * Enables the setting of the initially selected variant. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @deprecated As of version 1.103. replaced by property `selectionKey` * * @returns Reference to `this` in order to allow method chaining */ setInitialSelectionKey( /** * New value for property `initialSelectionKey` */ sInitialSelectionKey?: string ): this; /** * Sets a new value for property {@link #getLifecycleSupport lifecycleSupport}. * * Enables the lifecycle support. If set to true, the VariantManagement control handles the transport information * for shared variants. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @deprecated As of version 1.103. life-cycle handling of views is done internally by the SAPUI5 flexibility * service. * * @returns Reference to `this` in order to allow method chaining */ setLifecycleSupport( /** * New value for property `lifecycleSupport` */ bLifecycleSupport?: boolean ): this; /** * Sets a new value for property {@link #getStandardItemAuthor standardItemAuthor}. * * Defines the author of the standard variant, for example, the name of the own company. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"SAP"`. * * * @returns Reference to `this` in order to allow method chaining */ setStandardItemAuthor( /** * New value for property `standardItemAuthor` */ sStandardItemAuthor?: string ): this; } /** * Can be used to manage variants. You can use this control in most controls that are enabled for key * user adaptation. * **Note: **On the user interface, variants are generally referred to as "views". * * @since 1.56 */ class SmartVariantManagementMediator extends sap.ui.core.Control implements sap.ui.core.IShrinkable, sap.m.IOverflowToolbarContent, sap.m.IToolbarInteractiveControl { __implements__sap_ui_core_IShrinkable: boolean; __implements__sap_m_IOverflowToolbarContent: boolean; __implements__sap_m_IToolbarInteractiveControl: boolean; /** * Constructor for a new `SmartVariantManagementMediator`. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App} */ constructor( /** * Initial settings for the new control */ mSettings?: sap.ui.comp.smartvariants.$SmartVariantManagementMediatorSettings ); /** * Constructor for a new `SmartVariantManagementMediator`. * * Accepts an object literal `mSettings` that defines initial property values, aggregated and associated * objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description * of the syntax of the settings object. * See: * {@link https://ui5.sap.com/#/topic/f1430c0337534d469da3a56307ff76af Key User Adaptation: Enable Your App} */ constructor( /** * ID for the new control, generated automatically if no ID is given */ sId?: string, /** * Initial settings for the new control */ mSettings?: sap.ui.comp.smartvariants.$SmartVariantManagementMediatorSettings ); /** * Creates a new subclass of class sap.ui.comp.smartvariants.SmartVariantManagementMediator 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< T, sap.ui.comp.smartvariants.SmartVariantManagementMediator >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartvariants.SmartVariantManagementMediator. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some for into the association {@link #getFor for}. * * * @returns Reference to `this` in order to allow method chaining */ addFor( /** * The for to add; if empty, nothing is inserted */ vFor: sap.ui.core.ID | sap.ui.core.Control ): this; /** * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.comp.smartvariants.SmartVariantManagementMediator`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementMediator` itself. * * This event is fired when users press the Cancel button inside the Save As dialog. * * * @returns Reference to `this` in order to allow method chaining */ attachCancel( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementMediator` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.comp.smartvariants.SmartVariantManagementMediator`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementMediator` itself. * * This event is fired when users press the Cancel button inside the Save As dialog. * * * @returns Reference to `this` in order to allow method chaining */ attachCancel( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementMediator` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:manage manage} event of this `sap.ui.comp.smartvariants.SmartVariantManagementMediator`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementMediator` itself. * * This event is fired when users apply changes to variants in the Manage Views dialog. * * * @returns Reference to `this` in order to allow method chaining */ attachManage( /** * 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: SmartVariantManagementMediator$ManageEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementMediator` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:manage manage} event of this `sap.ui.comp.smartvariants.SmartVariantManagementMediator`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementMediator` itself. * * This event is fired when users apply changes to variants in the Manage Views dialog. * * * @returns Reference to `this` in order to allow method chaining */ attachManage( /** * The function to be called when the event occurs */ fnFunction: ( p1: SmartVariantManagementMediator$ManageEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementMediator` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:save save} event of this `sap.ui.comp.smartvariants.SmartVariantManagementMediator`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementMediator` itself. * * This event is fired when the Save View dialog or the Save As dialog is closed with the Save button. * * * @returns Reference to `this` in order to allow method chaining */ attachSave( /** * 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: SmartVariantManagementMediator$SaveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementMediator` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:save save} event of this `sap.ui.comp.smartvariants.SmartVariantManagementMediator`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementMediator` itself. * * This event is fired when the Save View dialog or the Save As dialog is closed with the Save button. * * * @returns Reference to `this` in order to allow method chaining */ attachSave( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartVariantManagementMediator$SaveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementMediator` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.comp.smartvariants.SmartVariantManagementMediator`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementMediator` itself. * * This event is fired when a new variant 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: SmartVariantManagementMediator$SelectEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementMediator` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.comp.smartvariants.SmartVariantManagementMediator`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementMediator` itself. * * This event is fired when a new variant is selected. * * * @returns Reference to `this` in order to allow method chaining */ attachSelect( /** * The function to be called when the event occurs */ fnFunction: ( p1: SmartVariantManagementMediator$SelectEvent ) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementMediator` * itself */ oListener?: object ): this; /** * Gets the dirty flag of the current variant. * * * @returns The dirty state of the current variant */ currentVariantGetModified(): boolean; /** * Sets the dirty flag of the current variant. */ currentVariantSetModified( /** * The value indicating the dirty state of the current variant */ bFlag: boolean ): void; /** * Detaches event handler `fnFunction` from the {@link #event:cancel cancel} event of this `sap.ui.comp.smartvariants.SmartVariantManagementMediator`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachCancel( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:manage manage} event of this `sap.ui.comp.smartvariants.SmartVariantManagementMediator`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachManage( /** * The function to be called, when the event occurs */ fnFunction: ( p1: SmartVariantManagementMediator$ManageEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:save save} event of this `sap.ui.comp.smartvariants.SmartVariantManagementMediator`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSave( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartVariantManagementMediator$SaveEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.ui.comp.smartvariants.SmartVariantManagementMediator`. * * 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: SmartVariantManagementMediator$SelectEvent ) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:cancel cancel} 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 */ fireCancel( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:manage manage} 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 */ fireManage( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartvariants.SmartVariantManagementMediator$ManageEventParameters ): this; /** * Fires event {@link #event:save save} 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 */ fireSave( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.smartvariants.SmartVariantManagementMediator$SaveEventParameters ): 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.ui.comp.smartvariants.SmartVariantManagementMediator$SelectEventParameters ): this; /** * Gets the currently selected variant key. * * * @returns Key of the currently selected variant. In case the model is not yet set `null` will be returned */ getCurrentVariantKey(): string | null; /** * Gets current value of property {@link #getDefaultVariantKey defaultVariantKey}. * * Provides a string value to set the default variant. Used for the save dialog. Has no effect on the selected * variant. * * * @returns Value of property `defaultVariantKey` */ getDefaultVariantKey(): string; /** * Gets current value of property {@link #getDisplayTextForExecuteOnSelectionForStandardVariant displayTextForExecuteOnSelectionForStandardVariant}. * * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application * controls this behavior. **Note:** The usage of this property is restricted to `sap.fe` components * only. * * Default value is `empty string`. * * * @returns Value of property `displayTextForExecuteOnSelectionForStandardVariant` */ getDisplayTextForExecuteOnSelectionForStandardVariant(): string; /** * Gets current value of property {@link #getEditable editable}. * * Indicates whether the buttons on My Views are visible. * * Default value is `true`. * * * @returns Value of property `editable` */ getEditable(): boolean; /** * Gets current value of property {@link #getEnabled enabled}. * * Can be set to true or false depending on whether you want to enable or disable the control. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getExecuteOnSelectionForStandardDefault executeOnSelectionForStandardDefault}. * * Determines the behavior for Apply Automatically if the standard variant is marked as the default variant. * * Default value is `false`. * * * @returns Value of property `executeOnSelectionForStandardDefault` */ getExecuteOnSelectionForStandardDefault(): boolean; /** * Returns array of IDs of the elements which are the current targets of the association {@link #getFor for}. */ getFor(): sap.ui.core.ID[]; /** * Gets current value of property {@link #getHeaderLevel headerLevel}. * * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}. * * Default value is `Auto`. * * @since 1.104 * * @returns Value of property `headerLevel` */ getHeaderLevel(): sap.ui.core.TitleLevel; /** * Gets current value of property {@link #getInErrorState inErrorState}. * * Indicates whether the control is in error state. If set to `true`, an error message will be displayed * when the variant is opened. * * Default value is `false`. * * * @returns Value of property `inErrorState` */ getInErrorState(): boolean; /** * Gets current value of property {@link #getMaxWidth maxWidth}. * * Sets the maximum width of the control. * * Default value is `"100%"`. * * @since 1.109 * * @returns Value of property `maxWidth` */ getMaxWidth(): sap.ui.core.CSSSize; /** * Gets current value of property {@link #getModelName modelName}. * * The name of the model containing the data. * * Default value is `empty string`. * * * @returns Value of property `modelName` */ getModelName(): string; /** * Determines whether the current variant is modified. * * * @returns Returns `true`, if the current variant is modified, otherwise `false` */ getModified(): boolean; /** * Registers an invalidation event that is fired when the width of the control is changed. **Note:** This * is required by the {@link sap.m.IOverflowToolbarContent} interface. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Configuration information for the {@link sap.m.IOverflowToolbarContent} interface */ getOverflowToolbarConfig(): { canOverflow: boolean; invalidationEvents: string[]; }; /** * Gets current value of property {@link #getSelectionKey selectionKey}. * * The key of the currently selected item. * * * @returns Value of property `selectionKey` */ getSelectionKey(): string; /** * Gets current value of property {@link #getShowCreateTile showCreateTile}. * * Indicates that a Create Tile is visible in the Save As dialog. * * Default value is `false`. * * * @returns Value of property `showCreateTile` */ getShowCreateTile(): boolean; /** * Gets current value of property {@link #getShowExecuteOnSelection showExecuteOnSelection}. * * Indicates that Execute on Selection is visible in the Save As and the Manage Views dialogs. * * Default value is `false`. * * * @returns Value of property `showExecuteOnSelection` */ getShowExecuteOnSelection(): boolean; /** * Gets current value of property {@link #getShowSetAsDefault showSetAsDefault}. * * Indicates whether the functionality of setting a default variant is enabled. The Default column in Manage * Views and the Set as Default checkbox in Save View will be disabled if set to `false`. * * Default value is `true`. * * * @returns Value of property `showSetAsDefault` */ getShowSetAsDefault(): boolean; /** * Gets current value of property {@link #getShowShare showShare}. * * Indicates that the Public checkbox is visible in the Save As and the Manage Views dialogs. Selecting * this checkbox allows you to share variants with other users. **Note**: this property is controlled by * the SAPUI5 flexibility service. * * Default value is `false`. * * * @returns Value of property `showShare` */ getShowShare(): boolean; /** * Gets current value of property {@link #getStandardItemText standardItemText}. * * Overwrites the default standard variant title. By default, the standard variant displays the text "Standard". * Use this property to customize the text displayed for the standard variant in the variant management * dropdown. The property supports data binding, for example, to i18n models for translation. **Note:** * This property must be set during control initialization (in the constructor or XML view declaration). * Setting it later via `setStandardItemText()` will have no effect. * * @since 1.28.0 * * @returns Value of property `standardItemText` */ getStandardItemText(): string; /** * Gets current value of property {@link #getTitleStyle titleStyle}. * * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}. * * Default value is `Auto`. * * @since 1.109 * * @returns Value of property `titleStyle` */ getTitleStyle(): sap.ui.core.TitleLevel; /** * Gets current value of property {@link #getUseFavorites useFavorites}. * * Indicates that the 'Favorites' feature is used. Only variants marked as favorites will be displayed in * the variant list. * * Default value is `false`. * * * @returns Value of property `useFavorites` */ getUseFavorites(): boolean; /** * Gets current value of property {@link #getVariantCreationByUserAllowed variantCreationByUserAllowed}. * * Indicates that end users are allowed to create variants **Note**: this property is controlled by the * SAPUI5 flexibility service. * * Default value is `true`. * * * @returns Value of property `variantCreationByUserAllowed` */ getVariantCreationByUserAllowed(): boolean; /** * Gets all variants. * * * @returns All variants; if the model is not yet set, an empty array will be returned. */ getVariants(): any[]; /** * Checks for the provided `sap.m.VariantItem` in the aggregation {@link #getVariantItems variantItems}. * and returns its index if found or -1 otherwise. * * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfVariantItem( /** * The variantItem whose index is looked for */ oVariantItem: sap.m.VariantItem ): int; /** * Removes all the controls in the association named {@link #getFor for}. * * * @returns An array of the removed elements (might be empty) */ removeAllFor(): sap.ui.core.ID[]; /** * Removes an for from the association named {@link #getFor for}. * * * @returns The removed for or `null` */ removeFor( /** * The for to be removed or its index or ID */ vFor: int | sap.ui.core.ID | sap.ui.core.Control ): sap.ui.core.ID | null; /** * Sets a new value for property {@link #getDefaultVariantKey defaultVariantKey}. * * Provides a string value to set the default variant. Used for the save dialog. Has no effect on the selected * variant. * * 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 */ setDefaultVariantKey( /** * New value for property `defaultVariantKey` */ sDefaultVariantKey?: string ): this; /** * Sets a new value for property {@link #getDisplayTextForExecuteOnSelectionForStandardVariant displayTextForExecuteOnSelectionForStandardVariant}. * * Defines the Apply Automatically text for the standard variant in the Manage Views dialog if the application * controls this behavior. **Note:** The usage of this property is restricted to `sap.fe` components * only. * * 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 */ setDisplayTextForExecuteOnSelectionForStandardVariant( /** * New value for property `displayTextForExecuteOnSelectionForStandardVariant` */ sDisplayTextForExecuteOnSelectionForStandardVariant?: string ): this; /** * Sets a new value for property {@link #getEditable editable}. * * Indicates whether the buttons on My Views are visible. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEditable( /** * New value for property `editable` */ bEditable?: boolean ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * Can be set to true or false depending on whether you want to enable or disable the control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getExecuteOnSelectionForStandardDefault executeOnSelectionForStandardDefault}. * * Determines the behavior for Apply Automatically if the standard variant is marked as the default variant. * * 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 */ setExecuteOnSelectionForStandardDefault( /** * New value for property `executeOnSelectionForStandardDefault` */ bExecuteOnSelectionForStandardDefault?: boolean ): this; /** * Sets a new value for property {@link #getHeaderLevel headerLevel}. * * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Auto`. * * @since 1.104 * * @returns Reference to `this` in order to allow method chaining */ setHeaderLevel( /** * New value for property `headerLevel` */ sHeaderLevel?: sap.ui.core.TitleLevel ): this; /** * Sets a new value for property {@link #getInErrorState inErrorState}. * * Indicates whether the control is in error state. If set to `true`, an error message will be displayed * when the variant is opened. * * 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 */ setInErrorState( /** * New value for property `inErrorState` */ bInErrorState?: boolean ): this; /** * Sets a new value for property {@link #getMaxWidth maxWidth}. * * Sets the maximum width of the control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"100%"`. * * @since 1.109 * * @returns Reference to `this` in order to allow method chaining */ setMaxWidth( /** * New value for property `maxWidth` */ sMaxWidth?: sap.ui.core.CSSSize ): this; /** * Sets a new value for property {@link #getModelName modelName}. * * The name of the model containing the data. * * 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 */ setModelName( /** * New value for property `modelName` */ sModelName?: string ): this; /** * Sets a new value for property {@link #getSelectionKey selectionKey}. * * The key of the currently selected item. * * 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 */ setSelectionKey( /** * New value for property `selectionKey` */ sSelectionKey?: string ): this; /** * Indicates whether a {@link sap.m.Title Title} or {@link sap.m.Text Text} is rendered. * * @since 1.140 * * @returns The current instance for method chaining */ setShowAsText( /** * If set to `true`, the control renders a {@link sap.m.Text Text} instead of a {@link sap.m.Title Title} */ bValue: boolean ): sap.ui.comp.smartvariants.SmartVariantManagement; /** * Sets a new value for property {@link #getShowCreateTile showCreateTile}. * * Indicates that a Create Tile is visible in the Save As dialog. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setShowCreateTile( /** * New value for property `showCreateTile` */ bShowCreateTile?: boolean ): this; /** * Sets a new value for property {@link #getShowExecuteOnSelection showExecuteOnSelection}. * * Indicates that Execute on Selection is visible in the Save As and the Manage Views dialogs. * * 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 */ setShowExecuteOnSelection( /** * New value for property `showExecuteOnSelection` */ bShowExecuteOnSelection?: boolean ): this; /** * Sets a new value for property {@link #getShowSetAsDefault showSetAsDefault}. * * Indicates whether the functionality of setting a default variant is enabled. The Default column in Manage * Views and the Set as Default checkbox in Save View will be disabled if set to `false`. * * 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 */ setShowSetAsDefault( /** * New value for property `showSetAsDefault` */ bShowSetAsDefault?: boolean ): this; /** * Sets a new value for property {@link #getShowShare showShare}. * * Indicates that the Public checkbox is visible in the Save As and the Manage Views dialogs. Selecting * this checkbox allows you to share variants with other users. **Note**: this property is controlled by * the SAPUI5 flexibility service. * * 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 */ setShowShare( /** * New value for property `showShare` */ bShowShare?: boolean ): this; /** * Sets a new value for property {@link #getStandardItemText standardItemText}. * * Overwrites the default standard variant title. By default, the standard variant displays the text "Standard". * Use this property to customize the text displayed for the standard variant in the variant management * dropdown. The property supports data binding, for example, to i18n models for translation. **Note:** * This property must be set during control initialization (in the constructor or XML view declaration). * Setting it later via `setStandardItemText()` will have no effect. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setStandardItemText( /** * New value for property `standardItemText` */ sStandardItemText?: string ): this; /** * Sets a new value for property {@link #getTitleStyle titleStyle}. * * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Auto`. * * @since 1.109 * * @returns Reference to `this` in order to allow method chaining */ setTitleStyle( /** * New value for property `titleStyle` */ sTitleStyle?: sap.ui.core.TitleLevel ): this; /** * Sets a new value for property {@link #getUseFavorites useFavorites}. * * Indicates that the 'Favorites' feature is used. Only variants marked as favorites will be displayed in * the variant list. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * * @returns Reference to `this` in order to allow method chaining */ setUseFavorites( /** * New value for property `useFavorites` */ bUseFavorites?: boolean ): this; /** * Sets a new value for property {@link #getVariantCreationByUserAllowed variantCreationByUserAllowed}. * * Indicates that end users are allowed to create variants **Note**: this property is controlled by the * SAPUI5 flexibility service. * * 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 */ setVariantCreationByUserAllowed( /** * New value for property `variantCreationByUserAllowed` */ bVariantCreationByUserAllowed?: boolean ): this; } /** * The SmartVariantManagementUi2 control communicates with the Ui2 personalization layer to manage the variants. * * @deprecated As of version 1.136. replaced by {@link sap.ui.comp.smartvariants.SmartVariantManagement SmartVariantManagement } * for smart controls / OData V2 and {@link sap.ui.fl.variants.VariantManagement VariantManagement} for * OData V4 and freestyle applications. */ class SmartVariantManagementUi2 extends sap.ui.core.Control { /** * Constructor for a new SmartVariantManagementUi2. * * 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.ui.comp.smartvariants.$SmartVariantManagementUi2Settings ); /** * Constructor for a new SmartVariantManagementUi2. * * 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.ui.comp.smartvariants.$SmartVariantManagementUi2Settings ); /** * Creates a new subclass of class sap.ui.comp.smartvariants.SmartVariantManagementUi2 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< T, sap.ui.comp.smartvariants.SmartVariantManagementUi2 >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.smartvariants.SmartVariantManagementUi2. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Registers all controls interested and relying on variant handling. Each control has to be registered * separately. * * * @returns the current instance */ addPersonalizableControl( /** * control providing the required aggregation for flex-layer */ oCurrentControlInfo: sap.ui.comp.smartvariants.PersonalizableInfo ): sap.ui.comp.smartvariants.SmartVariantManagementUi2; /** * Attaches event handler `fnFunction` to the {@link #event:afterSave afterSave} event of this `sap.ui.comp.smartvariants.SmartVariantManagementUi2`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` itself. * * Fired after a variant is saved. This event can be used to retrieve the id of the saved variant. * * * @returns Reference to `this` in order to allow method chaining */ attachAfterSave( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:afterSave afterSave} event of this `sap.ui.comp.smartvariants.SmartVariantManagementUi2`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` itself. * * Fired after a variant is saved. This event can be used to retrieve the id of the saved variant. * * * @returns Reference to `this` in order to allow method chaining */ attachAfterSave( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialise initialise} event of this `sap.ui.comp.smartvariants.SmartVariantManagementUi2`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` itself. * * Once the `SmartVariantManagementUi2` control has been initialized, and especially after retrieving the * variants via the UI2 personalization service and the default variant was applied, the registered consumer * will be notified that this phase has completed. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialise( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:initialise initialise} event of this `sap.ui.comp.smartvariants.SmartVariantManagementUi2`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` itself. * * Once the `SmartVariantManagementUi2` control has been initialized, and especially after retrieving the * variants via the UI2 personalization service and the default variant was applied, the registered consumer * will be notified that this phase has completed. * * * @returns Reference to `this` in order to allow method chaining */ attachInitialise( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:manage manage} event of this `sap.ui.comp.smartvariants.SmartVariantManagementUi2`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` itself. * * This event is fired when users apply changes to variants in the Manage Variants dialog. * * * @returns Reference to `this` in order to allow method chaining */ attachManage( /** * 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: SmartVariantManagementUi2$ManageEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:manage manage} event of this `sap.ui.comp.smartvariants.SmartVariantManagementUi2`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` itself. * * This event is fired when users apply changes to variants in the Manage Variants dialog. * * * @returns Reference to `this` in order to allow method chaining */ attachManage( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartVariantManagementUi2$ManageEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:save save} event of this `sap.ui.comp.smartvariants.SmartVariantManagementUi2`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` itself. * * This event is fired when the Save Variant dialog is closed with OK for a variant. * * * @returns Reference to `this` in order to allow method chaining */ attachSave( /** * 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: SmartVariantManagementUi2$SaveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:save save} event of this `sap.ui.comp.smartvariants.SmartVariantManagementUi2`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` itself. * * This event is fired when the Save Variant dialog is closed with OK for a variant. * * * @returns Reference to `this` in order to allow method chaining */ attachSave( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartVariantManagementUi2$SaveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.comp.smartvariants.SmartVariantManagementUi2`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` itself. * * This event is fired when a new variant 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: SmartVariantManagementUi2$SelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.comp.smartvariants.SmartVariantManagementUi2`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` itself. * * This event is fired when a new variant is selected. * * * @returns Reference to `this` in order to allow method chaining */ attachSelect( /** * The function to be called when the event occurs */ fnFunction: (p1: SmartVariantManagementUi2$SelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.smartvariants.SmartVariantManagementUi2` * itself */ oListener?: object ): this; /** * Removes the current variant selection and resets to default value. */ clearVariantSelection(): void; /** * Destroys the personalizableControl in the aggregation {@link #getPersonalizableControl personalizableControl}. * * * @returns Reference to `this` in order to allow method chaining */ destroyPersonalizableControl(): this; /** * Detaches event handler `fnFunction` from the {@link #event:afterSave afterSave} event of this `sap.ui.comp.smartvariants.SmartVariantManagementUi2`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachAfterSave( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:initialise initialise} event of this `sap.ui.comp.smartvariants.SmartVariantManagementUi2`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachInitialise( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:manage manage} event of this `sap.ui.comp.smartvariants.SmartVariantManagementUi2`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachManage( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartVariantManagementUi2$ManageEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:save save} event of this `sap.ui.comp.smartvariants.SmartVariantManagementUi2`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachSave( /** * The function to be called, when the event occurs */ fnFunction: (p1: SmartVariantManagementUi2$SaveEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.ui.comp.smartvariants.SmartVariantManagementUi2`. * * 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: SmartVariantManagementUi2$SelectEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:afterSave afterSave} 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 */ fireAfterSave( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:initialise initialise} 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 */ fireInitialise( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Retrieves the current variant ID. For a standard variant, an empty string is returned. * * * @returns Current variant ID */ getCurrentVariantId(): string; /** * Gets current value of property {@link #getEnabled enabled}. * * Can be set to true or false depending on whether you want to enable or disable the control. * * Default value is `true`. * * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getHeaderLevel headerLevel}. * * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}. * * Default value is `Auto`. * * @since 1.120 * * @returns Value of property `headerLevel` */ getHeaderLevel(): sap.ui.core.TitleLevel; /** * Gets current value of property {@link #getMaxWidth maxWidth}. * * Sets the maximum width of the control. * * Default value is `"100%"`. * * @since 1.120 * * @returns Value of property `maxWidth` */ getMaxWidth(): sap.ui.core.CSSSize; /** * Gets content of aggregation {@link #getPersonalizableControl personalizableControl}. * * All controls that rely on variant handling have to be added to this aggregation. The only consumer currently * known is the `FilterBar` control. */ getPersonalizableControl(): sap.ui.comp.smartvariants.PersonalizableInfo; /** * Gets current value of property {@link #getStandardItemText standardItemText}. * * Overwrites the default Standard variant title. * * @since 1.28.0 * * @returns Value of property `standardItemText` */ getStandardItemText(): string; /** * Gets current value of property {@link #getTitleStyle titleStyle}. * * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}. * * Default value is `Auto`. * * @since 1.120 * * @returns Value of property `titleStyle` */ getTitleStyle(): sap.ui.core.TitleLevel; /** * Retrieves the variant content. * * * @returns json object representing the content of the variant */ getVariantContent( /** * current control */ oControl: sap.ui.core.Control, /** * the variant key */ sKey: string ): object; /** * Returns all known variant items. * * * @returns all known items. */ getVariantItems(): sap.ui.comp.variants.VariantItem[]; /** * Initializes the UI2 personalization layer by retrieving the list of variants. Once the initialization * has been completed, the control for personalization is informed via the initialise event. */ initialise(): void; /** * Determines if the control instance is a page variant. * * * @returns always returns `false` */ isPageVariant(): boolean; /** * Sets the current variant ID. In case an invalid ID is passed, a standard variant is set. */ setCurrentVariantId( /** * ID of the variant */ sVariantId: string, /** * If set to `true`, the `applyVariant` method is not executed yet. Relevant during navigation, when called * before the initialise event has be executed */ bDoNotApplyVariant: boolean ): void; /** * Sets a new value for property {@link #getEnabled enabled}. * * Can be set to true or false depending on whether you want to enable or disable the control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getHeaderLevel headerLevel}. * * Semantic level of the header. For more information, see {@link sap.m.Title#setLevel}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Auto`. * * @since 1.120 * * @returns Reference to `this` in order to allow method chaining */ setHeaderLevel( /** * New value for property `headerLevel` */ sHeaderLevel?: sap.ui.core.TitleLevel ): this; /** * Sets a new value for property {@link #getMaxWidth maxWidth}. * * Sets the maximum width of the control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"100%"`. * * @since 1.120 * * @returns Reference to `this` in order to allow method chaining */ setMaxWidth( /** * New value for property `maxWidth` */ sMaxWidth?: sap.ui.core.CSSSize ): this; /** * Sets the aggregated {@link #getPersonalizableControl personalizableControl}. * * * @returns Reference to `this` in order to allow method chaining */ setPersonalizableControl( /** * The personalizableControl to set */ oPersonalizableControl: sap.ui.comp.smartvariants.PersonalizableInfo ): this; /** * Sets a new value for property {@link #getStandardItemText standardItemText}. * * Overwrites the default Standard variant title. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setStandardItemText( /** * New value for property `standardItemText` */ sStandardItemText?: string ): this; /** * Sets a new value for property {@link #getTitleStyle titleStyle}. * * Defines the style of the title. For more information, see {@link sap.m.Title#setTitleStyle}. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `Auto`. * * @since 1.120 * * @returns Reference to `this` in order to allow method chaining */ setTitleStyle( /** * New value for property `titleStyle` */ sTitleStyle?: sap.ui.core.TitleLevel ): this; } /** * Enumeration for changes for personalization of variant favorites. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'smartvariants.ChangeHandlerType'. */ enum ChangeHandlerType { /** * Change handler creating a change for an added favorite. */ addFavorite = "addFavorite", /** * Change handler creating a change for a removed favorite. */ removeFavorite = "removeFavorite", } type VariantManagementPropertyMapping = { /** * The name of the property on the embedded {@link sap.m.VariantManagement} */ nameInVariantMangement: string; /** * The name of the property in the {@link sap.ui.comp.smartvariants.SmartVariantManagementModel} */ nameInModel: string; }; /** * Event object of the SmartVariantManagement#afterSave event. */ type SmartVariantManagement$AfterSaveEvent = sap.ui.base.Event< SmartVariantManagement$AfterSaveEventParameters, SmartVariantManagement >; /** * Event object of the SmartVariantManagement#initialise event. * * @deprecated As of version 1.38.0. Replaced by providing the personalizable control and the callback via * the `initialise`-method. */ type SmartVariantManagement$InitialiseEvent = sap.ui.base.Event< SmartVariantManagement$InitialiseEventParameters, SmartVariantManagement >; /** * Event object of the SmartVariantManagement#save event. */ type SmartVariantManagement$SaveEvent = sap.ui.base.Event< SmartVariantManagement$SaveEventParameters, SmartVariantManagement >; /** * Event object of the SmartVariantManagementMediator#cancel event. */ type SmartVariantManagementMediator$CancelEvent = sap.ui.base.Event< SmartVariantManagementMediator$CancelEventParameters, SmartVariantManagementMediator >; /** * Event object of the SmartVariantManagementMediator#manage event. */ type SmartVariantManagementMediator$ManageEvent = sap.ui.base.Event< SmartVariantManagementMediator$ManageEventParameters, SmartVariantManagementMediator >; /** * Event object of the SmartVariantManagementMediator#save event. */ type SmartVariantManagementMediator$SaveEvent = sap.ui.base.Event< SmartVariantManagementMediator$SaveEventParameters, SmartVariantManagementMediator >; /** * Event object of the SmartVariantManagementMediator#select event. */ type SmartVariantManagementMediator$SelectEvent = sap.ui.base.Event< SmartVariantManagementMediator$SelectEventParameters, SmartVariantManagementMediator >; /** * Event object of the SmartVariantManagementUi2#afterSave event. */ type SmartVariantManagementUi2$AfterSaveEvent = sap.ui.base.Event< SmartVariantManagementUi2$AfterSaveEventParameters, SmartVariantManagementUi2 >; /** * Event object of the SmartVariantManagementUi2#initialise event. */ type SmartVariantManagementUi2$InitialiseEvent = sap.ui.base.Event< SmartVariantManagementUi2$InitialiseEventParameters, SmartVariantManagementUi2 >; /** * Event object of the SmartVariantManagementUi2#manage event. */ type SmartVariantManagementUi2$ManageEvent = sap.ui.base.Event< SmartVariantManagementUi2$ManageEventParameters, SmartVariantManagementUi2 >; /** * Event object of the SmartVariantManagementUi2#save event. */ type SmartVariantManagementUi2$SaveEvent = sap.ui.base.Event< SmartVariantManagementUi2$SaveEventParameters, SmartVariantManagementUi2 >; /** * Event object of the SmartVariantManagementUi2#select event. */ type SmartVariantManagementUi2$SelectEvent = sap.ui.base.Event< SmartVariantManagementUi2$SelectEventParameters, SmartVariantManagementUi2 >; } namespace state { namespace UIState { type SelectionVariantParam = { FilterContextUrl: string; ParameterContextUrl: string; Parameters: Object[]; SelectOptions: Object[]; SelectionVariantID: string; }; } /** * Describes the settings that can be provided to the UIState constructor. */ interface $UIStateSettings extends sap.ui.base.$ManagedObjectSettings { /** * Object representing the presentation variant. The structure looks like: * * * ```javascript * * { * ContextUrl: {string}, * MaxItems: {int}, * SortOrder: [], * GroupBy: [], * Total: [], * RequestAtLeast: [], * Visualizations: [] * } * ``` * * * **Note:** * - `PresentationVariantID` property is not provided * - `Text` property is not provided because it is translated text * - `TotalBy` is not supported yet * - `IncludeGrandTotal` is not supported yet * - `InitialExpansionLevel` is not supported yet * - `Title` of `Visualizations.Content` property is not provided because it is translated text * - `Description` of `Visualizations.Content` property is not provided because it is translated text * `VariantName` property is not part of specified DataSuiteFormat yet */ presentationVariant?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Object representing the selection variant. The structure looks like: * * * ```javascript * * { * SelectionVariant: { * SelectionVariantID: {string}, * Parameters: [], * SelectOptions: [] * } * ``` */ selectionVariant?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Variant name. */ variantName?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Structure containing filter value keys and its corresponding descriptions. * * * ```javascript * * { * Texts: [ * { * Language: string, * ContextUrl: string, * PropertyTexts: [ * { * PropertyName: string, * ValueTexts: [ * { * PropertyValue: string, * Text: string * } * ] * } * ] * } * ] * } * ``` */ valueTexts?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Structure containing Date range semantic data of the filter value. * * * ```javascript * * { * Dates: [ * { * PropertyName: string, * Data: { * calendarType: string, * key: string, * operation: string, * value1: int, * value2: int * } * } * ] * } * ``` */ semanticDates?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Structure containing field names that use the DefaultValues operation. * * * ```javascript * * { * Fields: [ * { * PropertyName: string * } * ] * } * ``` */ defaultValues?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Structure containing table related settings. The properties might be related to a specific table type * and will be ignored if a different table type is used. * * * ```javascript * * { * fixedColumnCount: int, * showDetails: boolean * } * ``` */ tableSettings?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Structure defining the order of filter items. * * * ```javascript * * { * orderedItems: [ * { * group: string, * name: string * } * ] * } * ``` */ orderedItems?: | object | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Creates a new instance of an UIState class. * * @since 1.50 */ class UIState extends sap.ui.base.ManagedObject { /** * 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.ui.comp.state.$UIStateSettings ); /** * 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.ui.comp.state.$UIStateSettings ); /** * Scans the filter model data for fields that have a DefaultValues range. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns the defaultValues structure or null */ static calcDefaultValues( /** * the filter provider model data */ mData: Record ): object | null; /** * Constructs the value state out of a given selection variant and the current model data * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns the values texts format */ static calcSemanticDates( /** * selection variant object */ oSelectionVariant: sap.ui.comp.state.UIState.SelectionVariantParam, /** * the filter provider model data */ mData: Record ): Record; /** * Constructs the value state out of a given selection variant and the current model data * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns the values texts format */ static calculateValueTexts( /** * selection variant object */ oSelectionVariant: sap.ui.comp.state.UIState.SelectionVariantParam, /** * the filter provider model data */ mData: Record ): Record; /** * Converts PresentationVariant annotation to UIState object. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns UIState object containing converted parts of SelectionVariant and PresentationVariant annotations */ static createFromSelectionAndPresentationVariantAnnotation( /** * Name of the variant */ sVariantName: string, /** * Object representing the com.sap.vocabularies.UI.v1.SelectionVariant annotation provided by MetadataAnalyser */ oSelectionVariantAnnotation: Object, /** * Object representing the com.sap.vocabularies.UI.v1.PresentationVariant annotation provided by MetadataAnalyser */ oPresentationVariantAnnotation: Object ): sap.ui.comp.state.UIState; /** * Determines the filter names with value keys where the description is not available. * * @since 1.75 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns a structure [ { filterName: name of the filter, keys: [ value keys without a description]} ] */ static determineFiltersWithOnlyKeyValues( /** * Containing the value description for filters */ oValueTexts: object, /** * The selection variant containing filters and value keys */ oSelectionVariant: sap.ui.comp.state.UIState.SelectionVariantParam, /** * Filter names to ignore */ aIgnoreSelOptionNames: Object[] ): Record; /** * Enriches the internal filter bar value format with DefaultValues skeleton ranges. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns enriched the filter bar inner data format */ static enrichWithDefaultValues( /** * the filter bar inner data format */ sPayload: string, /** * DefaultValues field information */ oDefaultValues: object ): string; /** * Enriches the internal filter bar value format with the semantic date information. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns enriched the filter bar inner data format */ static enrichWithSemanticDates( /** * the filter bar inner data format */ sPayload: string, /** * Semantic date information */ oSemanticDates: Record ): string; /** * Enriches the internal filter bar value format with the information from the value state. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns enriched the filter bar inner data format */ static enrichWithValueTexts( /** * the filter bar inner data format */ sPayload: string, /** * the value texts format containing the eventual descriptions. */ oValueTexts: Record ): string; /** * Creates a new subclass of class sap.ui.comp.state.UIState 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.base.ManagedObject.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.state.UIState. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.base.ManagedObjectMetadata; /** * Gets current value of property {@link #getDefaultValues defaultValues}. * * Structure containing field names that use the DefaultValues operation. * * * ```javascript * * { * Fields: [ * { * PropertyName: string * } * ] * } * ``` * * * * @returns Value of property `defaultValues` */ getDefaultValues(): object; /** * Gets current value of property {@link #getOrderedItems orderedItems}. * * Structure defining the order of filter items. * * * ```javascript * * { * orderedItems: [ * { * group: string, * name: string * } * ] * } * ``` * * * * @returns Value of property `orderedItems` */ getOrderedItems(): object; /** * Gets current value of property {@link #getPresentationVariant presentationVariant}. * * Object representing the presentation variant. The structure looks like: * * * ```javascript * * { * ContextUrl: {string}, * MaxItems: {int}, * SortOrder: [], * GroupBy: [], * Total: [], * RequestAtLeast: [], * Visualizations: [] * } * ``` * * * **Note:** * - `PresentationVariantID` property is not provided * - `Text` property is not provided because it is translated text * - `TotalBy` is not supported yet * - `IncludeGrandTotal` is not supported yet * - `InitialExpansionLevel` is not supported yet * - `Title` of `Visualizations.Content` property is not provided because it is translated text * - `Description` of `Visualizations.Content` property is not provided because it is translated text * `VariantName` property is not part of specified DataSuiteFormat yet * * * @returns Value of property `presentationVariant` */ getPresentationVariant(): object; /** * Gets current value of property {@link #getSelectionVariant selectionVariant}. * * Object representing the selection variant. The structure looks like: * * * ```javascript * * { * SelectionVariant: { * SelectionVariantID: {string}, * Parameters: [], * SelectOptions: [] * } * ``` * * * * @returns Value of property `selectionVariant` */ getSelectionVariant(): object; /** * Gets current value of property {@link #getSemanticDates semanticDates}. * * Structure containing Date range semantic data of the filter value. * * * ```javascript * * { * Dates: [ * { * PropertyName: string, * Data: { * calendarType: string, * key: string, * operation: string, * value1: int, * value2: int * } * } * ] * } * ``` * * * * @returns Value of property `semanticDates` */ getSemanticDates(): object; /** * Gets current value of property {@link #getTableSettings tableSettings}. * * Structure containing table related settings. The properties might be related to a specific table type * and will be ignored if a different table type is used. * * * ```javascript * * { * fixedColumnCount: int, * showDetails: boolean * } * ``` * * * * @returns Value of property `tableSettings` */ getTableSettings(): object; /** * Gets current value of property {@link #getValueTexts valueTexts}. * * Structure containing filter value keys and its corresponding descriptions. * * * ```javascript * * { * Texts: [ * { * Language: string, * ContextUrl: string, * PropertyTexts: [ * { * PropertyName: string, * ValueTexts: [ * { * PropertyValue: string, * Text: string * } * ] * } * ] * } * ] * } * ``` * * * * @returns Value of property `valueTexts` */ getValueTexts(): object; /** * Gets current value of property {@link #getVariantName variantName}. * * Variant name. * * * @returns Value of property `variantName` */ getVariantName(): string; /** * Sets a new value for property {@link #getDefaultValues defaultValues}. * * Structure containing field names that use the DefaultValues operation. * * * ```javascript * * { * Fields: [ * { * PropertyName: string * } * ] * } * ``` * * * 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 */ setDefaultValues( /** * New value for property `defaultValues` */ oDefaultValues: object ): this; /** * Sets a new value for property {@link #getOrderedItems orderedItems}. * * Structure defining the order of filter items. * * * ```javascript * * { * orderedItems: [ * { * group: string, * name: string * } * ] * } * ``` * * * 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 */ setOrderedItems( /** * New value for property `orderedItems` */ oOrderedItems: object ): this; /** * Sets a new value for property {@link #getPresentationVariant presentationVariant}. * * Object representing the presentation variant. The structure looks like: * * * ```javascript * * { * ContextUrl: {string}, * MaxItems: {int}, * SortOrder: [], * GroupBy: [], * Total: [], * RequestAtLeast: [], * Visualizations: [] * } * ``` * * * **Note:** * - `PresentationVariantID` property is not provided * - `Text` property is not provided because it is translated text * - `TotalBy` is not supported yet * - `IncludeGrandTotal` is not supported yet * - `InitialExpansionLevel` is not supported yet * - `Title` of `Visualizations.Content` property is not provided because it is translated text * - `Description` of `Visualizations.Content` property is not provided because it is translated text * `VariantName` property is not part of specified DataSuiteFormat yet * * 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 */ setPresentationVariant( /** * New value for property `presentationVariant` */ oPresentationVariant: object ): this; /** * Sets a new value for property {@link #getSelectionVariant selectionVariant}. * * Object representing the selection variant. The structure looks like: * * * ```javascript * * { * SelectionVariant: { * SelectionVariantID: {string}, * Parameters: [], * SelectOptions: [] * } * ``` * * * 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 */ setSelectionVariant( /** * New value for property `selectionVariant` */ oSelectionVariant: object ): this; /** * Sets a new value for property {@link #getSemanticDates semanticDates}. * * Structure containing Date range semantic data of the filter value. * * * ```javascript * * { * Dates: [ * { * PropertyName: string, * Data: { * calendarType: string, * key: string, * operation: string, * value1: int, * value2: int * } * } * ] * } * ``` * * * 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 */ setSemanticDates( /** * New value for property `semanticDates` */ oSemanticDates: object ): this; /** * Sets a new value for property {@link #getTableSettings tableSettings}. * * Structure containing table related settings. The properties might be related to a specific table type * and will be ignored if a different table type is used. * * * ```javascript * * { * fixedColumnCount: int, * showDetails: boolean * } * ``` * * * 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 */ setTableSettings( /** * New value for property `tableSettings` */ oTableSettings: object ): this; /** * Sets a new value for property {@link #getValueTexts valueTexts}. * * Structure containing filter value keys and its corresponding descriptions. * * * ```javascript * * { * Texts: [ * { * Language: string, * ContextUrl: string, * PropertyTexts: [ * { * PropertyName: string, * ValueTexts: [ * { * PropertyValue: string, * Text: string * } * ] * } * ] * } * ] * } * ``` * * * 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 */ setValueTexts( /** * New value for property `valueTexts` */ oValueTexts: object ): this; /** * Sets a new value for property {@link #getVariantName variantName}. * * Variant name. * * 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 */ setVariantName( /** * New value for property `variantName` */ sVariantName: string ): this; } } namespace valuehelpdialog { /** * Describes the settings that can be provided to the ValueHelpDialog constructor. */ interface $ValueHelpDialogSettings extends sap.m.$DialogSettings { /** * Defines the value for the basic search field. The value is set into the basic search field of the filter * bar used. * * @since 1.24 */ basicSearchText?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Enables multi-selection in the table used. * * @since 1.24 */ supportMultiselect?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enables the ranges (conditions) feature in the dialog. * * @since 1.24 */ supportRanges?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If this property is set to `true`, the value help dialog only supports the ranges (conditions) feature. * * @since 1.24 */ supportRangesOnly?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the key of the column used for the internal key handling. The value of the column is used for * the token key and also to identify the row in the table. * * @since 1.24 */ key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines the list of additional keys of the column used for the internal key handling. * * @since 1.24 */ keys?: | string[] | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the key of the column used for the token text. * * @since 1.24 */ descriptionKey?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines the maximum number of include ranges. If value is 0 - the include group of operators should not * be displayed. * * @deprecated As of version 1.84.1. replaced by `maxConditions`. */ maxIncludeRanges?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines the maximum number of exclude ranges. If value is 0 - the exclude group of operators should not * be displayed. * * @deprecated As of version 1.84.1. replaced by `maxConditions`. */ maxExcludeRanges?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Defines the maximum number of conditions allowed to be added. * * @since 1.84.1 */ maxConditions?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Represents the display format of the range values. With the `displayFormat` value UpperCase, the entered * value of the range (condition) is converted to uppercase letters. * * @since 1.24 */ displayFormat?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Represents how the item token text should be displayed in ValueHelpDialog. Use one of the valid `sap.ui.comp.smartfilterbar.DisplayBehaviour` * values. * * @since 1.24 */ tokenDisplayBehaviour?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens. * * @since 1.24 */ filterMode?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Sets usage of `MultiSelectionPlugin`. If enabled the default behaviour is changed and the `ValueHelpDialog` * table uses the plugin which provides only "Deselect all" option and the ability for range selection. * Also a limit of 200 items that are able to be selected as a restriction. * * Note: Using `MultiSelectionPlugin` mode the method `update` will return a promise. * * @since 1.113 */ enabledMultiSelectionPlugin?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Allows you to add a {@link sap.ui.comp.filterbar.FilterBar FilterBar} or {@link sap.ui.comp.smartfilterbar.SmartFilterBar SmartFilterBar } * control to the value help dialog. */ filterBar?: sap.ui.comp.filterbar.FilterBar; /** * This event is fired when the OK button is pressed. * * @since 1.24 */ ok?: (oEvent: ValueHelpDialog$OkEvent) => void; /** * This event is fired when the Cancel button is pressed. * * @since 1.24 */ cancel?: (oEvent: sap.ui.base.Event) => void; /** * This event is fired when the user selects an item in the items table. * * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`. * * @since 1.32 */ selectionChange?: ( oEvent: ValueHelpDialog$SelectionChangeEvent ) => void; /** * This event is fired when the user removes one or multiple existing token(s) from the dialog. * * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`. * * @since 1.32 */ tokenRemove?: (oEvent: ValueHelpDialog$TokenRemoveEvent) => void; /** * This event is fired when the table gets an update and all existing tokens must be selected in the table. * * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`. * * @since 1.32 */ updateSelection?: ( oEvent: ValueHelpDialog$UpdateSelectionEvent ) => void; } /** * Parameters of the ValueHelpDialog#cancel event. */ interface ValueHelpDialog$CancelEventParameters {} /** * Parameters of the ValueHelpDialog#ok event. */ interface ValueHelpDialog$OkEventParameters { /** * The array of tokens created or modified on the ValueHelpDialog. */ tokens?: sap.m.Token[]; } /** * Parameters of the ValueHelpDialog#selectionChange event. */ interface ValueHelpDialog$SelectionChangeEventParameters { /** * The RowSelectionChange event parameter from the hosted table that contains the selected items. */ tableSelectionParams?: object; /** * Returns an array of objects which represents all selected row tokens. The object contains the token key, * the row object data from the model, and the information if the token is selected. ` [{sKey, oRow, bSelect}, * ...] ` */ updateTokens?: object[]; /** * When the value is `true`, then the default behavior of `ValueHelpDialog` will be executed. */ useDefault?: boolean; /** * The table instance used */ table?: object; } /** * Parameters of the ValueHelpDialog#tokenRemove event. */ interface ValueHelpDialog$TokenRemoveEventParameters { /** * The array of token keys that has been removed. */ tokenKeys?: string[]; /** * When the value is `true`, then the default behavior of `ValueHelpDialog` will be executed. */ useDefault?: boolean; } /** * Parameters of the ValueHelpDialog#updateSelection event. */ interface ValueHelpDialog$UpdateSelectionEventParameters { /** * The array of existing token keys for which the selection in the table has to be updated. */ tokenKeys?: string[]; /** * When the value is `true`, then the default behavior of `ValueHelpDialog` will be executed. */ useDefault?: boolean; } /** * Overview: The ValueHelpDialog helps the user to find and select single and multiple * values. The user can also define and select multiple conditions. The control is generally called from * an input field or a multi-input field by clicking the selection icon (value help icon) of the input field. * * This control only supports OData V2 model (see {@link sap.ui.model.odata.v2.ODataModel}) * * Usage: When to use:: * - The user is searching within a very large dataset * - The user needs to use different attributes to find an object (such as city, company name, and so * on). * - The user needs to define conditions, such as ranges and exclusions. When not to use:: * - There is a simpler control that fits the use case. Always start with the least complex control. For * example, use the select control if the user needs to select only one item from a short list. */ class ValueHelpDialog extends sap.m.Dialog { /** * Constructor for a new valuehelpdialog/ValueHelpDialog. * * 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.ui.comp.valuehelpdialog.$ValueHelpDialogSettings ); /** * Constructor for a new valuehelpdialog/ValueHelpDialog. * * 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.ui.comp.valuehelpdialog.$ValueHelpDialogSettings ); /** * Creates a new subclass of class sap.ui.comp.valuehelpdialog.ValueHelpDialog 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.Dialog.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< T, sap.ui.comp.valuehelpdialog.ValueHelpDialog >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.valuehelpdialog.ValueHelpDialog. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.comp.valuehelpdialog.ValueHelpDialog`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` itself. * * This event is fired when the Cancel button is pressed. * * @since 1.24 * * @returns Reference to `this` in order to allow method chaining */ attachCancel( /** * 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: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:cancel cancel} event of this `sap.ui.comp.valuehelpdialog.ValueHelpDialog`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` itself. * * This event is fired when the Cancel button is pressed. * * @since 1.24 * * @returns Reference to `this` in order to allow method chaining */ attachCancel( /** * The function to be called when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:ok ok} event of this `sap.ui.comp.valuehelpdialog.ValueHelpDialog`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` itself. * * This event is fired when the OK button is pressed. * * @since 1.24 * * @returns Reference to `this` in order to allow method chaining */ attachOk( /** * 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: ValueHelpDialog$OkEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:ok ok} event of this `sap.ui.comp.valuehelpdialog.ValueHelpDialog`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` itself. * * This event is fired when the OK button is pressed. * * @since 1.24 * * @returns Reference to `this` in order to allow method chaining */ attachOk( /** * The function to be called when the event occurs */ fnFunction: (p1: ValueHelpDialog$OkEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this * `sap.ui.comp.valuehelpdialog.ValueHelpDialog`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` itself. * * This event is fired when the user selects an item in the items table. * * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`. * * @since 1.32 * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: ValueHelpDialog$SelectionChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:selectionChange selectionChange} event of this * `sap.ui.comp.valuehelpdialog.ValueHelpDialog`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` itself. * * This event is fired when the user selects an item in the items table. * * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`. * * @since 1.32 * * @returns Reference to `this` in order to allow method chaining */ attachSelectionChange( /** * The function to be called when the event occurs */ fnFunction: (p1: ValueHelpDialog$SelectionChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:tokenRemove tokenRemove} event of this `sap.ui.comp.valuehelpdialog.ValueHelpDialog`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` itself. * * This event is fired when the user removes one or multiple existing token(s) from the dialog. * * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`. * * @since 1.32 * * @returns Reference to `this` in order to allow method chaining */ attachTokenRemove( /** * 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: ValueHelpDialog$TokenRemoveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:tokenRemove tokenRemove} event of this `sap.ui.comp.valuehelpdialog.ValueHelpDialog`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` itself. * * This event is fired when the user removes one or multiple existing token(s) from the dialog. * * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`. * * @since 1.32 * * @returns Reference to `this` in order to allow method chaining */ attachTokenRemove( /** * The function to be called when the event occurs */ fnFunction: (p1: ValueHelpDialog$TokenRemoveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:updateSelection updateSelection} event of this * `sap.ui.comp.valuehelpdialog.ValueHelpDialog`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` itself. * * This event is fired when the table gets an update and all existing tokens must be selected in the table. * * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`. * * @since 1.32 * * @returns Reference to `this` in order to allow method chaining */ attachUpdateSelection( /** * 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: ValueHelpDialog$UpdateSelectionEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:updateSelection updateSelection} event of this * `sap.ui.comp.valuehelpdialog.ValueHelpDialog`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` itself. * * This event is fired when the table gets an update and all existing tokens must be selected in the table. * * **Note:** The event will only be raised when the dialog gets a table instance from outside via `setTable`. * * @since 1.32 * * @returns Reference to `this` in order to allow method chaining */ attachUpdateSelection( /** * The function to be called when the event occurs */ fnFunction: (p1: ValueHelpDialog$UpdateSelectionEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.valuehelpdialog.ValueHelpDialog` * itself */ oListener?: object ): this; /** * Destroys the filterBar in the aggregation {@link #getFilterBar filterBar}. * * * @returns Reference to `this` in order to allow method chaining */ destroyFilterBar(): this; /** * Detaches event handler `fnFunction` from the {@link #event:cancel cancel} event of this `sap.ui.comp.valuehelpdialog.ValueHelpDialog`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.24 * * @returns Reference to `this` in order to allow method chaining */ detachCancel( /** * The function to be called, when the event occurs */ fnFunction: (p1: sap.ui.base.Event) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:ok ok} event of this `sap.ui.comp.valuehelpdialog.ValueHelpDialog`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.24 * * @returns Reference to `this` in order to allow method chaining */ detachOk( /** * The function to be called, when the event occurs */ fnFunction: (p1: ValueHelpDialog$OkEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:selectionChange selectionChange} event of * this `sap.ui.comp.valuehelpdialog.ValueHelpDialog`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.32 * * @returns Reference to `this` in order to allow method chaining */ detachSelectionChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: ValueHelpDialog$SelectionChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:tokenRemove tokenRemove} event of this `sap.ui.comp.valuehelpdialog.ValueHelpDialog`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.32 * * @returns Reference to `this` in order to allow method chaining */ detachTokenRemove( /** * The function to be called, when the event occurs */ fnFunction: (p1: ValueHelpDialog$TokenRemoveEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:updateSelection updateSelection} event of * this `sap.ui.comp.valuehelpdialog.ValueHelpDialog`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.32 * * @returns Reference to `this` in order to allow method chaining */ detachUpdateSelection( /** * The function to be called, when the event occurs */ fnFunction: (p1: ValueHelpDialog$UpdateSelectionEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:cancel cancel} to attached listeners. * * @since 1.24 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireCancel( /** * Parameters to pass along with the event */ mParameters?: object ): this; /** * Fires event {@link #event:ok ok} to attached listeners. * * @since 1.24 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireOk( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.valuehelpdialog.ValueHelpDialog$OkEventParameters ): this; /** * Fires event {@link #event:selectionChange selectionChange} to attached listeners. * * @since 1.32 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSelectionChange( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.valuehelpdialog.ValueHelpDialog$SelectionChangeEventParameters ): this; /** * Fires event {@link #event:tokenRemove tokenRemove} to attached listeners. * * @since 1.32 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireTokenRemove( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.valuehelpdialog.ValueHelpDialog$TokenRemoveEventParameters ): this; /** * Fires event {@link #event:updateSelection updateSelection} to attached listeners. * * @since 1.32 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireUpdateSelection( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.valuehelpdialog.ValueHelpDialog$UpdateSelectionEventParameters ): this; /** * Gets current value of property {@link #getBasicSearchText basicSearchText}. * * Defines the value for the basic search field. The value is set into the basic search field of the filter * bar used. * * Default value is `empty string`. * * @since 1.24 * * @returns Value of property `basicSearchText` */ getBasicSearchText(): string; /** * Gets current value of property {@link #getDescriptionKey descriptionKey}. * * Defines the key of the column used for the token text. * * Default value is `empty string`. * * @since 1.24 * * @returns Value of property `descriptionKey` */ getDescriptionKey(): string; /** * Gets current value of property {@link #getDisplayFormat displayFormat}. * * Represents the display format of the range values. With the `displayFormat` value UpperCase, the entered * value of the range (condition) is converted to uppercase letters. * * Default value is `empty string`. * * @since 1.24 * * @returns Value of property `displayFormat` */ getDisplayFormat(): string; /** * Gets current value of property {@link #getEnabledMultiSelectionPlugin enabledMultiSelectionPlugin}. * * Sets usage of `MultiSelectionPlugin`. If enabled the default behaviour is changed and the `ValueHelpDialog` * table uses the plugin which provides only "Deselect all" option and the ability for range selection. * Also a limit of 200 items that are able to be selected as a restriction. * * Note: Using `MultiSelectionPlugin` mode the method `update` will return a promise. * * Default value is `false`. * * @since 1.113 * * @returns Value of property `enabledMultiSelectionPlugin` */ getEnabledMultiSelectionPlugin(): boolean; /** * Gets content of aggregation {@link #getFilterBar filterBar}. * * Allows you to add a {@link sap.ui.comp.filterbar.FilterBar FilterBar} or {@link sap.ui.comp.smartfilterbar.SmartFilterBar SmartFilterBar } * control to the value help dialog. */ getFilterBar(): sap.ui.comp.filterbar.FilterBar; /** * Gets current value of property {@link #getFilterMode filterMode}. * * Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens. * * Default value is `false`. * * @since 1.24 * * @returns Value of property `filterMode` */ getFilterMode(): boolean; /** * Gets current value of property {@link #getKey key}. * * Defines the key of the column used for the internal key handling. The value of the column is used for * the token key and also to identify the row in the table. * * Default value is `empty string`. * * @since 1.24 * * @returns Value of property `key` */ getKey(): string; /** * Gets current value of property {@link #getKeys keys}. * * Defines the list of additional keys of the column used for the internal key handling. * * @since 1.24 * * @returns Value of property `keys` */ getKeys(): string[]; /** * Gets current value of property {@link #getMaxConditions maxConditions}. * * Defines the maximum number of conditions allowed to be added. * * Default value is `'-1'`. * * @since 1.84.1 * * @returns Value of property `maxConditions` */ getMaxConditions(): string; /** * Gets current value of property {@link #getMaxExcludeRanges maxExcludeRanges}. * * Defines the maximum number of exclude ranges. If value is 0 - the exclude group of operators should not * be displayed. * * Default value is `'-1'`. * * @deprecated As of version 1.84.1. replaced by `maxConditions`. * * @returns Value of property `maxExcludeRanges` */ getMaxExcludeRanges(): string; /** * Gets current value of property {@link #getMaxIncludeRanges maxIncludeRanges}. * * Defines the maximum number of include ranges. If value is 0 - the include group of operators should not * be displayed. * * Default value is `'-1'`. * * @deprecated As of version 1.84.1. replaced by `maxConditions`. * * @returns Value of property `maxIncludeRanges` */ getMaxIncludeRanges(): string; /** * Gets current value of property {@link #getSupportMultiselect supportMultiselect}. * * Enables multi-selection in the table used. * * Default value is `true`. * * @since 1.24 * * @returns Value of property `supportMultiselect` */ getSupportMultiselect(): boolean; /** * Gets current value of property {@link #getSupportRanges supportRanges}. * * Enables the ranges (conditions) feature in the dialog. * * Default value is `false`. * * @since 1.24 * * @returns Value of property `supportRanges` */ getSupportRanges(): boolean; /** * Gets current value of property {@link #getSupportRangesOnly supportRangesOnly}. * * If this property is set to `true`, the value help dialog only supports the ranges (conditions) feature. * * Default value is `false`. * * @since 1.24 * * @returns Value of property `supportRangesOnly` */ getSupportRangesOnly(): boolean; /** * Gives access to the internal table instance. * * @since 1.28 * @deprecated As of version 1.60.0. replaced by {@link sap.ui.comp.valuehelpdialog.ValueHelpDialog#getTableAsync } * to prevent synchronous calls. * * @returns the used table instance */ getTable(): | sap.m.Table | sap.ui.table.Table | sap.ui.comp.smarttable.SmartTable; /** * Gives access to the internal table instance. * * @since 1.58 * * @returns Promise that, if resolved, returns the table object */ getTableAsync(): Promise< Record< string, | sap.m.Table | sap.ui.table.Table | sap.ui.comp.smarttable.SmartTable > >; /** * Gets current value of property {@link #getTokenDisplayBehaviour tokenDisplayBehaviour}. * * Represents how the item token text should be displayed in ValueHelpDialog. Use one of the valid `sap.ui.comp.smartfilterbar.DisplayBehaviour` * values. * * Default value is `empty string`. * * @since 1.24 * * @returns Value of property `tokenDisplayBehaviour` */ getTokenDisplayBehaviour(): string; /** * Sets a new value for property {@link #getBasicSearchText basicSearchText}. * * Defines the value for the basic search field. The value is set into the basic search field of the filter * bar used. * * 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.24 * * @returns Reference to `this` in order to allow method chaining */ setBasicSearchText( /** * New value for property `basicSearchText` */ sBasicSearchText?: string ): this; /** * Sets a new value for property {@link #getDescriptionKey descriptionKey}. * * Defines the key of the column used for the token text. * * 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.24 * * @returns Reference to `this` in order to allow method chaining */ setDescriptionKey( /** * New value for property `descriptionKey` */ sDescriptionKey?: string ): this; /** * Sets a new value for property {@link #getDisplayFormat displayFormat}. * * Represents the display format of the range values. With the `displayFormat` value UpperCase, the entered * value of the range (condition) is converted to uppercase letters. * * 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.24 * * @returns Reference to `this` in order to allow method chaining */ setDisplayFormat( /** * New value for property `displayFormat` */ sDisplayFormat?: string ): this; /** * Sets a new value for property {@link #getEnabledMultiSelectionPlugin enabledMultiSelectionPlugin}. * * Sets usage of `MultiSelectionPlugin`. If enabled the default behaviour is changed and the `ValueHelpDialog` * table uses the plugin which provides only "Deselect all" option and the ability for range selection. * Also a limit of 200 items that are able to be selected as a restriction. * * Note: Using `MultiSelectionPlugin` mode the method `update` will return a promise. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.113 * * @returns Reference to `this` in order to allow method chaining */ setEnabledMultiSelectionPlugin( /** * New value for property `enabledMultiSelectionPlugin` */ bEnabledMultiSelectionPlugin?: boolean ): this; /** * Sets the array for the supported exclude range operations. * * @since 1.24 */ setExcludeRangeOperations( /** * An array of range operations */ aOperation: sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation[], /** * the type for which the operations are defined */ sType: string ): void; /** * Sets the aggregated {@link #getFilterBar filterBar}. * * * @returns Reference to `this` in order to allow method chaining */ setFilterBar( /** * The filterBar to set */ oFilterBar: sap.ui.comp.filterbar.FilterBar ): this; /** * Sets a new value for property {@link #getFilterMode filterMode}. * * Sets the dialog into a filter mode, which only shows ranges (conditions) and hides the tokens. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.24 * * @returns Reference to `this` in order to allow method chaining */ setFilterMode( /** * New value for property `filterMode` */ bFilterMode?: boolean ): this; /** * Sets the array for the supported include range operations. * * @since 1.24 */ setIncludeRangeOperations( /** * An array of range operations */ aOperation: sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation[], /** * the type for which the operations are defined */ sType: string ): void; /** * Sets a new value for property {@link #getKey key}. * * Defines the key of the column used for the internal key handling. The value of the column is used for * the token key and also to identify the row in the table. * * 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.24 * * @returns Reference to `this` in order to allow method chaining */ setKey( /** * New value for property `key` */ sKey?: string ): this; /** * Sets a new value for property {@link #getKeys keys}. * * Defines the list of additional keys of the column used for the internal key handling. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.24 * * @returns Reference to `this` in order to allow method chaining */ setKeys( /** * New value for property `keys` */ sKeys?: string[] ): this; /** * Sets a new value for property {@link #getMaxConditions maxConditions}. * * Defines the maximum number of conditions allowed to be added. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'-1'`. * * @since 1.84.1 * * @returns Reference to `this` in order to allow method chaining */ setMaxConditions( /** * New value for property `maxConditions` */ sMaxConditions?: string ): this; /** * Sets a new value for property {@link #getMaxExcludeRanges maxExcludeRanges}. * * Defines the maximum number of exclude ranges. If value is 0 - the exclude group of operators should not * be displayed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'-1'`. * * @deprecated As of version 1.84.1. replaced by `maxConditions`. * * @returns Reference to `this` in order to allow method chaining */ setMaxExcludeRanges( /** * New value for property `maxExcludeRanges` */ sMaxExcludeRanges?: string ): this; /** * Sets a new value for property {@link #getMaxIncludeRanges maxIncludeRanges}. * * Defines the maximum number of include ranges. If value is 0 - the include group of operators should not * be displayed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `'-1'`. * * @deprecated As of version 1.84.1. replaced by `maxConditions`. * * @returns Reference to `this` in order to allow method chaining */ setMaxIncludeRanges( /** * New value for property `maxIncludeRanges` */ sMaxIncludeRanges?: string ): this; /** * Sets a RangeKeyFields array. This method allows you to specify the KeyFields for the ranges. You can * set an array of objects with Key and Label properties to define the key fields. * * @since 1.24 */ setRangeKeyFields( /** * An array of range KeyFields `[{key: "CompanyCode", label: "ID"}, {key:"CompanyName", label : "Name"}]` */ aRangeKeyFields: Record ): void; /** * Sets a new value for property {@link #getSupportMultiselect supportMultiselect}. * * Enables multi-selection in the table used. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.24 * * @returns Reference to `this` in order to allow method chaining */ setSupportMultiselect( /** * New value for property `supportMultiselect` */ bSupportMultiselect?: boolean ): this; /** * Sets a new value for property {@link #getSupportRanges supportRanges}. * * Enables the ranges (conditions) feature in the dialog. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.24 * * @returns Reference to `this` in order to allow method chaining */ setSupportRanges( /** * New value for property `supportRanges` */ bSupportRanges?: boolean ): this; /** * Sets a new value for property {@link #getSupportRangesOnly supportRangesOnly}. * * If this property is set to `true`, the value help dialog only supports the ranges (conditions) feature. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.24 * * @returns Reference to `this` in order to allow method chaining */ setSupportRangesOnly( /** * New value for property `supportRangesOnly` */ bSupportRangesOnly?: boolean ): this; /** * Sets the table used in the value help dialog. If not used, the dialog creates a sap.ui.table.Table or * sap.m.Table instance internally. * * @since 1.32 */ setTable( /** * The used table control instance */ oTable: | sap.m.Table | sap.ui.table.Table | sap.ui.comp.smarttable.SmartTable ): void; /** * Sets a new value for property {@link #getTokenDisplayBehaviour tokenDisplayBehaviour}. * * Represents how the item token text should be displayed in ValueHelpDialog. Use one of the valid `sap.ui.comp.smartfilterbar.DisplayBehaviour` * values. * * 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.24 * * @returns Reference to `this` in order to allow method chaining */ setTokenDisplayBehaviour( /** * New value for property `tokenDisplayBehaviour` */ sTokenDisplayBehaviour?: string ): this; /** * Sets the array of tokens. The `sap.m.Token`s are added to the dialog tokenizer. Normal tokens are selected * in the table. `new sap.m.Token({key: "0001", text:"SAP A.G. (0001)"});` Tokens with the extra data with * value 'range' are handled as range tokens or exclude range tokens. ` new sap.m.Token({key: "i1", text: * "ID: a..z"}).data("range", { "exclude": false, "operation": sap.ui.comp.valuehelpdialog.ValueHelpRangeOperation.BT, * "keyField": "CompanyCode", "value1": "a", "value2": "z"}); ` The selected items or range tokens are returned * in the event parameters of the Ok event. * * @since 1.24 */ setTokens( /** * An array of token controls */ aTokens: sap.m.Token[] ): void; /** * Updates the selection of rows in the table. This function must be called after a first binding or binding * update of the table. It will set a table row as selected if a token for this row exists. * * @since 1.24 */ update(): void; } /** * The range operations supported by the `ValueHelpDialog` control. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'valuehelpdialog.ValueHelpRangeOperation'. */ enum ValueHelpRangeOperation { /** * The Between operation for the ranges. */ BT = "BT", /** * The Contains operation for the ranges. */ Contains = "Contains", /** * The EndsWith operation for the ranges. */ EndsWith = "EndsWith", /** * The Equals operation for the ranges. */ EQ = "EQ", /** * The Between or equals operation for the ranges. */ GE = "GE", /** * The Greater operation for the ranges. */ GT = "GT", /** * The Less or equals operation for the ranges. */ LE = "LE", /** * The Less operation for the ranges. */ LT = "LT", /** * The StartsWith operation for the ranges. */ StartsWith = "StartsWith", } /** * Event object of the ValueHelpDialog#cancel event. */ type ValueHelpDialog$CancelEvent = sap.ui.base.Event< ValueHelpDialog$CancelEventParameters, ValueHelpDialog >; /** * Event object of the ValueHelpDialog#ok event. */ type ValueHelpDialog$OkEvent = sap.ui.base.Event< ValueHelpDialog$OkEventParameters, ValueHelpDialog >; /** * Event object of the ValueHelpDialog#selectionChange event. */ type ValueHelpDialog$SelectionChangeEvent = sap.ui.base.Event< ValueHelpDialog$SelectionChangeEventParameters, ValueHelpDialog >; /** * Event object of the ValueHelpDialog#tokenRemove event. */ type ValueHelpDialog$TokenRemoveEvent = sap.ui.base.Event< ValueHelpDialog$TokenRemoveEventParameters, ValueHelpDialog >; /** * Event object of the ValueHelpDialog#updateSelection event. */ type ValueHelpDialog$UpdateSelectionEvent = sap.ui.base.Event< ValueHelpDialog$UpdateSelectionEventParameters, ValueHelpDialog >; } namespace variants { /** * Describes the settings that can be provided to the EditableVariantItem constructor. * * @deprecated As of version 1.120.0. the concept has been discarded. */ interface $EditableVariantItemSettings extends sap.m.$ColumnListItemSettings { /** * Key of the List Item * * @since 1.22.0 */ key?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Indicator if a variant is visible for all users. * * @since 1.26.0 */ global?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * ABAP Package the variant is assigned. Used for transport functionality * * @since 1.26.0 */ lifecyclePackage?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Identifier of the transport object the variant is assigned to. * * @since 1.26.0 */ lifecycleTransportId?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Variant namespace * * @since 1.26.0 */ namespace?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Indication if variant can be changed * * @since 1.26.0 */ readOnly?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Flags for a variant to indicate why it might be read-only * * @since 1.26.0 * @deprecated As of version 1.28.0. Replaced by property `labelReadOnly` */ accessOptions?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Indicates if the variant label can be changed * * @since 1.28.0 */ labelReadOnly?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Author of the variant * * @since 1.38.0 */ author?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Indicates if favorites can be created. * * @since 1.50.0 */ favorite?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; } /** * Describes the settings that can be provided to the VariantItem constructor. */ interface $VariantItemSettings extends sap.m.$VariantItemSettings { /** * Attribute for usage in `SmartFilterBar` * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. */ executeOnSelection?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * If set to `false`, the user is allowed to change the item's data * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. */ readOnly?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Identifier of the transport object the variant is assigned to. * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. */ lifecycleTransportId?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Indicator if a variant is visible for all users. * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. */ global?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * ABAP package the variant is assigned to. Used for transport functionality. * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. */ lifecyclePackage?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Variant namespace * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. */ namespace?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Flags for a variant to indicate why it might be read-only. * * @since 1.26.0 * @deprecated As of version 1.28.0. Replaced by property `labelReadOnly` */ accessOptions?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Indicates if the variant title can be changed. * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. */ labelReadOnly?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * This event is fired when one of the properties is changed. */ change?: (oEvent: VariantItem$ChangeEvent) => void; } /** * Describes the settings that can be provided to the VariantManagement constructor. * * @deprecated As of version 1.120.0. replaced by the {@link sap.m.VariantManagement} control. */ interface $VariantManagementSettings extends sap.ui.core.$ControlSettings { /** * Enables the setting of the initially selected variant. * * @since 1.22.0 */ initialSelectionKey?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Can be set to true or false depending on whether you want to enable or disable the control. * * @since 1.22.0 */ enabled?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Provides a string value to set the default variant. Used for the save dialog. Has no effect on the selected * variant. * * @since 1.22.0 */ defaultVariantKey?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * The key of the currently selected item. Returns null if the default item list is selected. This property * is calculated when accessing it via the getSelectionKey method. The corresponding setSelectionKey method * is not supported. The access via the standard set/getProperty is also not supported. * * @since 1.24.0 */ selectionKey?: string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Indicates that a Create Tile is visible in the Create dialog. * * @since 1.26.0 */ showCreateTile?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates that Execute on Selection is visible in the Save Variant and the Manage Variants dialogs. * * @since 1.26.0 */ showExecuteOnSelection?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates that the Public checkbox is visible in the Save View and the Manage Views dialogs. Selecting * this checkbox allows you to share variants with other users. * * @since 1.26.0 */ showShare?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates that set as default is visible in the Save Variant and the Manage Variants dialogs. * * @since 1.44.0 */ showSetAsDefault?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Enables the lifecycle support. If set to true, the VariantManagement control handles the transport information * for shared variants. * * @since 1.26.0 */ lifecycleSupport?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Overwrites the default Standard variant title. * * @since 1.28.0 */ standardItemText?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Indicates that the 'Favorites' feature is used. Only variants marked as favorites will be displayed in * the variant list. * * @since 1.50.0 */ useFavorites?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates that the control is in error state. If set to `true` error message will be displayed whenever * the variant is opened. * * @since 1.52.0 */ inErrorState?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Indicates that end users are allowed to create variants. * * @since 1.85 */ variantCreationByUserAllowed?: | boolean | sap.ui.base.ManagedObject.PropertyBindingInfo | `{${string}}`; /** * Defines the author of the standard variant, for example, the name of the own company. * * @since 1.86 */ standardItemAuthor?: | string | sap.ui.base.ManagedObject.PropertyBindingInfo; /** * Items displayed by the `VariantManagement` control. * * @since 1.22.0 * @deprecated As of version 1.26. replaced by the `variantItems` aggregation */ items?: | sap.ui.core.Item[] | sap.ui.core.Item | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * Variant items displayed by the `VariantManagement` control. * * @since 1.26.0 */ variantItems?: | sap.ui.comp.variants.VariantItem[] | sap.ui.comp.variants.VariantItem | sap.ui.base.ManagedObject.AggregationBindingInfo | `{${string}}`; /** * This event is fired when the Save Variant dialog is closed with OK for a variant. * * @since 1.22.0 */ save?: (oEvent: VariantManagement$SaveEvent) => void; /** * This event is fired when users apply changes to variants in the Manage Variants dialog. * * @since 1.22.0 */ manage?: (oEvent: VariantManagement$ManageEvent) => void; /** * This event is fired when a new variant is selected. * * @since 1.22.0 */ select?: (oEvent: VariantManagement$SelectEvent) => void; } /** * Parameters of the VariantItem#change event. */ interface VariantItem$ChangeEventParameters { /** * Name of the changed property */ propertyName?: string; } /** * Parameters of the VariantManagement#manage event. */ interface VariantManagement$ManageEventParameters { /** * List of changed variants. Each entry contains a 'key' - the variant key and a 'name' - the new title * of the variant */ renamed?: object[]; /** * List of deleted variant keys */ deleted?: string[]; /** * List of variant keys and the associated Execute on Selection indicator */ exe?: object[]; /** * The default variant key */ def?: string; } /** * Parameters of the VariantManagement#save event. */ interface VariantManagement$SaveEventParameters { /** * The variant title */ name?: string; /** * Indicates if an existing variant is overwritten or if a new variant is created */ overwrite?: boolean; /** * The variant key */ key?: string; /** * The Execute on Selection indicator */ exe?: boolean; /** * The default variant indicator */ def?: boolean; /** * The shared variant indicator */ global?: boolean; /** * The package name */ lifecyclePackage?: string; /** * The transport ID */ lifecycleTransportId?: string; } /** * Parameters of the VariantManagement#select event. */ interface VariantManagement$SelectEventParameters { /** * The variant key */ key?: string; } /** * The EditableVariantItem class describes an editable variant list item for the Manage Variants popup. * * @deprecated As of version 1.120.0. the concept has been discarded. */ class EditableVariantItem extends sap.m.ColumnListItem { /** * Constructor for a new variants/EditableVariantItem. * * 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.ui.comp.variants.$EditableVariantItemSettings ); /** * Constructor for a new variants/EditableVariantItem. * * 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.ui.comp.variants.$EditableVariantItemSettings ); /** * Creates a new subclass of class sap.ui.comp.variants.EditableVariantItem 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.ColumnListItem.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< T, sap.ui.comp.variants.EditableVariantItem >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.variants.EditableVariantItem. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Gets current value of property {@link #getAccessOptions accessOptions}. * * Flags for a variant to indicate why it might be read-only * * @since 1.26.0 * @deprecated As of version 1.28.0. Replaced by property `labelReadOnly` * * @returns Value of property `accessOptions` */ getAccessOptions(): string; /** * Gets current value of property {@link #getAuthor author}. * * Author of the variant * * @since 1.38.0 * * @returns Value of property `author` */ getAuthor(): string; /** * Gets current value of property {@link #getFavorite favorite}. * * Indicates if favorites can be created. * * Default value is `false`. * * @since 1.50.0 * * @returns Value of property `favorite` */ getFavorite(): boolean; /** * Gets current value of property {@link #getGlobal global}. * * Indicator if a variant is visible for all users. * * @since 1.26.0 * * @returns Value of property `global` */ getGlobal(): boolean; /** * Gets current value of property {@link #getKey key}. * * Key of the List Item * * @since 1.22.0 * * @returns Value of property `key` */ getKey(): string; /** * Gets current value of property {@link #getLabelReadOnly labelReadOnly}. * * Indicates if the variant label can be changed * * Default value is `false`. * * @since 1.28.0 * * @returns Value of property `labelReadOnly` */ getLabelReadOnly(): boolean; /** * Gets current value of property {@link #getLifecyclePackage lifecyclePackage}. * * ABAP Package the variant is assigned. Used for transport functionality * * @since 1.26.0 * * @returns Value of property `lifecyclePackage` */ getLifecyclePackage(): string; /** * Gets current value of property {@link #getLifecycleTransportId lifecycleTransportId}. * * Identifier of the transport object the variant is assigned to. * * @since 1.26.0 * * @returns Value of property `lifecycleTransportId` */ getLifecycleTransportId(): string; /** * Gets current value of property {@link #getNamespace namespace}. * * Variant namespace * * @since 1.26.0 * * @returns Value of property `namespace` */ getNamespace(): string; /** * Gets current value of property {@link #getReadOnly readOnly}. * * Indication if variant can be changed * * Default value is `false`. * * @since 1.26.0 * * @returns Value of property `readOnly` */ getReadOnly(): boolean; /** * Sets a new value for property {@link #getAccessOptions accessOptions}. * * Flags for a variant to indicate why it might be read-only * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.26.0 * @deprecated As of version 1.28.0. Replaced by property `labelReadOnly` * * @returns Reference to `this` in order to allow method chaining */ setAccessOptions( /** * New value for property `accessOptions` */ sAccessOptions?: string ): this; /** * Sets a new value for property {@link #getAuthor author}. * * Author of the variant * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.38.0 * * @returns Reference to `this` in order to allow method chaining */ setAuthor( /** * New value for property `author` */ sAuthor?: string ): this; /** * Sets a new value for property {@link #getFavorite favorite}. * * Indicates if favorites can be created. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.50.0 * * @returns Reference to `this` in order to allow method chaining */ setFavorite( /** * New value for property `favorite` */ bFavorite?: boolean ): this; /** * Sets a new value for property {@link #getGlobal global}. * * Indicator if a variant is visible for all users. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setGlobal( /** * New value for property `global` */ bGlobal?: boolean ): this; /** * Sets a new value for property {@link #getKey key}. * * Key of the List Item * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.22.0 * * @returns Reference to `this` in order to allow method chaining */ setKey( /** * New value for property `key` */ sKey?: string ): this; /** * Sets a new value for property {@link #getLabelReadOnly labelReadOnly}. * * Indicates if the variant label can be changed * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setLabelReadOnly( /** * New value for property `labelReadOnly` */ bLabelReadOnly?: boolean ): this; /** * Sets a new value for property {@link #getLifecyclePackage lifecyclePackage}. * * ABAP Package the variant is assigned. Used for transport functionality * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setLifecyclePackage( /** * New value for property `lifecyclePackage` */ sLifecyclePackage?: string ): this; /** * Sets a new value for property {@link #getLifecycleTransportId lifecycleTransportId}. * * Identifier of the transport object the variant is assigned to. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setLifecycleTransportId( /** * New value for property `lifecycleTransportId` */ sLifecycleTransportId?: string ): this; /** * Sets a new value for property {@link #getNamespace namespace}. * * Variant namespace * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setNamespace( /** * New value for property `namespace` */ sNamespace?: string ): this; /** * Sets a new value for property {@link #getReadOnly readOnly}. * * Indication if variant can be changed * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setReadOnly( /** * New value for property `readOnly` */ bReadOnly?: boolean ): this; } /** * The VariantItem class describes a variant item. */ class VariantItem extends sap.m.VariantItem { /** * Constructor for a new variants/VariantItem. * * 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.ui.comp.variants.$VariantItemSettings ); /** * Constructor for a new variants/VariantItem. * * 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.ui.comp.variants.$VariantItemSettings ); /** * Creates a new subclass of class sap.ui.comp.variants.VariantItem 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.VariantItem.extend}. * * * @returns Created class / constructor function */ static extend>( /** * Name of the class being created */ sClassName: string, /** * Object literal with information about the class */ oClassInfo?: sap.ClassInfo, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.variants.VariantItem. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.comp.variants.VariantItem`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.variants.VariantItem` itself. * * This event is fired when one of the properties is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * An application-specific payload object that will be passed to the event handler along with the event * object when firing the event */ oData: object, /** * The function to be called when the event occurs */ fnFunction: (p1: VariantItem$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.variants.VariantItem` itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:change change} event of this `sap.ui.comp.variants.VariantItem`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.variants.VariantItem` itself. * * This event is fired when one of the properties is changed. * * * @returns Reference to `this` in order to allow method chaining */ attachChange( /** * The function to be called when the event occurs */ fnFunction: (p1: VariantItem$ChangeEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.variants.VariantItem` itself */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:change change} event of this `sap.ui.comp.variants.VariantItem`. * * The passed function and listener object must match the ones used for event registration. * * * @returns Reference to `this` in order to allow method chaining */ detachChange( /** * The function to be called, when the event occurs */ fnFunction: (p1: VariantItem$ChangeEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:change change} to attached listeners. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireChange( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.variants.VariantItem$ChangeEventParameters ): this; /** * Gets current value of property {@link #getAccessOptions accessOptions}. * * Flags for a variant to indicate why it might be read-only. * * @since 1.26.0 * @deprecated As of version 1.28.0. Replaced by property `labelReadOnly` * * @returns Value of property `accessOptions` */ getAccessOptions(): string; /** * Gets current value of property {@link #getExecuteOnSelection executeOnSelection}. * * Attribute for usage in `SmartFilterBar` * * Default value is `false`. * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. * * @returns Value of property `executeOnSelection` */ getExecuteOnSelection(): boolean; /** * Gets current value of property {@link #getGlobal global}. * * Indicator if a variant is visible for all users. * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. * * @returns Value of property `global` */ getGlobal(): boolean; /** * Gets current value of property {@link #getLabelReadOnly labelReadOnly}. * * Indicates if the variant title can be changed. * * Default value is `false`. * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. * * @returns Value of property `labelReadOnly` */ getLabelReadOnly(): boolean; /** * Gets current value of property {@link #getLifecyclePackage lifecyclePackage}. * * ABAP package the variant is assigned to. Used for transport functionality. * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. * * @returns Value of property `lifecyclePackage` */ getLifecyclePackage(): string; /** * Gets current value of property {@link #getLifecycleTransportId lifecycleTransportId}. * * Identifier of the transport object the variant is assigned to. * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. * * @returns Value of property `lifecycleTransportId` */ getLifecycleTransportId(): string; /** * Gets current value of property {@link #getNamespace namespace}. * * Variant namespace * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. * * @returns Value of property `namespace` */ getNamespace(): string; /** * Gets current value of property {@link #getReadOnly readOnly}. * * If set to `false`, the user is allowed to change the item's data * * Default value is `false`. * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. * * @returns Value of property `readOnly` */ getReadOnly(): boolean; /** * Sets a new value for property {@link #getAccessOptions accessOptions}. * * Flags for a variant to indicate why it might be read-only. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.26.0 * @deprecated As of version 1.28.0. Replaced by property `labelReadOnly` * * @returns Reference to `this` in order to allow method chaining */ setAccessOptions( /** * New value for property `accessOptions` */ sAccessOptions?: string ): this; /** * Sets a new value for property {@link #getExecuteOnSelection executeOnSelection}. * * Attribute for usage in `SmartFilterBar` * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. * * @returns Reference to `this` in order to allow method chaining */ setExecuteOnSelection( /** * New value for property `executeOnSelection` */ bExecuteOnSelection?: boolean ): this; /** * Sets a new value for property {@link #getGlobal global}. * * Indicator if a variant is visible for all users. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. * * @returns Reference to `this` in order to allow method chaining */ setGlobal( /** * New value for property `global` */ bGlobal?: boolean ): this; /** * Sets a new value for property {@link #getLabelReadOnly labelReadOnly}. * * Indicates if the variant title can be changed. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. * * @returns Reference to `this` in order to allow method chaining */ setLabelReadOnly( /** * New value for property `labelReadOnly` */ bLabelReadOnly?: boolean ): this; /** * Sets a new value for property {@link #getLifecyclePackage lifecyclePackage}. * * ABAP package the variant is assigned to. Used for transport functionality. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. * * @returns Reference to `this` in order to allow method chaining */ setLifecyclePackage( /** * New value for property `lifecyclePackage` */ sLifecyclePackage?: string ): this; /** * Sets a new value for property {@link #getLifecycleTransportId lifecycleTransportId}. * * Identifier of the transport object the variant is assigned to. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. * * @returns Reference to `this` in order to allow method chaining */ setLifecycleTransportId( /** * New value for property `lifecycleTransportId` */ sLifecycleTransportId?: string ): this; /** * Sets a new value for property {@link #getNamespace namespace}. * * Variant namespace * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. * * @returns Reference to `this` in order to allow method chaining */ setNamespace( /** * New value for property `namespace` */ sNamespace?: string ): this; /** * Sets a new value for property {@link #getReadOnly readOnly}. * * If set to `false`, the user is allowed to change the item's data * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.26.0 * @deprecated As of version 1.120.0. the concept has been discarded. * * @returns Reference to `this` in order to allow method chaining */ setReadOnly( /** * New value for property `readOnly` */ bReadOnly?: boolean ): this; /** * Setter for text property. * * * @returns Reference to `this` to allow method chaining */ setText( /** * New text */ sText: string ): this; } /** * The VariantManagement control can be used to manage variants, such as filter bar variants or table variants. * * @deprecated As of version 1.120.0. replaced by the {@link sap.m.VariantManagement} control. */ class VariantManagement extends sap.ui.core.Control implements sap.m.IOverflowToolbarContent { __implements__sap_m_IOverflowToolbarContent: boolean; /** * Constructor for a new VariantManagement. * * 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.ui.comp.variants.$VariantManagementSettings ); /** * Constructor for a new VariantManagement. * * 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.ui.comp.variants.$VariantManagementSettings ); /** * Creates a new subclass of class sap.ui.comp.variants.VariantManagement 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< T, sap.ui.comp.variants.VariantManagement >, /** * Constructor function for the metadata object; if not given, it defaults to the metadata implementation * used by this class */ FNMetaImpl?: Function ): Function; /** * Returns a metadata object for class sap.ui.comp.variants.VariantManagement. * * * @returns Metadata object describing this class */ static getMetadata(): sap.ui.core.ElementMetadata; /** * Adds some item to the aggregation {@link #getItems items}. * * @since 1.22.0 * @deprecated As of version 1.26. replaced by the `variantItems` aggregation * * @returns Reference to `this` in order to allow method chaining */ addItem( /** * The item to add; if empty, nothing is inserted */ oItem: sap.ui.core.Item ): this; /** * Adds some variantItem to the aggregation {@link #getVariantItems variantItems}. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ addVariantItem( /** * The variantItem to add; if empty, nothing is inserted */ oVariantItem: sap.ui.comp.variants.VariantItem ): this; /** * Attaches event handler `fnFunction` to the {@link #event:manage manage} event of this `sap.ui.comp.variants.VariantManagement`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.variants.VariantManagement` itself. * * This event is fired when users apply changes to variants in the Manage Variants dialog. * * @since 1.22.0 * * @returns Reference to `this` in order to allow method chaining */ attachManage( /** * 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: VariantManagement$ManageEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.variants.VariantManagement` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:manage manage} event of this `sap.ui.comp.variants.VariantManagement`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.variants.VariantManagement` itself. * * This event is fired when users apply changes to variants in the Manage Variants dialog. * * @since 1.22.0 * * @returns Reference to `this` in order to allow method chaining */ attachManage( /** * The function to be called when the event occurs */ fnFunction: (p1: VariantManagement$ManageEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.variants.VariantManagement` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:save save} event of this `sap.ui.comp.variants.VariantManagement`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.variants.VariantManagement` itself. * * This event is fired when the Save Variant dialog is closed with OK for a variant. * * @since 1.22.0 * * @returns Reference to `this` in order to allow method chaining */ attachSave( /** * 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: VariantManagement$SaveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.variants.VariantManagement` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:save save} event of this `sap.ui.comp.variants.VariantManagement`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.variants.VariantManagement` itself. * * This event is fired when the Save Variant dialog is closed with OK for a variant. * * @since 1.22.0 * * @returns Reference to `this` in order to allow method chaining */ attachSave( /** * The function to be called when the event occurs */ fnFunction: (p1: VariantManagement$SaveEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.variants.VariantManagement` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.comp.variants.VariantManagement`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.variants.VariantManagement` itself. * * This event is fired when a new variant is selected. * * @since 1.22.0 * * @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: VariantManagement$SelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.variants.VariantManagement` * itself */ oListener?: object ): this; /** * Attaches event handler `fnFunction` to the {@link #event:select select} event of this `sap.ui.comp.variants.VariantManagement`. * * When called, the context of the event handler (its `this`) will be bound to `oListener` if specified, * otherwise it will be bound to this `sap.ui.comp.variants.VariantManagement` itself. * * This event is fired when a new variant is selected. * * @since 1.22.0 * * @returns Reference to `this` in order to allow method chaining */ attachSelect( /** * The function to be called when the event occurs */ fnFunction: (p1: VariantManagement$SelectEvent) => void, /** * Context object to call the event handler with. Defaults to this `sap.ui.comp.variants.VariantManagement` * itself */ oListener?: object ): this; /** * Removes the current variant selection and resets to default value. * * @since 1.22.0 */ clearVariantSelection(): void; /** * Gets the dirty flag of the current variant. * * * @returns The dirty state of the current variant */ currentVariantGetModified(): boolean; /** * Sets the dirty flag of the current variant. */ currentVariantSetModified( /** * The value indicating the dirty state of the current variant */ bFlag: boolean ): void; /** * Destroys all the items in the aggregation {@link #getItems items}. * * @since 1.22.0 * @deprecated As of version 1.26. replaced by the `variantItems` aggregation * * @returns Reference to `this` in order to allow method chaining */ destroyItems(): this; /** * Destroys all the variantItems in the aggregation {@link #getVariantItems variantItems}. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ destroyVariantItems(): this; /** * Detaches event handler `fnFunction` from the {@link #event:manage manage} event of this `sap.ui.comp.variants.VariantManagement`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.22.0 * * @returns Reference to `this` in order to allow method chaining */ detachManage( /** * The function to be called, when the event occurs */ fnFunction: (p1: VariantManagement$ManageEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:save save} event of this `sap.ui.comp.variants.VariantManagement`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.22.0 * * @returns Reference to `this` in order to allow method chaining */ detachSave( /** * The function to be called, when the event occurs */ fnFunction: (p1: VariantManagement$SaveEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Detaches event handler `fnFunction` from the {@link #event:select select} event of this `sap.ui.comp.variants.VariantManagement`. * * The passed function and listener object must match the ones used for event registration. * * @since 1.22.0 * * @returns Reference to `this` in order to allow method chaining */ detachSelect( /** * The function to be called, when the event occurs */ fnFunction: (p1: VariantManagement$SelectEvent) => void, /** * Context object on which the given function had to be called */ oListener?: object ): this; /** * Fires event {@link #event:manage manage} to attached listeners. * * @since 1.22.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireManage( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.variants.VariantManagement$ManageEventParameters ): this; /** * Fires event {@link #event:save save} to attached listeners. * * @since 1.22.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSave( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.variants.VariantManagement$SaveEventParameters ): this; /** * Fires event {@link #event:select select} to attached listeners. * * @since 1.22.0 * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Reference to `this` in order to allow method chaining */ fireSelect( /** * Parameters to pass along with the event */ mParameters?: sap.ui.comp.variants.VariantManagement$SelectEventParameters ): this; /** * Gets current value of property {@link #getDefaultVariantKey defaultVariantKey}. * * Provides a string value to set the default variant. Used for the save dialog. Has no effect on the selected * variant. * * @since 1.22.0 * * @returns Value of property `defaultVariantKey` */ getDefaultVariantKey(): string; /** * Gets current value of property {@link #getEnabled enabled}. * * Can be set to true or false depending on whether you want to enable or disable the control. * * Default value is `true`. * * @since 1.22.0 * * @returns Value of property `enabled` */ getEnabled(): boolean; /** * Gets current value of property {@link #getInErrorState inErrorState}. * * Indicates that the control is in error state. If set to `true` error message will be displayed whenever * the variant is opened. * * Default value is `false`. * * @since 1.52.0 * * @returns Value of property `inErrorState` */ getInErrorState(): boolean; /** * Gets current value of property {@link #getInitialSelectionKey initialSelectionKey}. * * Enables the setting of the initially selected variant. * * @since 1.22.0 * * @returns Value of property `initialSelectionKey` */ getInitialSelectionKey(): string; /** * Gets content of aggregation {@link #getItems items}. * * Items displayed by the `VariantManagement` control. * * @since 1.22.0 * @deprecated As of version 1.26. replaced by the `variantItems` aggregation */ getItems(): sap.ui.core.Item[]; /** * Gets current value of property {@link #getLifecycleSupport lifecycleSupport}. * * Enables the lifecycle support. If set to true, the VariantManagement control handles the transport information * for shared variants. * * Default value is `false`. * * @since 1.26.0 * * @returns Value of property `lifecycleSupport` */ getLifecycleSupport(): boolean; /** * Required by the {@link sap.m.IOverflowToolbarContent} interface. Registers invalidations event which * is fired when width of the control is changed. * * @ui5-protected Do not call from applications (only from related classes in the framework) * * @returns Configuration information for the `sap.m.IOverflowToolbarContent` interface */ getOverflowToolbarConfig(): { canOverflow: boolean; invalidationEvents: string[]; }; /** * Gets current value of property {@link #getSelectionKey selectionKey}. * * The key of the currently selected item. Returns null if the default item list is selected. This property * is calculated when accessing it via the getSelectionKey method. The corresponding setSelectionKey method * is not supported. The access via the standard set/getProperty is also not supported. * * @since 1.24.0 * * @returns Value of property `selectionKey` */ getSelectionKey(): string; /** * Gets current value of property {@link #getShowCreateTile showCreateTile}. * * Indicates that a Create Tile is visible in the Create dialog. * * Default value is `false`. * * @since 1.26.0 * * @returns Value of property `showCreateTile` */ getShowCreateTile(): boolean; /** * Gets current value of property {@link #getShowExecuteOnSelection showExecuteOnSelection}. * * Indicates that Execute on Selection is visible in the Save Variant and the Manage Variants dialogs. * * Default value is `false`. * * @since 1.26.0 * * @returns Value of property `showExecuteOnSelection` */ getShowExecuteOnSelection(): boolean; /** * Gets current value of property {@link #getShowSetAsDefault showSetAsDefault}. * * Indicates that set as default is visible in the Save Variant and the Manage Variants dialogs. * * Default value is `true`. * * @since 1.44.0 * * @returns Value of property `showSetAsDefault` */ getShowSetAsDefault(): boolean; /** * Gets current value of property {@link #getShowShare showShare}. * * Indicates that the Public checkbox is visible in the Save View and the Manage Views dialogs. Selecting * this checkbox allows you to share variants with other users. * * Default value is `false`. * * @since 1.26.0 * * @returns Value of property `showShare` */ getShowShare(): boolean; /** * Gets current value of property {@link #getStandardItemAuthor standardItemAuthor}. * * Defines the author of the standard variant, for example, the name of the own company. * * Default value is `"SAP"`. * * @since 1.86 * * @returns Value of property `standardItemAuthor` */ getStandardItemAuthor(): string; /** * Gets current value of property {@link #getStandardItemText standardItemText}. * * Overwrites the default Standard variant title. * * @since 1.28.0 * * @returns Value of property `standardItemText` */ getStandardItemText(): string; /** * Gets current value of property {@link #getUseFavorites useFavorites}. * * Indicates that the 'Favorites' feature is used. Only variants marked as favorites will be displayed in * the variant list. * * Default value is `false`. * * @since 1.50.0 * * @returns Value of property `useFavorites` */ getUseFavorites(): boolean; /** * Gets current value of property {@link #getVariantCreationByUserAllowed variantCreationByUserAllowed}. * * Indicates that end users are allowed to create variants. * * Default value is `true`. * * @since 1.85 * * @returns Value of property `variantCreationByUserAllowed` */ getVariantCreationByUserAllowed(): boolean; /** * Gets content of aggregation {@link #getVariantItems variantItems}. * * Variant items displayed by the `VariantManagement` control. * * @since 1.26.0 */ getVariantItems(): sap.ui.comp.variants.VariantItem[]; /** * Checks for the provided `sap.ui.core.Item` in the aggregation {@link #getItems items}. and returns its * index if found or -1 otherwise. * * @since 1.22.0 * @deprecated As of version 1.26. replaced by the `variantItems` aggregation * * @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.ui.core.Item ): int; /** * Checks for the provided `sap.ui.comp.variants.VariantItem` in the aggregation {@link #getVariantItems variantItems}. * and returns its index if found or -1 otherwise. * * @since 1.26.0 * * @returns The index of the provided control in the aggregation if found, or -1 otherwise */ indexOfVariantItem( /** * The variantItem whose index is looked for */ oVariantItem: sap.ui.comp.variants.VariantItem ): int; /** * Inserts a item into the aggregation {@link #getItems items}. * * @since 1.22.0 * @deprecated As of version 1.26. replaced by the `variantItems` aggregation * * @returns Reference to `this` in order to allow method chaining */ insertItem( /** * The item to insert; if empty, nothing is inserted */ oItem: sap.ui.core.Item, /** * The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted * at position 0; for a value greater than the current size of the aggregation, the item is inserted at * the last position */ iIndex: int ): this; /** * Inserts a variantItem into the aggregation {@link #getVariantItems variantItems}. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ insertVariantItem( /** * The variantItem to insert; if empty, nothing is inserted */ oVariantItem: sap.ui.comp.variants.VariantItem, /** * The `0`-based index the variantItem should be inserted at; for a negative value of `iIndex`, the variantItem * is inserted at position 0; for a value greater than the current size of the aggregation, the variantItem * 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.22.0 * @deprecated As of version 1.26. replaced by the `variantItems` aggregation * * @returns An array of the removed elements (might be empty) */ removeAllItems(): sap.ui.core.Item[]; /** * Removes all the controls from the aggregation {@link #getVariantItems variantItems}. * * Additionally, it unregisters them from the hosting UIArea. * * @since 1.26.0 * * @returns An array of the removed elements (might be empty) */ removeAllVariantItems(): sap.ui.comp.variants.VariantItem[]; /** * Removes a item from the aggregation {@link #getItems items}. * * @since 1.22.0 * @deprecated As of version 1.26. replaced by the `variantItems` aggregation * * @returns The removed item or `null` */ removeItem( /** * The item to remove or its index or id */ vItem: int | string | sap.ui.core.Item ): sap.ui.core.Item | null; /** * Removes a variantItem from the aggregation {@link #getVariantItems variantItems}. * * @since 1.26.0 * * @returns The removed variantItem or `null` */ removeVariantItem( /** * The variantItem to remove or its index or id */ vVariantItem: int | string | sap.ui.comp.variants.VariantItem ): sap.ui.comp.variants.VariantItem | null; /** * Replaces the key as proposed by the `VariantManagement` control with the one as proposed by the control * usage. */ replaceKey( /** * Key as proposed by the `VariantManagement` control. */ sOldKey: string, /** * New key which should be used instead of the sOldKey */ sNewKey: string ): void; /** * Defines the internal mode. The VariantManagement is able to support two different modes: * 1. the mode with standard entry displayed as 'Default' and * 2. the mode with standard entry displayed as 'Standard'. * The 'Default' display is the initial mode. * `Note:` this method has to be executed, before any items are assigned to the VariantManagement control! * * @since 1.48.0 */ setBackwardCompatibility( /** * defines the behavior: `false` new mode, otherwize 'old' mode. */ bFlag: boolean ): void; /** * Sets the new selected variant. */ setCurrentVariantKey( /** * Key of the variant that should be selected. */ sKey: string ): void; /** * Sets a new value for property {@link #getDefaultVariantKey defaultVariantKey}. * * Provides a string value to set the default variant. Used for the save dialog. Has no effect on the selected * variant. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.22.0 * * @returns Reference to `this` in order to allow method chaining */ setDefaultVariantKey( /** * New value for property `defaultVariantKey` */ sDefaultVariantKey?: string ): this; /** * Sets a new value for property {@link #getEnabled enabled}. * * Can be set to true or false depending on whether you want to enable or disable the control. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.22.0 * * @returns Reference to `this` in order to allow method chaining */ setEnabled( /** * New value for property `enabled` */ bEnabled?: boolean ): this; /** * Sets a new value for property {@link #getInErrorState inErrorState}. * * Indicates that the control is in error state. If set to `true` error message will be displayed whenever * the variant is opened. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.52.0 * * @returns Reference to `this` in order to allow method chaining */ setInErrorState( /** * New value for property `inErrorState` */ bInErrorState?: boolean ): this; /** * Sets a new value for property {@link #getInitialSelectionKey initialSelectionKey}. * * Enables the setting of the initially selected variant. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.22.0 * * @returns Reference to `this` in order to allow method chaining */ setInitialSelectionKey( /** * New value for property `initialSelectionKey` */ sInitialSelectionKey?: string ): this; /** * Sets a new value for property {@link #getLifecycleSupport lifecycleSupport}. * * Enables the lifecycle support. If set to true, the VariantManagement control handles the transport information * for shared variants. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setLifecycleSupport( /** * New value for property `lifecycleSupport` */ bLifecycleSupport?: boolean ): this; /** * Sets a new value for property {@link #getSelectionKey selectionKey}. * * The key of the currently selected item. Returns null if the default item list is selected. This property * is calculated when accessing it via the getSelectionKey method. The corresponding setSelectionKey method * is not supported. The access via the standard set/getProperty is also not supported. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.24.0 * * @returns Reference to `this` in order to allow method chaining */ setSelectionKey( /** * New value for property `selectionKey` */ sSelectionKey?: string ): this; /** * Sets a new value for property {@link #getShowCreateTile showCreateTile}. * * Indicates that a Create Tile is visible in the Create dialog. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setShowCreateTile( /** * New value for property `showCreateTile` */ bShowCreateTile?: boolean ): this; /** * Sets a new value for property {@link #getShowExecuteOnSelection showExecuteOnSelection}. * * Indicates that Execute on Selection is visible in the Save Variant and the Manage Variants dialogs. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setShowExecuteOnSelection( /** * New value for property `showExecuteOnSelection` */ bShowExecuteOnSelection?: boolean ): this; /** * Sets a new value for property {@link #getShowSetAsDefault showSetAsDefault}. * * Indicates that set as default is visible in the Save Variant and the Manage Variants dialogs. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.44.0 * * @returns Reference to `this` in order to allow method chaining */ setShowSetAsDefault( /** * New value for property `showSetAsDefault` */ bShowSetAsDefault?: boolean ): this; /** * Sets a new value for property {@link #getShowShare showShare}. * * Indicates that the Public checkbox is visible in the Save View and the Manage Views dialogs. Selecting * this checkbox allows you to share variants with other users. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.26.0 * * @returns Reference to `this` in order to allow method chaining */ setShowShare( /** * New value for property `showShare` */ bShowShare?: boolean ): this; /** * Sets a new value for property {@link #getStandardItemAuthor standardItemAuthor}. * * Defines the author of the standard variant, for example, the name of the own company. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `"SAP"`. * * @since 1.86 * * @returns Reference to `this` in order to allow method chaining */ setStandardItemAuthor( /** * New value for property `standardItemAuthor` */ sStandardItemAuthor?: string ): this; /** * Sets a new value for property {@link #getStandardItemText standardItemText}. * * Overwrites the default Standard variant title. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * @since 1.28.0 * * @returns Reference to `this` in order to allow method chaining */ setStandardItemText( /** * New value for property `standardItemText` */ sStandardItemText?: string ): this; /** * Sets a new value for property {@link #getUseFavorites useFavorites}. * * Indicates that the 'Favorites' feature is used. Only variants marked as favorites will be displayed in * the variant list. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `false`. * * @since 1.50.0 * * @returns Reference to `this` in order to allow method chaining */ setUseFavorites( /** * New value for property `useFavorites` */ bUseFavorites?: boolean ): this; /** * Sets a new value for property {@link #getVariantCreationByUserAllowed variantCreationByUserAllowed}. * * Indicates that end users are allowed to create variants. * * When called with a value of `null` or `undefined`, the default value of the property will be restored. * * Default value is `true`. * * @since 1.85 * * @returns Reference to `this` in order to allow method chaining */ setVariantCreationByUserAllowed( /** * New value for property `variantCreationByUserAllowed` */ bVariantCreationByUserAllowed?: boolean ): this; } /** * Event object of the VariantItem#change event. */ type VariantItem$ChangeEvent = sap.ui.base.Event< VariantItem$ChangeEventParameters, VariantItem >; /** * Event object of the VariantManagement#manage event. */ type VariantManagement$ManageEvent = sap.ui.base.Event< VariantManagement$ManageEventParameters, VariantManagement >; /** * Event object of the VariantManagement#save event. */ type VariantManagement$SaveEvent = sap.ui.base.Event< VariantManagement$SaveEventParameters, VariantManagement >; /** * Event object of the VariantManagement#select event. */ type VariantManagement$SelectEvent = sap.ui.base.Event< VariantManagement$SelectEventParameters, VariantManagement >; } /** * Marker interface for SmartForm GroupElements. * * @since 1.88.0 */ interface IFormGroupElement { __implements__sap_ui_comp_IFormGroupElement: boolean; } /** * Enumeration of text arrangement types. * * This enum is part of the 'sap/ui/comp/library' module export and must be accessed by the property 'TextArrangementType'. * * @since 1.60 */ enum TextArrangementType { /** * Text comes first, followed by the ID. */ TextFirst = "com.sap.vocabularies.UI.v1.TextArrangementType/TextFirst", /** * ID comes first, followed by the description. */ TextLast = "com.sap.vocabularies.UI.v1.TextArrangementType/TextLast", /** * Only description is represented, ID is hidden (for example, for `UUIDs`). */ TextOnly = "com.sap.vocabularies.UI.v1.TextArrangementType/TextOnly", /** * ID and description are represented separately. */ TextSeparate = "com.sap.vocabularies.UI.v1.TextArrangementType/TextSeparate", } } } interface IUI5DefineDependencyNames { "sap/ui/comp/config/ControlConfigurationBase": undefined; "sap/ui/comp/config/FilterControlConfiguration": undefined; "sap/ui/comp/delegates/FlexibilityDelegate": undefined; "sap/ui/comp/delegates/Label": undefined; "sap/ui/comp/delegates/TextArrangement": undefined; "sap/ui/comp/filterbar/FilterBar": undefined; "sap/ui/comp/filterbar/FilterGroupItem": undefined; "sap/ui/comp/filterbar/FilterItem": undefined; "sap/ui/comp/library": undefined; "sap/ui/comp/navpopover/LinkData": undefined; "sap/ui/comp/navpopover/NavigationPopover": undefined; "sap/ui/comp/navpopover/NavigationPopoverHandler": undefined; "sap/ui/comp/navpopover/SemanticObjectController": undefined; "sap/ui/comp/navpopover/SmartLink": undefined; "sap/ui/comp/odata/ComboBox": undefined; "sap/ui/comp/p13n/P13nItem": undefined; "sap/ui/comp/p13n/P13nOperationsHelperBase": undefined; "sap/ui/comp/smartchart/SmartChart": undefined; "sap/ui/comp/smartfield/ComboBox": undefined; "sap/ui/comp/smartfield/Configuration": undefined; "sap/ui/comp/smartfield/ControlProposal": undefined; "sap/ui/comp/smartfield/ObjectStatus": undefined; "sap/ui/comp/smartfield/SmartField": undefined; "sap/ui/comp/smartfilterbar/ControlConfiguration": undefined; "sap/ui/comp/smartfilterbar/GroupConfiguration": undefined; "sap/ui/comp/smartfilterbar/SelectOption": undefined; "sap/ui/comp/smartfilterbar/SFBMultiComboBox": undefined; "sap/ui/comp/smartfilterbar/SmartFilterBar": undefined; "sap/ui/comp/smartfilterbar/SmartFilterBarFilterGroupItem": undefined; "sap/ui/comp/smartform/ColumnLayout": undefined; "sap/ui/comp/smartform/Group": undefined; "sap/ui/comp/smartform/GroupElement": undefined; "sap/ui/comp/smartform/Layout": undefined; "sap/ui/comp/smartform/SemanticGroupElement": undefined; "sap/ui/comp/smartform/SmartForm": undefined; "sap/ui/comp/smartlist/SmartList": undefined; "sap/ui/comp/smartmicrochart/SmartAreaMicroChart": undefined; "sap/ui/comp/smartmicrochart/SmartBulletMicroChart": undefined; "sap/ui/comp/smartmicrochart/SmartColumnMicroChart": undefined; "sap/ui/comp/smartmicrochart/SmartComparisonMicroChart": undefined; "sap/ui/comp/smartmicrochart/SmartDeltaMicroChart": undefined; "sap/ui/comp/smartmicrochart/SmartHarveyBallMicroChart": undefined; "sap/ui/comp/smartmicrochart/SmartLineMicroChart": undefined; "sap/ui/comp/smartmicrochart/SmartMicroChart": undefined; "sap/ui/comp/smartmicrochart/SmartMicroChartBase": undefined; "sap/ui/comp/smartmicrochart/SmartRadialMicroChart": undefined; "sap/ui/comp/smartmicrochart/SmartStackedBarMicroChart": undefined; "sap/ui/comp/smartmultiedit/Container": undefined; "sap/ui/comp/smartmultiedit/Field": undefined; "sap/ui/comp/smartmultiinput/SmartMultiInput": undefined; "sap/ui/comp/smarttable/SmartTable": undefined; "sap/ui/comp/smartvariants/PersonalizableInfo": undefined; "sap/ui/comp/smartvariants/SmartVariantManagement": undefined; "sap/ui/comp/smartvariants/SmartVariantManagementAdapter": undefined; "sap/ui/comp/smartvariants/SmartVariantManagementBase": undefined; "sap/ui/comp/smartvariants/SmartVariantManagementMediator": undefined; "sap/ui/comp/smartvariants/SmartVariantManagementUi2": undefined; "sap/ui/comp/state/UIState": undefined; "sap/ui/comp/util/SharedUtil": undefined; "sap/ui/comp/util/TableUtil": undefined; "sap/ui/comp/valuehelpdialog/ValueHelpDialog": undefined; "sap/ui/comp/variants/EditableVariantItem": undefined; "sap/ui/comp/variants/VariantItem": undefined; "sap/ui/comp/variants/VariantManagement": undefined; } }