X-Git-Url: http://git.roojs.org/?a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.grid.RowSelectionModel.json;fp=docs%2Fsymbols%2FRoo.grid.RowSelectionModel.json;h=e0e1b7f7826628b1d65f989b7a03998cb05a31fa;hb=9ff8ded6bbbd258ecd646184ba26020874e2c085;hp=0000000000000000000000000000000000000000;hpb=2542b67d1a0768025056f2f330bfe50b64d1ad38;p=roojs1 diff --git a/docs/symbols/Roo.grid.RowSelectionModel.json b/docs/symbols/Roo.grid.RowSelectionModel.json new file mode 100644 index 0000000000..e0e1b7f782 --- /dev/null +++ b/docs/symbols/Roo.grid.RowSelectionModel.json @@ -0,0 +1,948 @@ +{ + "name" : "Roo.grid.RowSelectionModel", + "augments" : [ + "Roo.grid.AbstractSelectionModel", + "Roo.util.Observable" + ], + "desc" : "The default SelectionModel used by {@link Roo.grid.Grid}.\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" : "listeners", + "type" : "Object", + "desc" : "list of events and functions to call for this object, \nFor example :\n
\n    listeners :  { \n       'click' : function(e) {\n           ..... \n        } ,\n        .... \n    } \n  
", + "memberOf" : "Roo.util.Observable", + "values" : [ + ] + }, + { + "name" : "singleSelect", + "type" : "Boolean", + "desc" : "True to allow selection of only one row at a time (defaults to false)", + "memberOf" : "Roo.grid.RowSelectionModel", + "values" : [ + ] + } + ], + "methods" : [ + { + "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.grid.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.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "deselectRow", + "desc" : "Deselects a row.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "row", + "type" : "Number", + "desc" : "The index of the row to deselect", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "getCount", + "desc" : "Gets the number of selected rows.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Number", + "desc" : "" + } + ] + }, + { + "name" : "isSelected", + "desc" : "Returns True if the specified row is selected.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.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" : "selectLastRow", + "desc" : "Select the last row.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "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.grid.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.grid.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" : "getSelected", + "desc" : "Returns the first selected record.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Record", + "desc" : "" + } + ] + }, + { + "name" : "selectRecords", + "desc" : "Select records.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.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" : "clearSelections", + "desc" : "Clears all selections.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.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.grid.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" : [ + ] + }, + { + "name" : "getSelections", + "desc" : "Returns the selected records", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Array", + "desc" : "Array of selected records" + } + ] + }, + { + "name" : "selectNext", + "desc" : "Selects the row immediately following the last selected row.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "selectAll", + "desc" : "Selects all rows.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "selectRow", + "desc" : "Selects a row.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.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" : "selectRows", + "desc" : "Selects multiple rows.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.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" : "selectPrevious", + "desc" : "Selects the row that precedes the last selected row.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.RowSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "keepExisting", + "type" : "Boolean", + "desc" : "(optional) True to keep existing selections", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "lock", + "desc" : "Locks the selections.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "isLocked", + "desc" : "Returns true if the selections are locked.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "" + } + ] + }, + { + "name" : "unlock", + "desc" : "Unlocks the selections.", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "purgeListeners", + "desc" : "Removes all listeners for this object", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + ], + "returns" : [ + ] + }, + { + "name" : "on", + "desc" : "Appends an event handler to this element (shorthand for addListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional)", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "un", + "desc" : "Removes a listener (shorthand for removeListener)", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addEvents", + "desc" : "Used to define events on this Observable", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "object", + "type" : "Object", + "desc" : "The object with the events defined", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "releaseCapture", + "desc" : "Removes all added captures from the Observable.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to release", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "removeListener", + "desc" : "Removes a listener", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The handler to remove", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the handler", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "fireEvent", + "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "", + "isOptional" : false + }, + { + "name" : "args", + "type" : "Object...", + "desc" : "Variable number of parameters are passed to handlers", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "returns false if any of the handlers return false otherwise it returns true" + } + ] + }, + { + "name" : "hasListener", + "desc" : "Checks to see if this object has any listeners for a specified event", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The name of the event to check for", + "isOptional" : false + } + ], + "returns" : [ + { + "name" : "", + "type" : "Boolean", + "desc" : "True if the event is being listened for, else false" + } + ] + }, + { + "name" : "capture", + "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\nbefore the event is fired. If the supplied function returns false,\nthe event will not fire.", + "isStatic" : true, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "o", + "type" : "Observable", + "desc" : "The Observable to capture", + "isOptional" : false + }, + { + "name" : "fn", + "type" : "Function", + "desc" : "The function to call", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope (this object) for the fn", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "addListener", + "desc" : "Appends an event handler to this component", + "isStatic" : false, + "isConstructor" : false, + "isPrivate" : false, + "memberOf" : "Roo.util.Observable", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "eventName", + "type" : "String", + "desc" : "The type of event to listen for", + "isOptional" : false + }, + { + "name" : "handler", + "type" : "Function", + "desc" : "The method the event invokes", + "isOptional" : false + }, + { + "name" : "scope", + "type" : "Object", + "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.", + "isOptional" : false + }, + { + "name" : "options", + "type" : "Object", + "desc" : "(optional) An object containing handler configuration\nproperties. This may contain any of the following properties:
\n

\nCombining Options
\nUsing the options argument, it is possible to combine different types of listeners:
\n
\nA normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)\n\t\t

\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
\n

\nAttaching multiple handlers in 1 call
\nThe method also allows for a single argument to be passed which is a config object containing properties\nwhich specify multiple handlers.\n

\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
\n

\nOr a shorthand syntax which passes the same scope object to all handlers:\n \t

\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
", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ], + "events" : [ + { + "name" : "selectionchange", + "desc" : "Fires when the selection changes", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowselect", + "desc" : "Fires when a row is selected.", + "memberOf" : "", + "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" : "", + "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" : "afterselectionchange", + "desc" : "Fires after the selection changes (eg. by key press or clicking)", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + } + ], + "returns" : [ + ] + }, + { + "name" : "rowdeselect", + "desc" : "Fires when a row is deselected.", + "memberOf" : "", + "example" : "", + "deprecated" : "", + "since" : "", + "see" : "", + "params" : [ + { + "name" : "this", + "type" : "SelectionModel", + "desc" : "", + "isOptional" : false + }, + { + "name" : "rowIndex", + "type" : "Number", + "desc" : "The selected index", + "isOptional" : false + } + ], + "returns" : [ + ] + } + ] +} \ No newline at end of file