01: /*
02: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
03: *
04: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
05: *
06: * The contents of this file are subject to the terms of either the GNU
07: * General Public License Version 2 only ("GPL") or the Common
08: * Development and Distribution License("CDDL") (collectively, the
09: * "License"). You may not use this file except in compliance with the
10: * License. You can obtain a copy of the License at
11: * http://www.netbeans.org/cddl-gplv2.html
12: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
13: * specific language governing permissions and limitations under the
14: * License. When distributing the software, include this License Header
15: * Notice in each file and include the License file at
16: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
17: * particular file as subject to the "Classpath" exception as provided
18: * by Sun in the GPL Version 2 section of the License file that
19: * accompanied this code. If applicable, add the following below the
20: * License Header, with the fields enclosed by brackets [] replaced by
21: * your own identifying information:
22: * "Portions Copyrighted [year] [name of copyright owner]"
23: *
24: * Contributor(s):
25: *
26: * The Original Software is NetBeans. The Initial Developer of the Original
27: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2006 Sun
28: * Microsystems, Inc. All Rights Reserved.
29: *
30: * If you wish your version of this file to be governed by only the CDDL
31: * or only the GPL Version 2, indicate your decision by adding
32: * "[Contributor] elects to include this software in this distribution
33: * under the [CDDL or GPL Version 2] license." If you do not indicate a
34: * single choice of license, a recipient has the option to distribute
35: * your version of this file under either the CDDL, the GPL Version 2 or
36: * to extend the choice of license to its licensees as provided above.
37: * However, if you add GPL Version 2 code and therefore, elected the GPL
38: * Version 2 license, then the option applies only if the new code is
39: * made subject to such option by the copyright holder.
40: */
41:
42: package org.netbeans.modules.db.util;
43:
44: import javax.swing.ComboBoxModel;
45:
46: /**
47: * Serves as a model for {@link DataComboBoxSupport}.
48: *
49: * @author Andrei Badea
50: */
51: public interface DataComboBoxModel {
52:
53: /**
54: * Returns the combo box model; cannot be null.
55: */
56: ComboBoxModel getListModel();
57:
58: /**
59: * Returns the display name for the given item. The given item
60: * is one of the items in the model returned by {@link #getListModel}.
61: */
62: String getItemDisplayName(Object item);
63:
64: /**
65: * Returns the tooltip text for the given item. The given item
66: * is one of the items in the model returned by {@link #getListModel}.
67: */
68: String getItemTooltipText(Object item);
69:
70: /**
71: * Returns the text for the "Add item" item (used to add new items
72: * to the combo box).
73: */
74: String getNewItemDisplayName();
75:
76: /**
77: * Invoked when the "Add item" is selected. This method should do
78: * whatever is necessary to retrieve the new item to be added (e.g.
79: * by prompting the user) and add the new item to {@link #getListModel},
80: * firing a contentsChanged event.
81: */
82: void newItemActionPerformed();
83: }
|