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
|
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2012 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.faces.component;
import java.io.IOException;
import java.io.Serializable;
import java.sql.ResultSet;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import javax.el.ValueExpression;
import javax.faces.FacesException;
import javax.faces.application.Application;
import javax.faces.application.FacesMessage;
import javax.faces.application.StateManager;
import javax.faces.component.visit.VisitCallback;
import javax.faces.component.visit.VisitContext;
import javax.faces.component.visit.VisitHint;
import javax.faces.component.visit.VisitResult;
import javax.faces.context.FacesContext;
import javax.faces.el.ValueBinding;
import javax.faces.event.AbortProcessingException;
import javax.faces.event.FacesEvent;
import javax.faces.event.FacesListener;
import javax.faces.event.PhaseId;
import javax.faces.event.PostValidateEvent;
import javax.faces.event.PreValidateEvent;
import javax.faces.model.ArrayDataModel;
import javax.faces.model.CollectionDataModel;
import javax.faces.model.DataModel;
import javax.faces.model.ListDataModel;
import javax.faces.model.ResultDataModel;
import javax.faces.model.ResultSetDataModel;
import javax.faces.model.ScalarDataModel;
import javax.servlet.jsp.jstl.sql.Result;
// ------------------------------------------------------------- Private Classes
// Private class to represent saved state information
/**
* <p><strong class="changed_modified_2_0_rev_a
* changed_modified_2_1 changed_modified_2_2">UIData</strong> is a {@link UIComponent} that
* supports data binding to a collection of data objects represented by
* a {@link DataModel} instance, which is the current value of this
* component itself (typically established via a {@link
* ValueExpression}). During iterative processing over the rows of data
* in the data model, the object for the current row is exposed as a
* request attribute under the key specified by the <code>var</code>
* property.</p> <p/> <p>Only children of type {@link UIColumn} should
* be processed by renderers associated with this component.</p> <p/>
* <p>By default, the <code>rendererType</code> property is set to
* <code>javax.faces.Table</code>. This value can be changed by calling
* the <code>setRendererType()</code> method.</p>
*/
public class UIData extends UIComponentBase
implements NamingContainer, UniqueIdVendor {
// ------------------------------------------------------ Manifest Constants
/**
* <p>The standard component type for this component.</p>
*/
public static final String COMPONENT_TYPE = "javax.faces.Data";
/**
* <p>The standard component family for this component.</p>
*/
public static final String COMPONENT_FAMILY = "javax.faces.Data";
// ------------------------------------------------------------ Constructors
/**
* <p>Create a new {@link UIData} instance with default property
* values.</p>
*/
public UIData() {
super();
setRendererType("javax.faces.Table");
}
// ------------------------------------------------------ Instance Variables
/**
* Properties that are tracked by state saving.
*/
enum PropertyKeys {
/**
* <p>The first row number (zero-relative) to be displayed.</p>
*/
first,
/**
* <p>The zero-relative index of the current row number, or -1 for no
* current row association.</p>
*/
rowIndex,
/**
* <p>The number of rows to display, or zero for all remaining rows in the
* table.</p>
*/
rows,
/**
* <p>This map contains <code>SavedState</code> instances for each
* descendant component, keyed by the client identifier of the descendant.
* Because descendant client identifiers will contain the
* <code>rowIndex</code> value of the parent, per-row state information is
* actually preserved.</p>
*/
saved,
/**
* <p>The local value of this {@link UIComponent}.</p>
*/
value,
/**
* <p>The request scope attribute under which the data object for the
* current row will be exposed when iterating.</p>
*/
var,
/**
* <p>Last id vended by {@link UIData#createUniqueId(javax.faces.context.FacesContext, String)}.</p>
*/
lastId,
/**
*
*/
rowStatePreserved
}
/**
* <p>The {@link DataModel} associated with this component, lazily
* instantiated if requested. This object is not part of the saved and
* restored state of the component.</p>
*/
private DataModel model = null;
/**
* <p> During iteration through the rows of this table, This ivar is used to
* store the previous "var" value for this instance. When the row iteration
* is complete, this value is restored to the request map.
*/
private Object oldVar;
/**
* <p>Holds the base client ID that will be used to generate per-row
* client IDs (this will be null if this UIData is nested within another).</p>
*
* <p>This is not part of the component state.</p>
*/
private String baseClientId = null;
/**
* <p> Length of the cached <code>baseClientId</code> plus one for
* the {@link UINamingContainer#getSeparatorChar}. </p>
*
* <p>This is not part of the component state.</p>
*/
private int baseClientIdLength;
/**
* <p>StringBuilder used to build per-row client IDs.</p>
*
* <p>This is not part of the component state.</p>
*/
private StringBuilder clientIdBuilder = null;
/**
* <p>Flag indicating whether or not this UIData instance is nested
* within another UIData instance</p>
*
* <p>This is not part of the component state.</p>
*/
private Boolean isNested = null;
private Map<String, Object> _rowDeltaStates = new HashMap<String, Object>();
private Map<String, Object> _rowTransientStates = new HashMap<String, Object>();
private Object _initialDescendantFullComponentState = null;
// -------------------------------------------------------------- Properties
public String getFamily() {
return (COMPONENT_FAMILY);
}
/**
* <p>Return the zero-relative row number of the first row to be
* displayed.</p>
*/
public int getFirst() {
return (Integer) getStateHelper().eval(PropertyKeys.first, 0);
}
/**
* <p>Set the zero-relative row number of the first row to be
* displayed.</p>
*
* @param first New first row number
*
* @throws IllegalArgumentException if <code>first</code> is negative
*/
public void setFirst(int first) {
if (first < 0) {
throw new IllegalArgumentException(String.valueOf(first));
}
getStateHelper().put(PropertyKeys.first, first);
}
/**
* <p>Return the footer facet of this component (if any). A convenience
* method for <code>getFacet("footer")</code>.</p>
*/
public UIComponent getFooter() {
return getFacet("footer");
}
/**
* <p>Set the footer facet of this component. A convenience method for
* <code>getFacets().put("footer", footer)</code>.</p>
*
* @param footer the new footer facet
*
* @throws NullPointerException if <code>footer</code> is <code>null</code>
*/
public void setFooter(UIComponent footer) {
getFacets().put("footer", footer);
}
/**
* <p>Return the header facet of this component (if any). A convenience
* method for <code>getFacet("header")</code>.</p>
*/
public UIComponent getHeader() {
return getFacet("header");
}
/**
* <p>Set the header facet of this component. A convenience method for
* <code>getFacets().put("header", header)</code>.</p>
*
* @param header the new header facet
*
* @throws NullPointerException if <code>header</code> is <code>null</code>
*/
public void setHeader(UIComponent header) {
getFacets().put("header", header);
}
/**
* <p>Return a flag indicating whether there is <code>rowData</code>
* available at the current <code>rowIndex</code>. If no
* <code>wrappedData</code> is available, return <code>false</code>.</p>
*
* @throws FacesException if an error occurs getting the row availability
*/
public boolean isRowAvailable() {
return (getDataModel().isRowAvailable());
}
/**
* <p>Return the number of rows in the underlying data model. If the number
* of available rows is unknown, return -1.</p>
*
* @throws FacesException if an error occurs getting the row count
*/
public int getRowCount() {
return (getDataModel().getRowCount());
}
/**
* <p>Return the data object representing the data for the currently
* selected row index, if any.</p>
*
* @throws FacesException if an error occurs getting the row data
* @throws IllegalArgumentException if now row data is available at the
* currently specified row index
*/
public Object getRowData() {
return (getDataModel().getRowData());
}
/**
* <p>Return the zero-relative index of the currently selected row. If we
* are not currently positioned on a row, return -1. This property is
* <strong>not</strong> enabled for value binding expressions.</p>
*
* @throws FacesException if an error occurs getting the row index
*/
public int getRowIndex() {
return (Integer) getStateHelper().eval(PropertyKeys.rowIndex, -1);
}
/**
* <p><span class="changed_modified_2_1">Set</span> the zero
* relative index of the current row, or -1 to indicate that no row
* is currently selected, by implementing the following algorithm.
* It is possible to set the row index at a value for which the
* underlying data collection does not contain any row data.
* Therefore, callers may use the <code>isRowAvailable()</code>
* method to detect whether row data will be available for use by
* the <code>getRowData()</code> method.</p>
* <p class="changed_added_2_1">To support transient state among
* descendents, please consult the specification for {@link
* #setRowStatePreserved}, which details the requirements
* for <code>setRowIndex()</code> when the
* <code>rowStatePreserved</code> JavaBeans property is set
* to <code>true</code>.</p>
* <ul>
* <li>Save current state information for all descendant components (as
* described below).
* <li>Store the new row index, and pass it on to the {@link DataModel}
* associated with this {@link UIData} instance.</li>
* <li>If the new <code>rowIndex</code> value is -1:
* <ul>
* <li>If the <code>var</code> property is not null,
* remove the corresponding request scope attribute (if any).</li>
* <li>Reset the state information for all descendant components
* (as described below).</li>
* </ul></li>
* <li>If the new <code>rowIndex</code> value is not -1:
* <ul>
* <li>If the <code>var</code> property is not null, call
* <code>getRowData()</code> and expose the resulting data object
* as a request scope attribute whose key is the <code>var</code>
* property value.</li>
* <li>Reset the state information for all descendant components
* (as described below).
* </ul></li>
* </ul>
*
* <p>To save current state information for all descendant components,
* {@link UIData} must maintain per-row information for each descendant
* as follows:<p>
* <ul>
* <li>If the descendant is an instance of <code>EditableValueHolder</code>, save
* the state of its <code>localValue</code> property.</li>
* <li>If the descendant is an instance of <code>EditableValueHolder</code>,
* save the state of the <code>localValueSet</code> property.</li>
* <li>If the descendant is an instance of <code>EditableValueHolder</code>, save
* the state of the <code>valid</code> property.</li>
* <li>If the descendant is an instance of <code>EditableValueHolder</code>,
* save the state of the <code>submittedValue</code> property.</li>
* </ul>
*
* <p>To restore current state information for all descendant components,
* {@link UIData} must reference its previously stored information for the
* current <code>rowIndex</code> and call setters for each descendant
* as follows:</p>
* <ul>
* <li>If the descendant is an instance of <code>EditableValueHolder</code>,
* restore the <code>value</code> property.</li>
* <li>If the descendant is an instance of <code>EditableValueHolder</code>,
* restore the state of the <code>localValueSet</code> property.</li>
* <li>If the descendant is an instance of <code>EditableValueHolder</code>,
* restore the state of the <code>valid</code> property.</li>
* <li>If the descendant is an instance of <code>EditableValueHolder</code>,
* restore the state of the <code>submittedValue</code> property.</li>
* </ul>
*
* @param rowIndex The new row index value, or -1 for no associated row
*
* @throws FacesException if an error occurs setting the row index
* @throws IllegalArgumentException if <code>rowIndex</code>
* is less than -1
*/
public void setRowIndex(int rowIndex)
{
if (isRowStatePreserved())
{
setRowIndexRowStatePreserved(rowIndex);
}
else
{
setRowIndexWithoutRowStatePreserved(rowIndex);
}
}
private void setRowIndexWithoutRowStatePreserved(int rowIndex){
// Save current state for the previous row index
saveDescendantState();
// Update to the new row index
//this.rowIndex = rowIndex;
getStateHelper().put(PropertyKeys.rowIndex, rowIndex);
DataModel localModel = getDataModel();
localModel.setRowIndex(rowIndex);
// if rowIndex is -1, clear the cache
if (rowIndex == -1) {
setDataModel(null);
}
// Clear or expose the current row data as a request scope attribute
String var = (String) getStateHelper().get(PropertyKeys.var);
if (var != null) {
Map<String, Object> requestMap =
getFacesContext().getExternalContext().getRequestMap();
if (rowIndex == -1) {
oldVar = requestMap.remove(var);
} else if (isRowAvailable()) {
requestMap.put(var, getRowData());
} else {
requestMap.remove(var);
if (null != oldVar) {
requestMap.put(var, oldVar);
oldVar = null;
}
}
}
// Reset current state information for the new row index
restoreDescendantState();
}
private void setRowIndexRowStatePreserved(int rowIndex)
{
if (rowIndex < -1)
{
throw new IllegalArgumentException("rowIndex is less than -1");
}
if (getRowIndex() == rowIndex)
{
return;
}
FacesContext facesContext = getFacesContext();
if (_initialDescendantFullComponentState != null)
{
//Just save the row
Map<String, Object> sm = saveFullDescendantComponentStates(facesContext, null, getChildren().iterator(), false);
if (sm != null && !sm.isEmpty())
{
_rowDeltaStates.put(getContainerClientId(facesContext), sm);
}
if (getRowIndex() != -1)
{
_rowTransientStates.put(getContainerClientId(facesContext), saveTransientDescendantComponentStates(facesContext, null, getChildren().iterator(), false));
}
}
// Update to the new row index
//this.rowIndex = rowIndex;
getStateHelper().put(PropertyKeys.rowIndex, rowIndex);
DataModel localModel = getDataModel();
localModel.setRowIndex(rowIndex);
// if rowIndex is -1, clear the cache
if (rowIndex == -1) {
setDataModel(null);
}
// Clear or expose the current row data as a request scope attribute
String var = (String) getStateHelper().get(PropertyKeys.var);
if (var != null) {
Map<String, Object> requestMap =
getFacesContext().getExternalContext().getRequestMap();
if (rowIndex == -1) {
oldVar = requestMap.remove(var);
} else if (isRowAvailable()) {
requestMap.put(var, getRowData());
} else {
requestMap.remove(var);
if (null != oldVar) {
requestMap.put(var, oldVar);
oldVar = null;
}
}
}
if (_initialDescendantFullComponentState != null)
{
Object rowState = _rowDeltaStates.get(getContainerClientId(facesContext));
if (rowState == null)
{
//Restore as original
restoreFullDescendantComponentStates(facesContext, getChildren().iterator(), _initialDescendantFullComponentState, false);
}
else
{
//Restore first original and then delta
restoreFullDescendantComponentDeltaStates(facesContext, getChildren().iterator(), rowState, _initialDescendantFullComponentState, false);
}
if (getRowIndex() == -1)
{
restoreTransientDescendantComponentStates(facesContext, getChildren().iterator(), null, false);
}
else
{
rowState = _rowTransientStates.get(getContainerClientId(facesContext));
if (rowState == null)
{
restoreTransientDescendantComponentStates(facesContext, getChildren().iterator(), null, false);
}
else
{
restoreTransientDescendantComponentStates(facesContext, getChildren().iterator(), (Map<String, Object>) rowState, false);
}
}
}
}
/**
* <p>Return the number of rows to be displayed, or zero for all remaining
* rows in the table. The default value of this property is zero.</p>
*/
public int getRows() {
return (Integer) getStateHelper().eval(PropertyKeys.rows, 0);
}
/**
* <p>Set the number of rows to be displayed, or zero for all remaining rows
* in the table.</p>
*
* @param rows New number of rows
*
* @throws IllegalArgumentException if <code>rows</code> is negative
*/
public void setRows(int rows) {
if (rows < 0) {
throw new IllegalArgumentException(String.valueOf(rows));
}
getStateHelper().put(PropertyKeys.rows, rows);
}
/**
* <p>Return the request-scope attribute under which the data object for the
* current row will be exposed when iterating. This property is
* <strong>not</strong> enabled for value binding expressions.</p>
*/
public String getVar() {
return (String) getStateHelper().get(PropertyKeys.var);
}
/**
* <p>Set the request-scope attribute under which the data object for the
* current row wil be exposed when iterating.</p>
*
* @param var The new request-scope attribute name
*/
public void setVar(String var) {
getStateHelper().put(PropertyKeys.var, var);
}
/**
* <p class="changed_added_2_1">Return the value of the
* <code>rowStatePreserved</code> JavaBeans property. See
* {@link #setRowStatePreserved}.</p>
*
* @since 2.1
*/
public boolean isRowStatePreserved()
{
Boolean b = (Boolean) getStateHelper().get(PropertyKeys.rowStatePreserved);
return b == null ? false : b.booleanValue();
}
/**
* <p class="changed_added_2_1">If this property is set to
* <code>true</code>, the <code>UIData</code> must take steps to
* ensure that modifications to its iterated children will be
* preserved on a per-row basis. This allows applications to modify
* component properties, such as the style-class, for a specific
* row, rather than having such modifications apply to all rows.</p>
* <div class="changed_added_2_1">
* <p>To accomplish this, <code>UIData</code> must call {@link
* StateHolder#saveState} and {@link
* TransientStateHolder#saveTransientState} on its children to
* capture their state on exiting each row. When re-entering the
* row, {@link StateHolder#restoreState} and {@link
* TransientStateHolder#restoreTransientState} must be called in
* order to reinitialize the children to the correct state for the
* new row. All of this action must take place during the
* processing of {@link #setRowIndex}.</p>
* <p>Users should consider enabling this feature for cases where
* it is necessary to modify properties of <code>UIData</code>'s
* children in a row-specific way. Note, however, that row-level
* state saving/restoring does add overhead. As such, this feature
* should be used judiciously.</p>
* </div>
*
*
* @since 2.1
*/
public void setRowStatePreserved(boolean preserveComponentState)
{
getStateHelper().put(PropertyKeys.rowStatePreserved, preserveComponentState);
}
// ----------------------------------------------------- StateHolder Methods
/**
* <p><span class="changed_modified_2_2">Return</span> the value of the UIData. This value must either be
* be of type {@link DataModel}, or a type that can be adapted
* into a {@link DataModel}. <code>UIData</code> will automatically
* adapt the following types:</p>
* <ul>
* <li>Arrays</li>
* <li><code>java.util.List</code></li>
* <li><code>java.sql.ResultSet</code></li>
* <li><code>javax.servlet.jsp.jstl.sql.Result</code>
* <li class="changed_added_2_2"><code>java.util.Collection</code></li>
* </ul>
* <p>All other types will be adapted using the {@link ScalarDataModel}
* class, which will treat the object as a single row of data.</p>
*/
public Object getValue() {
return getStateHelper().eval(PropertyKeys.value);
}
/**
* <p>Set the value of the <code>UIData</code>. This value must either be
* be of type {@link DataModel}, or a type that can be adapted into a {@link
* DataModel}.</p>
*
* @param value the new value
*/
public void setValue(Object value) {
setDataModel(null);
getStateHelper().put(PropertyKeys.value, value);
}
// ----------------------------------------------------- UIComponent Methods
/**
* <p>If "name" is something other than "value", "var", or "rowIndex", rely
* on the superclass conversion from <code>ValueBinding</code> to
* <code>ValueExpression</code>.</p>
*
* @param name Name of the attribute or property for which to set a
* {@link ValueBinding}
* @param binding The {@link ValueBinding} to set, or <code>null</code> to
* remove any currently set {@link ValueBinding}
*
* @throws IllegalArgumentException if <code>name</code> is one of
* <code>id</code>, <code>parent</code>,
* <code>var</code>, or <code>rowIndex</code>
* @throws NullPointerException if <code>name</code> is <code>null</code>
* @deprecated This has been replaced by {@link #setValueExpression(java.lang.String,
*javax.el.ValueExpression)}.
*/
public void setValueBinding(String name, ValueBinding binding) {
if ("value".equals(name)) {
setDataModel(null);
} else if ("var".equals(name) || "rowIndex".equals(name)) {
throw new IllegalArgumentException();
}
super.setValueBinding(name, binding);
}
/**
* <p>Set the {@link ValueExpression} used to calculate the value for the
* specified attribute or property name, if any. In addition, if a {@link
* ValueExpression} is set for the <code>value</code> property, remove any
* synthesized {@link DataModel} for the data previously bound to this
* component.</p>
*
* @param name Name of the attribute or property for which to set a
* {@link ValueExpression}
* @param binding The {@link ValueExpression} to set, or <code>null</code>
* to remove any currently set {@link ValueExpression}
*
* @throws IllegalArgumentException if <code>name</code> is one of
* <code>id</code>, <code>parent</code>,
* <code>var</code>, or <code>rowIndex</code>
* @throws NullPointerException if <code>name</code> is <code>null</code>
* @since 1.2
*/
public void setValueExpression(String name, ValueExpression binding) {
if ("value".equals(name)) {
this.model = null;
} else if ("var".equals(name) || "rowIndex".equals(name)) {
throw new IllegalArgumentException();
}
super.setValueExpression(name, binding);
}
/**
* <p>Return a client identifier for this component that includes the
* current value of the <code>rowIndex</code> property, if it is not set to
* -1. This implies that multiple calls to <code>getClientId()</code> may
* return different results, but ensures that child components can
* themselves generate row-specific client identifiers (since {@link UIData}
* is a {@link NamingContainer}).</p>
*
* @throws NullPointerException if <code>context</code> is <code>null</code>
*/
public String getClientId(FacesContext context) {
if (context == null) {
throw new NullPointerException();
}
// If baseClientId and clientIdBuilder are both null, this is the
// first time that getClientId() has been called.
// If we're not nested within another UIData, then:
// - create a new StringBuilder assigned to clientIdBuilder containing
// our client ID.
// - toString() the builder - this result will be our baseClientId
// for the duration of the component
// - append UINamingContainer.getSeparatorChar() to the builder
// If we are nested within another UIData, then:
// - create an empty StringBuilder that will be used to build
// this instance's ID
if (baseClientId == null && clientIdBuilder == null) {
if (!isNestedWithinIterator()) {
clientIdBuilder = new StringBuilder(super.getClientId(context));
baseClientId = clientIdBuilder.toString();
baseClientIdLength = (baseClientId.length() + 1);
clientIdBuilder.append(UINamingContainer.getSeparatorChar(context));
clientIdBuilder.setLength(baseClientIdLength);
} else {
clientIdBuilder = new StringBuilder();
}
}
int rowIndex = getRowIndex();
if (rowIndex >= 0) {
String cid;
if (!isNestedWithinIterator()) {
// we're not nested, so the clientIdBuilder is already
// primed with clientID +
// UINamingContainer.getSeparatorChar(). Append the
// current rowIndex, and toString() the builder. reset
// the builder to it's primed state.
cid = clientIdBuilder.append(rowIndex).toString();
clientIdBuilder.setLength(baseClientIdLength);
} else {
// we're nested, so we have to build the ID from scratch
// each time. Reuse the same clientIdBuilder instance
// for each call by resetting the length to 0 after
// the ID has been computed.
cid = clientIdBuilder.append(super.getClientId(context))
.append(UINamingContainer.getSeparatorChar(context)).append(rowIndex)
.toString();
clientIdBuilder.setLength(0);
}
return (cid);
} else {
if (!isNestedWithinIterator()) {
// Not nested and no row available, so just return our baseClientId
return (baseClientId);
} else {
// nested and no row available, return the result of getClientId().
// this is necessary as the client ID will reflect the row that
// this table represents
return super.getClientId(context);
}
}
}
/**
* <p>Override behavior from {@link
* UIComponentBase#invokeOnComponent} to provide special care for
* positioning the data properly before finding the component and
* invoking the callback on it. If the argument
* <code>clientId</code> is equal to <code>this.getClientId()</code>
* simply invoke the <code>contextCallback</code>, passing the
* <code>context</code> argument and <b>this</b> as arguments, and
* return <code>true.</code> If the argument <code>clientId</code>
* is not equal to <code>this.getClientId()</code>, inspect each of
* the facet children of this <code>UIData</code> instance and for
* each one, compare its <code>clientId</code> with the argument
* <code>clientId</code>. If there is a match, invoke the
* <code>contextCallback</code>, passing the <code>context</code>
* argument and <b>this</b> as arguments, and return
* <code>true</code>. Otherwise, attempt to extract a rowIndex from
* the <code>clientId</code>. For example, if the argument
* <code>clientId</code> was <code>form:data:3:customerHeader</code>
* the rowIndex would be <code>3</code>. Let this value be called
* <code>newIndex</code>. The current rowIndex of this instance must
* be saved aside and restored before returning in all cases,
* regardless of the outcome of the search or if any exceptions are
* thrown in the process.</p>
*
* <p>The implementation of this method must never return <code>true</code>
* if setting the rowIndex of this instance to be equal to
* <code>newIndex</code> causes this instance to return <code>false</code>
* from {@link #isRowAvailable}.</p>
*
* @throws NullPointerException {@inheritDoc}
* @throws FacesException {@inheritDoc} Also throws <code>FacesException</code>
* if any exception is thrown when deriving the
* rowIndex from the argument <code>clientId</code>.
* @since 1.2
*/
public boolean invokeOnComponent(FacesContext context, String clientId,
ContextCallback callback)
throws FacesException {
if (null == context || null == clientId || null == callback) {
throw new NullPointerException();
}
String myId = super.getClientId(context);
boolean found = false;
if (clientId.equals(myId)) {
try {
this.pushComponentToEL(context, compositeParent);
callback.invokeContextCallback(context, this);
return true;
}
catch (Exception e) {
throw new FacesException(e);
}
finally {
this.popComponentFromEL(context);
}
}
// check the facets, if any, of UIData
if (this.getFacetCount() > 0) {
for (UIComponent c : this.getFacets().values()) {
if (clientId.equals(c.getClientId(context))) {
callback.invokeContextCallback(context, c);
return true;
}
}
}
// check column level facets, if any
if (this.getChildCount() > 0) {
for (UIComponent column : this.getChildren()) {
if (column instanceof UIColumn) {
if (column.getFacetCount() > 0) {
for (UIComponent facet : column.getFacets().values()) {
if (facet.invokeOnComponent(context, clientId, callback)) {
return true;
}
}
}
}
}
}
/*
* Check if we are looking for a component that is part of the
* actual skeleton.
*/
if (this.getChildCount() > 0) {
for (UIComponent column : this.getChildren()) {
if (column instanceof UIColumn) {
if (column.invokeOnComponent(context, clientId, callback)) {
return true;
}
}
}
}
int lastSep, newRow, savedRowIndex = this.getRowIndex();
try {
char sepChar = UINamingContainer.getSeparatorChar(context);
// If we need to strip out the rowIndex from our id
// PENDING(edburns): is this safe with respect to I18N?
if (myId.endsWith(sepChar + Integer.toString(savedRowIndex, 10))) {
lastSep = myId.lastIndexOf(sepChar);
assert (-1 != lastSep);
myId = myId.substring(0, lastSep);
}
// myId will be something like form:outerData for a non-nested table,
// and form:outerData:3:data for a nested table.
// clientId will be something like form:outerData:3:outerColumn
// for a non-nested table. clientId will be something like
// outerData:3:data:3:input for a nested table.
if (clientId.startsWith(myId)) {
int preRowIndexSep, postRowIndexSep;
if (-1 != (preRowIndexSep =
clientId.indexOf(sepChar,
myId.length()))) {
// Check the length
if (++preRowIndexSep < clientId.length()) {
if (-1 != (postRowIndexSep =
clientId.indexOf(sepChar,
preRowIndexSep + 1))) {
try {
newRow = Integer
.valueOf(clientId.substring(preRowIndexSep,
postRowIndexSep))
.intValue();
} catch (NumberFormatException ex) {
// PENDING(edburns): I18N
String message =
"Trying to extract rowIndex from clientId \'"
+
clientId
+ "\' "
+ ex.getMessage();
throw new NumberFormatException(message);
}
this.setRowIndex(newRow);
if (this.isRowAvailable()) {
found = super.invokeOnComponent(context,
clientId,
callback);
}
}
}
}
}
}
catch (FacesException fe) {
throw fe;
}
catch (Exception e) {
throw new FacesException(e);
}
finally {
this.setRowIndex(savedRowIndex);
}
return found;
}
/**
* <p>Override the default {@link UIComponentBase#queueEvent} processing to
* wrap any queued events in a wrapper so that we can reset the current row
* index in <code>broadcast()</code>.</p>
*
* @param event {@link FacesEvent} to be queued
*
* @throws IllegalStateException if this component is not a descendant of a
* {@link UIViewRoot}
* @throws NullPointerException if <code>event</code> is <code>null</code>
*/
public void queueEvent(FacesEvent event) {
super.queueEvent(new WrapperEvent(this, event, getRowIndex()));
}
/**
* <p>Override the default {@link UIComponentBase#broadcast} processing to
* unwrap any wrapped {@link FacesEvent} and reset the current row index,
* before the event is actually broadcast. For events that we did not wrap
* (in <code>queueEvent()</code>), default processing will occur.</p>
*
* @param event The {@link FacesEvent} to be broadcast
*
* @throws AbortProcessingException Signal the JavaServer Faces
* implementation that no further
* processing on the current event should
* be performed
* @throws IllegalArgumentException if the implementation class of this
* {@link FacesEvent} is not supported by
* this component
* @throws NullPointerException if <code>event</code> is <code>null</code>
*/
public void broadcast(FacesEvent event)
throws AbortProcessingException {
if (!(event instanceof WrapperEvent)) {
super.broadcast(event);
return;
}
FacesContext context = FacesContext.getCurrentInstance();
// Set up the correct context and fire our wrapped event
WrapperEvent revent = (WrapperEvent) event;
if (isNestedWithinIterator()) {
setDataModel(null);
}
int oldRowIndex = getRowIndex();
setRowIndex(revent.getRowIndex());
FacesEvent rowEvent = revent.getFacesEvent();
UIComponent source = rowEvent.getComponent();
UIComponent compositeParent = null;
try {
if (!UIComponent.isCompositeComponent(source)) {
compositeParent = UIComponent.getCompositeComponentParent(source);
}
if (compositeParent != null) {
compositeParent.pushComponentToEL(context, null);
}
source.pushComponentToEL(context, null);
source.broadcast(rowEvent);
} finally {
source.popComponentFromEL(context);
if (compositeParent != null) {
compositeParent.popComponentFromEL(context);
}
}
setRowIndex(oldRowIndex);
}
/**
* <p>In addition to the default behavior, ensure that any saved per-row
* state for our child input components is discarded unless it is needed to
* rerender the current page with errors.
*
* @param context FacesContext for the current request
*
* @throws IOException if an input/output error occurs while
* rendering
* @throws NullPointerException if <code>context</code> is <code>null</code>
*/
public void encodeBegin(FacesContext context) throws IOException {
preEncode(context);
super.encodeBegin(context);
}
/**
* <p>Override the default {@link UIComponentBase#processDecodes} processing
* to perform the following steps.</p> <ul> <li>If the <code>rendered</code>
* property of this {@link UIComponent} is <code>false</code>, skip further
* processing.</li> <li>Set the current <code>rowIndex</code> to -1.</li>
* <li>Call the <code>processDecodes()</code> method of all facets of this
* {@link UIData}, in the order determined by a call to
* <code>getFacets().keySet().iterator()</code>.</li> <li>Call the
* <code>processDecodes()</code> method of all facets of the {@link
* UIColumn} children of this {@link UIData}.</li> <li>Iterate over the set
* of rows that were included when this component was rendered (i.e. those
* defined by the <code>first</code> and <code>rows</code> properties),
* performing the following processing for each row: <ul> <li>Set the
* current <code>rowIndex</code> to the appropriate value for this row.</li>
* <li>If <code>isRowAvailable()</code> returns <code>true</code>, iterate
* over the children components of each {@link UIColumn} child of this
* {@link UIData} component, calling the <code>processDecodes()</code>
* method for each such child.</li> </ul></li> <li>Set the current
* <code>rowIndex</code> to -1.</li> <li>Call the <code>decode()</code>
* method of this component.</li> <li>If a <code>RuntimeException</code> is
* thrown during decode processing, call {@link FacesContext#renderResponse}
* and re-throw the exception.</li> </ul>
*
* @param context {@link FacesContext} for the current request
*
* @throws NullPointerException if <code>context</code> is <code>null</code>
*/
public void processDecodes(FacesContext context) {
if (context == null) {
throw new NullPointerException();
}
if (!isRendered()) {
return;
}
pushComponentToEL(context, this);
preDecode(context);
iterate(context, PhaseId.APPLY_REQUEST_VALUES);
decode(context);
popComponentFromEL(context);
}
/**
* <p>Override the default {@link UIComponentBase#processValidators}
* processing to perform the following steps.</p> <ul> <li>If the
* <code>rendered</code> property of this {@link UIComponent} is
* <code>false</code>, skip further processing.</li> <li>Set the current
* <code>rowIndex</code> to -1.</li> <li>Call the <code>processValidators()</code>
* method of all facets of this {@link UIData}, in the order determined by a
* call to <code>getFacets().keySet().iterator()</code>.</li> <li>Call the
* <code>processValidators()</code> method of all facets of the {@link
* UIColumn} children of this {@link UIData}.</li> <li>Iterate over the set
* of rows that were included when this component was rendered (i.e. those
* defined by the <code>first</code> and <code>rows</code> properties),
* performing the following processing for each row: <ul> <li>Set the
* current <code>rowIndex</code> to the appropriate value for this row.</li>
* <li>If <code>isRowAvailable()</code> returns <code>true</code>, iterate
* over the children components of each {@link UIColumn} child of this
* {@link UIData} component, calling the <code>processValidators()</code>
* method for each such child.</li> </ul></li> <li>Set the current
* <code>rowIndex</code> to -1.</li> </ul>
*
* @param context {@link FacesContext} for the current request
*
* @throws NullPointerException if <code>context</code> is <code>null</code>
*/
public void processValidators(FacesContext context) {
if (context == null) {
throw new NullPointerException();
}
if (!isRendered()) {
return;
}
pushComponentToEL(context, this);
Application app = context.getApplication();
app.publishEvent(context, PreValidateEvent.class, this);
preValidate(context);
iterate(context, PhaseId.PROCESS_VALIDATIONS);
app.publishEvent(context, PostValidateEvent.class, this);
popComponentFromEL(context);
}
/**
* <p>Override the default {@link UIComponentBase#processUpdates}
* processing to perform the following steps.</p>
* <ul>
* <li>If the <code>rendered</code> property of this {@link UIComponent}
* is <code>false</code>, skip further processing.</li>
* <li>Set the current <code>rowIndex</code> to -1.</li>
* <li>Call the <code>processUpdates()</code> method of all facets
* of this {@link UIData}, in the order determined
* by a call to <code>getFacets().keySet().iterator()</code>.</li>
* <li>Call the <code>processUpdates()</code> method of all facets
* of the {@link UIColumn} children of this {@link UIData}.</li>
* <li>Iterate over the set of rows that were included when this
* component was rendered (i.e. those defined by the <code>first</code>
* and <code>rows</code> properties), performing the following
* processing for each row:
* <ul>
* <li>Set the current <code>rowIndex</code> to the appropriate
* value for this row.</li>
* <li>If <code>isRowAvailable()</code> returns <code>true</code>,
* iterate over the children components of each {@link UIColumn}
* child of this {@link UIData} component, calling the
* <code>processUpdates()</code> method for each such child.</li>
* </ul></li>
* <li>Set the current <code>rowIndex</code> to -1.</li>
* </ul>
*
* @param context {@link FacesContext} for the current request
*
* @throws NullPointerException if <code>context</code> is <code>null</code>
*/
public void processUpdates(FacesContext context) {
if (context == null) {
throw new NullPointerException();
}
if (!isRendered()) {
return;
}
pushComponentToEL(context, this);
preUpdate(context);
iterate(context, PhaseId.UPDATE_MODEL_VALUES);
popComponentFromEL(context);
// This is not a EditableValueHolder, so no further processing is required
}
public String createUniqueId(FacesContext context, String seed) {
Integer i = (Integer) getStateHelper().get(PropertyKeys.lastId);
int lastId = ((i != null) ? i : 0);
getStateHelper().put(PropertyKeys.lastId, ++lastId);
return UIViewRoot.UNIQUE_ID_PREFIX + (seed == null ? lastId : seed);
}
/**
* <p class="changed_added_2_0"><span
* class="changed_modified_2_0_rev_a">Override</span> the behavior
* in {@link UIComponent#visitTree} to handle iteration
* correctly.</p>
*
* <div class="changed_added_2_0">
* <p>If the {@link UIComponent#isVisitable} method of this instance
* returns <code>false</code>, take no action and return.</p>
* <p>Call {@link UIComponent#pushComponentToEL} and
* invoke the visit callback on this <code>UIData</code> instance as
* described in {@link UIComponent#visitTree}. Let the result of
* the invoctaion be <em>visitResult</em>. If <em>visitResult</em>
* is {@link VisitResult#COMPLETE}, take no further action and
* return <code>true</code>. Otherwise, determine if we need to
* visit our children. The default implementation calls {@link
* VisitContext#getSubtreeIdsToVisit} passing <code>this</code> as
* the argument. If the result of that call is non-empty, let
* <em>doVisitChildren</em> be <code>true</code>. If
* <em>doVisitChildren</em> is <code>true</code> and
* <em>visitResult</em> is {@link VisitResult#ACCEPT}, take the
* following action.<p>
* <ul>
* <li><p>If this component has facets, call {@link
* UIComponent#getFacets} on this instance and invoke the
* <code>values()</code> method. For each
* <code>UIComponent</code> in the returned <code>Map</code>,
* call {@link UIComponent#visitTree}.</p></li>
* <li>
* <div class="changed_modified_2_0_rev_a">
* <p>If this component has children, for each
* <code>UIColumn</code> child:</p>
*
* <p>Call {@link VisitContext#invokeVisitCallback} on that
<code>UIColumn</code> instance.
* If such a call returns <code>true</code>, terminate visiting and
return <code>true</code> from this method.</p>
*
* <p>If the child <code>UIColumn</code> has facets, call
* {@link UIComponent#visitTree} on each one.</p>
*
* <p>Take no action on non-<code>UIColumn</code> children.</p>
*
* </div>
* </li>
*
* <li>
* <div class="changed_modified_2_0_rev_a">
*
* <p>Save aside the result of a call to {@link
* #getRowIndex}.</p>
* <p>For each child component of this <code>UIData</code> that is
* also an instance of {@link UIColumn},
* </p>
* <p>Iterate over the rows.</p>
* </div>
* <ul>
* <li><p>Let <em>rowsToProcess</em> be the return from {@link
* #getRows}. </p></li>
* <li><p>Let <em>rowIndex</em> be the return from {@link
* #getFirst} - 1.</p></li>
* <li><p>While the number of rows processed is less than
* <em>rowsToProcess</em>, take the following actions.</p>
* <p>Call {@link #setRowIndex}, passing the current row index.</p>
* <p>If {@link #isRowAvailable} returns <code>false</code>, take no
* further action and return <code>false</code>.</p>
*
* <p class="changed_modified_2_0_rev_a">Call {@link
* UIComponent#visitTree} on each of the children of this
* <code>UIColumn</code> instance.</p>
* </li>
* </ul>
* </li>
* </ul>
* <p>Call {@link #popComponentFromEL} and restore the saved row
* index with a call to {@link #setRowIndex}.</p>
* <p>Return <code>false</code> to allow the visiting to
* continue.</p>
* </div>
*
* @param context the <code>VisitContext</code> that provides
* context for performing the visit.
*
* @param callback the callback to be invoked for each node
* encountered in the visit.
* @throws NullPointerException if any of the parameters are
* <code>null</code>.
*
*/
@Override
public boolean visitTree(VisitContext context,
VisitCallback callback) {
// First check to see whether we are visitable. If not
// short-circuit out of this subtree, though allow the
// visit to proceed through to other subtrees.
if (!isVisitable(context))
return false;
FacesContext facesContext = context.getFacesContext();
// NOTE: that the visitRows local will be obsolete once the
// appropriate visit hints have been added to the API
boolean visitRows = requiresRowIteration(context);
// Clear out the row index is one is set so that
// we start from a clean slate.
int oldRowIndex = -1;
if (visitRows) {
oldRowIndex = getRowIndex();
setRowIndex(-1);
}
// Push ourselves to EL
pushComponentToEL(facesContext, null);
try {
// Visit ourselves. Note that we delegate to the
// VisitContext to actually perform the visit.
VisitResult result = context.invokeVisitCallback(this, callback);
// If the visit is complete, short-circuit out and end the visit
if (result == VisitResult.COMPLETE)
return true;
// Visit children, short-circuiting as necessary
// NOTE: that the visitRows parameter will be obsolete once the
// appropriate visit hints have been added to the API
if ((result == VisitResult.ACCEPT) && doVisitChildren(context, visitRows)) {
// First visit facets
// NOTE: that the visitRows parameter will be obsolete once the
// appropriate visit hints have been added to the API
if (visitFacets(context, callback, visitRows))
return true;
// Next column facets
// NOTE: that the visitRows parameter will be obsolete once the
// appropriate visit hints have been added to the API
if (visitColumnsAndColumnFacets(context, callback, visitRows))
return true;
// And finally, visit rows
// NOTE: that the visitRows parameter will be obsolete once the
// appropriate visit hints have been added to the API
if (visitRows(context, callback, visitRows))
return true;
}
}
finally {
// Clean up - pop EL and restore old row index
popComponentFromEL(facesContext);
if (visitRows) {
setRowIndex(oldRowIndex);
}
}
// Return false to allow the visit to continue
return false;
}
/**
* <p class="changed_added_2_1">Override the base class method to
* take special action if the method is being invoked when {@link
* StateManager#IS_BUILDING_INITIAL_STATE} is true
* <strong>and</strong> the <code>rowStatePreserved</code>
* JavaBeans property for this instance is <code>true</code>.</p>
*
* <p class="changed_modified_2_1">The additional action taken is to
* traverse the descendents and save their state without regard to
* any particular row value.</p>
*
* @since 2.1
*/
@Override
public void markInitialState()
{
if (isRowStatePreserved())
{
if (getFacesContext().getAttributes().containsKey(StateManager.IS_BUILDING_INITIAL_STATE))
{
_initialDescendantFullComponentState = saveDescendantInitialComponentStates(getFacesContext(), getChildren().iterator(), false);
}
}
super.markInitialState();
}
private void restoreFullDescendantComponentStates(FacesContext facesContext,
Iterator<UIComponent> childIterator, Object state,
boolean restoreChildFacets)
{
Iterator<? extends Object[]> descendantStateIterator = null;
while (childIterator.hasNext())
{
if (descendantStateIterator == null && state != null)
{
descendantStateIterator = ((Collection<? extends Object[]>) state)
.iterator();
}
UIComponent component = childIterator.next();
// reset the client id (see spec 3.1.6)
component.setId(component.getId());
if (!component.isTransient())
{
Object childState = null;
Object descendantState = null;
if (descendantStateIterator != null
&& descendantStateIterator.hasNext())
{
Object[] object = descendantStateIterator.next();
childState = object[0];
descendantState = object[1];
}
component.clearInitialState();
component.restoreState(facesContext, childState);
component.markInitialState();
Iterator<UIComponent> childsIterator;
if (restoreChildFacets)
{
childsIterator = component.getFacetsAndChildren();
}
else
{
childsIterator = component.getChildren().iterator();
}
restoreFullDescendantComponentStates(facesContext, childsIterator,
descendantState, true);
}
}
}
private Collection<Object[]> saveDescendantInitialComponentStates(FacesContext facesContext,
Iterator<UIComponent> childIterator, boolean saveChildFacets)
{
Collection<Object[]> childStates = null;
while (childIterator.hasNext())
{
if (childStates == null)
{
childStates = new ArrayList<Object[]>();
}
UIComponent child = childIterator.next();
if (!child.isTransient())
{
// Add an entry to the collection, being an array of two
// elements. The first element is the state of the children
// of this component; the second is the state of the current
// child itself.
Iterator<UIComponent> childsIterator;
if (saveChildFacets)
{
childsIterator = child.getFacetsAndChildren();
}
else
{
childsIterator = child.getChildren().iterator();
}
Object descendantState = saveDescendantInitialComponentStates(
facesContext, childsIterator, true);
Object state = child.saveState(facesContext);
childStates.add(new Object[] { state, descendantState });
}
}
return childStates;
}
private Map<String,Object> saveFullDescendantComponentStates(FacesContext facesContext, Map<String,Object> stateMap,
Iterator<UIComponent> childIterator, boolean saveChildFacets)
{
while (childIterator.hasNext())
{
UIComponent child = childIterator.next();
if (!child.isTransient())
{
Iterator<UIComponent> childsIterator;
if (saveChildFacets)
{
childsIterator = child.getFacetsAndChildren();
}
else
{
childsIterator = child.getChildren().iterator();
}
stateMap = saveFullDescendantComponentStates(facesContext, stateMap,
childsIterator, true);
Object state = child.saveState(facesContext);
if (state != null)
{
if (stateMap == null)
{
stateMap = new HashMap<String,Object>();
}
stateMap.put(child.getClientId(facesContext), state);
}
}
}
return stateMap;
}
private void restoreFullDescendantComponentDeltaStates(FacesContext facesContext,
Iterator<UIComponent> childIterator, Object state, Object initialState,
boolean restoreChildFacets)
{
Map<String,Object> descendantStateIterator = null;
Iterator<? extends Object[]> descendantFullStateIterator = null;
while (childIterator.hasNext())
{
if (descendantStateIterator == null && state != null)
{
descendantStateIterator = (Map<String,Object>) state;
}
if (descendantFullStateIterator == null && initialState != null)
{
descendantFullStateIterator = ((Collection<? extends Object[]>) initialState).iterator();
}
UIComponent component = childIterator.next();
// reset the client id (see spec 3.1.6)
component.setId(component.getId());
if (!component.isTransient())
{
Object childInitialState = null;
Object descendantInitialState = null;
Object childState = null;
if (descendantStateIterator != null
&& descendantStateIterator.containsKey(component.getClientId(facesContext)))
{
//Object[] object = (Object[]) descendantStateIterator.get(component.getClientId(facesContext));
//childState = object[0];
childState = descendantStateIterator.get(component.getClientId(facesContext));
}
if (descendantFullStateIterator != null
&& descendantFullStateIterator.hasNext())
{
Object[] object = (Object[]) descendantFullStateIterator.next();
childInitialState = object[0];
descendantInitialState = object[1];
}
component.clearInitialState();
if (childInitialState != null)
{
component.restoreState(facesContext, childInitialState);
component.markInitialState();
component.restoreState(facesContext, childState);
}
else
{
component.restoreState(facesContext, childState);
component.markInitialState();
}
Iterator<UIComponent> childsIterator;
if (restoreChildFacets)
{
childsIterator = component.getFacetsAndChildren();
}
else
{
childsIterator = component.getChildren().iterator();
}
restoreFullDescendantComponentDeltaStates(facesContext, childsIterator,
state, descendantInitialState , true);
}
}
}
private void restoreTransientDescendantComponentStates(FacesContext facesContext, Iterator<UIComponent> childIterator, Map<String, Object> state,
boolean restoreChildFacets)
{
while (childIterator.hasNext())
{
UIComponent component = childIterator.next();
// reset the client id (see spec 3.1.6)
component.setId(component.getId());
if (!component.isTransient())
{
component.restoreTransientState(facesContext, (state == null) ? null : state.get(component.getClientId(facesContext)));
Iterator<UIComponent> childsIterator;
if (restoreChildFacets)
{
childsIterator = component.getFacetsAndChildren();
}
else
{
childsIterator = component.getChildren().iterator();
}
restoreTransientDescendantComponentStates(facesContext, childsIterator, state, true);
}
}
}
private Map<String, Object> saveTransientDescendantComponentStates(FacesContext facesContext, Map<String, Object> childStates, Iterator<UIComponent> childIterator,
boolean saveChildFacets)
{
while (childIterator.hasNext())
{
UIComponent child = childIterator.next();
if (!child.isTransient())
{
Iterator<UIComponent> childsIterator;
if (saveChildFacets)
{
childsIterator = child.getFacetsAndChildren();
}
else
{
childsIterator = child.getChildren().iterator();
}
childStates = saveTransientDescendantComponentStates(facesContext, childStates, childsIterator, true);
Object state = child.saveTransientState(facesContext);
if (state != null)
{
if (childStates == null)
{
childStates = new HashMap<String, Object>();
}
childStates.put(child.getClientId(facesContext), state);
}
}
}
return childStates;
}
@Override
public void restoreState(FacesContext context, Object state)
{
if (state == null)
{
return;
}
Object values[] = (Object[]) state;
super.restoreState(context, values[0]);
Object restoredRowStates = UIComponentBase.restoreAttachedState(context, values[1]);
if (restoredRowStates == null)
{
if (!_rowDeltaStates.isEmpty())
{
_rowDeltaStates.clear();
}
}
else
{
_rowDeltaStates = (Map<String, Object>) restoredRowStates;
}
}
@Override
public Object saveState(FacesContext context)
{
if (initialStateMarked()) {
Object superState = super.saveState(context);
if (superState == null && _rowDeltaStates.isEmpty()) {
return null;
}
else {
Object values[] = null;
Object attachedState = UIComponentBase.saveAttachedState(context, _rowDeltaStates);
if (superState != null || attachedState != null) {
values = new Object[] { superState, attachedState };
}
return values;
}
} else {
Object values[] = new Object[2];
values[0] = super.saveState(context);
values[1] = UIComponentBase.saveAttachedState(context, _rowDeltaStates);
return values;
}
}
// --------------------------------------------------------- Protected Methods
/**
* <p>Return the internal {@link DataModel} object representing the data
* objects that we will iterate over in this component's rendering.</p>
* <p/>
* <p>If the model has been cached by a previous call to {@link
* #setDataModel}, return it. Otherwise call {@link #getValue}. If the
* result is null, create an empty {@link ListDataModel} and return it. If
* the result is an instance of {@link DataModel}, return it. Otherwise,
* adapt the result as described in {@link #getValue} and return it.</p>
*/
protected DataModel getDataModel() {
// Return any previously cached DataModel instance
if (this.model != null) {
return (model);
}
// Synthesize a DataModel around our current value if possible
Object current = getValue();
if (current == null) {
setDataModel(new ListDataModel(Collections.EMPTY_LIST));
} else if (current instanceof DataModel) {
setDataModel((DataModel) current);
} else if (current instanceof List) {
setDataModel(new ListDataModel((List) current));
} else if (Object[].class.isAssignableFrom(current.getClass())) {
setDataModel(new ArrayDataModel((Object[]) current));
} else if (current instanceof ResultSet) {
setDataModel(new ResultSetDataModel((ResultSet) current));
} else if (current instanceof Result) {
setDataModel(new ResultDataModel((Result) current));
} else if (current instanceof Collection) {
setDataModel(new CollectionDataModel((Collection) current));
} else {
setDataModel(new ScalarDataModel(current));
}
return (model);
}
/**
* <p>Set the internal DataModel. This <code>UIData</code> instance must
* use the given {@link DataModel} as its internal value representation from
* now until the next call to <code>setDataModel</code>. If the given
* <code>DataModel</code> is <code>null</code>, the internal
* <code>DataModel</code> must be reset in a manner so that the next call to
* {@link #getDataModel} causes lazy instantion of a newly refreshed
* <code>DataModel</code>.</p>
* <p/>
* <p>Subclasses might call this method if they either want to restore the
* internal <code>DataModel</code> during the <em>Restore View</em> phase or
* if they want to explicitly refresh the current <code>DataModel</code> for
* the <em>Render Response</em> phase.</p>
*
* @param dataModel the new <code>DataModel</code> or <code>null</code> to
* cause the model to be refreshed.
*/
protected void setDataModel(DataModel dataModel) {
this.model = dataModel;
}
// ---------------------------------------------------- Private Methods
/**
* Called by {@link UIData#visitTree} to determine whether or not the
* <code>visitTree</code> implementation should visit the rows of UIData
* or by manipulating the row index before visiting the components themselves.
*
* Once we have the appropriate Visit hints for state saving, this method
* will become obsolete.
*
* @param ctx the <code>FacesContext</code> for the current request
*
* @return true if row index manipulation is required by the visit to this
* UIData instance
*/
private boolean requiresRowIteration(VisitContext ctx) {
return !ctx.getHints().contains(VisitHint.SKIP_ITERATION);
}
// Perform pre-decode initialization work. Note that this
// initialization may be performed either during a normal decode
// (ie. processDecodes()) or during a tree visit (ie. visitTree()).
private void preDecode(FacesContext context) {
setDataModel(null); // Re-evaluate even with server-side state saving
Map<String, SavedState> saved =
(Map<String, SavedState>) getStateHelper().get(PropertyKeys.saved);
if (null == saved || !keepSaved(context)) {
//noinspection CollectionWithoutInitialCapacity
getStateHelper().remove(PropertyKeys.saved);
}
}
// Perform pre-validation initialization work. Note that this
// initialization may be performed either during a normal validation
// (ie. processValidators()) or during a tree visit (ie. visitTree()).
private void preValidate(FacesContext context) {
if (isNestedWithinIterator()) {
setDataModel(null);
}
}
// Perform pre-update initialization work. Note that this
// initialization may be performed either during normal update
// (ie. processUpdates()) or during a tree visit (ie. visitTree()).
private void preUpdate(FacesContext context) {
if (isNestedWithinIterator()) {
setDataModel(null);
}
}
// Perform pre-encode initialization work. Note that this
// initialization may be performed either during a normal encode
// (ie. encodeBegin()) or during a tree visit (ie. visitTree()).
private void preEncode(FacesContext context) {
setDataModel(null); // re-evaluate even with server-side state saving
if (!keepSaved(context)) {
////noinspection CollectionWithoutInitialCapacity
//saved = new HashMap<String, SavedState>();
getStateHelper().remove(PropertyKeys.saved);
}
}
/**
* <p>Perform the appropriate phase-specific processing and per-row
* iteration for the specified phase, as follows:
* <ul>
* <li>Set the <code>rowIndex</code> property to -1, and process the facets
* of this {@link UIData} component exactly once.</li>
* <li>Set the <code>rowIndex</code> property to -1, and process the facets
* of the {@link UIColumn} children of this {@link UIData} component
* exactly once.</li>
* <li>Iterate over the relevant rows, based on the <code>first</code>
* and <code>row</code> properties, and process the children
* of the {@link UIColumn} children of this {@link UIData} component
* once per row.</li>
* </ul>
*
* @param context {@link FacesContext} for the current request
* @param phaseId {@link PhaseId} of the phase we are currently running
*/
private void iterate(FacesContext context, PhaseId phaseId) {
// Process each facet of this component exactly once
setRowIndex(-1);
if (getFacetCount() > 0) {
for (UIComponent facet : getFacets().values()) {
if (phaseId == PhaseId.APPLY_REQUEST_VALUES) {
facet.processDecodes(context);
} else if (phaseId == PhaseId.PROCESS_VALIDATIONS) {
facet.processValidators(context);
} else if (phaseId == PhaseId.UPDATE_MODEL_VALUES) {
facet.processUpdates(context);
} else {
throw new IllegalArgumentException();
}
}
}
// Process each facet of our child UIColumn components exactly once
setRowIndex(-1);
if (getChildCount() > 0) {
for (UIComponent column : getChildren()) {
if (!(column instanceof UIColumn) || !column.isRendered()) {
continue;
}
if (column.getFacetCount() > 0) {
for (UIComponent columnFacet : column.getFacets().values()) {
if (phaseId == PhaseId.APPLY_REQUEST_VALUES) {
columnFacet.processDecodes(context);
} else if (phaseId == PhaseId.PROCESS_VALIDATIONS) {
columnFacet.processValidators(context);
} else if (phaseId == PhaseId.UPDATE_MODEL_VALUES) {
columnFacet.processUpdates(context);
} else {
throw new IllegalArgumentException();
}
}
}
}
}
// Iterate over our UIColumn children, once per row
int processed = 0;
int rowIndex = getFirst() - 1;
int rows = getRows();
while (true) {
// Have we processed the requested number of rows?
if ((rows > 0) && (++processed > rows)) {
break;
}
// Expose the current row in the specified request attribute
setRowIndex(++rowIndex);
if (!isRowAvailable()) {
break; // Scrolled past the last row
}
// Perform phase-specific processing as required
// on the *children* of the UIColumn (facets have
// been done a single time with rowIndex=-1 already)
if (getChildCount() > 0) {
for (UIComponent kid : getChildren()) {
if (!(kid instanceof UIColumn) || !kid.isRendered()) {
continue;
}
if (kid.getChildCount() > 0) {
for (UIComponent grandkid : kid.getChildren()) {
if (!grandkid.isRendered()) {
continue;
}
if (phaseId == PhaseId.APPLY_REQUEST_VALUES) {
grandkid.processDecodes(context);
} else if (phaseId == PhaseId.PROCESS_VALIDATIONS) {
grandkid.processValidators(context);
} else if (phaseId == PhaseId.UPDATE_MODEL_VALUES) {
grandkid.processUpdates(context);
} else {
throw new IllegalArgumentException();
}
}
}
}
}
}
// Clean up after ourselves
setRowIndex(-1);
}
// Tests whether we need to visit our children as part of
// a tree visit
private boolean doVisitChildren(VisitContext context, boolean visitRows) {
// Just need to check whether there are any ids under this
// subtree. Make sure row index is cleared out since
// getSubtreeIdsToVisit() needs our row-less client id.
if (visitRows) {
setRowIndex(-1);
}
Collection<String> idsToVisit = context.getSubtreeIdsToVisit(this);
assert(idsToVisit != null);
// All ids or non-empty collection means we need to visit our children.
return (!idsToVisit.isEmpty());
}
// // Performs pre-phase initialization before visiting children
// // (if necessary).
// private void preVisitChildren(VisitContext visitContext) {
//
// // If EXECUTE_LIFECYCLE hint is set, we need to do
// // lifecycle-related initialization before visiting children
// if (visitContext.getHints().contains(VisitHint.EXECUTE_LIFECYCLE)) {
// FacesContext facesContext = visitContext.getFacesContext();
// PhaseId phaseId = facesContext.getCurrentPhaseId();
//
// if (phaseId == PhaseId.APPLY_REQUEST_VALUES)
// preDecode(facesContext);
// else if (phaseId == PhaseId.PROCESS_VALIDATIONS)
// preValidate(facesContext);
// else if (phaseId == PhaseId.UPDATE_MODEL_VALUES)
// preUpdate(facesContext);
// else if (phaseId == PhaseId.RENDER_RESPONSE)
// preEncode(facesContext);
// }
// }
// Visit each facet of this component exactly once.
private boolean visitFacets(VisitContext context,
VisitCallback callback,
boolean visitRows) {
if (visitRows) {
setRowIndex(-1);
}
if (getFacetCount() > 0) {
for (UIComponent facet : getFacets().values()) {
if (facet.visitTree(context, callback))
return true;
}
}
return false;
}
// Visit each UIColumn and any facets it may have defined exactly once
private boolean visitColumnsAndColumnFacets(VisitContext context,
VisitCallback callback,
boolean visitRows) {
if (visitRows) {
setRowIndex(-1);
}
if (getChildCount() > 0) {
for (UIComponent column : getChildren()) {
if (column instanceof UIColumn) {
VisitResult result = context.invokeVisitCallback(column, callback); // visit the column directly
if (result == VisitResult.COMPLETE) {
return true;
}
if (column.getFacetCount() > 0) {
for (UIComponent columnFacet : column.getFacets().values()) {
if (columnFacet.visitTree(context, callback)) {
return true;
}
}
}
}
}
}
return false;
}
// Visit each column and row
private boolean visitRows(VisitContext context,
VisitCallback callback,
boolean visitRows) {
// Iterate over our UIColumn children, once per row
int processed = 0;
int rowIndex = 0;
int rows = 0;
if (visitRows) {
rowIndex = getFirst() - 1;
rows = getRows();
}
while (true) {
// Have we processed the requested number of rows?
if (visitRows) {
if ((rows > 0) && (++processed > rows)) {
break;
}
// Expose the current row in the specified request attribute
setRowIndex(++rowIndex);
if (!isRowAvailable()) {
break; // Scrolled past the last row
}
}
// Visit as required on the *children* of the UIColumn
// (facets have been done a single time with rowIndex=-1 already)
if (getChildCount() > 0) {
for (UIComponent kid : getChildren()) {
if (!(kid instanceof UIColumn)) {
continue;
}
if (kid.getChildCount() > 0) {
for (UIComponent grandkid : kid.getChildren()) {
if (grandkid.visitTree(context, callback)) {
return true;
}
}
}
}
}
if (!visitRows) {
break;
}
}
return false;
}
/**
* <p>Return <code>true</code> if we need to keep the saved
* per-child state information. This will be the case if any of the
* following are true:</p>
*
* <ul>
*
* <li>there are messages queued with severity ERROR or FATAL.</li>
*
* <li>this <code>UIData</code> instance is nested inside of another
* <code>UIData</code> instance</li>
*
* </ul>
*
* @param context {@link FacesContext} for the current request
*/
private boolean keepSaved(FacesContext context) {
return (contextHasErrorMessages(context) || isNestedWithinIterator());
}
private Boolean isNestedWithinIterator() {
if (isNested == null) {
UIComponent parent = this;
while (null != (parent = parent.getParent())) {
if (parent instanceof UIData || parent.getClass().getName().endsWith("UIRepeat")) {
isNested = Boolean.TRUE;
break;
}
}
if (isNested == null) {
isNested = Boolean.FALSE;
}
return isNested;
} else {
return isNested;
}
}
private boolean contextHasErrorMessages(FacesContext context) {
FacesMessage.Severity sev = context.getMaximumSeverity();
return (sev != null && (FacesMessage.SEVERITY_ERROR.compareTo(sev) >= 0));
}
/**
* <p>Restore state information for all descendant components, as described
* for <code>setRowIndex()</code>.</p>
*/
private void restoreDescendantState() {
FacesContext context = getFacesContext();
if (getChildCount() > 0) {
for (UIComponent kid : getChildren()) {
if (kid instanceof UIColumn) {
restoreDescendantState(kid, context);
}
}
}
}
/**
* <p>Restore state information for the specified component and its
* descendants.</p>
*
* @param component Component for which to restore state information
* @param context {@link FacesContext} for the current request
*/
private void restoreDescendantState(UIComponent component,
FacesContext context) {
// Reset the client identifier for this component
String id = component.getId();
component.setId(id); // Forces client id to be reset
Map<String, SavedState> saved = (Map<String,SavedState>)
getStateHelper().get(PropertyKeys.saved);
// Restore state for this component (if it is a EditableValueHolder)
if (component instanceof EditableValueHolder) {
EditableValueHolder input = (EditableValueHolder) component;
String clientId = component.getClientId(context);
SavedState state = saved.get(clientId);
if (state == null) {
state = new SavedState();
}
input.setValue(state.getValue());
input.setValid(state.isValid());
input.setSubmittedValue(state.getSubmittedValue());
// This *must* be set after the call to setValue(), since
// calling setValue() always resets "localValueSet" to true.
input.setLocalValueSet(state.isLocalValueSet());
} else if (component instanceof UIForm) {
UIForm form = (UIForm) component;
String clientId = component.getClientId(context);
SavedState state = saved.get(clientId);
if (state == null) {
state = new SavedState();
}
form.setSubmitted(state.getSubmitted());
state.setSubmitted(form.isSubmitted());
}
// Restore state for children of this component
if (component.getChildCount() > 0) {
for (UIComponent kid : component.getChildren()) {
restoreDescendantState(kid, context);
}
}
// Restore state for facets of this component
if (component.getFacetCount() > 0) {
for (UIComponent facet : component.getFacets().values()) {
restoreDescendantState(facet, context);
}
}
}
/**
* <p>Save state information for all descendant components, as described for
* <code>setRowIndex()</code>.</p>
*/
private void saveDescendantState() {
FacesContext context = getFacesContext();
if (getChildCount() > 0) {
for (UIComponent kid : getChildren()) {
if (kid instanceof UIColumn) {
saveDescendantState(kid, context);
}
}
}
}
/**
* <p>Save state information for the specified component and its
* descendants.</p>
*
* @param component Component for which to save state information
* @param context {@link FacesContext} for the current request
*/
private void saveDescendantState(UIComponent component,
FacesContext context) {
// Save state for this component (if it is a EditableValueHolder)
Map<String, SavedState> saved = (Map<String, SavedState>)
getStateHelper().get(PropertyKeys.saved);
if (component instanceof EditableValueHolder) {
EditableValueHolder input = (EditableValueHolder) component;
SavedState state = null;
String clientId = component.getClientId(context);
if (saved == null) {
state = new SavedState();
getStateHelper().put(PropertyKeys.saved, clientId, state);
}
if (state == null) {
state = saved.get(clientId);
if (state == null) {
state = new SavedState();
//saved.put(clientId, state);
getStateHelper().put(PropertyKeys.saved, clientId, state);
}
}
state.setValue(input.getLocalValue());
state.setValid(input.isValid());
state.setSubmittedValue(input.getSubmittedValue());
state.setLocalValueSet(input.isLocalValueSet());
} else if (component instanceof UIForm) {
UIForm form = (UIForm) component;
String clientId = component.getClientId(context);
SavedState state = null;
if (saved == null) {
state = new SavedState();
getStateHelper().put(PropertyKeys.saved, clientId, state);
}
if (state == null) {
state = saved.get(clientId);
if (state == null) {
state = new SavedState();
//saved.put(clientId, state);
getStateHelper().put(PropertyKeys.saved, clientId, state);
}
}
state.setSubmitted(form.isSubmitted());
}
// Save state for children of this component
if (component.getChildCount() > 0) {
for (UIComponent uiComponent : component.getChildren()) {
saveDescendantState(uiComponent, context);
}
}
// Save state for facets of this component
if (component.getFacetCount() > 0) {
for (UIComponent facet : component.getFacets().values()) {
saveDescendantState(facet, context);
}
}
}
}
@SuppressWarnings({"SerializableHasSerializationMethods",
"NonSerializableFieldInSerializableClass"})
class SavedState implements Serializable {
private static final long serialVersionUID = 2920252657338389849L;
private Object submittedValue;
private boolean submitted;
Object getSubmittedValue() {
return (this.submittedValue);
}
void setSubmittedValue(Object submittedValue) {
this.submittedValue = submittedValue;
}
private boolean valid = true;
boolean isValid() {
return (this.valid);
}
void setValid(boolean valid) {
this.valid = valid;
}
private Object value;
Object getValue() {
return (this.value);
}
public void setValue(Object value) {
this.value = value;
}
private boolean localValueSet;
boolean isLocalValueSet() {
return (this.localValueSet);
}
public void setLocalValueSet(boolean localValueSet) {
this.localValueSet = localValueSet;
}
public boolean getSubmitted() {
return this.submitted;
}
public void setSubmitted(boolean submitted) {
this.submitted = submitted;
}
public String toString() {
return ("submittedValue: " + submittedValue +
" value: " + value +
" localValueSet: " + localValueSet);
}
}
// Private class to wrap an event with a row index
class WrapperEvent extends FacesEvent {
public WrapperEvent(UIComponent component, FacesEvent event, int rowIndex) {
super(component);
this.event = event;
this.rowIndex = rowIndex;
}
private FacesEvent event = null;
private int rowIndex = -1;
public FacesEvent getFacesEvent() {
return (this.event);
}
public int getRowIndex() {
return (this.rowIndex);
}
public PhaseId getPhaseId() {
return (this.event.getPhaseId());
}
public void setPhaseId(PhaseId phaseId) {
this.event.setPhaseId(phaseId);
}
public boolean isAppropriateListener(FacesListener listener) {
return (false);
}
public void processListener(FacesListener listener) {
throw new IllegalStateException();
}
}
|