@sapui5/ts-types 1.147.2 → 1.148.1
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/index.d.ts +7 -7
- 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 +50 -11
- package/types/sap.esh.search.ui.d.ts +181 -34
- package/types/sap.f.d.ts +1 -1
- package/types/sap.fe.ariba.d.ts +1 -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 +47 -1
- package/types/sap.fe.ina.d.ts +1 -1
- package/types/sap.fe.macros.d.ts +25 -2
- 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 +3 -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 +19 -1
- package/types/sap.insights.d.ts +1 -1
- package/types/{mobile-1.147.0-d.ts → sap.m.d.ts} +188 -34
- package/types/sap.makit.d.ts +1 -1
- package/types/sap.me.d.ts +1 -1
- package/types/sap.ndc.d.ts +2 -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 +1 -1
- package/types/sap.suite.ui.commons.d.ts +1 -1
- package/types/sap.suite.ui.generic.template.d.ts +1 -1
- package/types/sap.suite.ui.microchart.d.ts +1 -1
- package/types/{tnt-1.147.0-d.ts → sap.tnt.d.ts} +1 -1
- package/types/sap.ui.codeeditor.d.ts +1 -1
- package/types/{commons-1.147.0-d.ts → sap.ui.commons.d.ts} +1 -1
- package/types/sap.ui.comp.d.ts +197 -4
- package/types/{core-1.147.0-d.ts → sap.ui.core.d.ts} +58 -19
- package/types/{dt-1.147.0-d.ts → sap.ui.dt.d.ts} +1 -1
- package/types/sap.ui.export.d.ts +143 -1
- package/types/sap.ui.fl.d.ts +1 -1
- package/types/sap.ui.generic.app.d.ts +1 -1
- package/types/sap.ui.generic.template.d.ts +1 -1
- package/types/sap.ui.geomap.d.ts +1 -1
- package/types/sap.ui.integration.d.ts +6 -3
- package/types/sap.ui.layout.d.ts +1 -1
- package/types/{mdc-1.147.0-d.ts → sap.ui.mdc.d.ts} +236 -3
- package/types/sap.ui.richtexteditor.d.ts +1 -1
- 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 +4 -4
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +1 -1
- package/types/{ux3-1.147.0-d.ts → sap.ui.ux3.d.ts} +1 -1
- package/types/sap.ui.vbm.d.ts +1 -1
- package/types/sap.ui.vk.d.ts +1 -1
- package/types/sap.ui.vtm.d.ts +1 -1
- package/types/sap.uiext.inbox.d.ts +1 -1
- package/types/sap.ushell.d.ts +3 -3
- package/types/sap.ushell_abap.d.ts +1 -1
- package/types/sap.uxap.d.ts +1 -1
- 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/package.json
CHANGED
package/types/index.d.ts
CHANGED
|
@@ -17,10 +17,10 @@
|
|
|
17
17
|
/// <reference path="./sap.zen.dsh.d.ts"/>
|
|
18
18
|
/// <reference path="./sap.zen.commons.d.ts"/>
|
|
19
19
|
/// <reference path="./sap.sac.df.d.ts"/>
|
|
20
|
-
/// <reference path="./commons
|
|
20
|
+
/// <reference path="./sap.ui.commons.d.ts"/>
|
|
21
21
|
/// <reference path="./sap.ui.comp.d.ts"/>
|
|
22
|
-
/// <reference path="./core
|
|
23
|
-
/// <reference path="./dt
|
|
22
|
+
/// <reference path="./sap.ui.core.d.ts"/>
|
|
23
|
+
/// <reference path="./sap.ui.dt.d.ts"/>
|
|
24
24
|
/// <reference path="./sap.ui.export.d.ts"/>
|
|
25
25
|
/// <reference path="./sap.f.d.ts"/>
|
|
26
26
|
/// <reference path="./sap.ui.fl.d.ts"/>
|
|
@@ -33,8 +33,8 @@
|
|
|
33
33
|
/// <reference path="./sap.ui.integration.d.ts"/>
|
|
34
34
|
/// <reference path="./sap.ui.layout.d.ts"/>
|
|
35
35
|
/// <reference path="./sap.makit.d.ts"/>
|
|
36
|
-
/// <reference path="./mdc
|
|
37
|
-
/// <reference path="./
|
|
36
|
+
/// <reference path="./sap.ui.mdc.d.ts"/>
|
|
37
|
+
/// <reference path="./sap.m.d.ts"/>
|
|
38
38
|
/// <reference path="./sap.me.d.ts"/>
|
|
39
39
|
/// <reference path="./sap.ndc.d.ts"/>
|
|
40
40
|
/// <reference path="./sap.ovp.d.ts"/>
|
|
@@ -70,12 +70,12 @@
|
|
|
70
70
|
/// <reference path="./sap.ui.support.d.ts"/>
|
|
71
71
|
/// <reference path="./sap.ui.table.d.ts"/>
|
|
72
72
|
/// <reference path="./sap.ui.testrecorder.d.ts"/>
|
|
73
|
-
/// <reference path="./tnt
|
|
73
|
+
/// <reference path="./sap.tnt.d.ts"/>
|
|
74
74
|
/// <reference path="./sap.ca.ui.d.ts"/>
|
|
75
75
|
/// <reference path="./sap.ui.unified.d.ts"/>
|
|
76
76
|
/// <reference path="./sap.ushell.d.ts"/>
|
|
77
77
|
/// <reference path="./sap.ushell_abap.d.ts"/>
|
|
78
|
-
/// <reference path="./ux3
|
|
78
|
+
/// <reference path="./sap.ui.ux3.d.ts"/>
|
|
79
79
|
/// <reference path="./sap.uxap.d.ts"/>
|
|
80
80
|
/// <reference path="./sap.ui.vbm.d.ts"/>
|
|
81
81
|
/// <reference path="./sap.viz.d.ts"/>
|
package/types/sap.apf.d.ts
CHANGED
package/types/sap.ca.ui.d.ts
CHANGED
package/types/sap.chart.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.148.0
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
/**
|
|
@@ -1993,9 +1993,6 @@ declare namespace sap {
|
|
|
1993
1993
|
namespace socialprofile {
|
|
1994
1994
|
/**
|
|
1995
1995
|
* Describes the settings that can be provided to the Component constructor.
|
|
1996
|
-
*
|
|
1997
|
-
* @experimental The API is not stable and the UI is not finalized. The implementation for this feature
|
|
1998
|
-
* is subject to change.
|
|
1999
1996
|
*/
|
|
2000
1997
|
interface $ComponentSettings extends sap.ui.core.$UIComponentSettings {
|
|
2001
1998
|
placement?:
|
|
@@ -2028,16 +2025,11 @@ declare namespace sap {
|
|
|
2028
2025
|
|
|
2029
2026
|
/**
|
|
2030
2027
|
* Social Profile Component
|
|
2031
|
-
*
|
|
2032
|
-
* @experimental The API is not stable and the UI is not finalized. The implementation for this feature
|
|
2033
|
-
* is subject to change.
|
|
2034
2028
|
*/
|
|
2035
2029
|
class Component extends sap.ui.core.UIComponent {
|
|
2036
2030
|
/**
|
|
2037
2031
|
* Constructor for the Social Profile Component.
|
|
2038
2032
|
*
|
|
2039
|
-
* !!! EXPERIMENTAL !!!
|
|
2040
|
-
*
|
|
2041
2033
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2042
2034
|
* objects as well as event handlers.
|
|
2043
2035
|
*
|
|
@@ -2054,8 +2046,6 @@ declare namespace sap {
|
|
|
2054
2046
|
/**
|
|
2055
2047
|
* Constructor for the Social Profile Component.
|
|
2056
2048
|
*
|
|
2057
|
-
* !!! EXPERIMENTAL !!!
|
|
2058
|
-
*
|
|
2059
2049
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
2060
2050
|
* objects as well as event handlers.
|
|
2061
2051
|
*
|
|
@@ -2789,6 +2779,53 @@ declare namespace sap {
|
|
|
2789
2779
|
Component
|
|
2790
2780
|
>;
|
|
2791
2781
|
}
|
|
2782
|
+
|
|
2783
|
+
namespace util {
|
|
2784
|
+
/**
|
|
2785
|
+
* Language bundle for Collaboration
|
|
2786
|
+
*/
|
|
2787
|
+
class DateUtil extends sap.ui.base.Object {
|
|
2788
|
+
/**
|
|
2789
|
+
* Date Utility Class for Collaboration
|
|
2790
|
+
*/
|
|
2791
|
+
constructor();
|
|
2792
|
+
|
|
2793
|
+
/**
|
|
2794
|
+
* Creates a new subclass of class sap.collaboration.components.util.DateUtil with name `sClassName` and
|
|
2795
|
+
* enriches it with the information contained in `oClassInfo`.
|
|
2796
|
+
*
|
|
2797
|
+
* `oClassInfo` might contain the same kind of information as described in {@link sap.ui.base.Object.extend}.
|
|
2798
|
+
*
|
|
2799
|
+
*
|
|
2800
|
+
* @returns Created class / constructor function
|
|
2801
|
+
*/
|
|
2802
|
+
static extend<T extends Record<string, unknown>>(
|
|
2803
|
+
/**
|
|
2804
|
+
* Name of the class being created
|
|
2805
|
+
*/
|
|
2806
|
+
sClassName: string,
|
|
2807
|
+
/**
|
|
2808
|
+
* Object literal with information about the class
|
|
2809
|
+
*/
|
|
2810
|
+
oClassInfo?: sap.ClassInfo<
|
|
2811
|
+
T,
|
|
2812
|
+
sap.collaboration.components.util.DateUtil
|
|
2813
|
+
>,
|
|
2814
|
+
/**
|
|
2815
|
+
* Constructor function for the metadata object; if not given, it defaults to the metadata implementation
|
|
2816
|
+
* used by this class
|
|
2817
|
+
*/
|
|
2818
|
+
FNMetaImpl?: Function
|
|
2819
|
+
): Function;
|
|
2820
|
+
/**
|
|
2821
|
+
* Returns a metadata object for class sap.collaboration.components.util.DateUtil.
|
|
2822
|
+
*
|
|
2823
|
+
*
|
|
2824
|
+
* @returns Metadata object describing this class
|
|
2825
|
+
*/
|
|
2826
|
+
static getMetadata(): sap.ui.base.Metadata;
|
|
2827
|
+
}
|
|
2828
|
+
}
|
|
2792
2829
|
}
|
|
2793
2830
|
|
|
2794
2831
|
/**
|
|
@@ -2903,6 +2940,8 @@ declare namespace sap {
|
|
|
2903
2940
|
|
|
2904
2941
|
"sap/collaboration/components/socialtimeline/Component": undefined;
|
|
2905
2942
|
|
|
2943
|
+
"sap/collaboration/components/utils/DateUtil": undefined;
|
|
2944
|
+
|
|
2906
2945
|
"sap/collaboration/library": undefined;
|
|
2907
2946
|
}
|
|
2908
2947
|
}
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.148.1
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
namespace esh {
|
|
@@ -755,7 +755,11 @@ declare namespace sap {
|
|
|
755
755
|
/**
|
|
756
756
|
* Items of the basket are automatically added/removed when selecting/deselecting items on result views.
|
|
757
757
|
* Moreover all items of the basket are automatically selected on result views, if they are visible on the
|
|
758
|
-
* current result view page.
|
|
758
|
+
* current result view page. The basket show/hide button is rendered as a toggle button. The left button
|
|
759
|
+
* shows available items (label: "Available"), the right button shows selected items (label: "Selected").
|
|
760
|
+
* You either see the result view (table, list or grid) or the basket. With release 1.148.0 the label, icon
|
|
761
|
+
* and tooltip of the right button are controlled by the properties 'basketShowHideButtonText', 'basketShowHideButtonIcon'
|
|
762
|
+
* and 'basketShowHideButtonTooltip'.
|
|
759
763
|
*
|
|
760
764
|
* @since 1.143.0
|
|
761
765
|
*/
|
|
@@ -774,7 +778,7 @@ declare namespace sap {
|
|
|
774
778
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
775
779
|
|
|
776
780
|
/**
|
|
777
|
-
* Custom
|
|
781
|
+
* Custom text of button 'add items to basket'. By default the text is empty and the button will show the
|
|
778
782
|
* icon, only.
|
|
779
783
|
*
|
|
780
784
|
* @since 1.143.0
|
|
@@ -784,7 +788,7 @@ declare namespace sap {
|
|
|
784
788
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
785
789
|
|
|
786
790
|
/**
|
|
787
|
-
* Custom
|
|
791
|
+
* Custom tooltip of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
|
|
788
792
|
*
|
|
789
793
|
* @since 1.143.0
|
|
790
794
|
*/
|
|
@@ -792,6 +796,39 @@ declare namespace sap {
|
|
|
792
796
|
| string
|
|
793
797
|
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
794
798
|
|
|
799
|
+
/**
|
|
800
|
+
* Custom icon of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
|
|
801
|
+
* is true. In that case, the icon is applied to the right button part ("Selected") of the segmented toggle
|
|
802
|
+
* button.
|
|
803
|
+
*
|
|
804
|
+
* @since 1.148.0
|
|
805
|
+
*/
|
|
806
|
+
basketShowHideButtonIcon?:
|
|
807
|
+
| string
|
|
808
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
809
|
+
|
|
810
|
+
/**
|
|
811
|
+
* Custom text of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
|
|
812
|
+
* is true. In that case, the text is applied to the right button part ("Selected") of the segmented toggle
|
|
813
|
+
* button.
|
|
814
|
+
*
|
|
815
|
+
* @since 1.148.0
|
|
816
|
+
*/
|
|
817
|
+
basketShowHideButtonText?:
|
|
818
|
+
| string
|
|
819
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
820
|
+
|
|
821
|
+
/**
|
|
822
|
+
* Custom tooltip of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
|
|
823
|
+
* is true. In that case, the tooltip is applied to the right button part ("Selected") of the segmented
|
|
824
|
+
* toggle button.
|
|
825
|
+
*
|
|
826
|
+
* @since 1.148.0
|
|
827
|
+
*/
|
|
828
|
+
basketShowHideButtonTooltip?:
|
|
829
|
+
| string
|
|
830
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
831
|
+
|
|
795
832
|
/**
|
|
796
833
|
* When basket gets initialized, this callback is called with the columns of the (future) basket table.
|
|
797
834
|
* You can add more columns or adjust the sequence of columns.
|
|
@@ -830,7 +867,7 @@ declare namespace sap {
|
|
|
830
867
|
/**
|
|
831
868
|
* Define your own view for the basket. The basket is displayed on a panel at the right/end of result views
|
|
832
869
|
* (by default, details see 'basketLocation'). There is buttons to show/hide it and add items to the basket
|
|
833
|
-
* (see config properties '
|
|
870
|
+
* (see config properties 'basketVisibilityButton' and 'basketAddButton'). For the basket items collection,
|
|
834
871
|
* we recommend to use function 'createAndRegisterBasket' to create a table/list, so the selection (incl.
|
|
835
872
|
* 'add to basket') of result views with table/list is managed by SearchCompositeControl.
|
|
836
873
|
*
|
|
@@ -977,19 +1014,22 @@ declare namespace sap {
|
|
|
977
1014
|
| `{${string}}`;
|
|
978
1015
|
|
|
979
1016
|
/**
|
|
980
|
-
* Enables
|
|
981
|
-
*
|
|
1017
|
+
* Enables a button in the search result list to control basket panel visibility. Depending on the configuration,
|
|
1018
|
+
* this is either a show/hide button or an 'Available'/'Selected' toggle button (when basketLinkByResultViewItemSelection=true).
|
|
1019
|
+
* The button is only rendered when the basket feature is active (i.e. createAndRegisterBasket was called).
|
|
982
1020
|
*
|
|
983
1021
|
* @since 1.143.0
|
|
984
1022
|
*/
|
|
985
|
-
|
|
1023
|
+
basketVisibilityButton?:
|
|
986
1024
|
| boolean
|
|
987
1025
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
988
1026
|
| `{${string}}`;
|
|
989
1027
|
|
|
990
1028
|
/**
|
|
991
1029
|
* Enables the basket add button in the search result list. The button is displayed on the top of search
|
|
992
|
-
* result view and allows to add result view items to the basket.
|
|
1030
|
+
* result view and allows to add result view items to the basket. Has no effect when basketLinkByResultViewItemSelection=true
|
|
1031
|
+
* — in that case items are added automatically via result view item selection and a manual add button is
|
|
1032
|
+
* redundant (a console warning is logged).
|
|
993
1033
|
*
|
|
994
1034
|
* @since 1.143.0
|
|
995
1035
|
*/
|
|
@@ -1959,7 +1999,9 @@ declare namespace sap {
|
|
|
1959
1999
|
* Gets current value of property {@link #getBasketAddButton basketAddButton}.
|
|
1960
2000
|
*
|
|
1961
2001
|
* Enables the basket add button in the search result list. The button is displayed on the top of search
|
|
1962
|
-
* result view and allows to add result view items to the basket.
|
|
2002
|
+
* result view and allows to add result view items to the basket. Has no effect when basketLinkByResultViewItemSelection=true
|
|
2003
|
+
* — in that case items are added automatically via result view item selection and a manual add button is
|
|
2004
|
+
* redundant (a console warning is logged).
|
|
1963
2005
|
*
|
|
1964
2006
|
* Default value is `false`.
|
|
1965
2007
|
*
|
|
@@ -1981,7 +2023,7 @@ declare namespace sap {
|
|
|
1981
2023
|
/**
|
|
1982
2024
|
* Gets current value of property {@link #getBasketAddButtonText basketAddButtonText}.
|
|
1983
2025
|
*
|
|
1984
|
-
* Custom
|
|
2026
|
+
* Custom text of button 'add items to basket'. By default the text is empty and the button will show the
|
|
1985
2027
|
* icon, only.
|
|
1986
2028
|
*
|
|
1987
2029
|
* @since 1.143.0
|
|
@@ -1992,7 +2034,7 @@ declare namespace sap {
|
|
|
1992
2034
|
/**
|
|
1993
2035
|
* Gets current value of property {@link #getBasketAddButtonTooltip basketAddButtonTooltip}.
|
|
1994
2036
|
*
|
|
1995
|
-
* Custom
|
|
2037
|
+
* Custom tooltip of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
|
|
1996
2038
|
*
|
|
1997
2039
|
* @since 1.143.0
|
|
1998
2040
|
*
|
|
@@ -2048,7 +2090,11 @@ declare namespace sap {
|
|
|
2048
2090
|
*
|
|
2049
2091
|
* Items of the basket are automatically added/removed when selecting/deselecting items on result views.
|
|
2050
2092
|
* Moreover all items of the basket are automatically selected on result views, if they are visible on the
|
|
2051
|
-
* current result view page.
|
|
2093
|
+
* current result view page. The basket show/hide button is rendered as a toggle button. The left button
|
|
2094
|
+
* shows available items (label: "Available"), the right button shows selected items (label: "Selected").
|
|
2095
|
+
* You either see the result view (table, list or grid) or the basket. With release 1.148.0 the label, icon
|
|
2096
|
+
* and tooltip of the right button are controlled by the properties 'basketShowHideButtonText', 'basketShowHideButtonIcon'
|
|
2097
|
+
* and 'basketShowHideButtonTooltip'.
|
|
2052
2098
|
*
|
|
2053
2099
|
* Default value is `false`.
|
|
2054
2100
|
*
|
|
@@ -2099,7 +2145,7 @@ declare namespace sap {
|
|
|
2099
2145
|
* Default size (percent) of the right hand panel, containing the basket with selected items. If "basketPanelResizable"
|
|
2100
2146
|
* is true, the width of the basket panel can be changed by the user.
|
|
2101
2147
|
*
|
|
2102
|
-
* Default value is `
|
|
2148
|
+
* Default value is `100`.
|
|
2103
2149
|
*
|
|
2104
2150
|
* @since 1.142.0
|
|
2105
2151
|
*
|
|
@@ -2107,18 +2153,55 @@ declare namespace sap {
|
|
|
2107
2153
|
*/
|
|
2108
2154
|
getBasketPanelWidthInPercent(): float;
|
|
2109
2155
|
/**
|
|
2110
|
-
* Gets current value of property {@link #
|
|
2156
|
+
* Gets current value of property {@link #getBasketShowHideButtonIcon basketShowHideButtonIcon}.
|
|
2111
2157
|
*
|
|
2112
|
-
*
|
|
2113
|
-
*
|
|
2158
|
+
* Custom icon of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
|
|
2159
|
+
* is true. In that case, the icon is applied to the right button part ("Selected") of the segmented toggle
|
|
2160
|
+
* button.
|
|
2114
2161
|
*
|
|
2115
|
-
*
|
|
2162
|
+
* @since 1.148.0
|
|
2163
|
+
*
|
|
2164
|
+
* @returns Value of property `basketShowHideButtonIcon`
|
|
2165
|
+
*/
|
|
2166
|
+
getBasketShowHideButtonIcon(): string;
|
|
2167
|
+
/**
|
|
2168
|
+
* Gets current value of property {@link #getBasketShowHideButtonText basketShowHideButtonText}.
|
|
2169
|
+
*
|
|
2170
|
+
* Custom text of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
|
|
2171
|
+
* is true. In that case, the text is applied to the right button part ("Selected") of the segmented toggle
|
|
2172
|
+
* button.
|
|
2173
|
+
*
|
|
2174
|
+
* @since 1.148.0
|
|
2175
|
+
*
|
|
2176
|
+
* @returns Value of property `basketShowHideButtonText`
|
|
2177
|
+
*/
|
|
2178
|
+
getBasketShowHideButtonText(): string;
|
|
2179
|
+
/**
|
|
2180
|
+
* Gets current value of property {@link #getBasketShowHideButtonTooltip basketShowHideButtonTooltip}.
|
|
2181
|
+
*
|
|
2182
|
+
* Custom tooltip of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
|
|
2183
|
+
* is true. In that case, the tooltip is applied to the right button part ("Selected") of the segmented
|
|
2184
|
+
* toggle button.
|
|
2185
|
+
*
|
|
2186
|
+
* @since 1.148.0
|
|
2187
|
+
*
|
|
2188
|
+
* @returns Value of property `basketShowHideButtonTooltip`
|
|
2189
|
+
*/
|
|
2190
|
+
getBasketShowHideButtonTooltip(): string;
|
|
2191
|
+
/**
|
|
2192
|
+
* Gets current value of property {@link #getBasketVisibilityButton basketVisibilityButton}.
|
|
2193
|
+
*
|
|
2194
|
+
* Enables a button in the search result list to control basket panel visibility. Depending on the configuration,
|
|
2195
|
+
* this is either a show/hide button or an 'Available'/'Selected' toggle button (when basketLinkByResultViewItemSelection=true).
|
|
2196
|
+
* The button is only rendered when the basket feature is active (i.e. createAndRegisterBasket was called).
|
|
2197
|
+
*
|
|
2198
|
+
* Default value is `true`.
|
|
2116
2199
|
*
|
|
2117
2200
|
* @since 1.143.0
|
|
2118
2201
|
*
|
|
2119
|
-
* @returns Value of property `
|
|
2202
|
+
* @returns Value of property `basketVisibilityButton`
|
|
2120
2203
|
*/
|
|
2121
|
-
|
|
2204
|
+
getBasketVisibilityButton(): boolean;
|
|
2122
2205
|
/**
|
|
2123
2206
|
* Gets current value of property {@link #getBoSuggestions boSuggestions}.
|
|
2124
2207
|
*
|
|
@@ -2154,7 +2237,7 @@ declare namespace sap {
|
|
|
2154
2237
|
*
|
|
2155
2238
|
* Define your own view for the basket. The basket is displayed on a panel at the right/end of result views
|
|
2156
2239
|
* (by default, details see 'basketLocation'). There is buttons to show/hide it and add items to the basket
|
|
2157
|
-
* (see config properties '
|
|
2240
|
+
* (see config properties 'basketVisibilityButton' and 'basketAddButton'). For the basket items collection,
|
|
2158
2241
|
* we recommend to use function 'createAndRegisterBasket' to create a table/list, so the selection (incl.
|
|
2159
2242
|
* 'add to basket') of result views with table/list is managed by SearchCompositeControl.
|
|
2160
2243
|
*
|
|
@@ -2897,7 +2980,9 @@ declare namespace sap {
|
|
|
2897
2980
|
* Sets a new value for property {@link #getBasketAddButton basketAddButton}.
|
|
2898
2981
|
*
|
|
2899
2982
|
* Enables the basket add button in the search result list. The button is displayed on the top of search
|
|
2900
|
-
* result view and allows to add result view items to the basket.
|
|
2983
|
+
* result view and allows to add result view items to the basket. Has no effect when basketLinkByResultViewItemSelection=true
|
|
2984
|
+
* — in that case items are added automatically via result view item selection and a manual add button is
|
|
2985
|
+
* redundant (a console warning is logged).
|
|
2901
2986
|
*
|
|
2902
2987
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2903
2988
|
*
|
|
@@ -2933,7 +3018,7 @@ declare namespace sap {
|
|
|
2933
3018
|
/**
|
|
2934
3019
|
* Sets a new value for property {@link #getBasketAddButtonText basketAddButtonText}.
|
|
2935
3020
|
*
|
|
2936
|
-
* Custom
|
|
3021
|
+
* Custom text of button 'add items to basket'. By default the text is empty and the button will show the
|
|
2937
3022
|
* icon, only.
|
|
2938
3023
|
*
|
|
2939
3024
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
@@ -2951,7 +3036,7 @@ declare namespace sap {
|
|
|
2951
3036
|
/**
|
|
2952
3037
|
* Sets a new value for property {@link #getBasketAddButtonTooltip basketAddButtonTooltip}.
|
|
2953
3038
|
*
|
|
2954
|
-
* Custom
|
|
3039
|
+
* Custom tooltip of button 'add items to basket'. By default there tooltip is 'Add to Basket'.
|
|
2955
3040
|
*
|
|
2956
3041
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
2957
3042
|
*
|
|
@@ -3027,7 +3112,11 @@ declare namespace sap {
|
|
|
3027
3112
|
*
|
|
3028
3113
|
* Items of the basket are automatically added/removed when selecting/deselecting items on result views.
|
|
3029
3114
|
* Moreover all items of the basket are automatically selected on result views, if they are visible on the
|
|
3030
|
-
* current result view page.
|
|
3115
|
+
* current result view page. The basket show/hide button is rendered as a toggle button. The left button
|
|
3116
|
+
* shows available items (label: "Available"), the right button shows selected items (label: "Selected").
|
|
3117
|
+
* You either see the result view (table, list or grid) or the basket. With release 1.148.0 the label, icon
|
|
3118
|
+
* and tooltip of the right button are controlled by the properties 'basketShowHideButtonText', 'basketShowHideButtonIcon'
|
|
3119
|
+
* and 'basketShowHideButtonTooltip'.
|
|
3031
3120
|
*
|
|
3032
3121
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3033
3122
|
*
|
|
@@ -3101,7 +3190,7 @@ declare namespace sap {
|
|
|
3101
3190
|
*
|
|
3102
3191
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3103
3192
|
*
|
|
3104
|
-
* Default value is `
|
|
3193
|
+
* Default value is `100`.
|
|
3105
3194
|
*
|
|
3106
3195
|
* @since 1.142.0
|
|
3107
3196
|
*
|
|
@@ -3114,24 +3203,82 @@ declare namespace sap {
|
|
|
3114
3203
|
fBasketPanelWidthInPercent?: float
|
|
3115
3204
|
): this;
|
|
3116
3205
|
/**
|
|
3117
|
-
* Sets a new value for property {@link #
|
|
3206
|
+
* Sets a new value for property {@link #getBasketShowHideButtonIcon basketShowHideButtonIcon}.
|
|
3118
3207
|
*
|
|
3119
|
-
*
|
|
3120
|
-
*
|
|
3208
|
+
* Custom icon of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
|
|
3209
|
+
* is true. In that case, the icon is applied to the right button part ("Selected") of the segmented toggle
|
|
3210
|
+
* button.
|
|
3121
3211
|
*
|
|
3122
3212
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3123
3213
|
*
|
|
3124
|
-
*
|
|
3214
|
+
* @since 1.148.0
|
|
3215
|
+
*
|
|
3216
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3217
|
+
*/
|
|
3218
|
+
setBasketShowHideButtonIcon(
|
|
3219
|
+
/**
|
|
3220
|
+
* New value for property `basketShowHideButtonIcon`
|
|
3221
|
+
*/
|
|
3222
|
+
sBasketShowHideButtonIcon: string
|
|
3223
|
+
): this;
|
|
3224
|
+
/**
|
|
3225
|
+
* Sets a new value for property {@link #getBasketShowHideButtonText basketShowHideButtonText}.
|
|
3226
|
+
*
|
|
3227
|
+
* Custom text of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
|
|
3228
|
+
* is true. In that case, the text is applied to the right button part ("Selected") of the segmented toggle
|
|
3229
|
+
* button.
|
|
3230
|
+
*
|
|
3231
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3232
|
+
*
|
|
3233
|
+
* @since 1.148.0
|
|
3234
|
+
*
|
|
3235
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3236
|
+
*/
|
|
3237
|
+
setBasketShowHideButtonText(
|
|
3238
|
+
/**
|
|
3239
|
+
* New value for property `basketShowHideButtonText`
|
|
3240
|
+
*/
|
|
3241
|
+
sBasketShowHideButtonText: string
|
|
3242
|
+
): this;
|
|
3243
|
+
/**
|
|
3244
|
+
* Sets a new value for property {@link #getBasketShowHideButtonTooltip basketShowHideButtonTooltip}.
|
|
3245
|
+
*
|
|
3246
|
+
* Custom tooltip of the show/hide basket button. Only applies when {@link #basketLinkByResultViewItemSelection }
|
|
3247
|
+
* is true. In that case, the tooltip is applied to the right button part ("Selected") of the segmented
|
|
3248
|
+
* toggle button.
|
|
3249
|
+
*
|
|
3250
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3251
|
+
*
|
|
3252
|
+
* @since 1.148.0
|
|
3253
|
+
*
|
|
3254
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
3255
|
+
*/
|
|
3256
|
+
setBasketShowHideButtonTooltip(
|
|
3257
|
+
/**
|
|
3258
|
+
* New value for property `basketShowHideButtonTooltip`
|
|
3259
|
+
*/
|
|
3260
|
+
sBasketShowHideButtonTooltip: string
|
|
3261
|
+
): this;
|
|
3262
|
+
/**
|
|
3263
|
+
* Sets a new value for property {@link #getBasketVisibilityButton basketVisibilityButton}.
|
|
3264
|
+
*
|
|
3265
|
+
* Enables a button in the search result list to control basket panel visibility. Depending on the configuration,
|
|
3266
|
+
* this is either a show/hide button or an 'Available'/'Selected' toggle button (when basketLinkByResultViewItemSelection=true).
|
|
3267
|
+
* The button is only rendered when the basket feature is active (i.e. createAndRegisterBasket was called).
|
|
3268
|
+
*
|
|
3269
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
3270
|
+
*
|
|
3271
|
+
* Default value is `true`.
|
|
3125
3272
|
*
|
|
3126
3273
|
* @since 1.143.0
|
|
3127
3274
|
*
|
|
3128
3275
|
* @returns Reference to `this` in order to allow method chaining
|
|
3129
3276
|
*/
|
|
3130
|
-
|
|
3277
|
+
setBasketVisibilityButton(
|
|
3131
3278
|
/**
|
|
3132
|
-
* New value for property `
|
|
3279
|
+
* New value for property `basketVisibilityButton`
|
|
3133
3280
|
*/
|
|
3134
|
-
|
|
3281
|
+
bBasketVisibilityButton?: boolean
|
|
3135
3282
|
): this;
|
|
3136
3283
|
/**
|
|
3137
3284
|
* Sets a new value for property {@link #getBoSuggestions boSuggestions}.
|
|
@@ -3174,7 +3321,7 @@ declare namespace sap {
|
|
|
3174
3321
|
*
|
|
3175
3322
|
* Define your own view for the basket. The basket is displayed on a panel at the right/end of result views
|
|
3176
3323
|
* (by default, details see 'basketLocation'). There is buttons to show/hide it and add items to the basket
|
|
3177
|
-
* (see config properties '
|
|
3324
|
+
* (see config properties 'basketVisibilityButton' and 'basketAddButton'). For the basket items collection,
|
|
3178
3325
|
* we recommend to use function 'createAndRegisterBasket' to create a table/list, so the selection (incl.
|
|
3179
3326
|
* 'add to basket') of result views with table/list is managed by SearchCompositeControl.
|
|
3180
3327
|
*
|
package/types/sap.f.d.ts
CHANGED
package/types/sap.fe.ariba.d.ts
CHANGED
package/types/sap.fe.base.d.ts
CHANGED
package/types/sap.fe.core.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// For Library Version: 1.
|
|
1
|
+
// For Library Version: 1.148.1
|
|
2
2
|
|
|
3
3
|
declare namespace sap {
|
|
4
4
|
/**
|
|
@@ -1065,6 +1065,50 @@ declare namespace sap {
|
|
|
1065
1065
|
oControl: sap.ui.core.Control
|
|
1066
1066
|
): void;
|
|
1067
1067
|
}
|
|
1068
|
+
/**
|
|
1069
|
+
* A controller extension which provides hooks into the flow of event-driven side effects in the application.
|
|
1070
|
+
*
|
|
1071
|
+
* @since 1.148.0
|
|
1072
|
+
*/
|
|
1073
|
+
class SideEffects extends sap.ui.core.mvc.ControllerExtension {
|
|
1074
|
+
/**
|
|
1075
|
+
* Hook called when an event-driven side effects message is received using a WebSocket.
|
|
1076
|
+
* This hook is called once per visible PageController for each incoming event.
|
|
1077
|
+
* Application developers can use it to do the following:
|
|
1078
|
+
*
|
|
1079
|
+
* - Execute custom logic.
|
|
1080
|
+
*
|
|
1081
|
+
* - Inspect app state and conditionally suppress the default refresh workflow
|
|
1082
|
+
* by returning a rejected promise.
|
|
1083
|
+
*
|
|
1084
|
+
* - Override the interaction type, such as (None / Notification / Confirmation), for this event.
|
|
1085
|
+
*
|
|
1086
|
+
* When multiple pages are visible simultaneously, for example, in a flexible column layout,
|
|
1087
|
+
* this hook is called once per visible page. If multiple pages return an interactionType override,
|
|
1088
|
+
* the last resolved value wins.
|
|
1089
|
+
* Returns a rejected promise that stops all further processing for this WebSocket event.
|
|
1090
|
+
*
|
|
1091
|
+
*
|
|
1092
|
+
* @since 1.148.0
|
|
1093
|
+
*
|
|
1094
|
+
* @returns A promise that resolves with an optional interactionType override, or rejects to stop processing.
|
|
1095
|
+
*/
|
|
1096
|
+
onEventDrivenSideEffectsReceived(
|
|
1097
|
+
/**
|
|
1098
|
+
* Parameters forwarded from the WebSocket message.
|
|
1099
|
+
*/
|
|
1100
|
+
_mParameters: {
|
|
1101
|
+
/**
|
|
1102
|
+
* The name of the side-effects event.
|
|
1103
|
+
*/
|
|
1104
|
+
sideEffectEventName: string;
|
|
1105
|
+
/**
|
|
1106
|
+
* The OData path that is the source of the event.
|
|
1107
|
+
*/
|
|
1108
|
+
sideEffectSource: string;
|
|
1109
|
+
}
|
|
1110
|
+
): any;
|
|
1111
|
+
}
|
|
1068
1112
|
/**
|
|
1069
1113
|
* A controller extension offering hooks for state handling
|
|
1070
1114
|
* If you need to maintain a specific state for your application, you can use the controller extension.
|
|
@@ -1897,6 +1941,8 @@ declare namespace sap {
|
|
|
1897
1941
|
|
|
1898
1942
|
"sap/fe/core/controllerextensions/Share": undefined;
|
|
1899
1943
|
|
|
1944
|
+
"sap/fe/core/controllerextensions/SideEffects": undefined;
|
|
1945
|
+
|
|
1900
1946
|
"sap/fe/core/controllerextensions/ViewState": undefined;
|
|
1901
1947
|
|
|
1902
1948
|
"sap/fe/core/controls/DataWatcher": undefined;
|
package/types/sap.fe.ina.d.ts
CHANGED