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