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