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