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   "throws" : "",
  35   "requires" : "",
  36   "config" : [
  37     {
  38       "name" : "dropGroup",
  39       "type" : "String/Array",
  40       "desc" : "The ddgroup name(s) for the View's DropZone.",
  41       "memberOf" : ""
  42     },
  43     {
  44       "name" : "allowCopy",
  45       "type" : "Boolean",
  46       "desc" : "Causes ctrl/drag operations to copy nodes rather than move.",
  47       "memberOf" : ""
  48     },
  49     {
  50       "name" : "copy",
  51       "type" : "Boolean",
  52       "desc" : "Causes drag operations to copy nodes rather than move.",
  53       "memberOf" : ""
  54     },
  55     {
  56       "name" : "dragGroup",
  57       "type" : "String/Array",
  58       "desc" : "The ddgroup name(s) for the View's DragZone.",
  59       "memberOf" : ""
  60     }
  61   ],
  62   "methods" : [
  63     {
  64       "name" : "getDropPoint",
  65       "type" : "function",
  66       "desc" : "Decide whether to drop above or below a View node.",
  67       "sig" : "()\n{\n\n}",
  68       "static" : false,
  69       "memberOf" : "",
  70       "isStatic" : false,
  71       "isConstructor" : false,
  72       "isPrivate" : false,
  73       "example" : "",
  74       "deprecated" : "",
  75       "since" : "",
  76       "see" : "",
  77       "exceptions" : "",
  78       "requires" : "",
  79       "params" : [],
  80       "returns" : []
  81     },
  82     {
  83       "name" : "getValue",
  84       "type" : "function",
  85       "desc" : "",
  86       "sig" : "()\n{\n\n}",
  87       "static" : false,
  88       "memberOf" : "",
  89       "isStatic" : false,
  90       "isConstructor" : false,
  91       "isPrivate" : false,
  92       "example" : "",
  93       "deprecated" : "",
  94       "since" : "",
  95       "see" : "",
  96       "exceptions" : "",
  97       "requires" : "",
  98       "params" : [],
  99       "returns" : [
 100         {
 101           "name" : "",
 102           "type" : "String",
 103           "desc" : "a parenthesised list of the ids of the Records in the View."
 104         }
 105       ]
 106     },
 107     {
 108       "name" : "setDeletable",
 109       "type" : "function",
 110       "desc" : "Utility method. Add a delete option to the DDView's context menu.",
 111       "sig" : "(imageUrl)",
 112       "static" : false,
 113       "memberOf" : "",
 114       "isStatic" : false,
 115       "isConstructor" : false,
 116       "isPrivate" : false,
 117       "example" : "",
 118       "deprecated" : "",
 119       "since" : "",
 120       "see" : "",
 121       "exceptions" : "",
 122       "requires" : "",
 123       "params" : [
 124         {
 125           "name" : "imageUrl",
 126           "type" : "String",
 127           "desc" : "The URL of the \"delete\" icon image.",
 128           "isOptional" : false
 129         }
 130       ],
 131       "returns" : []
 132     },
 133     {
 134       "name" : "setValue",
 135       "type" : "function",
 136       "desc" : "Loads the View from a JSON string representing the Records to put into the Store.",
 137       "sig" : "()\n{\n\n}",
 138       "static" : false,
 139       "memberOf" : "",
 140       "isStatic" : false,
 141       "isConstructor" : false,
 142       "isPrivate" : false,
 143       "example" : "",
 144       "deprecated" : "",
 145       "since" : "",
 146       "see" : "",
 147       "exceptions" : "",
 148       "requires" : "",
 149       "params" : [],
 150       "returns" : []
 151     },
 152     {
 153       "name" : "getTargetFromEvent",
 154       "type" : "function",
 155       "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.",
 156       "sig" : "()\n{\n\n}",
 157       "static" : false,
 158       "memberOf" : "",
 159       "isStatic" : false,
 160       "isConstructor" : false,
 161       "isPrivate" : false,
 162       "example" : "",
 163       "deprecated" : "",
 164       "since" : "",
 165       "see" : "",
 166       "exceptions" : "",
 167       "requires" : "",
 168       "params" : [],
 169       "returns" : []
 170     },
 171     {
 172       "name" : "onDblClick",
 173       "type" : "function",
 174       "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.",
 175       "sig" : "()\n{\n\n}",
 176       "static" : false,
 177       "memberOf" : "",
 178       "isStatic" : false,
 179       "isConstructor" : false,
 180       "isPrivate" : false,
 181       "example" : "",
 182       "deprecated" : "",
 183       "since" : "",
 184       "see" : "",
 185       "exceptions" : "",
 186       "requires" : "",
 187       "params" : [],
 188       "returns" : []
 189     },
 190     {
 191       "name" : "getDragData",
 192       "type" : "function",
 193       "desc" : "Create the drag data which consists of an object which has the property \"ddel\" as\n\tthe drag proxy element.",
 194       "sig" : "()\n{\n\n}",
 195       "static" : false,
 196       "memberOf" : "",
 197       "isStatic" : false,
 198       "isConstructor" : false,
 199       "isPrivate" : false,
 200       "example" : "",
 201       "deprecated" : "",
 202       "since" : "",
 203       "see" : "",
 204       "exceptions" : "",
 205       "requires" : "",
 206       "params" : [],
 207       "returns" : []
 208     },
 209     {
 210       "name" : "setDraggable",
 211       "type" : "function",
 212       "desc" : "Specify to which ddGroup items in this DDView may be dragged.",
 213       "sig" : "()\n{\n\n}",
 214       "static" : false,
 215       "memberOf" : "",
 216       "isStatic" : false,
 217       "isConstructor" : false,
 218       "isPrivate" : false,
 219       "example" : "",
 220       "deprecated" : "",
 221       "since" : "",
 222       "see" : "",
 223       "exceptions" : "",
 224       "requires" : "",
 225       "params" : [],
 226       "returns" : []
 227     },
 228     {
 229       "name" : "getName",
 230       "type" : "function",
 231       "desc" : "Allows this class to be an Roo.form.Field so it can be found using {@link Roo.form.BasicForm#findField}.",
 232       "sig" : "()\n{\n\n}",
 233       "static" : false,
 234       "memberOf" : "",
 235       "isStatic" : false,
 236       "isConstructor" : false,
 237       "isPrivate" : false,
 238       "example" : "",
 239       "deprecated" : "",
 240       "since" : "",
 241       "see" : "",
 242       "exceptions" : "",
 243       "requires" : "",
 244       "params" : [],
 245       "returns" : []
 246     },
 247     {
 248       "name" : "remove",
 249       "type" : "function",
 250       "desc" : "Remove {@link Roo.data.Record}s at the specified indices.",
 251       "sig" : "(selectedIndices)",
 252       "static" : false,
 253       "memberOf" : "",
 254       "isStatic" : false,
 255       "isConstructor" : false,
 256       "isPrivate" : false,
 257       "example" : "",
 258       "deprecated" : "",
 259       "since" : "",
 260       "see" : "",
 261       "exceptions" : "",
 262       "requires" : "",
 263       "params" : [
 264         {
 265           "name" : "selectedIndices",
 266           "type" : "Array/Number",
 267           "desc" : "The index (or Array of indices) of Records to remove.",
 268           "isOptional" : false
 269         }
 270       ],
 271       "returns" : []
 272     },
 273     {
 274       "name" : "getContextMenu",
 275       "type" : "function",
 276       "desc" : "Return the context menu for this DDView.",
 277       "sig" : "()\n{\n\n}",
 278       "static" : false,
 279       "memberOf" : "",
 280       "isStatic" : false,
 281       "isConstructor" : false,
 282       "isPrivate" : false,
 283       "example" : "",
 284       "deprecated" : "",
 285       "since" : "",
 286       "see" : "",
 287       "exceptions" : "",
 288       "requires" : "",
 289       "params" : [],
 290       "returns" : []
 291     },
 292     {
 293       "name" : "setDroppable",
 294       "type" : "function",
 295       "desc" : "Specify from which ddGroup this DDView accepts drops.",
 296       "sig" : "()\n{\n\n}",
 297       "static" : false,
 298       "memberOf" : "",
 299       "isStatic" : false,
 300       "isConstructor" : false,
 301       "isPrivate" : false,
 302       "example" : "",
 303       "deprecated" : "",
 304       "since" : "",
 305       "see" : "",
 306       "exceptions" : "",
 307       "requires" : "",
 308       "params" : [],
 309       "returns" : []
 310     }
 311   ],
 312   "events" : []
 313 }