Fix #5654 - roojspacker - get it working as a doc tool...
[roojs1] / docs / symbols / Roo.grid.Calendar.json
diff --git a/docs/symbols/Roo.grid.Calendar.json b/docs/symbols/Roo.grid.Calendar.json
new file mode 100644 (file)
index 0000000..a3779f5
--- /dev/null
@@ -0,0 +1,1012 @@
+{
+  "name" : "Roo.grid.Calendar",
+  "augments" : [
+  ],
+  "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();",
+  "isSingleton" : false,
+  "isStatic" : false,
+  "isBuiltin" : false,
+  "memberOf" : "Calendar",
+  "example" : "",
+  "deprecated" : "",
+  "since" : "",
+  "see" : "",
+  "params" : [
+    {
+      "name" : "container",
+      "type" : "String/HTMLElement/Roo.Element",
+      "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.",
+      "isOptional" : false
+    },
+    {
+      "name" : "config",
+      "type" : "Object",
+      "desc" : "A config object that sets properties on this grid.",
+      "isOptional" : false
+    }
+  ],
+  "returns" : [
+  ],
+  "config" : [
+    {
+      "name" : "eventStore",
+      "type" : "Store",
+      "desc" : "The store that loads events.",
+      "memberOf" : "Roo.grid.Calendar",
+      "values" : [
+      ]
+    }
+  ],
+  "methods" : [
+    {
+      "name" : "getSelectionModel",
+      "desc" : "Returns the grid's SelectionModel.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.grid.Calendar",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "SelectionModel",
+          "desc" : ""
+        }
+      ]
+    }
+  ],
+  "events" : [
+    {
+      "name" : "eventclick",
+      "desc" : "Fires when the mouse click an",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Calendar",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "",
+          "type" : "event",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "select",
+      "desc" : "Fires when a date is selected",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "DatePicker",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "date",
+          "type" : "Date",
+          "desc" : "The selected date",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "mouseout",
+      "desc" : "The raw mouseout event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "monthchange",
+      "desc" : "Fires when the displayed month changes",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "DatePicker",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "date",
+          "type" : "Date",
+          "desc" : "The selected month",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "dragdrop",
+      "desc" : "Fires when dragged row(s) are dropped on a valid DD target",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "dd",
+          "type" : "Roo.GridDD",
+          "desc" : "The drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "targetId",
+          "type" : "String",
+          "desc" : "The target drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "event",
+          "desc" : "The raw browser event",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "rowclick",
+      "desc" : "Fires when a row is clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "rowIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "headerclick",
+      "desc" : "Fires when a header is clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "columnIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "startdrag",
+      "desc" : "Fires when row(s) start being dragged",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "dd",
+          "type" : "Roo.GridDD",
+          "desc" : "The drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "event",
+          "desc" : "The raw browser event",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "enddrag",
+      "desc" : "Fires when a drag operation is complete",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "dd",
+          "type" : "Roo.GridDD",
+          "desc" : "The drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "event",
+          "desc" : "The raw browser event",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "headerdblclick",
+      "desc" : "Fires when a header cell is double clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "columnIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "dragenter",
+      "desc" : "Fires when the dragged row(s) first cross another DD target while being dragged",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "dd",
+          "type" : "Roo.GridDD",
+          "desc" : "The drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "targetId",
+          "type" : "String",
+          "desc" : "The target drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "event",
+          "desc" : "The raw browser event",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "keydown",
+      "desc" : "The raw keydown event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "dblclick",
+      "desc" : "The raw dblclick event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "dragout",
+      "desc" : "Fires when the dragged row(s) leave another DD target while being dragged",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "dd",
+          "type" : "Roo.GridDD",
+          "desc" : "The drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "targetId",
+          "type" : "String",
+          "desc" : "The target drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "event",
+          "desc" : "The raw browser event",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "columnmove",
+      "desc" : "Fires when the user moves a column",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "oldIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "newIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "mouseup",
+      "desc" : "The raw mouseup event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "eventrender",
+      "desc" : "Fires before each cell is rendered, so you can modify the contents, like cls / title / qtip",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Calendar",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "data",
+          "type" : "data",
+          "desc" : "to be modified",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "bodyscroll",
+      "desc" : "Fires when the body element is scrolled",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "scrollLeft",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "scrollTop",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "rowdblclick",
+      "desc" : "Fires when a row is double clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "rowIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "cellclick",
+      "desc" : "Fires when a cell is clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "rowIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "columnIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "evententer",
+      "desc" : "Fires when mouse over an event",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Calendar",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "Event",
+          "type" : "event",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "mousedown",
+      "desc" : "The raw mousedown event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "click",
+      "desc" : "The raw click event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "contextmenu",
+      "desc" : "The raw contextmenu event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "eventleave",
+      "desc" : "Fires when the mouse leaves an",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Calendar",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "",
+          "type" : "event",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "dragover",
+      "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.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "dd",
+          "type" : "Roo.GridDD",
+          "desc" : "The drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "targetId",
+          "type" : "String",
+          "desc" : "The target drag drop object",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "event",
+          "desc" : "The raw browser event",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "rowcontextmenu",
+      "desc" : "Fires when a row is right clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "rowIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "celldblclick",
+      "desc" : "Fires when a cell is double clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "rowIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "columnIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "headercontextmenu",
+      "desc" : "Fires when a header is right clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "columnIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "rowclass",
+      "desc" : "Fires when a row is rendered, so you can change add a style to it.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "gridview",
+          "type" : "GridView",
+          "desc" : "The grid view",
+          "isOptional" : false
+        },
+        {
+          "name" : "rowcfg",
+          "type" : "Object",
+          "desc" : "contains record  rowIndex and rowClass - set rowClass to add a style.",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "mouseover",
+      "desc" : "The raw mouseover event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "keypress",
+      "desc" : "The raw keypress event for the entire grid.",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "render",
+      "desc" : "Fires when the grid is rendered",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "grid",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "columnresize",
+      "desc" : "Fires when the user resizes a column",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "columnIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "newSize",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "cellcontextmenu",
+      "desc" : "Fires when a cell is right clicked",
+      "memberOf" : "",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "this",
+          "type" : "Grid",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "rowIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "cellIndex",
+          "type" : "Number",
+          "desc" : "",
+          "isOptional" : false
+        },
+        {
+          "name" : "e",
+          "type" : "Roo.EventObject",
+          "desc" : "",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    }
+  ]
+}
\ No newline at end of file