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