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

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