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
|
/* AbstractButton.java -- Provides basic button functionality.
Copyright (C) 2002, 2004 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA.
Linking this library statically or dynamically with other modules is
making a combined work based on this library. Thus, the terms and
conditions of the GNU General Public License cover the whole
combination.
As a special exception, the copyright holders of this library give you
permission to link this library with independent modules to produce an
executable, regardless of the license terms of these independent
modules, and to copy and distribute the resulting executable under
terms of your choice, provided that you also meet, for each linked
independent module, the terms and conditions of the license of that
module. An independent module is a module which is not derived from
or based on this library. If you modify this library, you may extend
this exception to your version of the library, but you are not
obligated to do so. If you do not wish to do so, delete this
exception statement from your version. */
package javax.swing;
import java.awt.Graphics;
import java.awt.Image;
import java.awt.Insets;
import java.awt.ItemSelectable;
import java.awt.Point;
import java.awt.Rectangle;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.awt.image.ImageObserver;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.io.Serializable;
import javax.accessibility.AccessibleAction;
import javax.accessibility.AccessibleIcon;
import javax.accessibility.AccessibleRelationSet;
import javax.accessibility.AccessibleStateSet;
import javax.accessibility.AccessibleText;
import javax.accessibility.AccessibleValue;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import javax.swing.plaf.ButtonUI;
import javax.swing.text.AttributeSet;
/**
* Provides an abstract implementation of common button behaviour,
* data model and look & feel.
*
* <p>This class is supposed to serve as a base class for
* several kinds of buttons with similar but non-identical semantics:
* toggle buttons (radio buttons and checkboxes), simple push buttons,
* menu items, etc.</p>
*
* <p>Buttons have many properties, some of which are stored in this class
* while others are delegated to the button's model. The following properties
* are available:</p>
*
* <table>
* <tr><th>Property </th><th>Stored in</th><th>Bound?</th></tr>
*
* <tr><td>action </td><td>button</td> <td>no</td></tr>
* <tr><td>actionCommand </td><td>model</td> <td>no</td></tr>
* <tr><td>borderPainted </td><td>button</td> <td>yes</td></tr>
* <tr><td>contentAreaFilled </td><td>button</td> <td>yes</td></tr>
* <tr><td>disabledIcon </td><td>button</td> <td>yes</td></tr>
* <tr><td>disabledSelectedIcon </td><td>button</td> <td>yes</td></tr>
* <tr><td>displayedMnemonicIndex </td><td>button</td> <td>no</td></tr>
* <tr><td>enabled </td><td>model</td> <td>no</td></tr>
* <tr><td>focusPainted </td><td>button</td> <td>yes</td></tr>
* <tr><td>horizontalAlignment </td><td>button</td> <td>yes</td></tr>
* <tr><td>horizontalTextPosition </td><td>button</td> <td>yes</td></tr>
* <tr><td>icon </td><td>button</td> <td>yes</td></tr>
* <tr><td>iconTextGap </td><td>button</td> <td>no</td></tr>
* <tr><td>label (same as text) </td><td>model</td> <td>yes</td></tr>
* <tr><td>margin </td><td>button</td> <td>yes</td></tr>
* <tr><td>multiClickThreshold </td><td>button</td> <td>no</td></tr>
* <tr><td>pressedIcon </td><td>button</td> <td>yes</td></tr>
* <tr><td>rolloverEnabled </td><td>button</td> <td>yes</td></tr>
* <tr><td>rolloverIcon </td><td>button</td> <td>yes</td></tr>
* <tr><td>rolloverSelectedIcon </td><td>button</td> <td>yes</td></tr>
* <tr><td>selected </td><td>model</td> <td>no</td></tr>
* <tr><td>selectedIcon </td><td>button</td> <td>yes</td></tr>
* <tr><td>selectedObjects </td><td>button</td> <td>no</td></tr>
* <tr><td>text </td><td>model</td> <td>yes</td></tr>
* <tr><td>UI </td><td>button</td> <td>yes</td></tr>
* <tr><td>verticalAlignment </td><td>button</td> <td>yes</td></tr>
* <tr><td>verticalTextPosition </td><td>button</td> <td>yes</td></tr>
*
* </table>
*
* <p>The various behavioral aspects of these properties follows:</p>
*
* <ul>
*
* <li>When non-bound properties stored in the button change, the button
* fires ChangeEvents to its ChangeListeners.</li>
*
* <li>When bound properties stored in the button change, the button fires
* PropertyChangeEvents to its PropertyChangeListeners</li>
*
* <li>If any of the model's properties change, it fires a ChangeEvent to
* its ChangeListeners, which include the button.</li>
*
* <li>If the button receives a ChangeEvent from its model, it will
* propagate the ChangeEvent to its ChangeListeners, with the ChangeEvent's
* "source" property set to refer to the button, rather than the model. The
* the button will request a repaint, to paint its updated state.</li>
*
* <li>If the model's "selected" property changes, the model will fire an
* ItemEvent to its ItemListeners, which include the button, in addition to
* the ChangeEvent which models the property change. The button propagates
* ItemEvents directly to its ItemListeners.</li>
*
* <li>If the model's armed and pressed properties are simultaneously
* <code>true</code>, the model will fire an ActionEvent to its
* ActionListeners, which include the button. The button will propagate
* this ActionEvent to its ActionListeners, with the ActionEvent's "source"
* property set to refer to the button, rather than the model.</li>
*
* </ul>
*
* @author Ronald Veldema (rveldema@cs.vu.nl)
* @author Graydon Hoare (graydon@redhat.com)
*/
public abstract class AbstractButton extends JComponent
implements ItemSelectable, SwingConstants
{
private static final long serialVersionUID = -937921345538462020L;
/**
* An extension of ChangeListener to be serializable.
*/
protected class ButtonChangeListener
implements ChangeListener, Serializable
{
private static final long serialVersionUID = 1471056094226600578L;
/**
* Notified when the target of the listener changes its state.
*
* @param ev the ChangeEvent describing the change
*/
public void stateChanged(ChangeEvent ev)
{
AbstractButton.this.fireStateChanged();
repaint();
}
}
/** The icon displayed by default. */
Icon default_icon;
/** The icon displayed when the button is pressed. */
Icon pressed_icon;
/** The icon displayed when the button is disabled. */
Icon disabeldIcon;
/** The icon displayed when the button is selected. */
Icon selectedIcon;
/** The icon displayed when the button is selected but disabled. */
Icon disabledSelectedIcon;
/** The icon displayed when the button is rolled over. */
Icon rolloverIcon;
/** The icon displayed when the button is selected and rolled over. */
Icon rolloverSelectedIcon;
/** The icon currently displayed. */
Icon current_icon;
/** The text displayed in the button. */
String text;
/**
* The gap between icon and text, if both icon and text are
* non-<code>null</code>.
*/
int iconTextGap;
/** The vertical alignment of the button's text and icon. */
int verticalAlignment;
/** The horizontal alignment of the button's text and icon. */
int horizontalAlignment;
/** The horizontal position of the button's text relative to its icon. */
int horizontalTextPosition;
/** The vertical position of the button's text relative to its icon. */
int verticalTextPosition;
/** Whether or not the button paints its border. */
boolean borderPainted;
/** Whether or not the button paints its focus state. */
boolean focusPainted;
/** Whether or not the button fills its content area. */
boolean contentAreaFilled;
/** Whether rollover is enabled. */
boolean rollOverEnabled;
/** The action taken when the button is clicked. */
Action action;
/** The button's current state. */
protected ButtonModel model;
/** The margin between the button's border and its label. */
Insets margin;
/**
* A hint to the look and feel class, suggesting which character in the
* button's label should be underlined when drawing the label.
*/
int mnemonicIndex;
/** Listener the button uses to receive ActionEvents from its model. */
protected ActionListener actionListener;
/** Listener the button uses to receive ItemEvents from its model. */
protected ItemListener itemListener;
/** Listener the button uses to receive ChangeEvents from its model. */
protected ChangeListener changeListener;
/**
* The time in miliseconds in which clicks get coalesced into a single
* <code>ActionEvent</code>.
*/
long multiClickThreshhold;
/**
* Listener the button uses to receive PropertyChangeEvents from its
* Action.
*/
PropertyChangeListener actionPropertyChangeListener;
/** ChangeEvent that is fired to button's ChangeEventListeners */
protected ChangeEvent changeEvent = new ChangeEvent(this);
/**
* Fired in a PropertyChangeEvent when the "borderPainted" property changes.
*/
public static final String BORDER_PAINTED_CHANGED_PROPERTY = "borderPainted";
/**
* Fired in a PropertyChangeEvent when the "contentAreaFilled" property
* changes.
*/
public static final String CONTENT_AREA_FILLED_CHANGED_PROPERTY =
"contentAreaFilled";
/**
* Fired in a PropertyChangeEvent when the "disabledIcon" property changes.
*/
public static final String DISABLED_ICON_CHANGED_PROPERTY = "disabledIcon";
/**
* Fired in a PropertyChangeEvent when the "disabledSelectedIcon" property
* changes.
*/
public static final String DISABLED_SELECTED_ICON_CHANGED_PROPERTY =
"disabledSelectedIcon";
/**
* Fired in a PropertyChangeEvent when the "focusPainted" property changes.
*/
public static final String FOCUS_PAINTED_CHANGED_PROPERTY = "focusPainted";
/**
* Fired in a PropertyChangeEvent when the "horizontalAlignment" property
* changes.
*/
public static final String HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY =
"horizontalAlignment";
/**
* Fired in a PropertyChangeEvent when the "horizontalTextPosition" property
* changes.
*/
public static final String HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY =
"horizontalTextPosition";
/**
* Fired in a PropertyChangeEvent when the "icon" property changes. */
public static final String ICON_CHANGED_PROPERTY = "icon";
/** Fired in a PropertyChangeEvent when the "margin" property changes. */
public static final String MARGIN_CHANGED_PROPERTY = "margin";
/** Fired in a PropertyChangeEvent when the "mnemonic" property changes. */
public static final String MNEMONIC_CHANGED_PROPERTY = "mnemonic";
/** Fired in a PropertyChangeEvent when the "model" property changes. */
public static final String MODEL_CHANGED_PROPERTY = "model";
/** Fired in a PropertyChangeEvent when the "pressedIcon" property changes. */
public static final String PRESSED_ICON_CHANGED_PROPERTY = "pressedIcon";
/**
* Fired in a PropertyChangeEvent when the "rolloverEnabled" property
* changes.
*/
public static final String ROLLOVER_ENABLED_CHANGED_PROPERTY =
"rolloverEnabled";
/**
* Fired in a PropertyChangeEvent when the "rolloverIcon" property changes.
*/
public static final String ROLLOVER_ICON_CHANGED_PROPERTY = "rolloverIcon";
/**
* Fired in a PropertyChangeEvent when the "rolloverSelectedIcon" property
* changes.
*/
public static final String ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY =
"rolloverSelectedIcon";
/**
* Fired in a PropertyChangeEvent when the "selectedIcon" property changes.
*/
public static final String SELECTED_ICON_CHANGED_PROPERTY = "selectedIcon";
/** Fired in a PropertyChangeEvent when the "text" property changes. */
public static final String TEXT_CHANGED_PROPERTY = "text";
/**
* Fired in a PropertyChangeEvent when the "verticalAlignment" property
* changes.
*/
public static final String VERTICAL_ALIGNMENT_CHANGED_PROPERTY =
"verticalAlignment";
/**
* Fired in a PropertyChangeEvent when the "verticalTextPosition" property
* changes.
*/
public static final String VERTICAL_TEXT_POSITION_CHANGED_PROPERTY =
"verticalTextPosition";
/**
* A Java Accessibility extension of the AbstractButton.
*/
protected abstract class AccessibleAbstractButton
extends AccessibleJComponent implements AccessibleAction, AccessibleValue,
AccessibleText
{
private static final long serialVersionUID = -5673062525319836790L;
protected AccessibleAbstractButton()
{
// Nothing to do here yet.
}
public AccessibleStateSet getAccessibleStateSet()
{
return null; // TODO
}
public String getAccessibleName()
{
return null; // TODO
}
public AccessibleIcon[] getAccessibleIcon()
{
return null; // TODO
}
public AccessibleRelationSet getAccessibleRelationSet()
{
return null; // TODO
}
public AccessibleAction getAccessibleAction()
{
return null; // TODO
}
public AccessibleValue getAccessibleValue()
{
return null; // TODO
}
public int getAccessibleActionCount()
{
return 0; // TODO
}
public String getAccessibleActionDescription(int value0)
{
return null; // TODO
}
public boolean doAccessibleAction(int value0)
{
return false; // TODO
}
public Number getCurrentAccessibleValue()
{
return null; // TODO
}
public boolean setCurrentAccessibleValue(Number value0)
{
return false; // TODO
}
public Number getMinimumAccessibleValue()
{
return null; // TODO
}
public Number getMaximumAccessibleValue()
{
return null; // TODO
}
public AccessibleText getAccessibleText()
{
return null; // TODO
}
public int getIndexAtPoint(Point value0)
{
return 0; // TODO
}
public Rectangle getCharacterBounds(int value0)
{
return null; // TODO
}
public int getCharCount()
{
return 0; // TODO
}
public int getCaretPosition()
{
return 0; // TODO
}
public String getAtIndex(int value0, int value1)
{
return null; // TODO
}
public String getAfterIndex(int value0, int value1)
{
return null; // TODO
}
public String getBeforeIndex(int value0, int value1)
{
return null; // TODO
}
public AttributeSet getCharacterAttribute(int value0)
{
return null; // TODO
}
public int getSelectionStart()
{
return 0; // TODO
}
public int getSelectionEnd()
{
return 0; // TODO
}
public String getSelectedText()
{
return null; // TODO
}
private Rectangle getTextRectangle()
{
return null; // TODO
}
}
/**
* Creates a new AbstractButton object. Subclasses should call the following
* sequence in their constructor in order to initialize the button correctly:
* <pre>
* super();
* init(text, icon);
* </pre>
*
* The {@link #init(String, Icon)} method is not called automatically by this
* constructor.
*
* @see #init(String, Icon)
*/
public AbstractButton()
{
actionListener = createActionListener();
changeListener = createChangeListener();
itemListener = createItemListener();
horizontalAlignment = CENTER;
horizontalTextPosition = TRAILING;
verticalAlignment = CENTER;
verticalTextPosition = CENTER;
borderPainted = true;
contentAreaFilled = true;
focusPainted = true;
setFocusable(true);
setAlignmentX(CENTER_ALIGNMENT);
setAlignmentY(CENTER_ALIGNMENT);
setDisplayedMnemonicIndex(-1);
setOpaque(true);
text = "";
updateUI();
}
/**
* Get the model the button is currently using.
*
* @return The current model
*/
public ButtonModel getModel()
{
return model;
}
/**
* Set the model the button is currently using. This un-registers all
* listeners associated with the current model, and re-registers them
* with the new model.
*
* @param newModel The new model
*/
public void setModel(ButtonModel newModel)
{
if (newModel == model)
return;
if (model != null)
{
model.removeActionListener(actionListener);
model.removeChangeListener(changeListener);
model.removeItemListener(itemListener);
}
ButtonModel old = model;
model = newModel;
if (model != null)
{
model.addActionListener(actionListener);
model.addChangeListener(changeListener);
model.addItemListener(itemListener);
}
firePropertyChange(MODEL_CHANGED_PROPERTY, old, model);
revalidate();
repaint();
}
protected void init(String text, Icon icon)
{
// If text is null, we fall back to the empty
// string (which is set using AbstractButton's
// constructor).
// This way the behavior of the JDK is matched.
if(text != null)
this.text = text;
if (icon != null)
default_icon = icon;
}
/**
* <p>Returns the action command string for this button's model.</p>
*
* <p>If the action command was set to <code>null</code>, the button's
* text (label) is returned instead.</p>
*
* @return The current action command string from the button's model
*/
public String getActionCommand()
{
String ac = model.getActionCommand();
if (ac != null)
return ac;
else
return text;
}
/**
* Sets the action command string for this button's model.
*
* @param actionCommand The new action command string to set in the button's
* model.
*/
public void setActionCommand(String actionCommand)
{
if (model != null)
model.setActionCommand(actionCommand);
}
/**
* Adds an ActionListener to the button's listener list. When the
* button's model is clicked it fires an ActionEvent, and these
* listeners will be called.
*
* @param l The new listener to add
*/
public void addActionListener(ActionListener l)
{
listenerList.add(ActionListener.class, l);
}
/**
* Removes an ActionListener from the button's listener list.
*
* @param l The listener to remove
*/
public void removeActionListener(ActionListener l)
{
listenerList.remove(ActionListener.class, l);
}
/**
* Returns all added <code>ActionListener</code> objects.
*
* @return an array of listeners
*
* @since 1.4
*/
public ActionListener[] getActionListeners()
{
return (ActionListener[]) listenerList.getListeners(ActionListener.class);
}
/**
* Adds an ItemListener to the button's listener list. When the button's
* model changes state (between any of ARMED, ENABLED, PRESSED, ROLLOVER
* or SELECTED) it fires an ItemEvent, and these listeners will be
* called.
*
* @param l The new listener to add
*/
public void addItemListener(ItemListener l)
{
listenerList.add(ItemListener.class, l);
}
/**
* Removes an ItemListener from the button's listener list.
*
* @param l The listener to remove
*/
public void removeItemListener(ItemListener l)
{
listenerList.remove(ItemListener.class, l);
}
/**
* Returns all added <code>ItemListener</code> objects.
*
* @return an array of listeners
*
* @since 1.4
*/
public ItemListener[] getItemListeners()
{
return (ItemListener[]) listenerList.getListeners(ItemListener.class);
}
/**
* Adds a ChangeListener to the button's listener list. When the button's
* model changes any of its (non-bound) properties, these listeners will be
* called.
*
* @param l The new listener to add
*/
public void addChangeListener(ChangeListener l)
{
listenerList.add(ChangeListener.class, l);
}
/**
* Removes a ChangeListener from the button's listener list.
*
* @param l The listener to remove
*/
public void removeChangeListener(ChangeListener l)
{
listenerList.remove(ChangeListener.class, l);
}
/**
* Returns all added <code>ChangeListener</code> objects.
*
* @return an array of listeners
*
* @since 1.4
*/
public ChangeListener[] getChangeListeners()
{
return (ChangeListener[]) listenerList.getListeners(ChangeListener.class);
}
/**
* Calls {@link ItemListener#itemStateChanged} on each ItemListener in
* the button's listener list.
*
* @param e The event signifying that the button's model changed state
*/
protected void fireItemStateChanged(ItemEvent e)
{
e.setSource(this);
ItemListener[] listeners = getItemListeners();
for (int i = 0; i < listeners.length; i++)
listeners[i].itemStateChanged(e);
}
/**
* Calls {@link ActionListener#actionPerformed} on each {@link
* ActionListener} in the button's listener list.
*
* @param e The event signifying that the button's model was clicked
*/
protected void fireActionPerformed(ActionEvent e)
{
// Dispatch a copy of the given ActionEvent in order to
// set the source and action command correctly.
ActionEvent ae = new ActionEvent(
this,
e.getID(),
getActionCommand(),
e.getWhen(),
e.getModifiers());
ActionListener[] listeners = getActionListeners();
for (int i = 0; i < listeners.length; i++)
listeners[i].actionPerformed(ae);
}
/**
* Calls {@link ChangeListener#stateChanged} on each {@link ChangeListener}
* in the button's listener list.
*/
protected void fireStateChanged()
{
ChangeListener[] listeners = getChangeListeners();
for (int i = 0; i < listeners.length; i++)
listeners[i].stateChanged(changeEvent);
}
/**
* Get the current keyboard mnemonic value. This value corresponds to a
* single key code (one of the {@link java.awt.event.KeyEvent} VK_*
* codes) and is used to activate the button when pressed in conjunction
* with the "mouseless modifier" of the button's look and feel class, and
* when focus is in one of the button's ancestors.
*
* @return The button's current keyboard mnemonic
*/
public int getMnemonic()
{
ButtonModel mod = getModel();
if (mod != null)
return mod.getMnemonic();
return -1;
}
/**
* Set the current keyboard mnemonic value. This value corresponds to a
* single key code (one of the {@link java.awt.event.KeyEvent} VK_*
* codes) and is used to activate the button when pressed in conjunction
* with the "mouseless modifier" of the button's look and feel class, and
* when focus is in one of the button's ancestors.
*
* @param mne A new mnemonic to use for the button
*/
public void setMnemonic(char mne)
{
setMnemonic((int) mne);
}
/**
* Set the current keyboard mnemonic value. This value corresponds to a
* single key code (one of the {@link java.awt.event.KeyEvent} VK_*
* codes) and is used to activate the button when pressed in conjunction
* with the "mouseless modifier" of the button's look and feel class, and
* when focus is in one of the button's ancestors.
*
* @param mne A new mnemonic to use for the button
*/
public void setMnemonic(int mne)
{
ButtonModel mod = getModel();
int old = -1;
if (mod != null)
old = mod.getMnemonic();
if (old != mne)
{
if (mod != null)
mod.setMnemonic(mne);
if (text != null && !text.equals(""))
{
// Since lower case char = upper case char for
// mnemonic, we will convert both text and mnemonic
// to upper case before checking if mnemonic character occurs
// in the menu item text.
int upperCaseMne = Character.toUpperCase((char) mne);
String upperCaseText = text.toUpperCase();
setDisplayedMnemonicIndex(upperCaseText.indexOf(upperCaseMne));
}
firePropertyChange(MNEMONIC_CHANGED_PROPERTY, old, mne);
revalidate();
repaint();
}
}
/**
* Sets the button's mnemonic index. The mnemonic index is a hint to the
* look and feel class, suggesting which character in the button's label
* should be underlined when drawing the label. If the mnemonic index is
* -1, no mnemonic will be displayed.
*
* If no mnemonic index is set, the button will choose a mnemonic index
* by default, which will be the first occurrence of the mnemonic
* character in the button's text.
*
* @param index An offset into the "text" property of the button
* @throws IllegalArgumentException If <code>index</code> is not within the
* range of legal offsets for the "text" property of the button.
* @since 1.4
*/
public void setDisplayedMnemonicIndex(int index)
{
if (index < -1 || (text != null && index >= text.length()))
throw new IllegalArgumentException();
mnemonicIndex = index;
}
/**
* Get the button's mnemonic index, which is an offset into the button's
* "text" property. The character specified by this offset should be
* underlined when the look and feel class draws this button.
*
* @return An index into the button's "text" property
*/
public int getDisplayedMnemonicIndex()
{
return mnemonicIndex;
}
/**
* Set the "rolloverEnabled" property. When rollover is enabled, and the
* look and feel supports it, the button will change its icon to
* rolloverIcon, when the mouse passes over it.
*
* @param r Whether or not to enable rollover icon changes
*/
public void setRolloverEnabled(boolean r)
{
if (rollOverEnabled != r)
{
rollOverEnabled = r;
firePropertyChange(ROLLOVER_ENABLED_CHANGED_PROPERTY, !r, r);
revalidate();
repaint();
}
}
/**
* Returns whether or not rollover icon changes are enabled on the
* button.
*
* @return The state of the "rolloverEnabled" property
*/
public boolean isRolloverEnabled()
{
return rollOverEnabled;
}
/**
* Set the value of the button's "selected" property. Selection is only
* meaningful for toggle-type buttons (check boxes, radio buttons).
*
* @param s New value for the property
*/
public void setSelected(boolean s)
{
ButtonModel mod = getModel();
if (mod != null)
mod.setSelected(s);
}
/**
* Get the value of the button's "selected" property. Selection is only
* meaningful for toggle-type buttons (check boxes, radio buttons).
*
* @return The value of the property
*/
public boolean isSelected()
{
ButtonModel mod = getModel();
if (mod != null)
return mod.isSelected();
return false;
}
/**
* Enables or disables the button. A button will neither be selectable
* nor preform any actions unless it is enabled.
*
* @param b Whether or not to enable the button
*/
public void setEnabled(boolean b)
{
// Do nothing if state does not change.
if (b == isEnabled())
return;
super.setEnabled(b);
ButtonModel mod = getModel();
if (mod != null)
mod.setEnabled(b);
}
/**
* Set the horizontal alignment of the button's text and icon. The
* alignment is a numeric constant from {@link SwingConstants}. It must
* be one of: <code>RIGHT</code>, <code>LEFT</code>, <code>CENTER</code>,
* <code>LEADING</code> or <code>TRAILING</code>. The default is
* <code>RIGHT</code>.
*
* @return The current horizontal alignment
*/
public int getHorizontalAlignment()
{
return horizontalAlignment;
}
/**
* Set the horizontal alignment of the button's text and icon. The
* alignment is a numeric constant from {@link SwingConstants}. It must
* be one of: <code>RIGHT</code>, <code>LEFT</code>, <code>CENTER</code>,
* <code>LEADING</code> or <code>TRAILING</code>. The default is
* <code>RIGHT</code>.
*
* @param a The new horizontal alignment
* @throws IllegalArgumentException If alignment is not one of the legal
* constants.
*/
public void setHorizontalAlignment(int a)
{
if (horizontalAlignment == a)
return;
int old = horizontalAlignment;
horizontalAlignment = a;
firePropertyChange(HORIZONTAL_ALIGNMENT_CHANGED_PROPERTY, old, a);
revalidate();
repaint();
}
/**
* Get the horizontal position of the button's text relative to its
* icon. The position is a numeric constant from {@link
* SwingConstants}. It must be one of: <code>RIGHT</code>,
* <code>LEFT</code>, <code>CENTER</code>, <code>LEADING</code> or
* <code>TRAILING</code>. The default is <code>TRAILING</code>.
*
* @return The current horizontal text position
*/
public int getHorizontalTextPosition()
{
return horizontalTextPosition;
}
/**
* Set the horizontal position of the button's text relative to its
* icon. The position is a numeric constant from {@link
* SwingConstants}. It must be one of: <code>RIGHT</code>,
* <code>LEFT</code>, <code>CENTER</code>, <code>LEADING</code> or
* <code>TRAILING</code>. The default is <code>TRAILING</code>.
*
* @param t The new horizontal text position
* @throws IllegalArgumentException If position is not one of the legal
* constants.
*/
public void setHorizontalTextPosition(int t)
{
if (horizontalTextPosition == t)
return;
int old = horizontalTextPosition;
horizontalTextPosition = t;
firePropertyChange(HORIZONTAL_TEXT_POSITION_CHANGED_PROPERTY, old, t);
revalidate();
repaint();
}
/**
* Get the vertical alignment of the button's text and icon. The
* alignment is a numeric constant from {@link SwingConstants}. It must
* be one of: <code>CENTER</code>, <code>TOP</code>, or
* <code>BOTTOM</code>. The default is <code>CENTER</code>.
*
* @return The current vertical alignment
*/
public int getVerticalAlignment()
{
return verticalAlignment;
}
/**
* Set the vertical alignment of the button's text and icon. The
* alignment is a numeric constant from {@link SwingConstants}. It must
* be one of: <code>CENTER</code>, <code>TOP</code>, or
* <code>BOTTOM</code>. The default is <code>CENTER</code>.
*
* @param a The new vertical alignment
* @throws IllegalArgumentException If alignment is not one of the legal
* constants.
*/
public void setVerticalAlignment(int a)
{
if (verticalAlignment == a)
return;
int old = verticalAlignment;
verticalAlignment = a;
firePropertyChange(VERTICAL_ALIGNMENT_CHANGED_PROPERTY, old, a);
revalidate();
repaint();
}
/**
* Get the vertical position of the button's text relative to its
* icon. The alignment is a numeric constant from {@link
* SwingConstants}. It must be one of: <code>CENTER</code>,
* <code>TOP</code>, or <code>BOTTOM</code>. The default is
* <code>CENTER</code>.
*
* @return The current vertical position
*/
public int getVerticalTextPosition()
{
return verticalTextPosition;
}
/**
* Set the vertical position of the button's text relative to its
* icon. The alignment is a numeric constant from {@link
* SwingConstants}. It must be one of: <code>CENTER</code>,
* <code>TOP</code>, or <code>BOTTOM</code>. The default is
* <code>CENTER</code>.
*
* @param t The new vertical position
* @throws IllegalArgumentException If position is not one of the legal
* constants.
*/
public void setVerticalTextPosition(int t)
{
if (verticalTextPosition == t)
return;
int old = verticalTextPosition;
verticalTextPosition = t;
firePropertyChange(VERTICAL_TEXT_POSITION_CHANGED_PROPERTY, old, t);
revalidate();
repaint();
}
/**
* Set the value of the "borderPainted" property. If set to
* <code>false</code>, the button's look and feel class should not paint
* a border for the button. The default is <code>true</code>.
*
* @return The current value of the property.
*/
public boolean isBorderPainted()
{
return borderPainted;
}
/**
* Set the value of the "borderPainted" property. If set to
* <code>false</code>, the button's look and feel class should not paint
* a border for the button. The default is <code>true</code>.
*
* @param b The new value of the property.
*/
public void setBorderPainted(boolean b)
{
if (borderPainted == b)
return;
boolean old = borderPainted;
borderPainted = b;
firePropertyChange(BORDER_PAINTED_CHANGED_PROPERTY, old, b);
revalidate();
repaint();
}
/**
* Get the value of the "action" property.
*
* @return The current value of the "action" property
*/
public Action getAction()
{
return action;
}
/**
* <p>Set the button's "action" property, subscribing the new action to the
* button, as an ActionListener, if it is not already subscribed. The old
* Action, if it exists, is unsubscribed, and the button is unsubscribed
* from the old Action if it was previously subscribed as a
* PropertyChangeListener.</p>
*
* <p>This method also configures several of the button's properties from
* the Action, by calling {@link #configurePropertiesFromAction}, and
* subscribes the button to the Action as a PropertyChangeListener.
* Subsequent changes to the Action will thus reconfigure the button
* automatically.</p>
*
* @param a The new value of the "action" property
*/
public void setAction(Action a)
{
if (action != null)
{
action.removePropertyChangeListener(actionPropertyChangeListener);
removeActionListener(action);
if (actionPropertyChangeListener != null)
{
action.removePropertyChangeListener(actionPropertyChangeListener);
actionPropertyChangeListener = null;
}
}
Action old = action;
action = a;
configurePropertiesFromAction(action);
if (action != null)
{
actionPropertyChangeListener = createActionPropertyChangeListener(a);
action.addPropertyChangeListener(actionPropertyChangeListener);
addActionListener(action);
}
}
/**
* Return the button's default "icon" property.
*
* @return The current default icon
*/
public Icon getIcon()
{
return default_icon;
}
/**
* Set the button's default "icon" property. This icon is used as a basis
* for the pressed and disabled icons, if none are explicitly set.
*
* @param i The new default icon
*/
public void setIcon(Icon i)
{
if (default_icon == i)
return;
Icon old = default_icon;
default_icon = i;
firePropertyChange(ICON_CHANGED_PROPERTY, old, i);
revalidate();
repaint();
}
/**
* Return the button's "text" property. This property is synonymous with
* the "label" property.
*
* @return The current "text" property
*/
public String getText()
{
return text;
}
/**
* Set the button's "label" property. This property is synonymous with the
* "text" property.
*
* @param label The new "label" property
*
* @deprecated use <code>setText(text)</code>
*/
public void setLabel(String label)
{
setText(label);
}
/**
* Return the button's "label" property. This property is synonymous with
* the "text" property.
*
* @return The current "label" property
*
* @deprecated use <code>getText()</code>
*/
public String getLabel()
{
return getText();
}
/**
* Set the button's "text" property. This property is synonymous with the
* "label" property.
*
* @param t The new "text" property
*/
public void setText(String t)
{
if (text == t)
return;
String old = text;
text = t;
firePropertyChange(TEXT_CHANGED_PROPERTY, old, t);
revalidate();
repaint();
}
/**
* Set the value of the {@link #iconTextGap} property.
*
* @param i The new value of the property
*/
public void setIconTextGap(int i)
{
if (iconTextGap == i)
return;
int old = iconTextGap;
iconTextGap = i;
fireStateChanged();
revalidate();
repaint();
}
/**
* Get the value of the {@link #iconTextGap} property.
*
* @return The current value of the property
*/
public int getIconTextGap()
{
return iconTextGap;
}
/**
* Return the button's "margin" property, which is an {@link Insets} object
* describing the distance between the button's border and its text and
* icon.
*
* @return The current "margin" property
*/
public Insets getMargin()
{
return margin;
}
/**
* Set the button's "margin" property, which is an {@link Insets} object
* describing the distance between the button's border and its text and
* icon.
*
* @param m The new "margin" property
*/
public void setMargin(Insets m)
{
if (margin == m)
return;
Insets old = margin;
margin = m;
firePropertyChange(MARGIN_CHANGED_PROPERTY, old, m);
revalidate();
repaint();
}
/**
* Return the button's "pressedIcon" property. The look and feel class
* should paint this icon when the "pressed" property of the button's
* {@link ButtonModel} is <code>true</code>. This property may be
* <code>null</code>, in which case the default icon is used.
*
* @return The current "pressedIcon" property
*/
public Icon getPressedIcon()
{
return pressed_icon;
}
/**
* Set the button's "pressedIcon" property. The look and feel class
* should paint this icon when the "pressed" property of the button's
* {@link ButtonModel} is <code>true</code>. This property may be
* <code>null</code>, in which case the default icon is used.
*
* @param pressedIcon The new "pressedIcon" property
*/
public void setPressedIcon(Icon pressedIcon)
{
if (pressed_icon == pressedIcon)
return;
Icon old = pressed_icon;
pressed_icon = pressedIcon;
firePropertyChange(PRESSED_ICON_CHANGED_PROPERTY, old, pressed_icon);
revalidate();
repaint();
}
/**
* Return the button's "disabledIcon" property. The look and feel class
* should paint this icon when the "enabled" property of the button's
* {@link ButtonModel} is <code>false</code>. This property may be
* <code>null</code>, in which case an icon is constructed, based on the
* default icon.
*
* @return The current "disabledIcon" property
*/
public Icon getDisabledIcon()
{
if (disabeldIcon == null && default_icon instanceof ImageIcon)
{
Image iconImage = ((ImageIcon) default_icon).getImage();
Image grayImage = GrayFilter.createDisabledImage(iconImage);
disabeldIcon = new ImageIcon(grayImage);
}
return disabeldIcon;
}
/**
* Set the button's "disabledIcon" property. The look and feel class should
* paint this icon when the "enabled" property of the button's {@link
* ButtonModel} is <code>false</code>. This property may be
* <code>null</code>, in which case an icon is constructed, based on the
* default icon.
*
* @param d The new "disabledIcon" property
*/
public void setDisabledIcon(Icon d)
{
disabeldIcon = d;
revalidate();
repaint();
}
/**
* Return the button's "paintFocus" property. This property controls
* whether or not the look and feel class will paint a special indicator
* of focus state for the button. If it is false, the button still paints
* when focused, but no special decoration is painted to indicate the
* presence of focus.
*
* @return The current "paintFocus" property
*/
public boolean isFocusPainted()
{
return focusPainted;
}
/**
* Set the button's "paintFocus" property. This property controls whether
* or not the look and feel class will paint a special indicator of focus
* state for the button. If it is false, the button still paints when
* focused, but no special decoration is painted to indicate the presence
* of focus.
*
* @param p The new "paintFocus" property
*/
public void setFocusPainted(boolean p)
{
if (focusPainted == p)
return;
boolean old = focusPainted;
focusPainted = p;
firePropertyChange(FOCUS_PAINTED_CHANGED_PROPERTY, old, p);
revalidate();
repaint();
}
/**
* Verifies that a particular key is one of the valid constants used for
* describing horizontal alignment and positioning. The valid constants
* are the following members of {@link SwingConstants}:
* <code>RIGHT</code>, <code>LEFT</code>, <code>CENTER</code>,
* <code>LEADING</code> or <code>TRAILING</code>.
*
* @param key The key to check
* @param exception A message to include in an IllegalArgumentException
*
* @return the value of key
*
* @throws IllegalArgumentException If key is not one of the valid constants
*
* @see #setHorizontalTextPosition(int)
* @see #setHorizontalAlignment(int)
*/
protected int checkHorizontalKey(int key, String exception)
{
switch (key)
{
case SwingConstants.RIGHT:
case SwingConstants.LEFT:
case SwingConstants.CENTER:
case SwingConstants.LEADING:
case SwingConstants.TRAILING:
break;
default:
throw new IllegalArgumentException(exception);
}
return key;
}
/**
* Verifies that a particular key is one of the valid constants used for
* describing vertical alignment and positioning. The valid constants are
* the following members of {@link SwingConstants}: <code>TOP</code>,
* <code>BOTTOM</code> or <code>CENTER</code>.
*
* @param key The key to check
* @param exception A message to include in an IllegalArgumentException
*
* @return the value of key
*
* @throws IllegalArgumentException If key is not one of the valid constants
*
* @see #setVerticalTextPosition(int)
* @see #setVerticalAlignment(int)
*/
protected int checkVerticalKey(int key, String exception)
{
switch (key)
{
case SwingConstants.TOP:
case SwingConstants.BOTTOM:
case SwingConstants.CENTER:
break;
default:
throw new IllegalArgumentException(exception);
}
return key;
}
/**
* Configure various properties of the button by reading properties
* of an {@link Action}. The mapping of properties is as follows:
*
* <table>
*
* <tr><th>Action keyed property</th> <th>AbstractButton property</th></tr>
*
* <tr><td>NAME </td> <td>text </td></tr>
* <tr><td>SMALL_ICON </td> <td>icon </td></tr>
* <tr><td>SHORT_DESCRIPTION </td> <td>toolTipText </td></tr>
* <tr><td>MNEMONIC_KEY </td> <td>mnemonic </td></tr>
* <tr><td>ACTION_COMMAND_KEY </td> <td>actionCommand </td></tr>
*
* </table>
*
* <p>In addition, this method always sets the button's "enabled" property to
* the value of the Action's "enabled" property.</p>
*
* <p>If the provided Action is <code>null</code>, the text, icon, and
* toolTipText properties of the button are set to <code>null</code>, and
* the "enabled" property is set to <code>true</code>; the mnemonic and
* actionCommand properties are unchanged.</p>
*
* @param a An Action to configure the button from
*/
protected void configurePropertiesFromAction(Action a)
{
if (a == null)
{
setText(null);
setIcon(null);
setEnabled(true);
setToolTipText(null);
}
else
{
setText((String) (a.getValue(Action.NAME)));
setIcon((Icon) (a.getValue(Action.SMALL_ICON)));
setEnabled(a.isEnabled());
setToolTipText((String) (a.getValue(Action.SHORT_DESCRIPTION)));
if (a.getValue(Action.MNEMONIC_KEY) != null)
setMnemonic(((Integer) (a.getValue(Action.MNEMONIC_KEY))).intValue());
String actionCommand = (String) (a.getValue(Action.ACTION_COMMAND_KEY));
// Set actionCommand to button's text by default if it is not specified
if (actionCommand != null)
setActionCommand((String) (a.getValue(Action.ACTION_COMMAND_KEY)));
else
setActionCommand(getText());
}
}
/**
* <p>A factory method which should return an {@link ActionListener} that
* propagates events from the button's {@link ButtonModel} to any of the
* button's ActionListeners. By default, this is an inner class which
* calls {@link AbstractButton#fireActionPerformed} with a modified copy
* of the incoming model {@link ActionEvent}.</p>
*
* <p>The button calls this method during construction, stores the
* resulting ActionListener in its <code>actionListener</code> member
* field, and subscribes it to the button's model. If the button's model
* is changed, this listener is unsubscribed from the old model and
* subscribed to the new one.</p>
*
* @return A new ActionListener
*/
protected ActionListener createActionListener()
{
return new ActionListener()
{
public void actionPerformed(ActionEvent e)
{
AbstractButton.this.fireActionPerformed(e);
}
};
}
/**
* <p>A factory method which should return a {@link PropertyChangeListener}
* that accepts changes to the specified {@link Action} and reconfigure
* the {@link AbstractButton}, by default using the {@link
* #configurePropertiesFromAction} method.</p>
*
* <p>The button calls this method whenever a new Action is assigned to
* the button's "action" property, via {@link #setAction}, and stores the
* resulting PropertyChangeListener in its
* <code>actionPropertyChangeListener</code> member field. The button
* then subscribes the listener to the button's new action. If the
* button's action is changed subsequently, the listener is unsubscribed
* from the old action and subscribed to the new one.</p>
*
* @param a The Action which will be listened to, and which should be
* the same as the source of any PropertyChangeEvents received by the
* new listener returned from this method.
*
* @return A new PropertyChangeListener
*/
protected PropertyChangeListener createActionPropertyChangeListener(Action a)
{
return new PropertyChangeListener()
{
public void propertyChange(PropertyChangeEvent e)
{
Action act = (Action) (e.getSource());
if (e.getPropertyName().equals("enabled"))
setEnabled(act.isEnabled());
else if (e.getPropertyName().equals(Action.NAME))
setText((String) (act.getValue(Action.NAME)));
else if (e.getPropertyName().equals(Action.SMALL_ICON))
setIcon((Icon) (act.getValue(Action.SMALL_ICON)));
else if (e.getPropertyName().equals(Action.SHORT_DESCRIPTION))
setToolTipText((String) (act.getValue(Action.SHORT_DESCRIPTION)));
else if (e.getPropertyName().equals(Action.MNEMONIC_KEY))
if (act.getValue(Action.MNEMONIC_KEY) != null)
setMnemonic(((Integer) (act.getValue(Action.MNEMONIC_KEY)))
.intValue());
else if (e.getPropertyName().equals(Action.ACTION_COMMAND_KEY))
setActionCommand((String) (act.getValue(Action.ACTION_COMMAND_KEY)));
}
};
}
/**
* <p>Factory method which creates a {@link ChangeListener}, used to
* subscribe to ChangeEvents from the button's model. Subclasses of
* AbstractButton may wish to override the listener used to subscribe to
* such ChangeEvents. By default, the listener just propagates the
* {@link ChangeEvent} to the button's ChangeListeners, via the {@link
* AbstractButton#fireStateChanged} method.</p>
*
* <p>The button calls this method during construction, stores the
* resulting ChangeListener in its <code>changeListener</code> member
* field, and subscribes it to the button's model. If the button's model
* is changed, this listener is unsubscribed from the old model and
* subscribed to the new one.</p>
*
* @return The new ChangeListener
*/
protected ChangeListener createChangeListener()
{
return new ButtonChangeListener();
}
/**
* <p>Factory method which creates a {@link ItemListener}, used to
* subscribe to ItemEvents from the button's model. Subclasses of
* AbstractButton may wish to override the listener used to subscribe to
* such ItemEvents. By default, the listener just propagates the
* {@link ItemEvent} to the button's ItemListeners, via the {@link
* AbstractButton#fireItemStateChanged} method.</p>
*
* <p>The button calls this method during construction, stores the
* resulting ItemListener in its <code>changeListener</code> member
* field, and subscribes it to the button's model. If the button's model
* is changed, this listener is unsubscribed from the old model and
* subscribed to the new one.</p>
*
* <p>Note that ItemEvents are only generated from the button's model
* when the model's <em>selected</em> property changes. If you want to
* subscribe to other properties of the model, you must subscribe to
* ChangeEvents.
*
* @return The new ItemListener
*/
protected ItemListener createItemListener()
{
return new ItemListener()
{
public void itemStateChanged(ItemEvent e)
{
AbstractButton.this.fireItemStateChanged(e);
}
};
}
/**
* Programmatically perform a "click" on the button: arming, pressing,
* waiting, un-pressing, and disarming the model.
*/
public void doClick()
{
doClick(100);
}
/**
* Programmatically perform a "click" on the button: arming, pressing,
* waiting, un-pressing, and disarming the model.
*
* @param pressTime The number of milliseconds to wait in the pressed state
*/
public void doClick(int pressTime)
{
ButtonModel mod = getModel();
if (mod != null)
{
mod.setArmed(true);
mod.setPressed(true);
try
{
java.lang.Thread.sleep(pressTime);
}
catch (java.lang.InterruptedException e)
{
// probably harmless
}
mod.setPressed(false);
mod.setArmed(false);
}
}
/**
* Return the button's disabled selected icon. The look and feel class
* should paint this icon when the "enabled" property of the button's model
* is <code>false</code> and its "selected" property is
* <code>true</code>. This icon can be <code>null</code>, in which case
* it is synthesized from the button's selected icon.
*
* @return The current disabled selected icon
*/
public Icon getDisabledSelectedIcon()
{
return disabledSelectedIcon;
}
/**
* Set the button's disabled selected icon. The look and feel class
* should paint this icon when the "enabled" property of the button's model
* is <code>false</code> and its "selected" property is
* <code>true</code>. This icon can be <code>null</code>, in which case
* it is synthesized from the button's selected icon.
*
* @param icon The new disabled selected icon
*/
public void setDisabledSelectedIcon(Icon icon)
{
if (disabledSelectedIcon == icon)
return;
Icon old = disabledSelectedIcon;
disabledSelectedIcon = icon;
firePropertyChange(DISABLED_SELECTED_ICON_CHANGED_PROPERTY, old, icon);
revalidate();
repaint();
}
/**
* Return the button's rollover icon. The look and feel class should
* paint this icon when the "rolloverEnabled" property of the button is
* <code>true</code> and the mouse rolls over the button.
*
* @return The current rollover icon
*/
public Icon getRolloverIcon()
{
return rolloverIcon;
}
/**
* Set the button's rollover icon. The look and feel class should
* paint this icon when the "rolloverEnabled" property of the button is
* <code>true</code> and the mouse rolls over the button.
*
* @param r The new rollover icon
*/
public void setRolloverIcon(Icon r)
{
if (rolloverIcon == r)
return;
Icon old = rolloverIcon;
rolloverIcon = r;
firePropertyChange(ROLLOVER_ICON_CHANGED_PROPERTY, old, rolloverIcon);
revalidate();
repaint();
}
/**
* Return the button's rollover selected icon. The look and feel class
* should paint this icon when the "rolloverEnabled" property of the button
* is <code>true</code>, the "selected" property of the button's model is
* <code>true</code>, and the mouse rolls over the button.
*
* @return The current rollover selected icon
*/
public Icon getRolloverSelectedIcon()
{
return rolloverSelectedIcon;
}
/**
* Set the button's rollover selected icon. The look and feel class
* should paint this icon when the "rolloverEnabled" property of the button
* is <code>true</code>, the "selected" property of the button's model is
* <code>true</code>, and the mouse rolls over the button.
*
* @param r The new rollover selected icon
*/
public void setRolloverSelectedIcon(Icon r)
{
if (rolloverSelectedIcon == r)
return;
Icon old = rolloverSelectedIcon;
rolloverSelectedIcon = r;
firePropertyChange(ROLLOVER_SELECTED_ICON_CHANGED_PROPERTY, old, r);
revalidate();
repaint();
}
/**
* Return the button's selected icon. The look and feel class should
* paint this icon when the "selected" property of the button's model is
* <code>true</code>, and either the "rolloverEnabled" property of the
* button is <code>false</code> or the mouse is not currently rolled
* over the button.
*
* @return The current selected icon
*/
public Icon getSelectedIcon()
{
return selectedIcon;
}
/**
* Set the button's selected icon. The look and feel class should
* paint this icon when the "selected" property of the button's model is
* <code>true</code>, and either the "rolloverEnabled" property of the
* button is <code>false</code> or the mouse is not currently rolled
* over the button.
*
* @param s The new selected icon
*/
public void setSelectedIcon(Icon s)
{
if (selectedIcon == s)
return;
Icon old = selectedIcon;
selectedIcon = s;
firePropertyChange(SELECTED_ICON_CHANGED_PROPERTY, old, s);
revalidate();
repaint();
}
/**
* Returns an single-element array containing the "text" property of the
* button if the "selected" property of the button's model is
* <code>true</code>, otherwise returns <code>null</code>.
*
* @return The button's "selected object" array
*/
public Object[] getSelectedObjects()
{
if (isSelected())
{
Object[] objs = new Object[1];
objs[0] = getText();
return objs;
}
else
{
return null;
}
}
/**
* Called when image data becomes available for one of the button's icons.
*
* @param img The image being updated
* @param infoflags One of the constant codes in {@link ImageObserver} used
* to describe updated portions of an image.
* @param x X coordinate of the region being updated
* @param y Y coordinate of the region being updated
* @param w Width of the region beign updated
* @param h Height of the region being updated
*
* @return <code>true</code> if img is equal to the button's current icon,
* otherwise <code>false</code>
*/
public boolean imageUpdate(Image img, int infoflags, int x, int y, int w,
int h)
{
return current_icon == img;
}
/**
* Returns the value of the button's "contentAreaFilled" property. This
* property indicates whether the area surrounding the text and icon of
* the button should be filled by the look and feel class. If this
* property is <code>false</code>, the look and feel class should leave
* the content area transparent.
*
* @return The current value of the "contentAreaFilled" property
*/
public boolean isContentAreaFilled()
{
return contentAreaFilled;
}
/**
* Sets the value of the button's "contentAreaFilled" property. This
* property indicates whether the area surrounding the text and icon of
* the button should be filled by the look and feel class. If this
* property is <code>false</code>, the look and feel class should leave
* the content area transparent.
*
* @param b The new value of the "contentAreaFilled" property
*/
public void setContentAreaFilled(boolean b)
{
if (contentAreaFilled == b)
return;
boolean old = contentAreaFilled;
contentAreaFilled = b;
firePropertyChange(CONTENT_AREA_FILLED_CHANGED_PROPERTY, old, b);
// The JDK sets the opaque property to the value of the contentAreaFilled
// property, so should we do.
setOpaque(b);
}
/**
* Paints the button's border, if the button's "borderPainted" property is
* <code>true</code>, by out calling to the button's look and feel class.
*
* @param g The graphics context used to paint the border
*/
protected void paintBorder(Graphics g)
{
if (isBorderPainted())
super.paintBorder(g);
}
/**
* Returns a string, used only for debugging, which identifies or somehow
* represents this button. The exact value is implementation-defined.
*
* @return A string representation of the button
*/
protected String paramString()
{
StringBuffer sb = new StringBuffer();
sb.append(super.paramString());
sb.append(",defaultIcon=");
if (getIcon() != null)
sb.append(getIcon());
sb.append(",disabledIcon=");
if (getDisabledIcon() != null)
sb.append(getDisabledIcon());
sb.append(",disabledSelectedIcon=");
if (getDisabledSelectedIcon() != null)
sb.append(getDisabledSelectedIcon());
sb.append(",margin=");
if (getMargin() != null)
sb.append(getMargin());
sb.append(",paintBorder=").append(isBorderPainted());
sb.append(",paintFocus=").append(isFocusPainted());
sb.append(",pressedIcon=");
if (getPressedIcon() != null)
sb.append(getPressedIcon());
sb.append(",rolloverEnabled=").append(isRolloverEnabled());
sb.append(",rolloverIcon=");
if (getRolloverIcon() != null)
sb.append(getRolloverIcon());
sb.append(",rolloverSelected=");
if (getRolloverSelectedIcon() != null)
sb.append(getRolloverSelectedIcon());
sb.append(",selectedIcon=");
if (getSelectedIcon() != null)
sb.append(getSelectedIcon());
sb.append(",text=");
if (getText() != null)
sb.append(getText());
return sb.toString();
}
/**
* Set the "UI" property of the button, which is a look and feel class
* responsible for handling the button's input events and painting it.
*
* @param ui The new "UI" property
*/
public void setUI(ButtonUI ui)
{
super.setUI(ui);
}
/**
* Set the "UI" property of the button, which is a look and feel class
* responsible for handling the button's input events and painting it.
*
* @return The current "UI" property
*/
public ButtonUI getUI()
{
return (ButtonUI) ui;
}
/**
* Set the "UI" property to a class constructed, via the {@link
* UIManager}, from the current look and feel. This should be overridden
* for each subclass of AbstractButton, to retrieve a suitable {@link
* ButtonUI} look and feel class.
*/
public void updateUI()
{
// TODO: What to do here?
}
/**
* Returns the current time in milliseconds in which clicks gets coalesced
* into a single <code>ActionEvent</code>.
*
* @return the time in milliseconds
*
* @since 1.4
*/
public long getMultiClickThreshhold()
{
return multiClickThreshhold;
}
/**
* Sets the time in milliseconds in which clicks gets coalesced into a single
* <code>ActionEvent</code>.
*
* @param threshhold the time in milliseconds
*
* @since 1.4
*/
public void setMultiClickThreshhold(long threshhold)
{
if (threshhold < 0)
throw new IllegalArgumentException();
multiClickThreshhold = threshhold;
}
}
|