git.roojs.org Git - roojs1/blob - docs/symbols/Roo.DDView.json

   1 {
   2   "name" : "Roo.DDView",
   3   "augments" : [],
   4   "desc" : "A DnD enabled version of Roo.View.",
   5   "isSingleton" : false,
   6   "isStatic" : false,
   7   "isBuiltin" : false,
   8   "memberOf" : "DDView",
   9   "example" : "",
  10   "deprecated" : "",
  11   "since" : "",
  12   "see" : "",
  13   "params" : [
  14     {
  15       "name" : "container",
  16       "type" : "Element/String",
  17       "desc" : "The Element in which to create the View.",
  18       "isOptional" : false
  19     },
  20     {
  21       "name" : "tpl",
  22       "type" : "String",
  23       "desc" : "The template string used to create the markup for each element of the View",
  24       "isOptional" : false
  25     },
  26     {
  27       "name" : "config",
  28       "type" : "Object",
  29       "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>",
  30       "isOptional" : false
  31     }
  32   ],
  33   "returns" : [],
  34   "config" : [
  35     {
  36       "name" : "dropGroup",
  37       "type" : "String/Array",
  38       "desc" : "The ddgroup name(s) for the View's DropZone.",
  39       "memberOf" : "Roo.DDView",
  40       "optvals" : []
  41     },
  42     {
  43       "name" : "allowCopy",
  44       "type" : "Boolean",
  45       "desc" : "Causes ctrl/drag operations to copy nodes rather than move.",
  46       "memberOf" : "Roo.DDView",
  47       "optvals" : []
  48     },
  49     {
  50       "name" : "copy",
  51       "type" : "Boolean",
  52       "desc" : "Causes drag operations to copy nodes rather than move.",
  53       "memberOf" : "Roo.DDView",
  54       "optvals" : []
  55     },
  56     {
  57       "name" : "dragGroup",
  58       "type" : "String/Array",
  59       "desc" : "The ddgroup name(s) for the View's DragZone.",
  60       "memberOf" : "Roo.DDView",
  61       "optvals" : []
  62     }
  63   ],
  64   "methods" : [
  65     {
  66       "name" : "getDropPoint",
  67       "desc" : "Decide whether to drop above or below a View node.",
  68       "isStatic" : false,
  69       "isConstructor" : false,
  70       "isPrivate" : false,
  71       "memberOf" : "Roo.DDView",
  72       "example" : "",
  73       "deprecated" : "",
  74       "since" : "",
  75       "see" : "",
  76       "params" : [],
  77       "returns" : []
  78     },
  79     {
  80       "name" : "getValue",
  81       "desc" : "",
  82       "isStatic" : false,
  83       "isConstructor" : false,
  84       "isPrivate" : false,
  85       "memberOf" : "Roo.DDView",
  86       "example" : "",
  87       "deprecated" : "",
  88       "since" : "",
  89       "see" : "",
  90       "params" : [],
  91       "returns" : [
  92         {
  93           "name" : "",
  94           "type" : "String",
  95           "desc" : "a parenthesised list of the ids of the Records in the View."
  96         }
  97       ]
  98     },
  99     {
 100       "name" : "setDeletable",
 101       "desc" : "Utility method. Add a delete option to the DDView's context menu.",
 102       "isStatic" : false,
 103       "isConstructor" : false,
 104       "isPrivate" : false,
 105       "memberOf" : "Roo.DDView",
 106       "example" : "",
 107       "deprecated" : "",
 108       "since" : "",
 109       "see" : "",
 110       "params" : [
 111         {
 112           "name" : "imageUrl",
 113           "type" : "String",
 114           "desc" : "The URL of the \"delete\" icon image.",
 115           "isOptional" : false
 116         }
 117       ],
 118       "returns" : []
 119     },
 120     {
 121       "name" : "setValue",
 122       "desc" : "Loads the View from a JSON string representing the Records to put into the Store.",
 123       "isStatic" : false,
 124       "isConstructor" : false,
 125       "isPrivate" : false,
 126       "memberOf" : "Roo.DDView",
 127       "example" : "",
 128       "deprecated" : "",
 129       "since" : "",
 130       "see" : "",
 131       "params" : [],
 132       "returns" : []
 133     },
 134     {
 135       "name" : "getTargetFromEvent",
 136       "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.",
 137       "isStatic" : false,
 138       "isConstructor" : false,
 139       "isPrivate" : false,
 140       "memberOf" : "Roo.DDView",
 141       "example" : "",
 142       "deprecated" : "",
 143       "since" : "",
 144       "see" : "",
 145       "params" : [],
 146       "returns" : []
 147     },
 148     {
 149       "name" : "onDblClick",
 150       "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.",
 151       "isStatic" : false,
 152       "isConstructor" : false,
 153       "isPrivate" : false,
 154       "memberOf" : "Roo.DDView",
 155       "example" : "",
 156       "deprecated" : "",
 157       "since" : "",
 158       "see" : "",
 159       "params" : [],
 160       "returns" : []
 161     },
 162     {
 163       "name" : "getDragData",
 164       "desc" : "Create the drag data which consists of an object which has the property \"ddel\" as\n\tthe drag proxy element.",
 165       "isStatic" : false,
 166       "isConstructor" : false,
 167       "isPrivate" : false,
 168       "memberOf" : "Roo.DDView",
 169       "example" : "",
 170       "deprecated" : "",
 171       "since" : "",
 172       "see" : "",
 173       "params" : [],
 174       "returns" : []
 175     },
 176     {
 177       "name" : "setDraggable",
 178       "desc" : "Specify to which ddGroup items in this DDView may be dragged.",
 179       "isStatic" : false,
 180       "isConstructor" : false,
 181       "isPrivate" : false,
 182       "memberOf" : "Roo.DDView",
 183       "example" : "",
 184       "deprecated" : "",
 185       "since" : "",
 186       "see" : "",
 187       "params" : [],
 188       "returns" : []
 189     },
 190     {
 191       "name" : "getName",
 192       "desc" : "Allows this class to be an Roo.form.Field so it can be found using {@link Roo.form.BasicForm#findField}.",
 193       "isStatic" : false,
 194       "isConstructor" : false,
 195       "isPrivate" : false,
 196       "memberOf" : "Roo.DDView",
 197       "example" : "",
 198       "deprecated" : "",
 199       "since" : "",
 200       "see" : "",
 201       "params" : [],
 202       "returns" : []
 203     },
 204     {
 205       "name" : "remove",
 206       "desc" : "Remove {@link Roo.data.Record}s at the specified indices.",
 207       "isStatic" : false,
 208       "isConstructor" : false,
 209       "isPrivate" : false,
 210       "memberOf" : "Roo.DDView",
 211       "example" : "",
 212       "deprecated" : "",
 213       "since" : "",
 214       "see" : "",
 215       "params" : [
 216         {
 217           "name" : "selectedIndices",
 218           "type" : "Array/Number",
 219           "desc" : "The index (or Array of indices) of Records to remove.",
 220           "isOptional" : false
 221         }
 222       ],
 223       "returns" : []
 224     },
 225     {
 226       "name" : "getContextMenu",
 227       "desc" : "Return the context menu for this DDView.",
 228       "isStatic" : false,
 229       "isConstructor" : false,
 230       "isPrivate" : false,
 231       "memberOf" : "Roo.DDView",
 232       "example" : "",
 233       "deprecated" : "",
 234       "since" : "",
 235       "see" : "",
 236       "params" : [],
 237       "returns" : []
 238     },
 239     {
 240       "name" : "setDroppable",
 241       "desc" : "Specify from which ddGroup this DDView accepts drops.",
 242       "isStatic" : false,
 243       "isConstructor" : false,
 244       "isPrivate" : false,
 245       "memberOf" : "Roo.DDView",
 246       "example" : "",
 247       "deprecated" : "",
 248       "since" : "",
 249       "see" : "",
 250       "params" : [],
 251       "returns" : []
 252     }
 253   ],
 254   "events" : []
 255 }