Fix #5665 - pre-commit hooks for roojs
[roojs1] / docs / symbols / Roo.BasicLayoutRegion.json
1 {
2   "name" : "Roo.BasicLayoutRegion",
3   "augments" : [
4     "Roo.util.Observable"
5   ],
6   "desc" : "This class represents a lightweight region in a layout manager. This region does not move dom nodes\nand does not have a titlebar, tabs or any other features. All it does is size and position \npanels. To create a BasicLayoutRegion, add lightweight:true or basic:true to your regions config.",
7   "isSingleton" : false,
8   "isStatic" : false,
9   "isBuiltin" : false,
10   "memberOf" : "BasicLayoutRegion",
11   "example" : "",
12   "deprecated" : "",
13   "since" : "",
14   "see" : "",
15   "params" : [
16   ],
17   "returns" : [
18   ],
19   "config" : [
20     {
21       "name" : "listeners",
22       "type" : "Object",
23       "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>",
24       "memberOf" : "Roo.util.Observable",
25       "values" : [
26       ]
27     }
28   ],
29   "methods" : [
30     {
31       "name" : "isVisible",
32       "desc" : "Returns true if this region is currently visible.",
33       "isStatic" : false,
34       "isConstructor" : false,
35       "isPrivate" : false,
36       "memberOf" : "Roo.BasicLayoutRegion",
37       "example" : "",
38       "deprecated" : "",
39       "since" : "",
40       "see" : "",
41       "params" : [
42       ],
43       "returns" : [
44         {
45           "name" : "",
46           "type" : "Boolean",
47           "desc" : ""
48         }
49       ]
50     },
51     {
52       "name" : "getEl",
53       "desc" : "Returns the container element for this region.",
54       "isStatic" : false,
55       "isConstructor" : false,
56       "isPrivate" : false,
57       "memberOf" : "Roo.BasicLayoutRegion",
58       "example" : "",
59       "deprecated" : "",
60       "since" : "",
61       "see" : "",
62       "params" : [
63       ],
64       "returns" : [
65         {
66           "name" : "",
67           "type" : "Roo.Element",
68           "desc" : ""
69         }
70       ]
71     },
72     {
73       "name" : "hasPanel",
74       "desc" : "Returns true if the panel is in this region.",
75       "isStatic" : false,
76       "isConstructor" : false,
77       "isPrivate" : false,
78       "memberOf" : "Roo.BasicLayoutRegion",
79       "example" : "",
80       "deprecated" : "",
81       "since" : "",
82       "see" : "",
83       "params" : [
84         {
85           "name" : "panel",
86           "type" : "Number/String/ContentPanel",
87           "desc" : "The panels index, id or the panel itself",
88           "isOptional" : false
89         }
90       ],
91       "returns" : [
92         {
93           "name" : "",
94           "type" : "Boolean",
95           "desc" : ""
96         }
97       ]
98     },
99     {
100       "name" : "getActivePanel",
101       "desc" : "Get the active panel for this region.",
102       "isStatic" : false,
103       "isConstructor" : false,
104       "isPrivate" : false,
105       "memberOf" : "Roo.BasicLayoutRegion",
106       "example" : "",
107       "deprecated" : "",
108       "since" : "",
109       "see" : "",
110       "params" : [
111       ],
112       "returns" : [
113         {
114           "name" : "",
115           "type" : "Roo.ContentPanel",
116           "desc" : "The active panel or null"
117         }
118       ]
119     },
120     {
121       "name" : "resizeTo",
122       "desc" : "Resizes the region to the specified size. For vertical regions (west, east) this adjusts \nthe width, for horizontal (north, south) the height.",
123       "isStatic" : false,
124       "isConstructor" : false,
125       "isPrivate" : false,
126       "memberOf" : "Roo.BasicLayoutRegion",
127       "example" : "",
128       "deprecated" : "",
129       "since" : "",
130       "see" : "",
131       "params" : [
132         {
133           "name" : "newSize",
134           "type" : "Number",
135           "desc" : "The new width or height",
136           "isOptional" : false
137         }
138       ],
139       "returns" : [
140       ]
141     },
142     {
143       "name" : "showPanel",
144       "desc" : "Show the specified panel.",
145       "isStatic" : false,
146       "isConstructor" : false,
147       "isPrivate" : false,
148       "memberOf" : "Roo.BasicLayoutRegion",
149       "example" : "",
150       "deprecated" : "",
151       "since" : "",
152       "see" : "",
153       "params" : [
154         {
155           "name" : "panelId",
156           "type" : "Number/String/ContentPanel",
157           "desc" : "The panels index, id or the panel itself",
158           "isOptional" : false
159         }
160       ],
161       "returns" : [
162         {
163           "name" : "",
164           "type" : "Roo.ContentPanel",
165           "desc" : "The shown panel or null"
166         }
167       ]
168     },
169     {
170       "name" : "getPosition",
171       "desc" : "Returns this regions position (north/south/east/west/center).",
172       "isStatic" : false,
173       "isConstructor" : false,
174       "isPrivate" : false,
175       "memberOf" : "Roo.BasicLayoutRegion",
176       "example" : "",
177       "deprecated" : "",
178       "since" : "",
179       "see" : "",
180       "params" : [
181       ],
182       "returns" : [
183         {
184           "name" : "",
185           "type" : "String",
186           "desc" : ""
187         }
188       ]
189     },
190     {
191       "name" : "add",
192       "desc" : "Add the passed ContentPanel(s)",
193       "isStatic" : false,
194       "isConstructor" : false,
195       "isPrivate" : false,
196       "memberOf" : "Roo.BasicLayoutRegion",
197       "example" : "",
198       "deprecated" : "",
199       "since" : "",
200       "see" : "",
201       "params" : [
202         {
203           "name" : "panel",
204           "type" : "ContentPanel...",
205           "desc" : "The ContentPanel(s) to add (you can pass more than one)",
206           "isOptional" : false
207         }
208       ],
209       "returns" : [
210         {
211           "name" : "",
212           "type" : "Roo.ContentPanel",
213           "desc" : "The panel added (if only one was added)"
214         }
215       ]
216     },
217     {
218       "name" : "remove",
219       "desc" : "Removes the specified panel. If preservePanel is not true (either here or in the config), the panel is destroyed.",
220       "isStatic" : false,
221       "isConstructor" : false,
222       "isPrivate" : false,
223       "memberOf" : "Roo.BasicLayoutRegion",
224       "example" : "",
225       "deprecated" : "",
226       "since" : "",
227       "see" : "",
228       "params" : [
229         {
230           "name" : "panel",
231           "type" : "Number/String/ContentPanel",
232           "desc" : "The panels index, id or the panel itself",
233           "isOptional" : false
234         },
235         {
236           "name" : "preservePanel",
237           "type" : "Boolean",
238           "desc" : "Overrides the config preservePanel option",
239           "isOptional" : false
240         }
241       ],
242       "returns" : [
243         {
244           "name" : "",
245           "type" : "Roo.ContentPanel",
246           "desc" : "The panel that was removed"
247         }
248       ]
249     },
250     {
251       "name" : "getPanel",
252       "desc" : "Returns the panel specified or null if it's not in this region.",
253       "isStatic" : false,
254       "isConstructor" : false,
255       "isPrivate" : false,
256       "memberOf" : "Roo.BasicLayoutRegion",
257       "example" : "",
258       "deprecated" : "",
259       "since" : "",
260       "see" : "",
261       "params" : [
262         {
263           "name" : "panel",
264           "type" : "Number/String/ContentPanel",
265           "desc" : "The panels index, id or the panel itself",
266           "isOptional" : false
267         }
268       ],
269       "returns" : [
270         {
271           "name" : "",
272           "type" : "Roo.ContentPanel",
273           "desc" : ""
274         }
275       ]
276     },
277     {
278       "name" : "purgeListeners",
279       "desc" : "Removes all listeners for this object",
280       "isStatic" : false,
281       "isConstructor" : false,
282       "isPrivate" : false,
283       "memberOf" : "Roo.util.Observable",
284       "example" : "",
285       "deprecated" : "",
286       "since" : "",
287       "see" : "",
288       "params" : [
289       ],
290       "returns" : [
291       ]
292     },
293     {
294       "name" : "on",
295       "desc" : "Appends an event handler to this element (shorthand for addListener)",
296       "isStatic" : false,
297       "isConstructor" : false,
298       "isPrivate" : false,
299       "memberOf" : "Roo.util.Observable",
300       "example" : "",
301       "deprecated" : "",
302       "since" : "",
303       "see" : "",
304       "params" : [
305         {
306           "name" : "eventName",
307           "type" : "String",
308           "desc" : "The type of event to listen for",
309           "isOptional" : false
310         },
311         {
312           "name" : "handler",
313           "type" : "Function",
314           "desc" : "The method the event invokes",
315           "isOptional" : false
316         },
317         {
318           "name" : "scope",
319           "type" : "Object",
320           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
321           "isOptional" : false
322         },
323         {
324           "name" : "options",
325           "type" : "Object",
326           "desc" : "(optional)",
327           "isOptional" : false
328         }
329       ],
330       "returns" : [
331       ]
332     },
333     {
334       "name" : "un",
335       "desc" : "Removes a listener (shorthand for removeListener)",
336       "isStatic" : false,
337       "isConstructor" : false,
338       "isPrivate" : false,
339       "memberOf" : "Roo.util.Observable",
340       "example" : "",
341       "deprecated" : "",
342       "since" : "",
343       "see" : "",
344       "params" : [
345         {
346           "name" : "eventName",
347           "type" : "String",
348           "desc" : "The type of event to listen for",
349           "isOptional" : false
350         },
351         {
352           "name" : "handler",
353           "type" : "Function",
354           "desc" : "The handler to remove",
355           "isOptional" : false
356         },
357         {
358           "name" : "scope",
359           "type" : "Object",
360           "desc" : "(optional) The scope (this object) for the handler",
361           "isOptional" : false
362         }
363       ],
364       "returns" : [
365       ]
366     },
367     {
368       "name" : "addEvents",
369       "desc" : "Used to define events on this Observable",
370       "isStatic" : false,
371       "isConstructor" : false,
372       "isPrivate" : false,
373       "memberOf" : "Roo.util.Observable",
374       "example" : "",
375       "deprecated" : "",
376       "since" : "",
377       "see" : "",
378       "params" : [
379         {
380           "name" : "object",
381           "type" : "Object",
382           "desc" : "The object with the events defined",
383           "isOptional" : false
384         }
385       ],
386       "returns" : [
387       ]
388     },
389     {
390       "name" : "releaseCapture",
391       "desc" : "Removes <b>all</b> added captures from the Observable.",
392       "isStatic" : true,
393       "isConstructor" : false,
394       "isPrivate" : false,
395       "memberOf" : "Roo.util.Observable",
396       "example" : "",
397       "deprecated" : "",
398       "since" : "",
399       "see" : "",
400       "params" : [
401         {
402           "name" : "o",
403           "type" : "Observable",
404           "desc" : "The Observable to release",
405           "isOptional" : false
406         }
407       ],
408       "returns" : [
409       ]
410     },
411     {
412       "name" : "removeListener",
413       "desc" : "Removes a listener",
414       "isStatic" : false,
415       "isConstructor" : false,
416       "isPrivate" : false,
417       "memberOf" : "Roo.util.Observable",
418       "example" : "",
419       "deprecated" : "",
420       "since" : "",
421       "see" : "",
422       "params" : [
423         {
424           "name" : "eventName",
425           "type" : "String",
426           "desc" : "The type of event to listen for",
427           "isOptional" : false
428         },
429         {
430           "name" : "handler",
431           "type" : "Function",
432           "desc" : "The handler to remove",
433           "isOptional" : false
434         },
435         {
436           "name" : "scope",
437           "type" : "Object",
438           "desc" : "(optional) The scope (this object) for the handler",
439           "isOptional" : false
440         }
441       ],
442       "returns" : [
443       ]
444     },
445     {
446       "name" : "fireEvent",
447       "desc" : "Fires the specified event with the passed parameters (minus the event name).",
448       "isStatic" : false,
449       "isConstructor" : false,
450       "isPrivate" : false,
451       "memberOf" : "Roo.util.Observable",
452       "example" : "",
453       "deprecated" : "",
454       "since" : "",
455       "see" : "",
456       "params" : [
457         {
458           "name" : "eventName",
459           "type" : "String",
460           "desc" : "",
461           "isOptional" : false
462         },
463         {
464           "name" : "args",
465           "type" : "Object...",
466           "desc" : "Variable number of parameters are passed to handlers",
467           "isOptional" : false
468         }
469       ],
470       "returns" : [
471         {
472           "name" : "",
473           "type" : "Boolean",
474           "desc" : "returns false if any of the handlers return false otherwise it returns true"
475         }
476       ]
477     },
478     {
479       "name" : "hasListener",
480       "desc" : "Checks to see if this object has any listeners for a specified event",
481       "isStatic" : false,
482       "isConstructor" : false,
483       "isPrivate" : false,
484       "memberOf" : "Roo.util.Observable",
485       "example" : "",
486       "deprecated" : "",
487       "since" : "",
488       "see" : "",
489       "params" : [
490         {
491           "name" : "eventName",
492           "type" : "String",
493           "desc" : "The name of the event to check for",
494           "isOptional" : false
495         }
496       ],
497       "returns" : [
498         {
499           "name" : "",
500           "type" : "Boolean",
501           "desc" : "True if the event is being listened for, else false"
502         }
503       ]
504     },
505     {
506       "name" : "capture",
507       "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.",
508       "isStatic" : true,
509       "isConstructor" : false,
510       "isPrivate" : false,
511       "memberOf" : "Roo.util.Observable",
512       "example" : "",
513       "deprecated" : "",
514       "since" : "",
515       "see" : "",
516       "params" : [
517         {
518           "name" : "o",
519           "type" : "Observable",
520           "desc" : "The Observable to capture",
521           "isOptional" : false
522         },
523         {
524           "name" : "fn",
525           "type" : "Function",
526           "desc" : "The function to call",
527           "isOptional" : false
528         },
529         {
530           "name" : "scope",
531           "type" : "Object",
532           "desc" : "(optional) The scope (this object) for the fn",
533           "isOptional" : false
534         }
535       ],
536       "returns" : [
537       ]
538     },
539     {
540       "name" : "addListener",
541       "desc" : "Appends an event handler to this component",
542       "isStatic" : false,
543       "isConstructor" : false,
544       "isPrivate" : false,
545       "memberOf" : "Roo.util.Observable",
546       "example" : "",
547       "deprecated" : "",
548       "since" : "",
549       "see" : "",
550       "params" : [
551         {
552           "name" : "eventName",
553           "type" : "String",
554           "desc" : "The type of event to listen for",
555           "isOptional" : false
556         },
557         {
558           "name" : "handler",
559           "type" : "Function",
560           "desc" : "The method the event invokes",
561           "isOptional" : false
562         },
563         {
564           "name" : "scope",
565           "type" : "Object",
566           "desc" : "(optional) The scope in which to execute the handler\nfunction. The handler function's \"this\" context.",
567           "isOptional" : false
568         },
569         {
570           "name" : "options",
571           "type" : "Object",
572           "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>",
573           "isOptional" : false
574         }
575       ],
576       "returns" : [
577       ]
578     }
579   ],
580   "events" : [
581     {
582       "name" : "paneladded",
583       "desc" : "Fires when a panel is added.",
584       "memberOf" : "Roo.BasicLayoutRegion",
585       "example" : "",
586       "deprecated" : "",
587       "since" : "",
588       "see" : "",
589       "params" : [
590         {
591           "name" : "this",
592           "type" : "Roo.LayoutRegion",
593           "desc" : "",
594           "isOptional" : false
595         },
596         {
597           "name" : "panel",
598           "type" : "Roo.ContentPanel",
599           "desc" : "The panel",
600           "isOptional" : false
601         }
602       ],
603       "returns" : [
604       ]
605     },
606     {
607       "name" : "invalidated",
608       "desc" : "Fires when the layout for this region is changed.",
609       "memberOf" : "Roo.BasicLayoutRegion",
610       "example" : "",
611       "deprecated" : "",
612       "since" : "",
613       "see" : "",
614       "params" : [
615         {
616           "name" : "this",
617           "type" : "Roo.LayoutRegion",
618           "desc" : "",
619           "isOptional" : false
620         }
621       ],
622       "returns" : [
623       ]
624     },
625     {
626       "name" : "expanded",
627       "desc" : "Fires when this region is expanded.",
628       "memberOf" : "Roo.BasicLayoutRegion",
629       "example" : "",
630       "deprecated" : "",
631       "since" : "",
632       "see" : "",
633       "params" : [
634         {
635           "name" : "this",
636           "type" : "Roo.LayoutRegion",
637           "desc" : "",
638           "isOptional" : false
639         }
640       ],
641       "returns" : [
642       ]
643     },
644     {
645       "name" : "beforeremove",
646       "desc" : "Fires before a panel is removed (or closed). To cancel the removal set \"e.cancel = true\" on the event argument.",
647       "memberOf" : "Roo.BasicLayoutRegion",
648       "example" : "",
649       "deprecated" : "",
650       "since" : "",
651       "see" : "",
652       "params" : [
653         {
654           "name" : "this",
655           "type" : "Roo.LayoutRegion",
656           "desc" : "",
657           "isOptional" : false
658         },
659         {
660           "name" : "panel",
661           "type" : "Roo.ContentPanel",
662           "desc" : "The panel",
663           "isOptional" : false
664         },
665         {
666           "name" : "e",
667           "type" : "Object",
668           "desc" : "The cancel event object",
669           "isOptional" : false
670         }
671       ],
672       "returns" : [
673       ]
674     },
675     {
676       "name" : "collapsed",
677       "desc" : "Fires when this region is collapsed.",
678       "memberOf" : "Roo.BasicLayoutRegion",
679       "example" : "",
680       "deprecated" : "",
681       "since" : "",
682       "see" : "",
683       "params" : [
684         {
685           "name" : "this",
686           "type" : "Roo.LayoutRegion",
687           "desc" : "",
688           "isOptional" : false
689         }
690       ],
691       "returns" : [
692       ]
693     },
694     {
695       "name" : "panelremoved",
696       "desc" : "Fires when a panel is removed.",
697       "memberOf" : "Roo.BasicLayoutRegion",
698       "example" : "",
699       "deprecated" : "",
700       "since" : "",
701       "see" : "",
702       "params" : [
703         {
704           "name" : "this",
705           "type" : "Roo.LayoutRegion",
706           "desc" : "",
707           "isOptional" : false
708         },
709         {
710           "name" : "panel",
711           "type" : "Roo.ContentPanel",
712           "desc" : "The panel",
713           "isOptional" : false
714         }
715       ],
716       "returns" : [
717       ]
718     },
719     {
720       "name" : "beforecollapse",
721       "desc" : "Fires when this region before collapse.",
722       "memberOf" : "Roo.BasicLayoutRegion",
723       "example" : "",
724       "deprecated" : "",
725       "since" : "",
726       "see" : "",
727       "params" : [
728         {
729           "name" : "this",
730           "type" : "Roo.LayoutRegion",
731           "desc" : "",
732           "isOptional" : false
733         }
734       ],
735       "returns" : [
736       ]
737     },
738     {
739       "name" : "slidehide",
740       "desc" : "Fires when this region slides out of view.",
741       "memberOf" : "Roo.BasicLayoutRegion",
742       "example" : "",
743       "deprecated" : "",
744       "since" : "",
745       "see" : "",
746       "params" : [
747         {
748           "name" : "this",
749           "type" : "Roo.LayoutRegion",
750           "desc" : "",
751           "isOptional" : false
752         }
753       ],
754       "returns" : [
755       ]
756     },
757     {
758       "name" : "visibilitychange",
759       "desc" : "Fires when this region is shown or hidden",
760       "memberOf" : "Roo.BasicLayoutRegion",
761       "example" : "",
762       "deprecated" : "",
763       "since" : "",
764       "see" : "",
765       "params" : [
766         {
767           "name" : "this",
768           "type" : "Roo.LayoutRegion",
769           "desc" : "",
770           "isOptional" : false
771         },
772         {
773           "name" : "visibility",
774           "type" : "Boolean",
775           "desc" : "true or false",
776           "isOptional" : false
777         }
778       ],
779       "returns" : [
780       ]
781     },
782     {
783       "name" : "slideshow",
784       "desc" : "Fires when this region is slid into view.",
785       "memberOf" : "Roo.BasicLayoutRegion",
786       "example" : "",
787       "deprecated" : "",
788       "since" : "",
789       "see" : "",
790       "params" : [
791         {
792           "name" : "this",
793           "type" : "Roo.LayoutRegion",
794           "desc" : "",
795           "isOptional" : false
796         }
797       ],
798       "returns" : [
799       ]
800     },
801     {
802       "name" : "panelactivated",
803       "desc" : "Fires when a panel is activated.",
804       "memberOf" : "Roo.BasicLayoutRegion",
805       "example" : "",
806       "deprecated" : "",
807       "since" : "",
808       "see" : "",
809       "params" : [
810         {
811           "name" : "this",
812           "type" : "Roo.LayoutRegion",
813           "desc" : "",
814           "isOptional" : false
815         },
816         {
817           "name" : "panel",
818           "type" : "Roo.ContentPanel",
819           "desc" : "The activated panel",
820           "isOptional" : false
821         }
822       ],
823       "returns" : [
824       ]
825     },
826     {
827       "name" : "resized",
828       "desc" : "Fires when the user resizes this region.",
829       "memberOf" : "Roo.BasicLayoutRegion",
830       "example" : "",
831       "deprecated" : "",
832       "since" : "",
833       "see" : "",
834       "params" : [
835         {
836           "name" : "this",
837           "type" : "Roo.LayoutRegion",
838           "desc" : "",
839           "isOptional" : false
840         },
841         {
842           "name" : "newSize",
843           "type" : "Number",
844           "desc" : "The new size (width for east/west, height for north/south)",
845           "isOptional" : false
846         }
847       ],
848       "returns" : [
849       ]
850     }
851   ]
852 }