SuperList.API.js

1       /* ----------------------------------------------------------------------------------
2        * Hint: This is a derived (generated) file. Changes should be done in the underlying 
3        * source files only (*.control, *.js) or they will be lost after the next generation.
4        * ---------------------------------------------------------------------------------- */
5       
6       // Provides control sap.apb.SuperList.
7       jQuery.sap.declare("sap.apb.SuperList");
8       jQuery.sap.require("sap.apb.library");
9       jQuery.sap.require("sap.ui.core.Control");
10      
11      /**
12       * Constructor for a new SuperList.
13       * 
14       * Accepts an object literal <code>mSettings</code> that defines initial 
15       * property values, aggregated and associated objects as well as event handlers. 
16       * 
17       * If the name of a setting is ambiguous (e.g. a property has the same name as an event), 
18       * then the framework assumes property, aggregation, association, event in that order. 
19       * To override this automatic resolution, one of the prefixes "aggregation:", "association:" 
20       * or "event:" can be added to the name of the setting (such a prefixed name must be
21       * enclosed in single or double quotes).
22       *
23       * The supported settings are:
24       * <ul>
25       * <li>Properties
26       * <ul>
27       * <li>{@link #getDataSource dataSource} : string</li>
28       * <li>height : sap.ui.core.CSSSize (default: '100%')</li>
29       * <li>{@link #getMetadataFile metadataFile} : sap.ui.core.URI</li>
30       * <li>{@link #getWidth width} : sap.ui.core.CSSSize (default: '100%')</li>
31       * <li>{@link #getReadRows readRows} : string (default: '200')</li></ul>
32       * </li>
33       * <li>Aggregations
34       * <ul></ul>
35       * </li>
36       * <li>Associations
37       * <ul></ul>
38       * </li>
39       * <li>Events
40       * <ul>
41       * <li>{@link sap.apb.SuperList#event:dataTableQuery dataTableQuery} : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]</li>
42       * <li>{@link sap.apb.SuperList#event:rowFocusChanged rowFocusChanged} : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]</li>
43       * <li>{@link sap.apb.SuperList#event:itemChanged itemChanged} : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]</li>
44       * <li>{@link sap.apb.SuperList#event:buttonClicked buttonClicked} : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]</li>
45       * <li>{@link sap.apb.SuperList#event:updateEnd updateEnd} : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]</li>
46       * <li>{@link sap.apb.SuperList#event:error error} : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]</li></ul>
47       * </li>
48       * </ul> 
49      
50       *
51       * @param {string} [sId] id for the new control, generated automatically if no id is given 
52       * @param {object} [mSettings] initial settings for the new control
53       *
54       * @class
55       * SuperList control
56       * @extends sap.ui.core.Control
57       *
58       * @author SAP AG 
59       * @version 1.0
60       *
61       * @constructor   
62       * @public
63       * @name sap.apb.SuperList
64       */
65      sap.ui.core.Control.extend("sap.apb.SuperList", { metadata : {
66      
67      	// ---- object ----
68      	publicMethods : [
69      		// methods
70      		"deleteRow", "drillBack", "filter", "getCurrentLevel", "getItem", "getNumberOfRows", "getRow", "insertRow", "refreshData", "load", "reset", "retrieve", "sort", "setItem", "update", "getObjectProperty", "setObjectProperty", "setData", "drillDown"
71      	],
72      
73      	// ---- control specific ----
74      	library : "sap.apb",
75      	properties : {
76      		"dataSource" : {type : "string", group : "", defaultValue : null},
77      		"height" : {type : "sap.ui.core.CSSSize", group : "Dimension", defaultValue : '100%'},
78      		"metadataFile" : {type : "sap.ui.core.URI", group : "", defaultValue : null},
79      		"width" : {type : "sap.ui.core.CSSSize", group : "Dimension", defaultValue : '100%'},
80      		"readRows" : {type : "string", group : "Misc", defaultValue : '200'}
81      	},
82      	events : {
83      		"dataTableQuery" : {}, 
84      		"rowFocusChanged" : {}, 
85      		"itemChanged" : {}, 
86      		"buttonClicked" : {}, 
87      		"updateEnd" : {}, 
88      		"error" : {}
89      	}
90      }});
91      
92      
93      /**
94       * Creates a new subclass of class sap.apb.SuperList with name <code>sClassName</code> 
95       * and enriches it with the information contained in <code>oClassInfo</code>.
96       * 
97       * <code>oClassInfo</code> might contain the same kind of informations as described in {@link sap.ui.core.Element.extend Element.extend}.
98       *   
99       * @param {string} sClassName name of the class to be created
100      * @param {object} [oClassInfo] object literal with informations about the class  
101      * @param {function} [FNMetaImpl] constructor function for the metadata object. If not given, it defaults to sap.ui.core.ElementMetadata.
102      * @return {function} the created class / constructor function
103      * @public
104      * @static
105      * @name sap.apb.SuperList.extend
106      * @function
107      */
108     
109     sap.apb.SuperList.M_EVENTS = {'dataTableQuery':'dataTableQuery','rowFocusChanged':'rowFocusChanged','itemChanged':'itemChanged','buttonClicked':'buttonClicked','updateEnd':'updateEnd','error':'error'};
110     
111     
112     /**
113      * Getter for property <code>dataSource</code>.
114      * DataSource name of the SuperList
115      *
116      * Default value is empty/<code>undefined</code>
117      *
118      * @return {string} the value of property <code>dataSource</code>
119      * @public
120      * @name sap.apb.SuperList#getDataSource
121      * @function
122      */
123     
124     /**
125      * Setter for property <code>dataSource</code>.
126      *
127      * Default value is empty/<code>undefined</code> 
128      *
129      * @param {string} sDataSource  new value for property <code>dataSource</code>
130      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
131      * @public
132      * @name sap.apb.SuperList#setDataSource
133      * @function
134      */
135     
136     
137     /**
138      * Getter for property <code>height</code>.
139      * The height of the SuperList
140      *
141      * Default value is <code>100%</code>
142      *
143      * @return {sap.ui.core.CSSSize} the value of property <code>height</code>
144      * @public
145      * @name sap.apb.SuperList#getHeight
146      * @function
147      */
148     
149     /**
150      * Setter for property <code>height</code>.
151      *
152      * Default value is <code>100%</code> 
153      *
154      * @param {sap.ui.core.CSSSize} sHeight  new value for property <code>height</code>
155      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
156      * @public
157      * @name sap.apb.SuperList#setHeight
158      * @function
159      */
160     
161     
162     /**
163      * Getter for property <code>metadataFile</code>.
164      * Metadata file name of the SuperList
165      *
166      * Default value is empty/<code>undefined</code>
167      *
168      * @return {sap.ui.core.URI} the value of property <code>metadataFile</code>
169      * @public
170      * @name sap.apb.SuperList#getMetadataFile
171      * @function
172      */
173     
174     /**
175      * Setter for property <code>metadataFile</code>.
176      *
177      * Default value is empty/<code>undefined</code> 
178      *
179      * @param {sap.ui.core.URI} sMetadataFile  new value for property <code>metadataFile</code>
180      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
181      * @public
182      * @name sap.apb.SuperList#setMetadataFile
183      * @function
184      */
185     
186     
187     /**
188      * Getter for property <code>width</code>.
189      * The width of the SuperList
190      *
191      * Default value is <code>100%</code>
192      *
193      * @return {sap.ui.core.CSSSize} the value of property <code>width</code>
194      * @public
195      * @name sap.apb.SuperList#getWidth
196      * @function
197      */
198     
199     /**
200      * Setter for property <code>width</code>.
201      *
202      * Default value is <code>100%</code> 
203      *
204      * @param {sap.ui.core.CSSSize} sWidth  new value for property <code>width</code>
205      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
206      * @public
207      * @name sap.apb.SuperList#setWidth
208      * @function
209      */
210     
211     
212     /**
213      * Getter for property <code>readRows</code>.
214      * The default number of rows of dara is retrieved for the SuperList
215      *
216      * Default value is <code>200</code>
217      *
218      * @return {string} the value of property <code>readRows</code>
219      * @public
220      * @name sap.apb.SuperList#getReadRows
221      * @function
222      */
223     
224     /**
225      * Setter for property <code>readRows</code>.
226      *
227      * Default value is <code>200</code> 
228      *
229      * @param {string} sReadRows  new value for property <code>readRows</code>
230      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
231      * @public
232      * @name sap.apb.SuperList#setReadRows
233      * @function
234      */
235     
236     
237     /**
238      * This event is triggered when the memory data is required. The args consists of url and retrieveArgs. 
239      *
240      * @name sap.apb.SuperList#dataTableQuery
241      * @event
242      * @param {sap.ui.base.Event} oControlEvent
243      * @param {sap.ui.base.EventProvider} oControlEvent.getSource
244      * @param {object} oControlEvent.getParameters
245     
246      * @public
247      */
248      
249     /**
250      * Attach event handler <code>fnFunction</code> to the 'dataTableQuery' event of this <code>sap.apb.SuperList</code>.<br/>.
251      * When called, the context of the event handler (its <code>this</code>) will be bound to <code>oListener<code> if specified
252      * otherwise to this <code>sap.apb.SuperList</code>.<br/> itself. 
253      *  
254      * This event is triggered when the memory data is required. The args consists of url and retrieveArgs. 
255      *
256      * @param {object}
257      *            [oData] An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
258      * @param {function}
259      *            fnFunction The function to call, when the event occurs.  
260      * @param {object}
261      *            [oListener=this] Context object to call the event handler with. Defaults to this <code>sap.apb.SuperList</code>.<br/> itself.
262      *
263      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
264      * @public
265      * @name sap.apb.SuperList#attachDataTableQuery
266      * @function
267      */
268     
269     /**
270      * Detach event handler <code>fnFunction</code> from the 'dataTableQuery' event of this <code>sap.apb.SuperList</code>.<br/>
271      *
272      * The passed function and listener object must match the ones used for event registration.
273      *
274      * @param {function}
275      *            fnFunction The function to call, when the event occurs.
276      * @param {object}
277      *            oListener Context object on which the given function had to be called.
278      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
279      * @public
280      * @name sap.apb.SuperList#detachDataTableQuery
281      * @function
282      */
283     
284     /**
285      * Fire event dataTableQuery to attached listeners.
286     
287      * @param {Map} [mArguments] the arguments to pass along with the event.
288      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
289      * @protected
290      * @name sap.apb.SuperList#fireDataTableQuery
291      * @function
292      */
293     
294     
295     /**
296      * This event is triggered when the row focus is changed. The args consists of id & row. 
297      *
298      * @name sap.apb.SuperList#rowFocusChanged
299      * @event
300      * @param {sap.ui.base.Event} oControlEvent
301      * @param {sap.ui.base.EventProvider} oControlEvent.getSource
302      * @param {object} oControlEvent.getParameters
303     
304      * @public
305      */
306      
307     /**
308      * Attach event handler <code>fnFunction</code> to the 'rowFocusChanged' event of this <code>sap.apb.SuperList</code>.<br/>.
309      * When called, the context of the event handler (its <code>this</code>) will be bound to <code>oListener<code> if specified
310      * otherwise to this <code>sap.apb.SuperList</code>.<br/> itself. 
311      *  
312      * This event is triggered when the row focus is changed. The args consists of id & row. 
313      *
314      * @param {object}
315      *            [oData] An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
316      * @param {function}
317      *            fnFunction The function to call, when the event occurs.  
318      * @param {object}
319      *            [oListener=this] Context object to call the event handler with. Defaults to this <code>sap.apb.SuperList</code>.<br/> itself.
320      *
321      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
322      * @public
323      * @name sap.apb.SuperList#attachRowFocusChanged
324      * @function
325      */
326     
327     /**
328      * Detach event handler <code>fnFunction</code> from the 'rowFocusChanged' event of this <code>sap.apb.SuperList</code>.<br/>
329      *
330      * The passed function and listener object must match the ones used for event registration.
331      *
332      * @param {function}
333      *            fnFunction The function to call, when the event occurs.
334      * @param {object}
335      *            oListener Context object on which the given function had to be called.
336      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
337      * @public
338      * @name sap.apb.SuperList#detachRowFocusChanged
339      * @function
340      */
341     
342     /**
343      * Fire event rowFocusChanged to attached listeners.
344     
345      * @param {Map} [mArguments] the arguments to pass along with the event.
346      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
347      * @protected
348      * @name sap.apb.SuperList#fireRowFocusChanged
349      * @function
350      */
351     
352     
353     /**
354      * This event is triggered when the value of (input, select, checkbox) contol is changed. The args consists of row, column & value. 
355      *
356      * @name sap.apb.SuperList#itemChanged
357      * @event
358      * @param {sap.ui.base.Event} oControlEvent
359      * @param {sap.ui.base.EventProvider} oControlEvent.getSource
360      * @param {object} oControlEvent.getParameters
361     
362      * @public
363      */
364      
365     /**
366      * Attach event handler <code>fnFunction</code> to the 'itemChanged' event of this <code>sap.apb.SuperList</code>.<br/>.
367      * When called, the context of the event handler (its <code>this</code>) will be bound to <code>oListener<code> if specified
368      * otherwise to this <code>sap.apb.SuperList</code>.<br/> itself. 
369      *  
370      * This event is triggered when the value of (input, select, checkbox) contol is changed. The args consists of row, column & value. 
371      *
372      * @param {object}
373      *            [oData] An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
374      * @param {function}
375      *            fnFunction The function to call, when the event occurs.  
376      * @param {object}
377      *            [oListener=this] Context object to call the event handler with. Defaults to this <code>sap.apb.SuperList</code>.<br/> itself.
378      *
379      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
380      * @public
381      * @name sap.apb.SuperList#attachItemChanged
382      * @function
383      */
384     
385     /**
386      * Detach event handler <code>fnFunction</code> from the 'itemChanged' event of this <code>sap.apb.SuperList</code>.<br/>
387      *
388      * The passed function and listener object must match the ones used for event registration.
389      *
390      * @param {function}
391      *            fnFunction The function to call, when the event occurs.
392      * @param {object}
393      *            oListener Context object on which the given function had to be called.
394      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
395      * @public
396      * @name sap.apb.SuperList#detachItemChanged
397      * @function
398      */
399     
400     /**
401      * Fire event itemChanged to attached listeners.
402     
403      * @param {Map} [mArguments] the arguments to pass along with the event.
404      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
405      * @protected
406      * @name sap.apb.SuperList#fireItemChanged
407      * @function
408      */
409     
410     
411     /**
412      * This event is triggered when the button is clicked. The args consists of action, row and dataRow. 
413      *
414      * @name sap.apb.SuperList#buttonClicked
415      * @event
416      * @param {sap.ui.base.Event} oControlEvent
417      * @param {sap.ui.base.EventProvider} oControlEvent.getSource
418      * @param {object} oControlEvent.getParameters
419     
420      * @public
421      */
422      
423     /**
424      * Attach event handler <code>fnFunction</code> to the 'buttonClicked' event of this <code>sap.apb.SuperList</code>.<br/>.
425      * When called, the context of the event handler (its <code>this</code>) will be bound to <code>oListener<code> if specified
426      * otherwise to this <code>sap.apb.SuperList</code>.<br/> itself. 
427      *  
428      * This event is triggered when the button is clicked. The args consists of action, row and dataRow. 
429      *
430      * @param {object}
431      *            [oData] An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
432      * @param {function}
433      *            fnFunction The function to call, when the event occurs.  
434      * @param {object}
435      *            [oListener=this] Context object to call the event handler with. Defaults to this <code>sap.apb.SuperList</code>.<br/> itself.
436      *
437      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
438      * @public
439      * @name sap.apb.SuperList#attachButtonClicked
440      * @function
441      */
442     
443     /**
444      * Detach event handler <code>fnFunction</code> from the 'buttonClicked' event of this <code>sap.apb.SuperList</code>.<br/>
445      *
446      * The passed function and listener object must match the ones used for event registration.
447      *
448      * @param {function}
449      *            fnFunction The function to call, when the event occurs.
450      * @param {object}
451      *            oListener Context object on which the given function had to be called.
452      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
453      * @public
454      * @name sap.apb.SuperList#detachButtonClicked
455      * @function
456      */
457     
458     /**
459      * Fire event buttonClicked to attached listeners.
460     
461      * @param {Map} [mArguments] the arguments to pass along with the event.
462      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
463      * @protected
464      * @name sap.apb.SuperList#fireButtonClicked
465      * @function
466      */
467     
468     
469     /**
470      * This event is triggered when the data source update is completed. 
471      *
472      * @name sap.apb.SuperList#updateEnd
473      * @event
474      * @param {sap.ui.base.Event} oControlEvent
475      * @param {sap.ui.base.EventProvider} oControlEvent.getSource
476      * @param {object} oControlEvent.getParameters
477     
478      * @public
479      */
480      
481     /**
482      * Attach event handler <code>fnFunction</code> to the 'updateEnd' event of this <code>sap.apb.SuperList</code>.<br/>.
483      * When called, the context of the event handler (its <code>this</code>) will be bound to <code>oListener<code> if specified
484      * otherwise to this <code>sap.apb.SuperList</code>.<br/> itself. 
485      *  
486      * This event is triggered when the data source update is completed. 
487      *
488      * @param {object}
489      *            [oData] An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
490      * @param {function}
491      *            fnFunction The function to call, when the event occurs.  
492      * @param {object}
493      *            [oListener=this] Context object to call the event handler with. Defaults to this <code>sap.apb.SuperList</code>.<br/> itself.
494      *
495      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
496      * @public
497      * @name sap.apb.SuperList#attachUpdateEnd
498      * @function
499      */
500     
501     /**
502      * Detach event handler <code>fnFunction</code> from the 'updateEnd' event of this <code>sap.apb.SuperList</code>.<br/>
503      *
504      * The passed function and listener object must match the ones used for event registration.
505      *
506      * @param {function}
507      *            fnFunction The function to call, when the event occurs.
508      * @param {object}
509      *            oListener Context object on which the given function had to be called.
510      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
511      * @public
512      * @name sap.apb.SuperList#detachUpdateEnd
513      * @function
514      */
515     
516     /**
517      * Fire event updateEnd to attached listeners.
518     
519      * @param {Map} [mArguments] the arguments to pass along with the event.
520      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
521      * @protected
522      * @name sap.apb.SuperList#fireUpdateEnd
523      * @function
524      */
525     
526     
527     /**
528      * This event is triggered when the row focus is changed. The args consists of message. 
529      *
530      * @name sap.apb.SuperList#error
531      * @event
532      * @param {sap.ui.base.Event} oControlEvent
533      * @param {sap.ui.base.EventProvider} oControlEvent.getSource
534      * @param {object} oControlEvent.getParameters
535     
536      * @public
537      */
538      
539     /**
540      * Attach event handler <code>fnFunction</code> to the 'error' event of this <code>sap.apb.SuperList</code>.<br/>.
541      * When called, the context of the event handler (its <code>this</code>) will be bound to <code>oListener<code> if specified
542      * otherwise to this <code>sap.apb.SuperList</code>.<br/> itself. 
543      *  
544      * This event is triggered when the row focus is changed. The args consists of message. 
545      *
546      * @param {object}
547      *            [oData] An application specific payload object, that will be passed to the event handler along with the event object when firing the event.
548      * @param {function}
549      *            fnFunction The function to call, when the event occurs.  
550      * @param {object}
551      *            [oListener=this] Context object to call the event handler with. Defaults to this <code>sap.apb.SuperList</code>.<br/> itself.
552      *
553      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
554      * @public
555      * @name sap.apb.SuperList#attachError
556      * @function
557      */
558     
559     /**
560      * Detach event handler <code>fnFunction</code> from the 'error' event of this <code>sap.apb.SuperList</code>.<br/>
561      *
562      * The passed function and listener object must match the ones used for event registration.
563      *
564      * @param {function}
565      *            fnFunction The function to call, when the event occurs.
566      * @param {object}
567      *            oListener Context object on which the given function had to be called.
568      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
569      * @public
570      * @name sap.apb.SuperList#detachError
571      * @function
572      */
573     
574     /**
575      * Fire event error to attached listeners.
576     
577      * @param {Map} [mArguments] the arguments to pass along with the event.
578      * @return {sap.apb.SuperList} <code>this</code> to allow method chaining
579      * @protected
580      * @name sap.apb.SuperList#fireError
581      * @function
582      */
583     
584     
585     /**
586      * Deletes a row.
587      *
588      * @name sap.apb.SuperList.prototype.deleteRow
589      * @function
590      * @param {int} 
591      *         iRow
592      *         row index
593     
594      * @type boolean
595      * @public
596      */
597     
598     
599     /**
600      * Drills back to prior level
601      *
602      * @name sap.apb.SuperList.prototype.drillBack
603      * @function
604     
605      * @type boolean
606      * @public
607      */
608     
609     
610     /**
611      * Filters the rows. Rows that do not meet the filter criteria are moved to the filtered buffer.
612      *
613      * @name sap.apb.SuperList.prototype.filter
614      * @function
615      * @param {string} 
616      *         sExpr
617      *         Expression of the filter
618     
619      * @type boolean
620      * @public
621      */
622     
623     
624     /**
625      * Gets current level.
626      *
627      * @name sap.apb.SuperList.prototype.getCurrentLevel
628      * @function
629     
630      * @type int
631      * @public
632      */
633     
634     
635     /**
636      * Gets the value of item.
637      *
638      * @name sap.apb.SuperList.prototype.getItem
639      * @function
640      * @param {int} 
641      *         iRow
642      *         row of the item
643      * @param {int} 
644      *         iCol
645      *         col of the item
646     
647      * @type any
648      * @public
649      */
650     
651     
652     /**
653      * Gets number of rows.
654      *
655      * @name sap.apb.SuperList.prototype.getNumberOfRows
656      * @function
657     
658      * @type int
659      * @public
660      */
661     
662     
663     /**
664      * Gets the values of row
665      *
666      * @name sap.apb.SuperList.prototype.getRow
667      * @function
668      * @param {int} 
669      *         iRow
670      *         
671     
672      * @type object
673      * @public
674      */
675     
676     
677     /**
678      * Inserts a row or appends a row if the input value is -1.
679      *
680      * @name sap.apb.SuperList.prototype.insertRow
681      * @function
682      * @param {object} 
683      *         oRow
684      *         
685     
686      * @type boolean
687      * @public
688      */
689     
690     
691     /**
692      * Retrieve data for the SuperList.
693      *
694      * @name sap.apb.SuperList.prototype.refreshData
695      * @function
696     
697      * @type boolean
698      * @public
699      */
700     
701     
702     /**
703      * Loads a metafile and creates a superlist object.
704      *
705      * @name sap.apb.SuperList.prototype.load
706      * @function
707      * @param {string} 
708      *         sUrl
709      *         The meta data file path to be loaded
710     
711      * @type boolean
712      * @public
713      */
714     
715     
716     /**
717      * Resets the data in datatable.
718      *
719      * @name sap.apb.SuperList.prototype.reset
720      * @function
721     
722      * @type boolean
723      * @public
724      */
725     
726     
727     /**
728      * Retrieves data.
729      *
730      * @name sap.apb.SuperList.prototype.retrieve
731      * @function
732      * @param {object} 
733      *         oArgs
734      *         Retrieve arguments
735     
736      * @type boolean
737      * @public
738      */
739     
740     
741     /**
742      * Sorts the row.
743      *
744      * @name sap.apb.SuperList.prototype.sort
745      * @function
746      * @param {string} 
747      *         sValue
748      *         sort value
749     
750      * @type boolean
751      * @public
752      */
753     
754     
755     /**
756      * Sets the value of a row and column.
757      *
758      * @name sap.apb.SuperList.prototype.setItem
759      * @function
760      * @param {int} 
761      *         iRow
762      *         The row of the item
763      * @param {int} 
764      *         iCol
765      *         The col of the item
766      * @param {object} 
767      *         oValue
768      *         The value to be set
769     
770      * @type boolean
771      * @public
772      */
773     
774     
775     /**
776      * Updates changes to data source.
777      *
778      * @name sap.apb.SuperList.prototype.update
779      * @function
780     
781      * @type boolean
782      * @public
783      */
784     
785     
786     /**
787      * Gets the value of property
788      *
789      * @name sap.apb.SuperList.prototype.getObjectProperty
790      * @function
791      * @param {string} 
792      *         sName
793      *         Name of the property
794     
795      * @type any
796      * @public
797      */
798     
799     
800     /**
801      * Sets value to property.
802      *
803      * @name sap.apb.SuperList.prototype.setObjectProperty
804      * @function
805      * @param {string} 
806      *         sName
807      *         Name of the property
808      * @param {string} 
809      *         sValue
810      *         The value to be set
811     
812      * @type boolean
813      * @public
814      */
815     
816     
817     /**
818      * Sets data to data table
819      *
820      * @name sap.apb.SuperList.prototype.setData
821      * @function
822      * @param {string} 
823      *         sValue
824      *         Thle value of the data
825      * @param {string} 
826      *         sId
827      *         The id of the data
828     
829      * @type boolean
830      * @public
831      */
832     
833     
834     /**
835      * Drills down to next level.
836      *
837      * @name sap.apb.SuperList.prototype.drillDown
838      * @function
839      * @param {int} 
840      *         iRow
841      *         row index
842     
843      * @type boolean
844      * @public
845      */
846     
847