1 /*
2  * Copyright (c) 1997, 1998, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 package javax.swing;
26 
27 import java.awt.*;
28 import java.awt.event.*;
29 
30 /**
31  * The editor component used for JComboBox components.
32  *
33  * @author Arnaud Weber
34  * @since 1.2
35  */
36 public interface ComboBoxEditor {
37 
38   /**
39    * Returns the component that should be added to the tree hierarchy for
40    * this editor
41    *
42    * @return the component
43    */
getEditorComponent()44   public Component getEditorComponent();
45 
46   /**
47    * Set the item that should be edited. Cancel any editing if necessary
48    *
49    * @param anObject an item
50    */
setItem(Object anObject)51   public void setItem(Object anObject);
52 
53   /**
54    * Returns the edited item
55    *
56    * @return the edited item
57    */
getItem()58   public Object getItem();
59 
60   /**
61    * Ask the editor to start editing and to select everything
62    */
selectAll()63   public void selectAll();
64 
65   /**
66    * Add an ActionListener. An action event is generated when the edited item changes
67    *
68    * @param l an {@code ActionListener}
69    */
addActionListener(ActionListener l)70   public void addActionListener(ActionListener l);
71 
72   /**
73    * Remove an ActionListener
74    *
75    * @param l an {@code ActionListener}
76    */
removeActionListener(ActionListener l)77   public void removeActionListener(ActionListener l);
78 }
79