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 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015
|
/*
* Copyright (C) 2011 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package android.widget;
import static android.view.Gravity.AXIS_PULL_AFTER;
import static android.view.Gravity.AXIS_PULL_BEFORE;
import static android.view.Gravity.AXIS_SPECIFIED;
import static android.view.Gravity.AXIS_X_SHIFT;
import static android.view.Gravity.AXIS_Y_SHIFT;
import static android.view.Gravity.HORIZONTAL_GRAVITY_MASK;
import static android.view.Gravity.RELATIVE_LAYOUT_DIRECTION;
import static android.view.Gravity.VERTICAL_GRAVITY_MASK;
import static android.view.View.MeasureSpec.EXACTLY;
import static android.view.View.MeasureSpec.makeMeasureSpec;
import static java.lang.Math.max;
import static java.lang.Math.min;
import android.annotation.IntDef;
import android.annotation.UnsupportedAppUsage;
import android.content.Context;
import android.content.res.TypedArray;
import android.graphics.Canvas;
import android.graphics.Color;
import android.graphics.Insets;
import android.graphics.Paint;
import android.util.AttributeSet;
import android.util.Log;
import android.util.LogPrinter;
import android.util.Pair;
import android.util.Printer;
import android.view.Gravity;
import android.view.View;
import android.view.ViewGroup;
import android.view.inspector.InspectableProperty;
import android.widget.RemoteViews.RemoteView;
import com.android.internal.R;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.reflect.Array;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* A layout that places its children in a rectangular <em>grid</em>.
* <p>
* The grid is composed of a set of infinitely thin lines that separate the
* viewing area into <em>cells</em>. Throughout the API, grid lines are referenced
* by grid <em>indices</em>. A grid with {@code N} columns
* has {@code N + 1} grid indices that run from {@code 0}
* through {@code N} inclusive. Regardless of how GridLayout is
* configured, grid index {@code 0} is fixed to the leading edge of the
* container and grid index {@code N} is fixed to its trailing edge
* (after padding is taken into account).
*
* <h4>Row and Column Specs</h4>
*
* Children occupy one or more contiguous cells, as defined
* by their {@link GridLayout.LayoutParams#rowSpec rowSpec} and
* {@link GridLayout.LayoutParams#columnSpec columnSpec} layout parameters.
* Each spec defines the set of rows or columns that are to be
* occupied; and how children should be aligned within the resulting group of cells.
* Although cells do not normally overlap in a GridLayout, GridLayout does
* not prevent children being defined to occupy the same cell or group of cells.
* In this case however, there is no guarantee that children will not themselves
* overlap after the layout operation completes.
*
* <h4>Default Cell Assignment</h4>
*
* If a child does not specify the row and column indices of the cell it
* wishes to occupy, GridLayout assigns cell locations automatically using its:
* {@link GridLayout#setOrientation(int) orientation},
* {@link GridLayout#setRowCount(int) rowCount} and
* {@link GridLayout#setColumnCount(int) columnCount} properties.
*
* <h4>Space</h4>
*
* Space between children may be specified either by using instances of the
* dedicated {@link Space} view or by setting the
*
* {@link ViewGroup.MarginLayoutParams#leftMargin leftMargin},
* {@link ViewGroup.MarginLayoutParams#topMargin topMargin},
* {@link ViewGroup.MarginLayoutParams#rightMargin rightMargin} and
* {@link ViewGroup.MarginLayoutParams#bottomMargin bottomMargin}
*
* layout parameters. When the
* {@link GridLayout#setUseDefaultMargins(boolean) useDefaultMargins}
* property is set, default margins around children are automatically
* allocated based on the prevailing UI style guide for the platform.
* Each of the margins so defined may be independently overridden by an assignment
* to the appropriate layout parameter.
* Default values will generally produce a reasonable spacing between components
* but values may change between different releases of the platform.
*
* <h4>Excess Space Distribution</h4>
*
* As of API 21, GridLayout's distribution of excess space accomodates the principle of weight.
* In the event that no weights are specified, the previous conventions are respected and
* columns and rows are taken as flexible if their views specify some form of alignment
* within their groups.
* <p>
* The flexibility of a view is therefore influenced by its alignment which is,
* in turn, typically defined by setting the
* {@link LayoutParams#setGravity(int) gravity} property of the child's layout parameters.
* If either a weight or alignment were defined along a given axis then the component
* is taken as <em>flexible</em> in that direction. If no weight or alignment was set,
* the component is instead assumed to be <em>inflexible</em>.
* <p>
* Multiple components in the same row or column group are
* considered to act in <em>parallel</em>. Such a
* group is flexible only if <em>all</em> of the components
* within it are flexible. Row and column groups that sit either side of a common boundary
* are instead considered to act in <em>series</em>. The composite group made of these two
* elements is flexible if <em>one</em> of its elements is flexible.
* <p>
* To make a column stretch, make sure all of the components inside it define a
* weight or a gravity. To prevent a column from stretching, ensure that one of the components
* in the column does not define a weight or a gravity.
* <p>
* When the principle of flexibility does not provide complete disambiguation,
* GridLayout's algorithms favour rows and columns that are closer to its <em>right</em>
* and <em>bottom</em> edges. To be more precise, GridLayout treats each of its layout
* parameters as a constraint in the a set of variables that define the grid-lines along a
* given axis. During layout, GridLayout solves the constraints so as to return the unique
* solution to those constraints for which all variables are less-than-or-equal-to
* the corresponding value in any other valid solution.
*
* <h4>Interpretation of GONE</h4>
*
* For layout purposes, GridLayout treats views whose visibility status is
* {@link View#GONE GONE}, as having zero width and height. This is subtly different from
* the policy of ignoring views that are marked as GONE outright. If, for example, a gone-marked
* view was alone in a column, that column would itself collapse to zero width if and only if
* no gravity was defined on the view. If gravity was defined, then the gone-marked
* view has no effect on the layout and the container should be laid out as if the view
* had never been added to it. GONE views are taken to have zero weight during excess space
* distribution.
* <p>
* These statements apply equally to rows as well as columns, and to groups of rows or columns.
*
* <p>
* See {@link GridLayout.LayoutParams} for a full description of the
* layout parameters used by GridLayout.
*
* @attr ref android.R.styleable#GridLayout_orientation
* @attr ref android.R.styleable#GridLayout_rowCount
* @attr ref android.R.styleable#GridLayout_columnCount
* @attr ref android.R.styleable#GridLayout_useDefaultMargins
* @attr ref android.R.styleable#GridLayout_rowOrderPreserved
* @attr ref android.R.styleable#GridLayout_columnOrderPreserved
*/
@RemoteView
public class GridLayout extends ViewGroup {
// Public constants
/** @hide */
@IntDef(prefix = { "HORIZONTAL", "VERTICAL" }, value = {
HORIZONTAL,
VERTICAL
})
@Retention(RetentionPolicy.SOURCE)
public @interface Orientation {}
/**
* The horizontal orientation.
*/
public static final int HORIZONTAL = LinearLayout.HORIZONTAL;
/**
* The vertical orientation.
*/
public static final int VERTICAL = LinearLayout.VERTICAL;
/**
* The constant used to indicate that a value is undefined.
* Fields can use this value to indicate that their values
* have not yet been set. Similarly, methods can return this value
* to indicate that there is no suitable value that the implementation
* can return.
* The value used for the constant (currently {@link Integer#MIN_VALUE}) is
* intended to avoid confusion between valid values whose sign may not be known.
*/
public static final int UNDEFINED = Integer.MIN_VALUE;
/** @hide */
@IntDef(prefix = { "ALIGN_" }, value = {
ALIGN_BOUNDS,
ALIGN_MARGINS
})
@Retention(RetentionPolicy.SOURCE)
public @interface AlignmentMode {}
/**
* This constant is an {@link #setAlignmentMode(int) alignmentMode}.
* When the {@code alignmentMode} is set to {@link #ALIGN_BOUNDS}, alignment
* is made between the edges of each component's raw
* view boundary: i.e. the area delimited by the component's:
* {@link android.view.View#getTop() top},
* {@link android.view.View#getLeft() left},
* {@link android.view.View#getBottom() bottom} and
* {@link android.view.View#getRight() right} properties.
* <p>
* For example, when {@code GridLayout} is in {@link #ALIGN_BOUNDS} mode,
* children that belong to a row group that uses {@link #TOP} alignment will
* all return the same value when their {@link android.view.View#getTop()}
* method is called.
*
* @see #setAlignmentMode(int)
*/
public static final int ALIGN_BOUNDS = 0;
/**
* This constant is an {@link #setAlignmentMode(int) alignmentMode}.
* When the {@code alignmentMode} is set to {@link #ALIGN_MARGINS},
* the bounds of each view are extended outwards, according
* to their margins, before the edges of the resulting rectangle are aligned.
* <p>
* For example, when {@code GridLayout} is in {@link #ALIGN_MARGINS} mode,
* the quantity {@code top - layoutParams.topMargin} is the same for all children that
* belong to a row group that uses {@link #TOP} alignment.
*
* @see #setAlignmentMode(int)
*/
public static final int ALIGN_MARGINS = 1;
// Misc constants
static final int MAX_SIZE = 100000;
static final int DEFAULT_CONTAINER_MARGIN = 0;
static final int UNINITIALIZED_HASH = 0;
static final Printer LOG_PRINTER = new LogPrinter(Log.DEBUG, GridLayout.class.getName());
static final Printer NO_PRINTER = new Printer() {
@Override
public void println(String x) {
}
};
// Defaults
private static final int DEFAULT_ORIENTATION = HORIZONTAL;
private static final int DEFAULT_COUNT = UNDEFINED;
private static final boolean DEFAULT_USE_DEFAULT_MARGINS = false;
private static final boolean DEFAULT_ORDER_PRESERVED = true;
private static final int DEFAULT_ALIGNMENT_MODE = ALIGN_MARGINS;
// TypedArray indices
private static final int ORIENTATION = R.styleable.GridLayout_orientation;
private static final int ROW_COUNT = R.styleable.GridLayout_rowCount;
private static final int COLUMN_COUNT = R.styleable.GridLayout_columnCount;
private static final int USE_DEFAULT_MARGINS = R.styleable.GridLayout_useDefaultMargins;
private static final int ALIGNMENT_MODE = R.styleable.GridLayout_alignmentMode;
private static final int ROW_ORDER_PRESERVED = R.styleable.GridLayout_rowOrderPreserved;
private static final int COLUMN_ORDER_PRESERVED = R.styleable.GridLayout_columnOrderPreserved;
// Instance variables
final Axis mHorizontalAxis = new Axis(true);
final Axis mVerticalAxis = new Axis(false);
int mOrientation = DEFAULT_ORIENTATION;
boolean mUseDefaultMargins = DEFAULT_USE_DEFAULT_MARGINS;
int mAlignmentMode = DEFAULT_ALIGNMENT_MODE;
int mDefaultGap;
int mLastLayoutParamsHashCode = UNINITIALIZED_HASH;
Printer mPrinter = LOG_PRINTER;
// Constructors
public GridLayout(Context context) {
this(context, null);
}
public GridLayout(Context context, AttributeSet attrs) {
this(context, attrs, 0);
}
public GridLayout(Context context, AttributeSet attrs, int defStyleAttr) {
this(context, attrs, defStyleAttr, 0);
}
public GridLayout(Context context, AttributeSet attrs, int defStyleAttr, int defStyleRes) {
super(context, attrs, defStyleAttr, defStyleRes);
mDefaultGap = context.getResources().getDimensionPixelOffset(R.dimen.default_gap);
final TypedArray a = context.obtainStyledAttributes(
attrs, R.styleable.GridLayout, defStyleAttr, defStyleRes);
saveAttributeDataForStyleable(context, R.styleable.GridLayout,
attrs, a, defStyleAttr, defStyleRes);
try {
setRowCount(a.getInt(ROW_COUNT, DEFAULT_COUNT));
setColumnCount(a.getInt(COLUMN_COUNT, DEFAULT_COUNT));
setOrientation(a.getInt(ORIENTATION, DEFAULT_ORIENTATION));
setUseDefaultMargins(a.getBoolean(USE_DEFAULT_MARGINS, DEFAULT_USE_DEFAULT_MARGINS));
setAlignmentMode(a.getInt(ALIGNMENT_MODE, DEFAULT_ALIGNMENT_MODE));
setRowOrderPreserved(a.getBoolean(ROW_ORDER_PRESERVED, DEFAULT_ORDER_PRESERVED));
setColumnOrderPreserved(a.getBoolean(COLUMN_ORDER_PRESERVED, DEFAULT_ORDER_PRESERVED));
} finally {
a.recycle();
}
}
// Implementation
/**
* Returns the current orientation.
*
* @return either {@link #HORIZONTAL} or {@link #VERTICAL}
*
* @see #setOrientation(int)
*
* @attr ref android.R.styleable#GridLayout_orientation
*/
@Orientation
@InspectableProperty(enumMapping = {
@InspectableProperty.EnumEntry(value = HORIZONTAL, name = "horizontal"),
@InspectableProperty.EnumEntry(value = VERTICAL, name = "vertical")
})
public int getOrientation() {
return mOrientation;
}
/**
*
* GridLayout uses the orientation property for two purposes:
* <ul>
* <li>
* To control the 'direction' in which default row/column indices are generated
* when they are not specified in a component's layout parameters.
* </li>
* <li>
* To control which axis should be processed first during the layout operation:
* when orientation is {@link #HORIZONTAL} the horizontal axis is laid out first.
* </li>
* </ul>
*
* The order in which axes are laid out is important if, for example, the height of
* one of GridLayout's children is dependent on its width - and its width is, in turn,
* dependent on the widths of other components.
* <p>
* If your layout contains a {@link TextView} (or derivative:
* {@code Button}, {@code EditText}, {@code CheckBox}, etc.) which is
* in multi-line mode (the default) it is normally best to leave GridLayout's
* orientation as {@code HORIZONTAL} - because {@code TextView} is capable of
* deriving its height for a given width, but not the other way around.
* <p>
* Other than the effects above, orientation does not affect the actual layout operation of
* GridLayout, so it's fine to leave GridLayout in {@code HORIZONTAL} mode even if
* the height of the intended layout greatly exceeds its width.
* <p>
* The default value of this property is {@link #HORIZONTAL}.
*
* @param orientation either {@link #HORIZONTAL} or {@link #VERTICAL}
*
* @see #getOrientation()
*
* @attr ref android.R.styleable#GridLayout_orientation
*/
public void setOrientation(@Orientation int orientation) {
if (this.mOrientation != orientation) {
this.mOrientation = orientation;
invalidateStructure();
requestLayout();
}
}
/**
* Returns the current number of rows. This is either the last value that was set
* with {@link #setRowCount(int)} or, if no such value was set, the maximum
* value of each the upper bounds defined in {@link LayoutParams#rowSpec}.
*
* @return the current number of rows
*
* @see #setRowCount(int)
* @see LayoutParams#rowSpec
*
* @attr ref android.R.styleable#GridLayout_rowCount
*/
@InspectableProperty
public int getRowCount() {
return mVerticalAxis.getCount();
}
/**
* RowCount is used only to generate default row/column indices when
* they are not specified by a component's layout parameters.
*
* @param rowCount the number of rows
*
* @see #getRowCount()
* @see LayoutParams#rowSpec
*
* @attr ref android.R.styleable#GridLayout_rowCount
*/
public void setRowCount(int rowCount) {
mVerticalAxis.setCount(rowCount);
invalidateStructure();
requestLayout();
}
/**
* Returns the current number of columns. This is either the last value that was set
* with {@link #setColumnCount(int)} or, if no such value was set, the maximum
* value of each the upper bounds defined in {@link LayoutParams#columnSpec}.
*
* @return the current number of columns
*
* @see #setColumnCount(int)
* @see LayoutParams#columnSpec
*
* @attr ref android.R.styleable#GridLayout_columnCount
*/
@InspectableProperty
public int getColumnCount() {
return mHorizontalAxis.getCount();
}
/**
* ColumnCount is used only to generate default column/column indices when
* they are not specified by a component's layout parameters.
*
* @param columnCount the number of columns.
*
* @see #getColumnCount()
* @see LayoutParams#columnSpec
*
* @attr ref android.R.styleable#GridLayout_columnCount
*/
public void setColumnCount(int columnCount) {
mHorizontalAxis.setCount(columnCount);
invalidateStructure();
requestLayout();
}
/**
* Returns whether or not this GridLayout will allocate default margins when no
* corresponding layout parameters are defined.
*
* @return {@code true} if default margins should be allocated
*
* @see #setUseDefaultMargins(boolean)
*
* @attr ref android.R.styleable#GridLayout_useDefaultMargins
*/
@InspectableProperty
public boolean getUseDefaultMargins() {
return mUseDefaultMargins;
}
/**
* When {@code true}, GridLayout allocates default margins around children
* based on the child's visual characteristics. Each of the
* margins so defined may be independently overridden by an assignment
* to the appropriate layout parameter.
* <p>
* When {@code false}, the default value of all margins is zero.
* <p>
* When setting to {@code true}, consider setting the value of the
* {@link #setAlignmentMode(int) alignmentMode}
* property to {@link #ALIGN_BOUNDS}.
* <p>
* The default value of this property is {@code false}.
*
* @param useDefaultMargins use {@code true} to make GridLayout allocate default margins
*
* @see #getUseDefaultMargins()
* @see #setAlignmentMode(int)
*
* @see ViewGroup.MarginLayoutParams#leftMargin
* @see ViewGroup.MarginLayoutParams#topMargin
* @see ViewGroup.MarginLayoutParams#rightMargin
* @see ViewGroup.MarginLayoutParams#bottomMargin
*
* @attr ref android.R.styleable#GridLayout_useDefaultMargins
*/
public void setUseDefaultMargins(boolean useDefaultMargins) {
this.mUseDefaultMargins = useDefaultMargins;
requestLayout();
}
/**
* Returns the alignment mode.
*
* @return the alignment mode; either {@link #ALIGN_BOUNDS} or {@link #ALIGN_MARGINS}
*
* @see #ALIGN_BOUNDS
* @see #ALIGN_MARGINS
*
* @see #setAlignmentMode(int)
*
* @attr ref android.R.styleable#GridLayout_alignmentMode
*/
@AlignmentMode
@InspectableProperty(enumMapping = {
@InspectableProperty.EnumEntry(value = ALIGN_BOUNDS, name = "alignBounds"),
@InspectableProperty.EnumEntry(value = ALIGN_MARGINS, name = "alignMargins"),
})
public int getAlignmentMode() {
return mAlignmentMode;
}
/**
* Sets the alignment mode to be used for all of the alignments between the
* children of this container.
* <p>
* The default value of this property is {@link #ALIGN_MARGINS}.
*
* @param alignmentMode either {@link #ALIGN_BOUNDS} or {@link #ALIGN_MARGINS}
*
* @see #ALIGN_BOUNDS
* @see #ALIGN_MARGINS
*
* @see #getAlignmentMode()
*
* @attr ref android.R.styleable#GridLayout_alignmentMode
*/
public void setAlignmentMode(@AlignmentMode int alignmentMode) {
this.mAlignmentMode = alignmentMode;
requestLayout();
}
/**
* Returns whether or not row boundaries are ordered by their grid indices.
*
* @return {@code true} if row boundaries must appear in the order of their indices,
* {@code false} otherwise
*
* @see #setRowOrderPreserved(boolean)
*
* @attr ref android.R.styleable#GridLayout_rowOrderPreserved
*/
@InspectableProperty
public boolean isRowOrderPreserved() {
return mVerticalAxis.isOrderPreserved();
}
/**
* When this property is {@code true}, GridLayout is forced to place the row boundaries
* so that their associated grid indices are in ascending order in the view.
* <p>
* When this property is {@code false} GridLayout is at liberty to place the vertical row
* boundaries in whatever order best fits the given constraints.
* <p>
* The default value of this property is {@code true}.
* @param rowOrderPreserved {@code true} to force GridLayout to respect the order
* of row boundaries
*
* @see #isRowOrderPreserved()
*
* @attr ref android.R.styleable#GridLayout_rowOrderPreserved
*/
public void setRowOrderPreserved(boolean rowOrderPreserved) {
mVerticalAxis.setOrderPreserved(rowOrderPreserved);
invalidateStructure();
requestLayout();
}
/**
* Returns whether or not column boundaries are ordered by their grid indices.
*
* @return {@code true} if column boundaries must appear in the order of their indices,
* {@code false} otherwise
*
* @see #setColumnOrderPreserved(boolean)
*
* @attr ref android.R.styleable#GridLayout_columnOrderPreserved
*/
@InspectableProperty
public boolean isColumnOrderPreserved() {
return mHorizontalAxis.isOrderPreserved();
}
/**
* When this property is {@code true}, GridLayout is forced to place the column boundaries
* so that their associated grid indices are in ascending order in the view.
* <p>
* When this property is {@code false} GridLayout is at liberty to place the horizontal column
* boundaries in whatever order best fits the given constraints.
* <p>
* The default value of this property is {@code true}.
*
* @param columnOrderPreserved use {@code true} to force GridLayout to respect the order
* of column boundaries.
*
* @see #isColumnOrderPreserved()
*
* @attr ref android.R.styleable#GridLayout_columnOrderPreserved
*/
public void setColumnOrderPreserved(boolean columnOrderPreserved) {
mHorizontalAxis.setOrderPreserved(columnOrderPreserved);
invalidateStructure();
requestLayout();
}
/**
* Return the printer that will log diagnostics from this layout.
*
* @see #setPrinter(android.util.Printer)
*
* @return the printer associated with this view
*
* @hide
*/
public Printer getPrinter() {
return mPrinter;
}
/**
* Set the printer that will log diagnostics from this layout.
* The default value is created by {@link android.util.LogPrinter}.
*
* @param printer the printer associated with this layout
*
* @see #getPrinter()
*
* @hide
*/
public void setPrinter(Printer printer) {
this.mPrinter = (printer == null) ? NO_PRINTER : printer;
}
// Static utility methods
static int max2(int[] a, int valueIfEmpty) {
int result = valueIfEmpty;
for (int i = 0, N = a.length; i < N; i++) {
result = Math.max(result, a[i]);
}
return result;
}
@SuppressWarnings("unchecked")
static <T> T[] append(T[] a, T[] b) {
T[] result = (T[]) Array.newInstance(a.getClass().getComponentType(), a.length + b.length);
System.arraycopy(a, 0, result, 0, a.length);
System.arraycopy(b, 0, result, a.length, b.length);
return result;
}
static Alignment getAlignment(int gravity, boolean horizontal) {
int mask = horizontal ? HORIZONTAL_GRAVITY_MASK : VERTICAL_GRAVITY_MASK;
int shift = horizontal ? AXIS_X_SHIFT : AXIS_Y_SHIFT;
int flags = (gravity & mask) >> shift;
switch (flags) {
case (AXIS_SPECIFIED | AXIS_PULL_BEFORE):
return horizontal ? LEFT : TOP;
case (AXIS_SPECIFIED | AXIS_PULL_AFTER):
return horizontal ? RIGHT : BOTTOM;
case (AXIS_SPECIFIED | AXIS_PULL_BEFORE | AXIS_PULL_AFTER):
return FILL;
case AXIS_SPECIFIED:
return CENTER;
case (AXIS_SPECIFIED | AXIS_PULL_BEFORE | RELATIVE_LAYOUT_DIRECTION):
return START;
case (AXIS_SPECIFIED | AXIS_PULL_AFTER | RELATIVE_LAYOUT_DIRECTION):
return END;
default:
return UNDEFINED_ALIGNMENT;
}
}
/** @noinspection UnusedParameters*/
private int getDefaultMargin(View c, boolean horizontal, boolean leading) {
if (c.getClass() == Space.class) {
return 0;
}
return mDefaultGap / 2;
}
private int getDefaultMargin(View c, boolean isAtEdge, boolean horizontal, boolean leading) {
return /*isAtEdge ? DEFAULT_CONTAINER_MARGIN :*/ getDefaultMargin(c, horizontal, leading);
}
private int getDefaultMargin(View c, LayoutParams p, boolean horizontal, boolean leading) {
if (!mUseDefaultMargins) {
return 0;
}
Spec spec = horizontal ? p.columnSpec : p.rowSpec;
Axis axis = horizontal ? mHorizontalAxis : mVerticalAxis;
Interval span = spec.span;
boolean leading1 = (horizontal && isLayoutRtl()) ? !leading : leading;
boolean isAtEdge = leading1 ? (span.min == 0) : (span.max == axis.getCount());
return getDefaultMargin(c, isAtEdge, horizontal, leading);
}
int getMargin1(View view, boolean horizontal, boolean leading) {
LayoutParams lp = getLayoutParams(view);
int margin = horizontal ?
(leading ? lp.leftMargin : lp.rightMargin) :
(leading ? lp.topMargin : lp.bottomMargin);
return margin == UNDEFINED ? getDefaultMargin(view, lp, horizontal, leading) : margin;
}
private int getMargin(View view, boolean horizontal, boolean leading) {
if (mAlignmentMode == ALIGN_MARGINS) {
return getMargin1(view, horizontal, leading);
} else {
Axis axis = horizontal ? mHorizontalAxis : mVerticalAxis;
int[] margins = leading ? axis.getLeadingMargins() : axis.getTrailingMargins();
LayoutParams lp = getLayoutParams(view);
Spec spec = horizontal ? lp.columnSpec : lp.rowSpec;
int index = leading ? spec.span.min : spec.span.max;
return margins[index];
}
}
private int getTotalMargin(View child, boolean horizontal) {
return getMargin(child, horizontal, true) + getMargin(child, horizontal, false);
}
private static boolean fits(int[] a, int value, int start, int end) {
if (end > a.length) {
return false;
}
for (int i = start; i < end; i++) {
if (a[i] > value) {
return false;
}
}
return true;
}
private static void procrusteanFill(int[] a, int start, int end, int value) {
int length = a.length;
Arrays.fill(a, Math.min(start, length), Math.min(end, length), value);
}
private static void setCellGroup(LayoutParams lp, int row, int rowSpan, int col, int colSpan) {
lp.setRowSpecSpan(new Interval(row, row + rowSpan));
lp.setColumnSpecSpan(new Interval(col, col + colSpan));
}
// Logic to avert infinite loops by ensuring that the cells can be placed somewhere.
private static int clip(Interval minorRange, boolean minorWasDefined, int count) {
int size = minorRange.size();
if (count == 0) {
return size;
}
int min = minorWasDefined ? min(minorRange.min, count) : 0;
return min(size, count - min);
}
// install default indices for cells that don't define them
private void validateLayoutParams() {
final boolean horizontal = (mOrientation == HORIZONTAL);
final Axis axis = horizontal ? mHorizontalAxis : mVerticalAxis;
final int count = (axis.definedCount != UNDEFINED) ? axis.definedCount : 0;
int major = 0;
int minor = 0;
int[] maxSizes = new int[count];
for (int i = 0, N = getChildCount(); i < N; i++) {
LayoutParams lp = (LayoutParams) getChildAt(i).getLayoutParams();
final Spec majorSpec = horizontal ? lp.rowSpec : lp.columnSpec;
final Interval majorRange = majorSpec.span;
final boolean majorWasDefined = majorSpec.startDefined;
final int majorSpan = majorRange.size();
if (majorWasDefined) {
major = majorRange.min;
}
final Spec minorSpec = horizontal ? lp.columnSpec : lp.rowSpec;
final Interval minorRange = minorSpec.span;
final boolean minorWasDefined = minorSpec.startDefined;
final int minorSpan = clip(minorRange, minorWasDefined, count);
if (minorWasDefined) {
minor = minorRange.min;
}
if (count != 0) {
// Find suitable row/col values when at least one is undefined.
if (!majorWasDefined || !minorWasDefined) {
while (!fits(maxSizes, major, minor, minor + minorSpan)) {
if (minorWasDefined) {
major++;
} else {
if (minor + minorSpan <= count) {
minor++;
} else {
minor = 0;
major++;
}
}
}
}
procrusteanFill(maxSizes, minor, minor + minorSpan, major + majorSpan);
}
if (horizontal) {
setCellGroup(lp, major, majorSpan, minor, minorSpan);
} else {
setCellGroup(lp, minor, minorSpan, major, majorSpan);
}
minor = minor + minorSpan;
}
}
private void invalidateStructure() {
mLastLayoutParamsHashCode = UNINITIALIZED_HASH;
mHorizontalAxis.invalidateStructure();
mVerticalAxis.invalidateStructure();
// This can end up being done twice. Better twice than not at all.
invalidateValues();
}
private void invalidateValues() {
// Need null check because requestLayout() is called in View's initializer,
// before we are set up.
if (mHorizontalAxis != null && mVerticalAxis != null) {
mHorizontalAxis.invalidateValues();
mVerticalAxis.invalidateValues();
}
}
/** @hide */
@Override
protected void onSetLayoutParams(View child, ViewGroup.LayoutParams layoutParams) {
super.onSetLayoutParams(child, layoutParams);
if (!checkLayoutParams(layoutParams)) {
handleInvalidParams("supplied LayoutParams are of the wrong type");
}
invalidateStructure();
}
final LayoutParams getLayoutParams(View c) {
return (LayoutParams) c.getLayoutParams();
}
private static void handleInvalidParams(String msg) {
throw new IllegalArgumentException(msg + ". ");
}
private void checkLayoutParams(LayoutParams lp, boolean horizontal) {
String groupName = horizontal ? "column" : "row";
Spec spec = horizontal ? lp.columnSpec : lp.rowSpec;
Interval span = spec.span;
if (span.min != UNDEFINED && span.min < 0) {
handleInvalidParams(groupName + " indices must be positive");
}
Axis axis = horizontal ? mHorizontalAxis : mVerticalAxis;
int count = axis.definedCount;
if (count != UNDEFINED) {
if (span.max > count) {
handleInvalidParams(groupName +
" indices (start + span) mustn't exceed the " + groupName + " count");
}
if (span.size() > count) {
handleInvalidParams(groupName + " span mustn't exceed the " + groupName + " count");
}
}
}
@Override
protected boolean checkLayoutParams(ViewGroup.LayoutParams p) {
if (!(p instanceof LayoutParams)) {
return false;
}
LayoutParams lp = (LayoutParams) p;
checkLayoutParams(lp, true);
checkLayoutParams(lp, false);
return true;
}
@Override
protected LayoutParams generateDefaultLayoutParams() {
return new LayoutParams();
}
@Override
public LayoutParams generateLayoutParams(AttributeSet attrs) {
return new LayoutParams(getContext(), attrs);
}
@Override
protected LayoutParams generateLayoutParams(ViewGroup.LayoutParams lp) {
if (sPreserveMarginParamsInLayoutParamConversion) {
if (lp instanceof LayoutParams) {
return new LayoutParams((LayoutParams) lp);
} else if (lp instanceof MarginLayoutParams) {
return new LayoutParams((MarginLayoutParams) lp);
}
}
return new LayoutParams(lp);
}
// Draw grid
private void drawLine(Canvas graphics, int x1, int y1, int x2, int y2, Paint paint) {
if (isLayoutRtl()) {
int width = getWidth();
graphics.drawLine(width - x1, y1, width - x2, y2, paint);
} else {
graphics.drawLine(x1, y1, x2, y2, paint);
}
}
/**
* @hide
*/
@Override
protected void onDebugDrawMargins(Canvas canvas, Paint paint) {
// Apply defaults, so as to remove UNDEFINED values
LayoutParams lp = new LayoutParams();
for (int i = 0; i < getChildCount(); i++) {
View c = getChildAt(i);
lp.setMargins(
getMargin1(c, true, true),
getMargin1(c, false, true),
getMargin1(c, true, false),
getMargin1(c, false, false));
lp.onDebugDraw(c, canvas, paint);
}
}
/**
* @hide
*/
@Override
protected void onDebugDraw(Canvas canvas) {
Paint paint = new Paint();
paint.setStyle(Paint.Style.STROKE);
paint.setColor(Color.argb(50, 255, 255, 255));
Insets insets = getOpticalInsets();
int top = getPaddingTop() + insets.top;
int left = getPaddingLeft() + insets.left;
int right = getWidth() - getPaddingRight() - insets.right;
int bottom = getHeight() - getPaddingBottom() - insets.bottom;
int[] xs = mHorizontalAxis.locations;
if (xs != null) {
for (int i = 0, length = xs.length; i < length; i++) {
int x = left + xs[i];
drawLine(canvas, x, top, x, bottom, paint);
}
}
int[] ys = mVerticalAxis.locations;
if (ys != null) {
for (int i = 0, length = ys.length; i < length; i++) {
int y = top + ys[i];
drawLine(canvas, left, y, right, y, paint);
}
}
super.onDebugDraw(canvas);
}
@Override
public void onViewAdded(View child) {
super.onViewAdded(child);
invalidateStructure();
}
@Override
public void onViewRemoved(View child) {
super.onViewRemoved(child);
invalidateStructure();
}
/**
* We need to call invalidateStructure() when a child's GONE flag changes state.
* This implementation is a catch-all, invalidating on any change in the visibility flags.
*
* @hide
*/
@Override
protected void onChildVisibilityChanged(View child, int oldVisibility, int newVisibility) {
super.onChildVisibilityChanged(child, oldVisibility, newVisibility);
if (oldVisibility == GONE || newVisibility == GONE) {
invalidateStructure();
}
}
private int computeLayoutParamsHashCode() {
int result = 1;
for (int i = 0, N = getChildCount(); i < N; i++) {
View c = getChildAt(i);
if (c.getVisibility() == View.GONE) continue;
LayoutParams lp = (LayoutParams) c.getLayoutParams();
result = 31 * result + lp.hashCode();
}
return result;
}
private void consistencyCheck() {
if (mLastLayoutParamsHashCode == UNINITIALIZED_HASH) {
validateLayoutParams();
mLastLayoutParamsHashCode = computeLayoutParamsHashCode();
} else if (mLastLayoutParamsHashCode != computeLayoutParamsHashCode()) {
mPrinter.println("The fields of some layout parameters were modified in between "
+ "layout operations. Check the javadoc for GridLayout.LayoutParams#rowSpec.");
invalidateStructure();
consistencyCheck();
}
}
// Measurement
// Note: padding has already been removed from the supplied specs
private void measureChildWithMargins2(View child, int parentWidthSpec, int parentHeightSpec,
int childWidth, int childHeight) {
int childWidthSpec = getChildMeasureSpec(parentWidthSpec,
getTotalMargin(child, true), childWidth);
int childHeightSpec = getChildMeasureSpec(parentHeightSpec,
getTotalMargin(child, false), childHeight);
child.measure(childWidthSpec, childHeightSpec);
}
// Note: padding has already been removed from the supplied specs
private void measureChildrenWithMargins(int widthSpec, int heightSpec, boolean firstPass) {
for (int i = 0, N = getChildCount(); i < N; i++) {
View c = getChildAt(i);
if (c.getVisibility() == View.GONE) continue;
LayoutParams lp = getLayoutParams(c);
if (firstPass) {
measureChildWithMargins2(c, widthSpec, heightSpec, lp.width, lp.height);
} else {
boolean horizontal = (mOrientation == HORIZONTAL);
Spec spec = horizontal ? lp.columnSpec : lp.rowSpec;
if (spec.getAbsoluteAlignment(horizontal) == FILL) {
Interval span = spec.span;
Axis axis = horizontal ? mHorizontalAxis : mVerticalAxis;
int[] locations = axis.getLocations();
int cellSize = locations[span.max] - locations[span.min];
int viewSize = cellSize - getTotalMargin(c, horizontal);
if (horizontal) {
measureChildWithMargins2(c, widthSpec, heightSpec, viewSize, lp.height);
} else {
measureChildWithMargins2(c, widthSpec, heightSpec, lp.width, viewSize);
}
}
}
}
}
static int adjust(int measureSpec, int delta) {
return makeMeasureSpec(
MeasureSpec.getSize(measureSpec + delta), MeasureSpec.getMode(measureSpec));
}
@Override
protected void onMeasure(int widthSpec, int heightSpec) {
consistencyCheck();
/** If we have been called by {@link View#measure(int, int)}, one of width or height
* is likely to have changed. We must invalidate if so. */
invalidateValues();
int hPadding = getPaddingLeft() + getPaddingRight();
int vPadding = getPaddingTop() + getPaddingBottom();
int widthSpecSansPadding = adjust( widthSpec, -hPadding);
int heightSpecSansPadding = adjust(heightSpec, -vPadding);
measureChildrenWithMargins(widthSpecSansPadding, heightSpecSansPadding, true);
int widthSansPadding;
int heightSansPadding;
// Use the orientation property to decide which axis should be laid out first.
if (mOrientation == HORIZONTAL) {
widthSansPadding = mHorizontalAxis.getMeasure(widthSpecSansPadding);
measureChildrenWithMargins(widthSpecSansPadding, heightSpecSansPadding, false);
heightSansPadding = mVerticalAxis.getMeasure(heightSpecSansPadding);
} else {
heightSansPadding = mVerticalAxis.getMeasure(heightSpecSansPadding);
measureChildrenWithMargins(widthSpecSansPadding, heightSpecSansPadding, false);
widthSansPadding = mHorizontalAxis.getMeasure(widthSpecSansPadding);
}
int measuredWidth = Math.max(widthSansPadding + hPadding, getSuggestedMinimumWidth());
int measuredHeight = Math.max(heightSansPadding + vPadding, getSuggestedMinimumHeight());
setMeasuredDimension(
resolveSizeAndState(measuredWidth, widthSpec, 0),
resolveSizeAndState(measuredHeight, heightSpec, 0));
}
private int getMeasurement(View c, boolean horizontal) {
return horizontal ? c.getMeasuredWidth() : c.getMeasuredHeight();
}
final int getMeasurementIncludingMargin(View c, boolean horizontal) {
if (c.getVisibility() == View.GONE) {
return 0;
}
return getMeasurement(c, horizontal) + getTotalMargin(c, horizontal);
}
@Override
public void requestLayout() {
super.requestLayout();
invalidateValues();
}
// Layout container
/**
* {@inheritDoc}
*/
/*
The layout operation is implemented by delegating the heavy lifting to the
to the mHorizontalAxis and mVerticalAxis instances of the internal Axis class.
Together they compute the locations of the vertical and horizontal lines of
the grid (respectively!).
This method is then left with the simpler task of applying margins, gravity
and sizing to each child view and then placing it in its cell.
*/
@Override
protected void onLayout(boolean changed, int left, int top, int right, int bottom) {
consistencyCheck();
int targetWidth = right - left;
int targetHeight = bottom - top;
int paddingLeft = getPaddingLeft();
int paddingTop = getPaddingTop();
int paddingRight = getPaddingRight();
int paddingBottom = getPaddingBottom();
mHorizontalAxis.layout(targetWidth - paddingLeft - paddingRight);
mVerticalAxis.layout(targetHeight - paddingTop - paddingBottom);
int[] hLocations = mHorizontalAxis.getLocations();
int[] vLocations = mVerticalAxis.getLocations();
for (int i = 0, N = getChildCount(); i < N; i++) {
View c = getChildAt(i);
if (c.getVisibility() == View.GONE) continue;
LayoutParams lp = getLayoutParams(c);
Spec columnSpec = lp.columnSpec;
Spec rowSpec = lp.rowSpec;
Interval colSpan = columnSpec.span;
Interval rowSpan = rowSpec.span;
int x1 = hLocations[colSpan.min];
int y1 = vLocations[rowSpan.min];
int x2 = hLocations[colSpan.max];
int y2 = vLocations[rowSpan.max];
int cellWidth = x2 - x1;
int cellHeight = y2 - y1;
int pWidth = getMeasurement(c, true);
int pHeight = getMeasurement(c, false);
Alignment hAlign = columnSpec.getAbsoluteAlignment(true);
Alignment vAlign = rowSpec.getAbsoluteAlignment(false);
Bounds boundsX = mHorizontalAxis.getGroupBounds().getValue(i);
Bounds boundsY = mVerticalAxis.getGroupBounds().getValue(i);
// Gravity offsets: the location of the alignment group relative to its cell group.
int gravityOffsetX = hAlign.getGravityOffset(c, cellWidth - boundsX.size(true));
int gravityOffsetY = vAlign.getGravityOffset(c, cellHeight - boundsY.size(true));
int leftMargin = getMargin(c, true, true);
int topMargin = getMargin(c, false, true);
int rightMargin = getMargin(c, true, false);
int bottomMargin = getMargin(c, false, false);
int sumMarginsX = leftMargin + rightMargin;
int sumMarginsY = topMargin + bottomMargin;
// Alignment offsets: the location of the view relative to its alignment group.
int alignmentOffsetX = boundsX.getOffset(this, c, hAlign, pWidth + sumMarginsX, true);
int alignmentOffsetY = boundsY.getOffset(this, c, vAlign, pHeight + sumMarginsY, false);
int width = hAlign.getSizeInCell(c, pWidth, cellWidth - sumMarginsX);
int height = vAlign.getSizeInCell(c, pHeight, cellHeight - sumMarginsY);
int dx = x1 + gravityOffsetX + alignmentOffsetX;
int cx = !isLayoutRtl() ? paddingLeft + leftMargin + dx :
targetWidth - width - paddingRight - rightMargin - dx;
int cy = paddingTop + y1 + gravityOffsetY + alignmentOffsetY + topMargin;
if (width != c.getMeasuredWidth() || height != c.getMeasuredHeight()) {
c.measure(makeMeasureSpec(width, EXACTLY), makeMeasureSpec(height, EXACTLY));
}
c.layout(cx, cy, cx + width, cy + height);
}
}
@Override
public CharSequence getAccessibilityClassName() {
return GridLayout.class.getName();
}
// Inner classes
/*
This internal class houses the algorithm for computing the locations of grid lines;
along either the horizontal or vertical axis. A GridLayout uses two instances of this class -
distinguished by the "horizontal" flag which is true for the horizontal axis and false
for the vertical one.
*/
final class Axis {
private static final int NEW = 0;
private static final int PENDING = 1;
private static final int COMPLETE = 2;
public final boolean horizontal;
public int definedCount = UNDEFINED;
private int maxIndex = UNDEFINED;
PackedMap<Spec, Bounds> groupBounds;
public boolean groupBoundsValid = false;
PackedMap<Interval, MutableInt> forwardLinks;
public boolean forwardLinksValid = false;
PackedMap<Interval, MutableInt> backwardLinks;
public boolean backwardLinksValid = false;
public int[] leadingMargins;
public boolean leadingMarginsValid = false;
public int[] trailingMargins;
public boolean trailingMarginsValid = false;
public Arc[] arcs;
public boolean arcsValid = false;
public int[] locations;
public boolean locationsValid = false;
public boolean hasWeights;
public boolean hasWeightsValid = false;
public int[] deltas;
boolean orderPreserved = DEFAULT_ORDER_PRESERVED;
private MutableInt parentMin = new MutableInt(0);
private MutableInt parentMax = new MutableInt(-MAX_SIZE);
private Axis(boolean horizontal) {
this.horizontal = horizontal;
}
private int calculateMaxIndex() {
// the number Integer.MIN_VALUE + 1 comes up in undefined cells
int result = -1;
for (int i = 0, N = getChildCount(); i < N; i++) {
View c = getChildAt(i);
LayoutParams params = getLayoutParams(c);
Spec spec = horizontal ? params.columnSpec : params.rowSpec;
Interval span = spec.span;
result = max(result, span.min);
result = max(result, span.max);
result = max(result, span.size());
}
return result == -1 ? UNDEFINED : result;
}
private int getMaxIndex() {
if (maxIndex == UNDEFINED) {
maxIndex = max(0, calculateMaxIndex()); // use zero when there are no children
}
return maxIndex;
}
public int getCount() {
return max(definedCount, getMaxIndex());
}
public void setCount(int count) {
if (count != UNDEFINED && count < getMaxIndex()) {
handleInvalidParams((horizontal ? "column" : "row") +
"Count must be greater than or equal to the maximum of all grid indices " +
"(and spans) defined in the LayoutParams of each child");
}
this.definedCount = count;
}
public boolean isOrderPreserved() {
return orderPreserved;
}
public void setOrderPreserved(boolean orderPreserved) {
this.orderPreserved = orderPreserved;
invalidateStructure();
}
private PackedMap<Spec, Bounds> createGroupBounds() {
Assoc<Spec, Bounds> assoc = Assoc.of(Spec.class, Bounds.class);
for (int i = 0, N = getChildCount(); i < N; i++) {
View c = getChildAt(i);
// we must include views that are GONE here, see introductory javadoc
LayoutParams lp = getLayoutParams(c);
Spec spec = horizontal ? lp.columnSpec : lp.rowSpec;
Bounds bounds = spec.getAbsoluteAlignment(horizontal).getBounds();
assoc.put(spec, bounds);
}
return assoc.pack();
}
private void computeGroupBounds() {
Bounds[] values = groupBounds.values;
for (int i = 0; i < values.length; i++) {
values[i].reset();
}
for (int i = 0, N = getChildCount(); i < N; i++) {
View c = getChildAt(i);
// we must include views that are GONE here, see introductory javadoc
LayoutParams lp = getLayoutParams(c);
Spec spec = horizontal ? lp.columnSpec : lp.rowSpec;
int size = getMeasurementIncludingMargin(c, horizontal) +
((spec.weight == 0) ? 0 : getDeltas()[i]);
groupBounds.getValue(i).include(GridLayout.this, c, spec, this, size);
}
}
public PackedMap<Spec, Bounds> getGroupBounds() {
if (groupBounds == null) {
groupBounds = createGroupBounds();
}
if (!groupBoundsValid) {
computeGroupBounds();
groupBoundsValid = true;
}
return groupBounds;
}
// Add values computed by alignment - taking the max of all alignments in each span
private PackedMap<Interval, MutableInt> createLinks(boolean min) {
Assoc<Interval, MutableInt> result = Assoc.of(Interval.class, MutableInt.class);
Spec[] keys = getGroupBounds().keys;
for (int i = 0, N = keys.length; i < N; i++) {
Interval span = min ? keys[i].span : keys[i].span.inverse();
result.put(span, new MutableInt());
}
return result.pack();
}
private void computeLinks(PackedMap<Interval, MutableInt> links, boolean min) {
MutableInt[] spans = links.values;
for (int i = 0; i < spans.length; i++) {
spans[i].reset();
}
// Use getter to trigger a re-evaluation
Bounds[] bounds = getGroupBounds().values;
for (int i = 0; i < bounds.length; i++) {
int size = bounds[i].size(min);
MutableInt valueHolder = links.getValue(i);
// this effectively takes the max() of the minima and the min() of the maxima
valueHolder.value = max(valueHolder.value, min ? size : -size);
}
}
private PackedMap<Interval, MutableInt> getForwardLinks() {
if (forwardLinks == null) {
forwardLinks = createLinks(true);
}
if (!forwardLinksValid) {
computeLinks(forwardLinks, true);
forwardLinksValid = true;
}
return forwardLinks;
}
private PackedMap<Interval, MutableInt> getBackwardLinks() {
if (backwardLinks == null) {
backwardLinks = createLinks(false);
}
if (!backwardLinksValid) {
computeLinks(backwardLinks, false);
backwardLinksValid = true;
}
return backwardLinks;
}
private void include(List<Arc> arcs, Interval key, MutableInt size,
boolean ignoreIfAlreadyPresent) {
/*
Remove self referential links.
These appear:
. as parental constraints when GridLayout has no children
. when components have been marked as GONE
*/
if (key.size() == 0) {
return;
}
// this bit below should really be computed outside here -
// its just to stop default (row/col > 0) constraints obliterating valid entries
if (ignoreIfAlreadyPresent) {
for (Arc arc : arcs) {
Interval span = arc.span;
if (span.equals(key)) {
return;
}
}
}
arcs.add(new Arc(key, size));
}
private void include(List<Arc> arcs, Interval key, MutableInt size) {
include(arcs, key, size, true);
}
// Group arcs by their first vertex, returning an array of arrays.
// This is linear in the number of arcs.
Arc[][] groupArcsByFirstVertex(Arc[] arcs) {
int N = getCount() + 1; // the number of vertices
Arc[][] result = new Arc[N][];
int[] sizes = new int[N];
for (Arc arc : arcs) {
sizes[arc.span.min]++;
}
for (int i = 0; i < sizes.length; i++) {
result[i] = new Arc[sizes[i]];
}
// reuse the sizes array to hold the current last elements as we insert each arc
Arrays.fill(sizes, 0);
for (Arc arc : arcs) {
int i = arc.span.min;
result[i][sizes[i]++] = arc;
}
return result;
}
private Arc[] topologicalSort(final Arc[] arcs) {
return new Object() {
Arc[] result = new Arc[arcs.length];
int cursor = result.length - 1;
Arc[][] arcsByVertex = groupArcsByFirstVertex(arcs);
int[] visited = new int[getCount() + 1];
void walk(int loc) {
switch (visited[loc]) {
case NEW: {
visited[loc] = PENDING;
for (Arc arc : arcsByVertex[loc]) {
walk(arc.span.max);
result[cursor--] = arc;
}
visited[loc] = COMPLETE;
break;
}
case PENDING: {
// le singe est dans l'arbre
assert false;
break;
}
case COMPLETE: {
break;
}
}
}
Arc[] sort() {
for (int loc = 0, N = arcsByVertex.length; loc < N; loc++) {
walk(loc);
}
assert cursor == -1;
return result;
}
}.sort();
}
private Arc[] topologicalSort(List<Arc> arcs) {
return topologicalSort(arcs.toArray(new Arc[arcs.size()]));
}
private void addComponentSizes(List<Arc> result, PackedMap<Interval, MutableInt> links) {
for (int i = 0; i < links.keys.length; i++) {
Interval key = links.keys[i];
include(result, key, links.values[i], false);
}
}
private Arc[] createArcs() {
List<Arc> mins = new ArrayList<Arc>();
List<Arc> maxs = new ArrayList<Arc>();
// Add the minimum values from the components.
addComponentSizes(mins, getForwardLinks());
// Add the maximum values from the components.
addComponentSizes(maxs, getBackwardLinks());
// Add ordering constraints to prevent row/col sizes from going negative
if (orderPreserved) {
// Add a constraint for every row/col
for (int i = 0; i < getCount(); i++) {
include(mins, new Interval(i, i + 1), new MutableInt(0));
}
}
// Add the container constraints. Use the version of include that allows
// duplicate entries in case a child spans the entire grid.
int N = getCount();
include(mins, new Interval(0, N), parentMin, false);
include(maxs, new Interval(N, 0), parentMax, false);
// Sort
Arc[] sMins = topologicalSort(mins);
Arc[] sMaxs = topologicalSort(maxs);
return append(sMins, sMaxs);
}
private void computeArcs() {
// getting the links validates the values that are shared by the arc list
getForwardLinks();
getBackwardLinks();
}
public Arc[] getArcs() {
if (arcs == null) {
arcs = createArcs();
}
if (!arcsValid) {
computeArcs();
arcsValid = true;
}
return arcs;
}
private boolean relax(int[] locations, Arc entry) {
if (!entry.valid) {
return false;
}
Interval span = entry.span;
int u = span.min;
int v = span.max;
int value = entry.value.value;
int candidate = locations[u] + value;
if (candidate > locations[v]) {
locations[v] = candidate;
return true;
}
return false;
}
private void init(int[] locations) {
Arrays.fill(locations, 0);
}
private String arcsToString(List<Arc> arcs) {
String var = horizontal ? "x" : "y";
StringBuilder result = new StringBuilder();
boolean first = true;
for (Arc arc : arcs) {
if (first) {
first = false;
} else {
result = result.append(", ");
}
int src = arc.span.min;
int dst = arc.span.max;
int value = arc.value.value;
result.append((src < dst) ?
var + dst + "-" + var + src + ">=" + value :
var + src + "-" + var + dst + "<=" + -value);
}
return result.toString();
}
private void logError(String axisName, Arc[] arcs, boolean[] culprits0) {
List<Arc> culprits = new ArrayList<Arc>();
List<Arc> removed = new ArrayList<Arc>();
for (int c = 0; c < arcs.length; c++) {
Arc arc = arcs[c];
if (culprits0[c]) {
culprits.add(arc);
}
if (!arc.valid) {
removed.add(arc);
}
}
mPrinter.println(axisName + " constraints: " + arcsToString(culprits) +
" are inconsistent; permanently removing: " + arcsToString(removed) + ". ");
}
/*
Bellman-Ford variant - modified to reduce typical running time from O(N^2) to O(N)
GridLayout converts its requirements into a system of linear constraints of the
form:
x[i] - x[j] < a[k]
Where the x[i] are variables and the a[k] are constants.
For example, if the variables were instead labeled x, y, z we might have:
x - y < 17
y - z < 23
z - x < 42
This is a special case of the Linear Programming problem that is, in turn,
equivalent to the single-source shortest paths problem on a digraph, for
which the O(n^2) Bellman-Ford algorithm the most commonly used general solution.
*/
private boolean solve(Arc[] arcs, int[] locations) {
return solve(arcs, locations, true);
}
private boolean solve(Arc[] arcs, int[] locations, boolean modifyOnError) {
String axisName = horizontal ? "horizontal" : "vertical";
int N = getCount() + 1; // The number of vertices is the number of columns/rows + 1.
boolean[] originalCulprits = null;
for (int p = 0; p < arcs.length; p++) {
init(locations);
// We take one extra pass over traditional Bellman-Ford (and omit their final step)
for (int i = 0; i < N; i++) {
boolean changed = false;
for (int j = 0, length = arcs.length; j < length; j++) {
changed |= relax(locations, arcs[j]);
}
if (!changed) {
if (originalCulprits != null) {
logError(axisName, arcs, originalCulprits);
}
return true;
}
}
if (!modifyOnError) {
return false; // cannot solve with these constraints
}
boolean[] culprits = new boolean[arcs.length];
for (int i = 0; i < N; i++) {
for (int j = 0, length = arcs.length; j < length; j++) {
culprits[j] |= relax(locations, arcs[j]);
}
}
if (p == 0) {
originalCulprits = culprits;
}
for (int i = 0; i < arcs.length; i++) {
if (culprits[i]) {
Arc arc = arcs[i];
// Only remove max values, min values alone cannot be inconsistent
if (arc.span.min < arc.span.max) {
continue;
}
arc.valid = false;
break;
}
}
}
return true;
}
private void computeMargins(boolean leading) {
int[] margins = leading ? leadingMargins : trailingMargins;
for (int i = 0, N = getChildCount(); i < N; i++) {
View c = getChildAt(i);
if (c.getVisibility() == View.GONE) continue;
LayoutParams lp = getLayoutParams(c);
Spec spec = horizontal ? lp.columnSpec : lp.rowSpec;
Interval span = spec.span;
int index = leading ? span.min : span.max;
margins[index] = max(margins[index], getMargin1(c, horizontal, leading));
}
}
// External entry points
public int[] getLeadingMargins() {
if (leadingMargins == null) {
leadingMargins = new int[getCount() + 1];
}
if (!leadingMarginsValid) {
computeMargins(true);
leadingMarginsValid = true;
}
return leadingMargins;
}
public int[] getTrailingMargins() {
if (trailingMargins == null) {
trailingMargins = new int[getCount() + 1];
}
if (!trailingMarginsValid) {
computeMargins(false);
trailingMarginsValid = true;
}
return trailingMargins;
}
private boolean solve(int[] a) {
return solve(getArcs(), a);
}
private boolean computeHasWeights() {
for (int i = 0, N = getChildCount(); i < N; i++) {
final View child = getChildAt(i);
if (child.getVisibility() == View.GONE) {
continue;
}
LayoutParams lp = getLayoutParams(child);
Spec spec = horizontal ? lp.columnSpec : lp.rowSpec;
if (spec.weight != 0) {
return true;
}
}
return false;
}
private boolean hasWeights() {
if (!hasWeightsValid) {
hasWeights = computeHasWeights();
hasWeightsValid = true;
}
return hasWeights;
}
public int[] getDeltas() {
if (deltas == null) {
deltas = new int[getChildCount()];
}
return deltas;
}
private void shareOutDelta(int totalDelta, float totalWeight) {
Arrays.fill(deltas, 0);
for (int i = 0, N = getChildCount(); i < N; i++) {
final View c = getChildAt(i);
if (c.getVisibility() == View.GONE) {
continue;
}
LayoutParams lp = getLayoutParams(c);
Spec spec = horizontal ? lp.columnSpec : lp.rowSpec;
float weight = spec.weight;
if (weight != 0) {
int delta = Math.round((weight * totalDelta / totalWeight));
deltas[i] = delta;
// the two adjustments below are to counter the above rounding and avoid
// off-by-ones at the end
totalDelta -= delta;
totalWeight -= weight;
}
}
}
private void solveAndDistributeSpace(int[] a) {
Arrays.fill(getDeltas(), 0);
solve(a);
int deltaMax = parentMin.value * getChildCount() + 1; //exclusive
if (deltaMax < 2) {
return; //don't have any delta to distribute
}
int deltaMin = 0; //inclusive
float totalWeight = calculateTotalWeight();
int validDelta = -1; //delta for which a solution exists
boolean validSolution = true;
// do a binary search to find the max delta that won't conflict with constraints
while(deltaMin < deltaMax) {
// cast to long to prevent overflow.
final int delta = (int) (((long) deltaMin + deltaMax) / 2);
invalidateValues();
shareOutDelta(delta, totalWeight);
validSolution = solve(getArcs(), a, false);
if (validSolution) {
validDelta = delta;
deltaMin = delta + 1;
} else {
deltaMax = delta;
}
}
if (validDelta > 0 && !validSolution) {
// last solution was not successful but we have a successful one. Use it.
invalidateValues();
shareOutDelta(validDelta, totalWeight);
solve(a);
}
}
private float calculateTotalWeight() {
float totalWeight = 0f;
for (int i = 0, N = getChildCount(); i < N; i++) {
View c = getChildAt(i);
if (c.getVisibility() == View.GONE) {
continue;
}
LayoutParams lp = getLayoutParams(c);
Spec spec = horizontal ? lp.columnSpec : lp.rowSpec;
totalWeight += spec.weight;
}
return totalWeight;
}
private void computeLocations(int[] a) {
if (!hasWeights()) {
solve(a);
} else {
solveAndDistributeSpace(a);
}
if (!orderPreserved) {
// Solve returns the smallest solution to the constraint system for which all
// values are positive. One value is therefore zero - though if the row/col
// order is not preserved this may not be the first vertex. For consistency,
// translate all the values so that they measure the distance from a[0]; the
// leading edge of the parent. After this transformation some values may be
// negative.
int a0 = a[0];
for (int i = 0, N = a.length; i < N; i++) {
a[i] = a[i] - a0;
}
}
}
public int[] getLocations() {
if (locations == null) {
int N = getCount() + 1;
locations = new int[N];
}
if (!locationsValid) {
computeLocations(locations);
locationsValid = true;
}
return locations;
}
private int size(int[] locations) {
// The parental edges are attached to vertices 0 and N - even when order is not
// being preserved and other vertices fall outside this range. Measure the distance
// between vertices 0 and N, assuming that locations[0] = 0.
return locations[getCount()];
}
private void setParentConstraints(int min, int max) {
parentMin.value = min;
parentMax.value = -max;
locationsValid = false;
}
private int getMeasure(int min, int max) {
setParentConstraints(min, max);
return size(getLocations());
}
public int getMeasure(int measureSpec) {
int mode = MeasureSpec.getMode(measureSpec);
int size = MeasureSpec.getSize(measureSpec);
switch (mode) {
case MeasureSpec.UNSPECIFIED: {
return getMeasure(0, MAX_SIZE);
}
case MeasureSpec.EXACTLY: {
return getMeasure(size, size);
}
case MeasureSpec.AT_MOST: {
return getMeasure(0, size);
}
default: {
assert false;
return 0;
}
}
}
public void layout(int size) {
setParentConstraints(size, size);
getLocations();
}
public void invalidateStructure() {
maxIndex = UNDEFINED;
groupBounds = null;
forwardLinks = null;
backwardLinks = null;
leadingMargins = null;
trailingMargins = null;
arcs = null;
locations = null;
deltas = null;
hasWeightsValid = false;
invalidateValues();
}
public void invalidateValues() {
groupBoundsValid = false;
forwardLinksValid = false;
backwardLinksValid = false;
leadingMarginsValid = false;
trailingMarginsValid = false;
arcsValid = false;
locationsValid = false;
}
}
/**
* Layout information associated with each of the children of a GridLayout.
* <p>
* GridLayout supports both row and column spanning and arbitrary forms of alignment within
* each cell group. The fundamental parameters associated with each cell group are
* gathered into their vertical and horizontal components and stored
* in the {@link #rowSpec} and {@link #columnSpec} layout parameters.
* {@link GridLayout.Spec Specs} are immutable structures
* and may be shared between the layout parameters of different children.
* <p>
* The row and column specs contain the leading and trailing indices along each axis
* and together specify the four grid indices that delimit the cells of this cell group.
* <p>
* The alignment properties of the row and column specs together specify
* both aspects of alignment within the cell group. It is also possible to specify a child's
* alignment within its cell group by using the {@link GridLayout.LayoutParams#setGravity(int)}
* method.
* <p>
* The weight property is also included in Spec and specifies the proportion of any
* excess space that is due to the associated view.
*
* <h4>WRAP_CONTENT and MATCH_PARENT</h4>
*
* Because the default values of the {@link #width} and {@link #height}
* properties are both {@link #WRAP_CONTENT}, this value never needs to be explicitly
* declared in the layout parameters of GridLayout's children. In addition,
* GridLayout does not distinguish the special size value {@link #MATCH_PARENT} from
* {@link #WRAP_CONTENT}. A component's ability to expand to the size of the parent is
* instead controlled by the principle of <em>flexibility</em>,
* as discussed in {@link GridLayout}.
*
* <h4>Summary</h4>
*
* You should not need to use either of the special size values:
* {@code WRAP_CONTENT} or {@code MATCH_PARENT} when configuring the children of
* a GridLayout.
*
* <h4>Default values</h4>
*
* <ul>
* <li>{@link #width} = {@link #WRAP_CONTENT}</li>
* <li>{@link #height} = {@link #WRAP_CONTENT}</li>
* <li>{@link #topMargin} = 0 when
* {@link GridLayout#setUseDefaultMargins(boolean) useDefaultMargins} is
* {@code false}; otherwise {@link #UNDEFINED}, to
* indicate that a default value should be computed on demand. </li>
* <li>{@link #leftMargin} = 0 when
* {@link GridLayout#setUseDefaultMargins(boolean) useDefaultMargins} is
* {@code false}; otherwise {@link #UNDEFINED}, to
* indicate that a default value should be computed on demand. </li>
* <li>{@link #bottomMargin} = 0 when
* {@link GridLayout#setUseDefaultMargins(boolean) useDefaultMargins} is
* {@code false}; otherwise {@link #UNDEFINED}, to
* indicate that a default value should be computed on demand. </li>
* <li>{@link #rightMargin} = 0 when
* {@link GridLayout#setUseDefaultMargins(boolean) useDefaultMargins} is
* {@code false}; otherwise {@link #UNDEFINED}, to
* indicate that a default value should be computed on demand. </li>
* <li>{@link #rowSpec}<code>.row</code> = {@link #UNDEFINED} </li>
* <li>{@link #rowSpec}<code>.rowSpan</code> = 1 </li>
* <li>{@link #rowSpec}<code>.alignment</code> = {@link #BASELINE} </li>
* <li>{@link #rowSpec}<code>.weight</code> = 0 </li>
* <li>{@link #columnSpec}<code>.column</code> = {@link #UNDEFINED} </li>
* <li>{@link #columnSpec}<code>.columnSpan</code> = 1 </li>
* <li>{@link #columnSpec}<code>.alignment</code> = {@link #START} </li>
* <li>{@link #columnSpec}<code>.weight</code> = 0 </li>
* </ul>
*
* See {@link GridLayout} for a more complete description of the conventions
* used by GridLayout in the interpretation of the properties of this class.
*
* @attr ref android.R.styleable#GridLayout_Layout_layout_row
* @attr ref android.R.styleable#GridLayout_Layout_layout_rowSpan
* @attr ref android.R.styleable#GridLayout_Layout_layout_rowWeight
* @attr ref android.R.styleable#GridLayout_Layout_layout_column
* @attr ref android.R.styleable#GridLayout_Layout_layout_columnSpan
* @attr ref android.R.styleable#GridLayout_Layout_layout_columnWeight
* @attr ref android.R.styleable#GridLayout_Layout_layout_gravity
*/
public static class LayoutParams extends MarginLayoutParams {
// Default values
private static final int DEFAULT_WIDTH = WRAP_CONTENT;
private static final int DEFAULT_HEIGHT = WRAP_CONTENT;
private static final int DEFAULT_MARGIN = UNDEFINED;
private static final int DEFAULT_ROW = UNDEFINED;
private static final int DEFAULT_COLUMN = UNDEFINED;
private static final Interval DEFAULT_SPAN = new Interval(UNDEFINED, UNDEFINED + 1);
private static final int DEFAULT_SPAN_SIZE = DEFAULT_SPAN.size();
// TypedArray indices
private static final int MARGIN = R.styleable.ViewGroup_MarginLayout_layout_margin;
private static final int LEFT_MARGIN = R.styleable.ViewGroup_MarginLayout_layout_marginLeft;
private static final int TOP_MARGIN = R.styleable.ViewGroup_MarginLayout_layout_marginTop;
private static final int RIGHT_MARGIN =
R.styleable.ViewGroup_MarginLayout_layout_marginRight;
private static final int BOTTOM_MARGIN =
R.styleable.ViewGroup_MarginLayout_layout_marginBottom;
private static final int COLUMN = R.styleable.GridLayout_Layout_layout_column;
private static final int COLUMN_SPAN = R.styleable.GridLayout_Layout_layout_columnSpan;
private static final int COLUMN_WEIGHT = R.styleable.GridLayout_Layout_layout_columnWeight;
private static final int ROW = R.styleable.GridLayout_Layout_layout_row;
private static final int ROW_SPAN = R.styleable.GridLayout_Layout_layout_rowSpan;
private static final int ROW_WEIGHT = R.styleable.GridLayout_Layout_layout_rowWeight;
private static final int GRAVITY = R.styleable.GridLayout_Layout_layout_gravity;
// Instance variables
/**
* The spec that defines the vertical characteristics of the cell group
* described by these layout parameters.
* If an assignment is made to this field after a measurement or layout operation
* has already taken place, a call to
* {@link ViewGroup#setLayoutParams(ViewGroup.LayoutParams)}
* must be made to notify GridLayout of the change. GridLayout is normally able
* to detect when code fails to observe this rule, issue a warning and take steps to
* compensate for the omission. This facility is implemented on a best effort basis
* and should not be relied upon in production code - so it is best to include the above
* calls to remove the warnings as soon as it is practical.
*/
public Spec rowSpec = Spec.UNDEFINED;
/**
* The spec that defines the horizontal characteristics of the cell group
* described by these layout parameters.
* If an assignment is made to this field after a measurement or layout operation
* has already taken place, a call to
* {@link ViewGroup#setLayoutParams(ViewGroup.LayoutParams)}
* must be made to notify GridLayout of the change. GridLayout is normally able
* to detect when code fails to observe this rule, issue a warning and take steps to
* compensate for the omission. This facility is implemented on a best effort basis
* and should not be relied upon in production code - so it is best to include the above
* calls to remove the warnings as soon as it is practical.
*/
public Spec columnSpec = Spec.UNDEFINED;
// Constructors
private LayoutParams(
int width, int height,
int left, int top, int right, int bottom,
Spec rowSpec, Spec columnSpec) {
super(width, height);
setMargins(left, top, right, bottom);
this.rowSpec = rowSpec;
this.columnSpec = columnSpec;
}
/**
* Constructs a new LayoutParams instance for this <code>rowSpec</code>
* and <code>columnSpec</code>. All other fields are initialized with
* default values as defined in {@link LayoutParams}.
*
* @param rowSpec the rowSpec
* @param columnSpec the columnSpec
*/
public LayoutParams(Spec rowSpec, Spec columnSpec) {
this(DEFAULT_WIDTH, DEFAULT_HEIGHT,
DEFAULT_MARGIN, DEFAULT_MARGIN, DEFAULT_MARGIN, DEFAULT_MARGIN,
rowSpec, columnSpec);
}
/**
* Constructs a new LayoutParams with default values as defined in {@link LayoutParams}.
*/
public LayoutParams() {
this(Spec.UNDEFINED, Spec.UNDEFINED);
}
// Copying constructors
/**
* {@inheritDoc}
*/
public LayoutParams(ViewGroup.LayoutParams params) {
super(params);
}
/**
* {@inheritDoc}
*/
public LayoutParams(MarginLayoutParams params) {
super(params);
}
/**
* Copy constructor. Clones the width, height, margin values, row spec,
* and column spec of the source.
*
* @param source The layout params to copy from.
*/
public LayoutParams(LayoutParams source) {
super(source);
this.rowSpec = source.rowSpec;
this.columnSpec = source.columnSpec;
}
// AttributeSet constructors
/**
* {@inheritDoc}
*
* Values not defined in the attribute set take the default values
* defined in {@link LayoutParams}.
*/
public LayoutParams(Context context, AttributeSet attrs) {
super(context, attrs);
reInitSuper(context, attrs);
init(context, attrs);
}
// Implementation
// Reinitialise the margins using a different default policy than MarginLayoutParams.
// Here we use the value UNDEFINED (as distinct from zero) to represent the undefined state
// so that a layout manager default can be accessed post set up. We need this as, at the
// point of installation, we do not know how many rows/cols there are and therefore
// which elements are positioned next to the container's trailing edges. We need to
// know this as margins around the container's boundary should have different
// defaults to those between peers.
// This method could be parametrized and moved into MarginLayout.
private void reInitSuper(Context context, AttributeSet attrs) {
TypedArray a =
context.obtainStyledAttributes(attrs, R.styleable.ViewGroup_MarginLayout);
try {
int margin = a.getDimensionPixelSize(MARGIN, DEFAULT_MARGIN);
this.leftMargin = a.getDimensionPixelSize(LEFT_MARGIN, margin);
this.topMargin = a.getDimensionPixelSize(TOP_MARGIN, margin);
this.rightMargin = a.getDimensionPixelSize(RIGHT_MARGIN, margin);
this.bottomMargin = a.getDimensionPixelSize(BOTTOM_MARGIN, margin);
} finally {
a.recycle();
}
}
private void init(Context context, AttributeSet attrs) {
TypedArray a = context.obtainStyledAttributes(attrs, R.styleable.GridLayout_Layout);
try {
int gravity = a.getInt(GRAVITY, Gravity.NO_GRAVITY);
int column = a.getInt(COLUMN, DEFAULT_COLUMN);
int colSpan = a.getInt(COLUMN_SPAN, DEFAULT_SPAN_SIZE);
float colWeight = a.getFloat(COLUMN_WEIGHT, Spec.DEFAULT_WEIGHT);
this.columnSpec = spec(column, colSpan, getAlignment(gravity, true), colWeight);
int row = a.getInt(ROW, DEFAULT_ROW);
int rowSpan = a.getInt(ROW_SPAN, DEFAULT_SPAN_SIZE);
float rowWeight = a.getFloat(ROW_WEIGHT, Spec.DEFAULT_WEIGHT);
this.rowSpec = spec(row, rowSpan, getAlignment(gravity, false), rowWeight);
} finally {
a.recycle();
}
}
/**
* Describes how the child views are positioned. Default is {@code LEFT | BASELINE}.
* See {@link Gravity}.
*
* @param gravity the new gravity value
*
* @attr ref android.R.styleable#GridLayout_Layout_layout_gravity
*/
public void setGravity(int gravity) {
rowSpec = rowSpec.copyWriteAlignment(getAlignment(gravity, false));
columnSpec = columnSpec.copyWriteAlignment(getAlignment(gravity, true));
}
@Override
protected void setBaseAttributes(TypedArray attributes, int widthAttr, int heightAttr) {
this.width = attributes.getLayoutDimension(widthAttr, DEFAULT_WIDTH);
this.height = attributes.getLayoutDimension(heightAttr, DEFAULT_HEIGHT);
}
final void setRowSpecSpan(Interval span) {
rowSpec = rowSpec.copyWriteSpan(span);
}
final void setColumnSpecSpan(Interval span) {
columnSpec = columnSpec.copyWriteSpan(span);
}
@Override
public boolean equals(Object o) {
if (this == o) return true;
if (o == null || getClass() != o.getClass()) return false;
LayoutParams that = (LayoutParams) o;
if (!columnSpec.equals(that.columnSpec)) return false;
if (!rowSpec.equals(that.rowSpec)) return false;
return true;
}
@Override
public int hashCode() {
int result = rowSpec.hashCode();
result = 31 * result + columnSpec.hashCode();
return result;
}
}
/*
In place of a HashMap from span to Int, use an array of key/value pairs - stored in Arcs.
Add the mutables completesCycle flag to avoid creating another hash table for detecting cycles.
*/
final static class Arc {
public final Interval span;
public final MutableInt value;
public boolean valid = true;
public Arc(Interval span, MutableInt value) {
this.span = span;
this.value = value;
}
@Override
public String toString() {
return span + " " + (!valid ? "+>" : "->") + " " + value;
}
}
// A mutable Integer - used to avoid heap allocation during the layout operation
final static class MutableInt {
public int value;
public MutableInt() {
reset();
}
public MutableInt(int value) {
this.value = value;
}
public void reset() {
value = Integer.MIN_VALUE;
}
@Override
public String toString() {
return Integer.toString(value);
}
}
final static class Assoc<K, V> extends ArrayList<Pair<K, V>> {
private final Class<K> keyType;
private final Class<V> valueType;
private Assoc(Class<K> keyType, Class<V> valueType) {
this.keyType = keyType;
this.valueType = valueType;
}
public static <K, V> Assoc<K, V> of(Class<K> keyType, Class<V> valueType) {
return new Assoc<K, V>(keyType, valueType);
}
public void put(K key, V value) {
add(Pair.create(key, value));
}
@SuppressWarnings(value = "unchecked")
public PackedMap<K, V> pack() {
int N = size();
K[] keys = (K[]) Array.newInstance(keyType, N);
V[] values = (V[]) Array.newInstance(valueType, N);
for (int i = 0; i < N; i++) {
keys[i] = get(i).first;
values[i] = get(i).second;
}
return new PackedMap<K, V>(keys, values);
}
}
/*
This data structure is used in place of a Map where we have an index that refers to the order
in which each key/value pairs were added to the map. In this case we store keys and values
in arrays of a length that is equal to the number of unique keys. We also maintain an
array of indexes from insertion order to the compacted arrays of keys and values.
Note that behavior differs from that of a LinkedHashMap in that repeated entries
*do* get added multiples times. So the length of index is equals to the number of
items added.
This is useful in the GridLayout class where we can rely on the order of children not
changing during layout - to use integer-based lookup for our internal structures
rather than using (and storing) an implementation of Map<Key, ?>.
*/
@SuppressWarnings(value = "unchecked")
final static class PackedMap<K, V> {
public final int[] index;
public final K[] keys;
public final V[] values;
private PackedMap(K[] keys, V[] values) {
this.index = createIndex(keys);
this.keys = compact(keys, index);
this.values = compact(values, index);
}
public V getValue(int i) {
return values[index[i]];
}
private static <K> int[] createIndex(K[] keys) {
int size = keys.length;
int[] result = new int[size];
Map<K, Integer> keyToIndex = new HashMap<K, Integer>();
for (int i = 0; i < size; i++) {
K key = keys[i];
Integer index = keyToIndex.get(key);
if (index == null) {
index = keyToIndex.size();
keyToIndex.put(key, index);
}
result[i] = index;
}
return result;
}
/*
Create a compact array of keys or values using the supplied index.
*/
private static <K> K[] compact(K[] a, int[] index) {
int size = a.length;
Class<?> componentType = a.getClass().getComponentType();
K[] result = (K[]) Array.newInstance(componentType, max2(index, -1) + 1);
// this overwrite duplicates, retaining the last equivalent entry
for (int i = 0; i < size; i++) {
result[index[i]] = a[i];
}
return result;
}
}
/*
For each group (with a given alignment) we need to store the amount of space required
before the alignment point and the amount of space required after it. One side of this
calculation is always 0 for START and END alignments but we don't make use of this.
For CENTER and BASELINE alignments both sides are needed and in the BASELINE case no
simple optimisations are possible.
The general algorithm therefore is to create a Map (actually a PackedMap) from
group to Bounds and to loop through all Views in the group taking the maximum
of the values for each View.
*/
static class Bounds {
public int before;
public int after;
public int flexibility; // we're flexible iff all included specs are flexible
private Bounds() {
reset();
}
protected void reset() {
before = Integer.MIN_VALUE;
after = Integer.MIN_VALUE;
flexibility = CAN_STRETCH; // from the above, we're flexible when empty
}
protected void include(int before, int after) {
this.before = max(this.before, before);
this.after = max(this.after, after);
}
protected int size(boolean min) {
if (!min) {
if (canStretch(flexibility)) {
return MAX_SIZE;
}
}
return before + after;
}
protected int getOffset(GridLayout gl, View c, Alignment a, int size, boolean horizontal) {
return before - a.getAlignmentValue(c, size, gl.getLayoutMode());
}
protected final void include(GridLayout gl, View c, Spec spec, Axis axis, int size) {
this.flexibility &= spec.getFlexibility();
boolean horizontal = axis.horizontal;
Alignment alignment = spec.getAbsoluteAlignment(axis.horizontal);
// todo test this works correctly when the returned value is UNDEFINED
int before = alignment.getAlignmentValue(c, size, gl.getLayoutMode());
include(before, size - before);
}
@Override
public String toString() {
return "Bounds{" +
"before=" + before +
", after=" + after +
'}';
}
}
/**
* An Interval represents a contiguous range of values that lie between
* the interval's {@link #min} and {@link #max} values.
* <p>
* Intervals are immutable so may be passed as values and used as keys in hash tables.
* It is not necessary to have multiple instances of Intervals which have the same
* {@link #min} and {@link #max} values.
* <p>
* Intervals are often written as {@code [min, max]} and represent the set of values
* {@code x} such that {@code min <= x < max}.
*/
final static class Interval {
/**
* The minimum value.
*/
public final int min;
/**
* The maximum value.
*/
public final int max;
/**
* Construct a new Interval, {@code interval}, where:
* <ul>
* <li> {@code interval.min = min} </li>
* <li> {@code interval.max = max} </li>
* </ul>
*
* @param min the minimum value.
* @param max the maximum value.
*/
public Interval(int min, int max) {
this.min = min;
this.max = max;
}
int size() {
return max - min;
}
Interval inverse() {
return new Interval(max, min);
}
/**
* Returns {@code true} if the {@link #getClass class},
* {@link #min} and {@link #max} properties of this Interval and the
* supplied parameter are pairwise equal; {@code false} otherwise.
*
* @param that the object to compare this interval with
*
* @return {@code true} if the specified object is equal to this
* {@code Interval}, {@code false} otherwise.
*/
@Override
public boolean equals(Object that) {
if (this == that) {
return true;
}
if (that == null || getClass() != that.getClass()) {
return false;
}
Interval interval = (Interval) that;
if (max != interval.max) {
return false;
}
//noinspection RedundantIfStatement
if (min != interval.min) {
return false;
}
return true;
}
@Override
public int hashCode() {
int result = min;
result = 31 * result + max;
return result;
}
@Override
public String toString() {
return "[" + min + ", " + max + "]";
}
}
/**
* A Spec defines the horizontal or vertical characteristics of a group of
* cells. Each spec. defines the <em>grid indices</em> and <em>alignment</em>
* along the appropriate axis.
* <p>
* The <em>grid indices</em> are the leading and trailing edges of this cell group.
* See {@link GridLayout} for a description of the conventions used by GridLayout
* for grid indices.
* <p>
* The <em>alignment</em> property specifies how cells should be aligned in this group.
* For row groups, this specifies the vertical alignment.
* For column groups, this specifies the horizontal alignment.
* <p>
* Use the following static methods to create specs:
* <ul>
* <li>{@link #spec(int)}</li>
* <li>{@link #spec(int, int)}</li>
* <li>{@link #spec(int, Alignment)}</li>
* <li>{@link #spec(int, int, Alignment)}</li>
* <li>{@link #spec(int, float)}</li>
* <li>{@link #spec(int, int, float)}</li>
* <li>{@link #spec(int, Alignment, float)}</li>
* <li>{@link #spec(int, int, Alignment, float)}</li>
* </ul>
*
*/
public static class Spec {
static final Spec UNDEFINED = spec(GridLayout.UNDEFINED);
static final float DEFAULT_WEIGHT = 0;
final boolean startDefined;
final Interval span;
final Alignment alignment;
final float weight;
private Spec(boolean startDefined, Interval span, Alignment alignment, float weight) {
this.startDefined = startDefined;
this.span = span;
this.alignment = alignment;
this.weight = weight;
}
private Spec(boolean startDefined, int start, int size, Alignment alignment, float weight) {
this(startDefined, new Interval(start, start + size), alignment, weight);
}
private Alignment getAbsoluteAlignment(boolean horizontal) {
if (alignment != UNDEFINED_ALIGNMENT) {
return alignment;
}
if (weight == 0f) {
return horizontal ? START : BASELINE;
}
return FILL;
}
final Spec copyWriteSpan(Interval span) {
return new Spec(startDefined, span, alignment, weight);
}
final Spec copyWriteAlignment(Alignment alignment) {
return new Spec(startDefined, span, alignment, weight);
}
final int getFlexibility() {
return (alignment == UNDEFINED_ALIGNMENT && weight == 0) ? INFLEXIBLE : CAN_STRETCH;
}
/**
* Returns {@code true} if the {@code class}, {@code alignment} and {@code span}
* properties of this Spec and the supplied parameter are pairwise equal,
* {@code false} otherwise.
*
* @param that the object to compare this spec with
*
* @return {@code true} if the specified object is equal to this
* {@code Spec}; {@code false} otherwise
*/
@Override
public boolean equals(Object that) {
if (this == that) {
return true;
}
if (that == null || getClass() != that.getClass()) {
return false;
}
Spec spec = (Spec) that;
if (!alignment.equals(spec.alignment)) {
return false;
}
//noinspection RedundantIfStatement
if (!span.equals(spec.span)) {
return false;
}
return true;
}
@Override
public int hashCode() {
int result = span.hashCode();
result = 31 * result + alignment.hashCode();
return result;
}
}
/**
* Return a Spec, {@code spec}, where:
* <ul>
* <li> {@code spec.span = [start, start + size]} </li>
* <li> {@code spec.alignment = alignment} </li>
* <li> {@code spec.weight = weight} </li>
* </ul>
* <p>
* To leave the start index undefined, use the value {@link #UNDEFINED}.
*
* @param start the start
* @param size the size
* @param alignment the alignment
* @param weight the weight
*/
public static Spec spec(int start, int size, Alignment alignment, float weight) {
return new Spec(start != UNDEFINED, start, size, alignment, weight);
}
/**
* Equivalent to: {@code spec(start, 1, alignment, weight)}.
*
* @param start the start
* @param alignment the alignment
* @param weight the weight
*/
public static Spec spec(int start, Alignment alignment, float weight) {
return spec(start, 1, alignment, weight);
}
/**
* Equivalent to: {@code spec(start, 1, default_alignment, weight)} -
* where {@code default_alignment} is specified in
* {@link android.widget.GridLayout.LayoutParams}.
*
* @param start the start
* @param size the size
* @param weight the weight
*/
public static Spec spec(int start, int size, float weight) {
return spec(start, size, UNDEFINED_ALIGNMENT, weight);
}
/**
* Equivalent to: {@code spec(start, 1, weight)}.
*
* @param start the start
* @param weight the weight
*/
public static Spec spec(int start, float weight) {
return spec(start, 1, weight);
}
/**
* Equivalent to: {@code spec(start, size, alignment, 0f)}.
*
* @param start the start
* @param size the size
* @param alignment the alignment
*/
public static Spec spec(int start, int size, Alignment alignment) {
return spec(start, size, alignment, Spec.DEFAULT_WEIGHT);
}
/**
* Return a Spec, {@code spec}, where:
* <ul>
* <li> {@code spec.span = [start, start + 1]} </li>
* <li> {@code spec.alignment = alignment} </li>
* </ul>
* <p>
* To leave the start index undefined, use the value {@link #UNDEFINED}.
*
* @param start the start index
* @param alignment the alignment
*
* @see #spec(int, int, Alignment)
*/
public static Spec spec(int start, Alignment alignment) {
return spec(start, 1, alignment);
}
/**
* Return a Spec, {@code spec}, where:
* <ul>
* <li> {@code spec.span = [start, start + size]} </li>
* </ul>
* <p>
* To leave the start index undefined, use the value {@link #UNDEFINED}.
*
* @param start the start
* @param size the size
*
* @see #spec(int, Alignment)
*/
public static Spec spec(int start, int size) {
return spec(start, size, UNDEFINED_ALIGNMENT);
}
/**
* Return a Spec, {@code spec}, where:
* <ul>
* <li> {@code spec.span = [start, start + 1]} </li>
* </ul>
* <p>
* To leave the start index undefined, use the value {@link #UNDEFINED}.
*
* @param start the start index
*
* @see #spec(int, int)
*/
public static Spec spec(int start) {
return spec(start, 1);
}
/**
* Alignments specify where a view should be placed within a cell group and
* what size it should be.
* <p>
* The {@link LayoutParams} class contains a {@link LayoutParams#rowSpec rowSpec}
* and a {@link LayoutParams#columnSpec columnSpec} each of which contains an
* {@code alignment}. Overall placement of the view in the cell
* group is specified by the two alignments which act along each axis independently.
* <p>
* The GridLayout class defines the most common alignments used in general layout:
* {@link #TOP}, {@link #LEFT}, {@link #BOTTOM}, {@link #RIGHT}, {@link #START},
* {@link #END}, {@link #CENTER}, {@link #BASELINE} and {@link #FILL}.
*/
/*
* An Alignment implementation must define {@link #getAlignmentValue(View, int, int)},
* to return the appropriate value for the type of alignment being defined.
* The enclosing algorithms position the children
* so that the locations defined by the alignment values
* are the same for all of the views in a group.
* <p>
*/
public static abstract class Alignment {
Alignment() {
}
abstract int getGravityOffset(View view, int cellDelta);
/**
* Returns an alignment value. In the case of vertical alignments the value
* returned should indicate the distance from the top of the view to the
* alignment location.
* For horizontal alignments measurement is made from the left edge of the component.
*
* @param view the view to which this alignment should be applied
* @param viewSize the measured size of the view
* @param mode the basis of alignment: CLIP or OPTICAL
* @return the alignment value
*/
abstract int getAlignmentValue(View view, int viewSize, int mode);
/**
* Returns the size of the view specified by this alignment.
* In the case of vertical alignments this method should return a height; for
* horizontal alignments this method should return the width.
* <p>
* The default implementation returns {@code viewSize}.
*
* @param view the view to which this alignment should be applied
* @param viewSize the measured size of the view
* @param cellSize the size of the cell into which this view will be placed
* @return the aligned size
*/
int getSizeInCell(View view, int viewSize, int cellSize) {
return viewSize;
}
Bounds getBounds() {
return new Bounds();
}
}
@UnsupportedAppUsage
static final Alignment UNDEFINED_ALIGNMENT = new Alignment() {
@Override
int getGravityOffset(View view, int cellDelta) {
return UNDEFINED;
}
@Override
public int getAlignmentValue(View view, int viewSize, int mode) {
return UNDEFINED;
}
};
/**
* Indicates that a view should be aligned with the <em>start</em>
* edges of the other views in its cell group.
*/
private static final Alignment LEADING = new Alignment() {
@Override
int getGravityOffset(View view, int cellDelta) {
return 0;
}
@Override
public int getAlignmentValue(View view, int viewSize, int mode) {
return 0;
}
};
/**
* Indicates that a view should be aligned with the <em>end</em>
* edges of the other views in its cell group.
*/
private static final Alignment TRAILING = new Alignment() {
@Override
int getGravityOffset(View view, int cellDelta) {
return cellDelta;
}
@Override
public int getAlignmentValue(View view, int viewSize, int mode) {
return viewSize;
}
};
/**
* Indicates that a view should be aligned with the <em>top</em>
* edges of the other views in its cell group.
*/
public static final Alignment TOP = LEADING;
/**
* Indicates that a view should be aligned with the <em>bottom</em>
* edges of the other views in its cell group.
*/
public static final Alignment BOTTOM = TRAILING;
/**
* Indicates that a view should be aligned with the <em>start</em>
* edges of the other views in its cell group.
*/
public static final Alignment START = LEADING;
/**
* Indicates that a view should be aligned with the <em>end</em>
* edges of the other views in its cell group.
*/
public static final Alignment END = TRAILING;
private static Alignment createSwitchingAlignment(final Alignment ltr, final Alignment rtl) {
return new Alignment() {
@Override
int getGravityOffset(View view, int cellDelta) {
return (!view.isLayoutRtl() ? ltr : rtl).getGravityOffset(view, cellDelta);
}
@Override
public int getAlignmentValue(View view, int viewSize, int mode) {
return (!view.isLayoutRtl() ? ltr : rtl).getAlignmentValue(view, viewSize, mode);
}
};
}
/**
* Indicates that a view should be aligned with the <em>left</em>
* edges of the other views in its cell group.
*/
public static final Alignment LEFT = createSwitchingAlignment(START, END);
/**
* Indicates that a view should be aligned with the <em>right</em>
* edges of the other views in its cell group.
*/
public static final Alignment RIGHT = createSwitchingAlignment(END, START);
/**
* Indicates that a view should be <em>centered</em> with the other views in its cell group.
* This constant may be used in both {@link LayoutParams#rowSpec rowSpecs} and {@link
* LayoutParams#columnSpec columnSpecs}.
*/
public static final Alignment CENTER = new Alignment() {
@Override
int getGravityOffset(View view, int cellDelta) {
return cellDelta >> 1;
}
@Override
public int getAlignmentValue(View view, int viewSize, int mode) {
return viewSize >> 1;
}
};
/**
* Indicates that a view should be aligned with the <em>baselines</em>
* of the other views in its cell group.
* This constant may only be used as an alignment in {@link LayoutParams#rowSpec rowSpecs}.
*
* @see View#getBaseline()
*/
public static final Alignment BASELINE = new Alignment() {
@Override
int getGravityOffset(View view, int cellDelta) {
return 0; // baseline gravity is top
}
@Override
public int getAlignmentValue(View view, int viewSize, int mode) {
if (view.getVisibility() == GONE) {
return 0;
}
int baseline = view.getBaseline();
return baseline == -1 ? UNDEFINED : baseline;
}
@Override
public Bounds getBounds() {
return new Bounds() {
/*
In a baseline aligned row in which some components define a baseline
and some don't, we need a third variable to properly account for all
the sizes. This tracks the maximum size of all the components -
including those that don't define a baseline.
*/
private int size;
@Override
protected void reset() {
super.reset();
size = Integer.MIN_VALUE;
}
@Override
protected void include(int before, int after) {
super.include(before, after);
size = max(size, before + after);
}
@Override
protected int size(boolean min) {
return max(super.size(min), size);
}
@Override
protected int getOffset(GridLayout gl, View c, Alignment a, int size, boolean hrz) {
return max(0, super.getOffset(gl, c, a, size, hrz));
}
};
}
};
/**
* Indicates that a view should expanded to fit the boundaries of its cell group.
* This constant may be used in both {@link LayoutParams#rowSpec rowSpecs} and
* {@link LayoutParams#columnSpec columnSpecs}.
*/
public static final Alignment FILL = new Alignment() {
@Override
int getGravityOffset(View view, int cellDelta) {
return 0;
}
@Override
public int getAlignmentValue(View view, int viewSize, int mode) {
return UNDEFINED;
}
@Override
public int getSizeInCell(View view, int viewSize, int cellSize) {
return cellSize;
}
};
static boolean canStretch(int flexibility) {
return (flexibility & CAN_STRETCH) != 0;
}
private static final int INFLEXIBLE = 0;
private static final int CAN_STRETCH = 2;
}
|