X-Git-Url: http://git.roojs.org/?p=roojs1;a=blobdiff_plain;f=docs%2Fsymbols%2FRoo.grid.RowSelectionModel.json;fp=docs%2Fsymbols%2FRoo.grid.RowSelectionModel.json;h=252098d92e1035092062bbf0cff76c39cc93a036;hp=502fab84d280dfce527646d828668aa2014473a0;hb=e01802ac69da0ec0c9ccecc295beff82c1779f68;hpb=0fa7894b7489284160ff14afdca7b6911983357f diff --git a/docs/symbols/Roo.grid.RowSelectionModel.json b/docs/symbols/Roo.grid.RowSelectionModel.json index 502fab84d2..252098d92e 100644 --- a/docs/symbols/Roo.grid.RowSelectionModel.json +++ b/docs/symbols/Roo.grid.RowSelectionModel.json @@ -4,10 +4,15 @@ "Roo.grid.AbstractSelectionModel", "Roo.util.Observable" ], + "childClasses" : { }, + "tree_children" : [], + "tree_parent" : [], "desc" : "The default SelectionModel used by {@link Roo.grid.Grid}.\nIt supports multiple selections and keyboard selection/navigation.", "isSingleton" : false, "isStatic" : false, "isBuiltin" : false, + "isAbstract" : false, + "isBuilderTop" : false, "memberOf" : "RowSelectionModel", "example" : "", "deprecated" : "", @@ -22,34 +27,39 @@ } ], "returns" : [], + "throws" : "", + "requires" : "", "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", - "optvals" : [] + "memberOf" : "Roo.util.Observable" }, { "name" : "singleSelect", "type" : "Boolean", "desc" : "True to allow selection of only one row at a time (defaults to false)", - "memberOf" : "Roo.grid.RowSelectionModel", - "optvals" : [] + "memberOf" : "Roo.grid.RowSelectionModel" } ], "methods" : [ { "name" : "selectRange", + "type" : "function", "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.", + "sig" : "(startRow, endRow, keepExisting)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "startRow", @@ -74,29 +84,39 @@ }, { "name" : "selectFirstRow", + "type" : "function", "desc" : "Selects the first row in the grid.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "deselectRow", + "type" : "function", "desc" : "Deselects a row.", + "sig" : "(row)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "row", @@ -109,15 +129,20 @@ }, { "name" : "getCount", + "type" : "function", "desc" : "Gets the number of selected rows.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -129,15 +154,20 @@ }, { "name" : "isSelected", + "type" : "function", "desc" : "Returns True if the specified row is selected.", + "sig" : "(record)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "record", @@ -156,15 +186,20 @@ }, { "name" : "selectLastRow", + "type" : "function", "desc" : "Select the last row.", + "sig" : "(keepExisting)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "keepExisting", @@ -177,15 +212,20 @@ }, { "name" : "hasSelection", + "type" : "function", "desc" : "Returns True if there is a selection.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -197,15 +237,20 @@ }, { "name" : "isIdSelected", + "type" : "function", "desc" : "Returns True if the specified record id is selected.", + "sig" : "(id)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "id", @@ -224,15 +269,20 @@ }, { "name" : "getSelected", + "type" : "function", "desc" : "Returns the first selected record.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -244,15 +294,20 @@ }, { "name" : "selectRecords", + "type" : "function", "desc" : "Select records.", + "sig" : "(records, keepExisting)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "records", @@ -271,29 +326,39 @@ }, { "name" : "clearSelections", + "type" : "function", "desc" : "Clears all selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "deselectRange", + "type" : "function", "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.", + "sig" : "(startRow, endRow)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "startRow", @@ -312,15 +377,20 @@ }, { "name" : "getSelections", + "type" : "function", "desc" : "Returns the selected records", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -332,15 +402,20 @@ }, { "name" : "selectNext", + "type" : "function", "desc" : "Selects the row immediately following the last selected row.", + "sig" : "(keepExisting)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "keepExisting", @@ -353,29 +428,39 @@ }, { "name" : "selectAll", + "type" : "function", "desc" : "Selects all rows.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "selectRow", + "type" : "function", "desc" : "Selects a row.", + "sig" : "(row, keepExisting)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "row", @@ -394,15 +479,20 @@ }, { "name" : "selectRows", + "type" : "function", "desc" : "Selects multiple rows.", + "sig" : "(rows, keepExisting)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "rows", @@ -421,15 +511,20 @@ }, { "name" : "selectPrevious", + "type" : "function", "desc" : "Selects the row that precedes the last selected row.", + "sig" : "(keepExisting)", + "static" : false, + "memberOf" : "", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.RowSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "keepExisting", @@ -442,29 +537,39 @@ }, { "name" : "lock", + "type" : "function", "desc" : "Locks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "isLocked", + "type" : "function", "desc" : "Returns true if the selections are locked.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [ { @@ -476,43 +581,58 @@ }, { "name" : "unlock", + "type" : "function", "desc" : "Unlocks the selections.", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.grid.AbstractSelectionModel", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.grid.AbstractSelectionModel", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "purgeListeners", + "type" : "function", "desc" : "Removes all listeners for this object", + "sig" : "()\n{\n\n}", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [], "returns" : [] }, { "name" : "on", + "type" : "function", "desc" : "Appends an event handler to this element (shorthand for addListener)", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -543,15 +663,20 @@ }, { "name" : "un", + "type" : "function", "desc" : "Removes a listener (shorthand for removeListener)", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -576,15 +701,20 @@ }, { "name" : "addEvents", + "type" : "function", "desc" : "Used to define events on this Observable", + "sig" : "(object)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "object", @@ -597,15 +727,20 @@ }, { "name" : "releaseCapture", + "type" : "function", "desc" : "Removes all added captures from the Observable.", + "sig" : "(o)", + "static" : true, + "memberOf" : "Roo.util.Observable", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -618,15 +753,20 @@ }, { "name" : "removeListener", + "type" : "function", "desc" : "Removes a listener", + "sig" : "(eventName, handler, scope)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -651,15 +791,20 @@ }, { "name" : "fireEvent", + "type" : "function", "desc" : "Fires the specified event with the passed parameters (minus the event name).", + "sig" : "(eventName, args)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -684,15 +829,20 @@ }, { "name" : "hasListener", + "type" : "function", "desc" : "Checks to see if this object has any listeners for a specified event", + "sig" : "(eventName)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -711,15 +861,20 @@ }, { "name" : "capture", + "type" : "function", "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.", + "sig" : "(o, fn, scope)", + "static" : true, + "memberOf" : "Roo.util.Observable", "isStatic" : true, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "o", @@ -744,15 +899,20 @@ }, { "name" : "addListener", + "type" : "function", "desc" : "Appends an event handler to this component", + "sig" : "(eventName, handler, scope, options)", + "static" : false, + "memberOf" : "Roo.util.Observable", "isStatic" : false, "isConstructor" : false, "isPrivate" : false, - "memberOf" : "Roo.util.Observable", "example" : "", "deprecated" : "", "since" : "", "see" : "", + "exceptions" : "", + "requires" : "", "params" : [ { "name" : "eventName", @@ -785,8 +945,10 @@ "events" : [ { "name" : "selectionchange", + "type" : "function", "desc" : "Fires when the selection changes", - "memberOf" : "Roo.grid.RowSelectionModel", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -803,8 +965,10 @@ }, { "name" : "rowselect", + "type" : "function", "desc" : "Fires when a row is selected.", - "memberOf" : "Roo.grid.RowSelectionModel", + "sig" : "function (_self, rowIndex, r)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -833,8 +997,10 @@ }, { "name" : "beforerowselect", + "type" : "function", "desc" : "Fires when a row is selected being selected, return false to cancel.", - "memberOf" : "Roo.grid.RowSelectionModel", + "sig" : "function (_self, rowIndex, keepExisting)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -863,8 +1029,10 @@ }, { "name" : "afterselectionchange", + "type" : "function", "desc" : "Fires after the selection changes (eg. by key press or clicking)", - "memberOf" : "Roo.grid.RowSelectionModel", + "sig" : "function (_self)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "", @@ -881,8 +1049,10 @@ }, { "name" : "rowdeselect", + "type" : "function", "desc" : "Fires when a row is deselected.", - "memberOf" : "Roo.grid.RowSelectionModel", + "sig" : "function (_self, rowIndex)\n{\n\n}", + "memberOf" : "", "example" : "", "deprecated" : "", "since" : "",