2 "name" : "Roo.grid.RowSelectionModel",
4 "Roo.grid.AbstractSelectionModel",
10 "desc" : "The default SelectionModel used by {@link Roo.grid.Grid}.\nIt supports multiple selections and keyboard selection/navigation.",
11 "isSingleton" : false,
15 "isBuilderTop" : false,
16 "memberOf" : "RowSelectionModel",
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"
40 "name" : "singleSelect",
42 "desc" : "True to allow selection of only one row at a time (defaults to false)",
48 "name" : "selectRange",
50 "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.",
51 "sig" : "(startRow, endRow, keepExisting)",
55 "isConstructor" : false,
67 "desc" : "The index of the first row in the range",
73 "desc" : "The index of the last row in the range",
77 "name" : "keepExisting",
79 "desc" : "(optional) True to retain existing selections",
86 "name" : "selectFirstRow",
88 "desc" : "Selects the first row in the grid.",
93 "isConstructor" : false,
105 "name" : "deselectRow",
107 "desc" : "Deselects a row.",
112 "isConstructor" : false,
124 "desc" : "The index of the row to deselect",
133 "desc" : "Gets the number of selected rows.",
134 "sig" : "()\n{\n\n}",
138 "isConstructor" : false,
156 "name" : "isSelected",
158 "desc" : "Returns True if the specified row is selected.",
163 "isConstructor" : false,
174 "type" : "Number/Record",
175 "desc" : "The record or index of the record to check",
188 "name" : "selectLastRow",
190 "desc" : "Select the last row.",
191 "sig" : "(keepExisting)",
195 "isConstructor" : false,
205 "name" : "keepExisting",
207 "desc" : "(optional) True to keep existing selections",
214 "name" : "hasSelection",
216 "desc" : "Returns True if there is a selection.",
217 "sig" : "()\n{\n\n}",
221 "isConstructor" : false,
239 "name" : "isIdSelected",
241 "desc" : "Returns True if the specified record id is selected.",
246 "isConstructor" : false,
258 "desc" : "The id of record to check",
271 "name" : "getSelected",
273 "desc" : "Returns the first selected record.",
274 "sig" : "()\n{\n\n}",
278 "isConstructor" : false,
296 "name" : "selectRecords",
298 "desc" : "Select records.",
299 "sig" : "(records, keepExisting)",
303 "isConstructor" : false,
315 "desc" : "The records to select",
319 "name" : "keepExisting",
321 "desc" : "(optional) True to keep existing selections",
328 "name" : "clearSelections",
330 "desc" : "Clears all selections.",
331 "sig" : "()\n{\n\n}",
335 "isConstructor" : false,
347 "name" : "deselectRange",
349 "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.",
350 "sig" : "(startRow, endRow)",
354 "isConstructor" : false,
366 "desc" : "The index of the first row in the range",
372 "desc" : "The index of the last row in the range",
379 "name" : "getSelections",
381 "desc" : "Returns the selected records",
382 "sig" : "()\n{\n\n}",
386 "isConstructor" : false,
399 "desc" : "Array of selected records"
404 "name" : "selectNext",
406 "desc" : "Selects the row immediately following the last selected row.",
407 "sig" : "(keepExisting)",
411 "isConstructor" : false,
421 "name" : "keepExisting",
423 "desc" : "(optional) True to keep existing selections",
430 "name" : "selectAll",
432 "desc" : "Selects all rows.",
433 "sig" : "()\n{\n\n}",
437 "isConstructor" : false,
449 "name" : "selectRow",
451 "desc" : "Selects a row.",
452 "sig" : "(row, keepExisting)",
456 "isConstructor" : false,
468 "desc" : "The index of the row to select",
472 "name" : "keepExisting",
474 "desc" : "(optional) True to keep existing selections",
481 "name" : "selectRows",
483 "desc" : "Selects multiple rows.",
484 "sig" : "(rows, keepExisting)",
488 "isConstructor" : false,
500 "desc" : "Array of the indexes of the row to select",
504 "name" : "keepExisting",
506 "desc" : "(optional) True to keep existing selections",
513 "name" : "selectPrevious",
515 "desc" : "Selects the row that precedes the last selected row.",
516 "sig" : "(keepExisting)",
520 "isConstructor" : false,
530 "name" : "keepExisting",
532 "desc" : "(optional) True to keep existing selections",
541 "desc" : "Locks the selections.",
542 "sig" : "()\n{\n\n}",
544 "memberOf" : "Roo.grid.AbstractSelectionModel",
546 "isConstructor" : false,
560 "desc" : "Returns true if the selections are locked.",
561 "sig" : "()\n{\n\n}",
563 "memberOf" : "Roo.grid.AbstractSelectionModel",
565 "isConstructor" : false,
585 "desc" : "Unlocks the selections.",
586 "sig" : "()\n{\n\n}",
588 "memberOf" : "Roo.grid.AbstractSelectionModel",
590 "isConstructor" : false,
602 "name" : "purgeListeners",
604 "desc" : "Removes all listeners for this object",
605 "sig" : "()\n{\n\n}",
607 "memberOf" : "Roo.util.Observable",
609 "isConstructor" : false,
623 "desc" : "Appends an event handler to this element (shorthand for addListener)",
624 "sig" : "(eventName, handler, scope, options)",
626 "memberOf" : "Roo.util.Observable",
628 "isConstructor" : false,
638 "name" : "eventName",
640 "desc" : "The type of event to listen for",
646 "desc" : "The method the event invokes",
652 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
658 "desc" : "(optional)",
667 "desc" : "Removes a listener (shorthand for removeListener)",
668 "sig" : "(eventName, handler, scope)",
670 "memberOf" : "Roo.util.Observable",
672 "isConstructor" : false,
682 "name" : "eventName",
684 "desc" : "The type of event to listen for",
690 "desc" : "The handler to remove",
696 "desc" : "(optional) The scope (this object) for the handler",
703 "name" : "addEvents",
705 "desc" : "Used to define events on this Observable",
708 "memberOf" : "Roo.util.Observable",
710 "isConstructor" : false,
722 "desc" : "The object with the events defined",
729 "name" : "releaseCapture",
731 "desc" : "Removes <b>all</b> added captures from the Observable.",
734 "memberOf" : "Roo.util.Observable",
736 "isConstructor" : false,
747 "type" : "Observable",
748 "desc" : "The Observable to release",
755 "name" : "removeListener",
757 "desc" : "Removes a listener",
758 "sig" : "(eventName, handler, scope)",
760 "memberOf" : "Roo.util.Observable",
762 "isConstructor" : false,
772 "name" : "eventName",
774 "desc" : "The type of event to listen for",
780 "desc" : "The handler to remove",
786 "desc" : "(optional) The scope (this object) for the handler",
793 "name" : "fireEvent",
795 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
796 "sig" : "(eventName, args)",
798 "memberOf" : "Roo.util.Observable",
800 "isConstructor" : false,
810 "name" : "eventName",
817 "type" : "Object...",
818 "desc" : "Variable number of parameters are passed to handlers",
826 "desc" : "returns false if any of the handlers return false otherwise it returns true"
831 "name" : "hasListener",
833 "desc" : "Checks to see if this object has any listeners for a specified event",
834 "sig" : "(eventName)",
836 "memberOf" : "Roo.util.Observable",
838 "isConstructor" : false,
848 "name" : "eventName",
850 "desc" : "The name of the event to check for",
858 "desc" : "True if the event is being listened for, else false"
865 "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.",
866 "sig" : "(o, fn, scope)",
868 "memberOf" : "Roo.util.Observable",
870 "isConstructor" : false,
881 "type" : "Observable",
882 "desc" : "The Observable to capture",
888 "desc" : "The function to call",
894 "desc" : "(optional) The scope (this object) for the fn",
901 "name" : "addListener",
903 "desc" : "Appends an event handler to this component",
904 "sig" : "(eventName, handler, scope, options)",
906 "memberOf" : "Roo.util.Observable",
908 "isConstructor" : false,
918 "name" : "eventName",
920 "desc" : "The type of event to listen for",
926 "desc" : "The method the event invokes",
932 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
938 "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>",
947 "name" : "selectionchange",
949 "desc" : "Fires when the selection changes",
950 "sig" : "function (_self)\n{\n\n}",
959 "type" : "SelectionModel",
967 "name" : "rowselect",
969 "desc" : "Fires when a row is selected.",
970 "sig" : "function (_self, rowIndex, r)\n{\n\n}",
979 "type" : "SelectionModel",
986 "desc" : "The selected index",
991 "type" : "Roo.data.Record",
992 "desc" : "The record",
999 "name" : "beforerowselect",
1000 "type" : "function",
1001 "desc" : "Fires when a row is selected being selected, return false to cancel.",
1002 "sig" : "function (_self, rowIndex, keepExisting)\n{\n\n}",
1011 "type" : "SelectionModel",
1013 "isOptional" : false
1016 "name" : "rowIndex",
1018 "desc" : "The selected index",
1019 "isOptional" : false
1022 "name" : "keepExisting",
1024 "desc" : "False if other selections will be cleared",
1025 "isOptional" : false
1031 "name" : "afterselectionchange",
1032 "type" : "function",
1033 "desc" : "Fires after the selection changes (eg. by key press or clicking)",
1034 "sig" : "function (_self)\n{\n\n}",
1043 "type" : "SelectionModel",
1045 "isOptional" : false
1051 "name" : "rowdeselect",
1052 "type" : "function",
1053 "desc" : "Fires when a row is deselected.",
1054 "sig" : "function (_self, rowIndex)\n{\n\n}",
1063 "type" : "SelectionModel",
1065 "isOptional" : false
1068 "name" : "rowIndex",
1070 "desc" : "The selected index",
1071 "isOptional" : false