git.roojs.org Git - roojs1/blob - docs/symbols/Roo.bootstrap.Table.RowSelectionModel.json

   1 {
   2   "name" : "Roo.bootstrap.Table.RowSelectionModel",
   3   "augments" : [
   4     "Roo.bootstrap.Table.AbstractSelectionModel"
   5   ],
   6   "desc" : "The default SelectionModel used by {@link Roo.bootstrap.Table}.\nIt supports multiple selections and keyboard selection/navigation.",
   7   "isSingleton" : false,
   8   "isStatic" : false,
   9   "isBuiltin" : false,
  10   "memberOf" : "RowSelectionModel",
  11   "example" : "",
  12   "deprecated" : "",
  13   "since" : "",
  14   "see" : "",
  15   "params" : [
  16     {
  17       "name" : "config",
  18       "type" : "Object",
  19       "desc" : "",
  20       "isOptional" : false
  21     }
  22   ],
  23   "returns" : [],
  24   "config" : [
  25     {
  26       "name" : "singleSelect",
  27       "type" : "Boolean",
  28       "desc" : "True to allow selection of only one row at a time (defaults to false)",
  29       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
  30       "values" : []
  31     }
  32   ],
  33   "methods" : [
  34     {
  35       "name" : "getCount",
  36       "desc" : "Gets the number of selected rows.",
  37       "isStatic" : false,
  38       "isConstructor" : false,
  39       "isPrivate" : false,
  40       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
  41       "example" : "",
  42       "deprecated" : "",
  43       "since" : "",
  44       "see" : "",
  45       "params" : [],
  46       "returns" : [
  47         {
  48           "name" : "",
  49           "type" : "Number",
  50           "desc" : ""
  51         }
  52       ]
  53     },
  54     {
  55       "name" : "getSelections",
  56       "desc" : "Returns the selected records",
  57       "isStatic" : false,
  58       "isConstructor" : false,
  59       "isPrivate" : false,
  60       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
  61       "example" : "",
  62       "deprecated" : "",
  63       "since" : "",
  64       "see" : "",
  65       "params" : [],
  66       "returns" : [
  67         {
  68           "name" : "",
  69           "type" : "Array",
  70           "desc" : "Array of selected records"
  71         }
  72       ]
  73     },
  74     {
  75       "name" : "selectRange",
  76       "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.",
  77       "isStatic" : false,
  78       "isConstructor" : false,
  79       "isPrivate" : false,
  80       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
  81       "example" : "",
  82       "deprecated" : "",
  83       "since" : "",
  84       "see" : "",
  85       "params" : [
  86         {
  87           "name" : "startRow",
  88           "type" : "Number",
  89           "desc" : "The index of the first row in the range",
  90           "isOptional" : false
  91         },
  92         {
  93           "name" : "endRow",
  94           "type" : "Number",
  95           "desc" : "The index of the last row in the range",
  96           "isOptional" : false
  97         },
  98         {
  99           "name" : "keepExisting",
 100           "type" : "Boolean",
 101           "desc" : "(optional) True to retain existing selections",
 102           "isOptional" : false
 103         }
 104       ],
 105       "returns" : []
 106     },
 107     {
 108       "name" : "selectFirstRow",
 109       "desc" : "Selects the first row in the grid.",
 110       "isStatic" : false,
 111       "isConstructor" : false,
 112       "isPrivate" : false,
 113       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 114       "example" : "",
 115       "deprecated" : "",
 116       "since" : "",
 117       "see" : "",
 118       "params" : [],
 119       "returns" : []
 120     },
 121     {
 122       "name" : "selectLastRow",
 123       "desc" : "Select the last row.",
 124       "isStatic" : false,
 125       "isConstructor" : false,
 126       "isPrivate" : false,
 127       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 128       "example" : "",
 129       "deprecated" : "",
 130       "since" : "",
 131       "see" : "",
 132       "params" : [
 133         {
 134           "name" : "keepExisting",
 135           "type" : "Boolean",
 136           "desc" : "(optional) True to keep existing selections",
 137           "isOptional" : false
 138         }
 139       ],
 140       "returns" : []
 141     },
 142     {
 143       "name" : "deselectRow",
 144       "desc" : "Deselects a row.",
 145       "isStatic" : false,
 146       "isConstructor" : false,
 147       "isPrivate" : false,
 148       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 149       "example" : "",
 150       "deprecated" : "",
 151       "since" : "",
 152       "see" : "",
 153       "params" : [
 154         {
 155           "name" : "row",
 156           "type" : "Number",
 157           "desc" : "The index of the row to deselect",
 158           "isOptional" : false
 159         }
 160       ],
 161       "returns" : []
 162     },
 163     {
 164       "name" : "selectNext",
 165       "desc" : "Selects the row immediately following the last selected row.",
 166       "isStatic" : false,
 167       "isConstructor" : false,
 168       "isPrivate" : false,
 169       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 170       "example" : "",
 171       "deprecated" : "",
 172       "since" : "",
 173       "see" : "",
 174       "params" : [
 175         {
 176           "name" : "keepExisting",
 177           "type" : "Boolean",
 178           "desc" : "(optional) True to keep existing selections",
 179           "isOptional" : false
 180         }
 181       ],
 182       "returns" : []
 183     },
 184     {
 185       "name" : "selectPrevious",
 186       "desc" : "Selects the row that precedes the last selected row.",
 187       "isStatic" : false,
 188       "isConstructor" : false,
 189       "isPrivate" : false,
 190       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 191       "example" : "",
 192       "deprecated" : "",
 193       "since" : "",
 194       "see" : "",
 195       "params" : [
 196         {
 197           "name" : "keepExisting",
 198           "type" : "Boolean",
 199           "desc" : "(optional) True to keep existing selections",
 200           "isOptional" : false
 201         }
 202       ],
 203       "returns" : []
 204     },
 205     {
 206       "name" : "selectRows",
 207       "desc" : "Selects multiple rows.",
 208       "isStatic" : false,
 209       "isConstructor" : false,
 210       "isPrivate" : false,
 211       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 212       "example" : "",
 213       "deprecated" : "",
 214       "since" : "",
 215       "see" : "",
 216       "params" : [
 217         {
 218           "name" : "rows",
 219           "type" : "Array",
 220           "desc" : "Array of the indexes of the row to select",
 221           "isOptional" : false
 222         },
 223         {
 224           "name" : "keepExisting",
 225           "type" : "Boolean",
 226           "desc" : "(optional) True to keep existing selections",
 227           "isOptional" : false
 228         }
 229       ],
 230       "returns" : []
 231     },
 232     {
 233       "name" : "selectRecords",
 234       "desc" : "Select records.",
 235       "isStatic" : false,
 236       "isConstructor" : false,
 237       "isPrivate" : false,
 238       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 239       "example" : "",
 240       "deprecated" : "",
 241       "since" : "",
 242       "see" : "",
 243       "params" : [
 244         {
 245           "name" : "records",
 246           "type" : "Array",
 247           "desc" : "The records to select",
 248           "isOptional" : false
 249         },
 250         {
 251           "name" : "keepExisting",
 252           "type" : "Boolean",
 253           "desc" : "(optional) True to keep existing selections",
 254           "isOptional" : false
 255         }
 256       ],
 257       "returns" : []
 258     },
 259     {
 260       "name" : "hasSelection",
 261       "desc" : "Returns True if there is a selection.",
 262       "isStatic" : false,
 263       "isConstructor" : false,
 264       "isPrivate" : false,
 265       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 266       "example" : "",
 267       "deprecated" : "",
 268       "since" : "",
 269       "see" : "",
 270       "params" : [],
 271       "returns" : [
 272         {
 273           "name" : "",
 274           "type" : "Boolean",
 275           "desc" : ""
 276         }
 277       ]
 278     },
 279     {
 280       "name" : "isIdSelected",
 281       "desc" : "Returns True if the specified record id is selected.",
 282       "isStatic" : false,
 283       "isConstructor" : false,
 284       "isPrivate" : false,
 285       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 286       "example" : "",
 287       "deprecated" : "",
 288       "since" : "",
 289       "see" : "",
 290       "params" : [
 291         {
 292           "name" : "id",
 293           "type" : "String",
 294           "desc" : "The id of record to check",
 295           "isOptional" : false
 296         }
 297       ],
 298       "returns" : [
 299         {
 300           "name" : "",
 301           "type" : "Boolean",
 302           "desc" : ""
 303         }
 304       ]
 305     },
 306     {
 307       "name" : "selectAll",
 308       "desc" : "Selects all rows.",
 309       "isStatic" : false,
 310       "isConstructor" : false,
 311       "isPrivate" : false,
 312       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 313       "example" : "",
 314       "deprecated" : "",
 315       "since" : "",
 316       "see" : "",
 317       "params" : [],
 318       "returns" : []
 319     },
 320     {
 321       "name" : "selectRow",
 322       "desc" : "Selects a row.",
 323       "isStatic" : false,
 324       "isConstructor" : false,
 325       "isPrivate" : false,
 326       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 327       "example" : "",
 328       "deprecated" : "",
 329       "since" : "",
 330       "see" : "",
 331       "params" : [
 332         {
 333           "name" : "row",
 334           "type" : "Number",
 335           "desc" : "The index of the row to select",
 336           "isOptional" : false
 337         },
 338         {
 339           "name" : "keepExisting",
 340           "type" : "Boolean",
 341           "desc" : "(optional) True to keep existing selections",
 342           "isOptional" : false
 343         }
 344       ],
 345       "returns" : []
 346     },
 347     {
 348       "name" : "getSelected",
 349       "desc" : "Returns the first selected record.",
 350       "isStatic" : false,
 351       "isConstructor" : false,
 352       "isPrivate" : false,
 353       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 354       "example" : "",
 355       "deprecated" : "",
 356       "since" : "",
 357       "see" : "",
 358       "params" : [],
 359       "returns" : [
 360         {
 361           "name" : "",
 362           "type" : "Record",
 363           "desc" : ""
 364         }
 365       ]
 366     },
 367     {
 368       "name" : "isSelected",
 369       "desc" : "Returns True if the specified row is selected.",
 370       "isStatic" : false,
 371       "isConstructor" : false,
 372       "isPrivate" : false,
 373       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 374       "example" : "",
 375       "deprecated" : "",
 376       "since" : "",
 377       "see" : "",
 378       "params" : [
 379         {
 380           "name" : "record",
 381           "type" : "Number/Record",
 382           "desc" : "The record or index of the record to check",
 383           "isOptional" : false
 384         }
 385       ],
 386       "returns" : [
 387         {
 388           "name" : "",
 389           "type" : "Boolean",
 390           "desc" : ""
 391         }
 392       ]
 393     },
 394     {
 395       "name" : "clearSelections",
 396       "desc" : "Clears all selections.",
 397       "isStatic" : false,
 398       "isConstructor" : false,
 399       "isPrivate" : false,
 400       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 401       "example" : "",
 402       "deprecated" : "",
 403       "since" : "",
 404       "see" : "",
 405       "params" : [],
 406       "returns" : []
 407     },
 408     {
 409       "name" : "deselectRange",
 410       "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.",
 411       "isStatic" : false,
 412       "isConstructor" : false,
 413       "isPrivate" : false,
 414       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 415       "example" : "",
 416       "deprecated" : "",
 417       "since" : "",
 418       "see" : "",
 419       "params" : [
 420         {
 421           "name" : "startRow",
 422           "type" : "Number",
 423           "desc" : "The index of the first row in the range",
 424           "isOptional" : false
 425         },
 426         {
 427           "name" : "endRow",
 428           "type" : "Number",
 429           "desc" : "The index of the last row in the range",
 430           "isOptional" : false
 431         }
 432       ],
 433       "returns" : []
 434     }
 435   ],
 436   "events" : [
 437     {
 438       "name" : "rowselect",
 439       "desc" : "Fires when a row is selected.",
 440       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 441       "example" : "",
 442       "deprecated" : "",
 443       "since" : "",
 444       "see" : "",
 445       "params" : [
 446         {
 447           "name" : "this",
 448           "type" : "SelectionModel",
 449           "desc" : "",
 450           "isOptional" : false
 451         },
 452         {
 453           "name" : "rowIndex",
 454           "type" : "Number",
 455           "desc" : "The selected index",
 456           "isOptional" : false
 457         },
 458         {
 459           "name" : "r",
 460           "type" : "Roo.data.Record",
 461           "desc" : "The record",
 462           "isOptional" : false
 463         }
 464       ],
 465       "returns" : []
 466     },
 467     {
 468       "name" : "beforerowselect",
 469       "desc" : "Fires when a row is selected being selected, return false to cancel.",
 470       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 471       "example" : "",
 472       "deprecated" : "",
 473       "since" : "",
 474       "see" : "",
 475       "params" : [
 476         {
 477           "name" : "this",
 478           "type" : "SelectionModel",
 479           "desc" : "",
 480           "isOptional" : false
 481         },
 482         {
 483           "name" : "rowIndex",
 484           "type" : "Number",
 485           "desc" : "The selected index",
 486           "isOptional" : false
 487         },
 488         {
 489           "name" : "keepExisting",
 490           "type" : "Boolean",
 491           "desc" : "False if other selections will be cleared",
 492           "isOptional" : false
 493         }
 494       ],
 495       "returns" : []
 496     },
 497     {
 498       "name" : "rowdeselect",
 499       "desc" : "Fires when a row is deselected.",
 500       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 501       "example" : "",
 502       "deprecated" : "",
 503       "since" : "",
 504       "see" : "",
 505       "params" : [
 506         {
 507           "name" : "this",
 508           "type" : "SelectionModel",
 509           "desc" : "",
 510           "isOptional" : false
 511         },
 512         {
 513           "name" : "rowIndex",
 514           "type" : "Number",
 515           "desc" : "The selected index",
 516           "isOptional" : false
 517         }
 518       ],
 519       "returns" : []
 520     },
 521     {
 522       "name" : "afterselectionchange",
 523       "desc" : "Fires after the selection changes (eg. by key press or clicking)",
 524       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 525       "example" : "",
 526       "deprecated" : "",
 527       "since" : "",
 528       "see" : "",
 529       "params" : [
 530         {
 531           "name" : "this",
 532           "type" : "SelectionModel",
 533           "desc" : "",
 534           "isOptional" : false
 535         }
 536       ],
 537       "returns" : []
 538     },
 539     {
 540       "name" : "selectionchange",
 541       "desc" : "Fires when the selection changes",
 542       "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
 543       "example" : "",
 544       "deprecated" : "",
 545       "since" : "",
 546       "see" : "",
 547       "params" : [
 548         {
 549           "name" : "this",
 550           "type" : "SelectionModel",
 551           "desc" : "",
 552           "isOptional" : false
 553         }
 554       ],
 555       "returns" : []
 556     }
 557   ]
 558 }