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
|
/* JComboBox.java --
Copyright (C) 2002, 2004, 2005, 2006, 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.ItemSelectable;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.awt.event.KeyEvent;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.util.Vector;
import javax.accessibility.Accessible;
import javax.accessibility.AccessibleAction;
import javax.accessibility.AccessibleContext;
import javax.accessibility.AccessibleRole;
import javax.accessibility.AccessibleSelection;
import javax.swing.event.ListDataEvent;
import javax.swing.event.ListDataListener;
import javax.swing.event.PopupMenuEvent;
import javax.swing.event.PopupMenuListener;
import javax.swing.plaf.ComboBoxUI;
import javax.swing.plaf.ComponentUI;
import javax.swing.plaf.basic.ComboPopup;
/**
* A component that allows a user to select any item in its list and
* displays the selected item to the user. JComboBox also can show/hide a
* popup menu containing its list of item whenever the mouse is pressed
* over it.
*
* @author Andrew Selkirk
* @author Olga Rodimina
* @author Robert Schuster
*/
public class JComboBox extends JComponent implements ItemSelectable,
ListDataListener,
ActionListener,
Accessible
{
private static final long serialVersionUID = 5654585963292734470L;
/**
* Classes implementing this interface are
* responsible for matching key characters typed by the user with combo
* box's items.
*/
public static interface KeySelectionManager
{
int selectionForKey(char aKey, ComboBoxModel aModel);
}
/**
* Maximum number of rows that should be visible by default in the
* JComboBox's popup
*/
private static final int DEFAULT_MAXIMUM_ROW_COUNT = 8;
/**
* Data model used by JComboBox to keep track of its list data and currently
* selected element in the list.
*/
protected ComboBoxModel dataModel;
/**
* Renderer renders(paints) every object in the combo box list in its
* associated list cell. This ListCellRenderer is used only when this
* JComboBox is uneditable.
*/
protected ListCellRenderer renderer;
/**
* Editor that is responsible for editing an object in a combo box list.
*/
protected ComboBoxEditor editor;
/**
* Number of rows that will be visible in the JComboBox's popup.
*/
protected int maximumRowCount;
/**
* This field indicates if textfield of this JComboBox is editable or not.
*/
protected boolean isEditable;
/**
* This field is reference to the current selection of the combo box.
*/
protected Object selectedItemReminder;
/**
* keySelectionManager
*/
protected KeySelectionManager keySelectionManager;
/**
* This actionCommand is used in ActionEvent that is fired to JComboBox's
* ActionListeneres.
*/
protected String actionCommand;
/**
* This property indicates if heavyweight popup or lightweight popup will be
* used to diplay JComboBox's elements.
*/
protected boolean lightWeightPopupEnabled;
/**
* The action taken when new item is selected in the JComboBox
*/
private Action action;
/**
* since 1.4 If this field is set then comboBox's display area for the
* selected item will be set by default to this value.
*/
private Object prototypeDisplayValue;
/**
* Constructs JComboBox object with specified data model for it.
* <p>Note that the JComboBox will not change the value that
* is preselected by your ComboBoxModel implementation.</p>
*
* @param model Data model that will be used by this JComboBox to keep track
* of its list of items.
*/
public JComboBox(ComboBoxModel model)
{
setEditable(false);
setEnabled(true);
setMaximumRowCount(DEFAULT_MAXIMUM_ROW_COUNT);
setModel(model);
setActionCommand("comboBoxChanged");
lightWeightPopupEnabled = true;
isEditable = false;
updateUI();
}
/**
* Constructs JComboBox with specified list of items.
*
* @param itemArray array containing list of items for this JComboBox
*/
public JComboBox(Object[] itemArray)
{
this(new DefaultComboBoxModel(itemArray));
if (itemArray.length > 0)
setSelectedIndex(0);
}
/**
* Constructs JComboBox object with specified list of items.
*
* @param itemVector vector containing list of items for this JComboBox.
*/
public JComboBox(Vector itemVector)
{
this(new DefaultComboBoxModel(itemVector));
if (itemVector.size() > 0)
setSelectedIndex(0);
}
/**
* Constructor. Creates new empty JComboBox. ComboBox's data model is set to
* DefaultComboBoxModel.
*/
public JComboBox()
{
this(new DefaultComboBoxModel());
}
/**
* This method returns true JComboBox is editable and false otherwise
*
* @return boolean true if JComboBox is editable and false otherwise
*/
public boolean isEditable()
{
return isEditable;
}
/*
* This method adds ancestor listener to this JComboBox.
*/
protected void installAncestorListener()
{
/* FIXME: Need to implement.
*
* Need to add ancestor listener to this JComboBox. This listener
* should close combo box's popup list of items whenever it
* receives an AncestorEvent.
*/
}
/**
* Set the "UI" property of the combo box, which is a look and feel class
* responsible for handling comboBox's input events and painting it.
*
* @param ui The new "UI" property
*/
public void setUI(ComboBoxUI ui)
{
super.setUI(ui);
}
/**
* This method sets this comboBox's UI to the UIManager's default for the
* current look and feel.
*/
public void updateUI()
{
setUI((ComboBoxUI) UIManager.getUI(this));
}
/**
* This method returns the String identifier for the UI class to the used
* with the JComboBox.
*
* @return The String identifier for the UI class.
*/
public String getUIClassID()
{
return "ComboBoxUI";
}
/**
* This method returns the UI used to display the JComboBox.
*
* @return The UI used to display the JComboBox.
*/
public ComboBoxUI getUI()
{
return (ComboBoxUI) ui;
}
/**
* Set the data model for this JComboBox. This un-registers all listeners
* associated with the current model, and re-registers them with the new
* model.
*
* @param newDataModel The new data model for this JComboBox
*/
public void setModel(ComboBoxModel newDataModel)
{
// dataModel is null if it this method is called from inside the constructors.
if (dataModel != null)
{
// Prevents unneccessary updates.
if (dataModel == newDataModel)
return;
// Removes itself (as DataListener) from the to-be-replaced model.
dataModel.removeListDataListener(this);
}
/* Adds itself as a DataListener to the new model.
* It is intentioned that this operation will fail with a NullPointerException if the
* caller delivered a null argument.
*/
newDataModel.addListDataListener(this);
// Stores old data model for event notification.
ComboBoxModel oldDataModel = dataModel;
dataModel = newDataModel;
selectedItemReminder = newDataModel.getSelectedItem();
// Notifies the listeners of the model change.
firePropertyChange("model", oldDataModel, dataModel);
}
/**
* This method returns data model for this comboBox.
*
* @return ComboBoxModel containing items for this combo box.
*/
public ComboBoxModel getModel()
{
return dataModel;
}
/**
* This method sets JComboBox's popup to be either lightweight or
* heavyweight. If 'enabled' is true then lightweight popup is used and
* heavyweight otherwise. By default lightweight popup is used to display
* this JComboBox's elements.
*
* @param enabled indicates if lightweight popup or heavyweight popup should
* be used to display JComboBox's elements.
*/
public void setLightWeightPopupEnabled(boolean enabled)
{
lightWeightPopupEnabled = enabled;
}
/**
* This method returns whether popup menu that is used to display list of
* combo box's item is lightWeight or not.
*
* @return boolean true if popup menu is lightweight and false otherwise.
*/
public boolean isLightWeightPopupEnabled()
{
return lightWeightPopupEnabled;
}
/**
* This method sets editability of the combo box. If combo box is editable
* the user can choose component from the combo box list by typing
* component's name in the editor(JTextfield by default). Otherwise if not
* editable, the user should use the list to choose the component. This
* method fires PropertyChangeEvents to JComboBox's registered
* PropertyChangeListeners to indicate that 'editable' property of the
* JComboBox has changed.
*
* @param editable indicates if the JComboBox's textfield should be editable
* or not.
*/
public void setEditable(boolean editable)
{
if (isEditable != editable)
{
isEditable = editable;
firePropertyChange("editable", !isEditable, isEditable);
}
}
/**
* Sets number of rows that should be visible in this JComboBox's popup. If
* this JComboBox's popup has more elements that maximum number or rows
* then popup will have a scroll pane to allow users to view other
* elements.
*
* @param rowCount number of rows that will be visible in JComboBox's popup.
*/
public void setMaximumRowCount(int rowCount)
{
if (maximumRowCount != rowCount)
{
int oldMaximumRowCount = maximumRowCount;
maximumRowCount = rowCount;
firePropertyChange("maximumRowCount", oldMaximumRowCount,
maximumRowCount);
}
}
/**
* This method returns number of rows visible in the JComboBox's list of
* items.
*
* @return int maximun number of visible rows in the JComboBox's list.
*/
public int getMaximumRowCount()
{
return maximumRowCount;
}
/**
* This method sets cell renderer for this JComboBox that will be used to
* paint combo box's items. The Renderer should only be used only when
* JComboBox is not editable. In the case when JComboBox is editable the
* editor must be used. This method also fires PropertyChangeEvent when
* cellRendered for this JComboBox has changed.
*
* @param aRenderer cell renderer that will be used by this JComboBox to
* paint its elements.
*/
public void setRenderer(ListCellRenderer aRenderer)
{
if (renderer != aRenderer)
{
ListCellRenderer oldRenderer = renderer;
renderer = aRenderer;
firePropertyChange("renderer", oldRenderer, renderer);
}
}
/**
* This method returns renderer responsible for rendering selected item in
* the combo box
*
* @return ListCellRenderer
*/
public ListCellRenderer getRenderer()
{
return renderer;
}
/**
* Sets editor for this JComboBox
*
* @param newEditor ComboBoxEditor for this JComboBox. This method fires
* PropertyChangeEvent when 'editor' property is changed.
*/
public void setEditor(ComboBoxEditor newEditor)
{
if (editor == newEditor)
return;
if (editor != null)
editor.removeActionListener(this);
ComboBoxEditor oldEditor = editor;
editor = newEditor;
if (editor != null)
editor.addActionListener(this);
firePropertyChange("editor", oldEditor, editor);
}
/**
* Returns editor component that is responsible for displaying/editing
* selected item in the combo box.
*
* @return ComboBoxEditor
*/
public ComboBoxEditor getEditor()
{
return editor;
}
/**
* Forces combo box to select given item
*
* @param item element in the combo box to select.
*/
public void setSelectedItem(Object item)
{
dataModel.setSelectedItem(item);
fireActionEvent();
}
/**
* Returns currently selected item in the combo box.
* The result may be <code>null</code> to indicate that nothing is
* currently selected.
*
* @return element that is currently selected in this combo box.
*/
public Object getSelectedItem()
{
return dataModel.getSelectedItem();
}
/**
* Forces JComboBox to select component located in the given index in the
* combo box.
* <p>If the index is below -1 or exceeds the upper bound an
* <code>IllegalArgumentException</code> is thrown.<p/>
* <p>If the index is -1 then no item gets selected.</p>
*
* @param index index specifying location of the component that should be
* selected.
*/
public void setSelectedIndex(int index)
{
if (index < -1 || index >= dataModel.getSize())
// Fails because index is out of bounds.
throw new IllegalArgumentException("illegal index: " + index);
else
// Selects the item at the given index or clears the selection if the
// index value is -1.
setSelectedItem((index == -1) ? null : dataModel.getElementAt(index));
}
/**
* Returns index of the item that is currently selected in the combo box. If
* no item is currently selected, then -1 is returned.
* <p>
* Note: For performance reasons you should minimize invocation of this
* method. If the data model is not an instance of
* <code>DefaultComboBoxModel</code> the complexity is O(n) where n is the
* number of elements in the combo box.
* </p>
*
* @return int Index specifying location of the currently selected item in the
* combo box or -1 if nothing is selected in the combo box.
*/
public int getSelectedIndex()
{
Object selectedItem = getSelectedItem();
if (selectedItem != null)
{
if (dataModel instanceof DefaultComboBoxModel)
// Uses special method of DefaultComboBoxModel to retrieve the index.
return ((DefaultComboBoxModel) dataModel).getIndexOf(selectedItem);
else
{
// Iterates over all items to retrieve the index.
int size = dataModel.getSize();
for (int i = 0; i < size; i++)
{
Object o = dataModel.getElementAt(i);
// XXX: Is special handling of ComparableS neccessary?
if ((selectedItem != null) ? selectedItem.equals(o) : o == null)
return i;
}
}
}
// returns that no item is currently selected
return -1;
}
/**
* Returns an object that is used as the display value when calculating the
* preferred size for the combo box. This value is, of course, never
* displayed anywhere.
*
* @return The prototype display value (possibly <code>null</code>).
*
* @since 1.4
* @see #setPrototypeDisplayValue(Object)
*/
public Object getPrototypeDisplayValue()
{
return prototypeDisplayValue;
}
/**
* Sets the object that is assumed to be the displayed item when calculating
* the preferred size for the combo box. A {@link PropertyChangeEvent} (with
* the name <code>prototypeDisplayValue</code>) is sent to all registered
* listeners.
*
* @param value the new value (<code>null</code> permitted).
*
* @since 1.4
* @see #getPrototypeDisplayValue()
*/
public void setPrototypeDisplayValue(Object value)
{
Object oldValue = prototypeDisplayValue;
prototypeDisplayValue = value;
firePropertyChange("prototypeDisplayValue", oldValue, value);
}
/**
* This method adds given element to this JComboBox.
* <p>A <code>RuntimeException</code> is thrown if the data model is not
* an instance of {@link MutableComboBoxModel}.</p>
*
* @param element element to add
*/
public void addItem(Object element)
{
if (dataModel instanceof MutableComboBoxModel)
((MutableComboBoxModel) dataModel).addElement(element);
else
throw new RuntimeException("Unable to add the item because the data "
+ "model it is not an instance of "
+ "MutableComboBoxModel.");
}
/**
* Inserts given element at the specified index to this JComboBox.
* <p>A <code>RuntimeException</code> is thrown if the data model is not
* an instance of {@link MutableComboBoxModel}.</p>
*
* @param element element to insert
* @param index position where to insert the element
*/
public void insertItemAt(Object element, int index)
{
if (dataModel instanceof MutableComboBoxModel)
((MutableComboBoxModel) dataModel).insertElementAt(element, index);
else
throw new RuntimeException("Unable to insert the item because the data "
+ "model it is not an instance of "
+ "MutableComboBoxModel.");
}
/**
* This method removes given element from this JComboBox.
* <p>A <code>RuntimeException</code> is thrown if the data model is not
* an instance of {@link MutableComboBoxModel}.</p>
*
* @param element element to remove
*/
public void removeItem(Object element)
{
if (dataModel instanceof MutableComboBoxModel)
((MutableComboBoxModel) dataModel).removeElement(element);
else
throw new RuntimeException("Unable to remove the item because the data "
+ "model it is not an instance of "
+ "MutableComboBoxModel.");
}
/**
* This method remove element location in the specified index in the
* JComboBox.
* <p>A <code>RuntimeException</code> is thrown if the data model is not
* an instance of {@link MutableComboBoxModel}.</p>
*
* @param index index specifying position of the element to remove
*/
public void removeItemAt(int index)
{
if (dataModel instanceof MutableComboBoxModel)
((MutableComboBoxModel) dataModel).removeElementAt(index);
else
throw new RuntimeException("Unable to remove the item because the data "
+ "model it is not an instance of "
+ "MutableComboBoxModel.");
}
/**
* This method removes all elements from this JComboBox.
* <p>
* A <code>RuntimeException</code> is thrown if the data model is not an
* instance of {@link MutableComboBoxModel}.
* </p>
*/
public void removeAllItems()
{
if (dataModel instanceof DefaultComboBoxModel)
// Uses special method if we have a DefaultComboBoxModel.
((DefaultComboBoxModel) dataModel).removeAllElements();
else if (dataModel instanceof MutableComboBoxModel)
{
// Iterates over all items and removes each.
MutableComboBoxModel mcbm = (MutableComboBoxModel) dataModel;
// We intentionally remove the items backwards to support models which
// shift their content to the beginning (e.g. linked lists)
for (int i = mcbm.getSize() - 1; i >= 0; i--)
mcbm.removeElementAt(i);
}
else
throw new RuntimeException("Unable to remove the items because the data "
+ "model it is not an instance of "
+ "MutableComboBoxModel.");
}
/**
* This method displays popup with list of combo box's items on the screen
*/
public void showPopup()
{
setPopupVisible(true);
}
/**
* This method hides popup containing list of combo box's items
*/
public void hidePopup()
{
setPopupVisible(false);
}
/**
* This method either displayes or hides the popup containing list of combo
* box's items.
*
* @param visible show popup if 'visible' is true and hide it otherwise
*/
public void setPopupVisible(boolean visible)
{
getUI().setPopupVisible(this, visible);
}
/**
* Checks if popup is currently visible on the screen.
*
* @return boolean true if popup is visible and false otherwise
*/
public boolean isPopupVisible()
{
return getUI().isPopupVisible(this);
}
/**
* This method sets actionCommand to the specified string. ActionEvent fired
* to this JComboBox registered ActionListeners will contain this
* actionCommand.
*
* @param aCommand new action command for the JComboBox's ActionEvent
*/
public void setActionCommand(String aCommand)
{
actionCommand = aCommand;
}
/**
* Returns actionCommand associated with the ActionEvent fired by the
* JComboBox to its registered ActionListeners.
*
* @return String actionCommand for the ActionEvent
*/
public String getActionCommand()
{
return actionCommand;
}
/**
* setAction
*
* @param a action to set
*/
public void setAction(Action a)
{
Action old = action;
action = a;
configurePropertiesFromAction(action);
if (action != null)
// FIXME: remove from old action and add to new action
// PropertyChangeListener to listen to changes in the action
addActionListener(action);
}
/**
* This method returns Action that is invoked when selected item is changed
* in the JComboBox.
*
* @return Action
*/
public Action getAction()
{
return action;
}
/**
* Configure properties of the JComboBox by reading properties of specified
* action. This method always sets the comboBox's "enabled" property to the
* value of the Action's "enabled" property.
*
* @param a An Action to configure the combo box from
*/
protected void configurePropertiesFromAction(Action a)
{
if (a == null)
{
setEnabled(true);
setToolTipText(null);
}
else
{
setEnabled(a.isEnabled());
setToolTipText((String) (a.getValue(Action.SHORT_DESCRIPTION)));
}
}
/**
* Creates PropertyChangeListener to listen for the changes in comboBox's
* action properties.
*
* @param action action to listen to for property changes
*
* @return a PropertyChangeListener that listens to changes in
* action properties.
*/
protected PropertyChangeListener createActionPropertyChangeListener(Action action)
{
return new PropertyChangeListener()
{
public void propertyChange(PropertyChangeEvent e)
{
Action act = (Action) (e.getSource());
configurePropertiesFromAction(act);
}
};
}
/**
* This method fires ItemEvent to this JComboBox's registered ItemListeners.
* This method is invoked when currently selected item in this combo box
* has changed.
*
* @param e the ItemEvent describing the change in the combo box's
* selection.
*/
protected void fireItemStateChanged(ItemEvent e)
{
ItemListener[] ll = getItemListeners();
for (int i = 0; i < ll.length; i++)
ll[i].itemStateChanged(e);
}
/**
* This method fires ActionEvent to this JComboBox's registered
* ActionListeners. This method is invoked when user explicitly changes
* currently selected item.
*/
protected void fireActionEvent()
{
ActionListener[] ll = getActionListeners();
for (int i = 0; i < ll.length; i++)
ll[i].actionPerformed(new ActionEvent(this,
ActionEvent.ACTION_PERFORMED,
actionCommand));
}
/**
* Fires a popupMenuCanceled() event to all <code>PopupMenuListeners</code>.
*
* Note: This method is intended for use by plaf classes only.
*/
public void firePopupMenuCanceled()
{
PopupMenuListener[] listeners = getPopupMenuListeners();
PopupMenuEvent e = new PopupMenuEvent(this);
for (int i = 0; i < listeners.length; i++)
listeners[i].popupMenuCanceled(e);
}
/**
* Fires a popupMenuWillBecomeInvisible() event to all
* <code>PopupMenuListeners</code>.
*
* Note: This method is intended for use by plaf classes only.
*/
public void firePopupMenuWillBecomeInvisible()
{
PopupMenuListener[] listeners = getPopupMenuListeners();
PopupMenuEvent e = new PopupMenuEvent(this);
for (int i = 0; i < listeners.length; i++)
listeners[i].popupMenuWillBecomeInvisible(e);
}
/**
* Fires a popupMenuWillBecomeVisible() event to all
* <code>PopupMenuListeners</code>.
*
* Note: This method is intended for use by plaf classes only.
*/
public void firePopupMenuWillBecomeVisible()
{
PopupMenuListener[] listeners = getPopupMenuListeners();
PopupMenuEvent e = new PopupMenuEvent(this);
for (int i = 0; i < listeners.length; i++)
listeners[i].popupMenuWillBecomeVisible(e);
}
/**
* This method is invoked whenever selected item changes in the combo box's
* data model. It fires ItemEvent and ActionEvent to all registered
* ComboBox's ItemListeners and ActionListeners respectively, indicating
* the change.
*/
protected void selectedItemChanged()
{
// Fire ItemEvent to indicated that previously selected item is now
// deselected
if (selectedItemReminder != null)
fireItemStateChanged(new ItemEvent(this, ItemEvent.ITEM_STATE_CHANGED,
selectedItemReminder,
ItemEvent.DESELECTED));
// Fire ItemEvent to indicate that new item is selected
Object newSelection = getSelectedItem();
if (newSelection != null)
fireItemStateChanged(new ItemEvent(this, ItemEvent.ITEM_STATE_CHANGED,
newSelection, ItemEvent.SELECTED));
// Fire Action Event to JComboBox's registered listeners
fireActionEvent();
selectedItemReminder = newSelection;
}
/**
* Returns Object array of size 1 containing currently selected element in
* the JComboBox.
*
* @return Object[] Object array of size 1 containing currently selected
* element in the JComboBox.
*/
public Object[] getSelectedObjects()
{
return new Object[] { getSelectedItem() };
}
/**
* This method handles actionEvents fired by the ComboBoxEditor. It changes
* this JComboBox's selection to the new value currently in the editor and
* hides list of combo box items.
*
* @param e the ActionEvent
*/
public void actionPerformed(ActionEvent e)
{
setSelectedItem(getEditor().getItem());
setPopupVisible(false);
}
/**
* This method selects item in this combo box that matches specified
* specified keyChar and returns true if such item is found. Otherwise
* false is returned.
*
* @param keyChar character indicating which item in the combo box should be
* selected.
*
* @return boolean true if item corresponding to the specified keyChar
* exists in the combo box. Otherwise false is returned.
*/
public boolean selectWithKeyChar(char keyChar)
{
if (keySelectionManager == null)
{
keySelectionManager = createDefaultKeySelectionManager();
}
int index = keySelectionManager.selectionForKey(keyChar, getModel());
boolean retVal = false;
if (index >= 0)
{
setSelectedIndex(index);
retVal = true;
}
return retVal;
}
/**
* The part of implementation of ListDataListener interface. This method is
* invoked when some items where added to the JComboBox's data model.
*
* @param event ListDataEvent describing the change
*/
public void intervalAdded(ListDataEvent event)
{
// FIXME: Need to implement
repaint();
}
/**
* The part of implementation of ListDataListener interface. This method is
* invoked when some items where removed from the JComboBox's data model.
*
* @param event ListDataEvent describing the change.
*/
public void intervalRemoved(ListDataEvent event)
{
// FIXME: Need to implement
repaint();
}
/**
* The part of implementation of ListDataListener interface. This method is
* invoked when contents of the JComboBox's data model changed.
*
* @param event ListDataEvent describing the change
*/
public void contentsChanged(ListDataEvent event)
{
// if first and last index of the given ListDataEvent are both -1,
// then it indicates that selected item in the combo box data model
// have changed.
if (event.getIndex0() == -1 && event.getIndex1() == -1)
selectedItemChanged();
}
/**
* This method disables or enables JComboBox. If the JComboBox is enabled,
* then user is able to make item choice, otherwise if JComboBox is
* disabled then user is not able to make a selection.
*
* @param enabled if 'enabled' is true then enable JComboBox and disable it
*/
public void setEnabled(boolean enabled)
{
boolean oldEnabled = super.isEnabled();
if (enabled != oldEnabled)
{
super.setEnabled(enabled);
firePropertyChange("enabled", oldEnabled, enabled);
}
}
/**
* This method initializes specified ComboBoxEditor to display given item.
*
* @param anEditor ComboBoxEditor to initialize
* @param anItem Item that should displayed in the specified editor
*/
public void configureEditor(ComboBoxEditor anEditor, Object anItem)
{
anEditor.setItem(anItem);
}
/**
* This method is fired whenever a key is pressed with the combo box
* in focus
*
* @param e The KeyEvent indicating which key was pressed.
*/
public void processKeyEvent(KeyEvent e)
{
if (e.getKeyCode() == KeyEvent.VK_TAB)
setPopupVisible(false);
else
super.processKeyEvent(e);
}
/**
* setKeySelectionManager
*
* @param aManager
*/
public void setKeySelectionManager(KeySelectionManager aManager)
{
keySelectionManager = aManager;
}
/**
* getKeySelectionManager
*
* @return JComboBox.KeySelectionManager
*/
public KeySelectionManager getKeySelectionManager()
{
return keySelectionManager;
}
/**
* This method returns number of elements in this JComboBox
*
* @return int number of elements in this JComboBox
*/
public int getItemCount()
{
return dataModel.getSize();
}
/**
* Returns elements located in the combo box at the given index.
*
* @param index index specifying location of the component to return.
*
* @return component in the combo box that is located in the given index.
*/
public Object getItemAt(int index)
{
return dataModel.getElementAt(index);
}
/**
* createDefaultKeySelectionManager
*
* @return KeySelectionManager
*/
protected KeySelectionManager createDefaultKeySelectionManager()
{
return new DefaultKeySelectionManager();
}
/**
* Returns an implementation-dependent string describing the attributes of
* this <code>JComboBox</code>.
*
* @return A string describing the attributes of this <code>JComboBox</code>
* (never <code>null</code>).
*/
protected String paramString()
{
String superParamStr = super.paramString();
StringBuffer sb = new StringBuffer();
sb.append(",isEditable=").append(isEditable());
sb.append(",lightWeightPopupEnabled=").append(isLightWeightPopupEnabled());
sb.append(",maximumRowCount=").append(getMaximumRowCount());
sb.append(",selectedItemReminder=");
if (selectedItemReminder != null)
sb.append(selectedItemReminder);
return superParamStr + sb.toString();
}
/**
* Returns the object that provides accessibility features for this
* <code>JComboBox</code> component.
*
* @return The accessible context (an instance of
* {@link AccessibleJComboBox}).
*/
public AccessibleContext getAccessibleContext()
{
if (accessibleContext == null)
accessibleContext = new AccessibleJComboBox();
return accessibleContext;
}
/**
* This methods adds specified ActionListener to this JComboBox.
*
* @param listener to add
*/
public void addActionListener(ActionListener listener)
{
listenerList.add(ActionListener.class, listener);
}
/**
* This method removes specified ActionListener from this JComboBox.
*
* @param listener ActionListener
*/
public void removeActionListener(ActionListener listener)
{
listenerList.remove(ActionListener.class, listener);
}
/**
* This method returns array of ActionListeners that are registered with
* this JComboBox.
*
* @since 1.4
*/
public ActionListener[] getActionListeners()
{
return (ActionListener[]) getListeners(ActionListener.class);
}
/**
* This method registers given ItemListener with this JComboBox
*
* @param listener to remove
*/
public void addItemListener(ItemListener listener)
{
listenerList.add(ItemListener.class, listener);
}
/**
* This method unregisters given ItemListener from this JComboBox
*
* @param listener to remove
*/
public void removeItemListener(ItemListener listener)
{
listenerList.remove(ItemListener.class, listener);
}
/**
* This method returns array of ItemListeners that are registered with this
* JComboBox.
*
* @since 1.4
*/
public ItemListener[] getItemListeners()
{
return (ItemListener[]) getListeners(ItemListener.class);
}
/**
* Adds PopupMenuListener to combo box to listen to the events fired by the
* combo box's popup menu containing its list of items
*
* @param listener to add
*/
public void addPopupMenuListener(PopupMenuListener listener)
{
listenerList.add(PopupMenuListener.class, listener);
}
/**
* Removes PopupMenuListener to combo box to listen to the events fired by
* the combo box's popup menu containing its list of items
*
* @param listener to add
*/
public void removePopupMenuListener(PopupMenuListener listener)
{
listenerList.remove(PopupMenuListener.class, listener);
}
/**
* Returns array of PopupMenuListeners that are registered with combo box.
*/
public PopupMenuListener[] getPopupMenuListeners()
{
return (PopupMenuListener[]) getListeners(PopupMenuListener.class);
}
/**
* Accessibility support for <code>JComboBox</code>.
*/
protected class AccessibleJComboBox extends AccessibleJComponent
implements AccessibleAction, AccessibleSelection
{
private static final long serialVersionUID = 8217828307256675666L;
/**
* @specnote This constructor was protected in 1.4, but made public
* in 1.5.
*/
public AccessibleJComboBox()
{
// Nothing to do here.
}
/**
* Returns the number of accessible children of this object. The
* implementation of AccessibleJComboBox delegates this call to the UI
* of the associated JComboBox.
*
* @return the number of accessible children of this object
*
* @see ComponentUI#getAccessibleChildrenCount(JComponent)
*/
public int getAccessibleChildrenCount()
{
ComponentUI ui = getUI();
int count;
if (ui != null)
count = ui.getAccessibleChildrenCount(JComboBox.this);
else
count = super.getAccessibleChildrenCount();
return count;
}
/**
* Returns the number of accessible children of this object. The
* implementation of AccessibleJComboBox delegates this call to the UI
* of the associated JComboBox.
*
* @param index the index of the accessible child to fetch
*
* @return the number of accessible children of this object
*
* @see ComponentUI#getAccessibleChild(JComponent, int)
*/
public Accessible getAccessibleChild(int index)
{
ComponentUI ui = getUI();
Accessible child = null;
if (ui != null)
child = ui.getAccessibleChild(JComboBox.this, index);
else
child = super.getAccessibleChild(index);
return child;
}
/**
* Returns the AccessibleSelection object associated with this object.
* AccessibleJComboBoxes handle their selection themselves, so this
* always returns <code>this</code>.
*
* @return the AccessibleSelection object associated with this object
*/
public AccessibleSelection getAccessibleSelection()
{
return this;
}
/**
* Returns the accessible selection from this AccssibleJComboBox.
*
* @param index the index of the selected child to fetch
*
* @return the accessible selection from this AccssibleJComboBox
*/
public Accessible getAccessibleSelection(int index)
{
// Get hold of the actual popup.
Accessible popup = getUI().getAccessibleChild(JComboBox.this, 0);
Accessible selected = null;
if (popup != null && popup instanceof ComboPopup)
{
ComboPopup cPopup = (ComboPopup) popup;
// Query the list for the currently selected child.
JList l = cPopup.getList();
AccessibleContext listCtx = l.getAccessibleContext();
if (listCtx != null)
{
AccessibleSelection s = listCtx.getAccessibleSelection();
if (s != null)
{
selected = s.getAccessibleSelection(index);
}
}
}
return selected;
}
/**
* Returns <code>true</code> if the accessible child with the specified
* <code>index</code> is selected, <code>false</code> otherwise.
*
* @param index the index of the accessible child
*
* @return <code>true</code> if the accessible child with the specified
* <code>index</code> is selected, <code>false</code> otherwise
*/
public boolean isAccessibleChildSelected(int index)
{
return getSelectedIndex() == index;
}
/**
* Returns the accessible role for the <code>JComboBox</code> component.
*
* @return {@link AccessibleRole#COMBO_BOX}.
*/
public AccessibleRole getAccessibleRole()
{
return AccessibleRole.COMBO_BOX;
}
/**
* Returns the accessible action associated to this accessible object.
* AccessibleJComboBox implements its own AccessibleAction, so this
* method returns <code>this</code>.
*
* @return the accessible action associated to this accessible object
*/
public AccessibleAction getAccessibleAction()
{
return this;
}
/**
* Returns the description of the specified action. AccessibleJComboBox
* implements 1 action (toggle the popup menu) and thus returns
* <code>UIManager.getString("ComboBox.togglePopupText")</code>
*
* @param actionIndex the index of the action for which to return the
* description
*
* @return the description of the specified action
*/
public String getAccessibleActionDescription(int actionIndex)
{
return UIManager.getString("ComboBox.togglePopupText");
}
/**
* Returns the number of accessible actions that can be performed by
* this object. AccessibleJComboBox implement s one accessible action
* (toggle the popup menu), so this method always returns <code>1</code>.
*
* @return the number of accessible actions that can be performed by
* this object
*/
public int getAccessibleActionCount()
{
return 1;
}
/**
* Performs the accessible action with the specified index.
* AccessibleJComboBox has 1 accessible action
* (<code>actionIndex == 0</code>), which is to toggle the
* popup menu. All other action indices have no effect and return
* <code<>false</code>.
*
* @param actionIndex the index of the action to perform
*
* @return <code>true</code> if the action has been performed,
* <code>false</code> otherwise
*/
public boolean doAccessibleAction(int actionIndex)
{
boolean actionPerformed = false;
if (actionIndex == 0)
{
setPopupVisible(! isPopupVisible());
actionPerformed = true;
}
return actionPerformed;
}
/**
* Returns the number of selected accessible children of this object. This
* returns <code>1</code> if the combobox has a selected entry,
* <code>0</code> otherwise.
*
* @return the number of selected accessible children of this object
*/
public int getAccessibleSelectionCount()
{
Object sel = getSelectedItem();
int count = 0;
if (sel != null)
count = 1;
return count;
}
/**
* Sets the current selection to the specified <code>index</code>.
*
* @param index the index to set as selection
*/
public void addAccessibleSelection(int index)
{
setSelectedIndex(index);
}
/**
* Removes the specified index from the current selection.
*
* @param index the index to remove from the selection
*/
public void removeAccessibleSelection(int index)
{
if (getSelectedIndex() == index)
clearAccessibleSelection();
}
/**
* Clears the current selection.
*/
public void clearAccessibleSelection()
{
setSelectedIndex(-1);
}
/**
* Multiple selection is not supported by AccessibleJComboBox, so this
* does nothing.
*/
public void selectAllAccessibleSelection()
{
// Nothing to do here.
}
}
private class DefaultKeySelectionManager
implements KeySelectionManager
{
public int selectionForKey(char aKey, ComboBoxModel aModel)
{
int selectedIndex = getSelectedIndex();
// Start at currently selected item and iterate to end of list
for (int i = selectedIndex + 1; i < aModel.getSize(); i++)
{
String nextItem = aModel.getElementAt(i).toString();
if (nextItem.charAt(0) == aKey)
return i;
}
// Wrap to start of list if no match yet
for (int i = 0; i <= selectedIndex; i++)
{
String nextItem = aModel.getElementAt(i).toString();
if (nextItem.charAt(0) == aKey)
return i;
}
return - 1;
}
}
}
|