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