Fix #5654 - roojspacker - get it working as a doc tool...
[roojs1] / docs / symbols / Roo.DDView.json
diff --git a/docs/symbols/Roo.DDView.json b/docs/symbols/Roo.DDView.json
new file mode 100644 (file)
index 0000000..96dec01
--- /dev/null
@@ -0,0 +1,283 @@
+{
+  "name" : "Roo.DDView",
+  "augments" : [
+  ],
+  "desc" : "A DnD enabled version of Roo.View.",
+  "isSingleton" : false,
+  "isStatic" : false,
+  "isBuiltin" : false,
+  "memberOf" : "DDView",
+  "example" : "",
+  "deprecated" : "",
+  "since" : "",
+  "see" : "",
+  "params" : [
+    {
+      "name" : "container",
+      "type" : "Element/String",
+      "desc" : "The Element in which to create the View.",
+      "isOptional" : false
+    },
+    {
+      "name" : "tpl",
+      "type" : "String",
+      "desc" : "The template string used to create the markup for each element of the View",
+      "isOptional" : false
+    },
+    {
+      "name" : "config",
+      "type" : "Object",
+      "desc" : "The configuration properties. These include all the config options of\n{@link Roo.View} plus some specific to this class.<br>\n<p>\nDrag/drop is implemented by adding {@link Roo.data.Record}s to the target DDView. If copying is\nnot being performed, the original {@link Roo.data.Record} is removed from the source DDView.<br>\n<p>\nThe following extra CSS rules are needed to provide insertion point highlighting:<pre><code>\n.x-view-drag-insert-above {\n\tborder-top:1px dotted #3366cc;\n}\n.x-view-drag-insert-below {\n\tborder-bottom:1px dotted #3366cc;\n}\n</code></pre>",
+      "isOptional" : false
+    }
+  ],
+  "returns" : [
+  ],
+  "config" : [
+    {
+      "name" : "dropGroup",
+      "type" : "String/Array",
+      "desc" : "The ddgroup name(s) for the View's DropZone.",
+      "memberOf" : "Roo.DDView",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "allowCopy",
+      "type" : "Boolean",
+      "desc" : "Causes ctrl/drag operations to copy nodes rather than move.",
+      "memberOf" : "Roo.DDView",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "copy",
+      "type" : "Boolean",
+      "desc" : "Causes drag operations to copy nodes rather than move.",
+      "memberOf" : "Roo.DDView",
+      "values" : [
+      ]
+    },
+    {
+      "name" : "dragGroup",
+      "type" : "String/Array",
+      "desc" : "The ddgroup name(s) for the View's DragZone.",
+      "memberOf" : "Roo.DDView",
+      "values" : [
+      ]
+    }
+  ],
+  "methods" : [
+    {
+      "name" : "getDropPoint",
+      "desc" : "Decide whether to drop above or below a View node.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.DDView",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "getValue",
+      "desc" : "",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.DDView",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+        {
+          "name" : "",
+          "type" : "String",
+          "desc" : "a parenthesised list of the ids of the Records in the View."
+        }
+      ]
+    },
+    {
+      "name" : "setDeletable",
+      "desc" : "Utility method. Add a delete option to the DDView's context menu.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.DDView",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "imageUrl",
+          "type" : "String",
+          "desc" : "The URL of the \"delete\" icon image.",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "setValue",
+      "desc" : "Loads the View from a JSON string representing the Records to put into the Store.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.DDView",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "getTargetFromEvent",
+      "desc" : "Part of the Roo.dd.DropZone interface. If no target node is found, the\n\twhole Element becomes the target, and this causes the drop gesture to append.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.DDView",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "onDblClick",
+      "desc" : "Double click fires the event, but also, if this is draggable, and there is only one other\n\trelated DropZone, it transfers the selected node.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.DDView",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "getDragData",
+      "desc" : "Create the drag data which consists of an object which has the property \"ddel\" as\n\tthe drag proxy element.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.DDView",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "setDraggable",
+      "desc" : "Specify to which ddGroup items in this DDView may be dragged.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.DDView",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "getName",
+      "desc" : "Allows this class to be an Roo.form.Field so it can be found using {@link Roo.form.BasicForm#findField}.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.DDView",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "remove",
+      "desc" : "Remove {@link Roo.data.Record}s at the specified indices.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.DDView",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+        {
+          "name" : "selectedIndices",
+          "type" : "Array/Number",
+          "desc" : "The index (or Array of indices) of Records to remove.",
+          "isOptional" : false
+        }
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "getContextMenu",
+      "desc" : "Return the context menu for this DDView.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.DDView",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+      ]
+    },
+    {
+      "name" : "setDroppable",
+      "desc" : "Specify from which ddGroup this DDView accepts drops.",
+      "isStatic" : false,
+      "isConstructor" : false,
+      "isPrivate" : false,
+      "memberOf" : "Roo.DDView",
+      "example" : "",
+      "deprecated" : "",
+      "since" : "",
+      "see" : "",
+      "params" : [
+      ],
+      "returns" : [
+      ]
+    }
+  ],
+  "events" : [
+  ]
+}
\ No newline at end of file