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