javax.swing.plaf.basic

Class BasicComboBoxEditor

Implemented Interfaces:
ComboBoxEditor, EventListener, FocusListener
Known Direct Subclasses:
BasicComboBoxEditor.UIResource, MetalComboBoxEditor

public class BasicComboBoxEditor
extends Object
implements ComboBoxEditor, FocusListener

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

Nested Class Summary

static class
BasicComboBoxEditor.UIResource
A subclass of BasicComboBoxEditor that implements the BasicComboBoxEditor.UIResource interface.

Field Summary

protected JTextField
editor
The editor component.

Constructor Summary

BasicComboBoxEditor()
Creates a new BasicComboBoxEditor instance.

Method Summary

void
addActionListener(ActionListener l)
Adds an ActionListener to the editor component.
void
focusGained(FocusEvent e)
This method is called when textfield gains focus.
void
focusLost(FocusEvent e)
This method is called when textfield loses focus.
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.
Object
getItem()
Returns the text from the editor component.
void
removeActionListener(ActionListener l)
Removes the ActionListener from the editor component.
void
selectAll()
Selects all the text in the editor component.
void
setItem(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, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

editor

protected JTextField editor
The editor component.

Constructor Details

BasicComboBoxEditor

public BasicComboBoxEditor()
Creates a new BasicComboBoxEditor instance.

Method Details

addActionListener

public void addActionListener(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 ComboBoxEditor
Parameters:
l - the ActionListener responsible for changing selected item of the combo box when it is editted by the user.

focusGained

public void focusGained(FocusEvent e)
This method is called when textfield gains focus. This will enable editing of the selected item.
Specified by:
focusGained in interface FocusListener
Parameters:
e - the FocusEvent describing change in focus.

focusLost

public void focusLost(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 FocusListener
Parameters:
e - the FocusEvent describing change in focus

getEditorComponent

public 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 ComboBoxEditor
Returns:
The editor component, which is a JTextField in this case.

getItem

public Object getItem()
Returns the text from the editor component.
Specified by:
getItem in interface ComboBoxEditor
Returns:
The text from the editor component.

removeActionListener

public void removeActionListener(ActionListener l)
Removes the ActionListener from the editor component.
Specified by:
removeActionListener in interface ComboBoxEditor
Parameters:
l - the listener to remove.

selectAll

public void selectAll()
Selects all the text in the editor component.
Specified by:
selectAll in interface ComboBoxEditor

setItem

public void setItem(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 ComboBoxEditor
Parameters:
item - item that is currently selected in the combo box

BasicComboBoxEditor.java -- Copyright (C) 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.