@openui5/ts-types 1.145.1 → 1.147.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/index.d.ts +0 -3
- package/types/sap.f.d.ts +214 -528
- package/types/sap.m.d.ts +607 -48
- package/types/sap.tnt.d.ts +9 -19
- package/types/sap.ui.codeeditor.d.ts +82 -46
- package/types/sap.ui.commons.d.ts +1 -1
- package/types/sap.ui.core.d.ts +1209 -376
- package/types/sap.ui.dt.d.ts +1 -1
- package/types/sap.ui.fl.d.ts +9 -1
- package/types/sap.ui.integration.d.ts +87 -289
- package/types/sap.ui.layout.d.ts +1 -1
- package/types/sap.ui.mdc.d.ts +108 -21
- 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 +2 -2
- package/types/sap.ui.table.d.ts +1 -1
- package/types/sap.ui.testrecorder.d.ts +1 -1
- package/types/sap.ui.unified.d.ts +41 -11
- package/types/sap.ui.ux3.d.ts +1 -1
- package/types/sap.uxap.d.ts +146 -1
- package/types/sap.ui.webc.common.d.ts +0 -173
- package/types/sap.ui.webc.fiori.d.ts +0 -16012
- package/types/sap.ui.webc.main.d.ts +0 -51158
package/types/sap.ui.core.d.ts
CHANGED
|
@@ -279,7 +279,7 @@ declare namespace sap {
|
|
|
279
279
|
"sap/ui/thirdparty/qunit-2": undefined;
|
|
280
280
|
}
|
|
281
281
|
}
|
|
282
|
-
// For Library Version: 1.
|
|
282
|
+
// For Library Version: 1.147.0
|
|
283
283
|
|
|
284
284
|
declare module "sap/base/assert" {
|
|
285
285
|
/**
|
|
@@ -5499,211 +5499,418 @@ declare module "sap/ui/events/ControlEvents" {
|
|
|
5499
5499
|
|
|
5500
5500
|
declare module "sap/ui/events/KeyCodes" {
|
|
5501
5501
|
/**
|
|
5502
|
+
* KeyCodes enumeration.
|
|
5503
|
+
*
|
|
5502
5504
|
* @since 1.58
|
|
5503
5505
|
*/
|
|
5504
5506
|
enum KeyCodes {
|
|
5507
|
+
/**
|
|
5508
|
+
* Letter A key
|
|
5509
|
+
*/
|
|
5505
5510
|
A = "65",
|
|
5506
|
-
|
|
5511
|
+
/**
|
|
5512
|
+
* Alt key
|
|
5513
|
+
*/
|
|
5507
5514
|
ALT = "18",
|
|
5508
|
-
|
|
5515
|
+
/**
|
|
5516
|
+
* Down arrow key
|
|
5517
|
+
*/
|
|
5509
5518
|
ARROW_DOWN = "40",
|
|
5510
|
-
|
|
5519
|
+
/**
|
|
5520
|
+
* Left arrow key
|
|
5521
|
+
*/
|
|
5511
5522
|
ARROW_LEFT = "37",
|
|
5512
|
-
|
|
5523
|
+
/**
|
|
5524
|
+
* Right arrow key
|
|
5525
|
+
*/
|
|
5513
5526
|
ARROW_RIGHT = "39",
|
|
5514
|
-
|
|
5527
|
+
/**
|
|
5528
|
+
* Up arrow key
|
|
5529
|
+
*/
|
|
5515
5530
|
ARROW_UP = "38",
|
|
5516
|
-
|
|
5531
|
+
/**
|
|
5532
|
+
* Letter B key
|
|
5533
|
+
*/
|
|
5517
5534
|
B = "66",
|
|
5518
|
-
|
|
5535
|
+
/**
|
|
5536
|
+
* Backslash (\) key
|
|
5537
|
+
*/
|
|
5519
5538
|
BACKSLASH = "226",
|
|
5520
|
-
|
|
5539
|
+
/**
|
|
5540
|
+
* Backspace key
|
|
5541
|
+
*/
|
|
5521
5542
|
BACKSPACE = "8",
|
|
5522
|
-
|
|
5543
|
+
/**
|
|
5544
|
+
* Pause/Break key
|
|
5545
|
+
*/
|
|
5523
5546
|
BREAK = "19",
|
|
5524
|
-
|
|
5547
|
+
/**
|
|
5548
|
+
* Letter C key
|
|
5549
|
+
*/
|
|
5525
5550
|
C = "67",
|
|
5526
|
-
|
|
5551
|
+
/**
|
|
5552
|
+
* Caps Lock key
|
|
5553
|
+
*/
|
|
5527
5554
|
CAPS_LOCK = "20",
|
|
5528
|
-
|
|
5555
|
+
/**
|
|
5556
|
+
* Comma (,) key
|
|
5557
|
+
*/
|
|
5529
5558
|
COMMA = "188",
|
|
5530
|
-
|
|
5559
|
+
/**
|
|
5560
|
+
* Context menu key
|
|
5561
|
+
*/
|
|
5531
5562
|
CONTEXT_MENU = "93",
|
|
5532
|
-
|
|
5563
|
+
/**
|
|
5564
|
+
* Control key
|
|
5565
|
+
*/
|
|
5533
5566
|
CONTROL = "17",
|
|
5534
|
-
|
|
5567
|
+
/**
|
|
5568
|
+
* Letter D key
|
|
5569
|
+
*/
|
|
5535
5570
|
D = "68",
|
|
5536
|
-
|
|
5571
|
+
/**
|
|
5572
|
+
* Delete key
|
|
5573
|
+
*/
|
|
5537
5574
|
DELETE = "46",
|
|
5538
|
-
|
|
5575
|
+
/**
|
|
5576
|
+
* Digit 0 key
|
|
5577
|
+
*/
|
|
5539
5578
|
DIGIT_0 = "48",
|
|
5540
|
-
|
|
5579
|
+
/**
|
|
5580
|
+
* Digit 1 key
|
|
5581
|
+
*/
|
|
5541
5582
|
DIGIT_1 = "49",
|
|
5542
|
-
|
|
5583
|
+
/**
|
|
5584
|
+
* Digit 2 key
|
|
5585
|
+
*/
|
|
5543
5586
|
DIGIT_2 = "50",
|
|
5544
|
-
|
|
5587
|
+
/**
|
|
5588
|
+
* Digit 3 key
|
|
5589
|
+
*/
|
|
5545
5590
|
DIGIT_3 = "51",
|
|
5546
|
-
|
|
5591
|
+
/**
|
|
5592
|
+
* Digit 4 key
|
|
5593
|
+
*/
|
|
5547
5594
|
DIGIT_4 = "52",
|
|
5548
|
-
|
|
5595
|
+
/**
|
|
5596
|
+
* Digit 5 key
|
|
5597
|
+
*/
|
|
5549
5598
|
DIGIT_5 = "53",
|
|
5550
|
-
|
|
5599
|
+
/**
|
|
5600
|
+
* Digit 6 key
|
|
5601
|
+
*/
|
|
5551
5602
|
DIGIT_6 = "54",
|
|
5552
|
-
|
|
5603
|
+
/**
|
|
5604
|
+
* Digit 7 key
|
|
5605
|
+
*/
|
|
5553
5606
|
DIGIT_7 = "55",
|
|
5554
|
-
|
|
5607
|
+
/**
|
|
5608
|
+
* Digit 8 key
|
|
5609
|
+
*/
|
|
5555
5610
|
DIGIT_8 = "56",
|
|
5556
|
-
|
|
5611
|
+
/**
|
|
5612
|
+
* Digit 9 key
|
|
5613
|
+
*/
|
|
5557
5614
|
DIGIT_9 = "57",
|
|
5558
|
-
|
|
5615
|
+
/**
|
|
5616
|
+
* Dot/period (.) key
|
|
5617
|
+
*/
|
|
5559
5618
|
DOT = "190",
|
|
5560
|
-
|
|
5619
|
+
/**
|
|
5620
|
+
* Letter E key
|
|
5621
|
+
*/
|
|
5561
5622
|
E = "69",
|
|
5562
|
-
|
|
5623
|
+
/**
|
|
5624
|
+
* End key
|
|
5625
|
+
*/
|
|
5563
5626
|
END = "35",
|
|
5564
|
-
|
|
5627
|
+
/**
|
|
5628
|
+
* Enter key
|
|
5629
|
+
*/
|
|
5565
5630
|
ENTER = "13",
|
|
5566
|
-
|
|
5631
|
+
/**
|
|
5632
|
+
* Equals (=) key
|
|
5633
|
+
*/
|
|
5567
5634
|
EQUALS = "221",
|
|
5568
|
-
|
|
5635
|
+
/**
|
|
5636
|
+
* Escape key
|
|
5637
|
+
*/
|
|
5569
5638
|
ESCAPE = "27",
|
|
5570
|
-
|
|
5639
|
+
/**
|
|
5640
|
+
* Letter F key
|
|
5641
|
+
*/
|
|
5571
5642
|
F = "70",
|
|
5572
|
-
|
|
5643
|
+
/**
|
|
5644
|
+
* F1 function key
|
|
5645
|
+
*/
|
|
5573
5646
|
F1 = "112",
|
|
5574
|
-
|
|
5647
|
+
/**
|
|
5648
|
+
* F10 function key
|
|
5649
|
+
*/
|
|
5575
5650
|
F10 = "121",
|
|
5576
|
-
|
|
5651
|
+
/**
|
|
5652
|
+
* F11 function key
|
|
5653
|
+
*/
|
|
5577
5654
|
F11 = "122",
|
|
5578
|
-
|
|
5655
|
+
/**
|
|
5656
|
+
* F12 function key
|
|
5657
|
+
*/
|
|
5579
5658
|
F12 = "123",
|
|
5580
|
-
|
|
5659
|
+
/**
|
|
5660
|
+
* F2 function key
|
|
5661
|
+
*/
|
|
5581
5662
|
F2 = "113",
|
|
5582
|
-
|
|
5663
|
+
/**
|
|
5664
|
+
* F3 function key
|
|
5665
|
+
*/
|
|
5583
5666
|
F3 = "114",
|
|
5584
|
-
|
|
5667
|
+
/**
|
|
5668
|
+
* F4 function key
|
|
5669
|
+
*/
|
|
5585
5670
|
F4 = "115",
|
|
5586
|
-
|
|
5671
|
+
/**
|
|
5672
|
+
* F5 function key
|
|
5673
|
+
*/
|
|
5587
5674
|
F5 = "116",
|
|
5588
|
-
|
|
5675
|
+
/**
|
|
5676
|
+
* F6 function key
|
|
5677
|
+
*/
|
|
5589
5678
|
F6 = "117",
|
|
5590
|
-
|
|
5679
|
+
/**
|
|
5680
|
+
* F7 function key
|
|
5681
|
+
*/
|
|
5591
5682
|
F7 = "118",
|
|
5592
|
-
|
|
5683
|
+
/**
|
|
5684
|
+
* F8 function key
|
|
5685
|
+
*/
|
|
5593
5686
|
F8 = "119",
|
|
5594
|
-
|
|
5687
|
+
/**
|
|
5688
|
+
* F9 function key
|
|
5689
|
+
*/
|
|
5595
5690
|
F9 = "120",
|
|
5596
|
-
|
|
5691
|
+
/**
|
|
5692
|
+
* Letter G key
|
|
5693
|
+
*/
|
|
5597
5694
|
G = "71",
|
|
5598
|
-
|
|
5695
|
+
/**
|
|
5696
|
+
* Grave accent (`) key
|
|
5697
|
+
*/
|
|
5599
5698
|
GREAT_ACCENT = "220",
|
|
5600
|
-
|
|
5699
|
+
/**
|
|
5700
|
+
* Letter H key
|
|
5701
|
+
*/
|
|
5601
5702
|
H = "72",
|
|
5602
|
-
|
|
5703
|
+
/**
|
|
5704
|
+
* Home key
|
|
5705
|
+
*/
|
|
5603
5706
|
HOME = "36",
|
|
5604
|
-
|
|
5707
|
+
/**
|
|
5708
|
+
* Letter I key
|
|
5709
|
+
*/
|
|
5605
5710
|
I = "73",
|
|
5606
|
-
|
|
5711
|
+
/**
|
|
5712
|
+
* Insert key
|
|
5713
|
+
*/
|
|
5607
5714
|
INSERT = "45",
|
|
5608
|
-
|
|
5715
|
+
/**
|
|
5716
|
+
* Letter J key
|
|
5717
|
+
*/
|
|
5609
5718
|
J = "74",
|
|
5610
|
-
|
|
5719
|
+
/**
|
|
5720
|
+
* Letter K key
|
|
5721
|
+
*/
|
|
5611
5722
|
K = "75",
|
|
5612
|
-
|
|
5723
|
+
/**
|
|
5724
|
+
* Letter L key
|
|
5725
|
+
*/
|
|
5613
5726
|
L = "76",
|
|
5614
|
-
|
|
5727
|
+
/**
|
|
5728
|
+
* Letter M key
|
|
5729
|
+
*/
|
|
5615
5730
|
M = "77",
|
|
5616
|
-
|
|
5731
|
+
/**
|
|
5732
|
+
* Minus (-) key
|
|
5733
|
+
*/
|
|
5617
5734
|
MINUS = "219",
|
|
5618
|
-
|
|
5735
|
+
/**
|
|
5736
|
+
* Letter N key
|
|
5737
|
+
*/
|
|
5619
5738
|
N = "78",
|
|
5620
|
-
|
|
5739
|
+
/**
|
|
5740
|
+
* Num Lock key
|
|
5741
|
+
*/
|
|
5621
5742
|
NUM_LOCK = "144",
|
|
5622
|
-
|
|
5743
|
+
/**
|
|
5744
|
+
* Numpad 0 key
|
|
5745
|
+
*/
|
|
5623
5746
|
NUMPAD_0 = "96",
|
|
5624
|
-
|
|
5747
|
+
/**
|
|
5748
|
+
* Numpad 1 key
|
|
5749
|
+
*/
|
|
5625
5750
|
NUMPAD_1 = "97",
|
|
5626
|
-
|
|
5751
|
+
/**
|
|
5752
|
+
* Numpad 2 key
|
|
5753
|
+
*/
|
|
5627
5754
|
NUMPAD_2 = "98",
|
|
5628
|
-
|
|
5755
|
+
/**
|
|
5756
|
+
* Numpad 3 key
|
|
5757
|
+
*/
|
|
5629
5758
|
NUMPAD_3 = "99",
|
|
5630
|
-
|
|
5759
|
+
/**
|
|
5760
|
+
* Numpad 4 key
|
|
5761
|
+
*/
|
|
5631
5762
|
NUMPAD_4 = "100",
|
|
5632
|
-
|
|
5763
|
+
/**
|
|
5764
|
+
* Numpad 5 key
|
|
5765
|
+
*/
|
|
5633
5766
|
NUMPAD_5 = "101",
|
|
5634
|
-
|
|
5767
|
+
/**
|
|
5768
|
+
* Numpad 6 key
|
|
5769
|
+
*/
|
|
5635
5770
|
NUMPAD_6 = "102",
|
|
5636
|
-
|
|
5771
|
+
/**
|
|
5772
|
+
* Numpad 7 key
|
|
5773
|
+
*/
|
|
5637
5774
|
NUMPAD_7 = "103",
|
|
5638
|
-
|
|
5775
|
+
/**
|
|
5776
|
+
* Numpad 8 key
|
|
5777
|
+
*/
|
|
5639
5778
|
NUMPAD_8 = "104",
|
|
5640
|
-
|
|
5779
|
+
/**
|
|
5780
|
+
* Numpad 9 key
|
|
5781
|
+
*/
|
|
5641
5782
|
NUMPAD_9 = "105",
|
|
5642
|
-
|
|
5783
|
+
/**
|
|
5784
|
+
* Numpad asterisk (*) key
|
|
5785
|
+
*/
|
|
5643
5786
|
NUMPAD_ASTERISK = "106",
|
|
5644
|
-
|
|
5787
|
+
/**
|
|
5788
|
+
* Numpad comma/decimal (.) key
|
|
5789
|
+
*/
|
|
5645
5790
|
NUMPAD_COMMA = "110",
|
|
5646
|
-
|
|
5791
|
+
/**
|
|
5792
|
+
* Numpad minus (-) key
|
|
5793
|
+
*/
|
|
5647
5794
|
NUMPAD_MINUS = "109",
|
|
5648
|
-
|
|
5795
|
+
/**
|
|
5796
|
+
* Numpad plus (+) key
|
|
5797
|
+
*/
|
|
5649
5798
|
NUMPAD_PLUS = "107",
|
|
5650
|
-
|
|
5799
|
+
/**
|
|
5800
|
+
* Numpad slash (/) key
|
|
5801
|
+
*/
|
|
5651
5802
|
NUMPAD_SLASH = "111",
|
|
5652
|
-
|
|
5803
|
+
/**
|
|
5804
|
+
* Letter O key
|
|
5805
|
+
*/
|
|
5653
5806
|
O = "79",
|
|
5654
|
-
|
|
5807
|
+
/**
|
|
5808
|
+
* Open bracket ([) key
|
|
5809
|
+
*/
|
|
5655
5810
|
OPEN_BRACKET = "186",
|
|
5656
|
-
|
|
5811
|
+
/**
|
|
5812
|
+
* Letter P key
|
|
5813
|
+
*/
|
|
5657
5814
|
P = "80",
|
|
5658
|
-
|
|
5815
|
+
/**
|
|
5816
|
+
* Page Down key
|
|
5817
|
+
*/
|
|
5659
5818
|
PAGE_DOWN = "34",
|
|
5660
|
-
|
|
5819
|
+
/**
|
|
5820
|
+
* Page Up key
|
|
5821
|
+
*/
|
|
5661
5822
|
PAGE_UP = "33",
|
|
5662
|
-
|
|
5823
|
+
/**
|
|
5824
|
+
* Pipe (|) key
|
|
5825
|
+
*/
|
|
5663
5826
|
PIPE = "191",
|
|
5664
|
-
|
|
5827
|
+
/**
|
|
5828
|
+
* Plus (+) key
|
|
5829
|
+
*/
|
|
5665
5830
|
PLUS = "187",
|
|
5666
|
-
|
|
5831
|
+
/**
|
|
5832
|
+
* Print Screen key
|
|
5833
|
+
*/
|
|
5667
5834
|
PRINT = "44",
|
|
5668
|
-
|
|
5835
|
+
/**
|
|
5836
|
+
* Letter Q key
|
|
5837
|
+
*/
|
|
5669
5838
|
Q = "81",
|
|
5670
|
-
|
|
5839
|
+
/**
|
|
5840
|
+
* Letter R key
|
|
5841
|
+
*/
|
|
5671
5842
|
R = "82",
|
|
5672
|
-
|
|
5843
|
+
/**
|
|
5844
|
+
* Letter S key
|
|
5845
|
+
*/
|
|
5673
5846
|
S = "83",
|
|
5674
|
-
|
|
5847
|
+
/**
|
|
5848
|
+
* Scroll Lock key
|
|
5849
|
+
*/
|
|
5675
5850
|
SCROLL_LOCK = "145",
|
|
5676
|
-
|
|
5851
|
+
/**
|
|
5852
|
+
* Semicolon (;) key
|
|
5853
|
+
*/
|
|
5677
5854
|
SEMICOLON = "192",
|
|
5678
|
-
|
|
5855
|
+
/**
|
|
5856
|
+
* Shift key
|
|
5857
|
+
*/
|
|
5679
5858
|
SHIFT = "16",
|
|
5680
|
-
|
|
5859
|
+
/**
|
|
5860
|
+
* Single quote (') key
|
|
5861
|
+
*/
|
|
5681
5862
|
SINGLE_QUOTE = "222",
|
|
5682
|
-
|
|
5863
|
+
/**
|
|
5864
|
+
* Slash (/) key
|
|
5865
|
+
*/
|
|
5683
5866
|
SLASH = "189",
|
|
5684
|
-
|
|
5867
|
+
/**
|
|
5868
|
+
* Sleep key
|
|
5869
|
+
*/
|
|
5685
5870
|
SLEEP = "95",
|
|
5686
|
-
|
|
5871
|
+
/**
|
|
5872
|
+
* Space bar key
|
|
5873
|
+
*/
|
|
5687
5874
|
SPACE = "32",
|
|
5688
|
-
|
|
5875
|
+
/**
|
|
5876
|
+
* Letter T key
|
|
5877
|
+
*/
|
|
5689
5878
|
T = "84",
|
|
5690
|
-
|
|
5879
|
+
/**
|
|
5880
|
+
* Tab key
|
|
5881
|
+
*/
|
|
5691
5882
|
TAB = "9",
|
|
5692
|
-
|
|
5883
|
+
/**
|
|
5884
|
+
* Turn off key
|
|
5885
|
+
*/
|
|
5693
5886
|
TURN_OFF = "94",
|
|
5694
|
-
|
|
5887
|
+
/**
|
|
5888
|
+
* Letter U key
|
|
5889
|
+
*/
|
|
5695
5890
|
U = "85",
|
|
5696
|
-
|
|
5891
|
+
/**
|
|
5892
|
+
* Letter V key
|
|
5893
|
+
*/
|
|
5697
5894
|
V = "86",
|
|
5698
|
-
|
|
5895
|
+
/**
|
|
5896
|
+
* Letter W key
|
|
5897
|
+
*/
|
|
5699
5898
|
W = "87",
|
|
5700
|
-
|
|
5899
|
+
/**
|
|
5900
|
+
* Windows key (or Meta key on Mac)
|
|
5901
|
+
*/
|
|
5701
5902
|
WINDOWS = "91",
|
|
5702
|
-
|
|
5903
|
+
/**
|
|
5904
|
+
* Letter X key
|
|
5905
|
+
*/
|
|
5703
5906
|
X = "88",
|
|
5704
|
-
|
|
5907
|
+
/**
|
|
5908
|
+
* Letter Y key
|
|
5909
|
+
*/
|
|
5705
5910
|
Y = "89",
|
|
5706
|
-
|
|
5911
|
+
/**
|
|
5912
|
+
* Letter Z key
|
|
5913
|
+
*/
|
|
5707
5914
|
Z = "90",
|
|
5708
5915
|
}
|
|
5709
5916
|
export default KeyCodes;
|
|
@@ -5761,6 +5968,24 @@ declare module "sap/ui/model/FilterProcessor" {
|
|
|
5761
5968
|
* @since 1.71
|
|
5762
5969
|
*/
|
|
5763
5970
|
interface FilterProcessor {
|
|
5971
|
+
/**
|
|
5972
|
+
* Combines control filters and application filters using AND and returns the resulting filter
|
|
5973
|
+
*
|
|
5974
|
+
* @since 1.146.0
|
|
5975
|
+
*
|
|
5976
|
+
* @returns A single filter containing all filters of the arrays combined or `undefined` if no filters are
|
|
5977
|
+
* given
|
|
5978
|
+
*/
|
|
5979
|
+
combineFilters(
|
|
5980
|
+
/**
|
|
5981
|
+
* The control filters
|
|
5982
|
+
*/
|
|
5983
|
+
aFilters?: sap.ui.model.Filter[],
|
|
5984
|
+
/**
|
|
5985
|
+
* The application filters
|
|
5986
|
+
*/
|
|
5987
|
+
aApplicationFilters?: sap.ui.model.Filter[]
|
|
5988
|
+
): sap.ui.model.Filter | undefined;
|
|
5764
5989
|
/**
|
|
5765
5990
|
* Groups filters according to their path and combines filters on the same path using "OR" and filters on
|
|
5766
5991
|
* different paths using "AND", all multi-filters contained are ANDed.
|
|
@@ -10724,7 +10949,7 @@ declare namespace sap {
|
|
|
10724
10949
|
* Returns the application root component.
|
|
10725
10950
|
*
|
|
10726
10951
|
* @since 1.13.1
|
|
10727
|
-
* @deprecated As of version 1.14.
|
|
10952
|
+
* @deprecated As of version 1.14. superseded by {@link sap.ui.core.Component}.
|
|
10728
10953
|
*
|
|
10729
10954
|
* @returns The root component
|
|
10730
10955
|
*/
|
|
@@ -11227,13 +11452,20 @@ declare namespace sap {
|
|
|
11227
11452
|
*/
|
|
11228
11453
|
length?: int;
|
|
11229
11454
|
/**
|
|
11230
|
-
* The initial sort order
|
|
11455
|
+
* The initial sort order
|
|
11231
11456
|
*/
|
|
11232
11457
|
sorter?: sap.ui.model.Sorter | sap.ui.model.Sorter[];
|
|
11233
11458
|
/**
|
|
11234
|
-
* The predefined filters for this aggregation
|
|
11459
|
+
* The predefined {@link sap.ui.model.FilterType.Application application filters} for this aggregation where
|
|
11460
|
+
* filter values are constants.
|
|
11235
11461
|
*/
|
|
11236
11462
|
filters?: sap.ui.model.Filter | sap.ui.model.Filter[];
|
|
11463
|
+
/**
|
|
11464
|
+
* The predefined {@link sap.ui.model.FilterType.ApplicationBound bound application filters} for this aggregation.
|
|
11465
|
+
* Filter values support binding expressions. The aggregation updates its filters whenever a filter value
|
|
11466
|
+
* changes through data binding. Supported since 1.146.0.
|
|
11467
|
+
*/
|
|
11468
|
+
boundFilters?: sap.ui.model.Filter | sap.ui.model.Filter[];
|
|
11237
11469
|
/**
|
|
11238
11470
|
* Name of the key property or a function getting the context as only parameter to calculate a key for entries.
|
|
11239
11471
|
* This can be used to improve update behaviour in models, where a key is not already available.
|
|
@@ -12705,8 +12937,8 @@ declare namespace sap {
|
|
|
12705
12937
|
* ```
|
|
12706
12938
|
*
|
|
12707
12939
|
*
|
|
12708
|
-
* Note that when setting string values, any curly braces in those values need to be escaped,
|
|
12709
|
-
* not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
|
|
12940
|
+
* Note that when setting string values, any curly braces and backslashes in those values need to be escaped,
|
|
12941
|
+
* so they are not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
|
|
12710
12942
|
*
|
|
12711
12943
|
* **Note:** As of version 1.120, providing aggregation content via an object literal is deprecated, in
|
|
12712
12944
|
* case the object's type is given via the property 'Type' as a string, or is derived via the defined type
|
|
@@ -12827,8 +13059,8 @@ declare namespace sap {
|
|
|
12827
13059
|
* ```
|
|
12828
13060
|
*
|
|
12829
13061
|
*
|
|
12830
|
-
* Note that when setting string values, any curly braces in those values need to be escaped,
|
|
12831
|
-
* not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
|
|
13062
|
+
* Note that when setting string values, any curly braces and backslashes in those values need to be escaped,
|
|
13063
|
+
* so they are not interpreted as binding expressions. Use {@link #escapeSettingsValue} to do so.
|
|
12832
13064
|
*
|
|
12833
13065
|
* **Note:** As of version 1.120, providing aggregation content via an object literal is deprecated, in
|
|
12834
13066
|
* case the object's type is given via the property 'Type' as a string, or is derived via the defined type
|
|
@@ -12892,17 +13124,46 @@ declare namespace sap {
|
|
|
12892
13124
|
);
|
|
12893
13125
|
|
|
12894
13126
|
/**
|
|
12895
|
-
* Escapes the given value so it can be used in the constructor's settings object.
|
|
12896
|
-
*
|
|
13127
|
+
* Escapes the given value so it can be used in the constructor's settings object.
|
|
13128
|
+
*
|
|
13129
|
+
* Use this method when passing static string values that might contain binding syntax characters. Without
|
|
13130
|
+
* escaping, curly braces in strings would be misinterpreted as data binding expressions.
|
|
13131
|
+
*
|
|
13132
|
+
* **Characters that are escaped:**
|
|
13133
|
+
* - `{` (opening curly brace) - binding expression start
|
|
13134
|
+
* - `}` (closing curly brace) - binding expression end
|
|
13135
|
+
* - `\` (backslash) - escape character itself
|
|
13136
|
+
*
|
|
13137
|
+
* Each of the above characters is prefixed with a backslash, e.g. `{foo}` becomes `\{foo\}`.
|
|
13138
|
+
*
|
|
13139
|
+
* **When to use:**
|
|
13140
|
+
* - Static string values containing curly braces that should be displayed literally
|
|
13141
|
+
* - Rendering escaped backslashes (e.g. expecting `\\\\` to result in `\\`)
|
|
13142
|
+
* - User input or external data used as property values in constructors
|
|
13143
|
+
* - JSON content that should not be parsed as bindings
|
|
13144
|
+
*
|
|
13145
|
+
* Example usage:
|
|
13146
|
+
* ```javascript
|
|
13147
|
+
*
|
|
13148
|
+
* new MyControl({
|
|
13149
|
+
* // Without escaping: "{info}" would be interpreted as a binding to the path "info"
|
|
13150
|
+
* // With escaping: displays the literal text "{info}"
|
|
13151
|
+
* text: ManagedObject.escapeSettingsValue("{info}")
|
|
13152
|
+
* });
|
|
13153
|
+
* ```
|
|
13154
|
+
*
|
|
13155
|
+
*
|
|
13156
|
+
* **Note:** This is only needed when setting values via the constructor or {@link #applySettings}. Setter
|
|
13157
|
+
* method calls, e.g. `setText("{info}")` do not interpret binding syntax and thus do not require escaping.
|
|
12897
13158
|
*
|
|
12898
13159
|
* @since 1.52
|
|
12899
13160
|
*
|
|
12900
|
-
* @returns The
|
|
12901
|
-
* (or unchanged, if not of type string)
|
|
13161
|
+
* @returns The escaped string value, or the original value if not a string
|
|
12902
13162
|
*/
|
|
12903
13163
|
static escapeSettingsValue(
|
|
12904
13164
|
/**
|
|
12905
|
-
* Value to escape; only
|
|
13165
|
+
* Value to escape; only strings are escaped, other types (e.g. objects) are returned through unchanged.
|
|
13166
|
+
* Strings nested in objects must be escaped individually.
|
|
12906
13167
|
*/
|
|
12907
13168
|
vValue: any
|
|
12908
13169
|
): any;
|
|
@@ -13584,9 +13845,18 @@ declare namespace sap {
|
|
|
13584
13845
|
* Destroys (all) the managed object(s) in the aggregation named `sAggregationName` and empties the aggregation.
|
|
13585
13846
|
* If the aggregation did contain any object, this ManagedObject is marked as changed.
|
|
13586
13847
|
*
|
|
13848
|
+
* **Note:** Destroying an aggregation by calling this method (or indirectly via `destroyXYZ`) does
|
|
13849
|
+
* not call the named aggregation mutators (`setXYZ` for a 0..1 aggregation, `removeXYZ` for
|
|
13850
|
+
* a 0..n aggregation) for the aggregated children. Controls that implement side effects in those methods
|
|
13851
|
+
* therefore must also implement similar side effects in their `destroyXYZ` method.
|
|
13852
|
+
*
|
|
13853
|
+
* While this is understood as inconvenient, it was decided (February 2026, after a thorough investigation),
|
|
13854
|
+
* not to change it. Too many existing controls depend on the current behavior, and, even worse, would have
|
|
13855
|
+
* severe problems with a changed behavior.
|
|
13856
|
+
*
|
|
13587
13857
|
* **Note:** This method is a low-level API as described in the class documentation.
|
|
13588
13858
|
* Applications or frameworks must not use this method to generically destroy all objects in an aggregation.
|
|
13589
|
-
* Use the concrete method destroyXYZ for aggregation 'XYZ' instead.
|
|
13859
|
+
* Use the concrete method `destroyXYZ` for aggregation 'XYZ' instead.
|
|
13590
13860
|
*
|
|
13591
13861
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
13592
13862
|
*
|
|
@@ -23566,7 +23836,8 @@ declare namespace sap {
|
|
|
23566
23836
|
/**
|
|
23567
23837
|
* JS View
|
|
23568
23838
|
*
|
|
23569
|
-
* @deprecated As of version 1.90.
|
|
23839
|
+
* @deprecated As of version 1.90. Consider using {@link sap.ui.core.mvx.XMLView XMLViews} or "typed views"
|
|
23840
|
+
* (view classes written in JavaScript) instead.
|
|
23570
23841
|
*/
|
|
23571
23842
|
JS = "JS",
|
|
23572
23843
|
/**
|
|
@@ -23579,7 +23850,8 @@ declare namespace sap {
|
|
|
23579
23850
|
/**
|
|
23580
23851
|
* Template View
|
|
23581
23852
|
*
|
|
23582
|
-
* @deprecated As of version 1.56.
|
|
23853
|
+
* @deprecated As of version 1.56. Consider using {@link sap.ui.core.mvx.XMLView XMLViews} or "typed views"
|
|
23854
|
+
* (view classes written in JavaScript) instead.
|
|
23583
23855
|
*/
|
|
23584
23856
|
Template = "Template",
|
|
23585
23857
|
/**
|
|
@@ -24786,34 +25058,65 @@ declare namespace sap {
|
|
|
24786
25058
|
* This enum is part of the 'sap/ui/core/Popup' module export and must be accessed by the property 'Dock'.
|
|
24787
25059
|
*/
|
|
24788
25060
|
enum Dock {
|
|
25061
|
+
/**
|
|
25062
|
+
* Docks the popup at the begin of the reference element, at the bottom.
|
|
25063
|
+
*/
|
|
24789
25064
|
BeginBottom = "BeginBottom",
|
|
24790
|
-
|
|
25065
|
+
/**
|
|
25066
|
+
* Docks the popup at the begin of the reference element, vertically centered.
|
|
25067
|
+
*/
|
|
24791
25068
|
BeginCenter = "BeginCenter",
|
|
24792
|
-
|
|
25069
|
+
/**
|
|
25070
|
+
* Docks the popup at the begin of the reference element, at the top.
|
|
25071
|
+
*/
|
|
24793
25072
|
BeginTop = "BeginTop",
|
|
24794
|
-
|
|
25073
|
+
/**
|
|
25074
|
+
* Docks the popup horizontally centered to the reference element, at the bottom.
|
|
25075
|
+
*/
|
|
24795
25076
|
CenterBottom = "CenterBottom",
|
|
24796
|
-
|
|
25077
|
+
/**
|
|
25078
|
+
* Docks the popup horizontally and vertically centered to the reference element.
|
|
25079
|
+
*/
|
|
24797
25080
|
CenterCenter = "CenterCenter",
|
|
24798
|
-
|
|
25081
|
+
/**
|
|
25082
|
+
* Docks the popup horizontally centered to the reference element, at the top.
|
|
25083
|
+
*/
|
|
24799
25084
|
CenterTop = "CenterTop",
|
|
24800
|
-
|
|
25085
|
+
/**
|
|
25086
|
+
* Docks the popup at the end of the reference element, at the bottom.
|
|
25087
|
+
*/
|
|
24801
25088
|
EndBottom = "EndBottom",
|
|
24802
|
-
|
|
25089
|
+
/**
|
|
25090
|
+
* Docks the popup at the end of the reference element, vertically centered.
|
|
25091
|
+
*/
|
|
24803
25092
|
EndCenter = "EndCenter",
|
|
24804
|
-
|
|
25093
|
+
/**
|
|
25094
|
+
* Docks the popup at the end of the reference element, at the top.
|
|
25095
|
+
*/
|
|
24805
25096
|
EndTop = "EndTop",
|
|
24806
|
-
|
|
25097
|
+
/**
|
|
25098
|
+
* Docks the popup at the left side of the reference element, at the bottom.
|
|
25099
|
+
*/
|
|
24807
25100
|
LeftBottom = "LeftBottom",
|
|
24808
|
-
|
|
25101
|
+
/**
|
|
25102
|
+
* Docks the popup at the left side of the reference element, vertically centered.
|
|
25103
|
+
*/
|
|
24809
25104
|
LeftCenter = "LeftCenter",
|
|
24810
|
-
|
|
25105
|
+
/**
|
|
25106
|
+
* Docks the popup at the left side of the reference element, at the top.
|
|
25107
|
+
*/
|
|
24811
25108
|
LeftTop = "LeftTop",
|
|
24812
|
-
|
|
25109
|
+
/**
|
|
25110
|
+
* Docks the popup at the right side of the reference element, at the bottom.
|
|
25111
|
+
*/
|
|
24813
25112
|
RightBottom = "RightBottom",
|
|
24814
|
-
|
|
25113
|
+
/**
|
|
25114
|
+
* Docks the popup at the right side of the reference element, vertically centered.
|
|
25115
|
+
*/
|
|
24815
25116
|
RightCenter = "RightCenter",
|
|
24816
|
-
|
|
25117
|
+
/**
|
|
25118
|
+
* Docks the popup at the right side of the reference element, at the top.
|
|
25119
|
+
*/
|
|
24817
25120
|
RightTop = "RightTop",
|
|
24818
25121
|
}
|
|
24819
25122
|
|
|
@@ -27201,34 +27504,6 @@ declare namespace sap {
|
|
|
27201
27504
|
* @returns Metadata object describing this class
|
|
27202
27505
|
*/
|
|
27203
27506
|
static getMetadata(): sap.ui.base.Metadata;
|
|
27204
|
-
/**
|
|
27205
|
-
* This function is called between the target view is loaded and the view is added to the container.
|
|
27206
|
-
*
|
|
27207
|
-
* This function can be used for applying modification on the view or the container to make the rerendering
|
|
27208
|
-
* occur together with the later aggregation change.
|
|
27209
|
-
*
|
|
27210
|
-
* @since 1.46.1
|
|
27211
|
-
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
27212
|
-
*/
|
|
27213
|
-
_beforePlacingViewIntoContainer(
|
|
27214
|
-
/**
|
|
27215
|
-
* the object containing the arguments
|
|
27216
|
-
*/
|
|
27217
|
-
mArguments: {
|
|
27218
|
-
/**
|
|
27219
|
-
* the container where the view will be added
|
|
27220
|
-
*/
|
|
27221
|
-
container: sap.ui.core.Control;
|
|
27222
|
-
/**
|
|
27223
|
-
* the view which will be added to the container
|
|
27224
|
-
*/
|
|
27225
|
-
view: sap.ui.core.Control;
|
|
27226
|
-
/**
|
|
27227
|
-
* the data passed from {@link sap.ui.core.routing.Target#display} method
|
|
27228
|
-
*/
|
|
27229
|
-
data?: object;
|
|
27230
|
-
}
|
|
27231
|
-
): void;
|
|
27232
27507
|
/**
|
|
27233
27508
|
* Attaches event handler `fnFunction` to the {@link #event:display display} event of this `sap.ui.core.routing.Target`.
|
|
27234
27509
|
*
|
|
@@ -27272,6 +27547,37 @@ declare namespace sap {
|
|
|
27272
27547
|
*/
|
|
27273
27548
|
oListener?: object
|
|
27274
27549
|
): this;
|
|
27550
|
+
/**
|
|
27551
|
+
* This function is called between the target view is loaded and the view is added to the container.
|
|
27552
|
+
*
|
|
27553
|
+
* This function can be used for applying modification on the view or the container to make the rerendering
|
|
27554
|
+
* occur together with the later aggregation change.
|
|
27555
|
+
*
|
|
27556
|
+
* **Note:** This function was previously named `_beforePlacingViewIntoContainer` (with a leading underscore)
|
|
27557
|
+
* and has been renamed to be protected instead of private.
|
|
27558
|
+
*
|
|
27559
|
+
* @since 1.46.1
|
|
27560
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
27561
|
+
*/
|
|
27562
|
+
beforePlacingViewIntoContainer(
|
|
27563
|
+
/**
|
|
27564
|
+
* the object containing the arguments
|
|
27565
|
+
*/
|
|
27566
|
+
mArguments: {
|
|
27567
|
+
/**
|
|
27568
|
+
* the container where the view will be added
|
|
27569
|
+
*/
|
|
27570
|
+
container: sap.ui.core.Control;
|
|
27571
|
+
/**
|
|
27572
|
+
* the view which will be added to the container
|
|
27573
|
+
*/
|
|
27574
|
+
view: sap.ui.core.Control;
|
|
27575
|
+
/**
|
|
27576
|
+
* the data passed from {@link sap.ui.core.routing.Target#display} method
|
|
27577
|
+
*/
|
|
27578
|
+
data?: object;
|
|
27579
|
+
}
|
|
27580
|
+
): void;
|
|
27275
27581
|
/**
|
|
27276
27582
|
* Destroys the target, will be called by {@link sap.m.routing.Targets} don't call this directly.
|
|
27277
27583
|
*
|
|
@@ -30677,16 +30983,29 @@ declare namespace sap {
|
|
|
30677
30983
|
* 'HTTPMETHOD'.
|
|
30678
30984
|
*/
|
|
30679
30985
|
enum HTTPMETHOD {
|
|
30986
|
+
/**
|
|
30987
|
+
* HTTP DELETE method.
|
|
30988
|
+
*/
|
|
30680
30989
|
DELETE = "DELETE",
|
|
30681
|
-
|
|
30990
|
+
/**
|
|
30991
|
+
* HTTP GET method.
|
|
30992
|
+
*/
|
|
30682
30993
|
GET = "GET",
|
|
30683
|
-
|
|
30994
|
+
/**
|
|
30995
|
+
* HTTP MERGE method.
|
|
30996
|
+
*/
|
|
30684
30997
|
MERGE = "MERGE",
|
|
30685
|
-
|
|
30998
|
+
/**
|
|
30999
|
+
* HTTP PATCH method.
|
|
31000
|
+
*/
|
|
30686
31001
|
PATCH = "PATCH",
|
|
30687
|
-
|
|
31002
|
+
/**
|
|
31003
|
+
* HTTP POST method.
|
|
31004
|
+
*/
|
|
30688
31005
|
POST = "POST",
|
|
30689
|
-
|
|
31006
|
+
/**
|
|
31007
|
+
* HTTP PUT method.
|
|
31008
|
+
*/
|
|
30690
31009
|
PUT = "PUT",
|
|
30691
31010
|
}
|
|
30692
31011
|
|
|
@@ -32838,6 +33157,9 @@ declare namespace sap {
|
|
|
32838
33157
|
* 'SUPPORTED_PROTOCOLS'.
|
|
32839
33158
|
*/
|
|
32840
33159
|
enum SUPPORTED_PROTOCOLS {
|
|
33160
|
+
/**
|
|
33161
|
+
* Protocol v10.pcp.sap.com
|
|
33162
|
+
*/
|
|
32841
33163
|
v10 = "v10.pcp.sap.com",
|
|
32842
33164
|
}
|
|
32843
33165
|
}
|
|
@@ -33448,7 +33770,6 @@ declare namespace sap {
|
|
|
33448
33770
|
/**
|
|
33449
33771
|
* Implementing this interface allows a control to be accessible via access keys.
|
|
33450
33772
|
*
|
|
33451
|
-
* @since 1.104
|
|
33452
33773
|
* @experimental As of version 1.104.
|
|
33453
33774
|
*/
|
|
33454
33775
|
interface IAccessKeySupport {
|
|
@@ -33458,21 +33779,18 @@ declare namespace sap {
|
|
|
33458
33779
|
* Returns a refence to DOM element to be focused during Access key navigation. If not implemented getFocusDomRef()
|
|
33459
33780
|
* method is used.
|
|
33460
33781
|
*
|
|
33461
|
-
* @since 1.104
|
|
33462
33782
|
* @experimental As of version 1.104.
|
|
33463
33783
|
*/
|
|
33464
33784
|
getAccessKeysFocusTarget?(): void;
|
|
33465
33785
|
/**
|
|
33466
33786
|
* If implemented called when access keys feature is enabled and highlighting is over
|
|
33467
33787
|
*
|
|
33468
|
-
* @since 1.104
|
|
33469
33788
|
* @experimental As of version 1.104.
|
|
33470
33789
|
*/
|
|
33471
33790
|
onAccKeysHighlightEnd?(): void;
|
|
33472
33791
|
/**
|
|
33473
33792
|
* If implemented called when access keys feature is enabled and highlighting is ongoing
|
|
33474
33793
|
*
|
|
33475
|
-
* @since 1.104
|
|
33476
33794
|
* @experimental As of version 1.104.
|
|
33477
33795
|
*/
|
|
33478
33796
|
onAccKeysHighlightStart?(): void;
|
|
@@ -34209,6 +34527,9 @@ declare namespace sap {
|
|
|
34209
34527
|
* Describes the settings that can be provided to the Fragment constructor.
|
|
34210
34528
|
*/
|
|
34211
34529
|
interface $FragmentSettings extends sap.ui.base.$ManagedObjectSettings {
|
|
34530
|
+
/**
|
|
34531
|
+
* The Fragment type.
|
|
34532
|
+
*/
|
|
34212
34533
|
type?: string | sap.ui.base.ManagedObject.PropertyBindingInfo;
|
|
34213
34534
|
|
|
34214
34535
|
fragmentName?: string;
|
|
@@ -34585,8 +34906,18 @@ declare namespace sap {
|
|
|
34585
34906
|
* Describes the settings that can be provided to the Popup constructor.
|
|
34586
34907
|
*/
|
|
34587
34908
|
interface $PopupSettings extends sap.ui.base.$ManagedObjectSettings {
|
|
34909
|
+
/**
|
|
34910
|
+
* Fired when the popup has completely opened (after any animation).
|
|
34911
|
+
*
|
|
34912
|
+
* @since 1.2
|
|
34913
|
+
*/
|
|
34588
34914
|
opened?: (oEvent: sap.ui.base.Event) => void;
|
|
34589
34915
|
|
|
34916
|
+
/**
|
|
34917
|
+
* Fired when the popup has completely closed (after any animation).
|
|
34918
|
+
*
|
|
34919
|
+
* @since 1.2
|
|
34920
|
+
*/
|
|
34590
34921
|
closed?: (oEvent: sap.ui.base.Event) => void;
|
|
34591
34922
|
}
|
|
34592
34923
|
|
|
@@ -37311,24 +37642,24 @@ declare namespace sap {
|
|
|
37311
37642
|
* ```
|
|
37312
37643
|
*
|
|
37313
37644
|
*
|
|
37314
|
-
* If parts of the theme are at different locations (e.g. because you provide a standard theme like "
|
|
37645
|
+
* If parts of the theme are at different locations (e.g. because you provide a standard theme like "sap_horizon"
|
|
37315
37646
|
* for a custom control library and this self-made part of the standard theme is at a different location
|
|
37316
37647
|
* than the UI5 resources), you can also specify for which control libraries the setting should be used,
|
|
37317
37648
|
* by giving an array with the names of the respective control libraries as second parameter:
|
|
37318
37649
|
* ```javascript
|
|
37319
37650
|
*
|
|
37320
|
-
* sap.ui.getCore().setThemeRoot("
|
|
37651
|
+
* sap.ui.getCore().setThemeRoot("sap_horizon", ["my.own.library"], "https://mythemeserver.com/allThemes");
|
|
37321
37652
|
* ```
|
|
37322
37653
|
*
|
|
37323
37654
|
*
|
|
37324
|
-
* This will cause the
|
|
37655
|
+
* This will cause the Horizon theme to be loaded from the UI5 location for all standard libraries. Resources
|
|
37325
37656
|
* for styling the `my.own.library` controls will be loaded from the configured location:
|
|
37326
37657
|
* ```javascript
|
|
37327
37658
|
*
|
|
37328
|
-
* https://sdk.openui5.org/resources/sap/ui/core/themes/
|
|
37329
|
-
* https://sdk.openui5.org/resources/sap/ui/layout/themes/
|
|
37330
|
-
* https://sdk.openui5.org/resources/sap/m/themes/
|
|
37331
|
-
* https://mythemeserver.com/allThemes/my/own/library/themes/
|
|
37659
|
+
* https://sdk.openui5.org/resources/sap/ui/core/themes/sap_horizon/library.css
|
|
37660
|
+
* https://sdk.openui5.org/resources/sap/ui/layout/themes/sap_horizon/library.css
|
|
37661
|
+
* https://sdk.openui5.org/resources/sap/m/themes/sap_horizon/library.css
|
|
37662
|
+
* https://mythemeserver.com/allThemes/my/own/library/themes/sap_horizon/library.css
|
|
37332
37663
|
* ```
|
|
37333
37664
|
*
|
|
37334
37665
|
*
|
|
@@ -37382,24 +37713,24 @@ declare namespace sap {
|
|
|
37382
37713
|
* ```
|
|
37383
37714
|
*
|
|
37384
37715
|
*
|
|
37385
|
-
* If parts of the theme are at different locations (e.g. because you provide a standard theme like "
|
|
37716
|
+
* If parts of the theme are at different locations (e.g. because you provide a standard theme like "sap_horizon"
|
|
37386
37717
|
* for a custom control library and this self-made part of the standard theme is at a different location
|
|
37387
37718
|
* than the UI5 resources), you can also specify for which control libraries the setting should be used,
|
|
37388
37719
|
* by giving an array with the names of the respective control libraries as second parameter:
|
|
37389
37720
|
* ```javascript
|
|
37390
37721
|
*
|
|
37391
|
-
* sap.ui.getCore().setThemeRoot("
|
|
37722
|
+
* sap.ui.getCore().setThemeRoot("sap_horizon", ["my.own.library"], "https://mythemeserver.com/allThemes");
|
|
37392
37723
|
* ```
|
|
37393
37724
|
*
|
|
37394
37725
|
*
|
|
37395
|
-
* This will cause the
|
|
37726
|
+
* This will cause the Horizon theme to be loaded from the UI5 location for all standard libraries. Resources
|
|
37396
37727
|
* for styling the `my.own.library` controls will be loaded from the configured location:
|
|
37397
37728
|
* ```javascript
|
|
37398
37729
|
*
|
|
37399
|
-
* https://sdk.openui5.org/resources/sap/ui/core/themes/
|
|
37400
|
-
* https://sdk.openui5.org/resources/sap/ui/layout/themes/
|
|
37401
|
-
* https://sdk.openui5.org/resources/sap/m/themes/
|
|
37402
|
-
* https://mythemeserver.com/allThemes/my/own/library/themes/
|
|
37730
|
+
* https://sdk.openui5.org/resources/sap/ui/core/themes/sap_horizon/library.css
|
|
37731
|
+
* https://sdk.openui5.org/resources/sap/ui/layout/themes/sap_horizon/library.css
|
|
37732
|
+
* https://sdk.openui5.org/resources/sap/m/themes/sap_horizon/library.css
|
|
37733
|
+
* https://mythemeserver.com/allThemes/my/own/library/themes/sap_horizon/library.css
|
|
37403
37734
|
* ```
|
|
37404
37735
|
*
|
|
37405
37736
|
*
|
|
@@ -38077,56 +38408,56 @@ declare namespace sap {
|
|
|
38077
38408
|
}
|
|
38078
38409
|
|
|
38079
38410
|
/**
|
|
38411
|
+
* The CommandExecution registers a shortcut when it is added to the dependent aggregation of a control.
|
|
38412
|
+
* The shortcut information is retrieved from the owner components manifest (`/sap.ui5/commands/<command>`).
|
|
38413
|
+
*
|
|
38414
|
+
* You can use a CommandExecution instead of an event handler in XMLViews by using `cmd:` plus the command
|
|
38415
|
+
* name.
|
|
38416
|
+
*
|
|
38417
|
+
* Example for `sap.m.Button`:
|
|
38418
|
+
*
|
|
38419
|
+
*
|
|
38420
|
+
* ```javascript
|
|
38421
|
+
*
|
|
38422
|
+
* <Button press="cmd:MyCommand" />
|
|
38423
|
+
* ```
|
|
38424
|
+
*
|
|
38425
|
+
*
|
|
38426
|
+
* When the press event is fired, the CommandExecution will be triggered and the `execute` event is fired.
|
|
38427
|
+
*
|
|
38428
|
+
* When using commands, the component will create a model named `$cmd`. The model data provides the enabled
|
|
38429
|
+
* and visible state of all CommandExecutions. With that, action-triggering controls (e.g. a button) can
|
|
38430
|
+
* be bound to the enable/visible property of the CommandExecution to centrally control their state.
|
|
38431
|
+
*
|
|
38432
|
+
* **Note: The usage of the `$cmd` model is restricted to `sap.suite.ui.generic`**
|
|
38433
|
+
*
|
|
38434
|
+
* When binding a button's enabled state to this model, it follows the enabled state of the CommandExecution.
|
|
38435
|
+
* The binding path must be relative like `myCommand/enabled`:
|
|
38436
|
+
*
|
|
38437
|
+
*
|
|
38438
|
+
* ```javascript
|
|
38439
|
+
*
|
|
38440
|
+
* <Button press="cmd:MyCommand" enabled="$cmd>MyCommand/enabled" />
|
|
38441
|
+
* ```
|
|
38442
|
+
*
|
|
38443
|
+
*
|
|
38444
|
+
* A CommandExecution can have three states:
|
|
38445
|
+
* - the CommandExecution is visible and enabled. If the configured shortcut is executed, the configured
|
|
38446
|
+
* event handler of this CommandExecution is called
|
|
38447
|
+
* - the CommandExecution is visible but not enabled. If the configured shortcut is executed, neither
|
|
38448
|
+
* the configured event handler of this CommandExecution nor any event handler configured on CommandExecutions
|
|
38449
|
+
* in the ancestor chain is called
|
|
38450
|
+
* - the CommandExecution is not visible. If the configured shortcut is executed, the configured event
|
|
38451
|
+
* handler of this CommandExecution is not called, but the event is propagated to its parent, which can
|
|
38452
|
+
* then handle the event by a configured CommandExecution or propagate the event to its parent, until no
|
|
38453
|
+
* parent exits anymore and the browser can handle the executed shortcut
|
|
38454
|
+
*
|
|
38080
38455
|
* @since 1.70
|
|
38081
38456
|
*/
|
|
38082
38457
|
class CommandExecution extends sap.ui.core.Element {
|
|
38083
38458
|
/**
|
|
38084
38459
|
* Creates and initializes a new CommandExecution.
|
|
38085
38460
|
*
|
|
38086
|
-
* The CommandExecution registers a shortcut when it is added to the dependent aggregation of a control.
|
|
38087
|
-
* The shortcut information is retrieved from the owner components manifest (`/sap.ui5/commands/<command>`).
|
|
38088
|
-
*
|
|
38089
|
-
* You can use a CommandExecution instead of an event handler in XMLViews by using `cmd:` plus the command
|
|
38090
|
-
* name.
|
|
38091
|
-
*
|
|
38092
|
-
* Example for `sap.m.Button`:
|
|
38093
|
-
*
|
|
38094
|
-
*
|
|
38095
|
-
* ```javascript
|
|
38096
|
-
*
|
|
38097
|
-
* <Button press="cmd:MyCommand" />
|
|
38098
|
-
* ```
|
|
38099
|
-
*
|
|
38100
|
-
*
|
|
38101
|
-
* When the press event is fired, the CommandExecution will be triggered and the `execute` event is fired.
|
|
38102
|
-
*
|
|
38103
|
-
* When using commands, the component will create a model named `$cmd`. The model data provides the enabled
|
|
38104
|
-
* and visible state of all CommandExecutions. With that, action-triggering controls (e.g. a button) can
|
|
38105
|
-
* be bound to the enable/visible property of the CommandExecution to centrally control their state.
|
|
38106
|
-
*
|
|
38107
|
-
* **Note: The usage of the `$cmd` model is restricted to `sap.suite.ui.generic`**
|
|
38108
|
-
*
|
|
38109
|
-
* When binding a button's enabled state to this model, it follows the enabled state of the CommandExecution.
|
|
38110
|
-
* The binding path must be relative like `myCommand/enabled`:
|
|
38111
|
-
*
|
|
38112
|
-
*
|
|
38113
|
-
* ```javascript
|
|
38114
|
-
*
|
|
38115
|
-
* <Button press="cmd:MyCommand" enabled="$cmd>MyCommand/enabled" />
|
|
38116
|
-
* ```
|
|
38117
|
-
*
|
|
38118
|
-
*
|
|
38119
|
-
* A CommandExecution can have three states:
|
|
38120
|
-
* - the CommandExecution is visible and enabled. If the configured shortcut is executed, the configured
|
|
38121
|
-
* event handler of this CommandExecution is called
|
|
38122
|
-
* - the CommandExecution is visible but not enabled. If the configured shortcut is executed, neither
|
|
38123
|
-
* the configured event handler of this CommandExecution nor any event handler configured on CommandExecutions
|
|
38124
|
-
* in the ancestor chain is called
|
|
38125
|
-
* - the CommandExecution is not visible. If the configured shortcut is executed, the configured event
|
|
38126
|
-
* handler of this CommandExecution is not called, but the event is propagated to its parent, which can
|
|
38127
|
-
* then handle the event by a configured CommandExecution or propagate the event to its parent, until no
|
|
38128
|
-
* parent exits anymore and the browser can handle the executed shortcut
|
|
38129
|
-
*
|
|
38130
38461
|
* Accepts an object literal `mSettings` that defines initial property values, aggregated and associated
|
|
38131
38462
|
* objects as well as event handlers. See {@link sap.ui.base.ManagedObject#constructor} for a general description
|
|
38132
38463
|
* of the syntax of the settings object.
|
|
@@ -42845,6 +43176,8 @@ declare namespace sap {
|
|
|
42845
43176
|
/**
|
|
42846
43177
|
* Gets current value of property {@link #getType type}.
|
|
42847
43178
|
*
|
|
43179
|
+
* The Fragment type.
|
|
43180
|
+
*
|
|
42848
43181
|
*
|
|
42849
43182
|
* @returns Value of property `type`
|
|
42850
43183
|
*/
|
|
@@ -42852,6 +43185,8 @@ declare namespace sap {
|
|
|
42852
43185
|
/**
|
|
42853
43186
|
* Sets a new value for property {@link #getType type}.
|
|
42854
43187
|
*
|
|
43188
|
+
* The Fragment type.
|
|
43189
|
+
*
|
|
42855
43190
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
42856
43191
|
*
|
|
42857
43192
|
*
|
|
@@ -44648,8 +44983,9 @@ declare namespace sap {
|
|
|
44648
44983
|
* is e.g. useful when an application merges the CSS for multiple libraries and already loaded the resulting
|
|
44649
44984
|
* stylesheet.
|
|
44650
44985
|
*
|
|
44651
|
-
*
|
|
44652
|
-
*
|
|
44986
|
+
*
|
|
44987
|
+
* - If a list of library `dependencies` is specified in the info object, those libraries will be loaded
|
|
44988
|
+
* synchronously if they haven't been loaded yet.
|
|
44653
44989
|
*
|
|
44654
44990
|
* **Note:** Dependencies between libraries have to be modeled consistently in several places:
|
|
44655
44991
|
* - Both eager and lazy dependencies have to be modelled in the `.library` file.
|
|
@@ -44680,10 +45016,72 @@ declare namespace sap {
|
|
|
44680
45016
|
* Library API-Version 2:
|
|
44681
45017
|
*
|
|
44682
45018
|
* The Library API Version 2 has been introduced to avoid access to the global namespace when retrieving
|
|
44683
|
-
* enum types. With Library API Version 2 a library must declare its enum types via {@link
|
|
45019
|
+
* enum types. With Library API Version 2 a library must declare its enum types via {@link sap.ui.base.DataType.registerEnum }
|
|
45020
|
+
* as described in the "Defining Enums" section below.
|
|
45021
|
+
*
|
|
45022
|
+
* Library API version 2 is defined as a number (int) in the library's `init()` call:
|
|
45023
|
+
* ```javascript
|
|
45024
|
+
*
|
|
45025
|
+
* var thisLib = Library.init({
|
|
45026
|
+
* apiVersion: 2,
|
|
45027
|
+
* name: "my.library",
|
|
45028
|
+
* ...
|
|
45029
|
+
* });
|
|
45030
|
+
* ```
|
|
45031
|
+
*
|
|
45032
|
+
*
|
|
45033
|
+
* **Important:** The object returned by `Library.init()` should be used as the return value of the `library.js`
|
|
45034
|
+
* module.
|
|
45035
|
+
*
|
|
45036
|
+
* **Defining Enums**
|
|
45037
|
+
*
|
|
45038
|
+
* Enums that are exposed through a library (not as separate modules) should be defined as properties on
|
|
45039
|
+
* the object returned by `Library.init()`. Each enum must be registered via {@link sap.ui.base.DataType.registerEnum }
|
|
45040
|
+
* to make it available to the framework.
|
|
45041
|
+
*
|
|
45042
|
+
* Example for a simple enum definition:
|
|
45043
|
+
* ```javascript
|
|
45044
|
+
*
|
|
45045
|
+
* // The return value "thisLib" will be used to expose enums
|
|
45046
|
+
* var thisLib = Library.init({
|
|
45047
|
+
* apiVersion: 2,
|
|
45048
|
+
* name: "my.library",
|
|
45049
|
+
* ...
|
|
45050
|
+
* });
|
|
45051
|
+
*
|
|
45052
|
+
* // Note that enum keys and values must match
|
|
45053
|
+
* thisLib.MyEnumType = {
|
|
45054
|
+
* Small: "Small",
|
|
45055
|
+
* Medium: "Medium",
|
|
45056
|
+
* Large: "Large"
|
|
45057
|
+
* };
|
|
45058
|
+
*
|
|
45059
|
+
* // make sure to register the enum and make it know to the framework for later type checks
|
|
45060
|
+
* DataType.registerEnum("my.library.MyEnumType", thisLib.MyEnumType);
|
|
45061
|
+
* ```
|
|
45062
|
+
*
|
|
45063
|
+
*
|
|
45064
|
+
* **Special case: enums in nested namespaces**
|
|
45065
|
+
*
|
|
45066
|
+
* Ensure to create the namespace first and then define the enum:
|
|
44684
45067
|
*
|
|
44685
45068
|
*
|
|
44686
|
-
*
|
|
45069
|
+
* ```javascript
|
|
45070
|
+
*
|
|
45071
|
+
* thisLib.cards = thisLib.cards || {};
|
|
45072
|
+
*
|
|
45073
|
+
* thisLib.cards.HeaderPosition = {
|
|
45074
|
+
* Top: "Top",
|
|
45075
|
+
* Bottom: "Bottom"
|
|
45076
|
+
* };
|
|
45077
|
+
*
|
|
45078
|
+
* DataType.registerEnum("my.library.cards.HeaderPosition", thisLib.cards.HeaderPosition);
|
|
45079
|
+
* ```
|
|
45080
|
+
*
|
|
45081
|
+
*
|
|
45082
|
+
*
|
|
45083
|
+
* @returns Returns an object with the exports of the library (enums, helpers, ...). This object should
|
|
45084
|
+
* be used as the return value of the `library.js` module from which `Library.init` is called.
|
|
44687
45085
|
*/
|
|
44688
45086
|
static init(
|
|
44689
45087
|
/**
|
|
@@ -47087,6 +47485,9 @@ declare namespace sap {
|
|
|
47087
47485
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
47088
47486
|
* otherwise it will be bound to this `sap.ui.core.Popup` itself.
|
|
47089
47487
|
*
|
|
47488
|
+
* Fired when the popup has completely closed (after any animation).
|
|
47489
|
+
*
|
|
47490
|
+
* @since 1.2
|
|
47090
47491
|
*
|
|
47091
47492
|
* @returns Reference to `this` in order to allow method chaining
|
|
47092
47493
|
*/
|
|
@@ -47111,6 +47512,9 @@ declare namespace sap {
|
|
|
47111
47512
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
47112
47513
|
* otherwise it will be bound to this `sap.ui.core.Popup` itself.
|
|
47113
47514
|
*
|
|
47515
|
+
* Fired when the popup has completely closed (after any animation).
|
|
47516
|
+
*
|
|
47517
|
+
* @since 1.2
|
|
47114
47518
|
*
|
|
47115
47519
|
* @returns Reference to `this` in order to allow method chaining
|
|
47116
47520
|
*/
|
|
@@ -47130,6 +47534,9 @@ declare namespace sap {
|
|
|
47130
47534
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
47131
47535
|
* otherwise it will be bound to this `sap.ui.core.Popup` itself.
|
|
47132
47536
|
*
|
|
47537
|
+
* Fired when the popup has completely opened (after any animation).
|
|
47538
|
+
*
|
|
47539
|
+
* @since 1.2
|
|
47133
47540
|
*
|
|
47134
47541
|
* @returns Reference to `this` in order to allow method chaining
|
|
47135
47542
|
*/
|
|
@@ -47154,6 +47561,9 @@ declare namespace sap {
|
|
|
47154
47561
|
* When called, the context of the event handler (its `this`) will be bound to `oListener` if specified,
|
|
47155
47562
|
* otherwise it will be bound to this `sap.ui.core.Popup` itself.
|
|
47156
47563
|
*
|
|
47564
|
+
* Fired when the popup has completely opened (after any animation).
|
|
47565
|
+
*
|
|
47566
|
+
* @since 1.2
|
|
47157
47567
|
*
|
|
47158
47568
|
* @returns Reference to `this` in order to allow method chaining
|
|
47159
47569
|
*/
|
|
@@ -47191,6 +47601,7 @@ declare namespace sap {
|
|
|
47191
47601
|
*
|
|
47192
47602
|
* The passed function and listener object must match the ones used for event registration.
|
|
47193
47603
|
*
|
|
47604
|
+
* @since 1.2
|
|
47194
47605
|
*
|
|
47195
47606
|
* @returns Reference to `this` in order to allow method chaining
|
|
47196
47607
|
*/
|
|
@@ -47209,6 +47620,7 @@ declare namespace sap {
|
|
|
47209
47620
|
*
|
|
47210
47621
|
* The passed function and listener object must match the ones used for event registration.
|
|
47211
47622
|
*
|
|
47623
|
+
* @since 1.2
|
|
47212
47624
|
*
|
|
47213
47625
|
* @returns Reference to `this` in order to allow method chaining
|
|
47214
47626
|
*/
|
|
@@ -47230,6 +47642,7 @@ declare namespace sap {
|
|
|
47230
47642
|
/**
|
|
47231
47643
|
* Fires event {@link #event:closed closed} to attached listeners.
|
|
47232
47644
|
*
|
|
47645
|
+
* @since 1.2
|
|
47233
47646
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
47234
47647
|
*
|
|
47235
47648
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -47243,6 +47656,7 @@ declare namespace sap {
|
|
|
47243
47656
|
/**
|
|
47244
47657
|
* Fires event {@link #event:opened opened} to attached listeners.
|
|
47245
47658
|
*
|
|
47659
|
+
* @since 1.2
|
|
47246
47660
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
47247
47661
|
*
|
|
47248
47662
|
* @returns Reference to `this` in order to allow method chaining
|
|
@@ -48312,6 +48726,59 @@ declare namespace sap {
|
|
|
48312
48726
|
*/
|
|
48313
48727
|
oTargetDomNode: /* was Element */ global_Element
|
|
48314
48728
|
): void;
|
|
48729
|
+
/**
|
|
48730
|
+
* Executes a rendering callback and flushes the result into the provided DOM node.
|
|
48731
|
+
*
|
|
48732
|
+
* The rendering callback receives a RenderManager instance with the semantic rendering API implementation
|
|
48733
|
+
* (DOM interface methods like `openStart`, `attr`, `openEnd`, `text`, `close`, etc.).
|
|
48734
|
+
*
|
|
48735
|
+
* This method combines rendering and flushing in a single call, automatically handling non-HTML namespaces
|
|
48736
|
+
* (e.g., SVG, MathML) by detecting the namespace of the target DOM node.
|
|
48737
|
+
*
|
|
48738
|
+
* **Difference from calling render() then flush() separately:** When rendering into a non-HTML namespace
|
|
48739
|
+
* context (e.g., SVG or MathML elements), this method automatically detects the target node's namespace
|
|
48740
|
+
* and applies it as a fallback namespace for the rendering operation. This ensures that elements created
|
|
48741
|
+
* without an explicit parent element (such as when rendering into a DocumentFragment initially) inherit
|
|
48742
|
+
* the correct namespace.
|
|
48743
|
+
*
|
|
48744
|
+
* This function must not be called within control renderers.
|
|
48745
|
+
*
|
|
48746
|
+
* Usage:
|
|
48747
|
+
* ```javascript
|
|
48748
|
+
*
|
|
48749
|
+
* const oRM = new RenderManager().getInterface();
|
|
48750
|
+
*
|
|
48751
|
+
* // assume that oSvgContainer is already part of the DOM and we want to render a circle into it
|
|
48752
|
+
* oRM.renderAndFlush(function(oRM) {
|
|
48753
|
+
* oRM.openStart("circle").attr("cx", "50").attr("cy", "50").attr("r", "40");
|
|
48754
|
+
* oRM.openEnd();
|
|
48755
|
+
* oRM.close("circle");
|
|
48756
|
+
* }, oSvgContainer);
|
|
48757
|
+
*
|
|
48758
|
+
* oRM.destroy();
|
|
48759
|
+
* ```
|
|
48760
|
+
*
|
|
48761
|
+
*
|
|
48762
|
+
* @since 1.147
|
|
48763
|
+
*
|
|
48764
|
+
* @returns Reference to `this` to allow method chaining
|
|
48765
|
+
*/
|
|
48766
|
+
renderAndFlush(
|
|
48767
|
+
/**
|
|
48768
|
+
* Rendering callback that receives a RenderManager instance with the semantic rendering API implementation
|
|
48769
|
+
* (DOM interface methods like `openStart`, `attr`, `openEnd`, `text`, `close`, etc.)
|
|
48770
|
+
*/
|
|
48771
|
+
fnRender: (p1: sap.ui.core.RenderManager) => void,
|
|
48772
|
+
/**
|
|
48773
|
+
* Node in the DOM where the result should be flushed into
|
|
48774
|
+
*/
|
|
48775
|
+
oTargetDomNode: /* was Element */ global_Element,
|
|
48776
|
+
/**
|
|
48777
|
+
* Determines whether the buffer of the target DOM node is expanded (`true`) or replaced (`false`), or the
|
|
48778
|
+
* new entry is inserted at a specific position (value of type `int`)
|
|
48779
|
+
*/
|
|
48780
|
+
vInsert?: boolean | int
|
|
48781
|
+
): this;
|
|
48315
48782
|
/**
|
|
48316
48783
|
* Turns the given control into its HTML representation and appends it to the rendering buffer.
|
|
48317
48784
|
*
|
|
@@ -55395,47 +55862,15 @@ declare namespace sap {
|
|
|
55395
55862
|
*/
|
|
55396
55863
|
namespace json {
|
|
55397
55864
|
/**
|
|
55398
|
-
* List binding implementation for JSON
|
|
55865
|
+
* List binding implementation for JSON model.
|
|
55399
55866
|
*
|
|
55400
55867
|
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
55401
55868
|
*/
|
|
55402
55869
|
class JSONListBinding extends sap.ui.model.ClientListBinding {
|
|
55403
55870
|
/**
|
|
55404
|
-
* Creates a new JSONListBinding.
|
|
55405
|
-
*
|
|
55406
|
-
* This constructor should only be called by subclasses or model implementations, not by application or
|
|
55407
|
-
* control code. Such code should use {@link sap.ui.model.json.JSONModel#bindList JSONModel#bindList} on
|
|
55408
|
-
* the corresponding model instance instead.
|
|
55409
|
-
*
|
|
55410
55871
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
55411
55872
|
*/
|
|
55412
|
-
protected constructor(
|
|
55413
|
-
/**
|
|
55414
|
-
* Model instance that this binding is created for and that it belongs to
|
|
55415
|
-
*/
|
|
55416
|
-
oModel: sap.ui.model.json.JSONModel,
|
|
55417
|
-
/**
|
|
55418
|
-
* Binding path to be used for this binding
|
|
55419
|
-
*/
|
|
55420
|
-
sPath: string,
|
|
55421
|
-
/**
|
|
55422
|
-
* Binding context relative to which a relative binding path will be resolved
|
|
55423
|
-
*/
|
|
55424
|
-
oContext: sap.ui.model.Context,
|
|
55425
|
-
/**
|
|
55426
|
-
* The sorters used initially; call {@link #sort} to replace them
|
|
55427
|
-
*/
|
|
55428
|
-
aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
|
|
55429
|
-
/**
|
|
55430
|
-
* The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
|
|
55431
|
-
* to replace them
|
|
55432
|
-
*/
|
|
55433
|
-
aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
|
|
55434
|
-
/**
|
|
55435
|
-
* Map of optional parameters as defined by subclasses; this class does not introduce any own parameters
|
|
55436
|
-
*/
|
|
55437
|
-
mParameters?: object
|
|
55438
|
-
);
|
|
55873
|
+
protected constructor();
|
|
55439
55874
|
}
|
|
55440
55875
|
/**
|
|
55441
55876
|
* Model implementation for the JSON format.
|
|
@@ -55535,6 +55970,107 @@ declare namespace sap {
|
|
|
55535
55970
|
*/
|
|
55536
55971
|
oContext?: sap.ui.model.Context
|
|
55537
55972
|
): any | null | undefined;
|
|
55973
|
+
/**
|
|
55974
|
+
* Creates a new {@link sap.ui.model.json.JSONListBinding}.
|
|
55975
|
+
*
|
|
55976
|
+
*
|
|
55977
|
+
* @returns The newly created JSONListBinding
|
|
55978
|
+
*/
|
|
55979
|
+
bindList(
|
|
55980
|
+
/**
|
|
55981
|
+
* The path to the list or array to bind
|
|
55982
|
+
*/
|
|
55983
|
+
sPath: string,
|
|
55984
|
+
/**
|
|
55985
|
+
* The context for the binding. This is mandatory when a relative binding path is provided.
|
|
55986
|
+
*/
|
|
55987
|
+
oContext?: sap.ui.model.Context,
|
|
55988
|
+
/**
|
|
55989
|
+
* The sorters used initially. To replace them, call {@link sap.ui.model.ListBinding#sort}.
|
|
55990
|
+
*/
|
|
55991
|
+
aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter,
|
|
55992
|
+
/**
|
|
55993
|
+
* The filters initially used with type {@link sap.ui.model.FilterType.Application}. To replace them, call
|
|
55994
|
+
* {@link sap.ui.model.ListBinding#filter}.
|
|
55995
|
+
*/
|
|
55996
|
+
aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
|
|
55997
|
+
/**
|
|
55998
|
+
* Map of optional parameters as defined by subclasses. This class does not introduce any own parameters.
|
|
55999
|
+
*/
|
|
56000
|
+
mParameters?: Record<string, any>
|
|
56001
|
+
): sap.ui.model.json.JSONListBinding;
|
|
56002
|
+
/**
|
|
56003
|
+
* Creates a new {@link sap.ui.model.json.JSONPropertyBinding}.
|
|
56004
|
+
*
|
|
56005
|
+
*
|
|
56006
|
+
* @returns The newly created JSONPropertyBinding
|
|
56007
|
+
*/
|
|
56008
|
+
bindProperty(
|
|
56009
|
+
/**
|
|
56010
|
+
* The path to the property to bind
|
|
56011
|
+
*/
|
|
56012
|
+
sPath: string,
|
|
56013
|
+
/**
|
|
56014
|
+
* The context for the binding. This is mandatory when a relative binding path is provided.
|
|
56015
|
+
*/
|
|
56016
|
+
oContext?: sap.ui.model.Context,
|
|
56017
|
+
/**
|
|
56018
|
+
* Additional model-specific parameters
|
|
56019
|
+
*/
|
|
56020
|
+
mParameters?: {
|
|
56021
|
+
/**
|
|
56022
|
+
* Whether this binding ignores model messages instead of propagating them to the control. Supported since
|
|
56023
|
+
* 1.119.0. Some composite types like {@link sap.ui.model.type.Currency} automatically ignore model messages
|
|
56024
|
+
* for some of their parts, depending on their format options. Setting this parameter to `true` or `false`
|
|
56025
|
+
* overrules the automatism of the type.
|
|
56026
|
+
*
|
|
56027
|
+
* **Example:** A binding for a currency code is used in a composite binding for rendering the proper number
|
|
56028
|
+
* of decimals, but the currency code itself is not displayed in the attached control. In this case, messages
|
|
56029
|
+
* for the currency code aren't displayed at that control, only messages for the amount.
|
|
56030
|
+
*/
|
|
56031
|
+
ignoreMessages?: boolean;
|
|
56032
|
+
}
|
|
56033
|
+
): sap.ui.model.json.JSONPropertyBinding;
|
|
56034
|
+
/**
|
|
56035
|
+
* Creates a new {@link sap.ui.model.json.JSONTreeBinding}. The bound data can contain JSON objects and
|
|
56036
|
+
* arrays. Both are used to build the tree structure.
|
|
56037
|
+
*
|
|
56038
|
+
*
|
|
56039
|
+
* @returns The newly created JSONTreeBinding
|
|
56040
|
+
*/
|
|
56041
|
+
bindTree(
|
|
56042
|
+
/**
|
|
56043
|
+
* The path pointing to the tree or array that is bound
|
|
56044
|
+
*/
|
|
56045
|
+
sPath: string,
|
|
56046
|
+
/**
|
|
56047
|
+
* The context for the binding. This is mandatory when a relative binding path is provided.
|
|
56048
|
+
*/
|
|
56049
|
+
oContext?: sap.ui.model.Context,
|
|
56050
|
+
/**
|
|
56051
|
+
* The filters initially used with type {@link sap.ui.model.FilterType.Application}. To replace them, call
|
|
56052
|
+
* {@link sap.ui.model.TreeBinding#filter}.
|
|
56053
|
+
*/
|
|
56054
|
+
aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
|
|
56055
|
+
/**
|
|
56056
|
+
* Additional model-specific parameters
|
|
56057
|
+
*/
|
|
56058
|
+
mParameters?: {
|
|
56059
|
+
/**
|
|
56060
|
+
* Keys of arrays to be used for building the tree structure. If not specified, all arrays and objects in
|
|
56061
|
+
* the bound data are used. Note: For arrays nested within other arrays with different names, add both array
|
|
56062
|
+
* names to `arrayNames`. To include a nested array in the hierarchy, you must list the names of all containing
|
|
56063
|
+
* arrays. If an array name is missing from the list, its child arrays are also excluded from the hierarchy,
|
|
56064
|
+
* even if you add them to `arrayNames`. If this parameter is set, all other objects and arrays in the bound
|
|
56065
|
+
* data are ignored.
|
|
56066
|
+
*/
|
|
56067
|
+
arrayNames?: string[];
|
|
56068
|
+
},
|
|
56069
|
+
/**
|
|
56070
|
+
* The sorters used initially. To replace them, call {@link sap.ui.model.TreeBinding#sort}.
|
|
56071
|
+
*/
|
|
56072
|
+
aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter
|
|
56073
|
+
): sap.ui.model.json.JSONTreeBinding;
|
|
55538
56074
|
/**
|
|
55539
56075
|
* Returns a Promise of the current data-loading state. Every currently running {@link sap.ui.model.json.JSONModel#loadData }
|
|
55540
56076
|
* call is respected by the returned Promise. This also includes a potential loadData call from the JSONModel's
|
|
@@ -55678,38 +56214,15 @@ declare namespace sap {
|
|
|
55678
56214
|
): boolean;
|
|
55679
56215
|
}
|
|
55680
56216
|
/**
|
|
55681
|
-
* Property binding implementation for JSON
|
|
56217
|
+
* Property binding implementation for JSON model.
|
|
55682
56218
|
*
|
|
55683
56219
|
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
55684
56220
|
*/
|
|
55685
56221
|
class JSONPropertyBinding extends sap.ui.model.ClientPropertyBinding {
|
|
55686
56222
|
/**
|
|
55687
|
-
* Creates a new JSONListBinding.
|
|
55688
|
-
*
|
|
55689
|
-
* This constructor should only be called by subclasses or model implementations, not by application or
|
|
55690
|
-
* control code. Such code should use {@link sap.ui.model.json.JSONModel#bindProperty JSONModel#bindProperty }
|
|
55691
|
-
* on the corresponding model instance instead.
|
|
55692
|
-
*
|
|
55693
56223
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
55694
56224
|
*/
|
|
55695
|
-
protected constructor(
|
|
55696
|
-
/**
|
|
55697
|
-
* Model instance that this binding is created for and that it belongs to
|
|
55698
|
-
*/
|
|
55699
|
-
oModel: sap.ui.model.json.JSONModel,
|
|
55700
|
-
/**
|
|
55701
|
-
* Binding path to be used for this binding
|
|
55702
|
-
*/
|
|
55703
|
-
sPath: string,
|
|
55704
|
-
/**
|
|
55705
|
-
* Binding context relative to which a relative binding path will be resolved
|
|
55706
|
-
*/
|
|
55707
|
-
oContext: sap.ui.model.Context,
|
|
55708
|
-
/**
|
|
55709
|
-
* Map of optional parameters as defined by subclasses; this class does not introduce any own parameters
|
|
55710
|
-
*/
|
|
55711
|
-
mParameters?: object
|
|
55712
|
-
);
|
|
56225
|
+
protected constructor();
|
|
55713
56226
|
|
|
55714
56227
|
/**
|
|
55715
56228
|
* Creates a new subclass of class sap.ui.model.json.JSONPropertyBinding with name `sClassName` and enriches
|
|
@@ -55749,59 +56262,15 @@ declare namespace sap {
|
|
|
55749
56262
|
static getMetadata(): sap.ui.base.Metadata;
|
|
55750
56263
|
}
|
|
55751
56264
|
/**
|
|
55752
|
-
* Tree binding implementation for JSON
|
|
55753
|
-
*
|
|
55754
|
-
* The bound data can contain JSON objects and arrays. Both will be used to build the tree structure. You
|
|
55755
|
-
* can optionally define a set of arrays to be used for the tree structure in the parameter `arrayNames`.
|
|
55756
|
-
* If this parameter is set, all other objects and arrays will be ignored.
|
|
56265
|
+
* Tree binding implementation for JSON model. See {@link sap.ui.model.json.JSONModel#bindTree}
|
|
55757
56266
|
*
|
|
55758
56267
|
* @ui5-protected DO NOT USE IN APPLICATIONS (only for related classes in the framework)
|
|
55759
56268
|
*/
|
|
55760
56269
|
class JSONTreeBinding extends sap.ui.model.ClientTreeBinding {
|
|
55761
56270
|
/**
|
|
55762
|
-
* Creates a new JSONListBinding.
|
|
55763
|
-
*
|
|
55764
|
-
* This constructor should only be called by subclasses or model implementations, not by application or
|
|
55765
|
-
* control code. Such code should use {@link sap.ui.model.json.JSONModel#bindTree JSONModel#bindTree} on
|
|
55766
|
-
* the corresponding model instance instead.
|
|
55767
|
-
*
|
|
55768
56271
|
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
55769
56272
|
*/
|
|
55770
|
-
protected constructor(
|
|
55771
|
-
/**
|
|
55772
|
-
* Model instance that this binding is created for and that it belongs to
|
|
55773
|
-
*/
|
|
55774
|
-
oModel: sap.ui.model.json.JSONModel,
|
|
55775
|
-
/**
|
|
55776
|
-
* Path pointing to the tree or array that should be bound
|
|
55777
|
-
*/
|
|
55778
|
-
sPath: string,
|
|
55779
|
-
/**
|
|
55780
|
-
* Context object for this binding, mandatory when a relative binding path is given
|
|
55781
|
-
*/
|
|
55782
|
-
oContext?: object,
|
|
55783
|
-
/**
|
|
55784
|
-
* The filters to be used initially with type {@link sap.ui.model.FilterType.Application}; call {@link #filter }
|
|
55785
|
-
* to replace them
|
|
55786
|
-
*/
|
|
55787
|
-
aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
|
|
55788
|
-
/**
|
|
55789
|
-
* Additional model-specific parameters
|
|
55790
|
-
*/
|
|
55791
|
-
mParameters?: {
|
|
55792
|
-
/**
|
|
55793
|
-
* Keys of arrays to be used for building the tree structure. If not specified, all arrays and objects in
|
|
55794
|
-
* the bound data will be used. Note that for arrays nested inside differently named arrays, you need to
|
|
55795
|
-
* add both to `arrayNames`. You always have to add the complete parent chain. If any array is ignored,
|
|
55796
|
-
* its child arrays will be ignored as well even if they have been added to `arrayNames`.
|
|
55797
|
-
*/
|
|
55798
|
-
arrayNames?: string[];
|
|
55799
|
-
},
|
|
55800
|
-
/**
|
|
55801
|
-
* The sorters used initially; call {@link #sort} to replace them
|
|
55802
|
-
*/
|
|
55803
|
-
aSorters?: sap.ui.model.Sorter[] | sap.ui.model.Sorter
|
|
55804
|
-
);
|
|
56273
|
+
protected constructor();
|
|
55805
56274
|
}
|
|
55806
56275
|
}
|
|
55807
56276
|
/**
|
|
@@ -62320,9 +62789,9 @@ declare namespace sap {
|
|
|
62320
62789
|
* has been resolved!
|
|
62321
62790
|
*
|
|
62322
62791
|
*
|
|
62323
|
-
* @returns The meta model for this `ODataModel`
|
|
62792
|
+
* @returns The meta model for this `ODataModel`, or `undefined` if the model has been destroyed
|
|
62324
62793
|
*/
|
|
62325
|
-
getMetaModel(): sap.ui.model.odata.ODataMetaModel;
|
|
62794
|
+
getMetaModel(): sap.ui.model.odata.ODataMetaModel | undefined;
|
|
62326
62795
|
/**
|
|
62327
62796
|
* Returns a JSON object that is a copy of the entity data referenced by the given `sPath` and `oContext`.
|
|
62328
62797
|
* It does not load any data and may not return all requested data if it is not available.
|
|
@@ -63881,6 +64350,8 @@ declare namespace sap {
|
|
|
63881
64350
|
|
|
63882
64351
|
/**
|
|
63883
64352
|
* Parameters of the ODataModel#parseError event.
|
|
64353
|
+
*
|
|
64354
|
+
* @deprecated As of version 1.37.0. this event is not supported
|
|
63884
64355
|
*/
|
|
63885
64356
|
interface ODataModel$ParseErrorEventParameters
|
|
63886
64357
|
extends sap.ui.model.Model$ParseErrorEventParameters {}
|
|
@@ -63904,18 +64375,24 @@ declare namespace sap {
|
|
|
63904
64375
|
|
|
63905
64376
|
/**
|
|
63906
64377
|
* Parameters of the ODataModel#requestCompleted event.
|
|
64378
|
+
*
|
|
64379
|
+
* @deprecated As of version 1.37.0. this event is not supported
|
|
63907
64380
|
*/
|
|
63908
64381
|
interface ODataModel$RequestCompletedEventParameters
|
|
63909
64382
|
extends sap.ui.model.Model$RequestCompletedEventParameters {}
|
|
63910
64383
|
|
|
63911
64384
|
/**
|
|
63912
64385
|
* Parameters of the ODataModel#requestFailed event.
|
|
64386
|
+
*
|
|
64387
|
+
* @deprecated As of version 1.37.0. this event is not supported
|
|
63913
64388
|
*/
|
|
63914
64389
|
interface ODataModel$RequestFailedEventParameters
|
|
63915
64390
|
extends sap.ui.model.Model$RequestFailedEventParameters {}
|
|
63916
64391
|
|
|
63917
64392
|
/**
|
|
63918
64393
|
* Parameters of the ODataModel#requestSent event.
|
|
64394
|
+
*
|
|
64395
|
+
* @deprecated As of version 1.37.0. this event is not supported
|
|
63919
64396
|
*/
|
|
63920
64397
|
interface ODataModel$RequestSentEventParameters
|
|
63921
64398
|
extends sap.ui.model.Model$RequestSentEventParameters {}
|
|
@@ -64723,7 +65200,7 @@ declare namespace sap {
|
|
|
64723
65200
|
* (for example due to a filter), and the group ID must not have {@link sap.ui.model.odata.v4.SubmitMode.API}.
|
|
64724
65201
|
* Such a deletion is not a pending change.
|
|
64725
65202
|
*
|
|
64726
|
-
* When using data aggregation without
|
|
65203
|
+
* When using data aggregation without `groupLevels`, single entities can be deleted (@experimental as of
|
|
64727
65204
|
* version 1.144.0, see {@link #isAggregated}). The same restrictions as for a recursive hierarchy apply.
|
|
64728
65205
|
* See:
|
|
64729
65206
|
* #hasPendingChanges
|
|
@@ -65021,11 +65498,24 @@ declare namespace sap {
|
|
|
65021
65498
|
* @returns `true` if this context is kept alive
|
|
65022
65499
|
*/
|
|
65023
65500
|
isKeepAlive(): boolean;
|
|
65501
|
+
/**
|
|
65502
|
+
* Tells whether this context is outdated:
|
|
65503
|
+
* `undefined`: The outdated state has not been determined yet `true`: The context is outdated `false`:
|
|
65504
|
+
* The context is up to date
|
|
65505
|
+
*
|
|
65506
|
+
* The outdated state can also be accessed via the instance annotation "@$ui5.context.isOutdated".
|
|
65507
|
+
*
|
|
65508
|
+
* @experimental As of version 1.147.
|
|
65509
|
+
*
|
|
65510
|
+
* @returns Whether this context is outdated, or `undefined` if the outdated state has not been determined
|
|
65511
|
+
* yet
|
|
65512
|
+
*/
|
|
65513
|
+
isOutdated(): boolean | undefined;
|
|
65024
65514
|
/**
|
|
65025
65515
|
* Tells whether this context is currently selected, but not {@link #delete deleted} on the client. Selection
|
|
65026
|
-
* was experimental as of version 1.111.0. Since 1.122.0, the selection state can also be accessed via
|
|
65027
|
-
* annotation "@$ui5.context.isSelected" at the entity. Note that the annotation does not take
|
|
65028
|
-
* state into account.
|
|
65516
|
+
* was experimental as of version 1.111.0. Since 1.122.0, the selection state can also be accessed via the
|
|
65517
|
+
* instance annotation "@$ui5.context.isSelected" at the entity. Note that the annotation does not take
|
|
65518
|
+
* the deletion state into account.
|
|
65029
65519
|
* See:
|
|
65030
65520
|
* #setSelected
|
|
65031
65521
|
*
|
|
@@ -65283,6 +65773,12 @@ declare namespace sap {
|
|
|
65283
65773
|
* 'dataRequested', can instead be done before calling {@link #requestSideEffects}. 'dataReceived',
|
|
65284
65774
|
* can instead be done once the `oPromise` returned by {@link #requestSideEffects} fulfills or rejects (using
|
|
65285
65775
|
* `oPromise.then(function () {...}, function () {...})`).
|
|
65776
|
+
*
|
|
65777
|
+
* Since 1.109.0, this context can also represent a node in a recursive hierarchy (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}).
|
|
65778
|
+
*
|
|
65779
|
+
* When using data aggregation but no recursive hierarchy, and without `groupLevels` or `"grandTotal like
|
|
65780
|
+
* 1.84"` (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}), this context can also represent
|
|
65781
|
+
* a single entity (see {@link #isAggregated}, @experimental as of version 1.146.0).
|
|
65286
65782
|
* See:
|
|
65287
65783
|
* sap.ui.model.odata.v4.ODataContextBinding#getBoundContext
|
|
65288
65784
|
* sap.ui.model.odata.v4.ODataContextBinding#invoke
|
|
@@ -65291,13 +65787,15 @@ declare namespace sap {
|
|
|
65291
65787
|
*
|
|
65292
65788
|
* @since 1.61.0
|
|
65293
65789
|
*
|
|
65294
|
-
* @returns A promise which is resolved without a defined result, or rejected with an error if
|
|
65295
|
-
*
|
|
65790
|
+
* @returns A promise which is resolved without a defined result, or rejected with an error if the side
|
|
65791
|
+
* effects fail to load. Use it to set fields affected by side effects to read-only before {@link #requestSideEffects }
|
|
65296
65792
|
* and make them editable again when the promise resolves; in the error handler, you can repeat the loading
|
|
65297
65793
|
* of side effects.
|
|
65298
|
-
* The promise is rejected if
|
|
65299
|
-
*
|
|
65300
|
-
* ID
|
|
65794
|
+
* The promise is rejected if
|
|
65795
|
+
* the call attempts to refresh an entire list binding (via header context or an absolute path) while
|
|
65796
|
+
* the deletion of a row context (see {@link #delete}) is pending with a different group ID, this is
|
|
65797
|
+
* the row context of a list binding with data aggregation which has `groupLevels` or `"grandTotal like
|
|
65798
|
+
* 1.84"`, or this context does not represent a single entity
|
|
65301
65799
|
*/
|
|
65302
65800
|
requestSideEffects(
|
|
65303
65801
|
/**
|
|
@@ -65312,9 +65810,11 @@ declare namespace sap {
|
|
|
65312
65810
|
*
|
|
65313
65811
|
* Since 1.82.0, absolute paths are supported. Absolute paths must start with the entity container (example
|
|
65314
65812
|
* "/com.sap.gateway.default.iwbep.tea_busi.v0001.Container/TEAMS") of the service. All (navigation) properties
|
|
65315
|
-
* in the complete model matching such an absolute path are updated. Since 1.
|
|
65316
|
-
*
|
|
65317
|
-
*
|
|
65813
|
+
* in the complete model matching such an absolute path are updated. Since 1.146.0, {@link sap.ui.model.odata.v4.ODataModel#requestSideEffects }
|
|
65814
|
+
* can be used as well.
|
|
65815
|
+
*
|
|
65816
|
+
* Since 1.85.0, "14.3.11 Expression edm:String" is accepted as well. Since 1.145.0, you can use `null`
|
|
65817
|
+
* values (and `{$Null : null}`) as synonyms for empty navigation property paths.
|
|
65318
65818
|
*
|
|
65319
65819
|
* Since 1.108.8, a property path matching the "com.sap.vocabularies.Common.v1.Messages" annotation of a
|
|
65320
65820
|
* list binding's entity type is treated specially for a row context of a list binding: It is loaded even
|
|
@@ -65327,8 +65827,8 @@ declare namespace sap {
|
|
|
65327
65827
|
| string
|
|
65328
65828
|
>,
|
|
65329
65829
|
/**
|
|
65330
|
-
* The group ID to be used (since 1.69.0)
|
|
65331
|
-
*
|
|
65830
|
+
* The group ID to be used (since 1.69.0). If not specified, the {@link #getUpdateGroupId update group ID }
|
|
65831
|
+
* for the context's binding is used. If a different group ID is specified, make sure that {@link #requestSideEffects }
|
|
65332
65832
|
* is called after the corresponding updates have been successfully processed by the server and that there
|
|
65333
65833
|
* are no pending changes for the affected properties.
|
|
65334
65834
|
*/
|
|
@@ -66340,6 +66840,9 @@ declare namespace sap {
|
|
|
66340
66840
|
* is set to `undefined`. The created context always knows its {@link sap.ui.model.odata.v4.Context#getPath path},
|
|
66341
66841
|
* which can be used for {@link #getKeepAliveContext}.
|
|
66342
66842
|
*
|
|
66843
|
+
* When using data aggregation without `groupLevels` and without `"grandTotal like 1.84"` (see {@link #setAggregation}),
|
|
66844
|
+
* single entities can be created (@experimental as of version 1.146.0, see {@link sap.ui.model.odata.v4.Context#isAggregated}).
|
|
66845
|
+
*
|
|
66343
66846
|
* @since 1.43.0
|
|
66344
66847
|
*
|
|
66345
66848
|
* @returns The context object for the created entity; its method {@link sap.ui.model.odata.v4.Context#created }
|
|
@@ -66544,7 +67047,8 @@ declare namespace sap {
|
|
|
66544
67047
|
*/
|
|
66545
67048
|
vFilters?: sap.ui.model.Filter | sap.ui.model.Filter[],
|
|
66546
67049
|
/**
|
|
66547
|
-
* The filter type to be used
|
|
67050
|
+
* The filter type to be used. Since 1.146.0, you may use {@link sap.ui.model.FilterType.ApplicationBound }
|
|
67051
|
+
* to replace bound application filters.
|
|
66548
67052
|
*/
|
|
66549
67053
|
sFilterType?: sap.ui.model.FilterType
|
|
66550
67054
|
): this;
|
|
@@ -66705,9 +67209,11 @@ declare namespace sap {
|
|
|
66705
67209
|
*/
|
|
66706
67210
|
getGroupId(): string;
|
|
66707
67211
|
/**
|
|
66708
|
-
* Returns the header context which allows binding to `$count
|
|
67212
|
+
* Returns the header context which allows binding to `$count`, `@$ui5.context.isOutdated`, or `@$ui5.context.isSelected`.
|
|
66709
67213
|
* See:
|
|
66710
67214
|
* #getCount
|
|
67215
|
+
* sap.ui.model.odata.v4.Context#isOutdated
|
|
67216
|
+
* sap.ui.model.odata.v4.Context#isSelected
|
|
66711
67217
|
*
|
|
66712
67218
|
* @since 1.45.0
|
|
66713
67219
|
*
|
|
@@ -67052,10 +67558,10 @@ declare namespace sap {
|
|
|
67052
67558
|
*/
|
|
67053
67559
|
aggregate?: object;
|
|
67054
67560
|
/**
|
|
67055
|
-
* Whether created nodes are shown in place at the position specified by the service (since 1.130.0)
|
|
67056
|
-
* the value `true` is allowed. Otherwise, created nodes are
|
|
67057
|
-
* of their parent or as the first roots, but not in their
|
|
67058
|
-
* the current sort order.
|
|
67561
|
+
* Whether created nodes are shown in place at the position specified by the service (since 1.130.0), supported
|
|
67562
|
+
* only if a `hierarchyQualifier` is given; only the value `true` is allowed. Otherwise, created nodes are
|
|
67563
|
+
* displayed out of place as the first children of their parent or as the first roots, but not in their
|
|
67564
|
+
* usual position as defined by the service and the current sort order.
|
|
67059
67565
|
*/
|
|
67060
67566
|
createInPlace?: boolean;
|
|
67061
67567
|
/**
|
|
@@ -68042,7 +68548,7 @@ declare namespace sap {
|
|
|
68042
68548
|
*
|
|
68043
68549
|
* Every resource path (relative to the service root URL, no query options) according to "4 Resource Path" in specification "OData Version 4.01. Part 2: URL Conventions" is a valid data
|
|
68044
68550
|
* binding path within this model if a leading slash is added; for example "/" + "SalesOrderList('A%2FB%26C')"
|
|
68045
|
-
* to access an entity instance with key "A/B&C". Note that appropriate
|
|
68551
|
+
* to access an entity instance with key "A/B&C". Note that appropriate URL encoding is necessary, see the
|
|
68046
68552
|
* example of {@link sap.ui.model.odata.v4.ODataUtils.formatLiteral}. "4.5.1 Addressing Actions" needs an
|
|
68047
68553
|
* operation binding, see {@link sap.ui.model.odata.v4.ODataContextBinding}.
|
|
68048
68554
|
*
|
|
@@ -68874,7 +69380,7 @@ declare namespace sap {
|
|
|
68874
69380
|
*
|
|
68875
69381
|
* @since 1.107.0
|
|
68876
69382
|
*
|
|
68877
|
-
* @returns The proper
|
|
69383
|
+
* @returns The proper URL-encoded key predicate, for example "(Sector='A%2FB%26C',ID='42')" or "('42')",
|
|
68878
69384
|
* or `undefined` if at least one key property is undefined.
|
|
68879
69385
|
*/
|
|
68880
69386
|
getKeyPredicate(
|
|
@@ -69036,7 +69542,7 @@ declare namespace sap {
|
|
|
69036
69542
|
*
|
|
69037
69543
|
* @since 1.107.0
|
|
69038
69544
|
*
|
|
69039
|
-
* @returns A promise that gets resolved with the proper
|
|
69545
|
+
* @returns A promise that gets resolved with the proper URL-encoded key predicate, for example "(Sector='A%2FB%26C',ID='42')"
|
|
69040
69546
|
* or "('42')", or `undefined` if at least one key property is undefined. It gets rejected if the metadata
|
|
69041
69547
|
* cannot be fetched, or in case the entity has no key properties according to the metadata.
|
|
69042
69548
|
*/
|
|
@@ -69050,6 +69556,25 @@ declare namespace sap {
|
|
|
69050
69556
|
*/
|
|
69051
69557
|
oEntity: object
|
|
69052
69558
|
): Promise<string | undefined>;
|
|
69559
|
+
/**
|
|
69560
|
+
* Loads side effects for the given absolute paths on all affected bindings. For more information about
|
|
69561
|
+
* side effects in general, see {@link sap.ui.model.odata.v4.Context#requestSideEffects}.
|
|
69562
|
+
*
|
|
69563
|
+
* @since 1.146.0
|
|
69564
|
+
*
|
|
69565
|
+
* @returns A promise which is resolved without a defined result, or rejected with an error if the side
|
|
69566
|
+
* effects fail to load.
|
|
69567
|
+
*/
|
|
69568
|
+
requestSideEffects(
|
|
69569
|
+
/**
|
|
69570
|
+
* The absolute paths for which to request side effects, for example "/SalesOrderList/SO_2_SOITEM/Note".
|
|
69571
|
+
*/
|
|
69572
|
+
aAbsolutePaths: string[],
|
|
69573
|
+
/**
|
|
69574
|
+
* The group ID to be used. If not specified, the {@link #getUpdateGroupId update group ID} is used.
|
|
69575
|
+
*/
|
|
69576
|
+
sGroupId?: string
|
|
69577
|
+
): Promise<void>;
|
|
69053
69578
|
/**
|
|
69054
69579
|
* Resets all property changes, created entities, and entity deletions associated with the given group ID
|
|
69055
69580
|
* which have not been successfully submitted via {@link #submitBatch}. Resets also invalid user input for
|
|
@@ -69682,6 +70207,8 @@ declare namespace sap {
|
|
|
69682
70207
|
|
|
69683
70208
|
/**
|
|
69684
70209
|
* Event object of the ODataModel#parseError event.
|
|
70210
|
+
*
|
|
70211
|
+
* @deprecated As of version 1.37.0. this event is not supported
|
|
69685
70212
|
*/
|
|
69686
70213
|
type ODataModel$ParseErrorEvent = sap.ui.base.Event<
|
|
69687
70214
|
ODataModel$ParseErrorEventParameters,
|
|
@@ -69698,6 +70225,8 @@ declare namespace sap {
|
|
|
69698
70225
|
|
|
69699
70226
|
/**
|
|
69700
70227
|
* Event object of the ODataModel#requestCompleted event.
|
|
70228
|
+
*
|
|
70229
|
+
* @deprecated As of version 1.37.0. this event is not supported
|
|
69701
70230
|
*/
|
|
69702
70231
|
type ODataModel$RequestCompletedEvent = sap.ui.base.Event<
|
|
69703
70232
|
ODataModel$RequestCompletedEventParameters,
|
|
@@ -69706,6 +70235,8 @@ declare namespace sap {
|
|
|
69706
70235
|
|
|
69707
70236
|
/**
|
|
69708
70237
|
* Event object of the ODataModel#requestFailed event.
|
|
70238
|
+
*
|
|
70239
|
+
* @deprecated As of version 1.37.0. this event is not supported
|
|
69709
70240
|
*/
|
|
69710
70241
|
type ODataModel$RequestFailedEvent = sap.ui.base.Event<
|
|
69711
70242
|
ODataModel$RequestFailedEventParameters,
|
|
@@ -69714,6 +70245,8 @@ declare namespace sap {
|
|
|
69714
70245
|
|
|
69715
70246
|
/**
|
|
69716
70247
|
* Event object of the ODataModel#requestSent event.
|
|
70248
|
+
*
|
|
70249
|
+
* @deprecated As of version 1.37.0. this event is not supported
|
|
69717
70250
|
*/
|
|
69718
70251
|
type ODataModel$RequestSentEvent = sap.ui.base.Event<
|
|
69719
70252
|
ODataModel$RequestSentEventParameters,
|
|
@@ -76095,7 +76628,7 @@ declare namespace sap {
|
|
|
76095
76628
|
/**
|
|
76096
76629
|
* HTTP status code returned by the request (if available)
|
|
76097
76630
|
*/
|
|
76098
|
-
statusCode?: string;
|
|
76631
|
+
statusCode?: string | number;
|
|
76099
76632
|
|
|
76100
76633
|
/**
|
|
76101
76634
|
* The status as a text, details not specified, intended only for diagnosis output
|
|
@@ -76790,7 +77323,9 @@ declare namespace sap {
|
|
|
76790
77323
|
aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
|
|
76791
77324
|
/**
|
|
76792
77325
|
* The type of the filter to replace; if no type is given, all filters previously configured with type {@link sap.ui.model.FilterType.Application }
|
|
76793
|
-
* are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}
|
|
77326
|
+
* are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}.
|
|
77327
|
+
* Since 1.146.0, you may use {@link sap.ui.model.FilterType.ApplicationBound} to set bound application
|
|
77328
|
+
* filters.
|
|
76794
77329
|
*/
|
|
76795
77330
|
sFilterType?: sap.ui.model.FilterType
|
|
76796
77331
|
): this;
|
|
@@ -76873,6 +77408,26 @@ declare namespace sap {
|
|
|
76873
77408
|
* @returns Metadata object describing this class
|
|
76874
77409
|
*/
|
|
76875
77410
|
static getMetadata(): sap.ui.base.Metadata;
|
|
77411
|
+
/**
|
|
77412
|
+
* Creates a `sap.ui.model.ClientContextBinding`.
|
|
77413
|
+
*
|
|
77414
|
+
*
|
|
77415
|
+
* @returns The newly created `ClientContextBinding`
|
|
77416
|
+
*/
|
|
77417
|
+
bindContext(
|
|
77418
|
+
/**
|
|
77419
|
+
* The path pointing to the property that should be bound
|
|
77420
|
+
*/
|
|
77421
|
+
sPath: string,
|
|
77422
|
+
/**
|
|
77423
|
+
* The context object for this databinding
|
|
77424
|
+
*/
|
|
77425
|
+
oContext?: sap.ui.model.Context,
|
|
77426
|
+
/**
|
|
77427
|
+
* Additional model-specific parameters
|
|
77428
|
+
*/
|
|
77429
|
+
mParameters?: object
|
|
77430
|
+
): sap.ui.model.ClientContextBinding;
|
|
76876
77431
|
/**
|
|
76877
77432
|
* Creates a new property binding for this model.
|
|
76878
77433
|
* See:
|
|
@@ -76897,14 +77452,14 @@ declare namespace sap {
|
|
|
76897
77452
|
*/
|
|
76898
77453
|
mParameters?: {
|
|
76899
77454
|
/**
|
|
76900
|
-
* Whether this binding
|
|
76901
|
-
* composite types like {@link sap.ui.model.type.Currency} automatically ignore model messages
|
|
76902
|
-
* of their parts depending on their format options
|
|
76903
|
-
* the automatism of the type.
|
|
77455
|
+
* Whether this binding ignores model messages instead of propagating them to the control. Supported since
|
|
77456
|
+
* 1.119.0. Some composite types like {@link sap.ui.model.type.Currency} automatically ignore model messages
|
|
77457
|
+
* for some of their parts, depending on their format options. Setting this parameter to `true` or `false`
|
|
77458
|
+
* overrules the automatism of the type.
|
|
76904
77459
|
*
|
|
76905
|
-
*
|
|
76906
|
-
* of decimals, but the currency code is not displayed in the attached control. In
|
|
76907
|
-
* the currency code
|
|
77460
|
+
* **Example:** A binding for a currency code is used in a composite binding for rendering the proper number
|
|
77461
|
+
* of decimals, but the currency code itself is not displayed in the attached control. In this case, messages
|
|
77462
|
+
* for the currency code aren't displayed at that control, only messages for the amount.
|
|
76908
77463
|
*/
|
|
76909
77464
|
ignoreMessages?: boolean;
|
|
76910
77465
|
}
|
|
@@ -77128,7 +77683,9 @@ declare namespace sap {
|
|
|
77128
77683
|
aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
|
|
77129
77684
|
/**
|
|
77130
77685
|
* The type of the filter to replace; if no type is given, all filters previously configured with type {@link sap.ui.model.FilterType.Application }
|
|
77131
|
-
* are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}
|
|
77686
|
+
* are cleared, and the given filters are used as filters of type {@link sap.ui.model.FilterType.Control}.
|
|
77687
|
+
* Since 1.146.0, you may use {@link sap.ui.model.FilterType.ApplicationBound} to set bound application
|
|
77688
|
+
* filters.
|
|
77132
77689
|
*/
|
|
77133
77690
|
sFilterType?: sap.ui.model.FilterType
|
|
77134
77691
|
): this;
|
|
@@ -78710,6 +79267,26 @@ declare namespace sap {
|
|
|
78710
79267
|
*/
|
|
78711
79268
|
oListener?: object
|
|
78712
79269
|
): void;
|
|
79270
|
+
/**
|
|
79271
|
+
* Computes the binding's application filters by replacing application filters of the given type with the
|
|
79272
|
+
* given new filters. Subclasses call this method from their filter method implementation.
|
|
79273
|
+
*
|
|
79274
|
+
* @since 1.146.0
|
|
79275
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
79276
|
+
*
|
|
79277
|
+
* @returns The new application filters
|
|
79278
|
+
*/
|
|
79279
|
+
computeApplicationFilters(
|
|
79280
|
+
/**
|
|
79281
|
+
* The new filters for the given filter type
|
|
79282
|
+
*/
|
|
79283
|
+
vFilter?: sap.ui.model.Filter[] | sap.ui.model.Filter,
|
|
79284
|
+
/**
|
|
79285
|
+
* The type of the application filters to replace
|
|
79286
|
+
*/
|
|
79287
|
+
sFilterType?: /* was: sap.ui.model.FilterType.Application */
|
|
79288
|
+
any | /* was: sap.ui.model.FilterType.ApplicationBound */ any
|
|
79289
|
+
): sap.ui.model.Filter[] | sap.ui.model.Filter | undefined;
|
|
78713
79290
|
/**
|
|
78714
79291
|
* Detaches event handler `fnFunction` from the {@link #event:filter filter} event of this `sap.ui.model.ListBinding`.
|
|
78715
79292
|
*
|
|
@@ -78822,7 +79399,9 @@ declare namespace sap {
|
|
|
78822
79399
|
*/
|
|
78823
79400
|
aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
|
|
78824
79401
|
/**
|
|
78825
|
-
* The type of
|
|
79402
|
+
* The type of filter to replace. If no type is specified, the behavior depends on the model implementation.
|
|
79403
|
+
* Since 1.146.0, you can use `sap.ui.model.FilterType.ApplicationBound` to replace bound application filters
|
|
79404
|
+
* if the model implementation supports it.
|
|
78826
79405
|
*/
|
|
78827
79406
|
sFilterType?: sap.ui.model.FilterType
|
|
78828
79407
|
): this;
|
|
@@ -80524,6 +81103,11 @@ declare namespace sap {
|
|
|
80524
81103
|
* See `vGroup` parameter
|
|
80525
81104
|
*/
|
|
80526
81105
|
group?: boolean | Function;
|
|
81106
|
+
/**
|
|
81107
|
+
* An array of paths that are required for grouping. Supported since 1.147.0; consult the documentation
|
|
81108
|
+
* of the specific model implementation whether it evaluates these paths.
|
|
81109
|
+
*/
|
|
81110
|
+
groupPaths?: string[];
|
|
80527
81111
|
/**
|
|
80528
81112
|
* The binding path for this sorter
|
|
80529
81113
|
*/
|
|
@@ -80633,6 +81217,14 @@ declare namespace sap {
|
|
|
80633
81217
|
* @returns The group function
|
|
80634
81218
|
*/
|
|
80635
81219
|
getGroupFunction(): Function;
|
|
81220
|
+
/**
|
|
81221
|
+
* Returns the group paths.
|
|
81222
|
+
*
|
|
81223
|
+
* @since 1.147.0
|
|
81224
|
+
*
|
|
81225
|
+
* @returns The array of group paths or `undefined` if this sorter has no group paths.
|
|
81226
|
+
*/
|
|
81227
|
+
getGroupPaths(): string[] | undefined;
|
|
80636
81228
|
/**
|
|
80637
81229
|
* Returns the binding path for this sorter; see the path parameter of {@link sap.ui.model.Sorter#constructor}.
|
|
80638
81230
|
*
|
|
@@ -80788,6 +81380,26 @@ declare namespace sap {
|
|
|
80788
81380
|
*/
|
|
80789
81381
|
oListener?: object
|
|
80790
81382
|
): void;
|
|
81383
|
+
/**
|
|
81384
|
+
* Computes the binding's application filters by replacing application filters of the given type with the
|
|
81385
|
+
* given new filters. Subclasses call this method from their filter method implementation.
|
|
81386
|
+
*
|
|
81387
|
+
* @since 1.146.0
|
|
81388
|
+
* @ui5-protected Do not call from applications (only from related classes in the framework)
|
|
81389
|
+
*
|
|
81390
|
+
* @returns The new application filters
|
|
81391
|
+
*/
|
|
81392
|
+
computeApplicationFilters(
|
|
81393
|
+
/**
|
|
81394
|
+
* The new filters for the given filter type
|
|
81395
|
+
*/
|
|
81396
|
+
vFilter?: sap.ui.model.Filter[] | sap.ui.model.Filter,
|
|
81397
|
+
/**
|
|
81398
|
+
* The type of the application filters to replace
|
|
81399
|
+
*/
|
|
81400
|
+
sFilterType?: /* was: sap.ui.model.FilterType.Application */
|
|
81401
|
+
any | /* was: sap.ui.model.FilterType.ApplicationBound */ any
|
|
81402
|
+
): sap.ui.model.Filter[] | sap.ui.model.Filter | undefined;
|
|
80791
81403
|
/**
|
|
80792
81404
|
* Detaches event handler `fnFunction` from the {@link #event:_filter _filter} event of this `sap.ui.model.TreeBinding`.
|
|
80793
81405
|
*
|
|
@@ -80817,7 +81429,9 @@ declare namespace sap {
|
|
|
80817
81429
|
*/
|
|
80818
81430
|
aFilters?: sap.ui.model.Filter[] | sap.ui.model.Filter,
|
|
80819
81431
|
/**
|
|
80820
|
-
* The type of
|
|
81432
|
+
* The type of filter to replace. If no type is specified, the behavior depends on the model implementation.
|
|
81433
|
+
* Since 1.146.0, you can use `sap.ui.model.FilterType.ApplicationBound` to set bound application filters
|
|
81434
|
+
* if the model implementation supports it.
|
|
80821
81435
|
*/
|
|
80822
81436
|
sFilterType?: sap.ui.model.FilterType
|
|
80823
81437
|
): void;
|
|
@@ -81200,9 +81814,20 @@ declare namespace sap {
|
|
|
81200
81814
|
*/
|
|
81201
81815
|
enum FilterType {
|
|
81202
81816
|
/**
|
|
81203
|
-
* Filters which are provided by the application.
|
|
81817
|
+
* Filters which are provided by the application and have constant values. Filters defined via the property
|
|
81818
|
+
* `filters` in {@link sap.ui.base.ManagedObject.AggregationBindingInfo} have this type. Filters of this
|
|
81819
|
+
* type are called "unbound application filters".
|
|
81204
81820
|
*/
|
|
81205
81821
|
Application = "Application",
|
|
81822
|
+
/**
|
|
81823
|
+
* Filters provided by the application that may have values which are binding expressions. Filters defined
|
|
81824
|
+
* via the property `boundFilters` in {@link sap.ui.base.ManagedObject.AggregationBindingInfo} have this
|
|
81825
|
+
* type. Filters of this type are called "bound application filters". When a filter value changes through
|
|
81826
|
+
* data binding, the aggregation binding that uses this filter is filtered automatically.
|
|
81827
|
+
*
|
|
81828
|
+
* @since 1.146.0
|
|
81829
|
+
*/
|
|
81830
|
+
ApplicationBound = "ApplicationBound",
|
|
81206
81831
|
/**
|
|
81207
81832
|
* Filters which are set by a control itself.
|
|
81208
81833
|
*
|
|
@@ -81525,7 +82150,7 @@ declare namespace sap {
|
|
|
81525
82150
|
* have the possibility to customize the user agent, and to explicitly add this information.
|
|
81526
82151
|
*
|
|
81527
82152
|
* @since 1.31.0
|
|
81528
|
-
* @deprecated As of version 1.98.
|
|
82153
|
+
* @deprecated As of version 1.98. without replacement, refer to the above note.
|
|
81529
82154
|
*/
|
|
81530
82155
|
export const webview: boolean;
|
|
81531
82156
|
|
|
@@ -82272,11 +82897,24 @@ declare namespace sap {
|
|
|
82272
82897
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
82273
82898
|
| `{${string}}`;
|
|
82274
82899
|
|
|
82900
|
+
/**
|
|
82901
|
+
* If it is set to `true`, the input will remain focused after text is entered. Use this for inputs with
|
|
82902
|
+
* a suggestion list that you want to keep open.
|
|
82903
|
+
*
|
|
82904
|
+
* @since 1.67
|
|
82905
|
+
*/
|
|
82275
82906
|
keepFocus?:
|
|
82276
82907
|
| boolean
|
|
82277
82908
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
82278
82909
|
| `{${string}}`;
|
|
82279
82910
|
|
|
82911
|
+
/**
|
|
82912
|
+
* If it is set to `true`, an ENTER key will be entered after the text. Use this for inputs that shouldn't
|
|
82913
|
+
* lose the focus after a text is entered. (e.g. inputs in a sap.m.Popover shouldn't be focused out, as
|
|
82914
|
+
* this will make the popover close in FF and IE11)
|
|
82915
|
+
*
|
|
82916
|
+
* @since 1.76
|
|
82917
|
+
*/
|
|
82280
82918
|
pressEnterKey?:
|
|
82281
82919
|
| boolean
|
|
82282
82920
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
@@ -82338,17 +82976,58 @@ declare namespace sap {
|
|
|
82338
82976
|
| float
|
|
82339
82977
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
82340
82978
|
| `{${string}}`;
|
|
82979
|
+
|
|
82980
|
+
/**
|
|
82981
|
+
* If it is set to `true`, a `keydown` keyboard event will be dispatched instead of mouse events. The modifier
|
|
82982
|
+
* keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
|
|
82983
|
+
*
|
|
82984
|
+
* @since 1.146
|
|
82985
|
+
*/
|
|
82986
|
+
keyDown?:
|
|
82987
|
+
| boolean
|
|
82988
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
82989
|
+
| `{${string}}`;
|
|
82990
|
+
|
|
82991
|
+
/**
|
|
82992
|
+
* If it is set to `true`, a `keyup` keyboard event will be dispatched instead of mouse events. The modifier
|
|
82993
|
+
* keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
|
|
82994
|
+
*
|
|
82995
|
+
* @since 1.146
|
|
82996
|
+
*/
|
|
82997
|
+
keyUp?:
|
|
82998
|
+
| boolean
|
|
82999
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
83000
|
+
| `{${string}}`;
|
|
83001
|
+
|
|
83002
|
+
/**
|
|
83003
|
+
* If set to `true`, a right-click (context menu) event will be triggered instead of a left-click. This
|
|
83004
|
+
* simulates the native browser right-click behavior by dispatching `mousedown` and `mouseup` with `button:
|
|
83005
|
+
* 2`, followed by a `contextmenu` event. The `xPercentage` and `yPercentage` properties can be used to
|
|
83006
|
+
* specify the position of the right-click event.
|
|
83007
|
+
*
|
|
83008
|
+
* @since 1.147
|
|
83009
|
+
*/
|
|
83010
|
+
rightClick?:
|
|
83011
|
+
| boolean
|
|
83012
|
+
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
83013
|
+
| `{${string}}`;
|
|
82341
83014
|
}
|
|
82342
83015
|
|
|
82343
83016
|
/**
|
|
82344
83017
|
* Describes the settings that can be provided to the Scroll constructor.
|
|
82345
83018
|
*/
|
|
82346
83019
|
interface $ScrollSettings extends sap.ui.test.actions.$ActionSettings {
|
|
83020
|
+
/**
|
|
83021
|
+
* The x scroll position.
|
|
83022
|
+
*/
|
|
82347
83023
|
x?:
|
|
82348
83024
|
| int
|
|
82349
83025
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
82350
83026
|
| `{${string}}`;
|
|
82351
83027
|
|
|
83028
|
+
/**
|
|
83029
|
+
* The y scroll position.
|
|
83030
|
+
*/
|
|
82352
83031
|
y?:
|
|
82353
83032
|
| int
|
|
82354
83033
|
| sap.ui.base.ManagedObject.PropertyBindingInfo
|
|
@@ -82831,8 +83510,12 @@ declare namespace sap {
|
|
|
82831
83510
|
/**
|
|
82832
83511
|
* Gets current value of property {@link #getKeepFocus keepFocus}.
|
|
82833
83512
|
*
|
|
83513
|
+
* If it is set to `true`, the input will remain focused after text is entered. Use this for inputs with
|
|
83514
|
+
* a suggestion list that you want to keep open.
|
|
83515
|
+
*
|
|
82834
83516
|
* Default value is `false`.
|
|
82835
83517
|
*
|
|
83518
|
+
* @since 1.67
|
|
82836
83519
|
*
|
|
82837
83520
|
* @returns Value of property `keepFocus`
|
|
82838
83521
|
*/
|
|
@@ -82840,8 +83523,13 @@ declare namespace sap {
|
|
|
82840
83523
|
/**
|
|
82841
83524
|
* Gets current value of property {@link #getPressEnterKey pressEnterKey}.
|
|
82842
83525
|
*
|
|
83526
|
+
* If it is set to `true`, an ENTER key will be entered after the text. Use this for inputs that shouldn't
|
|
83527
|
+
* lose the focus after a text is entered. (e.g. inputs in a sap.m.Popover shouldn't be focused out, as
|
|
83528
|
+
* this will make the popover close in FF and IE11)
|
|
83529
|
+
*
|
|
82843
83530
|
* Default value is `false`.
|
|
82844
83531
|
*
|
|
83532
|
+
* @since 1.76
|
|
82845
83533
|
*
|
|
82846
83534
|
* @returns Value of property `pressEnterKey`
|
|
82847
83535
|
*/
|
|
@@ -82881,10 +83569,14 @@ declare namespace sap {
|
|
|
82881
83569
|
/**
|
|
82882
83570
|
* Sets a new value for property {@link #getKeepFocus keepFocus}.
|
|
82883
83571
|
*
|
|
83572
|
+
* If it is set to `true`, the input will remain focused after text is entered. Use this for inputs with
|
|
83573
|
+
* a suggestion list that you want to keep open.
|
|
83574
|
+
*
|
|
82884
83575
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
82885
83576
|
*
|
|
82886
83577
|
* Default value is `false`.
|
|
82887
83578
|
*
|
|
83579
|
+
* @since 1.67
|
|
82888
83580
|
*
|
|
82889
83581
|
* @returns Reference to `this` in order to allow method chaining
|
|
82890
83582
|
*/
|
|
@@ -82897,10 +83589,15 @@ declare namespace sap {
|
|
|
82897
83589
|
/**
|
|
82898
83590
|
* Sets a new value for property {@link #getPressEnterKey pressEnterKey}.
|
|
82899
83591
|
*
|
|
83592
|
+
* If it is set to `true`, an ENTER key will be entered after the text. Use this for inputs that shouldn't
|
|
83593
|
+
* lose the focus after a text is entered. (e.g. inputs in a sap.m.Popover shouldn't be focused out, as
|
|
83594
|
+
* this will make the popover close in FF and IE11)
|
|
83595
|
+
*
|
|
82900
83596
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
82901
83597
|
*
|
|
82902
83598
|
* Default value is `false`.
|
|
82903
83599
|
*
|
|
83600
|
+
* @since 1.76
|
|
82904
83601
|
*
|
|
82905
83602
|
* @returns Reference to `this` in order to allow method chaining
|
|
82906
83603
|
*/
|
|
@@ -82932,6 +83629,10 @@ declare namespace sap {
|
|
|
82932
83629
|
* The `Press` action is used to simulate a press interaction with a control. Most controls are supported,
|
|
82933
83630
|
* for example buttons, links, list items, tables, filters, and form controls.
|
|
82934
83631
|
*
|
|
83632
|
+
* The `Press` action can also simulate right-click (context menu) interactions by setting the `rightClick`
|
|
83633
|
+
* property to true. This is useful for testing controls with custom context menus, such as `sap.ui.table.Table`
|
|
83634
|
+
* and `sap.m.Table`.
|
|
83635
|
+
*
|
|
82935
83636
|
* The `Press` action targets a special DOM element representing the control. This DOM element can be customized.
|
|
82936
83637
|
*
|
|
82937
83638
|
* For most most controls (even custom ones), the DOM focus reference is an appropriate choice. You can
|
|
@@ -83030,7 +83731,10 @@ declare namespace sap {
|
|
|
83030
83731
|
static getMetadata(): sap.ui.base.ManagedObjectMetadata;
|
|
83031
83732
|
/**
|
|
83032
83733
|
* Sets focus on given control and triggers a 'tap' event on it (which is internally translated into a 'press'
|
|
83033
|
-
* event).
|
|
83734
|
+
* event). If `keyDown` or `keyUp` is set to `true`, dispatches the corresponding keyboard event instead
|
|
83735
|
+
* of mouse events. If `rightClick` property is set to `true`, triggers a `contextmenu` event instead, along
|
|
83736
|
+
* with appropriate `mousedown` and `mouseup` events. Logs an error if control is not visible (i.e. has
|
|
83737
|
+
* no dom representation)
|
|
83034
83738
|
*/
|
|
83035
83739
|
executeOn(
|
|
83036
83740
|
/**
|
|
@@ -83058,6 +83762,43 @@ declare namespace sap {
|
|
|
83058
83762
|
* @returns Value of property `ctrlKey`
|
|
83059
83763
|
*/
|
|
83060
83764
|
getCtrlKey(): boolean;
|
|
83765
|
+
/**
|
|
83766
|
+
* Gets current value of property {@link #getKeyDown keyDown}.
|
|
83767
|
+
*
|
|
83768
|
+
* If it is set to `true`, a `keydown` keyboard event will be dispatched instead of mouse events. The modifier
|
|
83769
|
+
* keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
|
|
83770
|
+
*
|
|
83771
|
+
* @since 1.146
|
|
83772
|
+
*
|
|
83773
|
+
* @returns Value of property `keyDown`
|
|
83774
|
+
*/
|
|
83775
|
+
getKeyDown(): boolean;
|
|
83776
|
+
/**
|
|
83777
|
+
* Gets current value of property {@link #getKeyUp keyUp}.
|
|
83778
|
+
*
|
|
83779
|
+
* If it is set to `true`, a `keyup` keyboard event will be dispatched instead of mouse events. The modifier
|
|
83780
|
+
* keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
|
|
83781
|
+
*
|
|
83782
|
+
* @since 1.146
|
|
83783
|
+
*
|
|
83784
|
+
* @returns Value of property `keyUp`
|
|
83785
|
+
*/
|
|
83786
|
+
getKeyUp(): boolean;
|
|
83787
|
+
/**
|
|
83788
|
+
* Gets current value of property {@link #getRightClick rightClick}.
|
|
83789
|
+
*
|
|
83790
|
+
* If set to `true`, a right-click (context menu) event will be triggered instead of a left-click. This
|
|
83791
|
+
* simulates the native browser right-click behavior by dispatching `mousedown` and `mouseup` with `button:
|
|
83792
|
+
* 2`, followed by a `contextmenu` event. The `xPercentage` and `yPercentage` properties can be used to
|
|
83793
|
+
* specify the position of the right-click event.
|
|
83794
|
+
*
|
|
83795
|
+
* Default value is `false`.
|
|
83796
|
+
*
|
|
83797
|
+
* @since 1.147
|
|
83798
|
+
*
|
|
83799
|
+
* @returns Value of property `rightClick`
|
|
83800
|
+
*/
|
|
83801
|
+
getRightClick(): boolean;
|
|
83061
83802
|
/**
|
|
83062
83803
|
* Gets current value of property {@link #getShiftKey shiftKey}.
|
|
83063
83804
|
*
|
|
@@ -83124,6 +83865,64 @@ declare namespace sap {
|
|
|
83124
83865
|
*/
|
|
83125
83866
|
bCtrlKey: boolean
|
|
83126
83867
|
): this;
|
|
83868
|
+
/**
|
|
83869
|
+
* Sets a new value for property {@link #getKeyDown keyDown}.
|
|
83870
|
+
*
|
|
83871
|
+
* If it is set to `true`, a `keydown` keyboard event will be dispatched instead of mouse events. The modifier
|
|
83872
|
+
* keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
|
|
83873
|
+
*
|
|
83874
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
83875
|
+
*
|
|
83876
|
+
* @since 1.146
|
|
83877
|
+
*
|
|
83878
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
83879
|
+
*/
|
|
83880
|
+
setKeyDown(
|
|
83881
|
+
/**
|
|
83882
|
+
* New value for property `keyDown`
|
|
83883
|
+
*/
|
|
83884
|
+
bKeyDown: boolean
|
|
83885
|
+
): this;
|
|
83886
|
+
/**
|
|
83887
|
+
* Sets a new value for property {@link #getKeyUp keyUp}.
|
|
83888
|
+
*
|
|
83889
|
+
* If it is set to `true`, a `keyup` keyboard event will be dispatched instead of mouse events. The modifier
|
|
83890
|
+
* keys (shiftKey, altKey, ctrlKey) will be applied to the keyboard event if set.
|
|
83891
|
+
*
|
|
83892
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
83893
|
+
*
|
|
83894
|
+
* @since 1.146
|
|
83895
|
+
*
|
|
83896
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
83897
|
+
*/
|
|
83898
|
+
setKeyUp(
|
|
83899
|
+
/**
|
|
83900
|
+
* New value for property `keyUp`
|
|
83901
|
+
*/
|
|
83902
|
+
bKeyUp: boolean
|
|
83903
|
+
): this;
|
|
83904
|
+
/**
|
|
83905
|
+
* Sets a new value for property {@link #getRightClick rightClick}.
|
|
83906
|
+
*
|
|
83907
|
+
* If set to `true`, a right-click (context menu) event will be triggered instead of a left-click. This
|
|
83908
|
+
* simulates the native browser right-click behavior by dispatching `mousedown` and `mouseup` with `button:
|
|
83909
|
+
* 2`, followed by a `contextmenu` event. The `xPercentage` and `yPercentage` properties can be used to
|
|
83910
|
+
* specify the position of the right-click event.
|
|
83911
|
+
*
|
|
83912
|
+
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
83913
|
+
*
|
|
83914
|
+
* Default value is `false`.
|
|
83915
|
+
*
|
|
83916
|
+
* @since 1.147
|
|
83917
|
+
*
|
|
83918
|
+
* @returns Reference to `this` in order to allow method chaining
|
|
83919
|
+
*/
|
|
83920
|
+
setRightClick(
|
|
83921
|
+
/**
|
|
83922
|
+
* New value for property `rightClick`
|
|
83923
|
+
*/
|
|
83924
|
+
bRightClick?: boolean
|
|
83925
|
+
): this;
|
|
83127
83926
|
/**
|
|
83128
83927
|
* Sets a new value for property {@link #getShiftKey shiftKey}.
|
|
83129
83928
|
*
|
|
@@ -83248,6 +84047,8 @@ declare namespace sap {
|
|
|
83248
84047
|
/**
|
|
83249
84048
|
* Gets current value of property {@link #getX x}.
|
|
83250
84049
|
*
|
|
84050
|
+
* The x scroll position.
|
|
84051
|
+
*
|
|
83251
84052
|
* Default value is `0`.
|
|
83252
84053
|
*
|
|
83253
84054
|
*
|
|
@@ -83257,6 +84058,8 @@ declare namespace sap {
|
|
|
83257
84058
|
/**
|
|
83258
84059
|
* Gets current value of property {@link #getY y}.
|
|
83259
84060
|
*
|
|
84061
|
+
* The y scroll position.
|
|
84062
|
+
*
|
|
83260
84063
|
* Default value is `0`.
|
|
83261
84064
|
*
|
|
83262
84065
|
*
|
|
@@ -83266,6 +84069,8 @@ declare namespace sap {
|
|
|
83266
84069
|
/**
|
|
83267
84070
|
* Sets a new value for property {@link #getX x}.
|
|
83268
84071
|
*
|
|
84072
|
+
* The x scroll position.
|
|
84073
|
+
*
|
|
83269
84074
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
83270
84075
|
*
|
|
83271
84076
|
* Default value is `0`.
|
|
@@ -83282,6 +84087,8 @@ declare namespace sap {
|
|
|
83282
84087
|
/**
|
|
83283
84088
|
* Sets a new value for property {@link #getY y}.
|
|
83284
84089
|
*
|
|
84090
|
+
* The y scroll position.
|
|
84091
|
+
*
|
|
83285
84092
|
* When called with a value of `null` or `undefined`, the default value of the property will be restored.
|
|
83286
84093
|
*
|
|
83287
84094
|
* Default value is `0`.
|
|
@@ -85830,8 +86637,13 @@ declare namespace sap {
|
|
|
85830
86637
|
* 'InteractionType'.
|
|
85831
86638
|
*/
|
|
85832
86639
|
enum InteractionType {
|
|
86640
|
+
/**
|
|
86641
|
+
* "EnterText" interaction type.
|
|
86642
|
+
*/
|
|
85833
86643
|
EnterText = "ENTER_TEXT",
|
|
85834
|
-
|
|
86644
|
+
/**
|
|
86645
|
+
* "Press" Interaction type.
|
|
86646
|
+
*/
|
|
85835
86647
|
Press = "PRESS",
|
|
85836
86648
|
}
|
|
85837
86649
|
/**
|
|
@@ -87113,6 +87925,27 @@ declare namespace sap {
|
|
|
87113
87925
|
* Use when there are multiple views with the same viewName.
|
|
87114
87926
|
*/
|
|
87115
87927
|
viewId?: string;
|
|
87928
|
+
/**
|
|
87929
|
+
* The namespace to be prepended to the view name defined in the `viewName` parameter. When set, all `waitFor`
|
|
87930
|
+
* calls inside the page object will resolve the view by `viewNamespace + "." + viewName`.
|
|
87931
|
+
*
|
|
87932
|
+
* Example:
|
|
87933
|
+
* ```javascript
|
|
87934
|
+
*
|
|
87935
|
+
* Opa5.createPageObjects({
|
|
87936
|
+
* onMyPage: {
|
|
87937
|
+
* viewName: "myView",
|
|
87938
|
+
* viewNamespace: "my.app.namespace",
|
|
87939
|
+
* assertions: { ... }
|
|
87940
|
+
* }
|
|
87941
|
+
* });
|
|
87942
|
+
* ```
|
|
87943
|
+
*
|
|
87944
|
+
*
|
|
87945
|
+
* Note: If all page objects share the same `viewNamespace`, consider setting it globally via {@link sap.ui.test.Opa5.extendConfig }
|
|
87946
|
+
* to avoid repetition.
|
|
87947
|
+
*/
|
|
87948
|
+
viewNamespace?: string;
|
|
87116
87949
|
/**
|
|
87117
87950
|
* Base class for the page object's actions and assertions
|
|
87118
87951
|
*/
|