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