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