git.roojs.org Git - roojs1/blob - docs2/symbols/Roo.grid.CellSelectionModel.json

   1 {
   2   "name" : "Roo.grid.CellSelectionModel",
   3   "augments" : [
   4     "Roo.grid.AbstractSelectionModel",
   5     "Roo.util.Observable"
   6   ],
   7   "desc" : "This class provides the basic implementation for cell selection in a grid.",
   8   "isSingleton" : false,
   9   "isStatic" : true,
  10   "isBuiltin" : false,
  11   "config" : [
  12     {
  13       "name" : "listeners",
  14       "type" : "Object",
  15       "desc" : "list of events and functions to call for this object, \nFor example :\n<pre><code>\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  </code></pre>",
  16       "memberOf" : "Roo.util.Observable",
  17       "values" : [
  18       ]
  19     },
  20     {
  21       "name" : "enter_is_tab",
  22       "type" : "Boolean",
  23       "desc" : "Enter behaves the same as tab. (eg. goes to next cell) default: false",
  24       "memberOf" : "Roo.grid.CellSelectionModel",
  25       "values" : [
  26       ]
  27     }
  28   ],
  29   "methods" : [
  30     {
  31       "name" : "hasSelection",
  32       "desc" : "Returns true if there is a selection.",
  33       "isStatic" : false,
  34       "isConstructor" : false,
  35       "isPrivate" : false,
  36       "memberOf" : "Roo.grid.CellSelectionModel",
  37       "example" : "",
  38       "deprecated" : "",
  39       "since" : "",
  40       "see" : "",
  41       "params" : [
  42       ],
  43       "returns" : [
  44         {
  45           "name" : "",
  46           "type" : "Boolean",
  47           "desc" : ""
  48         }
  49       ]
  50     },
  51     {
  52       "name" : "onEditorKey",
  53       "desc" : "Selects a cell.",
  54       "isStatic" : false,
  55       "isConstructor" : false,
  56       "isPrivate" : false,
  57       "memberOf" : "Roo.grid.CellSelectionModel",
  58       "example" : "",
  59       "deprecated" : "",
  60       "since" : "",
  61       "see" : "",
  62       "params" : [
  63         {
  64           "name" : "field",
  65           "type" : "Number",
  66           "desc" : "(not used) - as it's normally used as a listener",
  67           "isOptional" : false
  68         },
  69         {
  70           "name" : "e",
  71           "type" : "Number",
  72           "desc" : "- event - fake it by using\n\nvar e = Roo.EventObjectImpl.prototype;\ne.keyCode = e.TAB",
  73           "isOptional" : false
  74         }
  75       ],
  76       "returns" : [
  77       ]
  78     },
  79     {
  80       "name" : "select",
  81       "desc" : "Selects a cell.",
  82       "isStatic" : false,
  83       "isConstructor" : false,
  84       "isPrivate" : false,
  85       "memberOf" : "Roo.grid.CellSelectionModel",
  86       "example" : "",
  87       "deprecated" : "",
  88       "since" : "",
  89       "see" : "",
  90       "params" : [
  91         {
  92           "name" : "rowIndex",
  93           "type" : "Number",
  94           "desc" : "",
  95           "isOptional" : false
  96         },
  97         {
  98           "name" : "collIndex",
  99           "type" : "Number",
 100           "desc" : "",
 101           "isOptional" : false
 102         }
 103       ],
 104       "returns" : [
 105       ]
 106     },
 107     {
 108       "name" : "getSelectedCell",
 109       "desc" : "Returns the currently selected cell,.",
 110       "isStatic" : false,
 111       "isConstructor" : false,
 112       "isPrivate" : false,
 113       "memberOf" : "Roo.grid.CellSelectionModel",
 114       "example" : "",
 115       "deprecated" : "",
 116       "since" : "",
 117       "see" : "",
 118       "params" : [
 119       ],
 120       "returns" : [
 121         {
 122           "name" : "",
 123           "type" : "Array",
 124           "desc" : "The selected cell (row, column) or null if none selected."
 125         }
 126       ]
 127     },
 128     {
 129       "name" : "clearSelections",
 130       "desc" : "Clears all selections.",
 131       "isStatic" : false,
 132       "isConstructor" : false,
 133       "isPrivate" : false,
 134       "memberOf" : "Roo.grid.CellSelectionModel",
 135       "example" : "",
 136       "deprecated" : "",
 137       "since" : "",
 138       "see" : "",
 139       "params" : [
 140         {
 141           "name" : "true",
 142           "type" : "Boolean",
 143           "desc" : "to prevent the gridview from being notified about the change.",
 144           "isOptional" : false
 145         }
 146       ],
 147       "returns" : [
 148       ]
 149     },
 150     {
 151       "name" : "lock",
 152       "desc" : "Locks the selections.",
 153       "isStatic" : false,
 154       "isConstructor" : false,
 155       "isPrivate" : false,
 156       "memberOf" : "Roo.grid.AbstractSelectionModel",
 157       "example" : "",
 158       "deprecated" : "",
 159       "since" : "",
 160       "see" : "",
 161       "params" : [
 162       ],
 163       "returns" : [
 164       ]
 165     },
 166     {
 167       "name" : "isLocked",
 168       "desc" : "Returns true if the selections are locked.",
 169       "isStatic" : false,
 170       "isConstructor" : false,
 171       "isPrivate" : false,
 172       "memberOf" : "Roo.grid.AbstractSelectionModel",
 173       "example" : "",
 174       "deprecated" : "",
 175       "since" : "",
 176       "see" : "",
 177       "params" : [
 178       ],
 179       "returns" : [
 180         {
 181           "name" : "",
 182           "type" : "Boolean",
 183           "desc" : ""
 184         }
 185       ]
 186     },
 187     {
 188       "name" : "unlock",
 189       "desc" : "Unlocks the selections.",
 190       "isStatic" : false,
 191       "isConstructor" : false,
 192       "isPrivate" : false,
 193       "memberOf" : "Roo.grid.AbstractSelectionModel",
 194       "example" : "",
 195       "deprecated" : "",
 196       "since" : "",
 197       "see" : "",
 198       "params" : [
 199       ],
 200       "returns" : [
 201       ]
 202     },
 203     {
 204       "name" : "purgeListeners",
 205       "desc" : "Removes all listeners for this object",
 206       "isStatic" : false,
 207       "isConstructor" : false,
 208       "isPrivate" : false,
 209       "memberOf" : "Roo.util.Observable",
 210       "example" : "",
 211       "deprecated" : "",
 212       "since" : "",
 213       "see" : "",
 214       "params" : [
 215       ],
 216       "returns" : [
 217       ]
 218     },
 219     {
 220       "name" : "on",
 221       "desc" : "Appends an event handler to this element (shorthand for addListener)",
 222       "isStatic" : false,
 223       "isConstructor" : false,
 224       "isPrivate" : false,
 225       "memberOf" : "Roo.util.Observable",
 226       "example" : "",
 227       "deprecated" : "",
 228       "since" : "",
 229       "see" : "",
 230       "params" : [
 231         {
 232           "name" : "eventName",
 233           "type" : "String",
 234           "desc" : "The type of event to listen for",
 235           "isOptional" : false
 236         },
 237         {
 238           "name" : "handler",
 239           "type" : "Function",
 240           "desc" : "The method the event invokes",
 241           "isOptional" : false
 242         },
 243         {
 244           "name" : "scope",
 245           "type" : "Object",
 246           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 247           "isOptional" : false
 248         },
 249         {
 250           "name" : "options",
 251           "type" : "Object",
 252           "desc" : "(optional)",
 253           "isOptional" : false
 254         }
 255       ],
 256       "returns" : [
 257       ]
 258     },
 259     {
 260       "name" : "un",
 261       "desc" : "Removes a listener (shorthand for removeListener)",
 262       "isStatic" : false,
 263       "isConstructor" : false,
 264       "isPrivate" : false,
 265       "memberOf" : "Roo.util.Observable",
 266       "example" : "",
 267       "deprecated" : "",
 268       "since" : "",
 269       "see" : "",
 270       "params" : [
 271         {
 272           "name" : "eventName",
 273           "type" : "String",
 274           "desc" : "The type of event to listen for",
 275           "isOptional" : false
 276         },
 277         {
 278           "name" : "handler",
 279           "type" : "Function",
 280           "desc" : "The handler to remove",
 281           "isOptional" : false
 282         },
 283         {
 284           "name" : "scope",
 285           "type" : "Object",
 286           "desc" : "(optional) The scope (this object) for the handler",
 287           "isOptional" : false
 288         }
 289       ],
 290       "returns" : [
 291       ]
 292     },
 293     {
 294       "name" : "addEvents",
 295       "desc" : "Used to define events on this Observable",
 296       "isStatic" : false,
 297       "isConstructor" : false,
 298       "isPrivate" : false,
 299       "memberOf" : "Roo.util.Observable",
 300       "example" : "",
 301       "deprecated" : "",
 302       "since" : "",
 303       "see" : "",
 304       "params" : [
 305         {
 306           "name" : "object",
 307           "type" : "Object",
 308           "desc" : "The object with the events defined",
 309           "isOptional" : false
 310         }
 311       ],
 312       "returns" : [
 313       ]
 314     },
 315     {
 316       "name" : "releaseCapture",
 317       "desc" : "Removes <b>all</b> added captures from the Observable.",
 318       "isStatic" : true,
 319       "isConstructor" : false,
 320       "isPrivate" : false,
 321       "memberOf" : "Roo.util.Observable",
 322       "example" : "",
 323       "deprecated" : "",
 324       "since" : "",
 325       "see" : "",
 326       "params" : [
 327         {
 328           "name" : "o",
 329           "type" : "Observable",
 330           "desc" : "The Observable to release",
 331           "isOptional" : false
 332         }
 333       ],
 334       "returns" : [
 335       ]
 336     },
 337     {
 338       "name" : "removeListener",
 339       "desc" : "Removes a listener",
 340       "isStatic" : false,
 341       "isConstructor" : false,
 342       "isPrivate" : false,
 343       "memberOf" : "Roo.util.Observable",
 344       "example" : "",
 345       "deprecated" : "",
 346       "since" : "",
 347       "see" : "",
 348       "params" : [
 349         {
 350           "name" : "eventName",
 351           "type" : "String",
 352           "desc" : "The type of event to listen for",
 353           "isOptional" : false
 354         },
 355         {
 356           "name" : "handler",
 357           "type" : "Function",
 358           "desc" : "The handler to remove",
 359           "isOptional" : false
 360         },
 361         {
 362           "name" : "scope",
 363           "type" : "Object",
 364           "desc" : "(optional) The scope (this object) for the handler",
 365           "isOptional" : false
 366         }
 367       ],
 368       "returns" : [
 369       ]
 370     },
 371     {
 372       "name" : "fireEvent",
 373       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
 374       "isStatic" : false,
 375       "isConstructor" : false,
 376       "isPrivate" : false,
 377       "memberOf" : "Roo.util.Observable",
 378       "example" : "",
 379       "deprecated" : "",
 380       "since" : "",
 381       "see" : "",
 382       "params" : [
 383         {
 384           "name" : "eventName",
 385           "type" : "String",
 386           "desc" : "",
 387           "isOptional" : false
 388         },
 389         {
 390           "name" : "args",
 391           "type" : "Object...",
 392           "desc" : "Variable number of parameters are passed to handlers",
 393           "isOptional" : false
 394         }
 395       ],
 396       "returns" : [
 397         {
 398           "name" : "",
 399           "type" : "Boolean",
 400           "desc" : "returns false if any of the handlers return false otherwise it returns true"
 401         }
 402       ]
 403     },
 404     {
 405       "name" : "hasListener",
 406       "desc" : "Checks to see if this object has any listeners for a specified event",
 407       "isStatic" : false,
 408       "isConstructor" : false,
 409       "isPrivate" : false,
 410       "memberOf" : "Roo.util.Observable",
 411       "example" : "",
 412       "deprecated" : "",
 413       "since" : "",
 414       "see" : "",
 415       "params" : [
 416         {
 417           "name" : "eventName",
 418           "type" : "String",
 419           "desc" : "The name of the event to check for",
 420           "isOptional" : false
 421         }
 422       ],
 423       "returns" : [
 424         {
 425           "name" : "",
 426           "type" : "Boolean",
 427           "desc" : "True if the event is being listened for, else false"
 428         }
 429       ]
 430     },
 431     {
 432       "name" : "capture",
 433       "desc" : "Starts capture on the specified Observable. All events will be passed\nto the supplied function with the event name + standard signature of the event\n<b>before</b> the event is fired. If the supplied function returns false,\nthe event will not fire.",
 434       "isStatic" : true,
 435       "isConstructor" : false,
 436       "isPrivate" : false,
 437       "memberOf" : "Roo.util.Observable",
 438       "example" : "",
 439       "deprecated" : "",
 440       "since" : "",
 441       "see" : "",
 442       "params" : [
 443         {
 444           "name" : "o",
 445           "type" : "Observable",
 446           "desc" : "The Observable to capture",
 447           "isOptional" : false
 448         },
 449         {
 450           "name" : "fn",
 451           "type" : "Function",
 452           "desc" : "The function to call",
 453           "isOptional" : false
 454         },
 455         {
 456           "name" : "scope",
 457           "type" : "Object",
 458           "desc" : "(optional) The scope (this object) for the fn",
 459           "isOptional" : false
 460         }
 461       ],
 462       "returns" : [
 463       ]
 464     },
 465     {
 466       "name" : "addListener",
 467       "desc" : "Appends an event handler to this component",
 468       "isStatic" : false,
 469       "isConstructor" : false,
 470       "isPrivate" : false,
 471       "memberOf" : "Roo.util.Observable",
 472       "example" : "",
 473       "deprecated" : "",
 474       "since" : "",
 475       "see" : "",
 476       "params" : [
 477         {
 478           "name" : "eventName",
 479           "type" : "String",
 480           "desc" : "The type of event to listen for",
 481           "isOptional" : false
 482         },
 483         {
 484           "name" : "handler",
 485           "type" : "Function",
 486           "desc" : "The method the event invokes",
 487           "isOptional" : false
 488         },
 489         {
 490           "name" : "scope",
 491           "type" : "Object",
 492           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
 493           "isOptional" : false
 494         },
 495         {
 496           "name" : "options",
 497           "type" : "Object",
 498           "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:<ul>\n<li>scope {Object} The scope in which to execute the handler function. The handler function's \"this\" context.</li>\n<li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li>\n<li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li>\n<li>buffer {Number} Causes the handler to be scheduled to run in an {@link Roo.util.DelayedTask} delayed\nby the specified number of milliseconds. If the event fires again within that time, the original\nhandler is <em>not</em> invoked, but the new handler is scheduled in its place.</li>\n</ul><br>\n<p>\n<b>Combining Options</b><br>\nUsing the options argument, it is possible to combine different types of listeners:<br>\n<br>\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t<pre><code>\n\t\tel.on('click', this.onClick, this, {\n \t\t\tsingle: true,\n    \t\tdelay: 100,\n    \t\tforumId: 4\n\t\t});\n\t\t</code></pre>\n<p>\n<b>Attaching multiple handlers in 1 call</b><br>\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n<pre><code>\n\t\tel.on({\n\t\t\t'click': {\n        \t\tfn: this.onClick,\n        \t\tscope: this,\n        \t\tdelay: 100\n    \t\t}, \n    \t\t'mouseover': {\n        \t\tfn: this.onMouseOver,\n        \t\tscope: this\n    \t\t},\n    \t\t'mouseout': {\n        \t\tfn: this.onMouseOut,\n        \t\tscope: this\n    \t\t}\n\t\t});\n\t\t</code></pre>\n<p>\nOr a shorthand syntax which passes the same scope object to all handlers:\n     \t<pre><code>\n\t\tel.on({\n\t\t\t'click': this.onClick,\n    \t\t'mouseover': this.onMouseOver,\n    \t\t'mouseout': this.onMouseOut,\n    \t\tscope: this\n\t\t});\n\t\t</code></pre>",
 499           "isOptional" : false
 500         }
 501       ],
 502       "returns" : [
 503       ]
 504     }
 505   ],
 506   "events" : [
 507     {
 508       "name" : "beforeeditnext",
 509       "desc" : "Fires before the next editable sell is made active\nYou can use this to skip to another cell or fire the tabend\n   if you set cell to false",
 510       "memberOf" : "",
 511       "example" : "",
 512       "deprecated" : "",
 513       "since" : "",
 514       "see" : "",
 515       "params" : [
 516         {
 517           "name" : "eventdata",
 518           "type" : "Object",
 519           "desc" : "object : { cell : [ row, col ] }",
 520           "isOptional" : false
 521         }
 522       ],
 523       "returns" : [
 524       ]
 525     },
 526     {
 527       "name" : "cellselect",
 528       "desc" : "Fires when a cell is selected.",
 529       "memberOf" : "",
 530       "example" : "",
 531       "deprecated" : "",
 532       "since" : "",
 533       "see" : "",
 534       "params" : [
 535         {
 536           "name" : "this",
 537           "type" : "SelectionModel",
 538           "desc" : "",
 539           "isOptional" : false
 540         },
 541         {
 542           "name" : "rowIndex",
 543           "type" : "Number",
 544           "desc" : "The selected row index",
 545           "isOptional" : false
 546         },
 547         {
 548           "name" : "colIndex",
 549           "type" : "Number",
 550           "desc" : "The selected cell index",
 551           "isOptional" : false
 552         }
 553       ],
 554       "returns" : [
 555       ]
 556     },
 557     {
 558       "name" : "tabend",
 559       "desc" : "Fires when the tab (or enter) was pressed on the last editable cell\nYou can use this to trigger add new row.",
 560       "memberOf" : "",
 561       "example" : "",
 562       "deprecated" : "",
 563       "since" : "",
 564       "see" : "",
 565       "params" : [
 566         {
 567           "name" : "this",
 568           "type" : "SelectionModel",
 569           "desc" : "",
 570           "isOptional" : false
 571         }
 572       ],
 573       "returns" : [
 574       ]
 575     },
 576     {
 577       "name" : "selectionchange",
 578       "desc" : "Fires when the active selection changes.",
 579       "memberOf" : "",
 580       "example" : "",
 581       "deprecated" : "",
 582       "since" : "",
 583       "see" : "",
 584       "params" : [
 585         {
 586           "name" : "this",
 587           "type" : "SelectionModel",
 588           "desc" : "",
 589           "isOptional" : false
 590         },
 591         {
 592           "name" : "selection",
 593           "type" : "Object",
 594           "desc" : "null for no selection or an object (o) with two properties\n\t        <ul>\n\t        <li>o.record: the record object for the row the selection is in</li>\n\t        <li>o.cell: An array of [rowIndex, columnIndex]</li>\n\t        </ul>",
 595           "isOptional" : false
 596         }
 597       ],
 598       "returns" : [
 599       ]
 600     },
 601     {
 602       "name" : "beforerowselect",
 603       "desc" : "Fires before a cell is selected.",
 604       "memberOf" : "",
 605       "example" : "",
 606       "deprecated" : "",
 607       "since" : "",
 608       "see" : "",
 609       "params" : [
 610         {
 611           "name" : "this",
 612           "type" : "SelectionModel",
 613           "desc" : "",
 614           "isOptional" : false
 615         },
 616         {
 617           "name" : "rowIndex",
 618           "type" : "Number",
 619           "desc" : "The selected row index",
 620           "isOptional" : false
 621         },
 622         {
 623           "name" : "colIndex",
 624           "type" : "Number",
 625           "desc" : "The selected cell index",
 626           "isOptional" : false
 627         }
 628       ],
 629       "returns" : [
 630       ]
 631     }
 632   ]
 633 }