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",
42 "name" : "singleSelect",
44 "desc" : "True to allow selection of only one row at a time (defaults to false)",
52 "name" : "selectRange",
54 "desc" : "Selects a range of rows. All rows in between startRow and endRow are also selected.",
55 "sig" : "(startRow, endRow, keepExisting)",
59 "isConstructor" : false,
71 "desc" : "The index of the first row in the range",
77 "desc" : "The index of the last row in the range",
81 "name" : "keepExisting",
83 "desc" : "(optional) True to retain existing selections",
90 "name" : "selectFirstRow",
92 "desc" : "Selects the first row in the grid.",
97 "isConstructor" : false,
109 "name" : "deselectRow",
111 "desc" : "Deselects a row.",
116 "isConstructor" : false,
128 "desc" : "The index of the row to deselect",
137 "desc" : "Gets the number of selected rows.",
138 "sig" : "()\n{\n\n}",
142 "isConstructor" : false,
160 "name" : "isSelected",
162 "desc" : "Returns True if the specified row is selected.",
167 "isConstructor" : false,
178 "type" : "Number/Record",
179 "desc" : "The record or index of the record to check",
192 "name" : "selectLastRow",
194 "desc" : "Select the last row.",
195 "sig" : "(keepExisting)",
199 "isConstructor" : false,
209 "name" : "keepExisting",
211 "desc" : "(optional) True to keep existing selections",
218 "name" : "hasSelection",
220 "desc" : "Returns True if there is a selection.",
221 "sig" : "()\n{\n\n}",
225 "isConstructor" : false,
243 "name" : "isIdSelected",
245 "desc" : "Returns True if the specified record id is selected.",
250 "isConstructor" : false,
262 "desc" : "The id of record to check",
275 "name" : "getSelected",
277 "desc" : "Returns the first selected record.",
278 "sig" : "()\n{\n\n}",
282 "isConstructor" : false,
300 "name" : "selectRecords",
302 "desc" : "Select records.",
303 "sig" : "(records, keepExisting)",
307 "isConstructor" : false,
319 "desc" : "The records to select",
323 "name" : "keepExisting",
325 "desc" : "(optional) True to keep existing selections",
332 "name" : "clearSelections",
334 "desc" : "Clears all selections.",
335 "sig" : "()\n{\n\n}",
339 "isConstructor" : false,
351 "name" : "deselectRange",
353 "desc" : "Deselects a range of rows. All rows in between startRow and endRow are also deselected.",
354 "sig" : "(startRow, endRow)",
358 "isConstructor" : false,
370 "desc" : "The index of the first row in the range",
376 "desc" : "The index of the last row in the range",
383 "name" : "getSelections",
385 "desc" : "Returns the selected records",
386 "sig" : "()\n{\n\n}",
390 "isConstructor" : false,
403 "desc" : "Array of selected records"
408 "name" : "selectNext",
410 "desc" : "Selects the row immediately following the last selected row.",
411 "sig" : "(keepExisting)",
415 "isConstructor" : false,
425 "name" : "keepExisting",
427 "desc" : "(optional) True to keep existing selections",
434 "name" : "selectAll",
436 "desc" : "Selects all rows.",
437 "sig" : "()\n{\n\n}",
441 "isConstructor" : false,
453 "name" : "selectRow",
455 "desc" : "Selects a row.",
456 "sig" : "(row, keepExisting)",
460 "isConstructor" : false,
472 "desc" : "The index of the row to select",
476 "name" : "keepExisting",
478 "desc" : "(optional) True to keep existing selections",
485 "name" : "selectRows",
487 "desc" : "Selects multiple rows.",
488 "sig" : "(rows, keepExisting)",
492 "isConstructor" : false,
504 "desc" : "Array of the indexes of the row to select",
508 "name" : "keepExisting",
510 "desc" : "(optional) True to keep existing selections",
517 "name" : "selectPrevious",
519 "desc" : "Selects the row that precedes the last selected row.",
520 "sig" : "(keepExisting)",
524 "isConstructor" : false,
534 "name" : "keepExisting",
536 "desc" : "(optional) True to keep existing selections",
545 "desc" : "Locks the selections.",
546 "sig" : "()\n{\n\n}",
548 "memberOf" : "Roo.grid.AbstractSelectionModel",
550 "isConstructor" : false,
564 "desc" : "Returns true if the selections are locked.",
565 "sig" : "()\n{\n\n}",
567 "memberOf" : "Roo.grid.AbstractSelectionModel",
569 "isConstructor" : false,
589 "desc" : "Unlocks the selections.",
590 "sig" : "()\n{\n\n}",
592 "memberOf" : "Roo.grid.AbstractSelectionModel",
594 "isConstructor" : false,
606 "name" : "purgeListeners",
608 "desc" : "Removes all listeners for this object",
609 "sig" : "()\n{\n\n}",
611 "memberOf" : "Roo.util.Observable",
613 "isConstructor" : false,
627 "desc" : "Appends an event handler to this element (shorthand for addListener)",
628 "sig" : "(eventName, handler, scope, options)",
630 "memberOf" : "Roo.util.Observable",
632 "isConstructor" : false,
642 "name" : "eventName",
644 "desc" : "The type of event to listen for",
650 "desc" : "The method the event invokes",
656 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
662 "desc" : "(optional)",
671 "desc" : "Removes a listener (shorthand for removeListener)",
672 "sig" : "(eventName, handler, scope)",
674 "memberOf" : "Roo.util.Observable",
676 "isConstructor" : false,
686 "name" : "eventName",
688 "desc" : "The type of event to listen for",
694 "desc" : "The handler to remove",
700 "desc" : "(optional) The scope (this object) for the handler",
707 "name" : "addEvents",
709 "desc" : "Used to define events on this Observable",
712 "memberOf" : "Roo.util.Observable",
714 "isConstructor" : false,
726 "desc" : "The object with the events defined",
733 "name" : "releaseCapture",
735 "desc" : "Removes <b>all</b> added captures from the Observable.",
738 "memberOf" : "Roo.util.Observable",
740 "isConstructor" : false,
751 "type" : "Observable",
752 "desc" : "The Observable to release",
759 "name" : "removeListener",
761 "desc" : "Removes a listener",
762 "sig" : "(eventName, handler, scope)",
764 "memberOf" : "Roo.util.Observable",
766 "isConstructor" : false,
776 "name" : "eventName",
778 "desc" : "The type of event to listen for",
784 "desc" : "The handler to remove",
790 "desc" : "(optional) The scope (this object) for the handler",
797 "name" : "fireEvent",
799 "desc" : "Fires the specified event with the passed parameters (minus the event name).",
800 "sig" : "(eventName, args)",
802 "memberOf" : "Roo.util.Observable",
804 "isConstructor" : false,
814 "name" : "eventName",
821 "type" : "Object...",
822 "desc" : "Variable number of parameters are passed to handlers",
830 "desc" : "returns false if any of the handlers return false otherwise it returns true"
835 "name" : "hasListener",
837 "desc" : "Checks to see if this object has any listeners for a specified event",
838 "sig" : "(eventName)",
840 "memberOf" : "Roo.util.Observable",
842 "isConstructor" : false,
852 "name" : "eventName",
854 "desc" : "The name of the event to check for",
862 "desc" : "True if the event is being listened for, else false"
869 "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.",
870 "sig" : "(o, fn, scope)",
872 "memberOf" : "Roo.util.Observable",
874 "isConstructor" : false,
885 "type" : "Observable",
886 "desc" : "The Observable to capture",
892 "desc" : "The function to call",
898 "desc" : "(optional) The scope (this object) for the fn",
905 "name" : "addListener",
907 "desc" : "Appends an event handler to this component",
908 "sig" : "(eventName, handler, scope, options)",
910 "memberOf" : "Roo.util.Observable",
912 "isConstructor" : false,
922 "name" : "eventName",
924 "desc" : "The type of event to listen for",
930 "desc" : "The method the event invokes",
936 "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
942 "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>",
951 "name" : "selectionchange",
953 "desc" : "Fires when the selection changes",
954 "sig" : "function (_self)\n{\n\n}",
963 "type" : "SelectionModel",
971 "name" : "rowselect",
973 "desc" : "Fires when a row is selected.",
974 "sig" : "function (_self, rowIndex, r)\n{\n\n}",
983 "type" : "SelectionModel",
990 "desc" : "The selected index",
995 "type" : "Roo.data.Record",
996 "desc" : "The record",
1003 "name" : "beforerowselect",
1004 "type" : "function",
1005 "desc" : "Fires when a row is selected being selected, return false to cancel.",
1006 "sig" : "function (_self, rowIndex, keepExisting)\n{\n\n}",
1015 "type" : "SelectionModel",
1017 "isOptional" : false
1020 "name" : "rowIndex",
1022 "desc" : "The selected index",
1023 "isOptional" : false
1026 "name" : "keepExisting",
1028 "desc" : "False if other selections will be cleared",
1029 "isOptional" : false
1035 "name" : "afterselectionchange",
1036 "type" : "function",
1037 "desc" : "Fires after the selection changes (eg. by key press or clicking)",
1038 "sig" : "function (_self)\n{\n\n}",
1047 "type" : "SelectionModel",
1049 "isOptional" : false
1055 "name" : "rowdeselect",
1056 "type" : "function",
1057 "desc" : "Fires when a row is deselected.",
1058 "sig" : "function (_self, rowIndex)\n{\n\n}",
1067 "type" : "SelectionModel",
1069 "isOptional" : false
1072 "name" : "rowIndex",
1074 "desc" : "The selected index",
1075 "isOptional" : false