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

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