javax.swing.plaf.basic

Class BasicComboBoxEditor

java.lang.Object

javax.swing.plaf.basic.BasicComboBoxEditor

All Implemented Interfaces:

java.awt.event.FocusListener, java.util.EventListener, javax.swing.ComboBoxEditor

Direct Known Subclasses:

BasicComboBoxEditor.UIResource

public class BasicComboBoxEditor
extends java.lang.Object
implements javax.swing.ComboBoxEditor, java.awt.event.FocusListener

An editor used by the BasicComboBoxUI class. This editor uses a JTextField as the editor component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BasicComboBoxEditor.UIResource A subclass of BasicComboBoxEditor that implements the BasicComboBoxEditor.UIResource interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.swing.JTextField	editor The editor component.

Constructor Summary

Constructors

Constructor and Description
BasicComboBoxEditor() Creates a new BasicComboBoxEditor instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	addActionListener(java.awt.event.ActionListener l) Adds an ActionListener to the editor component.
void	focusGained(java.awt.event.FocusEvent e) This method is called when textfield gains focus.
void	focusLost(java.awt.event.FocusEvent e) This method is called when textfield loses focus.
java.awt.Component	getEditorComponent() Returns the component that will be used by the combo box to display and edit the currently selected item in the combo box.
java.lang.Object	getItem() Returns the text from the editor component.
void	removeActionListener(java.awt.event.ActionListener l) Removes the ActionListener from the editor component.
void	selectAll() Selects all the text in the editor component.
void	setItem(java.lang.Object item) Sets item that should be edited when any editing operation is performed by the user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

editor

protected javax.swing.JTextField editor

The editor component.

Constructor Detail

BasicComboBoxEditor

public BasicComboBoxEditor()

Creates a new BasicComboBoxEditor instance.

Method Detail

getEditorComponent

public java.awt.Component getEditorComponent()

Returns the component that will be used by the combo box to display and edit the currently selected item in the combo box.

Specified by:

getEditorComponent in interface javax.swing.ComboBoxEditor

Returns:

The editor component, which is a JTextField in this case.

setItem

public void setItem(java.lang.Object item)

Sets item that should be edited when any editing operation is performed by the user. The value is always equal to the currently selected value in the combo box. Thus whenever a different value is selected from the combo box list then this method should be called to change editing item to the new selected item.

Specified by:

setItem in interface javax.swing.ComboBoxEditor

Parameters:

item - item that is currently selected in the combo box

getItem

public java.lang.Object getItem()

Returns the text from the editor component.

Specified by:

getItem in interface javax.swing.ComboBoxEditor

Returns:

The text from the editor component.

selectAll

public void selectAll()

Selects all the text in the editor component.

Specified by:

selectAll in interface javax.swing.ComboBoxEditor

focusGained

public void focusGained(java.awt.event.FocusEvent e)

This method is called when textfield gains focus. This will enable editing of the selected item.

Specified by:

focusGained in interface java.awt.event.FocusListener

Parameters:

e - the FocusEvent describing change in focus.

focusLost

public void focusLost(java.awt.event.FocusEvent e)

This method is called when textfield loses focus. If during this time any editting operation was performed by the user, then it will be cancelled and selected item will not be changed.

Specified by:

focusLost in interface java.awt.event.FocusListener

Parameters:

e - the FocusEvent describing change in focus

addActionListener

public void addActionListener(java.awt.event.ActionListener l)

Adds an ActionListener to the editor component. If the user will edit currently selected item in the textfield and pressEnter, then action will be performed. The actionPerformed of this ActionListener should change the selected item of the comboBox to the newly editted selected item.

Specified by:

addActionListener in interface javax.swing.ComboBoxEditor

Parameters:

l - the ActionListener responsible for changing selected item of the combo box when it is editted by the user.

removeActionListener

public void removeActionListener(java.awt.event.ActionListener l)

Removes the ActionListener from the editor component.

Specified by:

removeActionListener in interface javax.swing.ComboBoxEditor

Parameters:

l - the listener to remove.