forked from extnet/Ext.NET
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAbstractDataView.cs
More file actions
913 lines (845 loc) · 33.6 KB
/
AbstractDataView.cs
File metadata and controls
913 lines (845 loc) · 33.6 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
/********
* @version : 2.1.1 - Ext.NET Pro License
* @author : Ext.NET, Inc. http://www.ext.net/
* @date : 2012-12-10
* @copyright : Copyright (c) 2007-2012, Ext.NET, Inc. (http://www.ext.net/). All rights reserved.
* @license : See license.txt and http://www.ext.net/license/.
********/
using System;
using System.ComponentModel;
using System.Web.UI;
using Ext.Net.Utilities;
namespace Ext.Net
{
///<summary>
/// A mechanism for displaying data using custom layout templates and formatting. DataView uses an Ext.XTemplate as its internal templating mechanism, and is bound to an Ext.data.Store so that as the data in the store changes the view is automatically updated to reflect the changes. The view also provides built-in behavior for many common events that can occur for its contained items including click, doubleclick, mouseover, mouseout, etc. as well as a built-in selection model. In order to use these features, an itemSelector config must be provided for the DataView to determine what nodes it will be working with.
///</summary>
[Meta]
public abstract partial class AbstractDataView : ComponentBase, IStore<Store>, INoneContentable
{
/// <summary>
///
/// </summary>
[Description("")]
protected override void OnPreRender(EventArgs e)
{
base.OnPreRender(e);
this.CheckProperties();
this.CheckStore();
}
/// <summary>
///
/// </summary>
protected virtual void CheckStore()
{
}
/// <summary>
///
/// </summary>
[Description("")]
protected virtual void CheckProperties()
{
}
/// <summary>
///
/// </summary>
[Description("")]
protected override void OnBeforeClientInitHandler()
{
if (this.StoreID.IsNotEmpty() && this.Store.Primary != null)
{
throw new Exception(string.Format("Please do not set both the StoreID property on {0} and <Store> inner property at the same time.", this.ID));
}
base.OnBeforeClientInitHandler();
}
/// <summary>
/// Allow users to deselect a record in a DataView, List or Grid. Only applicable when the SelectionModel's mode is 'SINGLE'. Defaults to false.
/// </summary>
[Meta]
[ConfigOption]
[DefaultValue(false)]
[NotifyParentProperty(true)]
[Description("Allow users to deselect a record in a DataView, List or Grid. Only applicable when the SelectionModel's mode is 'SINGLE'. Defaults to false. ")]
public virtual bool AllowDeselect
{
get
{
return this.State.Get<bool>("AllowDeselect", false);
}
set
{
this.State.Set("AllowDeselect", value);
}
}
/// <summary>
/// Always copy items
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue(false)]
[NotifyParentProperty(true)]
[Description("Always copy items")]
public virtual bool Copy
{
get
{
return this.State.Get<bool>("Copy", false);
}
set
{
this.State.Set("Copy", value);
}
}
/// <summary>
/// Copy items if Ctrl key is pressed
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue(false)]
[NotifyParentProperty(true)]
[Description("Copy items if Ctrl key is pressed")]
public virtual bool AllowCopy
{
get
{
return this.State.Get<bool>("AllowCopy", false);
}
set
{
this.State.Set("AllowCopy", value);
}
}
/// <summary>
/// Set this to true to ignore datachanged events on the bound store. This is useful if you wish to provide custom transition animations via a plugin (defaults to false)
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue(false)]
[NotifyParentProperty(true)]
[Description("Set this to true to ignore datachanged events on the bound store. This is useful if you wish to provide custom transition animations via a plugin (defaults to false)")]
public virtual bool BlockRefresh
{
get
{
return this.State.Get<bool>("BlockRefresh", false);
}
set
{
this.State.Set("BlockRefresh", value);
}
}
/// <summary>
/// True to defer emptyText being applied until the store's first load. Defaults to true.
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue(true)]
[NotifyParentProperty(true)]
[Description("True to defer emptyText being applied until the store's first load. Defaults to:true.")]
public virtual bool DeferEmptyText
{
get
{
return this.State.Get<bool>("DeferEmptyText", true);
}
set
{
this.State.Set("DeferEmptyText", value);
}
}
/// <summary>
/// Defaults to true to defer the initial refresh of the view.
/// This allows the View to execute its render and initial layout more quickly because the process will not be encumbered by the expensive update of the view structure.
/// Important: Be aware that this will mean that the View's item elements will not be available immediately upon render, so selection may not take place at render time. To access a View's item elements as soon as possible, use the viewready event. Or set deferInitialrefresh to false, but this will be at the cost of slower rendering.
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue(true)]
[NotifyParentProperty(true)]
[Description("Defaults to true to defer the initial refresh of the view.")]
public virtual bool DeferInitialRefresh
{
get
{
return this.State.Get<bool>("DeferInitialRefresh", true);
}
set
{
this.State.Set("DeferInitialRefresh", value);
}
}
/// <summary>
/// True to disable selection within the DataView. Defaults to false. This configuration will lock the selection model that the DataView uses.
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue(false)]
[NotifyParentProperty(true)]
[Description("True to disable selection within the DataView. Defaults to false. This configuration will lock the selection model that the DataView uses.")]
public virtual bool DisableSelection
{
get
{
return this.State.Get<bool>("DisableSelection", false);
}
set
{
this.State.Set("DisableSelection", value);
}
}
/// <summary>
/// The text to display in the view when there is no data to display. Note that when using local data the emptyText will not be displayed unless you set the deferEmptyText option to false. Defaults to: ""
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue("")]
[Description("The text to display in the view when there is no data to display. Note that when using local data the emptyText will not be displayed unless you set the deferEmptyText option to false. Defaults to: \"\"")]
public virtual string EmptyText
{
get
{
return this.State.Get<string>("EmptyText", "");
}
set
{
this.State.Set("EmptyText", value);
}
}
/// <summary>
/// Specifies the class to be assigned to each element in the view when used in conjunction with the itemTpl configuration. Defaults to: "x-dataview-item"
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue("")]
[Description("Specifies the class to be assigned to each element in the view when used in conjunction with the itemTpl configuration. Defaults to: \"x-dataview-item\"")]
public virtual string ItemCls
{
get
{
return this.State.Get<string>("ItemCls", "");
}
set
{
this.State.Set("ItemCls", value);
}
}
/// <summary>
/// This is a required setting. A simple CSS selector (e.g. div.some-class or span:first-child) that will be used to determine what nodes this DataView will be working with. The itemSelector is used to map DOM nodes to records. As such, there should only be one root level element that matches the selector for each record.
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue("")]
[Description("This is a required setting. A simple CSS selector (e.g. div.some-class or span:first-child) that will be used to determine what nodes this DataView will be working with. The itemSelector is used to map DOM nodes to records. As such, there should only be one root level element that matches the selector for each record.")]
public virtual string ItemSelector
{
get
{
return this.State.Get<string>("ItemSelector", "");
}
set
{
this.State.Set("ItemSelector", value);
}
}
private XTemplate itemTpl;
/// <summary>
/// The inner portion of the item template to be rendered. Follows an XTemplate structure and will be placed inside of a tpl.
/// </summary>
[Meta]
[Category("4. AbstractDataView")]
[ConfigOption("itemTpl", typeof(LazyControlJsonConverter))]
[DefaultValue(null)]
[PersistenceMode(PersistenceMode.InnerProperty)]
[Description("The inner portion of the item template to be rendered. Follows an XTemplate structure and will be placed inside of a tpl.")]
public virtual XTemplate ItemTpl
{
get
{
return this.itemTpl;
}
set
{
if (this.itemTpl != null)
{
this.Controls.Remove(this.itemTpl);
this.LazyItems.Remove(this.itemTpl);
}
this.itemTpl = value;
if (this.itemTpl != null)
{
this.itemTpl.EnableViewState = false;
this.Controls.Add(this.itemTpl);
this.LazyItems.Add(this.itemTpl);
}
}
}
/// <summary>
/// False to disable a load mask from displaying will the view is loading.
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue(true)]
[Description("False to disable a load mask from displaying will the view is loading.")]
public virtual bool LoadMask
{
get
{
return this.State.Get<bool>("LoadMask", true);
}
set
{
this.State.Set("LoadMask", value);
}
}
/// <summary>
/// The CSS class to apply to the loading message element (defaults to Ext.LoadMask.prototype.msgCls "x-mask-loading")
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue("")]
[Description("The CSS class to apply to the loading message element (defaults to Ext.LoadMask.prototype.msgCls \"x-mask-loading\")")]
public virtual string LoadingCls
{
get
{
return this.State.Get<string>("LoadingCls", "");
}
set
{
this.State.Set("LoadingCls", value);
}
}
/// <summary>
/// Whether or not to use a loading message class or simply mask the bound element.
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue(true)]
[NotifyParentProperty(true)]
[Description("Whether or not to use a loading message class or simply mask the bound element.")]
public virtual bool LoadingUseMsg
{
get
{
return this.State.Get<bool>("LoadingUseMsg", true);
}
set
{
this.State.Set("LoadingUseMsg", value);
}
}
/// <summary>
/// If specified, gives an explicit height for the data view when it is showing the loadingText, if that is specified. This is useful to prevent the view's height from collapsing to zero when the loading mask is applied and there are no other contents in the data view. Defaults to undefined.
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue(null)]
[NotifyParentProperty(true)]
[Description("If specified, gives an explicit height for the data view when it is showing the loadingText, if that is specified. This is useful to prevent the view's height from collapsing to zero when the loading mask is applied and there are no other contents in the data view. Defaults to undefined.")]
public virtual int? LoadingHeight
{
get
{
return this.State.Get<int?>("LoadingHeight", null);
}
set
{
this.State.Set("LoadingHeight", value);
}
}
/// <summary>
/// A string to display during data load operations (defaults to undefined). If specified, this text will be displayed in a loading div and the view's contents will be cleared while loading, otherwise the view's contents will continue to display normally until the new data is loaded and the contents are replaced.Defaults to: "Loading..."
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue("")]
[Description("A string to display during data load operations (defaults to undefined). If specified, this text will be displayed in a loading div and the view's contents will be cleared while loading, otherwise the view's contents will continue to display normally until the new data is loaded and the contents are replaced.Defaults to: \"Loading...\"")]
public virtual string LoadingText
{
get
{
return this.State.Get<string>("LoadingText", "");
}
set
{
this.State.Set("LoadingText", value);
}
}
/// <summary>
/// True to allow selection of more than one item at a time, false to allow selection of only a single item at a time or no selection at all, depending on the value of singleSelect (defaults to false).
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue(false)]
[NotifyParentProperty(true)]
[Description("True to allow selection of more than one item at a time, false to allow selection of only a single item at a time or no selection at all, depending on the value of singleSelect (defaults to false).")]
public virtual bool MultiSelect
{
get
{
return this.State.Get<bool>("MultiSelect", false);
}
set
{
this.State.Set("MultiSelect", value);
}
}
/// <summary>
/// A CSS class to apply to each item in the view on mouseover. Ensure trackOver is set to true to make use of this.
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue("")]
[Description("A CSS class to apply to each item in the view on mouseover. Ensure trackOver is set to true to make use of this.")]
public virtual string OverItemCls
{
get
{
return this.State.Get<string>("OverItemCls", "");
}
set
{
this.State.Set("OverItemCls", value);
}
}
/// <summary>
/// True to preserve scroll position across refresh operations. Defaults to: false
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue(false)]
[NotifyParentProperty(true)]
[Description("True to preserve scroll position across refresh operations. Defaults to: false")]
public virtual bool PreserveScrollOnRefresh
{
get
{
return this.State.Get<bool>("PreserveScrollOnRefresh", false);
}
set
{
this.State.Set("PreserveScrollOnRefresh", value);
}
}
/// <summary>
/// A CSS class to apply to each selected item in the view (defaults to 'x-item-selected').
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue("x-item-selected")]
[Description("A CSS class to apply to each selected item in the view (defaults to 'x-item-selected').")]
public virtual string SelectedItemCls
{
get
{
return this.State.Get<string>("SelectedItemCls", "x-item-selected");
}
set
{
this.State.Set("SelectedItemCls", value);
}
}
/// <summary>
/// True to enable multiselection by clicking on multiple items without requiring the user to hold Shift or Ctrl, false to force the user to hold Ctrl or Shift to select more than on item (defaults to false).
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue(false)]
[NotifyParentProperty(true)]
[Description("True to enable multiselection by clicking on multiple items without requiring the user to hold Shift or Ctrl, false to force the user to hold Ctrl or Shift to select more than on item (defaults to false).")]
public virtual bool SimpleSelect
{
get
{
return this.State.Get<bool>("SimpleSelect", false);
}
set
{
this.State.Set("SimpleSelect", value);
}
}
/// <summary>
/// True to allow selection of exactly one item at a time, false to allow no selection at all (defaults to false). Note that if multiSelect = true, this value will be ignored.
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue(false)]
[NotifyParentProperty(true)]
[Description("True to allow selection of exactly one item at a time, false to allow no selection at all (defaults to false). Note that if multiSelect = true, this value will be ignored.")]
public virtual bool SingleSelect
{
get
{
return this.State.Get<bool>("SingleSelect", false);
}
set
{
this.State.Set("SingleSelect", value);
}
}
/// <summary>
/// The data store to use.
/// </summary>
[Meta]
[ConfigOption("store", JsonMode.ToClientID)]
[Category("4. AbstractDataView")]
[DefaultValue("")]
[IDReferenceProperty(typeof(Store))]
[Description("The data store to use.")]
public virtual string StoreID
{
get
{
return this.State.Get<string>("StoreID", "");
}
set
{
this.State.Set("StoreID", value);
}
}
private StoreCollection<Store> store;
/// <summary>
/// The data store to use.
/// </summary>
[Meta]
[ConfigOption("store>Primary")]
[Category("4. AbstractDataView")]
[PersistenceMode(PersistenceMode.InnerProperty)]
[Description("The data store to use.")]
public virtual StoreCollection<Store> Store
{
get
{
if (this.store == null)
{
this.store = new StoreCollection<Store>();
this.store.AfterItemAdd += this.AfterItemAdd;
this.store.AfterItemRemove += this.AfterItemRemove;
}
return this.store;
}
}
/// <summary>
///
/// </summary>
/// <returns></returns>
public Store GetStore()
{
if (this.Store.Primary != null)
{
return this.Store.Primary;
}
if (this.StoreID.IsNotEmpty())
{
return ControlUtils.FindControl<Store>(this, this.StoreID, true);
}
return null;
}
/// <summary>
/// The HTML fragment or an array of fragments that will make up the template used by this DataView. This should be specified in the same format expected by the constructor of Ext.XTemplate.
/// </summary>
[Meta]
[Category("4. AbstractDataView")]
[ConfigOption("tpl", typeof(LazyControlJsonConverter))]
[PersistenceMode(PersistenceMode.InnerProperty)]
[DefaultValue(null)]
[Description("The HTML fragment or an array of fragments that will make up the template used by this DataView. This should be specified in the same format expected by the constructor of Ext.XTemplate.")]
public override XTemplate Tpl
{
get
{
return base.Tpl;
}
set
{
base.Tpl = value;
}
}
/// <summary>
/// True to enable mouseenter and mouseleave events
/// </summary>
[Meta]
[ConfigOption]
[Category("4. AbstractDataView")]
[DefaultValue(false)]
[Description("True to enable mouseenter and mouseleave events")]
public virtual bool TrackOver
{
get
{
return this.State.Get<bool>("TrackOver", false);
}
set
{
this.State.Set("TrackOver", value);
}
}
private JFunction prepareData;
/// <summary>
/// Function which can be overridden to provide custom formatting for each Record that is used by this DataView's template to render each node.
/// Parameters
/// data : Array/Object
/// The raw data object that was used to create the Record.
/// recordIndex : Number
/// the index number of the Record being prepared for rendering.
/// record : Record
/// The Record being prepared for rendering.
/// </summary>
[Meta]
[ConfigOption(JsonMode.Raw)]
[Category("4. AbstractDataView")]
[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
public virtual JFunction PrepareData
{
get
{
if (this.prepareData == null)
{
this.prepareData = new JFunction();
if (!this.DesignMode)
{
this.prepareData.Args = new []{"data", "recordIndex", "record"};
}
}
return this.prepareData;
}
}
/// <summary>
///
/// </summary>
/// <param name="name"></param>
/// <param name="args"></param>
protected virtual void CallSelectionModel(string name, params object[] args)
{
this.CallTemplate("{0}.selModel.{1}({2});", name, args);
}
/// <summary>
/// Changes the data store bound to this view and refreshes it.
/// </summary>
/// <param name="store">The store to bind to this view</param>
public virtual void BindStore(Store store)
{
this.Call("bindStore", store.ToConfig(LazyMode.Instance));
}
/// <summary>
/// Changes the data store bound to this view and refreshes it.
/// </summary>
/// <param name="storeId">The store id to bind to this view</param>
public virtual void BindStore(string storeId)
{
this.Call("bindStore", JRawValue.From(storeId));
}
/// <summary>
/// Deselects a record instance by record instance or index.
/// </summary>
/// <param name="index">The index of node to deselect</param>
[Meta]
[Description("Deselects a node.")]
public void Deselect(int index)
{
this.CallSelectionModel("deselect", index);
}
/// <summary>
/// Deselects a record instance by record instance or index.
/// </summary>
/// <param name="index">The index of node to deselect</param>
/// <param name="suppressEvent">Set to false to not fire a deselect event</param>
[Meta]
[Description("Deselects a node.")]
public void Deselect(int index, bool suppressEvent)
{
this.CallSelectionModel("deselect", index, suppressEvent);
}
/// <summary>
/// Deselects a record instance by record instance or index.
/// </summary>
/// <param name="records">An array of records</param>
[Meta]
[Description("Deselects a node.")]
public void Deselect(ModelProxy[] records)
{
this.CallSelectionModel("deselect", new JRawValue(ModelProxy.Serialize(records)));
}
/// <summary>
/// Deselects a record instance by record instance or index.
/// </summary>
/// <param name="records">An array of records</param>
/// <param name="suppressEvent">Set to false to not fire a deselect event</param>
[Meta]
[Description("Deselects a node.")]
public void Deselect(ModelProxy[] records, bool suppressEvent)
{
this.CallSelectionModel("deselect", new JRawValue(ModelProxy.Serialize(records)), suppressEvent);
}
/// <summary>
/// Refreshes the view by reloading the data from the store and re-rendering the template.
/// </summary>
[Meta]
public void Refresh()
{
this.Call("refresh");
}
/// <summary>
/// Refreshes an individual node's data from the store.
/// </summary>
/// <param name="index">The item's data index in the store</param>
[Meta]
public void RefreshNode(int index)
{
this.Call("refreshNode", index);
}
/// <summary>
/// Clears all selections.
/// </summary>
[Meta]
public void DeselectAll()
{
this.CallSelectionModel("deselectAll");
}
/// <summary>
/// Clears all selections.
/// </summary>
[Meta]
public void SelectAll()
{
this.CallSelectionModel("selectAll");
}
/// <summary>
/// Selects a record instance by index.
/// </summary>
/// <param name="index">Index to select</param>
/// <param name="keepExisting">true to keep existing selections</param>
/// <param name="suppressEvent">true to skip firing of the selectionchange vent</param>
[Meta]
public void Select(int index, bool keepExisting, bool suppressEvent)
{
this.CallSelectionModel("select", index, keepExisting, suppressEvent);
}
/// <summary>
/// Selects a record instance by index.
/// </summary>
/// <param name="index">Index to select</param>
/// <param name="keepExisting">true to keep existing selections</param>
[Meta]
public void Select(int index, bool keepExisting)
{
this.CallSelectionModel("select", index, keepExisting);
}
/// <summary>
/// Selects a record instance by index.
/// </summary>
/// <param name="index">Index to select</param>
[Meta]
public void Select(int index)
{
this.CallSelectionModel("select", index);
}
/// <summary>
/// Selects a record instance by index.
/// </summary>
/// <param name="records">An array of records</param>
/// <param name="keepExisting">true to keep existing selections</param>
/// <param name="suppressEvent">true to skip firing of the selectionchange vent</param>
[Meta]
public void Select(ModelProxy[] records, bool keepExisting, bool suppressEvent)
{
this.CallSelectionModel("select", new JRawValue(ModelProxy.Serialize(records)), keepExisting, suppressEvent);
}
/// <summary>
/// Selects a record instance by index.
/// </summary>
/// <param name="records">An array of records</param>
/// <param name="keepExisting">true to keep existing selections</param>
[Meta]
public void Select(ModelProxy[] records, bool keepExisting)
{
this.CallSelectionModel("select", new JRawValue(ModelProxy.Serialize(records)), keepExisting);
}
/// <summary>
/// Selects a record instance by index.
/// </summary>
/// <param name="records">An array of records</param>
[Meta]
public void Select(ModelProxy[] records)
{
this.CallSelectionModel("select", new JRawValue(ModelProxy.Serialize(records)));
}
/// <summary>
/// Selects a range of rows if the selection model is not locked. All rows in between startRow and endRow are also selected.
/// </summary>
/// <param name="start">The index of the first node in the range</param>
/// <param name="end">The index of the last node in the range</param>
/// <param name="keepExisting">True to retain existing selections</param>
[Meta]
public void SelectRange(int start, int end, bool keepExisting)
{
this.CallSelectionModel("selectRange", start, end, keepExisting);
}
/// <summary>
/// Selects a range of rows if the selection model is not locked. All rows in between startRow and endRow are also selected.
/// </summary>
/// <param name="start">The index of the first node in the range</param>
/// <param name="end">The index of the last node in the range</param>
[Meta]
public void SelectRange(int start, int end)
{
this.CallSelectionModel("selectRange", start, end);
}
/// <summary>
/// Locks the current selection and disables any changes from happening to the selection.
/// </summary>
/// <param name="locked">True to lock</param>
[Meta]
public void SetLocked(bool locked)
{
this.CallSelectionModel("setLocked", locked);
}
/// <summary>
/// Sets the current selectionMode. SINGLE, MULTI or SIMPLE.
/// </summary>
/// <param name="mode">New mode</param>
[Meta]
public void SetSelectionMode(SelectionMode mode)
{
this.CallSelectionModel("setSelectionMode", mode.ToString().ToUpperInvariant());
}
/// <summary>
/// Un-highlight the currently highlighted item, if any.
/// </summary>
[Meta]
public void ClearHighlight()
{
this.Call("clearHighlight");
}
/// <summary>
/// Highlight a given item in the DataView. This is called by the mouseover handler if overItemCls and trackOver are configured, but can also be called manually by other code, for instance to handle stepping through the list via keyboard navigation.
/// </summary>
/// <param name="item">The item to highlight</param>
[Meta]
public void HighlightItem(Element item)
{
this.Call("highlightItem", new JRawValue(item.RealDescriptor + ".dom"));
}
}
}