Panel.html
79.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>The source code</title>
<link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
<script type="text/javascript" src="../resources/prettify/prettify.js"></script>
<style type="text/css">
.highlight { display: block; background-color: #ddd; }
</style>
<script type="text/javascript">
function highlight() {
document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
}
</script>
</head>
<body onload="prettyPrint(); highlight();">
<pre class="prettyprint lang-js"><span id='Ext-panel-Panel'>/**
</span> * Panel is a container that has specific functionality and structural components that make it the perfect building
* block for application-oriented user interfaces.
*
* Panels are, by virtue of their inheritance from {@link Ext.container.Container}, capable of being configured with a
* {@link Ext.container.Container#layout layout}, and containing child Components.
*
* When either specifying child {@link #cfg-items} of a Panel, or dynamically {@link Ext.container.Container#method-add adding}
* Components to a Panel, remember to consider how you wish the Panel to arrange those child elements, and whether those
* child elements need to be sized using one of Ext's built-in `{@link Ext.container.Container#layout layout}`
* schemes. By default, Panels use the {@link Ext.layout.container.Auto Auto} scheme. This simply renders child
* components, appending them one after the other inside the Container, and **does not apply any sizing** at all.
*
* {@img Ext.panel.Panel/panel.png Panel components}
*
* A Panel may also contain {@link #bbar bottom} and {@link #tbar top} toolbars, along with separate {@link
* Ext.panel.Header header}, {@link #fbar footer} and body sections.
*
* Panel also provides built-in {@link #collapsible collapsible, expandable} and {@link #closable} behavior. Panels can
* be easily dropped into any {@link Ext.container.Container Container} or layout, and the layout and rendering pipeline
* is {@link Ext.container.Container#method-add completely managed by the framework}.
*
* **Note:** By default, the `{@link #closable close}` header tool _destroys_ the Panel resulting in removal of the
* Panel and the destruction of any descendant Components. This makes the Panel object, and all its descendants
* **unusable**. To enable the close tool to simply _hide_ a Panel for later re-use, configure the Panel with
* `{@link #closeAction closeAction}: 'hide'`.
*
* Usually, Panels are used as constituents within an application, in which case, they would be used as child items of
* Containers, and would themselves use Ext.Components as child {@link #cfg-items}. However to illustrate simply rendering a
* Panel into the document, here's how to do it:
*
* @example
* Ext.create('Ext.panel.Panel', {
* title: 'Hello',
* width: 200,
* html: '<p>World!</p>',
* renderTo: Ext.getBody()
* });
*
* A more realistic scenario is a Panel created to house input fields which will not be rendered, but used as a
* constituent part of a Container:
*
* @example
* var filterPanel = Ext.create('Ext.panel.Panel', {
* bodyPadding: 5, // Don't want content to crunch against the borders
* width: 300,
* title: 'Filters',
* items: [{
* xtype: 'datefield',
* fieldLabel: 'Start date'
* }, {
* xtype: 'datefield',
* fieldLabel: 'End date'
* }],
* renderTo: Ext.getBody()
* });
*
* Note that the Panel above is configured to render into the document and assigned a size. In a real world scenario,
* the Panel will often be added inside a Container which will use a {@link #layout} to render, size and position its
* child Components.
*
* Panels will often use specific {@link #layout}s to provide an application with shape and structure by containing and
* arranging child Components:
*
* @example
* var resultsPanel = Ext.create('Ext.panel.Panel', {
* title: 'Results',
* width: 600,
* height: 400,
* renderTo: Ext.getBody(),
* layout: {
* type: 'vbox', // Arrange child items vertically
* align: 'stretch', // Each takes up full width
* padding: 5
* },
* items: [{ // Results grid specified as a config object with an xtype of 'grid'
* xtype: 'grid',
* columns: [{header: 'Column One'}], // One header just for show. There's no data,
* store: Ext.create('Ext.data.ArrayStore', {}), // A dummy empty data store
* flex: 1 // Use 1/3 of Container's height (hint to Box layout)
* }, {
* xtype: 'splitter' // A splitter between the two child items
* }, { // Details Panel specified as a config object (no xtype defaults to 'panel').
* title: 'Details',
* bodyPadding: 5,
* items: [{
* fieldLabel: 'Data item',
* xtype: 'textfield'
* }], // An array of form fields
* flex: 2 // Use 2/3 of Container's height (hint to Box layout)
* }]
* });
*
* The example illustrates one possible method of displaying search results. The Panel contains a grid with the
* resulting data arranged in rows. Each selected row may be displayed in detail in the Panel below. The {@link
* Ext.layout.container.VBox vbox} layout is used to arrange the two vertically. It is configured to stretch child items
* horizontally to full width. Child items may either be configured with a numeric height, or with a `flex` value to
* distribute available space proportionately.
*
* This Panel itself may be a child item of, for exaple, a {@link Ext.tab.Panel} which will size its child items to fit
* within its content area.
*
* Using these techniques, as long as the **layout** is chosen and configured correctly, an application may have any
* level of nested containment, all dynamically sized according to configuration, the user's preference and available
* browser size.
*/
Ext.define('Ext.panel.Panel', {
extend: 'Ext.panel.AbstractPanel',
requires: [
'Ext.panel.Header',
'Ext.fx.Anim',
'Ext.util.KeyMap',
'Ext.panel.DD',
'Ext.XTemplate',
'Ext.layout.component.Dock',
'Ext.util.Memento'
],
alias: 'widget.panel',
alternateClassName: 'Ext.Panel',
<span id='Ext-panel-Panel-cfg-collapsedCls'> /**
</span> * @cfg {String} collapsedCls
* A CSS class to add to the panel's element after it has been collapsed.
*/
collapsedCls: 'collapsed',
<span id='Ext-panel-Panel-cfg-animCollapse'> /**
</span> * @cfg {Boolean} animCollapse
* `true` to animate the transition when the panel is collapsed, `false` to skip the animation (defaults to `true`
* if the {@link Ext.fx.Anim} class is available, otherwise `false`). May also be specified as the animation
* duration in milliseconds.
*/
animCollapse: Ext.enableFx,
<span id='Ext-panel-Panel-cfg-minButtonWidth'> /**
</span> * @cfg {Number} minButtonWidth
* Minimum width of all footer toolbar buttons in pixels. If set, this will be used as the default
* value for the {@link Ext.button.Button#minWidth} config of each Button added to the **footer toolbar** via the
* {@link #fbar} or {@link #buttons} configurations. It will be ignored for buttons that have a minWidth configured
* some other way, e.g. in their own config object or via the {@link Ext.container.Container#defaults defaults} of
* their parent container.
*/
minButtonWidth: 75,
<span id='Ext-panel-Panel-cfg-collapsed'> /**
</span> * @cfg {Boolean} collapsed
* `true` to render the panel collapsed, `false` to render it expanded.
*/
collapsed: false,
<span id='Ext-panel-Panel-cfg-collapseFirst'> /**
</span> * @cfg {Boolean} collapseFirst
* `true` to make sure the collapse/expand toggle button always renders first (to the left of) any other tools in
* the panel's title bar, `false` to render it last.
*/
collapseFirst: true,
<span id='Ext-panel-Panel-cfg-hideCollapseTool'> /**
</span> * @cfg {Boolean} hideCollapseTool
* `true` to hide the expand/collapse toggle button when `{@link #collapsible} == true`, `false` to display it.
*/
hideCollapseTool: false,
<span id='Ext-panel-Panel-cfg-titleCollapse'> /**
</span> * @cfg {Boolean} titleCollapse
* `true` to allow expanding and collapsing the panel (when `{@link #collapsible} = true`) by clicking anywhere in
* the header bar, `false`) to allow it only by clicking to tool button).
*/
titleCollapse: false,
<span id='Ext-panel-Panel-cfg-collapseMode'> /**
</span> * @cfg {String} collapseMode
* **Important: this config is only effective for {@link #collapsible} Panels which are direct child items of a
* {@link Ext.layout.container.Border border layout}.**
*
* When _not_ a direct child item of a {@link Ext.layout.container.Border border layout}, then the Panel's header
* remains visible, and the body is collapsed to zero dimensions. If the Panel has no header, then a new header
* (orientated correctly depending on the {@link #collapseDirection}) will be inserted to show a the title and a re-
* expand tool.
*
* When a child item of a {@link Ext.layout.container.Border border layout}, this config has three possible values:
*
* - `undefined` - When collapsed, a placeholder {@link Ext.panel.Header Header} is injected into the layout to
* represent the Panel and to provide a UI with a Tool to allow the user to re-expand the Panel.
*
* - `"header"` - The Panel collapses to leave its header visible as when not inside a
* {@link Ext.layout.container.Border border layout}.
*
* - `"mini"` - The Panel collapses without a visible header.
*/
<span id='Ext-panel-Panel-cfg-placeholder'> /**
</span> * @cfg {Ext.Component/Object} placeholder
* **Important: This config is only effective for {@link #collapsible} Panels which are direct child items of a
* {@link Ext.layout.container.Border border layout} when not using the `'header'` {@link #collapseMode}.**
*
* **Optional.** A Component (or config object for a Component) to show in place of this Panel when this Panel is
* collapsed by a {@link Ext.layout.container.Border border layout}. Defaults to a generated {@link Ext.panel.Header
* Header} containing a {@link Ext.panel.Tool Tool} to re-expand the Panel.
*/
<span id='Ext-panel-Panel-cfg-floatable'> /**
</span> * @cfg {Boolean} floatable
* **Important: This config is only effective for {@link #collapsible} Panels which are direct child items of a
* {@link Ext.layout.container.Border border layout}.**
*
* true to allow clicking a collapsed Panel's {@link #placeholder} to display the Panel floated above the layout,
* false to force the user to fully expand a collapsed region by clicking the expand button to see it again.
*/
floatable: true,
<span id='Ext-panel-Panel-cfg-overlapHeader'> /**
</span> * @cfg {Boolean} overlapHeader
* True to overlap the header in a panel over the framing of the panel itself. This is needed when frame:true (and
* is done automatically for you). Otherwise it is undefined. If you manually add rounded corners to a panel header
* which does not have frame:true, this will need to be set to true.
*/
<span id='Ext-panel-Panel-cfg-collapsible'> /**
</span> * @cfg {Boolean} collapsible
* True to make the panel collapsible and have an expand/collapse toggle Tool added into the header tool button
* area. False to keep the panel sized either statically, or by an owning layout manager, with no toggle Tool.
*
* See {@link #collapseMode} and {@link #collapseDirection}
*/
collapsible: false,
<span id='Ext-panel-Panel-cfg-collapseDirection'> /**
</span> * @cfg {String} collapseDirection
* The direction to collapse the Panel when the toggle button is clicked.
*
* Defaults to the {@link #headerPosition}
*
* **Important: This config is _ignored_ for {@link #collapsible} Panels which are direct child items of a {@link
* Ext.layout.container.Border border layout}.**
*
* Specify as `'top'`, `'bottom'`, `'left'` or `'right'`.
*/
<span id='Ext-panel-Panel-cfg-closable'> /**
</span> * @cfg {Boolean} closable
* True to display the 'close' tool button and allow the user to close the window, false to hide the button and
* disallow closing the window.
*
* By default, when close is requested by clicking the close button in the header, the {@link #method-close} method will be
* called. This will _{@link Ext.Component#method-destroy destroy}_ the Panel and its content meaning that it may not be
* reused.
*
* To make closing a Panel _hide_ the Panel so that it may be reused, set {@link #closeAction} to 'hide'.
*/
closable: false,
<span id='Ext-panel-Panel-cfg-closeAction'> /**
</span> * @cfg {String} closeAction
* The action to take when the close header tool is clicked:
*
* - **`'{@link #method-destroy}'`** :
*
* {@link #method-remove remove} the window from the DOM and {@link Ext.Component#method-destroy destroy} it and all descendant
* Components. The window will **not** be available to be redisplayed via the {@link #method-show} method.
*
* - **`'{@link #method-hide}'`** :
*
* {@link #method-hide} the window by setting visibility to hidden and applying negative offsets. The window will be
* available to be redisplayed via the {@link #method-show} method.
*
* **Note:** This behavior has changed! setting *does* affect the {@link #method-close} method which will invoke the
* approriate closeAction.
*/
closeAction: 'destroy',
<span id='Ext-panel-Panel-cfg-dockedItems'> /**
</span> * @cfg {Object/Object[]} dockedItems
* A component or series of components to be added as docked items to this panel. The docked items can be docked to
* either the top, right, left or bottom of a panel. This is typically used for things like toolbars or tab bars:
*
* var panel = new Ext.panel.Panel({
* dockedItems: [{
* xtype: 'toolbar',
* dock: 'top',
* items: [{
* text: 'Docked to the top'
* }]
* }]
* });
*/
<span id='Ext-panel-Panel-cfg-placeholderCollapseHideMode'> /**
</span> * @cfg {Number} placeholderCollapseHideMode
* The {@link Ext.dom.Element#setVisibilityMode mode} for hiding collapsed panels when
* using {@link #collapseMode} "placeholder".
*/
placeholderCollapseHideMode: Ext.Element.VISIBILITY,
<span id='Ext-panel-Panel-cfg-preventHeader'> /**
</span> * @cfg {Boolean} preventHeader
* @deprecated 4.1.0 Use {@link #header} instead.
* Prevent a Header from being created and shown.
*/
preventHeader: false,
<span id='Ext-panel-Panel-cfg-header'> /**
</span> * @cfg {Boolean/Object} header
* Pass as `false` to prevent a Header from being created and shown.
*
* Pass as a config object (optionally containing an `xtype`) to custom-configure this Panel's header.
*
*/
header: undefined,
<span id='Ext-panel-Panel-cfg-headerPosition'> /**
</span> * @cfg {String} headerPosition
* Specify as `'top'`, `'bottom'`, `'left'` or `'right'`.
*/
headerPosition: 'top',
<span id='Ext-panel-Panel-cfg-frame'> /**
</span> * @cfg {Boolean} frame
* True to apply a frame to the panel.
*/
frame: false,
<span id='Ext-panel-Panel-cfg-frameHeader'> /**
</span> * @cfg {Boolean} frameHeader
* True to apply a frame to the panel panels header (if 'frame' is true).
*/
frameHeader: true,
<span id='Ext-panel-Panel-cfg-tools'> /**
</span> * @cfg {Object[]/Ext.panel.Tool[]} tools
* An array of {@link Ext.panel.Tool} configs/instances to be added to the header tool area. The tools are stored as
* child components of the header container. They can be accessed using {@link #down} and {#query}, as well as the
* other component methods. The toggle tool is automatically created if {@link #collapsible} is set to true.
*
* Note that, apart from the toggle tool which is provided when a panel is collapsible, these tools only provide the
* visual button. Any required functionality must be provided by adding handlers that implement the necessary
* behavior.
*
* Example usage:
*
* tools:[{
* type:'refresh',
* tooltip: 'Refresh form Data',
* // hidden:true,
* handler: function(event, toolEl, panel){
* // refresh logic
* }
* },
* {
* type:'help',
* tooltip: 'Get Help',
* handler: function(event, toolEl, panel){
* // show help here
* }
* }]
*/
<span id='Ext-panel-Panel-cfg-title'> /**
</span> * @cfg {String} [title='']
* The title text to be used to display in the {@link Ext.panel.Header panel header}. When a
* `title` is specified the {@link Ext.panel.Header} will automatically be created and displayed unless
* {@link #header} is set to `false`.
*/
<span id='Ext-panel-Panel-cfg-titleAlign'> /**
</span> * @cfg {String} [titleAlign='left']
* May be `"left"`, `"right"` or `"center"`.
*
* The alignment of the title text within the available space between the icon and the tools.
*/
titleAlign: 'left',
<span id='Ext-panel-Panel-cfg-manageHeight'> /**
</span> * @cfg {Boolean} [manageHeight=true]: When true, the dock component layout writes
* height information to the panel's DOM elements based on its shrink wrap height
* calculation. This ensures that the browser respects the calculated height.
* When false, the dock component layout will not write heights on the panel or its
* body element. In some simple layout cases, not writing the heights to the DOM may
* be desired because this allows the browser to respond to direct DOM manipulations
* (like animations).
*/
manageHeight: true,
<span id='Ext-panel-Panel-cfg-iconCls'> /**
</span> * @cfg {String} iconCls
* CSS class for an icon in the header. Used for displaying an icon to the left of a title.
*/
<span id='Ext-panel-Panel-cfg-icon'> /**
</span> * @cfg {String} icon
* Path to image for an icon in the header. Used for displaying an icon to the left of a title.
*/
initComponent: function() {
var me = this;
me.addEvents(
<span id='Ext-panel-Panel-event-beforeclose'> /**
</span> * @event beforeclose
* Fires before the user closes the panel. Return false from any listener to stop the close event being
* fired
* @param {Ext.panel.Panel} panel The Panel object
*/
'beforeclose',
<span id='Ext-panel-Panel-event-close'> /**
</span> * @event close
* Fires when the user closes the panel.
* @param {Ext.panel.Panel} panel The Panel object
*/
'close',
<span id='Ext-panel-Panel-event-beforeexpand'> /**
</span> * @event beforeexpand
* Fires before this panel is expanded. Return false to prevent the expand.
* @param {Ext.panel.Panel} p The Panel being expanded.
* @param {Boolean} animate True if the expand is animated, else false.
*/
"beforeexpand",
<span id='Ext-panel-Panel-event-beforecollapse'> /**
</span> * @event beforecollapse
* Fires before this panel is collapsed. Return false to prevent the collapse.
* @param {Ext.panel.Panel} p The Panel being collapsed.
* @param {String} direction . The direction of the collapse. One of
*
* - Ext.Component.DIRECTION_TOP
* - Ext.Component.DIRECTION_RIGHT
* - Ext.Component.DIRECTION_BOTTOM
* - Ext.Component.DIRECTION_LEFT
*
* @param {Boolean} animate True if the collapse is animated, else false.
*/
"beforecollapse",
<span id='Ext-panel-Panel-event-expand'> /**
</span> * @event expand
* Fires after this Panel has expanded.
* @param {Ext.panel.Panel} p The Panel that has been expanded.
*/
"expand",
<span id='Ext-panel-Panel-event-collapse'> /**
</span> * @event collapse
* Fires after this Panel hass collapsed.
* @param {Ext.panel.Panel} p The Panel that has been collapsed.
*/
"collapse",
<span id='Ext-panel-Panel-event-titlechange'> /**
</span> * @event titlechange
* Fires after the Panel title has been set or changed.
* @param {Ext.panel.Panel} p the Panel which has been resized.
* @param {String} newTitle The new title.
* @param {String} oldTitle The previous panel title.
*/
'titlechange',
<span id='Ext-panel-Panel-event-iconchange'> /**
</span> * @event iconchange
* Fires after the Panel icon has been set or changed.
* @param {Ext.panel.Panel} p The Panel which has the icon changed.
* @param {String} newIcon The path to the new icon image.
* @param {String} oldIcon The path to the previous panel icon image.
*/
'iconchange',
<span id='Ext-panel-Panel-event-iconclschange'> /**
</span> * @event iconclschange
* Fires after the Panel iconCls has been set or changed.
* @param {Ext.panel.Panel} p The Panel which has the iconCls changed.
* @param {String} newIconCls The new iconCls.
* @param {String} oldIconCls The previous panel iconCls.
*/
'iconclschange'
);
if (me.collapsible) {
// Save state on these two events.
this.addStateEvents(['expand', 'collapse']);
}
if (me.unstyled) {
me.setUI('plain');
}
if (me.frame) {
me.setUI(me.ui + '-framed');
}
// Backwards compatibility
me.bridgeToolbars();
me.callParent();
me.collapseDirection = me.collapseDirection || me.headerPosition || Ext.Component.DIRECTION_TOP;
// Used to track hidden content elements during collapsed state
me.hiddenOnCollapse = new Ext.dom.CompositeElement();
},
beforeDestroy: function() {
var me = this;
Ext.destroy(
me.placeholder,
me.ghostPanel,
me.dd
);
me.callParent();
},
initAria: function() {
this.callParent();
this.initHeaderAria();
},
getFocusEl: function() {
return this.el;
},
initHeaderAria: function() {
var me = this,
el = me.el,
header = me.header;
if (el && header) {
el.dom.setAttribute('aria-labelledby', header.titleCmp.id);
}
},
<span id='Ext-panel-Panel-method-getHeader'> /**
</span> * Gets the {@link Ext.panel.Header Header} for this panel.
*/
getHeader: function() {
return this.header;
},
<span id='Ext-panel-Panel-method-setTitle'> /**
</span> * Set a title for the panel's header. See {@link Ext.panel.Header#title}.
* @param {String} newTitle
*/
setTitle: function(newTitle) {
var me = this,
oldTitle = me.title,
header = me.header,
reExpander = me.reExpander,
placeholder = me.placeholder;
me.title = newTitle;
if (header) {
if (header.isHeader) {
header.setTitle(newTitle);
} else {
header.title = newTitle;
}
} else {
me.updateHeader();
}
if (reExpander) {
reExpander.setTitle(newTitle);
}
if (placeholder && placeholder.setTitle) {
placeholder.setTitle(newTitle);
}
me.fireEvent('titlechange', me, newTitle, oldTitle);
},
<span id='Ext-panel-Panel-method-setIconCls'> /**
</span> * Set the iconCls for the panel's header. See {@link Ext.panel.Header#iconCls}. It will fire the
* {@link #iconclschange} event after completion.
* @param {String} newIconCls The new CSS class name
*/
setIconCls: function(newIconCls) {
var me = this,
oldIconCls = me.iconCls,
header = me.header,
placeholder = me.placeholder;
me.iconCls = newIconCls;
if (header) {
if (header.isHeader) {
header.setIconCls(newIconCls);
} else {
header.iconCls = newIconCls;
}
} else {
me.updateHeader();
}
if (placeholder && placeholder.setIconCls) {
placeholder.setIconCls(newIconCls);
}
me.fireEvent('iconclschange', me, newIconCls, oldIconCls);
},
<span id='Ext-panel-Panel-method-setIcon'> /**
</span> * Set the icon for the panel's header. See {@link Ext.panel.Header#icon}. It will fire the
* {@link #iconchange} event after completion.
* @param {String} newIcon The new icon path
*/
setIcon: function(newIcon) {
var me = this,
oldIcon = me.icon,
header = me.header,
placeholder = me.placeholder;
me.icon = newIcon;
if (header) {
if (header.isHeader) {
header.setIcon(newIcon);
} else {
header.icon = newIcon;
}
} else {
me.updateHeader();
}
if (placeholder && placeholder.setIcon) {
placeholder.setIcon(newIcon);
}
me.fireEvent('iconchange', me, newIcon, oldIcon);
},
bridgeToolbars: function() {
var me = this,
docked = [],
fbar,
fbarDefaults,
minButtonWidth = me.minButtonWidth;
function initToolbar (toolbar, pos, useButtonAlign) {
if (Ext.isArray(toolbar)) {
toolbar = {
xtype: 'toolbar',
items: toolbar
};
}
else if (!toolbar.xtype) {
toolbar.xtype = 'toolbar';
}
toolbar.dock = pos;
if (pos == 'left' || pos == 'right') {
toolbar.vertical = true;
}
// Legacy support for buttonAlign (only used by buttons/fbar)
if (useButtonAlign) {
toolbar.layout = Ext.applyIf(toolbar.layout || {}, {
// default to 'end' (right-aligned) if me.buttonAlign is undefined or invalid
pack: { left:'start', center:'center' }[me.buttonAlign] || 'end'
});
}
return toolbar;
}
// Short-hand toolbars (tbar, bbar and fbar plus new lbar and rbar):
<span id='Ext-panel-Panel-cfg-buttonAlign'> /**
</span> * @cfg {String} buttonAlign
* The alignment of any buttons added to this panel. Valid values are 'right', 'left' and 'center' (defaults to
* 'right' for buttons/fbar, 'left' for other toolbar types).
*
* **NOTE:** The prefered way to specify toolbars is to use the dockedItems config. Instead of buttonAlign you
* would add the layout: { pack: 'start' | 'center' | 'end' } option to the dockedItem config.
*/
<span id='Ext-panel-Panel-cfg-tbar'> /**
</span> * @cfg {Object/Object[]} tbar
* Convenience config. Short for 'Top Bar'.
*
* tbar: [
* { xtype: 'button', text: 'Button 1' }
* ]
*
* is equivalent to
*
* dockedItems: [{
* xtype: 'toolbar',
* dock: 'top',
* items: [
* { xtype: 'button', text: 'Button 1' }
* ]
* }]
*/
if (me.tbar) {
docked.push(initToolbar(me.tbar, 'top'));
me.tbar = null;
}
<span id='Ext-panel-Panel-cfg-bbar'> /**
</span> * @cfg {Object/Object[]} bbar
* Convenience config. Short for 'Bottom Bar'.
*
* bbar: [
* { xtype: 'button', text: 'Button 1' }
* ]
*
* is equivalent to
*
* dockedItems: [{
* xtype: 'toolbar',
* dock: 'bottom',
* items: [
* { xtype: 'button', text: 'Button 1' }
* ]
* }]
*/
if (me.bbar) {
docked.push(initToolbar(me.bbar, 'bottom'));
me.bbar = null;
}
<span id='Ext-panel-Panel-cfg-buttons'> /**
</span> * @cfg {Object/Object[]} buttons
* Convenience config used for adding buttons docked to the bottom of the panel. This is a
* synonym for the {@link #fbar} config.
*
* buttons: [
* { text: 'Button 1' }
* ]
*
* is equivalent to
*
* dockedItems: [{
* xtype: 'toolbar',
* dock: 'bottom',
* ui: 'footer',
* defaults: {minWidth: {@link #minButtonWidth}},
* items: [
* { xtype: 'component', flex: 1 },
* { xtype: 'button', text: 'Button 1' }
* ]
* }]
*
* The {@link #minButtonWidth} is used as the default {@link Ext.button.Button#minWidth minWidth} for
* each of the buttons in the buttons toolbar.
*/
if (me.buttons) {
me.fbar = me.buttons;
me.buttons = null;
}
<span id='Ext-panel-Panel-cfg-fbar'> /**
</span> * @cfg {Object/Object[]} fbar
* Convenience config used for adding items to the bottom of the panel. Short for Footer Bar.
*
* fbar: [
* { type: 'button', text: 'Button 1' }
* ]
*
* is equivalent to
*
* dockedItems: [{
* xtype: 'toolbar',
* dock: 'bottom',
* ui: 'footer',
* defaults: {minWidth: {@link #minButtonWidth}},
* items: [
* { xtype: 'component', flex: 1 },
* { xtype: 'button', text: 'Button 1' }
* ]
* }]
*
* The {@link #minButtonWidth} is used as the default {@link Ext.button.Button#minWidth minWidth} for
* each of the buttons in the fbar.
*/
if (me.fbar) {
fbar = initToolbar(me.fbar, 'bottom', true); // only we useButtonAlign
fbar.ui = 'footer';
// Apply the minButtonWidth config to buttons in the toolbar
if (minButtonWidth) {
fbarDefaults = fbar.defaults;
fbar.defaults = function(config) {
var defaults = fbarDefaults || {};
if ((!config.xtype || config.xtype === 'button' || (config.isComponent && config.isXType('button'))) &&
!('minWidth' in defaults)) {
defaults = Ext.apply({minWidth: minButtonWidth}, defaults);
}
return defaults;
};
}
docked.push(fbar);
me.fbar = null;
}
<span id='Ext-panel-Panel-cfg-lbar'> /**
</span> * @cfg {Object/Object[]} lbar
* Convenience config. Short for 'Left Bar' (left-docked, vertical toolbar).
*
* lbar: [
* { xtype: 'button', text: 'Button 1' }
* ]
*
* is equivalent to
*
* dockedItems: [{
* xtype: 'toolbar',
* dock: 'left',
* items: [
* { xtype: 'button', text: 'Button 1' }
* ]
* }]
*/
if (me.lbar) {
docked.push(initToolbar(me.lbar, 'left'));
me.lbar = null;
}
<span id='Ext-panel-Panel-cfg-rbar'> /**
</span> * @cfg {Object/Object[]} rbar
* Convenience config. Short for 'Right Bar' (right-docked, vertical toolbar).
*
* rbar: [
* { xtype: 'button', text: 'Button 1' }
* ]
*
* is equivalent to
*
* dockedItems: [{
* xtype: 'toolbar',
* dock: 'right',
* items: [
* { xtype: 'button', text: 'Button 1' }
* ]
* }]
*/
if (me.rbar) {
docked.push(initToolbar(me.rbar, 'right'));
me.rbar = null;
}
if (me.dockedItems) {
if (!Ext.isArray(me.dockedItems)) {
me.dockedItems = [me.dockedItems];
}
me.dockedItems = me.dockedItems.concat(docked);
} else {
me.dockedItems = docked;
}
},
isPlaceHolderCollapse: function(){
return this.collapseMode == 'placeholder';
},
onBoxReady: function(){
this.callParent();
if (this.collapsed) {
this.setHiddenDocked();
}
},
beforeRender: function() {
var me = this,
wasCollapsed;
me.callParent();
// Add class-specific header tools.
// Panel adds collapsible and closable.
me.initTools();
// Dock the header/title unless we are configured specifically not to create a header
if (!(me.preventHeader || (me.header === false))) {
me.updateHeader();
}
// If we are rendering collapsed, we still need to save and modify various configs
if (me.collapsed) {
if (me.isPlaceHolderCollapse()) {
me.hidden = true;
// This will insert the placeholder Component into the ownerCt's child collection
// Its getRenderTree call which is calling this will then iterate again and
// recreate the child items array to include the new Component.
me.placeholderCollapse();
wasCollapsed = me.collapsed;
// Temporarily clear the flag so that the header is rendered with a collapse tool in it.
// Placeholder collapse panels never really collapse, they just hide. The tool is always
// a collapse tool.
me.collapsed = false;
} else {
me.beginCollapse();
me.addClsWithUI(me.collapsedCls);
}
}
// Restore the flag if we are being rendered initially placeholder collapsed.
if (wasCollapsed) {
me.collapsed = wasCollapsed;
}
},
<span id='Ext-panel-Panel-method-initTools'> /**
</span> * @private
* Tools are a Panel-specific capabilty.
* Panel uses initTools. Subclasses may contribute tools by implementing addTools.
*/
initTools: function() {
var me = this;
me.tools = me.tools ? Ext.Array.clone(me.tools) : [];
// Add a collapse tool unless configured to not show a collapse tool
// or to not even show a header.
if (me.collapsible && !(me.hideCollapseTool || me.header === false || me.preventHeader)) {
me.collapseDirection = me.collapseDirection || me.headerPosition || 'top';
me.collapseTool = me.expandTool = Ext.widget({
xtype: 'tool',
type: (me.collapsed && !me.isPlaceHolderCollapse()) ? ('expand-' + me.getOppositeDirection(me.collapseDirection)) : ('collapse-' + me.collapseDirection),
handler: me.toggleCollapse,
scope: me
});
// Prepend collapse tool is configured to do so.
if (me.collapseFirst) {
me.tools.unshift(me.collapseTool);
}
}
// Add subclass-specific tools.
me.addTools();
// Make Panel closable.
if (me.closable) {
me.addClsWithUI('closable');
me.addTool({
type: 'close',
handler: Ext.Function.bind(me.close, me, [])
});
}
// Append collapse tool if needed.
if (me.collapseTool && !me.collapseFirst) {
me.addTool(me.collapseTool);
}
},
<span id='Ext-panel-Panel-method-addTools'> /**
</span> * @private
* @template
* Template method to be implemented in subclasses to add their tools after the collapsible tool.
*/
addTools: Ext.emptyFn,
<span id='Ext-panel-Panel-method-close'> /**
</span> * Closes the Panel. By default, this method, removes it from the DOM, {@link Ext.Component#method-destroy destroy}s the
* Panel object and all its descendant Components. The {@link #beforeclose beforeclose} event is fired before the
* close happens and will cancel the close action if it returns false.
*
* **Note:** This method is also affected by the {@link #closeAction} setting. For more explicit control use
* {@link #method-destroy} and {@link #method-hide} methods.
*/
close: function() {
if (this.fireEvent('beforeclose', this) !== false) {
this.doClose();
}
},
// private
doClose: function() {
this.fireEvent('close', this);
this[this.closeAction]();
},
<span id='Ext-panel-Panel-method-updateHeader'> /**
</span> * Create, hide, or show the header component as appropriate based on the current config.
* @private
* @param {Boolean} force True to force the header to be created
*/
updateHeader: function(force) {
var me = this,
header = me.header,
title = me.title,
tools = me.tools,
icon = me.icon || me.iconCls,
vertical = me.headerPosition == 'left' || me.headerPosition == 'right';
if ((header !== false) && (force || (title || icon) || (tools && tools.length) || (me.collapsible && !me.titleCollapse))) {
if (header && header.isHeader) {
header.show();
} else {
// Apply the header property to the header config
header = me.header = Ext.widget(Ext.apply({
xtype : 'header',
title : title,
titleAlign : me.titleAlign,
orientation : vertical ? 'vertical' : 'horizontal',
dock : me.headerPosition || 'top',
textCls : me.headerTextCls,
iconCls : me.iconCls,
icon : me.icon,
baseCls : me.baseCls + '-header',
tools : tools,
ui : me.ui,
id : me.id + '_header',
indicateDrag: me.draggable,
frame : (me.frame || me.alwaysFramed) && me.frameHeader,
ignoreParentFrame : me.frame || me.overlapHeader,
ignoreBorderManagement: me.frame || me.ignoreHeaderBorderManagement,
listeners : me.collapsible && me.titleCollapse ? {
click: me.toggleCollapse,
scope: me
} : null
}, me.header));
me.addDocked(header, 0);
// Reference the Header's tool array.
// Header injects named references.
me.tools = header.tools;
}
me.initHeaderAria();
} else if (header) {
header.hide();
}
},
// inherit docs
setUI: function(ui) {
var me = this;
me.callParent(arguments);
if (me.header && me.header.rendered) {
me.header.setUI(ui);
}
},
// private
getContentTarget: function() {
return this.body;
},
getTargetEl: function() {
var me = this;
return me.body || me.protoBody || me.frameBody || me.el;
},
// the overrides below allow for collapsed regions inside the border layout to be hidden
// inherit docs
isVisible: function(deep){
var me = this;
if (me.collapsed && me.placeholder) {
return me.placeholder.isVisible(deep);
}
return me.callParent(arguments);
},
// inherit docs
onHide: function(){
var me = this;
if (me.collapsed && me.placeholder) {
me.placeholder.hide();
} else {
me.callParent(arguments);
}
},
// inherit docs
onShow: function(){
var me = this;
if (me.collapsed && me.placeholder) {
// force hidden back to true, since this gets set by the layout
me.hidden = true;
me.placeholder.show();
} else {
me.callParent(arguments);
}
},
onRemoved: function(destroying) {
var me = this;
me.callParent(arguments);
// If we are removed but not being destroyed, ensure our placeholder is also removed but not destroyed
// If we are being destroyed, our destroy processing will destroy the placeholder.
if (me.placeholder && !destroying) {
me.ownerCt.remove(me.placeholder, false);
}
},
addTool: function(tools) {
tools = [].concat(tools);
var me = this,
header = me.header,
t,
tLen = tools.length,
tool;
for (t = 0; t < tLen; t++) {
tool = tools[t];
me.tools.push(tool);
if (header && header.isHeader) {
header.addTool(tool);
}
}
me.updateHeader();
},
getOppositeDirection: function(d) {
var c = Ext.Component;
switch (d) {
case c.DIRECTION_TOP:
return c.DIRECTION_BOTTOM;
case c.DIRECTION_RIGHT:
return c.DIRECTION_LEFT;
case c.DIRECTION_BOTTOM:
return c.DIRECTION_TOP;
case c.DIRECTION_LEFT:
return c.DIRECTION_RIGHT;
}
},
getWidthAuthority: function() {
if (this.collapsed && this.collapsedHorizontal()) {
return 1; // the panel determine's its own width
}
return this.callParent();
},
getHeightAuthority: function() {
if (this.collapsed && this.collapsedVertical()) {
return 1; // the panel determine's its own height
}
return this.callParent();
},
collapsedHorizontal: function () {
var dir = this.getCollapsed();
return dir == 'left' || dir == 'right';
},
collapsedVertical: function () {
var dir = this.getCollapsed();
return dir == 'top' || dir == 'bottom';
},
restoreDimension: function(){
var dir = this.collapseDirection;
// If we're collapsing top/bottom, we want to restore the height
// If we're collapsing left/right, we want to restore the width
return (dir === 'top' || dir === 'bottom') ? 'height' : 'width';
},
<span id='Ext-panel-Panel-method-getCollapsed'> /**
</span> * Returns the current collapsed state of the panel.
* @return {Boolean/String} False when not collapsed, otherwise the value of {@link #collapseDirection}.
*/
getCollapsed: function() {
var me = this;
// The collapsed flag, when the Panel is collapsed acts as the direction in which the collapse took
// place. It can still be tested as truthy/falsy if only a truth value is required.
if (me.collapsed === true) {
return me.collapseDirection;
}
return me.collapsed;
},
getState: function() {
var me = this,
state = me.callParent(),
memento;
state = me.addPropertyToState(state, 'collapsed');
// If a collapse has taken place, use remembered values as the dimensions.
if (me.collapsed) {
memento = me.collapseMemento;
memento = memento && memento.data;
if (me.collapsedVertical()) {
if (state) {
delete state.height;
}
if (memento) {
state = me.addPropertyToState(state, 'height', memento.height);
}
} else {
if (state) {
delete state.width;
}
if (memento) {
state = me.addPropertyToState(state, 'width', memento.width);
}
}
}
return state;
},
findReExpander: function (direction) {
var me = this,
c = Ext.Component,
dockedItems = me.dockedItems.items,
dockedItemCount = dockedItems.length,
comp, i;
// never use the header if we're in collapseMode mini
if (me.collapseMode == 'mini') {
return;
}
switch (direction) {
case c.DIRECTION_TOP:
case c.DIRECTION_BOTTOM:
// Attempt to find a reExpander Component (docked in a horizontal orientation)
// Also, collect all other docked items which we must hide after collapse.
for (i = 0; i < dockedItemCount; i++) {
comp = dockedItems[i];
if (!comp.hidden) {
if (comp.isHeader && (!comp.dock || comp.dock == 'top' || comp.dock == 'bottom')) {
return comp;
}
}
}
break;
case c.DIRECTION_LEFT:
case c.DIRECTION_RIGHT:
// Attempt to find a reExpander Component (docked in a vecrtical orientation)
// Also, collect all other docked items which we must hide after collapse.
for (i = 0; i < dockedItemCount; i++) {
comp = dockedItems[i];
if (!comp.hidden) {
if (comp.isHeader && (comp.dock == 'left' || comp.dock == 'right')) {
return comp;
}
}
}
break;
default:
throw('Panel#findReExpander must be passed a valid collapseDirection');
}
},
getReExpander: function (direction) {
var me = this,
collapseDir = direction || me.collapseDirection,
reExpander = me.reExpander || me.findReExpander(collapseDir);
me.expandDirection = me.getOppositeDirection(collapseDir);
if (!reExpander) {
// We did not find a Header of the required orientation: create one.
me.reExpander = reExpander = me.createReExpander(collapseDir, {
dock: collapseDir,
cls: Ext.baseCSSPrefix + 'docked ' + me.baseCls + '-' + me.ui + '-collapsed',
ownerCt: me,
ownerLayout: me.componentLayout
});
me.dockedItems.insert(0, reExpander);
}
return reExpander;
},
createReExpander: function(direction, defaults) {
var me = this,
isLeft = direction == 'left',
isRight = direction == 'right',
isVertical = isLeft || isRight,
toolAtTop,
result = Ext.apply({
hideMode: 'offsets',
title: me.title,
orientation: isVertical ? 'vertical' : 'horizontal',
textCls: me.headerTextCls,
icon: me.icon,
iconCls: me.iconCls,
baseCls: me.baseCls + '-header',
ui: me.ui,
frame: me.frame && me.frameHeader,
ignoreParentFrame: me.frame || me.overlapHeader,
indicateDrag: me.draggable
}, defaults);
// If we're in mini mode, set the placeholder size to only 1px since
// we don't need it to show up.
if (me.collapseMode == 'mini') {
if (isVertical) {
result.width = 1;
} else {
result.height = 1;
}
}
// Create the re expand tool
// For UI consistency reasons, collapse:left reExpanders, and region: 'west' placeHolders
// have the re expand tool at the *top* with a bit of space.
if (!me.hideCollapseTool) {
toolAtTop = isLeft || (isRight && me.isPlaceHolderCollapse());
result[toolAtTop ? 'items' : 'tools'] = [{
xtype: 'tool',
type: 'expand-' + me.getOppositeDirection(direction),
uiCls: ['top'],
handler: me.toggleCollapse,
scope: me
}];
}
result = new Ext.panel.Header(result);
result.addClsWithUI(me.getHeaderCollapsedClasses(result));
return result;
},
// private
// Create the class array to add to the Header when collpsed.
getHeaderCollapsedClasses: function(header) {
var me = this,
collapsedCls = me.collapsedCls,
collapsedClasses;
collapsedClasses = [ collapsedCls, collapsedCls + '-' + header.dock];
if (me.border && (!me.frame || (me.frame && Ext.supports.CSS3BorderRadius))) {
collapsedClasses.push(collapsedCls + '-border-' + header.dock);
}
return collapsedClasses;
},
<span id='Ext-panel-Panel-method-beginCollapse'> /**
</span> * @private
* Called before the change from default, configured state into the collapsed state.
* This method may be called at render time to enable rendering in an initially collapsed state,
* or at runtime when an existing, fully layed out Panel may be collapsed.
* It basically saves configs which need to be clobbered for the duration of the collapsed state.
*/
beginCollapse: function() {
var me = this,
lastBox = me.lastBox,
rendered = me.rendered,
collapseMemento = me.collapseMemento || (me.collapseMemento = new Ext.util.Memento(me)),
sizeModel = me.getSizeModel(),
reExpander;
// When we collapse a panel, the panel is in control of one dimension (depending on
// collapse direction) and sets that on the component. We must restore the user's
// original value (including non-existance) when we expand. Using this technique, we
// mimic setCalculatedSize for the dimension we do not control and setSize for the
// one we do (only while collapsed).
// Additionally, the panel may have a shrink wrapped width and/or height. For shrinkWrapped
// panels this can be problematic, since a collapsed, shrink-wrapped panel has no way
// of determining its width (or height if the collapse direction is horizontal). It is
// therefore necessary to capture both the width and height regardless of collapse direction.
// This allows us to set a configured width or height on the panel when it is collapsed,
// and it will be restored to an unconfigured-width shrinkWrapped state on expand.
collapseMemento.capture(['height', 'minHeight', 'width', 'minWidth']);
if (lastBox) {
collapseMemento.capture(me.restoreDimension(), lastBox, 'last.');
}
// If the panel has a shrinkWrapped height/width and is already rendered, configure its width/height as its calculated width/height,
// so that the collapsed header will have the same width or height as the panel did before it was collapsed.
// If the shrinkWrapped panel has not yet been rendered, as will be the case when a panel is initially configured with
// collapsed:true, we attempt to use the configured width/height, and fall back to minWidth or minHeight if
// width/height has not been configured, and fall back to a value of 100 if a minWidth/minHeight has not been configured.
if (me.collapsedVertical()) {
if (sizeModel.width.shrinkWrap) {
me.width = rendered ? me.getWidth() : me.width || me.minWidth || 100;
}
delete me.height;
me.minHeight = 0;
} else if (me.collapsedHorizontal()) {
if (sizeModel.height.shrinkWrap) {
me.height = rendered ? me.getHeight() : me.height || me.minHeight || 100;
}
delete me.width;
me.minWidth = 0;
}
if (me.ownerCt) {
me.ownerCt.getLayout().beginCollapse(me);
}
// Get a reExpander header. This will return the Panel Header if the Header is in the correct orientation
// If we are using the Header as the reExpander, change its UI to collapsed state
if (!me.isPlaceHolderCollapse()) {
if (me.header === (reExpander = me.getReExpander())) {
me.header.addClsWithUI(me.getHeaderCollapsedClasses(me.header));
// Ensure that the reExpander has the correct framing applied.
if (me.header.rendered) {
me.header.updateFrame();
}
}
// We're going to use a temporary reExpander: show it.
else {
if (reExpander.el) {
reExpander.el.show();
reExpander.hidden = false;
}
}
}
if (me.resizer) {
me.resizer.disable();
}
},
beginExpand: function() {
var me = this,
lastBox = me.lastBox,
collapseMemento = me.collapseMemento,
restoreDimension = this.restoreDimension(),
reExpander;
collapseMemento.restore(['minHeight', 'minWidth', restoreDimension]);
if (lastBox) {
collapseMemento.restore(restoreDimension, true, lastBox, 'last.');
}
if (me.ownerCt) {
me.ownerCt.getLayout().beginExpand(me);
}
if (!me.isPlaceHolderCollapse()) {
// If we have been using our Header as the reExpander then restore the Header to expanded UI
if (me.header === (reExpander = me.getReExpander())) {
me.header.removeClsWithUI(me.getHeaderCollapsedClasses(me.header));
// Ensure that the reExpander has the correct framing applied.
if (me.header.rendered) {
me.header.updateFrame();
}
}
// We've been using a temporary reExpander: hide it.
else {
reExpander.hidden = true;
reExpander.el.hide();
}
}
if (me.resizer) {
me.resizer.enable();
}
},
<span id='Ext-panel-Panel-method-collapse'> /**
</span> * Collapses the panel body so that the body becomes hidden. Docked Components parallel to the border towards which
* the collapse takes place will remain visible. Fires the {@link #beforecollapse} event which will cancel the
* collapse action if it returns false.
*
* @param {String} [direction] The direction to collapse towards. Must be one of
*
* - Ext.Component.DIRECTION_TOP
* - Ext.Component.DIRECTION_RIGHT
* - Ext.Component.DIRECTION_BOTTOM
* - Ext.Component.DIRECTION_LEFT
*
* Defaults to {@link #collapseDirection}.
*
* @param {Boolean} [animate] True to animate the transition, else false (defaults to the value of the
* {@link #animCollapse} panel config)
* @return {Ext.panel.Panel} this
*/
collapse: function(direction, animate) {
var me = this,
collapseDir = direction || me.collapseDirection,
ownerCt = me.ownerCt;
if (me.isCollapsingOrExpanding) {
return me;
}
if (arguments.length < 2) {
animate = me.animCollapse;
}
if (me.collapsed || me.fireEvent('beforecollapse', me, direction, animate) === false) {
return me;
}
if (ownerCt && me.isPlaceHolderCollapse()) {
return me.placeholderCollapse(direction, animate);
}
me.collapsed = collapseDir;
me.beginCollapse();
me.fireHierarchyEvent('collapse');
return me.doCollapseExpand(1, animate);
},
doCollapseExpand: function (flags, animate) {
var me = this,
originalAnimCollapse = me.animCollapse,
ownerLayout = me.ownerLayout;
// we need to temporarily set animCollapse to the animate value here because ContextItem
// uses the animCollapse property to determine if the collapse/expand should be animated
me.animCollapse = animate;
// Flag used by the layouy ContextItem to impose an animation policy based upon the
// collapse direction and the animCollapse setting.
me.isCollapsingOrExpanding = flags;
if (ownerLayout && !animate) {
ownerLayout.onContentChange(me);
} else {
me.updateLayout({ isRoot: true });
}
// set animCollapse back to its original value
me.animCollapse = originalAnimCollapse;
return me;
},
<span id='Ext-panel-Panel-method-afterCollapse'> /**
</span> * Invoked after the Panel is Collapsed.
*
* @param {Boolean} animated
*
* @template
* @protected
*/
afterCollapse: function(animated) {
var me = this,
ownerLayout = me.ownerLayout;
me.isCollapsingOrExpanding = 0;
if (me.collapseTool) {
me.collapseTool.setType('expand-' + me.getOppositeDirection(me.collapseDirection));
}
if (ownerLayout && animated) {
ownerLayout.onContentChange(me);
}
me.setHiddenDocked();
me.fireEvent('collapse', me);
},
setHiddenDocked: function(){
// Hide Panel content except reExpander using visibility to prevent focusing of contained elements.
// Track what we hide to re-show on expand
var me = this,
toHide = me.hiddenOnCollapse,
reExpander = me.getReExpander(),
items = me.getDockedItems(),
len = items.length,
i = 0,
item;
toHide.add(me.body);
for (; i < len; i++) {
item = items[i];
if (item && item !== reExpander && item.el) {
toHide.add(item.el);
}
}
toHide.setStyle('visibility', 'hidden');
},
restoreHiddenDocked: function(){
var toShow = this.hiddenOnCollapse;
// Re-show Panel content which was hidden after collapse.
toShow.setStyle('visibility', '');
toShow.clear();
},
getPlaceholder: function(direction) {
var me = this,
collapseDir = direction || me.collapseDirection,
listeners = null,
placeholder = me.placeholder;
if (!placeholder) {
if (me.floatable || (me.collapsible && me.titleCollapse)) {
listeners = {
click: {
fn: me.floatable ? me.floatCollapsedPanel : me.toggleCollapse,
element: 'el',
scope: me
}
};
}
me.placeholder = placeholder = Ext.widget(me.createReExpander(collapseDir, {
id: me.id + '-placeholder',
listeners: listeners
}));
}
// User created placeholder was passed in
if (!placeholder.placeholderFor) {
// Handle the case of a placeholder config
if (!placeholder.isComponent) {
me.placeholder = placeholder = me.lookupComponent(placeholder);
}
Ext.applyIf(placeholder, {
margins: me.margins,
placeholderFor: me
});
placeholder.addCls([Ext.baseCSSPrefix + 'region-collapsed-placeholder', Ext.baseCSSPrefix + 'region-collapsed-' + collapseDir + '-placeholder', me.collapsedCls]);
}
return placeholder;
},
placeholderCollapse: function(direction, animate) {
var me = this,
ownerCt = me.ownerCt,
collapseDir = direction || me.collapseDirection,
floatCls = Ext.baseCSSPrefix + 'border-region-slide-in',
placeholder = me.getPlaceholder(direction);
me.isCollapsingOrExpanding = 1;
// Upcoming layout run will ignore this Component
me.hidden = true;
me.collapsed = collapseDir;
if (placeholder.rendered) {
// We may have been added to another Container from that in which we rendered the placeholder
if (placeholder.el.dom.parentNode !== me.el.dom.parentNode) {
me.el.dom.parentNode.insertBefore(placeholder.el.dom, me.el.dom);
}
placeholder.hidden = false;
placeholder.el.show();
ownerCt.updateLayout();
} else {
ownerCt.insert(ownerCt.items.indexOf(me), placeholder);
}
if (me.rendered) {
// We MUST NOT hide using display because that resets all scroll information.
me.el.setVisibilityMode(me.placeholderCollapseHideMode);
if (animate) {
me.el.addCls(floatCls);
placeholder.el.hide();
me.el.slideOut(collapseDir.substr(0, 1), {
preserveScroll: true,
duration: Ext.Number.from(animate, Ext.fx.Anim.prototype.duration),
listeners: {
afteranimate: function() {
me.el.removeCls(floatCls);
/* We need to show the element so that slideIn will work correctly. However, if we leave it
visible then it can be seen before the animation starts, causing a flicker. The solution,
borrowed from date picker, is to hide it using display none. The slideIn effect includes
a call to fixDisplay() that will undo the display none at the appropriate time.
*/
placeholder.el.show().setStyle('display', 'none').slideIn(collapseDir.substr(0, 1), {
easing: 'linear',
duration: 100,
listeners: {
afteranimate: function() {
placeholder.focus();
me.isCollapsingOrExpanding = 0;
me.fireEvent('collapse', me);
}
}
});
}
}
});
} else {
me.el.hide();
me.isCollapsingOrExpanding = 0;
me.fireEvent('collapse', me);
}
} else {
me.isCollapsingOrExpanding = 0;
me.fireEvent('collapse', me);
}
return me;
},
floatCollapsedPanel: function() {
var me = this,
placeholder = me.placeholder,
pb = placeholder.getBox(true),
myBox,
floatCls = Ext.baseCSSPrefix + 'border-region-slide-in',
collapsed = me.collapsed,
layoutOwner = me.ownerCt || me,
slideDirection;
// Already floated
if (me.el.hasCls(floatCls)) {
me.slideOutFloatedPanel();
return;
}
if (me.isSliding) {
return;
}
me.isSliding = true;
// Function to be called when the mouse leaves the floated Panel
// Slide out when the mouse leaves the region bounded by the slid Component and its placeholder.
function onMouseLeaveFloated(e) {
if (!me.isDestroyed) {
var slideRegion = me.el.getRegion().union(placeholder.el.getRegion()).adjust(1, -1, -1, 1);
// If mouse is not within slide Region, slide it out
if (!slideRegion.contains(e.getPoint())) {
me.slideOutFloatedPanel();
}
}
}
// Lay out in fully expanded mode to ensure we are at the correct size, and collect our expanded box
me.placeholder.el.hide();
me.placeholder.hidden = true;
me.el.show();
me.hidden = false;
me.collapsed = false;
layoutOwner.updateLayout();
myBox = me.getBox(true);
// Then go back immediately to collapsed state from which to initiate the float into view.
me.placeholder.el.show();
me.placeholder.hidden = false;
me.el.hide();
me.hidden = true;
me.collapsed = collapsed;
layoutOwner.updateLayout();
// Monitor for mouseouting of the placeholder. Hide it if they exit for half a second or more
me.placeholderMouseMon = placeholder.el.monitorMouseLeave(500, onMouseLeaveFloated);
me.panelMouseMon = me.el.monitorMouseLeave(500, onMouseLeaveFloated);
me.el.addCls(floatCls);
// Hide collapse tool in header if there is one (we might be headerless)
if (me.collapseTool) {
me.collapseTool.el.hide();
}
switch (me.collapsed) {
case 'top':
me.el.setLeftTop(pb.x, pb.y + pb.height - 1);
slideDirection = 't';
break;
case 'right':
me.el.setLeftTop(pb.x - myBox.width + 1, pb.y);
slideDirection = 'r';
break;
case 'bottom':
me.el.setLeftTop(pb.x, pb.y - myBox.height + 1);
slideDirection = 'b';
break;
case 'left':
me.el.setLeftTop(pb.x + pb.width - 1, pb.y);
slideDirection = 'l';
break;
}
// Remember how we are really collapsed so we can restore it, but also so we can
// become a layoutRoot while we are floated:
me.floatedFromCollapse = me.collapsed;
me.collapsed = me.hidden = false;
me.el.slideIn(slideDirection, {
preserveScroll: true,
listeners: {
afteranimate: function() {
me.isSliding = false;
}
}
});
},
isLayoutRoot: function() {
if (this.floatedFromCollapse) {
return true;
}
return this.callParent();
},
slideOutFloatedPanel: function() {
var me = this,
compEl = this.el,
collapseDirection;
if (me.isSliding) {
return;
}
me.isSliding = true;
me.slideOutFloatedPanelBegin();
if (typeof me.collapsed == 'string') {
collapseDirection = me.collapsed.charAt(0);
}
compEl.slideOut(collapseDirection, {
preserveScroll: true,
listeners: {
afteranimate: function() {
me.slideOutFloatedPanelEnd();
// this would be in slideOutFloatedPanelEnd except that the only other
// caller removes this cls later
me.el.removeCls(Ext.baseCSSPrefix + 'border-region-slide-in');
me.isSliding = false;
}
}
});
},
<span id='Ext-panel-Panel-method-slideOutFloatedPanelBegin'> /**
</span> * This method begins the slide out of the floated panel.
* @private
*/
slideOutFloatedPanelBegin: function() {
var me = this,
compEl = this.el;
me.collapsed = me.floatedFromCollapse;
me.hidden = true;
me.floatedFromCollapse = null;
// Remove mouse leave monitors
compEl.un(me.panelMouseMon);
me.placeholder.el.un(me.placeholderMouseMon);
},
<span id='Ext-panel-Panel-method-slideOutFloatedPanelEnd'> /**
</span> * This method cleans up after the slide out of the floated panel.
* @private
*/
slideOutFloatedPanelEnd: function() {
if (this.collapseTool) {
this.collapseTool.el.show();
}
},
<span id='Ext-panel-Panel-method-expand'> /**
</span> * Expands the panel body so that it becomes visible. Fires the {@link #beforeexpand} event which will
* cancel the expand action if it returns false.
* @param {Boolean} [animate] True to animate the transition, else false (defaults to the value of the
* {@link #animCollapse} panel config)
* @return {Ext.panel.Panel} this
*/
expand: function(animate) {
var me = this;
if (me.isCollapsingOrExpanding) {
return me;
}
if (!arguments.length) {
animate = me.animCollapse;
}
if (!me.collapsed && !me.floatedFromCollapse) {
return me;
}
if (me.fireEvent('beforeexpand', me, animate) === false) {
return me;
}
if (me.isPlaceHolderCollapse()) {
return me.placeholderExpand(animate);
}
me.restoreHiddenDocked();
me.beginExpand();
me.collapsed = false;
me.fireHierarchyEvent('expand');
return me.doCollapseExpand(2, animate);
},
placeholderExpand: function(animate) {
var me = this,
collapseDir = me.collapsed,
floatCls = Ext.baseCSSPrefix + 'border-region-slide-in',
finalPos,
floatedPos,
slideInDirection;
if (me.floatedFromCollapse) {
floatedPos = me.getPosition(true);
// these are the same cleanups performed by the normal slideOut mechanism:
me.slideOutFloatedPanelBegin();
me.slideOutFloatedPanelEnd();
}
me.isCollapsingOrExpanding = 2;
// Expand me and hide the placeholder
me.placeholder.hidden = true;
me.placeholder.el.hide();
me.collapsed = false;
me.show();
if (animate) {
// Floated, move it back to the floated pos, and thence into the correct place
if (floatedPos) {
finalPos = me.el.getXY();
me.el.setLeftTop(floatedPos[0], floatedPos[1]);
me.el.moveTo(finalPos[0], finalPos[1], {
duration: Ext.Number.from(animate, Ext.fx.Anim.prototype.duration),
listeners: {
afteranimate: function() {
me.el.removeCls(floatCls);
me.isCollapsingOrExpanding = 0;
me.fireEvent('expand', me);
}
}
});
}
// Not floated, slide it in to the correct place
else {
me.hidden = true;
me.el.addCls(floatCls);
me.el.hide();
me.collapsed = collapseDir;
me.placeholder.show();
slideInDirection = collapseDir.substr(0, 1);
// Slide this Component's el back into place, after which we lay out AGAIN
me.hidden = false;
me.el.slideIn(slideInDirection, {
preserveScroll: true,
duration: Ext.Number.from(animate, Ext.fx.Anim.prototype.duration),
listeners: {
afteranimate: function() {
me.collapsed = false;
// the ordering of these two lines appears to be important in
// IE9. There is an odd expand issue in IE 9 in the border layout
// example that causes the index1 child of the south dock region
// to get 'hidden' after a collapse / expand cycle. See
// EXTJSIV-5318 for details
me.el.removeCls(floatCls);
me.placeholder.hide();
me.isCollapsingOrExpanding = 0;
me.fireEvent('expand', me);
}
}
});
}
} else {
me.isCollapsingOrExpanding = 0;
me.fireEvent('expand', me);
}
return me;
},
<span id='Ext-panel-Panel-method-afterExpand'> /**
</span> * Invoked after the Panel is Expanded.
*
* @param {Boolean} animated
*
* @template
* @protected
*/
afterExpand: function(animated) {
var me = this,
ownerLayout = me.ownerLayout;
me.isCollapsingOrExpanding = 0;
if (me.collapseTool) {
me.collapseTool.setType('collapse-' + me.collapseDirection);
}
if (ownerLayout && animated) {
ownerLayout.onContentChange(me);
}
me.fireEvent('expand', me);
},
// inherit docs
setBorder: function(border, targetEl) {
if (targetEl) {
// skip out here, the panel will set the border on the body/header during rendering
return;
}
var me = this,
header = me.header;
if (!border) {
border = 0;
} else {
border = Ext.Element.unitizeBox((border === true) ? 1 : border);
}
if (header) {
if (header.isHeader) {
header.setBorder(border);
} else {
header.border = border;
}
}
if (me.rendered && me.bodyBorder !== false) {
me.body.setStyle('border-width', border);
}
me.updateLayout();
me.border = border;
},
<span id='Ext-panel-Panel-method-toggleCollapse'> /**
</span> * Shortcut for performing an {@link #method-expand} or {@link #method-collapse} based on the current state of the panel.
* @return {Ext.panel.Panel} this
*/
toggleCollapse: function() {
return (this.collapsed || this.floatedFromCollapse) ? this.expand() : this.collapse();
},
// private
getKeyMap : function() {
return this.keyMap || (this.keyMap = new Ext.util.KeyMap(Ext.apply({
target: this.el
}, this.keys)));
},
// private
initDraggable : function(){
<span id='Ext-panel-Panel-property-dd'> /**
</span> * @property {Ext.dd.DragSource} dd
* If this Panel is configured {@link #cfg-draggable}, this property will contain an instance of {@link
* Ext.dd.DragSource} which handles dragging the Panel.
*
* The developer must provide implementations of the abstract methods of {@link Ext.dd.DragSource} in order to
* supply behaviour for each stage of the drag/drop process. See {@link #cfg-draggable}.
*/
this.dd = new Ext.panel.DD(this, Ext.isBoolean(this.draggable) ? null : this.draggable);
},
// private - helper function for ghost
ghostTools : function() {
var tools = [],
header = this.header,
headerTools = header ? header.query('tool[hidden=false]') : [],
t, tLen, tool;
if (headerTools.length) {
t = 0;
tLen = headerTools.length;
for (; t < tLen; t++) {
tool = headerTools[t];
// Some tools can be full components, and copying them into the ghost
// actually removes them from the owning panel. You could also potentially
// end up with duplicate DOM ids as well. To avoid any issues we just make
// a simple bare-minimum clone of each tool for ghosting purposes.
tools.push({
type: tool.type
});
}
} else {
tools = [{
type: 'placeholder'
}];
}
return tools;
},
// private - used for dragging
ghost: function(cls) {
var me = this,
ghostPanel = me.ghostPanel,
box = me.getBox(),
header;
if (!ghostPanel) {
ghostPanel = new Ext.panel.Panel({
renderTo: document.body,
floating: {
shadow: false
},
frame: me.frame && !me.alwaysFramed,
alwaysFramed: me.alwaysFramed,
overlapHeader: me.overlapHeader,
headerPosition: me.headerPosition,
baseCls: me.baseCls,
cls: me.baseCls + '-ghost ' + (cls ||'')
});
me.ghostPanel = ghostPanel;
} else {
ghostPanel.el.show();
}
ghostPanel.floatParent = me.floatParent;
if (me.floating) {
ghostPanel.setZIndex(Ext.Number.from(me.el.getStyle('zIndex'), 0));
} else {
ghostPanel.toFront();
}
if (!(me.preventHeader || (me.header === false))) {
header = ghostPanel.header;
// restore options
if (header) {
header.suspendLayouts();
Ext.Array.forEach(header.query('tool'), header.remove, header);
header.resumeLayouts();
}
ghostPanel.addTool(me.ghostTools());
ghostPanel.setTitle(me.title);
ghostPanel.setIconCls(me.iconCls);
}
ghostPanel.setPagePosition(box.x, box.y);
ghostPanel.setSize(box.width, box.height);
me.el.hide();
return ghostPanel;
},
// private
unghost: function(show, matchPosition) {
var me = this;
if (!me.ghostPanel) {
return;
}
if (show !== false) {
// Show el first, so that position adjustment in setPagePosition
// will work when relative positioned elements have their XY read.
me.el.show();
if (matchPosition !== false) {
me.setPagePosition(me.ghostPanel.el.getXY());
if (me.hideMode == 'offsets') {
// clear the hidden style because we just repositioned
delete me.el.hideModeStyles;
}
}
Ext.defer(me.focus, 10, me);
}
me.ghostPanel.el.hide();
},
beginDrag: function() {
if (this.floatingDescendants) {
this.floatingDescendants.hide();
}
},
endDrag: function() {
if (this.floatingDescendants) {
this.floatingDescendants.show();
}
},
initResizable: function(resizable) {
if (this.collapsed) {
resizable.disabled = true;
}
this.callParent([resizable]);
}
}, function() {
this.prototype.animCollapse = Ext.enableFx;
});
</pre>
</body>
</html>