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