-
Notifications
You must be signed in to change notification settings - Fork 474
/
ListView.js
4662 lines (4116 loc) · 249 KB
/
ListView.js
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
// Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the MIT License. See License.txt in the project root for license information.
define([
'../Core/_Global',
'../Core/_Base',
'../Core/_BaseUtils',
'../Core/_ErrorFromName',
'../Core/_Events',
'../Core/_Log',
'../Core/_Resources',
'../Core/_WriteProfilerMark',
'../_Accents',
'../Animations',
'../Animations/_TransitionAnimation',
'../BindingList',
'../Promise',
'../Scheduler',
'../_Signal',
'../Utilities/_Control',
'../Utilities/_Dispose',
'../Utilities/_ElementUtilities',
'../Utilities/_Hoverable',
'../Utilities/_ItemsManager',
'../Utilities/_SafeHtml',
'../Utilities/_TabContainer',
'../Utilities/_UI',
'../Utilities/_VersionManager',
'./ElementResizeInstrument',
'./ItemContainer/_Constants',
'./ItemContainer/_ItemEventsHandler',
'./ListView/_BrowseMode',
'./ListView/_ErrorMessages',
'./ListView/_GroupFocusCache',
'./ListView/_GroupsContainer',
'./ListView/_Helpers',
'./ListView/_ItemsContainer',
'./ListView/_Layouts',
'./ListView/_SelectionManager',
'./ListView/_VirtualizeContentsView',
'require-style!less/styles-listview',
'require-style!less/colors-listview'
], function listViewImplInit(_Global, _Base, _BaseUtils, _ErrorFromName, _Events, _Log, _Resources, _WriteProfilerMark, _Accents, Animations, _TransitionAnimation, BindingList, Promise, Scheduler, _Signal, _Control, _Dispose, _ElementUtilities, _Hoverable, _ItemsManager, _SafeHtml, _TabContainer, _UI, _VersionManager, _ElementResizeInstrument, _Constants, _ItemEventsHandler, _BrowseMode, _ErrorMessages, _GroupFocusCache, _GroupsContainer, _Helpers, _ItemsContainer, _Layouts, _SelectionManager, _VirtualizeContentsView) {
"use strict";
_Accents.createAccentRule(
".win-listview:not(.win-selectionstylefilled) .win-selectioncheckmarkbackground,\
.win-itemcontainer:not(.win-selectionstylefilled) .win-selectioncheckmarkbackground", [
{ name: "border-color", value: _Accents.ColorTypes.accent },
{ name: "background-color", value: _Accents.ColorTypes.accent },
]);
_Accents.createAccentRule(
".win-listview:not(.win-selectionstylefilled) .win-container.win-selected .win-selectionborder,\
.win-itemcontainer:not(.win-selectionstylefilled).win-container.win-selected .win-selectionborder", [
{ name: "border-color", value: _Accents.ColorTypes.accent },
]);
_Accents.createAccentRule(
".win-listview.win-selectionstylefilled .win-selected .win-selectionbackground,\
.win-itemcontainer.win-selectionstylefilled.win-selected .win-selectionbackground", [
{ name: "background-color", value: _Accents.ColorTypes.accent }
]);
var transformNames = _BaseUtils._browserStyleEquivalents["transform"];
var DISPOSE_TIMEOUT = 1000;
var controlsToDispose = [];
var disposeControlTimeout;
var uniqueID = _ElementUtilities._uniqueID;
function disposeControls() {
var temp = controlsToDispose;
controlsToDispose = [];
temp = temp.filter(function (c) {
if (c._isZombie()) {
c._dispose();
return false;
} else {
return true;
}
});
controlsToDispose = controlsToDispose.concat(temp);
}
function scheduleForDispose(lv) {
controlsToDispose.push(lv);
disposeControlTimeout && disposeControlTimeout.cancel();
disposeControlTimeout = Promise.timeout(DISPOSE_TIMEOUT).then(disposeControls);
}
function getOffsetRight(element) {
return element.offsetParent ? (element.offsetParent.offsetWidth - element.offsetLeft - element.offsetWidth) : 0;
}
var strings = {
get notCompatibleWithSemanticZoom() { return "ListView can only be used with SemanticZoom if randomAccess loading behavior is specified."; },
get listViewInvalidItem() { return "Item must provide index, key or description of corresponding item."; },
get listViewViewportAriaLabel() { return _Resources._getWinJSString("ui/listViewViewportAriaLabel").value; }
};
var requireSupportedForProcessing = _BaseUtils.requireSupportedForProcessing;
var ListViewAnimationType = {
/// <field locid="WinJS.UI.ListView.ListViewAnimationType.entrance" helpKeyword="WinJS.UI.ListViewAnimationType.entrance">
/// The animation plays when the ListView is first displayed.
/// </field>
entrance: "entrance",
/// <field locid="WinJS.UI.ListView.ListViewAnimationType.contentTransition" helpKeyword="WinJS.UI.ListViewAnimationType.contentTransition">
/// The animation plays when the ListView is changing its content.
/// </field>
contentTransition: "contentTransition"
};
// ListView implementation
_Base.Namespace.define("WinJS.UI", {
/// <field locid="WinJS.UI.ListView.ListViewAnimationType" helpKeyword="WinJS.UI.ListViewAnimationType">
/// Specifies whether the ListView animation is an entrance animation or a transition animation.
/// <compatibleWith platform="Windows" minVersion="8.0"/>
/// </field>
ListViewAnimationType: ListViewAnimationType,
/// <field>
/// <summary locid="WinJS.UI.ListView">
/// Displays items in a customizable list or grid.
/// </summary>
/// </field>
/// <icon src="ui_winjs.ui.listview.12x12.png" width="12" height="12" />
/// <icon src="ui_winjs.ui.listview.16x16.png" width="16" height="16" />
/// <htmlSnippet><![CDATA[<div data-win-control="WinJS.UI.ListView"></div>]]></htmlSnippet>
/// <event name="contentanimating" bubbles="true" locid="WinJS.UI.ListView_e:contentanimating">Raised when the ListView is about to play an entrance or a transition animation.</event>
/// <event name="iteminvoked" bubbles="true" locid="WinJS.UI.ListView_e:iteminvoked">Raised when the user taps or clicks an item.</event>
/// <event name="groupheaderinvoked" bubbles="true" locid="WinJS.UI.ListView_e:groupheaderinvoked">Raised when the user taps or clicks a group header.</event>
/// <event name="selectionchanging" bubbles="true" locid="WinJS.UI.ListView_e:selectionchanging">Raised before items are selected or deselected.</event>
/// <event name="selectionchanged" bubbles="true" locid="WinJS.UI.ListView_e:selectionchanged">Raised after items are selected or deselected.</event>
/// <event name="loadingstatechanged" bubbles="true" locid="WinJS.UI.ListView_e:loadingstatechanged">Raised when the loading state changes.</event>
/// <event name="keyboardnavigating" bubbles="true" locid="WinJS.UI.ListView_e:keyboardnavigating">Raised when the focused item changes.</event>
/// <event name="itemdragstart" bubbles="true" locid="WinJS.UI.ListView_e:itemdragstart">Raised when the the user begins dragging ListView items.</event>
/// <event name="itemdragenter" bubbles="true" locid="WinJS.UI.ListView_e:itemdragenter">Raised when the user drags into the ListView.</event>
/// <event name="itemdragend" bubbles="true" locid="WinJS.UI.ListView_e:itemdragend">Raised when a drag operation begun in a ListView ends.</event>
/// <event name="itemdragbetween" bubbles="true" locid="WinJS.UI.ListView_e:itemdragbetween">Raised when the user drags between two ListView items.</event>
/// <event name="itemdragleave" bubbles="true" locid="WinJS.UI.ListView_e:itemdragleave">Raised when the user drags outside of the ListView region.</event>
/// <event name="itemdragchanged" bubbles="true" locid="WinJS.UI.ListView_e:itemdragchanged">Raised when the items being dragged are changed due to a datasource modification.</event>
/// <event name="itemdragdrop" bubbles="true" locid="WinJS.UI.ListView_e:itemdragdrop">Raised when the user drops items into the ListView.</event>
/// <event name="headervisibilitychanged" bubbles="true" locid="WinJS.UI.ListView_e:headervisibilitychanged">Raised when the header's visibility property changes. </event>
/// <event name="footervisibilitychanged" bubbles="true" locid="WinJS.UI.ListView_e:footervisibilitychanged">Raised when the footer's visibility property changes. </event>
/// <event name="accessibilityannotationcomplete" bubbles="true" locid="WinJS.UI.ListView_e:accessibilityannotationcomplete">Raised when the accessibility attributes have been added to the ListView items.</event>
/// <part name="listView" class="win-listview" locid="WinJS.UI.ListView_part:listView">The entire ListView control.</part>
/// <part name="viewport" class="win-viewport" locid="WinJS.UI.ListView_part:viewport">The viewport of the ListView. </part>
/// <part name="surface" class="win-surface" locid="WinJS.UI.ListView_part:surface">The scrollable region of the ListView.</part>
/// <part name="item" class="win-item" locid="WinJS.UI.ListView_part:item">An item in the ListView.</part>
/// <part name="selectionbackground" class="win-selectionbackground" locid="WinJS.UI.ListView_part:selectionbackground">The background of a selection checkmark.</part>
/// <part name="selectioncheckmark" class="win-selectioncheckmark" locid="WinJS.UI.ListView_part:selectioncheckmark">A selection checkmark.</part>
/// <part name="groupHeader" class="win-groupheader" locid="WinJS.UI.ListView_part:groupHeader">The header of a group.</part>
/// <part name="progressbar" class="win-progress" locid="WinJS.UI.ListView_part:progressbar">The progress indicator of the ListView.</part>
/// <resource type="javascript" src="//$(TARGET_DESTINATION)/js/WinJS.js" shared="true" />
/// <resource type="css" src="//$(TARGET_DESTINATION)/css/ui-dark.css" shared="true" />
ListView: _Base.Namespace._lazy(function () {
var AffectedRange = _Base.Class.define(function () {
this.clear();
}, {
// Marks the union of the current affected range and range as requiring layout
add: function (range, itemsCount) {
range._lastKnownSizeOfData = itemsCount; // store this in order to make unions.
if (!this._range) {
this._range = range;
} else {
// Take the union of these two ranges.
this._range.start = Math.min(this._range.start, range.start);
// To accurately calculate the new unioned range 'end' value, we need to convert the current and new range end
// positions into values that represent the remaining number of un-modified items in between the end of the range
// and the end of the list of data.
var previousUnmodifiedItemsFromEnd = (this._range._lastKnownSizeOfData - this._range.end);
var newUnmodifiedItemsFromEnd = (range._lastKnownSizeOfData - range.end);
var finalUnmodifiedItemsFromEnd = Math.min(previousUnmodifiedItemsFromEnd, newUnmodifiedItemsFromEnd);
this._range._lastKnownSizeOfData = range._lastKnownSizeOfData;
// Convert representation of the unioned end position back into a value which matches the above definition of _affecteRange.end
this._range.end = this._range._lastKnownSizeOfData - finalUnmodifiedItemsFromEnd;
}
},
// Marks everything as requiring layout
addAll: function () {
this.add({ start: 0, end: Number.MAX_VALUE }, Number.MAX_VALUE);
},
// Marks nothing as requiring layout
clear: function () {
this._range = null;
},
get: function () {
return this._range;
}
});
var ZoomableView = _Base.Class.define(function ZoomableView_ctor(listView) {
// Constructor
this._listView = listView;
}, {
// Public methods
getPanAxis: function () {
return this._listView._getPanAxis();
},
configureForZoom: function (isZoomedOut, isCurrentView, triggerZoom, prefetchedPages) {
this._listView._configureForZoom(isZoomedOut, isCurrentView, triggerZoom, prefetchedPages);
},
setCurrentItem: function (x, y) {
this._listView._setCurrentItem(x, y);
},
getCurrentItem: function () {
return this._listView._getCurrentItem();
},
beginZoom: function () {
return this._listView._beginZoom();
},
positionItem: function (item, position) {
return this._listView._positionItem(item, position);
},
endZoom: function (isCurrentView) {
this._listView._endZoom(isCurrentView);
},
pinching: {
get: function () {
return this._listView._pinching;
},
set: function (value) {
this._listView._pinching = value;
}
}
});
var ListView = _Base.Class.define(function ListView_ctor(element, options) {
/// <signature helpKeyword="WinJS.UI.ListView.ListView">
/// <summary locid="WinJS.UI.ListView.constructor">
/// Creates a new ListView.
/// </summary>
/// <param name="element" domElement="true" locid="WinJS.UI.ListView.constructor_p:element">
/// The DOM element that hosts the ListView control.
/// </param>
/// <param name="options" type="Object" locid="WinJS.UI.ListView.constructor_p:options">
/// An object that contains one or more property/value pairs to apply to the new control.
/// Each property of the options object corresponds to one of the control's properties or events.
/// Event names must begin with "on". For example, to provide a handler for the selectionchanged event,
/// add a property named "onselectionchanged" to the options object and set its value to the event handler.
/// </param>
/// <returns type="WinJS.UI.ListView" locid="WinJS.UI.ListView.constructor_returnValue">
/// The new ListView.
/// </returns>
/// </signature>
element = element || _Global.document.createElement("div");
this._id = element.id || "";
this._writeProfilerMark("constructor,StartTM");
options = options || {};
// Attaching JS control to DOM element
element.winControl = this;
_ElementUtilities.addClass(element, "win-disposable");
this._affectedRange = new AffectedRange();
this._mutationObserver = new _ElementUtilities._MutationObserver(this._itemPropertyChange.bind(this));
this._versionManager = null;
this._insertedItems = {};
this._element = element;
this._startProperty = null;
this._scrollProperty = null;
this._scrollLength = null;
this._scrolling = false;
this._zooming = false;
this._pinching = false;
this._itemsManager = null;
this._canvas = null;
this._cachedCount = _Constants._UNINITIALIZED;
this._loadingState = this._LoadingState.complete;
this._firstTimeDisplayed = true;
this._currentScrollPosition = 0;
this._lastScrollPosition = 0;
this._notificationHandlers = [];
this._itemsBlockExtent = -1;
this._lastFocusedElementInGroupTrack = { type: _UI.ObjectType.item, index: -1 };
this._headerFooterVisibilityStatus = { headerVisible: false, footerVisible: false };
this._viewportWidth = _Constants._UNINITIALIZED;
this._viewportHeight = _Constants._UNINITIALIZED;
this._manipulationState = _ElementUtilities._MSManipulationEvent.MS_MANIPULATION_STATE_STOPPED;
this._maxDeferredItemCleanup = Number.MAX_VALUE;
this._groupsToRemove = {};
this._setupInternalTree();
this._isCurrentZoomView = true;
this._dragSource = false;
this._reorderable = false;
this._groupFocusCache = new _GroupFocusCache._UnsupportedGroupFocusCache();
this._viewChange = _Constants._ViewChange.rebuild;
this._scrollToFunctor = null;
this._setScrollbarPosition = false;
// The view needs to be initialized after the internal tree is setup, because the view uses the canvas node immediately to insert an element in its constructor
this._view = new _VirtualizeContentsView._VirtualizeContentsView(this);
this._selection = new _SelectionManager._SelectionManager(this);
this._createTemplates();
this._groupHeaderRenderer = _ItemsManager._trivialHtmlRenderer;
this._itemRenderer = _ItemsManager._trivialHtmlRenderer;
this._groupHeaderRelease = null;
this._itemRelease = null;
if (!options.itemDataSource) {
var list = new BindingList.List();
this._dataSource = list.dataSource;
} else {
this._dataSource = options.itemDataSource;
}
this._selectionMode = _UI.SelectionMode.multi;
this._tap = _UI.TapBehavior.invokeOnly;
this._groupHeaderTap = _UI.GroupHeaderTapBehavior.invoke;
this._mode = new _BrowseMode._SelectionMode(this);
this._groups = new _GroupsContainer._NoGroups(this);
this._updateItemsAriaRoles();
this._updateGroupHeadersAriaRoles();
this._element.setAttribute("aria-multiselectable", this._multiSelection());
this._element.tabIndex = -1;
this._tabManager.tabIndex = this._tabIndex;
if (this._element.style.position !== "absolute" && this._element.style.position !== "relative") {
this._element.style.position = "relative";
}
this._updateItemsManager();
if (!options.layout) {
this._updateLayout(new _Layouts.GridLayout());
}
this._attachEvents();
this._runningInit = true;
_Control.setOptions(this, options);
this._runningInit = false;
this._batchViewUpdates(_Constants._ViewChange.rebuild, _Constants._ScrollToPriority.medium, 0);
this._writeProfilerMark("constructor,StopTM");
}, {
// Public properties
/// <field type="HTMLElement" domElement="true" hidden="true" locid="WinJS.UI.ListView.element" helpKeyword="WinJS.UI.ListView.element">
/// Gets the DOM element that hosts the ListView.
/// </field>
element: {
get: function () { return this._element; }
},
/// <field type="WinJS.UI.Layout" locid="WinJS.UI.ListView.layout" helpKeyword="WinJS.UI.ListView.layout">
/// Gets or sets an object that controls the layout of the ListView.
/// </field>
layout: {
get: function () {
return this._layoutImpl;
},
set: function (layoutObject) {
this._updateLayout(layoutObject);
if (!this._runningInit) {
this._view.reset();
this._updateItemsManager();
this._batchViewUpdates(_Constants._ViewChange.rebuild, _Constants._ScrollToPriority.medium, 0, true);
}
}
},
/// <field type="Number" integer="true" locid="WinJS.UI.ListView.maxLeadingPages" helpKeyword="WinJS.UI.ListView.maxLeadingPages" isAdvanced="true">
/// Gets or sets the maximum number of pages to prefetch in the leading buffer for virtualization.
/// </field>
maxLeadingPages: {
get: function ListView_getMaxLeadingPages() {
return this._view.maxLeadingPages;
},
set: function ListView_setMaxLeadingPages(value) {
this._view.maxLeadingPages = Math.max(0, Math.floor(value));
},
},
/// <field type="Number" integer="true" locid="WinJS.UI.ListView.maxTrailingPages" helpKeyword="WinJS.UI.ListView.maxTrailingPages" isAdvanced="true">
/// Gets or sets the maximum number of pages to prefetch in the trailing buffer for virtualization.
/// </field>
maxTrailingPages: {
get: function ListView_getMaxTrailingPages() {
return this._view.maxTrailingPages;
},
set: function ListView_setMaxTrailingPages(value) {
this._view.maxTrailingPages = Math.max(0, Math.floor(value));
},
},
/// <field type="Number" integer="true" locid="WinJS.UI.ListView.pagesToLoad" helpKeyword="WinJS.UI.ListView.pagesToLoad" isAdvanced="true">
/// Gets or sets the number of pages to load when the user scrolls beyond the
/// threshold specified by the pagesToLoadThreshold property if
/// the loadingBehavior property is set to incremental.
/// <deprecated type="deprecate">
/// pagesToLoad is deprecated. The control will not use this property. Please refer to the 'ListView loading behaviors' SDK Sample for guidance on how to implement incremental load behavior.
/// </deprecated>
/// </field>
pagesToLoad: {
get: function () {
return (_VirtualizeContentsView._VirtualizeContentsView._defaultPagesToPrefetch * 2) + 1;
},
set: function () {
_ElementUtilities._deprecated(_ErrorMessages.pagesToLoadIsDeprecated);
}
},
/// <field type="Number" integer="true" locid="WinJS.UI.ListView.pagesToLoadThreshold" helpKeyword="WinJS.UI.ListView.pagesToLoadThreshold" isAdvanced="true">
/// Gets or sets the threshold (in pages) for initiating an incremental load. When the last visible item is
/// within the specified number of pages from the end of the loaded portion of the list,
/// and if automaticallyLoadPages is true and loadingBehavior is set to "incremental",
/// the ListView initiates an incremental load.
/// <deprecated type="deprecate">
/// pagesToLoadThreshold is deprecated. The control will not use this property. Please refer to the 'ListView loading behaviors' SDK Sample for guidance on how to implement incremental load behavior.
/// </deprecated>
/// </field>
pagesToLoadThreshold: {
get: function () {
return 0;
},
set: function () {
_ElementUtilities._deprecated(_ErrorMessages.pagesToLoadThresholdIsDeprecated);
}
},
/// <field type="Object" locid="WinJS.UI.ListView.groupDataSource" helpKeyword="WinJS.UI.ListView.groupDataSource">
/// Gets or sets the data source that contains the groups for the items in the itemDataSource.
/// </field>
groupDataSource: {
get: function () {
return this._groupDataSource;
},
set: function (newValue) {
this._writeProfilerMark("set_groupDataSource,info");
var that = this;
function groupStatusChanged(eventObject) {
if (eventObject.detail === _UI.DataSourceStatus.failure) {
that.itemDataSource = null;
that.groupDataSource = null;
}
}
if (this._groupDataSource && this._groupDataSource.removeEventListener) {
this._groupDataSource.removeEventListener("statuschanged", groupStatusChanged, false);
}
this._groupDataSource = newValue;
this._groupFocusCache = (newValue && this._supportsGroupHeaderKeyboarding) ? new _GroupFocusCache._GroupFocusCache(this) : new _GroupFocusCache._UnsupportedGroupFocusCache();
if (this._groupDataSource && this._groupDataSource.addEventListener) {
this._groupDataSource.addEventListener("statuschanged", groupStatusChanged, false);
}
this._createGroupsContainer();
if (!this._runningInit) {
this._view.reset();
this._pendingLayoutReset = true;
this._pendingGroupWork = true;
this._batchViewUpdates(_Constants._ViewChange.rebuild, _Constants._ScrollToPriority.medium, 0, true);
} else {
this._updateGroupWork();
this._resetLayout();
}
}
},
_updateGroupWork: function () {
this._pendingGroupWork = false;
if (this._groupDataSource) {
_ElementUtilities.addClass(this._element, _Constants._groupsClass);
} else {
_ElementUtilities.removeClass(this._element, _Constants._groupsClass);
}
this._resetLayout();
},
/// <field type="Boolean" locid="WinJS.UI.ListView.automaticallyLoadPages" helpKeyword="WinJS.UI.ListView.automaticallyLoadPages">
/// Gets or sets a value that indicates whether the next set of pages is automatically loaded
/// when the user scrolls beyond the number of pages specified by the
/// pagesToLoadThreshold property.
/// <deprecated type="deprecate">
/// automaticallyLoadPages is deprecated. The control will default this property to false. Please refer to the 'ListView loading behaviors' SDK Sample for guidance on how to implement incremental load behavior.
/// </deprecated>
/// </field>
automaticallyLoadPages: {
get: function () {
return false;
},
set: function () {
_ElementUtilities._deprecated(_ErrorMessages.automaticallyLoadPagesIsDeprecated);
}
},
/// <field type="String" oamOptionsDatatype="WinJS.UI.ListView.LoadingBehavior" locid="WinJS.UI.ListView.loadingBehavior" helpKeyword="WinJS.UI.ListView.loadingBehavior">
/// Gets or sets a value that determines how many data items are loaded into the DOM.
/// <deprecated type="deprecate">
/// pagesToLoadThreshold is deprecated. The control will default this property to 'randomAccess'. Please refer to the 'ListView loading behaviors' SDK Sample for guidance on how to implement incremental load behavior.
/// </deprecated>
/// </field>
loadingBehavior: {
get: function () {
return "randomAccess";
},
set: function () {
_ElementUtilities._deprecated(_ErrorMessages.loadingBehaviorIsDeprecated);
}
},
/// <field type="String" oamOptionsDatatype="WinJS.UI.ListView.SelectionMode" locid="WinJS.UI.ListView.selectionMode" helpKeyword="WinJS.UI.ListView.selectionMode">
/// Gets or sets a value that specifies how many ListView items the user can select: "none", "single", or "multi".
/// </field>
selectionMode: {
get: function () {
return this._selectionMode;
},
set: function (newMode) {
if (typeof newMode === "string") {
if (newMode.match(/^(none|single|multi)$/)) {
if (_BaseUtils.isPhone && newMode === _UI.SelectionMode.single) {
return;
}
this._selectionMode = newMode;
this._element.setAttribute("aria-multiselectable", this._multiSelection());
this._updateItemsAriaRoles();
this._configureSelectionMode();
return;
}
}
throw new _ErrorFromName("WinJS.UI.ListView.ModeIsInvalid", _ErrorMessages.modeIsInvalid);
}
},
/// <field type="String" oamOptionsDatatype="WinJS.UI.TapBehavior" locid="WinJS.UI.ListView.tapBehavior" helpKeyword="WinJS.UI.ListView.tapBehavior">
/// Gets or sets how the ListView reacts when the user taps or clicks an item.
/// The tap or click can invoke the item, select it and invoke it, or have no
/// effect.
/// </field>
tapBehavior: {
get: function () {
return this._tap;
},
set: function (tap) {
if (_BaseUtils.isPhone && tap === _UI.TapBehavior.directSelect) {
return;
}
this._tap = tap;
this._updateItemsAriaRoles();
this._configureSelectionMode();
}
},
/// <field type="String" oamOptionsDatatype="WinJS.UI.GroupHeaderTapBehavior" locid="WinJS.UI.ListView.groupHeaderTapBehavior" helpKeyword="WinJS.UI.ListView.groupHeaderTapBehavior">
/// Gets or sets how the ListView reacts when the user taps or clicks a group header.
/// </field>
groupHeaderTapBehavior: {
get: function () {
return this._groupHeaderTap;
},
set: function (tap) {
this._groupHeaderTap = tap;
this._updateGroupHeadersAriaRoles();
}
},
/// <field type="String" oamOptionsDatatype="WinJS.UI.SwipeBehavior" locid="WinJS.UI.ListView.swipeBehavior" helpKeyword="WinJS.UI.ListView.swipeBehavior">
/// Gets or sets how the ListView reacts to the swipe interaction.
/// The swipe gesture can select the swiped items or it can
/// have no effect on the current selection.
/// <compatibleWith platform="Windows" minVersion="8.0"/>
/// <deprecated type="deprecate">
/// swipeBehavior is deprecated. The control will not use this property.
/// </deprecated>
/// </field>
swipeBehavior: {
get: function () {
return "none";
},
set: function (value) {
_ElementUtilities._deprecated(_ErrorMessages.swipeBehaviorDeprecated);
}
},
/// <field type="Object" locid="WinJS.UI.ListView.itemDataSource" helpKeyword="WinJS.UI.ListView.itemDataSource">
/// Gets or sets the data source that provides items for the ListView.
/// </field>
itemDataSource: {
get: function () {
return this._itemsManager.dataSource;
},
set: function (newData) {
this._writeProfilerMark("set_itemDataSource,info");
this._dataSource = newData || new BindingList.List().dataSource;
this._groupFocusCache.clear();
if (!this._runningInit) {
this._selection._reset();
this._cancelAsyncViewWork(true);
this._updateItemsManager();
this._pendingLayoutReset = true;
this._batchViewUpdates(_Constants._ViewChange.rebuild, _Constants._ScrollToPriority.medium, 0, true);
}
}
},
/// <field type="Object" locid="WinJS.UI.ListView.itemTemplate" helpKeyword="WinJS.UI.ListView.itemTemplate" potentialValueSelector="[data-win-control='WinJS.Binding.Template']">
/// Gets or sets the templating function that creates the DOM elements
/// for each item in the itemDataSource. Each item can contain multiple
/// DOM elements, but we recommend that it have a single root element.
/// </field>
itemTemplate: {
get: function () {
return this._itemRenderer;
},
set: function (newRenderer) {
this._setRenderer(newRenderer, false);
if (!this._runningInit) {
this._cancelAsyncViewWork(true);
this._updateItemsManager();
this._pendingLayoutReset = true;
this._batchViewUpdates(_Constants._ViewChange.rebuild, _Constants._ScrollToPriority.medium, 0, true);
}
}
},
/// <field type="Function" locid="WinJS.UI.ListView.resetItem" helpKeyword="WinJS.UI.ListView.resetItem">
/// Gets or sets the function that is called when the ListView recycles the
/// element representation of an item.
/// <deprecated type="deprecate">
/// resetItem may be altered or unavailable in future versions. Instead, mark the element as disposable using WinJS.Utilities.markDisposable.
/// </deprecated>
/// </field>
resetItem: {
get: function () {
return this._itemRelease;
},
set: function (release) {
_ElementUtilities._deprecated(_ErrorMessages.resetItemIsDeprecated);
this._itemRelease = release;
}
},
/// <field type="Object" locid="WinJS.UI.ListView.groupHeaderTemplate" helpKeyword="WinJS.UI.ListView.groupHeaderTemplate" potentialValueSelector="[data-win-control='WinJS.Binding.Template']">
/// Gets or sets the templating function that creates the DOM elements
/// for each group header in the groupDataSource. Each group header
/// can contain multiple elements, but it must have a single root element.
/// </field>
groupHeaderTemplate: {
get: function () {
return this._groupHeaderRenderer;
},
set: function (newRenderer) {
this._setRenderer(newRenderer, true);
if (!this._runningInit) {
this._cancelAsyncViewWork(true);
this._pendingLayoutReset = true;
this._batchViewUpdates(_Constants._ViewChange.rebuild, _Constants._ScrollToPriority.medium, 0, true);
}
}
},
/// <field type="Function" locid="WinJS.UI.ListView.resetGroupHeader" helpKeyword="WinJS.UI.ListView.resetGroupHeader" isAdvanced="true">
/// Gets or sets the function that is called when the ListView recycles the DOM element representation
/// of a group header.
/// <deprecated type="deprecate">
/// resetGroupHeader may be altered or unavailable in future versions. Instead, mark the header element as disposable using WinJS.Utilities.markDisposable.
/// </deprecated>
/// </field>
resetGroupHeader: {
get: function () {
return this._groupHeaderRelease;
},
set: function (release) {
_ElementUtilities._deprecated(_ErrorMessages.resetGroupHeaderIsDeprecated);
this._groupHeaderRelease = release;
}
},
/// <field type="HTMLElement" domElement="true" locid="WinJS.UI.ListView.header" helpKeyword="WinJS.UI.ListView.header">
/// Gets or sets the header to display at the start of the ListView.
/// </field>
header: {
get: function () {
return this._header;
},
set: function (newHeader) {
_ElementUtilities.empty(this._headerContainer);
this._header = newHeader;
if (newHeader) {
this._header.tabIndex = this._tabIndex;
this._headerContainer.appendChild(newHeader);
}
var currentFocus = this._selection._getFocused();
if (currentFocus.type === _UI.ObjectType.header) {
var targetEntity = currentFocus;
if (!newHeader) {
targetEntity = { type: _UI.ObjectType.item, index: 0 };
}
if (this._hasKeyboardFocus) {
this._changeFocus(targetEntity, true, false, true);
} else {
this._changeFocusPassively(targetEntity);
}
}
this.recalculateItemPosition();
this._raiseHeaderFooterVisibilityEvent();
}
},
/// <field type="HTMLElement" domElement="true" locid="WinJS.UI.ListView.footer" helpKeyword="WinJS.UI.ListView.footer">
/// Gets or sets the footer to display at the end of the ListView.
/// </field>
footer: {
get: function () {
return this._footer;
},
set: function (newFooter) {
_ElementUtilities.empty(this._footerContainer);
this._footer = newFooter;
if (newFooter) {
this._footer.tabIndex = this._tabIndex;
this._footerContainer.appendChild(newFooter);
}
var currentFocus = this._selection._getFocused();
if (currentFocus.type === _UI.ObjectType.footer) {
var targetEntity = currentFocus;
if (!newFooter) {
targetEntity = { type: _UI.ObjectType.item, index: 0 };
}
if (this._hasKeyboardFocus) {
this._changeFocus(targetEntity, true, false, true);
} else {
this._changeFocusPassively(targetEntity);
}
}
this.recalculateItemPosition();
this._raiseHeaderFooterVisibilityEvent();
}
},
/// <field type="String" hidden="true" locid="WinJS.UI.ListView.loadingState" helpKeyword="WinJS.UI.ListView.loadingState">
/// Gets a value that indicates whether the ListView is still loading or whether
/// loading is complete. This property can return one of these values:
/// "itemsLoading", "viewPortLoaded", "itemsLoaded", or "complete".
/// </field>
loadingState: {
get: function () {
return this._loadingState;
}
},
/// <field type="Object" locid="WinJS.UI.ListView.selection" helpKeyword="WinJS.UI.ListView.selection" isAdvanced="true">
/// Gets an ISelection object that contains the currently selected items.
/// </field>
selection: {
get: function () {
return this._selection;
}
},
/// <field type="Number" integer="true" locid="WinJS.UI.ListView.indexOfFirstVisible" helpKeyword="WinJS.UI.ListView.indexOfFirstVisible" isAdvanced="true">
/// Gets or sets the first visible item. When setting this property, the ListView scrolls so that the
/// item with the specified index is at the top of the list.
/// </field>
indexOfFirstVisible: {
get: function () {
return this._view.firstIndexDisplayed;
},
set: function (itemIndex) {
if (itemIndex < 0) {
return;
}
this._writeProfilerMark("set_indexOfFirstVisible(" + itemIndex + "),info");
this._raiseViewLoading(true);
var that = this;
this._batchViewUpdates(_Constants._ViewChange.realize, _Constants._ScrollToPriority.high, function () {
var range;
return that._entityInRange({ type: _UI.ObjectType.item, index: itemIndex }).then(function (validated) {
if (!validated.inRange) {
return {
position: 0,
direction: "left"
};
} else {
return that._getItemOffset({ type: _UI.ObjectType.item, index: validated.index }).then(function (r) {
range = r;
return that._ensureFirstColumnRange(_UI.ObjectType.item);
}).then(function () {
range = that._correctRangeInFirstColumn(range, _UI.ObjectType.item);
range = that._convertFromCanvasCoordinates(range);
return that._view.waitForValidScrollPosition(range.begin);
}).then(function (begin) {
var direction = (begin < that._lastScrollPosition) ? "left" : "right";
var max = that._viewport[that._scrollLength] - that._getViewportLength();
begin = _ElementUtilities._clamp(begin, 0, max);
return {
position: begin,
direction: direction
};
});
}
});
}, true);
}
},
/// <field type="Number" integer="true" readonly="true" locid="WinJS.UI.ListView.indexOfLastVisible" helpKeyword="WinJS.UI.ListView.indexOfLastVisible" isAdvanced="true">
/// Gets the index of the last visible item.
/// </field>
indexOfLastVisible: {
get: function () {
return this._view.lastIndexDisplayed;
}
},
/// <field type="Object" locid="WinJS.UI.ListView.currentItem" helpKeyword="WinJS.UI.ListView.currentItem" isAdvanced="true">
/// Gets or sets an object that indicates which item should get keyboard focus and its focus status.
/// The object has these properties:
/// index: the index of the item in the itemDataSource.
/// key: the key of the item in the itemDataSource.
/// hasFocus: when getting this property, this value is true if the item already has focus; otherwise, it's false.
/// When setting this property, set this value to true if the item should get focus immediately; otherwise, set it to
/// false and the item will get focus eventually.
/// showFocus: true if the item displays the focus rectangle; otherwise, false.
/// </field>
currentItem: {
get: function () {
var focused = this._selection._getFocused();
var retVal = {
index: focused.index,
type: focused.type,
key: null,
hasFocus: !!this._hasKeyboardFocus,
showFocus: false
};
if (focused.type === _UI.ObjectType.groupHeader) {
var group = this._groups.group(focused.index);
if (group) {
retVal.key = group.key;
retVal.showFocus = !!(group.header && _ElementUtilities.hasClass(group.header, _Constants._itemFocusClass));
}
} else if (focused.type === _UI.ObjectType.item) {
var item = this._view.items.itemAt(focused.index);
if (item) {
var record = this._itemsManager._recordFromElement(item);
retVal.key = record.item && record.item.key;
retVal.showFocus = !!item.parentNode.querySelector("." + _Constants._itemFocusOutlineClass);
}
}
return retVal;
},
set: function (data) {
this._hasKeyboardFocus = data.hasFocus || this._hasKeyboardFocus;
if (!data.type) {
data.type = _UI.ObjectType.item;
}
var that = this;
function setItemFocused(item, isInTree, entity) {
var drawKeyboardFocus = !!data.showFocus && that._hasKeyboardFocus;
that._unsetFocusOnItem(isInTree);
that._selection._setFocused(entity, drawKeyboardFocus);
if (that._hasKeyboardFocus) {
that._keyboardFocusInbound = drawKeyboardFocus;
that._setFocusOnItem(entity);
} else {
that._tabManager.childFocus = (isInTree ? item : null);
}
if (entity.type !== _UI.ObjectType.groupHeader) {
that._updateFocusCache(entity.index);
if (that._updater) {
that._updater.newSelectionPivot = entity.index;
that._updater.oldSelectionPivot = -1;
}
that._selection._pivot = entity.index;
}
}
if (data.key &&
((data.type === _UI.ObjectType.item && this._dataSource.itemFromKey) ||
(data.type === _UI.ObjectType.groupHeader && this._groupDataSource && this._groupDataSource.itemFromKey))) {
if (this.oldCurrentItemKeyFetch) {
this.oldCurrentItemKeyFetch.cancel();
}
var dataSource = (data.type === _UI.ObjectType.groupHeader ? this._groupDataSource : this._dataSource);
this.oldCurrentItemKeyFetch = dataSource.itemFromKey(data.key).then(function (item) {
that.oldCurrentItemKeyFetch = null;
if (item) {
var element = (data.type === _UI.ObjectType.groupHeader ? that._groups.group(item.index).header : that._view.items.itemAt(item.index));
setItemFocused(element, !!element, { type: data.type, index: item.index });
}
});
} else {
var element;
if (data.type === _UI.ObjectType.header || data.type === _UI.ObjectType.footer) {
element = (data.type === _UI.ObjectType.header ? this._header : this._footer);
setItemFocused(element, !!element, { type: data.type, index: data.index });
} else if (data.index !== undefined) {
if (data.type === _UI.ObjectType.groupHeader) {
var group = that._groups.group(data.index);
element = group && group.header;
} else {
element = that._view.items.itemAt(data.index);
}
setItemFocused(element, !!element, { type: data.type, index: data.index });
}
}
}
},
/// <field type="Object" locid="WinJS.UI.ListView.zoomableView" helpKeyword="WinJS.UI.ListView.zoomableView" isAdvanced="true">
/// Gets a ZoomableView. This API supports the SemanticZoom infrastructure
/// and is not intended to be used directly from your code.
/// </field>
zoomableView: {
get: function () {
if (!this._zoomableView) {
this._zoomableView = new ZoomableView(this);
}
return this._zoomableView;
}
},
/// <field type="Boolean" locid="WinJS.UI.ListView.itemsDraggable" helpKeyword="WinJS.UI.ListView.itemsDraggable">
/// Gets or sets whether the ListView's items can be dragged via drag and drop.
/// <compatibleWith platform="Windows" minVersion="8.1"/>
/// </field>
itemsDraggable: {
get: function () {
return this._dragSource;
},
set: function (value) {
if (_BaseUtils.isPhone) {
return;
}
if (this._dragSource !== value) {
this._dragSource = value;
this._setDraggable();
}
}
},
/// <field type="Boolean" locid="WinJS.UI.ListView.itemsReorderable" helpKeyword="WinJS.UI.ListView.itemsReorderable">
/// Gets or sets whether the ListView's items can be reordered within itself via drag and drop. When a ListView is marked as reorderable, its items can be dragged about inside itself, but it will not require the itemdrag events it fires to be handled.
/// <compatibleWith platform="Windows" minVersion="8.1"/>
/// </field>
itemsReorderable: {
get: function () {
return this._reorderable;
},
set: function (value) {
if (_BaseUtils.isPhone) {
return;
}
if (this._reorderable !== value) {
this._reorderable = value;
this._setDraggable();
}
}
},
/// <field type="Number" integer="true" locid="WinJS.UI.ListView.maxDeferredItemCleanup" helpKeyword="WinJS.UI.ListView.maxDeferredItemCleanup" isAdvanced="true">
/// Gets or sets the maximum number of realized items.
/// </field>
maxDeferredItemCleanup: {
get: function () {
return this._maxDeferredItemCleanup;
},
set: function (value) {
this._maxDeferredItemCleanup = Math.max(0, +value || 0);
}
},
// Public methods
dispose: function () {
/// <signature helpKeyword="WinJS.UI.ListView.dispose">
/// <summary locid="WinJS.UI.ListView.dispose">