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
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
|
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Selenium Reference</title>
</head>
<body>
<h1>Selenium Reference</h1>
<ol>
<li>
<a href="#name">Concepts</a>
</li>
<ol>
<li>
<a href="#locators">Element Locators</a>
</li>
<li>
<a href="#element-filters">Element Filters</a>
</li>
<li>
<a href="#patterns">String-match Patterns</a>
</li>
</ol>
<li>
<a href="#actions">Selenium Actions</a>
</li>
<li>
<a href="#accessors">Selenium Accessors</a>
</li>
<li>
<a href="#parameter-construction-and-variables">Parameter Construction and Variables</a>
</li>
<li>
<a href="#whitespace">Whitespace Rules</a>
</li>
<li>
<a href="#extending-selenium">Extending Selenium</a>
</li>
</ol>
<h2>Concepts</h2>
<a name="concepts"></a>
<p>A <strong>command</strong> is what tells Selenium what to do. Selenium commands come in three 'flavors': <strong>Actions</strong>, <strong>Accessors</strong> and <strong>Assertions</strong>.
Each command call is one line in the test table of the form:</p>
<blockquote>
<table border="1" class="table">
<colgroup>
<col width="39%">
<col width="33%">
<col width="28%">
</colgroup>
<tbody valign="top">
<tr>
<td>command</td><td>target</td><td>value</td>
</tr>
</tbody>
</table>
</blockquote>
<p>
<strong>Actions</strong> are commands that generally manipulate the state of the application. They do things like "click this link" and "select that option". If an Action fails, or has an error, the execution of the current test is stopped.</p>
<p>Many Actions can be called with the "AndWait" suffix, e.g. "clickAndWait".
This suffix tells Selenium that the action will cause the browser to make a call to the server,
and that Selenium should wait for a new page to load.</p>
<p>
<strong>Accessors</strong> examine the state of the application and store the results in variables, e.g. "storeTitle". They are also used to automatically generate Assertions.</p>
<p>
<strong>Assertions</strong> are like Accessors, but they verify that the state of the application conforms to what is expected. Examples include "make sure the page title is X" and "verify that this checkbox is checked".</p>
<p>All Selenium Assertions can be used in 3 modes: "assert", "verify", and "waitFor". For example, you can "assertText", "verifyText" and "waitForText". When an "assert" fails, the test is aborted. When a "verify" fails, the test will continue execution, logging the failure. This allows a single "assert" to ensure that the application is on the correct page, followed by a bunch of "verify" assertions to test form field values, labels, etc.</p>
<p>"waitFor" commands wait for some condition to become true (which can be useful for testing Ajax applications).
They will succeed immediately if the condition is already true.
However, they will fail and halt the test if the condition does not become true within the current timeout setting
(see the <strong>setTimeout</strong> action below).
</p>
<p>
<strong>Element Locators</strong> tell Selenium which HTML element a command refers to. Many commands require an Element Locator as the "target" attribute. Examples of Element Locators include "elementId" and "document.forms[0].element". These are described more clearly in the next section.</p>
<p>
<strong>Patterns</strong> are used for various reasons, e.g. to specify the expected value of an input field, or identify a select option. Selenium supports various types of pattern, including regular-expressions, all of which are described in more detail below.</p>Defines an object that runs Selenium commands.
<h3>
<a name="locators"></a>Element Locators</h3>
<p>
Element Locators tell Selenium which HTML element a command refers to.
The format of a locator is:</p>
<blockquote>
<em>locatorType</em><strong>=</strong><em>argument</em>
</blockquote>
<p>
We support the following strategies for locating elements:
</p>
<ul>
<li>
<strong>identifier</strong>=<em>id</em>:
Select the element with the specified @id attribute. If no match is
found, select the first element whose @name attribute is <em>id</em>.
(This is normally the default; see below.)</li>
<li>
<strong>id</strong>=<em>id</em>:
Select the element with the specified @id attribute.</li>
<li>
<strong>name</strong>=<em>name</em>:
Select the first element with the specified @name attribute.
<ul class="first last simple">
<li>username</li>
<li>name=username</li>
</ul>
<p>The name may optionally be followed by one or more <em>element-filters</em>, separated from the name by whitespace. If the <em>filterType</em> is not specified, <strong>value</strong> is assumed.</p>
<ul class="first last simple">
<li>name=flavour value=chocolate</li>
</ul>
</li>
<li>
<strong>dom</strong>=<em>javascriptExpression</em>:
Find an element by evaluating the specified string. This allows you to traverse the HTML Document Object
Model using JavaScript. Note that you must not return a value in this string; simply make it the last expression in the block.
<ul class="first last simple">
<li>dom=document.forms['myForm'].myDropdown</li>
<li>dom=document.images[56]</li>
<li>dom=function foo() { return document.links[1]; }; foo();</li>
</ul>
</li>
<li>
<strong>xpath</strong>=<em>xpathExpression</em>:
Locate an element using an XPath expression.
<ul class="first last simple">
<li>xpath=//img[@alt='The image alt text']</li>
<li>xpath=//table[@id='table1']//tr[4]/td[2]</li>
<li>xpath=//a[contains(@href,'#id1')]</li>
<li>xpath=//a[contains(@href,'#id1')]/@class</li>
<li>xpath=(//table[@class='stylee'])//th[text()='theHeaderText']/../td</li>
<li>xpath=//input[@name='name2' and @value='yes']</li>
<li>xpath=//*[text()="right"]</li>
</ul>
</li>
<li>
<strong>link</strong>=<em>textPattern</em>:
Select the link (anchor) element which contains text matching the
specified <em>pattern</em>.
<ul class="first last simple">
<li>link=The link text</li>
</ul>
</li>
<li>
<strong>css</strong>=<em>cssSelectorSyntax</em>:
Select the element using css selectors. Please refer to <a href="http://www.w3.org/TR/REC-CSS2/selector.html">CSS2 selectors</a>, <a href="http://www.w3.org/TR/2001/CR-css3-selectors-20011113/">CSS3 selectors</a> for more information. You can also check the TestCssLocators test in the selenium test suite for an example of usage, which is included in the downloaded selenium core package.
<ul class="first last simple">
<li>css=a[href="#id3"]</li>
<li>css=span#firstChild + span</li>
</ul>
<p>Currently the css selector locator supports all css1, css2 and css3 selectors except namespace in css3, some pseudo classes(:nth-of-type, :nth-last-of-type, :first-of-type, :last-of-type, :only-of-type, :visited, :hover, :active, :focus, :indeterminate) and pseudo elements(::first-line, ::first-letter, ::selection, ::before, ::after). </p>
</li>
<li>
<strong>ui</strong>=<em>uiSpecifierString</em>:
Locate an element by resolving the UI specifier string to another locator, and evaluating it. See the <a href="http://svn.openqa.org/fisheye/browse/~raw,r=trunk/selenium/trunk/src/main/resources/core/scripts/ui-doc.html">Selenium UI-Element Reference</a> for more details.
<ul class="first last simple">
<li>ui=loginPages::loginButton()</li>
<li>ui=settingsPages::toggle(label=Hide Email)</li>
<li>ui=forumPages::postBody(index=2)//a[2]</li>
</ul>
</li>
</ul>
<p>
Without an explicit locator prefix, Selenium uses the following default
strategies:
</p>
<ul class="simple">
<li>
<strong>dom</strong>, for locators starting with "document."</li>
<li>
<strong>xpath</strong>, for locators starting with "//"</li>
<li>
<strong>identifier</strong>, otherwise</li>
</ul>
<h3>
<a name="element-filters">Element Filters</a>
</h3>
<blockquote>
<p>Element filters can be used with a locator to refine a list of candidate elements. They are currently used only in the 'name' element-locator.</p>
<p>Filters look much like locators, ie.</p>
<blockquote>
<em>filterType</em><strong>=</strong><em>argument</em>
</blockquote>
<p>Supported element-filters are:</p>
<p>
<strong>value=</strong><em>valuePattern</em>
</p>
<blockquote>
Matches elements based on their values. This is particularly useful for refining a list of similarly-named toggle-buttons.</blockquote>
<p>
<strong>index=</strong><em>index</em>
</p>
<blockquote>
Selects a single element based on its position in the list (offset from zero).</blockquote>
</blockquote>
<h3>
<a name="patterns"></a>String-match Patterns</h3>
<p>
Various Pattern syntaxes are available for matching string values:
</p>
<ul>
<li>
<strong>glob:</strong><em>pattern</em>:
Match a string against a "glob" (aka "wildmat") pattern. "Glob" is a
kind of limited regular-expression syntax typically used in command-line
shells. In a glob pattern, "*" represents any sequence of characters, and "?"
represents any single character. Glob patterns match against the entire
string.</li>
<li>
<strong>regexp:</strong><em>regexp</em>:
Match a string using a regular-expression. The full power of JavaScript
regular-expressions is available.</li>
<li>
<strong>regexpi:</strong><em>regexpi</em>:
Match a string using a case-insensitive regular-expression.</li>
<li>
<strong>exact:</strong><em>string</em>:
Match a string exactly, verbatim, without any of that fancy wildcard
stuff.</li>
</ul>
<p>
If no pattern prefix is specified, Selenium assumes that it's a "glob"
pattern.
</p>
<p>
For commands that return multiple values (such as verifySelectOptions),
the string being matched is a comma-separated list of the return values,
where both commas and backslashes in the values are backslash-escaped.
When providing a pattern, the optional matching syntax (i.e. glob,
regexp, etc.) is specified once, as usual, at the beginning of the
pattern.
</p>
<a name="actions"></a>
<h2>Selenium Actions</h2>
<dl>
<dt>
<strong><a name="addLocationStrategy"></a>addLocationStrategy
(
strategyName,functionDefinition
)
</strong>
</dt>
<dd>Defines a new function for Selenium to locate elements on the page.
For example,
if you define the strategy "foo", and someone runs click("foo=blah"), we'll
run your function, passing you the string "blah", and click on the element
that your function
returns, or throw an "Element not found" error if your function returns null.
We'll pass three arguments to your function:
<ul>
<li>locator: the string the user passed in</li>
<li>inWindow: the currently selected window</li>
<li>inDocument: the currently selected document</li>
</ul>
The function must return null if the element can't be found.<p>Arguments:</p>
<ul>
<li>strategyName - the name of the strategy to define; this should use only letters [a-zA-Z] with no spaces or other punctuation.</li>
<li>functionDefinition - a string defining the body of a function in JavaScript. For example: <code>return inDocument.getElementById(locator);</code>
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="addScript"></a>addScript
(
scriptContent,scriptTagId
)
</strong>
</dt>
<dd>Loads script content into a new script tag in the Selenium document. This
differs from the runScript command in that runScript adds the script tag
to the document of the AUT, not the Selenium document. The following
entities in the script content are replaced by the characters they
represent:
<
>
&
The corresponding remove command is removeScript.<p>Arguments:</p>
<ul>
<li>scriptContent - the Javascript content of the script to add</li>
<li>scriptTagId - (optional) the id of the new script tag. If specified, and an element with this id already exists, this operation will fail.</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="addSelection"></a>addSelection
(
locator,optionLocator
)
</strong>
</dt>
<dd>Add a selection to the set of selected options in a multi-select element using an option locator.
@see #doSelect for details of option locators<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a> identifying a multi-select box</li>
<li>optionLocator - an option locator (a label by default)</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="allowNativeXpath"></a>allowNativeXpath
(
allow
)
</strong>
</dt>
<dd>Specifies whether Selenium should use the native in-browser implementation
of XPath (if any native version is available); if you pass "false" to
this function, we will always use our pure-JavaScript xpath library.
Using the pure-JS xpath library can improve the consistency of xpath
element locators between different browser vendors, but the pure-JS
version is much slower than the native implementations.<p>Arguments:</p>
<ul>
<li>allow - boolean, true means we'll prefer to use native XPath; false means we'll only use JS XPath</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="altKeyDown"></a>altKeyDown
(
)
</strong>
</dt>
<dd>Press the alt key and hold it down until doAltUp() is called or a new page is loaded.</dd>
<br>
<dt>
<strong><a name="altKeyUp"></a>altKeyUp
(
)
</strong>
</dt>
<dd>Release the alt key.</dd>
<br>
<dt>
<strong><a name="answerOnNextPrompt"></a>answerOnNextPrompt
(
answer
)
</strong>
</dt>
<dd>Instructs Selenium to return the specified answer string in response to
the next JavaScript prompt [window.prompt()].<p>Arguments:</p>
<ul>
<li>answer - the answer to give in response to the prompt pop-up</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="assignId"></a>assignId
(
locator,identifier
)
</strong>
</dt>
<dd>Temporarily sets the "id" attribute of the specified element, so you can locate it in the future
using its ID rather than a slow/complicated XPath. This ID will disappear once the page is
reloaded.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a> pointing to an element</li>
<li>identifier - a string to be used as the ID of the specified element</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="break"></a>break
(
)
</strong>
</dt>
<dd>Halt the currently running test, and wait for the user to press the Continue button.
This command is useful for debugging, but be careful when using it, because it will
force automated tests to hang until a user intervenes manually.</dd>
<br>
<dt>
<strong><a name="captureEntirePageScreenshot"></a>captureEntirePageScreenshot
(
filename,kwargs
)
</strong>
</dt>
<dd>Saves the entire contents of the current window canvas to a PNG file.
Contrast this with the captureScreenshot command, which captures the
contents of the OS viewport (i.e. whatever is currently being displayed
on the monitor), and is implemented in the RC only. Currently this only
works in Firefox when running in chrome mode, and in IE non-HTA using
the EXPERIMENTAL "Snapsie" utility. The Firefox implementation is mostly
borrowed from the Screengrab! Firefox extension. Please see
http://www.screengrab.org and http://snapsie.sourceforge.net/ for
details.<p>Arguments:</p>
<ul>
<li>filename - the path to the file to persist the screenshot as. No filename extension will be appended by default. Directories will not be created if they do not exist, and an exception will be thrown, possibly by native code.</li>
<li>kwargs - a kwargs string that modifies the way the screenshot is captured. Example: "background=#CCFFDD" . Currently valid options: <dl>
<dt>background</dt>
<dd>the background CSS for the HTML document. This may be useful to set for capturing screenshots of less-than-ideal layouts, for example where absolute positioning causes the calculation of the canvas dimension to fail and a black background is exposed (possibly obscuring black text).</dd>
</dl>
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="check"></a>check
(
locator
)
</strong>
</dt>
<dd>Check a toggle-button (checkbox/radio)<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="chooseCancelOnNextConfirmation"></a>chooseCancelOnNextConfirmation
(
)
</strong>
</dt>
<dd>
<p>
By default, Selenium's overridden window.confirm() function will
return true, as if the user had manually clicked OK; after running
this command, the next call to confirm() will return false, as if
the user had clicked Cancel. Selenium will then resume using the
default behavior for future confirmations, automatically returning
true (OK) unless/until you explicitly call this command for each
confirmation.
</p>
<p>
Take note - every time a confirmation comes up, you must
consume it with a corresponding getConfirmation, or else
the next selenium operation will fail.
</p>
</dd>
<br>
<dt>
<strong><a name="chooseOkOnNextConfirmation"></a>chooseOkOnNextConfirmation
(
)
</strong>
</dt>
<dd>
<p>
Undo the effect of calling chooseCancelOnNextConfirmation. Note
that Selenium's overridden window.confirm() function will normally automatically
return true, as if the user had manually clicked OK, so you shouldn't
need to use this command unless for some reason you need to change
your mind prior to the next confirmation. After any confirmation, Selenium will resume using the
default behavior for future confirmations, automatically returning
true (OK) unless/until you explicitly call chooseCancelOnNextConfirmation for each
confirmation.
</p>
<p>
Take note - every time a confirmation comes up, you must
consume it with a corresponding getConfirmation, or else
the next selenium operation will fail.
</p>
</dd>
<br>
<dt>
<strong><a name="click"></a>click
(
locator
)
</strong>
</dt>
<dd>Clicks on a link, button, checkbox or radio button. If the click action
causes a new page to load (like a link usually does), call
waitForPageToLoad.<p>Arguments:</p>
<ul>
<li>locator - an element locator</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="clickAt"></a>clickAt
(
locator,coordString
)
</strong>
</dt>
<dd>Clicks on a link, button, checkbox or radio button. If the click action
causes a new page to load (like a link usually does), call
waitForPageToLoad.<p>Arguments:</p>
<ul>
<li>locator - an element locator</li>
<li>coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="close"></a>close
(
)
</strong>
</dt>
<dd>Simulates the user clicking the "close" button in the titlebar of a popup
window or tab.</dd>
<br>
<dt>
<strong><a name="contextMenu"></a>contextMenu
(
locator
)
</strong>
</dt>
<dd>Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).<p>Arguments:</p>
<ul>
<li>locator - an element locator</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="contextMenuAt"></a>contextMenuAt
(
locator,coordString
)
</strong>
</dt>
<dd>Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).<p>Arguments:</p>
<ul>
<li>locator - an element locator</li>
<li>coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="controlKeyDown"></a>controlKeyDown
(
)
</strong>
</dt>
<dd>Press the control key and hold it down until doControlUp() is called or a new page is loaded.</dd>
<br>
<dt>
<strong><a name="controlKeyUp"></a>controlKeyUp
(
)
</strong>
</dt>
<dd>Release the control key.</dd>
<br>
<dt>
<strong><a name="createCookie"></a>createCookie
(
nameValuePair,optionsString
)
</strong>
</dt>
<dd>Create a new cookie whose path and domain are same with those of current page
under test, unless you specified a path for this cookie explicitly.<p>Arguments:</p>
<ul>
<li>nameValuePair - name and value of the cookie in a format "name=value"</li>
<li>optionsString - options for the cookie. Currently supported options include 'path', 'max_age' and 'domain'. the optionsString's format is "path=/path/, max_age=60, domain=.foo.com". The order of options are irrelevant, the unit of the value of 'max_age' is second. Note that specifying a domain that isn't a subset of the current domain will usually fail.</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="deleteAllVisibleCookies"></a>deleteAllVisibleCookies
(
)
</strong>
</dt>
<dd>Calls deleteCookie with recurse=true on all cookies visible to the current page.
As noted on the documentation for deleteCookie, recurse=true can be much slower
than simply deleting the cookies using a known domain/path.</dd>
<br>
<dt>
<strong><a name="deleteCookie"></a>deleteCookie
(
name,optionsString
)
</strong>
</dt>
<dd>Delete a named cookie with specified path and domain. Be careful; to delete a cookie, you
need to delete it using the exact same path and domain that were used to create the cookie.
If the path is wrong, or the domain is wrong, the cookie simply won't be deleted. Also
note that specifying a domain that isn't a subset of the current domain will usually fail.
Since there's no way to discover at runtime the original path and domain of a given cookie,
we've added an option called 'recurse' to try all sub-domains of the current domain with
all paths that are a subset of the current path. Beware; this option can be slow. In
big-O notation, it operates in O(n*m) time, where n is the number of dots in the domain
name and m is the number of slashes in the path.<p>Arguments:</p>
<ul>
<li>name - the name of the cookie to be deleted</li>
<li>optionsString - options for the cookie. Currently supported options include 'path', 'domain' and 'recurse.' The optionsString's format is "path=/path/, domain=.foo.com, recurse=true". The order of options are irrelevant. Note that specifying a domain that isn't a subset of the current domain will usually fail.</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="deselectPopUp"></a>deselectPopUp
(
)
</strong>
</dt>
<dd>Selects the main window. Functionally equivalent to using
<code>selectWindow()</code> and specifying no value for
<code>windowID</code>.</dd>
<br>
<dt>
<strong><a name="doubleClick"></a>doubleClick
(
locator
)
</strong>
</dt>
<dd>Double clicks on a link, button, checkbox or radio button. If the double click action
causes a new page to load (like a link usually does), call
waitForPageToLoad.<p>Arguments:</p>
<ul>
<li>locator - an element locator</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="doubleClickAt"></a>doubleClickAt
(
locator,coordString
)
</strong>
</dt>
<dd>Doubleclicks on a link, button, checkbox or radio button. If the action
causes a new page to load (like a link usually does), call
waitForPageToLoad.<p>Arguments:</p>
<ul>
<li>locator - an element locator</li>
<li>coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="dragAndDrop"></a>dragAndDrop
(
locator,movementsString
)
</strong>
</dt>
<dd>Drags an element a certain distance and then drops it<p>Arguments:</p>
<ul>
<li>locator - an element locator</li>
<li>movementsString - offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="dragAndDropToObject"></a>dragAndDropToObject
(
locatorOfObjectToBeDragged,locatorOfDragDestinationObject
)
</strong>
</dt>
<dd>Drags an element and drops it on another element<p>Arguments:</p>
<ul>
<li>locatorOfObjectToBeDragged - an element to be dragged</li>
<li>locatorOfDragDestinationObject - an element whose location (i.e., whose center-most pixel) will be the point where locatorOfObjectToBeDragged is dropped</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="dragdrop"></a>dragdrop
(
locator,movementsString
)
</strong>
</dt>
<dd>deprecated - use dragAndDrop instead<p>Arguments:</p>
<ul>
<li>locator - an element locator</li>
<li>movementsString - offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="echo"></a>echo
(
message
)
</strong>
</dt>
<dd>Prints the specified message into the third table cell in your Selenese tables.
Useful for debugging.<p>Arguments:</p>
<ul>
<li>message - the message to print</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="fireEvent"></a>fireEvent
(
locator,eventName
)
</strong>
</dt>
<dd>Explicitly simulate an event, to trigger the corresponding "on<em>event</em>"
handler.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
<li>eventName - the event name, e.g. "focus" or "blur"</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="focus"></a>focus
(
locator
)
</strong>
</dt>
<dd>Move the focus to the specified element; for example, if the element is an input field, move the cursor to that field.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="goBack"></a>goBack
(
)
</strong>
</dt>
<dd>Simulates the user clicking the "back" button on their browser.</dd>
<br>
<dt>
<strong><a name="highlight"></a>highlight
(
locator
)
</strong>
</dt>
<dd>Briefly changes the backgroundColor of the specified element yellow. Useful for debugging.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="ignoreAttributesWithoutValue"></a>ignoreAttributesWithoutValue
(
ignore
)
</strong>
</dt>
<dd>Specifies whether Selenium will ignore xpath attributes that have no
value, i.e. are the empty string, when using the non-native xpath
evaluation engine. You'd want to do this for performance reasons in IE.
However, this could break certain xpaths, for example an xpath that looks
for an attribute whose value is NOT the empty string.
The hope is that such xpaths are relatively rare, but the user should
have the option of using them. Note that this only influences xpath
evaluation when using the ajaxslt engine (i.e. not "javascript-xpath").<p>Arguments:</p>
<ul>
<li>ignore - boolean, true means we'll ignore attributes without value at the expense of xpath "correctness"; false means we'll sacrifice speed for correctness.</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="keyDown"></a>keyDown
(
locator,keySequence
)
</strong>
</dt>
<dd>Simulates a user pressing a key (without releasing it yet).<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
<li>keySequence - Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119".</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="keyPress"></a>keyPress
(
locator,keySequence
)
</strong>
</dt>
<dd>Simulates a user pressing and releasing a key.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
<li>keySequence - Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119".</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="keyUp"></a>keyUp
(
locator,keySequence
)
</strong>
</dt>
<dd>Simulates a user releasing a key.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
<li>keySequence - Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119".</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="metaKeyDown"></a>metaKeyDown
(
)
</strong>
</dt>
<dd>Press the meta key and hold it down until doMetaUp() is called or a new page is loaded.</dd>
<br>
<dt>
<strong><a name="metaKeyUp"></a>metaKeyUp
(
)
</strong>
</dt>
<dd>Release the meta key.</dd>
<br>
<dt>
<strong><a name="mouseDown"></a>mouseDown
(
locator
)
</strong>
</dt>
<dd>Simulates a user pressing the left mouse button (without releasing it yet) on
the specified element.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="mouseDownAt"></a>mouseDownAt
(
locator,coordString
)
</strong>
</dt>
<dd>Simulates a user pressing the left mouse button (without releasing it yet) at
the specified location.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
<li>coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="mouseDownRight"></a>mouseDownRight
(
locator
)
</strong>
</dt>
<dd>Simulates a user pressing the right mouse button (without releasing it yet) on
the specified element.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="mouseDownRightAt"></a>mouseDownRightAt
(
locator,coordString
)
</strong>
</dt>
<dd>Simulates a user pressing the right mouse button (without releasing it yet) at
the specified location.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
<li>coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="mouseMove"></a>mouseMove
(
locator
)
</strong>
</dt>
<dd>Simulates a user pressing the mouse button (without releasing it yet) on
the specified element.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="mouseMoveAt"></a>mouseMoveAt
(
locator,coordString
)
</strong>
</dt>
<dd>Simulates a user pressing the mouse button (without releasing it yet) on
the specified element.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
<li>coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="mouseOut"></a>mouseOut
(
locator
)
</strong>
</dt>
<dd>Simulates a user moving the mouse pointer away from the specified element.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="mouseOver"></a>mouseOver
(
locator
)
</strong>
</dt>
<dd>Simulates a user hovering a mouse over the specified element.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="mouseUp"></a>mouseUp
(
locator
)
</strong>
</dt>
<dd>Simulates the event that occurs when the user releases the mouse button (i.e., stops
holding the button down) on the specified element.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="mouseUpAt"></a>mouseUpAt
(
locator,coordString
)
</strong>
</dt>
<dd>Simulates the event that occurs when the user releases the mouse button (i.e., stops
holding the button down) at the specified location.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
<li>coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="mouseUpRight"></a>mouseUpRight
(
locator
)
</strong>
</dt>
<dd>Simulates the event that occurs when the user releases the right mouse button (i.e., stops
holding the button down) on the specified element.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="mouseUpRightAt"></a>mouseUpRightAt
(
locator,coordString
)
</strong>
</dt>
<dd>Simulates the event that occurs when the user releases the right mouse button (i.e., stops
holding the button down) at the specified location.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
<li>coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="open"></a>open
(
url
)
</strong>
</dt>
<dd>Opens an URL in the test frame. This accepts both relative and absolute
URLs.
The "open" command waits for the page to load before proceeding,
ie. the "AndWait" suffix is implicit.
<em>Note</em>: The URL must be on the same domain as the runner HTML
due to security restrictions in the browser (Same Origin Policy). If you
need to open an URL on another domain, use the Selenium Server to start a
new browser session on that domain.<p>Arguments:</p>
<ul>
<li>url - the URL to open; may be relative or absolute</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="openWindow"></a>openWindow
(
url,windowID
)
</strong>
</dt>
<dd>Opens a popup window (if a window with that ID isn't already open).
After opening the window, you'll need to select it using the selectWindow
command.
<p>This command can also be a useful workaround for bug SEL-339. In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example).
In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using
an empty (blank) url, like this: openWindow("", "myFunnyWindow").</p>
<p>Arguments:</p>
<ul>
<li>url - the URL to open, which can be blank</li>
<li>windowID - the JavaScript window ID of the window to select</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="pause"></a>pause
(
waitTime
)
</strong>
</dt>
<dd>Wait for the specified amount of time (in milliseconds)<p>Arguments:</p>
<ul>
<li>waitTime - the amount of time to sleep (in milliseconds)</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="refresh"></a>refresh
(
)
</strong>
</dt>
<dd>Simulates the user clicking the "Refresh" button on their browser.</dd>
<br>
<dt>
<strong><a name="removeAllSelections"></a>removeAllSelections
(
locator
)
</strong>
</dt>
<dd>Unselects all of the selected options in a multi-select element.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a> identifying a multi-select box</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="removeScript"></a>removeScript
(
scriptTagId
)
</strong>
</dt>
<dd>Removes a script tag from the Selenium document identified by the given
id. Does nothing if the referenced tag doesn't exist.<p>Arguments:</p>
<ul>
<li>scriptTagId - the id of the script element to remove.</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="removeSelection"></a>removeSelection
(
locator,optionLocator
)
</strong>
</dt>
<dd>Remove a selection from the set of selected options in a multi-select element using an option locator.
@see #doSelect for details of option locators<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a> identifying a multi-select box</li>
<li>optionLocator - an option locator (a label by default)</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="rollup"></a>rollup
(
rollupName,kwargs
)
</strong>
</dt>
<dd>Executes a command rollup, which is a series of commands with a unique
name, and optionally arguments that control the generation of the set of
commands. If any one of the rolled-up commands fails, the rollup is
considered to have failed. Rollups may also contain nested rollups.<p>Arguments:</p>
<ul>
<li>rollupName - the name of the rollup command</li>
<li>kwargs - keyword arguments string that influences how the rollup expands into commands</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="runScript"></a>runScript
(
script
)
</strong>
</dt>
<dd>Creates a new "script" tag in the body of the current test window, and
adds the specified text into the body of the command. Scripts run in
this way can often be debugged more easily than scripts executed using
Selenium's "getEval" command. Beware that JS exceptions thrown in these script
tags aren't managed by Selenium, so you should probably wrap your script
in try/catch blocks if there is any chance that the script will throw
an exception.<p>Arguments:</p>
<ul>
<li>script - the JavaScript snippet to run</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="select"></a>select
(
selectLocator,optionLocator
)
</strong>
</dt>
<dd>Select an option from a drop-down using an option locator.
<p>
Option locators provide different ways of specifying options of an HTML
Select element (e.g. for selecting a specific option, or for asserting
that the selected option satisfies a specification). There are several
forms of Select Option Locator.
</p>
<ul>
<li>
<strong>label</strong>=<em>labelPattern</em>:
matches options based on their labels, i.e. the visible text. (This
is the default.)
<ul class="first last simple">
<li>label=regexp:^[Oo]ther</li>
</ul>
</li>
<li>
<strong>value</strong>=<em>valuePattern</em>:
matches options based on their values.
<ul class="first last simple">
<li>value=other</li>
</ul>
</li>
<li>
<strong>id</strong>=<em>id</em>:
matches options based on their ids.
<ul class="first last simple">
<li>id=option1</li>
</ul>
</li>
<li>
<strong>index</strong>=<em>index</em>:
matches an option based on its index (offset from zero).
<ul class="first last simple">
<li>index=2</li>
</ul>
</li>
</ul>
<p>
If no option locator prefix is provided, the default behaviour is to match on <strong>label</strong>.
</p>
<p>Arguments:</p>
<ul>
<li>selectLocator - an <a href="#locators">element locator</a> identifying a drop-down menu</li>
<li>optionLocator - an option locator (a label by default)</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="selectFrame"></a>selectFrame
(
locator
)
</strong>
</dt>
<dd>Selects a frame within the current window. (You may invoke this command
multiple times to select nested frames.) To select the parent frame, use
"relative=parent" as a locator; to select the top frame, use "relative=top".
You can also select a frame by its 0-based index number; select the first frame with
"index=0", or the third frame with "index=2".
<p>You may also use a DOM expression to identify the frame you want directly,
like this: <code>dom=frames["main"].frames["subframe"]</code>
</p>
<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a> identifying a frame or iframe</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="selectPopUp"></a>selectPopUp
(
windowID
)
</strong>
</dt>
<dd>Simplifies the process of selecting a popup window (and does not offer
functionality beyond what <code>selectWindow()</code> already provides).
<ul>
<li>If <code>windowID</code> is either not specified, or specified as
"null", the first non-top window is selected. The top window is the one
that would be selected by <code>selectWindow()</code> without providing a
<code>windowID</code> . This should not be used when more than one popup
window is in play.</li>
<li>Otherwise, the window will be looked up considering
<code>windowID</code> as the following in order: 1) the "name" of the
window, as specified to <code>window.open()</code>; 2) a javascript
variable which is a reference to a window; and 3) the title of the
window. This is the same ordered lookup performed by
<code>selectWindow</code> .</li>
</ul>
<p>Arguments:</p>
<ul>
<li>windowID - an identifier for the popup window, which can take on a number of different meanings</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="selectWindow"></a>selectWindow
(
windowID
)
</strong>
</dt>
<dd>Selects a popup window using a window locator; once a popup window has been selected, all
commands go to that window. To select the main window again, use null
as the target.
<p>
Window locators provide different ways of specifying the window object:
by title, by internal JavaScript "name," or by JavaScript variable.
</p>
<ul>
<li>
<strong>title</strong>=<em>My Special Window</em>:
Finds the window using the text that appears in the title bar. Be careful;
two windows can share the same title. If that happens, this locator will
just pick one.
</li>
<li>
<strong>name</strong>=<em>myWindow</em>:
Finds the window using its internal JavaScript "name" property. This is the second
parameter "windowName" passed to the JavaScript method window.open(url, windowName, windowFeatures, replaceFlag)
(which Selenium intercepts).
</li>
<li>
<strong>var</strong>=<em>variableName</em>:
Some pop-up windows are unnamed (anonymous), but are associated with a JavaScript variable name in the current
application window, e.g. "window.foo = window.open(url);". In those cases, you can open the window using
"var=foo".
</li>
</ul>
<p>
If no window locator prefix is provided, we'll try to guess what you mean like this:</p>
<p>1.) if windowID is null, (or the string "null") then it is assumed the user is referring to the original window instantiated by the browser).</p>
<p>2.) if the value of the "windowID" parameter is a JavaScript variable name in the current application window, then it is assumed
that this variable contains the return value from a call to the JavaScript window.open() method.</p>
<p>3.) Otherwise, selenium looks in a hash it maintains that maps string names to window "names".</p>
<p>4.) If <em>that</em> fails, we'll try looping over all of the known windows to try to find the appropriate "title".
Since "title" is not necessarily unique, this may have unexpected behavior.</p>
<p>If you're having trouble figuring out the name of a window that you want to manipulate, look at the Selenium log messages
which identify the names of windows created via window.open (and therefore intercepted by Selenium). You will see messages
like the following for each window as it is opened:</p>
<p>
<code>debug: window.open call intercepted; window ID (which you can use with selectWindow()) is "myNewWindow"</code>
</p>
<p>In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example).
(This is bug SEL-339.) In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using
an empty (blank) url, like this: openWindow("", "myFunnyWindow").</p>
<p>Arguments:</p>
<ul>
<li>windowID - the JavaScript window ID of the window to select</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="setBrowserLogLevel"></a>setBrowserLogLevel
(
logLevel
)
</strong>
</dt>
<dd>Sets the threshold for browser-side logging messages; log messages beneath this threshold will be discarded.
Valid logLevel strings are: "debug", "info", "warn", "error" or "off".
To see the browser logs, you need to
either show the log window in GUI mode, or enable browser-side logging in Selenium RC.<p>Arguments:</p>
<ul>
<li>logLevel - one of the following: "debug", "info", "warn", "error" or "off"</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="setCursorPosition"></a>setCursorPosition
(
locator,position
)
</strong>
</dt>
<dd>Moves the text cursor to the specified position in the given input element or textarea.
This method will fail if the specified element isn't an input element or textarea.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a> pointing to an input element or textarea</li>
<li>position - the numerical position of the cursor in the field; position should be 0 to move the position to the beginning of the field. You can also set the cursor to -1 to move it to the end of the field.</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="setMouseSpeed"></a>setMouseSpeed
(
pixels
)
</strong>
</dt>
<dd>Configure the number of pixels between "mousemove" events during dragAndDrop commands (default=10).
<p>Setting this value to 0 means that we'll send a "mousemove" event to every single pixel
in between the start location and the end location; that can be very slow, and may
cause some browsers to force the JavaScript to timeout.</p>
<p>If the mouse speed is greater than the distance between the two dragged objects, we'll
just send one "mousemove" at the start location and then one final one at the end location.</p>
<p>Arguments:</p>
<ul>
<li>pixels - the number of pixels between "mousemove" events</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="setSpeed"></a>setSpeed
(
value
)
</strong>
</dt>
<dd>Set execution speed (i.e., set the millisecond length of a delay which will follow each selenium operation). By default, there is no such delay, i.e.,
the delay is 0 milliseconds.<p>Arguments:</p>
<ul>
<li>value - the number of milliseconds to pause after operation</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="setTimeout"></a>setTimeout
(
timeout
)
</strong>
</dt>
<dd>Specifies the amount of time that Selenium will wait for actions to complete.
<p>Actions that require waiting include "open" and the "waitFor*" actions.</p>
The default timeout is 30 seconds.<p>Arguments:</p>
<ul>
<li>timeout - a timeout in milliseconds, after which the action will return with an error</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="shiftKeyDown"></a>shiftKeyDown
(
)
</strong>
</dt>
<dd>Press the shift key and hold it down until doShiftUp() is called or a new page is loaded.</dd>
<br>
<dt>
<strong><a name="shiftKeyUp"></a>shiftKeyUp
(
)
</strong>
</dt>
<dd>Release the shift key.</dd>
<br>
<dt>
<strong><a name="store"></a>store
(
expression,variableName
)
</strong>
</dt>
<dd>This command is a synonym for storeExpression.<p>Arguments:</p>
<ul>
<li>expression - the value to store</li>
<li>variableName - the name of a <a href="#storedVars">variable</a> in which the result is to be stored.</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="submit"></a>submit
(
formLocator
)
</strong>
</dt>
<dd>Submit the specified form. This is particularly useful for forms without
submit buttons, e.g. single-input "Search" forms.<p>Arguments:</p>
<ul>
<li>formLocator - an <a href="#locators">element locator</a> for the form you want to submit</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="type"></a>type
(
locator,value
)
</strong>
</dt>
<dd>Sets the value of an input field, as though you typed it in.
<p>Can also be used to set the value of combo boxes, check boxes, etc. In these cases,
value should be the value of the option selected, not the visible text.</p>
<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
<li>value - the value to type</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="typeKeys"></a>typeKeys
(
locator,value
)
</strong>
</dt>
<dd>Simulates keystroke events on the specified element, as though you typed the value key-by-key.
<p>This is a convenience method for calling keyDown, keyUp, keyPress for every character in the specified string;
this is useful for dynamic UI widgets (like auto-completing combo boxes) that require explicit key events.</p>
<p>Unlike the simple "type" command, which forces the specified value into the page directly, this command
may or may not have any visible effect, even in cases where typing keys would normally have a visible effect.
For example, if you use "typeKeys" on a form element, you may or may not see the results of what you typed in
the field.</p>
<p>In some cases, you may need to use the simple "type" command to set the value of the field and then the "typeKeys" command to
send the keystroke events corresponding to what you just typed.</p>
<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
<li>value - the value to type</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="uncheck"></a>uncheck
(
locator
)
</strong>
</dt>
<dd>Uncheck a toggle-button (checkbox/radio)<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="useXpathLibrary"></a>useXpathLibrary
(
libraryName
)
</strong>
</dt>
<dd>Allows choice of one of the available libraries.<p>Arguments:</p>
<ul>
<li>libraryName - name of the desired library Only the following three can be chosen: <ul>
<li>"ajaxslt" - Google's library</li>
<li>"javascript-xpath" - Cybozu Labs' faster library</li>
<li>"default" - The default library. Currently the default library is "ajaxslt" .</li>
</ul> If libraryName isn't one of these three, then no change will be made.</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="waitForCondition"></a>waitForCondition
(
script,timeout
)
</strong>
</dt>
<dd>Runs the specified JavaScript snippet repeatedly until it evaluates to "true".
The snippet may have multiple lines, but only the result of the last line
will be considered.
<p>Note that, by default, the snippet will be run in the runner's test window, not in the window
of your application. To get the window of your application, you can use
the JavaScript snippet <code>selenium.browserbot.getCurrentWindow()</code>, and then
run your JavaScript in there</p>
<p>Arguments:</p>
<ul>
<li>script - the JavaScript snippet to run</li>
<li>timeout - a timeout in milliseconds, after which this command will return with an error</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="waitForFrameToLoad"></a>waitForFrameToLoad
(
frameAddress,timeout
)
</strong>
</dt>
<dd>Waits for a new frame to load.
<p>Selenium constantly keeps track of new pages and frames loading,
and sets a "newPageLoaded" flag when it first notices a page load.</p>
See waitForPageToLoad for more information.<p>Arguments:</p>
<ul>
<li>frameAddress - FrameAddress from the server side</li>
<li>timeout - a timeout in milliseconds, after which this command will return with an error</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="waitForPageToLoad"></a>waitForPageToLoad
(
timeout
)
</strong>
</dt>
<dd>Waits for a new page to load.
<p>You can use this command instead of the "AndWait" suffixes, "clickAndWait", "selectAndWait", "typeAndWait" etc.
(which are only available in the JS API).</p>
<p>Selenium constantly keeps track of new pages loading, and sets a "newPageLoaded"
flag when it first notices a page load. Running any other Selenium command after
turns the flag to false. Hence, if you want to wait for a page to load, you must
wait immediately after a Selenium command that caused a page-load.</p>
<p>Arguments:</p>
<ul>
<li>timeout - a timeout in milliseconds, after which this command will return with an error</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="waitForPopUp"></a>waitForPopUp
(
windowID,timeout
)
</strong>
</dt>
<dd>Waits for a popup window to appear and load up.<p>Arguments:</p>
<ul>
<li>windowID - the JavaScript window "name" of the window that will appear (not the text of the title bar) If unspecified, or specified as "null", this command will wait for the first non-top window to appear (don't rely on this if you are working with multiple popups simultaneously).</li>
<li>timeout - a timeout in milliseconds, after which the action will return with an error. If this value is not specified, the default Selenium timeout will be used. See the setTimeout() command.</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="windowFocus"></a>windowFocus
(
)
</strong>
</dt>
<dd>Gives focus to the currently selected window</dd>
<br>
<dt>
<strong><a name="windowMaximize"></a>windowMaximize
(
)
</strong>
</dt>
<dd>Resize currently selected window to take up the entire screen</dd>
<br>
</dl>
<a name="accessors"></a>
<h2>Selenium Accessors</h2>
<dl>
<dt>
<strong><a name="assertErrorOnNext"></a>assertErrorOnNext
(
message
)
</strong>
</dt>
<dd>Tell Selenium to expect an error on the next command execution.<p>Arguments:</p>
<ul>
<li>message - The error message we should expect. This command will fail if the wrong error message appears.</li>
</ul>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertNotErrorOnNext
(
message
)
</li>
<li>verifyErrorOnNext
(
message
)
</li>
<li>verifyNotErrorOnNext
(
message
)
</li>
<li>waitForErrorOnNext
(
message
)
</li>
<li>waitForNotErrorOnNext
(
message
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="assertFailureOnNext"></a>assertFailureOnNext
(
message
)
</strong>
</dt>
<dd>Tell Selenium to expect a failure on the next command execution.<p>Arguments:</p>
<ul>
<li>message - The failure message we should expect. This command will fail if the wrong failure message appears.</li>
</ul>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertNotFailureOnNext
(
message
)
</li>
<li>verifyFailureOnNext
(
message
)
</li>
<li>verifyNotFailureOnNext
(
message
)
</li>
<li>waitForFailureOnNext
(
message
)
</li>
<li>waitForNotFailureOnNext
(
message
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="assertSelected"></a>assertSelected
(
selectLocator,optionLocator
)
</strong>
</dt>
<dd>Verifies that the selected option of a drop-down satisfies the optionSpecifier. <i>Note that this command is deprecated; you should use assertSelectedLabel, assertSelectedValue, assertSelectedIndex, or assertSelectedId instead.</i>
<p>See the select command for more information about option locators.</p>
<p>Arguments:</p>
<ul>
<li>selectLocator - an <a href="#locators">element locator</a> identifying a drop-down menu</li>
<li>optionLocator - an option locator, typically just an option label (e.g. "John Smith")</li>
</ul>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertNotSelected
(
selectLocator, optionLocator
)
</li>
<li>verifySelected
(
selectLocator, optionLocator
)
</li>
<li>verifyNotSelected
(
selectLocator, optionLocator
)
</li>
<li>waitForSelected
(
selectLocator, optionLocator
)
</li>
<li>waitForNotSelected
(
selectLocator, optionLocator
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeAlert"></a>storeAlert
(
variableName
)
</strong>
</dt>
<dd>Retrieves the message of a JavaScript alert generated during the previous action, or fail if there were no alerts.
<p>Getting an alert has the same effect as manually clicking OK. If an
alert is generated but you do not consume it with getAlert, the next Selenium action
will fail.</p>
<p>Under Selenium, JavaScript alerts will NOT pop up a visible alert
dialog.</p>
<p>Selenium does NOT support JavaScript alerts that are generated in a
page's onload() event handler. In this case a visible dialog WILL be
generated and Selenium will hang until someone manually clicks OK.</p>
<p>
<dl>
<dt>Returns: </dt>
<dd>The message of the most recent JavaScript alert</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertAlert
(
<a href="#patterns">pattern</a>
)
</li>
<li>assertNotAlert
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyAlert
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyNotAlert
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForAlert
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForNotAlert
(
<a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeAllButtons"></a>storeAllButtons
(
variableName
)
</strong>
</dt>
<dd>Returns the IDs of all buttons on the page.
<p>If a given button has no ID, it will appear as "" in this array.</p>
<p>
<dl>
<dt>Returns: </dt>
<dd>the IDs of all buttons on the page</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertAllButtons
(
<a href="#patterns">pattern</a>
)
</li>
<li>assertNotAllButtons
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyAllButtons
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyNotAllButtons
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForAllButtons
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForNotAllButtons
(
<a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeAllFields"></a>storeAllFields
(
variableName
)
</strong>
</dt>
<dd>Returns the IDs of all input fields on the page.
<p>If a given field has no ID, it will appear as "" in this array.</p>
<p>
<dl>
<dt>Returns: </dt>
<dd>the IDs of all field on the page</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertAllFields
(
<a href="#patterns">pattern</a>
)
</li>
<li>assertNotAllFields
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyAllFields
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyNotAllFields
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForAllFields
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForNotAllFields
(
<a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeAllLinks"></a>storeAllLinks
(
variableName
)
</strong>
</dt>
<dd>Returns the IDs of all links on the page.
<p>If a given link has no ID, it will appear as "" in this array.</p>
<p>
<dl>
<dt>Returns: </dt>
<dd>the IDs of all links on the page</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertAllLinks
(
<a href="#patterns">pattern</a>
)
</li>
<li>assertNotAllLinks
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyAllLinks
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyNotAllLinks
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForAllLinks
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForNotAllLinks
(
<a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeAllWindowIds"></a>storeAllWindowIds
(
variableName
)
</strong>
</dt>
<dd>Returns the IDs of all windows that the browser knows about in an array.<p>
<dl>
<dt>Returns: </dt>
<dd>Array of identifiers of all windows that the browser knows about.</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertAllWindowIds
(
<a href="#patterns">pattern</a>
)
</li>
<li>assertNotAllWindowIds
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyAllWindowIds
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyNotAllWindowIds
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForAllWindowIds
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForNotAllWindowIds
(
<a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeAllWindowNames"></a>storeAllWindowNames
(
variableName
)
</strong>
</dt>
<dd>Returns the names of all windows that the browser knows about in an array.<p>
<dl>
<dt>Returns: </dt>
<dd>Array of names of all windows that the browser knows about.</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertAllWindowNames
(
<a href="#patterns">pattern</a>
)
</li>
<li>assertNotAllWindowNames
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyAllWindowNames
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyNotAllWindowNames
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForAllWindowNames
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForNotAllWindowNames
(
<a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeAllWindowTitles"></a>storeAllWindowTitles
(
variableName
)
</strong>
</dt>
<dd>Returns the titles of all windows that the browser knows about in an array.<p>
<dl>
<dt>Returns: </dt>
<dd>Array of titles of all windows that the browser knows about.</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertAllWindowTitles
(
<a href="#patterns">pattern</a>
)
</li>
<li>assertNotAllWindowTitles
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyAllWindowTitles
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyNotAllWindowTitles
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForAllWindowTitles
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForNotAllWindowTitles
(
<a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeAttribute"></a>storeAttribute
(
attributeLocator,
variableName
)
</strong>
</dt>
<dd>Gets the value of an element attribute. The value of the attribute may
differ across browsers (this is the case for the "style" attribute, for
example).<p>Arguments:</p>
<ul>
<li>attributeLocator - an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar"</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>the value of the specified attribute</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertAttribute
(
attributeLocator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotAttribute
(
attributeLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyAttribute
(
attributeLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotAttribute
(
attributeLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForAttribute
(
attributeLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotAttribute
(
attributeLocator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeAttributeFromAllWindows"></a>storeAttributeFromAllWindows
(
attributeName,
variableName
)
</strong>
</dt>
<dd>Returns an array of JavaScript property values from all known windows having one.<p>Arguments:</p>
<ul>
<li>attributeName - name of an attribute on the windows</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>the set of values of this attribute from all known windows.</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertAttributeFromAllWindows
(
attributeName, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotAttributeFromAllWindows
(
attributeName, <a href="#patterns">pattern</a>
)
</li>
<li>verifyAttributeFromAllWindows
(
attributeName, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotAttributeFromAllWindows
(
attributeName, <a href="#patterns">pattern</a>
)
</li>
<li>waitForAttributeFromAllWindows
(
attributeName, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotAttributeFromAllWindows
(
attributeName, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeBodyText"></a>storeBodyText
(
variableName
)
</strong>
</dt>
<dd>Gets the entire text of the page.<p>
<dl>
<dt>Returns: </dt>
<dd>the entire text of the page</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertBodyText
(
<a href="#patterns">pattern</a>
)
</li>
<li>assertNotBodyText
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyBodyText
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyNotBodyText
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForBodyText
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForNotBodyText
(
<a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeConfirmation"></a>storeConfirmation
(
variableName
)
</strong>
</dt>
<dd>Retrieves the message of a JavaScript confirmation dialog generated during
the previous action.
<p>
By default, the confirm function will return true, having the same effect
as manually clicking OK. This can be changed by prior execution of the
chooseCancelOnNextConfirmation command.
</p>
<p>
If an confirmation is generated but you do not consume it with getConfirmation,
the next Selenium action will fail.
</p>
<p>
NOTE: under Selenium, JavaScript confirmations will NOT pop up a visible
dialog.
</p>
<p>
NOTE: Selenium does NOT support JavaScript confirmations that are
generated in a page's onload() event handler. In this case a visible
dialog WILL be generated and Selenium will hang until you manually click
OK.
</p>
<p>
<dl>
<dt>Returns: </dt>
<dd>the message of the most recent JavaScript confirmation dialog</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertConfirmation
(
<a href="#patterns">pattern</a>
)
</li>
<li>assertNotConfirmation
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyConfirmation
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyNotConfirmation
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForConfirmation
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForNotConfirmation
(
<a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeCookie"></a>storeCookie
(
variableName
)
</strong>
</dt>
<dd>Return all cookies of the current page under test.<p>
<dl>
<dt>Returns: </dt>
<dd>all cookies of the current page under test</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertCookie
(
<a href="#patterns">pattern</a>
)
</li>
<li>assertNotCookie
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyCookie
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyNotCookie
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForCookie
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForNotCookie
(
<a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeCookieByName"></a>storeCookieByName
(
name,
variableName
)
</strong>
</dt>
<dd>Returns the value of the cookie with the specified name, or throws an error if the cookie is not present.<p>Arguments:</p>
<ul>
<li>name - the name of the cookie</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>the value of the cookie</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertCookieByName
(
name, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotCookieByName
(
name, <a href="#patterns">pattern</a>
)
</li>
<li>verifyCookieByName
(
name, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotCookieByName
(
name, <a href="#patterns">pattern</a>
)
</li>
<li>waitForCookieByName
(
name, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotCookieByName
(
name, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeCursorPosition"></a>storeCursorPosition
(
locator,
variableName
)
</strong>
</dt>
<dd>Retrieves the text cursor position in the given input element or textarea; beware, this may not work perfectly on all browsers.
<p>Specifically, if the cursor/selection has been cleared by JavaScript, this command will tend to
return the position of the last location of the cursor, even though the cursor is now gone from the page. This is filed as <a href="http://jira.openqa.org/browse/SEL-243">SEL-243</a>.</p>
This method will fail if the specified element isn't an input element or textarea, or there is no cursor in the element.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a> pointing to an input element or textarea</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>the numerical position of the cursor in the field</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertCursorPosition
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotCursorPosition
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyCursorPosition
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotCursorPosition
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForCursorPosition
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotCursorPosition
(
locator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeElementHeight"></a>storeElementHeight
(
locator,
variableName
)
</strong>
</dt>
<dd>Retrieves the height of an element<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a> pointing to an element</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>height of an element in pixels</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertElementHeight
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotElementHeight
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyElementHeight
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotElementHeight
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForElementHeight
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotElementHeight
(
locator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeElementIndex"></a>storeElementIndex
(
locator,
variableName
)
</strong>
</dt>
<dd>Get the relative index of an element to its parent (starting from 0). The comment node and empty text node
will be ignored.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a> pointing to an element</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>of relative index of the element to its parent (starting from 0)</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertElementIndex
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotElementIndex
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyElementIndex
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotElementIndex
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForElementIndex
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotElementIndex
(
locator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeElementPositionLeft"></a>storeElementPositionLeft
(
locator,
variableName
)
</strong>
</dt>
<dd>Retrieves the horizontal position of an element<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a> pointing to an element OR an element itself</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>of pixels from the edge of the frame.</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertElementPositionLeft
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotElementPositionLeft
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyElementPositionLeft
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotElementPositionLeft
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForElementPositionLeft
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotElementPositionLeft
(
locator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeElementPositionTop"></a>storeElementPositionTop
(
locator,
variableName
)
</strong>
</dt>
<dd>Retrieves the vertical position of an element<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a> pointing to an element OR an element itself</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>of pixels from the edge of the frame.</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertElementPositionTop
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotElementPositionTop
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyElementPositionTop
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotElementPositionTop
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForElementPositionTop
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotElementPositionTop
(
locator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeElementWidth"></a>storeElementWidth
(
locator,
variableName
)
</strong>
</dt>
<dd>Retrieves the width of an element<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a> pointing to an element</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>width of an element in pixels</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertElementWidth
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotElementWidth
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyElementWidth
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotElementWidth
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForElementWidth
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotElementWidth
(
locator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeEval"></a>storeEval
(
script,
variableName
)
</strong>
</dt>
<dd>Gets the result of evaluating the specified JavaScript snippet. The snippet may
have multiple lines, but only the result of the last line will be returned.
<p>Note that, by default, the snippet will run in the context of the "selenium"
object itself, so <code>this</code> will refer to the Selenium object. Use <code>window</code> to
refer to the window of your application, e.g. <code>window.document.getElementById('foo')</code>
</p>
<p>If you need to use
a locator to refer to a single element in your application page, you can
use <code>this.browserbot.findElement("id=foo")</code> where "id=foo" is your locator.</p>
<p>Arguments:</p>
<ul>
<li>script - the JavaScript snippet to run</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>the results of evaluating the snippet</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertEval
(
script, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotEval
(
script, <a href="#patterns">pattern</a>
)
</li>
<li>verifyEval
(
script, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotEval
(
script, <a href="#patterns">pattern</a>
)
</li>
<li>waitForEval
(
script, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotEval
(
script, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeExpression"></a>storeExpression
(
expression,
variableName
)
</strong>
</dt>
<dd>Returns the specified expression.
<p>This is useful because of JavaScript preprocessing.
It is used to generate commands like assertExpression and waitForExpression.</p>
<p>Arguments:</p>
<ul>
<li>expression - the value to return</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>the value passed in</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertExpression
(
expression, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotExpression
(
expression, <a href="#patterns">pattern</a>
)
</li>
<li>verifyExpression
(
expression, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotExpression
(
expression, <a href="#patterns">pattern</a>
)
</li>
<li>waitForExpression
(
expression, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotExpression
(
expression, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeHtmlSource"></a>storeHtmlSource
(
variableName
)
</strong>
</dt>
<dd>Returns the entire HTML source between the opening and
closing "html" tags.<p>
<dl>
<dt>Returns: </dt>
<dd>the entire HTML source</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertHtmlSource
(
<a href="#patterns">pattern</a>
)
</li>
<li>assertNotHtmlSource
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyHtmlSource
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyNotHtmlSource
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForHtmlSource
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForNotHtmlSource
(
<a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeLocation"></a>storeLocation
(
variableName
)
</strong>
</dt>
<dd>Gets the absolute URL of the current page.<p>
<dl>
<dt>Returns: </dt>
<dd>the absolute URL of the current page</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertLocation
(
<a href="#patterns">pattern</a>
)
</li>
<li>assertNotLocation
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyLocation
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyNotLocation
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForLocation
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForNotLocation
(
<a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeMouseSpeed"></a>storeMouseSpeed
(
variableName
)
</strong>
</dt>
<dd>Returns the number of pixels between "mousemove" events during dragAndDrop commands (default=10).<p>
<dl>
<dt>Returns: </dt>
<dd>the number of pixels between "mousemove" events during dragAndDrop commands (default=10)</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertMouseSpeed
(
<a href="#patterns">pattern</a>
)
</li>
<li>assertNotMouseSpeed
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyMouseSpeed
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyNotMouseSpeed
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForMouseSpeed
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForNotMouseSpeed
(
<a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storePrompt"></a>storePrompt
(
variableName
)
</strong>
</dt>
<dd>Retrieves the message of a JavaScript question prompt dialog generated during
the previous action.
<p>Successful handling of the prompt requires prior execution of the
answerOnNextPrompt command. If a prompt is generated but you
do not get/verify it, the next Selenium action will fail.</p>
<p>NOTE: under Selenium, JavaScript prompts will NOT pop up a visible
dialog.</p>
<p>NOTE: Selenium does NOT support JavaScript prompts that are generated in a
page's onload() event handler. In this case a visible dialog WILL be
generated and Selenium will hang until someone manually clicks OK.</p>
<p>
<dl>
<dt>Returns: </dt>
<dd>the message of the most recent JavaScript question prompt</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertPrompt
(
<a href="#patterns">pattern</a>
)
</li>
<li>assertNotPrompt
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyPrompt
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyNotPrompt
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForPrompt
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForNotPrompt
(
<a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeSelectedId"></a>storeSelectedId
(
selectLocator,
variableName
)
</strong>
</dt>
<dd>Gets option element ID for selected option in the specified select element.<p>Arguments:</p>
<ul>
<li>selectLocator - an <a href="#locators">element locator</a> identifying a drop-down menu</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>the selected option ID in the specified select drop-down</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertSelectedId
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotSelectedId
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifySelectedId
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotSelectedId
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForSelectedId
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotSelectedId
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeSelectedIds"></a>storeSelectedIds
(
selectLocator,
variableName
)
</strong>
</dt>
<dd>Gets all option element IDs for selected options in the specified select or multi-select element.<p>Arguments:</p>
<ul>
<li>selectLocator - an <a href="#locators">element locator</a> identifying a drop-down menu</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>an array of all selected option IDs in the specified select drop-down</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertSelectedIds
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotSelectedIds
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifySelectedIds
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotSelectedIds
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForSelectedIds
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotSelectedIds
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeSelectedIndex"></a>storeSelectedIndex
(
selectLocator,
variableName
)
</strong>
</dt>
<dd>Gets option index (option number, starting at 0) for selected option in the specified select element.<p>Arguments:</p>
<ul>
<li>selectLocator - an <a href="#locators">element locator</a> identifying a drop-down menu</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>the selected option index in the specified select drop-down</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertSelectedIndex
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotSelectedIndex
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifySelectedIndex
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotSelectedIndex
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForSelectedIndex
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotSelectedIndex
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeSelectedIndexes"></a>storeSelectedIndexes
(
selectLocator,
variableName
)
</strong>
</dt>
<dd>Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element.<p>Arguments:</p>
<ul>
<li>selectLocator - an <a href="#locators">element locator</a> identifying a drop-down menu</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>an array of all selected option indexes in the specified select drop-down</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertSelectedIndexes
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotSelectedIndexes
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifySelectedIndexes
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotSelectedIndexes
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForSelectedIndexes
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotSelectedIndexes
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeSelectedLabel"></a>storeSelectedLabel
(
selectLocator,
variableName
)
</strong>
</dt>
<dd>Gets option label (visible text) for selected option in the specified select element.<p>Arguments:</p>
<ul>
<li>selectLocator - an <a href="#locators">element locator</a> identifying a drop-down menu</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>the selected option label in the specified select drop-down</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertSelectedLabel
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotSelectedLabel
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifySelectedLabel
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotSelectedLabel
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForSelectedLabel
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotSelectedLabel
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeSelectedLabels"></a>storeSelectedLabels
(
selectLocator,
variableName
)
</strong>
</dt>
<dd>Gets all option labels (visible text) for selected options in the specified select or multi-select element.<p>Arguments:</p>
<ul>
<li>selectLocator - an <a href="#locators">element locator</a> identifying a drop-down menu</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>an array of all selected option labels in the specified select drop-down</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertSelectedLabels
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotSelectedLabels
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifySelectedLabels
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotSelectedLabels
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForSelectedLabels
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotSelectedLabels
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeSelectedValue"></a>storeSelectedValue
(
selectLocator,
variableName
)
</strong>
</dt>
<dd>Gets option value (value attribute) for selected option in the specified select element.<p>Arguments:</p>
<ul>
<li>selectLocator - an <a href="#locators">element locator</a> identifying a drop-down menu</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>the selected option value in the specified select drop-down</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertSelectedValue
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotSelectedValue
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifySelectedValue
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotSelectedValue
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForSelectedValue
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotSelectedValue
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeSelectedValues"></a>storeSelectedValues
(
selectLocator,
variableName
)
</strong>
</dt>
<dd>Gets all option values (value attributes) for selected options in the specified select or multi-select element.<p>Arguments:</p>
<ul>
<li>selectLocator - an <a href="#locators">element locator</a> identifying a drop-down menu</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>an array of all selected option values in the specified select drop-down</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertSelectedValues
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotSelectedValues
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifySelectedValues
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotSelectedValues
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForSelectedValues
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotSelectedValues
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeSelectOptions"></a>storeSelectOptions
(
selectLocator,
variableName
)
</strong>
</dt>
<dd>Gets all option labels in the specified select drop-down.<p>Arguments:</p>
<ul>
<li>selectLocator - an <a href="#locators">element locator</a> identifying a drop-down menu</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>an array of all option labels in the specified select drop-down</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertSelectOptions
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotSelectOptions
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifySelectOptions
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotSelectOptions
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForSelectOptions
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotSelectOptions
(
selectLocator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeSpeed"></a>storeSpeed
(
variableName
)
</strong>
</dt>
<dd>Get execution speed (i.e., get the millisecond length of the delay following each selenium operation). By default, there is no such delay, i.e.,
the delay is 0 milliseconds.
See also setSpeed.<p>
<dl>
<dt>Returns: </dt>
<dd>the execution speed in milliseconds.</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertSpeed
(
<a href="#patterns">pattern</a>
)
</li>
<li>assertNotSpeed
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifySpeed
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyNotSpeed
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForSpeed
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForNotSpeed
(
<a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeTable"></a>storeTable
(
tableCellAddress,
variableName
)
</strong>
</dt>
<dd>Gets the text from a cell of a table. The cellAddress syntax
tableLocator.row.column, where row and column start at 0.<p>Arguments:</p>
<ul>
<li>tableCellAddress - a cell address, e.g. "foo.1.4"</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>the text from the specified cell</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertTable
(
tableCellAddress, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotTable
(
tableCellAddress, <a href="#patterns">pattern</a>
)
</li>
<li>verifyTable
(
tableCellAddress, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotTable
(
tableCellAddress, <a href="#patterns">pattern</a>
)
</li>
<li>waitForTable
(
tableCellAddress, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotTable
(
tableCellAddress, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeText"></a>storeText
(
locator,
variableName
)
</strong>
</dt>
<dd>Gets the text of an element. This works for any element that contains
text. This command uses either the textContent (Mozilla-like browsers) or
the innerText (IE-like browsers) of the element, which is the rendered
text shown to the user.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>the text of the element</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertText
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotText
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyText
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotText
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForText
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotText
(
locator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeTitle"></a>storeTitle
(
variableName
)
</strong>
</dt>
<dd>Gets the title of the current page.<p>
<dl>
<dt>Returns: </dt>
<dd>the title of the current page</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertTitle
(
<a href="#patterns">pattern</a>
)
</li>
<li>assertNotTitle
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyTitle
(
<a href="#patterns">pattern</a>
)
</li>
<li>verifyNotTitle
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForTitle
(
<a href="#patterns">pattern</a>
)
</li>
<li>waitForNotTitle
(
<a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeValue"></a>storeValue
(
locator,
variableName
)
</strong>
</dt>
<dd>Gets the (whitespace-trimmed) value of an input field (or anything else with a value parameter).
For checkbox/radio elements, the value will be "on" or "off" depending on
whether the element is checked or not.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>the element value, or "on/off" for checkbox/radio elements</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertValue
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotValue
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyValue
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotValue
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForValue
(
locator, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotValue
(
locator, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeWhetherThisFrameMatchFrameExpression"></a>storeWhetherThisFrameMatchFrameExpression
(
currentFrameString,
target,
variableName
)
</strong>
</dt>
<dd>Determine whether current/locator identify the frame containing this running code.
<p>This is useful in proxy injection mode, where this code runs in every
browser frame and window, and sometimes the selenium server needs to identify
the "current" frame. In this case, when the test calls selectFrame, this
routine is called for each frame to figure out which one has been selected.
The selected frame will return true, while all others will return false.</p>
<p>Arguments:</p>
<ul>
<li>currentFrameString - starting frame</li>
<li>target - new frame (which might be relative to the current one)</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>true if the new frame is this code's window</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertWhetherThisFrameMatchFrameExpression
(
currentFrameString, target
)
</li>
<li>assertNotWhetherThisFrameMatchFrameExpression
(
currentFrameString, target
)
</li>
<li>verifyWhetherThisFrameMatchFrameExpression
(
currentFrameString, target
)
</li>
<li>verifyNotWhetherThisFrameMatchFrameExpression
(
currentFrameString, target
)
</li>
<li>waitForWhetherThisFrameMatchFrameExpression
(
currentFrameString, target
)
</li>
<li>waitForNotWhetherThisFrameMatchFrameExpression
(
currentFrameString, target
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeWhetherThisWindowMatchWindowExpression"></a>storeWhetherThisWindowMatchWindowExpression
(
currentWindowString,
target,
variableName
)
</strong>
</dt>
<dd>Determine whether currentWindowString plus target identify the window containing this running code.
<p>This is useful in proxy injection mode, where this code runs in every
browser frame and window, and sometimes the selenium server needs to identify
the "current" window. In this case, when the test calls selectWindow, this
routine is called for each window to figure out which one has been selected.
The selected window will return true, while all others will return false.</p>
<p>Arguments:</p>
<ul>
<li>currentWindowString - starting window</li>
<li>target - new window (which might be relative to the current one, e.g., "_parent")</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>true if the new window is this code's window</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertWhetherThisWindowMatchWindowExpression
(
currentWindowString, target
)
</li>
<li>assertNotWhetherThisWindowMatchWindowExpression
(
currentWindowString, target
)
</li>
<li>verifyWhetherThisWindowMatchWindowExpression
(
currentWindowString, target
)
</li>
<li>verifyNotWhetherThisWindowMatchWindowExpression
(
currentWindowString, target
)
</li>
<li>waitForWhetherThisWindowMatchWindowExpression
(
currentWindowString, target
)
</li>
<li>waitForNotWhetherThisWindowMatchWindowExpression
(
currentWindowString, target
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeXpathCount"></a>storeXpathCount
(
xpath,
variableName
)
</strong>
</dt>
<dd>Returns the number of nodes that match the specified xpath, eg. "//table" would give
the number of tables.<p>Arguments:</p>
<ul>
<li>xpath - the xpath expression to evaluate. do NOT wrap this expression in a 'count()' function; we will do that for you.</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>the number of nodes that match the specified xpath</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertXpathCount
(
xpath, <a href="#patterns">pattern</a>
)
</li>
<li>assertNotXpathCount
(
xpath, <a href="#patterns">pattern</a>
)
</li>
<li>verifyXpathCount
(
xpath, <a href="#patterns">pattern</a>
)
</li>
<li>verifyNotXpathCount
(
xpath, <a href="#patterns">pattern</a>
)
</li>
<li>waitForXpathCount
(
xpath, <a href="#patterns">pattern</a>
)
</li>
<li>waitForNotXpathCount
(
xpath, <a href="#patterns">pattern</a>
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeAlertPresent"></a>storeAlertPresent
(
variableName
)
</strong>
</dt>
<dd>Has an alert occurred?
<p>
This function never throws an exception
</p>
<p>
<dl>
<dt>Returns: </dt>
<dd>true if there is an alert</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertAlertPresent
(
)
</li>
<li>assertAlertNotPresent
(
)
</li>
<li>verifyAlertPresent
(
)
</li>
<li>verifyAlertNotPresent
(
)
</li>
<li>waitForAlertPresent
(
)
</li>
<li>waitForAlertNotPresent
(
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeChecked"></a>storeChecked
(
locator,
variableName
)
</strong>
</dt>
<dd>Gets whether a toggle-button (checkbox/radio) is checked. Fails if the specified element doesn't exist or isn't a toggle-button.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a> pointing to a checkbox or radio button</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>true if the checkbox is checked, false otherwise</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertChecked
(
locator
)
</li>
<li>assertNotChecked
(
locator
)
</li>
<li>verifyChecked
(
locator
)
</li>
<li>verifyNotChecked
(
locator
)
</li>
<li>waitForChecked
(
locator
)
</li>
<li>waitForNotChecked
(
locator
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeConfirmationPresent"></a>storeConfirmationPresent
(
variableName
)
</strong>
</dt>
<dd>Has confirm() been called?
<p>
This function never throws an exception
</p>
<p>
<dl>
<dt>Returns: </dt>
<dd>true if there is a pending confirmation</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertConfirmationPresent
(
)
</li>
<li>assertConfirmationNotPresent
(
)
</li>
<li>verifyConfirmationPresent
(
)
</li>
<li>verifyConfirmationNotPresent
(
)
</li>
<li>waitForConfirmationPresent
(
)
</li>
<li>waitForConfirmationNotPresent
(
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeCookiePresent"></a>storeCookiePresent
(
name,
variableName
)
</strong>
</dt>
<dd>Returns true if a cookie with the specified name is present, or false otherwise.<p>Arguments:</p>
<ul>
<li>name - the name of the cookie</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>true if a cookie with the specified name is present, or false otherwise.</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertCookiePresent
(
name
)
</li>
<li>assertCookieNotPresent
(
name
)
</li>
<li>verifyCookiePresent
(
name
)
</li>
<li>verifyCookieNotPresent
(
name
)
</li>
<li>waitForCookiePresent
(
name
)
</li>
<li>waitForCookieNotPresent
(
name
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeEditable"></a>storeEditable
(
locator,
variableName
)
</strong>
</dt>
<dd>Determines whether the specified input element is editable, ie hasn't been disabled.
This method will fail if the specified element isn't an input element.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>true if the input element is editable, false otherwise</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertEditable
(
locator
)
</li>
<li>assertNotEditable
(
locator
)
</li>
<li>verifyEditable
(
locator
)
</li>
<li>verifyNotEditable
(
locator
)
</li>
<li>waitForEditable
(
locator
)
</li>
<li>waitForNotEditable
(
locator
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeElementPresent"></a>storeElementPresent
(
locator,
variableName
)
</strong>
</dt>
<dd>Verifies that the specified element is somewhere on the page.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>true if the element is present, false otherwise</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertElementPresent
(
locator
)
</li>
<li>assertElementNotPresent
(
locator
)
</li>
<li>verifyElementPresent
(
locator
)
</li>
<li>verifyElementNotPresent
(
locator
)
</li>
<li>waitForElementPresent
(
locator
)
</li>
<li>waitForElementNotPresent
(
locator
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeOrdered"></a>storeOrdered
(
locator1,
locator2,
variableName
)
</strong>
</dt>
<dd>Check if these two elements have same parent and are ordered siblings in the DOM. Two same elements will
not be considered ordered.<p>Arguments:</p>
<ul>
<li>locator1 - an <a href="#locators">element locator</a> pointing to the first element</li>
<li>locator2 - an <a href="#locators">element locator</a> pointing to the second element</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>true if element1 is the previous sibling of element2, false otherwise</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertOrdered
(
locator1, locator2
)
</li>
<li>assertNotOrdered
(
locator1, locator2
)
</li>
<li>verifyOrdered
(
locator1, locator2
)
</li>
<li>verifyNotOrdered
(
locator1, locator2
)
</li>
<li>waitForOrdered
(
locator1, locator2
)
</li>
<li>waitForNotOrdered
(
locator1, locator2
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storePromptPresent"></a>storePromptPresent
(
variableName
)
</strong>
</dt>
<dd>Has a prompt occurred?
<p>
This function never throws an exception
</p>
<p>
<dl>
<dt>Returns: </dt>
<dd>true if there is a pending prompt</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertPromptPresent
(
)
</li>
<li>assertPromptNotPresent
(
)
</li>
<li>verifyPromptPresent
(
)
</li>
<li>verifyPromptNotPresent
(
)
</li>
<li>waitForPromptPresent
(
)
</li>
<li>waitForPromptNotPresent
(
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeSomethingSelected"></a>storeSomethingSelected
(
selectLocator,
variableName
)
</strong>
</dt>
<dd>Determines whether some option in a drop-down menu is selected.<p>Arguments:</p>
<ul>
<li>selectLocator - an <a href="#locators">element locator</a> identifying a drop-down menu</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>true if some option has been selected, false otherwise</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertSomethingSelected
(
selectLocator
)
</li>
<li>assertNotSomethingSelected
(
selectLocator
)
</li>
<li>verifySomethingSelected
(
selectLocator
)
</li>
<li>verifyNotSomethingSelected
(
selectLocator
)
</li>
<li>waitForSomethingSelected
(
selectLocator
)
</li>
<li>waitForNotSomethingSelected
(
selectLocator
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeTextPresent"></a>storeTextPresent
(
pattern,
variableName
)
</strong>
</dt>
<dd>Verifies that the specified text pattern appears somewhere on the rendered page shown to the user.<p>Arguments:</p>
<ul>
<li>pattern - a <a href="#patterns">pattern</a> to match with the text of the page</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>true if the pattern matches the text, false otherwise</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertTextPresent
(
pattern
)
</li>
<li>assertTextNotPresent
(
pattern
)
</li>
<li>verifyTextPresent
(
pattern
)
</li>
<li>verifyTextNotPresent
(
pattern
)
</li>
<li>waitForTextPresent
(
pattern
)
</li>
<li>waitForTextNotPresent
(
pattern
)
</li>
</ul>
</dd>
<br>
<dt>
<strong><a name="storeVisible"></a>storeVisible
(
locator,
variableName
)
</strong>
</dt>
<dd>Determines if the specified element is visible. An
element can be rendered invisible by setting the CSS "visibility"
property to "hidden", or the "display" property to "none", either for the
element itself or one if its ancestors. This method will fail if
the element is not present.<p>Arguments:</p>
<ul>
<li>locator - an <a href="#locators">element locator</a>
</li>
<li>variableName -
the name of a <a href="#storedVars">variable</a> in which the result is to be stored.
</li>
</ul>
<p>
<dl>
<dt>Returns: </dt>
<dd>true if the specified element is visible, false otherwise</dd>
</dl>
</p>
<p>Related Assertions, automatically generated:</p>
<ul>
<li>assertVisible
(
locator
)
</li>
<li>assertNotVisible
(
locator
)
</li>
<li>verifyVisible
(
locator
)
</li>
<li>verifyNotVisible
(
locator
)
</li>
<li>waitForVisible
(
locator
)
</li>
<li>waitForNotVisible
(
locator
)
</li>
</ul>
</dd>
<br>
</dl>
<h2>
<a name="parameter-construction-and-variables">Parameter construction and Variables</a>
</h2>
<blockquote>
<p>All Selenium command parameters can be constructed using both simple
variable substitution as well as full javascript. Both of these
mechanisms can access previously stored variables, but do so using
different syntax.</p>
<p>
<a name="storedVars"></a><strong>Stored Variables</strong>
</p>
<p>The commands <em>store</em>, <em>storeValue</em> and <em>storeText</em> can be used to store a variable
value for later access. Internally, these variables are stored in a map called "storedVars",
with values keyed by the variable name. These commands are documented in the command reference.</p>
<p>
<strong>Variable substitution</strong>
</p>
<p>Variable substitution provides a simple way to include a previously stored variable in a
command parameter. This is a simple mechanism, by which the variable to substitute is indicated
by ${variableName}. Multiple variables can be substituted, and intermixed with static text.</p>
<p>Example:</p>
<blockquote>
<table border="1" class="table">
<colgroup>
<col width="18%">
<col width="36%">
<col width="45%">
</colgroup>
<tbody valign="top">
<tr>
<td>store</td><td>Mr</td><td>title</td>
</tr>
<tr>
<td>storeValue</td><td>nameField</td><td>surname</td>
</tr>
<tr>
<td>store</td><td>${title} ${surname}</td><td>fullname</td>
</tr>
<tr>
<td>type</td><td>textElement</td><td>Full name is: ${fullname}</td>
</tr>
</tbody>
</table>
</blockquote>
<p>
<strong>Javascript evaluation</strong>
</p>
<p>Javascript evaluation provides the full power of javascript in constructing a command parameter.
To use this mechanism, the <em>entire</em> parameter value must be prefixed by
'javascript{' with a trailing '}'. The text inside the braces is evaluated as a javascript expression,
and can access previously stored variables using the <em>storedVars</em> map detailed above.
Note that variable substitution cannot be combined with javascript evaluation.</p>
<p>Example:</p>
<blockquote>
<table border="1" class="table">
<colgroup>
<col width="9%">
<col width="44%">
<col width="46%">
</colgroup>
<tbody valign="top">
<tr>
<td>store</td><td>javascript{'merchant' + (new Date()).getTime()}</td><td>merchantId</td>
</tr>
<tr>
<td>type</td><td>textElement</td><td>javascript{storedVars['merchantId'].toUpperCase()}</td>
</tr>
</tbody>
</table>
</blockquote>
</blockquote>
<div class="section" id="whitespace">
<h2>
<a name="whitespace">Whitespace Rules</a>
</h2>
<blockquote>
<p>HTML automatically normalizes whitespace within elements, ignoring leading/trailing spaces and converting extra spaces, tabs and newlines into a single space. When Selenium reads text out of the page, it attempts to duplicate this behavior, so you can ignore all the tabs and newlines in your HTML and do assertions based on how the text looks in the browser when rendered. We do this by replacing all non-visible whitespace (including the non-breaking space "&nbsp;") with a single space. All visible newlines (<br>, <p>, and <pre>formatted newlines) should be preserved.</p>
<p>We use the same normalization logic on the text of HTML Selenese test case tables. This has a number of advantages. First, you don't need to look at the HTML source of the page to figure out what your assertions should be; "&nbsp;" symbols are invisible to the end user, and so you shouldn't have to worry about them when writing Selenese tests. (You don't need to put "&nbsp;" markers in your test case to assertText on a field that contains "&nbsp;".) You may also put extra newlines and spaces in your Selenese <td> tags; since we use the same normalization logic on the test case as we do on the text, we can ensure that assertions and the extracted text will match exactly.</p>
<p>This creates a bit of a problem on those rare occasions when you really want/need to insert extra whitespace in your test case. For example, you may need to type text in a field like this: "foo ". But if you simply write <td>foo </td> in your Selenese test case, we'll replace your extra spaces with just one space.</p>
<p>This problem has a simple workaround. We've defined a variable in Selenese, ${space}, whose value is a single space. You can use ${space} to insert a space that won't be automatically trimmed, like this: <td>foo${space}${space}${space}</td>. We've also included a variable ${nbsp}, that you can use to insert a non-breaking space.</p>
<p>Note that XPaths do <i>not</i> normalize whitespace the way we do. If you need to write an XPath like //div[text()="hello world"] but the HTML of the link is really "hello&nbsp;world", you'll need to insert a real "&nbsp;" into your Selenese test case to get it to match, like this: //div[text()="hello${nbsp}world"].</p>
</blockquote>
</div>
<div class="section" id="extending-selenium">
<h2>
<a name="extending-selenium">Extending Selenium</a>
</h2>
<blockquote>
<p>It can be quite simple to extend Selenium, adding your own actions, assertions and locator-strategies.
This is done with javascript by adding methods to the Selenium object prototype, and the PageBot
object prototype. On startup, Selenium will automatically look through methods on these prototypes,
using name patterns to recognise which ones are actions, assertions and locators.</p>
<p>The following examples try to give an indication of how Selenium can be extended with javascript.</p>
</blockquote>
<p>
<strong>Actions</strong>
</p>
<blockquote>
<p>All <em>doFoo</em> methods on the Selenium prototype are added as actions. For each action <em>foo</em> there
is also an action <em>fooAndWait</em> registered. An action method can take up to 2 parameters, which
will be passed the second and third column values in the test.</p>
<p>Example: Add a "typeRepeated" action to Selenium, which types the text twice into a text box.</p>
<pre class="literal-block">
Selenium.prototype.doTypeRepeated = function(locator, text) {
// All locator-strategies are automatically handled by "findElement"
var element = this.page().findElement(locator);
// Create the text to type
var valueToType = text + text;
// Replace the element text with the new text
this.page().replaceText(element, valueToType);
};
</pre>
</blockquote>
<p>
<strong>Accessors/Assertions</strong>
</p>
<blockquote>
<p>All <em>getFoo</em> and <em>isFoo</em> methods on the Selenium prototype are added as accessors (storeFoo). For each accessor there
is an <em>assertFoo</em>, <em>verifyFoo</em> and <em>waitForFoo</em> registered. An assert method can take up to 2 parameters, which
will be passed the second and third column values in the test. You can also define your own assertions literally
as simple "assert" methods, which will also auto-generate "verify" and "waitFor" commands.</p>
<p>Example: Add a <em>valueRepeated</em> assertion, that makes sure that the element value
consists of the supplied text repeated. The 2 commands that would be available in tests would be
<em>assertValueRepeated</em> and <em>verifyValueRepeated</em>.</p>
<pre class="literal-block">
Selenium.prototype.assertValueRepeated = function(locator, text) {
// All locator-strategies are automatically handled by "findElement"
var element = this.page().findElement(locator);
// Create the text to verify
var expectedValue = text + text;
// Get the actual element value
var actualValue = element.value;
// Make sure the actual value matches the expected
Assert.matches(expectedValue, actualValue);
};
</pre>
</blockquote>
<p>
<strong>Automatic availability of storeFoo, assertFoo, assertNotFoo, waitForFoo and waitForNotFoo for every getFoo</strong>
</p>
<blockquote>
<p>All <em>getFoo</em> and <em>isFoo</em> methods on the Selenium prototype automatically result in the availability
of storeFoo, assertFoo, assertNotFoo, verifyFoo, verifyNotFoo, waitForFoo, and waitForNotFoo commands.</p>
<p>Example, if you add a getTextLength() method, the following commands will automatically be available:
storeTextLength, assertTextLength, assertNotTextLength, verifyTextLength, verifyNotTextLength, waitForTextLength, and waitForNotTextLength commands.</p>
<pre class="literal-block">
Selenium.prototype.getTextLength = function(locator, text) {
return this.getText(locator).length;
};
</pre>
<p>Also note that the <em>assertValueRepeated</em> method described above could have been implemented using
isValueRepeated, with the added benefit of also automatically getting assertNotValueRepeated, storeValueRepeated,
waitForValueRepeated and waitForNotValueRepeated.</p>
</blockquote>
<p>
<strong>Locator Strategies</strong>
</p>
<blockquote>
<p>All <em>locateElementByFoo</em> methods on the PageBot prototype are added as locator-strategies. A locator strategy takes 2 parameters, the first being the locator string (minus the prefix), and the second being the document in which to search.</p>
<p>Example: Add a "valuerepeated=" locator, that finds the first element a value attribute equal to the the supplied value repeated.</p>
<pre class="literal-block">
// The "inDocument" is a the document you are searching.
PageBot.prototype.locateElementByValueRepeated = function(text, inDocument) {
// Create the text to search for
var expectedValue = text + text;
// Loop through all elements, looking for ones that have
// a value === our expected value
var allElements = inDocument.getElementsByTagName("*");
for (var i = 0; i < allElements.length; i++) {
var testElement = allElements[i];
if (testElement.value && testElement.value === expectedValue) {
return testElement;
}
}
return null;
};
</pre>
</blockquote>
<p>
<strong>user-extensions.js</strong>
</p>
<blockquote>
<p>By default, Selenium looks for a file called "user-extensions.js", and loads the javascript code found in that file. This file provides a convenient location for adding features to Selenium, without needing to modify the core Selenium sources.</p>
<p>In the standard distibution, this file does not exist. Users can create this file and place their extension code in this common location, removing the need to modify the Selenium sources, and hopefully assisting with the upgrade process.</p>
</blockquote>
</div>
</body>
</html>
|
