This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.

See also

getModel, setModel

This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.

See also

getRenderer, setRenderer

This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.

See also

getEditor, setEditor

This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.

See also

getMaximumRowCount, setMaximumRowCount

This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.

See also

isEditable, setEditable

This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.

See also

setKeySelectionManager, getKeySelectionManager

This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.

See also

setActionCommand, getActionCommand

This protected field is implementation specific. Do not access directly or override. Use the accessor methods instead.

See also

setLightWeightPopupEnabled, isLightWeightPopupEnabled

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
See also	javax.swing.DefaultComboBoxModel

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
See also	javax.swing.DefaultComboBoxModel

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
See also	javax.swing.DefaultComboBoxModel

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.

See also

javax.swing.DefaultComboBoxModel

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
since	1.6
See also	javax.swing.Action, configurePropertiesFromAction

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
See also	setSelectedItem

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
See also	javax.swing.MutableComboBoxModel

Adds an ItemListener.

aListener will receive one or two ItemEvents when the selected item changes.

aListener	the ItemListener that is to be notified
See also	setSelectedItem

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
since	1.4

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

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
since	1.3
See also	javax.swing.Action, setAction

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
since	1.3
See also	javax.swing.Action, setAction

Returns an instance of the default key-selection manager.

return	the KeySelectionManager currently used by the list
See also	setKeySelectionManager

Notifies all listeners that have registered interest for notification on this event type.

See also

javax.swing.event.EventListenerList

Notifies all listeners that have registered interest for notification on this event type.

e	the event of interest
See also	javax.swing.event.EventListenerList

Notifies PopupMenuListeners 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.

since	1.4
See also	addPopupMenuListener

Notifies PopupMenuListeners 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.

since	1.4
See also	addPopupMenuListener

Notifies PopupMenuListeners 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.

since	1.4
See also	addPopupMenuListener

Causes the combo box to close its popup window.

See also

setPopupVisible

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
See also	javax.swing.MutableComboBoxModel

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.

return

a string representation of this JComboBox

Handles KeyEvents, 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 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
See also	javax.swing.MutableComboBoxModel

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
See also	javax.swing.MutableComboBoxModel

Removes an ItemListener.

aListener

the ItemListener to remove

Removes a PopupMenuListener.

l	the PopupMenuListener to remove
since	1.4
See also	addPopupMenuListener

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

Causes the combo box to display its popup window.

See also

setPopupVisible

Resets the UI property to a value from the current look and feel.

See also

updateUI

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.

return

an AccessibleJComboBox that serves as the AccessibleContext of this JComboBox

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.
since	1.3
beaninfo	bound: true attribute: visualUpdate true description: the Action instance connected with this ActionEvent source
See also	javax.swing.Action, getAction, configurePropertiesFromAction, createActionPropertyChangeListener, actionPropertyChanged

Returns the currently set Action for this ActionEvent source, or null if no Action is set.

return	the Action for this ActionEvent source; or null
since	1.3
See also	javax.swing.Action, setAction

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

Returns the action command that is included in the event sent to action listeners.

return

the string containing the "command" that is sent to action listeners.

Returns an array of all the ActionListeners added to this JComboBox with addActionListener().

return	all of the ActionListeners added or an empty array if no listeners have been added
since	1.4

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
beaninfo	bound: true preferred: true description: If true, the user can type a new value in the combo box.

Returns true if the JComboBox is editable. By default, a combo box is not editable.

return

true if the JComboBox is editable, else false

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
beaninfo	bound: true expert: true description: The editor that combo box uses to edit the current value
See also	setRenderer

Returns the editor used to paint and edit the selected item in the JComboBox field.

return

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
beaninfo	bound: true preferred: true description: Whether the combo box is enabled.

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
return	the Object at that list position; or null if out of range

Returns the number of items in the list.

return

an integer equal to the number of items in the list

Returns an array of all the ItemListeners added to this JComboBox with addItemListener().

return	all of the ItemListeners added or an empty array if no listeners have been added
since	1.4

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.

beaninfo

expert: true description: The objects that changes the selection when a key is pressed.

Returns the list's key-selection manager.

return

the KeySelectionManager currently in use

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
beaninfo	bound: true expert: true description: Set to false to require heavyweight popups.

Gets the value of the lightWeightPopupEnabled property.

return	the value of the lightWeightPopupEnabled property
See also	setLightWeightPopupEnabled

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
beaninfo	bound: true preferred: true description: The maximum number of rows the popup should have

Returns the maximum number of items the combo box can display without a scrollbar

return

an integer specifying the maximum number of items that are displayed 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
beaninfo	bound: true description: Model that the combo box uses to get data to display.

Returns the data model currently used by the JComboBox.

return

the ComboBoxModel that provides the displayed list of items

Returns an array of all the PopupMenuListeners added to this JComboBox with addPopupMenuListener().

return	all of the PopupMenuListeners added or an empty array if no listeners have been added
since	1.4

Determines the visibility of the popup.

return

true if the popup is visible, otherwise returns false

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.

prototypeDisplayValue
since	1.4
beaninfo	bound: true attribute: visualUpdate true description: The display prototype value, used to compute display width and height.
See also	getPrototypeDisplayValue

Returns the "prototypical display" value - an Object used for the calculation of the display height and width.

return	the value of the prototypeDisplayValue property
since	1.4
See also	setPrototypeDisplayValue

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
beaninfo	bound: true expert: true description: The renderer that paints the item selected in the list.
See also	setEditor

Returns the renderer used to display the selected item in the JComboBox field.

return

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
Throws	IllegalArgumentException: if anIndex < -1 or anIndex is greater than or equal to size
beaninfo	preferred: true description: The item at index is selected.

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.

return

an integer specifying the currently selected list item, where 0 specifies the first item in the list; or -1 if no item is selected or if the currently selected item is not in the list

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, ItemListeners added to the combo box will be notified with one or two ItemEvents. 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.

ActionListeners 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
beaninfo	preferred: true description: Sets the selected item in the JComboBox.

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.

return	the current selected Object
See also	setSelectedItem

Returns an array containing the selected item. This method is implemented for compatibility with ItemSelectable.

return

an array of Objects containing one element -- the selected item

Sets the L&F object that renders this component.

ui	the ComboBoxUI L&F object
beaninfo	bound: true hidden: true attribute: visualUpdate true description: The UI object that implements the Component's LookAndFeel.
See also	getUI

Returns the L&F object that renders this component.

return

the ComboBoxUI object that renders this component

Returns the name of the L&F class that renders this component.

return	the string "ComboBoxUI"
See also	getUIClassID, getUI