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

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