java.lang.Object | ||||
↳ | java.awt.Component | |||
↳ | java.awt.Container | |||
↳ | javax.swing.JComponent | |||
↳ | javax.swing.JComboBox |
![]() |
A component that combines a button or editable field and a drop-down list. The user can select a value from the drop-down list, which appears at the user's request. If you make the combo box editable, then the combo box includes an editable field into which the user can type a value.
Warning: Swing is not thread safe. For more information see Swing's Threading Policy.
Warning:
Serialized objects of this class will not be compatible with
future Swing releases. The current serialization support is
appropriate for short term storage or RMI between applications running
the same version of Swing. As of 1.4, support for long term storage
of all JavaBeansTM
has been added to the java.beans
package.
Please see XMLEncoder
.
See How to Use Combo Boxes in The Java Tutorial for further information.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
JComboBox.AccessibleJComboBox | This class implements accessibility support for the
JComboBox class. |
||||||||||
JComboBox.KeySelectionManager | The interface that defines a KeySelectionManager . |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
actionCommand | This protected field is implementation specific. | ||||||||||
dataModel | This protected field is implementation specific. | ||||||||||
editor | This protected field is implementation specific. | ||||||||||
isEditable | This protected field is implementation specific. | ||||||||||
keySelectionManager | This protected field is implementation specific. | ||||||||||
lightWeightPopupEnabled | This protected field is implementation specific. | ||||||||||
maximumRowCount | This protected field is implementation specific. | ||||||||||
renderer | This protected field is implementation specific. | ||||||||||
selectedItemReminder | This protected field is implementation specific. |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Creates a
JComboBox that takes its items from an
existing ComboBoxModel . | |||||||||||
Creates a
JComboBox that contains the elements
in the specified array. | |||||||||||
Creates a
JComboBox that contains the elements
in the specified Vector. | |||||||||||
Creates a
JComboBox with a default data model. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
This method is public as an implementation side effect.
| |||||||||||
Adds an
ActionListener . | |||||||||||
Adds an item to the item list.
| |||||||||||
Adds an
ItemListener . | |||||||||||
Adds a
PopupMenu listener which will listen to notification
messages from the popup portion of the combo box. | |||||||||||
Initializes the editor with the specified item.
| |||||||||||
This method is public as an implementation side effect.
| |||||||||||
Notifies
PopupMenuListener s that the popup portion of the
combo box has been canceled. | |||||||||||
Notifies
PopupMenuListener s that the popup portion of the
combo box has become invisible. | |||||||||||
Notifies
PopupMenuListener s that the popup portion of the
combo box will become visible. | |||||||||||
Gets the AccessibleContext associated with this JComboBox.
| |||||||||||
Returns the currently set
Action for this
ActionEvent source, or null if no
Action is set. | |||||||||||
Returns the action command that is included in the event sent to
action listeners.
| |||||||||||
Returns an array of all the
ActionListener s added
to this JComboBox with addActionListener(). | |||||||||||
Returns the editor used to paint and edit the selected item in the
JComboBox field. | |||||||||||
Returns the list item at the specified index.
| |||||||||||
Returns the number of items in the list.
| |||||||||||
Returns an array of all the
ItemListener s added
to this JComboBox with addItemListener(). | |||||||||||
Returns the list's key-selection manager.
| |||||||||||
Returns the maximum number of items the combo box can display
without a scrollbar
| |||||||||||
Returns the data model currently used by the
JComboBox . | |||||||||||
Returns an array of all the
PopupMenuListener s added
to this JComboBox with addPopupMenuListener(). | |||||||||||
Returns the "prototypical display" value - an Object used
for the calculation of the display height and width.
| |||||||||||
Returns the renderer used to display the selected item in the
JComboBox field. | |||||||||||
Returns the first item in the list that matches the given item.
| |||||||||||
Returns the current selected item.
| |||||||||||
Returns an array containing the selected item.
| |||||||||||
Returns the L&F object that renders this component.
| |||||||||||
Returns the name of the L&F class that renders this component.
| |||||||||||
Causes the combo box to close its popup window.
| |||||||||||
Inserts an item into the item list at a given index.
| |||||||||||
This method is public as an implementation side effect.
| |||||||||||
This method is public as an implementation side effect.
| |||||||||||
Returns true if the
JComboBox is editable. | |||||||||||
Gets the value of the
lightWeightPopupEnabled
property. | |||||||||||
Determines the visibility of the popup.
| |||||||||||
Handles
KeyEvent s, looking for the Tab key. | |||||||||||
Removes an
ActionListener . | |||||||||||
Removes all items from the item list.
| |||||||||||
Removes an item from the item list.
| |||||||||||
Removes the item at
anIndex
This method works only if the JComboBox uses a
mutable data model. | |||||||||||
Removes an
ItemListener . | |||||||||||
Removes a
PopupMenuListener . | |||||||||||
Selects the list item that corresponds to the specified keyboard
character and returns true, if there is an item corresponding
to that character.
| |||||||||||
Sets the
Action for the ActionEvent source. | |||||||||||
Sets the action command that should be included in the event
sent to action listeners.
| |||||||||||
Determines whether the
JComboBox field is editable. | |||||||||||
Sets the editor used to paint and edit the selected item in the
JComboBox field. | |||||||||||
Enables the combo box so that items can be selected.
| |||||||||||
Sets the object that translates a keyboard character into a list
selection.
| |||||||||||
Sets the
lightWeightPopupEnabled property, which
provides a hint as to whether or not a lightweight
Component should be used to contain the
JComboBox , versus a heavyweight
Component such as a Panel
or a Window . | |||||||||||
Sets the maximum number of rows the
JComboBox displays. | |||||||||||
Sets the data model that the
JComboBox uses to obtain
the list of items. | |||||||||||
Sets the visibility of the popup.
| |||||||||||
Sets the prototype display value used to calculate the size of the display
for the UI portion.
| |||||||||||
Sets the renderer that paints the list items and the item selected from the list in
the JComboBox field.
| |||||||||||
Selects the item at index
anIndex . | |||||||||||
Sets the selected item in the combo box display area to the object in
the argument.
| |||||||||||
Sets the L&F object that renders this component.
| |||||||||||
Causes the combo box to display its popup window.
| |||||||||||
Resets the UI property to a value from the current look and feel.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Updates the combobox's state in response to property changes in
associated action.
| |||||||||||
Sets the properties on this combobox to match those in the specified
Action . | |||||||||||
Creates and returns a
PropertyChangeListener that is
responsible for listening for changes from the specified
Action and updating the appropriate properties. | |||||||||||
Returns an instance of the default key-selection manager.
| |||||||||||
Notifies all listeners that have registered interest for
notification on this event type.
| |||||||||||
Notifies all listeners that have registered interest for
notification on this event type.
| |||||||||||
Returns a string representation of this
JComboBox . | |||||||||||
This protected method is implementation specific.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.
This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.
This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.
This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.
This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.
This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.
This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.
This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.
This protected field is implementation specific. Do not access directly or override.
Creates a JComboBox
that takes its items from an
existing ComboBoxModel
. Since the
ComboBoxModel
is provided, a combo box created using
this constructor does not create a default combo box model and
may impact how the insert, remove and add methods behave.
aModel | the ComboBoxModel that provides the
displayed list of items |
---|
Creates a JComboBox
that contains the elements
in the specified array. By default the first item in the array
(and therefore the data model) becomes selected.
items | an array of objects to insert into the combo box |
---|
Creates a JComboBox
that contains the elements
in the specified Vector. By default the first item in the vector
(and therefore the data model) becomes selected.
items | an array of vectors to insert into the combo box |
---|
Creates a JComboBox
with a default data model.
The default data model is an empty list of objects.
Use addItem
to add items. By default the first item
in the data model becomes selected.
This method is public as an implementation side effect. do not call or override.
Adds an ActionListener
.
The ActionListener
will receive an ActionEvent
when a selection has been made. If the combo box is editable, then
an ActionEvent
will be fired when editing has stopped.
l | the ActionListener that is to be notified |
---|
Adds an item to the item list.
This method works only if the JComboBox
uses a
mutable data model.
Warning: Focus and keyboard navigation problems may arise if you add duplicate String objects. A workaround is to add new objects instead of String objects and make sure that the toString() method is defined. For example:
comboBox.addItem(makeObj("Item 1")); comboBox.addItem(makeObj("Item 1")); ... private Object makeObj(final String item) { return new Object() { public String toString() { return item; } }; }
anObject | the Object to add to the list |
---|
Adds an ItemListener
.
aListener
will receive one or two ItemEvent
s when
the selected item changes.
aListener | the ItemListener that is to be notified |
---|
Adds a PopupMenu
listener which will listen to notification
messages from the popup portion of the combo box.
For all standard look and feels shipped with Java, the popup list
portion of combo box is implemented as a JPopupMenu
.
A custom look and feel may not implement it this way and will
therefore not receive the notification.
l | the PopupMenuListener to add |
---|
Initializes the editor with the specified item.
anEditor | the ComboBoxEditor that displays
the list item in the
combo box field and allows it to be edited |
---|---|
anItem | the object to display and edit in the field |
This method is public as an implementation side effect. do not call or override.
e | a ListDataEvent encapsulating the
event information
|
---|
Notifies PopupMenuListener
s that the popup portion of the
combo box has been canceled.
This method is public but should not be called by anything other than the UI delegate.
Notifies PopupMenuListener
s that the popup portion of the
combo box has become invisible.
This method is public but should not be called by anything other than the UI delegate.
Notifies PopupMenuListener
s that the popup portion of the
combo box will become visible.
This method is public but should not be called by anything other than the UI delegate.
Gets the AccessibleContext associated with this JComboBox. For combo boxes, the AccessibleContext takes the form of an AccessibleJComboBox. A new AccessibleJComboBox instance is created if necessary.
Returns the currently set Action
for this
ActionEvent
source, or null
if no
Action
is set.
Action
for this ActionEvent
source; or null
Returns the action command that is included in the event sent to action listeners.
Returns an array of all the ActionListener
s added
to this JComboBox with addActionListener().
ActionListener
s added or an empty
array if no listeners have been addedReturns the editor used to paint and edit the selected item in the
JComboBox
field.
ComboBoxEditor
that displays the selected item
Returns the list item at the specified index. If index
is out of range (less than zero or greater than or equal to size)
it will return null
.
index | an integer indicating the list position, where the first item starts at zero |
---|
Object
at that list position; or
null
if out of range
Returns the number of items in the list.
Returns an array of all the ItemListener
s added
to this JComboBox with addItemListener().
ItemListener
s added or an empty
array if no listeners have been addedReturns the list's key-selection manager.
KeySelectionManager
currently in use
Returns the maximum number of items the combo box can display without a scrollbar
Returns the data model currently used by the JComboBox
.
ComboBoxModel
that provides the displayed
list of items
Returns an array of all the PopupMenuListener
s added
to this JComboBox with addPopupMenuListener().
PopupMenuListener
s added or an empty
array if no listeners have been addedReturns the "prototypical display" value - an Object used for the calculation of the display height and width.
prototypeDisplayValue
propertyReturns the renderer used to display the selected item in the
JComboBox
field.
ListCellRenderer
that displays
the selected item.
Returns the first item in the list that matches the given item.
The result is not always defined if the JComboBox
allows selected items that are not in the list.
Returns -1 if there is no selected item or if the user specified
an item which is not in the list.
Returns the current selected item.
If the combo box is editable, then this value may not have been added
to the combo box with addItem
, insertItemAt
or the data constructors.
Returns an array containing the selected item.
This method is implemented for compatibility with
ItemSelectable
.
Objects
containing one
element -- the selected item
Returns the L&F object that renders this component.
Returns the name of the L&F class that renders this component.
Causes the combo box to close its popup window.
Inserts an item into the item list at a given index.
This method works only if the JComboBox
uses a
mutable data model.
anObject | the Object to add to the list |
---|---|
index | an integer specifying the position at which to add the item |
This method is public as an implementation side effect. do not call or override.
e | a ListDataEvent encapsulating the
event information
|
---|
This method is public as an implementation side effect. do not call or override.
e | a ListDataEvent encapsulating the
event information
|
---|
Returns true if the JComboBox
is editable.
By default, a combo box is not editable.
JComboBox
is editable, else false
Gets the value of the lightWeightPopupEnabled
property.
lightWeightPopupEnabled
propertyDetermines the visibility of the popup.
Handles KeyEvent
s, looking for the Tab key.
If the Tab key is found, the popup window is closed.
e | the KeyEvent containing the keyboard
key that was pressed
|
---|
Removes an ActionListener
.
l | the ActionListener to remove
|
---|
Removes all items from the item list.
Removes an item from the item list.
This method works only if the JComboBox
uses a
mutable data model.
anObject | the object to remove from the item list |
---|
Removes the item at anIndex
This method works only if the JComboBox
uses a
mutable data model.
anIndex | an int specifying the index of the item to remove, where 0 indicates the first item in the list |
---|
Removes an ItemListener
.
aListener | the ItemListener to remove
|
---|
Removes a PopupMenuListener
.
l | the PopupMenuListener to remove |
---|
Selects the list item that corresponds to the specified keyboard character and returns true, if there is an item corresponding to that character. Otherwise, returns false.
keyChar | a char, typically this is a keyboard key typed by the user |
---|
Sets the Action
for the ActionEvent
source.
The new Action
replaces any previously set
Action
but does not affect ActionListeners
independently added with addActionListener
.
If the Action
is already a registered
ActionListener
for the ActionEvent
source,
it is not re-registered.
Setting the Action
results in immediately changing
all the properties described in
Swing Components Supporting Action
.
Subsequently, the combobox's properties are automatically updated
as the Action
's properties change.
This method uses three other methods to set
and help track the Action
's property values.
It uses the configurePropertiesFromAction
method
to immediately change the combobox's properties.
To track changes in the Action
's property values,
this method registers the PropertyChangeListener
returned by createActionPropertyChangeListener
. The
default PropertyChangeListener
invokes the
actionPropertyChanged
method when a property in the
Action
changes.
a | the Action for the JComboBox ,
or null . |
---|
Sets the action command that should be included in the event sent to action listeners.
aCommand | a string containing the "command" that is sent to action listeners; the same listener can then do different things depending on the command it receives |
---|
Determines whether the JComboBox
field is editable.
An editable JComboBox
allows the user to type into the
field or selected an item from the list to initialize the field,
after which it can be edited. (The editing affects only the field,
the list item remains intact.) A non editable JComboBox
displays the selected item in the field,
but the selection cannot be modified.
aFlag | a boolean value, where true indicates that the field is editable |
---|
Sets the editor used to paint and edit the selected item in the
JComboBox
field. The editor is used only if the
receiving JComboBox
is editable. If not editable,
the combo box uses the renderer to paint the selected item.
anEditor | the ComboBoxEditor that
displays the selected item |
---|
Enables the combo box so that items can be selected. When the combo box is disabled, items cannot be selected and values cannot be typed into its field (if it is editable).
b | a boolean value, where true enables the component and false disables it |
---|
Sets the object that translates a keyboard character into a list selection. Typically, the first selection with a matching first character becomes the selected item.
Sets the lightWeightPopupEnabled
property, which
provides a hint as to whether or not a lightweight
Component
should be used to contain the
JComboBox
, versus a heavyweight
Component
such as a Panel
or a Window
. The decision of lightweight
versus heavyweight is ultimately up to the
JComboBox
. Lightweight windows are more
efficient than heavyweight windows, but lightweight
and heavyweight components do not mix well in a GUI.
If your application mixes lightweight and heavyweight
components, you should disable lightweight popups.
The default value for the lightWeightPopupEnabled
property is true
, unless otherwise specified
by the look and feel. Some look and feels always use
heavyweight popups, no matter what the value of this property.
See the article Mixing Heavy and Light Components on The Swing Connection This method fires a property changed event.
aFlag | if true , lightweight popups are desired |
---|
Sets the maximum number of rows the JComboBox
displays.
If the number of objects in the model is greater than count,
the combo box uses a scrollbar.
count | an integer specifying the maximum number of items to display in the list before using a scrollbar |
---|
Sets the data model that the JComboBox
uses to obtain
the list of items.
aModel | the ComboBoxModel that provides the
displayed list of items |
---|
Sets the visibility of the popup.
Sets the prototype display value used to calculate the size of the display for the UI portion.
If a prototype display value is specified, the preferred size of the combo box is calculated by configuring the renderer with the prototype display value and obtaining its preferred size. Specifying the preferred display value is often useful when the combo box will be displaying large amounts of data. If no prototype display value has been specified, the renderer must be configured for each value from the model and its preferred size obtained, which can be relatively expensive.
Sets the renderer that paints the list items and the item selected from the list in the JComboBox field. The renderer is used if the JComboBox is not editable. If it is editable, the editor is used to render and edit the selected item.
The default renderer displays a string or an icon. Other renderers can handle graphic images and composite items.
To display the selected item,
aRenderer.getListCellRendererComponent
is called, passing the list object and an index of -1.
aRenderer | the ListCellRenderer that
displays the selected item |
---|
Selects the item at index anIndex
.
anIndex | an integer specifying the list item to select, where 0 specifies the first item in the list and -1 indicates no selection |
---|
IllegalArgumentException | if anIndex < -1 or
anIndex is greater than or equal to size |
---|
Sets the selected item in the combo box display area to the object in
the argument.
If anObject
is in the list, the display area shows
anObject
selected.
If anObject
is not in the list and the combo box is
uneditable, it will not change the current selection. For editable
combo boxes, the selection will change to anObject
.
If this constitutes a change in the selected item,
ItemListener
s added to the combo box will be notified with
one or two ItemEvent
s.
If there is a current selected item, an ItemEvent
will be
fired and the state change will be ItemEvent.DESELECTED
.
If anObject
is in the list and is not currently selected
then an ItemEvent
will be fired and the state change will
be ItemEvent.SELECTED
.
ActionListener
s added to the combo box will be notified
with an ActionEvent
when this method is called.
anObject | the list object to select; use null to
clear the selection |
---|
Sets the L&F object that renders this component.
ui | the ComboBoxUI L&F object |
---|
Causes the combo box to display its popup window.
Resets the UI property to a value from the current look and feel.
Updates the combobox's state in response to property changes in
associated action. This method is invoked from the
PropertyChangeListener
returned from
createActionPropertyChangeListener
. Subclasses do not normally
need to invoke this. Subclasses that support additional Action
properties should override this and
configurePropertiesFromAction
.
Refer to the table at
Swing Components Supporting Action
for a list of
the properties this method sets.
action | the Action associated with this combobox |
---|---|
propertyName | the name of the property that changed |
Sets the properties on this combobox to match those in the specified
Action
. Refer to
Swing Components Supporting Action
for more
details as to which properties this sets.
a | the Action from which to get the properties,
or null |
---|
Creates and returns a PropertyChangeListener
that is
responsible for listening for changes from the specified
Action
and updating the appropriate properties.
Warning: If you subclass this do not create an anonymous
inner class. If you do the lifetime of the combobox will be tied to
that of the Action
.
a | the combobox's action |
---|
Returns an instance of the default key-selection manager.
KeySelectionManager
currently used by the listNotifies all listeners that have registered interest for notification on this event type.
Notifies all listeners that have registered interest for notification on this event type.
e | the event of interest |
---|
Returns a string representation of this JComboBox
.
This method is intended to be used only for debugging purposes,
and the content and format of the returned string may vary between
implementations. The returned string may be empty but may not
be null
.
JComboBox
This protected method is implementation specific. Do not access directly or override.