-
Notifications
You must be signed in to change notification settings - Fork 138
/
AbstractCalendar.js
2145 lines (1915 loc) · 93 KB
/
AbstractCalendar.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
/**
* This is an abstract class that serves as the base for other calendar views. This class is not
* intended to be directly instantiated.
*
* When extending this class to create a custom calendar view, you must provide an implementation
* for the <tt>renderItems</tt> method, as there is no default implementation for rendering events
* The rendering logic is totally dependent on how the UI structures its data, which
* is determined by the underlying UI template (this base class does not have a template).
*/
Ext.define('Extensible.calendar.view.AbstractCalendar', {
extend: 'Ext.Component',
requires: [
'Ext.CompositeElement',
'Extensible.calendar.form.EventDetails',
'Extensible.calendar.form.EventWindow',
'Extensible.calendar.menu.Event',
'Extensible.calendar.dd.DragZone',
'Extensible.calendar.dd.DropZone',
'Extensible.form.recurrence.RangeEditWindow'
],
/**
* @cfg {Ext.data.Store} eventStore
* The {@link Ext.data.Store store} which is bound to this calendar and contains {@link Extensible.calendar.data.EventModel EventRecords}.
* Note that this is an alias to the default {@link #store} config (to differentiate that from the optional {@link #calendarStore}
* config), and either can be used interchangeably.
*/
/**
* @cfg {Ext.data.Store} calendarStore
* The {@link Ext.data.Store store} which is bound to this calendar and contains {@link Extensible.calendar.data.CalendarModel CalendarRecords}.
* This is an optional store that provides multi-calendar (and multi-color) support. If available an additional field for selecting the
* calendar in which to save an event will be shown in the edit forms. If this store is not available then all events will simply use
* the default calendar (and color).
*/
/*
* @cfg {Boolean} recurrence
* True to show the recurrence field, false to hide it (default). Note that recurrence requires
* something on the server-side that can parse the iCal RRULE format in order to generate the
* instances of recurring events to display on the calendar, so this field should only be enabled
* if the server supports it.
*/
recurrence: false,
// @private
// At the moment these are used, but not required to be modified. In the future, these may be used
// for customizing how recurrence data is requested and processed.
recurrenceOptions: {
expansionMode: 'remote',
expansionParam: {
name: 'singleEvents',
value: true
}
},
/**
* @cfg {Boolean} readOnly
* True to prevent clicks on events or the view from providing CRUD capabilities, false to enable CRUD (the default).
*/
/**
* @cfg {Number} startDay
* The 0-based index for the day on which the calendar week begins (0=Sunday, which is the default)
*/
startDay: 0,
/**
* @cfg {Boolean} spansHavePriority
* Allows switching between two different modes of rendering events that span multiple days. When true,
* span events are always sorted first, possibly at the expense of start dates being out of order (e.g.,
* a span event that starts at 11am one day and spans into the next day would display before a non-spanning
* event that starts at 10am, even though they would not be in date order). This can lead to more compact
* layouts when there are many overlapping events. If false (the default), events will always sort by start date
* first which can result in a less compact, but chronologically consistent layout.
*/
spansHavePriority: false,
/**
* @cfg {Boolean} trackMouseOver
* Whether or not the view tracks and responds to the browser mouseover event on contained elements (defaults to
* true). If you don't need mouseover event highlighting you can disable this.
*/
trackMouseOver: true,
/**
* @cfg {Boolean} enableFx
* Determines whether or not visual effects for CRUD actions are enabled (defaults to true). If this is false
* it will override any values for {@link #enableAddFx}, {@link #enableUpdateFx} or {@link enableRemoveFx} and
* all animations will be disabled.
*/
enableFx: true,
/**
* @cfg {Boolean} enableAddFx
* True to enable a visual effect on adding a new event (the default), false to disable it. Note that if
* {@link #enableFx} is false it will override this value. The specific effect that runs is defined in the
* {@link #doAddFx} method.
*/
enableAddFx: true,
/**
* @cfg {Boolean} enableUpdateFx
* True to enable a visual effect on updating an event, false to disable it (the default). Note that if
* {@link #enableFx} is false it will override this value. The specific effect that runs is defined in the
* {@link #doUpdateFx} method.
*/
enableUpdateFx: false,
/**
* @cfg {Boolean} enableRemoveFx
* True to enable a visual effect on removing an event (the default), false to disable it. Note that if
* {@link #enableFx} is false it will override this value. The specific effect that runs is defined in the
* {@link #doRemoveFx} method.
*/
enableRemoveFx: true,
/**
* @cfg {Boolean} enableDD
* True to enable drag and drop in the calendar view (the default), false to disable it
*/
enableDD: true,
/**
* @cfg {Boolean} enableContextMenus
* True to enable automatic right-click context menu handling in the calendar views (the default), false to disable
* them. Different context menus are provided when clicking on events vs. the view background.
*/
enableContextMenus: true,
/**
* @cfg {Boolean} suppressBrowserContextMenu
* When {@link #enableContextMenus} is true, the browser context menu will automatically be suppressed whenever a
* custom context menu is displayed. When this option is true, right-clicks on elements that do not have a custom
* context menu will also suppress the default browser context menu (no menu will be shown at all). When false,
* the browser context menu will still show if the right-clicked element has no custom menu (this is the default).
*/
suppressBrowserContextMenu: false,
/**
* @cfg {Boolean} monitorResize
* True to monitor the browser's resize event (the default), false to ignore it. If the calendar view is rendered
* into a fixed-size container this can be set to false. However, if the view can change dimensions (e.g., it's in
* fit layout in a viewport or some other resizable container) it is very important that this config is true so that
* any resize event propagates properly to all subcomponents and layouts get recalculated properly.
*/
monitorResize: true,
/**
* @cfg {String} todayText
* The text to display in the current day's box in the calendar when {@link #showTodayText} is true (defaults to 'Today')
*/
todayText: 'Today',
/**
* @cfg {String} ddCreateEventText
* The text to display inside the drag proxy while dragging over the calendar to create a new event (defaults to
* 'Create event for {0}' where {0} is a date range supplied by the view)
*/
ddCreateEventText: 'Create event for {0}',
/**
* @cfg {String} ddCopyEventText
* The text to display inside the drag proxy while alt-dragging an event to copy it (defaults to
* 'Copy event to {0}' where {0} is the updated event start date/time supplied by the view)
*/
ddCopyEventText: 'Copy event to {0}',
/**
* @cfg {String} ddMoveEventText
* The text to display inside the drag proxy while dragging an event to reposition it (defaults to
* 'Move event to {0}' where {0} is the updated event start date/time supplied by the view)
*/
ddMoveEventText: 'Move event to {0}',
/**
* @cfg {String} ddResizeEventText
* The string displayed to the user in the drag proxy while dragging the resize handle of an event (defaults to
* 'Update event to {0}' where {0} is the updated event start-end range supplied by the view). Note that
* this text is only used in views
* that allow resizing of events.
*/
ddResizeEventText: 'Update event to {0}',
/**
* @cfg {String} defaultEventTitleText
* The default text to display as the title of an event that has a null or empty string title value (defaults to '(No title)')
*/
defaultEventTitleText: '(No title)',
/**
* @cfg {String} dateParamStart
* The param name representing the start date of the current view range that's passed in requests to retrieve events
* when loading the view (defaults to 'startDate').
*/
dateParamStart: 'startDate',
/**
* @cfg {String} dateParamEnd
* The param name representing the end date of the current view range that's passed in requests to retrieve events
* when loading the view (defaults to 'endDate').
*/
dateParamEnd: 'endDate',
/**
* @cfg {String} dateParamFormat
* The format to use for date parameters sent with requests to retrieve events for the calendar (defaults to 'Y-m-d', e.g. '2010-10-31')
*/
dateParamFormat: 'Y-m-d',
/**
* @cfg {Boolean} editModal
* True to show the default event editor window modally over the entire page, false to allow user interaction with the page
* while showing the window (the default). Note that if you replace the default editor window with some alternate component this
* config will no longer apply.
*/
editModal: false,
/**
* @cfg {Boolean} enableEditDetails
* True to show a link on the event edit window to allow switching to the detailed edit form (the default), false to remove the
* link and disable detailed event editing.
*/
enableEditDetails: true,
/**
* @cfg {String} weekendCls
* A CSS class to apply to weekend days in the current view (defaults to 'ext-cal-day-we' which highlights weekend days in light blue).
* To disable this styling set the value to null or ''.
*/
weekendCls: 'ext-cal-day-we',
/**
* @cfg {String} prevMonthCls
* A CSS class to apply to any days that fall in the month previous to the current view's month (defaults to 'ext-cal-day-prev' which
* highlights previous month days in light gray). To disable this styling set the value to null or ''.
*/
prevMonthCls: 'ext-cal-day-prev',
/**
* @cfg {String} nextMonthCls
* A CSS class to apply to any days that fall in the month after the current view's month (defaults to 'ext-cal-day-next' which
* highlights next month days in light gray). To disable this styling set the value to null or ''.
*/
nextMonthCls: 'ext-cal-day-next',
/**
* @cfg {String} todayCls
* A CSS class to apply to the current date when it is visible in the current view (defaults to 'ext-cal-day-today' which
* highlights today in yellow). To disable this styling set the value to null or ''.
*/
todayCls: 'ext-cal-day-today',
/**
* @cfg {String} hideMode
* How this component should be hidden. Supported values are <tt>'visibility'</tt>
* (css visibility), <tt>'offsets'</tt> (negative offset position) and <tt>'display'</tt>
* (css display).
*
* **Note:** For calendar views the default is 'offsets' rather than the Ext JS default of
* 'display' in order to preserve scroll position after hiding/showing a scrollable view like Day or Week.
*/
hideMode: 'offsets',
/**
* @cfg {String} notifyOnExceptionTitle
* @since 1.6.0
* The notification title used by the {@link #notifyOnException} method when a server error occurs
* (defaults to "Server Error").
*/
notifyOnExceptionTitle: 'Server Error',
/**
* @cfg {String} notifyOnExceptionText
* @since 1.6.0
* The notification starting text used by the {@link #notifyOnException} method when a server error occurs
* (defaults to "The action failed with the following response:"). The text of the error is appended.
*/
notifyOnExceptionText: 'The action failed with the following response:',
/**
* @cfg {String} notifyOnExceptionDefaultMessage
* @since 1.6.0
* The default notification message text used by the {@link #notifyOnException} method when a server error occurs
* and no error message is returned from the server (defaults to "An unknown error occurred").
*/
notifyOnExceptionDefaultMessage: 'An unknown error occurred',
/**
* @property ownerCalendarPanel
* @type Extensible.calendar.CalendarPanel
* If this view is hosted inside a {@link Extensible.calendar.CalendarPanel CalendarPanel} this property will reference
* it. If the view was created directly outside of a CalendarPanel this property will be null. Read-only.
*/
//private properties -- do not override:
weekCount: 1,
dayCount: 1,
eventSelector: '.ext-cal-evt',
eventSelectorDepth: 10,
eventOverClass: 'ext-evt-over',
eventElIdDelimiter: '-evt-',
dayElIdDelimiter: '-day-',
recurringInstanceIdDelimiter: '-rid-',
/**
* Returns a string of HTML template markup to be used as the body portion of the event template created
* by {@link #getEventTemplate}. This provides the flexibility to customize what's in the body without
* having to override the entire XTemplate. This string can include any valid {@link Ext.Template} code, and
* any data tokens accessible to the containing event template can be referenced in this string.
* @return {String} The body template string
*/
getEventBodyMarkup: Ext.emptyFn, // must be implemented by a subclass
/**
* Returns the XTemplate that is bound to the calendar's event store (it expects records of type
* {@link Extensible.calendar.data.EventModel}) to populate the calendar views with events. Internally this method
* by default generates different markup for browsers that support CSS border radius and those that don't.
* This method can be overridden as needed to customize the markup generated.
*
* Note that this method calls {@link #getEventBodyMarkup} to retrieve the body markup for events separately
* from the surrounding container markup. This provides the flexibility to customize what's in the body without
* having to override the entire XTemplate. If you do override this method, you should make sure that your
* overridden version also does the same.
* @return {Ext.XTemplate} The event XTemplate
*/
getEventTemplate: Ext.emptyFn, // must be implemented by a subclass
/**
* This is undefined by default, but can be implemented to allow custom CSS classes and template data to be
* conditionally applied to events during rendering. This function will be called with the parameter list shown
* below and is expected to return the CSS class name (or empty string '' for none) that will be added to the
* event element's wrapping div. To apply multiple class names, simply return them space-delimited within the
* string (e.g., 'my-class another-class'). Example usage, applied in a CalendarPanel config:
* // This example assumes a custom field of 'IsHoliday' has been added to EventRecord
* viewConfig: {
* getEventClass: function(rec, allday, templateData, store) {
* if (rec.data.IsHoliday) {
* templateData.iconCls = 'holiday';
* return 'evt-holiday';
* }
* templateData.iconCls = 'plain';
* return '';
* },
* getEventBodyMarkup: function() {
* // This is simplified, but shows the symtax for how you could add a
* // custom placeholder that maps back to the templateData property created
* // in getEventClass. Note that this is standard Ext template syntax.
* if (!this.eventBodyMarkup) {
* this.eventBodyMarkup = '<span class="{iconCls}"></span> {Title}';
* }
* return this.eventBodyMarkup;
* }
* }
* @param {Extensible.calendar.data.EventModel} rec The {@link Extensible.calendar.data.EventModel record} being rendered
* @param {Boolean} isAllDay A flag indicating whether the event will be *rendered* as an all-day event. Note that this
* will not necessarily correspond with the value of the <tt>EventRecord.IsAllDay</tt> field — events that span multiple
* days will be rendered using the all-day event template regardless of the field value. If your logic for this function
* needs to know whether or not the event will be rendered as an all-day event, this value should be used.
* @param {Object} templateData A plain JavaScript object that is empty by default. You can add custom properties
* to this object that will then be passed into the event template for the specific event being rendered. If you have
* overridden the default event template and added custom data placeholders, you can use this object to pass the data
* into the template that will replace those placeholders.
* @param {Ext.data.Store} store The Event data store in use by the view
* @method getEventClass
* @return {String} A space-delimited CSS class string (or '')
*/
initComponent: function() {
this.setStartDate(this.startDate || new Date());
this.callParent(arguments);
if (this.readOnly === true) {
this.addCls('ext-cal-readonly');
}
this.addEvents({
/**
* @event eventsrendered
* Fires after events are finished rendering in the view
* @param {Extensible.calendar.view.AbstractCalendar} this
*/
eventsrendered: true,
/**
* @event eventclick
* Fires after the user clicks on an event element. This is a cancelable event, so returning false from a
* handler will cancel the click without displaying the event editor view. This could be useful for
* validating the rules by which events should be editable by the user.
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Extensible.calendar.data.EventModel} rec The {@link Extensible.calendar.data.EventModel record} for the event that was clicked on
* @param {HTMLNode} el The DOM node that was clicked on
*/
eventclick: true,
/**
* @event eventover
* Fires anytime the mouse is over an event element
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Extensible.calendar.data.EventModel} rec The {@link Extensible.calendar.data.EventModel record} for the event that the cursor is over
* @param {HTMLNode} el The DOM node that is being moused over
*/
eventover: true,
/**
* @event eventout
* Fires anytime the mouse exits an event element
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Extensible.calendar.data.EventModel} rec The {@link Extensible.calendar.data.EventModel record} for the event that the cursor exited
* @param {HTMLNode} el The DOM node that was exited
*/
eventout: true,
/**
* @event beforedatechange
* Fires before the start date of the view changes, giving you an opportunity to save state or anything else you may need
* to do prior to the UI view changing. This is a cancelable event, so returning false from a handler will cancel both the
* view change and the setting of the start date.
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Date} startDate The current start date of the view (as explained in {@link #getStartDate}
* @param {Date} newStartDate The new start date that will be set when the view changes
* @param {Date} viewStart The first displayed date in the current view
* @param {Date} viewEnd The last displayed date in the current view
*/
beforedatechange: true,
/**
* @event datechange
* Fires after the start date of the view has changed. If you need to cancel the date change you should handle the
* {@link #beforedatechange} event and return false from your handler function.
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Date} startDate The start date of the view (as explained in {@link #getStartDate}
* @param {Date} viewStart The first displayed date in the view
* @param {Date} viewEnd The last displayed date in the view
*/
datechange: true,
/**
* @event rangeselect
* Fires after the user drags on the calendar to select a range of dates/times in which to create an event. This is a
* cancelable event, so returning false from a handler will cancel the drag operation and clean up any drag shim elements
* without displaying the event editor view. This could be useful for validating that a user can only create events within
* a certain range.
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Object} dates An object containing the start (StartDate property) and end (EndDate property) dates selected
* @param {Function} callback A callback function that MUST be called after the event handling is complete so that
* the view is properly cleaned up (shim elements are persisted in the view while the user is prompted to handle the
* range selection). The callback is already created in the proper scope, so it simply needs to be executed as a standard
* function call (e.g., callback()).
*/
rangeselect: true,
/**
* @event beforeeventcopy
* Fires before an existing event is duplicated by the user via the "copy" command. This is a
* cancelable event, so returning false from a handler will cancel the copy operation.
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Extensible.calendar.data.EventModel} rec The {@link Extensible.calendar.data.EventModel
* record} for the event that will be copied
* @param {Date} dt The new start date to be set in the copy (the end date will be automaticaly
* adjusted to match the original event duration)
*/
beforeeventcopy: true,
/**
* @event eventcopy
* Fires after an event has been duplicated by the user via the "copy" command. If you need to
* cancel the copy operation you should handle the {@link #beforeeventcopy} event and return
* false from your handler function.
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Extensible.calendar.data.EventModel} rec The {@link Extensible.calendar.data.EventModel
* record} for the event that was copied (with updated start and end dates)
*/
eventcopy: true,
/**
* @event beforeeventmove
* Fires after an event element has been dragged by the user and dropped in a new position, but before
* the event record is updated with the new dates, providing a hook for canceling the update.
* To cancel the move, return false from a handling function. This could be useful for validating
* that a user can only move events within a certain date range, for example.
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Extensible.calendar.data.EventModel} rec The {@link Extensible.calendar.data.EventModel record}
* for the event that will be moved. Start and end dates will be the original values before the move started.
* @param {Date} dt The new start date to be set (the end date will be automaticaly calculated to match
* based on the event duration)
*/
beforeeventmove: true,
/**
* @event eventmove
* Fires after an event element has been moved to a new position and its data updated. If you need to
* cancel the move operation you should handle the {@link #beforeeventmove} event and return false
* from your handler function.
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Extensible.calendar.data.EventModel} rec The {@link Extensible.calendar.data.EventModel record}
* for the event that was moved with updated start and end dates
*/
eventmove: true,
/**
* @event initdrag
* Fires when a drag operation is initiated in the view
* @param {Extensible.calendar.view.AbstractCalendar} this
*/
initdrag: true,
/**
* @event dayover
* Fires while the mouse is over a day element
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Date} dt The date that is being moused over
* @param {Ext.Element} el The day Element that is being moused over
*/
dayover: true,
/**
* @event dayout
* Fires when the mouse exits a day element
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Date} dt The date that is exited
* @param {Ext.Element} el The day Element that is exited
*/
dayout: true,
/**
* @event editdetails
* Fires when the user selects the option in this window to continue editing in the detailed edit form
* (by default, an instance of {@link Extensible.calendar.form.EventDetails}. Handling code should hide this window
* and transfer the current event record to the appropriate instance of the detailed form by showing it
* and calling {@link Extensible.calendar.form.EventDetails#loadRecord loadRecord}.
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Extensible.calendar.data.EventModel} rec The {@link Extensible.calendar.data.EventModel record} that is currently being edited
* @param {Ext.Element} el The target element
*/
editdetails: true,
/**
* @event eventadd
* Fires after a new event has been added to the underlying store
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Extensible.calendar.data.EventModel} rec The new {@link Extensible.calendar.data.EventModel record} that was added
*/
eventadd: true,
/**
* @event eventupdate
* Fires after an existing event has been updated
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Extensible.calendar.data.EventModel} rec The new {@link Extensible.calendar.data.EventModel record} that was updated
*/
eventupdate: true,
/**
* @event eventcancel
* Fires after an event add/edit operation has been canceled by the user and no store update took place
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Extensible.calendar.data.EventModel} rec The new {@link Extensible.calendar.data.EventModel record} that was canceled
*/
eventcancel: true,
/**
* @event beforeeventdelete
* Fires before an event is deleted by the user. This is a cancelable event, so returning false from a handler
* will cancel the delete operation.
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Extensible.calendar.data.EventModel} rec The {@link Extensible.calendar.data.EventModel record} for the event that was deleted
* @param {Ext.Element} el The target element
*/
beforeeventdelete: true,
/**
* @event eventdelete
* Fires after an event has been deleted by the user. If you need to cancel the delete operation you should handle the
* {@link #beforeeventdelete} event and return false from your handler function.
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Extensible.calendar.data.EventModel} rec The {@link Extensible.calendar.data.EventModel record} for the event that was deleted
* @param {Ext.Element} el The target element
*/
eventdelete: true,
/**
* @event eventexception
* Fires after an event has been processed via an Ext proxy and returned with an exception. This
* could be because of a server error, or because the data returned <tt>success: false</tt>.
*
* The view provides default handling via the overrideable {@link #notifyOnException} method. If
* any function handling this event returns false, the notifyOnException method will not be called.
*
* Note that only Server proxy and subclasses (including Ajax proxy) will raise this event.
*
* @param {Extensible.calendar.view.AbstractCalendar} this
* @param {Object} response The raw response object returned from the server
* @param {Ext.data.Operation} operation The operation that was processed
* @since 1.6.0
*/
eventexception: true
});
},
afterRender: function() {
this.callParent(arguments);
this.renderTemplate();
if (this.store) {
this.setStore(this.store, true);
if (this.store.deferLoad) {
this.reloadStore(this.store.deferLoad);
delete this.store.deferLoad;
}
else {
this.store.initialParams = this.getStoreParams();
}
}
if (this.calendarStore) {
this.setCalendarStore(this.calendarStore, true);
}
this.on('resize', this.onResize, this);
this.el.on({
'mouseover': this.onMouseOver,
'mouseout': this.onMouseOut,
'click': this.onClick,
//'resize': this.onResize,
scope: this
});
// currently the context menu only contains CRUD actions so do not show it if read-only
if (this.enableContextMenus && this.readOnly !== true) {
this.el.on('contextmenu', this.onContextMenu, this);
}
this.el.unselectable();
if (this.enableDD && this.readOnly !== true && this.initDD) {
this.initDD();
}
this.on('eventsrendered', this.onEventsRendered);
Ext.defer(this.forceSize, 100, this);
},
/**
* Returns an object containing the start and end dates to be passed as params in all calls
* to load the event store. The param names are customizable using {@link #dateParamStart}
* and {@link #dateParamEnd} and the date format used in requests is defined by {@link #dateParamFormat}.
* If you need to add additional parameters to be sent when loading the store see {@link #getStoreParams}.
* @return {Object} An object containing the start and end dates
*/
getStoreDateParams: function() {
var o = {};
o[this.dateParamStart] = Ext.Date.format(this.viewStart, this.dateParamFormat);
o[this.dateParamEnd] = Ext.Date.format(this.viewEnd, this.dateParamFormat);
return o;
},
/**
* Returns an object containing all key/value params to be passed when loading the event store.
* By default the returned object will simply be the same object returned by {@link #getStoreDateParams},
* but this method is intended to be overridden if you need to pass anything in addition to start and end dates.
* See the inline code comments when overriding for details.
* @return {Object} An object containing all params to be sent when loading the event store
*/
getStoreParams: function() {
// This is needed if you require the default start and end dates to be included
var params = this.getStoreDateParams();
// Here is where you can add additional custom params, e.g.:
// params.now = Ext.Date.format(new Date(), this.dateParamFormat);
// params.foo = 'bar';
// params.number = 123;
return params;
},
/**
* Reloads the view's underlying event store using the params returned from {@link #getStoreParams}.
* Reloading the store is typically managed automatically by the view itself, but the method is
* available in case a manual reload is ever needed.
* @param {Object} options (optional) An object matching the format used by Store's {@link Ext.data.Store#load load} method
*/
reloadStore: function(o) {
Extensible.log('reloadStore');
var recurrenceOptions = this.recurrenceOptions;
o = Ext.isObject(o) ? o : {};
o.params = o.params || {};
Ext.apply(o.params, this.getStoreParams());
if (this.recurrence && recurrenceOptions.expansionParam && recurrenceOptions.expansionMode === 'remote') {
o.params[recurrenceOptions.expansionParam.name] = recurrenceOptions.expansionParam.value;
}
this.store.load(o);
},
onEventsRendered: function() {
this.forceSize();
},
forceSize: function() {
var el = this.el;
if (el && el.down) {
var hd = el.down('.ext-cal-hd-ct'),
bd = el.down('.ext-cal-body-ct');
if (!bd || !hd) {
return;
}
var headerHeight = hd.getHeight(),
sz = el.parent().getSize();
bd.setHeight(sz.height - headerHeight);
}
},
/**
* Refresh the current view, optionally reloading the event store also. While this is normally
* managed internally on any navigation and/or CRUD action, there are times when you might want
* to refresh the view manually (e.g., if you'd like to reload using different {@link #getStoreParams params}).
* @param {Boolean} reloadData True to reload the store data first, false to simply redraw the view using current
* data (defaults to false)
*/
refresh: function(reloadData) {
if (!this.isActiveView()) {
Extensible.log('refresh (AbstractCalendar), skipped for non-active view (' + this.id + ')');
return;
}
Extensible.log('refresh (AbstractCalendar), reload = ' + reloadData);
if (reloadData === true) {
this.reloadStore();
}
else {
this.prepareData();
this.renderTemplate();
this.renderItems();
}
},
getWeekCount: function() {
var days = Extensible.Date.diffDays(this.viewStart, this.viewEnd);
return Math.ceil(days / this.dayCount);
},
prepareData: function() {
var lastInMonth = Ext.Date.getLastDateOfMonth(this.startDate),
w = 0,
d = 0,
row = 0,
currentDt = Extensible.Date.add(Ext.Date.clearTime(this.viewStart, true), {hours: 12}),
weeks = this.weekCount < 1 ? 6 : this.weekCount;
lastInMonth = Extensible.Date.add(Ext.Date.clearTime(lastInMonth), {hours: 12})
this.eventGrid = [[]];
this.allDayGrid = [[]];
this.evtMaxCount = [];
var evtsInView = this.store.queryBy(function(rec) {
return this.isEventVisible(rec.data);
}, this);
var evtsInDay = function(rec) {
var EventMappings = Extensible.calendar.data.EventMappings,
startDt = Extensible.Date.add(Ext.Date.clearTime(rec.data[EventMappings.StartDate.name], true), {hours: 12}),
startsOnDate = Extensible.Date.diffDays(currentDt, startDt) === 0,
spansFromPrevView = (w === 0 && d === 0 && (currentDt > startDt));
return startsOnDate || spansFromPrevView;
};
for (; w < weeks; w++) {
this.evtMaxCount[w] = this.evtMaxCount[w] || 0;
if (this.weekCount === -1 && currentDt > lastInMonth) {
//current week is fully in next month so skip
break;
}
this.eventGrid[w] = this.eventGrid[w] || [];
this.allDayGrid[w] = this.allDayGrid[w] || [];
for (d = 0; d < this.dayCount; d++) {
if (evtsInView.getCount() > 0) {
var evts = evtsInView.filterBy(evtsInDay, this);
this.sortEventRecordsForDay(evts);
this.prepareEventGrid(evts, w, d);
}
currentDt = Extensible.Date.add(currentDt, {days: 1});
}
}
this.currentWeekCount = w;
},
prepareEventGrid: function(evts, w, d) {
var me = this,
row = 0,
maxEventsForDay;
evts.each(function(evt) {
var M = Extensible.calendar.data.EventMappings;
if (Extensible.Date.diffDays(evt.data[M.StartDate.name], evt.data[M.EndDate.name]) > 0) {
var daysInView = Extensible.Date.diffDays(
Extensible.Date.max(me.viewStart, evt.data[M.StartDate.name]),
Extensible.Date.min(me.viewEnd, evt.data[M.EndDate.name])) + 1;
me.prepareEventGridSpans(evt, me.eventGrid, w, d, daysInView);
me.prepareEventGridSpans(evt, me.allDayGrid, w, d, daysInView, true);
}
else {
row = me.findEmptyRowIndex(w,d);
me.eventGrid[w][d] = me.eventGrid[w][d] || [];
me.eventGrid[w][d][row] = evt;
if (evt.data[M.IsAllDay.name]) {
row = me.findEmptyRowIndex(w,d, true);
me.allDayGrid[w][d] = me.allDayGrid[w][d] || [];
me.allDayGrid[w][d][row] = evt;
}
}
me.setMaxEventsForDay(w, d);
return true;
}, me);
},
setMaxEventsForDay: function(weekIndex, dayIndex) {
var max = (this.maxEventsPerDay + 1) || 999;
// If calculating the max event count for the day/week view header, use the allDayGrid
// so that only all-day events displayed in that area get counted, otherwise count all events.
var maxEventsForDay = this[this.isHeaderView ? 'allDayGrid' : 'eventGrid'][weekIndex][dayIndex] || [];
this.evtMaxCount[weekIndex] = this.evtMaxCount[weekIndex] || 0;
if (maxEventsForDay.length && this.evtMaxCount[weekIndex] < maxEventsForDay.length) {
this.evtMaxCount[weekIndex] = Math.min(max, maxEventsForDay.length);
}
},
prepareEventGridSpans: function(evt, grid, w, d, days, allday) {
// this event spans multiple days/weeks, so we have to preprocess
// the events and store special span events as placeholders so that
// the render routine can build the necessary TD spans correctly.
var w1 = w,
d1 = d,
row = this.findEmptyRowIndex(w,d,allday),
dt = Extensible.Date.add(Ext.Date.clearTime(this.viewStart, true), {hours: 12});
var start = {
event: evt,
isSpan: true,
isSpanStart: true,
spanLeft: false,
spanRight: (d === 6)
};
grid[w][d] = grid[w][d] || [];
grid[w][d][row] = start;
this.setMaxEventsForDay(w, d);
while (--days) {
dt = Extensible.Date.add(dt, {days: 1});
if (dt > this.viewEnd) {
break;
}
if (++d1 > 6) {
// reset counters to the next week
d1 = 0; w1++;
row = this.findEmptyRowIndex(w1,0);
}
grid[w1] = grid[w1] || [];
grid[w1][d1] = grid[w1][d1] || [];
grid[w1][d1][row] = {
event: evt,
isSpan: true,
isSpanStart: (d1 === 0),
spanLeft: (w1 > w) && (d1 % 7 === 0),
spanRight: (d1 === 6) && (days > 1)
};
// In this loop we are pre-processing empty span placeholders. In the case
// where a given week might only contain such spans, we have to make this
// max event check on each iteration to make sure that our empty placeholder
// divs get created correctly even without "real" events:
this.setMaxEventsForDay(w1, d1);
}
},
findEmptyRowIndex: function(w, d, allday) {
var grid = allday ? this.allDayGrid : this.eventGrid,
day = grid[w] ? grid[w][d] || [] : [],
i = 0,
len = day.length;
for (; i < len; i++) {
if (!day[i]) {
return i;
}
}
return len;
},
renderTemplate: function() {
if (this.tpl) {
this.tpl.overwrite(this.el, this.getTemplateParams());
this.lastRenderStart = Ext.Date.clone(this.viewStart);
this.lastRenderEnd = Ext.Date.clone(this.viewEnd);
}
},
getTemplateParams: function() {
return {
viewStart: this.viewStart,
viewEnd: this.viewEnd,
startDate: this.startDate,
dayCount: this.dayCount,
weekCount: this.weekCount,
weekendCls: this.weekendCls,
prevMonthCls: this.prevMonthCls,
nextMonthCls: this.nextMonthCls,
todayCls: this.todayCls
};
},
/**
* Disable store event monitoring within this view. Note that if you do this the view will no longer
* refresh itself automatically when CRUD actions occur. To enable store events see {@link #enableStoreEvents}.
* @return {CalendarView} this
*/
disableStoreEvents: function() {
this.monitorStoreEvents = false;
return this;
},
/**
* Enable store event monitoring within this view if disabled by {@link #disbleStoreEvents}.
* @return {CalendarView} this
*/
enableStoreEvents: function(refresh) {
this.monitorStoreEvents = true;
if (refresh === true) {
this.refresh();
}
return this;
},
onResize: function() {
this.refresh(false);
},
onInitDrag: function() {
this.fireEvent('initdrag', this);
},
onEventDrop: function(rec, dt, mode) {
this[(mode || 'move') + 'Event'](rec, dt);
},
onCalendarEndDrag: function(start, end, onComplete) {
// set this flag for other event handlers that might conflict while we're waiting
this.dragPending = true;
var dates = {},
boundOnComplete = Ext.bind(this.onCalendarEndDragComplete, this, [onComplete]);
dates[Extensible.calendar.data.EventMappings.StartDate.name] = start;
dates[Extensible.calendar.data.EventMappings.EndDate.name] = end;
if (this.fireEvent('rangeselect', this, dates, boundOnComplete) !== false) {
this.showEventEditor(dates, null);
if (this.editWin) {
this.editWin.on('hide', boundOnComplete, this, {single:true});
}
else {
boundOnComplete();
}
}
else {
// client code canceled the selection so clean up immediately
this.onCalendarEndDragComplete(boundOnComplete);
}
},
onCalendarEndDragComplete: function(onComplete) {
// callback for the drop zone to clean up
onComplete();
// clear flag for other events to resume normally
this.dragPending = false;
},
/**
* Refresh the view. Determine if a store reload is required after a given CRUD operation.
* @param {String} action One of 'create', 'update' or 'delete'
* @param {Ext.data.Operation} operation The affected operation
*/
refreshAfterEventChange: function(action, operation) {
// Determine if a store reload is needed. A store reload is needed if the event is recurring after being
// edited or was recurring before being edited AND an event store reload has not been triggered already for
// this operation. If an event is not currently recurring (isRecurring = false) but still has an instance
// start date set, then it must have been recurring and edited to no longer recur.
var RInstanceStartDate = Extensible.calendar.data.EventMappings.RInstanceStartDate,
isInstance = RInstanceStartDate && !!operation.records[0].get(RInstanceStartDate.name),
reload = (operation.records[0].isRecurring() || isInstance) && !operation.wasStoreReloadTriggered;
if (reload) {
// For calendar views with a body and a header component (e.g. weekly view, day view), this function is
// called twice. Ensure that a store reload is triggered only once for the same operation.
operation.wasStoreReloadTriggered = true;
}
this.refresh(reload);
},
onUpdate: function(store, operation, updateType) {
if (this.hidden === true || this.ownerCt.hidden === true || this.monitorStoreEvents === false) {
// Hidden calendar view don't need to be refreshed. For views composed of header and body (for example
// Extensible.calendar.view.Day or Extensible.calendar.view.Week) we need to check the ownerCt to find out
// if a view is hidden.
return;
}
if (updateType === Ext.data.Record.COMMIT) {
Extensible.log('onUpdate');
this.dismissEventEditor();
this.refreshAfterEventChange('update', operation);
var rec = operation.records[0];
if (this.enableFx && this.enableUpdateFx) {
this.doUpdateFx(this.getEventEls(rec.data[Extensible.calendar.data.EventMappings.EventId.name]), {
scope: this
});
}
}
},
/**