-{
- "name" : "Roo.bootstrap.Table.RowSelectionModel",
- "augments" : [
- "Roo.bootstrap.Table.AbstractSelectionModel"
- ],
- "desc" : "The default SelectionModel used by {@link Roo.bootstrap.Table}.\nIt supports multiple selections and keyboard selection/navigation.",
- "isSingleton" : false,
- "isStatic" : false,
- "isBuiltin" : false,
- "memberOf" : "RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "config",
- "type" : "Object",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : [],
- "config" : [
- {
- "name" : "singleSelect",
- "type" : "Boolean",
- "desc" : "True to allow selection of only one row at a time (defaults to false)",
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "values" : []
- }
- ],
- "methods" : [
- {
- "name" : "getCount",
- "desc" : "Gets the number of selected rows.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Number",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "getSelections",
- "desc" : "Returns the selected records",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Array",
- "desc" : "Array of selected records"
- }
- ]
- },
- {
- "name" : "selectRange",
- "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "startRow",
- "type" : "Number",
- "desc" : "The index of the first row in the range",
- "isOptional" : false
- },
- {
- "name" : "endRow",
- "type" : "Number",
- "desc" : "The index of the last row in the range",
- "isOptional" : false
- },
- {
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) True to retain existing selections",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "selectFirstRow",
- "desc" : "Selects the first row in the grid.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "selectLastRow",
- "desc" : "Select the last row.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "deselectRow",
- "desc" : "Deselects a row.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Number",
- "desc" : "The index of the row to deselect",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "selectNext",
- "desc" : "Selects the row immediately following the last selected row.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "selectPrevious",
- "desc" : "Selects the row that precedes the last selected row.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "selectRows",
- "desc" : "Selects multiple rows.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "rows",
- "type" : "Array",
- "desc" : "Array of the indexes of the row to select",
- "isOptional" : false
- },
- {
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "selectRecords",
- "desc" : "Select records.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "records",
- "type" : "Array",
- "desc" : "The records to select",
- "isOptional" : false
- },
- {
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "hasSelection",
- "desc" : "Returns True if there is a selection.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "isIdSelected",
- "desc" : "Returns True if the specified record id is selected.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "id",
- "type" : "String",
- "desc" : "The id of record to check",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "selectAll",
- "desc" : "Selects all rows.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "selectRow",
- "desc" : "Selects a row.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "row",
- "type" : "Number",
- "desc" : "The index of the row to select",
- "isOptional" : false
- },
- {
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "(optional) True to keep existing selections",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "getSelected",
- "desc" : "Returns the first selected record.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : [
- {
- "name" : "",
- "type" : "Record",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "isSelected",
- "desc" : "Returns True if the specified row is selected.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "record",
- "type" : "Number/Record",
- "desc" : "The record or index of the record to check",
- "isOptional" : false
- }
- ],
- "returns" : [
- {
- "name" : "",
- "type" : "Boolean",
- "desc" : ""
- }
- ]
- },
- {
- "name" : "clearSelections",
- "desc" : "Clears all selections.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [],
- "returns" : []
- },
- {
- "name" : "deselectRange",
- "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.",
- "isStatic" : false,
- "isConstructor" : false,
- "isPrivate" : false,
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "startRow",
- "type" : "Number",
- "desc" : "The index of the first row in the range",
- "isOptional" : false
- },
- {
- "name" : "endRow",
- "type" : "Number",
- "desc" : "The index of the last row in the range",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ],
- "events" : [
- {
- "name" : "rowselect",
- "desc" : "Fires when a row is selected.",
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "SelectionModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "The selected index",
- "isOptional" : false
- },
- {
- "name" : "r",
- "type" : "Roo.data.Record",
- "desc" : "The record",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "beforerowselect",
- "desc" : "Fires when a row is selected being selected, return false to cancel.",
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "SelectionModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "The selected index",
- "isOptional" : false
- },
- {
- "name" : "keepExisting",
- "type" : "Boolean",
- "desc" : "False if other selections will be cleared",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "rowdeselect",
- "desc" : "Fires when a row is deselected.",
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "SelectionModel",
- "desc" : "",
- "isOptional" : false
- },
- {
- "name" : "rowIndex",
- "type" : "Number",
- "desc" : "The selected index",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "afterselectionchange",
- "desc" : "Fires after the selection changes (eg. by key press or clicking)",
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "SelectionModel",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- },
- {
- "name" : "selectionchange",
- "desc" : "Fires when the selection changes",
- "memberOf" : "Roo.bootstrap.Table.RowSelectionModel",
- "example" : "",
- "deprecated" : "",
- "since" : "",
- "see" : "",
- "params" : [
- {
- "name" : "this",
- "type" : "SelectionModel",
- "desc" : "",
- "isOptional" : false
- }
- ],
- "returns" : []
- }
- ]
-}
\ No newline at end of file