a3779f5b0812ac0a14ceb6d1c8d16fb76249df5b
[roojs1] / docs / symbols / Roo.grid.Calendar.json
1 {
2   "name" : "Roo.grid.Calendar",
3   "augments" : [
4   ],
5   "desc" : "This class extends the Grid to provide a calendar widget\n<br><br>Usage:<pre><code>\n var grid = new Roo.grid.Calendar(\"my-container-id\", {\n     ds: myDataStore,\n     cm: myColModel,\n     selModel: mySelectionModel,\n     autoSizeColumns: true,\n     monitorWindowResize: false,\n     trackMouseOver: true\n     eventstore : real data store..\n });\n // set any options\n grid.render();",
6   "isSingleton" : false,
7   "isStatic" : false,
8   "isBuiltin" : false,
9   "memberOf" : "Calendar",
10   "example" : "",
11   "deprecated" : "",
12   "since" : "",
13   "see" : "",
14   "params" : [
15     {
16       "name" : "container",
17       "type" : "String/HTMLElement/Roo.Element",
18       "desc" : "The element into which this grid will be rendered -\nThe container MUST have some type of size defined for the grid to fill. The container will be\nautomatically set to position relative if it isn't already.",
19       "isOptional" : false
20     },
21     {
22       "name" : "config",
23       "type" : "Object",
24       "desc" : "A config object that sets properties on this grid.",
25       "isOptional" : false
26     }
27   ],
28   "returns" : [
29   ],
30   "config" : [
31     {
32       "name" : "eventStore",
33       "type" : "Store",
34       "desc" : "The store that loads events.",
35       "memberOf" : "Roo.grid.Calendar",
36       "values" : [
37       ]
38     }
39   ],
40   "methods" : [
41     {
42       "name" : "getSelectionModel",
43       "desc" : "Returns the grid's SelectionModel.",
44       "isStatic" : false,
45       "isConstructor" : false,
46       "isPrivate" : false,
47       "memberOf" : "Roo.grid.Calendar",
48       "example" : "",
49       "deprecated" : "",
50       "since" : "",
51       "see" : "",
52       "params" : [
53       ],
54       "returns" : [
55         {
56           "name" : "",
57           "type" : "SelectionModel",
58           "desc" : ""
59         }
60       ]
61     }
62   ],
63   "events" : [
64     {
65       "name" : "eventclick",
66       "desc" : "Fires when the mouse click an",
67       "memberOf" : "",
68       "example" : "",
69       "deprecated" : "",
70       "since" : "",
71       "see" : "",
72       "params" : [
73         {
74           "name" : "this",
75           "type" : "Calendar",
76           "desc" : "",
77           "isOptional" : false
78         },
79         {
80           "name" : "",
81           "type" : "event",
82           "desc" : "",
83           "isOptional" : false
84         }
85       ],
86       "returns" : [
87       ]
88     },
89     {
90       "name" : "select",
91       "desc" : "Fires when a date is selected",
92       "memberOf" : "",
93       "example" : "",
94       "deprecated" : "",
95       "since" : "",
96       "see" : "",
97       "params" : [
98         {
99           "name" : "this",
100           "type" : "DatePicker",
101           "desc" : "",
102           "isOptional" : false
103         },
104         {
105           "name" : "date",
106           "type" : "Date",
107           "desc" : "The selected date",
108           "isOptional" : false
109         }
110       ],
111       "returns" : [
112       ]
113     },
114     {
115       "name" : "mouseout",
116       "desc" : "The raw mouseout event for the entire grid.",
117       "memberOf" : "",
118       "example" : "",
119       "deprecated" : "",
120       "since" : "",
121       "see" : "",
122       "params" : [
123         {
124           "name" : "e",
125           "type" : "Roo.EventObject",
126           "desc" : "",
127           "isOptional" : false
128         }
129       ],
130       "returns" : [
131       ]
132     },
133     {
134       "name" : "monthchange",
135       "desc" : "Fires when the displayed month changes",
136       "memberOf" : "",
137       "example" : "",
138       "deprecated" : "",
139       "since" : "",
140       "see" : "",
141       "params" : [
142         {
143           "name" : "this",
144           "type" : "DatePicker",
145           "desc" : "",
146           "isOptional" : false
147         },
148         {
149           "name" : "date",
150           "type" : "Date",
151           "desc" : "The selected month",
152           "isOptional" : false
153         }
154       ],
155       "returns" : [
156       ]
157     },
158     {
159       "name" : "dragdrop",
160       "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
161       "memberOf" : "",
162       "example" : "",
163       "deprecated" : "",
164       "since" : "",
165       "see" : "",
166       "params" : [
167         {
168           "name" : "this",
169           "type" : "Grid",
170           "desc" : "",
171           "isOptional" : false
172         },
173         {
174           "name" : "dd",
175           "type" : "Roo.GridDD",
176           "desc" : "The drag drop object",
177           "isOptional" : false
178         },
179         {
180           "name" : "targetId",
181           "type" : "String",
182           "desc" : "The target drag drop object",
183           "isOptional" : false
184         },
185         {
186           "name" : "e",
187           "type" : "event",
188           "desc" : "The raw browser event",
189           "isOptional" : false
190         }
191       ],
192       "returns" : [
193       ]
194     },
195     {
196       "name" : "rowclick",
197       "desc" : "Fires when a row is clicked",
198       "memberOf" : "",
199       "example" : "",
200       "deprecated" : "",
201       "since" : "",
202       "see" : "",
203       "params" : [
204         {
205           "name" : "this",
206           "type" : "Grid",
207           "desc" : "",
208           "isOptional" : false
209         },
210         {
211           "name" : "rowIndex",
212           "type" : "Number",
213           "desc" : "",
214           "isOptional" : false
215         },
216         {
217           "name" : "e",
218           "type" : "Roo.EventObject",
219           "desc" : "",
220           "isOptional" : false
221         }
222       ],
223       "returns" : [
224       ]
225     },
226     {
227       "name" : "headerclick",
228       "desc" : "Fires when a header is clicked",
229       "memberOf" : "",
230       "example" : "",
231       "deprecated" : "",
232       "since" : "",
233       "see" : "",
234       "params" : [
235         {
236           "name" : "this",
237           "type" : "Grid",
238           "desc" : "",
239           "isOptional" : false
240         },
241         {
242           "name" : "columnIndex",
243           "type" : "Number",
244           "desc" : "",
245           "isOptional" : false
246         },
247         {
248           "name" : "e",
249           "type" : "Roo.EventObject",
250           "desc" : "",
251           "isOptional" : false
252         }
253       ],
254       "returns" : [
255       ]
256     },
257     {
258       "name" : "startdrag",
259       "desc" : "Fires when row(s) start being dragged",
260       "memberOf" : "",
261       "example" : "",
262       "deprecated" : "",
263       "since" : "",
264       "see" : "",
265       "params" : [
266         {
267           "name" : "this",
268           "type" : "Grid",
269           "desc" : "",
270           "isOptional" : false
271         },
272         {
273           "name" : "dd",
274           "type" : "Roo.GridDD",
275           "desc" : "The drag drop object",
276           "isOptional" : false
277         },
278         {
279           "name" : "e",
280           "type" : "event",
281           "desc" : "The raw browser event",
282           "isOptional" : false
283         }
284       ],
285       "returns" : [
286       ]
287     },
288     {
289       "name" : "enddrag",
290       "desc" : "Fires when a drag operation is complete",
291       "memberOf" : "",
292       "example" : "",
293       "deprecated" : "",
294       "since" : "",
295       "see" : "",
296       "params" : [
297         {
298           "name" : "this",
299           "type" : "Grid",
300           "desc" : "",
301           "isOptional" : false
302         },
303         {
304           "name" : "dd",
305           "type" : "Roo.GridDD",
306           "desc" : "The drag drop object",
307           "isOptional" : false
308         },
309         {
310           "name" : "e",
311           "type" : "event",
312           "desc" : "The raw browser event",
313           "isOptional" : false
314         }
315       ],
316       "returns" : [
317       ]
318     },
319     {
320       "name" : "headerdblclick",
321       "desc" : "Fires when a header cell is double clicked",
322       "memberOf" : "",
323       "example" : "",
324       "deprecated" : "",
325       "since" : "",
326       "see" : "",
327       "params" : [
328         {
329           "name" : "this",
330           "type" : "Grid",
331           "desc" : "",
332           "isOptional" : false
333         },
334         {
335           "name" : "columnIndex",
336           "type" : "Number",
337           "desc" : "",
338           "isOptional" : false
339         },
340         {
341           "name" : "e",
342           "type" : "Roo.EventObject",
343           "desc" : "",
344           "isOptional" : false
345         }
346       ],
347       "returns" : [
348       ]
349     },
350     {
351       "name" : "dragenter",
352       "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
353       "memberOf" : "",
354       "example" : "",
355       "deprecated" : "",
356       "since" : "",
357       "see" : "",
358       "params" : [
359         {
360           "name" : "this",
361           "type" : "Grid",
362           "desc" : "",
363           "isOptional" : false
364         },
365         {
366           "name" : "dd",
367           "type" : "Roo.GridDD",
368           "desc" : "The drag drop object",
369           "isOptional" : false
370         },
371         {
372           "name" : "targetId",
373           "type" : "String",
374           "desc" : "The target drag drop object",
375           "isOptional" : false
376         },
377         {
378           "name" : "e",
379           "type" : "event",
380           "desc" : "The raw browser event",
381           "isOptional" : false
382         }
383       ],
384       "returns" : [
385       ]
386     },
387     {
388       "name" : "keydown",
389       "desc" : "The raw keydown event for the entire grid.",
390       "memberOf" : "",
391       "example" : "",
392       "deprecated" : "",
393       "since" : "",
394       "see" : "",
395       "params" : [
396         {
397           "name" : "e",
398           "type" : "Roo.EventObject",
399           "desc" : "",
400           "isOptional" : false
401         }
402       ],
403       "returns" : [
404       ]
405     },
406     {
407       "name" : "dblclick",
408       "desc" : "The raw dblclick event for the entire grid.",
409       "memberOf" : "",
410       "example" : "",
411       "deprecated" : "",
412       "since" : "",
413       "see" : "",
414       "params" : [
415         {
416           "name" : "e",
417           "type" : "Roo.EventObject",
418           "desc" : "",
419           "isOptional" : false
420         }
421       ],
422       "returns" : [
423       ]
424     },
425     {
426       "name" : "dragout",
427       "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
428       "memberOf" : "",
429       "example" : "",
430       "deprecated" : "",
431       "since" : "",
432       "see" : "",
433       "params" : [
434         {
435           "name" : "this",
436           "type" : "Grid",
437           "desc" : "",
438           "isOptional" : false
439         },
440         {
441           "name" : "dd",
442           "type" : "Roo.GridDD",
443           "desc" : "The drag drop object",
444           "isOptional" : false
445         },
446         {
447           "name" : "targetId",
448           "type" : "String",
449           "desc" : "The target drag drop object",
450           "isOptional" : false
451         },
452         {
453           "name" : "e",
454           "type" : "event",
455           "desc" : "The raw browser event",
456           "isOptional" : false
457         }
458       ],
459       "returns" : [
460       ]
461     },
462     {
463       "name" : "columnmove",
464       "desc" : "Fires when the user moves a column",
465       "memberOf" : "",
466       "example" : "",
467       "deprecated" : "",
468       "since" : "",
469       "see" : "",
470       "params" : [
471         {
472           "name" : "oldIndex",
473           "type" : "Number",
474           "desc" : "",
475           "isOptional" : false
476         },
477         {
478           "name" : "newIndex",
479           "type" : "Number",
480           "desc" : "",
481           "isOptional" : false
482         }
483       ],
484       "returns" : [
485       ]
486     },
487     {
488       "name" : "mouseup",
489       "desc" : "The raw mouseup event for the entire grid.",
490       "memberOf" : "",
491       "example" : "",
492       "deprecated" : "",
493       "since" : "",
494       "see" : "",
495       "params" : [
496         {
497           "name" : "e",
498           "type" : "Roo.EventObject",
499           "desc" : "",
500           "isOptional" : false
501         }
502       ],
503       "returns" : [
504       ]
505     },
506     {
507       "name" : "eventrender",
508       "desc" : "Fires before each cell is rendered, so you can modify the contents, like cls / title / qtip",
509       "memberOf" : "",
510       "example" : "",
511       "deprecated" : "",
512       "since" : "",
513       "see" : "",
514       "params" : [
515         {
516           "name" : "this",
517           "type" : "Calendar",
518           "desc" : "",
519           "isOptional" : false
520         },
521         {
522           "name" : "data",
523           "type" : "data",
524           "desc" : "to be modified",
525           "isOptional" : false
526         }
527       ],
528       "returns" : [
529       ]
530     },
531     {
532       "name" : "bodyscroll",
533       "desc" : "Fires when the body element is scrolled",
534       "memberOf" : "",
535       "example" : "",
536       "deprecated" : "",
537       "since" : "",
538       "see" : "",
539       "params" : [
540         {
541           "name" : "scrollLeft",
542           "type" : "Number",
543           "desc" : "",
544           "isOptional" : false
545         },
546         {
547           "name" : "scrollTop",
548           "type" : "Number",
549           "desc" : "",
550           "isOptional" : false
551         }
552       ],
553       "returns" : [
554       ]
555     },
556     {
557       "name" : "rowdblclick",
558       "desc" : "Fires when a row is double clicked",
559       "memberOf" : "",
560       "example" : "",
561       "deprecated" : "",
562       "since" : "",
563       "see" : "",
564       "params" : [
565         {
566           "name" : "this",
567           "type" : "Grid",
568           "desc" : "",
569           "isOptional" : false
570         },
571         {
572           "name" : "rowIndex",
573           "type" : "Number",
574           "desc" : "",
575           "isOptional" : false
576         },
577         {
578           "name" : "e",
579           "type" : "Roo.EventObject",
580           "desc" : "",
581           "isOptional" : false
582         }
583       ],
584       "returns" : [
585       ]
586     },
587     {
588       "name" : "cellclick",
589       "desc" : "Fires when a cell is clicked",
590       "memberOf" : "",
591       "example" : "",
592       "deprecated" : "",
593       "since" : "",
594       "see" : "",
595       "params" : [
596         {
597           "name" : "this",
598           "type" : "Grid",
599           "desc" : "",
600           "isOptional" : false
601         },
602         {
603           "name" : "rowIndex",
604           "type" : "Number",
605           "desc" : "",
606           "isOptional" : false
607         },
608         {
609           "name" : "columnIndex",
610           "type" : "Number",
611           "desc" : "",
612           "isOptional" : false
613         },
614         {
615           "name" : "e",
616           "type" : "Roo.EventObject",
617           "desc" : "",
618           "isOptional" : false
619         }
620       ],
621       "returns" : [
622       ]
623     },
624     {
625       "name" : "evententer",
626       "desc" : "Fires when mouse over an event",
627       "memberOf" : "",
628       "example" : "",
629       "deprecated" : "",
630       "since" : "",
631       "see" : "",
632       "params" : [
633         {
634           "name" : "this",
635           "type" : "Calendar",
636           "desc" : "",
637           "isOptional" : false
638         },
639         {
640           "name" : "Event",
641           "type" : "event",
642           "desc" : "",
643           "isOptional" : false
644         }
645       ],
646       "returns" : [
647       ]
648     },
649     {
650       "name" : "mousedown",
651       "desc" : "The raw mousedown event for the entire grid.",
652       "memberOf" : "",
653       "example" : "",
654       "deprecated" : "",
655       "since" : "",
656       "see" : "",
657       "params" : [
658         {
659           "name" : "e",
660           "type" : "Roo.EventObject",
661           "desc" : "",
662           "isOptional" : false
663         }
664       ],
665       "returns" : [
666       ]
667     },
668     {
669       "name" : "click",
670       "desc" : "The raw click event for the entire grid.",
671       "memberOf" : "",
672       "example" : "",
673       "deprecated" : "",
674       "since" : "",
675       "see" : "",
676       "params" : [
677         {
678           "name" : "e",
679           "type" : "Roo.EventObject",
680           "desc" : "",
681           "isOptional" : false
682         }
683       ],
684       "returns" : [
685       ]
686     },
687     {
688       "name" : "contextmenu",
689       "desc" : "The raw contextmenu event for the entire grid.",
690       "memberOf" : "",
691       "example" : "",
692       "deprecated" : "",
693       "since" : "",
694       "see" : "",
695       "params" : [
696         {
697           "name" : "e",
698           "type" : "Roo.EventObject",
699           "desc" : "",
700           "isOptional" : false
701         }
702       ],
703       "returns" : [
704       ]
705     },
706     {
707       "name" : "eventleave",
708       "desc" : "Fires when the mouse leaves an",
709       "memberOf" : "",
710       "example" : "",
711       "deprecated" : "",
712       "since" : "",
713       "see" : "",
714       "params" : [
715         {
716           "name" : "this",
717           "type" : "Calendar",
718           "desc" : "",
719           "isOptional" : false
720         },
721         {
722           "name" : "",
723           "type" : "event",
724           "desc" : "",
725           "isOptional" : false
726         }
727       ],
728       "returns" : [
729       ]
730     },
731     {
732       "name" : "dragover",
733       "desc" : "Fires while row(s) are being dragged. \"targetId\" is the id of the Yahoo.util.DD object the selected rows are being dragged over.",
734       "memberOf" : "",
735       "example" : "",
736       "deprecated" : "",
737       "since" : "",
738       "see" : "",
739       "params" : [
740         {
741           "name" : "this",
742           "type" : "Grid",
743           "desc" : "",
744           "isOptional" : false
745         },
746         {
747           "name" : "dd",
748           "type" : "Roo.GridDD",
749           "desc" : "The drag drop object",
750           "isOptional" : false
751         },
752         {
753           "name" : "targetId",
754           "type" : "String",
755           "desc" : "The target drag drop object",
756           "isOptional" : false
757         },
758         {
759           "name" : "e",
760           "type" : "event",
761           "desc" : "The raw browser event",
762           "isOptional" : false
763         }
764       ],
765       "returns" : [
766       ]
767     },
768     {
769       "name" : "rowcontextmenu",
770       "desc" : "Fires when a row is right clicked",
771       "memberOf" : "",
772       "example" : "",
773       "deprecated" : "",
774       "since" : "",
775       "see" : "",
776       "params" : [
777         {
778           "name" : "this",
779           "type" : "Grid",
780           "desc" : "",
781           "isOptional" : false
782         },
783         {
784           "name" : "rowIndex",
785           "type" : "Number",
786           "desc" : "",
787           "isOptional" : false
788         },
789         {
790           "name" : "e",
791           "type" : "Roo.EventObject",
792           "desc" : "",
793           "isOptional" : false
794         }
795       ],
796       "returns" : [
797       ]
798     },
799     {
800       "name" : "celldblclick",
801       "desc" : "Fires when a cell is double clicked",
802       "memberOf" : "",
803       "example" : "",
804       "deprecated" : "",
805       "since" : "",
806       "see" : "",
807       "params" : [
808         {
809           "name" : "this",
810           "type" : "Grid",
811           "desc" : "",
812           "isOptional" : false
813         },
814         {
815           "name" : "rowIndex",
816           "type" : "Number",
817           "desc" : "",
818           "isOptional" : false
819         },
820         {
821           "name" : "columnIndex",
822           "type" : "Number",
823           "desc" : "",
824           "isOptional" : false
825         },
826         {
827           "name" : "e",
828           "type" : "Roo.EventObject",
829           "desc" : "",
830           "isOptional" : false
831         }
832       ],
833       "returns" : [
834       ]
835     },
836     {
837       "name" : "headercontextmenu",
838       "desc" : "Fires when a header is right clicked",
839       "memberOf" : "",
840       "example" : "",
841       "deprecated" : "",
842       "since" : "",
843       "see" : "",
844       "params" : [
845         {
846           "name" : "this",
847           "type" : "Grid",
848           "desc" : "",
849           "isOptional" : false
850         },
851         {
852           "name" : "columnIndex",
853           "type" : "Number",
854           "desc" : "",
855           "isOptional" : false
856         },
857         {
858           "name" : "e",
859           "type" : "Roo.EventObject",
860           "desc" : "",
861           "isOptional" : false
862         }
863       ],
864       "returns" : [
865       ]
866     },
867     {
868       "name" : "rowclass",
869       "desc" : "Fires when a row is rendered, so you can change add a style to it.",
870       "memberOf" : "",
871       "example" : "",
872       "deprecated" : "",
873       "since" : "",
874       "see" : "",
875       "params" : [
876         {
877           "name" : "gridview",
878           "type" : "GridView",
879           "desc" : "The grid view",
880           "isOptional" : false
881         },
882         {
883           "name" : "rowcfg",
884           "type" : "Object",
885           "desc" : "contains record  rowIndex and rowClass - set rowClass to add a style.",
886           "isOptional" : false
887         }
888       ],
889       "returns" : [
890       ]
891     },
892     {
893       "name" : "mouseover",
894       "desc" : "The raw mouseover event for the entire grid.",
895       "memberOf" : "",
896       "example" : "",
897       "deprecated" : "",
898       "since" : "",
899       "see" : "",
900       "params" : [
901         {
902           "name" : "e",
903           "type" : "Roo.EventObject",
904           "desc" : "",
905           "isOptional" : false
906         }
907       ],
908       "returns" : [
909       ]
910     },
911     {
912       "name" : "keypress",
913       "desc" : "The raw keypress event for the entire grid.",
914       "memberOf" : "",
915       "example" : "",
916       "deprecated" : "",
917       "since" : "",
918       "see" : "",
919       "params" : [
920         {
921           "name" : "e",
922           "type" : "Roo.EventObject",
923           "desc" : "",
924           "isOptional" : false
925         }
926       ],
927       "returns" : [
928       ]
929     },
930     {
931       "name" : "render",
932       "desc" : "Fires when the grid is rendered",
933       "memberOf" : "",
934       "example" : "",
935       "deprecated" : "",
936       "since" : "",
937       "see" : "",
938       "params" : [
939         {
940           "name" : "grid",
941           "type" : "Grid",
942           "desc" : "",
943           "isOptional" : false
944         }
945       ],
946       "returns" : [
947       ]
948     },
949     {
950       "name" : "columnresize",
951       "desc" : "Fires when the user resizes a column",
952       "memberOf" : "",
953       "example" : "",
954       "deprecated" : "",
955       "since" : "",
956       "see" : "",
957       "params" : [
958         {
959           "name" : "columnIndex",
960           "type" : "Number",
961           "desc" : "",
962           "isOptional" : false
963         },
964         {
965           "name" : "newSize",
966           "type" : "Number",
967           "desc" : "",
968           "isOptional" : false
969         }
970       ],
971       "returns" : [
972       ]
973     },
974     {
975       "name" : "cellcontextmenu",
976       "desc" : "Fires when a cell is right clicked",
977       "memberOf" : "",
978       "example" : "",
979       "deprecated" : "",
980       "since" : "",
981       "see" : "",
982       "params" : [
983         {
984           "name" : "this",
985           "type" : "Grid",
986           "desc" : "",
987           "isOptional" : false
988         },
989         {
990           "name" : "rowIndex",
991           "type" : "Number",
992           "desc" : "",
993           "isOptional" : false
994         },
995         {
996           "name" : "cellIndex",
997           "type" : "Number",
998           "desc" : "",
999           "isOptional" : false
1000         },
1001         {
1002           "name" : "e",
1003           "type" : "Roo.EventObject",
1004           "desc" : "",
1005           "isOptional" : false
1006         }
1007       ],
1008       "returns" : [
1009       ]
1010     }
1011   ]
1012 }