Store.html
106 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The source code</title>
<link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
<script type="text/javascript" src="../resources/prettify/prettify.js"></script>
<style type="text/css">
.highlight { display: block; background-color: #ddd; }
</style>
<script type="text/javascript">
function highlight() {
document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
}
</script>
</head>
<body onload="prettyPrint(); highlight();">
<pre class="prettyprint lang-js"><span id='Ext-data-Store'>/**
</span> * The Store class encapsulates a client side cache of {@link Ext.data.Model Model} objects. Stores load data via a
* {@link Ext.data.proxy.Proxy Proxy}, and also provide functions for {@link #sort sorting}, {@link #filter filtering}
* and querying the {@link Ext.data.Model model} instances contained within it.
*
* Creating a Store is easy - we just tell it the Model and the Proxy to use to load and save its data:
*
* // Set up a {@link Ext.data.Model model} to use in our Store
* Ext.define('User', {
* extend: 'Ext.data.Model',
* fields: [
* {name: 'firstName', type: 'string'},
* {name: 'lastName', type: 'string'},
* {name: 'age', type: 'int'},
* {name: 'eyeColor', type: 'string'}
* ]
* });
*
* var myStore = Ext.create('Ext.data.Store', {
* model: 'User',
* proxy: {
* type: 'ajax',
* url: '/users.json',
* reader: {
* type: 'json',
* root: 'users'
* }
* },
* autoLoad: true
* });
*
* In the example above we configured an AJAX proxy to load data from the url '/users.json'. We told our Proxy to use a
* {@link Ext.data.reader.Json JsonReader} to parse the response from the server into Model object - {@link
* Ext.data.reader.Json see the docs on JsonReader} for details.
*
* ## Inline data
*
* Stores can also load data inline. Internally, Store converts each of the objects we pass in as {@link #cfg-data} into
* Model instances:
*
* Ext.create('Ext.data.Store', {
* model: 'User',
* data : [
* {firstName: 'Ed', lastName: 'Spencer'},
* {firstName: 'Tommy', lastName: 'Maintz'},
* {firstName: 'Aaron', lastName: 'Conran'},
* {firstName: 'Jamie', lastName: 'Avins'}
* ]
* });
*
* Loading inline data using the method above is great if the data is in the correct format already (e.g. it doesn't
* need to be processed by a {@link Ext.data.reader.Reader reader}). If your inline data requires processing to decode
* the data structure, use a {@link Ext.data.proxy.Memory MemoryProxy} instead (see the {@link Ext.data.proxy.Memory
* MemoryProxy} docs for an example).
*
* Additional data can also be loaded locally using {@link #method-add}.
*
* ## Dynamic Loading
*
* Stores can be dynamically updated by calling the {@link #method-load} method:
*
* store.load({
* params: {
* group: 3,
* type: 'user'
* },
* callback: function(records, operation, success) {
* // do something after the load finishes
* },
* scope: this
* });
*
* Here a bunch of arbitrary parameters is passed along with the load request and a callback function is set
* up to do something after the loading is over.
*
* ## Loading Nested Data
*
* Applications often need to load sets of associated data - for example a CRM system might load a User and her Orders.
* Instead of issuing an AJAX request for the User and a series of additional AJAX requests for each Order, we can load
* a nested dataset and allow the Reader to automatically populate the associated models. Below is a brief example, see
* the {@link Ext.data.reader.Reader} intro docs for a full explanation:
*
* var store = Ext.create('Ext.data.Store', {
* autoLoad: true,
* model: "User",
* proxy: {
* type: 'ajax',
* url: 'users.json',
* reader: {
* type: 'json',
* root: 'users'
* }
* }
* });
*
* Which would consume a response like this:
*
* {
* "users": [{
* "id": 1,
* "name": "Ed",
* "orders": [{
* "id": 10,
* "total": 10.76,
* "status": "invoiced"
* },{
* "id": 11,
* "total": 13.45,
* "status": "shipped"
* }]
* }]
* }
*
* See the {@link Ext.data.reader.Reader} intro docs for a full explanation.
*
* ## Filtering and Sorting
*
* Stores can be sorted and filtered - in both cases either remotely or locally. The {@link #sorters} and
* {@link #cfg-filters} are held inside {@link Ext.util.MixedCollection MixedCollection} instances to make them easy to manage.
* Usually it is sufficient to either just specify sorters and filters in the Store configuration or call {@link #sort}
* or {@link #filter}:
*
* var store = Ext.create('Ext.data.Store', {
* model: 'User',
* sorters: [{
* property: 'age',
* direction: 'DESC'
* }, {
* property: 'firstName',
* direction: 'ASC'
* }],
*
* filters: [{
* property: 'firstName',
* value: /Ed/
* }]
* });
*
* The new Store will keep the configured sorters and filters in the MixedCollection instances mentioned above. By
* default, sorting and filtering are both performed locally by the Store - see {@link #remoteSort} and
* {@link #remoteFilter} to allow the server to perform these operations instead.
*
* Filtering and sorting after the Store has been instantiated is also easy. Calling {@link #filter} adds another filter
* to the Store and automatically filters the dataset (calling {@link #filter} with no arguments simply re-applies all
* existing filters). Note that by default {@link #sortOnFilter} is set to true, which means that your sorters are
* automatically reapplied if using local sorting.
*
* store.filter('eyeColor', 'Brown');
*
* Change the sorting at any time by calling {@link #sort}:
*
* store.sort('height', 'ASC');
*
* Note that all existing sorters will be removed in favor of the new sorter data (if {@link #sort} is called with no
* arguments, the existing sorters are just reapplied instead of being removed). To keep existing sorters and add new
* ones, just add them to the MixedCollection:
*
* store.sorters.add(new Ext.util.Sorter({
* property : 'shoeSize',
* direction: 'ASC'
* }));
*
* store.sort();
*
* ## Registering with StoreManager
*
* Any Store that is instantiated with a {@link #storeId} will automatically be registed with the {@link
* Ext.data.StoreManager StoreManager}. This makes it easy to reuse the same store in multiple views:
*
* //this store can be used several times
* Ext.create('Ext.data.Store', {
* model: 'User',
* storeId: 'usersStore'
* });
*
* new Ext.List({
* store: 'usersStore',
* //other config goes here
* });
*
* new Ext.view.View({
* store: 'usersStore',
* //other config goes here
* });
*
* ## Further Reading
*
* Stores are backed up by an ecosystem of classes that enables their operation. To gain a full understanding of these
* pieces and how they fit together, see:
*
* - {@link Ext.data.proxy.Proxy Proxy} - overview of what Proxies are and how they are used
* - {@link Ext.data.Model Model} - the core class in the data package
* - {@link Ext.data.reader.Reader Reader} - used by any subclass of {@link Ext.data.proxy.Server ServerProxy} to read a response
*
* @author Ed Spencer
*/
Ext.define('Ext.data.Store', {
extend: 'Ext.data.AbstractStore',
alias: 'store.store',
// Required classes must be loaded before the definition callback runs
// The class definition callback creates a dummy Store which requires that
// all the classes below have been loaded.
requires: [
'Ext.data.StoreManager',
'Ext.data.Model',
'Ext.data.proxy.Ajax',
'Ext.data.proxy.Memory',
'Ext.data.reader.Json',
'Ext.data.writer.Json',
'Ext.util.LruCache'
],
uses: [
'Ext.ModelManager',
'Ext.util.Grouper'
],
remoteSort: false,
remoteFilter: false,
<span id='Ext-data-Store-cfg-remoteGroup'> /**
</span> * @cfg {Boolean} remoteGroup
* True if the grouping should apply on the server side, false if it is local only. If the
* grouping is local, it can be applied immediately to the data. If it is remote, then it will simply act as a
* helper, automatically sending the grouping information to the server.
*/
remoteGroup : false,
<span id='Ext-data-Store-cfg-proxy'> /**
</span> * @cfg {String/Ext.data.proxy.Proxy/Object} proxy
* The Proxy to use for this Store. This can be either a string, a config object or a Proxy instance -
* see {@link #setProxy} for details.
*/
<span id='Ext-data-Store-cfg-data'> /**
</span> * @cfg {Object[]/Ext.data.Model[]} data
* Array of Model instances or data objects to load locally. See "Inline data" above for details.
*/
<span id='Ext-data-Store-cfg-groupField'> /**
</span> * @cfg {String} groupField
* The field by which to group data in the store. Internally, grouping is very similar to sorting - the
* groupField and {@link #groupDir} are injected as the first sorter (see {@link #sort}). Stores support a single
* level of grouping, and groups can be fetched via the {@link #getGroups} method.
*/
groupField: undefined,
<span id='Ext-data-Store-cfg-groupDir'> /**
</span> * @cfg {String} groupDir
* The direction in which sorting should be applied when grouping. Supported values are "ASC" and "DESC".
*/
groupDir: "ASC",
<span id='Ext-data-Store-cfg-trailingBufferZone'> /**
</span> * @cfg {Number} trailingBufferZone
* When {@link #buffered}, the number of extra records to keep cached on the trailing side of scrolling buffer
* as scrolling proceeds. A larger number means fewer replenishments from the server.
*/
trailingBufferZone: 25,
<span id='Ext-data-Store-cfg-leadingBufferZone'> /**
</span> * @cfg {Number} leadingBufferZone
* When {@link #buffered}, the number of extra rows to keep cached on the leading side of scrolling buffer
* as scrolling proceeds. A larger number means fewer replenishments from the server.
*/
leadingBufferZone: 200,
<span id='Ext-data-Store-cfg-pageSize'> /**
</span> * @cfg {Number} pageSize
* The number of records considered to form a 'page'. This is used to power the built-in
* paging using the nextPage and previousPage functions when the grid is paged using a
* {@link Ext.toolbar.Paging PagingScroller} Defaults to 25.
*
* If this Store is {@link #buffered}, pages are loaded into a page cache before the Store's
* data is updated from the cache. The pageSize is the number of rows loaded into the cache in one request.
* This will not affect the rendering of a buffered grid, but a larger page size will mean fewer loads.
*
* In a buffered grid, scrolling is monitored, and the page cache is kept primed with data ahead of the
* direction of scroll to provide rapid access to data when scrolling causes it to be required. Several pages
* in advance may be requested depending on various parameters.
*
* It is recommended to tune the {@link #pageSize}, {@link #trailingBufferZone} and
* {@link #leadingBufferZone} configurations based upon the conditions pertaining in your deployed application.
*
* The provided SDK example `examples/grid/infinite-scroll-grid-tuner.html` can be used to experiment with
* different settings including simulating Ajax latency.
*/
pageSize: undefined,
<span id='Ext-data-Store-property-currentPage'> /**
</span> * @property {Number} currentPage
* The page that the Store has most recently loaded (see {@link #loadPage})
*/
currentPage: 1,
<span id='Ext-data-Store-cfg-clearOnPageLoad'> /**
</span> * @cfg {Boolean} clearOnPageLoad
* True to empty the store when loading another page via {@link #loadPage},
* {@link #nextPage} or {@link #previousPage}. Setting to false keeps existing records, allowing
* large data sets to be loaded one page at a time but rendered all together.
*/
clearOnPageLoad: true,
<span id='Ext-data-Store-property-loading'> /**
</span> * @property {Boolean} loading
* True if the Store is currently loading via its Proxy
* @private
*/
loading: false,
<span id='Ext-data-Store-cfg-sortOnFilter'> /**
</span> * @cfg {Boolean} sortOnFilter
* For local filtering only, causes {@link #sort} to be called whenever {@link #filter} is called,
* causing the sorters to be reapplied after filtering. Defaults to true
*/
sortOnFilter: true,
<span id='Ext-data-Store-cfg-buffered'> /**
</span> * @cfg {Boolean} buffered
* Allows the Store to prefetch and cache in a **page cache**, pages of Records, and to then satisfy
* loading requirements from this page cache.
*
* To use buffered Stores, initiate the process by loading the first page. The number of rows rendered are
* determined automatically, and the range of pages needed to keep the cache primed for scrolling is
* requested and cached.
* Example:
*
* // Load page 1
* myStore.loadPage(1);
*
* A {@link Ext.grid.PagingScroller PagingScroller} is instantiated which will monitor the scrolling in the grid, and
* refresh the view's rows from the page cache as needed. It will also pull new data into the page
* cache when scrolling of the view draws upon data near either end of the prefetched data.
*
* The margins which trigger view refreshing from the prefetched data are {@link Ext.grid.PagingScroller#numFromEdge},
* {@link Ext.grid.PagingScroller#leadingBufferZone} and {@link Ext.grid.PagingScroller#trailingBufferZone}.
*
* The margins which trigger loading more data into the page cache are, {@link #leadingBufferZone} and
* {@link #trailingBufferZone}.
*
* By defult, only 5 pages of data are cached in the page cache, with pages "scrolling" out of the buffer
* as the view moves down through the dataset.
* Setting this value to zero means that no pages are *ever* scrolled out of the page cache, and
* that eventually the whole dataset may become present in the page cache. This is sometimes desirable
* as long as datasets do not reach astronomical proportions.
*
* Selection state may be maintained across page boundaries by configuring the SelectionModel not to discard
* records from its collection when those Records cycle out of the Store's primary collection. This is done
* by configuring the SelectionModel like this:
*
* selModel: {
* pruneRemoved: false
* }
*
*/
buffered: false,
<span id='Ext-data-Store-cfg-purgePageCount'> /**
</span> * @cfg {Number} purgePageCount
* *Valid only when used with a {@link Ext.data.Store#buffered buffered} Store.*
*
* The number of pages *additional to the required buffered range* to keep in the prefetch cache before purging least recently used records.
*
* For example, if the height of the view area and the configured {@link #trailingBufferZone} and {@link #leadingBufferZone} require that there
* are three pages in the cache, then a `purgePageCount` of 5 ensures that up to 8 pages can be in the page cache any any one time.
*
* A value of 0 indicates to never purge the prefetched data.
*/
purgePageCount: 5,
<span id='Ext-data-Store-cfg-clearRemovedOnLoad'> /**
</span> * @cfg {Boolean} [clearRemovedOnLoad=true]
* True to clear anything in the {@link #removed} record collection when the store loads.
*/
clearRemovedOnLoad: true,
defaultPageSize: 25,
// Private. Used as parameter to loadRecords
addRecordsOptions: {
addRecords: true
},
statics: {
recordIdFn: function(record) {
return record.internalId;
},
recordIndexFn: function(record) {
return record.index;
}
},
onClassExtended: function(cls, data, hooks) {
var model = data.model,
onBeforeClassCreated;
if (typeof model == 'string') {
onBeforeClassCreated = hooks.onBeforeCreated;
hooks.onBeforeCreated = function() {
var me = this,
args = arguments;
Ext.require(model, function() {
onBeforeClassCreated.apply(me, args);
});
};
}
},
<span id='Ext-data-Store-method-constructor'> /**
</span> * Creates the store.
* @param {Object} [config] Config object
*/
constructor: function(config) {
// Clone the config so we don't modify the original config object
config = Ext.Object.merge({}, config);
var me = this,
groupers = config.groupers || me.groupers,
groupField = config.groupField || me.groupField,
proxy,
data;
<span id='Ext-data-Store-event-beforeprefetch'> /**
</span> * @event beforeprefetch
* Fires before a prefetch occurs. Return false to cancel.
* @param {Ext.data.Store} this
* @param {Ext.data.Operation} operation The associated operation
*/
<span id='Ext-data-Store-event-groupchange'> /**
</span> * @event groupchange
* Fired whenever the grouping in the grid changes
* @param {Ext.data.Store} store The store
* @param {Ext.util.Grouper[]} groupers The array of grouper objects
*/
<span id='Ext-data-Store-event-prefetch'> /**
</span> * @event prefetch
* Fires whenever records have been prefetched
* @param {Ext.data.Store} this
* @param {Ext.data.Model[]} records An array of records.
* @param {Boolean} successful True if the operation was successful.
* @param {Ext.data.Operation} operation The associated operation
*/
data = config.data || me.data;
<span id='Ext-data-Store-property-data'> /**
</span> * @property {Ext.util.MixedCollection} data
* The MixedCollection that holds this store's local cache of records.
*/
me.data = new Ext.util.MixedCollection(false, Ext.data.Store.recordIdFn);
if (data) {
me.inlineData = data;
delete config.data;
}
if (!groupers && groupField) {
groupers = [{
property : groupField,
direction: config.groupDir || me.groupDir
}];
}
delete config.groupers;
<span id='Ext-data-Store-property-groupers'> /**
</span> * @property {Ext.util.MixedCollection} groupers
* The collection of {@link Ext.util.Grouper Groupers} currently applied to this Store.
*/
me.groupers = new Ext.util.MixedCollection();
me.groupers.addAll(me.decodeGroupers(groupers));
this.callParent([config]);
// don't use *config* anymore from here on... use *me* instead...
if (me.buffered) {
<span id='Ext-data-Store-property-pageMap'> /**
</span> * @property {Ext.data.Store.PageMap} pageMap
* Internal PageMap instance.
* @private
*/
me.pageMap = new me.PageMap({
pageSize: me.pageSize,
maxSize: me.purgePageCount,
listeners: {
// Whenever PageMap gets cleared, it means we re no longer interested in
// any outstanding page prefetches, so cancel tham all
clear: me.cancelAllPrefetches,
scope: me
}
});
me.pageRequests = {};
me.sortOnLoad = false;
me.filterOnLoad = false;
}
// Only sort by group fields if we are doing local grouping
if (me.remoteGroup) {
me.remoteSort = true;
}
if (me.groupers.items.length && !me.remoteGroup) {
me.sort(me.groupers.items, 'prepend', false);
}
proxy = me.proxy;
data = me.inlineData;
// Page size for non-buffered Store defaults to 25
// For a buffered Store, the default page size is taken from the initial call to prefetch.
if (!me.buffered && !me.pageSize) {
me.pageSize = me.defaultPageSize;
}
if (data) {
if (proxy instanceof Ext.data.proxy.Memory) {
proxy.data = data;
me.read();
} else {
me.add.apply(me, [data]);
}
me.sort();
delete me.inlineData;
} else if (me.autoLoad) {
Ext.defer(me.load, 10, me, [ typeof me.autoLoad === 'object' ? me.autoLoad : undefined ]);
// Remove the defer call, we may need reinstate this at some point, but currently it's not obvious why it's here.
// this.load(typeof this.autoLoad == 'object' ? this.autoLoad : undefined);
}
},
// private override
// After destroying the Store, clear the page prefetch cache
destroyStore: function() {
this.callParent(arguments);
// Release cached pages.
// Will also cancel outstanding prefetch requests, and cause a generation change
// so that incoming prefetch data will be ignored.
if (this.pageMap) {
this.pageMap.clear();
}
},
onBeforeSort: function() {
var groupers = this.groupers;
if (groupers.getCount() > 0) {
this.sort(groupers.items, 'prepend', false);
}
},
<span id='Ext-data-Store-method-decodeGroupers'> /**
</span> * @private
* Normalizes an array of grouper objects, ensuring that they are all Ext.util.Grouper instances
* @param {Object[]} groupers The groupers array
* @return {Ext.util.Grouper[]} Array of Ext.util.Grouper objects
*/
decodeGroupers: function(groupers) {
if (!Ext.isArray(groupers)) {
if (groupers === undefined) {
groupers = [];
} else {
groupers = [groupers];
}
}
var length = groupers.length,
Grouper = Ext.util.Grouper,
config, i, result = [];
for (i = 0; i < length; i++) {
config = groupers[i];
if (!(config instanceof Grouper)) {
if (Ext.isString(config)) {
config = {
property: config
};
}
config = Ext.apply({
root : 'data',
direction: "ASC"
}, config);
//support for 3.x style sorters where a function can be defined as 'fn'
if (config.fn) {
config.sorterFn = config.fn;
}
//support a function to be passed as a sorter definition
if (typeof config == 'function') {
config = {
sorterFn: config
};
}
// return resulting Groupers in a separate array so as not to mutate passed in data objects.
result.push(new Grouper(config));
} else {
result.push(config);
}
}
return result;
},
<span id='Ext-data-Store-method-group'> /**
</span> * Groups data inside the store.
* @param {String/Object[]} groupers Either a string name of one of the fields in this Store's
* configured {@link Ext.data.Model Model}, or an Array of grouper configurations.
* @param {String} [direction="ASC"] The overall direction to group the data by.
*/
group: function(groupers, direction) {
var me = this,
hasNew = false,
grouper,
newGroupers;
if (Ext.isArray(groupers)) {
newGroupers = groupers;
} else if (Ext.isObject(groupers)) {
newGroupers = [groupers];
} else if (Ext.isString(groupers)) {
grouper = me.groupers.get(groupers);
if (!grouper) {
grouper = {
property : groupers,
direction: direction
};
newGroupers = [grouper];
} else if (direction === undefined) {
grouper.toggle();
} else {
grouper.setDirection(direction);
}
}
if (newGroupers && newGroupers.length) {
hasNew = true;
newGroupers = me.decodeGroupers(newGroupers);
me.groupers.clear();
me.groupers.addAll(newGroupers);
}
if (me.remoteGroup) {
if (me.buffered) {
me.pageMap.clear();
me.loadPage(1, { groupChange: true });
} else {
me.load({
scope: me,
callback: me.fireGroupChange
});
}
} else {
// need to explicitly force a sort if we have groupers
me.sort(null, null, null, hasNew);
me.fireGroupChange();
}
},
<span id='Ext-data-Store-method-clearGrouping'> /**
</span> * Clear any groupers in the store
*/
clearGrouping: function() {
var me = this,
groupers = me.groupers.items,
gLen = groupers.length,
grouper, g;
for (g = 0; g < gLen; g++) {
grouper = groupers[g];
me.sorters.remove(grouper);
}
me.groupers.clear();
if (me.remoteGroup) {
if (me.buffered) {
me.pageMap.clear();
me.loadPage(1, { groupChange: true });
} else {
me.load({
scope: me,
callback: me.fireGroupChange
});
}
} else {
me.sort();
me.fireGroupChange();
}
},
<span id='Ext-data-Store-method-isGrouped'> /**
</span> * Checks if the store is currently grouped
* @return {Boolean} True if the store is grouped.
*/
isGrouped: function() {
return this.groupers.getCount() > 0;
},
<span id='Ext-data-Store-method-fireGroupChange'> /**
</span> * Fires the groupchange event. Abstracted out so we can use it
* as a callback
* @private
*/
fireGroupChange: function() {
this.fireEvent('groupchange', this, this.groupers);
},
<span id='Ext-data-Store-method-getGroups'> /**
</span> * Returns an array containing the result of applying grouping to the records in this store.
* See {@link #groupField}, {@link #groupDir} and {@link #getGroupString}. Example for a store
* containing records with a color field:
*
* var myStore = Ext.create('Ext.data.Store', {
* groupField: 'color',
* groupDir : 'DESC'
* });
*
* myStore.getGroups(); // returns:
* [
* {
* name: 'yellow',
* children: [
* // all records where the color field is 'yellow'
* ]
* },
* {
* name: 'red',
* children: [
* // all records where the color field is 'red'
* ]
* }
* ]
*
* Group contents are effected by filtering.
*
* @param {String} [groupName] Pass in an optional groupName argument to access a specific
* group as defined by {@link #getGroupString}.
* @return {Object/Object[]} The grouped data
*/
getGroups: function(requestGroupString) {
var records = this.data.items,
length = records.length,
groups = [],
pointers = {},
record,
groupStr,
group,
i;
for (i = 0; i < length; i++) {
record = records[i];
groupStr = this.getGroupString(record);
group = pointers[groupStr];
if (group === undefined) {
group = {
name: groupStr,
children: []
};
groups.push(group);
pointers[groupStr] = group;
}
group.children.push(record);
}
return requestGroupString ? pointers[requestGroupString] : groups;
},
<span id='Ext-data-Store-method-getGroupsForGrouper'> /**
</span> * @private
* For a given set of records and a Grouper, returns an array of arrays - each of which is the set of records
* matching a certain group.
*/
getGroupsForGrouper: function(records, grouper) {
var length = records.length,
groups = [],
oldValue,
newValue,
record,
group,
i;
for (i = 0; i < length; i++) {
record = records[i];
newValue = grouper.getGroupString(record);
if (newValue !== oldValue) {
group = {
name: newValue,
grouper: grouper,
records: []
};
groups.push(group);
}
group.records.push(record);
oldValue = newValue;
}
return groups;
},
<span id='Ext-data-Store-method-getGroupsForGrouperIndex'> /**
</span> * @private
* This is used recursively to gather the records into the configured Groupers. The data MUST have been sorted for
* this to work properly (see {@link #getGroupData} and {@link #getGroupsForGrouper}) Most of the work is done by
* {@link #getGroupsForGrouper} - this function largely just handles the recursion.
*
* @param {Ext.data.Model[]} records The set or subset of records to group
* @param {Number} grouperIndex The grouper index to retrieve
* @return {Object[]} The grouped records
*/
getGroupsForGrouperIndex: function(records, grouperIndex) {
var me = this,
groupers = me.groupers,
grouper = groupers.getAt(grouperIndex),
groups = me.getGroupsForGrouper(records, grouper),
length = groups.length,
i;
if (grouperIndex + 1 < groupers.length) {
for (i = 0; i < length; i++) {
groups[i].children = me.getGroupsForGrouperIndex(groups[i].records, grouperIndex + 1);
}
}
for (i = 0; i < length; i++) {
groups[i].depth = grouperIndex;
}
return groups;
},
<span id='Ext-data-Store-method-getGroupData'> /**
</span> * @private
* Returns records grouped by the configured {@link #groupers grouper} configuration. Sample return value (in
* this case grouping by genre and then author in a fictional books dataset):
*
* [
* {
* name: 'Fantasy',
* depth: 0,
* records: [
* //book1, book2, book3, book4
* ],
* children: [
* {
* name: 'Rowling',
* depth: 1,
* records: [
* //book1, book2
* ]
* },
* {
* name: 'Tolkein',
* depth: 1,
* records: [
* //book3, book4
* ]
* }
* ]
* }
* ]
*
* @param {Boolean} [sort=true] True to call {@link #sort} before finding groups. Sorting is required to make grouping
* function correctly so this should only be set to false if the Store is known to already be sorted correctly.
* @return {Object[]} The group data
*/
getGroupData: function(sort) {
var me = this;
if (sort !== false) {
me.sort();
}
return me.getGroupsForGrouperIndex(me.data.items, 0);
},
<span id='Ext-data-Store-method-getGroupString'> /**
</span> * Returns the string to group on for a given model instance. The default implementation of this method returns
* the model's {@link #groupField}, but this can be overridden to group by an arbitrary string. For example, to
* group by the first letter of a model's 'name' field, use the following code:
*
* Ext.create('Ext.data.Store', {
* groupDir: 'ASC',
* getGroupString: function(instance) {
* return instance.get('name')[0];
* }
* });
*
* @param {Ext.data.Model} instance The model instance
* @return {String} The string to compare when forming groups
*/
getGroupString: function(instance) {
var group = this.groupers.first();
if (group) {
return instance.get(group.property);
}
return '';
},
<span id='Ext-data-Store-method-insert'> /**
</span> * Inserts Model instances into the Store at the given index and fires the {@link #event-add} event.
* See also {@link #method-add}.
*
* @param {Number} index The start index at which to insert the passed Records.
* @param {Ext.data.Model[]} records An Array of Ext.data.Model objects to add to the store.
*/
insert: function(index, records) {
var me = this,
sync = false,
i,
record,
len;
records = [].concat(records);
for (i = 0,len = records.length; i < len; i++) {
record = me.createModel(records[i]);
record.set(me.modelDefaults);
// reassign the model in the array in case it wasn't created yet
records[i] = record;
me.data.insert(index + i, record);
record.join(me);
sync = sync || record.phantom === true;
}
if (me.snapshot) {
me.snapshot.addAll(records);
}
if (me.requireSort) {
// suspend events so the usual data changed events don't get fired.
me.suspendEvents();
me.sort();
me.resumeEvents();
}
me.fireEvent('add', me, records, index);
me.fireEvent('datachanged', me);
if (me.autoSync && sync && !me.autoSyncSuspended) {
me.sync();
}
},
<span id='Ext-data-Store-method-add'> /**
</span> * Adds Model instance to the Store. This method accepts either:
*
* - An array of Model instances or Model configuration objects.
* - Any number of Model instance or Model configuration object arguments.
*
* The new Model instances will be added at the end of the existing collection.
*
* Sample usage:
*
* myStore.add({some: 'data'}, {some: 'other data'});
*
* Note that if this Store is sorted, the new Model instances will be inserted
* at the correct point in the Store to maintain the sort order.
*
* @param {Ext.data.Model[]/Ext.data.Model...} model An array of Model instances
* or Model configuration objects, or variable number of Model instance or config arguments.
* @return {Ext.data.Model[]} The model instances that were added
*/
add: function(records) {
//accept both a single-argument array of records, or any number of record arguments
if (!Ext.isArray(records)) {
records = Array.prototype.slice.apply(arguments);
} else {
// Create an array copy
records = records.slice(0);
}
var me = this,
i = 0,
length = records.length,
record,
isSorted = !me.remoteSort && me.sorters && me.sorters.items.length;
// If this Store is sorted, and they only passed one Record (99% or use cases)
// then it's much more efficient to add it sorted than to append and then sort.
if (isSorted && length === 1) {
return [ me.addSorted(me.createModel(records[0])) ];
}
for (; i < length; i++) {
record = me.createModel(records[i]);
// reassign the model in the array in case it wasn't created yet
records[i] = record;
}
// If this sort is sorted, set the flag used by the insert method to sort
// before firing events.
if (isSorted) {
me.requireSort = true;
}
me.insert(me.data.length, records);
delete me.requireSort;
return records;
},
<span id='Ext-data-Store-method-addSorted'> /**
</span> * (Local sort only) Inserts the passed Record into the Store at the index where it
* should go based on the current sort information.
*
* @param {Ext.data.Record} record
*/
addSorted: function(record) {
var me = this,
index = me.data.findInsertionIndex(record, me.generateComparator());
me.insert(index, record);
return record;
},
<span id='Ext-data-Store-method-createModel'> /**
</span> * Converts a literal to a model, if it's not a model already
* @private
* @param {Ext.data.Model/Object} record The record to create
* @return {Ext.data.Model}
*/
createModel: function(record) {
if (!record.isModel) {
record = Ext.ModelManager.create(record, this.model);
}
return record;
},
<span id='Ext-data-Store-method-each'> /**
</span> * Calls the specified function for each {@link Ext.data.Model record} in the store.
*
* When store is filtered, only loops over the filtered records.
*
* @param {Function} fn The function to call. The {@link Ext.data.Model Record} is passed as the first parameter.
* Returning `false` aborts and exits the iteration.
* @param {Object} [scope] The scope (this reference) in which the function is executed.
* Defaults to the current {@link Ext.data.Model record} in the iteration.
*/
each: function(fn, scope) {
var data = this.data.items,
dLen = data.length,
record, d;
for (d = 0; d < dLen; d++) {
record = data[d];
if (fn.call(scope || record, record, d, dLen) === false) {
break;
}
}
},
<span id='Ext-data-Store-method-remove'> /**
</span> * Removes the given record from the Store, firing the 'remove' event for each instance that is removed,
* plus a single 'datachanged' event after removal.
*
* @param {Ext.data.Model/Ext.data.Model[]} records Model instance or array of instances to remove.
*/
remove: function(records, /* private */ isMove) {
if (!Ext.isArray(records)) {
records = [records];
}
/*
* Pass the isMove parameter if we know we're going to be re-inserting this record
*/
isMove = isMove === true;
var me = this,
sync = false,
i = 0,
length = records.length,
isNotPhantom,
index,
record;
for (; i < length; i++) {
record = records[i];
index = me.data.indexOf(record);
if (me.snapshot) {
me.snapshot.remove(record);
}
if (index > -1) {
isNotPhantom = record.phantom !== true;
// don't push phantom records onto removed
if (!isMove && isNotPhantom) {
// Store the index the record was removed from so that rejectChanges can re-insert at the correct place.
// The record's index property won't do, as that is the index in the overall dataset when Store is buffered.
record.removedFrom = index;
me.removed.push(record);
}
record.unjoin(me);
me.data.remove(record);
sync = sync || isNotPhantom;
me.fireEvent('remove', me, record, index);
}
}
me.fireEvent('datachanged', me);
if (!isMove && me.autoSync && sync && !me.autoSyncSuspended) {
me.sync();
}
},
<span id='Ext-data-Store-method-removeAt'> /**
</span> * Removes the model instance at the given index
* @param {Number} index The record index
*/
removeAt: function(index) {
var record = this.getAt(index);
if (record) {
this.remove(record);
}
},
<span id='Ext-data-Store-method-load'> /**
</span> * Loads data into the Store via the configured {@link #proxy}. This uses the Proxy to make an
* asynchronous call to whatever storage backend the Proxy uses, automatically adding the retrieved
* instances into the Store and calling an optional callback if required. Example usage:
*
* store.load({
* scope: this,
* callback: function(records, operation, success) {
* // the {@link Ext.data.Operation operation} object
* // contains all of the details of the load operation
* console.log(records);
* }
* });
*
* If the callback scope does not need to be set, a function can simply be passed:
*
* store.load(function(records, operation, success) {
* console.log('loaded records');
* });
*
* @param {Object/Function} [options] config object, passed into the Ext.data.Operation object before loading.
* Additionally `addRecords: true` can be specified to add these records to the existing records, default is
* to remove the Store's existing records first.
*/
load: function(options) {
var me = this;
options = options || {};
if (typeof options == 'function') {
options = {
callback: options
};
}
options.groupers = options.groupers || me.groupers.items;
options.page = options.page || me.currentPage;
options.start = (options.start !== undefined) ? options.start : (options.page - 1) * me.pageSize;
options.limit = options.limit || me.pageSize;
options.addRecords = options.addRecords || false;
if (me.buffered) {
return me.loadToPrefetch(options);
}
return me.callParent([options]);
},
reload: function(options) {
var me = this,
startIdx,
endIdx,
startPage,
endPage,
i,
waitForReload,
bufferZone,
records;
if (!options) {
options = {};
}
// If buffered, we have to clear the page cache and then
// cache the page range surrounding store's loaded range.
if (me.buffered) {
// So that prefetchPage does not consider the store to be fully loaded if the local count is equal to the total count
delete me.totalCount;
waitForReload = function() {
if (me.rangeCached(startIdx, endIdx)) {
me.loading = false;
me.pageMap.un('pageAdded', waitForReload);
records = me.pageMap.getRange(startIdx, endIdx);
me.loadRecords(records, {
start: startIdx
});
me.fireEvent('load', me, records, true);
}
};
bufferZone = Math.ceil((me.leadingBufferZone + me.trailingBufferZone) / 2);
// Get our record index range in the dataset
startIdx = options.start || me.getAt(0).index;
endIdx = startIdx + (options.count || me.getCount()) - 1;
// Calculate a page range which encompasses the Store's loaded range plus both buffer zones
startPage = me.getPageFromRecordIndex(Math.max(startIdx - bufferZone, 0));
endPage = me.getPageFromRecordIndex(endIdx + bufferZone);
// Clear cache (with initial flag so that any listening PagingScroller does not reset to page 1).
me.pageMap.clear(true);
if (me.fireEvent('beforeload', me, options) !== false) {
me.loading = true;
// Recache the page range which encapsulates our visible records
for (i = startPage; i <= endPage; i++) {
me.prefetchPage(i, options);
}
// Wait for the requested range to become available in the page map
// Load the range as soon as the whole range is available
me.pageMap.on('pageAdded', waitForReload);
}
} else {
return me.callParent(arguments);
}
},
<span id='Ext-data-Store-method-onProxyLoad'> /**
</span> * @private
* Called internally when a Proxy has completed a load request
*/
onProxyLoad: function(operation) {
var me = this,
resultSet = operation.getResultSet(),
records = operation.getRecords(),
successful = operation.wasSuccessful();
if (resultSet) {
me.totalCount = resultSet.total;
}
if (successful) {
me.loadRecords(records, operation);
}
me.loading = false;
if (me.hasListeners.load) {
me.fireEvent('load', me, records, successful);
}
//TODO: deprecate this event, it should always have been 'load' instead. 'load' is now documented, 'read' is not.
//People are definitely using this so can't deprecate safely until 2.x
if (me.hasListeners.read) {
me.fireEvent('read', me, records, successful);
}
//this is a callback that would have been passed to the 'read' function and is optional
Ext.callback(operation.callback, operation.scope || me, [records, operation, successful]);
},
//inherit docs
getNewRecords: function() {
return this.data.filterBy(this.filterNew).items;
},
//inherit docs
getUpdatedRecords: function() {
return this.data.filterBy(this.filterUpdated).items;
},
<span id='Ext-data-Store-method-filter'> /**
</span> * Filters the loaded set of records by a given set of filters.
*
* By default, the passed filter(s) are *added* to the collection of filters being used to filter this Store.
*
* To remove existing filters before applying a new set of filters use
*
* // Clear the filter collection without updating the UI
* store.clearFilter(true);
*
* see {@link #clearFilter}.
*
* Alternatively, if filters are configured with an `id`, then existing filters store may be *replaced* by new
* filters having the same `id`.
*
* Filtering by single field:
*
* store.filter("email", /\.com$/);
*
* Using multiple filters:
*
* store.filter([
* {property: "email", value: /\.com$/},
* {filterFn: function(item) { return item.get("age") > 10; }}
* ]);
*
* Using Ext.util.Filter instances instead of config objects
* (note that we need to specify the {@link Ext.util.Filter#root root} config option in this case):
*
* store.filter([
* Ext.create('Ext.util.Filter', {property: "email", value: /\.com$/, root: 'data'}),
* Ext.create('Ext.util.Filter', {filterFn: function(item) { return item.get("age") > 10; }, root: 'data'})
* ]);
*
* When store is filtered, most of the methods for accessing store data will be working only
* within the set of filtered records. Two notable exceptions are {@link #queryBy} and
* {@link #getById}.
*
* @param {Object[]/Ext.util.Filter[]/String} filters The set of filters to apply to the data.
* These are stored internally on the store, but the filtering itself is done on the Store's
* {@link Ext.util.MixedCollection MixedCollection}. See MixedCollection's
* {@link Ext.util.MixedCollection#filter filter} method for filter syntax.
* Alternatively, pass in a property string
* @param {String} [value] value to filter by (only if using a property string as the first argument)
*/
filter: function(filters, value) {
if (Ext.isString(filters)) {
filters = {
property: filters,
value: value
};
}
var me = this,
decoded = me.decodeFilters(filters),
i = 0,
doLocalSort = me.sorters.length && me.sortOnFilter && !me.remoteSort,
length = decoded.length;
for (; i < length; i++) {
me.filters.replace(decoded[i]);
}
if (me.remoteFilter) {
// So that prefetchPage does not consider the store to be fully loaded if the local count is equal to the total count
delete me.totalCount;
// For a buffered Store, we have to clear the prefetch cache because the dataset will change upon filtering.
// Then we must prefetch the new page 1, and when that arrives, reload the visible part of the Store
// via the guaranteedrange event
if (me.buffered) {
me.pageMap.clear();
me.loadPage(1);
} else {
// Reset to the first page, the filter is likely to produce a smaller data set
me.currentPage = 1;
//the load function will pick up the new filters and request the filtered data from the proxy
me.load();
}
} else {
<span id='Ext-data-Store-property-snapshot'> /**
</span> * @property {Ext.util.MixedCollection} snapshot
* A pristine (unfiltered) collection of the records in this store. This is used to reinstate
* records when a filter is removed or changed
*/
if (me.filters.getCount()) {
me.snapshot = me.snapshot || me.data.clone();
me.data = me.data.filter(me.filters.items);
if (doLocalSort) {
me.sort();
} else {
// fire datachanged event if it hasn't already been fired by doSort
me.fireEvent('datachanged', me);
me.fireEvent('refresh', me);
}
}
}
},
<span id='Ext-data-Store-method-clearFilter'> /**
</span> * Reverts to a view of the Record cache with no filtering applied.
* @param {Boolean} suppressEvent If `true` the filter is cleared silently.
*
* For a locally filtered Store, this means that the filter collection is cleared without firing the
* {@link #datachanged} event.
*
* For a remotely filtered Store, this means that the filter collection is cleared, but the store
* is not reloaded from the server.
*/
clearFilter: function(suppressEvent) {
var me = this;
me.filters.clear();
if (me.remoteFilter) {
// In a buffered Store, the meaing of suppressEvent is to simply clear the filters collection
if (suppressEvent) {
return;
}
// So that prefetchPage does not consider the store to be fully loaded if the local count is equal to the total count
delete me.totalCount;
// For a buffered Store, we have to clear the prefetch cache because the dataset will change upon filtering.
// Then we must prefetch the new page 1, and when that arrives, reload the visible part of the Store
// via the guaranteedrange event
if (me.buffered) {
me.pageMap.clear();
me.loadPage(1);
} else {
// Reset to the first page, clearing a filter will destroy the context of the current dataset
me.currentPage = 1;
me.load();
}
} else if (me.isFiltered()) {
me.data = me.snapshot.clone();
delete me.snapshot;
if (suppressEvent !== true) {
me.fireEvent('datachanged', me);
me.fireEvent('refresh', me);
}
}
},
<span id='Ext-data-Store-method-isFiltered'> /**
</span> * Returns true if this store is currently filtered
* @return {Boolean}
*/
isFiltered: function() {
var snapshot = this.snapshot;
return !! snapshot && snapshot !== this.data;
},
<span id='Ext-data-Store-method-filterBy'> /**
</span> * Filters by a function. The specified function will be called for each
* Record in this Store. If the function returns `true` the Record is included,
* otherwise it is filtered out.
*
* When store is filtered, most of the methods for accessing store data will be working only
* within the set of filtered records. Two notable exceptions are {@link #queryBy} and
* {@link #getById}.
*
* @param {Function} fn The function to be called. It will be passed the following parameters:
* @param {Ext.data.Model} fn.record The record to test for filtering. Access field values
* using {@link Ext.data.Model#get}.
* @param {Object} fn.id The ID of the Record passed.
* @param {Object} [scope] The scope (this reference) in which the function is executed.
* Defaults to this Store.
*/
filterBy: function(fn, scope) {
var me = this;
me.snapshot = me.snapshot || me.data.clone();
me.data = me.queryBy(fn, scope || me);
me.fireEvent('datachanged', me);
me.fireEvent('refresh', me);
},
<span id='Ext-data-Store-method-queryBy'> /**
</span> * Query all the cached records in this Store using a filtering function. The specified function
* will be called with each record in this Store. If the function returns `true` the record is
* included in the results.
*
* This method is not effected by filtering, it will always look from all records inside the store
* no matter if filter is applied or not.
*
* @param {Function} fn The function to be called. It will be passed the following parameters:
* @param {Ext.data.Model} fn.record The record to test for filtering. Access field values
* using {@link Ext.data.Model#get}.
* @param {Object} fn.id The ID of the Record passed.
* @param {Object} [scope] The scope (this reference) in which the function is executed
* Defaults to this Store.
* @return {Ext.util.MixedCollection} Returns an Ext.util.MixedCollection of the matched records
*/
queryBy: function(fn, scope) {
var me = this,
data = me.snapshot || me.data;
return data.filterBy(fn, scope || me);
},
<span id='Ext-data-Store-method-query'> /**
</span> * Query all the cached records in this Store by name/value pair.
* The parameters will be used to generated a filter function that is given
* to the queryBy method.
*
* This method compliments queryBy by generating the query function automatically.
*
* @param {String} property The property to create the filter function for
* @param {String/RegExp} value The string/regex to compare the property value to
* @param {Boolean} [anyMatch=false] True if we don't care if the filter value is not the full value.
* @param {Boolean} [caseSensitive=false] True to create a case-sensitive regex.
* @param {Boolean} [exactMatch=false] True to force exact match (^ and $ characters added to the regex).
* Ignored if anyMatch is true.
* @return {Ext.util.MixedCollection} Returns an Ext.util.MixedCollection of the matched records
*/
query: function(property, value, anyMatch, caseSensitive, exactMatch) {
var me = this,
queryFn = me.createFilterFn(property, value, anyMatch, caseSensitive, exactMatch),
results = me.queryBy(queryFn);
//create an empty mixed collection for use if queryBy returns null
if(!results) {
results = new Ext.util.MixedCollection();
}
return results;
},
<span id='Ext-data-Store-method-loadData'> /**
</span> * Loads an array of data straight into the Store.
*
* Using this method is great if the data is in the correct format already (e.g. it doesn't need to be
* processed by a reader). If your data requires processing to decode the data structure, use a
* {@link Ext.data.proxy.Memory MemoryProxy} instead.
*
* @param {Ext.data.Model[]/Object[]} data Array of data to load. Any non-model instances will be cast
* into model instances first.
* @param {Boolean} [append=false] True to add the records to the existing records in the store, false
* to remove the old ones first.
*/
loadData: function(data, append) {
var me = this,
model = me.model,
length = data.length,
newData = [],
i,
record;
//make sure each data element is an Ext.data.Model instance
for (i = 0; i < length; i++) {
record = data[i];
if (!(record.isModel)) {
record = Ext.ModelManager.create(record, model);
}
newData.push(record);
}
me.loadRecords(newData, append ? me.addRecordsOptions : undefined);
},
<span id='Ext-data-Store-method-loadRawData'> /**
</span> * Loads data via the bound Proxy's reader
*
* Use this method if you are attempting to load data and want to utilize the configured data reader.
*
* @param {Object[]} data The full JSON object you'd like to load into the Data store.
* @param {Boolean} [append=false] True to add the records to the existing records in the store, false
* to remove the old ones first.
*/
loadRawData : function(data, append) {
var me = this,
result = me.proxy.reader.read(data),
records = result.records;
if (result.success) {
me.totalCount = result.total;
me.loadRecords(records, append ? me.addRecordsOptions : undefined);
me.fireEvent('load', me, records, true);
}
},
<span id='Ext-data-Store-method-loadRecords'> /**
</span> * Loads an array of {@link Ext.data.Model model} instances into the store, fires the datachanged event. This should only usually
* be called internally when loading from the {@link Ext.data.proxy.Proxy Proxy}, when adding records manually use {@link #method-add} instead
* @param {Ext.data.Model[]} records The array of records to load
* @param {Object} options
* @param {Boolean} [options.addRecords=false] Pass `true` to add these records to the existing records, `false` to remove the Store's existing records first.
* @param {Number} [options.start] Only used by buffered Stores. The index *within the overall dataset* of the first record in the array.
*/
loadRecords: function(records, options) {
var me = this,
i = 0,
length = records.length,
start,
addRecords,
snapshot = me.snapshot;
if (options) {
start = options.start;
addRecords = options.addRecords;
}
if (!addRecords) {
delete me.snapshot;
me.clearData(true);
} else if (snapshot) {
snapshot.addAll(records);
}
me.data.addAll(records);
if (start !== undefined) {
for (; i < length; i++) {
records[i].index = start + i;
records[i].join(me);
}
} else {
for (; i < length; i++) {
records[i].join(me);
}
}
/*
* this rather inelegant suspension and resumption of events is required because both the filter and sort functions
* fire an additional datachanged event, which is not wanted. Ideally we would do this a different way. The first
* datachanged event is fired by the call to this.add, above.
*/
me.suspendEvents();
if (me.filterOnLoad && !me.remoteFilter) {
me.filter();
}
if (me.sortOnLoad && !me.remoteSort) {
me.sort(undefined, undefined, undefined, true);
}
me.resumeEvents();
me.fireEvent('datachanged', me);
me.fireEvent('refresh', me);
},
// PAGING METHODS
<span id='Ext-data-Store-method-loadPage'> /**
</span> * Loads a given 'page' of data by setting the start and limit values appropriately. Internally this just causes a normal
* load operation, passing in calculated 'start' and 'limit' params
* @param {Number} page The number of the page to load
* @param {Object} options See options for {@link #method-load}
*/
loadPage: function(page, options) {
var me = this;
me.currentPage = page;
// Copy options into a new object so as not to mutate passed in objects
options = Ext.apply({
page: page,
start: (page - 1) * me.pageSize,
limit: me.pageSize,
addRecords: !me.clearOnPageLoad
}, options);
if (me.buffered) {
return me.loadToPrefetch(options);
}
me.read(options);
},
<span id='Ext-data-Store-method-nextPage'> /**
</span> * Loads the next 'page' in the current data set
* @param {Object} options See options for {@link #method-load}
*/
nextPage: function(options) {
this.loadPage(this.currentPage + 1, options);
},
<span id='Ext-data-Store-method-previousPage'> /**
</span> * Loads the previous 'page' in the current data set
* @param {Object} options See options for {@link #method-load}
*/
previousPage: function(options) {
this.loadPage(this.currentPage - 1, options);
},
// private
clearData: function(isLoad) {
var me = this,
records = me.data.items,
i = records.length;
while (i--) {
records[i].unjoin(me);
}
me.data.clear();
if (isLoad !== true || me.clearRemovedOnLoad) {
me.removed.length = 0;
}
},
loadToPrefetch: function(options) {
var me = this,
i,
records,
// Get the requested record index range in the dataset
startIdx = options.start,
endIdx = options.start + options.limit - 1,
// The end index to load into the store's live record collection
loadEndIdx = options.start + (me.viewSize || options.limit) - 1,
// Calculate a page range which encompasses the requested range plus both buffer zones
startPage = me.getPageFromRecordIndex(Math.max(startIdx - me.trailingBufferZone, 0)),
endPage = me.getPageFromRecordIndex(endIdx + me.leadingBufferZone),
// Wait for the viewable range to be available
waitForRequestedRange = function() {
if (me.rangeCached(startIdx, loadEndIdx)) {
me.loading = false;
records = me.pageMap.getRange(startIdx, loadEndIdx);
me.pageMap.un('pageAdded', waitForRequestedRange);
// If there is a listener for guranteedrange (PagingScroller uses this), then go through that event
if (me.hasListeners.guaranteedrange) {
me.guaranteeRange(startIdx, loadEndIdx, options.callback, options.scope);
}
// Otherwise load the records directly
else {
me.loadRecords(records, {
start: startIdx
});
}
me.fireEvent('load', me, records, true);
if (options.groupChange) {
me.fireGroupChange();
}
}
};
if (me.fireEvent('beforeload', me, options) !== false) {
// So that prefetchPage does not consider the store to be fully loaded if the local count is equal to the total count
delete me.totalCount;
me.loading = true;
// Wait for the requested range to become available in the page map
me.pageMap.on('pageAdded', waitForRequestedRange);
// Load the first page in the range, which will give us the initial total count.
// Once it is loaded, go ahead and prefetch any subsequent pages, if necessary.
// The prefetchPage has a check to prevent us loading more than the totalCount,
// so we don't want to blindly load up <n> pages where it isn't required.
me.on('prefetch', function(){
for (i = startPage + 1; i <= endPage; ++i) {
me.prefetchPage(i, options);
}
}, null, {single: true});
me.prefetchPage(startPage, options);
}
},
// Buffering
<span id='Ext-data-Store-method-prefetch'> /**
</span> * Prefetches data into the store using its configured {@link #proxy}.
* @param {Object} options (Optional) config object, passed into the Ext.data.Operation object before loading.
* See {@link #method-load}
*/
prefetch: function(options) {
var me = this,
pageSize = me.pageSize,
proxy,
operation;
// Check pageSize has not been tampered with. That would break page caching
if (pageSize) {
if (me.lastPageSize && pageSize != me.lastPageSize) {
Ext.error.raise("pageSize cannot be dynamically altered");
}
if (!me.pageMap.pageSize) {
me.pageMap.pageSize = pageSize;
}
}
// Allow first prefetch call to imply the required page size.
else {
me.pageSize = me.pageMap.pageSize = pageSize = options.limit;
}
// So that we can check for tampering next time through
me.lastPageSize = pageSize;
// Always get whole pages.
if (!options.page) {
options.page = me.getPageFromRecordIndex(options.start);
options.start = (options.page - 1) * pageSize;
options.limit = Math.ceil(options.limit / pageSize) * pageSize;
}
// Currently not requesting this page, then request it...
if (!me.pageRequests[options.page]) {
// Copy options into a new object so as not to mutate passed in objects
options = Ext.apply({
action : 'read',
filters: me.filters.items,
sorters: me.sorters.items,
groupers: me.groupers.items,
// Generation # of the page map to which the requested records belong.
// If page map is cleared while this request is in flight, the generation will increment and the payload will be rejected
generation: me.pageMap.generation
}, options);
operation = new Ext.data.Operation(options);
if (me.fireEvent('beforeprefetch', me, operation) !== false) {
me.loading = true;
proxy = me.proxy;
me.pageRequests[options.page] = proxy.read(operation, me.onProxyPrefetch, me);
if (proxy.isSynchronous) {
delete me.pageRequests[options.page];
}
}
}
return me;
},
<span id='Ext-data-Store-method-cancelAllPrefetches'> /**
</span> * @private
* Cancels all pending prefetch requests.
*
* This is called when the page map is cleared.
*
* Any requests which still make it through will be for the previous page map generation
* (generation is incremented upon clear), and so will be rejected upon arrival.
*/
cancelAllPrefetches: function() {
var me = this,
reqs = me.pageRequests,
req,
page;
// If any requests return, we no longer respond to them.
if (me.pageMap.events.pageadded) {
me.pageMap.events.pageadded.clearListeners();
}
// Cancel all outstanding requests
for (page in reqs) {
if (reqs.hasOwnProperty(page)) {
req = reqs[page];
delete reqs[page];
delete req.callback;
}
}
},
<span id='Ext-data-Store-method-prefetchPage'> /**
</span> * Prefetches a page of data.
* @param {Number} page The page to prefetch
* @param {Object} options (Optional) config object, passed into the Ext.data.Operation object before loading.
* See {@link #method-load}
*/
prefetchPage: function(page, options) {
var me = this,
pageSize = me.pageSize || me.defaultPageSize,
start = (page - 1) * me.pageSize,
total = me.totalCount;
// No more data to prefetch.
if (total !== undefined && me.getCount() === total) {
return;
}
// Copy options into a new object so as not to mutate passed in objects
me.prefetch(Ext.applyIf({
page : page,
start : start,
limit : pageSize
}, options));
},
<span id='Ext-data-Store-method-onProxyPrefetch'> /**
</span> * Called after the configured proxy completes a prefetch operation.
* @private
* @param {Ext.data.Operation} operation The operation that completed
*/
onProxyPrefetch: function(operation) {
var me = this,
resultSet = operation.getResultSet(),
records = operation.getRecords(),
successful = operation.wasSuccessful(),
page = operation.page;
// Only cache the data if the operation was invoked for the current generation of the page map.
// If the generation has changed since the request was fired off, it will have been cancelled.
if (operation.generation === me.pageMap.generation) {
if (resultSet) {
me.totalCount = resultSet.total;
me.fireEvent('totalcountchange', me.totalCount);
}
// Remove the loaded page from the outstanding pages hash
if (page !== undefined) {
delete me.pageRequests[page];
}
// Add the page into the page map.
// pageAdded event may trigger the onGuaranteedRange
if (successful) {
me.cachePage(records, operation.page);
}
me.loading = false;
me.fireEvent('prefetch', me, records, successful, operation);
//this is a callback that would have been passed to the 'read' function and is optional
Ext.callback(operation.callback, operation.scope || me, [records, operation, successful]);
}
},
<span id='Ext-data-Store-method-cachePage'> /**
</span> * Caches the records in the prefetch and stripes them with their server-side
* index.
* @private
* @param {Ext.data.Model[]} records The records to cache
* @param {Ext.data.Operation} The associated operation
*/
cachePage: function(records, page) {
var me = this;
if (!Ext.isDefined(me.totalCount)) {
me.totalCount = records.length;
me.fireEvent('totalcountchange', me.totalCount);
}
// Add the fetched page into the pageCache
me.pageMap.addPage(page, records);
},
<span id='Ext-data-Store-method-rangeCached'> /**
</span> * Determines if the passed range is available in the page cache.
* @private
* @param {Number} start The start index
* @param {Number} end The end index in the range
*/
rangeCached: function(start, end) {
return this.pageMap && this.pageMap.hasRange(start, end);
},
<span id='Ext-data-Store-method-pageCached'> /**
</span> * Determines if the passed page is available in the page cache.
* @private
* @param {Number} page The page to find in the page cache.
*/
pageCached: function(page) {
return this.pageMap && this.pageMap.hasPage(page);
},
<span id='Ext-data-Store-method-rangeSatisfied'> /**
</span> * Determines if the passed range is available in the page cache.
* @private
* @deprecated 4.1.0 use {@link #rangeCached} instead
* @param {Number} start The start index
* @param {Number} end The end index in the range
*/
rangeSatisfied: function(start, end) {
return this.rangeCached(start, end);
},
<span id='Ext-data-Store-method-getPageFromRecordIndex'> /**
</span> * Determines the page from a record index
* @param {Number} index The record index
* @return {Number} The page the record belongs to
*/
getPageFromRecordIndex: function(index) {
return Math.floor(index / this.pageSize) + 1;
},
<span id='Ext-data-Store-method-onGuaranteedRange'> /**
</span> * Handles a guaranteed range being loaded
* @private
*/
onGuaranteedRange: function(options) {
var me = this,
totalCount = me.getTotalCount(),
start = options.prefetchStart,
end = ((totalCount - 1) < options.prefetchEnd) ? totalCount - 1 : options.prefetchEnd,
range;
end = Math.max(0, end);
//<debug>
if (start > end) {
Ext.log({
level: 'warn',
msg: 'Start (' + start + ') was greater than end (' + end +
') for the range of records requested (' + start + '-' +
options.prefetchEnd + ')' + (this.storeId ? ' from store "' + this.storeId + '"' : '')
});
}
//</debug>
range = me.pageMap.getRange(start, end);
me.fireEvent('guaranteedrange', range, start, end);
if (options.cb) {
options.cb.call(options.scope || me, range, start, end);
}
},
<span id='Ext-data-Store-method-prefetchRange'> /**
</span> * Ensures that the specified range of rows is present in the cache.
*
* Converts the row range to a page range and then only load pages which are not already
* present in the page cache.
*/
prefetchRange: function(start, end) {
var me = this,
startPage, endPage, page;
if (!me.rangeCached(start, end)) {
startPage = me.getPageFromRecordIndex(start);
endPage = me.getPageFromRecordIndex(end);
// Ensure that the page cache's max size is correct.
// Our purgePageCount is the number of additional pages *outside of the required range* which
// may be kept in the cache. A purgePageCount of zero means unlimited.
me.pageMap.maxSize = me.purgePageCount ? (endPage - startPage + 1) + me.purgePageCount : 0;
// We have the range, but ensure that we have a "buffer" of pages around it.
for (page = startPage; page <= endPage; page++) {
if (!me.pageCached(page)) {
me.prefetchPage(page);
}
}
}
},
<span id='Ext-data-Store-method-guaranteeRange'> /**
</span> * Guarantee a specific range, this will load the store with a range (that
* must be the pageSize or smaller) and take care of any loading that may
* be necessary.
*/
guaranteeRange: function(start, end, cb, scope) {
// Sanity check end point to be within dataset range
end = (end > this.totalCount) ? this.totalCount - 1 : end;
var me = this,
lastRequestStart = me.lastRequestStart,
options = {
prefetchStart: start,
prefetchEnd: end,
cb: cb,
scope: scope
},
pageAddHandler;
me.lastRequestStart = start;
// If data request can be satisfied from the page cache
if (me.rangeCached(start, end)) {
// Attempt to keep the page cache primed with pages which encompass the live data range
if (start < lastRequestStart) {
start = Math.max(start - me.leadingBufferZone, 0);
end = Math.min(end + me.trailingBufferZone, me.totalCount - 1);
} else {
start = Math.max(Math.min(start - me.trailingBufferZone, me.totalCount - me.pageSize), 0);
end = Math.min(end + me.leadingBufferZone, me.totalCount - 1);
}
// If the prefetch window calculated round the requested range is not already satisfied in the page cache,
// then arrange to prefetch it.
if (!me.rangeCached(start, end)) {
// We have the range, but ensure that we have a "buffer" of pages around it.
me.prefetchRange(start, end);
}
me.onGuaranteedRange(options);
}
// At least some of the requested range needs loading from server
else {
// Private event used by the LoadMask class to perform masking when the range required for rendering is not found in the cache
me.fireEvent('cachemiss', me, start, end);
// Calculate a prefetch range which is centered on the requested data
start = Math.min(Math.max(Math.floor(start - ((me.leadingBufferZone + me.trailingBufferZone) / 2)), 0), me.totalCount - me.pageSize);
end = Math.min(Math.max(Math.ceil (end + ((me.leadingBufferZone + me.trailingBufferZone) / 2)), 0), me.totalCount - 1);
// Add a pageAdded listener, and as soon as the requested range is loaded, fire the guaranteedrange event
pageAddHandler = function(page, records) {
if (me.rangeCached(options.prefetchStart, options.prefetchEnd)) {
// Private event used by the LoadMask class to unmask when the range required for rendering has been loaded into the cache
me.fireEvent('cachefilled', me, start, end);
me.pageMap.un('pageAdded', pageAddHandler);
me.onGuaranteedRange(options);
}
};
me.pageMap.on('pageAdded', pageAddHandler);
// Prioritize the request for the *exact range that the UI is asking for*.
// When a page request is in flight, it will not be requested again by checking the me.pageRequests hash,
// so the request after this will only request the *remaining* unrequested pages .
me.prefetchRange(options.prefetchStart, options.prefetchEnd);
// Load the pages that need loading.
me.prefetchRange(start, end);
}
},
// because prefetchData is stored by index
// this invalidates all of the prefetchedData
sort: function() {
var me = this,
prefetchData = me.pageMap;
if (me.buffered) {
if (me.remoteSort) {
prefetchData.clear();
me.callParent(arguments);
} else {
me.callParent(arguments);
}
} else {
me.callParent(arguments);
}
},
// overriden to provide striping of the indexes as sorting occurs.
// this cannot be done inside of sort because datachanged has already
// fired and will trigger a repaint of the bound view.
doSort: function(sorterFn) {
var me = this,
range,
ln,
i;
if (me.remoteSort) {
// For a buffered Store, we have to clear the prefetch cache since it is keyed by the index within the dataset.
// Then we must prefetch the new page 1, and when that arrives, reload the visible part of the Store
// via the guaranteedrange event
if (me.buffered) {
me.pageMap.clear();
me.loadPage(1);
} else {
//the load function will pick up the new sorters and request the sorted data from the proxy
me.load();
}
} else {
me.data.sortBy(sorterFn);
if (!me.buffered) {
range = me.getRange();
ln = range.length;
for (i = 0; i < ln; i++) {
range[i].index = i;
}
}
me.fireEvent('datachanged', me);
me.fireEvent('refresh', me);
}
},
<span id='Ext-data-Store-method-find'> /**
</span> * Finds the index of the first matching Record in this store by a specific field value.
*
* When store is filtered, finds records only within filter.
*
* @param {String} fieldName The name of the Record field to test.
* @param {String/RegExp} value Either a string that the field value
* should begin with, or a RegExp to test against the field.
* @param {Number} [startIndex=0] The index to start searching at
* @param {Boolean} [anyMatch=false] True to match any part of the string, not just the beginning
* @param {Boolean} [caseSensitive=false] True for case sensitive comparison
* @param {Boolean} [exactMatch=false] True to force exact match (^ and $ characters added to the regex).
* @return {Number} The matched index or -1
*/
find: function(property, value, start, anyMatch, caseSensitive, exactMatch) {
var fn = this.createFilterFn(property, value, anyMatch, caseSensitive, exactMatch);
return fn ? this.data.findIndexBy(fn, null, start) : -1;
},
<span id='Ext-data-Store-method-findRecord'> /**
</span> * Finds the first matching Record in this store by a specific field value.
*
* When store is filtered, finds records only within filter.
*
* @param {String} fieldName The name of the Record field to test.
* @param {String/RegExp} value Either a string that the field value
* should begin with, or a RegExp to test against the field.
* @param {Number} [startIndex=0] The index to start searching at
* @param {Boolean} [anyMatch=false] True to match any part of the string, not just the beginning
* @param {Boolean} [caseSensitive=false] True for case sensitive comparison
* @param {Boolean} [exactMatch=false] True to force exact match (^ and $ characters added to the regex).
* @return {Ext.data.Model} The matched record or null
*/
findRecord: function() {
var me = this,
index = me.find.apply(me, arguments);
return index !== -1 ? me.getAt(index) : null;
},
<span id='Ext-data-Store-method-createFilterFn'> /**
</span> * @private
* Returns a filter function used to test a the given property's value. Defers most of the work to
* Ext.util.MixedCollection's createValueMatcher function.
*
* @param {String} property The property to create the filter function for
* @param {String/RegExp} value The string/regex to compare the property value to
* @param {Boolean} [anyMatch=false] True if we don't care if the filter value is not the full value.
* @param {Boolean} [caseSensitive=false] True to create a case-sensitive regex.
* @param {Boolean} [exactMatch=false] True to force exact match (^ and $ characters added to the regex).
* Ignored if anyMatch is true.
*/
createFilterFn: function(property, value, anyMatch, caseSensitive, exactMatch) {
if (Ext.isEmpty(value)) {
return false;
}
value = this.data.createValueMatcher(value, anyMatch, caseSensitive, exactMatch);
return function(r) {
return value.test(r.data[property]);
};
},
<span id='Ext-data-Store-method-findExact'> /**
</span> * Finds the index of the first matching Record in this store by a specific field value.
*
* When store is filtered, finds records only within filter.
*
* @param {String} fieldName The name of the Record field to test.
* @param {Object} value The value to match the field against.
* @param {Number} [startIndex=0] The index to start searching at
* @return {Number} The matched index or -1
*/
findExact: function(property, value, start) {
return this.data.findIndexBy(function(rec) {
return rec.isEqual(rec.get(property), value);
},
this, start);
},
<span id='Ext-data-Store-method-findBy'> /**
</span> * Find the index of the first matching Record in this Store by a function.
* If the function returns `true` it is considered a match.
*
* When store is filtered, finds records only within filter.
*
* @param {Function} fn The function to be called. It will be passed the following parameters:
* @param {Ext.data.Model} fn.record The record to test for filtering. Access field values
* using {@link Ext.data.Model#get}.
* @param {Object} fn.id The ID of the Record passed.
* @param {Object} [scope] The scope (this reference) in which the function is executed.
* Defaults to this Store.
* @param {Number} [startIndex=0] The index to start searching at
* @return {Number} The matched index or -1
*/
findBy: function(fn, scope, start) {
return this.data.findIndexBy(fn, scope, start);
},
<span id='Ext-data-Store-method-collect'> /**
</span> * Collects unique values for a particular dataIndex from this store.
*
* @param {String} dataIndex The property to collect
* @param {Boolean} [allowNull] Pass true to allow null, undefined or empty string values
* @param {Boolean} [bypassFilter] Pass true to collect from all records, even ones which are filtered.
* @return {Object[]} An array of the unique values
*/
collect: function(dataIndex, allowNull, bypassFilter) {
var me = this,
data = (bypassFilter === true && me.snapshot) ? me.snapshot : me.data;
return data.collect(dataIndex, 'data', allowNull);
},
<span id='Ext-data-Store-method-getCount'> /**
</span> * Gets the number of records in store.
*
* If using paging, this may not be the total size of the dataset. If the data object
* used by the Reader contains the dataset size, then the {@link #getTotalCount} function returns
* the dataset size. **Note**: see the Important note in {@link #method-load}.
*
* When store is filtered, it's the number of records matching the filter.
*
* @return {Number} The number of Records in the Store.
*/
getCount: function() {
return this.data.length || 0;
},
<span id='Ext-data-Store-method-getTotalCount'> /**
</span> * Returns the total number of {@link Ext.data.Model Model} instances that the {@link Ext.data.proxy.Proxy Proxy}
* indicates exist. This will usually differ from {@link #getCount} when using paging - getCount returns the
* number of records loaded into the Store at the moment, getTotalCount returns the number of records that
* could be loaded into the Store if the Store contained all data
* @return {Number} The total number of Model instances available via the Proxy. 0 returned if
* no value has been set via the reader.
*/
getTotalCount: function() {
return this.totalCount || 0;
},
<span id='Ext-data-Store-method-getAt'> /**
</span> * Get the Record at the specified index.
*
* The index is effected by filtering.
*
* @param {Number} index The index of the Record to find.
* @return {Ext.data.Model} The Record at the passed index. Returns undefined if not found.
*/
getAt: function(index) {
return this.data.getAt(index);
},
<span id='Ext-data-Store-method-getRange'> /**
</span> * Returns a range of Records between specified indices.
*
* This method is effected by filtering.
*
* @param {Number} [startIndex=0] The starting index
* @param {Number} [endIndex] The ending index. Defaults to the last Record in the Store.
* @return {Ext.data.Model[]} An array of Records
*/
getRange: function(start, end) {
return this.data.getRange(start, end);
},
<span id='Ext-data-Store-method-getById'> /**
</span> * Get the Record with the specified id.
*
* This method is not effected by filtering, lookup will be performed from all records
* inside the store, filtered or not.
*
* @param {Mixed} id The id of the Record to find.
* @return {Ext.data.Model} The Record with the passed id. Returns null if not found.
*/
getById: function(id) {
return (this.snapshot || this.data).findBy(function(record) {
return record.getId() === id;
});
},
<span id='Ext-data-Store-method-indexOf'> /**
</span> * Get the index of the record within the store.
*
* When store is filtered, records outside of filter will not be found.
*
* @param {Ext.data.Model} record The Ext.data.Model object to find.
* @return {Number} The index of the passed Record. Returns -1 if not found.
*/
indexOf: function(record) {
return this.data.indexOf(record);
},
<span id='Ext-data-Store-method-indexOfTotal'> /**
</span> * Get the index within the entire dataset. From 0 to the totalCount.
*
* Like #indexOf, this method is effected by filtering.
*
* @param {Ext.data.Model} record The Ext.data.Model object to find.
* @return {Number} The index of the passed Record. Returns -1 if not found.
*/
indexOfTotal: function(record) {
var index = record.index;
if (index || index === 0) {
return index;
}
return this.indexOf(record);
},
<span id='Ext-data-Store-method-indexOfId'> /**
</span> * Get the index within the store of the Record with the passed id.
*
* Like #indexOf, this method is effected by filtering.
*
* @param {String} id The id of the Record to find.
* @return {Number} The index of the Record. Returns -1 if not found.
*/
indexOfId: function(id) {
return this.indexOf(this.getById(id));
},
<span id='Ext-data-Store-method-removeAll'> /**
</span> * Removes all items from the store.
* @param {Boolean} silent Prevent the `clear` event from being fired.
*/
removeAll: function(silent) {
var me = this;
me.clearData();
if (me.snapshot) {
me.snapshot.clear();
}
// Special handling to synch the PageMap only for removeAll
// TODO: handle other store/data modifications WRT buffered Stores.
if (me.pageMap) {
me.pageMap.clear();
}
if (silent !== true) {
me.fireEvent('clear', me);
}
},
/*
* Aggregation methods
*/
<span id='Ext-data-Store-method-first'> /**
</span> * Convenience function for getting the first model instance in the store.
*
* When store is filtered, will return first item within the filter.
*
* @param {Boolean} [grouped] True to perform the operation for each group
* in the store. The value returned will be an object literal with the key being the group
* name and the first record being the value. The grouped parameter is only honored if
* the store has a groupField.
* @return {Ext.data.Model/undefined} The first model instance in the store, or undefined
*/
first: function(grouped) {
var me = this;
if (grouped && me.isGrouped()) {
return me.aggregate(function(records) {
return records.length ? records[0] : undefined;
}, me, true);
} else {
return me.data.first();
}
},
<span id='Ext-data-Store-method-last'> /**
</span> * Convenience function for getting the last model instance in the store.
*
* When store is filtered, will return last item within the filter.
*
* @param {Boolean} [grouped] True to perform the operation for each group
* in the store. The value returned will be an object literal with the key being the group
* name and the last record being the value. The grouped parameter is only honored if
* the store has a groupField.
* @return {Ext.data.Model/undefined} The last model instance in the store, or undefined
*/
last: function(grouped) {
var me = this;
if (grouped && me.isGrouped()) {
return me.aggregate(function(records) {
var len = records.length;
return len ? records[len - 1] : undefined;
}, me, true);
} else {
return me.data.last();
}
},
<span id='Ext-data-Store-method-sum'> /**
</span> * Sums the value of `property` for each {@link Ext.data.Model record} between `start`
* and `end` and returns the result.
*
* When store is filtered, only sums items within the filter.
*
* @param {String} field A field in each record
* @param {Boolean} [grouped] True to perform the operation for each group
* in the store. The value returned will be an object literal with the key being the group
* name and the sum for that group being the value. The grouped parameter is only honored if
* the store has a groupField.
* @return {Number} The sum
*/
sum: function(field, grouped) {
var me = this;
if (grouped && me.isGrouped()) {
return me.aggregate(me.getSum, me, true, [field]);
} else {
return me.getSum(me.data.items, field);
}
},
// @private, see sum
getSum: function(records, field) {
var total = 0,
i = 0,
len = records.length;
for (; i < len; ++i) {
total += records[i].get(field);
}
return total;
},
<span id='Ext-data-Store-method-count'> /**
</span> * Gets the count of items in the store.
*
* When store is filtered, only items within the filter are counted.
*
* @param {Boolean} [grouped] True to perform the operation for each group
* in the store. The value returned will be an object literal with the key being the group
* name and the count for each group being the value. The grouped parameter is only honored if
* the store has a groupField.
* @return {Number} the count
*/
count: function(grouped) {
var me = this;
if (grouped && me.isGrouped()) {
return me.aggregate(function(records) {
return records.length;
}, me, true);
} else {
return me.getCount();
}
},
<span id='Ext-data-Store-method-min'> /**
</span> * Gets the minimum value in the store.
*
* When store is filtered, only items within the filter are aggregated.
*
* @param {String} field The field in each record
* @param {Boolean} [grouped] True to perform the operation for each group
* in the store. The value returned will be an object literal with the key being the group
* name and the minimum in the group being the value. The grouped parameter is only honored if
* the store has a groupField.
* @return {Object} The minimum value, if no items exist, undefined.
*/
min: function(field, grouped) {
var me = this;
if (grouped && me.isGrouped()) {
return me.aggregate(me.getMin, me, true, [field]);
} else {
return me.getMin(me.data.items, field);
}
},
// @private, see min
getMin: function(records, field) {
var i = 1,
len = records.length,
value, min;
if (len > 0) {
min = records[0].get(field);
}
for (; i < len; ++i) {
value = records[i].get(field);
if (value < min) {
min = value;
}
}
return min;
},
<span id='Ext-data-Store-method-max'> /**
</span> * Gets the maximum value in the store.
*
* When store is filtered, only items within the filter are aggregated.
*
* @param {String} field The field in each record
* @param {Boolean} [grouped] True to perform the operation for each group
* in the store. The value returned will be an object literal with the key being the group
* name and the maximum in the group being the value. The grouped parameter is only honored if
* the store has a groupField.
* @return {Object} The maximum value, if no items exist, undefined.
*/
max: function(field, grouped) {
var me = this;
if (grouped && me.isGrouped()) {
return me.aggregate(me.getMax, me, true, [field]);
} else {
return me.getMax(me.data.items, field);
}
},
// @private, see max
getMax: function(records, field) {
var i = 1,
len = records.length,
value,
max;
if (len > 0) {
max = records[0].get(field);
}
for (; i < len; ++i) {
value = records[i].get(field);
if (value > max) {
max = value;
}
}
return max;
},
<span id='Ext-data-Store-method-average'> /**
</span> * Gets the average value in the store.
*
* When store is filtered, only items within the filter are aggregated.
*
* @param {String} field The field in each record
* @param {Boolean} [grouped] True to perform the operation for each group
* in the store. The value returned will be an object literal with the key being the group
* name and the group average being the value. The grouped parameter is only honored if
* the store has a groupField.
* @return {Object} The average value, if no items exist, 0.
*/
average: function(field, grouped) {
var me = this;
if (grouped && me.isGrouped()) {
return me.aggregate(me.getAverage, me, true, [field]);
} else {
return me.getAverage(me.data.items, field);
}
},
// @private, see average
getAverage: function(records, field) {
var i = 0,
len = records.length,
sum = 0;
if (records.length > 0) {
for (; i < len; ++i) {
sum += records[i].get(field);
}
return sum / len;
}
return 0;
},
<span id='Ext-data-Store-method-aggregate'> /**
</span> * Runs the aggregate function for all the records in the store.
*
* When store is filtered, only items within the filter are aggregated.
*
* @param {Function} fn The function to execute. The function is called with a single parameter,
* an array of records for that group.
* @param {Object} [scope] The scope to execute the function in. Defaults to the store.
* @param {Boolean} [grouped] True to perform the operation for each group
* in the store. The value returned will be an object literal with the key being the group
* name and the group average being the value. The grouped parameter is only honored if
* the store has a groupField.
* @param {Array} [args] Any arguments to append to the function call
* @return {Object} An object literal with the group names and their appropriate values.
*/
aggregate: function(fn, scope, grouped, args) {
args = args || [];
if (grouped && this.isGrouped()) {
var groups = this.getGroups(),
i = 0,
len = groups.length,
out = {},
group;
for (; i < len; ++i) {
group = groups[i];
out[group.name] = fn.apply(scope || this, [group.children].concat(args));
}
return out;
} else {
return fn.apply(scope || this, [this.data.items].concat(args));
}
},
<span id='Ext-data-Store-method-commitChanges'> /**
</span> * Commits all Records with {@link #getModifiedRecords outstanding changes}. To handle updates for changes,
* subscribe to the Store's {@link #event-update update event}, and perform updating when the third parameter is
* Ext.data.Record.COMMIT.
*/
commitChanges : function(){
var me = this,
recs = me.getModifiedRecords(),
len = recs.length,
i = 0;
for (; i < len; i++){
recs[i].commit();
}
// Since removals are cached in a simple array we can simply reset it here.
// Adds and updates are managed in the data MixedCollection and should already be current.
me.removed.length = 0;
},
filterNewOnly: function(item){
return item.phantom === true;
},
// Ideally in the future this will use getModifiedRecords, where there will be a param
// to getNewRecords & getUpdatedRecords to indicate whether to get only the valid
// records or grab all of them
getRejectRecords: function() {
// Return phantom records + updated records
return Ext.Array.push(this.data.filterBy(this.filterNewOnly).items, this.getUpdatedRecords());
},
<span id='Ext-data-Store-method-rejectChanges'> /**
</span> * {@link Ext.data.Model#reject Rejects} outstanding changes on all {@link #getModifiedRecords modified records}
* and re-insert any records that were removed locally. Any phantom records will be removed.
*/
rejectChanges : function() {
var me = this,
recs = me.getRejectRecords(),
len = recs.length,
i = 0,
rec;
for (; i < len; i++) {
rec = recs[i];
rec.reject();
if (rec.phantom) {
me.remove(rec);
}
}
// Restore removed records back to their original positions
recs = me.removed;
len = recs.length;
for (i = 0; i < len; i++) {
rec = recs[i];
me.insert(rec.removedFrom || 0, rec);
rec.reject();
}
// Since removals are cached in a simple array we can simply reset it here.
// Adds and updates are managed in the data MixedCollection and should already be current.
me.removed.length = 0;
}
}, function() {
// A dummy empty store with a fieldless Model defined in it.
// Just for binding to Views which are instantiated with no Store defined.
// They will be able to run and render fine, and be bound to a generated Store later.
Ext.regStore('ext-empty-store', {fields: [], proxy: 'memory'});
<span id='Ext-data-Store-PageMap'> /**
</span> * @class Ext.data.Store.PageMap
* @extends Ext.util.LruCache
* Private class for use by only Store when configured `buffered: true`.
* @private
*/
this.prototype.PageMap = new Ext.Class({
extend: 'Ext.util.LruCache',
// Maintain a generation counter, so that the Store can reject incoming pages destined for the previous generation
clear: function(initial) {
this.generation = (this.generation ||0) + 1;
this.callParent(arguments);
},
getPageFromRecordIndex: this.prototype.getPageFromRecordIndex,
addPage: function(page, records) {
this.add(page, records);
this.fireEvent('pageAdded', page, records);
},
getPage: function(page) {
return this.get(page);
},
hasRange: function(start, end) {
var page = this.getPageFromRecordIndex(start),
endPage = this.getPageFromRecordIndex(end);
for (; page <= endPage; page++) {
if (!this.hasPage(page)) {
return false;
}
}
return true;
},
hasPage: function(page) {
// We must use this.get to trigger an access so that the page which is checked for presence is not eligible for pruning
return !!this.get(page);
},
getRange: function(start, end) {
if (!this.hasRange(start, end)) {
Ext.Error.raise('PageMap asked for range which it does not have');
}
var me = this,
startPage = me.getPageFromRecordIndex(start),
endPage = me.getPageFromRecordIndex(end),
dataStart = (startPage - 1) * me.pageSize,
dataEnd = (endPage * me.pageSize) - 1,
page = startPage,
result = [],
sliceBegin, sliceEnd, doSlice,
i = 0, len;
for (; page <= endPage; page++) {
// First and last pages will need slicing to cut into the actual wanted records
if (page == startPage) {
sliceBegin = start - dataStart;
doSlice = true;
} else {
sliceBegin = 0;
doSlice = false;
}
if (page == endPage) {
sliceEnd = me.pageSize - (dataEnd - end);
doSlice = true;
}
// First and last pages will need slicing
if (doSlice) {
Ext.Array.push(result, Ext.Array.slice(me.getPage(page), sliceBegin, sliceEnd));
} else {
Ext.Array.push(result, me.getPage(page));
}
}
// Inject the dataset ordinal position into the record as the index
for (len = result.length; i < len; i++) {
result[i].index = start++;
}
return result;
}
});
});
</pre>
</body>
</html>