@sapui5/ts-types-esm 1.135.0 → 1.136.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/types/sap.apf.d.ts +1 -1
- package/types/sap.ca.ui.d.ts +1 -1
- package/types/sap.chart.d.ts +1 -1
- package/types/sap.collaboration.d.ts +1 -1
- package/types/sap.cux.home.d.ts +82 -0
- package/types/sap.esh.search.ui.d.ts +1 -1
- package/types/sap.f.d.ts +101 -1
- package/types/sap.fe.base.d.ts +1 -1
- package/types/sap.fe.controls.d.ts +1 -1
- package/types/sap.fe.core.d.ts +27 -3
- package/types/sap.fe.ina.d.ts +1 -1
- package/types/sap.fe.macros.d.ts +446 -57
- package/types/sap.fe.navigation.d.ts +1 -1
- package/types/sap.fe.placeholder.d.ts +1 -1
- package/types/sap.fe.plugins.managecache.d.ts +1 -1
- package/types/sap.fe.templates.d.ts +1 -1
- package/types/sap.fe.test.d.ts +1 -1
- package/types/sap.fe.tools.d.ts +1 -1
- package/types/sap.feedback.ui.d.ts +1 -1
- package/types/sap.gantt.d.ts +80 -8
- package/types/sap.insights.d.ts +1 -1
- package/types/sap.m.d.ts +518 -39
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +1 -1
- package/types/sap.ovp.d.ts +1 -1
- package/types/sap.rules.ui.d.ts +1 -1
- package/types/sap.sac.df.d.ts +4 -4
- package/types/sap.suite.ui.commons.d.ts +12 -1
- package/types/sap.suite.ui.generic.template.d.ts +8 -2
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/sap.tnt.d.ts +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.comp.d.ts +3278 -212
- package/types/sap.ui.core.d.ts +114 -117
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.export.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +8 -2
- package/types/sap.ui.generic.app.d.ts +1 -1
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +5 -3
- package/types/sap.ui.layout.d.ts +1 -1
- package/types/sap.ui.mdc.d.ts +135 -8
- package/types/sap.ui.richtexteditor.d.ts +8 -8
- package/types/sap.ui.rta.d.ts +1 -1
- package/types/sap.ui.suite.d.ts +1 -1
- package/types/sap.ui.support.d.ts +1 -1
- package/types/sap.ui.table.d.ts +7 -1
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +14 -32
- package/types/sap.ui.ux3.d.ts +3 -3
- package/types/sap.ui.vbm.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +310 -39
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.ui.webc.common.d.ts +1 -1
- package/types/sap.ui.webc.fiori.d.ts +1 -1
- package/types/sap.ui.webc.main.d.ts +1 -1
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +46 -37
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +2 -21
- package/types/sap.viz.d.ts +1 -1
- package/types/sap.webanalytics.core.d.ts +1 -1
- package/types/sap.zen.commons.d.ts +1 -1
- package/types/sap.zen.crosstab.d.ts +1 -1
- package/types/sap.zen.dsh.d.ts +1 -1
package/types/sap.ui.comp.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.136.0
|
|
2
2
|
|
|
3
3
|
declare module "sap/ui/comp/library" {
|
|
4
4
|
/**
|
|
@@ -8108,8 +8108,8 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
|
|
|
8108
8108
|
/**
|
|
8109
8109
|
* Gets current value of property {@link #getCreateControlCallback createControlCallback}.
|
|
8110
8110
|
*
|
|
8111
|
-
* Function that enables the SmartLink control to create an alternative control, which is displayed if
|
|
8112
|
-
*
|
|
8111
|
+
* Function that enables the SmartLink control to create an alternative control, which is displayed if `ignoreLinkRendering`
|
|
8112
|
+
* is enabled. The function has no parameters and has to return an instance of sap.ui.core.Control.
|
|
8113
8113
|
*
|
|
8114
8114
|
* @since 1.28.0
|
|
8115
8115
|
*
|
|
@@ -8354,8 +8354,8 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
|
|
|
8354
8354
|
/**
|
|
8355
8355
|
* Sets a new value for property {@link #getCreateControlCallback createControlCallback}.
|
|
8356
8356
|
*
|
|
8357
|
-
* Function that enables the SmartLink control to create an alternative control, which is displayed if
|
|
8358
|
-
*
|
|
8357
|
+
* Function that enables the SmartLink control to create an alternative control, which is displayed if `ignoreLinkRendering`
|
|
8358
|
+
* is enabled. The function has no parameters and has to return an instance of sap.ui.core.Control.
|
|
8359
8359
|
*
|
|
8360
8360
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
8361
8361
|
*
|
|
@@ -8662,8 +8662,8 @@ declare module "sap/ui/comp/navpopover/SmartLink" {
|
|
|
8662
8662
|
semanticObjectLabel?: string | PropertyBindingInfo;
|
|
8663
8663
|
|
|
8664
8664
|
/**
|
|
8665
|
-
* Function that enables the SmartLink control to create an alternative control, which is displayed if
|
|
8666
|
-
*
|
|
8665
|
+
* Function that enables the SmartLink control to create an alternative control, which is displayed if `ignoreLinkRendering`
|
|
8666
|
+
* is enabled. The function has no parameters and has to return an instance of sap.ui.core.Control.
|
|
8667
8667
|
*
|
|
8668
8668
|
* @since 1.28.0
|
|
8669
8669
|
*/
|
|
@@ -8990,8 +8990,6 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
|
|
|
8990
8990
|
|
|
8991
8991
|
import SmartLink from "sap/ui/comp/navpopover/SmartLink";
|
|
8992
8992
|
|
|
8993
|
-
import NavigationPopoverHandler from "sap/ui/comp/navpopover/NavigationPopoverHandler";
|
|
8994
|
-
|
|
8995
8993
|
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
8996
8994
|
|
|
8997
8995
|
import Event from "sap/ui/base/Event";
|
|
@@ -9554,7 +9552,7 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
|
|
|
9554
9552
|
* Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained.
|
|
9555
9553
|
* The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}.
|
|
9556
9554
|
* This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}.
|
|
9557
|
-
* The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `
|
|
9555
|
+
* The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `SmartLinkFieldInfo`.
|
|
9558
9556
|
* The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained`
|
|
9559
9557
|
* event. The event handling is ignored if this callback is set.
|
|
9560
9558
|
*
|
|
@@ -9618,7 +9616,7 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
|
|
|
9618
9616
|
/**
|
|
9619
9617
|
* Control registered by `SemanticObjectController`
|
|
9620
9618
|
*/
|
|
9621
|
-
oControl: SmartLink
|
|
9619
|
+
oControl: SmartLink
|
|
9622
9620
|
): boolean;
|
|
9623
9621
|
/**
|
|
9624
9622
|
* Adds the given control to the SemanticObjectController and registers all relevant events.
|
|
@@ -9627,7 +9625,7 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
|
|
|
9627
9625
|
/**
|
|
9628
9626
|
* Control to be registered by `SemanticObjectController`
|
|
9629
9627
|
*/
|
|
9630
|
-
oControl: SmartLink
|
|
9628
|
+
oControl: SmartLink
|
|
9631
9629
|
): void;
|
|
9632
9630
|
/**
|
|
9633
9631
|
* Sets a new value for property {@link #getBeforeNavigationCallback beforeNavigationCallback}.
|
|
@@ -9806,7 +9804,7 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
|
|
|
9806
9804
|
* Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained.
|
|
9807
9805
|
* The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}.
|
|
9808
9806
|
* This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}.
|
|
9809
|
-
* The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `
|
|
9807
|
+
* The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `SmartLinkFieldInfo`.
|
|
9810
9808
|
* The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained`
|
|
9811
9809
|
* event. The event handling is ignored if this callback is set.
|
|
9812
9810
|
*
|
|
@@ -9849,7 +9847,7 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
|
|
|
9849
9847
|
/**
|
|
9850
9848
|
* Control to be unregistered by `SemanticObjectController`
|
|
9851
9849
|
*/
|
|
9852
|
-
oControl: SmartLink
|
|
9850
|
+
oControl: SmartLink
|
|
9853
9851
|
): void;
|
|
9854
9852
|
}
|
|
9855
9853
|
/**
|
|
@@ -9964,7 +9962,7 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
|
|
|
9964
9962
|
* Function that is called when the navigation targets provided by the SAP Fiori launchpad are obtained.
|
|
9965
9963
|
* The function is called with one `oNavigationTargets` parameter of type {@link sap.ui.comp.navpopover.NavigationTargets}.
|
|
9966
9964
|
* This function has to return a `Promise` resolving into an `Object` of type {@link sap.ui.comp.navpopover.NavigationTargets}.
|
|
9967
|
-
* The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `
|
|
9965
|
+
* The provided `oNavigationTargets` can be manipulated in this callback before being returned to the `SmartLinkFieldInfo`.
|
|
9968
9966
|
* The `Popover` will open after the `Promise` has been resolved. This function replaces the `navigationTargetsObtained`
|
|
9969
9967
|
* event. The event handling is ignored if this callback is set.
|
|
9970
9968
|
*
|
|
@@ -10079,222 +10077,2955 @@ declare module "sap/ui/comp/navpopover/SemanticObjectController" {
|
|
|
10079
10077
|
>;
|
|
10080
10078
|
|
|
10081
10079
|
/**
|
|
10082
|
-
* Parameters of the SemanticObjectController#navigate event.
|
|
10080
|
+
* Parameters of the SemanticObjectController#navigate event.
|
|
10081
|
+
*/
|
|
10082
|
+
export interface SemanticObjectController$NavigateEventParameters {
|
|
10083
|
+
/**
|
|
10084
|
+
* The UI text shown in the clicked link.
|
|
10085
|
+
*/
|
|
10086
|
+
text?: string;
|
|
10087
|
+
|
|
10088
|
+
/**
|
|
10089
|
+
* The navigation target of the clicked link.
|
|
10090
|
+
*/
|
|
10091
|
+
href?: string;
|
|
10092
|
+
|
|
10093
|
+
/**
|
|
10094
|
+
* The semantic object used to retrieve this target.
|
|
10095
|
+
*/
|
|
10096
|
+
semanticObject?: string;
|
|
10097
|
+
|
|
10098
|
+
/**
|
|
10099
|
+
* Map containing the semantic attributes used to retrieve this target.
|
|
10100
|
+
*/
|
|
10101
|
+
semanticAttributes?: object;
|
|
10102
|
+
|
|
10103
|
+
/**
|
|
10104
|
+
* The ID of the control that fires this event. If `navigate` is registered on the SmartLink, `originalId`
|
|
10105
|
+
* is the same as the event's source ID which is the SmartLink's ID. If `navigate` is registered on the
|
|
10106
|
+
* SemanticObjectController, `originalId` helps to identify the original SmartLink control which triggered
|
|
10107
|
+
* the event.
|
|
10108
|
+
*/
|
|
10109
|
+
originalId?: string;
|
|
10110
|
+
}
|
|
10111
|
+
|
|
10112
|
+
/**
|
|
10113
|
+
* Event object of the SemanticObjectController#navigate event.
|
|
10114
|
+
*/
|
|
10115
|
+
export type SemanticObjectController$NavigateEvent = Event<
|
|
10116
|
+
SemanticObjectController$NavigateEventParameters,
|
|
10117
|
+
SemanticObjectController
|
|
10118
|
+
>;
|
|
10119
|
+
|
|
10120
|
+
/**
|
|
10121
|
+
* Parameters of the SemanticObjectController#navigationTargetsObtained event.
|
|
10122
|
+
*
|
|
10123
|
+
* @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property.
|
|
10124
|
+
*/
|
|
10125
|
+
export interface SemanticObjectController$NavigationTargetsObtainedEventParameters {
|
|
10126
|
+
/**
|
|
10127
|
+
* The main navigation object.
|
|
10128
|
+
*/
|
|
10129
|
+
mainNavigation?: LinkData;
|
|
10130
|
+
|
|
10131
|
+
/**
|
|
10132
|
+
* Array of available navigation target objects.
|
|
10133
|
+
*/
|
|
10134
|
+
actions?: LinkData[];
|
|
10135
|
+
|
|
10136
|
+
/**
|
|
10137
|
+
* The navigation object for the own application. This navigation option is by default not visible on the
|
|
10138
|
+
* popover.
|
|
10139
|
+
*/
|
|
10140
|
+
ownNavigation?: LinkData;
|
|
10141
|
+
|
|
10142
|
+
/**
|
|
10143
|
+
* Array containing contact data.
|
|
10144
|
+
*/
|
|
10145
|
+
popoverForms?: SimpleForm[];
|
|
10146
|
+
|
|
10147
|
+
/**
|
|
10148
|
+
* The semantic object for which the navigation targets have been retrieved.
|
|
10149
|
+
*/
|
|
10150
|
+
semanticObject?: string;
|
|
10151
|
+
|
|
10152
|
+
/**
|
|
10153
|
+
* Map containing the semantic attributes.
|
|
10154
|
+
*/
|
|
10155
|
+
semanticAttributes?: object;
|
|
10156
|
+
|
|
10157
|
+
/**
|
|
10158
|
+
* The ID of the control that fires this event. If `navigationTargetsObtained` is registered on the SmartLink,
|
|
10159
|
+
* `originalId` is the same as the event's source ID which is also the SmartLink's ID. If `navigationTargetsObtained`
|
|
10160
|
+
* is registered on the SemanticObjectController, `originalId` helps to identify the original SmartLink
|
|
10161
|
+
* control which triggered the event.
|
|
10162
|
+
*/
|
|
10163
|
+
originalId?: string;
|
|
10164
|
+
|
|
10165
|
+
/**
|
|
10166
|
+
* This callback function shows the actual navigation popover. If the `navigationTargetsObtained` has been
|
|
10167
|
+
* registered, the `show` function has to be called manually in order to open the navigation popover. Signatures:
|
|
10168
|
+
* `show()`
|
|
10169
|
+
* - `show(oMainNavigation, aAvailableActions, oAdditionalContent)` Parameters:
|
|
10170
|
+
* {sap.ui.comp.navpopover.LinkData | null | undefined} oMainNavigation The main navigation object. With
|
|
10171
|
+
* `null` the main navigation object will be removed. With `undefined` the old object will remain.
|
|
10172
|
+
* - {sap.ui.comp.navpopover.LinkData[] | [] | undefined} aAvailableActions Array containing the cross-application
|
|
10173
|
+
* navigation links. With empty array all available links will be removed. With `undefined` the old links
|
|
10174
|
+
* will remain.
|
|
10175
|
+
* - {sap.ui.core.Control | null | undefined} oAdditionalContent Control that will be displayed in extra
|
|
10176
|
+
* content section on the popover. With `null` the main extra content object will be removed. With `undefined`
|
|
10177
|
+
* the old object still remains.
|
|
10178
|
+
* - `show(sMainNavigationId, oMainNavigation, aAvailableActions, oAdditionalContent)` Parameters:
|
|
10179
|
+
* {string | undefined} sMainNavigationId The visible description for the main navigation link. With `''`,
|
|
10180
|
+
* both the description and subtitle will be removed. With `undefined`, the description is calculated using
|
|
10181
|
+
* the binding context of a given source object (for example `SmartLink` control).
|
|
10182
|
+
* - {sap.ui.comp.navpopover.LinkData | null | undefined} oMainNavigation The main navigation object.
|
|
10183
|
+
* With `null` the main navigation object will be removed. With `undefined` the old object will remain.
|
|
10184
|
+
*
|
|
10185
|
+
* - {sap.ui.comp.navpopover.LinkData[] | [] | undefined} aAvailableActions Array containing the cross-application
|
|
10186
|
+
* navigation links. With empty array all available links will be removed. With `undefined` the old links
|
|
10187
|
+
* will remain.
|
|
10188
|
+
* - {sap.ui.core.Control | null | undefined} oAdditionalContent Control that will be displayed in extra
|
|
10189
|
+
* content section on the popover. With `null` the main extra content object will be removed. With `undefined`
|
|
10190
|
+
* the old object still remains.
|
|
10191
|
+
*/
|
|
10192
|
+
show?: Function;
|
|
10193
|
+
}
|
|
10194
|
+
|
|
10195
|
+
/**
|
|
10196
|
+
* Event object of the SemanticObjectController#navigationTargetsObtained event.
|
|
10197
|
+
*
|
|
10198
|
+
* @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property.
|
|
10199
|
+
*/
|
|
10200
|
+
export type SemanticObjectController$NavigationTargetsObtainedEvent = Event<
|
|
10201
|
+
SemanticObjectController$NavigationTargetsObtainedEventParameters,
|
|
10202
|
+
SemanticObjectController
|
|
10203
|
+
>;
|
|
10204
|
+
|
|
10205
|
+
/**
|
|
10206
|
+
* Parameters of the SemanticObjectController#prefetchDone event.
|
|
10207
|
+
*
|
|
10208
|
+
* @deprecated As of version 1.42.0. The event `prefetchDone` is obsolete because it depends on the property
|
|
10209
|
+
* `prefetchNavigationTargets` which has been deprecated.
|
|
10210
|
+
*/
|
|
10211
|
+
export interface SemanticObjectController$PrefetchDoneEventParameters {
|
|
10212
|
+
/**
|
|
10213
|
+
* A map containing all semantic objects as keys for which at least one navigation target has been found.
|
|
10214
|
+
* The value for each semantic object key is an array containing the available actions found for this semantic
|
|
10215
|
+
* object.
|
|
10216
|
+
*/
|
|
10217
|
+
semanticObjects?: object;
|
|
10218
|
+
}
|
|
10219
|
+
|
|
10220
|
+
/**
|
|
10221
|
+
* Event object of the SemanticObjectController#prefetchDone event.
|
|
10222
|
+
*
|
|
10223
|
+
* @deprecated As of version 1.42.0. The event `prefetchDone` is obsolete because it depends on the property
|
|
10224
|
+
* `prefetchNavigationTargets` which has been deprecated.
|
|
10225
|
+
*/
|
|
10226
|
+
export type SemanticObjectController$PrefetchDoneEvent = Event<
|
|
10227
|
+
SemanticObjectController$PrefetchDoneEventParameters,
|
|
10228
|
+
SemanticObjectController
|
|
10229
|
+
>;
|
|
10230
|
+
}
|
|
10231
|
+
|
|
10232
|
+
declare module "sap/ui/comp/odata/ComboBox" {
|
|
10233
|
+
import {
|
|
10234
|
+
default as ComboBox1,
|
|
10235
|
+
$ComboBoxSettings as $ComboBoxSettings1,
|
|
10236
|
+
} from "sap/m/ComboBox";
|
|
10237
|
+
|
|
10238
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
10239
|
+
|
|
10240
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
10241
|
+
|
|
10242
|
+
import Event from "sap/ui/base/Event";
|
|
10243
|
+
|
|
10244
|
+
/**
|
|
10245
|
+
* Extends the functionalities in sap.m.ComboBox
|
|
10246
|
+
*
|
|
10247
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
10248
|
+
*/
|
|
10249
|
+
export default class ComboBox
|
|
10250
|
+
extends ComboBox1
|
|
10251
|
+
implements /* was: sap.ui.comp.IDropDownTextArrangement */ Object
|
|
10252
|
+
{
|
|
10253
|
+
__implements__sap_ui_comp_IDropDownTextArrangement: boolean;
|
|
10254
|
+
/**
|
|
10255
|
+
* Constructor for a new `odata/ComboBox`.
|
|
10256
|
+
*
|
|
10257
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
10258
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
10259
|
+
* of the syntax of the settings object.
|
|
10260
|
+
*
|
|
10261
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10262
|
+
*/
|
|
10263
|
+
protected constructor(
|
|
10264
|
+
/**
|
|
10265
|
+
* Initial settings for the new control
|
|
10266
|
+
*/
|
|
10267
|
+
mSettings?: $ComboBoxSettings
|
|
10268
|
+
);
|
|
10269
|
+
/**
|
|
10270
|
+
* Constructor for a new `odata/ComboBox`.
|
|
10271
|
+
*
|
|
10272
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
10273
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
10274
|
+
* of the syntax of the settings object.
|
|
10275
|
+
*
|
|
10276
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10277
|
+
*/
|
|
10278
|
+
protected constructor(
|
|
10279
|
+
/**
|
|
10280
|
+
* ID for the new control, generated automatically if no ID is given
|
|
10281
|
+
*/
|
|
10282
|
+
sId?: string,
|
|
10283
|
+
/**
|
|
10284
|
+
* Initial settings for the new control
|
|
10285
|
+
*/
|
|
10286
|
+
mSettings?: $ComboBoxSettings
|
|
10287
|
+
);
|
|
10288
|
+
|
|
10289
|
+
/**
|
|
10290
|
+
* Creates a new subclass of class sap.ui.comp.odata.ComboBox with name `sClassName` and enriches it with
|
|
10291
|
+
* the information contained in `oClassInfo`.
|
|
10292
|
+
*
|
|
10293
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.m.ComboBox.extend}.
|
|
10294
|
+
*
|
|
10295
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10296
|
+
*
|
|
10297
|
+
* @returns Created class / constructor function
|
|
10298
|
+
*/
|
|
10299
|
+
static extend<T extends Record<string, unknown>>(
|
|
10300
|
+
/**
|
|
10301
|
+
* Name of the class being created
|
|
10302
|
+
*/
|
|
10303
|
+
sClassName: string,
|
|
10304
|
+
/**
|
|
10305
|
+
* Object literal with information about the class
|
|
10306
|
+
*/
|
|
10307
|
+
oClassInfo?: sap.ClassInfo<T, ComboBox>,
|
|
10308
|
+
/**
|
|
10309
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
10310
|
+
* used by this class
|
|
10311
|
+
*/
|
|
10312
|
+
FNMetaImpl?: Function
|
|
10313
|
+
): Function;
|
|
10314
|
+
/**
|
|
10315
|
+
* Returns a metadata object for class sap.ui.comp.odata.ComboBox.
|
|
10316
|
+
*
|
|
10317
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10318
|
+
*
|
|
10319
|
+
* @returns Metadata object describing this class
|
|
10320
|
+
*/
|
|
10321
|
+
static getMetadata(): ElementMetadata;
|
|
10322
|
+
/**
|
|
10323
|
+
* Attaches event handler `fnFunction` to the {@link #event:selectedKeyChange selectedKeyChange} event of
|
|
10324
|
+
* this `sap.ui.comp.odata.ComboBox`.
|
|
10325
|
+
*
|
|
10326
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
10327
|
+
* otherwise it will be bound to this `sap.ui.comp.odata.ComboBox` itself.
|
|
10328
|
+
*
|
|
10329
|
+
* This event is fired when the selected key has changed only when: The key is valid. The control is visible
|
|
10330
|
+
* There is a change when the control gets visible.
|
|
10331
|
+
*
|
|
10332
|
+
*
|
|
10333
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10334
|
+
*/
|
|
10335
|
+
attachSelectedKeyChange(
|
|
10336
|
+
/**
|
|
10337
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
10338
|
+
* object when firing the event
|
|
10339
|
+
*/
|
|
10340
|
+
oData: object,
|
|
10341
|
+
/**
|
|
10342
|
+
* The function to be called when the event occurs
|
|
10343
|
+
*/
|
|
10344
|
+
fnFunction: (p1: ComboBox$SelectedKeyChangeEvent) => void,
|
|
10345
|
+
/**
|
|
10346
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.comp.odata.ComboBox` itself
|
|
10347
|
+
*/
|
|
10348
|
+
oListener?: object
|
|
10349
|
+
): this;
|
|
10350
|
+
/**
|
|
10351
|
+
* Attaches event handler `fnFunction` to the {@link #event:selectedKeyChange selectedKeyChange} event of
|
|
10352
|
+
* this `sap.ui.comp.odata.ComboBox`.
|
|
10353
|
+
*
|
|
10354
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
10355
|
+
* otherwise it will be bound to this `sap.ui.comp.odata.ComboBox` itself.
|
|
10356
|
+
*
|
|
10357
|
+
* This event is fired when the selected key has changed only when: The key is valid. The control is visible
|
|
10358
|
+
* There is a change when the control gets visible.
|
|
10359
|
+
*
|
|
10360
|
+
*
|
|
10361
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10362
|
+
*/
|
|
10363
|
+
attachSelectedKeyChange(
|
|
10364
|
+
/**
|
|
10365
|
+
* The function to be called when the event occurs
|
|
10366
|
+
*/
|
|
10367
|
+
fnFunction: (p1: ComboBox$SelectedKeyChangeEvent) => void,
|
|
10368
|
+
/**
|
|
10369
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.comp.odata.ComboBox` itself
|
|
10370
|
+
*/
|
|
10371
|
+
oListener?: object
|
|
10372
|
+
): this;
|
|
10373
|
+
/**
|
|
10374
|
+
* Detaches event handler `fnFunction` from the {@link #event:selectedKeyChange selectedKeyChange} event
|
|
10375
|
+
* of this `sap.ui.comp.odata.ComboBox`.
|
|
10376
|
+
*
|
|
10377
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
10378
|
+
*
|
|
10379
|
+
*
|
|
10380
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10381
|
+
*/
|
|
10382
|
+
detachSelectedKeyChange(
|
|
10383
|
+
/**
|
|
10384
|
+
* The function to be called, when the event occurs
|
|
10385
|
+
*/
|
|
10386
|
+
fnFunction: (p1: ComboBox$SelectedKeyChangeEvent) => void,
|
|
10387
|
+
/**
|
|
10388
|
+
* Context object on which the given function had to be called
|
|
10389
|
+
*/
|
|
10390
|
+
oListener?: object
|
|
10391
|
+
): this;
|
|
10392
|
+
/**
|
|
10393
|
+
* Fires event {@link #event:selectedKeyChange selectedKeyChange} to attached listeners.
|
|
10394
|
+
*
|
|
10395
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10396
|
+
*
|
|
10397
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10398
|
+
*/
|
|
10399
|
+
fireSelectedKeyChange(
|
|
10400
|
+
/**
|
|
10401
|
+
* Parameters to pass along with the event
|
|
10402
|
+
*/
|
|
10403
|
+
mParameters?: ComboBox$SelectedKeyChangeEventParameters
|
|
10404
|
+
): this;
|
|
10405
|
+
/**
|
|
10406
|
+
* Gets current value of property {@link #getTextArrangement textArrangement}.
|
|
10407
|
+
*
|
|
10408
|
+
* Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType`
|
|
10409
|
+
* from the ValueList property.
|
|
10410
|
+
*
|
|
10411
|
+
* Default value is `empty string`.
|
|
10412
|
+
*
|
|
10413
|
+
*
|
|
10414
|
+
* @returns Value of property `textArrangement`
|
|
10415
|
+
*/
|
|
10416
|
+
getTextArrangement(): string;
|
|
10417
|
+
/**
|
|
10418
|
+
* Sets a new value for property {@link #getTextArrangement textArrangement}.
|
|
10419
|
+
*
|
|
10420
|
+
* Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType`
|
|
10421
|
+
* from the ValueList property.
|
|
10422
|
+
*
|
|
10423
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10424
|
+
*
|
|
10425
|
+
* Default value is `empty string`.
|
|
10426
|
+
*
|
|
10427
|
+
*
|
|
10428
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10429
|
+
*/
|
|
10430
|
+
setTextArrangement(
|
|
10431
|
+
/**
|
|
10432
|
+
* New value for property `textArrangement`
|
|
10433
|
+
*/
|
|
10434
|
+
sTextArrangement?: string
|
|
10435
|
+
): this;
|
|
10436
|
+
}
|
|
10437
|
+
/**
|
|
10438
|
+
* Describes the settings that can be provided to the ComboBox constructor.
|
|
10439
|
+
*
|
|
10440
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
10441
|
+
*/
|
|
10442
|
+
export interface $ComboBoxSettings extends $ComboBoxSettings1 {
|
|
10443
|
+
/**
|
|
10444
|
+
* Sets the `value` property formatting according to the `com.sap.vocabularies.UI.v1.TextArrangementType`
|
|
10445
|
+
* from the ValueList property.
|
|
10446
|
+
*/
|
|
10447
|
+
textArrangement?: string | PropertyBindingInfo;
|
|
10448
|
+
|
|
10449
|
+
/**
|
|
10450
|
+
* This event is fired when the selected key has changed only when: The key is valid. The control is visible
|
|
10451
|
+
* There is a change when the control gets visible.
|
|
10452
|
+
*/
|
|
10453
|
+
selectedKeyChange?: (oEvent: ComboBox$SelectedKeyChangeEvent) => void;
|
|
10454
|
+
}
|
|
10455
|
+
|
|
10456
|
+
/**
|
|
10457
|
+
* Parameters of the ComboBox#selectedKeyChange event.
|
|
10458
|
+
*
|
|
10459
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
10460
|
+
*/
|
|
10461
|
+
export interface ComboBox$SelectedKeyChangeEventParameters {
|
|
10462
|
+
/**
|
|
10463
|
+
* The selected key.
|
|
10464
|
+
*/
|
|
10465
|
+
selectedKey?: string;
|
|
10466
|
+
}
|
|
10467
|
+
|
|
10468
|
+
/**
|
|
10469
|
+
* Event object of the ComboBox#selectedKeyChange event.
|
|
10470
|
+
*
|
|
10471
|
+
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
10472
|
+
*/
|
|
10473
|
+
export type ComboBox$SelectedKeyChangeEvent = Event<
|
|
10474
|
+
ComboBox$SelectedKeyChangeEventParameters,
|
|
10475
|
+
ComboBox
|
|
10476
|
+
>;
|
|
10477
|
+
}
|
|
10478
|
+
|
|
10479
|
+
declare module "sap/ui/comp/p13n/P13nConditionPanelBase" {
|
|
10480
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
10481
|
+
|
|
10482
|
+
import Event from "sap/ui/base/Event";
|
|
10483
|
+
|
|
10484
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
10485
|
+
|
|
10486
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
10487
|
+
|
|
10488
|
+
/**
|
|
10489
|
+
* The ConditionPanel Control will be used to implement the Sorting, Filtering and Grouping panel of the
|
|
10490
|
+
* new Personalization dialog.
|
|
10491
|
+
*
|
|
10492
|
+
* @since 1.136
|
|
10493
|
+
*/
|
|
10494
|
+
export default class P13nConditionPanelBase extends Control {
|
|
10495
|
+
/**
|
|
10496
|
+
* Constructor for a new P13nConditionPanelBase.
|
|
10497
|
+
*
|
|
10498
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
10499
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
10500
|
+
* of the syntax of the settings object.
|
|
10501
|
+
*/
|
|
10502
|
+
constructor(
|
|
10503
|
+
/**
|
|
10504
|
+
* initial settings for the new control
|
|
10505
|
+
*/
|
|
10506
|
+
mSettings?: $P13nConditionPanelBaseSettings
|
|
10507
|
+
);
|
|
10508
|
+
/**
|
|
10509
|
+
* Constructor for a new P13nConditionPanelBase.
|
|
10510
|
+
*
|
|
10511
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
10512
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
10513
|
+
* of the syntax of the settings object.
|
|
10514
|
+
*/
|
|
10515
|
+
constructor(
|
|
10516
|
+
/**
|
|
10517
|
+
* ID for the new control, generated automatically if no ID is given
|
|
10518
|
+
*/
|
|
10519
|
+
sId?: string,
|
|
10520
|
+
/**
|
|
10521
|
+
* initial settings for the new control
|
|
10522
|
+
*/
|
|
10523
|
+
mSettings?: $P13nConditionPanelBaseSettings
|
|
10524
|
+
);
|
|
10525
|
+
|
|
10526
|
+
/**
|
|
10527
|
+
* Creates a new subclass of class sap.ui.comp.p13n.P13nConditionPanelBase with name `sClassName` and enriches
|
|
10528
|
+
* it with the information contained in `oClassInfo`.
|
|
10529
|
+
*
|
|
10530
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
10531
|
+
*
|
|
10532
|
+
*
|
|
10533
|
+
* @returns Created class / constructor function
|
|
10534
|
+
*/
|
|
10535
|
+
static extend<T extends Record<string, unknown>>(
|
|
10536
|
+
/**
|
|
10537
|
+
* Name of the class being created
|
|
10538
|
+
*/
|
|
10539
|
+
sClassName: string,
|
|
10540
|
+
/**
|
|
10541
|
+
* Object literal with information about the class
|
|
10542
|
+
*/
|
|
10543
|
+
oClassInfo?: sap.ClassInfo<T, P13nConditionPanelBase>,
|
|
10544
|
+
/**
|
|
10545
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
10546
|
+
* used by this class
|
|
10547
|
+
*/
|
|
10548
|
+
FNMetaImpl?: Function
|
|
10549
|
+
): Function;
|
|
10550
|
+
/**
|
|
10551
|
+
* creates and returns a formatted text for the specified condition
|
|
10552
|
+
*
|
|
10553
|
+
*
|
|
10554
|
+
* @returns the range token text. An empty string when no operation matches or the values for the operation
|
|
10555
|
+
* are wrong
|
|
10556
|
+
*/
|
|
10557
|
+
static getFormatedConditionText(
|
|
10558
|
+
/**
|
|
10559
|
+
* the operation type sap.ui.compP13nConditionOperation
|
|
10560
|
+
*/
|
|
10561
|
+
sOperation: string,
|
|
10562
|
+
/**
|
|
10563
|
+
* value of the first range field
|
|
10564
|
+
*/
|
|
10565
|
+
sValue1: string,
|
|
10566
|
+
/**
|
|
10567
|
+
* value of the second range field
|
|
10568
|
+
*/
|
|
10569
|
+
sValue2: string,
|
|
10570
|
+
/**
|
|
10571
|
+
* indicates if the range is an Exclude range
|
|
10572
|
+
*/
|
|
10573
|
+
bExclude: boolean
|
|
10574
|
+
): string;
|
|
10575
|
+
/**
|
|
10576
|
+
* Returns a metadata object for class sap.ui.comp.p13n.P13nConditionPanelBase.
|
|
10577
|
+
*
|
|
10578
|
+
*
|
|
10579
|
+
* @returns Metadata object describing this class
|
|
10580
|
+
*/
|
|
10581
|
+
static getMetadata(): ElementMetadata;
|
|
10582
|
+
/**
|
|
10583
|
+
* add a single condition.
|
|
10584
|
+
*/
|
|
10585
|
+
addCondition(
|
|
10586
|
+
/**
|
|
10587
|
+
* the new condition of type `{ "key": "007", "operation": sap.ui.compP13nConditionOperation.Ascending,
|
|
10588
|
+
* "keyField": "keyFieldKey", "value1": "", "value2": ""};`
|
|
10589
|
+
*/
|
|
10590
|
+
oCondition: object
|
|
10591
|
+
): void;
|
|
10592
|
+
/**
|
|
10593
|
+
* add a single KeyField
|
|
10594
|
+
*/
|
|
10595
|
+
addKeyField(
|
|
10596
|
+
/**
|
|
10597
|
+
* {key: "CompanyCode", text: "ID"}
|
|
10598
|
+
*/
|
|
10599
|
+
oKeyField: object
|
|
10600
|
+
): void;
|
|
10601
|
+
/**
|
|
10602
|
+
* add a single operation
|
|
10603
|
+
*/
|
|
10604
|
+
addOperation(
|
|
10605
|
+
oOperation: /* was: sap.ui.compP13nConditionOperation */ any,
|
|
10606
|
+
/**
|
|
10607
|
+
* defines the type for which this operations will be used.
|
|
10608
|
+
*/
|
|
10609
|
+
sType: string
|
|
10610
|
+
): void;
|
|
10611
|
+
/**
|
|
10612
|
+
* Attaches event handler `fnFunction` to the {@link #event:dataChange dataChange} event of this `sap.ui.comp.p13n.P13nConditionPanelBase`.
|
|
10613
|
+
*
|
|
10614
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
10615
|
+
* otherwise it will be bound to this `sap.ui.comp.p13n.P13nConditionPanelBase` itself.
|
|
10616
|
+
*
|
|
10617
|
+
* Workaround for updating the binding
|
|
10618
|
+
*
|
|
10619
|
+
*
|
|
10620
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10621
|
+
*/
|
|
10622
|
+
attachDataChange(
|
|
10623
|
+
/**
|
|
10624
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
10625
|
+
* object when firing the event
|
|
10626
|
+
*/
|
|
10627
|
+
oData: object,
|
|
10628
|
+
/**
|
|
10629
|
+
* The function to be called when the event occurs
|
|
10630
|
+
*/
|
|
10631
|
+
fnFunction: (p1: Event) => void,
|
|
10632
|
+
/**
|
|
10633
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.comp.p13n.P13nConditionPanelBase`
|
|
10634
|
+
* itself
|
|
10635
|
+
*/
|
|
10636
|
+
oListener?: object
|
|
10637
|
+
): this;
|
|
10638
|
+
/**
|
|
10639
|
+
* Attaches event handler `fnFunction` to the {@link #event:dataChange dataChange} event of this `sap.ui.comp.p13n.P13nConditionPanelBase`.
|
|
10640
|
+
*
|
|
10641
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
10642
|
+
* otherwise it will be bound to this `sap.ui.comp.p13n.P13nConditionPanelBase` itself.
|
|
10643
|
+
*
|
|
10644
|
+
* Workaround for updating the binding
|
|
10645
|
+
*
|
|
10646
|
+
*
|
|
10647
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10648
|
+
*/
|
|
10649
|
+
attachDataChange(
|
|
10650
|
+
/**
|
|
10651
|
+
* The function to be called when the event occurs
|
|
10652
|
+
*/
|
|
10653
|
+
fnFunction: (p1: Event) => void,
|
|
10654
|
+
/**
|
|
10655
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.comp.p13n.P13nConditionPanelBase`
|
|
10656
|
+
* itself
|
|
10657
|
+
*/
|
|
10658
|
+
oListener?: object
|
|
10659
|
+
): this;
|
|
10660
|
+
/**
|
|
10661
|
+
* Detaches event handler `fnFunction` from the {@link #event:dataChange dataChange} event of this `sap.ui.comp.p13n.P13nConditionPanelBase`.
|
|
10662
|
+
*
|
|
10663
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
10664
|
+
*
|
|
10665
|
+
*
|
|
10666
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10667
|
+
*/
|
|
10668
|
+
detachDataChange(
|
|
10669
|
+
/**
|
|
10670
|
+
* The function to be called, when the event occurs
|
|
10671
|
+
*/
|
|
10672
|
+
fnFunction: (p1: Event) => void,
|
|
10673
|
+
/**
|
|
10674
|
+
* Context object on which the given function had to be called
|
|
10675
|
+
*/
|
|
10676
|
+
oListener?: object
|
|
10677
|
+
): this;
|
|
10678
|
+
/**
|
|
10679
|
+
* Fires event {@link #event:dataChange dataChange} to attached listeners.
|
|
10680
|
+
*
|
|
10681
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10682
|
+
*
|
|
10683
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10684
|
+
*/
|
|
10685
|
+
fireDataChange(
|
|
10686
|
+
/**
|
|
10687
|
+
* Parameters to pass along with the event
|
|
10688
|
+
*/
|
|
10689
|
+
mParameters?: object
|
|
10690
|
+
): this;
|
|
10691
|
+
/**
|
|
10692
|
+
* Gets current value of property {@link #getAlwaysShowAddIcon alwaysShowAddIcon}.
|
|
10693
|
+
*
|
|
10694
|
+
* makes the Add icon visible on each condition row. If is set to false the Add is only visible at the end
|
|
10695
|
+
* and you can only append a new condition.
|
|
10696
|
+
*
|
|
10697
|
+
* Default value is `true`.
|
|
10698
|
+
*
|
|
10699
|
+
*
|
|
10700
|
+
* @returns Value of property `alwaysShowAddIcon`
|
|
10701
|
+
*/
|
|
10702
|
+
getAlwaysShowAddIcon(): boolean;
|
|
10703
|
+
/**
|
|
10704
|
+
* Gets current value of property {@link #getAutoAddNewRow autoAddNewRow}.
|
|
10705
|
+
*
|
|
10706
|
+
* adds initial a new empty condition row
|
|
10707
|
+
*
|
|
10708
|
+
* Default value is `false`.
|
|
10709
|
+
*
|
|
10710
|
+
*
|
|
10711
|
+
* @returns Value of property `autoAddNewRow`
|
|
10712
|
+
*/
|
|
10713
|
+
getAutoAddNewRow(): boolean;
|
|
10714
|
+
/**
|
|
10715
|
+
* Gets current value of property {@link #getAutoReduceKeyFieldItems autoReduceKeyFieldItems}.
|
|
10716
|
+
*
|
|
10717
|
+
* KeyField value can only be selected once. When you set the property to `true` the ConditionPanel will
|
|
10718
|
+
* automatically offers on the KeyField drop down only the keyFields which are not used. The default behavior
|
|
10719
|
+
* is that in each keyField dropdown all keyfields are listed.
|
|
10720
|
+
*
|
|
10721
|
+
* Default value is `false`.
|
|
10722
|
+
*
|
|
10723
|
+
*
|
|
10724
|
+
* @returns Value of property `autoReduceKeyFieldItems`
|
|
10725
|
+
*/
|
|
10726
|
+
getAutoReduceKeyFieldItems(): boolean;
|
|
10727
|
+
/**
|
|
10728
|
+
* returns array of all defined conditions.
|
|
10729
|
+
*
|
|
10730
|
+
*
|
|
10731
|
+
* @returns array of Conditions
|
|
10732
|
+
*/
|
|
10733
|
+
getConditions(): object[];
|
|
10734
|
+
/**
|
|
10735
|
+
* Gets current value of property {@link #getContainerQuery containerQuery}.
|
|
10736
|
+
*
|
|
10737
|
+
* defines if the mediaQuery or a ContainerResize will be used for layout update. When the `P13nConditionPanelBase`
|
|
10738
|
+
* is used on a dialog the property should be set to `true`!
|
|
10739
|
+
*
|
|
10740
|
+
* Default value is `false`.
|
|
10741
|
+
*
|
|
10742
|
+
*
|
|
10743
|
+
* @returns Value of property `containerQuery`
|
|
10744
|
+
*/
|
|
10745
|
+
getContainerQuery(): boolean;
|
|
10746
|
+
/**
|
|
10747
|
+
* Gets current value of property {@link #getDisableFirstRemoveIcon disableFirstRemoveIcon}.
|
|
10748
|
+
*
|
|
10749
|
+
* makes the remove icon on the first condition row disabled when only one condition exist.
|
|
10750
|
+
*
|
|
10751
|
+
* Default value is `false`.
|
|
10752
|
+
*
|
|
10753
|
+
*
|
|
10754
|
+
* @returns Value of property `disableFirstRemoveIcon`
|
|
10755
|
+
*/
|
|
10756
|
+
getDisableFirstRemoveIcon(): boolean;
|
|
10757
|
+
/**
|
|
10758
|
+
* Gets current value of property {@link #getDisplayFormat displayFormat}.
|
|
10759
|
+
*
|
|
10760
|
+
* This represents the displayFormat of the condition Values. With the value "UpperCase" the entered value
|
|
10761
|
+
* of the condition will be converted to upperCase.
|
|
10762
|
+
*
|
|
10763
|
+
*
|
|
10764
|
+
* @returns Value of property `displayFormat`
|
|
10765
|
+
*/
|
|
10766
|
+
getDisplayFormat(): string;
|
|
10767
|
+
/**
|
|
10768
|
+
* Gets current value of property {@link #getExclude exclude}.
|
|
10769
|
+
*
|
|
10770
|
+
* exclude options for filter
|
|
10771
|
+
*
|
|
10772
|
+
* Default value is `false`.
|
|
10773
|
+
*
|
|
10774
|
+
*
|
|
10775
|
+
* @returns Value of property `exclude`
|
|
10776
|
+
*/
|
|
10777
|
+
getExclude(): boolean;
|
|
10778
|
+
/**
|
|
10779
|
+
* getter for KeyFields array
|
|
10780
|
+
*
|
|
10781
|
+
*
|
|
10782
|
+
* @returns array of KeyFields `[{key: "CompanyCode", text: "ID"}, {key:"CompanyName", text : "Name"}]`
|
|
10783
|
+
*/
|
|
10784
|
+
getKeyFields(): object[];
|
|
10785
|
+
/**
|
|
10786
|
+
* Gets current value of property {@link #getLayoutMode layoutMode}.
|
|
10787
|
+
*
|
|
10788
|
+
* can be used to control the layout behavior. Default is "" which will automatically change the layout.
|
|
10789
|
+
* With "Desktop", "Table" or "Phone" you can set a fixed layout.
|
|
10790
|
+
*
|
|
10791
|
+
*
|
|
10792
|
+
* @returns Value of property `layoutMode`
|
|
10793
|
+
*/
|
|
10794
|
+
getLayoutMode(): string;
|
|
10795
|
+
/**
|
|
10796
|
+
* Gets current value of property {@link #getMaxConditions maxConditions}.
|
|
10797
|
+
*
|
|
10798
|
+
* defines the max number of conditions on the ConditionPanel
|
|
10799
|
+
*
|
|
10800
|
+
* Default value is `'-1'`.
|
|
10801
|
+
*
|
|
10802
|
+
*
|
|
10803
|
+
* @returns Value of property `maxConditions`
|
|
10804
|
+
*/
|
|
10805
|
+
getMaxConditions(): string;
|
|
10806
|
+
/**
|
|
10807
|
+
* returns the default array of operations
|
|
10808
|
+
*
|
|
10809
|
+
*
|
|
10810
|
+
* @returns array of operations
|
|
10811
|
+
*/
|
|
10812
|
+
getOperations(
|
|
10813
|
+
/**
|
|
10814
|
+
* defines the type for which the operations should be returned.
|
|
10815
|
+
*/
|
|
10816
|
+
sType?: string
|
|
10817
|
+
): /* was: sap.ui.compP13nConditionOperation */ any[];
|
|
10818
|
+
/**
|
|
10819
|
+
* Gets current value of property {@link #getShowLabel showLabel}.
|
|
10820
|
+
*
|
|
10821
|
+
* show additional labels in the condition
|
|
10822
|
+
*
|
|
10823
|
+
* Default value is `false`.
|
|
10824
|
+
*
|
|
10825
|
+
*
|
|
10826
|
+
* @returns Value of property `showLabel`
|
|
10827
|
+
*/
|
|
10828
|
+
getShowLabel(): boolean;
|
|
10829
|
+
/**
|
|
10830
|
+
* Gets current value of property {@link #getUsePrevConditionSetting usePrevConditionSetting}.
|
|
10831
|
+
*
|
|
10832
|
+
* new added condition use the settings from the previous condition as default.
|
|
10833
|
+
*
|
|
10834
|
+
* Default value is `true`.
|
|
10835
|
+
*
|
|
10836
|
+
*
|
|
10837
|
+
* @returns Value of property `usePrevConditionSetting`
|
|
10838
|
+
*/
|
|
10839
|
+
getUsePrevConditionSetting(): boolean;
|
|
10840
|
+
/**
|
|
10841
|
+
* Gets current value of property {@link #getValidationExecutor validationExecutor}.
|
|
10842
|
+
*
|
|
10843
|
+
* Calls the validation listener tbd...
|
|
10844
|
+
*
|
|
10845
|
+
*
|
|
10846
|
+
* @returns Value of property `validationExecutor`
|
|
10847
|
+
*/
|
|
10848
|
+
getValidationExecutor(): object;
|
|
10849
|
+
/**
|
|
10850
|
+
* insert a single condition.
|
|
10851
|
+
*/
|
|
10852
|
+
insertCondition(
|
|
10853
|
+
/**
|
|
10854
|
+
* the new condition of type `{ "key": "007", "operation": sap.ui.compP13nConditionOperation.Ascending,
|
|
10855
|
+
* "keyField": "keyFieldKey", "value1": "", "value2": ""};`
|
|
10856
|
+
*/
|
|
10857
|
+
oCondition: object,
|
|
10858
|
+
/**
|
|
10859
|
+
* of the new condition
|
|
10860
|
+
*/
|
|
10861
|
+
index: int
|
|
10862
|
+
): void;
|
|
10863
|
+
/**
|
|
10864
|
+
* remove all conditions.
|
|
10865
|
+
*/
|
|
10866
|
+
removeAllConditions(): void;
|
|
10867
|
+
/**
|
|
10868
|
+
* removes all KeyFields
|
|
10869
|
+
*/
|
|
10870
|
+
removeAllKeyFields(): void;
|
|
10871
|
+
/**
|
|
10872
|
+
* remove all operations
|
|
10873
|
+
*/
|
|
10874
|
+
removeAllOperations(
|
|
10875
|
+
/**
|
|
10876
|
+
* defines the type for which all operations should be removed
|
|
10877
|
+
*/
|
|
10878
|
+
sType: string
|
|
10879
|
+
): void;
|
|
10880
|
+
/**
|
|
10881
|
+
* remove a single condition.
|
|
10882
|
+
*/
|
|
10883
|
+
removeCondition(
|
|
10884
|
+
/**
|
|
10885
|
+
* is the condition which should be removed. can be either a string with the key of the condition of the
|
|
10886
|
+
* condition object itself.
|
|
10887
|
+
*/
|
|
10888
|
+
vCondition: object
|
|
10889
|
+
): void;
|
|
10890
|
+
/**
|
|
10891
|
+
* removes all invalid conditions.
|
|
10892
|
+
*
|
|
10893
|
+
* @since 1.28.0
|
|
10894
|
+
*/
|
|
10895
|
+
removeInvalidConditions(): void;
|
|
10896
|
+
/**
|
|
10897
|
+
* removes all errors/warning states from the value1/2 fields of all conditions.
|
|
10898
|
+
*
|
|
10899
|
+
* @since 1.28.0
|
|
10900
|
+
*/
|
|
10901
|
+
removeValidationErrors(): void;
|
|
10902
|
+
/**
|
|
10903
|
+
* Sets a new value for property {@link #getAutoAddNewRow autoAddNewRow}.
|
|
10904
|
+
*
|
|
10905
|
+
* adds initial a new empty condition row
|
|
10906
|
+
*
|
|
10907
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10908
|
+
*
|
|
10909
|
+
* Default value is `false`.
|
|
10910
|
+
*
|
|
10911
|
+
*
|
|
10912
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10913
|
+
*/
|
|
10914
|
+
setAutoAddNewRow(
|
|
10915
|
+
/**
|
|
10916
|
+
* New value for property `autoAddNewRow`
|
|
10917
|
+
*/
|
|
10918
|
+
bAutoAddNewRow?: boolean
|
|
10919
|
+
): this;
|
|
10920
|
+
/**
|
|
10921
|
+
* Sets a new value for property {@link #getAutoReduceKeyFieldItems autoReduceKeyFieldItems}.
|
|
10922
|
+
*
|
|
10923
|
+
* KeyField value can only be selected once. When you set the property to `true` the ConditionPanel will
|
|
10924
|
+
* automatically offers on the KeyField drop down only the keyFields which are not used. The default behavior
|
|
10925
|
+
* is that in each keyField dropdown all keyfields are listed.
|
|
10926
|
+
*
|
|
10927
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10928
|
+
*
|
|
10929
|
+
* Default value is `false`.
|
|
10930
|
+
*
|
|
10931
|
+
*
|
|
10932
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10933
|
+
*/
|
|
10934
|
+
setAutoReduceKeyFieldItems(
|
|
10935
|
+
/**
|
|
10936
|
+
* New value for property `autoReduceKeyFieldItems`
|
|
10937
|
+
*/
|
|
10938
|
+
bAutoReduceKeyFieldItems?: boolean
|
|
10939
|
+
): this;
|
|
10940
|
+
/**
|
|
10941
|
+
* This method must be used to assign a list of conditions.
|
|
10942
|
+
*/
|
|
10943
|
+
setConditions(
|
|
10944
|
+
/**
|
|
10945
|
+
* array of Conditions.
|
|
10946
|
+
*/
|
|
10947
|
+
aConditions: object[]
|
|
10948
|
+
): void;
|
|
10949
|
+
/**
|
|
10950
|
+
* Sets a new value for property {@link #getDisableFirstRemoveIcon disableFirstRemoveIcon}.
|
|
10951
|
+
*
|
|
10952
|
+
* makes the remove icon on the first condition row disabled when only one condition exist.
|
|
10953
|
+
*
|
|
10954
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10955
|
+
*
|
|
10956
|
+
* Default value is `false`.
|
|
10957
|
+
*
|
|
10958
|
+
*
|
|
10959
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10960
|
+
*/
|
|
10961
|
+
setDisableFirstRemoveIcon(
|
|
10962
|
+
/**
|
|
10963
|
+
* New value for property `disableFirstRemoveIcon`
|
|
10964
|
+
*/
|
|
10965
|
+
bDisableFirstRemoveIcon?: boolean
|
|
10966
|
+
): this;
|
|
10967
|
+
/**
|
|
10968
|
+
* Sets a new value for property {@link #getDisplayFormat displayFormat}.
|
|
10969
|
+
*
|
|
10970
|
+
* This represents the displayFormat of the condition Values. With the value "UpperCase" the entered value
|
|
10971
|
+
* of the condition will be converted to upperCase.
|
|
10972
|
+
*
|
|
10973
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10974
|
+
*
|
|
10975
|
+
*
|
|
10976
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10977
|
+
*/
|
|
10978
|
+
setDisplayFormat(
|
|
10979
|
+
/**
|
|
10980
|
+
* New value for property `displayFormat`
|
|
10981
|
+
*/
|
|
10982
|
+
sDisplayFormat?: string
|
|
10983
|
+
): this;
|
|
10984
|
+
/**
|
|
10985
|
+
* Sets a new value for property {@link #getExclude exclude}.
|
|
10986
|
+
*
|
|
10987
|
+
* exclude options for filter
|
|
10988
|
+
*
|
|
10989
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10990
|
+
*
|
|
10991
|
+
* Default value is `false`.
|
|
10992
|
+
*
|
|
10993
|
+
*
|
|
10994
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
10995
|
+
*/
|
|
10996
|
+
setExclude(
|
|
10997
|
+
/**
|
|
10998
|
+
* New value for property `exclude`
|
|
10999
|
+
*/
|
|
11000
|
+
bExclude?: boolean
|
|
11001
|
+
): this;
|
|
11002
|
+
/**
|
|
11003
|
+
* This method allows you to specify the KeyFields for the conditions. You can set an array of object with
|
|
11004
|
+
* Key and Text properties to define the keyfields.
|
|
11005
|
+
*/
|
|
11006
|
+
setKeyFields(
|
|
11007
|
+
/**
|
|
11008
|
+
* array of KeyFields `[{key: "CompanyCode", text: "ID"}, {key:"CompanyName", text : "Name"}]`
|
|
11009
|
+
*/
|
|
11010
|
+
aKeyFields: any[]
|
|
11011
|
+
): void;
|
|
11012
|
+
/**
|
|
11013
|
+
* Sets a new value for property {@link #getMaxConditions maxConditions}.
|
|
11014
|
+
*
|
|
11015
|
+
* defines the max number of conditions on the ConditionPanel
|
|
11016
|
+
*
|
|
11017
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
11018
|
+
*
|
|
11019
|
+
* Default value is `'-1'`.
|
|
11020
|
+
*
|
|
11021
|
+
*
|
|
11022
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11023
|
+
*/
|
|
11024
|
+
setMaxConditions(
|
|
11025
|
+
/**
|
|
11026
|
+
* New value for property `maxConditions`
|
|
11027
|
+
*/
|
|
11028
|
+
sMaxConditions?: string
|
|
11029
|
+
): this;
|
|
11030
|
+
/**
|
|
11031
|
+
* setter for the supported operations which we show per condition row. This array of "default" operations
|
|
11032
|
+
* will only be used when we do not have on the keyfield itself some specific operations and a keyfield
|
|
11033
|
+
* is of not of type date or numeric.
|
|
11034
|
+
*/
|
|
11035
|
+
setOperations(
|
|
11036
|
+
/**
|
|
11037
|
+
* array of operations `[sap.ui.compP13nConditionOperation.BT, sap.ui.compP13nConditionOperation.EQ]`
|
|
11038
|
+
*/
|
|
11039
|
+
aOperations: /* was: sap.ui.compP13nConditionOperation */ any[],
|
|
11040
|
+
/**
|
|
11041
|
+
* defines the type for which this operations will be used. is `sType` is not defined the operations will
|
|
11042
|
+
* be used as default operations.
|
|
11043
|
+
*/
|
|
11044
|
+
sType: string
|
|
11045
|
+
): void;
|
|
11046
|
+
/**
|
|
11047
|
+
* Sets a new value for property {@link #getShowLabel showLabel}.
|
|
11048
|
+
*
|
|
11049
|
+
* show additional labels in the condition
|
|
11050
|
+
*
|
|
11051
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
11052
|
+
*
|
|
11053
|
+
* Default value is `false`.
|
|
11054
|
+
*
|
|
11055
|
+
*
|
|
11056
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11057
|
+
*/
|
|
11058
|
+
setShowLabel(
|
|
11059
|
+
/**
|
|
11060
|
+
* New value for property `showLabel`
|
|
11061
|
+
*/
|
|
11062
|
+
bShowLabel?: boolean
|
|
11063
|
+
): this;
|
|
11064
|
+
/**
|
|
11065
|
+
* Sets a new value for property {@link #getUsePrevConditionSetting usePrevConditionSetting}.
|
|
11066
|
+
*
|
|
11067
|
+
* new added condition use the settings from the previous condition as default.
|
|
11068
|
+
*
|
|
11069
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
11070
|
+
*
|
|
11071
|
+
* Default value is `true`.
|
|
11072
|
+
*
|
|
11073
|
+
*
|
|
11074
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11075
|
+
*/
|
|
11076
|
+
setUsePrevConditionSetting(
|
|
11077
|
+
/**
|
|
11078
|
+
* New value for property `usePrevConditionSetting`
|
|
11079
|
+
*/
|
|
11080
|
+
bUsePrevConditionSetting?: boolean
|
|
11081
|
+
): this;
|
|
11082
|
+
/**
|
|
11083
|
+
* Sets a new value for property {@link #getValidationExecutor validationExecutor}.
|
|
11084
|
+
*
|
|
11085
|
+
* Calls the validation listener tbd...
|
|
11086
|
+
*
|
|
11087
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
11088
|
+
*
|
|
11089
|
+
*
|
|
11090
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11091
|
+
*/
|
|
11092
|
+
setValidationExecutor(
|
|
11093
|
+
/**
|
|
11094
|
+
* New value for property `validationExecutor`
|
|
11095
|
+
*/
|
|
11096
|
+
oValidationExecutor?: object
|
|
11097
|
+
): this;
|
|
11098
|
+
}
|
|
11099
|
+
/**
|
|
11100
|
+
* Describes the settings that can be provided to the P13nConditionPanelBase constructor.
|
|
11101
|
+
*/
|
|
11102
|
+
export interface $P13nConditionPanelBaseSettings extends $ControlSettings {
|
|
11103
|
+
/**
|
|
11104
|
+
* defines the max number of conditions on the ConditionPanel
|
|
11105
|
+
*/
|
|
11106
|
+
maxConditions?: string | PropertyBindingInfo;
|
|
11107
|
+
|
|
11108
|
+
/**
|
|
11109
|
+
* exclude options for filter
|
|
11110
|
+
*/
|
|
11111
|
+
exclude?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
11112
|
+
|
|
11113
|
+
/**
|
|
11114
|
+
* defines if the mediaQuery or a ContainerResize will be used for layout update. When the `P13nConditionPanelBase`
|
|
11115
|
+
* is used on a dialog the property should be set to `true`!
|
|
11116
|
+
*/
|
|
11117
|
+
containerQuery?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
11118
|
+
|
|
11119
|
+
/**
|
|
11120
|
+
* adds initial a new empty condition row
|
|
11121
|
+
*/
|
|
11122
|
+
autoAddNewRow?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
11123
|
+
|
|
11124
|
+
/**
|
|
11125
|
+
* makes the remove icon on the first condition row disabled when only one condition exist.
|
|
11126
|
+
*/
|
|
11127
|
+
disableFirstRemoveIcon?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
11128
|
+
|
|
11129
|
+
/**
|
|
11130
|
+
* makes the Add icon visible on each condition row. If is set to false the Add is only visible at the end
|
|
11131
|
+
* and you can only append a new condition.
|
|
11132
|
+
*/
|
|
11133
|
+
alwaysShowAddIcon?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
11134
|
+
|
|
11135
|
+
/**
|
|
11136
|
+
* new added condition use the settings from the previous condition as default.
|
|
11137
|
+
*/
|
|
11138
|
+
usePrevConditionSetting?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
11139
|
+
|
|
11140
|
+
/**
|
|
11141
|
+
* KeyField value can only be selected once. When you set the property to `true` the ConditionPanel will
|
|
11142
|
+
* automatically offers on the KeyField drop down only the keyFields which are not used. The default behavior
|
|
11143
|
+
* is that in each keyField dropdown all keyfields are listed.
|
|
11144
|
+
*/
|
|
11145
|
+
autoReduceKeyFieldItems?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
11146
|
+
|
|
11147
|
+
/**
|
|
11148
|
+
* can be used to control the layout behavior. Default is "" which will automatically change the layout.
|
|
11149
|
+
* With "Desktop", "Table" or "Phone" you can set a fixed layout.
|
|
11150
|
+
*/
|
|
11151
|
+
layoutMode?: string | PropertyBindingInfo;
|
|
11152
|
+
|
|
11153
|
+
/**
|
|
11154
|
+
* show additional labels in the condition
|
|
11155
|
+
*/
|
|
11156
|
+
showLabel?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
11157
|
+
|
|
11158
|
+
/**
|
|
11159
|
+
* This represents the displayFormat of the condition Values. With the value "UpperCase" the entered value
|
|
11160
|
+
* of the condition will be converted to upperCase.
|
|
11161
|
+
*/
|
|
11162
|
+
displayFormat?: string | PropertyBindingInfo;
|
|
11163
|
+
|
|
11164
|
+
/**
|
|
11165
|
+
* Calls the validation listener tbd...
|
|
11166
|
+
*/
|
|
11167
|
+
validationExecutor?: object | PropertyBindingInfo | `{${string}}`;
|
|
11168
|
+
|
|
11169
|
+
/**
|
|
11170
|
+
* Workaround for updating the binding
|
|
11171
|
+
*/
|
|
11172
|
+
dataChange?: (oEvent: Event) => void;
|
|
11173
|
+
}
|
|
11174
|
+
|
|
11175
|
+
/**
|
|
11176
|
+
* Parameters of the P13nConditionPanelBase#dataChange event.
|
|
11177
|
+
*/
|
|
11178
|
+
export interface P13nConditionPanelBase$DataChangeEventParameters {}
|
|
11179
|
+
|
|
11180
|
+
/**
|
|
11181
|
+
* Event object of the P13nConditionPanelBase#dataChange event.
|
|
11182
|
+
*/
|
|
11183
|
+
export type P13nConditionPanelBase$DataChangeEvent = Event<
|
|
11184
|
+
P13nConditionPanelBase$DataChangeEventParameters,
|
|
11185
|
+
P13nConditionPanelBase
|
|
11186
|
+
>;
|
|
11187
|
+
}
|
|
11188
|
+
|
|
11189
|
+
declare module "sap/ui/comp/p13n/P13nFilterItem" {
|
|
11190
|
+
import { default as Item, $ItemSettings } from "sap/ui/core/Item";
|
|
11191
|
+
|
|
11192
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
11193
|
+
|
|
11194
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
11195
|
+
|
|
11196
|
+
/**
|
|
11197
|
+
* Type for `filterItems` aggregation in P13nFilterPanel control.
|
|
11198
|
+
*
|
|
11199
|
+
* @since 1.136
|
|
11200
|
+
*/
|
|
11201
|
+
export default class P13nFilterItem extends Item {
|
|
11202
|
+
/**
|
|
11203
|
+
* Constructor for a new P13nFilterItem.
|
|
11204
|
+
*
|
|
11205
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
11206
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
11207
|
+
* of the syntax of the settings object.
|
|
11208
|
+
*/
|
|
11209
|
+
constructor(
|
|
11210
|
+
/**
|
|
11211
|
+
* initial settings for the new control
|
|
11212
|
+
*/
|
|
11213
|
+
mSettings?: $P13nFilterItemSettings
|
|
11214
|
+
);
|
|
11215
|
+
/**
|
|
11216
|
+
* Constructor for a new P13nFilterItem.
|
|
11217
|
+
*
|
|
11218
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
11219
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
11220
|
+
* of the syntax of the settings object.
|
|
11221
|
+
*/
|
|
11222
|
+
constructor(
|
|
11223
|
+
/**
|
|
11224
|
+
* ID for the new control, generated automatically if no ID is given
|
|
11225
|
+
*/
|
|
11226
|
+
sId?: string,
|
|
11227
|
+
/**
|
|
11228
|
+
* initial settings for the new control
|
|
11229
|
+
*/
|
|
11230
|
+
mSettings?: $P13nFilterItemSettings
|
|
11231
|
+
);
|
|
11232
|
+
|
|
11233
|
+
/**
|
|
11234
|
+
* Creates a new subclass of class sap.ui.comp.p13n.P13nFilterItem with name `sClassName` and enriches it
|
|
11235
|
+
* with the information contained in `oClassInfo`.
|
|
11236
|
+
*
|
|
11237
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Item.extend}.
|
|
11238
|
+
*
|
|
11239
|
+
*
|
|
11240
|
+
* @returns Created class / constructor function
|
|
11241
|
+
*/
|
|
11242
|
+
static extend<T extends Record<string, unknown>>(
|
|
11243
|
+
/**
|
|
11244
|
+
* Name of the class being created
|
|
11245
|
+
*/
|
|
11246
|
+
sClassName: string,
|
|
11247
|
+
/**
|
|
11248
|
+
* Object literal with information about the class
|
|
11249
|
+
*/
|
|
11250
|
+
oClassInfo?: sap.ClassInfo<T, P13nFilterItem>,
|
|
11251
|
+
/**
|
|
11252
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
11253
|
+
* used by this class
|
|
11254
|
+
*/
|
|
11255
|
+
FNMetaImpl?: Function
|
|
11256
|
+
): Function;
|
|
11257
|
+
/**
|
|
11258
|
+
* Returns a metadata object for class sap.ui.comp.p13n.P13nFilterItem.
|
|
11259
|
+
*
|
|
11260
|
+
*
|
|
11261
|
+
* @returns Metadata object describing this class
|
|
11262
|
+
*/
|
|
11263
|
+
static getMetadata(): ElementMetadata;
|
|
11264
|
+
/**
|
|
11265
|
+
* Gets current value of property {@link #getColumnKey columnKey}.
|
|
11266
|
+
*
|
|
11267
|
+
* key of the column
|
|
11268
|
+
*
|
|
11269
|
+
*
|
|
11270
|
+
* @returns Value of property `columnKey`
|
|
11271
|
+
*/
|
|
11272
|
+
getColumnKey(): string;
|
|
11273
|
+
/**
|
|
11274
|
+
* Gets current value of property {@link #getExclude exclude}.
|
|
11275
|
+
*
|
|
11276
|
+
* defines if the filter is an include or exclude filter item
|
|
11277
|
+
*
|
|
11278
|
+
* Default value is `false`.
|
|
11279
|
+
*
|
|
11280
|
+
*
|
|
11281
|
+
* @returns Value of property `exclude`
|
|
11282
|
+
*/
|
|
11283
|
+
getExclude(): boolean;
|
|
11284
|
+
/**
|
|
11285
|
+
* Gets current value of property {@link #getOperation operation}.
|
|
11286
|
+
*
|
|
11287
|
+
* sap.ui.comp.P13nConditionOperation
|
|
11288
|
+
*
|
|
11289
|
+
*
|
|
11290
|
+
* @returns Value of property `operation`
|
|
11291
|
+
*/
|
|
11292
|
+
getOperation(): string;
|
|
11293
|
+
/**
|
|
11294
|
+
* Gets current value of property {@link #getValue1 value1}.
|
|
11295
|
+
*
|
|
11296
|
+
* value of the filter
|
|
11297
|
+
*
|
|
11298
|
+
*
|
|
11299
|
+
* @returns Value of property `value1`
|
|
11300
|
+
*/
|
|
11301
|
+
getValue1(): string;
|
|
11302
|
+
/**
|
|
11303
|
+
* Gets current value of property {@link #getValue2 value2}.
|
|
11304
|
+
*
|
|
11305
|
+
* to value of the between filter
|
|
11306
|
+
*
|
|
11307
|
+
*
|
|
11308
|
+
* @returns Value of property `value2`
|
|
11309
|
+
*/
|
|
11310
|
+
getValue2(): string;
|
|
11311
|
+
/**
|
|
11312
|
+
* Sets a new value for property {@link #getColumnKey columnKey}.
|
|
11313
|
+
*
|
|
11314
|
+
* key of the column
|
|
11315
|
+
*
|
|
11316
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
11317
|
+
*
|
|
11318
|
+
*
|
|
11319
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11320
|
+
*/
|
|
11321
|
+
setColumnKey(
|
|
11322
|
+
/**
|
|
11323
|
+
* New value for property `columnKey`
|
|
11324
|
+
*/
|
|
11325
|
+
sColumnKey?: string
|
|
11326
|
+
): this;
|
|
11327
|
+
/**
|
|
11328
|
+
* Sets a new value for property {@link #getExclude exclude}.
|
|
11329
|
+
*
|
|
11330
|
+
* defines if the filter is an include or exclude filter item
|
|
11331
|
+
*
|
|
11332
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
11333
|
+
*
|
|
11334
|
+
* Default value is `false`.
|
|
11335
|
+
*
|
|
11336
|
+
*
|
|
11337
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11338
|
+
*/
|
|
11339
|
+
setExclude(
|
|
11340
|
+
/**
|
|
11341
|
+
* New value for property `exclude`
|
|
11342
|
+
*/
|
|
11343
|
+
bExclude?: boolean
|
|
11344
|
+
): this;
|
|
11345
|
+
/**
|
|
11346
|
+
* Sets a new value for property {@link #getOperation operation}.
|
|
11347
|
+
*
|
|
11348
|
+
* sap.ui.comp.P13nConditionOperation
|
|
11349
|
+
*
|
|
11350
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
11351
|
+
*
|
|
11352
|
+
*
|
|
11353
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11354
|
+
*/
|
|
11355
|
+
setOperation(
|
|
11356
|
+
/**
|
|
11357
|
+
* New value for property `operation`
|
|
11358
|
+
*/
|
|
11359
|
+
sOperation?: string
|
|
11360
|
+
): this;
|
|
11361
|
+
/**
|
|
11362
|
+
* Sets a new value for property {@link #getValue1 value1}.
|
|
11363
|
+
*
|
|
11364
|
+
* value of the filter
|
|
11365
|
+
*
|
|
11366
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
11367
|
+
*
|
|
11368
|
+
*
|
|
11369
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11370
|
+
*/
|
|
11371
|
+
setValue1(
|
|
11372
|
+
/**
|
|
11373
|
+
* New value for property `value1`
|
|
11374
|
+
*/
|
|
11375
|
+
sValue1?: string
|
|
11376
|
+
): this;
|
|
11377
|
+
/**
|
|
11378
|
+
* Sets a new value for property {@link #getValue2 value2}.
|
|
11379
|
+
*
|
|
11380
|
+
* to value of the between filter
|
|
11381
|
+
*
|
|
11382
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
11383
|
+
*
|
|
11384
|
+
*
|
|
11385
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11386
|
+
*/
|
|
11387
|
+
setValue2(
|
|
11388
|
+
/**
|
|
11389
|
+
* New value for property `value2`
|
|
11390
|
+
*/
|
|
11391
|
+
sValue2?: string
|
|
11392
|
+
): this;
|
|
11393
|
+
}
|
|
11394
|
+
/**
|
|
11395
|
+
* Describes the settings that can be provided to the P13nFilterItem constructor.
|
|
11396
|
+
*/
|
|
11397
|
+
export interface $P13nFilterItemSettings extends $ItemSettings {
|
|
11398
|
+
/**
|
|
11399
|
+
* sap.ui.comp.P13nConditionOperation
|
|
11400
|
+
*/
|
|
11401
|
+
operation?: string | PropertyBindingInfo;
|
|
11402
|
+
|
|
11403
|
+
/**
|
|
11404
|
+
* value of the filter
|
|
11405
|
+
*/
|
|
11406
|
+
value1?: string | PropertyBindingInfo;
|
|
11407
|
+
|
|
11408
|
+
/**
|
|
11409
|
+
* to value of the between filter
|
|
11410
|
+
*/
|
|
11411
|
+
value2?: string | PropertyBindingInfo;
|
|
11412
|
+
|
|
11413
|
+
/**
|
|
11414
|
+
* key of the column
|
|
11415
|
+
*/
|
|
11416
|
+
columnKey?: string | PropertyBindingInfo;
|
|
11417
|
+
|
|
11418
|
+
/**
|
|
11419
|
+
* defines if the filter is an include or exclude filter item
|
|
11420
|
+
*/
|
|
11421
|
+
exclude?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
11422
|
+
}
|
|
11423
|
+
}
|
|
11424
|
+
|
|
11425
|
+
declare module "sap/ui/comp/p13n/P13nFilterPanelBase" {
|
|
11426
|
+
import Event from "sap/ui/base/Event";
|
|
11427
|
+
|
|
11428
|
+
import { AggregationBindingInfo } from "sap/ui/base/ManagedObject";
|
|
11429
|
+
|
|
11430
|
+
import MessageStrip from "sap/m/MessageStrip";
|
|
11431
|
+
|
|
11432
|
+
import Metadata from "sap/ui/base/Metadata";
|
|
11433
|
+
|
|
11434
|
+
/**
|
|
11435
|
+
* The P13nFilterPanelBase control is used to define filter-specific settings for table personalization.
|
|
11436
|
+
*
|
|
11437
|
+
* @since 1.136
|
|
11438
|
+
*/
|
|
11439
|
+
export default class P13nFilterPanelBase
|
|
11440
|
+
extends /* was: sap.ui.comp.P13nPanel */ Object
|
|
11441
|
+
{
|
|
11442
|
+
/**
|
|
11443
|
+
* Constructor for a new P13nFilterPanelBase.
|
|
11444
|
+
*
|
|
11445
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
11446
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
11447
|
+
* of the syntax of the settings object.
|
|
11448
|
+
*/
|
|
11449
|
+
constructor(
|
|
11450
|
+
/**
|
|
11451
|
+
* ID for the new control, generated automatically if no ID is given
|
|
11452
|
+
*/
|
|
11453
|
+
sId?: string,
|
|
11454
|
+
/**
|
|
11455
|
+
* initial settings for the new control
|
|
11456
|
+
*/
|
|
11457
|
+
mSettings?: object
|
|
11458
|
+
);
|
|
11459
|
+
|
|
11460
|
+
/**
|
|
11461
|
+
* Creates a new subclass of class sap.ui.comp.p13n.P13nFilterPanelBase with name `sClassName` and enriches
|
|
11462
|
+
* it with the information contained in `oClassInfo`.
|
|
11463
|
+
*
|
|
11464
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.comp.P13nPanel.extend}.
|
|
11465
|
+
*
|
|
11466
|
+
*
|
|
11467
|
+
* @returns Created class / constructor function
|
|
11468
|
+
*/
|
|
11469
|
+
static extend<T extends Record<string, unknown>>(
|
|
11470
|
+
/**
|
|
11471
|
+
* Name of the class being created
|
|
11472
|
+
*/
|
|
11473
|
+
sClassName: string,
|
|
11474
|
+
/**
|
|
11475
|
+
* Object literal with information about the class
|
|
11476
|
+
*/
|
|
11477
|
+
oClassInfo?: sap.ClassInfo<T, P13nFilterPanelBase>,
|
|
11478
|
+
/**
|
|
11479
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
11480
|
+
* used by this class
|
|
11481
|
+
*/
|
|
11482
|
+
FNMetaImpl?: Function
|
|
11483
|
+
): Function;
|
|
11484
|
+
/**
|
|
11485
|
+
* Returns a metadata object for class sap.ui.comp.p13n.P13nFilterPanelBase.
|
|
11486
|
+
*
|
|
11487
|
+
*
|
|
11488
|
+
* @returns Metadata object describing this class
|
|
11489
|
+
*/
|
|
11490
|
+
static getMetadata(): Metadata;
|
|
11491
|
+
/**
|
|
11492
|
+
* Adds some filterItem to the aggregation {@link #getFilterItems filterItems}.
|
|
11493
|
+
*
|
|
11494
|
+
*
|
|
11495
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11496
|
+
*/
|
|
11497
|
+
addFilterItem(
|
|
11498
|
+
/**
|
|
11499
|
+
* The filterItem to add; if empty, nothing is inserted
|
|
11500
|
+
*/
|
|
11501
|
+
oFilterItem: /* was: sap.ui.comp.P13nFilterItem */ any
|
|
11502
|
+
): this;
|
|
11503
|
+
/**
|
|
11504
|
+
* Attaches event handler `fnFunction` to the {@link #event:addFilterItem addFilterItem} event of this `sap.ui.comp.p13n.P13nFilterPanelBase`.
|
|
11505
|
+
*
|
|
11506
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
11507
|
+
* otherwise it will be bound to this `sap.ui.comp.p13n.P13nFilterPanelBase` itself.
|
|
11508
|
+
*
|
|
11509
|
+
* Event raised if a filter item has been added.
|
|
11510
|
+
*
|
|
11511
|
+
*
|
|
11512
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11513
|
+
*/
|
|
11514
|
+
attachAddFilterItem(
|
|
11515
|
+
/**
|
|
11516
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
11517
|
+
* object when firing the event
|
|
11518
|
+
*/
|
|
11519
|
+
oData: object,
|
|
11520
|
+
/**
|
|
11521
|
+
* The function to be called when the event occurs
|
|
11522
|
+
*/
|
|
11523
|
+
fnFunction: (p1: Event) => void,
|
|
11524
|
+
/**
|
|
11525
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.comp.p13n.P13nFilterPanelBase`
|
|
11526
|
+
* itself
|
|
11527
|
+
*/
|
|
11528
|
+
oListener?: object
|
|
11529
|
+
): this;
|
|
11530
|
+
/**
|
|
11531
|
+
* Attaches event handler `fnFunction` to the {@link #event:addFilterItem addFilterItem} event of this `sap.ui.comp.p13n.P13nFilterPanelBase`.
|
|
11532
|
+
*
|
|
11533
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
11534
|
+
* otherwise it will be bound to this `sap.ui.comp.p13n.P13nFilterPanelBase` itself.
|
|
11535
|
+
*
|
|
11536
|
+
* Event raised if a filter item has been added.
|
|
11537
|
+
*
|
|
11538
|
+
*
|
|
11539
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11540
|
+
*/
|
|
11541
|
+
attachAddFilterItem(
|
|
11542
|
+
/**
|
|
11543
|
+
* The function to be called when the event occurs
|
|
11544
|
+
*/
|
|
11545
|
+
fnFunction: (p1: Event) => void,
|
|
11546
|
+
/**
|
|
11547
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.comp.p13n.P13nFilterPanelBase`
|
|
11548
|
+
* itself
|
|
11549
|
+
*/
|
|
11550
|
+
oListener?: object
|
|
11551
|
+
): this;
|
|
11552
|
+
/**
|
|
11553
|
+
* Attaches event handler `fnFunction` to the {@link #event:filterItemChanged filterItemChanged} event of
|
|
11554
|
+
* this `sap.ui.comp.p13n.P13nFilterPanelBase`.
|
|
11555
|
+
*
|
|
11556
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
11557
|
+
* otherwise it will be bound to this `sap.ui.comp.p13n.P13nFilterPanelBase` itself.
|
|
11558
|
+
*
|
|
11559
|
+
* Event raised if a filter item has been changed. reason can be added, updated or removed.
|
|
11560
|
+
*
|
|
11561
|
+
*
|
|
11562
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11563
|
+
*/
|
|
11564
|
+
attachFilterItemChanged(
|
|
11565
|
+
/**
|
|
11566
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
11567
|
+
* object when firing the event
|
|
11568
|
+
*/
|
|
11569
|
+
oData: object,
|
|
11570
|
+
/**
|
|
11571
|
+
* The function to be called when the event occurs
|
|
11572
|
+
*/
|
|
11573
|
+
fnFunction: (p1: Event) => void,
|
|
11574
|
+
/**
|
|
11575
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.comp.p13n.P13nFilterPanelBase`
|
|
11576
|
+
* itself
|
|
11577
|
+
*/
|
|
11578
|
+
oListener?: object
|
|
11579
|
+
): this;
|
|
11580
|
+
/**
|
|
11581
|
+
* Attaches event handler `fnFunction` to the {@link #event:filterItemChanged filterItemChanged} event of
|
|
11582
|
+
* this `sap.ui.comp.p13n.P13nFilterPanelBase`.
|
|
11583
|
+
*
|
|
11584
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
11585
|
+
* otherwise it will be bound to this `sap.ui.comp.p13n.P13nFilterPanelBase` itself.
|
|
11586
|
+
*
|
|
11587
|
+
* Event raised if a filter item has been changed. reason can be added, updated or removed.
|
|
11588
|
+
*
|
|
11589
|
+
*
|
|
11590
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11591
|
+
*/
|
|
11592
|
+
attachFilterItemChanged(
|
|
11593
|
+
/**
|
|
11594
|
+
* The function to be called when the event occurs
|
|
11595
|
+
*/
|
|
11596
|
+
fnFunction: (p1: Event) => void,
|
|
11597
|
+
/**
|
|
11598
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.comp.p13n.P13nFilterPanelBase`
|
|
11599
|
+
* itself
|
|
11600
|
+
*/
|
|
11601
|
+
oListener?: object
|
|
11602
|
+
): this;
|
|
11603
|
+
/**
|
|
11604
|
+
* Attaches event handler `fnFunction` to the {@link #event:removeFilterItem removeFilterItem} event of
|
|
11605
|
+
* this `sap.ui.comp.p13n.P13nFilterPanelBase`.
|
|
11606
|
+
*
|
|
11607
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
11608
|
+
* otherwise it will be bound to this `sap.ui.comp.p13n.P13nFilterPanelBase` itself.
|
|
11609
|
+
*
|
|
11610
|
+
* Event raised if a filter item has been removed.
|
|
11611
|
+
*
|
|
11612
|
+
*
|
|
11613
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11614
|
+
*/
|
|
11615
|
+
attachRemoveFilterItem(
|
|
11616
|
+
/**
|
|
11617
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
11618
|
+
* object when firing the event
|
|
11619
|
+
*/
|
|
11620
|
+
oData: object,
|
|
11621
|
+
/**
|
|
11622
|
+
* The function to be called when the event occurs
|
|
11623
|
+
*/
|
|
11624
|
+
fnFunction: (p1: Event) => void,
|
|
11625
|
+
/**
|
|
11626
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.comp.p13n.P13nFilterPanelBase`
|
|
11627
|
+
* itself
|
|
11628
|
+
*/
|
|
11629
|
+
oListener?: object
|
|
11630
|
+
): this;
|
|
11631
|
+
/**
|
|
11632
|
+
* Attaches event handler `fnFunction` to the {@link #event:removeFilterItem removeFilterItem} event of
|
|
11633
|
+
* this `sap.ui.comp.p13n.P13nFilterPanelBase`.
|
|
11634
|
+
*
|
|
11635
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
11636
|
+
* otherwise it will be bound to this `sap.ui.comp.p13n.P13nFilterPanelBase` itself.
|
|
11637
|
+
*
|
|
11638
|
+
* Event raised if a filter item has been removed.
|
|
11639
|
+
*
|
|
11640
|
+
*
|
|
11641
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11642
|
+
*/
|
|
11643
|
+
attachRemoveFilterItem(
|
|
11644
|
+
/**
|
|
11645
|
+
* The function to be called when the event occurs
|
|
11646
|
+
*/
|
|
11647
|
+
fnFunction: (p1: Event) => void,
|
|
11648
|
+
/**
|
|
11649
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.comp.p13n.P13nFilterPanelBase`
|
|
11650
|
+
* itself
|
|
11651
|
+
*/
|
|
11652
|
+
oListener?: object
|
|
11653
|
+
): this;
|
|
11654
|
+
/**
|
|
11655
|
+
* Attaches event handler `fnFunction` to the {@link #event:updateFilterItem updateFilterItem} event of
|
|
11656
|
+
* this `sap.ui.comp.p13n.P13nFilterPanelBase`.
|
|
11657
|
+
*
|
|
11658
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
11659
|
+
* otherwise it will be bound to this `sap.ui.comp.p13n.P13nFilterPanelBase` itself.
|
|
11660
|
+
*
|
|
11661
|
+
* Event raised if a filter item has been updated.
|
|
11662
|
+
*
|
|
11663
|
+
*
|
|
11664
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11665
|
+
*/
|
|
11666
|
+
attachUpdateFilterItem(
|
|
11667
|
+
/**
|
|
11668
|
+
* An application-specific payload object that will be passed to the event handler along with the event
|
|
11669
|
+
* object when firing the event
|
|
11670
|
+
*/
|
|
11671
|
+
oData: object,
|
|
11672
|
+
/**
|
|
11673
|
+
* The function to be called when the event occurs
|
|
11674
|
+
*/
|
|
11675
|
+
fnFunction: (p1: Event) => void,
|
|
11676
|
+
/**
|
|
11677
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.comp.p13n.P13nFilterPanelBase`
|
|
11678
|
+
* itself
|
|
11679
|
+
*/
|
|
11680
|
+
oListener?: object
|
|
11681
|
+
): this;
|
|
11682
|
+
/**
|
|
11683
|
+
* Attaches event handler `fnFunction` to the {@link #event:updateFilterItem updateFilterItem} event of
|
|
11684
|
+
* this `sap.ui.comp.p13n.P13nFilterPanelBase`.
|
|
11685
|
+
*
|
|
11686
|
+
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
11687
|
+
* otherwise it will be bound to this `sap.ui.comp.p13n.P13nFilterPanelBase` itself.
|
|
11688
|
+
*
|
|
11689
|
+
* Event raised if a filter item has been updated.
|
|
11690
|
+
*
|
|
11691
|
+
*
|
|
11692
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11693
|
+
*/
|
|
11694
|
+
attachUpdateFilterItem(
|
|
11695
|
+
/**
|
|
11696
|
+
* The function to be called when the event occurs
|
|
11697
|
+
*/
|
|
11698
|
+
fnFunction: (p1: Event) => void,
|
|
11699
|
+
/**
|
|
11700
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.comp.p13n.P13nFilterPanelBase`
|
|
11701
|
+
* itself
|
|
11702
|
+
*/
|
|
11703
|
+
oListener?: object
|
|
11704
|
+
): this;
|
|
11705
|
+
/**
|
|
11706
|
+
* Binds aggregation {@link #getFilterItems filterItems} to model data.
|
|
11707
|
+
*
|
|
11708
|
+
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description
|
|
11709
|
+
* of the possible properties of `oBindingInfo`.
|
|
11710
|
+
*
|
|
11711
|
+
*
|
|
11712
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11713
|
+
*/
|
|
11714
|
+
bindFilterItems(
|
|
11715
|
+
/**
|
|
11716
|
+
* The binding information
|
|
11717
|
+
*/
|
|
11718
|
+
oBindingInfo: AggregationBindingInfo
|
|
11719
|
+
): this;
|
|
11720
|
+
/**
|
|
11721
|
+
* Destroys all the filterItems in the aggregation {@link #getFilterItems filterItems}.
|
|
11722
|
+
*
|
|
11723
|
+
*
|
|
11724
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11725
|
+
*/
|
|
11726
|
+
destroyFilterItems(): this;
|
|
11727
|
+
/**
|
|
11728
|
+
* Destroys the messageStrip in the aggregation {@link #getMessageStrip messageStrip}.
|
|
11729
|
+
*
|
|
11730
|
+
*
|
|
11731
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11732
|
+
*/
|
|
11733
|
+
destroyMessageStrip(): this;
|
|
11734
|
+
/**
|
|
11735
|
+
* Detaches event handler `fnFunction` from the {@link #event:addFilterItem addFilterItem} event of this
|
|
11736
|
+
* `sap.ui.comp.p13n.P13nFilterPanelBase`.
|
|
11737
|
+
*
|
|
11738
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
11739
|
+
*
|
|
11740
|
+
*
|
|
11741
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11742
|
+
*/
|
|
11743
|
+
detachAddFilterItem(
|
|
11744
|
+
/**
|
|
11745
|
+
* The function to be called, when the event occurs
|
|
11746
|
+
*/
|
|
11747
|
+
fnFunction: (p1: Event) => void,
|
|
11748
|
+
/**
|
|
11749
|
+
* Context object on which the given function had to be called
|
|
11750
|
+
*/
|
|
11751
|
+
oListener?: object
|
|
11752
|
+
): this;
|
|
11753
|
+
/**
|
|
11754
|
+
* Detaches event handler `fnFunction` from the {@link #event:filterItemChanged filterItemChanged} event
|
|
11755
|
+
* of this `sap.ui.comp.p13n.P13nFilterPanelBase`.
|
|
11756
|
+
*
|
|
11757
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
11758
|
+
*
|
|
11759
|
+
*
|
|
11760
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11761
|
+
*/
|
|
11762
|
+
detachFilterItemChanged(
|
|
11763
|
+
/**
|
|
11764
|
+
* The function to be called, when the event occurs
|
|
11765
|
+
*/
|
|
11766
|
+
fnFunction: (p1: Event) => void,
|
|
11767
|
+
/**
|
|
11768
|
+
* Context object on which the given function had to be called
|
|
11769
|
+
*/
|
|
11770
|
+
oListener?: object
|
|
11771
|
+
): this;
|
|
11772
|
+
/**
|
|
11773
|
+
* Detaches event handler `fnFunction` from the {@link #event:removeFilterItem removeFilterItem} event of
|
|
11774
|
+
* this `sap.ui.comp.p13n.P13nFilterPanelBase`.
|
|
11775
|
+
*
|
|
11776
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
11777
|
+
*
|
|
11778
|
+
*
|
|
11779
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11780
|
+
*/
|
|
11781
|
+
detachRemoveFilterItem(
|
|
11782
|
+
/**
|
|
11783
|
+
* The function to be called, when the event occurs
|
|
11784
|
+
*/
|
|
11785
|
+
fnFunction: (p1: Event) => void,
|
|
11786
|
+
/**
|
|
11787
|
+
* Context object on which the given function had to be called
|
|
11788
|
+
*/
|
|
11789
|
+
oListener?: object
|
|
11790
|
+
): this;
|
|
11791
|
+
/**
|
|
11792
|
+
* Detaches event handler `fnFunction` from the {@link #event:updateFilterItem updateFilterItem} event of
|
|
11793
|
+
* this `sap.ui.comp.p13n.P13nFilterPanelBase`.
|
|
11794
|
+
*
|
|
11795
|
+
* The passed function and listener object must match the ones used for event registration.
|
|
11796
|
+
*
|
|
11797
|
+
*
|
|
11798
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11799
|
+
*/
|
|
11800
|
+
detachUpdateFilterItem(
|
|
11801
|
+
/**
|
|
11802
|
+
* The function to be called, when the event occurs
|
|
11803
|
+
*/
|
|
11804
|
+
fnFunction: (p1: Event) => void,
|
|
11805
|
+
/**
|
|
11806
|
+
* Context object on which the given function had to be called
|
|
11807
|
+
*/
|
|
11808
|
+
oListener?: object
|
|
11809
|
+
): this;
|
|
11810
|
+
/**
|
|
11811
|
+
* Fires event {@link #event:addFilterItem addFilterItem} to attached listeners.
|
|
11812
|
+
*
|
|
11813
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
11814
|
+
*
|
|
11815
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11816
|
+
*/
|
|
11817
|
+
fireAddFilterItem(
|
|
11818
|
+
/**
|
|
11819
|
+
* Parameters to pass along with the event
|
|
11820
|
+
*/
|
|
11821
|
+
mParameters?: object
|
|
11822
|
+
): this;
|
|
11823
|
+
/**
|
|
11824
|
+
* Fires event {@link #event:filterItemChanged filterItemChanged} to attached listeners.
|
|
11825
|
+
*
|
|
11826
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
11827
|
+
*
|
|
11828
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11829
|
+
*/
|
|
11830
|
+
fireFilterItemChanged(
|
|
11831
|
+
/**
|
|
11832
|
+
* Parameters to pass along with the event
|
|
11833
|
+
*/
|
|
11834
|
+
mParameters?: {
|
|
11835
|
+
/**
|
|
11836
|
+
* reason for the changeFilterItem event. Value can be added, updated or removed.
|
|
11837
|
+
*/
|
|
11838
|
+
reason?: string;
|
|
11839
|
+
/**
|
|
11840
|
+
* key of the changed filterItem
|
|
11841
|
+
*/
|
|
11842
|
+
key?: string;
|
|
11843
|
+
/**
|
|
11844
|
+
* index of the changed filterItem
|
|
11845
|
+
*/
|
|
11846
|
+
index?: int;
|
|
11847
|
+
/**
|
|
11848
|
+
* JSON object of the changed filterItem instance (in case of reason=="removed" the itemData parameter does
|
|
11849
|
+
* not exist)
|
|
11850
|
+
*/
|
|
11851
|
+
itemData?: object;
|
|
11852
|
+
}
|
|
11853
|
+
): this;
|
|
11854
|
+
/**
|
|
11855
|
+
* Fires event {@link #event:removeFilterItem removeFilterItem} to attached listeners.
|
|
11856
|
+
*
|
|
11857
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
11858
|
+
*
|
|
11859
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11860
|
+
*/
|
|
11861
|
+
fireRemoveFilterItem(
|
|
11862
|
+
/**
|
|
11863
|
+
* Parameters to pass along with the event
|
|
11864
|
+
*/
|
|
11865
|
+
mParameters?: object
|
|
11866
|
+
): this;
|
|
11867
|
+
/**
|
|
11868
|
+
* Fires event {@link #event:updateFilterItem updateFilterItem} to attached listeners.
|
|
11869
|
+
*
|
|
11870
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
11871
|
+
*
|
|
11872
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11873
|
+
*/
|
|
11874
|
+
fireUpdateFilterItem(
|
|
11875
|
+
/**
|
|
11876
|
+
* Parameters to pass along with the event
|
|
11877
|
+
*/
|
|
11878
|
+
mParameters?: object
|
|
11879
|
+
): this;
|
|
11880
|
+
/**
|
|
11881
|
+
* Returns the array of conditions.
|
|
11882
|
+
*
|
|
11883
|
+
*
|
|
11884
|
+
* @returns array with filter conditions
|
|
11885
|
+
*/
|
|
11886
|
+
getConditions(): /* was: sap.ui.comp.P13nFilterPanelBase.FilterConditionOperations */ any[];
|
|
11887
|
+
/**
|
|
11888
|
+
* Gets current value of property {@link #getContainerQuery containerQuery}.
|
|
11889
|
+
*
|
|
11890
|
+
* Defines if the `mediaQuery` or a `ContainerResize` is used for layout update. If the `ConditionPanel`
|
|
11891
|
+
* is used in a dialog, the property must be set to `true`.
|
|
11892
|
+
*
|
|
11893
|
+
* Default value is `false`.
|
|
11894
|
+
*
|
|
11895
|
+
*
|
|
11896
|
+
* @returns Value of property `containerQuery`
|
|
11897
|
+
*/
|
|
11898
|
+
getContainerQuery(): boolean;
|
|
11899
|
+
/**
|
|
11900
|
+
* Gets current value of property {@link #getEnableEmptyOperations enableEmptyOperations}.
|
|
11901
|
+
*
|
|
11902
|
+
* Should empty operation be enabled for certain data types. This is also based on their nullable setting.
|
|
11903
|
+
*
|
|
11904
|
+
* Default value is `false`.
|
|
11905
|
+
*
|
|
11906
|
+
*
|
|
11907
|
+
* @returns Value of property `enableEmptyOperations`
|
|
11908
|
+
*/
|
|
11909
|
+
getEnableEmptyOperations(): boolean;
|
|
11910
|
+
/**
|
|
11911
|
+
* Getter for the exclude operations.
|
|
11912
|
+
*
|
|
11913
|
+
*
|
|
11914
|
+
* @returns array of operations [`sap.ui.comp.P13nConditionOperation.BT`, `sap.ui.comp.P13nConditionOperation.EQ`]
|
|
11915
|
+
*/
|
|
11916
|
+
getExcludeOperations(
|
|
11917
|
+
/**
|
|
11918
|
+
* the type for which the operations are defined
|
|
11919
|
+
*/
|
|
11920
|
+
sType: string
|
|
11921
|
+
): /* was: sap.ui.comp.P13nConditionOperation */ any[];
|
|
11922
|
+
/**
|
|
11923
|
+
* Gets content of aggregation {@link #getFilterItems filterItems}.
|
|
11924
|
+
*
|
|
11925
|
+
* Defines filter items.
|
|
11926
|
+
*/
|
|
11927
|
+
getFilterItems(): /* was: sap.ui.comp.P13nFilterItem */ any[];
|
|
11928
|
+
/**
|
|
11929
|
+
* Getter for the include operations.
|
|
11930
|
+
*
|
|
11931
|
+
*
|
|
11932
|
+
* @returns array of operations [`sap.ui.comp.P13nConditionOperation.BT`, `sap.ui.comp.P13nConditionOperation.EQ`]
|
|
11933
|
+
*/
|
|
11934
|
+
getIncludeOperations(
|
|
11935
|
+
/**
|
|
11936
|
+
* for which the operations are defined
|
|
11937
|
+
*/
|
|
11938
|
+
sType: string
|
|
11939
|
+
): /* was: sap.ui.comp.P13nConditionOperation */ any;
|
|
11940
|
+
/**
|
|
11941
|
+
* Gets current value of property {@link #getLayoutMode layoutMode}.
|
|
11942
|
+
*
|
|
11943
|
+
* Can be used to control the layout behavior. Default is "" which will automatically change the layout.
|
|
11944
|
+
* With "Desktop", "Table" or"Phone" you can set a fixed layout.
|
|
11945
|
+
*
|
|
11946
|
+
*
|
|
11947
|
+
* @returns Value of property `layoutMode`
|
|
11948
|
+
*/
|
|
11949
|
+
getLayoutMode(): string;
|
|
11950
|
+
/**
|
|
11951
|
+
* Gets current value of property {@link #getMaxExcludes maxExcludes}.
|
|
11952
|
+
*
|
|
11953
|
+
* Defines the maximum number of exclude filters.
|
|
11954
|
+
*
|
|
11955
|
+
* Default value is `'-1'`.
|
|
11956
|
+
*
|
|
11957
|
+
*
|
|
11958
|
+
* @returns Value of property `maxExcludes`
|
|
11959
|
+
*/
|
|
11960
|
+
getMaxExcludes(): string;
|
|
11961
|
+
/**
|
|
11962
|
+
* Gets current value of property {@link #getMaxIncludes maxIncludes}.
|
|
11963
|
+
*
|
|
11964
|
+
* Defines the maximum number of include filters.
|
|
11965
|
+
*
|
|
11966
|
+
* Default value is `'-1'`.
|
|
11967
|
+
*
|
|
11968
|
+
*
|
|
11969
|
+
* @returns Value of property `maxIncludes`
|
|
11970
|
+
*/
|
|
11971
|
+
getMaxIncludes(): string;
|
|
11972
|
+
/**
|
|
11973
|
+
* Gets content of aggregation {@link #getMessageStrip messageStrip}.
|
|
11974
|
+
*
|
|
11975
|
+
* Defines an optional message strip to be displayed in the content area
|
|
11976
|
+
*/
|
|
11977
|
+
getMessageStrip(): MessageStrip;
|
|
11978
|
+
/**
|
|
11979
|
+
* Checks for the provided `sap.ui.comp.P13nFilterItem` in the aggregation {@link #getFilterItems filterItems}.
|
|
11980
|
+
* and returns its index if found or -1 otherwise.
|
|
11981
|
+
*
|
|
11982
|
+
*
|
|
11983
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
11984
|
+
*/
|
|
11985
|
+
indexOfFilterItem(
|
|
11986
|
+
/**
|
|
11987
|
+
* The filterItem whose index is looked for
|
|
11988
|
+
*/
|
|
11989
|
+
oFilterItem: /* was: sap.ui.comp.P13nFilterItem */ any
|
|
11990
|
+
): int;
|
|
11991
|
+
/**
|
|
11992
|
+
* Inserts a filterItem into the aggregation {@link #getFilterItems filterItems}.
|
|
11993
|
+
*
|
|
11994
|
+
*
|
|
11995
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
11996
|
+
*/
|
|
11997
|
+
insertFilterItem(
|
|
11998
|
+
/**
|
|
11999
|
+
* The filterItem to insert; if empty, nothing is inserted
|
|
12000
|
+
*/
|
|
12001
|
+
oFilterItem: /* was: sap.ui.comp.P13nFilterItem */ any,
|
|
12002
|
+
/**
|
|
12003
|
+
* The `0`-based index the filterItem should be inserted at; for a negative value of `iIndex`, the filterItem
|
|
12004
|
+
* is inserted at position 0; for a value greater than the current size of the aggregation, the filterItem
|
|
12005
|
+
* is inserted at the last position
|
|
12006
|
+
*/
|
|
12007
|
+
iIndex: int
|
|
12008
|
+
): this;
|
|
12009
|
+
/**
|
|
12010
|
+
* Removes all the controls from the aggregation {@link #getFilterItems filterItems}.
|
|
12011
|
+
*
|
|
12012
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
12013
|
+
*
|
|
12014
|
+
*
|
|
12015
|
+
* @returns An array of the removed elements (might be empty)
|
|
12016
|
+
*/
|
|
12017
|
+
removeAllFilterItems(): /* was: sap.ui.comp.P13nFilterItem */ any[];
|
|
12018
|
+
/**
|
|
12019
|
+
* Removes a filterItem from the aggregation {@link #getFilterItems filterItems}.
|
|
12020
|
+
*
|
|
12021
|
+
*
|
|
12022
|
+
* @returns The removed filterItem or `null`
|
|
12023
|
+
*/
|
|
12024
|
+
removeFilterItem(
|
|
12025
|
+
/**
|
|
12026
|
+
* The filterItem to remove or its index or id
|
|
12027
|
+
*/
|
|
12028
|
+
vFilterItem: int | string | /* was: sap.ui.comp.P13nFilterItem */ any
|
|
12029
|
+
): /* was: sap.ui.comp.P13nFilterItem */ any | null;
|
|
12030
|
+
/**
|
|
12031
|
+
* Removes all invalid conditions.
|
|
12032
|
+
*
|
|
12033
|
+
* @since 1.28
|
|
12034
|
+
*/
|
|
12035
|
+
removeInvalidConditions(): void;
|
|
12036
|
+
/**
|
|
12037
|
+
* Removes all errors and warnings states from of all filter conditions.
|
|
12038
|
+
*
|
|
12039
|
+
* @since 1.28
|
|
12040
|
+
*/
|
|
12041
|
+
removeValidationErrors(): void;
|
|
12042
|
+
/**
|
|
12043
|
+
* Sets the array of conditions.
|
|
12044
|
+
*
|
|
12045
|
+
*
|
|
12046
|
+
* @returns this for chaining
|
|
12047
|
+
*/
|
|
12048
|
+
setConditions(
|
|
12049
|
+
/**
|
|
12050
|
+
* the complete list of conditions
|
|
12051
|
+
*/
|
|
12052
|
+
aConditions: /* was: sap.ui.comp.P13nFilterPanelBase.FilterConditionOperations */ any[]
|
|
12053
|
+
): this;
|
|
12054
|
+
/**
|
|
12055
|
+
* Sets a new value for property {@link #getContainerQuery containerQuery}.
|
|
12056
|
+
*
|
|
12057
|
+
* Defines if the `mediaQuery` or a `ContainerResize` is used for layout update. If the `ConditionPanel`
|
|
12058
|
+
* is used in a dialog, the property must be set to `true`.
|
|
12059
|
+
*
|
|
12060
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12061
|
+
*
|
|
12062
|
+
* Default value is `false`.
|
|
12063
|
+
*
|
|
12064
|
+
*
|
|
12065
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12066
|
+
*/
|
|
12067
|
+
setContainerQuery(
|
|
12068
|
+
/**
|
|
12069
|
+
* New value for property `containerQuery`
|
|
12070
|
+
*/
|
|
12071
|
+
bContainerQuery?: boolean
|
|
12072
|
+
): this;
|
|
12073
|
+
/**
|
|
12074
|
+
* Sets a new value for property {@link #getEnableEmptyOperations enableEmptyOperations}.
|
|
12075
|
+
*
|
|
12076
|
+
* Should empty operation be enabled for certain data types. This is also based on their nullable setting.
|
|
12077
|
+
*
|
|
12078
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12079
|
+
*
|
|
12080
|
+
* Default value is `false`.
|
|
12081
|
+
*
|
|
12082
|
+
*
|
|
12083
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12084
|
+
*/
|
|
12085
|
+
setEnableEmptyOperations(
|
|
12086
|
+
/**
|
|
12087
|
+
* New value for property `enableEmptyOperations`
|
|
12088
|
+
*/
|
|
12089
|
+
bEnableEmptyOperations?: boolean
|
|
12090
|
+
): this;
|
|
12091
|
+
/**
|
|
12092
|
+
* Setter for the supported exclude operations array.
|
|
12093
|
+
*/
|
|
12094
|
+
setExcludeOperations(
|
|
12095
|
+
/**
|
|
12096
|
+
* array of operations [`sap.ui.comp.P13nConditionOperation.BT`, `sap.ui.comp.P13nConditionOperation.EQ`]
|
|
12097
|
+
*/
|
|
12098
|
+
aOperation: /* was: sap.ui.comp.P13nConditionOperation */ any[],
|
|
12099
|
+
/**
|
|
12100
|
+
* the type for which the operations are defined
|
|
12101
|
+
*/
|
|
12102
|
+
sType: string
|
|
12103
|
+
): void;
|
|
12104
|
+
/**
|
|
12105
|
+
* Setter for the supported Include operations array.
|
|
12106
|
+
*/
|
|
12107
|
+
setIncludeOperations(
|
|
12108
|
+
/**
|
|
12109
|
+
* array of operations [`sap.ui.comp.P13nConditionOperation.BT`, `sap.ui.comp.P13nConditionOperation.EQ`]
|
|
12110
|
+
*/
|
|
12111
|
+
aOperation: /* was: sap.ui.comp.P13nConditionOperation */ any[],
|
|
12112
|
+
/**
|
|
12113
|
+
* the type for which the operations are defined
|
|
12114
|
+
*/
|
|
12115
|
+
sType: string
|
|
12116
|
+
): void;
|
|
12117
|
+
/**
|
|
12118
|
+
* Sets a new value for property {@link #getLayoutMode layoutMode}.
|
|
12119
|
+
*
|
|
12120
|
+
* Can be used to control the layout behavior. Default is "" which will automatically change the layout.
|
|
12121
|
+
* With "Desktop", "Table" or"Phone" you can set a fixed layout.
|
|
12122
|
+
*
|
|
12123
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12124
|
+
*
|
|
12125
|
+
*
|
|
12126
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12127
|
+
*/
|
|
12128
|
+
setLayoutMode(
|
|
12129
|
+
/**
|
|
12130
|
+
* New value for property `layoutMode`
|
|
12131
|
+
*/
|
|
12132
|
+
sLayoutMode?: string
|
|
12133
|
+
): this;
|
|
12134
|
+
/**
|
|
12135
|
+
* Sets a new value for property {@link #getMaxExcludes maxExcludes}.
|
|
12136
|
+
*
|
|
12137
|
+
* Defines the maximum number of exclude filters.
|
|
12138
|
+
*
|
|
12139
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12140
|
+
*
|
|
12141
|
+
* Default value is `'-1'`.
|
|
12142
|
+
*
|
|
12143
|
+
*
|
|
12144
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12145
|
+
*/
|
|
12146
|
+
setMaxExcludes(
|
|
12147
|
+
/**
|
|
12148
|
+
* New value for property `maxExcludes`
|
|
12149
|
+
*/
|
|
12150
|
+
sMaxExcludes?: string
|
|
12151
|
+
): this;
|
|
12152
|
+
/**
|
|
12153
|
+
* Sets a new value for property {@link #getMaxIncludes maxIncludes}.
|
|
12154
|
+
*
|
|
12155
|
+
* Defines the maximum number of include filters.
|
|
12156
|
+
*
|
|
12157
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12158
|
+
*
|
|
12159
|
+
* Default value is `'-1'`.
|
|
12160
|
+
*
|
|
12161
|
+
*
|
|
12162
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12163
|
+
*/
|
|
12164
|
+
setMaxIncludes(
|
|
12165
|
+
/**
|
|
12166
|
+
* New value for property `maxIncludes`
|
|
12167
|
+
*/
|
|
12168
|
+
sMaxIncludes?: string
|
|
12169
|
+
): this;
|
|
12170
|
+
/**
|
|
12171
|
+
* Sets the aggregated {@link #getMessageStrip messageStrip}.
|
|
12172
|
+
*
|
|
12173
|
+
*
|
|
12174
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12175
|
+
*/
|
|
12176
|
+
setMessageStrip(
|
|
12177
|
+
/**
|
|
12178
|
+
* The messageStrip to set
|
|
12179
|
+
*/
|
|
12180
|
+
oMessageStrip: MessageStrip
|
|
12181
|
+
): this;
|
|
12182
|
+
/**
|
|
12183
|
+
* Unbinds aggregation {@link #getFilterItems filterItems} from model data.
|
|
12184
|
+
*
|
|
12185
|
+
*
|
|
12186
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12187
|
+
*/
|
|
12188
|
+
unbindFilterItems(): this;
|
|
12189
|
+
/**
|
|
12190
|
+
* Checks if the entered and modified conditions are correct, marks invalid fields in yellow (warning).
|
|
12191
|
+
*
|
|
12192
|
+
*
|
|
12193
|
+
* @returns `True` if all conditions are valid, `false` otherwise.
|
|
12194
|
+
*/
|
|
12195
|
+
validateConditions(): boolean;
|
|
12196
|
+
}
|
|
12197
|
+
|
|
12198
|
+
export type FilterConditionOperations = {
|
|
12199
|
+
exclude: undefined | boolean;
|
|
12200
|
+
|
|
12201
|
+
key: string;
|
|
12202
|
+
|
|
12203
|
+
keyField: string;
|
|
12204
|
+
|
|
12205
|
+
operation: /* was: sap.ui.comp.P13nConditionOperation */ any;
|
|
12206
|
+
|
|
12207
|
+
showIfGrouped: boolean;
|
|
12208
|
+
|
|
12209
|
+
text: string;
|
|
12210
|
+
|
|
12211
|
+
value1: string;
|
|
12212
|
+
|
|
12213
|
+
value2: string;
|
|
12214
|
+
};
|
|
12215
|
+
}
|
|
12216
|
+
|
|
12217
|
+
declare module "sap/ui/comp/p13n/P13nItem" {
|
|
12218
|
+
import { default as UI5Element, $ElementSettings } from "sap/ui/core/Element";
|
|
12219
|
+
|
|
12220
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
12221
|
+
|
|
12222
|
+
import { PropertyBindingInfo } from "sap/ui/base/ManagedObject";
|
|
12223
|
+
|
|
12224
|
+
/**
|
|
12225
|
+
* Base type for `items` aggregation in `P13nPanel` control.
|
|
12226
|
+
*
|
|
12227
|
+
* @since 1.136
|
|
12228
|
+
*/
|
|
12229
|
+
export default class P13nItem extends UI5Element {
|
|
12230
|
+
/**
|
|
12231
|
+
* Constructor for a new P13nItem.
|
|
12232
|
+
*
|
|
12233
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
12234
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
12235
|
+
* of the syntax of the settings object.
|
|
12236
|
+
*/
|
|
12237
|
+
constructor(
|
|
12238
|
+
/**
|
|
12239
|
+
* initial settings for the new control
|
|
12240
|
+
*/
|
|
12241
|
+
mSettings?: $P13nItemSettings
|
|
12242
|
+
);
|
|
12243
|
+
/**
|
|
12244
|
+
* Constructor for a new P13nItem.
|
|
12245
|
+
*
|
|
12246
|
+
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
12247
|
+
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
12248
|
+
* of the syntax of the settings object.
|
|
12249
|
+
*/
|
|
12250
|
+
constructor(
|
|
12251
|
+
/**
|
|
12252
|
+
* ID for the new control, generated automatically if no ID is given
|
|
12253
|
+
*/
|
|
12254
|
+
sId?: string,
|
|
12255
|
+
/**
|
|
12256
|
+
* initial settings for the new control
|
|
12257
|
+
*/
|
|
12258
|
+
mSettings?: $P13nItemSettings
|
|
12259
|
+
);
|
|
12260
|
+
|
|
12261
|
+
/**
|
|
12262
|
+
* Creates a new subclass of class sap.ui.comp.p13n.P13nItem with name `sClassName` and enriches it with
|
|
12263
|
+
* the information contained in `oClassInfo`.
|
|
12264
|
+
*
|
|
12265
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Element.extend}.
|
|
12266
|
+
*
|
|
12267
|
+
*
|
|
12268
|
+
* @returns Created class / constructor function
|
|
12269
|
+
*/
|
|
12270
|
+
static extend<T extends Record<string, unknown>>(
|
|
12271
|
+
/**
|
|
12272
|
+
* Name of the class being created
|
|
12273
|
+
*/
|
|
12274
|
+
sClassName: string,
|
|
12275
|
+
/**
|
|
12276
|
+
* Object literal with information about the class
|
|
12277
|
+
*/
|
|
12278
|
+
oClassInfo?: sap.ClassInfo<T, P13nItem>,
|
|
12279
|
+
/**
|
|
12280
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
12281
|
+
* used by this class
|
|
12282
|
+
*/
|
|
12283
|
+
FNMetaImpl?: Function
|
|
12284
|
+
): Function;
|
|
12285
|
+
/**
|
|
12286
|
+
* Returns a metadata object for class sap.ui.comp.p13n.P13nItem.
|
|
12287
|
+
*
|
|
12288
|
+
*
|
|
12289
|
+
* @returns Metadata object describing this class
|
|
12290
|
+
*/
|
|
12291
|
+
static getMetadata(): ElementMetadata;
|
|
12292
|
+
/**
|
|
12293
|
+
* Gets current value of property {@link #getAggregationRole aggregationRole}.
|
|
12294
|
+
*
|
|
12295
|
+
* Defines aggregation role
|
|
12296
|
+
*
|
|
12297
|
+
* @since 1.34.0
|
|
12298
|
+
*
|
|
12299
|
+
* @returns Value of property `aggregationRole`
|
|
12300
|
+
*/
|
|
12301
|
+
getAggregationRole(): string;
|
|
12302
|
+
/**
|
|
12303
|
+
* Gets current value of property {@link #getColumnKey columnKey}.
|
|
12304
|
+
*
|
|
12305
|
+
* Can be used as input for subsequent actions.
|
|
12306
|
+
*
|
|
12307
|
+
*
|
|
12308
|
+
* @returns Value of property `columnKey`
|
|
12309
|
+
*/
|
|
12310
|
+
getColumnKey(): string;
|
|
12311
|
+
/**
|
|
12312
|
+
* Gets current value of property {@link #getDescription description}.
|
|
12313
|
+
*
|
|
12314
|
+
* Defines additional information of the link.
|
|
12315
|
+
*
|
|
12316
|
+
* @since 1.56.0
|
|
12317
|
+
*
|
|
12318
|
+
* @returns Value of property `description`
|
|
12319
|
+
*/
|
|
12320
|
+
getDescription(): string;
|
|
12321
|
+
/**
|
|
12322
|
+
* Gets current value of property {@link #getFormatSettings formatSettings}.
|
|
12323
|
+
*
|
|
12324
|
+
* A JSON object containing the formatSettings which will be used to pass additional type/format settings
|
|
12325
|
+
* for the entered value. if type==time or date or datetime the object will be used for the DateFormatter,
|
|
12326
|
+
* TimeFormatter or DateTimeFormatter
|
|
12327
|
+
*
|
|
12328
|
+
* Below you can find a brief example
|
|
12329
|
+
*
|
|
12330
|
+
*
|
|
12331
|
+
* ```javascript
|
|
12332
|
+
*
|
|
12333
|
+
* {
|
|
12334
|
+
* UTC: false,
|
|
12335
|
+
* style: "medium" //"short" or "long"
|
|
12336
|
+
* }
|
|
12337
|
+
* ```
|
|
12338
|
+
*
|
|
12339
|
+
*
|
|
12340
|
+
* @since 1.52
|
|
12341
|
+
*
|
|
12342
|
+
* @returns Value of property `formatSettings`
|
|
12343
|
+
*/
|
|
12344
|
+
getFormatSettings(): object;
|
|
12345
|
+
/**
|
|
12346
|
+
* Gets current value of property {@link #getHref href}.
|
|
12347
|
+
*
|
|
12348
|
+
* Defines href of a link.
|
|
12349
|
+
*
|
|
12350
|
+
* @since 1.46.0
|
|
12351
|
+
*
|
|
12352
|
+
* @returns Value of property `href`
|
|
12353
|
+
*/
|
|
12354
|
+
getHref(): string;
|
|
12355
|
+
/**
|
|
12356
|
+
* Gets current value of property {@link #getIsDefault isDefault}.
|
|
12357
|
+
*
|
|
12358
|
+
* the column with isDefault==true will be used as the selected column item on the conditionPanel
|
|
12359
|
+
*
|
|
12360
|
+
* Default value is `false`.
|
|
12361
|
+
*
|
|
12362
|
+
*
|
|
12363
|
+
* @returns Value of property `isDefault`
|
|
12364
|
+
*/
|
|
12365
|
+
getIsDefault(): boolean;
|
|
12366
|
+
/**
|
|
12367
|
+
* Gets current value of property {@link #getMaxLength maxLength}.
|
|
12368
|
+
*
|
|
12369
|
+
* specifies the number of characters which can be entered in the value fields of the condition panel
|
|
12370
|
+
*
|
|
12371
|
+
*
|
|
12372
|
+
* @returns Value of property `maxLength`
|
|
12373
|
+
*/
|
|
12374
|
+
getMaxLength(): string;
|
|
12375
|
+
/**
|
|
12376
|
+
* Gets current value of property {@link #getNullable nullable}.
|
|
12377
|
+
*
|
|
12378
|
+
* Defines if the item is nullable
|
|
12379
|
+
*
|
|
12380
|
+
* Default value is `false`.
|
|
12381
|
+
*
|
|
12382
|
+
*
|
|
12383
|
+
* @returns Value of property `nullable`
|
|
12384
|
+
*/
|
|
12385
|
+
getNullable(): boolean;
|
|
12386
|
+
/**
|
|
12387
|
+
* Gets current value of property {@link #getPrecision precision}.
|
|
12388
|
+
*
|
|
12389
|
+
* if type==numeric the precision will be used to format the entered value (maxIntegerDigits of the used
|
|
12390
|
+
* Formatter)
|
|
12391
|
+
*
|
|
12392
|
+
*
|
|
12393
|
+
* @returns Value of property `precision`
|
|
12394
|
+
*/
|
|
12395
|
+
getPrecision(): string;
|
|
12396
|
+
/**
|
|
12397
|
+
* Gets current value of property {@link #getPress press}.
|
|
12398
|
+
*
|
|
12399
|
+
* Defines press handler of a link.
|
|
12400
|
+
*
|
|
12401
|
+
* @since 1.46.0
|
|
12402
|
+
*
|
|
12403
|
+
* @returns Value of property `press`
|
|
12404
|
+
*/
|
|
12405
|
+
getPress(): object;
|
|
12406
|
+
/**
|
|
12407
|
+
* Gets current value of property {@link #getRole role}.
|
|
12408
|
+
*
|
|
12409
|
+
* Defines role. The role is reflected in the manner how the dimension will influence the chart layout.
|
|
12410
|
+
*
|
|
12411
|
+
* @since 1.34.0
|
|
12412
|
+
*
|
|
12413
|
+
* @returns Value of property `role`
|
|
12414
|
+
*/
|
|
12415
|
+
getRole(): string;
|
|
12416
|
+
/**
|
|
12417
|
+
* Gets current value of property {@link #getScale scale}.
|
|
12418
|
+
*
|
|
12419
|
+
* if type==numeric the scale will be used to format the entered value (maxFractionDigits of the used Formatter)
|
|
12420
|
+
*
|
|
12421
|
+
*
|
|
12422
|
+
* @returns Value of property `scale`
|
|
12423
|
+
*/
|
|
12424
|
+
getScale(): string;
|
|
12425
|
+
/**
|
|
12426
|
+
* Gets current value of property {@link #getTarget target}.
|
|
12427
|
+
*
|
|
12428
|
+
* Defines target of a link.
|
|
12429
|
+
*
|
|
12430
|
+
*
|
|
12431
|
+
* @returns Value of property `target`
|
|
12432
|
+
*/
|
|
12433
|
+
getTarget(): string;
|
|
12434
|
+
/**
|
|
12435
|
+
* Gets current value of property {@link #getText text}.
|
|
12436
|
+
*
|
|
12437
|
+
* The text to be displayed for the item.
|
|
12438
|
+
*
|
|
12439
|
+
* Default value is `empty string`.
|
|
12440
|
+
*
|
|
12441
|
+
*
|
|
12442
|
+
* @returns Value of property `text`
|
|
12443
|
+
*/
|
|
12444
|
+
getText(): string;
|
|
12445
|
+
/**
|
|
12446
|
+
* Gets current value of property {@link #getType type}.
|
|
12447
|
+
*
|
|
12448
|
+
* data type of the column (text, numeric or date is supported)
|
|
12449
|
+
*
|
|
12450
|
+
* Default value is `"text"`.
|
|
12451
|
+
*
|
|
12452
|
+
*
|
|
12453
|
+
* @returns Value of property `type`
|
|
12454
|
+
*/
|
|
12455
|
+
getType(): string;
|
|
12456
|
+
/**
|
|
12457
|
+
* Gets current value of property {@link #getTypeInstance typeInstance}.
|
|
12458
|
+
*
|
|
12459
|
+
* data type instance of the column. Can be used instead of the type, precision, scale and formatSettings
|
|
12460
|
+
* properties
|
|
12461
|
+
*
|
|
12462
|
+
* @since 1.56
|
|
12463
|
+
*
|
|
12464
|
+
* @returns Value of property `typeInstance`
|
|
12465
|
+
*/
|
|
12466
|
+
getTypeInstance(): object;
|
|
12467
|
+
/**
|
|
12468
|
+
* Gets current value of property {@link #getValues values}.
|
|
12469
|
+
*
|
|
12470
|
+
* the array of values for type bool. e.g. ["", "Off", "On"]. The first entry can be empty (used to blank
|
|
12471
|
+
* the value field). Next value represent the false value, last entry the true value.
|
|
12472
|
+
*
|
|
12473
|
+
* @since 1.34.0
|
|
12474
|
+
*
|
|
12475
|
+
* @returns Value of property `values`
|
|
12476
|
+
*/
|
|
12477
|
+
getValues(): string[];
|
|
12478
|
+
/**
|
|
12479
|
+
* Gets current value of property {@link #getVisible visible}.
|
|
12480
|
+
*
|
|
12481
|
+
* Defines visibility of column
|
|
12482
|
+
*
|
|
12483
|
+
*
|
|
12484
|
+
* @returns Value of property `visible`
|
|
12485
|
+
*/
|
|
12486
|
+
getVisible(): boolean;
|
|
12487
|
+
/**
|
|
12488
|
+
* Gets current value of property {@link #getWidth width}.
|
|
12489
|
+
*
|
|
12490
|
+
* Defines column width
|
|
12491
|
+
*
|
|
12492
|
+
*
|
|
12493
|
+
* @returns Value of property `width`
|
|
12494
|
+
*/
|
|
12495
|
+
getWidth(): string;
|
|
12496
|
+
/**
|
|
12497
|
+
* Sets a new value for property {@link #getAggregationRole aggregationRole}.
|
|
12498
|
+
*
|
|
12499
|
+
* Defines aggregation role
|
|
12500
|
+
*
|
|
12501
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12502
|
+
*
|
|
12503
|
+
* @since 1.34.0
|
|
12504
|
+
*
|
|
12505
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12506
|
+
*/
|
|
12507
|
+
setAggregationRole(
|
|
12508
|
+
/**
|
|
12509
|
+
* New value for property `aggregationRole`
|
|
12510
|
+
*/
|
|
12511
|
+
sAggregationRole?: string
|
|
12512
|
+
): this;
|
|
12513
|
+
/**
|
|
12514
|
+
* Sets a new value for property {@link #getColumnKey columnKey}.
|
|
12515
|
+
*
|
|
12516
|
+
* Can be used as input for subsequent actions.
|
|
12517
|
+
*
|
|
12518
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12519
|
+
*
|
|
12520
|
+
*
|
|
12521
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12522
|
+
*/
|
|
12523
|
+
setColumnKey(
|
|
12524
|
+
/**
|
|
12525
|
+
* New value for property `columnKey`
|
|
12526
|
+
*/
|
|
12527
|
+
sColumnKey?: string
|
|
12528
|
+
): this;
|
|
12529
|
+
/**
|
|
12530
|
+
* Sets a new value for property {@link #getDescription description}.
|
|
12531
|
+
*
|
|
12532
|
+
* Defines additional information of the link.
|
|
12533
|
+
*
|
|
12534
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12535
|
+
*
|
|
12536
|
+
* @since 1.56.0
|
|
12537
|
+
*
|
|
12538
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12539
|
+
*/
|
|
12540
|
+
setDescription(
|
|
12541
|
+
/**
|
|
12542
|
+
* New value for property `description`
|
|
12543
|
+
*/
|
|
12544
|
+
sDescription?: string
|
|
12545
|
+
): this;
|
|
12546
|
+
/**
|
|
12547
|
+
* Sets a new value for property {@link #getFormatSettings formatSettings}.
|
|
12548
|
+
*
|
|
12549
|
+
* A JSON object containing the formatSettings which will be used to pass additional type/format settings
|
|
12550
|
+
* for the entered value. if type==time or date or datetime the object will be used for the DateFormatter,
|
|
12551
|
+
* TimeFormatter or DateTimeFormatter
|
|
12552
|
+
*
|
|
12553
|
+
* Below you can find a brief example
|
|
12554
|
+
*
|
|
12555
|
+
*
|
|
12556
|
+
* ```javascript
|
|
12557
|
+
*
|
|
12558
|
+
* {
|
|
12559
|
+
* UTC: false,
|
|
12560
|
+
* style: "medium" //"short" or "long"
|
|
12561
|
+
* }
|
|
12562
|
+
* ```
|
|
12563
|
+
*
|
|
12564
|
+
*
|
|
12565
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12566
|
+
*
|
|
12567
|
+
* @since 1.52
|
|
12568
|
+
*
|
|
12569
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12570
|
+
*/
|
|
12571
|
+
setFormatSettings(
|
|
12572
|
+
/**
|
|
12573
|
+
* New value for property `formatSettings`
|
|
12574
|
+
*/
|
|
12575
|
+
oFormatSettings?: object
|
|
12576
|
+
): this;
|
|
12577
|
+
/**
|
|
12578
|
+
* Sets a new value for property {@link #getHref href}.
|
|
12579
|
+
*
|
|
12580
|
+
* Defines href of a link.
|
|
12581
|
+
*
|
|
12582
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12583
|
+
*
|
|
12584
|
+
* @since 1.46.0
|
|
12585
|
+
*
|
|
12586
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12587
|
+
*/
|
|
12588
|
+
setHref(
|
|
12589
|
+
/**
|
|
12590
|
+
* New value for property `href`
|
|
12591
|
+
*/
|
|
12592
|
+
sHref?: string
|
|
12593
|
+
): this;
|
|
12594
|
+
/**
|
|
12595
|
+
* Sets a new value for property {@link #getIsDefault isDefault}.
|
|
12596
|
+
*
|
|
12597
|
+
* the column with isDefault==true will be used as the selected column item on the conditionPanel
|
|
12598
|
+
*
|
|
12599
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12600
|
+
*
|
|
12601
|
+
* Default value is `false`.
|
|
12602
|
+
*
|
|
12603
|
+
*
|
|
12604
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12605
|
+
*/
|
|
12606
|
+
setIsDefault(
|
|
12607
|
+
/**
|
|
12608
|
+
* New value for property `isDefault`
|
|
12609
|
+
*/
|
|
12610
|
+
bIsDefault?: boolean
|
|
12611
|
+
): this;
|
|
12612
|
+
/**
|
|
12613
|
+
* Sets a new value for property {@link #getMaxLength maxLength}.
|
|
12614
|
+
*
|
|
12615
|
+
* specifies the number of characters which can be entered in the value fields of the condition panel
|
|
12616
|
+
*
|
|
12617
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12618
|
+
*
|
|
12619
|
+
*
|
|
12620
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12621
|
+
*/
|
|
12622
|
+
setMaxLength(
|
|
12623
|
+
/**
|
|
12624
|
+
* New value for property `maxLength`
|
|
12625
|
+
*/
|
|
12626
|
+
sMaxLength?: string
|
|
12627
|
+
): this;
|
|
12628
|
+
/**
|
|
12629
|
+
* Sets a new value for property {@link #getNullable nullable}.
|
|
12630
|
+
*
|
|
12631
|
+
* Defines if the item is nullable
|
|
12632
|
+
*
|
|
12633
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12634
|
+
*
|
|
12635
|
+
* Default value is `false`.
|
|
12636
|
+
*
|
|
12637
|
+
*
|
|
12638
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12639
|
+
*/
|
|
12640
|
+
setNullable(
|
|
12641
|
+
/**
|
|
12642
|
+
* New value for property `nullable`
|
|
12643
|
+
*/
|
|
12644
|
+
bNullable?: boolean
|
|
12645
|
+
): this;
|
|
12646
|
+
/**
|
|
12647
|
+
* Sets a new value for property {@link #getPrecision precision}.
|
|
12648
|
+
*
|
|
12649
|
+
* if type==numeric the precision will be used to format the entered value (maxIntegerDigits of the used
|
|
12650
|
+
* Formatter)
|
|
12651
|
+
*
|
|
12652
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12653
|
+
*
|
|
12654
|
+
*
|
|
12655
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12656
|
+
*/
|
|
12657
|
+
setPrecision(
|
|
12658
|
+
/**
|
|
12659
|
+
* New value for property `precision`
|
|
12660
|
+
*/
|
|
12661
|
+
sPrecision?: string
|
|
12662
|
+
): this;
|
|
12663
|
+
/**
|
|
12664
|
+
* Sets a new value for property {@link #getPress press}.
|
|
12665
|
+
*
|
|
12666
|
+
* Defines press handler of a link.
|
|
12667
|
+
*
|
|
12668
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12669
|
+
*
|
|
12670
|
+
* @since 1.46.0
|
|
12671
|
+
*
|
|
12672
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12673
|
+
*/
|
|
12674
|
+
setPress(
|
|
12675
|
+
/**
|
|
12676
|
+
* New value for property `press`
|
|
12677
|
+
*/
|
|
12678
|
+
oPress?: object
|
|
12679
|
+
): this;
|
|
12680
|
+
/**
|
|
12681
|
+
* Sets a new value for property {@link #getRole role}.
|
|
12682
|
+
*
|
|
12683
|
+
* Defines role. The role is reflected in the manner how the dimension will influence the chart layout.
|
|
12684
|
+
*
|
|
12685
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12686
|
+
*
|
|
12687
|
+
* @since 1.34.0
|
|
12688
|
+
*
|
|
12689
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12690
|
+
*/
|
|
12691
|
+
setRole(
|
|
12692
|
+
/**
|
|
12693
|
+
* New value for property `role`
|
|
12694
|
+
*/
|
|
12695
|
+
sRole?: string
|
|
12696
|
+
): this;
|
|
12697
|
+
/**
|
|
12698
|
+
* Sets a new value for property {@link #getScale scale}.
|
|
12699
|
+
*
|
|
12700
|
+
* if type==numeric the scale will be used to format the entered value (maxFractionDigits of the used Formatter)
|
|
12701
|
+
*
|
|
12702
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12703
|
+
*
|
|
12704
|
+
*
|
|
12705
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12706
|
+
*/
|
|
12707
|
+
setScale(
|
|
12708
|
+
/**
|
|
12709
|
+
* New value for property `scale`
|
|
12710
|
+
*/
|
|
12711
|
+
sScale?: string
|
|
12712
|
+
): this;
|
|
12713
|
+
/**
|
|
12714
|
+
* Sets a new value for property {@link #getTarget target}.
|
|
12715
|
+
*
|
|
12716
|
+
* Defines target of a link.
|
|
12717
|
+
*
|
|
12718
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12719
|
+
*
|
|
12720
|
+
*
|
|
12721
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12722
|
+
*/
|
|
12723
|
+
setTarget(
|
|
12724
|
+
/**
|
|
12725
|
+
* New value for property `target`
|
|
12726
|
+
*/
|
|
12727
|
+
sTarget?: string
|
|
12728
|
+
): this;
|
|
12729
|
+
/**
|
|
12730
|
+
* Sets a new value for property {@link #getText text}.
|
|
12731
|
+
*
|
|
12732
|
+
* The text to be displayed for the item.
|
|
12733
|
+
*
|
|
12734
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12735
|
+
*
|
|
12736
|
+
* Default value is `empty string`.
|
|
12737
|
+
*
|
|
12738
|
+
*
|
|
12739
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12740
|
+
*/
|
|
12741
|
+
setText(
|
|
12742
|
+
/**
|
|
12743
|
+
* New value for property `text`
|
|
12744
|
+
*/
|
|
12745
|
+
sText?: string
|
|
12746
|
+
): this;
|
|
12747
|
+
/**
|
|
12748
|
+
* Sets a new value for property {@link #getType type}.
|
|
12749
|
+
*
|
|
12750
|
+
* data type of the column (text, numeric or date is supported)
|
|
12751
|
+
*
|
|
12752
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12753
|
+
*
|
|
12754
|
+
* Default value is `"text"`.
|
|
12755
|
+
*
|
|
12756
|
+
*
|
|
12757
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12758
|
+
*/
|
|
12759
|
+
setType(
|
|
12760
|
+
/**
|
|
12761
|
+
* New value for property `type`
|
|
12762
|
+
*/
|
|
12763
|
+
sType?: string
|
|
12764
|
+
): this;
|
|
12765
|
+
/**
|
|
12766
|
+
* Sets a new value for property {@link #getTypeInstance typeInstance}.
|
|
12767
|
+
*
|
|
12768
|
+
* data type instance of the column. Can be used instead of the type, precision, scale and formatSettings
|
|
12769
|
+
* properties
|
|
12770
|
+
*
|
|
12771
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12772
|
+
*
|
|
12773
|
+
* @since 1.56
|
|
12774
|
+
*
|
|
12775
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12776
|
+
*/
|
|
12777
|
+
setTypeInstance(
|
|
12778
|
+
/**
|
|
12779
|
+
* New value for property `typeInstance`
|
|
12780
|
+
*/
|
|
12781
|
+
oTypeInstance?: object
|
|
12782
|
+
): this;
|
|
12783
|
+
/**
|
|
12784
|
+
* Sets a new value for property {@link #getValues values}.
|
|
12785
|
+
*
|
|
12786
|
+
* the array of values for type bool. e.g. ["", "Off", "On"]. The first entry can be empty (used to blank
|
|
12787
|
+
* the value field). Next value represent the false value, last entry the true value.
|
|
12788
|
+
*
|
|
12789
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12790
|
+
*
|
|
12791
|
+
* @since 1.34.0
|
|
12792
|
+
*
|
|
12793
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12794
|
+
*/
|
|
12795
|
+
setValues(
|
|
12796
|
+
/**
|
|
12797
|
+
* New value for property `values`
|
|
12798
|
+
*/
|
|
12799
|
+
sValues?: string[]
|
|
12800
|
+
): this;
|
|
12801
|
+
/**
|
|
12802
|
+
* Sets a new value for property {@link #getVisible visible}.
|
|
12803
|
+
*
|
|
12804
|
+
* Defines visibility of column
|
|
12805
|
+
*
|
|
12806
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12807
|
+
*
|
|
12808
|
+
*
|
|
12809
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12810
|
+
*/
|
|
12811
|
+
setVisible(
|
|
12812
|
+
/**
|
|
12813
|
+
* New value for property `visible`
|
|
12814
|
+
*/
|
|
12815
|
+
bVisible?: boolean
|
|
12816
|
+
): this;
|
|
12817
|
+
/**
|
|
12818
|
+
* Sets a new value for property {@link #getWidth width}.
|
|
12819
|
+
*
|
|
12820
|
+
* Defines column width
|
|
12821
|
+
*
|
|
12822
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
12823
|
+
*
|
|
12824
|
+
*
|
|
12825
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
12826
|
+
*/
|
|
12827
|
+
setWidth(
|
|
12828
|
+
/**
|
|
12829
|
+
* New value for property `width`
|
|
12830
|
+
*/
|
|
12831
|
+
sWidth?: string
|
|
12832
|
+
): this;
|
|
12833
|
+
}
|
|
12834
|
+
/**
|
|
12835
|
+
* Describes the settings that can be provided to the P13nItem constructor.
|
|
10083
12836
|
*/
|
|
10084
|
-
export interface
|
|
12837
|
+
export interface $P13nItemSettings extends $ElementSettings {
|
|
10085
12838
|
/**
|
|
10086
|
-
*
|
|
12839
|
+
* Can be used as input for subsequent actions.
|
|
10087
12840
|
*/
|
|
10088
|
-
|
|
12841
|
+
columnKey?: string | PropertyBindingInfo;
|
|
10089
12842
|
|
|
10090
12843
|
/**
|
|
10091
|
-
* The
|
|
12844
|
+
* The text to be displayed for the item.
|
|
10092
12845
|
*/
|
|
10093
|
-
|
|
12846
|
+
text?: string | PropertyBindingInfo;
|
|
10094
12847
|
|
|
10095
12848
|
/**
|
|
10096
|
-
*
|
|
12849
|
+
* Defines visibility of column
|
|
10097
12850
|
*/
|
|
10098
|
-
|
|
12851
|
+
visible?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
10099
12852
|
|
|
10100
12853
|
/**
|
|
10101
|
-
*
|
|
12854
|
+
* data type of the column (text, numeric or date is supported)
|
|
10102
12855
|
*/
|
|
10103
|
-
|
|
12856
|
+
type?: string | PropertyBindingInfo;
|
|
10104
12857
|
|
|
10105
12858
|
/**
|
|
10106
|
-
*
|
|
10107
|
-
*
|
|
10108
|
-
*
|
|
10109
|
-
*
|
|
12859
|
+
* data type instance of the column. Can be used instead of the type, precision, scale and formatSettings
|
|
12860
|
+
* properties
|
|
12861
|
+
*
|
|
12862
|
+
* @since 1.56
|
|
10110
12863
|
*/
|
|
10111
|
-
|
|
10112
|
-
}
|
|
12864
|
+
typeInstance?: object | PropertyBindingInfo | `{${string}}`;
|
|
10113
12865
|
|
|
10114
|
-
|
|
10115
|
-
|
|
10116
|
-
|
|
10117
|
-
|
|
10118
|
-
|
|
10119
|
-
SemanticObjectController
|
|
10120
|
-
>;
|
|
12866
|
+
/**
|
|
12867
|
+
* if type==numeric the precision will be used to format the entered value (maxIntegerDigits of the used
|
|
12868
|
+
* Formatter)
|
|
12869
|
+
*/
|
|
12870
|
+
precision?: string | PropertyBindingInfo;
|
|
10121
12871
|
|
|
10122
|
-
/**
|
|
10123
|
-
* Parameters of the SemanticObjectController#navigationTargetsObtained event.
|
|
10124
|
-
*
|
|
10125
|
-
* @deprecated As of version 1.126. replaced by `navigationTargetsObtainedCallback` property.
|
|
10126
|
-
*/
|
|
10127
|
-
export interface SemanticObjectController$NavigationTargetsObtainedEventParameters {
|
|
10128
12872
|
/**
|
|
10129
|
-
*
|
|
12873
|
+
* A JSON object containing the formatSettings which will be used to pass additional type/format settings
|
|
12874
|
+
* for the entered value. if type==time or date or datetime the object will be used for the DateFormatter,
|
|
12875
|
+
* TimeFormatter or DateTimeFormatter
|
|
12876
|
+
*
|
|
12877
|
+
* Below you can find a brief example
|
|
12878
|
+
*
|
|
12879
|
+
*
|
|
12880
|
+
* ```javascript
|
|
12881
|
+
*
|
|
12882
|
+
* {
|
|
12883
|
+
* UTC: false,
|
|
12884
|
+
* style: "medium" //"short" or "long"
|
|
12885
|
+
* }
|
|
12886
|
+
* ```
|
|
12887
|
+
*
|
|
12888
|
+
*
|
|
12889
|
+
* @since 1.52
|
|
10130
12890
|
*/
|
|
10131
|
-
|
|
12891
|
+
formatSettings?: object | PropertyBindingInfo | `{${string}}`;
|
|
10132
12892
|
|
|
10133
12893
|
/**
|
|
10134
|
-
*
|
|
12894
|
+
* if type==numeric the scale will be used to format the entered value (maxFractionDigits of the used Formatter)
|
|
10135
12895
|
*/
|
|
10136
|
-
|
|
12896
|
+
scale?: string | PropertyBindingInfo;
|
|
10137
12897
|
|
|
10138
12898
|
/**
|
|
10139
|
-
*
|
|
10140
|
-
* popover.
|
|
12899
|
+
* specifies the number of characters which can be entered in the value fields of the condition panel
|
|
10141
12900
|
*/
|
|
10142
|
-
|
|
12901
|
+
maxLength?: string | PropertyBindingInfo;
|
|
10143
12902
|
|
|
10144
12903
|
/**
|
|
10145
|
-
*
|
|
12904
|
+
* Defines column width
|
|
10146
12905
|
*/
|
|
10147
|
-
|
|
12906
|
+
width?: string | PropertyBindingInfo;
|
|
10148
12907
|
|
|
10149
12908
|
/**
|
|
10150
|
-
*
|
|
12909
|
+
* the column with isDefault==true will be used as the selected column item on the conditionPanel
|
|
10151
12910
|
*/
|
|
10152
|
-
|
|
12911
|
+
isDefault?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
10153
12912
|
|
|
10154
12913
|
/**
|
|
10155
|
-
*
|
|
12914
|
+
* the array of values for type bool. e.g. ["", "Off", "On"]. The first entry can be empty (used to blank
|
|
12915
|
+
* the value field). Next value represent the false value, last entry the true value.
|
|
12916
|
+
*
|
|
12917
|
+
* @since 1.34.0
|
|
10156
12918
|
*/
|
|
10157
|
-
|
|
12919
|
+
values?: string[] | PropertyBindingInfo | `{${string}}`;
|
|
10158
12920
|
|
|
10159
12921
|
/**
|
|
10160
|
-
*
|
|
10161
|
-
*
|
|
10162
|
-
*
|
|
10163
|
-
* control which triggered the event.
|
|
12922
|
+
* Defines role. The role is reflected in the manner how the dimension will influence the chart layout.
|
|
12923
|
+
*
|
|
12924
|
+
* @since 1.34.0
|
|
10164
12925
|
*/
|
|
10165
|
-
|
|
12926
|
+
role?: string | PropertyBindingInfo;
|
|
10166
12927
|
|
|
10167
12928
|
/**
|
|
10168
|
-
*
|
|
10169
|
-
* registered, the `show` function has to be called manually in order to open the navigation popover. Signatures:
|
|
10170
|
-
* `show()`
|
|
10171
|
-
* - `show(oMainNavigation, aAvailableActions, oAdditionalContent)` Parameters:
|
|
10172
|
-
* {sap.ui.comp.navpopover.LinkData | null | undefined} oMainNavigation The main navigation object. With
|
|
10173
|
-
* `null` the main navigation object will be removed. With `undefined` the old object will remain.
|
|
10174
|
-
* - {sap.ui.comp.navpopover.LinkData[] | [] | undefined} aAvailableActions Array containing the cross-application
|
|
10175
|
-
* navigation links. With empty array all available links will be removed. With `undefined` the old links
|
|
10176
|
-
* will remain.
|
|
10177
|
-
* - {sap.ui.core.Control | null | undefined} oAdditionalContent Control that will be displayed in extra
|
|
10178
|
-
* content section on the popover. With `null` the main extra content object will be removed. With `undefined`
|
|
10179
|
-
* the old object still remains.
|
|
10180
|
-
* - `show(sMainNavigationId, oMainNavigation, aAvailableActions, oAdditionalContent)` Parameters:
|
|
10181
|
-
* {string | undefined} sMainNavigationId The visible description for the main navigation link. With `''`,
|
|
10182
|
-
* both the description and subtitle will be removed. With `undefined`, the description is calculated using
|
|
10183
|
-
* the binding context of a given source object (for example `SmartLink` control).
|
|
10184
|
-
* - {sap.ui.comp.navpopover.LinkData | null | undefined} oMainNavigation The main navigation object.
|
|
10185
|
-
* With `null` the main navigation object will be removed. With `undefined` the old object will remain.
|
|
12929
|
+
* Defines aggregation role
|
|
10186
12930
|
*
|
|
10187
|
-
*
|
|
10188
|
-
* navigation links. With empty array all available links will be removed. With `undefined` the old links
|
|
10189
|
-
* will remain.
|
|
10190
|
-
* - {sap.ui.core.Control | null | undefined} oAdditionalContent Control that will be displayed in extra
|
|
10191
|
-
* content section on the popover. With `null` the main extra content object will be removed. With `undefined`
|
|
10192
|
-
* the old object still remains.
|
|
12931
|
+
* @since 1.34.0
|
|
10193
12932
|
*/
|
|
10194
|
-
|
|
10195
|
-
}
|
|
12933
|
+
aggregationRole?: string | PropertyBindingInfo;
|
|
10196
12934
|
|
|
10197
|
-
|
|
10198
|
-
|
|
10199
|
-
|
|
10200
|
-
|
|
10201
|
-
|
|
10202
|
-
|
|
10203
|
-
SemanticObjectController$NavigationTargetsObtainedEventParameters,
|
|
10204
|
-
SemanticObjectController
|
|
10205
|
-
>;
|
|
12935
|
+
/**
|
|
12936
|
+
* Defines href of a link.
|
|
12937
|
+
*
|
|
12938
|
+
* @since 1.46.0
|
|
12939
|
+
*/
|
|
12940
|
+
href?: string | PropertyBindingInfo;
|
|
10206
12941
|
|
|
10207
|
-
/**
|
|
10208
|
-
* Parameters of the SemanticObjectController#prefetchDone event.
|
|
10209
|
-
*
|
|
10210
|
-
* @deprecated As of version 1.42.0. The event `prefetchDone` is obsolete because it depends on the property
|
|
10211
|
-
* `prefetchNavigationTargets` which has been deprecated.
|
|
10212
|
-
*/
|
|
10213
|
-
export interface SemanticObjectController$PrefetchDoneEventParameters {
|
|
10214
12942
|
/**
|
|
10215
|
-
*
|
|
10216
|
-
* The value for each semantic object key is an array containing the available actions found for this semantic
|
|
10217
|
-
* object.
|
|
12943
|
+
* Defines target of a link.
|
|
10218
12944
|
*/
|
|
10219
|
-
|
|
10220
|
-
}
|
|
12945
|
+
target?: string | PropertyBindingInfo;
|
|
10221
12946
|
|
|
10222
|
-
|
|
10223
|
-
|
|
10224
|
-
|
|
10225
|
-
|
|
10226
|
-
|
|
10227
|
-
|
|
10228
|
-
export type SemanticObjectController$PrefetchDoneEvent = Event<
|
|
10229
|
-
SemanticObjectController$PrefetchDoneEventParameters,
|
|
10230
|
-
SemanticObjectController
|
|
10231
|
-
>;
|
|
10232
|
-
}
|
|
12947
|
+
/**
|
|
12948
|
+
* Defines press handler of a link.
|
|
12949
|
+
*
|
|
12950
|
+
* @since 1.46.0
|
|
12951
|
+
*/
|
|
12952
|
+
press?: object | PropertyBindingInfo | `{${string}}`;
|
|
10233
12953
|
|
|
10234
|
-
|
|
10235
|
-
|
|
10236
|
-
|
|
10237
|
-
|
|
10238
|
-
|
|
12954
|
+
/**
|
|
12955
|
+
* Defines additional information of the link.
|
|
12956
|
+
*
|
|
12957
|
+
* @since 1.56.0
|
|
12958
|
+
*/
|
|
12959
|
+
description?: string | PropertyBindingInfo;
|
|
10239
12960
|
|
|
10240
|
-
|
|
12961
|
+
/**
|
|
12962
|
+
* Defines if the item is nullable
|
|
12963
|
+
*/
|
|
12964
|
+
nullable?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
12965
|
+
}
|
|
12966
|
+
}
|
|
10241
12967
|
|
|
10242
|
-
|
|
12968
|
+
declare module "sap/ui/comp/p13n/P13nPanel" {
|
|
12969
|
+
import { default as Control, $ControlSettings } from "sap/ui/core/Control";
|
|
12970
|
+
|
|
12971
|
+
import P13nItem from "sap/m/P13nItem";
|
|
10243
12972
|
|
|
10244
12973
|
import Event from "sap/ui/base/Event";
|
|
10245
12974
|
|
|
12975
|
+
import {
|
|
12976
|
+
AggregationBindingInfo,
|
|
12977
|
+
PropertyBindingInfo,
|
|
12978
|
+
} from "sap/ui/base/ManagedObject";
|
|
12979
|
+
|
|
12980
|
+
import ElementMetadata from "sap/ui/core/ElementMetadata";
|
|
12981
|
+
|
|
10246
12982
|
/**
|
|
10247
|
-
*
|
|
12983
|
+
* An abstract base type for `panels` aggregation in `P13nDialog` control.
|
|
10248
12984
|
*
|
|
10249
|
-
* @
|
|
12985
|
+
* @since 1.136
|
|
10250
12986
|
*/
|
|
10251
|
-
export default class
|
|
10252
|
-
extends
|
|
10253
|
-
implements /* was: sap.ui.comp.
|
|
12987
|
+
export default abstract class P13nPanel
|
|
12988
|
+
extends Control
|
|
12989
|
+
implements /* was: sap.ui.comp.p13n.IContent */ Object
|
|
10254
12990
|
{
|
|
10255
|
-
|
|
12991
|
+
__implements__sap_ui_comp_p13n_IContent: boolean;
|
|
10256
12992
|
/**
|
|
10257
|
-
* Constructor for a new
|
|
12993
|
+
* Constructor for a new P13nPanel.
|
|
10258
12994
|
*
|
|
10259
12995
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
10260
12996
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
10261
12997
|
* of the syntax of the settings object.
|
|
10262
|
-
*
|
|
10263
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10264
12998
|
*/
|
|
10265
|
-
|
|
12999
|
+
constructor(
|
|
10266
13000
|
/**
|
|
10267
|
-
*
|
|
13001
|
+
* initial settings for the new control
|
|
10268
13002
|
*/
|
|
10269
|
-
mSettings?: $
|
|
13003
|
+
mSettings?: $P13nPanelSettings
|
|
10270
13004
|
);
|
|
10271
13005
|
/**
|
|
10272
|
-
* Constructor for a new
|
|
13006
|
+
* Constructor for a new P13nPanel.
|
|
10273
13007
|
*
|
|
10274
13008
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
10275
13009
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
10276
13010
|
* of the syntax of the settings object.
|
|
10277
|
-
*
|
|
10278
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10279
13011
|
*/
|
|
10280
|
-
|
|
13012
|
+
constructor(
|
|
10281
13013
|
/**
|
|
10282
13014
|
* ID for the new control, generated automatically if no ID is given
|
|
10283
13015
|
*/
|
|
10284
13016
|
sId?: string,
|
|
10285
13017
|
/**
|
|
10286
|
-
*
|
|
13018
|
+
* initial settings for the new control
|
|
10287
13019
|
*/
|
|
10288
|
-
mSettings?: $
|
|
13020
|
+
mSettings?: $P13nPanelSettings
|
|
10289
13021
|
);
|
|
10290
13022
|
|
|
10291
13023
|
/**
|
|
10292
|
-
* Creates a new subclass of class sap.ui.comp.
|
|
13024
|
+
* Creates a new subclass of class sap.ui.comp.p13n.P13nPanel with name `sClassName` and enriches it with
|
|
10293
13025
|
* the information contained in `oClassInfo`.
|
|
10294
13026
|
*
|
|
10295
|
-
* `oClassInfo` might contain the same kind of information as described in {@link sap.
|
|
13027
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.core.Control.extend}.
|
|
10296
13028
|
*
|
|
10297
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10298
13029
|
*
|
|
10299
13030
|
* @returns Created class / constructor function
|
|
10300
13031
|
*/
|
|
@@ -10306,7 +13037,7 @@ declare module "sap/ui/comp/odata/ComboBox" {
|
|
|
10306
13037
|
/**
|
|
10307
13038
|
* Object literal with information about the class
|
|
10308
13039
|
*/
|
|
10309
|
-
oClassInfo?: sap.ClassInfo<T,
|
|
13040
|
+
oClassInfo?: sap.ClassInfo<T, P13nPanel>,
|
|
10310
13041
|
/**
|
|
10311
13042
|
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
10312
13043
|
* used by this class
|
|
@@ -10314,27 +13045,38 @@ declare module "sap/ui/comp/odata/ComboBox" {
|
|
|
10314
13045
|
FNMetaImpl?: Function
|
|
10315
13046
|
): Function;
|
|
10316
13047
|
/**
|
|
10317
|
-
* Returns a metadata object for class sap.ui.comp.
|
|
13048
|
+
* Returns a metadata object for class sap.ui.comp.p13n.P13nPanel.
|
|
10318
13049
|
*
|
|
10319
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10320
13050
|
*
|
|
10321
13051
|
* @returns Metadata object describing this class
|
|
10322
13052
|
*/
|
|
10323
13053
|
static getMetadata(): ElementMetadata;
|
|
10324
13054
|
/**
|
|
10325
|
-
*
|
|
10326
|
-
*
|
|
13055
|
+
* Adds some item to the aggregation {@link #getItems items}.
|
|
13056
|
+
*
|
|
13057
|
+
*
|
|
13058
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
13059
|
+
*/
|
|
13060
|
+
addItem(
|
|
13061
|
+
/**
|
|
13062
|
+
* The item to add; if empty, nothing is inserted
|
|
13063
|
+
*/
|
|
13064
|
+
oItem: P13nItem
|
|
13065
|
+
): this;
|
|
13066
|
+
/**
|
|
13067
|
+
* Attaches event handler `fnFunction` to the {@link #event:beforeNavigationTo beforeNavigationTo} event
|
|
13068
|
+
* of this `sap.ui.comp.p13n.P13nPanel`.
|
|
10327
13069
|
*
|
|
10328
13070
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
10329
|
-
* otherwise it will be bound to this `sap.ui.comp.
|
|
13071
|
+
* otherwise it will be bound to this `sap.ui.comp.p13n.P13nPanel` itself.
|
|
10330
13072
|
*
|
|
10331
|
-
*
|
|
10332
|
-
* There is a change when the control gets visible.
|
|
13073
|
+
* Due to performance the data of the panel can be requested in lazy mode e.g. when the panel is displayed
|
|
10333
13074
|
*
|
|
13075
|
+
* @since 1.28.0
|
|
10334
13076
|
*
|
|
10335
13077
|
* @returns Reference to `this` in order to allow method chaining
|
|
10336
13078
|
*/
|
|
10337
|
-
|
|
13079
|
+
attachBeforeNavigationTo(
|
|
10338
13080
|
/**
|
|
10339
13081
|
* An application-specific payload object that will be passed to the event handler along with the event
|
|
10340
13082
|
* object when firing the event
|
|
@@ -10343,138 +13085,444 @@ declare module "sap/ui/comp/odata/ComboBox" {
|
|
|
10343
13085
|
/**
|
|
10344
13086
|
* The function to be called when the event occurs
|
|
10345
13087
|
*/
|
|
10346
|
-
fnFunction: (p1:
|
|
13088
|
+
fnFunction: (p1: Event) => void,
|
|
10347
13089
|
/**
|
|
10348
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.comp.
|
|
13090
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.comp.p13n.P13nPanel` itself
|
|
10349
13091
|
*/
|
|
10350
13092
|
oListener?: object
|
|
10351
13093
|
): this;
|
|
10352
13094
|
/**
|
|
10353
|
-
* Attaches event handler `fnFunction` to the {@link #event:
|
|
10354
|
-
* this `sap.ui.comp.
|
|
13095
|
+
* Attaches event handler `fnFunction` to the {@link #event:beforeNavigationTo beforeNavigationTo} event
|
|
13096
|
+
* of this `sap.ui.comp.p13n.P13nPanel`.
|
|
10355
13097
|
*
|
|
10356
13098
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
10357
|
-
* otherwise it will be bound to this `sap.ui.comp.
|
|
13099
|
+
* otherwise it will be bound to this `sap.ui.comp.p13n.P13nPanel` itself.
|
|
10358
13100
|
*
|
|
10359
|
-
*
|
|
10360
|
-
* There is a change when the control gets visible.
|
|
13101
|
+
* Due to performance the data of the panel can be requested in lazy mode e.g. when the panel is displayed
|
|
10361
13102
|
*
|
|
13103
|
+
* @since 1.28.0
|
|
10362
13104
|
*
|
|
10363
13105
|
* @returns Reference to `this` in order to allow method chaining
|
|
10364
13106
|
*/
|
|
10365
|
-
|
|
13107
|
+
attachBeforeNavigationTo(
|
|
10366
13108
|
/**
|
|
10367
13109
|
* The function to be called when the event occurs
|
|
10368
13110
|
*/
|
|
10369
|
-
fnFunction: (p1:
|
|
13111
|
+
fnFunction: (p1: Event) => void,
|
|
10370
13112
|
/**
|
|
10371
|
-
* Context object to call the event handler with. Defaults to this `sap.ui.comp.
|
|
13113
|
+
* Context object to call the event handler with. Defaults to this `sap.ui.comp.p13n.P13nPanel` itself
|
|
10372
13114
|
*/
|
|
10373
13115
|
oListener?: object
|
|
10374
13116
|
): this;
|
|
10375
13117
|
/**
|
|
10376
|
-
*
|
|
10377
|
-
*
|
|
13118
|
+
* This method defines the point in time before the panel becomes active.
|
|
13119
|
+
*
|
|
13120
|
+
* @since 1.28.0
|
|
13121
|
+
*/
|
|
13122
|
+
beforeNavigationTo(): void;
|
|
13123
|
+
/**
|
|
13124
|
+
* Binds aggregation {@link #getItems items} to model data.
|
|
13125
|
+
*
|
|
13126
|
+
* See {@link sap.ui.base.ManagedObject#bindAggregation ManagedObject.bindAggregation} for a detailed description
|
|
13127
|
+
* of the possible properties of `oBindingInfo`.
|
|
13128
|
+
*
|
|
13129
|
+
*
|
|
13130
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
13131
|
+
*/
|
|
13132
|
+
bindItems(
|
|
13133
|
+
/**
|
|
13134
|
+
* The binding information
|
|
13135
|
+
*/
|
|
13136
|
+
oBindingInfo: AggregationBindingInfo
|
|
13137
|
+
): this;
|
|
13138
|
+
/**
|
|
13139
|
+
* Destroys all the items in the aggregation {@link #getItems items}.
|
|
13140
|
+
*
|
|
13141
|
+
*
|
|
13142
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
13143
|
+
*/
|
|
13144
|
+
destroyItems(): this;
|
|
13145
|
+
/**
|
|
13146
|
+
* Detaches event handler `fnFunction` from the {@link #event:beforeNavigationTo beforeNavigationTo} event
|
|
13147
|
+
* of this `sap.ui.comp.p13n.P13nPanel`.
|
|
10378
13148
|
*
|
|
10379
13149
|
* The passed function and listener object must match the ones used for event registration.
|
|
10380
13150
|
*
|
|
13151
|
+
* @since 1.28.0
|
|
10381
13152
|
*
|
|
10382
13153
|
* @returns Reference to `this` in order to allow method chaining
|
|
10383
13154
|
*/
|
|
10384
|
-
|
|
13155
|
+
detachBeforeNavigationTo(
|
|
10385
13156
|
/**
|
|
10386
13157
|
* The function to be called, when the event occurs
|
|
10387
13158
|
*/
|
|
10388
|
-
fnFunction: (p1:
|
|
13159
|
+
fnFunction: (p1: Event) => void,
|
|
10389
13160
|
/**
|
|
10390
13161
|
* Context object on which the given function had to be called
|
|
10391
13162
|
*/
|
|
10392
13163
|
oListener?: object
|
|
10393
13164
|
): this;
|
|
10394
13165
|
/**
|
|
10395
|
-
* Fires event {@link #event:
|
|
13166
|
+
* Fires event {@link #event:beforeNavigationTo beforeNavigationTo} to attached listeners.
|
|
10396
13167
|
*
|
|
13168
|
+
* @since 1.28.0
|
|
10397
13169
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
10398
13170
|
*
|
|
10399
13171
|
* @returns Reference to `this` in order to allow method chaining
|
|
10400
13172
|
*/
|
|
10401
|
-
|
|
13173
|
+
fireBeforeNavigationTo(
|
|
10402
13174
|
/**
|
|
10403
13175
|
* Parameters to pass along with the event
|
|
10404
13176
|
*/
|
|
10405
|
-
mParameters?:
|
|
13177
|
+
mParameters?: object
|
|
10406
13178
|
): this;
|
|
10407
13179
|
/**
|
|
10408
|
-
* Gets current value of property {@link #
|
|
13180
|
+
* Gets current value of property {@link #getChangeNotifier changeNotifier}.
|
|
10409
13181
|
*
|
|
10410
|
-
*
|
|
10411
|
-
* from the ValueList property.
|
|
13182
|
+
* Callback which notifies a change on this panel.
|
|
10412
13183
|
*
|
|
10413
|
-
* Default value is `empty string`.
|
|
10414
13184
|
*
|
|
13185
|
+
* @returns Value of property `changeNotifier`
|
|
13186
|
+
*/
|
|
13187
|
+
getChangeNotifier(): object;
|
|
13188
|
+
/**
|
|
13189
|
+
* Gets content of aggregation {@link #getItems items}.
|
|
10415
13190
|
*
|
|
10416
|
-
*
|
|
13191
|
+
* Defines personalization items (e.g. columns in the `P13nColumnsPanel`).
|
|
10417
13192
|
*/
|
|
10418
|
-
|
|
13193
|
+
getItems(): P13nItem[];
|
|
10419
13194
|
/**
|
|
10420
|
-
*
|
|
13195
|
+
* This method can be overwritten by subclass in order to return a payload for Ok action
|
|
10421
13196
|
*
|
|
10422
|
-
*
|
|
10423
|
-
*
|
|
13197
|
+
* @since 1.26.7
|
|
13198
|
+
* @deprecated As of version 1.50. replaced by the event of the respective inherited control, for example
|
|
13199
|
+
* {@link sap.ui.comp.P13nColumnsPanel#event:changeColumnsItems} of `P13nColumnsPanel` control.
|
|
13200
|
+
*
|
|
13201
|
+
* @returns Object which describes the state after Ok has been pressed
|
|
13202
|
+
*/
|
|
13203
|
+
getOkPayload(): object;
|
|
13204
|
+
/**
|
|
13205
|
+
* This method can be overwritten by subclass in order to return a payload for Reset action
|
|
13206
|
+
*
|
|
13207
|
+
* @since 1.28.0
|
|
13208
|
+
*/
|
|
13209
|
+
getResetPayload(): void;
|
|
13210
|
+
/**
|
|
13211
|
+
* Gets current value of property {@link #getTitle title}.
|
|
13212
|
+
*
|
|
13213
|
+
* Title text appears in the panel.
|
|
13214
|
+
*
|
|
13215
|
+
*
|
|
13216
|
+
* @returns Value of property `title`
|
|
13217
|
+
*/
|
|
13218
|
+
getTitle(): string;
|
|
13219
|
+
/**
|
|
13220
|
+
* Gets current value of property {@link #getTitleLarge titleLarge}.
|
|
13221
|
+
*
|
|
13222
|
+
* Large title text appears e.g. in dialog header in case that only one panel is shown.
|
|
13223
|
+
*
|
|
13224
|
+
* @since 1.30.0
|
|
13225
|
+
*
|
|
13226
|
+
* @returns Value of property `titleLarge`
|
|
13227
|
+
*/
|
|
13228
|
+
getTitleLarge(): string;
|
|
13229
|
+
/**
|
|
13230
|
+
* Gets current value of property {@link #getType type}.
|
|
13231
|
+
*
|
|
13232
|
+
* Panel type for generic use. Due to extensibility reason the type of `type` property should be `string`.
|
|
13233
|
+
* So it is feasible to add a custom panel without expanding the type.
|
|
13234
|
+
*
|
|
13235
|
+
*
|
|
13236
|
+
* @returns Value of property `type`
|
|
13237
|
+
*/
|
|
13238
|
+
getType(): string;
|
|
13239
|
+
/**
|
|
13240
|
+
* Gets current value of property {@link #getValidationExecutor validationExecutor}.
|
|
13241
|
+
*
|
|
13242
|
+
* Callback method which is called in order to validate end user entry.
|
|
13243
|
+
*
|
|
13244
|
+
*
|
|
13245
|
+
* @returns Value of property `validationExecutor`
|
|
13246
|
+
*/
|
|
13247
|
+
getValidationExecutor(): object;
|
|
13248
|
+
/**
|
|
13249
|
+
* Gets current value of property {@link #getValidationListener validationListener}.
|
|
13250
|
+
*
|
|
13251
|
+
* Callback method which is called in order to register for validation result.
|
|
13252
|
+
*
|
|
13253
|
+
*
|
|
13254
|
+
* @returns Value of property `validationListener`
|
|
13255
|
+
*/
|
|
13256
|
+
getValidationListener(): object;
|
|
13257
|
+
/**
|
|
13258
|
+
* Gets current value of property {@link #getVerticalScrolling verticalScrolling}.
|
|
13259
|
+
*
|
|
13260
|
+
* Enables the vertical Scrolling on the `P13nDialog` when the panel is shown.
|
|
13261
|
+
*
|
|
13262
|
+
* Default value is `true`.
|
|
13263
|
+
*
|
|
13264
|
+
*
|
|
13265
|
+
* @returns Value of property `verticalScrolling`
|
|
13266
|
+
*/
|
|
13267
|
+
getVerticalScrolling(): boolean;
|
|
13268
|
+
/**
|
|
13269
|
+
* Checks for the provided `sap.m.P13nItem` in the aggregation {@link #getItems items}. and returns its
|
|
13270
|
+
* index if found or -1 otherwise.
|
|
13271
|
+
*
|
|
13272
|
+
*
|
|
13273
|
+
* @returns The index of the provided control in the aggregation if found, or -1 otherwise
|
|
13274
|
+
*/
|
|
13275
|
+
indexOfItem(
|
|
13276
|
+
/**
|
|
13277
|
+
* The item whose index is looked for
|
|
13278
|
+
*/
|
|
13279
|
+
oItem: P13nItem
|
|
13280
|
+
): int;
|
|
13281
|
+
/**
|
|
13282
|
+
* Inserts a item into the aggregation {@link #getItems items}.
|
|
13283
|
+
*
|
|
13284
|
+
*
|
|
13285
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
13286
|
+
*/
|
|
13287
|
+
insertItem(
|
|
13288
|
+
/**
|
|
13289
|
+
* The item to insert; if empty, nothing is inserted
|
|
13290
|
+
*/
|
|
13291
|
+
oItem: P13nItem,
|
|
13292
|
+
/**
|
|
13293
|
+
* The `0`-based index the item should be inserted at; for a negative value of `iIndex`, the item is inserted
|
|
13294
|
+
* at position 0; for a value greater than the current size of the aggregation, the item is inserted at
|
|
13295
|
+
* the last position
|
|
13296
|
+
*/
|
|
13297
|
+
iIndex: int
|
|
13298
|
+
): this;
|
|
13299
|
+
/**
|
|
13300
|
+
* This method can be overwritten by subclass in order to cleanup after navigation, e.g. to remove invalid
|
|
13301
|
+
* content on the panel.
|
|
13302
|
+
*
|
|
13303
|
+
* @since 1.28.0
|
|
13304
|
+
*/
|
|
13305
|
+
onAfterNavigationFrom(): void;
|
|
13306
|
+
/**
|
|
13307
|
+
* This method can be overwritten by subclass in order to prevent navigation to another panel. This could
|
|
13308
|
+
* be the case if some content on the panel is considered 'invalid'.
|
|
13309
|
+
*
|
|
13310
|
+
* @since 1.28.0
|
|
13311
|
+
*
|
|
13312
|
+
* @returns true if it is allowed to navigate away from this panel, false if it is not allowed
|
|
13313
|
+
*/
|
|
13314
|
+
onBeforeNavigationFrom(): boolean;
|
|
13315
|
+
/**
|
|
13316
|
+
* Removes all the controls from the aggregation {@link #getItems items}.
|
|
13317
|
+
*
|
|
13318
|
+
* Additionally, it unregisters them from the hosting UIArea.
|
|
13319
|
+
*
|
|
13320
|
+
*
|
|
13321
|
+
* @returns An array of the removed elements (might be empty)
|
|
13322
|
+
*/
|
|
13323
|
+
removeAllItems(): P13nItem[];
|
|
13324
|
+
/**
|
|
13325
|
+
* Removes a item from the aggregation {@link #getItems items}.
|
|
13326
|
+
*
|
|
13327
|
+
*
|
|
13328
|
+
* @returns The removed item or `null`
|
|
13329
|
+
*/
|
|
13330
|
+
removeItem(
|
|
13331
|
+
/**
|
|
13332
|
+
* The item to remove or its index or id
|
|
13333
|
+
*/
|
|
13334
|
+
vItem: int | string | P13nItem
|
|
13335
|
+
): P13nItem | null;
|
|
13336
|
+
/**
|
|
13337
|
+
* Sets a new value for property {@link #getChangeNotifier changeNotifier}.
|
|
13338
|
+
*
|
|
13339
|
+
* Callback which notifies a change on this panel.
|
|
10424
13340
|
*
|
|
10425
13341
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10426
13342
|
*
|
|
10427
|
-
*
|
|
13343
|
+
*
|
|
13344
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
13345
|
+
*/
|
|
13346
|
+
setChangeNotifier(
|
|
13347
|
+
/**
|
|
13348
|
+
* New value for property `changeNotifier`
|
|
13349
|
+
*/
|
|
13350
|
+
oChangeNotifier?: object
|
|
13351
|
+
): this;
|
|
13352
|
+
/**
|
|
13353
|
+
* Sets a new value for property {@link #getTitle title}.
|
|
13354
|
+
*
|
|
13355
|
+
* Title text appears in the panel.
|
|
13356
|
+
*
|
|
13357
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
10428
13358
|
*
|
|
10429
13359
|
*
|
|
10430
13360
|
* @returns Reference to `this` in order to allow method chaining
|
|
10431
13361
|
*/
|
|
10432
|
-
|
|
13362
|
+
setTitle(
|
|
10433
13363
|
/**
|
|
10434
|
-
* New value for property `
|
|
13364
|
+
* New value for property `title`
|
|
10435
13365
|
*/
|
|
10436
|
-
|
|
13366
|
+
sTitle?: string
|
|
13367
|
+
): this;
|
|
13368
|
+
/**
|
|
13369
|
+
* Sets a new value for property {@link #getTitleLarge titleLarge}.
|
|
13370
|
+
*
|
|
13371
|
+
* Large title text appears e.g. in dialog header in case that only one panel is shown.
|
|
13372
|
+
*
|
|
13373
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
13374
|
+
*
|
|
13375
|
+
* @since 1.30.0
|
|
13376
|
+
*
|
|
13377
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
13378
|
+
*/
|
|
13379
|
+
setTitleLarge(
|
|
13380
|
+
/**
|
|
13381
|
+
* New value for property `titleLarge`
|
|
13382
|
+
*/
|
|
13383
|
+
sTitleLarge?: string
|
|
13384
|
+
): this;
|
|
13385
|
+
/**
|
|
13386
|
+
* Sets a new value for property {@link #getType type}.
|
|
13387
|
+
*
|
|
13388
|
+
* Panel type for generic use. Due to extensibility reason the type of `type` property should be `string`.
|
|
13389
|
+
* So it is feasible to add a custom panel without expanding the type.
|
|
13390
|
+
*
|
|
13391
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
13392
|
+
*
|
|
13393
|
+
*
|
|
13394
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
13395
|
+
*/
|
|
13396
|
+
setType(
|
|
13397
|
+
/**
|
|
13398
|
+
* New value for property `type`
|
|
13399
|
+
*/
|
|
13400
|
+
sType?: string
|
|
13401
|
+
): this;
|
|
13402
|
+
/**
|
|
13403
|
+
* Sets a new value for property {@link #getValidationExecutor validationExecutor}.
|
|
13404
|
+
*
|
|
13405
|
+
* Callback method which is called in order to validate end user entry.
|
|
13406
|
+
*
|
|
13407
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
13408
|
+
*
|
|
13409
|
+
*
|
|
13410
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
13411
|
+
*/
|
|
13412
|
+
setValidationExecutor(
|
|
13413
|
+
/**
|
|
13414
|
+
* New value for property `validationExecutor`
|
|
13415
|
+
*/
|
|
13416
|
+
oValidationExecutor?: object
|
|
13417
|
+
): this;
|
|
13418
|
+
/**
|
|
13419
|
+
* Sets a new value for property {@link #getValidationListener validationListener}.
|
|
13420
|
+
*
|
|
13421
|
+
* Callback method which is called in order to register for validation result.
|
|
13422
|
+
*
|
|
13423
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
13424
|
+
*
|
|
13425
|
+
*
|
|
13426
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
13427
|
+
*/
|
|
13428
|
+
setValidationListener(
|
|
13429
|
+
/**
|
|
13430
|
+
* New value for property `validationListener`
|
|
13431
|
+
*/
|
|
13432
|
+
oValidationListener?: object
|
|
13433
|
+
): this;
|
|
13434
|
+
/**
|
|
13435
|
+
* Sets a new value for property {@link #getVerticalScrolling verticalScrolling}.
|
|
13436
|
+
*
|
|
13437
|
+
* Enables the vertical Scrolling on the `P13nDialog` when the panel is shown.
|
|
13438
|
+
*
|
|
13439
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
13440
|
+
*
|
|
13441
|
+
* Default value is `true`.
|
|
13442
|
+
*
|
|
13443
|
+
*
|
|
13444
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
13445
|
+
*/
|
|
13446
|
+
setVerticalScrolling(
|
|
13447
|
+
/**
|
|
13448
|
+
* New value for property `verticalScrolling`
|
|
13449
|
+
*/
|
|
13450
|
+
bVerticalScrolling?: boolean
|
|
10437
13451
|
): this;
|
|
13452
|
+
/**
|
|
13453
|
+
* Unbinds aggregation {@link #getItems items} from model data.
|
|
13454
|
+
*
|
|
13455
|
+
*
|
|
13456
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
13457
|
+
*/
|
|
13458
|
+
unbindItems(): this;
|
|
10438
13459
|
}
|
|
10439
13460
|
/**
|
|
10440
|
-
* Describes the settings that can be provided to the
|
|
10441
|
-
*
|
|
10442
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
13461
|
+
* Describes the settings that can be provided to the P13nPanel constructor.
|
|
10443
13462
|
*/
|
|
10444
|
-
export interface $
|
|
13463
|
+
export interface $P13nPanelSettings extends $ControlSettings {
|
|
10445
13464
|
/**
|
|
10446
|
-
*
|
|
10447
|
-
* from the ValueList property.
|
|
13465
|
+
* Title text appears in the panel.
|
|
10448
13466
|
*/
|
|
10449
|
-
|
|
13467
|
+
title?: string | PropertyBindingInfo;
|
|
10450
13468
|
|
|
10451
13469
|
/**
|
|
10452
|
-
*
|
|
10453
|
-
*
|
|
13470
|
+
* Large title text appears e.g. in dialog header in case that only one panel is shown.
|
|
13471
|
+
*
|
|
13472
|
+
* @since 1.30.0
|
|
10454
13473
|
*/
|
|
10455
|
-
|
|
10456
|
-
}
|
|
13474
|
+
titleLarge?: string | PropertyBindingInfo;
|
|
10457
13475
|
|
|
10458
|
-
/**
|
|
10459
|
-
* Parameters of the ComboBox#selectedKeyChange event.
|
|
10460
|
-
*
|
|
10461
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
10462
|
-
*/
|
|
10463
|
-
export interface ComboBox$SelectedKeyChangeEventParameters {
|
|
10464
13476
|
/**
|
|
10465
|
-
*
|
|
13477
|
+
* Panel type for generic use. Due to extensibility reason the type of `type` property should be `string`.
|
|
13478
|
+
* So it is feasible to add a custom panel without expanding the type.
|
|
10466
13479
|
*/
|
|
10467
|
-
|
|
13480
|
+
type?: string | PropertyBindingInfo;
|
|
13481
|
+
|
|
13482
|
+
/**
|
|
13483
|
+
* Enables the vertical Scrolling on the `P13nDialog` when the panel is shown.
|
|
13484
|
+
*/
|
|
13485
|
+
verticalScrolling?: boolean | PropertyBindingInfo | `{${string}}`;
|
|
13486
|
+
|
|
13487
|
+
/**
|
|
13488
|
+
* Callback method which is called in order to validate end user entry.
|
|
13489
|
+
*/
|
|
13490
|
+
validationExecutor?: object | PropertyBindingInfo | `{${string}}`;
|
|
13491
|
+
|
|
13492
|
+
/**
|
|
13493
|
+
* Callback method which is called in order to register for validation result.
|
|
13494
|
+
*/
|
|
13495
|
+
validationListener?: object | PropertyBindingInfo | `{${string}}`;
|
|
13496
|
+
|
|
13497
|
+
/**
|
|
13498
|
+
* Callback which notifies a change on this panel.
|
|
13499
|
+
*/
|
|
13500
|
+
changeNotifier?: object | PropertyBindingInfo | `{${string}}`;
|
|
13501
|
+
|
|
13502
|
+
/**
|
|
13503
|
+
* Defines personalization items (e.g. columns in the `P13nColumnsPanel`).
|
|
13504
|
+
*/
|
|
13505
|
+
items?: P13nItem[] | P13nItem | AggregationBindingInfo | `{${string}}`;
|
|
13506
|
+
|
|
13507
|
+
/**
|
|
13508
|
+
* Due to performance the data of the panel can be requested in lazy mode e.g. when the panel is displayed
|
|
13509
|
+
*
|
|
13510
|
+
* @since 1.28.0
|
|
13511
|
+
*/
|
|
13512
|
+
beforeNavigationTo?: (oEvent: Event) => void;
|
|
10468
13513
|
}
|
|
10469
13514
|
|
|
10470
13515
|
/**
|
|
10471
|
-
*
|
|
10472
|
-
*
|
|
10473
|
-
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
13516
|
+
* Parameters of the P13nPanel#beforeNavigationTo event.
|
|
10474
13517
|
*/
|
|
10475
|
-
export
|
|
10476
|
-
|
|
10477
|
-
|
|
13518
|
+
export interface P13nPanel$BeforeNavigationToEventParameters {}
|
|
13519
|
+
|
|
13520
|
+
/**
|
|
13521
|
+
* Event object of the P13nPanel#beforeNavigationTo event.
|
|
13522
|
+
*/
|
|
13523
|
+
export type P13nPanel$BeforeNavigationToEvent = Event<
|
|
13524
|
+
P13nPanel$BeforeNavigationToEventParameters,
|
|
13525
|
+
P13nPanel
|
|
10478
13526
|
>;
|
|
10479
13527
|
}
|
|
10480
13528
|
|
|
@@ -37368,6 +40416,10 @@ declare module "sap/ui/comp/smartvariants/SmartVariantManagementUi2" {
|
|
|
37368
40416
|
|
|
37369
40417
|
/**
|
|
37370
40418
|
* The SmartVariantManagementUi2 control communicates with the Ui2 personalization layer to manage the variants.
|
|
40419
|
+
*
|
|
40420
|
+
* @deprecated As of version 1.136. replaced by {@link sap.ui.comp.smartvariants.SmartVariantManagement SmartVariantManagement }
|
|
40421
|
+
* for smart controls / OData V2 and {@link sap.ui.fl.variants.VariantManagement VariantManagement} for
|
|
40422
|
+
* OData V4 and freestyle applications.
|
|
37371
40423
|
*/
|
|
37372
40424
|
export default class SmartVariantManagementUi2 extends Control {
|
|
37373
40425
|
/**
|
|
@@ -38048,6 +41100,10 @@ declare module "sap/ui/comp/smartvariants/SmartVariantManagementUi2" {
|
|
|
38048
41100
|
}
|
|
38049
41101
|
/**
|
|
38050
41102
|
* Describes the settings that can be provided to the SmartVariantManagementUi2 constructor.
|
|
41103
|
+
*
|
|
41104
|
+
* @deprecated As of version 1.136. replaced by {@link sap.ui.comp.smartvariants.SmartVariantManagement SmartVariantManagement }
|
|
41105
|
+
* for smart controls / OData V2 and {@link sap.ui.fl.variants.VariantManagement VariantManagement} for
|
|
41106
|
+
* OData V4 and freestyle applications.
|
|
38051
41107
|
*/
|
|
38052
41108
|
export interface $SmartVariantManagementUi2Settings extends $ControlSettings {
|
|
38053
41109
|
/**
|
|
@@ -42544,6 +45600,16 @@ declare namespace sap {
|
|
|
42544
45600
|
|
|
42545
45601
|
"sap/ui/comp/odata/ComboBox": undefined;
|
|
42546
45602
|
|
|
45603
|
+
"sap/ui/comp/p13n/P13nConditionPanelBase": undefined;
|
|
45604
|
+
|
|
45605
|
+
"sap/ui/comp/p13n/P13nFilterItem": undefined;
|
|
45606
|
+
|
|
45607
|
+
"sap/ui/comp/p13n/P13nFilterPanelBase": undefined;
|
|
45608
|
+
|
|
45609
|
+
"sap/ui/comp/p13n/P13nItem": undefined;
|
|
45610
|
+
|
|
45611
|
+
"sap/ui/comp/p13n/P13nPanel": undefined;
|
|
45612
|
+
|
|
42547
45613
|
"sap/ui/comp/smartchart/SmartChart": undefined;
|
|
42548
45614
|
|
|
42549
45615
|
"sap/ui/comp/smartfield/ComboBox": undefined;
|